Merge branch 'lh/about'

* lh/about:
  Add 'about site' and 'about repo' pages
  Prepare for 'about site' page / add 'root-readme' option to cgitrc
  Make it possible for a single cmd to work both with and without a repo
  Re-enable 'index-info' and add support for 'root-desc' in cgitrc
  Move included header-file out of repolist table
  Prepare for 'about repo' page

8 files changed, 100 insertions, 16 deletions

diff --git a/cgit.c b/cgit.c
index 38b0ba5..a402758 100644
--- a/cgit.c
+++ b/cgit.c
@@ -1,45 +1,49 @@
 /* cgit.c: cgi for the git scm
  *
  * Copyright (C) 2006 Lars Hjemli
  *
  * Licensed under GNU General Public License v2
  *   (see COPYING for full license text)
  */
 
 #include "cgit.h"
 #include "cache.h"
 #include "cmd.h"
 #include "configfile.h"
 #include "html.h"
 #include "ui-shared.h"
 
 const char *cgit_version = CGIT_VERSION;
 
 void config_cb(const char *name, const char *value)
 {
         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);
         else if (!strcmp(name, "css"))
                 ctx.cfg.css = xstrdup(value);
         else if (!strcmp(name, "logo"))
                 ctx.cfg.logo = xstrdup(value);
         else if (!strcmp(name, "index-header"))
                 ctx.cfg.index_header = xstrdup(value);
         else if (!strcmp(name, "index-info"))
                 ctx.cfg.index_info = xstrdup(value);
         else if (!strcmp(name, "logo-link"))
                 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, "snapshots"))
                 ctx.cfg.snapshots = cgit_parse_snapshots_mask(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);
