doc: remove manpage-base-url workaround
[git.git] / archive.c
blob1c2ca78e52a8daaf3a7b123ce2ea004f970b1a79
1 #include "git-compat-util.h"
2 #include "alloc.h"
3 #include "config.h"
4 #include "hex.h"
5 #include "refs.h"
6 #include "object-store.h"
7 #include "commit.h"
8 #include "tree-walk.h"
9 #include "attr.h"
10 #include "archive.h"
11 #include "parse-options.h"
12 #include "unpack-trees.h"
13 #include "dir.h"
14 #include "quote.h"
16 static char const * const archive_usage[] = {
17 N_("git archive [<options>] <tree-ish> [<path>...]"),
18 "git archive --list",
19 N_("git archive --remote <repo> [--exec <cmd>] [<options>] <tree-ish> [<path>...]"),
20 N_("git archive --remote <repo> [--exec <cmd>] --list"),
21 NULL
24 static const struct archiver **archivers;
25 static int nr_archivers;
26 static int alloc_archivers;
27 static int remote_allow_unreachable;
29 void register_archiver(struct archiver *ar)
31 ALLOC_GROW(archivers, nr_archivers + 1, alloc_archivers);
32 archivers[nr_archivers++] = ar;
35 void init_archivers(void)
37 init_tar_archiver();
38 init_zip_archiver();
41 static void format_subst(const struct commit *commit,
42 const char *src, size_t len,
43 struct strbuf *buf, struct pretty_print_context *ctx)
45 char *to_free = NULL;
46 struct strbuf fmt = STRBUF_INIT;
48 if (src == buf->buf)
49 to_free = strbuf_detach(buf, NULL);
50 for (;;) {
51 const char *b, *c;
53 b = memmem(src, len, "$Format:", 8);
54 if (!b)
55 break;
56 c = memchr(b + 8, '$', (src + len) - b - 8);
57 if (!c)
58 break;
60 strbuf_reset(&fmt);
61 strbuf_add(&fmt, b + 8, c - b - 8);
63 strbuf_add(buf, src, b - src);
64 format_commit_message(commit, fmt.buf, buf, ctx);
65 len -= c + 1 - src;
66 src = c + 1;
68 strbuf_add(buf, src, len);
69 strbuf_release(&fmt);
70 free(to_free);
73 static void *object_file_to_archive(const struct archiver_args *args,
74 const char *path,
75 const struct object_id *oid,
76 unsigned int mode,
77 enum object_type *type,
78 unsigned long *sizep)
80 void *buffer;
81 const struct commit *commit = args->convert ? args->commit : NULL;
82 struct checkout_metadata meta;
84 init_checkout_metadata(&meta, args->refname,
85 args->commit_oid ? args->commit_oid :
86 (args->tree ? &args->tree->object.oid : NULL), oid);
88 path += args->baselen;
89 buffer = read_object_file(oid, type, sizep);
90 if (buffer && S_ISREG(mode)) {
91 struct strbuf buf = STRBUF_INIT;
92 size_t size = 0;
94 strbuf_attach(&buf, buffer, *sizep, *sizep + 1);
95 convert_to_working_tree(args->repo->index, path, buf.buf, buf.len, &buf, &meta);
96 if (commit)
97 format_subst(commit, buf.buf, buf.len, &buf, args->pretty_ctx);
98 buffer = strbuf_detach(&buf, &size);
99 *sizep = size;
102 return buffer;
105 struct directory {
106 struct directory *up;
107 struct object_id oid;
108 int baselen, len;
109 unsigned mode;
110 char path[FLEX_ARRAY];
113 struct archiver_context {
114 struct archiver_args *args;
115 write_archive_entry_fn_t write_entry;
116 struct directory *bottom;
119 static const struct attr_check *get_archive_attrs(struct index_state *istate,
120 const char *path)
122 static struct attr_check *check;
123 if (!check)
124 check = attr_check_initl("export-ignore", "export-subst", NULL);
125 git_check_attr(istate, NULL, path, check);
126 return check;
129 static int check_attr_export_ignore(const struct attr_check *check)
131 return check && ATTR_TRUE(check->items[0].value);
134 static int check_attr_export_subst(const struct attr_check *check)
136 return check && ATTR_TRUE(check->items[1].value);
139 static int write_archive_entry(const struct object_id *oid, const char *base,
140 int baselen, const char *filename, unsigned mode,
141 void *context)
143 static struct strbuf path = STRBUF_INIT;
144 struct archiver_context *c = context;
145 struct archiver_args *args = c->args;
146 write_archive_entry_fn_t write_entry = c->write_entry;
147 int err;
148 const char *path_without_prefix;
149 unsigned long size;
150 void *buffer;
151 enum object_type type;
153 args->convert = 0;
154 strbuf_reset(&path);
155 strbuf_grow(&path, PATH_MAX);
156 strbuf_add(&path, args->base, args->baselen);
157 strbuf_add(&path, base, baselen);
158 strbuf_addstr(&path, filename);
159 if (S_ISDIR(mode) || S_ISGITLINK(mode))
160 strbuf_addch(&path, '/');
161 path_without_prefix = path.buf + args->baselen;
163 if (!S_ISDIR(mode)) {
164 const struct attr_check *check;
165 check = get_archive_attrs(args->repo->index, path_without_prefix);
166 if (check_attr_export_ignore(check))
167 return 0;
168 args->convert = check_attr_export_subst(check);
171 if (args->verbose)
172 fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
174 if (S_ISDIR(mode) || S_ISGITLINK(mode)) {
175 err = write_entry(args, oid, path.buf, path.len, mode, NULL, 0);
176 if (err)
177 return err;
178 return (S_ISDIR(mode) ? READ_TREE_RECURSIVE : 0);
181 /* Stream it? */
182 if (S_ISREG(mode) && !args->convert &&
183 oid_object_info(args->repo, oid, &size) == OBJ_BLOB &&
184 size > big_file_threshold)
185 return write_entry(args, oid, path.buf, path.len, mode, NULL, size);
187 buffer = object_file_to_archive(args, path.buf, oid, mode, &type, &size);
188 if (!buffer)
189 return error(_("cannot read '%s'"), oid_to_hex(oid));
190 err = write_entry(args, oid, path.buf, path.len, mode, buffer, size);
191 free(buffer);
192 return err;
195 static void queue_directory(const struct object_id *oid,
196 struct strbuf *base, const char *filename,
197 unsigned mode, struct archiver_context *c)
199 struct directory *d;
200 size_t len = st_add4(base->len, 1, strlen(filename), 1);
201 d = xmalloc(st_add(sizeof(*d), len));
202 d->up = c->bottom;
203 d->baselen = base->len;
204 d->mode = mode;
205 c->bottom = d;
206 d->len = xsnprintf(d->path, len, "%.*s%s/", (int)base->len, base->buf, filename);
207 oidcpy(&d->oid, oid);
210 static int write_directory(struct archiver_context *c)
212 struct directory *d = c->bottom;
213 int ret;
215 if (!d)
216 return 0;
217 c->bottom = d->up;
218 d->path[d->len - 1] = '\0'; /* no trailing slash */
219 ret =
220 write_directory(c) ||
221 write_archive_entry(&d->oid, d->path, d->baselen,
222 d->path + d->baselen, d->mode,
223 c) != READ_TREE_RECURSIVE;
224 free(d);
225 return ret ? -1 : 0;
228 static int queue_or_write_archive_entry(const struct object_id *oid,
229 struct strbuf *base, const char *filename,
230 unsigned mode, void *context)
232 struct archiver_context *c = context;
234 while (c->bottom &&
235 !(base->len >= c->bottom->len &&
236 !strncmp(base->buf, c->bottom->path, c->bottom->len))) {
237 struct directory *next = c->bottom->up;
238 free(c->bottom);
239 c->bottom = next;
242 if (S_ISDIR(mode)) {
243 size_t baselen = base->len;
244 const struct attr_check *check;
246 /* Borrow base, but restore its original value when done. */
247 strbuf_addstr(base, filename);
248 strbuf_addch(base, '/');
249 check = get_archive_attrs(c->args->repo->index, base->buf);
250 strbuf_setlen(base, baselen);
252 if (check_attr_export_ignore(check))
253 return 0;
254 queue_directory(oid, base, filename, mode, c);
255 return READ_TREE_RECURSIVE;
258 if (write_directory(c))
259 return -1;
260 return write_archive_entry(oid, base->buf, base->len, filename, mode,
261 context);
264 struct extra_file_info {
265 char *base;
266 struct stat stat;
267 void *content;
270 int write_archive_entries(struct archiver_args *args,
271 write_archive_entry_fn_t write_entry)
273 struct archiver_context context;
274 struct unpack_trees_options opts;
275 struct tree_desc t;
276 int err;
277 struct strbuf path_in_archive = STRBUF_INIT;
278 struct strbuf content = STRBUF_INIT;
279 struct object_id fake_oid;
280 int i;
282 oidcpy(&fake_oid, null_oid());
284 if (args->baselen > 0 && args->base[args->baselen - 1] == '/') {
285 size_t len = args->baselen;
287 while (len > 1 && args->base[len - 2] == '/')
288 len--;
289 if (args->verbose)
290 fprintf(stderr, "%.*s\n", (int)len, args->base);
291 err = write_entry(args, &args->tree->object.oid, args->base,
292 len, 040777, NULL, 0);
293 if (err)
294 return err;
297 memset(&context, 0, sizeof(context));
298 context.args = args;
299 context.write_entry = write_entry;
302 * Setup index and instruct attr to read index only
304 if (!args->worktree_attributes) {
305 memset(&opts, 0, sizeof(opts));
306 opts.index_only = 1;
307 opts.head_idx = -1;
308 opts.src_index = args->repo->index;
309 opts.dst_index = args->repo->index;
310 opts.fn = oneway_merge;
311 init_tree_desc(&t, args->tree->buffer, args->tree->size);
312 if (unpack_trees(1, &t, &opts))
313 return -1;
314 git_attr_set_direction(GIT_ATTR_INDEX);
317 err = read_tree(args->repo, args->tree,
318 &args->pathspec,
319 queue_or_write_archive_entry,
320 &context);
321 if (err == READ_TREE_RECURSIVE)
322 err = 0;
323 while (context.bottom) {
324 struct directory *next = context.bottom->up;
325 free(context.bottom);
326 context.bottom = next;
329 for (i = 0; i < args->extra_files.nr; i++) {
330 struct string_list_item *item = args->extra_files.items + i;
331 char *path = item->string;
332 struct extra_file_info *info = item->util;
334 put_be64(fake_oid.hash, i + 1);
336 if (!info->content) {
337 strbuf_reset(&path_in_archive);
338 if (info->base)
339 strbuf_addstr(&path_in_archive, info->base);
340 strbuf_addstr(&path_in_archive, basename(path));
342 strbuf_reset(&content);
343 if (strbuf_read_file(&content, path, info->stat.st_size) < 0)
344 err = error_errno(_("cannot read '%s'"), path);
345 else
346 err = write_entry(args, &fake_oid, path_in_archive.buf,
347 path_in_archive.len,
348 canon_mode(info->stat.st_mode),
349 content.buf, content.len);
350 } else {
351 err = write_entry(args, &fake_oid,
352 path, strlen(path),
353 canon_mode(info->stat.st_mode),
354 info->content, info->stat.st_size);
357 if (err)
358 break;
360 strbuf_release(&path_in_archive);
361 strbuf_release(&content);
363 return err;
366 static const struct archiver *lookup_archiver(const char *name)
368 int i;
370 if (!name)
371 return NULL;
373 for (i = 0; i < nr_archivers; i++) {
374 if (!strcmp(name, archivers[i]->name))
375 return archivers[i];
377 return NULL;
380 struct path_exists_context {
381 struct pathspec pathspec;
382 struct archiver_args *args;
385 static int reject_entry(const struct object_id *oid UNUSED,
386 struct strbuf *base,
387 const char *filename, unsigned mode,
388 void *context)
390 int ret = -1;
391 struct path_exists_context *ctx = context;
393 if (S_ISDIR(mode)) {
394 struct strbuf sb = STRBUF_INIT;
395 strbuf_addbuf(&sb, base);
396 strbuf_addstr(&sb, filename);
397 if (!match_pathspec(ctx->args->repo->index,
398 &ctx->pathspec,
399 sb.buf, sb.len, 0, NULL, 1))
400 ret = READ_TREE_RECURSIVE;
401 strbuf_release(&sb);
403 return ret;
406 static int path_exists(struct archiver_args *args, const char *path)
408 const char *paths[] = { path, NULL };
409 struct path_exists_context ctx;
410 int ret;
412 ctx.args = args;
413 parse_pathspec(&ctx.pathspec, 0, 0, "", paths);
414 ctx.pathspec.recursive = 1;
415 ret = read_tree(args->repo, args->tree,
416 &ctx.pathspec,
417 reject_entry, &ctx);
418 clear_pathspec(&ctx.pathspec);
419 return ret != 0;
422 static void parse_pathspec_arg(const char **pathspec,
423 struct archiver_args *ar_args)
426 * must be consistent with parse_pathspec in path_exists()
427 * Also if pathspec patterns are dependent, we're in big
428 * trouble as we test each one separately
430 parse_pathspec(&ar_args->pathspec, 0,
431 PATHSPEC_PREFER_FULL,
432 "", pathspec);
433 ar_args->pathspec.recursive = 1;
434 if (pathspec) {
435 while (*pathspec) {
436 if (**pathspec && !path_exists(ar_args, *pathspec))
437 die(_("pathspec '%s' did not match any files"), *pathspec);
438 pathspec++;
443 static void parse_treeish_arg(const char **argv,
444 struct archiver_args *ar_args, const char *prefix,
445 int remote)
447 const char *name = argv[0];
448 const struct object_id *commit_oid;
449 time_t archive_time;
450 struct tree *tree;
451 const struct commit *commit;
452 struct object_id oid;
453 char *ref = NULL;
455 /* Remotes are only allowed to fetch actual refs */
456 if (remote && !remote_allow_unreachable) {
457 const char *colon = strchrnul(name, ':');
458 int refnamelen = colon - name;
460 if (!dwim_ref(name, refnamelen, &oid, &ref, 0))
461 die(_("no such ref: %.*s"), refnamelen, name);
462 } else {
463 dwim_ref(name, strlen(name), &oid, &ref, 0);
466 if (get_oid(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;