Add page 'ls_cache'

This new page will list all entries found in the current cache, which is
useful when reviewing the new cache implementation. There are no links to
the new page, but it's reachable by adding 'p=ls_cache' to any cgit url.

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

3 files changed, 87 insertions, 5 deletions

diff --git a/cache.c b/cache.c
index e590d7b..b701e13 100644
--- a/cache.c
+++ b/cache.c
@@ -239,105 +239,173 @@ static int process_slot(struct cache_slot *slot)
                 }
                 print_slot(slot);
                 close_slot(slot);
                 return 0;
         }
 
         /* If the cache slot does not exist (or its key doesn't match the
          * current key), lets try to create a new cache slot for this
          * request. If this fails (for whatever reason), lets just generate
          * the content without caching it and fool the caller to belive
          * everything worked out (but print a warning on stdout).
          */
 
         close_slot(slot);
         if ((err = lock_slot(slot)) != 0) {
                 cache_log("[cgit] Unable to lock slot %s: %s (%d)\n",
                           slot->lock_name, strerror(err), err);
                 slot->fn(slot->cbdata);
                 return 0;
         }
 
         if ((err = fill_slot(slot)) != 0) {
                 cache_log("[cgit] Unable to fill slot %s: %s (%d)\n",
                           slot->lock_name, strerror(err), err);
                 unlock_slot(slot, 0);
                 close_lock(slot);
                 slot->fn(slot->cbdata);
                 return 0;
         }
         // We've got a valid cache slot in the lock file, which
         // is about to replace the old cache slot. But if we
         // release the lockfile and then try to open the new cache
         // slot, we might get a race condition with a concurrent
         // writer for the same cache slot (with a different key).
         // Lets avoid such a race by just printing the content of
         // the lock file.
         slot->cache_fd = slot->lock_fd;
         unlock_slot(slot, 1);
         err = print_slot(slot);
         close_slot(slot);
         return err;
 }
 
 /* Print cached content to stdout, generate the content if necessary. */
 int cache_process(int size, const char *path, const char *key, int ttl,
                   cache_fill_fn fn, void *cbdata)
 {
         unsigned long hash;
         int len, i;
         char filename[1024];
         char lockname[1024 + 5];  /* 5 = ".lock" */
         struct cache_slot slot;
 
         /* If the cache is disabled, just generate the content */
         if (size <= 0) {
                 fn(cbdata);
                 return 0;
         }
 
         /* Verify input, calculate filenames */
         if (!path) {
                 cache_log("[cgit] Cache path not specified, caching is disabled\n");
                 fn(cbdata);
                 return 0;
         }
         len = strlen(path);
         if (len > sizeof(filename) - 10) { /* 10 = "/01234567\0" */
                 cache_log("[cgit] Cache path too long, caching is disabled: %s\n",
                           path);
                 fn(cbdata);
                 return 0;
         }
         if (!key)
                 key = "";
         hash = hash_str(key) % size;
         strcpy(filename, path);
         if (filename[len - 1] != '/')
                 filename[len++] = '/';
         for(i = 0; i < 8; i++) {
                 sprintf(filename + len++, "%x",
                         (unsigned char)(hash & 0xf));
                 hash >>= 4;
         }
         filename[len] = '\0';
         strcpy(lockname, filename);
         strcpy(lockname + len, ".lock");
         slot.fn = fn;
         slot.cbdata = cbdata;
         slot.ttl = ttl;
         slot.cache_name = filename;
         slot.lock_name = lockname;
         slot.key = key;
         slot.keylen = strlen(key);
         return process_slot(&slot);
 }
 
