Merge branch 'kb/hashmap-v5-minimal' into kb/fscache-v4-t1.8.5
[git/mingw/4msysgit.git] / archive.c
blob346f3b2f1ab0d522638475b729274d992d5b82d5
1 #include "cache.h"
2 #include "commit.h"
3 #include "tree-walk.h"
4 #include "attr.h"
5 #include "archive.h"
6 #include "parse-options.h"
7 #include "unpack-trees.h"
9 static char const * const archive_usage[] = {
10 N_("git archive [options] <tree-ish> [<path>...]"),
11 N_("git archive --list"),
12 N_("git archive --remote <repo> [--exec <cmd>] [options] <tree-ish> [<path>...]"),
13 N_("git archive --remote <repo> [--exec <cmd>] --list"),
14 NULL
17 static const struct archiver **archivers;
18 static int nr_archivers;
19 static int alloc_archivers;
21 void register_archiver(struct archiver *ar)
23 ALLOC_GROW(archivers, nr_archivers + 1, alloc_archivers);
24 archivers[nr_archivers++] = ar;
27 static void format_subst(const struct commit *commit,
28 const char *src, size_t len,
29 struct strbuf *buf)
31 char *to_free = NULL;
32 struct strbuf fmt = STRBUF_INIT;
33 struct pretty_print_context ctx = {0};
34 ctx.date_mode = DATE_NORMAL;
35 ctx.abbrev = DEFAULT_ABBREV;
37 if (src == buf->buf)
38 to_free = strbuf_detach(buf, NULL);
39 for (;;) {
40 const char *b, *c;
42 b = memmem(src, len, "$Format:", 8);
43 if (!b)
44 break;
45 c = memchr(b + 8, '$', (src + len) - b - 8);
46 if (!c)
47 break;
49 strbuf_reset(&fmt);
50 strbuf_add(&fmt, b + 8, c - b - 8);
52 strbuf_add(buf, src, b - src);
53 format_commit_message(commit, fmt.buf, buf, &ctx);
54 len -= c + 1 - src;
55 src = c + 1;
57 strbuf_add(buf, src, len);
58 strbuf_release(&fmt);
59 free(to_free);
62 void *sha1_file_to_archive(const struct archiver_args *args,
63 const char *path, const unsigned char *sha1,
64 unsigned int mode, enum object_type *type,
65 unsigned long *sizep)
67 void *buffer;
68 const struct commit *commit = args->convert ? args->commit : NULL;
70 path += args->baselen;
71 buffer = read_sha1_file(sha1, type, sizep);
72 if (buffer && S_ISREG(mode)) {
73 struct strbuf buf = STRBUF_INIT;
74 size_t size = 0;
76 strbuf_attach(&buf, buffer, *sizep, *sizep + 1);
77 convert_to_working_tree(path, buf.buf, buf.len, &buf);
78 if (commit)
79 format_subst(commit, buf.buf, buf.len, &buf);
80 buffer = strbuf_detach(&buf, &size);
81 *sizep = size;
84 return buffer;
87 static void setup_archive_check(struct git_attr_check *check)
89 static struct git_attr *attr_export_ignore;
90 static struct git_attr *attr_export_subst;
92 if (!attr_export_ignore) {
93 attr_export_ignore = git_attr("export-ignore");
94 attr_export_subst = git_attr("export-subst");
96 check[0].attr = attr_export_ignore;
97 check[1].attr = attr_export_subst;
100 struct archiver_context {
101 struct archiver_args *args;
102 write_archive_entry_fn_t write_entry;
105 static int write_archive_entry(const unsigned char *sha1, const char *base,
106 int baselen, const char *filename, unsigned mode, int stage,
107 void *context)
109 static struct strbuf path = STRBUF_INIT;
110 struct archiver_context *c = context;
111 struct archiver_args *args = c->args;
112 write_archive_entry_fn_t write_entry = c->write_entry;
113 struct git_attr_check check[2];
114 const char *path_without_prefix;
115 int err;
117 args->convert = 0;
118 strbuf_reset(&path);
119 strbuf_grow(&path, PATH_MAX);
120 strbuf_add(&path, args->base, args->baselen);
121 strbuf_add(&path, base, baselen);
122 strbuf_addstr(&path, filename);
123 if (S_ISDIR(mode) || S_ISGITLINK(mode))
124 strbuf_addch(&path, '/');
125 path_without_prefix = path.buf + args->baselen;
127 setup_archive_check(check);
128 if (!git_check_attr(path_without_prefix, ARRAY_SIZE(check), check)) {
129 if (ATTR_TRUE(check[0].value))
130 return 0;
131 args->convert = ATTR_TRUE(check[1].value);
134 if (S_ISDIR(mode) || S_ISGITLINK(mode)) {
135 if (args->verbose)
136 fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
137 err = write_entry(args, sha1, path.buf, path.len, mode);
138 if (err)
139 return err;
140 return (S_ISDIR(mode) ? READ_TREE_RECURSIVE : 0);
143 if (args->verbose)
144 fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
145 return write_entry(args, sha1, path.buf, path.len, mode);
148 int write_archive_entries(struct archiver_args *args,
149 write_archive_entry_fn_t write_entry)
151 struct archiver_context context;
152 struct unpack_trees_options opts;
153 struct tree_desc t;
154 int err;
156 if (args->baselen > 0 && args->base[args->baselen - 1] == '/') {
157 size_t len = args->baselen;
159 while (len > 1 && args->base[len - 2] == '/')
160 len--;
161 if (args->verbose)
162 fprintf(stderr, "%.*s\n", (int)len, args->base);
163 err = write_entry(args, args->tree->object.sha1, args->base,
164 len, 040777);
165 if (err)
166 return err;
169 context.args = args;
170 context.write_entry = write_entry;
173 * Setup index and instruct attr to read index only
175 if (!args->worktree_attributes) {
176 memset(&opts, 0, sizeof(opts));
177 opts.index_only = 1;
178 opts.head_idx = -1;
179 opts.src_index = &the_index;
180 opts.dst_index = &the_index;
181 opts.fn = oneway_merge;
182 init_tree_desc(&t, args->tree->buffer, args->tree->size);
183 if (unpack_trees(1, &t, &opts))
184 return -1;
185 git_attr_set_direction(GIT_ATTR_INDEX, &the_index);
188 err = read_tree_recursive(args->tree, "", 0, 0, &args->pathspec,
189 write_archive_entry, &context);
190 if (err == READ_TREE_RECURSIVE)
191 err = 0;
192 return err;
195 static const struct archiver *lookup_archiver(const char *name)
197 int i;
199 if (!name)
200 return NULL;
202 for (i = 0; i < nr_archivers; i++) {
203 if (!strcmp(name, archivers[i]->name))
204 return archivers[i];
206 return NULL;
209 static int reject_entry(const unsigned char *sha1, const char *base,
210 int baselen, const char *filename, unsigned mode,
211 int stage, void *context)
213 return -1;
216 static int path_exists(struct tree *tree, const char *path)
218 const char *paths[] = { path, NULL };
219 struct pathspec pathspec;
220 int ret;
222 parse_pathspec(&pathspec, 0, 0, "", paths);
223 ret = read_tree_recursive(tree, "", 0, 0, &pathspec, reject_entry, NULL);
224 free_pathspec(&pathspec);
225 return ret != 0;
228 static void parse_pathspec_arg(const char **pathspec,
229 struct archiver_args *ar_args)
232 * must be consistent with parse_pathspec in path_exists()
233 * Also if pathspec patterns are dependent, we're in big
234 * trouble as we test each one separately
236 parse_pathspec(&ar_args->pathspec, 0,
237 PATHSPEC_PREFER_FULL,
238 "", pathspec);
239 if (pathspec) {
240 while (*pathspec) {
241 if (**pathspec && !path_exists(ar_args->tree, *pathspec))
242 die(_("pathspec '%s' did not match any files"), *pathspec);
243 pathspec++;
248 static void parse_treeish_arg(const char **argv,
249 struct archiver_args *ar_args, const char *prefix,
250 int remote)
252 const char *name = argv[0];
253 const unsigned char *commit_sha1;
254 time_t archive_time;
255 struct tree *tree;
256 const struct commit *commit;
257 unsigned char sha1[20];
259 /* Remotes are only allowed to fetch actual refs */
260 if (remote) {
261 char *ref = NULL;
262 const char *colon = strchr(name, ':');
263 int refnamelen = colon ? colon - name : strlen(name);
265 if (!dwim_ref(name, refnamelen, sha1, &ref))
266 die("no such ref: %.*s", refnamelen, name);
267 free(ref);
270 if (get_sha1(name, sha1))
271 die("Not a valid object name");
273 commit = lookup_commit_reference_gently(sha1, 1);
274 if (commit) {
275 commit_sha1 = commit->object.sha1;
276 archive_time = commit->date;
277 } else {
278 commit_sha1 = NULL;
279 archive_time = time(NULL);
282 tree = parse_tree_indirect(sha1);
283 if (tree == NULL)
284 die("not a tree object");
286 if (prefix) {
287 unsigned char tree_sha1[20];
288 unsigned int mode;
289 int err;
291 err = get_tree_entry(tree->object.sha1, prefix,
292 tree_sha1, &mode);
293 if (err || !S_ISDIR(mode))
294 die("current working directory is untracked");
296 tree = parse_tree_indirect(tree_sha1);
298 ar_args->tree = tree;
299 ar_args->commit_sha1 = commit_sha1;
300 ar_args->commit = commit;
301 ar_args->time = archive_time;
304 #define OPT__COMPR(s, v, h, p) \
305 { OPTION_SET_INT, (s), NULL, (v), NULL, (h), \
306 PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL, (p) }
307 #define OPT__COMPR_HIDDEN(s, v, p) \
308 { OPTION_SET_INT, (s), NULL, (v), NULL, "", \
309 PARSE_OPT_NOARG | PARSE_OPT_NONEG | PARSE_OPT_HIDDEN, NULL, (p) }
311 static int parse_archive_args(int argc, const char **argv,
312 const struct archiver **ar, struct archiver_args *args,
313 const char *name_hint, int is_remote)
315 const char *format = NULL;
316 const char *base = NULL;
317 const char *remote = NULL;
318 const char *exec = NULL;
319 const char *output = NULL;
320 int compression_level = -1;
321 int verbose = 0;
322 int i;
323 int list = 0;
324 int worktree_attributes = 0;
325 struct option opts[] = {
326 OPT_GROUP(""),
327 OPT_STRING(0, "format", &format, N_("fmt"), N_("archive format")),
328 OPT_STRING(0, "prefix", &base, N_("prefix"),
329 N_("prepend prefix to each pathname in the archive")),
330 OPT_STRING('o', "output", &output, N_("file"),
331 N_("write the archive to this file")),
332 OPT_BOOL(0, "worktree-attributes", &worktree_attributes,
333 N_("read .gitattributes in working directory")),
334 OPT__VERBOSE(&verbose, N_("report archived files on stderr")),
335 OPT__COMPR('0', &compression_level, N_("store only"), 0),
336 OPT__COMPR('1', &compression_level, N_("compress faster"), 1),
337 OPT__COMPR_HIDDEN('2', &compression_level, 2),
338 OPT__COMPR_HIDDEN('3', &compression_level, 3),
339 OPT__COMPR_HIDDEN('4', &compression_level, 4),
340 OPT__COMPR_HIDDEN('5', &compression_level, 5),
341 OPT__COMPR_HIDDEN('6', &compression_level, 6),
342 OPT__COMPR_HIDDEN('7', &compression_level, 7),
343 OPT__COMPR_HIDDEN('8', &compression_level, 8),
344 OPT__COMPR('9', &compression_level, N_("compress better"), 9),
345 OPT_GROUP(""),
346 OPT_BOOL('l', "list", &list,
347 N_("list supported archive formats")),
348 OPT_GROUP(""),
349 OPT_STRING(0, "remote", &remote, N_("repo"),
350 N_("retrieve the archive from remote repository <repo>")),
351 OPT_STRING(0, "exec", &exec, N_("command"),
352 N_("path to the remote git-upload-archive command")),
353 OPT_END()
356 argc = parse_options(argc, argv, NULL, opts, archive_usage, 0);
358 if (remote)
359 die("Unexpected option --remote");
360 if (exec)
361 die("Option --exec can only be used together with --remote");
362 if (output)
363 die("Unexpected option --output");
365 if (!base)
366 base = "";
368 if (list) {
369 for (i = 0; i < nr_archivers; i++)
370 if (!is_remote || archivers[i]->flags & ARCHIVER_REMOTE)
371 printf("%s\n", archivers[i]->name);
372 exit(0);
375 if (!format && name_hint)
376 format = archive_format_from_filename(name_hint);
377 if (!format)
378 format = "tar";
380 /* We need at least one parameter -- tree-ish */
381 if (argc < 1)
382 usage_with_options(archive_usage, opts);
383 *ar = lookup_archiver(format);
384 if (!*ar || (is_remote && !((*ar)->flags & ARCHIVER_REMOTE)))
385 die("Unknown archive format '%s'", format);
387 args->compression_level = Z_DEFAULT_COMPRESSION;
388 if (compression_level != -1) {
389 if ((*ar)->flags & ARCHIVER_WANT_COMPRESSION_LEVELS)
390 args->compression_level = compression_level;
391 else {
392 die("Argument not supported for format '%s': -%d",
393 format, compression_level);
396 args->verbose = verbose;
397 args->base = base;
398 args->baselen = strlen(base);
399 args->worktree_attributes = worktree_attributes;
401 return argc;
404 int write_archive(int argc, const char **argv, const char *prefix,
405 int setup_prefix, const char *name_hint, int remote)
407 int nongit = 0;
408 const struct archiver *ar = NULL;
409 struct archiver_args args;
411 if (setup_prefix && prefix == NULL)
412 prefix = setup_git_directory_gently(&nongit);
414 git_config(git_default_config, NULL);
415 init_tar_archiver();
416 init_zip_archiver();
418 argc = parse_archive_args(argc, argv, &ar, &args, name_hint, remote);
419 if (nongit) {
421 * We know this will die() with an error, so we could just
422 * die ourselves; but its error message will be more specific
423 * than what we could write here.
425 setup_git_directory();
428 parse_treeish_arg(argv, &args, prefix, remote);
429 parse_pathspec_arg(argv + 1, &args);
431 return ar->write_archive(ar, &args);
434 static int match_extension(const char *filename, const char *ext)
436 int prefixlen = strlen(filename) - strlen(ext);
439 * We need 1 character for the '.', and 1 character to ensure that the
440 * prefix is non-empty (k.e., we don't match .tar.gz with no actual
441 * filename).
443 if (prefixlen < 2 || filename[prefixlen - 1] != '.')
444 return 0;
445 return !strcmp(filename + prefixlen, ext);
448 const char *archive_format_from_filename(const char *filename)
450 int i;
452 for (i = 0; i < nr_archivers; i++)
453 if (match_extension(filename, archivers[i]->name))
454 return archivers[i]->name;
455 return NULL;