alias.c: mark split_cmdline_strerror() strings for translation
[git/git.git] / archive.c
CommitLineData
18125644 1#include "cache.h"
b2141fc1 2#include "config.h"
fb58c8d5 3#include "refs.h"
cbd53a21 4#include "object-store.h"
18125644 5#include "commit.h"
c0885435 6#include "tree-walk.h"
18125644 7#include "attr.h"
562e25ab 8#include "archive.h"
4fac1d3a 9#include "parse-options.h"
ba053ea9 10#include "unpack-trees.h"
ed22b417 11#include "dir.h"
4fac1d3a
RS
12
13static char const * const archive_usage[] = {
9c9b4f2f 14 N_("git archive [<options>] <tree-ish> [<path>...]"),
0012a387 15 N_("git archive --list"),
9c9b4f2f 16 N_("git archive --remote <repo> [--exec <cmd>] [<options>] <tree-ish> [<path>...]"),
0012a387 17 N_("git archive --remote <repo> [--exec <cmd>] --list"),
4fac1d3a
RS
18 NULL
19};
c0885435 20
13e0f88d
JK
21static const struct archiver **archivers;
22static int nr_archivers;
23static int alloc_archivers;
7671b632 24static int remote_allow_unreachable;
13e0f88d
JK
25
26void register_archiver(struct archiver *ar)
27{
28 ALLOC_GROW(archivers, nr_archivers + 1, alloc_archivers);
29 archivers[nr_archivers++] = ar;
30}
c0885435 31
18125644
LH
32static void format_subst(const struct commit *commit,
33 const char *src, size_t len,
34 struct strbuf *buf)
35{
36 char *to_free = NULL;
f285a2d7 37 struct strbuf fmt = STRBUF_INIT;
dd2e794a 38 struct pretty_print_context ctx = {0};
a5481a6c 39 ctx.date_mode.type = DATE_NORMAL;
35039ced 40 ctx.abbrev = DEFAULT_ABBREV;
18125644
LH
41
42 if (src == buf->buf)
43 to_free = strbuf_detach(buf, NULL);
18125644
LH
44 for (;;) {
45 const char *b, *c;
46
47 b = memmem(src, len, "$Format:", 8);
75b7dfbd 48 if (!b)
18125644 49 break;
75b7dfbd 50 c = memchr(b + 8, '$', (src + len) - b - 8);
18125644
LH
51 if (!c)
52 break;
53
54 strbuf_reset(&fmt);
55 strbuf_add(&fmt, b + 8, c - b - 8);
56
57 strbuf_add(buf, src, b - src);
dd2e794a 58 format_commit_message(commit, fmt.buf, buf, &ctx);
18125644
LH
59 len -= c + 1 - src;
60 src = c + 1;
61 }
62 strbuf_add(buf, src, len);
63 strbuf_release(&fmt);
64 free(to_free);
65}
66
e5ec981a 67void *object_file_to_archive(const struct archiver_args *args,
68 const char *path, const struct object_id *oid,
69 unsigned int mode, enum object_type *type,
70 unsigned long *sizep)
18125644
LH
71{
72 void *buffer;
9cb513b7 73 const struct commit *commit = args->convert ? args->commit : NULL;
18125644 74
9cb513b7 75 path += args->baselen;
b4f5aca4 76 buffer = read_object_file(oid, type, sizep);
18125644 77 if (buffer && S_ISREG(mode)) {
f285a2d7 78 struct strbuf buf = STRBUF_INIT;
18125644
LH
79 size_t size = 0;
80
18125644 81 strbuf_attach(&buf, buffer, *sizep, *sizep + 1);
b612ee20 82 convert_to_working_tree(args->repo->index, path, buf.buf, buf.len, &buf);
1d11d5bb
RS
83 if (commit)
84 format_subst(commit, buf.buf, buf.len, &buf);
18125644
LH
85 buffer = strbuf_detach(&buf, &size);
86 *sizep = size;
87 }
88
89 return buffer;
90}
91
ed22b417
NTND
92struct directory {
93 struct directory *up;
13609673 94 struct object_id oid;
ed22b417
NTND
95 int baselen, len;
96 unsigned mode;
97 int stage;
98 char path[FLEX_ARRAY];
99};
100
562e25ab
RS
101struct archiver_context {
102 struct archiver_args *args;
103 write_archive_entry_fn_t write_entry;
ed22b417 104 struct directory *bottom;
562e25ab
RS
105};
106
b612ee20
NTND
107static const struct attr_check *get_archive_attrs(struct index_state *istate,
108 const char *path)
c6c08f7e
RS
109{
110 static struct attr_check *check;
111 if (!check)
112 check = attr_check_initl("export-ignore", "export-subst", NULL);
d64324cb
TB
113 git_check_attr(istate, path, check);
114 return check;
c6c08f7e
RS
115}
116
117static int check_attr_export_ignore(const struct attr_check *check)
118{
119 return check && ATTR_TRUE(check->items[0].value);
120}
121
122static int check_attr_export_subst(const struct attr_check *check)
123{
124 return check && ATTR_TRUE(check->items[1].value);
125}
126
015ff4f8 127static int write_archive_entry(const struct object_id *oid, const char *base,
562e25ab
RS
128 int baselen, const char *filename, unsigned mode, int stage,
129 void *context)
130{
131 static struct strbuf path = STRBUF_INIT;
132 struct archiver_context *c = context;
133 struct archiver_args *args = c->args;
134 write_archive_entry_fn_t write_entry = c->write_entry;
135 int err;
5ff247ac 136 const char *path_without_prefix;
562e25ab 137
9cb513b7 138 args->convert = 0;
562e25ab
RS
139 strbuf_reset(&path);
140 strbuf_grow(&path, PATH_MAX);
ebfbdb34 141 strbuf_add(&path, args->base, args->baselen);
562e25ab
RS
142 strbuf_add(&path, base, baselen);
143 strbuf_addstr(&path, filename);
94bc671a
JNA
144 if (S_ISDIR(mode) || S_ISGITLINK(mode))
145 strbuf_addch(&path, '/');
1d11d5bb 146 path_without_prefix = path.buf + args->baselen;
562e25ab 147
43180940 148 if (!S_ISDIR(mode)) {
5ff247ac 149 const struct attr_check *check;
b612ee20 150 check = get_archive_attrs(args->repo->index, path_without_prefix);
5ff247ac 151 if (check_attr_export_ignore(check))
1d11d5bb 152 return 0;
5ff247ac 153 args->convert = check_attr_export_subst(check);
1d11d5bb 154 }
562e25ab
RS
155
156 if (S_ISDIR(mode) || S_ISGITLINK(mode)) {
562e25ab
RS
157 if (args->verbose)
158 fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
015ff4f8 159 err = write_entry(args, oid, path.buf, path.len, mode);
562e25ab
RS
160 if (err)
161 return err;
d3bee161 162 return (S_ISDIR(mode) ? READ_TREE_RECURSIVE : 0);
562e25ab
RS
163 }
164
562e25ab
RS
165 if (args->verbose)
166 fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
015ff4f8 167 return write_entry(args, oid, path.buf, path.len, mode);
562e25ab
RS
168}
169
ed22b417 170static void queue_directory(const unsigned char *sha1,
6a0b0b6d 171 struct strbuf *base, const char *filename,
ed22b417
NTND
172 unsigned mode, int stage, struct archiver_context *c)
173{
174 struct directory *d;
50a6c8ef
JK
175 size_t len = st_add4(base->len, 1, strlen(filename), 1);
176 d = xmalloc(st_add(sizeof(*d), len));
ed22b417 177 d->up = c->bottom;
6a0b0b6d 178 d->baselen = base->len;
ed22b417
NTND
179 d->mode = mode;
180 d->stage = stage;
181 c->bottom = d;
c7ab0ba3 182 d->len = xsnprintf(d->path, len, "%.*s%s/", (int)base->len, base->buf, filename);
13609673 183 hashcpy(d->oid.hash, sha1);
ed22b417
NTND
184}
185
186static int write_directory(struct archiver_context *c)
187{
188 struct directory *d = c->bottom;
189 int ret;
190
191 if (!d)
192 return 0;
193 c->bottom = d->up;
194 d->path[d->len - 1] = '\0'; /* no trailing slash */
195 ret =
196 write_directory(c) ||
015ff4f8 197 write_archive_entry(&d->oid, d->path, d->baselen,
ed22b417
NTND
198 d->path + d->baselen, d->mode,
199 d->stage, c) != READ_TREE_RECURSIVE;
200 free(d);
201 return ret ? -1 : 0;
202}
203
df46d77e 204static int queue_or_write_archive_entry(const struct object_id *oid,
6a0b0b6d 205 struct strbuf *base, const char *filename,
ed22b417
NTND
206 unsigned mode, int stage, void *context)
207{
208 struct archiver_context *c = context;
209
210 while (c->bottom &&
6a0b0b6d
NTND
211 !(base->len >= c->bottom->len &&
212 !strncmp(base->buf, c->bottom->path, c->bottom->len))) {
ed22b417
NTND
213 struct directory *next = c->bottom->up;
214 free(c->bottom);
215 c->bottom = next;
216 }
217
218 if (S_ISDIR(mode)) {
5ff247ac
RS
219 size_t baselen = base->len;
220 const struct attr_check *check;
221
222 /* Borrow base, but restore its original value when done. */
223 strbuf_addstr(base, filename);
224 strbuf_addch(base, '/');
b612ee20 225 check = get_archive_attrs(c->args->repo->index, base->buf);
5ff247ac
RS
226 strbuf_setlen(base, baselen);
227
228 if (check_attr_export_ignore(check))
229 return 0;
df46d77e 230 queue_directory(oid->hash, base, filename,
ed22b417
NTND
231 mode, stage, c);
232 return READ_TREE_RECURSIVE;
233 }
234
235 if (write_directory(c))
236 return -1;
015ff4f8 237 return write_archive_entry(oid, base->buf, base->len, filename, mode,
ed22b417
NTND
238 stage, context);
239}
240
562e25ab
RS
241int write_archive_entries(struct archiver_args *args,
242 write_archive_entry_fn_t write_entry)
243{
244 struct archiver_context context;
ba053ea9
NTND
245 struct unpack_trees_options opts;
246 struct tree_desc t;
562e25ab
RS
247 int err;
248
249 if (args->baselen > 0 && args->base[args->baselen - 1] == '/') {
250 size_t len = args->baselen;
251
252 while (len > 1 && args->base[len - 2] == '/')
253 len--;
254 if (args->verbose)
255 fprintf(stderr, "%.*s\n", (int)len, args->base);
015ff4f8 256 err = write_entry(args, &args->tree->object.oid, args->base,
9cb513b7 257 len, 040777);
562e25ab
RS
258 if (err)
259 return err;
260 }
261
ed22b417 262 memset(&context, 0, sizeof(context));
562e25ab
RS
263 context.args = args;
264 context.write_entry = write_entry;
265
ba053ea9
NTND
266 /*
267 * Setup index and instruct attr to read index only
268 */
269 if (!args->worktree_attributes) {
270 memset(&opts, 0, sizeof(opts));
271 opts.index_only = 1;
272 opts.head_idx = -1;
b612ee20
NTND
273 opts.src_index = args->repo->index;
274 opts.dst_index = args->repo->index;
ba053ea9
NTND
275 opts.fn = oneway_merge;
276 init_tree_desc(&t, args->tree->buffer, args->tree->size);
277 if (unpack_trees(1, &t, &opts))
278 return -1;
c4500e25 279 git_attr_set_direction(GIT_ATTR_INDEX);
ba053ea9
NTND
280 }
281
f3e743a0 282 err = read_tree_recursive(args->tree, "", 0, 0, &args->pathspec,
43180940 283 queue_or_write_archive_entry,
ed22b417 284 &context);
562e25ab
RS
285 if (err == READ_TREE_RECURSIVE)
286 err = 0;
ed22b417
NTND
287 while (context.bottom) {
288 struct directory *next = context.bottom->up;
289 free(context.bottom);
290 context.bottom = next;
291 }
562e25ab
RS
292 return err;
293}
6e94e683 294
c0885435
RS
295static const struct archiver *lookup_archiver(const char *name)
296{
297 int i;
298
4fac1d3a
RS
299 if (!name)
300 return NULL;
301
13e0f88d
JK
302 for (i = 0; i < nr_archivers; i++) {
303 if (!strcmp(name, archivers[i]->name))
304 return archivers[i];
c0885435
RS
305 }
306 return NULL;
307}
308
b612ee20
NTND
309struct path_exists_context {
310 struct pathspec pathspec;
311 struct archiver_args *args;
312};
313
df46d77e 314static int reject_entry(const struct object_id *oid, struct strbuf *base,
6a0b0b6d 315 const char *filename, unsigned mode,
d5f53d6d
RS
316 int stage, void *context)
317{
ed22b417 318 int ret = -1;
b612ee20
NTND
319 struct path_exists_context *ctx = context;
320
ed22b417
NTND
321 if (S_ISDIR(mode)) {
322 struct strbuf sb = STRBUF_INIT;
6a0b0b6d 323 strbuf_addbuf(&sb, base);
ed22b417 324 strbuf_addstr(&sb, filename);
b612ee20
NTND
325 if (!match_pathspec(ctx->args->repo->index,
326 &ctx->pathspec,
327 sb.buf, sb.len, 0, NULL, 1))
ed22b417
NTND
328 ret = READ_TREE_RECURSIVE;
329 strbuf_release(&sb);
330 }
331 return ret;
d5f53d6d
RS
332}
333
b612ee20 334static int path_exists(struct archiver_args *args, const char *path)
d5f53d6d 335{
f0096c06 336 const char *paths[] = { path, NULL };
b612ee20 337 struct path_exists_context ctx;
f0096c06
NTND
338 int ret;
339
b612ee20
NTND
340 ctx.args = args;
341 parse_pathspec(&ctx.pathspec, 0, 0, "", paths);
342 ctx.pathspec.recursive = 1;
343 ret = read_tree_recursive(args->tree, "", 0, 0, &ctx.pathspec,
344 reject_entry, &ctx);
345 clear_pathspec(&ctx.pathspec);
f0096c06 346 return ret != 0;
d5f53d6d
RS
347}
348
c0885435
RS
349static void parse_pathspec_arg(const char **pathspec,
350 struct archiver_args *ar_args)
351{
f3e743a0
NTND
352 /*
353 * must be consistent with parse_pathspec in path_exists()
354 * Also if pathspec patterns are dependent, we're in big
355 * trouble as we test each one separately
356 */
357 parse_pathspec(&ar_args->pathspec, 0,
358 PATHSPEC_PREFER_FULL,
359 "", pathspec);
ed22b417 360 ar_args->pathspec.recursive = 1;
d5f53d6d
RS
361 if (pathspec) {
362 while (*pathspec) {
b612ee20 363 if (**pathspec && !path_exists(ar_args, *pathspec))
f3e743a0 364 die(_("pathspec '%s' did not match any files"), *pathspec);
d5f53d6d
RS
365 pathspec++;
366 }
367 }
c0885435
RS
368}
369
370static void parse_treeish_arg(const char **argv,
ee27ca4a
JK
371 struct archiver_args *ar_args, const char *prefix,
372 int remote)
c0885435
RS
373{
374 const char *name = argv[0];
375 const unsigned char *commit_sha1;
376 time_t archive_time;
377 struct tree *tree;
378 const struct commit *commit;
13609673 379 struct object_id oid;
c0885435 380
ee27ca4a 381 /* Remotes are only allowed to fetch actual refs */
7671b632 382 if (remote && !remote_allow_unreachable) {
ee27ca4a 383 char *ref = NULL;
2c5495f7
RM
384 const char *colon = strchrnul(name, ':');
385 int refnamelen = colon - name;
c51a351a 386
cca5fa64 387 if (!dwim_ref(name, refnamelen, &oid, &ref))
c51a351a 388 die("no such ref: %.*s", refnamelen, name);
ee27ca4a
JK
389 free(ref);
390 }
0f544ee8 391
e82caf38 392 if (get_oid(name, &oid))
0f544ee8 393 die("Not a valid object name");
c0885435 394
ce3a7ec8 395 commit = lookup_commit_reference_gently(ar_args->repo, &oid, 1);
c0885435 396 if (commit) {
ed1c9977 397 commit_sha1 = commit->object.oid.hash;
c0885435
RS
398 archive_time = commit->date;
399 } else {
400 commit_sha1 = NULL;
401 archive_time = time(NULL);
402 }
403
a9dbc179 404 tree = parse_tree_indirect(&oid);
c0885435
RS
405 if (tree == NULL)
406 die("not a tree object");
407
408 if (prefix) {
13609673 409 struct object_id tree_oid;
c0885435
RS
410 unsigned int mode;
411 int err;
412
916bc35b 413 err = get_tree_entry(&tree->object.oid, prefix, &tree_oid,
414 &mode);
c0885435
RS
415 if (err || !S_ISDIR(mode))
416 die("current working directory is untracked");
417
a9dbc179 418 tree = parse_tree_indirect(&tree_oid);
c0885435
RS
419 }
420 ar_args->tree = tree;
421 ar_args->commit_sha1 = commit_sha1;
422 ar_args->commit = commit;
423 ar_args->time = archive_time;
424}
425
4fac1d3a 426#define OPT__COMPR(s, v, h, p) \
3e4a67b4 427 OPT_SET_INT_F(s, NULL, v, h, p, PARSE_OPT_NONEG)
4fac1d3a 428#define OPT__COMPR_HIDDEN(s, v, p) \
3e4a67b4 429 OPT_SET_INT_F(s, NULL, v, "", p, PARSE_OPT_NONEG | PARSE_OPT_HIDDEN)
4fac1d3a 430
c0885435 431static int parse_archive_args(int argc, const char **argv,
56baa61d 432 const struct archiver **ar, struct archiver_args *args,
7b97730b 433 const char *name_hint, int is_remote)
c0885435 434{
56baa61d 435 const char *format = NULL;
4fac1d3a
RS
436 const char *base = NULL;
437 const char *remote = NULL;
438 const char *exec = NULL;
aec0c1bb 439 const char *output = NULL;
c0885435
RS
440 int compression_level = -1;
441 int verbose = 0;
442 int i;
4fac1d3a 443 int list = 0;
ba053ea9 444 int worktree_attributes = 0;
4fac1d3a
RS
445 struct option opts[] = {
446 OPT_GROUP(""),
0012a387
NTND
447 OPT_STRING(0, "format", &format, N_("fmt"), N_("archive format")),
448 OPT_STRING(0, "prefix", &base, N_("prefix"),
449 N_("prepend prefix to each pathname in the archive")),
450 OPT_STRING('o', "output", &output, N_("file"),
451 N_("write the archive to this file")),
f858c646 452 OPT_BOOL(0, "worktree-attributes", &worktree_attributes,
0012a387
NTND
453 N_("read .gitattributes in working directory")),
454 OPT__VERBOSE(&verbose, N_("report archived files on stderr")),
455 OPT__COMPR('0', &compression_level, N_("store only"), 0),
456 OPT__COMPR('1', &compression_level, N_("compress faster"), 1),
4fac1d3a
RS
457 OPT__COMPR_HIDDEN('2', &compression_level, 2),
458 OPT__COMPR_HIDDEN('3', &compression_level, 3),
459 OPT__COMPR_HIDDEN('4', &compression_level, 4),
460 OPT__COMPR_HIDDEN('5', &compression_level, 5),
461 OPT__COMPR_HIDDEN('6', &compression_level, 6),
462 OPT__COMPR_HIDDEN('7', &compression_level, 7),
463 OPT__COMPR_HIDDEN('8', &compression_level, 8),
0012a387 464 OPT__COMPR('9', &compression_level, N_("compress better"), 9),
4fac1d3a 465 OPT_GROUP(""),
f858c646 466 OPT_BOOL('l', "list", &list,
0012a387 467 N_("list supported archive formats")),
4fac1d3a 468 OPT_GROUP(""),
0012a387
NTND
469 OPT_STRING(0, "remote", &remote, N_("repo"),
470 N_("retrieve the archive from remote repository <repo>")),
b0ff9654 471 OPT_STRING(0, "exec", &exec, N_("command"),
0012a387 472 N_("path to the remote git-upload-archive command")),
4fac1d3a
RS
473 OPT_END()
474 };
475
37782920 476 argc = parse_options(argc, argv, NULL, opts, archive_usage, 0);
4fac1d3a
RS
477
478 if (remote)
5a36d00c 479 die(_("Unexpected option --remote"));
4fac1d3a 480 if (exec)
5a36d00c 481 die(_("Option --exec can only be used together with --remote"));
52e77876 482 if (output)
5a36d00c 483 die(_("Unexpected option --output"));
4fac1d3a
RS
484
485 if (!base)
486 base = "";
487
488 if (list) {
13e0f88d 489 for (i = 0; i < nr_archivers; i++)
7b97730b
JK
490 if (!is_remote || archivers[i]->flags & ARCHIVER_REMOTE)
491 printf("%s\n", archivers[i]->name);
4fac1d3a 492 exit(0);
c0885435
RS
493 }
494
56baa61d
JK
495 if (!format && name_hint)
496 format = archive_format_from_filename(name_hint);
497 if (!format)
498 format = "tar";
499
c0885435 500 /* We need at least one parameter -- tree-ish */
4fac1d3a
RS
501 if (argc < 1)
502 usage_with_options(archive_usage, opts);
c0885435 503 *ar = lookup_archiver(format);
7b97730b 504 if (!*ar || (is_remote && !((*ar)->flags & ARCHIVER_REMOTE)))
5a36d00c 505 die(_("Unknown archive format '%s'"), format);
c0885435
RS
506
507 args->compression_level = Z_DEFAULT_COMPRESSION;
508 if (compression_level != -1) {
13e0f88d 509 if ((*ar)->flags & ARCHIVER_WANT_COMPRESSION_LEVELS)
c0885435
RS
510 args->compression_level = compression_level;
511 else {
5a36d00c 512 die(_("Argument not supported for format '%s': -%d"),
c0885435
RS
513 format, compression_level);
514 }
515 }
516 args->verbose = verbose;
517 args->base = base;
518 args->baselen = strlen(base);
ba053ea9 519 args->worktree_attributes = worktree_attributes;
c0885435 520
4fac1d3a 521 return argc;
c0885435
RS
522}
523
6e94e683 524int write_archive(int argc, const char **argv, const char *prefix,
b612ee20 525 struct repository *repo,
eb0224c6 526 const char *name_hint, int remote)
6e94e683
RS
527{
528 const struct archiver *ar = NULL;
529 struct archiver_args args;
6e94e683 530
95790ff6
TA
531 git_config_get_bool("uploadarchive.allowunreachable", &remote_allow_unreachable);
532 git_config(git_default_config, NULL);
533
13e0f88d
JK
534 init_tar_archiver();
535 init_zip_archiver();
23212862 536
b612ee20 537 args.repo = repo;
7b97730b 538 argc = parse_archive_args(argc, argv, &ar, &args, name_hint, remote);
eb0224c6 539 if (!startup_info->have_repository) {
23212862
JK
540 /*
541 * We know this will die() with an error, so we could just
542 * die ourselves; but its error message will be more specific
543 * than what we could write here.
544 */
545 setup_git_directory();
546 }
6e94e683 547
ee27ca4a 548 parse_treeish_arg(argv, &args, prefix, remote);
6e94e683
RS
549 parse_pathspec_arg(argv + 1, &args);
550
4d7c9898 551 return ar->write_archive(ar, &args);
6e94e683 552}
56baa61d 553
08716b3c
JK
554static int match_extension(const char *filename, const char *ext)
555{
556 int prefixlen = strlen(filename) - strlen(ext);
557
558 /*
559 * We need 1 character for the '.', and 1 character to ensure that the
560 * prefix is non-empty (k.e., we don't match .tar.gz with no actual
561 * filename).
562 */
b1cdfb54 563 if (prefixlen < 2 || filename[prefixlen - 1] != '.')
08716b3c
JK
564 return 0;
565 return !strcmp(filename + prefixlen, ext);
566}
567
56baa61d
JK
568const char *archive_format_from_filename(const char *filename)
569{
08716b3c
JK
570 int i;
571
572 for (i = 0; i < nr_archivers; i++)
573 if (match_extension(filename, archivers[i]->name))
574 return archivers[i]->name;
56baa61d
JK
575 return NULL;
576}