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
@@ -45,96 +45,98 @@ void config_cb(const char *name, const char *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);
diff --git a/cgit.h b/cgit.h
index f9cf0df..438301d 100644
--- a/cgit.h
+++ b/cgit.h
@@ -138,96 +138,97 @@ struct cgit_filter {
         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);
 
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index d420ad4..2efd6aa 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -10,96 +10,102 @@ 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
diff --git a/ui-commit.c b/ui-commit.c
index 41ce70e..ee0e139 100644
--- a/ui-commit.c
+++ b/ui-commit.c
@@ -44,63 +44,71 @@ void cgit_print_commit(char *hex)
         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);
 }