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