filters: import more modern scripts

[cgit.git] / ui-snapshot.c

diff --git a/ui-snapshot.c b/ui-snapshot.c
index c7414691290eef3dc335c237810d07e3524f5907..42b7489d5b4048248b9223cfc14a437fabdeba09 100644 (file)
--- a/ui-snapshot.c
+++ b/ui-snapshot.c
@@ -1,159 +1,237 @@
 /* ui-snapshot.c: generate snapshot of a commit
  *
  * Copyright (C) 2006 Lars Hjemli
 /* ui-snapshot.c: generate snapshot of a commit
  *
  * Copyright (C) 2006 Lars Hjemli

+ * Copyright (C) 2012 Jason A. Donenfeld <Jason@zx2c4.com>

  *
  * Licensed under GNU General Public License v2
  *   (see COPYING for full license text)
  */
 
 #include "cgit.h"
  *
  * Licensed under GNU General Public License v2
  *   (see COPYING for full license text)
  */
 
 #include "cgit.h"

+#include "ui-snapshot.h"

 #include "html.h"
 #include "html.h"

+#include "ui-shared.h"

 
 

-static int write_compressed_tar_archive(struct archiver_args *args,const char *filter)
+static int write_archive_type(const char *format, const char *hex, const char *prefix)

 {
 {

-       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);
+       struct argv_array argv = ARGV_ARRAY_INIT;
+       const char **nargv;
+       int result;
+       argv_array_push(&argv, "snapshot");
+       argv_array_push(&argv, format);
+       if (prefix) {
+               struct strbuf buf = STRBUF_INIT;
+               strbuf_addstr(&buf, prefix);
+               strbuf_addch(&buf, '/');
+               argv_array_push(&argv, "--prefix");
+               argv_array_push(&argv, buf.buf);
+               strbuf_release(&buf);

        }
        }

-       /* parent */
-       chk_zero(close(rw[0]), "Closing read end of pipe");
-       chk_non_negative(dup2(rw[1],STDOUT_FILENO), "Redirecting output to compressor");
+       argv_array_push(&argv, hex);
+       /*
+        * Now we need to copy the pointers to arguments into a new
+        * structure because write_archive will rearrange its arguments
+        * which may result in duplicated/missing entries causing leaks
+        * or double-frees in argv_array_clear.
+        */
+       nargv = xmalloc(sizeof(char *) * (argv.argc + 1));
+       /* argv_array guarantees a trailing NULL entry. */
+       memcpy(nargv, argv.argv, sizeof(char *) * (argv.argc + 1));
+
+       result = write_archive(argv.argc, nargv, NULL, 1, NULL, 0);
+       argv_array_clear(&argv);
+       free(nargv);
+       return result;
+}

 
 

-       rv = write_tar_archive(args);
+static int write_tar_archive(const char *hex, const char *prefix)
+{
+       return write_archive_type("--format=tar", hex, prefix);
+}

 
 

-       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");
+static int write_zip_archive(const char *hex, const char *prefix)
+{
+       return write_archive_type("--format=zip", hex, prefix);
+}

 
 

+static int write_compressed_tar_archive(const char *hex,
+                                       const char *prefix,
+                                       char *filter_argv[])
+{
+       int rv;
+       struct cgit_filter f;
+
+       f.cmd = filter_argv[0];
+       f.argv = filter_argv;
+       cgit_open_filter(&f);
+       rv = write_tar_archive(hex, prefix);
+       cgit_close_filter(&f);

        return rv;
 }
 
        return rv;
 }
 

-static int write_tar_gzip_archive(struct archiver_args *args)
+static int write_tar_gzip_archive(const char *hex, const char *prefix)

 {
 {

-       return write_compressed_tar_archive(args,"gzip");
+       char *argv[] = { "gzip", "-n", NULL };
+       return write_compressed_tar_archive(hex, prefix, argv);

 }
 
 }
 

-static int write_tar_bzip2_archive(struct archiver_args *args)
+static int write_tar_bzip2_archive(const char *hex, const char *prefix)

 {
 {

-       return write_compressed_tar_archive(args,"bzip2");
+       char *argv[] = { "bzip2", NULL };
+       return write_compressed_tar_archive(hex, prefix, argv);

 }
 
 }
 

