Add support for "readme" option

The value of this option is used as the default value for repo.readme.

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

6 files changed, 43 insertions, 24 deletions

diff --git a/cgit.c b/cgit.c
index d6146e2..04cef23 100644
--- a/cgit.c
+++ b/cgit.c
@@ -69,17 +69,13 @@ void repo_config(struct cgit_repo *repo, const char *name, const char *value)
                 repo->max_stats = cgit_find_stats_period(value, NULL);
         else if (!strcmp(name, "module-link"))
                 repo->module_link= xstrdup(value);
         else if (!strcmp(name, "section"))
                 repo->section = xstrdup(value);
         else if (!strcmp(name, "readme") && value != NULL) {
-                char *colon;
-                if (*value == '/' || ((colon = strchr(value, ':')) != NULL && colon != value && *(colon + 1) != '\0'))
-                        repo->readme = xstrdup(value);
-                else
-                        repo->readme = xstrdup(fmt("%s/%s", repo->path, value));
+                repo->readme = xstrdup(value);
         } else if (ctx.cfg.enable_filter_overrides) {
                 if (!strcmp(name, "about-filter"))
                         repo->about_filter = new_filter(value, 0);
                 else if (!strcmp(name, "commit-filter"))
                         repo->commit_filter = new_filter(value, 0);
                 else if (!strcmp(name, "source-filter"))
@@ -94,12 +90,14 @@ void config_cb(const char *name, const char *value)
         else if (!strcmp(name, "repo.url"))
                 ctx.repo = cgit_add_repo(value);
         else if (ctx.repo && !strcmp(name, "repo.path"))
                 ctx.repo->path = trim_end(value, '/');
         else if (ctx.repo && !prefixcmp(name, "repo."))
                 repo_config(ctx.repo, name + 5, value);
+        else if (!strcmp(name, "readme"))
+                ctx.cfg.readme = xstrdup(value);
         else 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);
diff --git a/cgit.h b/cgit.h
index 4090cd4..72fb1c7 100644
--- a/cgit.h
+++ b/cgit.h
@@ -165,12 +165,13 @@ struct cgit_config {
         char *index_header;
         char *index_info;
         char *logo;
         char *logo_link;
         char *module_link;
         char *project_list;
+        char *readme;
         char *robots;
         char *root_title;
         char *root_desc;
         char *root_readme;
         char *script_name;
         char *section;
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index c643fae..187031a 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -231,12 +231,16 @@ noheader::
 
 project-list::
         A list of subdirectories inside of scan-path, relative to it, that
         should loaded as git repositories. This must be defined prior to
         scan-path. Default value: none. See also: scan-path.
 
+readme::
+        Text which will be used as default value for "repo.readme". Default
+        value: none.
+
 remove-suffix::
         If set to "1" and scan-path is enabled, if any repositories are found
         with a suffix of ".git", this suffix will be removed for the url and
         name. Default value: "0". See also: scan-path.
 
 renamelimit::
@@ -370,13 +374,13 @@ repo.path::
         this is the .git-directory. Default value: none.
 
 repo.readme::
         A path (relative to <repo.path>) which specifies a file to include
         verbatim as the "About" page for this repo. You may also specify a
         git refspec by head or by hash by prepending the refspec followed by
-        a colon. For example, "master:docs/readme.mkd" Default value: none.
+        a colon. For example, "master:docs/readme.mkd" Default value: <readme>.
 
 repo.snapshots::
         A mask of allowed snapshot-formats for this repo, restricted by the
         "snapshots" global setting. Default value: <snapshots>.
 
 repo.section::
diff --git a/scan-tree.c b/scan-tree.c
index e987824..780d405 100644
--- a/scan-tree.c
+++ b/scan-tree.c
@@ -107,15 +107,17 @@ static void add_repo(const char *base, const char *path, repo_config_fn fn)
         repo->owner = owner;
 
         p = fmt("%s/description", path);
         if (!stat(p, &st))
                 readfile(p, &repo->desc, &size);
 
-        p = fmt("%s/README.html", path);
-        if (!stat(p, &st))
-                repo->readme = "README.html";
+        if (!repo->readme) {
+                p = fmt("%s/README.html", path);
+                if (!stat(p, &st))
+                        repo->readme = "README.html";
+        }
 
         p = fmt("%s/cgitrc", path);
         if (!stat(p, &st)) {
                 config_fn = fn;
                 parse_configfile(xstrdup(p), &repo_config);
         }
diff --git a/shared.c b/shared.c
index b42c2a2..72ac140 100644
--- a/shared.c
+++ b/shared.c
@@ -59,13 +59,13 @@ struct cgit_repo *cgit_add_repo(const char *url)
         ret->enable_log_filecount = ctx.cfg.enable_log_filecount;
         ret->enable_log_linecount = ctx.cfg.enable_log_linecount;
         ret->enable_remote_branches = ctx.cfg.enable_remote_branches;
         ret->enable_subject_links = ctx.cfg.enable_subject_links;
         ret->max_stats = ctx.cfg.max_stats;
         ret->module_link = ctx.cfg.module_link;
-        ret->readme = NULL;
+        ret->readme = ctx.cfg.readme;
         ret->mtime = -1;
         ret->about_filter = ctx.cfg.about_filter;
         ret->commit_filter = ctx.cfg.commit_filter;
         ret->source_filter = ctx.cfg.source_filter;
         return ret;
 }
