Andrew's git - gitweb.git/blob

   1#include "cache.h"
   2#include "commit.h"
   3#include "tree-walk.h"
   4#include "attr.h"
   5#include "archive.h"
   6#include "parse-options.h"
   7#include "unpack-trees.h"
   8#include "pathspec.h"
   9
  10static char const * const archive_usage[] = {
  11        N_("git archive [options] <tree-ish> [<path>...]"),
  12        N_("git archive --list"),
  13        N_("git archive --remote <repo> [--exec <cmd>] [options] <tree-ish> [<path>...]"),
  14        N_("git archive --remote <repo> [--exec <cmd>] --list"),
  15        NULL
  16};
  17
  18static const struct archiver **archivers;
  19static int nr_archivers;
  20static int alloc_archivers;
  21
  22void register_archiver(struct archiver *ar)
  23{
  24        ALLOC_GROW(archivers, nr_archivers + 1, alloc_archivers);
  25        archivers[nr_archivers++] = ar;
  26}
  27
  28static void format_subst(const struct commit *commit,
  29                         const char *src, size_t len,
  30                         struct strbuf *buf)
  31{
  32        char *to_free = NULL;
  33        struct strbuf fmt = STRBUF_INIT;
  34        struct pretty_print_context ctx = {0};
  35        ctx.date_mode = DATE_NORMAL;
  36        ctx.abbrev = DEFAULT_ABBREV;
  37
  38        if (src == buf->buf)
  39                to_free = strbuf_detach(buf, NULL);
  40        for (;;) {
  41                const char *b, *c;
  42
  43                b = memmem(src, len, "$Format:", 8);
  44                if (!b)
  45                        break;
  46                c = memchr(b + 8, '$', (src + len) - b - 8);
  47                if (!c)
  48                        break;
  49
  50                strbuf_reset(&fmt);
  51                strbuf_add(&fmt, b + 8, c - b - 8);
  52
  53                strbuf_add(buf, src, b - src);
  54                format_commit_message(commit, fmt.buf, buf, &ctx);
  55                len -= c + 1 - src;
  56                src  = c + 1;
  57        }
  58        strbuf_add(buf, src, len);
  59        strbuf_release(&fmt);
  60        free(to_free);
  61}
  62
  63void *sha1_file_to_archive(const struct archiver_args *args,
  64                           const char *path, const unsigned char *sha1,
  65                           unsigned int mode, enum object_type *type,
  66                           unsigned long *sizep)
  67{
  68        void *buffer;
  69        const struct commit *commit = args->convert ? args->commit : NULL;
  70
  71        path += args->baselen;
  72        buffer = read_sha1_file(sha1, type, sizep);
  73        if (buffer && S_ISREG(mode)) {
  74                struct strbuf buf = STRBUF_INIT;
  75                size_t size = 0;
  76
  77                strbuf_attach(&buf, buffer, *sizep, *sizep + 1);
  78                convert_to_working_tree(path, buf.buf, buf.len, &buf);
  79                if (commit)
  80                        format_subst(commit, buf.buf, buf.len, &buf);
  81                buffer = strbuf_detach(&buf, &size);
  82                *sizep = size;
  83        }
  84
  85        return buffer;
  86}
  87
  88static void setup_archive_check(struct git_attr_check *check)
  89{
  90        static struct git_attr *attr_export_ignore;
  91        static struct git_attr *attr_export_subst;
  92
  93        if (!attr_export_ignore) {
  94                attr_export_ignore = git_attr("export-ignore");
  95                attr_export_subst = git_attr("export-subst");
  96        }
  97        check[0].attr = attr_export_ignore;
  98        check[1].attr = attr_export_subst;
  99}
 100
 101struct archiver_context {
 102        struct archiver_args *args;
 103        write_archive_entry_fn_t write_entry;
 104};
 105
 106static int write_archive_entry(const unsigned char *sha1, const char *base,
 107                int baselen, const char *filename, unsigned mode, int stage,
 108                void *context)
 109{
 110        static struct strbuf path = STRBUF_INIT;
 111        struct archiver_context *c = context;
 112        struct archiver_args *args = c->args;
 113        write_archive_entry_fn_t write_entry = c->write_entry;
 114        struct git_attr_check check[2];
 115        const char *path_without_prefix;
 116        int err;
 117
 118        args->convert = 0;
 119        strbuf_reset(&path);
 120        strbuf_grow(&path, PATH_MAX);
 121        strbuf_add(&path, args->base, args->baselen);
 122        strbuf_add(&path, base, baselen);
 123        strbuf_addstr(&path, filename);
 124        if (S_ISDIR(mode) || S_ISGITLINK(mode))
 125                strbuf_addch(&path, '/');
 126        path_without_prefix = path.buf + args->baselen;
 127
 128        setup_archive_check(check);
 129        if (!git_check_attr(path_without_prefix, ARRAY_SIZE(check), check)) {
 130                if (ATTR_TRUE(check[0].value))
 131                        return 0;
 132                args->convert = ATTR_TRUE(check[1].value);
 133        }
 134
 135        if (S_ISDIR(mode) || S_ISGITLINK(mode)) {
 136                if (args->verbose)
 137                        fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
 138                err = write_entry(args, sha1, path.buf, path.len, mode);
 139                if (err)
 140                        return err;
 141                return (S_ISDIR(mode) ? READ_TREE_RECURSIVE : 0);
 142        }
 143
 144        if (args->verbose)
 145                fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
 146        return write_entry(args, sha1, path.buf, path.len, mode);
 147}
 148
 149int write_archive_entries(struct archiver_args *args,
 150                write_archive_entry_fn_t write_entry)
 151{
 152        struct archiver_context context;
 153        struct unpack_trees_options opts;
 154        struct tree_desc t;
 155        struct pathspec pathspec;
 156        int err;
 157
 158        if (args->baselen > 0 && args->base[args->baselen - 1] == '/') {
 159                size_t len = args->baselen;
 160
 161                while (len > 1 && args->base[len - 2] == '/')
 162                        len--;
 163                if (args->verbose)
 164                        fprintf(stderr, "%.*s\n", (int)len, args->base);
 165                err = write_entry(args, args->tree->object.sha1, args->base,
 166                                  len, 040777);
 167                if (err)
 168                        return err;
 169        }
 170
 171        context.args = args;
 172        context.write_entry = write_entry;
 173
 174        /*
 175         * Setup index and instruct attr to read index only
 176         */
 177        if (!args->worktree_attributes) {
 178                memset(&opts, 0, sizeof(opts));
 179                opts.index_only = 1;
 180                opts.head_idx = -1;
 181                opts.src_index = &the_index;
 182                opts.dst_index = &the_index;
 183                opts.fn = oneway_merge;
 184                init_tree_desc(&t, args->tree->buffer, args->tree->size);
 185                if (unpack_trees(1, &t, &opts))
 186                        return -1;
 187                git_attr_set_direction(GIT_ATTR_INDEX, &the_index);
 188        }
 189
 190        init_pathspec(&pathspec, args->pathspec);
 191        err = read_tree_recursive(args->tree, "", 0, 0, &pathspec,
 192                                  write_archive_entry, &context);
 193        free_pathspec(&pathspec);
 194        if (err == READ_TREE_RECURSIVE)
 195                err = 0;
 196        return err;
 197}
 198
 199static const struct archiver *lookup_archiver(const char *name)
 200{
 201        int i;
 202
 203        if (!name)
 204                return NULL;
 205
 206        for (i = 0; i < nr_archivers; i++) {
 207                if (!strcmp(name, archivers[i]->name))
 208                        return archivers[i];
 209        }
 210        return NULL;
 211}
 212
 213static int reject_entry(const unsigned char *sha1, const char *base,
 214                        int baselen, const char *filename, unsigned mode,
 215                        int stage, void *context)
 216{
 217        return -1;
 218}
 219
 220static int path_exists(struct tree *tree, const char *path)
 221{
 222        const char *paths[] = { path, NULL };
 223        struct pathspec pathspec;
 224        int ret;
 225
 226        init_pathspec(&pathspec, paths);
 227        ret = read_tree_recursive(tree, "", 0, 0, &pathspec, reject_entry, NULL);
 228        free_pathspec(&pathspec);
 229        return ret != 0;
 230}
 231
 232static void parse_pathspec_arg(const char **pathspec,
 233                struct archiver_args *ar_args)
 234{
 235        ar_args->pathspec = pathspec = get_pathspec("", pathspec);
 236        if (pathspec) {
 237                while (*pathspec) {
 238                        if (**pathspec && !path_exists(ar_args->tree, *pathspec))
 239                                die("path not found: %s", *pathspec);
 240                        pathspec++;
 241                }
 242        }
 243}
 244
 245static void parse_treeish_arg(const char **argv,
 246                struct archiver_args *ar_args, const char *prefix,
 247                int remote)
 248{
 249        const char *name = argv[0];
 250        const unsigned char *commit_sha1;
 251        time_t archive_time;
 252        struct tree *tree;
 253        const struct commit *commit;
 254        unsigned char sha1[20];
 255
 256        /* Remotes are only allowed to fetch actual refs */
 257        if (remote) {
 258                char *ref = NULL;
 259                const char *colon = strchr(name, ':');
 260                int refnamelen = colon ? colon - name : strlen(name);
 261
 262                if (!dwim_ref(name, refnamelen, sha1, &ref))
 263                        die("no such ref: %.*s", refnamelen, name);
 264                free(ref);
 265        }
 266
 267        if (get_sha1(name, sha1))
 268                die("Not a valid object name");
 269
 270        commit = lookup_commit_reference_gently(sha1, 1);
 271        if (commit) {
 272                commit_sha1 = commit->object.sha1;
 273                archive_time = commit->date;
 274        } else {
 275                commit_sha1 = NULL;
 276                archive_time = time(NULL);
 277        }
 278
 279        tree = parse_tree_indirect(sha1);
 280        if (tree == NULL)
 281                die("not a tree object");
 282
 283        if (prefix) {
 284                unsigned char tree_sha1[20];
 285                unsigned int mode;
 286                int err;
 287
 288                err = get_tree_entry(tree->object.sha1, prefix,
 289                                     tree_sha1, &mode);
 290                if (err || !S_ISDIR(mode))
 291                        die("current working directory is untracked");
 292
 293                tree = parse_tree_indirect(tree_sha1);
 294        }
 295        ar_args->tree = tree;
 296        ar_args->commit_sha1 = commit_sha1;
 297        ar_args->commit = commit;
 298        ar_args->time = archive_time;
 299}
 300
 301#define OPT__COMPR(s, v, h, p) \
 302        { OPTION_SET_INT, (s), NULL, (v), NULL, (h), \
 303          PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL, (p) }
 304#define OPT__COMPR_HIDDEN(s, v, p) \
 305        { OPTION_SET_INT, (s), NULL, (v), NULL, "", \
 306          PARSE_OPT_NOARG | PARSE_OPT_NONEG | PARSE_OPT_HIDDEN, NULL, (p) }
 307
 308static int parse_archive_args(int argc, const char **argv,
 309                const struct archiver **ar, struct archiver_args *args,
 310                const char *name_hint, int is_remote)
 311{
 312        const char *format = NULL;
 313        const char *base = NULL;
 314        const char *remote = NULL;
 315        const char *exec = NULL;
 316        const char *output = NULL;
 317        int compression_level = -1;
 318        int verbose = 0;
 319        int i;
 320        int list = 0;
 321        int worktree_attributes = 0;
 322        struct option opts[] = {
 323                OPT_GROUP(""),
 324                OPT_STRING(0, "format", &format, N_("fmt"), N_("archive format")),
 325                OPT_STRING(0, "prefix", &base, N_("prefix"),
 326                        N_("prepend prefix to each pathname in the archive")),
 327                OPT_STRING('o', "output", &output, N_("file"),
 328                        N_("write the archive to this file")),
 329                OPT_BOOL(0, "worktree-attributes", &worktree_attributes,
 330                        N_("read .gitattributes in working directory")),
 331                OPT__VERBOSE(&verbose, N_("report archived files on stderr")),
 332                OPT__COMPR('0', &compression_level, N_("store only"), 0),
 333                OPT__COMPR('1', &compression_level, N_("compress faster"), 1),
 334                OPT__COMPR_HIDDEN('2', &compression_level, 2),
 335                OPT__COMPR_HIDDEN('3', &compression_level, 3),
 336                OPT__COMPR_HIDDEN('4', &compression_level, 4),
 337                OPT__COMPR_HIDDEN('5', &compression_level, 5),
 338                OPT__COMPR_HIDDEN('6', &compression_level, 6),
 339                OPT__COMPR_HIDDEN('7', &compression_level, 7),
 340                OPT__COMPR_HIDDEN('8', &compression_level, 8),
 341                OPT__COMPR('9', &compression_level, N_("compress better"), 9),
 342                OPT_GROUP(""),
 343                OPT_BOOL('l', "list", &list,
 344                        N_("list supported archive formats")),
 345                OPT_GROUP(""),
 346                OPT_STRING(0, "remote", &remote, N_("repo"),
 347                        N_("retrieve the archive from remote repository <repo>")),
 348                OPT_STRING(0, "exec", &exec, N_("command"),
 349                        N_("path to the remote git-upload-archive command")),
 350                OPT_END()
 351        };
 352
 353        argc = parse_options(argc, argv, NULL, opts, archive_usage, 0);
 354
 355        if (remote)
 356                die("Unexpected option --remote");
 357        if (exec)
 358                die("Option --exec can only be used together with --remote");
 359        if (output)
 360                die("Unexpected option --output");
 361
 362        if (!base)
 363                base = "";
 364
 365        if (list) {
 366                for (i = 0; i < nr_archivers; i++)
 367                        if (!is_remote || archivers[i]->flags & ARCHIVER_REMOTE)
 368                                printf("%s\n", archivers[i]->name);
 369                exit(0);
 370        }
 371
 372        if (!format && name_hint)
 373                format = archive_format_from_filename(name_hint);
 374        if (!format)
 375                format = "tar";
 376
 377        /* We need at least one parameter -- tree-ish */
 378        if (argc < 1)
 379                usage_with_options(archive_usage, opts);
 380        *ar = lookup_archiver(format);
 381        if (!*ar || (is_remote && !((*ar)->flags & ARCHIVER_REMOTE)))
 382                die("Unknown archive format '%s'", format);
 383
 384        args->compression_level = Z_DEFAULT_COMPRESSION;
 385        if (compression_level != -1) {
 386                if ((*ar)->flags & ARCHIVER_WANT_COMPRESSION_LEVELS)
 387                        args->compression_level = compression_level;
 388                else {
 389                        die("Argument not supported for format '%s': -%d",
 390                                        format, compression_level);
 391                }
 392        }
 393        args->verbose = verbose;
 394        args->base = base;
 395        args->baselen = strlen(base);
 396        args->worktree_attributes = worktree_attributes;
 397
 398        return argc;
 399}
 400
 401int write_archive(int argc, const char **argv, const char *prefix,
 402                  int setup_prefix, const char *name_hint, int remote)
 403{
 404        int nongit = 0;
 405        const struct archiver *ar = NULL;
 406        struct archiver_args args;
 407
 408        if (setup_prefix && prefix == NULL)
 409                prefix = setup_git_directory_gently(&nongit);
 410
 411        git_config(git_default_config, NULL);
 412        init_tar_archiver();
 413        init_zip_archiver();
 414
 415        argc = parse_archive_args(argc, argv, &ar, &args, name_hint, remote);
 416        if (nongit) {
 417                /*
 418                 * We know this will die() with an error, so we could just
 419                 * die ourselves; but its error message will be more specific
 420                 * than what we could write here.
 421                 */
 422                setup_git_directory();
 423        }
 424
 425        parse_treeish_arg(argv, &args, prefix, remote);
 426        parse_pathspec_arg(argv + 1, &args);
 427
 428        return ar->write_archive(ar, &args);
 429}
 430
 431static int match_extension(const char *filename, const char *ext)
 432{
 433        int prefixlen = strlen(filename) - strlen(ext);
 434
 435        /*
 436         * We need 1 character for the '.', and 1 character to ensure that the
 437         * prefix is non-empty (k.e., we don't match .tar.gz with no actual
 438         * filename).
 439         */
 440        if (prefixlen < 2 || filename[prefixlen-1] != '.')
 441                return 0;
 442        return !strcmp(filename + prefixlen, ext);
 443}
 444
 445const char *archive_format_from_filename(const char *filename)
 446{
 447        int i;
 448
 449        for (i = 0; i < nr_archivers; i++)
 450                if (match_extension(filename, archivers[i]->name))
 451                        return archivers[i]->name;
 452        return NULL;
 453}