-static const struct snapshot_archive_t {
-       const char *suffix;
-       const char *mimetype;
-       write_archive_fn_t write_func;
-       int bit;
-}      snapshot_archives[] = {
-       { ".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 int write_tar_xz_archive(const char *hex, const char *prefix)
+{
+       char *argv[] = { "xz", NULL };
+       return write_compressed_tar_archive(hex, prefix, argv);
+}

 
 

-#define snapshot_archives_len (sizeof(snapshot_archives) / sizeof(*snapshot_archives))
+const struct cgit_snapshot_format cgit_snapshot_formats[] = {
+       { ".zip", "application/x-zip", write_zip_archive, 0x01 },
+       { ".tar.gz", "application/x-gzip", write_tar_gzip_archive, 0x02 },
+       { ".tar.bz2", "application/x-bzip2", write_tar_bzip2_archive, 0x04 },
+       { ".tar", "application/x-tar", write_tar_archive, 0x08 },
+       { ".tar.xz", "application/x-xz", write_tar_xz_archive, 0x10 },
+       { NULL }
+};

 
 

-void cgit_print_snapshot(const char *head, const char *hex, const char *prefix,
-                        const char *filename, int snapshots)
+static const struct cgit_snapshot_format *get_format(const char *filename)

 {
 {

-       const struct snapshot_archive_t* sat;
-       struct archiver_args args;
-       struct commit *commit;
-       unsigned char sha1[20];
-       int f, sl, fnl = strlen(filename);
+       const struct cgit_snapshot_format *fmt;
+       int fl, sl;

 
 

-       for(f=0; f<snapshot_archives_len; f++) {
-               sat = &snapshot_archives[f];
-               if(!(snapshots & sat->bit))
+       fl = strlen(filename);
+       for (fmt = cgit_snapshot_formats; fmt->suffix; fmt++) {
+               sl = strlen(fmt->suffix);
+               if (sl >= fl)

                        continue;
                        continue;

-               sl = strlen(sat->suffix);
-               if(fnl<sl || strcmp(&filename[fnl-sl],sat->suffix))
-                       continue;
-               if (!hex)
-                       hex = head;
-               if(get_sha1(hex, sha1)) {
-                       cgit_print_error(fmt("Bad object id: %s", hex));
-                       return;
-               }
-               commit = lookup_commit_reference(sha1);
-               if(!commit) {
-                       cgit_print_error(fmt("Not a commit reference: %s", hex));
-                       return;;
-               }
-               memset(&args,0,sizeof(args));
-               args.base = fmt("%s/", prefix);
-               args.tree = commit->tree;
-               args.time = commit->date;
-               ctx.page.mimetype = xstrdup(sat->mimetype);
-               ctx.page.filename = xstrdup(filename);
-               cgit_print_http_headers(&ctx);
-               (*sat->write_func)(&args);
-               return;
+               if (!strcmp(fmt->suffix, filename + fl - sl))
+                       return fmt;

        }
        }

-       cgit_print_error(fmt("Unsupported snapshot format: %s", filename));
+       return NULL;

 }
 
 }
 

-void cgit_print_snapshot_links(const char *repo, const char *head,
-                              const char *hex, int snapshots)
+static int make_snapshot(const struct cgit_snapshot_format *format,
+                        const char *hex, const char *prefix,
+                        const char *filename)

 {
 {

-       const struct snapshot_archive_t* sat;
-       char *filename;
-       int f;
+       unsigned char sha1[20];

 
 

-       for(f=0; f<snapshot_archives_len; f++) {
-               sat = &snapshot_archives[f];
-               if(!(snapshots & sat->bit))
-                       continue;
-               filename = fmt("%s-%s%s", cgit_repobasename(repo), hex,
-                              sat->suffix);
-               cgit_snapshot_link(filename, NULL, NULL, (char *)head,
-                                  (char *)hex, filename);
-               html("<br/>");
+       if (get_sha1(hex, sha1)) {
+               cgit_print_error("Bad object id: %s", hex);
+               return 1;
+       }
+       if (!lookup_commit_reference(sha1)) {
+               cgit_print_error("Not a commit reference: %s", hex);
+               return 1;
+       }
+       ctx.page.mimetype = xstrdup(format->mimetype);
+       ctx.page.filename = xstrdup(filename);
+       cgit_print_http_headers(&ctx);
+       format->write_func(hex, prefix);
+       return 0;
+}
+
+/* Try to guess the requested revision from the requested snapshot name.
+ * First the format extension is stripped, e.g. "cgit-0.7.2.tar.gz" become
+ * "cgit-0.7.2". If this is a valid commit object name we've got a winner.
+ * Otherwise, if the snapshot name has a prefix matching the result from
+ * repo_basename(), we strip the basename and any following '-' and '_'
+ * characters ("cgit-0.7.2" -> "0.7.2") and check the resulting name once
+ * more. If this still isn't a valid commit object name, we check if pre-
+ * pending a 'v' or a 'V' to the remaining snapshot name ("0.7.2" ->
+ * "v0.7.2") gives us something valid.
+ */
+static const char *get_ref_from_filename(const char *url, const char *filename,
+                                        const struct cgit_snapshot_format *format)
+{
+       const char *reponame;
+       unsigned char sha1[20];
+       struct strbuf snapshot = STRBUF_INIT;
+       int result = 1;
+
+       strbuf_addstr(&snapshot, filename);
+       strbuf_setlen(&snapshot, snapshot.len - strlen(format->suffix));
+
+       if (get_sha1(snapshot.buf, sha1) == 0)
+               goto out;
+
+       reponame = cgit_repobasename(url);
+       if (prefixcmp(snapshot.buf, reponame) == 0) {
+               const char *new_start = snapshot.buf;
+               new_start += strlen(reponame);
+               while (new_start && (*new_start == '-' || *new_start == '_'))
+                       new_start++;
+               strbuf_splice(&snapshot, 0, new_start - snapshot.buf, "", 0);

        }
        }

+
+       if (get_sha1(snapshot.buf, sha1) == 0)
+               goto out;
+
+       strbuf_insert(&snapshot, 0, "v", 1);
+       if (get_sha1(snapshot.buf, sha1) == 0)
+               goto out;
+
+       strbuf_splice(&snapshot, 0, 1, "V", 1);
+       if (get_sha1(snapshot.buf, sha1) == 0)
+               goto out;
+
+       result = 0;
+       strbuf_release(&snapshot);
+
+out:
+       return result ? strbuf_detach(&snapshot, NULL) : NULL;

 }
 
 }
 

-int cgit_parse_snapshots_mask(const char *str)
+__attribute__((format (printf, 1, 2)))
+static void show_error(char *fmt, ...)

 {
 {

-       const struct snapshot_archive_t* sat;
-       static const char *delim = " \t,:/|;";
-       int f, tl, sl, rv = 0;
+       va_list ap;
+
+       ctx.page.mimetype = "text/html";
+       cgit_print_http_headers(&ctx);
+       cgit_print_docstart(&ctx);
+       cgit_print_pageheader(&ctx);
+       va_start(ap, fmt);
+       cgit_vprint_error(fmt, ap);
+       va_end(ap);
+       cgit_print_docend();
+}

 
 

-       /* favor legacy setting */
-       if(atoi(str))
-               return 1;
-       for(;;) {
-               str += strspn(str,delim);
-               tl = strcspn(str,delim);
-               if(!tl)
-                       break;
-               for(f=0; f<snapshot_archives_len; f++) {
-                       sat = &snapshot_archives[f];
-                       sl = strlen(sat->suffix);
-                       if((tl == sl && !strncmp(sat->suffix, str, tl)) ||
-                          (tl == sl-1 && !strncmp(sat->suffix+1, str, tl-1))) {
-                               rv |= sat->bit;
-                               break;
-                       }
+void cgit_print_snapshot(const char *head, const char *hex,
+                        const char *filename, int snapshots, int dwim)
+{
+       const struct cgit_snapshot_format* f;
+       char *prefix = NULL;
+
+       if (!filename) {
+               show_error("No snapshot name specified");
+               return;
+       }
+
+       f = get_format(filename);
+       if (!f) {
+               show_error("Unsupported snapshot format: %s", filename);
+               return;
+       }
+
+       if (!hex && dwim) {
+               hex = get_ref_from_filename(ctx.repo->url, filename, f);
+               if (hex == NULL) {
+                       html_status(404, "Not found", 0);
+                       return;

                }
                }

-               str += tl;
+               prefix = xstrdup(filename);
+               prefix[strlen(filename) - strlen(f->suffix)] = '\0';

        }
        }

-       return rv;
-}

 
 

-/* vim:set sw=8: */
+       if (!hex)
+               hex = head;
+
+       if (!prefix)
+               prefix = xstrdup(cgit_repobasename(ctx.repo->url));
+
+       make_snapshot(f, hex, prefix, filename);
+       free(prefix);
+}