]> git.cameronkatri.com Git - cgit.git/blobdiff - cgit.c
readme: Accept multiple candidates and test them.
[cgit.git] / cgit.c
diff --git a/cgit.c b/cgit.c
index 2ccf8646a5e5867632b5dcf6b2e15cbacd16f9f1..f738b83acd4d442327cc3d721ac367b4d5666f29 100644 (file)
--- a/cgit.c
+++ b/cgit.c
 #include "html.h"
 #include "ui-shared.h"
 #include "ui-stats.h"
+#include "ui-blob.h"
+#include "ui-summary.h"
 #include "scan-tree.h"
 
 const char *cgit_version = CGIT_VERSION;
 
-void add_mimetype(const char *name, const char *value)
+static void add_mimetype(const char *name, const char *value)
 {
        struct string_list_item *item;
 
@@ -26,7 +28,7 @@ void add_mimetype(const char *name, const char *value)
        item->util = xstrdup(value);
 }
 
-struct cgit_filter *new_filter(const char *cmd, filter_type filtertype)
+static struct cgit_filter *new_filter(const char *cmd, filter_type filtertype)
 {
        struct cgit_filter *f;
        int args_size = 0;
@@ -37,10 +39,10 @@ struct cgit_filter *new_filter(const char *cmd, filter_type filtertype)
 
        switch (filtertype) {
                case SOURCE:
+               case ABOUT:
                        extra_args = 1;
                        break;
 
-               case ABOUT:
                case COMMIT:
                default:
                        extra_args = 0;
@@ -58,7 +60,7 @@ struct cgit_filter *new_filter(const char *cmd, filter_type filtertype)
 
 static void process_cached_repolist(const char *path);
 
-void repo_config(struct cgit_repo *repo, const char *name, const char *value)
+static void repo_config(struct cgit_repo *repo, const char *name, const char *value)
 {
        struct string_list_item *item;
 
@@ -84,7 +86,12 @@ void repo_config(struct cgit_repo *repo, const char *name, const char *value)
                repo->enable_remote_branches = atoi(value);
        else if (!strcmp(name, "enable-subject-links"))
                repo->enable_subject_links = atoi(value);
-       else if (!strcmp(name, "commit-sort")) {
+       else if (!strcmp(name, "branch-sort")) {
+               if (!strcmp(value, "age"))
+                       repo->branch_sort = 1;
+               if (!strcmp(value, "name"))
+                       repo->branch_sort = 0;
+       } else if (!strcmp(name, "commit-sort")) {
                if (!strcmp(value, "date"))
                        repo->commit_sort = 1;
                if (!strcmp(value, "topo"))
@@ -114,7 +121,7 @@ void repo_config(struct cgit_repo *repo, const char *name, const char *value)
        }
 }
 
-void config_cb(const char *name, const char *value)
+static void config_cb(const char *name, const char *value)
 {
        if (!strcmp(name, "section") || !strcmp(name, "repo.group"))
                ctx.cfg.section = xstrdup(value);
@@ -155,9 +162,7 @@ void config_cb(const char *name, const char *value)
        else if (!strcmp(name, "strict-export"))
                ctx.cfg.strict_export = 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 = "";
+               ctx.cfg.virtual_root = ensure_end(value, '/');
        } else if (!strcmp(name, "nocache"))
                ctx.cfg.nocache = atoi(value);
        else if (!strcmp(name, "noplainemail"))
@@ -273,6 +278,11 @@ void config_cb(const char *name, const char *value)
                        ctx.cfg.commit_sort = 1;
                if (!strcmp(value, "topo"))
                        ctx.cfg.commit_sort = 2;
+       } else if (!strcmp(name, "branch-sort")) {
+               if (!strcmp(value, "age"))
+                       ctx.cfg.branch_sort = 1;
+               if (!strcmp(value, "name"))
+                       ctx.cfg.branch_sort = 0;
        } else if (!prefixcmp(name, "mimetype."))
                add_mimetype(name + 9, value);
        else if (!strcmp(name, "include"))
@@ -333,11 +343,6 @@ static void querystring_cb(const char *name, const char *value)
        }
 }
 
