archive.c

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