Add generic filter/plugin infrastructure

The functions cgit_open_filter() and cgit_close_filter() can be used to
execute filters on the output stream from cgit.

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

3 files changed, 62 insertions, 0 deletions

diff --git a/cgit.c b/cgit.c
index 2039ab1..779a464 100644
--- a/cgit.c
+++ b/cgit.c
@@ -1,51 +1,66 @@
 /* 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 = "";
diff --git a/cgit.h b/cgit.h
index 8c64efe..d0fff1f 100644
--- a/cgit.h
+++ b/cgit.h
@@ -100,64 +100,73 @@ struct refinfo {
                 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;
@@ -219,34 +228,37 @@ 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/shared.c b/shared.c
index cce0af4..288cfa2 100644
--- a/shared.c
+++ b/shared.c
@@ -326,32 +326,67 @@ void cgit_diff_commit(struct commit *commit, filepair_fn fn)
 
         if (commit->parents)
                 old_sha1 = commit->parents->item->object.sha1;
         cgit_diff_tree(old_sha1, commit->object.sha1, fn, NULL);
 }
 
 int cgit_parse_snapshots_mask(const char *str)
 {
         const struct cgit_snapshot_format *f;
         static const char *delim = " \t,:/|;";
         int tl, sl, rv = 0;
 
         /* favor legacy setting */
         if(atoi(str))
                 return 1;
         for(;;) {
                 str += strspn(str,delim);
                 tl = strcspn(str,delim);
                 if (!tl)
                         break;
                 for (f = cgit_snapshot_formats; f->suffix; f++) {
                         sl = strlen(f->suffix);
                         if((tl == sl && !strncmp(f->suffix, str, tl)) ||
                            (tl == sl-1 && !strncmp(f->suffix+1, str, tl-1))) {
                                 rv |= f->bit;
                                 break;
                         }
                 }
                 str += tl;
         }
         return rv;
 }
+
+int cgit_open_filter(struct cgit_filter *filter)
+{
+
+        filter->old_stdout = chk_positive(dup(STDOUT_FILENO),
+                "Unable to duplicate STDOUT");
+        chk_zero(pipe(filter->pipe_fh), "Unable to create pipe to subprocess");
+        filter->pid = chk_non_negative(fork(), "Unable to create subprocess");
+        if (filter->pid == 0) {
+                close(filter->pipe_fh[1]);
+                chk_non_negative(dup2(filter->pipe_fh[0], STDIN_FILENO),
+                        "Unable to use pipe as STDIN");
+                execvp(filter->cmd, filter->argv);
+                die("Unable to exec subprocess %s: %s (%d)", filter->cmd,
+                        strerror(errno), errno);
+        }
+        close(filter->pipe_fh[0]);
+        chk_non_negative(dup2(filter->pipe_fh[1], STDOUT_FILENO),
+                "Unable to use pipe as STDOUT");
+        close(filter->pipe_fh[1]);
+        return 0;
+}
+
+int cgit_close_filter(struct cgit_filter *filter)
+{
+        chk_non_negative(dup2(filter->old_stdout, STDOUT_FILENO),
+                "Unable to restore STDOUT");
+        close(filter->old_stdout);
+        if (filter->pid < 0)
+                return 0;
+        waitpid(filter->pid, &filter->exitstatus, 0);
+        if (WIFEXITED(filter->exitstatus) && !WEXITSTATUS(filter->exitstatus))
+                return 0;
+        die("Subprocess %s exited abnormally", filter->cmd);
+}