ui-stats: replace 'enable-stats' setting with 'max-stats'

The new 'max-stats' and 'repo.max-stats' settings makes it possible to
define the maximum statistics period, both globally and per repo. Hence,
it is now feasible to allow statistics on repositories with a high commit
frequency, like linux-2.6, by setting repo.max-stats to e.g. 'month'.

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

8 files changed, 104 insertions, 58 deletions

diff --git a/cgit.c b/cgit.c
index 22b6d7c..57e11cd 100644
--- a/cgit.c
+++ b/cgit.c
@@ -9,12 +9,13 @@
 #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;
 
 void config_cb(const char *name, const char *value)
 {
@@ -51,14 +52,14 @@ void config_cb(const char *name, const char *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-stats"))
-                ctx.cfg.enable_stats = 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);
         else if (!strcmp(name, "cache-root-ttl"))
                 ctx.cfg.cache_root_ttl = atoi(value);
@@ -111,14 +112,14 @@ void config_cb(const char *name, const char *value)
         else if (ctx.repo && !strcmp(name, "repo.snapshots"))
                 ctx.repo->snapshots = ctx.cfg.snapshots & cgit_parse_snapshots_mask(value); /* XXX: &? */
         else if (ctx.repo && !strcmp(name, "repo.enable-log-filecount"))
                 ctx.repo->enable_log_filecount = ctx.cfg.enable_log_filecount * atoi(value);
         else if (ctx.repo && !strcmp(name, "repo.enable-log-linecount"))
                 ctx.repo->enable_log_linecount = ctx.cfg.enable_log_linecount * atoi(value);
-        else if (ctx.repo && !strcmp(name, "repo.enable-stats"))
-                ctx.repo->enable_stats = ctx.cfg.enable_stats && atoi(value);
+        else if (ctx.repo && !strcmp(name, "repo.max-stats"))
+                ctx.repo->max_stats = cgit_find_stats_period(value, NULL);
         else if (ctx.repo && !strcmp(name, "repo.module-link"))
                 ctx.repo->module_link= xstrdup(value);
         else if (ctx.repo && !strcmp(name, "repo.readme") && value != NULL) {
                 if (*value == '/')
                         ctx.repo->readme = xstrdup(value);
                 else
@@ -180,12 +181,13 @@ static void prepare_context(struct cgit_context *ctx)
         ctx->cfg.local_time = 0;
         ctx->cfg.max_repo_count = 50;
         ctx->cfg.max_commit_count = 50;
         ctx->cfg.max_lock_attempts = 5;
         ctx->cfg.max_msg_len = 80;
         ctx->cfg.max_repodesc_len = 80;
+        ctx->cfg.max_stats = 0;
         ctx->cfg.module_link = "./?repo=%s&page=commit&id=%s";
         ctx->cfg.renamelimit = -1;
         ctx->cfg.robots = "index, nofollow";
         ctx->cfg.root_title = "Git repository browser";
         ctx->cfg.root_desc = "a fast webinterface for the git dscm";
         ctx->cfg.script_name = CGIT_SCRIPT_NAME;
diff --git a/cgit.h b/cgit.h
index 85045c4..f2cb671 100644
--- a/cgit.h
+++ b/cgit.h
@@ -58,13 +58,13 @@ struct cgit_repo {
         char *module_link;
         char *readme;
         char *clone_url;
         int snapshots;
         int enable_log_filecount;
         int enable_log_linecount;
-        int enable_stats;
+        int max_stats;
 };
 
 struct cgit_repolist {
         int length;
         int count;
         struct cgit_repo *repos;
@@ -150,19 +150,19 @@ struct cgit_config {
         int cache_repo_ttl;
         int cache_root_ttl;
         int cache_static_ttl;
         int enable_index_links;
         int enable_log_filecount;
         int enable_log_linecount;
-        int enable_stats;
         int local_time;
         int max_repo_count;
         int max_commit_count;
         int max_lock_attempts;
         int max_msg_len;
         int max_repodesc_len;
+        int max_stats;
         int nocache;
         int renamelimit;
         int snapshots;
         int summary_branches;
         int summary_log;
         int summary_tags;
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 60d3ea4..0bbbea3 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -71,16 +71,12 @@ enable-log-filecount
 
 enable-log-linecount
         Flag which, when set to "1", will make cgit print the number of added
         and removed lines for each commit on the repository log page. Default
         value: "0".
 
-enable-stats
-        Globally enable/disable statistics for each repository. Default
-        value: "0".
-
 favicon
         Url used as link to a shortcut icon for cgit. If specified, it is
         suggested to use the value "/favicon.ico" since certain browsers will
         ignore other values. Default value: none.
 
 footer
@@ -130,12 +126,17 @@ max-repo-count
         index page. Default value: "50".
 
 max-repodesc-length
         Specifies the maximum number of repo description characters to display
         on the repository index page. Default value: "80".
 
+max-stats
+        Set the default maximum statistics period. Valid values are "week",
+        "month", "quarter" and "year". If unspecified, statistics are
+        disabled. Default value: none. See also: "repo.max-stats".
+
 module-link
         Text which will be used as the formatstring for a hyperlink when a
         submodule is printed in a directory listing. The arguments for the
         formatstring are the path and SHA1 of the submodule commit. Default
         value: "./?repo=%s&page=commit&id=%s"
 
@@ -219,15 +220,16 @@ repo.enable-log-filecount
         `enable-log-filecount'. Default value: none.
 
 repo.enable-log-linecount
         A flag which can be used to disable the global setting
         `enable-log-linecount'. Default value: none.
 
-repo.enable-stats
-        A flag which can be used to disable the global setting
-        `enable-stats'. Default value: none.
+repo.max-stats
+        Override the default maximum statistics period. Valid values are equal
+        to the values specified for the global "max-stats" setting. Default
+        value: none.
 
 repo.name
         The value to show as repository name. Default value: <repo.url>.
 
 repo.owner
         A value used to identify the owner of the repository. Default value:
@@ -281,12 +283,16 @@ favicon=/favicon.ico
 
 
 # Use a custom logo
 logo=/img/mylogo.png
 
 
+# Enable statistics per week, month and quarter
+max-stats=quarter
+
+
 # Set the title and heading of the repository index page
 root-title=foobar.com git repositories
 
 
 # Set a subheading for the repository index page
 root-desc=tracking the foobar development
@@ -353,12 +359,15 @@ repo.desc=the kernel
 # Disable adhoc downloads of this repo
 repo.snapshots=0
 
 # Disable line-counts for this repo
 repo.enable-log-linecount=0
 
+# Restrict the max statistics period for this repo
+repo.max-stats=month
+
 
 BUGS
 ----
 Comments currently cannot appear on the same line as a setting; the comment
 will be included as part of the value. E.g. this line:
 
diff --git a/cmd.c b/cmd.c
index 744bf84..763a558 100644
--- a/cmd.c
+++ b/cmd.c
@@ -109,16 +109,13 @@ static void snapshot_fn(struct cgit_context *ctx)
                             cgit_repobasename(ctx->repo->url), ctx->qry.path,
                             ctx->repo->snapshots, ctx->qry.nohead);
 }
 
 static void stats_fn(struct cgit_context *ctx)
 {
-        if (ctx->repo->enable_stats)
-                cgit_show_stats(ctx);
-        else
-                cgit_print_error("Stats disabled for this repo");
+        cgit_show_stats(ctx);
 }
 
 static void summary_fn(struct cgit_context *ctx)
 {
         cgit_print_summary();
 }
diff --git a/shared.c b/shared.c
index 37333f0..7382609 100644
--- a/shared.c
+++ b/shared.c
@@ -55,13 +55,13 @@ struct cgit_repo *cgit_add_repo(const char *url)
         ret->owner = NULL;
         ret->group = ctx.cfg.repo_group;
         ret->defbranch = "master";
         ret->snapshots = ctx.cfg.snapshots;
         ret->enable_log_filecount = ctx.cfg.enable_log_filecount;
         ret->enable_log_linecount = ctx.cfg.enable_log_linecount;
-        ret->enable_stats = ctx.cfg.enable_stats;
+        ret->max_stats = ctx.cfg.max_stats;
         ret->module_link = ctx.cfg.module_link;
         ret->readme = NULL;
         return ret;
 }
 
 struct cgit_repo *cgit_get_repoinfo(const char *url)
diff --git a/ui-shared.c b/ui-shared.c
index 0e688a0..97b9d46 100644
--- a/ui-shared.c
+++ b/ui-shared.c
@@ -638,13 +638,13 @@ void cgit_print_pageheader(struct cgit_context *ctx)
                 cgit_tree_link("tree", NULL, hc(cmd, "tree"), ctx->qry.head,
                                ctx->qry.sha1, NULL);
                 cgit_commit_link("commit", NULL, hc(cmd, "commit"),
                                  ctx->qry.head, ctx->qry.sha1);
                 cgit_diff_link("diff", NULL, hc(cmd, "diff"), ctx->qry.head,
                                ctx->qry.sha1, ctx->qry.sha2, NULL);
-                if (ctx->repo->enable_stats)
+                if (ctx->repo->max_stats)
                         reporevlink("stats", "stats", NULL, hc(cmd, "stats"),
                                     ctx->qry.head, NULL, NULL);
                 if (ctx->repo->readme)
                         reporevlink("about", "about", NULL,
                                     hc(cmd, "about"), ctx->qry.head, NULL,
                                     NULL);
diff --git a/ui-stats.c b/ui-stats.c
index 3cc8d70..1104485 100644
--- a/ui-stats.c
+++ b/ui-stats.c
@@ -1,29 +1,15 @@
+#include <string-list.h>
+
 #include "cgit.h"
 #include "html.h"
-#include <string-list.h>
+#include "ui-shared.h"
+#include "ui-stats.h"
 
 #define MONTHS 6
 
-struct Period {
-        const char code;
-        const char *name;
-        int max_periods;
-        int count;
-
-        /* Convert a tm value to the first day in the period */
-        void (*trunc)(struct tm *tm);
-
-        /* Update tm value to start of next/previous period */
-        void (*dec)(struct tm *tm);
-        void (*inc)(struct tm *tm);
-
-        /* Pretty-print a tm value */
-        char *(*pretty)(struct tm *tm);
-};
-
 struct authorstat {
         long total;
         struct string_list list;
 };
 
 #define DAY_SECS (60 * 60 * 24)
@@ -134,21 +120,45 @@ static void inc_year(struct tm *tm)
 
 static char *pretty_year(struct tm *tm)
 {
         return fmt("%d", tm->tm_year + 1900);
 }
 
-struct Period periods[] = {
+struct cgit_period periods[] = {
         {'w', "week", 12, 4, trunc_week, dec_week, inc_week, pretty_week},
         {'m', "month", 12, 4, trunc_month, dec_month, inc_month, pretty_month},
         {'q', "quarter", 12, 4, trunc_quarter, dec_quarter, inc_quarter, pretty_quarter},
         {'y', "year", 12, 4, trunc_year, dec_year, inc_year, pretty_year},
 };
 
+/* Given a period code or name, return a period index (1, 2, 3 or 4)
+ * and update the period pointer to the correcsponding struct.
+ * If no matching code is found, return 0.
+ */
+int cgit_find_stats_period(const char *expr, struct cgit_period **period)
+{
+        int i;
+        char code = '\0';
+
+        if (!expr)
+                return 0;
+
+        if (strlen(expr) == 1)
+                code = expr[0];
+
+        for (i = 0; i < sizeof(periods) / sizeof(periods[0]); i++)
+                if (periods[i].code == code || !strcmp(periods[i].name, expr)) {
+                        if (period)
+                                *period = &periods[i];
+                        return i+1;
+                }
+        return 0;
+}
+
 static void add_commit(struct string_list *authors, struct commit *commit,
-        struct Period *period)
+        struct cgit_period *period)
 {
         struct commitinfo *info;
         struct string_list_item *author, *item;
         struct authorstat *authorstat;
         struct string_list *items;
         char *tmp;
@@ -187,13 +197,13 @@ static int cmp_total_commits(const void *a1, const void *a2)
 }
 
 /* Walk the commit DAG and collect number of commits per author per
  * timeperiod into a nested string_list collection.
  */
 struct string_list collect_stats(struct cgit_context *ctx,
-        struct Period *period)
+        struct cgit_period *period)
 {
         struct string_list authors;
         struct rev_info rev;
         struct commit *commit;
         const char *argv[] = {NULL, ctx->qry.head, NULL, NULL, NULL, NULL};
         int argc = 3;
@@ -230,13 +240,13 @@ struct string_list collect_stats(struct cgit_context *ctx,
         }
         return authors;
 }
 
 void print_combined_authorrow(struct string_list *authors, int from, int to,
         const char *name, const char *leftclass, const char *centerclass,
-        const char *rightclass, struct Period *period)
+        const char *rightclass, struct cgit_period *period)
 {
         struct string_list_item *author;
         struct authorstat *authorstat;
         struct string_list *items;
         struct string_list_item *date;
         time_t now;
@@ -268,13 +278,14 @@ void print_combined_authorrow(struct string_list *authors, int from, int to,
                 htmlf("<td class='%s'>%d</td>", centerclass, subtotal);
                 total += subtotal;
         }
         htmlf("<td class='%s'>%d</td></tr>", rightclass, total);
 }
 
-void print_authors(struct string_list *authors, int top, struct Period *period)
+void print_authors(struct string_list *authors, int top,
+                   struct cgit_period *period)
 {
         struct string_list_item *author;
         struct authorstat *authorstat;
         struct string_list *items;
         struct string_list_item *date;
         time_t now;
@@ -336,22 +347,28 @@ void print_authors(struct string_list *authors, int top, struct Period *period)
  * for each author is another string_list which is used to calculate the
  * number of commits per time-interval.
  */
 void cgit_show_stats(struct cgit_context *ctx)
 {
         struct string_list authors;
-        struct Period *period;
+        struct cgit_period *period;
         int top, i;
+        const char *code = "w";
 
-        period = &periods[0];
-        if (ctx->qry.period) {
-                for (i = 0; i < sizeof(periods) / sizeof(periods[0]); i++)
-                        if (periods[i].code == ctx->qry.period[0]) {
-                                period = &periods[i];
-                                break;
-                        }
+        if (ctx->qry.period)
+                code = ctx->qry.period;
+
+        i = cgit_find_stats_period(code, &period);
+        if (!i) {
+                cgit_print_error(fmt("Unknown statistics type: %c", code));
+                return;
+        }
+        if (i > ctx->repo->max_stats) {
+                cgit_print_error(fmt("Statistics type disabled: %s",
+                                     period->name));
+                return;
         }
         authors = collect_stats(ctx, period);
         qsort(authors.items, authors.nr, sizeof(struct string_list_item),
                 cmp_total_commits);
 
         top = ctx->qry.ofs;
@@ -365,20 +382,22 @@ void cgit_show_stats(struct cgit_context *ctx)
         }
         html("</h2>");
 
         html("<form method='get' action='.' style='float: right; text-align: right;'>");
         if (strcmp(ctx->qry.head, ctx->repo->defbranch))
                 htmlf("<input type='hidden' name='h' value='%s'/>", ctx->qry.head);
-        html("Period: ");
-        html("<select name='period' onchange='this.form.submit();'>");
-        for (i = 0; i < sizeof(periods) / sizeof(periods[0]); i++)
-                htmlf("<option value='%c'%s>%s</option>",
-                        periods[i].code,
-                        period == &periods[i] ? " selected" : "",
-                        periods[i].name);
-        html("</select><br/><br/>");
+        if (ctx->repo->max_stats > 1) {
+                html("Period: ");
+                html("<select name='period' onchange='this.form.submit();'>");
+                for (i = 0; i < ctx->repo->max_stats; i++)
+                        htmlf("<option value='%c'%s>%s</option>",
+                                periods[i].code,
+                                period == &periods[i] ? " selected" : "",
+                                periods[i].name);
+                html("</select><br/><br/>");
+        }
         html("Authors: ");
         html("");
         html("<select name='ofs' onchange='this.form.submit();'>");
         htmlf("<option value='10'%s>10</option>", top == 10 ? " selected" : "");
         htmlf("<option value='25'%s>25</option>", top == 25 ? " selected" : "");
         htmlf("<option value='50'%s>50</option>", top == 50 ? " selected" : "");
diff --git a/ui-stats.h b/ui-stats.h
index f1d744c..4f13dba 100644
--- a/ui-stats.h
+++ b/ui-stats.h
@@ -1,8 +1,27 @@
 #ifndef UI_STATS_H
 #define UI_STATS_H
 
 #include "cgit.h"
 
+struct cgit_period {
+        const char code;
+        const char *name;
+        int max_periods;
+        int count;
+
+        /* Convert a tm value to the first day in the period */
+        void (*trunc)(struct tm *tm);
+
+        /* Update tm value to start of next/previous period */
+        void (*dec)(struct tm *tm);
+        void (*inc)(struct tm *tm);
+
+        /* Pretty-print a tm value */
+        char *(*pretty)(struct tm *tm);
+};
+
+extern int cgit_find_stats_period(const char *expr, struct cgit_period **period);
+
 extern void cgit_show_stats(struct cgit_context *ctx);
 
 #endif /* UI_STATS_H */