]> git.cameronkatri.com Git - cgit.git/blobdiff - cgit.c
cache: document negative ttls and add about ttl
[cgit.git] / cgit.c
diff --git a/cgit.c b/cgit.c
index f73c7b0b6c7b76d3aa231fe75edfc2ac6acd4745..a45ce1ff7de5a88af2dc287c918099a5cd62d53f 100644 (file)
--- a/cgit.c
+++ b/cgit.c
@@ -1,7 +1,7 @@
 /* cgit.c: cgi for the git scm
  *
  * Copyright (C) 2006 Lars Hjemli
- * Copyright (C) 2010, 2012 Jason A. Donenfeld <Jason@zx2c4.com>
+ * Copyright (C) 2010-2013 Jason A. Donenfeld <Jason@zx2c4.com>
  *
  * Licensed under GNU General Public License v2
  *   (see COPYING for full license text)
@@ -14,6 +14,8 @@
 #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;
@@ -37,10 +39,10 @@ static 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;
@@ -84,7 +86,12 @@ static void repo_config(struct cgit_repo *repo, const char *name, const char *va
                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"))
@@ -94,13 +101,15 @@ static void repo_config(struct cgit_repo *repo, const char *name, const char *va
        else if (!strcmp(name, "module-link"))
                repo->module_link= xstrdup(value);
        else if (!prefixcmp(name, "module-link.")) {
-               item = string_list_append(&repo->submodules, name + 12);
+               item = string_list_append(&repo->submodules, xstrdup(name + 12));
                item->util = xstrdup(value);
        } else if (!strcmp(name, "section"))
                repo->section = xstrdup(value);
-       else if (!strcmp(name, "readme") && value != NULL)
-               repo->readme = xstrdup(value);
-       else if (!strcmp(name, "logo") && value != NULL)
+       else if (!strcmp(name, "readme") && value != NULL) {
+               if (repo->readme.items == ctx.cfg.readme.items)
+                       memset(&repo->readme, 0, sizeof(repo->readme));
+               string_list_append(&repo->readme, xstrdup(value));
+       } else if (!strcmp(name, "logo") && value != NULL)
                repo->logo = xstrdup(value);
        else if (!strcmp(name, "logo-link") && value != NULL)
                repo->logo_link = xstrdup(value);
@@ -124,8 +133,8 @@ static void config_cb(const char *name, const char *value)
                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, "readme") && value != NULL)
+               string_list_append(&ctx.cfg.readme, xstrdup(value));
        else if (!strcmp(name, "root-title"))
                ctx.cfg.root_title = xstrdup(value);
        else if (!strcmp(name, "root-desc"))
@@ -202,6 +211,8 @@ static void config_cb(const char *name, const char *value)
                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, "cache-about-ttl"))
+               ctx.cfg.cache_about_ttl = atoi(value);
        else if (!strcmp(name, "case-sensitive-sort"))
                ctx.cfg.case_sensitive_sort = atoi(value);
        else if (!strcmp(name, "about-filter"))
@@ -271,6 +282,11 @@ static 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"))
@@ -337,16 +353,20 @@ static void prepare_context(struct cgit_context *ctx)
        ctx->cfg.agefile = "info/web/last-modified";
        ctx->cfg.nocache = 0;
        ctx->cfg.cache_size = 0;
-       ctx->cfg.cache_dynamic_ttl = 5;
        ctx->cfg.cache_max_create_time = 5;
-       ctx->cfg.cache_repo_ttl = 5;
        ctx->cfg.cache_root = CGIT_CACHE_ROOT;
+       ctx->cfg.cache_about_ttl = 15;
+       ctx->cfg.cache_repo_ttl = 5;
        ctx->cfg.cache_root_ttl = 5;
        ctx->cfg.cache_scanrc_ttl = 15;
+       ctx->cfg.cache_dynamic_ttl = 5;
        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.favicon = "/favicon.ico";
        ctx->cfg.local_time = 0;
        ctx->cfg.enable_http_clone = 1;
        ctx->cfg.enable_index_owner = 1;
@@ -456,6 +476,77 @@ static char *guess_defbranch(void)
                return "master";
        return xstrdup(ref + 11);
 }
+/* The caller must free filename and ref after calling this. */
+static inline void parse_readme(const char *readme, char **filename, char **ref, struct cgit_repo *repo)
+{
+       const char *colon;
+
+       *filename = NULL;
+       *ref = NULL;
+
+       if (!readme || !readme[0])
+               return;
+
+       /* Check if the readme is tracked in the git repo. */
+       colon = strchr(readme, ':');
+       if (colon && strlen(colon) > 1) {
+               /* If it starts with a colon, we want to use
+                * the default branch */
+               if (colon == readme && repo->defbranch)
+                       *ref = xstrdup(repo->defbranch);
+               else
+                       *ref = xstrndup(readme, colon - readme);
+               readme = colon + 1;
+       }
+
+       /* Prepend repo path to relative readme path unless tracked. */
+       if (!(*ref) && readme[0] != '/')
+               *filename = fmtalloc("%s/%s", repo->path, readme);
+       else
+               *filename = xstrdup(readme);
+}
+static void choose_readme(struct cgit_repo *repo)
+{
+       int found;
+       char *filename, *ref;
+       struct string_list_item *entry;
+
+       if (!repo->readme.nr)
+               return;
+
+       found = 0;
+       for_each_string_list_item(entry, &repo->readme) {
+               parse_readme(entry->string, &filename, &ref, repo);
+               if (!filename) {
+                       free(filename);
+                       free(ref);
+                       continue;
+               }
+               /* If there's only one item, we skip the possibly expensive
+                * selection process. */
+               if (repo->readme.nr == 1) {
+                       found = 1;
+                       break;
+               }
+               if (ref) {
+                       if (cgit_ref_path_exists(filename, ref, 1)) {
+                               found = 1;
+                               break;
+                       }
+               }
+               else if (!access(filename, R_OK)) {
+                       found = 1;
+                       break;
+               }
+               free(filename);
+               free(ref);
+       }
+       repo->readme.strdup_strings = 1;
+       string_list_clear(&repo->readme, 0);
+       repo->readme.strdup_strings = 0;
+       if (found)
+               string_list_append(&repo->readme, filename)->util = ref;
+}
 
 static int prepare_repo_cmd(struct cgit_context *ctx)
 {
@@ -463,8 +554,21 @@ static int prepare_repo_cmd(struct cgit_context *ctx)
        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;
@@ -512,6 +616,7 @@ static int prepare_repo_cmd(struct cgit_context *ctx)
        }
        sort_string_list(&ctx->repo->submodules);
        cgit_prepare_repo_env(ctx->repo);
