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