archive.c

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