-char *xstrdupn(const char *str)
-{
-       return (str ? xstrdup(str) : NULL);
-}
-
 static void prepare_context(struct cgit_context *ctx)
 {
        memset(ctx, 0, sizeof(*ctx));
@@ -352,6 +357,8 @@ static void prepare_context(struct cgit_context *ctx)
        ctx->cfg.cache_scanrc_ttl = 15;
        ctx->cfg.cache_static_ttl = -1;
        ctx->cfg.case_sensitive_sort = 1;
+       ctx->cfg.branch_sort = 0;
+       ctx->cfg.commit_sort = 0;
        ctx->cfg.css = "/cgit.css";
        ctx->cfg.logo = "/cgit.png";
        ctx->cfg.local_time = 0;
@@ -382,16 +389,16 @@ static void prepare_context(struct cgit_context *ctx)
        ctx->cfg.summary_tags = 10;
        ctx->cfg.max_atom_items = 10;
        ctx->cfg.ssdiff = 0;
-       ctx->env.cgit_config = xstrdupn(getenv("CGIT_CONFIG"));
-       ctx->env.http_host = xstrdupn(getenv("HTTP_HOST"));
-       ctx->env.https = xstrdupn(getenv("HTTPS"));
-       ctx->env.no_http = xstrdupn(getenv("NO_HTTP"));
-       ctx->env.path_info = xstrdupn(getenv("PATH_INFO"));
-       ctx->env.query_string = xstrdupn(getenv("QUERY_STRING"));
-       ctx->env.request_method = xstrdupn(getenv("REQUEST_METHOD"));
-       ctx->env.script_name = xstrdupn(getenv("SCRIPT_NAME"));
-       ctx->env.server_name = xstrdupn(getenv("SERVER_NAME"));
-       ctx->env.server_port = xstrdupn(getenv("SERVER_PORT"));
+       ctx->env.cgit_config = getenv("CGIT_CONFIG");
+       ctx->env.http_host = getenv("HTTP_HOST");
+       ctx->env.https = getenv("HTTPS");
+       ctx->env.no_http = getenv("NO_HTTP");
+       ctx->env.path_info = getenv("PATH_INFO");
+       ctx->env.query_string = getenv("QUERY_STRING");
+       ctx->env.request_method = getenv("REQUEST_METHOD");
+       ctx->env.script_name = getenv("SCRIPT_NAME");
+       ctx->env.server_name = getenv("SERVER_NAME");
+       ctx->env.server_port = getenv("SERVER_PORT");
        ctx->page.mimetype = "text/html";
        ctx->page.charset = PAGE_ENCODING;
        ctx->page.filename = NULL;
@@ -401,9 +408,9 @@ static void prepare_context(struct cgit_context *ctx)
        ctx->page.etag = NULL;
        memset(&ctx->cfg.mimetypes, 0, sizeof(struct string_list));
        if (ctx->env.script_name)
-               ctx->cfg.script_name = ctx->env.script_name;
+               ctx->cfg.script_name = xstrdup(ctx->env.script_name);
        if (ctx->env.query_string)
-               ctx->qry.raw = ctx->env.query_string;
+               ctx->qry.raw = xstrdup(ctx->env.query_string);
        if (!ctx->env.cgit_config)
                ctx->env.cgit_config = CGIT_CONFIG;
 }
@@ -414,8 +421,8 @@ struct refmatch {
        int match;
 };
 
-int find_current_ref(const char *refname, const unsigned char *sha1,
-                    int flags, void *cb_data)
+static int find_current_ref(const char *refname, const unsigned char *sha1,
+                           int flags, void *cb_data)
 {
        struct refmatch *info;
 
@@ -427,7 +434,13 @@ int find_current_ref(const char *refname, const unsigned char *sha1,
        return info->match;
 }
 
-char *find_default_branch(struct cgit_repo *repo)
+static void free_refmatch_inner(struct refmatch *info)
+{
+       if (info->first_ref)
+               free(info->first_ref);
+}
+
+static char *find_default_branch(struct cgit_repo *repo)
 {
        struct refmatch info;
        char *ref;
@@ -442,6 +455,8 @@ char *find_default_branch(struct cgit_repo *repo)
                ref = info.first_ref;
        if (ref)
                ref = xstrdup(ref);
+       free_refmatch_inner(&info);
+
        return ref;
 }
 
@@ -456,31 +471,74 @@ static char *guess_defbranch(void)
        return xstrdup(ref + 11);
 }
 