@@ -138,48 +142,49 @@ static void querystring_cb(const char *name, const char *value)
                 ctx.qry.name = xstrdup(value);
         }
 }
 
 static void prepare_context(struct cgit_context *ctx)
 {
         memset(ctx, 0, sizeof(ctx));
         ctx->cfg.agefile = "info/web/last-modified";
         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_root_ttl = 5;
         ctx->cfg.cache_static_ttl = -1;
         ctx->cfg.css = "/cgit.css";
         ctx->cfg.logo = "/git-logo.png";
         ctx->cfg.max_commit_count = 50;
         ctx->cfg.max_lock_attempts = 5;
         ctx->cfg.max_msg_len = 60;
         ctx->cfg.max_repodesc_len = 60;
         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;
         ctx->page.mimetype = "text/html";
         ctx->page.charset = PAGE_ENCODING;
         ctx->page.filename = NULL;
 }
 
 static int cgit_prepare_cache(struct cacheitem *item)
 {
         if (!ctx.repo && ctx.qry.repo) {
                 ctx.page.title = fmt("%s - %s", ctx.cfg.root_title,
                                       "Bad request");
                 cgit_print_http_headers(&ctx);
                 cgit_print_docstart(&ctx);
                 cgit_print_pageheader(&ctx);
                 cgit_print_error(fmt("Unknown repo: %s", ctx.qry.repo));
                 cgit_print_docend();
                 return 0;
         }
 
         if (!ctx.repo) {
                 item->name = xstrdup(fmt("%s/index.%s.html",
                                          ctx.cfg.cache_root,
                                          cache_safe_filename(ctx.qry.raw)));
                 item->ttl = ctx.cfg.cache_root_ttl;
@@ -283,49 +288,58 @@ static int prepare_repo_cmd(struct cgit_context *ctx)
                 cgit_print_pageheader(ctx);
                 cgit_print_error(fmt("Invalid branch: %s", tmp));
                 cgit_print_docend();
                 return 1;
         }
         return 0;
 }
 
 static void process_request(struct cgit_context *ctx)
 {
         struct cgit_cmd *cmd;
 
         cmd = cgit_get_cmd(ctx);
         if (!cmd) {
                 ctx->page.title = "cgit error";
                 ctx->repo = NULL;
                 cgit_print_http_headers(ctx);
                 cgit_print_docstart(ctx);
                 cgit_print_pageheader(ctx);
                 cgit_print_error("Invalid request");
                 cgit_print_docend();
                 return;
         }
 
-        if (cmd->want_repo && prepare_repo_cmd(ctx))
+        if (cmd->want_repo && !ctx->repo) {
+                cgit_print_http_headers(ctx);
+                cgit_print_docstart(ctx);
+                cgit_print_pageheader(ctx);
+                cgit_print_error(fmt("No repository selected"));
+                cgit_print_docend();
+                return;
+        }
+
+        if (ctx->repo && prepare_repo_cmd(ctx))
                 return;
 
         if (cmd->want_layout) {
                 cgit_print_http_headers(ctx);
                 cgit_print_docstart(ctx);
                 cgit_print_pageheader(ctx);
         }
 
         cmd->fn(ctx);
 
         if (cmd->want_layout)
                 cgit_print_docend();
 }
 
 static long ttl_seconds(long ttl)
 {
         if (ttl<0)
                 return 60 * 60 * 24 * 365;
         else
                 return ttl * 60;
 }
 
 static void cgit_fill_cache(struct cacheitem *item, int use_cache)
 {
diff --git a/cgit.h b/cgit.h
index a3b6535..daebeff 100644
--- a/cgit.h
+++ b/cgit.h
@@ -111,48 +111,50 @@ struct cgit_query {
         char *page;
         char *search;
         char *grep;
         char *head;
         char *sha1;
         char *sha2;
         char *path;
         char *name;
         int   ofs;
 };
 
 struct cgit_config {
         char *agefile;
         char *cache_root;
         char *clone_prefix;
         char *css;
         char *index_header;
         char *index_info;
         char *logo;
         char *logo_link;
         char *module_link;
         char *repo_group;
         char *robots;
         char *root_title;
+        char *root_desc;
+        char *root_readme;
         char *script_name;
         char *virtual_root;
         int cache_dynamic_ttl;
         int cache_max_create_time;
         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 max_commit_count;
         int max_lock_attempts;
         int max_msg_len;
         int max_repodesc_len;
         int nocache;
         int renamelimit;
         int snapshots;
         int summary_branches;
         int summary_log;
         int summary_tags;
 };
 
 struct cgit_page {
         time_t modified;
diff --git a/cmd.c b/cmd.c
index e0eacbe..6cc91e6 100644
--- a/cmd.c
+++ b/cmd.c
@@ -1,46 +1,54 @@
 /* cmd.c: the cgit command dispatcher
  *
  * Copyright (C) 2008 Lars Hjemli
  *
  * Licensed under GNU General Public License v2
  *   (see COPYING for full license text)
  */
 
 #include "cgit.h"
 #include "cmd.h"
 #include "ui-blob.h"
 #include "ui-commit.h"
 #include "ui-diff.h"
 #include "ui-log.h"
 #include "ui-patch.h"
 #include "ui-refs.h"
 #include "ui-repolist.h"
 #include "ui-snapshot.h"
 #include "ui-summary.h"
 #include "ui-tag.h"
 #include "ui-tree.h"
 
+static void about_fn(struct cgit_context *ctx)
+{
+        if (ctx->repo)
+                cgit_print_repo_readme();
+        else
+                cgit_print_site_readme();
+}
+
 static void blob_fn(struct cgit_context *ctx)
 {
         cgit_print_blob(ctx->qry.sha1, ctx->qry.path);
 }
 
 static void commit_fn(struct cgit_context *ctx)
 {
         cgit_print_commit(ctx->qry.sha1);
 }
 
 static void diff_fn(struct cgit_context *ctx)
 {
         cgit_print_diff(ctx->qry.sha1, ctx->qry.sha2, ctx->qry.path);
 }
 
 static void repolist_fn(struct cgit_context *ctx)
 {
         cgit_print_repolist();
 }
 
 static void log_fn(struct cgit_context *ctx)
 {
         cgit_print_log(ctx->qry.sha1, ctx->qry.ofs, ctx->cfg.max_commit_count,
                        ctx->qry.grep, ctx->qry.search, ctx->qry.path, 1);
@@ -63,48 +71,49 @@ static void snapshot_fn(struct cgit_context *ctx)
                             ctx->repo->snapshots);
 }
 
 static void summary_fn(struct cgit_context *ctx)
 {
         cgit_print_summary();
 }
 
 static void tag_fn(struct cgit_context *ctx)
 {
         cgit_print_tag(ctx->qry.sha1);
 }
 
 static void tree_fn(struct cgit_context *ctx)
 {
         cgit_print_tree(ctx->qry.sha1, ctx->qry.path);
 }
 
 #define def_cmd(name, want_repo, want_layout) \
         {#name, name##_fn, want_repo, want_layout}
 
 struct cgit_cmd *cgit_get_cmd(struct cgit_context *ctx)
 {
         static struct cgit_cmd cmds[] = {
+                def_cmd(about, 0, 1),
                 def_cmd(blob, 1, 0),
                 def_cmd(commit, 1, 1),
                 def_cmd(diff, 1, 1),
                 def_cmd(log, 1, 1),
                 def_cmd(patch, 1, 0),
                 def_cmd(refs, 1, 1),
                 def_cmd(repolist, 0, 0),
                 def_cmd(snapshot, 1, 0),
                 def_cmd(summary, 1, 1),
                 def_cmd(tag, 1, 1),
                 def_cmd(tree, 1, 1),
         };
         int i;
 
         if (ctx->qry.page == NULL) {
                 if (ctx->repo)
                         ctx->qry.page = "summary";
                 else
                         ctx->qry.page = "repolist";
         }
 
         for(i = 0; i < sizeof(cmds)/sizeof(*cmds); i++)
                 if (!strcmp(ctx->qry.page, cmds[i].name))
                         return &cmds[i];
diff --git a/ui-repolist.c b/ui-repolist.c
index 98009c0..3f78e28 100644
--- a/ui-repolist.c
+++ b/ui-repolist.c
@@ -40,77 +40,74 @@ static void print_modtime(struct cgit_repo *repo)
 
         path = fmt("%s/refs/heads/%s", repo->path, repo->defbranch);
         if (stat(path, &s) != 0)
                 return;
         cgit_print_age(s.st_mtime, -1, NULL);
 }
 
 int is_match(struct cgit_repo *repo)
 {
         if (!ctx.qry.search)
                 return 1;
         if (repo->url && strcasestr(repo->url, ctx.qry.search))
                 return 1;
         if (repo->name && strcasestr(repo->name, ctx.qry.search))
                 return 1;
         if (repo->desc && strcasestr(repo->desc, ctx.qry.search))
                 return 1;
         if (repo->owner && strcasestr(repo->owner, ctx.qry.search))
                 return 1;
         return 0;
 }
 
 void print_header(int columns)
 {
-        if (ctx.cfg.index_header) {
-                htmlf("<tr class='nohover'><td colspan='%d' class='include-block'>",
-                      columns);
-                html_include(ctx.cfg.index_header);
-                html("</td></tr>");
-        }
         html("<tr class='nohover'>"
              "<th class='left'>Name</th>"
              "<th class='left'>Description</th>"
              "<th class='left'>Owner</th>"
              "<th class='left'>Idle</th>");
         if (ctx.cfg.enable_index_links)
                 html("<th class='left'>Links</th>");
         html("</tr>\n");
 }
 
 void cgit_print_repolist()
 {
         int i, columns = 4, hits = 0, header = 0;
         char *last_group = NULL;
 
         if (ctx.cfg.enable_index_links)
                 columns++;
 
         ctx.page.title = ctx.cfg.root_title;
         cgit_print_http_headers(&ctx);
         cgit_print_docstart(&ctx);
         cgit_print_pageheader(&ctx);
 
+        if (ctx.cfg.index_header)
+                html_include(ctx.cfg.index_header);
+
         html("<table summary='repository list' class='list nowrap'>");
         for (i=0; i<cgit_repolist.count; i++) {
                 ctx.repo = &cgit_repolist.repos[i];
                 if (!is_match(ctx.repo))
                         continue;
                 if (!header++)
                         print_header(columns);
                 hits++;
                 if ((last_group == NULL && ctx.repo->group != NULL) ||
                     (last_group != NULL && ctx.repo->group == NULL) ||
                     (last_group != NULL && ctx.repo->group != NULL &&
                      strcmp(ctx.repo->group, last_group))) {
                         htmlf("<tr class='nohover'><td colspan='%d' class='repogroup'>",
                               columns);
                         html_txt(ctx.repo->group);
                         html("</td></tr>");
                         last_group = ctx.repo->group;
                 }
                 htmlf("<tr><td class='%s'>",
                       ctx.repo->group ? "sublevel-repo" : "toplevel-repo");
                 html_link_open(cgit_repourl(ctx.repo->url), NULL, NULL);
                 html_txt(ctx.repo->name);
                 html_link_close();
                 html("</td><td>");
@@ -118,24 +115,30 @@ void cgit_print_repolist()
                 html_ntxt(ctx.cfg.max_repodesc_len, ctx.repo->desc);
                 html_link_close();
                 html("</td><td>");
                 html_txt(ctx.repo->owner);
                 html("</td><td>");
                 print_modtime(ctx.repo);
                 html("</td>");
                 if (ctx.cfg.enable_index_links) {
                         html("<td>");
                         html_link_open(cgit_repourl(ctx.repo->url),
                                        NULL, "button");
                         html("summary</a>");
                         cgit_log_link("log", NULL, "button", NULL, NULL, NULL,
                                       0, NULL, NULL);
                         cgit_tree_link("tree", NULL, "button", NULL, NULL, NULL);
                         html("</td>");
                 }
                 html("</tr>\n");
         }
         html("</table>");
         if (!hits)
                 cgit_print_error("No repositories found");
         cgit_print_docend();
 }
+
+void cgit_print_site_readme()
+{
+        if (ctx.cfg.root_readme)
+                html_include(ctx.cfg.root_readme);
+}
diff --git a/ui-repolist.h b/ui-repolist.h
index c23e5d2..5b1e542 100644
--- a/ui-repolist.h
+++ b/ui-repolist.h
@@ -1,6 +1,7 @@
 #ifndef UI_REPOLIST_H
 #define UI_REPOLIST_H
 
 extern void cgit_print_repolist();
+extern void cgit_print_site_readme();
 
 #endif /* UI_REPOLIST_H */
diff --git a/ui-shared.c b/ui-shared.c
index 8a804c2..d08ede9 100644
--- a/ui-shared.c
+++ b/ui-shared.c
@@ -93,48 +93,91 @@ const char *cgit_repobasename(const char *reponame)
         if(p>=3 && !strncmp(&rvbuf[p-3],".git",4)) {
                 p -= 3; rvbuf[p--] = 0;
         }
         /* strip more trailing slashes if any */
         while( p && rvbuf[p]=='/') rvbuf[p--]=0;
         /* find last slash in the remaining string */
         rv = strrchr(rvbuf,'/');
         if(rv)
                 return ++rv;
         return rvbuf;
 }
 
 char *cgit_currurl()
 {
         if (!ctx.cfg.virtual_root)
                 return ctx.cfg.script_name;
         else if (ctx.qry.page)
                 return fmt("%s/%s/%s/", ctx.cfg.virtual_root, ctx.qry.repo, ctx.qry.page);
         else if (ctx.qry.repo)
                 return fmt("%s/%s/", ctx.cfg.virtual_root, ctx.qry.repo);
         else
                 return fmt("%s/", ctx.cfg.virtual_root);
 }
 
+static void site_url(char *page, char *search)
+{
+        char *delim = "?";
+
+        if (ctx.cfg.virtual_root) {
+                html_attr(ctx.cfg.virtual_root);
+                if (ctx.cfg.virtual_root[strlen(ctx.cfg.virtual_root) - 1] != '/')
+                        html("/");
+        } else
+                html(ctx.cfg.script_name);
+
+        if (page) {
+                htmlf("?p=%s", page);
+                delim = "&";
+        }
+        if (search) {
+                html(delim);
+                html("q=");
+                html_attr(search);
+        }
+}
+
+static void site_link(char *page, char *name, char *title, char *class,
+                       char *search)
+{
+        html("<a");
+        if (title) {
+                html(" title='");
+                html_attr(title);
+                html("'");
+        }
+        if (class) {
+                html(" class='");
+                html_attr(class);
+                html("'");
+        }
+        html(" href='");
+        site_url(page, search);
+        html("'>");
+        html_txt(name);
+        html("</a>");
+}
+
 static char *repolink(char *title, char *class, char *page, char *head,
                       char *path)
 {
         char *delim = "?";
 
         html("<a");
         if (title) {
                 html(" title='");
                 html_attr(title);
                 html("'");
         }
         if (class) {
                 html(" class='");
                 html_attr(class);
                 html("'");
         }
         html(" href='");
         if (ctx.cfg.virtual_root) {
                 html_attr(ctx.cfg.virtual_root);
                 if (ctx.cfg.virtual_root[strlen(ctx.cfg.virtual_root) - 1] != '/')
                         html("/");
                 html_attr(ctx.repo->url);
                 if (ctx.repo->url[strlen(ctx.repo->url) - 1] != '/')
                         html("/");
@@ -489,87 +532,94 @@ void cgit_print_pageheader(struct cgit_context *ctx)
         html("<td class='main'>");
         if (ctx->repo) {
                 reporevlink(NULL, ctx->repo->name, NULL, hc(cmd, "summary"),
                             ctx->qry.head, NULL, NULL);
                 html(" : ");
                 html_txt(ctx->qry.page);
                 html("</td><td class='form'>");
                 html("<form method='get' action=''>\n");
                 add_hidden_formfields(0, 1, ctx->qry.page);
                 html("<select name='h' onchange='this.form.submit();'>\n");
                 for_each_branch_ref(print_branch_option, ctx->qry.head);
                 html("</select> ");
                 html("<input type='submit' name='' value='switch'/>");
                 html("</form>");
         } else
                 html_txt(ctx->cfg.root_title);
         html("</td></tr>\n");
 
         html("<tr><td class='sub'");
         if (ctx->repo) {
                 html(" colspan='2'>");
                 html_txt(ctx->repo->desc);
         } else {
                 html(">");
-                html_txt("a fast webinterface for the git dscm");
+                if (ctx->cfg.root_desc)
+                        html_txt(ctx->cfg.root_desc);
+                else if (ctx->cfg.index_info)
+                        html_include(ctx->cfg.index_info);
         }
         html("</td></tr></table>\n");
 
         html("<table class='tabs'><tr><td>\n");
         if (ctx->repo) {
                 reporevlink(NULL, "summary", NULL, hc(cmd, "summary"),
                             ctx->qry.head, NULL, NULL);
                 cgit_refs_link("refs", NULL, hc(cmd, "refs"), ctx->qry.head,
                                ctx->qry.sha1, NULL);
                 cgit_log_link("log", NULL, hc(cmd, "log"), ctx->qry.head,
                               NULL, NULL, 0, NULL, NULL);
                 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->readme)
+                        reporevlink("about", "about", NULL,
+                                    hc(cmd, "about"), ctx->qry.head, NULL,
+                                    NULL);
                 html("</td><td class='form'>");
                 html("<form class='right' method='get' action='");
                 if (ctx->cfg.virtual_root)
                         html_attr(cgit_fileurl(ctx->qry.repo, "log",
                                                ctx->qry.path, NULL));
                 html("'>\n");
                 add_hidden_formfields(1, 0, "log");
                 html("<select name='qt'>\n");
                 html_option("grep", "log msg", ctx->qry.grep);
                 html_option("author", "author", ctx->qry.grep);
                 html_option("committer", "committer", ctx->qry.grep);
                 html("</select>\n");
                 html("<input class='txt' type='text' size='10' name='q' value='");
                 html_attr(ctx->qry.search);
                 html("'/>\n");
                 html("<input type='submit' value='search'/>\n");
                 html("</form>\n");
         } else {
-                html("<a class='active' href='");
-                html_attr(cgit_rooturl());
-                html("'>index</a>\n");
+                site_link(NULL, "index", NULL, hc(cmd, "repolist"), NULL);
+                if (ctx->cfg.root_readme)
+                        site_link("about", "about", NULL, hc(cmd, "about"), NULL);
                 html("</td><td class='form'>");
                 html("<form method='get' action='");
                 html_attr(cgit_rooturl());
                 html("'>\n");
                 html("<input type='text' name='q' size='10' value='");
                 html_attr(ctx->qry.search);
                 html("'/>\n");
                 html("<input type='submit' value='search'/>\n");
                 html("</form>");
         }
         html("</td></tr></table>\n");
         html("<div class='content'>");
 }
 
 void cgit_print_filemode(unsigned short mode)
 {
         if (S_ISDIR(mode))
                 html("d");
         else if (S_ISLNK(mode))
                 html("l");
         else if (S_ISGITLINK(mode))
                 html("m");
         else
                 html("-");
diff --git a/ui-summary.c b/ui-summary.c
index 318148a..ad0b4a7 100644
--- a/ui-summary.c
+++ b/ui-summary.c
@@ -1,31 +1,35 @@
 /* ui-summary.c: functions for generating repo summary page
  *
  * Copyright (C) 2006 Lars Hjemli
  *
  * Licensed under GNU General Public License v2
  *   (see COPYING for full license text)
  */
 
 #include "cgit.h"
 #include "html.h"
 #include "ui-log.h"
 #include "ui-refs.h"
 
 void cgit_print_summary()
 {
-        if (ctx.repo->readme) {
-                html("<div id='summary'>");
-                html_include(ctx.repo->readme);
-                html("</div>");
-        }
         html("<table summary='repository info' class='list nowrap'>");
         cgit_print_branches(ctx.cfg.summary_branches);
         html("<tr class='nohover'><td colspan='4'>&nbsp;</td></tr>");
         cgit_print_tags(ctx.cfg.summary_tags);
         if (ctx.cfg.summary_log > 0) {
                 html("<tr class='nohover'><td colspan='4'>&nbsp;</td></tr>");
                 cgit_print_log(ctx.qry.head, 0, ctx.cfg.summary_log, NULL,
                                NULL, NULL, 0);
         }
         html("</table>");
 }
+
+void cgit_print_repo_readme()
+{
+        if (ctx.repo->readme) {
+                html("<div id='summary'>");
+                html_include(ctx.repo->readme);
+                html("</div>");
+        }
+}
diff --git a/ui-summary.h b/ui-summary.h
index 37aedd2..3e13039 100644
--- a/ui-summary.h
+++ b/ui-summary.h
@@ -1,6 +1,7 @@
 #ifndef UI_SUMMARY_H
 #define UI_SUMMARY_H
 
 extern void cgit_print_summary();
+extern void cgit_print_repo_readme();
 
 #endif /* UI_SUMMARY_H */