1 #include "git-compat-util.h"
5 #include "environment.h"
10 #include "object-store.h"
12 #include "tree-walk.h"
15 #include "parse-options.h"
16 #include "unpack-trees.h"
20 static char const * const archive_usage
[] = {
21 N_("git archive [<options>] <tree-ish> [<path>...]"),
23 N_("git archive --remote <repo> [--exec <cmd>] [<options>] <tree-ish> [<path>...]"),
24 N_("git archive --remote <repo> [--exec <cmd>] --list"),
28 static const struct archiver
**archivers
;
29 static int nr_archivers
;
30 static int alloc_archivers
;
31 static int remote_allow_unreachable
;
33 void register_archiver(struct archiver
*ar
)
35 ALLOC_GROW(archivers
, nr_archivers
+ 1, alloc_archivers
);
36 archivers
[nr_archivers
++] = ar
;
39 void init_archivers(void)
45 static void format_subst(const struct commit
*commit
,
46 const char *src
, size_t len
,
47 struct strbuf
*buf
, struct pretty_print_context
*ctx
)
50 struct strbuf fmt
= STRBUF_INIT
;
53 to_free
= strbuf_detach(buf
, NULL
);
57 b
= memmem(src
, len
, "$Format:", 8);
60 c
= memchr(b
+ 8, '$', (src
+ len
) - b
- 8);
65 strbuf_add(&fmt
, b
+ 8, c
- b
- 8);
67 strbuf_add(buf
, src
, b
- src
);
68 format_commit_message(commit
, fmt
.buf
, buf
, ctx
);
72 strbuf_add(buf
, src
, len
);
77 static void *object_file_to_archive(const struct archiver_args
*args
,
79 const struct object_id
*oid
,
81 enum object_type
*type
,
85 const struct commit
*commit
= args
->convert
? args
->commit
: NULL
;
86 struct checkout_metadata meta
;
88 init_checkout_metadata(&meta
, args
->refname
,
89 args
->commit_oid
? args
->commit_oid
:
90 (args
->tree
? &args
->tree
->object
.oid
: NULL
), oid
);
92 path
+= args
->baselen
;
93 buffer
= read_object_file(oid
, type
, sizep
);
94 if (buffer
&& S_ISREG(mode
)) {
95 struct strbuf buf
= STRBUF_INIT
;
98 strbuf_attach(&buf
, buffer
, *sizep
, *sizep
+ 1);
99 convert_to_working_tree(args
->repo
->index
, path
, buf
.buf
, buf
.len
, &buf
, &meta
);
101 format_subst(commit
, buf
.buf
, buf
.len
, &buf
, args
->pretty_ctx
);
102 buffer
= strbuf_detach(&buf
, &size
);
110 struct directory
*up
;
111 struct object_id oid
;
114 char path
[FLEX_ARRAY
];
117 struct archiver_context
{
118 struct archiver_args
*args
;
119 write_archive_entry_fn_t write_entry
;
120 struct directory
*bottom
;
123 static const struct attr_check
*get_archive_attrs(struct index_state
*istate
,
126 static struct attr_check
*check
;
128 check
= attr_check_initl("export-ignore", "export-subst", NULL
);
129 git_check_attr(istate
, NULL
, path
, check
);
133 static int check_attr_export_ignore(const struct attr_check
*check
)
135 return check
&& ATTR_TRUE(check
->items
[0].value
);
138 static int check_attr_export_subst(const struct attr_check
*check
)
140 return check
&& ATTR_TRUE(check
->items
[1].value
);
143 static int write_archive_entry(const struct object_id
*oid
, const char *base
,
144 int baselen
, const char *filename
, unsigned mode
,
147 static struct strbuf path
= STRBUF_INIT
;
148 struct archiver_context
*c
= context
;
149 struct archiver_args
*args
= c
->args
;
150 write_archive_entry_fn_t write_entry
= c
->write_entry
;
152 const char *path_without_prefix
;
155 enum object_type type
;
159 strbuf_grow(&path
, PATH_MAX
);
160 strbuf_add(&path
, args
->base
, args
->baselen
);
161 strbuf_add(&path
, base
, baselen
);
162 strbuf_addstr(&path
, filename
);
163 if (S_ISDIR(mode
) || S_ISGITLINK(mode
))
164 strbuf_addch(&path
, '/');
165 path_without_prefix
= path
.buf
+ args
->baselen
;
167 if (!S_ISDIR(mode
)) {
168 const struct attr_check
*check
;
169 check
= get_archive_attrs(args
->repo
->index
, path_without_prefix
);
170 if (check_attr_export_ignore(check
))
172 args
->convert
= check_attr_export_subst(check
);
176 fprintf(stderr
, "%.*s\n", (int)path
.len
, path
.buf
);
178 if (S_ISDIR(mode
) || S_ISGITLINK(mode
)) {
179 err
= write_entry(args
, oid
, path
.buf
, path
.len
, mode
, NULL
, 0);
182 return (S_ISDIR(mode
) ? READ_TREE_RECURSIVE
: 0);
186 if (S_ISREG(mode
) && !args
->convert
&&
187 oid_object_info(args
->repo
, oid
, &size
) == OBJ_BLOB
&&
188 size
> big_file_threshold
)
189 return write_entry(args
, oid
, path
.buf
, path
.len
, mode
, NULL
, size
);
191 buffer
= object_file_to_archive(args
, path
.buf
, oid
, mode
, &type
, &size
);
193 return error(_("cannot read '%s'"), oid_to_hex(oid
));
194 err
= write_entry(args
, oid
, path
.buf
, path
.len
, mode
, buffer
, size
);
199 static void queue_directory(const struct object_id
*oid
,
200 struct strbuf
*base
, const char *filename
,
201 unsigned mode
, struct archiver_context
*c
)
204 size_t len
= st_add4(base
->len
, 1, strlen(filename
), 1);
205 d
= xmalloc(st_add(sizeof(*d
), len
));
207 d
->baselen
= base
->len
;
210 d
->len
= xsnprintf(d
->path
, len
, "%.*s%s/", (int)base
->len
, base
->buf
, filename
);
211 oidcpy(&d
->oid
, oid
);
214 static int write_directory(struct archiver_context
*c
)
216 struct directory
*d
= c
->bottom
;
222 d
->path
[d
->len
- 1] = '\0'; /* no trailing slash */
224 write_directory(c
) ||
225 write_archive_entry(&d
->oid
, d
->path
, d
->baselen
,
226 d
->path
+ d
->baselen
, d
->mode
,
227 c
) != READ_TREE_RECURSIVE
;
232 static int queue_or_write_archive_entry(const struct object_id
*oid
,
233 struct strbuf
*base
, const char *filename
,
234 unsigned mode
, void *context
)
236 struct archiver_context
*c
= context
;
239 !(base
->len
>= c
->bottom
->len
&&
240 !strncmp(base
->buf
, c
->bottom
->path
, c
->bottom
->len
))) {
241 struct directory
*next
= c
->bottom
->up
;
247 size_t baselen
= base
->len
;
248 const struct attr_check
*check
;
250 /* Borrow base, but restore its original value when done. */
251 strbuf_addstr(base
, filename
);
252 strbuf_addch(base
, '/');
253 check
= get_archive_attrs(c
->args
->repo
->index
, base
->buf
);
254 strbuf_setlen(base
, baselen
);
256 if (check_attr_export_ignore(check
))
258 queue_directory(oid
, base
, filename
, mode
, c
);
259 return READ_TREE_RECURSIVE
;
262 if (write_directory(c
))
264 return write_archive_entry(oid
, base
->buf
, base
->len
, filename
, mode
,
268 struct extra_file_info
{
274 int write_archive_entries(struct archiver_args
*args
,
275 write_archive_entry_fn_t write_entry
)
277 struct archiver_context context
;
278 struct unpack_trees_options opts
;
281 struct strbuf path_in_archive
= STRBUF_INIT
;
282 struct strbuf content
= STRBUF_INIT
;
283 struct object_id fake_oid
;
286 oidcpy(&fake_oid
, null_oid());
288 if (args
->baselen
> 0 && args
->base
[args
->baselen
- 1] == '/') {
289 size_t len
= args
->baselen
;
291 while (len
> 1 && args
->base
[len
- 2] == '/')
294 fprintf(stderr
, "%.*s\n", (int)len
, args
->base
);
295 err
= write_entry(args
, &args
->tree
->object
.oid
, args
->base
,
296 len
, 040777, NULL
, 0);
301 memset(&context
, 0, sizeof(context
));
303 context
.write_entry
= write_entry
;
306 * Setup index and instruct attr to read index only
308 if (!args
->worktree_attributes
) {
309 memset(&opts
, 0, sizeof(opts
));
312 opts
.src_index
= args
->repo
->index
;
313 opts
.dst_index
= args
->repo
->index
;
314 opts
.fn
= oneway_merge
;
315 init_tree_desc(&t
, args
->tree
->buffer
, args
->tree
->size
);
316 if (unpack_trees(1, &t
, &opts
))
318 git_attr_set_direction(GIT_ATTR_INDEX
);
321 err
= read_tree(args
->repo
, args
->tree
,
323 queue_or_write_archive_entry
,
325 if (err
== READ_TREE_RECURSIVE
)
327 while (context
.bottom
) {
328 struct directory
*next
= context
.bottom
->up
;
329 free(context
.bottom
);
330 context
.bottom
= next
;
333 for (i
= 0; i
< args
->extra_files
.nr
; i
++) {
334 struct string_list_item
*item
= args
->extra_files
.items
+ i
;
335 char *path
= item
->string
;
336 struct extra_file_info
*info
= item
->util
;
338 put_be64(fake_oid
.hash
, i
+ 1);
340 if (!info
->content
) {
341 strbuf_reset(&path_in_archive
);
343 strbuf_addstr(&path_in_archive
, info
->base
);
344 strbuf_addstr(&path_in_archive
, basename(path
));
346 strbuf_reset(&content
);
347 if (strbuf_read_file(&content
, path
, info
->stat
.st_size
) < 0)
348 err
= error_errno(_("cannot read '%s'"), path
);
350 err
= write_entry(args
, &fake_oid
, path_in_archive
.buf
,
352 canon_mode(info
->stat
.st_mode
),
353 content
.buf
, content
.len
);
355 err
= write_entry(args
, &fake_oid
,
357 canon_mode(info
->stat
.st_mode
),
358 info
->content
, info
->stat
.st_size
);
364 strbuf_release(&path_in_archive
);
365 strbuf_release(&content
);
370 static const struct archiver
*lookup_archiver(const char *name
)
377 for (i
= 0; i
< nr_archivers
; i
++) {
378 if (!strcmp(name
, archivers
[i
]->name
))
384 struct path_exists_context
{
385 struct pathspec pathspec
;
386 struct archiver_args
*args
;
389 static int reject_entry(const struct object_id
*oid UNUSED
,
391 const char *filename
, unsigned mode
,
395 struct path_exists_context
*ctx
= context
;
398 struct strbuf sb
= STRBUF_INIT
;
399 strbuf_addbuf(&sb
, base
);
400 strbuf_addstr(&sb
, filename
);
401 if (!match_pathspec(ctx
->args
->repo
->index
,
403 sb
.buf
, sb
.len
, 0, NULL
, 1))
404 ret
= READ_TREE_RECURSIVE
;
410 static int path_exists(struct archiver_args
*args
, const char *path
)
412 const char *paths
[] = { path
, NULL
};
413 struct path_exists_context ctx
;
417 parse_pathspec(&ctx
.pathspec
, 0, 0, "", paths
);
418 ctx
.pathspec
.recursive
= 1;
419 ret
= read_tree(args
->repo
, args
->tree
,
422 clear_pathspec(&ctx
.pathspec
);
426 static void parse_pathspec_arg(const char **pathspec
,
427 struct archiver_args
*ar_args
)
430 * must be consistent with parse_pathspec in path_exists()
431 * Also if pathspec patterns are dependent, we're in big
432 * trouble as we test each one separately
434 parse_pathspec(&ar_args
->pathspec
, 0,
435 PATHSPEC_PREFER_FULL
,
437 ar_args
->pathspec
.recursive
= 1;
440 if (**pathspec
&& !path_exists(ar_args
, *pathspec
))
441 die(_("pathspec '%s' did not match any files"), *pathspec
);
447 static void parse_treeish_arg(const char **argv
,
448 struct archiver_args
*ar_args
, const char *prefix
,
451 const char *name
= argv
[0];
452 const struct object_id
*commit_oid
;
455 const struct commit
*commit
;
456 struct object_id oid
;
459 /* Remotes are only allowed to fetch actual refs */
460 if (remote
&& !remote_allow_unreachable
) {
461 const char *colon
= strchrnul(name
, ':');
462 int refnamelen
= colon
- name
;
464 if (!dwim_ref(name
, refnamelen
, &oid
, &ref
, 0))
465 die(_("no such ref: %.*s"), refnamelen
, name
);
467 dwim_ref(name
, strlen(name
), &oid
, &ref
, 0);
470 if (get_oid(name
, &oid
))
471 die(_("not a valid object name: %s"), name
);
473 commit
= lookup_commit_reference_gently(ar_args
->repo
, &oid
, 1);
475 commit_oid
= &commit
->object
.oid
;
476 archive_time
= commit
->date
;
479 archive_time
= time(NULL
);
481 if (ar_args
->mtime_option
)
482 archive_time
= approxidate(ar_args
->mtime_option
);
484 tree
= parse_tree_indirect(&oid
);
486 die(_("not a tree object: %s"), oid_to_hex(&oid
));
489 struct object_id tree_oid
;
493 err
= get_tree_entry(ar_args
->repo
,
497 if (err
|| !S_ISDIR(mode
))
498 die(_("current working directory is untracked"));
500 tree
= parse_tree_indirect(&tree_oid
);
502 ar_args
->refname
= ref
;
503 ar_args
->tree
= tree
;
504 ar_args
->commit_oid
= commit_oid
;
505 ar_args
->commit
= commit
;
506 ar_args
->time
= archive_time
;
509 static void extra_file_info_clear(void *util
, const char *str UNUSED
)
511 struct extra_file_info
*info
= util
;
517 static int add_file_cb(const struct option
*opt
, const char *arg
, int unset
)
519 struct archiver_args
*args
= opt
->value
;
520 const char **basep
= (const char **)opt
->defval
;
521 const char *base
= *basep
;
523 struct string_list_item
*item
;
524 struct extra_file_info
*info
;
527 string_list_clear_func(&args
->extra_files
,
528 extra_file_info_clear
);
535 info
= xmalloc(sizeof(*info
));
536 info
->base
= xstrdup_or_null(base
);
538 if (!strcmp(opt
->long_name
, "add-file")) {
539 path
= prefix_filename(args
->prefix
, arg
);
540 if (stat(path
, &info
->stat
))
541 die(_("File not found: %s"), path
);
542 if (!S_ISREG(info
->stat
.st_mode
))
543 die(_("Not a regular file: %s"), path
);
544 info
->content
= NULL
; /* read the file later */
545 } else if (!strcmp(opt
->long_name
, "add-virtual-file")) {
546 struct strbuf buf
= STRBUF_INIT
;
551 else if (unquote_c_style(&buf
, p
, &p
) < 0)
552 die(_("unclosed quote: '%s'"), arg
);
555 die(_("missing colon: '%s'"), arg
);
558 die(_("empty file name: '%s'"), arg
);
561 strbuf_detach(&buf
, NULL
) : xstrndup(arg
, p
- arg
);
565 path
= prefix_filename(args
->prefix
, path
);
568 memset(&info
->stat
, 0, sizeof(info
->stat
));
569 info
->stat
.st_mode
= S_IFREG
| 0644;
570 info
->content
= xstrdup(p
+ 1);
571 info
->stat
.st_size
= strlen(info
->content
);
573 BUG("add_file_cb() called for %s", opt
->long_name
);
575 item
= string_list_append_nodup(&args
->extra_files
, path
);
581 static int number_callback(const struct option
*opt
, const char *arg
, int unset
)
583 BUG_ON_OPT_NEG(unset
);
584 *(int *)opt
->value
= strtol(arg
, NULL
, 10);
588 static int parse_archive_args(int argc
, const char **argv
,
589 const struct archiver
**ar
, struct archiver_args
*args
,
590 const char *name_hint
, int is_remote
)
592 const char *format
= NULL
;
593 const char *base
= NULL
;
594 const char *remote
= NULL
;
595 const char *exec
= NULL
;
596 const char *output
= NULL
;
597 const char *mtime_option
= NULL
;
598 int compression_level
= -1;
602 int worktree_attributes
= 0;
603 struct option opts
[] = {
605 OPT_STRING(0, "format", &format
, N_("fmt"), N_("archive format")),
606 OPT_STRING(0, "prefix", &base
, N_("prefix"),
607 N_("prepend prefix to each pathname in the archive")),
608 { OPTION_CALLBACK
, 0, "add-file", args
, N_("file"),
609 N_("add untracked file to archive"), 0, add_file_cb
,
611 { OPTION_CALLBACK
, 0, "add-virtual-file", args
,
612 N_("path:content"), N_("add untracked file to archive"), 0,
613 add_file_cb
, (intptr_t)&base
},
614 OPT_STRING('o', "output", &output
, N_("file"),
615 N_("write the archive to this file")),
616 OPT_BOOL(0, "worktree-attributes", &worktree_attributes
,
617 N_("read .gitattributes in working directory")),
618 OPT__VERBOSE(&verbose
, N_("report archived files on stderr")),
619 { OPTION_STRING
, 0, "mtime", &mtime_option
, N_("time"),
620 N_("set modification time of archive entries"),
622 OPT_NUMBER_CALLBACK(&compression_level
,
623 N_("set compression level"), number_callback
),
625 OPT_BOOL('l', "list", &list
,
626 N_("list supported archive formats")),
628 OPT_STRING(0, "remote", &remote
, N_("repo"),
629 N_("retrieve the archive from remote repository <repo>")),
630 OPT_STRING(0, "exec", &exec
, N_("command"),
631 N_("path to the remote git-upload-archive command")),
635 argc
= parse_options(argc
, argv
, NULL
, opts
, archive_usage
, 0);
638 die(_("Unexpected option --remote"));
640 die(_("the option '%s' requires '%s'"), "--exec", "--remote");
642 die(_("Unexpected option --output"));
643 if (is_remote
&& args
->extra_files
.nr
)
644 die(_("options '%s' and '%s' cannot be used together"), "--add-file", "--remote");
650 for (i
= 0; i
< nr_archivers
; i
++)
651 if (!is_remote
|| archivers
[i
]->flags
& ARCHIVER_REMOTE
)
652 printf("%s\n", archivers
[i
]->name
);
656 if (!format
&& name_hint
)
657 format
= archive_format_from_filename(name_hint
);
661 /* We need at least one parameter -- tree-ish */
663 usage_with_options(archive_usage
, opts
);
664 *ar
= lookup_archiver(format
);
665 if (!*ar
|| (is_remote
&& !((*ar
)->flags
& ARCHIVER_REMOTE
)))
666 die(_("Unknown archive format '%s'"), format
);
668 args
->compression_level
= Z_DEFAULT_COMPRESSION
;
669 if (compression_level
!= -1) {
670 int levels_ok
= (*ar
)->flags
& ARCHIVER_WANT_COMPRESSION_LEVELS
;
671 int high_ok
= (*ar
)->flags
& ARCHIVER_HIGH_COMPRESSION_LEVELS
;
672 if (levels_ok
&& (compression_level
<= 9 || high_ok
))
673 args
->compression_level
= compression_level
;
675 die(_("Argument not supported for format '%s': -%d"),
676 format
, compression_level
);
679 args
->verbose
= verbose
;
681 args
->baselen
= strlen(base
);
682 args
->worktree_attributes
= worktree_attributes
;
683 args
->mtime_option
= mtime_option
;
688 int write_archive(int argc
, const char **argv
, const char *prefix
,
689 struct repository
*repo
,
690 const char *name_hint
, int remote
)
692 const struct archiver
*ar
= NULL
;
693 struct pretty_print_describe_status describe_status
= {0};
694 struct pretty_print_context ctx
= {0};
695 struct archiver_args args
;
698 git_config_get_bool("uploadarchive.allowunreachable", &remote_allow_unreachable
);
699 git_config(git_default_config
, NULL
);
701 describe_status
.max_invocations
= 1;
702 ctx
.date_mode
.type
= DATE_NORMAL
;
703 ctx
.abbrev
= DEFAULT_ABBREV
;
704 ctx
.describe_status
= &describe_status
;
705 args
.pretty_ctx
= &ctx
;
707 args
.prefix
= prefix
;
708 string_list_init_dup(&args
.extra_files
);
709 argc
= parse_archive_args(argc
, argv
, &ar
, &args
, name_hint
, remote
);
710 if (!startup_info
->have_repository
) {
712 * We know this will die() with an error, so we could just
713 * die ourselves; but its error message will be more specific
714 * than what we could write here.
716 setup_git_directory();
719 parse_treeish_arg(argv
, &args
, prefix
, remote
);
720 parse_pathspec_arg(argv
+ 1, &args
);
722 rc
= ar
->write_archive(ar
, &args
);
724 string_list_clear_func(&args
.extra_files
, extra_file_info_clear
);
726 clear_pathspec(&args
.pathspec
);
731 static int match_extension(const char *filename
, const char *ext
)
733 int prefixlen
= strlen(filename
) - strlen(ext
);
736 * We need 1 character for the '.', and 1 character to ensure that the
737 * prefix is non-empty (k.e., we don't match .tar.gz with no actual
740 if (prefixlen
< 2 || filename
[prefixlen
- 1] != '.')
742 return !strcmp(filename
+ prefixlen
, ext
);
745 const char *archive_format_from_filename(const char *filename
)
749 for (i
= 0; i
< nr_archivers
; i
++)
750 if (match_extension(filename
, archivers
[i
]->name
))
751 return archivers
[i
]->name
;