+static void choose_readme(struct cgit_repo *repo)
+{
+       char *entry, *filename, *ref;
+
+       /* If there's no space, we skip the possibly expensive
+        * selection process. */
+       if (!repo->readme || !strchr(repo->readme, ' '))
+               return;
+
+       for (entry = strtok(repo->readme, " "); entry; entry = strtok(NULL, " ")) {
+               cgit_parse_readme(entry, NULL, &filename, &ref, repo);
+               if (!(*filename)) {
+                       free(filename);
+                       free(ref);
+                       continue;
+               }
+               if (*ref && cgit_ref_path_exists(filename, ref)) {
+                       free(filename);
+                       free(ref);
+                       break;
+               }
+               if (!access(filename, R_OK)) {
+                       free(filename);
+                       free(ref);
+                       break;
+               }
+               free(filename);
+               free(ref);
+       }
+       repo->readme = entry;
+}
+
 static int prepare_repo_cmd(struct cgit_context *ctx)
 {
-       char *tmp;
        unsigned char sha1[20];
        int nongit = 0;
        int rc;
 
+       /* The path to the git repository. */
        setenv("GIT_DIR", ctx->repo->path, 1);
+
+       /* Do not look in /etc/ for gitconfig and gitattributes. */
+       setenv("GIT_CONFIG_NOSYSTEM", "1", 1);
+       setenv("GIT_ATTR_NOSYSTEM", "1", 1);
+       unsetenv("HOME");
+       unsetenv("XDG_CONFIG_HOME");
+
+       /* Setup the git directory and initialize the notes system. Both of these
+        * load local configuration from the git repository, so we do them both while
+        * the HOME variables are unset. */
        setup_git_directory_gently(&nongit);
+       init_display_notes(NULL);
+
        if (nongit) {
+               const char *name = ctx->repo->name;
                rc = errno;
-               ctx->page.title = fmt("%s - %s", ctx->cfg.root_title,
-                                     "config error");
-               tmp = fmt("Failed to open %s: %s",
-                         ctx->repo->name,
-                         rc ? strerror(rc) : "Not a valid git repository");
+               ctx->page.title = fmtalloc("%s - %s", ctx->cfg.root_title,
+                                               "config error");
                ctx->repo = NULL;
                cgit_print_http_headers(ctx);
                cgit_print_docstart(ctx);
                cgit_print_pageheader(ctx);
-               cgit_print_error(tmp);
+               cgit_print_error("Failed to open %s: %s", name,
+                                rc ? strerror(rc) : "Not a valid git repository");
                cgit_print_docend();
                return 1;
        }
-       ctx->page.title = fmt("%s - %s", ctx->repo->name, ctx->repo->desc);
+       ctx->page.title = fmtalloc("%s - %s", ctx->repo->name, ctx->repo->desc);
 
        if (!ctx->repo->defbranch)
                ctx->repo->defbranch = guess_defbranch();
@@ -500,19 +558,20 @@ static int prepare_repo_cmd(struct cgit_context *ctx)
        }
 
        if (get_sha1(ctx->qry.head, sha1)) {
-               tmp = xstrdup(ctx->qry.head);
+               char *tmp = xstrdup(ctx->qry.head);
                ctx->qry.head = ctx->repo->defbranch;
                ctx->page.status = 404;
                ctx->page.statusmsg = "Not found";
                cgit_print_http_headers(ctx);
                cgit_print_docstart(ctx);
                cgit_print_pageheader(ctx);
-               cgit_print_error(fmt("Invalid branch: %s", tmp));
+               cgit_print_error("Invalid branch: %s", tmp);
                cgit_print_docend();
                return 1;
        }
        sort_string_list(&ctx->repo->submodules);
        cgit_prepare_repo_env(ctx->repo);
+       choose_readme(ctx->repo);
        return 0;
 }
 
@@ -549,7 +608,7 @@ static void process_request(void *cbdata)
                cgit_print_http_headers(ctx);
                cgit_print_docstart(ctx);
                cgit_print_pageheader(ctx);
-               cgit_print_error(fmt("No repository selected"));
+               cgit_print_error("No repository selected");
                cgit_print_docend();
                return;
        }
@@ -569,33 +628,28 @@ static void process_request(void *cbdata)
                cgit_print_docend();
 }
 
