1 #include "git-compat-util.h"
5 #include "environment.h"
12 #include "object-store-ll.h"
15 #include "tree-walk.h"
18 #include "parse-options.h"
19 #include "unpack-trees.h"
23 static char const * const archive_usage
[] = {
24 N_("git archive [<options>] <tree-ish> [<path>...]"),
26 N_("git archive --remote <repo> [--exec <cmd>] [<options>] <tree-ish> [<path>...]"),
27 N_("git archive --remote <repo> [--exec <cmd>] --list"),
31 static const struct archiver
**archivers
;
32 static int nr_archivers
;
33 static int alloc_archivers
;
34 static int remote_allow_unreachable
;
36 void register_archiver(struct archiver
*ar
)
38 ALLOC_GROW(archivers
, nr_archivers
+ 1, alloc_archivers
);
39 archivers
[nr_archivers
++] = ar
;
42 void init_archivers(void)
48 static void format_subst(const struct commit
*commit
,
49 const char *src
, size_t len
,
50 struct strbuf
*buf
, struct pretty_print_context
*ctx
)
53 struct strbuf fmt
= STRBUF_INIT
;
56 to_free
= strbuf_detach(buf
, NULL
);
60 b
= memmem(src
, len
, "$Format:", 8);
63 c
= memchr(b
+ 8, '$', (src
+ len
) - b
- 8);
68 strbuf_add(&fmt
, b
+ 8, c
- b
- 8);
70 strbuf_add(buf
, src
, b
- src
);
71 repo_format_commit_message(the_repository
, commit
, fmt
.buf
,
76 strbuf_add(buf
, src
, len
);
81 static void *object_file_to_archive(const struct archiver_args
*args
,
83 const struct object_id
*oid
,
85 enum object_type
*type
,
89 const struct commit
*commit
= args
->convert
? args
->commit
: NULL
;
90 struct checkout_metadata meta
;
92 init_checkout_metadata(&meta
, args
->refname
,
93 args
->commit_oid
? args
->commit_oid
:
94 (args
->tree
? &args
->tree
->object
.oid
: NULL
), oid
);
96 path
+= args
->baselen
;
97 buffer
= repo_read_object_file(the_repository
, oid
, type
, sizep
);
98 if (buffer
&& S_ISREG(mode
)) {
99 struct strbuf buf
= STRBUF_INIT
;
102 strbuf_attach(&buf
, buffer
, *sizep
, *sizep
+ 1);
103 convert_to_working_tree(args
->repo
->index
, path
, buf
.buf
, buf
.len
, &buf
, &meta
);
105 format_subst(commit
, buf
.buf
, buf
.len
, &buf
, args
->pretty_ctx
);
106 buffer
= strbuf_detach(&buf
, &size
);
114 struct directory
*up
;
115 struct object_id oid
;
118 char path
[FLEX_ARRAY
];
121 struct archiver_context
{
122 struct archiver_args
*args
;
123 write_archive_entry_fn_t write_entry
;
124 struct directory
*bottom
;
127 static const struct attr_check
*get_archive_attrs(struct index_state
*istate
,
130 static struct attr_check
*check
;
132 check
= attr_check_initl("export-ignore", "export-subst", NULL
);
133 git_check_attr(istate
, path
, check
);
137 static int check_attr_export_ignore(const struct attr_check
*check
)
139 return check
&& ATTR_TRUE(check
->items
[0].value
);
142 static int check_attr_export_subst(const struct attr_check
*check
)
144 return check
&& ATTR_TRUE(check
->items
[1].value
);
147 static int write_archive_entry(const struct object_id
*oid
, const char *base
,
148 int baselen
, const char *filename
, unsigned mode
,
151 static struct strbuf path
= STRBUF_INIT
;
152 struct archiver_context
*c
= context
;
153 struct archiver_args
*args
= c
->args
;
154 write_archive_entry_fn_t write_entry
= c
->write_entry
;
156 const char *path_without_prefix
;
159 enum object_type type
;
163 strbuf_grow(&path
, PATH_MAX
);
164 strbuf_add(&path
, args
->base
, args
->baselen
);
165 strbuf_add(&path
, base
, baselen
);
166 strbuf_addstr(&path
, filename
);
167 if (S_ISDIR(mode
) || S_ISGITLINK(mode
))
168 strbuf_addch(&path
, '/');
169 path_without_prefix
= path
.buf
+ args
->baselen
;
171 if (!S_ISDIR(mode
)) {
172 const struct attr_check
*check
;
173 check
= get_archive_attrs(args
->repo
->index
, path_without_prefix
);
174 if (check_attr_export_ignore(check
))
176 args
->convert
= check_attr_export_subst(check
);
180 static struct strbuf new_path
= STRBUF_INIT
;
181 static struct strbuf buf
= STRBUF_INIT
;
184 rel
= relative_path(path_without_prefix
, args
->prefix
, &buf
);
187 * We don't add an entry for the current working
188 * directory when we are at the root; skip it also when
189 * we're in a subdirectory or submodule. Skip entries
192 if (!strcmp(rel
, "./") || starts_with(rel
, "../"))
193 return S_ISDIR(mode
) ? READ_TREE_RECURSIVE
: 0;
195 /* rel can refer to path, so don't edit it in place */
196 strbuf_reset(&new_path
);
197 strbuf_add(&new_path
, args
->base
, args
->baselen
);
198 strbuf_addstr(&new_path
, rel
);
199 strbuf_swap(&path
, &new_path
);
203 fprintf(stderr
, "%.*s\n", (int)path
.len
, path
.buf
);
205 if (S_ISDIR(mode
) || S_ISGITLINK(mode
)) {
206 err
= write_entry(args
, oid
, path
.buf
, path
.len
, mode
, NULL
, 0);
209 return (S_ISDIR(mode
) ? READ_TREE_RECURSIVE
: 0);
213 if (S_ISREG(mode
) && !args
->convert
&&
214 oid_object_info(args
->repo
, oid
, &size
) == OBJ_BLOB
&&
215 size
> big_file_threshold
)
216 return write_entry(args
, oid
, path
.buf
, path
.len
, mode
, NULL
, size
);
218 buffer
= object_file_to_archive(args
, path
.buf
, oid
, mode
, &type
, &size
);
220 return error(_("cannot read '%s'"), oid_to_hex(oid
));
221 err
= write_entry(args
, oid
, path
.buf
, path
.len
, mode
, buffer
, size
);
226 static void queue_directory(const struct object_id
*oid
,
227 struct strbuf
*base
, const char *filename
,
228 unsigned mode
, struct archiver_context
*c
)
231 size_t len
= st_add4(base
->len
, 1, strlen(filename
), 1);
232 d
= xmalloc(st_add(sizeof(*d
), len
));
234 d
->baselen
= base
->len
;
237 d
->len
= xsnprintf(d
->path
, len
, "%.*s%s/", (int)base
->len
, base
->buf
, filename
);
238 oidcpy(&d
->oid
, oid
);
241 static int write_directory(struct archiver_context
*c
)
243 struct directory
*d
= c
->bottom
;
249 d
->path
[d
->len
- 1] = '\0'; /* no trailing slash */
251 write_directory(c
) ||
252 write_archive_entry(&d
->oid
, d
->path
, d
->baselen
,
253 d
->path
+ d
->baselen
, d
->mode
,
254 c
) != READ_TREE_RECURSIVE
;
259 static int queue_or_write_archive_entry(const struct object_id
*oid
,
260 struct strbuf
*base
, const char *filename
,
261 unsigned mode
, void *context
)
263 struct archiver_context
*c
= context
;
266 !(base
->len
>= c
->bottom
->len
&&
267 !strncmp(base
->buf
, c
->bottom
->path
, c
->bottom
->len
))) {
268 struct directory
*next
= c
->bottom
->up
;
274 size_t baselen
= base
->len
;
275 const struct attr_check
*check
;
277 /* Borrow base, but restore its original value when done. */
278 strbuf_addstr(base
, filename
);
279 strbuf_addch(base
, '/');
280 check
= get_archive_attrs(c
->args
->repo
->index
, base
->buf
);
281 strbuf_setlen(base
, baselen
);
283 if (check_attr_export_ignore(check
))
285 queue_directory(oid
, base
, filename
, mode
, c
);
286 return READ_TREE_RECURSIVE
;
289 if (write_directory(c
))
291 return write_archive_entry(oid
, base
->buf
, base
->len
, filename
, mode
,
295 struct extra_file_info
{
301 int write_archive_entries(struct archiver_args
*args
,
302 write_archive_entry_fn_t write_entry
)
304 struct archiver_context context
;
305 struct unpack_trees_options opts
;
308 struct strbuf path_in_archive
= STRBUF_INIT
;
309 struct strbuf content
= STRBUF_INIT
;
310 struct object_id fake_oid
;
313 oidcpy(&fake_oid
, null_oid());
315 if (args
->baselen
> 0 && args
->base
[args
->baselen
- 1] == '/') {
316 size_t len
= args
->baselen
;
318 while (len
> 1 && args
->base
[len
- 2] == '/')
321 fprintf(stderr
, "%.*s\n", (int)len
, args
->base
);
322 err
= write_entry(args
, &args
->tree
->object
.oid
, args
->base
,
323 len
, 040777, NULL
, 0);
328 memset(&context
, 0, sizeof(context
));
330 context
.write_entry
= write_entry
;
333 * Setup index and instruct attr to read index only
335 if (!args
->worktree_attributes
) {
336 memset(&opts
, 0, sizeof(opts
));
339 opts
.src_index
= args
->repo
->index
;
340 opts
.dst_index
= args
->repo
->index
;
341 opts
.fn
= oneway_merge
;
342 init_tree_desc(&t
, args
->tree
->buffer
, args
->tree
->size
);
343 if (unpack_trees(1, &t
, &opts
))
345 git_attr_set_direction(GIT_ATTR_INDEX
);
348 err
= read_tree(args
->repo
, args
->tree
,
350 queue_or_write_archive_entry
,
352 if (err
== READ_TREE_RECURSIVE
)
354 while (context
.bottom
) {
355 struct directory
*next
= context
.bottom
->up
;
356 free(context
.bottom
);
357 context
.bottom
= next
;
360 for (i
= 0; i
< args
->extra_files
.nr
; i
++) {
361 struct string_list_item
*item
= args
->extra_files
.items
+ i
;
362 char *path
= item
->string
;
363 struct extra_file_info
*info
= item
->util
;
365 put_be64(fake_oid
.hash
, i
+ 1);
367 if (!info
->content
) {
368 strbuf_reset(&path_in_archive
);
370 strbuf_addstr(&path_in_archive
, info
->base
);
371 strbuf_addstr(&path_in_archive
, basename(path
));
373 strbuf_reset(&content
);
374 if (strbuf_read_file(&content
, path
, info
->stat
.st_size
) < 0)
375 err
= error_errno(_("cannot read '%s'"), path
);
377 err
= write_entry(args
, &fake_oid
, path_in_archive
.buf
,
379 canon_mode(info
->stat
.st_mode
),
380 content
.buf
, content
.len
);
382 err
= write_entry(args
, &fake_oid
,
384 canon_mode(info
->stat
.st_mode
),
385 info
->content
, info
->stat
.st_size
);
391 strbuf_release(&path_in_archive
);
392 strbuf_release(&content
);
397 static const struct archiver
*lookup_archiver(const char *name
)
404 for (i
= 0; i
< nr_archivers
; i
++) {
405 if (!strcmp(name
, archivers
[i
]->name
))
411 struct path_exists_context
{
412 struct pathspec pathspec
;
413 struct archiver_args
*args
;
416 static int reject_entry(const struct object_id
*oid UNUSED
,
418 const char *filename
, unsigned mode
,
422 struct path_exists_context
*ctx
= context
;
425 struct strbuf sb
= STRBUF_INIT
;
426 strbuf_addbuf(&sb
, base
);
427 strbuf_addstr(&sb
, filename
);
428 if (!match_pathspec(ctx
->args
->repo
->index
,
430 sb
.buf
, sb
.len
, 0, NULL
, 1))
431 ret
= READ_TREE_RECURSIVE
;
437 static int reject_outside(const struct object_id
*oid UNUSED
,
438 struct strbuf
*base
, const char *filename
,
439 unsigned mode
, void *context
)
441 struct archiver_args
*args
= context
;
442 struct strbuf buf
= STRBUF_INIT
;
443 struct strbuf path
= STRBUF_INIT
;
447 return READ_TREE_RECURSIVE
;
449 strbuf_addbuf(&path
, base
);
450 strbuf_addstr(&path
, filename
);
451 if (starts_with(relative_path(path
.buf
, args
->prefix
, &buf
), "../"))
453 strbuf_release(&buf
);
454 strbuf_release(&path
);
458 static int path_exists(struct archiver_args
*args
, const char *path
)
460 const char *paths
[] = { path
, NULL
};
461 struct path_exists_context ctx
;
465 parse_pathspec(&ctx
.pathspec
, 0, PATHSPEC_PREFER_CWD
,
466 args
->prefix
, paths
);
467 ctx
.pathspec
.recursive
= 1;
468 if (args
->prefix
&& read_tree(args
->repo
, args
->tree
, &ctx
.pathspec
,
469 reject_outside
, args
))
470 die(_("pathspec '%s' matches files outside the "
471 "current directory"), path
);
472 ret
= read_tree(args
->repo
, args
->tree
,
475 clear_pathspec(&ctx
.pathspec
);
479 static void parse_pathspec_arg(const char **pathspec
,
480 struct archiver_args
*ar_args
)
483 * must be consistent with parse_pathspec in path_exists()
484 * Also if pathspec patterns are dependent, we're in big
485 * trouble as we test each one separately
487 parse_pathspec(&ar_args
->pathspec
, 0, PATHSPEC_PREFER_CWD
,
488 ar_args
->prefix
, pathspec
);
489 ar_args
->pathspec
.recursive
= 1;
492 if (**pathspec
&& !path_exists(ar_args
, *pathspec
))
493 die(_("pathspec '%s' did not match any files"), *pathspec
);
499 static void parse_treeish_arg(const char **argv
,
500 struct archiver_args
*ar_args
, int remote
)
502 const char *name
= argv
[0];
503 const struct object_id
*commit_oid
;
506 const struct commit
*commit
;
507 struct object_id oid
;
510 /* Remotes are only allowed to fetch actual refs */
511 if (remote
&& !remote_allow_unreachable
) {
512 const char *colon
= strchrnul(name
, ':');
513 int refnamelen
= colon
- name
;
515 if (!repo_dwim_ref(the_repository
, name
, refnamelen
, &oid
, &ref
, 0))
516 die(_("no such ref: %.*s"), refnamelen
, name
);
518 repo_dwim_ref(the_repository
, name
, strlen(name
), &oid
, &ref
,
522 if (repo_get_oid(the_repository
, name
, &oid
))
523 die(_("not a valid object name: %s"), name
);
525 commit
= lookup_commit_reference_gently(ar_args
->repo
, &oid
, 1);
527 commit_oid
= &commit
->object
.oid
;
528 archive_time
= commit
->date
;
531 archive_time
= time(NULL
);
533 if (ar_args
->mtime_option
)
534 archive_time
= approxidate(ar_args
->mtime_option
);
536 tree
= parse_tree_indirect(&oid
);
538 die(_("not a tree object: %s"), oid_to_hex(&oid
));
540 ar_args
->refname
= ref
;
541 ar_args
->tree
= tree
;
542 ar_args
->commit_oid
= commit_oid
;
543 ar_args
->commit
= commit
;
544 ar_args
->time
= archive_time
;
547 static void extra_file_info_clear(void *util
, const char *str UNUSED
)
549 struct extra_file_info
*info
= util
;
555 static int add_file_cb(const struct option
*opt
, const char *arg
, int unset
)
557 struct archiver_args
*args
= opt
->value
;
558 const char **basep
= (const char **)opt
->defval
;
559 const char *base
= *basep
;
561 struct string_list_item
*item
;
562 struct extra_file_info
*info
;
565 string_list_clear_func(&args
->extra_files
,
566 extra_file_info_clear
);
573 info
= xmalloc(sizeof(*info
));
574 info
->base
= xstrdup_or_null(base
);
576 if (!strcmp(opt
->long_name
, "add-file")) {
577 path
= prefix_filename(args
->prefix
, arg
);
578 if (stat(path
, &info
->stat
))
579 die(_("File not found: %s"), path
);
580 if (!S_ISREG(info
->stat
.st_mode
))
581 die(_("Not a regular file: %s"), path
);
582 info
->content
= NULL
; /* read the file later */
583 } else if (!strcmp(opt
->long_name
, "add-virtual-file")) {
584 struct strbuf buf
= STRBUF_INIT
;
589 else if (unquote_c_style(&buf
, p
, &p
) < 0)
590 die(_("unclosed quote: '%s'"), arg
);
593 die(_("missing colon: '%s'"), arg
);
596 die(_("empty file name: '%s'"), arg
);
599 strbuf_detach(&buf
, NULL
) : xstrndup(arg
, p
- arg
);
603 path
= prefix_filename(args
->prefix
, path
);
606 memset(&info
->stat
, 0, sizeof(info
->stat
));
607 info
->stat
.st_mode
= S_IFREG
| 0644;
608 info
->content
= xstrdup(p
+ 1);
609 info
->stat
.st_size
= strlen(info
->content
);
611 BUG("add_file_cb() called for %s", opt
->long_name
);
613 item
= string_list_append_nodup(&args
->extra_files
, path
);
619 static int number_callback(const struct option
*opt
, const char *arg
, int unset
)
621 BUG_ON_OPT_NEG(unset
);
622 *(int *)opt
->value
= strtol(arg
, NULL
, 10);
626 static int parse_archive_args(int argc
, const char **argv
,
627 const struct archiver
**ar
, struct archiver_args
*args
,
628 const char *name_hint
, int is_remote
)
630 const char *format
= NULL
;
631 const char *base
= NULL
;
632 const char *remote
= NULL
;
633 const char *exec
= NULL
;
634 const char *output
= NULL
;
635 const char *mtime_option
= NULL
;
636 int compression_level
= -1;
640 int worktree_attributes
= 0;
641 struct option opts
[] = {
643 OPT_STRING(0, "format", &format
, N_("fmt"), N_("archive format")),
644 OPT_STRING(0, "prefix", &base
, N_("prefix"),
645 N_("prepend prefix to each pathname in the archive")),
646 { OPTION_CALLBACK
, 0, "add-file", args
, N_("file"),
647 N_("add untracked file to archive"), 0, add_file_cb
,
649 { OPTION_CALLBACK
, 0, "add-virtual-file", args
,
650 N_("path:content"), N_("add untracked file to archive"), 0,
651 add_file_cb
, (intptr_t)&base
},
652 OPT_STRING('o', "output", &output
, N_("file"),
653 N_("write the archive to this file")),
654 OPT_BOOL(0, "worktree-attributes", &worktree_attributes
,
655 N_("read .gitattributes in working directory")),
656 OPT__VERBOSE(&verbose
, N_("report archived files on stderr")),
657 { OPTION_STRING
, 0, "mtime", &mtime_option
, N_("time"),
658 N_("set modification time of archive entries"),
660 OPT_NUMBER_CALLBACK(&compression_level
,
661 N_("set compression level"), number_callback
),
663 OPT_BOOL('l', "list", &list
,
664 N_("list supported archive formats")),
666 OPT_STRING(0, "remote", &remote
, N_("repo"),
667 N_("retrieve the archive from remote repository <repo>")),
668 OPT_STRING(0, "exec", &exec
, N_("command"),
669 N_("path to the remote git-upload-archive command")),
673 argc
= parse_options(argc
, argv
, NULL
, opts
, archive_usage
, 0);
676 die(_("Unexpected option --remote"));
678 die(_("the option '%s' requires '%s'"), "--exec", "--remote");
680 die(_("Unexpected option --output"));
681 if (is_remote
&& args
->extra_files
.nr
)
682 die(_("options '%s' and '%s' cannot be used together"), "--add-file", "--remote");
688 for (i
= 0; i
< nr_archivers
; i
++)
689 if (!is_remote
|| archivers
[i
]->flags
& ARCHIVER_REMOTE
)
690 printf("%s\n", archivers
[i
]->name
);
694 if (!format
&& name_hint
)
695 format
= archive_format_from_filename(name_hint
);
699 /* We need at least one parameter -- tree-ish */
701 usage_with_options(archive_usage
, opts
);
702 *ar
= lookup_archiver(format
);
703 if (!*ar
|| (is_remote
&& !((*ar
)->flags
& ARCHIVER_REMOTE
)))
704 die(_("Unknown archive format '%s'"), format
);
706 args
->compression_level
= Z_DEFAULT_COMPRESSION
;
707 if (compression_level
!= -1) {
708 int levels_ok
= (*ar
)->flags
& ARCHIVER_WANT_COMPRESSION_LEVELS
;
709 int high_ok
= (*ar
)->flags
& ARCHIVER_HIGH_COMPRESSION_LEVELS
;
710 if (levels_ok
&& (compression_level
<= 9 || high_ok
))
711 args
->compression_level
= compression_level
;
713 die(_("Argument not supported for format '%s': -%d"),
714 format
, compression_level
);
717 args
->verbose
= verbose
;
719 args
->baselen
= strlen(base
);
720 args
->worktree_attributes
= worktree_attributes
;
721 args
->mtime_option
= mtime_option
;
726 int write_archive(int argc
, const char **argv
, const char *prefix
,
727 struct repository
*repo
,
728 const char *name_hint
, int remote
)
730 const struct archiver
*ar
= NULL
;
731 struct pretty_print_describe_status describe_status
= {0};
732 struct pretty_print_context ctx
= {0};
733 struct archiver_args args
;
736 git_config_get_bool("uploadarchive.allowunreachable", &remote_allow_unreachable
);
737 git_config(git_default_config
, NULL
);
739 describe_status
.max_invocations
= 1;
740 ctx
.date_mode
.type
= DATE_NORMAL
;
741 ctx
.abbrev
= DEFAULT_ABBREV
;
742 ctx
.describe_status
= &describe_status
;
743 args
.pretty_ctx
= &ctx
;
745 args
.prefix
= prefix
;
746 string_list_init_dup(&args
.extra_files
);
747 argc
= parse_archive_args(argc
, argv
, &ar
, &args
, name_hint
, remote
);
748 if (!startup_info
->have_repository
) {
750 * We know this will die() with an error, so we could just
751 * die ourselves; but its error message will be more specific
752 * than what we could write here.
754 setup_git_directory();
757 parse_treeish_arg(argv
, &args
, remote
);
758 parse_pathspec_arg(argv
+ 1, &args
);
760 rc
= ar
->write_archive(ar
, &args
);
762 string_list_clear_func(&args
.extra_files
, extra_file_info_clear
);
764 clear_pathspec(&args
.pathspec
);
769 static int match_extension(const char *filename
, const char *ext
)
771 int prefixlen
= strlen(filename
) - strlen(ext
);
774 * We need 1 character for the '.', and 1 character to ensure that the
775 * prefix is non-empty (k.e., we don't match .tar.gz with no actual
778 if (prefixlen
< 2 || filename
[prefixlen
- 1] != '.')
780 return !strcmp(filename
+ prefixlen
, ext
);
783 const char *archive_format_from_filename(const char *filename
)
787 for (i
= 0; i
< nr_archivers
; i
++)
788 if (match_extension(filename
, archivers
[i
]->name
))
789 return archivers
[i
]->name
;