Add support for including a footer on all pages

The new cgitrc option `footer` can be used to include a html-file which
replaces the standard 'generated by cgit' message at the bottom of each
page.

Suggested-by: Peter Danenberg <pcd@wikitex.org>
Signed-off-by: Lars Hjemli <hjemli@gmail.com>

3 files changed, 13 insertions, 4 deletions

diff --git a/cgit.c b/cgit.c
index 0deae12..8f154c9 100644
--- a/cgit.c
+++ b/cgit.c
@@ -1,155 +1,157 @@
 /* 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, "footer"))
+                ctx.cfg.footer = 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-size"))
                 ctx.cfg.cache_size = 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-repo-count"))
                 ctx.cfg.max_repo_count = 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);
         } else if (!strcmp(name, "url")) {
                 cgit_parse_url(value);
         } else if (!strcmp(name, "qt")) {
                 ctx.qry.grep = xstrdup(value);
         } else if (!strcmp(name, "q")) {
                 ctx.qry.search = xstrdup(value);
         } else if (!strcmp(name, "h")) {
                 ctx.qry.head = xstrdup(value);
                 ctx.qry.has_symref = 1;
         } else if (!strcmp(name, "id")) {
                 ctx.qry.sha1 = xstrdup(value);
                 ctx.qry.has_sha1 = 1;
         } else if (!strcmp(name, "id2")) {
                 ctx.qry.sha2 = xstrdup(value);
                 ctx.qry.has_sha1 = 1;
         } else if (!strcmp(name, "ofs")) {
                 ctx.qry.ofs = atoi(value);
         } else if (!strcmp(name, "path")) {
                 ctx.qry.path = trim_end(value, '/');
         } else if (!strcmp(name, "name")) {
                 ctx.qry.name = xstrdup(value);
         } else if (!strcmp(name, "mimetype")) {
                 ctx.qry.mimetype = xstrdup(value);
         }
 }
 
 static void prepare_context(struct cgit_context *ctx)
 {
         memset(ctx, 0, sizeof(ctx));
         ctx->cfg.agefile = "info/web/last-modified";
diff --git a/cgit.h b/cgit.h
index 1972d75..d18d9ca 100644
--- a/cgit.h
+++ b/cgit.h
@@ -1,236 +1,237 @@
 #ifndef CGIT_H
 #define CGIT_H
 
 
 #include <git-compat-util.h>
 #include <cache.h>
 #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>
 #include <utf8.h>
 
 
 /*
  * 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)
 
 
 /*
  * 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;
         char *mimetype;
         int   ofs;
 };
 
 struct cgit_config {
         char *agefile;
         char *cache_root;
         char *clone_prefix;
         char *css;
+        char *footer;
         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_size;
         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_repo_count;
         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);
 
 
 #endif /* CGIT_H */
