ui-snapshot: add dwimmery

When downloading a snapshot, the snapshot name will often contain the repo
name combined with a tag. This patch tries to exploit this so that the
correct revision is downloaded even if no specific revision is specified.

PS: this only occurs if neither 'h' nor 'id' is specified in the query-
string.

PPS: this also fixes a bug which occurs when trying to download a filename
with an unsupported suffix: it used to try to print an error message to
the user but failed since it didn't prepare the output properly.

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

3 files changed, 83 insertions, 15 deletions

diff --git a/cmd.c b/cmd.c
index a989220..5b3c14c 100644
--- a/cmd.c
+++ b/cmd.c
@@ -1,165 +1,165 @@
 /* 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-atom.h"
 #include "ui-blob.h"
 #include "ui-clone.h"
 #include "ui-commit.h"
 #include "ui-diff.h"
 #include "ui-log.h"
 #include "ui-patch.h"
 #include "ui-plain.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 HEAD_fn(struct cgit_context *ctx)
 {
         cgit_clone_head(ctx);
 }
 
 static void atom_fn(struct cgit_context *ctx)
 {
         cgit_print_atom(ctx->qry.head, ctx->qry.path, 10);
 }
 
 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, ctx->qry.head);
 }
 
 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 info_fn(struct cgit_context *ctx)
 {
         cgit_clone_info(ctx);
 }
 
 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 objects_fn(struct cgit_context *ctx)
 {
         cgit_clone_objects(ctx);
 }
 
 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 plain_fn(struct cgit_context *ctx)
 {
         cgit_print_plain(ctx);
 }
 
 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);
+                            ctx->repo->snapshots, ctx->qry.nohead);
 }
 
 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(HEAD, 1, 0),
                 def_cmd(atom, 1, 0),
                 def_cmd(about, 0, 1),
                 def_cmd(blob, 1, 0),
                 def_cmd(commit, 1, 1),
                 def_cmd(diff, 1, 1),
                 def_cmd(info, 1, 0),
                 def_cmd(log, 1, 1),
                 def_cmd(ls_cache, 0, 0),
                 def_cmd(objects, 1, 0),
                 def_cmd(patch, 1, 0),
                 def_cmd(plain, 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;
 }
diff --git a/ui-snapshot.c b/ui-snapshot.c
index 7a597ff..9c4d086 100644
--- a/ui-snapshot.c
+++ b/ui-snapshot.c
@@ -1,120 +1,188 @@
 /* ui-snapshot.c: generate snapshot of a commit
  *
  * 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-shared.h"
 
 static int write_compressed_tar_archive(struct archiver_args *args,const char *filter)
 {
         int rw[2];
         pid_t gzpid;
         int stdout2;
         int status;
         int rv;
 
         stdout2 = chk_non_negative(dup(STDIN_FILENO), "Preserving STDOUT before compressing");
         chk_zero(pipe(rw), "Opening pipe from compressor subprocess");
         gzpid = chk_non_negative(fork(), "Forking compressor subprocess");
         if(gzpid==0) {
                 /* child */
                 chk_zero(close(rw[1]), "Closing write end of pipe in child");
                 chk_zero(close(STDIN_FILENO), "Closing STDIN");
                 chk_non_negative(dup2(rw[0],STDIN_FILENO), "Redirecting compressor input to stdin");
                 execlp(filter,filter,NULL);
                 _exit(-1);
         }
         /* parent */
         chk_zero(close(rw[0]), "Closing read end of pipe");
         chk_non_negative(dup2(rw[1],STDOUT_FILENO), "Redirecting output to compressor");
 
         rv = write_tar_archive(args);
 
         chk_zero(close(STDOUT_FILENO), "Closing STDOUT redirected to compressor");
         chk_non_negative(dup2(stdout2,STDOUT_FILENO), "Restoring uncompressed STDOUT");
         chk_zero(close(stdout2), "Closing uncompressed STDOUT");
         chk_zero(close(rw[1]), "Closing write end of pipe in parent");
         chk_positive(waitpid(gzpid,&status,0), "Waiting on compressor process");
         if(! ( WIFEXITED(status) && WEXITSTATUS(status)==0 ) )
                 cgit_print_error("Failed to compress archive");
 
         return rv;
 }
 
 static int write_tar_gzip_archive(struct archiver_args *args)
 {
         return write_compressed_tar_archive(args,"gzip");
 }
 
 static int write_tar_bzip2_archive(struct archiver_args *args)
 {
         return write_compressed_tar_archive(args,"bzip2");
 }
 
 const struct cgit_snapshot_format cgit_snapshot_formats[] = {
         { ".zip", "application/x-zip", write_zip_archive, 0x1 },
         { ".tar.gz", "application/x-tar", write_tar_gzip_archive, 0x2 },
         { ".tar.bz2", "application/x-tar", write_tar_bzip2_archive, 0x4 },
         { ".tar", "application/x-tar", write_tar_archive, 0x8 },
         {}
 };
 