-int cmp_repos(const void *a, const void *b)
+static int cmp_repos(const void *a, const void *b)
 {
        const struct cgit_repo *ra = a, *rb = b;
        return strcmp(ra->url, rb->url);
 }
 
-char *build_snapshot_setting(int bitmap)
+static char *build_snapshot_setting(int bitmap)
 {
        const struct cgit_snapshot_format *f;
-       char *result = xstrdup("");
-       char *tmp;
-       int len;
+       struct strbuf result = STRBUF_INIT;
 
        for (f = cgit_snapshot_formats; f->suffix; f++) {
                if (f->bit & bitmap) {
-                       tmp = result;
-                       result = xstrdup(fmt("%s%s ", tmp, f->suffix));
-                       free(tmp);
+                       if (result.len)
+                               strbuf_addch(&result, ' ');
+                       strbuf_addstr(&result, f->suffix);
                }
        }
-       len = strlen(result);
-       if (len)
-               result[len - 1] = '\0';
-       return result;
+       return strbuf_detach(&result, NULL);
 }
 
-char *get_first_line(char *txt)
+static char *get_first_line(char *txt)
 {
        char *t = xstrdup(txt);
        char *p = strchr(t, '\n');
@@ -604,7 +658,7 @@ char *get_first_line(char *txt)
        return t;
 }
 
-void print_repo(FILE *f, struct cgit_repo *repo)
+static void print_repo(FILE *f, struct cgit_repo *repo)
 {
        fprintf(f, "repo.url=%s\n", repo->url);
        fprintf(f, "repo.name=%s\n", repo->name);
@@ -640,16 +694,30 @@ void print_repo(FILE *f, struct cgit_repo *repo)
                fprintf(f, "repo.source-filter=%s\n", repo->source_filter->cmd);
        if (repo->snapshots != ctx.cfg.snapshots) {
                char *tmp = build_snapshot_setting(repo->snapshots);
-               fprintf(f, "repo.snapshots=%s\n", tmp);
+               fprintf(f, "repo.snapshots=%s\n", tmp ? tmp : "");
                free(tmp);
        }
        if (repo->max_stats != ctx.cfg.max_stats)
                fprintf(f, "repo.max-stats=%s\n",
                        cgit_find_stats_periodname(repo->max_stats));
+       if (repo->logo)
+               fprintf(f, "repo.logo=%s\n", repo->logo);
+       if (repo->logo_link)
+               fprintf(f, "repo.logo-link=%s\n", repo->logo_link);
+       fprintf(f, "repo.enable-remote-branches=%d\n", repo->enable_remote_branches);
+       fprintf(f, "repo.enable-subject-links=%d\n", repo->enable_subject_links);
+       if (repo->branch_sort == 1)
+               fprintf(f, "repo.branch-sort=age\n");
+       if (repo->commit_sort) {
+               if (repo->commit_sort == 1)
+                       fprintf(f, "repo.commit-sort=date\n");
+               else if (repo->commit_sort == 2)
+                       fprintf(f, "repo.commit-sort=topo\n");
+       }
        fprintf(f, "\n");
 }
 
-void print_repolist(FILE *f, struct cgit_repolist *list, int start)
+static void print_repolist(FILE *f, struct cgit_repolist *list, int start)
 {
        int i;
 
@@ -662,20 +730,22 @@ void print_repolist(FILE *f, struct cgit_repolist *list, int start)
  */
 static int generate_cached_repolist(const char *path, const char *cached_rc)
 {
-       char *locked_rc;
+       struct strbuf locked_rc = STRBUF_INIT;
+       int result = 0;
        int idx;
        FILE *f;
 
-       locked_rc = xstrdup(fmt("%s.lock", cached_rc));
-       f = fopen(locked_rc, "wx");
+       strbuf_addf(&locked_rc, "%s.lock", cached_rc);
+       f = fopen(locked_rc.buf, "wx");
        if (!f) {
                /* Inform about the error unless the lockfile already existed,
                 * since that only means we've got concurrent requests.
                 */
-               if (errno != EEXIST)
+               result = errno;
+               if (result != EEXIST)
                        fprintf(stderr, "[cgit] Error opening %s: %s (%d)\n",
-                               locked_rc, strerror(errno), errno);
-               return errno;
+                               locked_rc.buf, strerror(result), result);
+               goto out;
        }
        idx = cgit_repolist.count;
        if (ctx.cfg.project_list)
@@ -683,55 +753,59 @@ static int generate_cached_repolist(const char *path, const char *cached_rc)
        else
                scan_tree(path, repo_config);
        print_repolist(f, &cgit_repolist, idx);
-       if (rename(locked_rc, cached_rc))
+       if (rename(locked_rc.buf, cached_rc))
                fprintf(stderr, "[cgit] Error renaming %s to %s: %s (%d)\n",
-                       locked_rc, cached_rc, strerror(errno), errno);
+                       locked_rc.buf, cached_rc, strerror(errno), errno);
        fclose(f);