diff --git a/ui-summary.c b/ui-summary.c
index 02f191e..b203bcc 100644
--- a/ui-summary.c
+++ b/ui-summary.c
@@ -67,39 +67,53 @@ void cgit_print_summary()
                 print_urls(ctx.cfg.clone_prefix, ctx.repo->url);
         html("</table>");
 }
 
 void cgit_print_repo_readme(char *path)
 {
-        char *slash, *tmp, *colon, *ref = 0;
+        char *slash, *tmp, *colon, *ref;
 
-        if (!ctx.repo->readme)
+        if (!ctx.repo->readme || !(*ctx.repo->readme))
                 return;
 
+        ref = NULL;
+
+        /* Check if the readme is tracked in the git repo. */
+        colon = strchr(ctx.repo->readme, ':');
+        if (colon && strlen(colon) > 1) {
+                *colon = '\0';
+                ref = ctx.repo->readme;
+                ctx.repo->readme = colon + 1;
+                if (!(*ctx.repo->readme))
+                        return;
+        }
+
+        /* Prepend repo path to relative readme path unless tracked. */
+        if (!ref && *ctx.repo->readme != '/')
+                ctx.repo->readme = xstrdup(fmt("%s/%s", ctx.repo->path,
+                                               ctx.repo->readme));
+
+        /* If a subpath is specified for the about page, make it relative
+         * to the directory containing the configured readme.
+         */
         if (path) {
                 slash = strrchr(ctx.repo->readme, '/');
                 if (!slash) {
-                        slash = strchr(ctx.repo->readme, ':');
-                        if (!slash)
+                        if (!colon)
                                 return;
+                        slash = colon;
                 }
                 tmp = xmalloc(slash - ctx.repo->readme + 1 + strlen(path) + 1);
                 strncpy(tmp, ctx.repo->readme, slash - ctx.repo->readme + 1);
                 strcpy(tmp + (slash - ctx.repo->readme + 1), path);
         } else
                 tmp = ctx.repo->readme;
-        colon = strchr(tmp, ':');
-        if (colon && strlen(colon) > 1) {
-                *colon = '\0';
-                ref = tmp;
-                tmp = colon + 1;
-                while ((*tmp == '/' || *tmp == ':') && *tmp != '\0')
-                        ++tmp;
-                if (!(*tmp))
-                        return;
-        }
+
+        /* Print the calculated readme, either from the git repo or from the
+         * filesystem, while applying the about-filter.
+         */
         html("<div id='summary'>");
         if (ctx.repo->about_filter)
                 cgit_open_filter(ctx.repo->about_filter);
         if (ref)
                 cgit_print_file(tmp, ref);
         else