+       choose_readme(ctx->repo);
        return 0;
 }
 
@@ -600,6 +705,7 @@ static char *get_first_line(char *txt)
 
 static void print_repo(FILE *f, struct cgit_repo *repo)
 {
+       struct string_list_item *item;
        fprintf(f, "repo.url=%s\n", repo->url);
        fprintf(f, "repo.name=%s\n", repo->name);
        fprintf(f, "repo.path=%s\n", repo->path);
@@ -610,8 +716,12 @@ static void print_repo(FILE *f, struct cgit_repo *repo)
                fprintf(f, "repo.desc=%s\n", tmp);
                free(tmp);
        }
-       if (repo->readme)
-               fprintf(f, "repo.readme=%s\n", repo->readme);
+       for_each_string_list_item(item, &repo->readme) {
+               if (item->util)
+                       fprintf(f, "repo.readme=%s:%s\n", (char *)item->util, item->string);
+               else
+                       fprintf(f, "repo.readme=%s\n", item->string);
+       }
        if (repo->defbranch)
                fprintf(f, "repo.defbranch=%s\n", repo->defbranch);
        if (repo->module_link)
@@ -640,6 +750,20 @@ static void print_repo(FILE *f, struct cgit_repo *repo)
        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");
 }
 
@@ -801,6 +925,9 @@ static int calc_ttl()
        if (!ctx.qry.page)
                return ctx.cfg.cache_repo_ttl;
 
+       if (!strcmp(ctx.qry.page, "about"))
+               return ctx.cfg.cache_about_ttl;
+
        if (ctx.qry.has_symref)
                return ctx.cfg.cache_dynamic_ttl;
 
@@ -852,7 +979,10 @@ int main(int argc, const char **argv)
        }
 
        ttl = calc_ttl();
-       ctx.page.expires += ttl * 60;
+       if (ttl < 0)
+               ctx.page.expires += 10 * 365 * 24 * 60 * 60; /* 10 years */
+       else
+               ctx.page.expires += ttl * 60;
        if (ctx.env.request_method && !strcmp(ctx.env.request_method, "HEAD"))
                ctx.cfg.nocache = 1;
        if (ctx.cfg.nocache)