Add support for environment variable expansion

This patch teaches cgit to expand environment variables in certain
cgitrc option values (cache_root, scan-path, include) plus when
finding the location of cgitrc itself.

One use case for this feature is virtual hosting - e.g. by setting
$CGIT_CONFIG='/etc/cgitrc/$HTTP_HOST' in httpd.conf, all virtual
hosts automatically gets their own cgitrc.

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

3 files changed, 78 insertions, 5 deletions

diff --git a/cgit.c b/cgit.c
index 9305d0a..37154e3 100644
--- a/cgit.c
+++ b/cgit.c
@@ -119,120 +119,120 @@ void config_cb(const char *name, const char *value)
                 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, "noplainemail"))
                 ctx.cfg.noplainemail = 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-filter-overrides"))
                 ctx.cfg.enable_filter_overrides = atoi(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, "enable-remote-branches"))
                 ctx.cfg.enable_remote_branches = atoi(value);
         else if (!strcmp(name, "enable-tree-linenumbers"))
                 ctx.cfg.enable_tree_linenumbers = 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);
+                ctx.cfg.cache_root = xstrdup(expand_macros(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-scanrc-ttl"))
                 ctx.cfg.cache_scanrc_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, "about-filter"))
                 ctx.cfg.about_filter = new_filter(value, 0);
         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-blob-size"))
                 ctx.cfg.max_blob_size = 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, "scan-path"))
                 if (!ctx.cfg.nocache && ctx.cfg.cache_size)
-                        process_cached_repolist(value);
+                        process_cached_repolist(expand_macros(value));
                 else
-                        scan_tree(value, repo_config);
+                        scan_tree(expand_macros(value), repo_config);
         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, "side-by-side-diffs"))
                 ctx.cfg.ssdiff = 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 (!prefixcmp(name, "mimetype."))
                 add_mimetype(name + 9, value);
         else if (!strcmp(name, "include"))
-                parse_configfile(value, config_cb);
+                parse_configfile(expand_macros(value), config_cb);
 }
 
 static void querystring_cb(const char *name, const char *value)
 {
         if (!value)
                 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")) {
                 if (*value == '/')
                         value++;
                 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);
@@ -659,65 +659,65 @@ static void cgit_parse_args(int argc, const char **argv)
         }
 }
 
 static int calc_ttl()
 {
         if (!ctx.repo)
                 return ctx.cfg.cache_root_ttl;
 
         if (!ctx.qry.page)
                 return ctx.cfg.cache_repo_ttl;
 
         if (ctx.qry.has_symref)
                 return ctx.cfg.cache_dynamic_ttl;
 
         if (ctx.qry.has_sha1)
                 return ctx.cfg.cache_static_ttl;
 
         return ctx.cfg.cache_repo_ttl;
 }
 
 int main(int argc, const char **argv)
 {
         const char *path;
         char *qry;
         int err, ttl;
 
         prepare_context(&ctx);
         cgit_repolist.length = 0;
         cgit_repolist.count = 0;
         cgit_repolist.repos = NULL;
 
         cgit_parse_args(argc, argv);
-        parse_configfile(ctx.env.cgit_config, config_cb);
+        parse_configfile(expand_macros(ctx.env.cgit_config), config_cb);
         ctx.repo = NULL;
         http_parse_querystring(ctx.qry.raw, querystring_cb);
 
         /* If virtual-root isn't specified in cgitrc, lets pretend
          * that virtual-root equals SCRIPT_NAME.
          */
         if (!ctx.cfg.virtual_root)
                 ctx.cfg.virtual_root = ctx.cfg.script_name;
 
         /* If no url parameter is specified on the querystring, lets
          * use PATH_INFO as url. This allows cgit to work with virtual
          * urls without the need for rewriterules in the webserver (as
          * long as PATH_INFO is included in the cache lookup key).
          */
         path = ctx.env.path_info;
         if (!ctx.qry.url && path) {
                 if (path[0] == '/')
                         path++;
                 ctx.qry.url = xstrdup(path);
                 if (ctx.qry.raw) {
                         qry = ctx.qry.raw;
                         ctx.qry.raw = xstrdup(fmt("%s?%s", path, qry));
                         free(qry);
                 } else
                         ctx.qry.raw = xstrdup(ctx.qry.url);
                 cgit_parse_url(ctx.qry.url);
         }
 
         ttl = calc_ttl();
         ctx.page.expires += ttl*60;
         if (ctx.env.request_method && !strcmp(ctx.env.request_method, "HEAD"))
                 ctx.cfg.nocache = 1;
diff --git a/cgit.h b/cgit.h
index cd4af72..568e0c0 100644
--- a/cgit.h
+++ b/cgit.h
@@ -267,33 +267,35 @@ 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);
 
 extern int readfile(const char *path, char **buf, size_t *size);
 
