Prepare for 'about site' page / add 'root-readme' option to cgitrc

The new option names a file which will be included on a new page, next
to the current 'index' page.

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

4 files changed, 10 insertions, 0 deletions

diff --git a/cgit.c b/cgit.c
index d37abc9..a402758 100644
--- a/cgit.c
+++ b/cgit.c
@@ -1,119 +1,121 @@
 /* cgit.c: cgi for the git scm
  *
  * Copyright (C) 2006 Lars Hjemli
  *
  * Licensed under GNU General Public License v2
  *   (see COPYING for full license text)
  */
 
 #include "cgit.h"
 #include "cache.h"
 #include "cmd.h"
 #include "configfile.h"
 #include "html.h"
 #include "ui-shared.h"
 
 const char *cgit_version = CGIT_VERSION;
 
 void config_cb(const char *name, const char *value)
 {
 	if (!strcmp(name, "root-title"))
 		ctx.cfg.root_title = xstrdup(value);
 	else if (!strcmp(name, "root-desc"))
 		ctx.cfg.root_desc = xstrdup(value);
+	else if (!strcmp(name, "root-readme"))
+		ctx.cfg.root_readme = xstrdup(value);
 	else if (!strcmp(name, "css"))
 		ctx.cfg.css = xstrdup(value);
 	else if (!strcmp(name, "logo"))
 		ctx.cfg.logo = xstrdup(value);
 	else if (!strcmp(name, "index-header"))
 		ctx.cfg.index_header = xstrdup(value);
 	else if (!strcmp(name, "index-info"))
 		ctx.cfg.index_info = xstrdup(value);
 	else if (!strcmp(name, "logo-link"))
 		ctx.cfg.logo_link = xstrdup(value);
 	else if (!strcmp(name, "module-link"))
 		ctx.cfg.module_link = xstrdup(value);
 	else if (!strcmp(name, "virtual-root")) {
 		ctx.cfg.virtual_root = trim_end(value, '/');
 		if (!ctx.cfg.virtual_root && (!strcmp(value, "/")))
 			ctx.cfg.virtual_root = "";
 	} else if (!strcmp(name, "nocache"))
 		ctx.cfg.nocache = atoi(value);
 	else if (!strcmp(name, "snapshots"))
 		ctx.cfg.snapshots = cgit_parse_snapshots_mask(value);
 	else if (!strcmp(name, "enable-index-links"))
 		ctx.cfg.enable_index_links = atoi(value);
 	else if (!strcmp(name, "enable-log-filecount"))
 		ctx.cfg.enable_log_filecount = atoi(value);
 	else if (!strcmp(name, "enable-log-linecount"))
 		ctx.cfg.enable_log_linecount = atoi(value);
 	else if (!strcmp(name, "cache-root"))
 		ctx.cfg.cache_root = xstrdup(value);
 	else if (!strcmp(name, "cache-root-ttl"))
 		ctx.cfg.cache_root_ttl = atoi(value);
 	else if (!strcmp(name, "cache-repo-ttl"))
 		ctx.cfg.cache_repo_ttl = atoi(value);
 	else if (!strcmp(name, "cache-static-ttl"))
 		ctx.cfg.cache_static_ttl = atoi(value);
 	else if (!strcmp(name, "cache-dynamic-ttl"))
 		ctx.cfg.cache_dynamic_ttl = atoi(value);
 	else if (!strcmp(name, "max-message-length"))
 		ctx.cfg.max_msg_len = atoi(value);
 	else if (!strcmp(name, "max-repodesc-length"))
 		ctx.cfg.max_repodesc_len = atoi(value);
 	else if (!strcmp(name, "max-commit-count"))
 		ctx.cfg.max_commit_count = atoi(value);
 	else if (!strcmp(name, "summary-log"))
 		ctx.cfg.summary_log = atoi(value);
 	else if (!strcmp(name, "summary-branches"))
 		ctx.cfg.summary_branches = atoi(value);
 	else if (!strcmp(name, "summary-tags"))
 		ctx.cfg.summary_tags = atoi(value);
 	else if (!strcmp(name, "agefile"))
 		ctx.cfg.agefile = xstrdup(value);
 	else if (!strcmp(name, "renamelimit"))
 		ctx.cfg.renamelimit = atoi(value);
 	else if (!strcmp(name, "robots"))
 		ctx.cfg.robots = xstrdup(value);
 	else if (!strcmp(name, "clone-prefix"))
 		ctx.cfg.clone_prefix = xstrdup(value);
 	else if (!strcmp(name, "repo.group"))
 		ctx.cfg.repo_group = xstrdup(value);
 	else if (!strcmp(name, "repo.url"))
 		ctx.repo = cgit_add_repo(value);
 	else if (!strcmp(name, "repo.name"))
 		ctx.repo->name = xstrdup(value);
 	else if (ctx.repo && !strcmp(name, "repo.path"))
 		ctx.repo->path = trim_end(value, '/');
 	else if (ctx.repo && !strcmp(name, "repo.clone-url"))
 		ctx.repo->clone_url = xstrdup(value);
 	else if (ctx.repo && !strcmp(name, "repo.desc"))
 		ctx.repo->desc = xstrdup(value);
 	else if (ctx.repo && !strcmp(name, "repo.owner"))
 		ctx.repo->owner = xstrdup(value);
 	else if (ctx.repo && !strcmp(name, "repo.defbranch"))
 		ctx.repo->defbranch = xstrdup(value);
 	else if (ctx.repo && !strcmp(name, "repo.snapshots"))
 		ctx.repo->snapshots = ctx.cfg.snapshots & cgit_parse_snapshots_mask(value); /* XXX: &? */
 	else if (ctx.repo && !strcmp(name, "repo.enable-log-filecount"))
 		ctx.repo->enable_log_filecount = ctx.cfg.enable_log_filecount * atoi(value);
 	else if (ctx.repo && !strcmp(name, "repo.enable-log-linecount"))
 		ctx.repo->enable_log_linecount = ctx.cfg.enable_log_linecount * atoi(value);
 	else if (ctx.repo && !strcmp(name, "repo.module-link"))
 		ctx.repo->module_link= xstrdup(value);
 	else if (ctx.repo && !strcmp(name, "repo.readme") && value != NULL) {
 		if (*value == '/')
 			ctx.repo->readme = xstrdup(value);
 		else
 			ctx.repo->readme = xstrdup(fmt("%s/%s", ctx.repo->path, value));
 	} else if (!strcmp(name, "include"))
 		parse_configfile(value, config_cb);
 }
 
 static void querystring_cb(const char *name, const char *value)
 {
 	if (!strcmp(name,"r")) {
 		ctx.qry.repo = xstrdup(value);
 		ctx.repo = cgit_get_repoinfo(value);
 	} else if (!strcmp(name, "p")) {
 		ctx.qry.page = xstrdup(value);
diff --git a/cgit.h b/cgit.h
index 7761b6e..daebeff 100644
--- a/cgit.h
+++ b/cgit.h
@@ -40,192 +40,193 @@
 /*
  * Default encoding
  */
 #define PAGE_ENCODING "UTF-8"
 
 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 cgit_repo {
 	char *url;
 	char *name;
 	char *path;
 	char *desc;
 	char *owner;
 	char *defbranch;
 	char *group;
 	char *module_link;
 	char *readme;
 	char *clone_url;
 	int snapshots;
 	int enable_log_filecount;
 	int enable_log_linecount;
 };
 
 struct cgit_repolist {
 	int length;
 	int count;
 	struct cgit_repo *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;
 	char *msg_encoding;
 };
 
 struct taginfo {
 	char *tagger;
 	char *tagger_email;
 	int tagger_date;
 	char *msg;
 };
 
 struct refinfo {
 	const char *refname;
 	struct object *object;
 	union {
 		struct taginfo *tag;
 		struct commitinfo *commit;
 	};
 };
 
 struct reflist {
 	struct refinfo **refs;
 	int alloc;
 	int count;
 };
 
 struct cgit_query {
 	int has_symref;
 	int has_sha1;
 	char *raw;
 	char *repo;
 	char *page;
 	char *search;
 	char *grep;
 	char *head;
 	char *sha1;
 	char *sha2;
 	char *path;
 	char *name;
 	int   ofs;
 };
 
 struct cgit_config {
 	char *agefile;
 	char *cache_root;
 	char *clone_prefix;
 	char *css;
 	char *index_header;
 	char *index_info;
 	char *logo;
 	char *logo_link;
 	char *module_link;
 	char *repo_group;
 	char *robots;
 	char *root_title;
 	char *root_desc;
+	char *root_readme;
 	char *script_name;
 	char *virtual_root;
 	int cache_dynamic_ttl;
 	int cache_max_create_time;
 	int cache_repo_ttl;
 	int cache_root_ttl;
 	int cache_static_ttl;
 	int enable_index_links;
 	int enable_log_filecount;
 	int enable_log_linecount;
 	int max_commit_count;
 	int max_lock_attempts;
 	int max_msg_len;
 	int max_repodesc_len;
 	int nocache;
 	int renamelimit;
 	int snapshots;
 	int summary_branches;
 	int summary_log;
 	int summary_tags;
 };
 
 struct cgit_page {
 	time_t modified;
 	time_t expires;
 	char *mimetype;
 	char *charset;
 	char *filename;
 	char *title;
 };
 
 struct cgit_context {
 	struct cgit_query qry;
 	struct cgit_config cfg;
 	struct cgit_repo *repo;
 	struct cgit_page page;
 };
 
 struct cgit_snapshot_format {
 	const char *suffix;
 	const char *mimetype;
 	write_archive_fn_t write_func;
 	int bit;
 };
 
 extern const char *cgit_version;
 
 extern struct cgit_repolist cgit_repolist;
 extern struct cgit_context ctx;
 extern const struct cgit_snapshot_format cgit_snapshot_formats[];
 
 extern struct cgit_repo *cgit_add_repo(const char *url);
 extern struct cgit_repo *cgit_get_repoinfo(const char *url);
 extern void cgit_repo_config_cb(const char *name, const char *value);
 
 extern int chk_zero(int result, char *msg);
 extern int chk_positive(int result, char *msg);
 extern int chk_non_negative(int result, char *msg);
 
 extern char *trim_end(const char *str, char c);
 extern char *strlpart(char *txt, int maxlen);
 extern char *strrpart(char *txt, int maxlen);
 
 extern void cgit_add_ref(struct reflist *list, struct refinfo *ref);
 extern int cgit_refs_cb(const char *refname, const unsigned char *sha1,
 			int flags, void *cb_data);
 
 extern void *cgit_free_commitinfo(struct commitinfo *info);
 
 extern int cgit_diff_files(const unsigned char *old_sha1,
 			   const unsigned char *new_sha1,
 			   linediff_fn fn);
 
 extern void cgit_diff_tree(const unsigned char *old_sha1,
 			   const unsigned char *new_sha1,
 			   filepair_fn fn, const char *prefix);
 
 extern void cgit_diff_commit(struct commit *commit, filepair_fn fn);
 
 extern char *fmt(const char *format,...);
 
 extern struct commitinfo *cgit_parse_commit(struct commit *commit);
 extern struct taginfo *cgit_parse_tag(struct tag *tag);
 extern void cgit_parse_url(const char *url);
 
 extern const char *cgit_repobasename(const char *reponame);
 
 extern int cgit_parse_snapshots_mask(const char *str);
 
 /* libgit.a either links against or compiles its own implementation of
  * strcasestr(), and we'd like to reuse it. Simply re-declaring it
  * seems to do the trick.
  */
 extern char *strcasestr(const char *haystack, const char *needle);
 
 
diff --git a/ui-repolist.c b/ui-repolist.c
index 200640c..3f78e28 100644
--- a/ui-repolist.c
+++ b/ui-repolist.c
@@ -43,96 +43,102 @@ static void print_modtime(struct cgit_repo *repo)
 		return;
 	cgit_print_age(s.st_mtime, -1, NULL);
 }
 
 int is_match(struct cgit_repo *repo)
 {
 	if (!ctx.qry.search)
 		return 1;
 	if (repo->url && strcasestr(repo->url, ctx.qry.search))
 		return 1;
 	if (repo->name && strcasestr(repo->name, ctx.qry.search))
 		return 1;
 	if (repo->desc && strcasestr(repo->desc, ctx.qry.search))
 		return 1;
 	if (repo->owner && strcasestr(repo->owner, ctx.qry.search))
 		return 1;
 	return 0;
 }
 
 void print_header(int columns)
 {
 	html("<tr class='nohover'>"
 	     "<th class='left'>Name</th>"
 	     "<th class='left'>Description</th>"
 	     "<th class='left'>Owner</th>"
 	     "<th class='left'>Idle</th>");
 	if (ctx.cfg.enable_index_links)
 		html("<th class='left'>Links</th>");
 	html("</tr>\n");
 }
 
 void cgit_print_repolist()
 {
 	int i, columns = 4, hits = 0, header = 0;
 	char *last_group = NULL;
 
 	if (ctx.cfg.enable_index_links)
 		columns++;
 
 	ctx.page.title = ctx.cfg.root_title;
 	cgit_print_http_headers(&ctx);
 	cgit_print_docstart(&ctx);
 	cgit_print_pageheader(&ctx);
 
 	if (ctx.cfg.index_header)
 		html_include(ctx.cfg.index_header);
 
 	html("<table summary='repository list' class='list nowrap'>");
 	for (i=0; i<cgit_repolist.count; i++) {
 		ctx.repo = &cgit_repolist.repos[i];
 		if (!is_match(ctx.repo))
 			continue;
 		if (!header++)
 			print_header(columns);
 		hits++;
 		if ((last_group == NULL && ctx.repo->group != NULL) ||
 		    (last_group != NULL && ctx.repo->group == NULL) ||
 		    (last_group != NULL && ctx.repo->group != NULL &&
 		     strcmp(ctx.repo->group, last_group))) {
 			htmlf("<tr class='nohover'><td colspan='%d' class='repogroup'>",
 			      columns);
 			html_txt(ctx.repo->group);
 			html("</td></tr>");
 			last_group = ctx.repo->group;
 		}
 		htmlf("<tr><td class='%s'>",
 		      ctx.repo->group ? "sublevel-repo" : "toplevel-repo");
 		html_link_open(cgit_repourl(ctx.repo->url), NULL, NULL);
 		html_txt(ctx.repo->name);
 		html_link_close();
 		html("</td><td>");
 		html_link_open(cgit_repourl(ctx.repo->url), NULL, NULL);
 		html_ntxt(ctx.cfg.max_repodesc_len, ctx.repo->desc);
 		html_link_close();
 		html("</td><td>");
 		html_txt(ctx.repo->owner);
 		html("</td><td>");
 		print_modtime(ctx.repo);
 		html("</td>");
 		if (ctx.cfg.enable_index_links) {
 			html("<td>");
 			html_link_open(cgit_repourl(ctx.repo->url),
 				       NULL, "button");
 			html("summary</a>");
 			cgit_log_link("log", NULL, "button", NULL, NULL, NULL,
 				      0, NULL, NULL);
 			cgit_tree_link("tree", NULL, "button", NULL, NULL, NULL);
 			html("</td>");
 		}
 		html("</tr>\n");
 	}
 	html("</table>");
 	if (!hits)
 		cgit_print_error("No repositories found");
 	cgit_print_docend();
 }
+
+void cgit_print_site_readme()
+{
+	if (ctx.cfg.root_readme)
+		html_include(ctx.cfg.root_readme);
+}
diff --git a/ui-repolist.h b/ui-repolist.h
index c23e5d2..5b1e542 100644
--- a/ui-repolist.h
+++ b/ui-repolist.h
@@ -1,6 +1,7 @@
 #ifndef UI_REPOLIST_H
 #define UI_REPOLIST_H
 
 extern void cgit_print_repolist();
+extern void cgit_print_site_readme();
 
 #endif /* UI_REPOLIST_H */