diff --git a/ui-shared.c b/ui-shared.c
index cd98387..8a00099 100644
--- a/ui-shared.c
+++ b/ui-shared.c
@@ -318,260 +318,266 @@ void cgit_diff_link(char *name, char *title, char *class, char *head,
         html("'>");
         html_txt(name);
         html("</a>");
 }
 
 void cgit_patch_link(char *name, char *title, char *class, char *head,
                      char *rev)
 {
         reporevlink("patch", name, title, class, head, rev, NULL);
 }
 
 void cgit_object_link(struct object *obj)
 {
         char *page, *arg, *url;
 
         if (obj->type == OBJ_COMMIT) {
                 cgit_commit_link(fmt("commit %s", sha1_to_hex(obj->sha1)), NULL, NULL,
                                  ctx.qry.head, sha1_to_hex(obj->sha1));
                 return;
         } else if (obj->type == OBJ_TREE) {
                 page = "tree";
                 arg = "id";
         } else if (obj->type == OBJ_TAG) {
                 page = "tag";
                 arg = "id";
         } else {
                 page = "blob";
                 arg = "id";
         }
 
         url = cgit_pageurl(ctx.qry.repo, page,
                            fmt("%s=%s", arg, sha1_to_hex(obj->sha1)));
         html_link_open(url, NULL, NULL);
         htmlf("%s %s", typename(obj->type),
               sha1_to_hex(obj->sha1));
         html_link_close();
 }
 
 void cgit_print_date(time_t secs, char *format)
 {
         char buf[64];
         struct tm *time;
 
         if (!secs)
                 return;
         time = gmtime(&secs);
         strftime(buf, sizeof(buf)-1, format, time);
         html_txt(buf);
 }
 
 void cgit_print_age(time_t t, time_t max_relative, char *format)
 {
         time_t now, secs;
 
         if (!t)
                 return;
         time(&now);
         secs = now - t;
 
         if (secs > max_relative && max_relative >= 0) {
                 cgit_print_date(t, format);
                 return;
         }
 
         if (secs < TM_HOUR * 2) {
                 htmlf("<span class='age-mins'>%.0f min.</span>",
                       secs * 1.0 / TM_MIN);
                 return;
         }
         if (secs < TM_DAY * 2) {
                 htmlf("<span class='age-hours'>%.0f hours</span>",
                       secs * 1.0 / TM_HOUR);
                 return;
         }
         if (secs < TM_WEEK * 2) {
                 htmlf("<span class='age-days'>%.0f days</span>",
                       secs * 1.0 / TM_DAY);
                 return;
         }
         if (secs < TM_MONTH * 2) {
                 htmlf("<span class='age-weeks'>%.0f weeks</span>",
                       secs * 1.0 / TM_WEEK);
                 return;
         }
         if (secs < TM_YEAR * 2) {
                 htmlf("<span class='age-months'>%.0f months</span>",
                       secs * 1.0 / TM_MONTH);
                 return;
         }
         htmlf("<span class='age-years'>%.0f years</span>",
               secs * 1.0 / TM_YEAR);
 }
 
 void cgit_print_http_headers(struct cgit_context *ctx)
 {
         if (ctx->page.mimetype && ctx->page.charset)
                 htmlf("Content-Type: %s; charset=%s\n", ctx->page.mimetype,
                       ctx->page.charset);
         else if (ctx->page.mimetype)
                 htmlf("Content-Type: %s\n", ctx->page.mimetype);
         if (ctx->page.filename)
                 htmlf("Content-Disposition: inline; filename=\"%s\"\n",
                       ctx->page.filename);
         htmlf("Last-Modified: %s\n", http_date(ctx->page.modified));
         htmlf("Expires: %s\n", http_date(ctx->page.expires));
         html("\n");
 }
 
 void cgit_print_docstart(struct cgit_context *ctx)
 {
         html(cgit_doctype);
         html("<html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'>\n");
         html("<head>\n");
         html("<title>");
         html_txt(ctx->page.title);
         html("</title>\n");
         htmlf("<meta name='generator' content='cgit %s'/>\n", cgit_version);
         if (ctx->cfg.robots && *ctx->cfg.robots)
                 htmlf("<meta name='robots' content='%s'/>\n", ctx->cfg.robots);
         html("<link rel='stylesheet' type='text/css' href='");
         html_attr(ctx->cfg.css);
         html("'/>\n");
         html("</head>\n");
         html("<body>\n");
 }
 
 void cgit_print_docend()
 {
-        html("</div><div class='footer'>generated ");
-        cgit_print_date(time(NULL), FMT_LONGDATE);
-        htmlf(" by cgit %s", cgit_version);
-        html("</div>\n</body>\n</html>\n");
+        html("</div>");
+        if (ctx.cfg.footer)
+                html_include(ctx.cfg.footer);
+        else {
+                html("<div class='footer'>generated ");
+                cgit_print_date(time(NULL), FMT_LONGDATE);
+                htmlf(" by cgit %s", cgit_version);
+                html("</div>\n");
+        }
+        html("</body>\n</html>\n");
 }
 
 int print_branch_option(const char *refname, const unsigned char *sha1,
                         int flags, void *cb_data)
 {
         char *name = (char *)refname;
         html_option(name, name, ctx.qry.head);
         return 0;
 }
 
 int print_archive_ref(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];
         int *header = (int *)cb_data;
 
         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("<h1>download</h1>\n");
                 *header = 1;
         }
         url = cgit_pageurl(ctx.qry.repo, "blob",
                            fmt("id=%s&amp;path=%s", sha1_to_hex(fileid),
                                buf));
         html_link_open(url, NULL, "menu");
         html_txt(strlpart(buf, 20));
         html_link_close();
         return 0;
 }
 
 void add_hidden_formfields(int incl_head, int incl_search, char *page)
 {
         char *url;
 
         if (!ctx.cfg.virtual_root) {
                 url = fmt("%s/%s", ctx.qry.repo, page);
                 if (ctx.qry.path)
                         url = fmt("%s/%s", url, ctx.qry.path);
                 html_hidden("url", url);
         }
 
         if (incl_head && strcmp(ctx.qry.head, ctx.repo->defbranch))
                 html_hidden("h", ctx.qry.head);
 
         if (ctx.qry.sha1)
                 html_hidden("id", ctx.qry.sha1);
         if (ctx.qry.sha2)
                 html_hidden("id2", ctx.qry.sha2);
 
         if (incl_search) {
                 if (ctx.qry.grep)
                         html_hidden("qt", ctx.qry.grep);
                 if (ctx.qry.search)
                         html_hidden("q", ctx.qry.search);
         }
 }
 
 char *hc(struct cgit_cmd *cmd, const char *page)
 {
         return (strcmp(cmd->name, page) ? NULL : "active");
 }
 
 void cgit_print_pageheader(struct cgit_context *ctx)
 {
         struct cgit_cmd *cmd = cgit_get_cmd(ctx);
 
         html("<table id='header'>\n");
         html("<tr>\n");
         html("<td class='logo' rowspan='2'><a href='");
         if (ctx->cfg.logo_link)
                 html_attr(ctx->cfg.logo_link);
         else
                 html_attr(cgit_rooturl());
         html("'><img src='");
         html_attr(ctx->cfg.logo);
         html("' alt='cgit logo'/></a></td>\n");
 
         html("<td class='main'>");
         if (ctx->repo) {
                 cgit_index_link("index", NULL, NULL, NULL, 0);
                 html(" : ");
                 reporevlink(NULL, ctx->repo->name, NULL, hc(cmd, "summary"),
                             ctx->qry.head, NULL, NULL);
                 html("</td><td class='form'>");
                 html("<form method='get' action=''>\n");
                 add_hidden_formfields(0, 1, ctx->qry.page);
                 html("<select name='h' onchange='this.form.submit();'>\n");
                 for_each_branch_ref(print_branch_option, ctx->qry.head);
                 html("</select> ");
                 html("<input type='submit' name='' value='switch'/>");
                 html("</form>");
         } else
                 html_txt(ctx->cfg.root_title);
         html("</td></tr>\n");
 
         html("<tr><td class='sub'");
         if (ctx->repo) {
                 html(" colspan='2'>");
                 html_txt(ctx->repo->desc);
         } else {
                 html(">");
                 if (ctx->cfg.root_desc)
                         html_txt(ctx->cfg.root_desc);
                 else if (ctx->cfg.index_info)
                         html_include(ctx->cfg.index_info);
         }
         html("</td></tr></table>\n");
 
         html("<table class='tabs'><tr><td>\n");