Add repo.readme parameter

This parameter can be used to specify a repo-specific includefile, which will
then be printed on the summary page for the repo.

If the parametervalue is a not an absolute path, it is taken to be relative
to repo.path.

Signed-off-by: Lars Hjemli <hjemli@gmail.com>

5 files changed, 23 insertions, 15 deletions

diff --git a/cgit.css b/cgit.css
index 327eaba..8977533 100644
--- a/cgit.css
+++ b/cgit.css
@@ -79,144 +79,142 @@ table#layout {
 	width: 100%;
 	border-collapse: collapse;
 	margin: 0px;
 }
 
 td#header, td#logo {
 	color: #666;
 	background-color: #ddd;
 	border-bottom: solid 1px #000;
 }
 
 td#header {
 	font-size: 150%;
 	font-weight: bold;
 	padding: 0.2em 0.5em;
 	vertical-align: text-bottom;
 }
 
 td#logo {
 	text-align: right;
 	vertical-align: middle;
 	padding-right: 0.5em;
 }
 
 td#crumb, td#search {
 	color: #ccc;
 	border-top: solid 3px #555;
 	background-color: #666;
 	border-bottom: solid 1px #333;
 	padding: 2px 1em;
 }
 
 td#crumb {
 	font-weight: bold;
 }
 
 td#crumb a {
 	color: #ccc;
 }
 
 td#crumb a:hover {
 	color: #eee;
 }
 
 td#search {
 	text-align: right;
 	vertical-align: center;
 	padding-right: 0.5em;
 }
 
 td#search form {
 	margin: 0px;
 	padding: 0px;
 }
 
 td#search input {
 	font-size: 9pt;
 	padding: 0px;
 	width: 10em;
 	border: solid 1px #333;
 	color: #333;
 	background-color: #fff;
 }
 
-td#summary {
+div#summary {
 	vertical-align: top;
-	padding-bottom: 1em;
+	margin-bottom: 1em;
 }
 
-td#archivelist {
-	padding-bottom: 1em;
-}
-
-td#archivelist table {
+table#downloads {
 	float: right;
 	border-collapse: collapse;
 	border: solid 1px #777;
+	margin-left: 0.5em;
+	margin-bottom: 0.5em;
 }
 
