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