cocci: apply the "refs.h" part of "the_repository.pending"
[git/debian.git] / archive.c
blob716a18567bce8ea536f6bbab5e180be8d57ae935
1 #include "cache.h"
2 #include "config.h"
3 #include "refs.h"
4 #include "object-store.h"
5 #include "commit.h"
6 #include "tree-walk.h"
7 #include "attr.h"
8 #include "archive.h"
9 #include "parse-options.h"
10 #include "unpack-trees.h"
11 #include "dir.h"
12 #include "quote.h"
14 static char const * const archive_usage[] = {
15 N_("git archive [<options>] <tree-ish> [<path>...]"),
16 "git archive --list",
17 N_("git archive --remote <repo> [--exec <cmd>] [<options>] <tree-ish> [<path>...]"),
18 N_("git archive --remote <repo> [--exec <cmd>] --list"),
19 NULL
22 static const struct archiver **archivers;
23 static int nr_archivers;
24 static int alloc_archivers;
25 static int remote_allow_unreachable;
27 void register_archiver(struct archiver *ar)
29 ALLOC_GROW(archivers, nr_archivers + 1, alloc_archivers);
30 archivers[nr_archivers++] = ar;
33 void init_archivers(void)
35 init_tar_archiver();
36 init_zip_archiver();
39 static void format_subst(const struct commit *commit,
40 const char *src, size_t len,
41 struct strbuf *buf, struct pretty_print_context *ctx)
43 char *to_free = NULL;
44 struct strbuf fmt = STRBUF_INIT;
46 if (src == buf->buf)
47 to_free = strbuf_detach(buf, NULL);
48 for (;;) {
49 const char *b, *c;
51 b = memmem(src, len, "$Format:", 8);
52 if (!b)
53 break;
54 c = memchr(b + 8, '$', (src + len) - b - 8);
55 if (!c)
56 break;
58 strbuf_reset(&fmt);
59 strbuf_add(&fmt, b + 8, c - b - 8);
61 strbuf_add(buf, src, b - src);
62 repo_format_commit_message(the_repository, commit, fmt.buf,
63 buf, ctx);
64 len -= c + 1 - src;
65 src = c + 1;
67 strbuf_add(buf, src, len);
68 strbuf_release(&fmt);
69 free(to_free);
72 static void *object_file_to_archive(const struct archiver_args *args,
73 const char *path,
74 const struct object_id *oid,
75 unsigned int mode,
76 enum object_type *type,
77 unsigned long *sizep)
79 void *buffer;
80 const struct commit *commit = args->convert ? args->commit : NULL;
81 struct checkout_metadata meta;
83 init_checkout_metadata(&meta, args->refname,
84 args->commit_oid ? args->commit_oid :
85 (args->tree ? &args->tree->object.oid : NULL), oid);
87 path += args->baselen;
88 buffer = repo_read_object_file(the_repository, oid, type, sizep);
89 if (buffer && S_ISREG(mode)) {
90 struct strbuf buf = STRBUF_INIT;
91 size_t size = 0;
93 strbuf_attach(&buf, buffer, *sizep, *sizep + 1);
94 convert_to_working_tree(args->repo->index, path, buf.buf, buf.len, &buf, &meta);
95 if (commit)
96 format_subst(commit, buf.buf, buf.len, &buf, args->pretty_ctx);
97 buffer = strbuf_detach(&buf, &size);
98 *sizep = size;
101 return buffer;
104 struct directory {
105 struct directory *up;
106 struct object_id oid;
107 int baselen, len;
108 unsigned mode;
109 char path[FLEX_ARRAY];
112 struct archiver_context {
113 struct archiver_args *args;
114 write_archive_entry_fn_t write_entry;
115 struct directory *bottom;
118 static const struct attr_check *get_archive_attrs(struct index_state *istate,
119 const char *path)
121 static struct attr_check *check;
122 if (!check)
123 check = attr_check_initl("export-ignore", "export-subst", NULL);
124 git_check_attr(istate, NULL, path, check);
125 return check;
128 static int check_attr_export_ignore(const struct attr_check *check)
130 return check && ATTR_TRUE(check->items[0].value);
133 static int check_attr_export_subst(const struct attr_check *check)
135 return check && ATTR_TRUE(check->items[1].value);
138 static int write_archive_entry(const struct object_id *oid, const char *base,
139 int baselen, const char *filename, unsigned mode,
140 void *context)
142 static struct strbuf path = STRBUF_INIT;
143 struct archiver_context *c = context;
144 struct archiver_args *args = c->args;
145 write_archive_entry_fn_t write_entry = c->write_entry;
146 int err;
147 const char *path_without_prefix;
148 unsigned long size;
149 void *buffer;
150 enum object_type type;
152 args->convert = 0;
153 strbuf_reset(&path);
154 strbuf_grow(&path, PATH_MAX);
155 strbuf_add(&path, args->base, args->baselen);
156 strbuf_add(&path, base, baselen);
157 strbuf_addstr(&path, filename);
158 if (S_ISDIR(mode) || S_ISGITLINK(mode))
159 strbuf_addch(&path, '/');
160 path_without_prefix = path.buf + args->baselen;
162 if (!S_ISDIR(mode)) {
163 const struct attr_check *check;
164 check = get_archive_attrs(args->repo->index, path_without_prefix);
165 if (check_attr_export_ignore(check))
166 return 0;
167 args->convert = check_attr_export_subst(check);
170 if (args->verbose)
171 fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
173 if (S_ISDIR(mode) || S_ISGITLINK(mode)) {
174 err = write_entry(args, oid, path.buf, path.len, mode, NULL, 0);
175 if (err)
176 return err;
177 return (S_ISDIR(mode) ? READ_TREE_RECURSIVE : 0);
180 /* Stream it? */
181 if (S_ISREG(mode) && !args->convert &&
182 oid_object_info(args->repo, oid, &size) == OBJ_BLOB &&
183 size > big_file_threshold)
184 return write_entry(args, oid, path.buf, path.len, mode, NULL, size);
186 buffer = object_file_to_archive(args, path.buf, oid, mode, &type, &size);
187 if (!buffer)
188 return error(_("cannot read '%s'"), oid_to_hex(oid));
189 err = write_entry(args, oid, path.buf, path.len, mode, buffer, size);
190 free(buffer);
191 return err;
194 static void queue_directory(const struct object_id *oid,
195 struct strbuf *base, const char *filename,
196 unsigned mode, struct archiver_context *c)
198 struct directory *d;
199 size_t len = st_add4(base->len, 1, strlen(filename), 1);
200 d = xmalloc(st_add(sizeof(*d), len));
201 d->up = c->bottom;
202 d->baselen = base->len;
203 d->mode = mode;
204 c->bottom = d;
205 d->len = xsnprintf(d->path, len, "%.*s%s/", (int)base->len, base->buf, filename);
206 oidcpy(&d->oid, oid);
209 static int write_directory(struct archiver_context *c)
211 struct directory *d = c->bottom;
212 int ret;
214 if (!d)
215 return 0;
216 c->bottom = d->up;
217 d->path[d->len - 1] = '\0'; /* no trailing slash */
218 ret =
219 write_directory(c) ||
220 write_archive_entry(&d->oid, d->path, d->baselen,
221 d->path + d->baselen, d->mode,
222 c) != READ_TREE_RECURSIVE;
223 free(d);
224 return ret ? -1 : 0;
227 static int queue_or_write_archive_entry(const struct object_id *oid,
228 struct strbuf *base, const char *filename,
229 unsigned mode, void *context)
231 struct archiver_context *c = context;
233 while (c->bottom &&
234 !(base->len >= c->bottom->len &&
235 !strncmp(base->buf, c->bottom->path, c->bottom->len))) {
236 struct directory *next = c->bottom->up;
237 free(c->bottom);
238 c->bottom = next;
241 if (S_ISDIR(mode)) {
242 size_t baselen = base->len;
243 const struct attr_check *check;
245 /* Borrow base, but restore its original value when done. */
246 strbuf_addstr(base, filename);
247 strbuf_addch(base, '/');
248 check = get_archive_attrs(c->args->repo->index, base->buf);
249 strbuf_setlen(base, baselen);
251 if (check_attr_export_ignore(check))
252 return 0;
253 queue_directory(oid, base, filename, mode, c);
254 return READ_TREE_RECURSIVE;
257 if (write_directory(c))
258 return -1;
259 return write_archive_entry(oid, base->buf, base->len, filename, mode,
260 context);
263 struct extra_file_info {
264 char *base;
265 struct stat stat;
266 void *content;
269 int write_archive_entries(struct archiver_args *args,
270 write_archive_entry_fn_t write_entry)
272 struct archiver_context context;
273 struct unpack_trees_options opts;
274 struct tree_desc t;
275 int err;
276 struct strbuf path_in_archive = STRBUF_INIT;
277 struct strbuf content = STRBUF_INIT;
278 struct object_id fake_oid;
279 int i;
281 oidcpy(&fake_oid, null_oid());
283 if (args->baselen > 0 && args->base[args->baselen - 1] == '/') {
284 size_t len = args->baselen;
286 while (len > 1 && args->base[len - 2] == '/')
287 len--;
288 if (args->verbose)
289 fprintf(stderr, "%.*s\n", (int)len, args->base);
290 err = write_entry(args, &args->tree->object.oid, args->base,
291 len, 040777, NULL, 0);
292 if (err)
293 return err;
296 memset(&context, 0, sizeof(context));
297 context.args = args;
298 context.write_entry = write_entry;
301 * Setup index and instruct attr to read index only
303 if (!args->worktree_attributes) {
304 memset(&opts, 0, sizeof(opts));
305 opts.index_only = 1;
306 opts.head_idx = -1;
307 opts.src_index = args->repo->index;
308 opts.dst_index = args->repo->index;
309 opts.fn = oneway_merge;
310 init_tree_desc(&t, args->tree->buffer, args->tree->size);
311 if (unpack_trees(1, &t, &opts))
312 return -1;
313 git_attr_set_direction(GIT_ATTR_INDEX);
316 err = read_tree(args->repo, args->tree,
317 &args->pathspec,
318 queue_or_write_archive_entry,
319 &context);
320 if (err == READ_TREE_RECURSIVE)
321 err = 0;
322 while (context.bottom) {
323 struct directory *next = context.bottom->up;
324 free(context.bottom);
325 context.bottom = next;
328 for (i = 0; i < args->extra_files.nr; i++) {
329 struct string_list_item *item = args->extra_files.items + i;
330 char *path = item->string;
331 struct extra_file_info *info = item->util;
333 put_be64(fake_oid.hash, i + 1);
335 if (!info->content) {
336 strbuf_reset(&path_in_archive);
337 if (info->base)
338 strbuf_addstr(&path_in_archive, info->base);
339 strbuf_addstr(&path_in_archive, basename(path));
341 strbuf_reset(&content);
342 if (strbuf_read_file(&content, path, info->stat.st_size) < 0)
343 err = error_errno(_("cannot read '%s'"), path);
344 else
345 err = write_entry(args, &fake_oid, path_in_archive.buf,
346 path_in_archive.len,
347 canon_mode(info->stat.st_mode),
348 content.buf, content.len);
349 } else {
350 err = write_entry(args, &fake_oid,
351 path, strlen(path),
352 canon_mode(info->stat.st_mode),
353 info->content, info->stat.st_size);
356 if (err)
357 break;
359 strbuf_release(&path_in_archive);
360 strbuf_release(&content);
362 return err;
365 static const struct archiver *lookup_archiver(const char *name)
367 int i;
369 if (!name)
370 return NULL;
372 for (i = 0; i < nr_archivers; i++) {
373 if (!strcmp(name, archivers[i]->name))
374 return archivers[i];
376 return NULL;
379 struct path_exists_context {
380 struct pathspec pathspec;
381 struct archiver_args *args;
384 static int reject_entry(const struct object_id *oid UNUSED,
385 struct strbuf *base,
386 const char *filename, unsigned mode,
387 void *context)
389 int ret = -1;
390 struct path_exists_context *ctx = context;
392 if (S_ISDIR(mode)) {
393 struct strbuf sb = STRBUF_INIT;
394 strbuf_addbuf(&sb, base);
395 strbuf_addstr(&sb, filename);
396 if (!match_pathspec(ctx->args->repo->index,
397 &ctx->pathspec,
398 sb.buf, sb.len, 0, NULL, 1))
399 ret = READ_TREE_RECURSIVE;
400 strbuf_release(&sb);
402 return ret;
405 static int path_exists(struct archiver_args *args, const char *path)
407 const char *paths[] = { path, NULL };
408 struct path_exists_context ctx;
409 int ret;
411 ctx.args = args;
412 parse_pathspec(&ctx.pathspec, 0, 0, "", paths);
413 ctx.pathspec.recursive = 1;
414 ret = read_tree(args->repo, args->tree,
415 &ctx.pathspec,
416 reject_entry, &ctx);
417 clear_pathspec(&ctx.pathspec);
418 return ret != 0;
421 static void parse_pathspec_arg(const char **pathspec,
422 struct archiver_args *ar_args)
425 * must be consistent with parse_pathspec in path_exists()
426 * Also if pathspec patterns are dependent, we're in big
427 * trouble as we test each one separately
429 parse_pathspec(&ar_args->pathspec, 0,
430 PATHSPEC_PREFER_FULL,
431 "", pathspec);
432 ar_args->pathspec.recursive = 1;
433 if (pathspec) {
434 while (*pathspec) {
435 if (**pathspec && !path_exists(ar_args, *pathspec))
436 die(_("pathspec '%s' did not match any files"), *pathspec);
437 pathspec++;
442 static void parse_treeish_arg(const char **argv,
443 struct archiver_args *ar_args, const char *prefix,
444 int remote)
446 const char *name = argv[0];
447 const struct object_id *commit_oid;
448 time_t archive_time;
449 struct tree *tree;
450 const struct commit *commit;
451 struct object_id oid;
452 char *ref = NULL;
454 /* Remotes are only allowed to fetch actual refs */
455 if (remote && !remote_allow_unreachable) {
456 const char *colon = strchrnul(name, ':');
457 int refnamelen = colon - name;
459 if (!repo_dwim_ref(the_repository, name, refnamelen, &oid, &ref, 0))
460 die(_("no such ref: %.*s"), refnamelen, name);
461 } else {
462 repo_dwim_ref(the_repository, name, strlen(name), &oid, &ref,
466 if (repo_get_oid(the_repository, name, &oid))
467 die(_("not a valid object name: %s"), name);
469 commit = lookup_commit_reference_gently(ar_args->repo, &oid, 1);
470 if (commit) {
471 commit_oid = &commit->object.oid;
472 archive_time = commit->date;
473 } else {
474 commit_oid = NULL;
475 archive_time = time(NULL);
477 if (ar_args->mtime_option)
478 archive_time = approxidate(ar_args->mtime_option);
480 tree = parse_tree_indirect(&oid);
481 if (!tree)
482 die(_("not a tree object: %s"), oid_to_hex(&oid));
484 if (prefix) {
485 struct object_id tree_oid;
486 unsigned short mode;
487 int err;
489 err = get_tree_entry(ar_args->repo,
490 &tree->object.oid,
491 prefix, &tree_oid,
492 &mode);
493 if (err || !S_ISDIR(mode))
494 die(_("current working directory is untracked"));
496 tree = parse_tree_indirect(&tree_oid);
498 ar_args->refname = ref;
499 ar_args->tree = tree;
500 ar_args->commit_oid = commit_oid;
501 ar_args->commit = commit;
502 ar_args->time = archive_time;
505 static void extra_file_info_clear(void *util, const char *str UNUSED)
507 struct extra_file_info *info = util;
508 free(info->base);
509 free(info->content);
510 free(info);
513 static int add_file_cb(const struct option *opt, const char *arg, int unset)
515 struct archiver_args *args = opt->value;
516 const char **basep = (const char **)opt->defval;
517 const char *base = *basep;
518 char *path;
519 struct string_list_item *item;
520 struct extra_file_info *info;
522 if (unset) {
523 string_list_clear_func(&args->extra_files,
524 extra_file_info_clear);
525 return 0;
528 if (!arg)
529 return -1;
531 info = xmalloc(sizeof(*info));
532 info->base = xstrdup_or_null(base);
534 if (!strcmp(opt->long_name, "add-file")) {
535 path = prefix_filename(args->prefix, arg);
536 if (stat(path, &info->stat))
537 die(_("File not found: %s"), path);
538 if (!S_ISREG(info->stat.st_mode))
539 die(_("Not a regular file: %s"), path);
540 info->content = NULL; /* read the file later */
541 } else if (!strcmp(opt->long_name, "add-virtual-file")) {
542 struct strbuf buf = STRBUF_INIT;
543 const char *p = arg;
545 if (*p != '"')
546 p = strchr(p, ':');
547 else if (unquote_c_style(&buf, p, &p) < 0)
548 die(_("unclosed quote: '%s'"), arg);
550 if (!p || *p != ':')
551 die(_("missing colon: '%s'"), arg);
553 if (p == arg)
554 die(_("empty file name: '%s'"), arg);
556 path = buf.len ?
557 strbuf_detach(&buf, NULL) : xstrndup(arg, p - arg);
559 if (args->prefix) {
560 char *save = path;
561 path = prefix_filename(args->prefix, path);
562 free(save);
564 memset(&info->stat, 0, sizeof(info->stat));
565 info->stat.st_mode = S_IFREG | 0644;
566 info->content = xstrdup(p + 1);
567 info->stat.st_size = strlen(info->content);
568 } else {
569 BUG("add_file_cb() called for %s", opt->long_name);
571 item = string_list_append_nodup(&args->extra_files, path);
572 item->util = info;
574 return 0;
577 static int number_callback(const struct option *opt, const char *arg, int unset)
579 BUG_ON_OPT_NEG(unset);
580 *(int *)opt->value = strtol(arg, NULL, 10);
581 return 0;
584 static int parse_archive_args(int argc, const char **argv,
585 const struct archiver **ar, struct archiver_args *args,
586 const char *name_hint, int is_remote)
588 const char *format = NULL;
589 const char *base = NULL;
590 const char *remote = NULL;
591 const char *exec = NULL;
592 const char *output = NULL;
593 const char *mtime_option = NULL;
594 int compression_level = -1;
595 int verbose = 0;
596 int i;
597 int list = 0;
598 int worktree_attributes = 0;
599 struct option opts[] = {
600 OPT_GROUP(""),
601 OPT_STRING(0, "format", &format, N_("fmt"), N_("archive format")),
602 OPT_STRING(0, "prefix", &base, N_("prefix"),
603 N_("prepend prefix to each pathname in the archive")),
604 { OPTION_CALLBACK, 0, "add-file", args, N_("file"),
605 N_("add untracked file to archive"), 0, add_file_cb,
606 (intptr_t)&base },
607 { OPTION_CALLBACK, 0, "add-virtual-file", args,
608 N_("path:content"), N_("add untracked file to archive"), 0,
609 add_file_cb, (intptr_t)&base },
610 OPT_STRING('o', "output", &output, N_("file"),
611 N_("write the archive to this file")),
612 OPT_BOOL(0, "worktree-attributes", &worktree_attributes,
613 N_("read .gitattributes in working directory")),
614 OPT__VERBOSE(&verbose, N_("report archived files on stderr")),
615 { OPTION_STRING, 0, "mtime", &mtime_option, N_("time"),
616 N_("set modification time of archive entries"),
617 PARSE_OPT_NONEG },
618 OPT_NUMBER_CALLBACK(&compression_level,
619 N_("set compression level"), number_callback),
620 OPT_GROUP(""),
621 OPT_BOOL('l', "list", &list,
622 N_("list supported archive formats")),
623 OPT_GROUP(""),
624 OPT_STRING(0, "remote", &remote, N_("repo"),
625 N_("retrieve the archive from remote repository <repo>")),
626 OPT_STRING(0, "exec", &exec, N_("command"),
627 N_("path to the remote git-upload-archive command")),
628 OPT_END()
631 argc = parse_options(argc, argv, NULL, opts, archive_usage, 0);
633 if (remote)
634 die(_("Unexpected option --remote"));
635 if (exec)
636 die(_("the option '%s' requires '%s'"), "--exec", "--remote");
637 if (output)
638 die(_("Unexpected option --output"));
639 if (is_remote && args->extra_files.nr)
640 die(_("options '%s' and '%s' cannot be used together"), "--add-file", "--remote");
642 if (!base)
643 base = "";
645 if (list) {
646 for (i = 0; i < nr_archivers; i++)
647 if (!is_remote || archivers[i]->flags & ARCHIVER_REMOTE)
648 printf("%s\n", archivers[i]->name);
649 exit(0);
652 if (!format && name_hint)
653 format = archive_format_from_filename(name_hint);
654 if (!format)
655 format = "tar";
657 /* We need at least one parameter -- tree-ish */
658 if (argc < 1)
659 usage_with_options(archive_usage, opts);
660 *ar = lookup_archiver(format);
661 if (!*ar || (is_remote && !((*ar)->flags & ARCHIVER_REMOTE)))
662 die(_("Unknown archive format '%s'"), format);
664 args->compression_level = Z_DEFAULT_COMPRESSION;
665 if (compression_level != -1) {
666 int levels_ok = (*ar)->flags & ARCHIVER_WANT_COMPRESSION_LEVELS;
667 int high_ok = (*ar)->flags & ARCHIVER_HIGH_COMPRESSION_LEVELS;
668 if (levels_ok && (compression_level <= 9 || high_ok))
669 args->compression_level = compression_level;
670 else {
671 die(_("Argument not supported for format '%s': -%d"),
672 format, compression_level);
675 args->verbose = verbose;
676 args->base = base;
677 args->baselen = strlen(base);
678 args->worktree_attributes = worktree_attributes;
679 args->mtime_option = mtime_option;
681 return argc;
684 int write_archive(int argc, const char **argv, const char *prefix,
685 struct repository *repo,
686 const char *name_hint, int remote)
688 const struct archiver *ar = NULL;
689 struct pretty_print_describe_status describe_status = {0};
690 struct pretty_print_context ctx = {0};
691 struct archiver_args args;
692 int rc;
694 git_config_get_bool("uploadarchive.allowunreachable", &remote_allow_unreachable);
695 git_config(git_default_config, NULL);
697 describe_status.max_invocations = 1;
698 ctx.date_mode.type = DATE_NORMAL;
699 ctx.abbrev = DEFAULT_ABBREV;
700 ctx.describe_status = &describe_status;
701 args.pretty_ctx = &ctx;
702 args.repo = repo;
703 args.prefix = prefix;
704 string_list_init_dup(&args.extra_files);
705 argc = parse_archive_args(argc, argv, &ar, &args, name_hint, remote);
706 if (!startup_info->have_repository) {
708 * We know this will die() with an error, so we could just
709 * die ourselves; but its error message will be more specific
710 * than what we could write here.
712 setup_git_directory();
715 parse_treeish_arg(argv, &args, prefix, remote);
716 parse_pathspec_arg(argv + 1, &args);
718 rc = ar->write_archive(ar, &args);
720 string_list_clear_func(&args.extra_files, extra_file_info_clear);
721 free(args.refname);
722 clear_pathspec(&args.pathspec);
724 return rc;
727 static int match_extension(const char *filename, const char *ext)
729 int prefixlen = strlen(filename) - strlen(ext);
732 * We need 1 character for the '.', and 1 character to ensure that the
733 * prefix is non-empty (k.e., we don't match .tar.gz with no actual
734 * filename).
736 if (prefixlen < 2 || filename[prefixlen - 1] != '.')
737 return 0;
738 return !strcmp(filename + prefixlen, ext);
741 const char *archive_format_from_filename(const char *filename)
743 int i;
745 for (i = 0; i < nr_archivers; i++)
746 if (match_extension(filename, archivers[i]->name))
747 return archivers[i]->name;
748 return NULL;