+extern char *expand_macros(const char *txt);
+
 #endif /* CGIT_H */
diff --git a/shared.c b/shared.c
index 5f46793..76d26dd 100644
--- a/shared.c
+++ b/shared.c
@@ -394,32 +394,103 @@ int cgit_close_filter(struct cgit_filter *filter)
         if (WIFEXITED(filter->exitstatus) && !WEXITSTATUS(filter->exitstatus))
                 return 0;
         die("Subprocess %s exited abnormally", filter->cmd);
 }
 
 /* Read the content of the specified file into a newly allocated buffer,
  * zeroterminate the buffer and return 0 on success, errno otherwise.
  */
 int readfile(const char *path, char **buf, size_t *size)
 {
         int fd, e;
         struct stat st;
 
         fd = open(path, O_RDONLY);
         if (fd == -1)
                 return errno;
         if (fstat(fd, &st)) {
                 e = errno;
                 close(fd);
                 return e;
         }
         if (!S_ISREG(st.st_mode)) {
                 close(fd);
                 return EISDIR;
         }
         *buf = xmalloc(st.st_size + 1);
         *size = read_in_full(fd, *buf, st.st_size);
         e = errno;
         (*buf)[*size] = '\0';
         close(fd);
         return (*size == st.st_size ? 0 : e);
 }
+
+int is_token_char(char c)
+{
+        return isalnum(c) || c == '_';
+}
+
+/* Replace name with getenv(name), return pointer to zero-terminating char
+ */
+char *expand_macro(char *name, int maxlength)
+{
+        char *value;
+        int len;
+
+        len = 0;
+        value = getenv(name);
+        if (value) {
+                len = strlen(value);
+                if (len > maxlength)
+                        len = maxlength;
+                strncpy(name, value, len);
+        }
+        return name + len;
+}
+
+#define EXPBUFSIZE (1024 * 8)
+
+/* Replace all tokens prefixed by '$' in the specified text with the
+ * value of the named environment variable.
+ * NB: the return value is a static buffer, i.e. it must be strdup'd
+ * by the caller.
+ */
+char *expand_macros(const char *txt)
+{
+        static char result[EXPBUFSIZE];
+        char *p, *start;
+        int len;
+
+        p = result;
+        start = NULL;
+        while (p < result + EXPBUFSIZE - 1 && txt && *txt) {
+                *p = *txt;
+                if (start) {
+                        if (!is_token_char(*txt)) {
+                                if (p - start > 0) {
+                                        *p = '\0';
+                                        len = result + EXPBUFSIZE - start - 1;
+                                        p = expand_macro(start, len) - 1;
+                                }
+                                start = NULL;
+                                txt--;
+                        }
+                        p++;
+                        txt++;
+                        continue;
+                }
+                if (*txt == '$') {
+                        start = p;
+                        txt++;
+                        continue;
+                }
+                p++;
+                txt++;
+        }
+        *p = '\0';
+        if (start && p - start > 0) {
+                len = result + EXPBUFSIZE - start - 1;
+                p = expand_macro(start, len);
+                *p = '\0';
+        }
+        return result;
+}