+static const struct cgit_snapshot_format *get_format(const char *filename)
+{
+        const struct cgit_snapshot_format *fmt;
+        int fl, sl;
+
+        fl = strlen(filename);
+        for(fmt = cgit_snapshot_formats; fmt->suffix; fmt++) {
+                sl = strlen(fmt->suffix);
+                if (sl >= fl)
+                        continue;
+                if (!strcmp(fmt->suffix, filename + fl - sl))
+                        return fmt;
+        }
+        return NULL;
+}
+
 static int make_snapshot(const struct cgit_snapshot_format *format,
                          const char *hex, const char *prefix,
                          const char *filename)
 {
         struct archiver_args args;
         struct commit *commit;
         unsigned char sha1[20];
 
         if(get_sha1(hex, sha1)) {
                 cgit_print_error(fmt("Bad object id: %s", hex));
                 return 1;
         }
         commit = lookup_commit_reference(sha1);
         if(!commit) {
                 cgit_print_error(fmt("Not a commit reference: %s", hex));
                 return 1;
         }
         memset(&args, 0, sizeof(args));
         if (prefix) {
                 args.base = fmt("%s/", prefix);
                 args.baselen = strlen(prefix) + 1;
         } else {
                 args.base = "";
                 args.baselen = 0;
         }
         args.tree = commit->tree;
         args.time = commit->date;
         ctx.page.mimetype = xstrdup(format->mimetype);
         ctx.page.filename = xstrdup(filename);
         cgit_print_http_headers(&ctx);
         format->write_func(&args);
         return 0;
 }
 
+char *dwim_filename = NULL;
+const char *dwim_refname = NULL;
+
+static int ref_cb(const char *refname, const unsigned char *sha1, int flags,
+                  void *cb_data)
+{
+        const char *r = refname;
+        while (r && *r) {
+                fprintf(stderr, "  cmp %s with %s:", dwim_filename, r);
+                if (!strcmp(dwim_filename, r)) {
+                        fprintf(stderr, "MATCH!\n");
+                        dwim_refname = refname;
+                        return 1;
+                }
+                fprintf(stderr, "no match\n");
+                if (isdigit(*r))
+                        break;
+                r++;
+        }
+        return 0;
+}
+
+/* Try to guess the requested revision by combining repo name and tag name
+ * and comparing this to the requested snapshot name. E.g. the requested
+ * snapshot is "cgit-0.7.2.tar.gz" while repo name is "cgit" and tag name
+ * is "v0.7.2". First, the reponame is stripped off, leaving "-0.7.2.tar.gz".
+ * Next, any '-' and '_' characters are stripped, leaving "0.7.2.tar.gz".
+ * Finally, the requested format suffix is removed and we end up with "0.7.2".
+ * Then we test each tag against this dwimmed filename, and for each tag
+ * we even try to remove any leading characters which are non-digits. I.e.
+ * we first compare with "v0.7.2", then with "0.7.2" and we've got a match.
+ */
+static const char *get_ref_from_filename(const char *url, const char *filename,
+                                         const struct cgit_snapshot_format *fmt)
+{
+        const char *reponame = cgit_repobasename(url);
+        fprintf(stderr, "reponame=%s, filename=%s\n", reponame, filename);
+        if (prefixcmp(filename, reponame))
+                return NULL;
+        filename += strlen(reponame);
+        while (filename && (*filename == '-' || *filename == '_'))
+                filename++;
+        dwim_filename = xstrdup(filename);
+        dwim_filename[strlen(filename) - strlen(fmt->suffix)] = '\0';
+        for_each_tag_ref(ref_cb, NULL);
+        return dwim_refname;
+}
+
 void cgit_print_snapshot(const char *head, const char *hex, const char *prefix,
-                         const char *filename, int snapshots)
+                         const char *filename, int snapshots, int dwim)
 {
         const struct cgit_snapshot_format* f;
-        int sl, fnl;
 
-        fnl = strlen(filename);
-        if (!hex)
-                hex = head;
-        for (f = cgit_snapshot_formats; f->suffix; f++) {
-                if (!(snapshots & f->bit))
-                        continue;
-                sl = strlen(f->suffix);
-                if(fnl < sl || strcmp(&filename[fnl-sl], f->suffix))
-                        continue;
-                make_snapshot(f, hex, prefix, filename);
+        f = get_format(filename);
+        if (!f) {
+                ctx.page.mimetype = "text/html";
+                cgit_print_http_headers(&ctx);
+                cgit_print_docstart(&ctx);
+                cgit_print_pageheader(&ctx);
+                cgit_print_error(fmt("Unsupported snapshot format: %s", filename));
+                cgit_print_docend();
                 return;
         }
-        cgit_print_error(fmt("Unsupported snapshot format: %s", filename));
+
+        if (!hex && dwim)
+                hex = get_ref_from_filename(ctx.repo->url, filename, f);
+
+        if (!hex)
+                hex = head;
+
+        make_snapshot(f, hex, prefix, filename);
 }
diff --git a/ui-snapshot.h b/ui-snapshot.h
index 6e03761..3540303 100644
--- a/ui-snapshot.h
+++ b/ui-snapshot.h
@@ -1,8 +1,8 @@
 #ifndef UI_SNAPSHOT_H
 #define UI_SNAPSHOT_H
 
 extern void cgit_print_snapshot(const char *head, const char *hex,
                                 const char *prefix, const char *filename,
-                                int snapshot);
+                                int snapshot, int dwim);
 
 #endif /* UI_SNAPSHOT_H */