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