+/* Return a strftime formatted date/time
+ * NB: the result from this function is to shared memory
+ */
+char *sprintftime(const char *format, time_t time)
+{
+        static char buf[64];
+        struct tm *tm;
+
+        if (!time)
+                return NULL;
+        tm = gmtime(&time);
+        strftime(buf, sizeof(buf)-1, format, tm);
+        return buf;
+}
+
+int cache_ls(const char *path)
+{
+        DIR *dir;
+        struct dirent *ent;
+        int err = 0;
+        struct cache_slot slot;
+        char fullname[1024];
+        char *name;
+
+        if (!path) {
+                cache_log("[cgit] cache path not specified\n");
+                return -1;
+        }
+        if (strlen(path) > 1024 - 10) {
+                cache_log("[cgit] cache path too long: %s\n",
+                          path);
+                return -1;
+        }
+        dir = opendir(path);
+        if (!dir) {
+                err = errno;
+                cache_log("[cgit] unable to open path %s: %s (%d)\n",
+                          path, strerror(err), err);
+                return err;
+        }
+        strcpy(fullname, path);
+        name = fullname + strlen(path);
+        if (*(name - 1) != '/') {
+                *name++ = '/';
+                *name = '\0';
+        }
+        slot.cache_name = fullname;
+        while((ent = readdir(dir)) != NULL) {
+                if (strlen(ent->d_name) != 8)
+                        continue;
+                strcpy(name, ent->d_name);
+                if ((err = open_slot(&slot)) != 0) {
+                        cache_log("[cgit] unable to open path %s: %s (%d)\n",
+                                  fullname, strerror(err), err);
+                        continue;
+                }
+                printf("%s %s %10lld %s\n",
+                       name,
+                       sprintftime("%Y-%m-%d %H:%M:%S",
+                                   slot.cache_st.st_mtime),
+                       slot.cache_st.st_size,
+                       slot.buf);
+                close_slot(&slot);
+        }
+        closedir(dir);
+        return 0;
+}
+
 /* Print a message to stdout */
 void cache_log(const char *format, ...)
 {
         va_list args;
         va_start(args, format);
         vfprintf(stderr, format, args);
         va_end(args);
 }
 
diff --git a/cache.h b/cache.h
index 5f2178d..66cc41f 100644
--- a/cache.h
+++ b/cache.h
@@ -1,32 +1,35 @@
 /*
  * Since git has it's own cache.h which we include,
  * lets test on CGIT_CACHE_H to avoid confusion
  */
 
 #ifndef CGIT_CACHE_H
 #define CGIT_CACHE_H
 
 typedef void (*cache_fill_fn)(void *cbdata);
 
 
 /* Print cached content to stdout, generate the content if necessary.
  *
  * Parameters
  *   size    max number of cache files
  *   path    directory used to store cache files
  *   key     the key used to lookup cache files
  *   ttl     max cache time in seconds for this key
  *   fn      content generator function for this key
  *   cbdata  user-supplied data to the content generator function
  *
  * Return value
  *   0 indicates success, everyting else is an error
  */
 extern int cache_process(int size, const char *path, const char *key, int ttl,
                          cache_fill_fn fn, void *cbdata);
 
 
+/* List info about all cache entries on stdout */
+extern int cache_ls(const char *path);
+
 /* Print a message to stdout */
 extern void cache_log(const char *format, ...);
 
 #endif /* CGIT_CACHE_H */
diff --git a/cmd.c b/cmd.c
index e0eacbe..07f4707 100644
--- a/cmd.c
+++ b/cmd.c
@@ -1,112 +1,123 @@
 /* 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 "cache.h"
+#include "ui-shared.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 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);
 }
 
+static void ls_cache_fn(struct cgit_context *ctx)
+{
+        ctx->page.mimetype = "text/plain";
+        ctx->page.filename = "ls-cache.txt";
+        cgit_print_http_headers(ctx);
+        cache_ls(ctx->cfg.cache_root);
+}
+
+static void repolist_fn(struct cgit_context *ctx)
+{
+        cgit_print_repolist();
+}
+
 static void patch_fn(struct cgit_context *ctx)
 {
         cgit_print_patch(ctx->qry.sha1);
 }
 
 static void refs_fn(struct cgit_context *ctx)
 {
         cgit_print_refs();
 }
 
 static void snapshot_fn(struct cgit_context *ctx)
 {
         cgit_print_snapshot(ctx->qry.head, ctx->qry.sha1,
                             cgit_repobasename(ctx->repo->url), ctx->qry.path,
                             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(blob, 1, 0),
                 def_cmd(commit, 1, 1),
                 def_cmd(diff, 1, 1),
                 def_cmd(log, 1, 1),
+                def_cmd(ls_cache, 0, 0),
                 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];
         return NULL;
 }