-td#archivelist table th {
+table#downloads th {
 	background-color: #ccc;
 }
 
 td#content {
 	padding: 1em 0.5em;
 }
 
 div#blob {
 	border: solid 1px black;
 }
 
 div.error {
 	color: red;
 	font-weight: bold;
 	margin: 1em 2em;
 }
 
 td.ls-blob, td.ls-dir, td.ls-mod {
 	font-family: monospace;
 }
 
 div.ls-dir a {
 	font-weight: bold;
 }
 
 th.filesize, td.filesize {
 	text-align: right;
 }
 
 td.filesize {
 	font-family: monospace;
 }
 
 td.links {
 	font-size: 80%;
 	padding-left: 2em;
 }
 
 td.filemode {
 	font-family: monospace;
 }
 
 td.blob {
 	white-space: pre;
 	font-family: monospace;
 	background-color: white;
 }
 
 table.nowrap td {
 	white-space: nowrap;
 }
 
 table.commit-info {
 	border-collapse: collapse;
 	margin-top: 1.5em;
 }
 
 table.commit-info th {
 	text-align: left;
 	font-weight: normal;
 	padding: 0.1em 1em 0.1em 0.1em;
 }
 
 table.commit-info td {
diff --git a/cgit.h b/cgit.h
index 3938633..5c55bec 100644
--- a/cgit.h
+++ b/cgit.h
@@ -7,128 +7,129 @@
 #include <grep.h>
 #include <object.h>
 #include <tree.h>
 #include <commit.h>
 #include <tag.h>
 #include <diff.h>
 #include <diffcore.h>
 #include <refs.h>
 #include <revision.h>
 #include <log-tree.h>
 #include <archive.h>
 #include <xdiff/xdiff.h>
 
 
 /*
  * The valid cgit repo-commands
  */
 #define CMD_LOG      1
 #define CMD_COMMIT   2
 #define CMD_DIFF     3
 #define CMD_TREE     4
 #define CMD_VIEW     5
 #define CMD_BLOB     6
 #define CMD_SNAPSHOT 7
 
 
 /*
  * Dateformats used on misc. pages
  */
 #define FMT_LONGDATE "%Y-%m-%d %H:%M:%S"
 #define FMT_SHORTDATE "%Y-%m-%d"
 
 
 /*
  * Limits used for relative dates
  */
 #define TM_MIN    60
 #define TM_HOUR  (TM_MIN * 60)
 #define TM_DAY   (TM_HOUR * 24)
 #define TM_WEEK  (TM_DAY * 7)
 #define TM_YEAR  (TM_DAY * 365)
 #define TM_MONTH (TM_YEAR / 12.0)
 
 
 typedef void (*configfn)(const char *name, const char *value);
 typedef void (*filepair_fn)(struct diff_filepair *pair);
 typedef void (*linediff_fn)(char *line, int len);
 
 struct cacheitem {
 	char *name;
 	struct stat st;
 	int ttl;
 	int fd;
 };
 
 struct repoinfo {
 	char *url;
 	char *name;
 	char *path;
 	char *desc;
 	char *owner;
 	char *defbranch;
 	char *group;
 	char *module_link;
+	char *readme;
 	int snapshots;
 	int enable_log_filecount;
 	int enable_log_linecount;
 };
 
 struct repolist {
 	int length;
 	int count;
 	struct repoinfo *repos;
 };
 
 struct commitinfo {
 	struct commit *commit;
 	char *author;
 	char *author_email;
 	unsigned long author_date;
 	char *committer;
 	char *committer_email;
 	unsigned long committer_date;
 	char *subject;
 	char *msg;
 };
 
 struct taginfo {
 	char *tagger;
 	char *tagger_email;
 	int tagger_date;
 	char *msg;
 };
 
 extern const char cgit_version[];
 
 extern struct repolist cgit_repolist;
 extern struct repoinfo *cgit_repo;
 extern int cgit_cmd;
 
 extern char *cgit_root_title;
 extern char *cgit_css;
 extern char *cgit_logo;
 extern char *cgit_index_header;
 extern char *cgit_logo_link;
 extern char *cgit_module_link;
 extern char *cgit_agefile;
 extern char *cgit_virtual_root;
 extern char *cgit_script_name;
 extern char *cgit_cache_root;
 extern char *cgit_repo_group;
 
 extern int cgit_nocache;
 extern int cgit_snapshots;
 extern int cgit_enable_log_filecount;
 extern int cgit_enable_log_linecount;
 extern int cgit_max_lock_attempts;
 extern int cgit_cache_root_ttl;
 extern int cgit_cache_repo_ttl;
 extern int cgit_cache_dynamic_ttl;
 extern int cgit_cache_static_ttl;
 extern int cgit_cache_max_create_time;
 
 extern int cgit_max_msg_len;
 extern int cgit_max_repodesc_len;
 extern int cgit_max_commit_count;
 
 extern int cgit_query_has_symref;
diff --git a/cgitrc b/cgitrc
index eaa9ce3..054a708 100644
--- a/cgitrc
+++ b/cgitrc
@@ -47,64 +47,65 @@
 #css=/cgit/cgit.css
 
 
 ## Link to logo file
 #logo=/cgit/git-logo.png
 
 
 ## Url loaded when clicking the logo
 #logo-link=http://www.kernel.org/pub/software/scm/git/docs/
 
 
 ## Url loaded when clicking a submodule link
 #module-link=./?repo=%s&page=commit&id=%s
 
 
 ## Number of chars shown of repo description (in repolist view)
 #max-repodesc-length=60
 
 
 ## Number of chars shown of commit subject message (in log view)
 #max-message-length=60
 
 
 ## Number of commits per page in log view
 #max-commit-count=50
 
 
 ## Root of cached output
 #cache-root=/var/cache/cgit
 
 
 ## Include another config-file
 #include=/var/cgit/repolist
 
 ##
 ## Time-To-Live settings: specifies how long (in minutes) different pages
 ## should be cached (0 for instant expiration, -1 for immortal pages)
 ##
 
 ## ttl for root page
 #cache-root-ttl=5
 
 ## ttl for repo summary page
 #cache-repo-ttl=5
 
 ## ttl for other dynamic pages
 #cache-dynamic-ttl=5
 
 ## ttl for static pages (addressed by SHA-1)
 #cache-static-ttl=-1
 
 
 
 ## Example repository entry. Required values are repo.url and repo.path (each
 ## repository section must start with repo.url).
 #repo.url=cgit
 #repo.name=cgit
 #repo.desc=the caching cgi for git
 #repo.path=/pub/git/cgit
 #repo.owner=Lars Hjemli
 #repo.snapshots=1				# override a sitewide snapshot-setting
 #repo.enable-log-filecount=0			# override the default filecount setting
 #repo.enable-log-linecount=0			# override the default linecount setting
 #repo.module-link=/git/%s/commit/?id=%s		# override the standard module-link
+#repo.readme=info/web/readme			# specify a file to include on summary page
diff --git a/shared.c b/shared.c
index ce3ca4f..e3123a8 100644
--- a/shared.c
+++ b/shared.c
@@ -46,209 +46,215 @@ char *cgit_querystring  = NULL;
 char *cgit_query_repo   = NULL;
 char *cgit_query_page   = NULL;
 char *cgit_query_head   = NULL;
 char *cgit_query_search = NULL;
 char *cgit_query_sha1   = NULL;
 char *cgit_query_sha2   = NULL;
 char *cgit_query_path   = NULL;
 char *cgit_query_name   = NULL;
 int   cgit_query_ofs    = 0;
 
 int htmlfd = 0;
 
 
 int cgit_get_cmd_index(const char *cmd)
 {
 	static char *cmds[] = {"log", "commit", "diff", "tree", "view", "blob", "snapshot", NULL};
 	int i;
 
 	for(i = 0; cmds[i]; i++)
 		if (!strcmp(cmd, cmds[i]))
 			return i + 1;
 	return 0;
 }
 
 int chk_zero(int result, char *msg)
 {
 	if (result != 0)
 		die("%s: %s", msg, strerror(errno));
 	return result;
 }
 
 int chk_positive(int result, char *msg)
 {
 	if (result <= 0)
 		die("%s: %s", msg, strerror(errno));
 	return result;
 }
 
 struct repoinfo *add_repo(const char *url)
 {
 	struct repoinfo *ret;
 
 	if (++cgit_repolist.count > cgit_repolist.length) {
 		if (cgit_repolist.length == 0)
 			cgit_repolist.length = 8;
 		else
 			cgit_repolist.length *= 2;
 		cgit_repolist.repos = xrealloc(cgit_repolist.repos,
 					       cgit_repolist.length *
 					       sizeof(struct repoinfo));
 	}
 
 	ret = &cgit_repolist.repos[cgit_repolist.count-1];
 	ret->url = xstrdup(url);
 	ret->name = ret->url;
 	ret->path = NULL;
 	ret->desc = NULL;
 	ret->owner = NULL;
 	ret->group = cgit_repo_group;
 	ret->defbranch = "master";
 	ret->snapshots = cgit_snapshots;
 	ret->enable_log_filecount = cgit_enable_log_filecount;
 	ret->enable_log_linecount = cgit_enable_log_linecount;
 	ret->module_link = cgit_module_link;
+	ret->readme = NULL;
 	return ret;
 }
 
 struct repoinfo *cgit_get_repoinfo(const char *url)
 {
 	int i;
 	struct repoinfo *repo;
 
 	for (i=0; i<cgit_repolist.count; i++) {
 		repo = &cgit_repolist.repos[i];
 		if (!strcmp(repo->url, url))
 			return repo;
 	}
 	return NULL;
 }
 
 void cgit_global_config_cb(const char *name, const char *value)
 {
 	if (!strcmp(name, "root-title"))
 		cgit_root_title = xstrdup(value);
 	else if (!strcmp(name, "css"))
 		cgit_css = xstrdup(value);
 	else if (!strcmp(name, "logo"))
 		cgit_logo = xstrdup(value);
 	else if (!strcmp(name, "index-header"))
 		cgit_index_header = xstrdup(value);
 	else if (!strcmp(name, "logo-link"))
 		cgit_logo_link = xstrdup(value);
 	else if (!strcmp(name, "module-link"))
 		cgit_module_link = xstrdup(value);
 	else if (!strcmp(name, "virtual-root"))
 		cgit_virtual_root = xstrdup(value);
 	else if (!strcmp(name, "nocache"))
 		cgit_nocache = atoi(value);
 	else if (!strcmp(name, "snapshots"))
 		cgit_snapshots = atoi(value);
 	else if (!strcmp(name, "enable-log-filecount"))
 		cgit_enable_log_filecount = atoi(value);
 	else if (!strcmp(name, "enable-log-linecount"))
 		cgit_enable_log_linecount = atoi(value);
 	else if (!strcmp(name, "cache-root"))
 		cgit_cache_root = xstrdup(value);
 	else if (!strcmp(name, "cache-root-ttl"))
 		cgit_cache_root_ttl = atoi(value);
 	else if (!strcmp(name, "cache-repo-ttl"))
 		cgit_cache_repo_ttl = atoi(value);
 	else if (!strcmp(name, "cache-static-ttl"))
 		cgit_cache_static_ttl = atoi(value);
 	else if (!strcmp(name, "cache-dynamic-ttl"))
 		cgit_cache_dynamic_ttl = atoi(value);
 	else if (!strcmp(name, "max-message-length"))
 		cgit_max_msg_len = atoi(value);
 	else if (!strcmp(name, "max-repodesc-length"))
 		cgit_max_repodesc_len = atoi(value);
 	else if (!strcmp(name, "max-commit-count"))
 		cgit_max_commit_count = atoi(value);
 	else if (!strcmp(name, "agefile"))
 		cgit_agefile = xstrdup(value);
 	else if (!strcmp(name, "repo.group"))
 		cgit_repo_group = xstrdup(value);
 	else if (!strcmp(name, "repo.url"))
 		cgit_repo = add_repo(value);
 	else if (!strcmp(name, "repo.name"))
 		cgit_repo->name = xstrdup(value);
 	else if (cgit_repo && !strcmp(name, "repo.path"))
 		cgit_repo->path = xstrdup(value);
 	else if (cgit_repo && !strcmp(name, "repo.desc"))
 		cgit_repo->desc = xstrdup(value);
 	else if (cgit_repo && !strcmp(name, "repo.owner"))
 		cgit_repo->owner = xstrdup(value);
 	else if (cgit_repo && !strcmp(name, "repo.defbranch"))
 		cgit_repo->defbranch = xstrdup(value);
 	else if (cgit_repo && !strcmp(name, "repo.snapshots"))
 		cgit_repo->snapshots = cgit_snapshots * atoi(value);
 	else if (cgit_repo && !strcmp(name, "repo.enable-log-filecount"))
 		cgit_repo->enable_log_filecount = cgit_enable_log_filecount * atoi(value);
 	else if (cgit_repo && !strcmp(name, "repo.enable-log-linecount"))
 		cgit_repo->enable_log_linecount = cgit_enable_log_linecount * atoi(value);
 	else if (cgit_repo && !strcmp(name, "repo.module-link"))
 		cgit_repo->module_link= xstrdup(value);
-	else if (!strcmp(name, "include"))
+	else if (cgit_repo && !strcmp(name, "repo.readme") && value != NULL) {
+		if (*value == '/')
+			cgit_repo->readme = xstrdup(value);
+		else
+			cgit_repo->readme = xstrdup(fmt("%s/%s", cgit_repo->path, value));
+	} else if (!strcmp(name, "include"))
 		cgit_read_config(value, cgit_global_config_cb);
 }
 
 void cgit_querystring_cb(const char *name, const char *value)
 {
 	if (!strcmp(name,"r")) {
 		cgit_query_repo = xstrdup(value);
 		cgit_repo = cgit_get_repoinfo(value);
 	} else if (!strcmp(name, "p")) {
 		cgit_query_page = xstrdup(value);
 		cgit_cmd = cgit_get_cmd_index(value);
 	} else if (!strcmp(name, "url")) {
 		cgit_parse_url(value);
 	} else if (!strcmp(name, "q")) {
 		cgit_query_search = xstrdup(value);
 	} else if (!strcmp(name, "h")) {
 		cgit_query_head = xstrdup(value);
 		cgit_query_has_symref = 1;
 	} else if (!strcmp(name, "id")) {
 		cgit_query_sha1 = xstrdup(value);
 		cgit_query_has_sha1 = 1;
 	} else if (!strcmp(name, "id2")) {
 		cgit_query_sha2 = xstrdup(value);
 		cgit_query_has_sha1 = 1;
 	} else if (!strcmp(name, "ofs")) {
 		cgit_query_ofs = atoi(value);
 	} else if (!strcmp(name, "path")) {
 		cgit_query_path = xstrdup(value);
 	} else if (!strcmp(name, "name")) {
 		cgit_query_name = xstrdup(value);
 	}
 }
 
 void *cgit_free_commitinfo(struct commitinfo *info)
 {
 	free(info->author);
 	free(info->author_email);
 	free(info->committer);
 	free(info->committer_email);
 	free(info->subject);
 	free(info);
 	return NULL;
 }
 
 int hextoint(char c)
 {
 	if (c >= 'a' && c <= 'f')
 		return 10 + c - 'a';
 	else if (c >= 'A' && c <= 'F')
 		return 10 + c - 'A';
 	else if (c >= '0' && c <= '9')
 		return c - '0';
 	else
 		return -1;
 }
 
 void cgit_diff_tree_cb(struct diff_queue_struct *q,
 		       struct diff_options *options, void *data)
 {
 	int i;
 
 	for (i = 0; i < q->nr; i++) {
 		if (q->queue[i]->status == 'U')
 			continue;
diff --git a/ui-summary.c b/ui-summary.c
index 5799773..5c1fc33 100644
--- a/ui-summary.c
+++ b/ui-summary.c
@@ -92,119 +92,121 @@ static int cgit_print_tag_cb(const char *refname, const unsigned char *sha1,
 
 	strncpy(buf, refname, sizeof(buf));
 	obj = parse_object(sha1);
 	if (!obj)
 		return 1;
 	if (obj->type == OBJ_TAG) {
 		tag = lookup_tag(sha1);
 		if (!tag || parse_tag(tag) || !(info = cgit_parse_tag(tag)))
 			return 2;
 		if (!header)
 			print_tag_header();
 		html("<tr><td>");
 		url = cgit_pageurl(cgit_query_repo, "view",
 				   fmt("id=%s", sha1_to_hex(sha1)));
 		html_link_open(url, NULL, NULL);
 		html_txt(buf);
 		html_link_close();
 		html("</td><td>");
 		if (info->tagger_date > 0)
 			cgit_print_age(info->tagger_date, -1, NULL);
 		html("</td><td>");
 		if (info->tagger)
 			html(info->tagger);
 		html("</td><td>");
 		cgit_print_object_ref(tag->tagged);
 		html("</td></tr>\n");
 	} else {
 		if (!header)
 			print_tag_header();
 		html("<tr><td>");
 		html_txt(buf);
 		html("</td><td colspan='2'/><td>");
 		cgit_print_object_ref(obj);
 		html("</td></tr>\n");
 	}
 	return 0;
 }
 
 static int cgit_print_archive_cb(const char *refname, const unsigned char *sha1,
 				 int flags, void *cb_data)
 {
 	struct tag *tag;
 	struct taginfo *info;
 	struct object *obj;
 	char buf[256], *url;
 	unsigned char fileid[20];
 
 	if (prefixcmp(refname, "refs/archives"))
 		return 0;
 	strncpy(buf, refname+14, sizeof(buf));
 	obj = parse_object(sha1);
 	if (!obj)
 		return 1;
 	if (obj->type == OBJ_TAG) {
 		tag = lookup_tag(sha1);
 		if (!tag || parse_tag(tag) || !(info = cgit_parse_tag(tag)))
 			return 0;
 		hashcpy(fileid, tag->tagged->sha1);
 	} else if (obj->type != OBJ_BLOB) {
 		return 0;
 	} else {
 		hashcpy(fileid, sha1);
 	}
 	if (!header) {
-		html("<table>");
+		html("<table id='downloads'>");
 		html("<tr><th>Downloads</th></tr>");
 		header = 1;
 	}
 	html("<tr><td>");
 	url = cgit_pageurl(cgit_query_repo, "blob",
 			   fmt("id=%s&path=%s", sha1_to_hex(fileid),
 			       buf));
 	html_link_open(url, NULL, NULL);
 	html_txt(buf);
 	html_link_close();
 	html("</td><tr>");
 	return 0;
 }
 
 static void cgit_print_branches()
 {
 	html("<tr class='nohover'><th class='left'>Branch</th>"
 	     "<th class='left'>Idle</th>"
 	     "<th class='left'>Author</th>"
 	     "<th class='left'>Head commit</th></tr>\n");
 	for_each_branch_ref(cgit_print_branch_cb, NULL);
 }
 
 static void cgit_print_tags()
 {
 	header = 0;
 	for_each_tag_ref(cgit_print_tag_cb, NULL);
 }
 
 static void cgit_print_archives()
 {
 	header = 0;
 	for_each_ref(cgit_print_archive_cb, NULL);
 	if (header)
 		html("</table>");
 }
 
 void cgit_print_summary()
 {
-	html("<table class='list nowrap'>");
-	html("<tr class='nohover'><td id='summary' colspan='3'>");
+	html("<div id='summary'>");
+	cgit_print_archives();
 	html("<h2>");
 	html_txt(cgit_repo->name);
 	html(" - ");
 	html_txt(cgit_repo->desc);
 	html("</h2>");
-	html("</td><td id='archivelist'>");
-	cgit_print_archives();
-	html("</td></tr>");
+	if (cgit_repo->readme)
+		html_include(cgit_repo->readme);
+	html("</div>");
+
+	html("<table class='list nowrap'>");
 	cgit_print_branches();
 	html("<tr class='nohover'><td colspan='4'>&nbsp;</td></tr>");
 	cgit_print_tags();
 	html("</table>");
 }