-       return 0;
+out:
+       strbuf_release(&locked_rc);
+       return result;
 }
 
 static void process_cached_repolist(const char *path)
 {
        struct stat st;
-       char *cached_rc;
+       struct strbuf cached_rc = STRBUF_INIT;
        time_t age;
        unsigned long hash;
 
        hash = hash_str(path);
        if (ctx.cfg.project_list)
                hash += hash_str(ctx.cfg.project_list);
-       cached_rc = xstrdup(fmt("%s/rc-%8lx", ctx.cfg.cache_root, hash));
+       strbuf_addf(&cached_rc, "%s/rc-%8lx", ctx.cfg.cache_root, hash);
 
-       if (stat(cached_rc, &st)) {
+       if (stat(cached_rc.buf, &st)) {
                /* Nothing is cached, we need to scan without forking. And
                 * if we fail to generate a cached repolist, we need to
                 * invoke scan_tree manually.
                 */
-               if (generate_cached_repolist(path, cached_rc)) {
+               if (generate_cached_repolist(path, cached_rc.buf)) {
                        if (ctx.cfg.project_list)
                                scan_projects(path, ctx.cfg.project_list,
                                              repo_config);
                        else
                                scan_tree(path, repo_config);
                }
-               return;
+               goto out;
        }
 
-       parse_configfile(cached_rc, config_cb);
+       parse_configfile(cached_rc.buf, config_cb);
 
        /* If the cached configfile hasn't expired, lets exit now */
        age = time(NULL) - st.st_mtime;
        if (age <= (ctx.cfg.cache_scanrc_ttl * 60))
-               return;
+               goto out;
 
        /* The cached repolist has been parsed, but it was old. So lets
         * rescan the specified path and generate a new cached repolist
         * in a child-process to avoid latency for the current request.
         */
        if (fork())
-               return;
+               goto out;
 
-       exit(generate_cached_repolist(path, cached_rc));
+       exit(generate_cached_repolist(path, cached_rc.buf));
+out:
+       strbuf_release(&cached_rc);
 }
 
 static void cgit_parse_args(int argc, const char **argv)
@@ -813,7 +887,6 @@ static int calc_ttl()
 int main(int argc, const char **argv)
 {
        const char *path;
-       char *qry;
        int err, ttl;
 
        prepare_context(&ctx);
@@ -830,11 +903,8 @@ int main(int argc, const char **argv)
         * that virtual-root equals SCRIPT_NAME, minus any possibly
         * trailing slashes.
         */
-       if (!ctx.cfg.virtual_root && ctx.cfg.script_name) {
-               ctx.cfg.virtual_root = trim_end(ctx.cfg.script_name, '/');
-               if (!ctx.cfg.virtual_root)
-                       ctx.cfg.virtual_root = "";
-       }
+       if (!ctx.cfg.virtual_root && ctx.cfg.script_name)
+               ctx.cfg.virtual_root = ensure_end(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
@@ -847,9 +917,9 @@ int main(int argc, const char **argv)
                        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);
+                       char *newqry = fmtalloc("%s?%s", path, ctx.qry.raw);
+                       free(ctx.qry.raw);
+                       ctx.qry.raw = newqry;
                } else
                        ctx.qry.raw = xstrdup(ctx.qry.url);
                cgit_parse_url(ctx.qry.url);
@@ -864,7 +934,7 @@ int main(int argc, const char **argv)
        err = cache_process(ctx.cfg.cache_size, ctx.cfg.cache_root,
                            ctx.qry.raw, ttl, process_request, &ctx);
        if (err)
-               cgit_print_error(fmt("Error processing page: %s (%d)",
-                                    strerror(err), err));
+               cgit_print_error("Error processing page: %s (%d)",
+                                strerror(err), err);
        return err;
 }