Sync with 1.8.1.5
[git/jnareb-git.git] / archive.c
blob93e00bb4ae8ff9637be9e55fd41536b8837c3ba2
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 struct pathspec pathspec;
155 int err;
157 if (args->baselen > 0 && args->base[args->baselen - 1] == '/') {
158 size_t len = args->baselen;
160 while (len > 1 && args->base[len - 2] == '/')
161 len--;
162 if (args->verbose)
163 fprintf(stderr, "%.*s\n", (int)len, args->base);
164 err = write_entry(args, args->tree->object.sha1, args->base,
165 len, 040777);
166 if (err)
167 return err;
170 context.args = args;
171 context.write_entry = write_entry;
174 * Setup index and instruct attr to read index only
176 if (!args->worktree_attributes) {
177 memset(&opts, 0, sizeof(opts));
178 opts.index_only = 1;
179 opts.head_idx = -1;
180 opts.src_index = &the_index;
181 opts.dst_index = &the_index;
182 opts.fn = oneway_merge;
183 init_tree_desc(&t, args->tree->buffer, args->tree->size);
184 if (unpack_trees(1, &t, &opts))
185 return -1;
186 git_attr_set_direction(GIT_ATTR_INDEX, &the_index);
189 init_pathspec(&pathspec, args->pathspec);
190 err = read_tree_recursive(args->tree, "", 0, 0, &pathspec,
191 write_archive_entry, &context);
192 free_pathspec(&pathspec);
193 if (err == READ_TREE_RECURSIVE)
194 err = 0;
195 return err;
198 static const struct archiver *lookup_archiver(const char *name)
200 int i;
202 if (!name)
203 return NULL;
205 for (i = 0; i < nr_archivers; i++) {
206 if (!strcmp(name, archivers[i]->name))
207 return archivers[i];
209 return NULL;
212 static int reject_entry(const unsigned char *sha1, const char *base,
213 int baselen, const char *filename, unsigned mode,
214 int stage, void *context)
216 return -1;
219 static int path_exists(struct tree *tree, const char *path)
221 const char *paths[] = { path, NULL };
222 struct pathspec pathspec;
223 int ret;
225 init_pathspec(&pathspec, paths);
226 ret = read_tree_recursive(tree, "", 0, 0, &pathspec, reject_entry, NULL);
227 free_pathspec(&pathspec);
228 return ret != 0;
231 static void parse_pathspec_arg(const char **pathspec,
232 struct archiver_args *ar_args)
234 ar_args->pathspec = pathspec = get_pathspec("", pathspec);
235 if (pathspec) {
236 while (*pathspec) {
237 if (!path_exists(ar_args->tree, *pathspec))
238 die("path not found: %s", *pathspec);
239 pathspec++;
244 static void parse_treeish_arg(const char **argv,
245 struct archiver_args *ar_args, const char *prefix,
246 int remote)
248 const char *name = argv[0];
249 const unsigned char *commit_sha1;
250 time_t archive_time;
251 struct tree *tree;
252 const struct commit *commit;
253 unsigned char sha1[20];
255 /* Remotes are only allowed to fetch actual refs */
256 if (remote) {
257 char *ref = NULL;
258 const char *colon = strchr(name, ':');
259 int refnamelen = colon ? colon - name : strlen(name);
261 if (!dwim_ref(name, refnamelen, sha1, &ref))
262 die("no such ref: %.*s", refnamelen, name);
263 free(ref);
266 if (get_sha1(name, sha1))
267 die("Not a valid object name");
269 commit = lookup_commit_reference_gently(sha1, 1);
270 if (commit) {
271 commit_sha1 = commit->object.sha1;
272 archive_time = commit->date;
273 } else {
274 commit_sha1 = NULL;
275 archive_time = time(NULL);
278 tree = parse_tree_indirect(sha1);
279 if (tree == NULL)
280 die("not a tree object");
282 if (prefix) {
283 unsigned char tree_sha1[20];
284 unsigned int mode;
285 int err;
287 err = get_tree_entry(tree->object.sha1, prefix,
288 tree_sha1, &mode);
289 if (err || !S_ISDIR(mode))
290 die("current working directory is untracked");
292 tree = parse_tree_indirect(tree_sha1);
294 ar_args->tree = tree;
295 ar_args->commit_sha1 = commit_sha1;
296 ar_args->commit = commit;
297 ar_args->time = archive_time;
300 #define OPT__COMPR(s, v, h, p) \
301 { OPTION_SET_INT, (s), NULL, (v), NULL, (h), \
302 PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL, (p) }
303 #define OPT__COMPR_HIDDEN(s, v, p) \
304 { OPTION_SET_INT, (s), NULL, (v), NULL, "", \
305 PARSE_OPT_NOARG | PARSE_OPT_NONEG | PARSE_OPT_HIDDEN, NULL, (p) }
307 static int parse_archive_args(int argc, const char **argv,
308 const struct archiver **ar, struct archiver_args *args,
309 const char *name_hint, int is_remote)
311 const char *format = NULL;
312 const char *base = NULL;
313 const char *remote = NULL;
314 const char *exec = NULL;
315 const char *output = NULL;
316 int compression_level = -1;
317 int verbose = 0;
318 int i;
319 int list = 0;
320 int worktree_attributes = 0;
321 struct option opts[] = {
322 OPT_GROUP(""),
323 OPT_STRING(0, "format", &format, N_("fmt"), N_("archive format")),
324 OPT_STRING(0, "prefix", &base, N_("prefix"),
325 N_("prepend prefix to each pathname in the archive")),
326 OPT_STRING('o', "output", &output, N_("file"),
327 N_("write the archive to this file")),
328 OPT_BOOL(0, "worktree-attributes", &worktree_attributes,
329 N_("read .gitattributes in working directory")),
330 OPT__VERBOSE(&verbose, N_("report archived files on stderr")),
331 OPT__COMPR('0', &compression_level, N_("store only"), 0),
332 OPT__COMPR('1', &compression_level, N_("compress faster"), 1),
333 OPT__COMPR_HIDDEN('2', &compression_level, 2),
334 OPT__COMPR_HIDDEN('3', &compression_level, 3),
335 OPT__COMPR_HIDDEN('4', &compression_level, 4),
336 OPT__COMPR_HIDDEN('5', &compression_level, 5),
337 OPT__COMPR_HIDDEN('6', &compression_level, 6),
338 OPT__COMPR_HIDDEN('7', &compression_level, 7),
339 OPT__COMPR_HIDDEN('8', &compression_level, 8),
340 OPT__COMPR('9', &compression_level, N_("compress better"), 9),
341 OPT_GROUP(""),
342 OPT_BOOL('l', "list", &list,
343 N_("list supported archive formats")),
344 OPT_GROUP(""),
345 OPT_STRING(0, "remote", &remote, N_("repo"),
346 N_("retrieve the archive from remote repository <repo>")),
347 OPT_STRING(0, "exec", &exec, N_("command"),
348 N_("path to the remote git-upload-archive command")),
349 OPT_END()
352 argc = parse_options(argc, argv, NULL, opts, archive_usage, 0);
354 if (remote)
355 die("Unexpected option --remote");
356 if (exec)
357 die("Option --exec can only be used together with --remote");
358 if (output)
359 die("Unexpected option --output");
361 if (!base)
362 base = "";
364 if (list) {
365 for (i = 0; i < nr_archivers; i++)
366 if (!is_remote || archivers[i]->flags & ARCHIVER_REMOTE)
367 printf("%s\n", archivers[i]->name);
368 exit(0);
371 if (!format && name_hint)
372 format = archive_format_from_filename(name_hint);
373 if (!format)
374 format = "tar";
376 /* We need at least one parameter -- tree-ish */
377 if (argc < 1)
378 usage_with_options(archive_usage, opts);
379 *ar = lookup_archiver(format);
380 if (!*ar || (is_remote && !((*ar)->flags & ARCHIVER_REMOTE)))
381 die("Unknown archive format '%s'", format);
383 args->compression_level = Z_DEFAULT_COMPRESSION;
384 if (compression_level != -1) {
385 if ((*ar)->flags & ARCHIVER_WANT_COMPRESSION_LEVELS)
386 args->compression_level = compression_level;
387 else {
388 die("Argument not supported for format '%s': -%d",
389 format, compression_level);
392 args->verbose = verbose;
393 args->base = base;
394 args->baselen = strlen(base);
395 args->worktree_attributes = worktree_attributes;
397 return argc;
400 int write_archive(int argc, const char **argv, const char *prefix,
401 int setup_prefix, const char *name_hint, int remote)
403 int nongit = 0;
404 const struct archiver *ar = NULL;
405 struct archiver_args args;
407 if (setup_prefix && prefix == NULL)
408 prefix = setup_git_directory_gently(&nongit);
410 git_config(git_default_config, NULL);
411 init_tar_archiver();
412 init_zip_archiver();
414 argc = parse_archive_args(argc, argv, &ar, &args, name_hint, remote);
415 if (nongit) {
417 * We know this will die() with an error, so we could just
418 * die ourselves; but its error message will be more specific
419 * than what we could write here.
421 setup_git_directory();
424 parse_treeish_arg(argv, &args, prefix, remote);
425 parse_pathspec_arg(argv + 1, &args);
427 return ar->write_archive(ar, &args);
430 static int match_extension(const char *filename, const char *ext)
432 int prefixlen = strlen(filename) - strlen(ext);
435 * We need 1 character for the '.', and 1 character to ensure that the
436 * prefix is non-empty (k.e., we don't match .tar.gz with no actual
437 * filename).
439 if (prefixlen < 2 || filename[prefixlen-1] != '.')
440 return 0;
441 return !strcmp(filename + prefixlen, ext);
444 const char *archive_format_from_filename(const char *filename)
446 int i;
448 for (i = 0; i < nr_archivers; i++)
449 if (match_extension(filename, archivers[i]->name))
450 return archivers[i]->name;
451 return NULL;