ui-commit: add support for 'commit-filter' option

This new option specifies a filter which is executed on the commit
message, i.e. the commit message is written to the filters STDIN and
the filters STDOUT is included verbatim as the commit message.

This can be used to implement commit linking by creating a simple
shell script in e.g. /usr/bin/cgit-commit-filter.sh like this:

#/bin/sh
sed -re 's|\b([0-9a-fA-F]{6,40})\b|<a href="./?id=\1">\1</a>|g'

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

4 files changed, 17 insertions, 0 deletions

diff --git a/cgit.c b/cgit.c
index eb7b45d..2cda554 100644
--- a/cgit.c
+++ b/cgit.c
@@ -1,188 +1,190 @@
 /* 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"
 #include "ui-stats.h"
 #include "scan-tree.h"
 
 const char *cgit_version = CGIT_VERSION;
 
 struct cgit_filter *new_filter(const char *cmd, int extra_args)
 {
         struct cgit_filter *f;
 
         if (!cmd)
                 return NULL;
 
         f = xmalloc(sizeof(struct cgit_filter));
         f->cmd = xstrdup(cmd);
         f->argv = xmalloc((2 + extra_args) * sizeof(char *));
         f->argv[0] = f->cmd;
         f->argv[1] = NULL;
         return f;
 }
 
 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, "favicon"))
                 ctx.cfg.favicon = xstrdup(value);
         else if (!strcmp(name, "footer"))
                 ctx.cfg.footer = xstrdup(value);
         else if (!strcmp(name, "head-include"))
                 ctx.cfg.head_include = xstrdup(value);
         else if (!strcmp(name, "header"))
                 ctx.cfg.header = 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, "noheader"))
                 ctx.cfg.noheader = 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, "max-stats"))
                 ctx.cfg.max_stats = cgit_find_stats_period(value, NULL);
         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, "commit-filter"))
+                ctx.cfg.commit_filter = new_filter(value, 0);
         else if (!strcmp(name, "embedded"))
                 ctx.cfg.embedded = 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, "source-filter"))
                 ctx.cfg.source_filter = new_filter(value, 1);
         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, "local-time"))
                 ctx.cfg.local_time = atoi(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.max-stats"))
                 ctx.repo->max_stats = cgit_find_stats_period(value, NULL);
         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")) {
                 ctx.qry.url = xstrdup(value);
                 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);
         } else if (!strcmp(name, "s")){
                 ctx.qry.sort = xstrdup(value);
diff --git a/cgit.h b/cgit.h
index f9cf0df..438301d 100644
--- a/cgit.h
+++ b/cgit.h
@@ -90,176 +90,177 @@ struct taginfo {
         char *tagger_email;
         unsigned long 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;
         char *url;
         char *period;
         int   ofs;
         int nohead;
         char *sort;
         int showmsg;
 };
 
 struct cgit_filter {
         char *cmd;
         char **argv;
         int old_stdout;
         int pipe_fh[2];
         int pid;
         int exitstatus;
 };
 
 struct cgit_config {
         char *agefile;
         char *cache_root;
         char *clone_prefix;
         char *css;
         char *favicon;
         char *footer;
         char *head_include;
         char *header;
         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 embedded;
         int enable_index_links;
         int enable_log_filecount;
         int enable_log_linecount;
         int local_time;
         int max_repo_count;
         int max_commit_count;
         int max_lock_attempts;
         int max_msg_len;
         int max_repodesc_len;
         int max_stats;
         int nocache;
         int noheader;
         int renamelimit;
         int snapshots;
         int summary_branches;
         int summary_log;
         int summary_tags;
+        struct cgit_filter *commit_filter;
         struct cgit_filter *source_filter;
 };
 
 struct cgit_page {
         time_t modified;
         time_t expires;
         size_t size;
         char *mimetype;
         char *charset;
         char *filename;
         char *etag;
         char *title;
         int status;
         char *statusmsg;
 };
 
 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,
                            unsigned long *old_size, unsigned long *new_size,
                            int *binary, 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);
 
 extern int cgit_open_filter(struct cgit_filter *filter);
 extern int cgit_close_filter(struct cgit_filter *filter);
 
 
 #endif /* CGIT_H */
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index d420ad4..2efd6aa 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -1,153 +1,159 @@
 CGITRC(5)
 ========
 
 
 NAME
 ----
 cgitrc - runtime configuration for cgit
 
 
 SYNOPSIS
 --------
 Cgitrc contains all runtime settings for cgit, including the list of git
 repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank
 lines, and lines starting with '#', are ignored.
 
 
 GLOBAL SETTINGS
 ---------------
 agefile::
         Specifies a path, relative to each repository path, which can be used
         to specify the date and time of the youngest commit in the repository.
         The first line in the file is used as input to the "parse_date"
         function in libgit. Recommended timestamp-format is "yyyy-mm-dd
         hh:mm:ss". Default value: "info/web/last-modified".
 
 cache-root::
         Path used to store the cgit cache entries. Default value:
         "/var/cache/cgit".
 
 cache-dynamic-ttl::
         Number which specifies the time-to-live, in minutes, for the cached
         version of repository pages accessed without a fixed SHA1. Default
         value: "5".
 
 cache-repo-ttl::
         Number which specifies the time-to-live, in minutes, for the cached
         version of the repository summary page. Default value: "5".
 
 cache-root-ttl::
         Number which specifies the time-to-live, in minutes, for the cached
         version of the repository index page. Default value: "5".
 
 cache-size::
         The maximum number of entries in the cgit cache. Default value: "0"
         (i.e. caching is disabled).
 
 cache-static-ttl::
         Number which specifies the time-to-live, in minutes, for the cached
         version of repository pages accessed with a fixed SHA1. Default value:
         "5".
 
 clone-prefix::
         Space-separated list of common prefixes which, when combined with a
         repository url, generates valid clone urls for the repository. This
         setting is only used if `repo.clone-url` is unspecified. Default value:
         none.
 
