4 #include "object-store.h"
9 #include "parse-options.h"
10 #include "unpack-trees.h"
14 static char const * const archive_usage
[] = {
15 N_("git archive [<options>] <tree-ish> [<path>...]"),
17 N_("git archive --remote <repo> [--exec <cmd>] [<options>] <tree-ish> [<path>...]"),
18 N_("git archive --remote <repo> [--exec <cmd>] --list"),
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)
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
)
44 struct strbuf fmt
= STRBUF_INIT
;
47 to_free
= strbuf_detach(buf
, NULL
);
51 b
= memmem(src
, len
, "$Format:", 8);
54 c
= memchr(b
+ 8, '$', (src
+ len
) - b
- 8);
59 strbuf_add(&fmt
, b
+ 8, c
- b
- 8);
61 strbuf_add(buf
, src
, b
- src
);
62 format_commit_message(commit
, fmt
.buf
, buf
, ctx
);
66 strbuf_add(buf
, src
, len
);
71 static void *object_file_to_archive(const struct archiver_args
*args
,
73 const struct object_id
*oid
,
75 enum object_type
*type
,
79 const struct commit
*commit
= args
->convert
? args
->commit
: NULL
;
80 struct checkout_metadata meta
;
82 init_checkout_metadata(&meta
, args
->refname
,
83 args
->commit_oid
? args
->commit_oid
:
84 (args
->tree
? &args
->tree
->object
.oid
: NULL
), oid
);
86 path
+= args
->baselen
;
87 buffer
= read_object_file(oid
, type
, sizep
);
88 if (buffer
&& S_ISREG(mode
)) {
89 struct strbuf buf
= STRBUF_INIT
;
92 strbuf_attach(&buf
, buffer
, *sizep
, *sizep
+ 1);
93 convert_to_working_tree(args
->repo
->index
, path
, buf
.buf
, buf
.len
, &buf
, &meta
);
95 format_subst(commit
, buf
.buf
, buf
.len
, &buf
, args
->pretty_ctx
);
96 buffer
= strbuf_detach(&buf
, &size
);
104 struct directory
*up
;
105 struct object_id oid
;
108 char path
[FLEX_ARRAY
];
111 struct archiver_context
{
112 struct archiver_args
*args
;
113 write_archive_entry_fn_t write_entry
;
114 struct directory
*bottom
;
117 static const struct attr_check
*get_archive_attrs(struct index_state
*istate
,
120 static struct attr_check
*check
;
122 check
= attr_check_initl("export-ignore", "export-subst", NULL
);
123 git_check_attr(istate
, path
, check
);
127 static int check_attr_export_ignore(const struct attr_check
*check
)
129 return check
&& ATTR_TRUE(check
->items
[0].value
);
132 static int check_attr_export_subst(const struct attr_check
*check
)
134 return check
&& ATTR_TRUE(check
->items
[1].value
);
137 static int write_archive_entry(const struct object_id
*oid
, const char *base
,
138 int baselen
, const char *filename
, unsigned mode
,
141 static struct strbuf path
= STRBUF_INIT
;
142 struct archiver_context
*c
= context
;
143 struct archiver_args
*args
= c
->args
;
144 write_archive_entry_fn_t write_entry
= c
->write_entry
;
146 const char *path_without_prefix
;
149 enum object_type type
;
153 strbuf_grow(&path
, PATH_MAX
);
154 strbuf_add(&path
, args
->base
, args
->baselen
);
155 strbuf_add(&path
, base
, baselen
);
156 strbuf_addstr(&path
, filename
);
157 if (S_ISDIR(mode
) || S_ISGITLINK(mode
))
158 strbuf_addch(&path
, '/');
159 path_without_prefix
= path
.buf
+ args
->baselen
;
161 if (!S_ISDIR(mode
)) {
162 const struct attr_check
*check
;
163 check
= get_archive_attrs(args
->repo
->index
, path_without_prefix
);
164 if (check_attr_export_ignore(check
))
166 args
->convert
= check_attr_export_subst(check
);
169 if (S_ISDIR(mode
) || S_ISGITLINK(mode
)) {
171 fprintf(stderr
, "%.*s\n", (int)path
.len
, path
.buf
);
172 err
= write_entry(args
, oid
, path
.buf
, path
.len
, mode
, NULL
, 0);
175 return (S_ISDIR(mode
) ? READ_TREE_RECURSIVE
: 0);
179 fprintf(stderr
, "%.*s\n", (int)path
.len
, path
.buf
);
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
);
189 return error(_("cannot read '%s'"), oid_to_hex(oid
));
190 err
= write_entry(args
, oid
, path
.buf
, path
.len
, mode
, buffer
, size
);
195 static void queue_directory(const struct object_id
*oid
,
196 struct strbuf
*base
, const char *filename
,
197 unsigned mode
, struct archiver_context
*c
)
200 size_t len
= st_add4(base
->len
, 1, strlen(filename
), 1);
201 d
= xmalloc(st_add(sizeof(*d
), len
));
203 d
->baselen
= base
->len
;
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
;
218 d
->path
[d
->len
- 1] = '\0'; /* no trailing slash */
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
;
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
;
235 !(base
->len
>= c
->bottom
->len
&&
236 !strncmp(base
->buf
, c
->bottom
->path
, c
->bottom
->len
))) {
237 struct directory
*next
= c
->bottom
->up
;
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
))
254 queue_directory(oid
, base
, filename
, mode
, c
);
255 return READ_TREE_RECURSIVE
;
258 if (write_directory(c
))
260 return write_archive_entry(oid
, base
->buf
, base
->len
, filename
, mode
,
264 struct extra_file_info
{
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
;
277 struct strbuf path_in_archive
= STRBUF_INIT
;
278 struct strbuf content
= STRBUF_INIT
;
279 struct object_id fake_oid
;
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] == '/')
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);
297 memset(&context
, 0, sizeof(context
));
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
));
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
))
314 git_attr_set_direction(GIT_ATTR_INDEX
);
317 err
= read_tree(args
->repo
, args
->tree
,
319 queue_or_write_archive_entry
,
321 if (err
== READ_TREE_RECURSIVE
)
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
);
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
);
346 err
= write_entry(args
, &fake_oid
, path_in_archive
.buf
,
348 canon_mode(info
->stat
.st_mode
),
349 content
.buf
, content
.len
);
351 err
= write_entry(args
, &fake_oid
,
353 canon_mode(info
->stat
.st_mode
),
354 info
->content
, info
->stat
.st_size
);
360 strbuf_release(&path_in_archive
);
361 strbuf_release(&content
);
366 static const struct archiver
*lookup_archiver(const char *name
)
373 for (i
= 0; i
< nr_archivers
; i
++) {
374 if (!strcmp(name
, archivers
[i
]->name
))
380 struct path_exists_context
{
381 struct pathspec pathspec
;
382 struct archiver_args
*args
;
385 static int reject_entry(const struct object_id
*oid
, struct strbuf
*base
,
386 const char *filename
, unsigned mode
,
390 struct path_exists_context
*ctx
= context
;
393 struct strbuf sb
= STRBUF_INIT
;
394 strbuf_addbuf(&sb
, base
);
395 strbuf_addstr(&sb
, filename
);
396 if (!match_pathspec(ctx
->args
->repo
->index
,
398 sb
.buf
, sb
.len
, 0, NULL
, 1))
399 ret
= READ_TREE_RECURSIVE
;
405 static int path_exists(struct archiver_args
*args
, const char *path
)
407 const char *paths
[] = { path
, NULL
};
408 struct path_exists_context ctx
;
412 parse_pathspec(&ctx
.pathspec
, 0, 0, "", paths
);
413 ctx
.pathspec
.recursive
= 1;
414 ret
= read_tree(args
->repo
, args
->tree
,
417 clear_pathspec(&ctx
.pathspec
);
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
,
432 ar_args
->pathspec
.recursive
= 1;
435 if (**pathspec
&& !path_exists(ar_args
, *pathspec
))
436 die(_("pathspec '%s' did not match any files"), *pathspec
);
442 static void parse_treeish_arg(const char **argv
,
443 struct archiver_args
*ar_args
, const char *prefix
,
446 const char *name
= argv
[0];
447 const struct object_id
*commit_oid
;
450 const struct commit
*commit
;
451 struct object_id oid
;
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 (!dwim_ref(name
, refnamelen
, &oid
, &ref
, 0))
460 die(_("no such ref: %.*s"), refnamelen
, name
);
462 dwim_ref(name
, strlen(name
), &oid
, &ref
, 0);
465 if (get_oid(name
, &oid
))
466 die(_("not a valid object name: %s"), name
);
468 commit
= lookup_commit_reference_gently(ar_args
->repo
, &oid
, 1);
470 commit_oid
= &commit
->object
.oid
;
471 archive_time
= commit
->date
;
474 archive_time
= time(NULL
);
477 tree
= parse_tree_indirect(&oid
);
479 die(_("not a tree object: %s"), oid_to_hex(&oid
));
482 struct object_id tree_oid
;
486 err
= get_tree_entry(ar_args
->repo
,
490 if (err
|| !S_ISDIR(mode
))
491 die(_("current working directory is untracked"));
493 tree
= parse_tree_indirect(&tree_oid
);
495 ar_args
->refname
= ref
;
496 ar_args
->tree
= tree
;
497 ar_args
->commit_oid
= commit_oid
;
498 ar_args
->commit
= commit
;
499 ar_args
->time
= archive_time
;
502 static void extra_file_info_clear(void *util
, const char *str
)
504 struct extra_file_info
*info
= util
;
510 static int add_file_cb(const struct option
*opt
, const char *arg
, int unset
)
512 struct archiver_args
*args
= opt
->value
;
513 const char **basep
= (const char **)opt
->defval
;
514 const char *base
= *basep
;
516 struct string_list_item
*item
;
517 struct extra_file_info
*info
;
520 string_list_clear_func(&args
->extra_files
,
521 extra_file_info_clear
);
528 info
= xmalloc(sizeof(*info
));
529 info
->base
= xstrdup_or_null(base
);
531 if (!strcmp(opt
->long_name
, "add-file")) {
532 path
= prefix_filename(args
->prefix
, arg
);
533 if (stat(path
, &info
->stat
))
534 die(_("File not found: %s"), path
);
535 if (!S_ISREG(info
->stat
.st_mode
))
536 die(_("Not a regular file: %s"), path
);
537 info
->content
= NULL
; /* read the file later */
538 } else if (!strcmp(opt
->long_name
, "add-virtual-file")) {
539 struct strbuf buf
= STRBUF_INIT
;
544 else if (unquote_c_style(&buf
, p
, &p
) < 0)
545 die(_("unclosed quote: '%s'"), arg
);
548 die(_("missing colon: '%s'"), arg
);
551 die(_("empty file name: '%s'"), arg
);
554 strbuf_detach(&buf
, NULL
) : xstrndup(arg
, p
- arg
);
558 path
= prefix_filename(args
->prefix
, path
);
561 memset(&info
->stat
, 0, sizeof(info
->stat
));
562 info
->stat
.st_mode
= S_IFREG
| 0644;
563 info
->content
= xstrdup(p
+ 1);
564 info
->stat
.st_size
= strlen(info
->content
);
566 BUG("add_file_cb() called for %s", opt
->long_name
);
568 item
= string_list_append_nodup(&args
->extra_files
, path
);
574 static int number_callback(const struct option
*opt
, const char *arg
, int unset
)
576 BUG_ON_OPT_NEG(unset
);
577 *(int *)opt
->value
= strtol(arg
, NULL
, 10);
581 static int parse_archive_args(int argc
, const char **argv
,
582 const struct archiver
**ar
, struct archiver_args
*args
,
583 const char *name_hint
, int is_remote
)
585 const char *format
= NULL
;
586 const char *base
= NULL
;
587 const char *remote
= NULL
;
588 const char *exec
= NULL
;
589 const char *output
= NULL
;
590 int compression_level
= -1;
594 int worktree_attributes
= 0;
595 struct option opts
[] = {
597 OPT_STRING(0, "format", &format
, N_("fmt"), N_("archive format")),
598 OPT_STRING(0, "prefix", &base
, N_("prefix"),
599 N_("prepend prefix to each pathname in the archive")),
600 { OPTION_CALLBACK
, 0, "add-file", args
, N_("file"),
601 N_("add untracked file to archive"), 0, add_file_cb
,
603 { OPTION_CALLBACK
, 0, "add-virtual-file", args
,
604 N_("path:content"), N_("add untracked file to archive"), 0,
605 add_file_cb
, (intptr_t)&base
},
606 OPT_STRING('o', "output", &output
, N_("file"),
607 N_("write the archive to this file")),
608 OPT_BOOL(0, "worktree-attributes", &worktree_attributes
,
609 N_("read .gitattributes in working directory")),
610 OPT__VERBOSE(&verbose
, N_("report archived files on stderr")),
611 OPT_NUMBER_CALLBACK(&compression_level
,
612 N_("set compression level"), number_callback
),
614 OPT_BOOL('l', "list", &list
,
615 N_("list supported archive formats")),
617 OPT_STRING(0, "remote", &remote
, N_("repo"),
618 N_("retrieve the archive from remote repository <repo>")),
619 OPT_STRING(0, "exec", &exec
, N_("command"),
620 N_("path to the remote git-upload-archive command")),
624 argc
= parse_options(argc
, argv
, NULL
, opts
, archive_usage
, 0);
627 die(_("Unexpected option --remote"));
629 die(_("the option '%s' requires '%s'"), "--exec", "--remote");
631 die(_("Unexpected option --output"));
632 if (is_remote
&& args
->extra_files
.nr
)
633 die(_("options '%s' and '%s' cannot be used together"), "--add-file", "--remote");
639 for (i
= 0; i
< nr_archivers
; i
++)
640 if (!is_remote
|| archivers
[i
]->flags
& ARCHIVER_REMOTE
)
641 printf("%s\n", archivers
[i
]->name
);
645 if (!format
&& name_hint
)
646 format
= archive_format_from_filename(name_hint
);
650 /* We need at least one parameter -- tree-ish */
652 usage_with_options(archive_usage
, opts
);
653 *ar
= lookup_archiver(format
);
654 if (!*ar
|| (is_remote
&& !((*ar
)->flags
& ARCHIVER_REMOTE
)))
655 die(_("Unknown archive format '%s'"), format
);
657 args
->compression_level
= Z_DEFAULT_COMPRESSION
;
658 if (compression_level
!= -1) {
659 int levels_ok
= (*ar
)->flags
& ARCHIVER_WANT_COMPRESSION_LEVELS
;
660 int high_ok
= (*ar
)->flags
& ARCHIVER_HIGH_COMPRESSION_LEVELS
;
661 if (levels_ok
&& (compression_level
<= 9 || high_ok
))
662 args
->compression_level
= compression_level
;
664 die(_("Argument not supported for format '%s': -%d"),
665 format
, compression_level
);
668 args
->verbose
= verbose
;
670 args
->baselen
= strlen(base
);
671 args
->worktree_attributes
= worktree_attributes
;
676 int write_archive(int argc
, const char **argv
, const char *prefix
,
677 struct repository
*repo
,
678 const char *name_hint
, int remote
)
680 const struct archiver
*ar
= NULL
;
681 struct pretty_print_describe_status describe_status
= {0};
682 struct pretty_print_context ctx
= {0};
683 struct archiver_args args
;
686 git_config_get_bool("uploadarchive.allowunreachable", &remote_allow_unreachable
);
687 git_config(git_default_config
, NULL
);
689 describe_status
.max_invocations
= 1;
690 ctx
.date_mode
.type
= DATE_NORMAL
;
691 ctx
.abbrev
= DEFAULT_ABBREV
;
692 ctx
.describe_status
= &describe_status
;
693 args
.pretty_ctx
= &ctx
;
695 args
.prefix
= prefix
;
696 string_list_init_dup(&args
.extra_files
);
697 argc
= parse_archive_args(argc
, argv
, &ar
, &args
, name_hint
, remote
);
698 if (!startup_info
->have_repository
) {
700 * We know this will die() with an error, so we could just
701 * die ourselves; but its error message will be more specific
702 * than what we could write here.
704 setup_git_directory();
707 parse_treeish_arg(argv
, &args
, prefix
, remote
);
708 parse_pathspec_arg(argv
+ 1, &args
);
710 rc
= ar
->write_archive(ar
, &args
);
712 string_list_clear_func(&args
.extra_files
, extra_file_info_clear
);
718 static int match_extension(const char *filename
, const char *ext
)
720 int prefixlen
= strlen(filename
) - strlen(ext
);
723 * We need 1 character for the '.', and 1 character to ensure that the
724 * prefix is non-empty (k.e., we don't match .tar.gz with no actual
727 if (prefixlen
< 2 || filename
[prefixlen
- 1] != '.')
729 return !strcmp(filename
+ prefixlen
, ext
);
732 const char *archive_format_from_filename(const char *filename
)
736 for (i
= 0; i
< nr_archivers
; i
++)
737 if (match_extension(filename
, archivers
[i
]->name
))
738 return archivers
[i
]->name
;