+commit-filter::
+        Specifies a command which will be invoked to format commit messages.
+        The command will get the message on its STDIN, and the STDOUT from the
+        command will be included verbatim as the commit message, i.e. this can
+        be used to implement bugtracker integration. Default value: none.
+
 css::
         Url which specifies the css document to include in all cgit pages.
         Default value: "/cgit.css".
 
 embedded::
         Flag which, when set to "1", will make cgit generate a html fragment
         suitable for embedding in other html pages. Default value: none. See
         also: "noheader".
         
 enable-index-links::
         Flag which, when set to "1", will make cgit generate extra links for
         each repo in the repository index (specifically, to the "summary",
         "commit" and "tree" pages). Default value: "0".
 
 enable-log-filecount::
         Flag which, when set to "1", will make cgit print the number of
         modified files for each commit on the repository log page. Default
         value: "0".
 
 enable-log-linecount::
         Flag which, when set to "1", will make cgit print the number of added
         and removed lines for each commit on the repository log page. Default
         value: "0".
 
 favicon::
         Url used as link to a shortcut icon for cgit. If specified, it is
         suggested to use the value "/favicon.ico" since certain browsers will
         ignore other values. Default value: none.
 
 footer::
         The content of the file specified with this option will be included
         verbatim at the bottom of all pages (i.e. it replaces the standard
         "generated by..." message. Default value: none.
 
 head-include::
         The content of the file specified with this option will be included
         verbatim in the html HEAD section on all pages. Default value: none.
 
 header::
         The content of the file specified with this option will be included
         verbatim at the top of all pages. Default value: none.
 
 include::
         Name of a configfile to include before the rest of the current config-
         file is parsed. Default value: none.
 
 index-header::
         The content of the file specified with this option will be included
         verbatim above the repository index. This setting is deprecated, and
         will not be supported by cgit-1.0 (use root-readme instead). Default
         value: none.
 
 index-info::
         The content of the file specified with this option will be included
         verbatim below the heading on the repository index page. This setting
         is deprecated, and will not be supported by cgit-1.0 (use root-desc
         instead). Default value: none.
 
 local-time::
         Flag which, if set to "1", makes cgit print commit and tag times in the
         servers timezone. Default value: "0".
 
 logo::
         Url which specifies the source of an image which will be used as a logo
         on all cgit pages.
 
 logo-link::
         Url loaded when clicking on the cgit logo image. If unspecified the
         calculated url of the repository index page will be used. Default
         value: none.
 
 max-commit-count::
         Specifies the number of entries to list per page in "log" view. Default
         value: "50".
 
 max-message-length::
         Specifies the maximum number of commit message characters to display in
         "log" view. Default value: "80".
 
 max-repo-count::
                 Specifies the number of entries to list per page on therepository
         index page. Default value: "50".
 
 max-repodesc-length::
         Specifies the maximum number of repo description characters to display
         on the repository index page. Default value: "80".
 
 max-stats::
         Set the default maximum statistics period. Valid values are "week",
         "month", "quarter" and "year". If unspecified, statistics are
         disabled. Default value: none. See also: "repo.max-stats".
 
 module-link::
         Text which will be used as the formatstring for a hyperlink when a
         submodule is printed in a directory listing. The arguments for the
         formatstring are the path and SHA1 of the submodule commit. Default
diff --git a/ui-commit.c b/ui-commit.c
index 41ce70e..ee0e139 100644
--- a/ui-commit.c
+++ b/ui-commit.c
@@ -1,106 +1,114 @@
 /* ui-commit.c: generate commit view
  *
  * Copyright (C) 2006 Lars Hjemli
  *
  * Licensed under GNU General Public License v2
  *   (see COPYING for full license text)
  */
 
 #include "cgit.h"
 #include "html.h"
 #include "ui-shared.h"
 #include "ui-diff.h"
 #include "ui-log.h"
 
 void cgit_print_commit(char *hex)
 {
         struct commit *commit, *parent;
         struct commitinfo *info;
         struct commit_list *p;
         unsigned char sha1[20];
         char *tmp;
         int parents = 0;
 
         if (!hex)
                 hex = ctx.qry.head;
 
         if (get_sha1(hex, sha1)) {
                 cgit_print_error(fmt("Bad object id: %s", hex));
                 return;
         }
         commit = lookup_commit_reference(sha1);
         if (!commit) {
                 cgit_print_error(fmt("Bad commit reference: %s", hex));
                 return;
         }
         info = cgit_parse_commit(commit);
 
         load_ref_decorations();
 
         html("<table summary='commit info' class='commit-info'>\n");
         html("<tr><th>author</th><td>");
         html_txt(info->author);
         html(" ");
         html_txt(info->author_email);
         html("</td><td class='right'>");
         cgit_print_date(info->author_date, FMT_LONGDATE, ctx.cfg.local_time);
         html("</td></tr>\n");
         html("<tr><th>committer</th><td>");
         html_txt(info->committer);
         html(" ");
         html_txt(info->committer_email);
         html("</td><td class='right'>");
         cgit_print_date(info->committer_date, FMT_LONGDATE, ctx.cfg.local_time);
         html("</td></tr>\n");
         html("<tr><th>commit</th><td colspan='2' class='sha1'>");
         tmp = sha1_to_hex(commit->object.sha1);
         cgit_commit_link(tmp, NULL, NULL, ctx.qry.head, tmp);
         html(" (");
         cgit_patch_link("patch", NULL, NULL, NULL, tmp);
         html(")</td></tr>\n");
         html("<tr><th>tree</th><td colspan='2' class='sha1'>");
         tmp = xstrdup(hex);
         cgit_tree_link(sha1_to_hex(commit->tree->object.sha1), NULL, NULL,
                        ctx.qry.head, tmp, NULL);
         html("</td></tr>\n");
               for (p = commit->parents; p ; p = p->next) {
                 parent = lookup_commit_reference(p->item->object.sha1);
                 if (!parent) {
                         html("<tr><td colspan='3'>");
                         cgit_print_error("Error reading parent commit");
                         html("</td></tr>");
                         continue;
                 }
                 html("<tr><th>parent</th>"
                      "<td colspan='2' class='sha1'>");
                 cgit_commit_link(sha1_to_hex(p->item->object.sha1), NULL, NULL,
                                  ctx.qry.head, sha1_to_hex(p->item->object.sha1));
                 html(" (");
                 cgit_diff_link("diff", NULL, NULL, ctx.qry.head, hex,
                                sha1_to_hex(p->item->object.sha1), NULL);
                 html(")</td></tr>");
                 parents++;
         }
         if (ctx.repo->snapshots) {
                 html("<tr><th>download</th><td colspan='2' class='sha1'>");
                 cgit_print_snapshot_links(ctx.qry.repo, ctx.qry.head,
                                           hex, ctx.repo->snapshots);
                 html("</td></tr>");
         }
         html("</table>\n");
         html("<div class='commit-subject'>");
+        if (ctx.cfg.commit_filter)
+                cgit_open_filter(ctx.cfg.commit_filter);
         html_txt(info->subject);
+        if (ctx.cfg.commit_filter)
+                cgit_close_filter(ctx.cfg.commit_filter);
         show_commit_decorations(commit);
         html("</div>");
         html("<div class='commit-msg'>");
+        if (ctx.cfg.commit_filter)
+                cgit_open_filter(ctx.cfg.commit_filter);
         html_txt(info->msg);
+        if (ctx.cfg.commit_filter)
+                cgit_close_filter(ctx.cfg.commit_filter);
         html("</div>");
         if (parents < 3) {
                 if (parents)
                         tmp = sha1_to_hex(commit->parents->item->object.sha1);
                 else
                         tmp = NULL;
                 cgit_print_diff(ctx.qry.sha1, tmp, NULL);
         }
         cgit_free_commitinfo(info);
 }