git.1: switch homepage for stats
[git.git] / archive.c
blob3fc0fb2928f1007ec5d8763d9d3a9b88152059ad
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;
20 static int remote_allow_unreachable;
22 void register_archiver(struct archiver *ar)
24 ALLOC_GROW(archivers, nr_archivers + 1, alloc_archivers);
25 archivers[nr_archivers++] = ar;
28 static void format_subst(const struct commit *commit,
29 const char *src, size_t len,
30 struct strbuf *buf)
32 char *to_free = NULL;
33 struct strbuf fmt = STRBUF_INIT;
34 struct pretty_print_context ctx = {0};
35 ctx.date_mode = DATE_NORMAL;
36 ctx.abbrev = DEFAULT_ABBREV;
38 if (src == buf->buf)
39 to_free = strbuf_detach(buf, NULL);
40 for (;;) {
41 const char *b, *c;
43 b = memmem(src, len, "$Format:", 8);
44 if (!b)
45 break;
46 c = memchr(b + 8, '$', (src + len) - b - 8);
47 if (!c)
48 break;
50 strbuf_reset(&fmt);
51 strbuf_add(&fmt, b + 8, c - b - 8);
53 strbuf_add(buf, src, b - src);
54 format_commit_message(commit, fmt.buf, buf, &ctx);
55 len -= c + 1 - src;
56 src = c + 1;
58 strbuf_add(buf, src, len);
59 strbuf_release(&fmt);
60 free(to_free);
63 void *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)
68 void *buffer;
69 const struct commit *commit = args->convert ? args->commit : NULL;
71 path += args->baselen;
72 buffer = read_sha1_file(sha1, type, sizep);
73 if (buffer && S_ISREG(mode)) {
74 struct strbuf buf = STRBUF_INIT;
75 size_t size = 0;
77 strbuf_attach(&buf, buffer, *sizep, *sizep + 1);
78 convert_to_working_tree(path, buf.buf, buf.len, &buf);
79 if (commit)
80 format_subst(commit, buf.buf, buf.len, &buf);
81 buffer = strbuf_detach(&buf, &size);
82 *sizep = size;
85 return buffer;
88 static void setup_archive_check(struct git_attr_check *check)
90 static struct git_attr *attr_export_ignore;
91 static struct git_attr *attr_export_subst;
93 if (!attr_export_ignore) {
94 attr_export_ignore = git_attr("export-ignore");
95 attr_export_subst = git_attr("export-subst");
97 check[0].attr = attr_export_ignore;
98 check[1].attr = attr_export_subst;
101 struct archiver_context {
102 struct archiver_args *args;
103 write_archive_entry_fn_t write_entry;
106 static int write_archive_entry(const unsigned char *sha1, const char *base,
107 int baselen, const char *filename, unsigned mode, int stage,
108 void *context)
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;
114 struct git_attr_check check[2];
115 const char *path_without_prefix;
116 int err;
118 args->convert = 0;
119 strbuf_reset(&path);
120 strbuf_grow(&path, PATH_MAX);
121 strbuf_add(&path, args->base, args->baselen);
122 strbuf_add(&path, base, baselen);
123 strbuf_addstr(&path, filename);
124 if (S_ISDIR(mode) || S_ISGITLINK(mode))
125 strbuf_addch(&path, '/');
126 path_without_prefix = path.buf + args->baselen;
128 setup_archive_check(check);
129 if (!git_check_attr(path_without_prefix, ARRAY_SIZE(check), check)) {
130 if (ATTR_TRUE(check[0].value))
131 return 0;
132 args->convert = ATTR_TRUE(check[1].value);
135 if (S_ISDIR(mode) || S_ISGITLINK(mode)) {
136 if (args->verbose)
137 fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
138 err = write_entry(args, sha1, path.buf, path.len, mode);
139 if (err)
140 return err;
141 return (S_ISDIR(mode) ? READ_TREE_RECURSIVE : 0);
144 if (args->verbose)
145 fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
146 return write_entry(args, sha1, path.buf, path.len, mode);
149 int write_archive_entries(struct archiver_args *args,
150 write_archive_entry_fn_t write_entry)
152 struct archiver_context context;
153 struct unpack_trees_options opts;
154 struct tree_desc t;
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 err = read_tree_recursive(args->tree, "", 0, 0, &args->pathspec,
190 write_archive_entry, &context);
191 if (err == READ_TREE_RECURSIVE)
192 err = 0;
193 return err;
196 static const struct archiver *lookup_archiver(const char *name)
198 int i;
200 if (!name)
201 return NULL;
203 for (i = 0; i < nr_archivers; i++) {
204 if (!strcmp(name, archivers[i]->name))
205 return archivers[i];
207 return NULL;
210 static int reject_entry(const unsigned char *sha1, const char *base,
211 int baselen, const char *filename, unsigned mode,
212 int stage, void *context)
214 return -1;
217 static int path_exists(struct tree *tree, const char *path)
219 const char *paths[] = { path, NULL };
220 struct pathspec pathspec;
221 int ret;
223 parse_pathspec(&pathspec, 0, 0, "", paths);
224 ret = read_tree_recursive(tree, "", 0, 0, &pathspec, reject_entry, NULL);
225 free_pathspec(&pathspec);
226 return ret != 0;
229 static void parse_pathspec_arg(const char **pathspec,
230 struct archiver_args *ar_args)
233 * must be consistent with parse_pathspec in path_exists()
234 * Also if pathspec patterns are dependent, we're in big
235 * trouble as we test each one separately
237 parse_pathspec(&ar_args->pathspec, 0,
238 PATHSPEC_PREFER_FULL,
239 "", pathspec);
240 if (pathspec) {
241 while (*pathspec) {
242 if (**pathspec && !path_exists(ar_args->tree, *pathspec))
243 die(_("pathspec '%s' did not match any files"), *pathspec);
244 pathspec++;
249 static void parse_treeish_arg(const char **argv,
250 struct archiver_args *ar_args, const char *prefix,
251 int remote)
253 const char *name = argv[0];
254 const unsigned char *commit_sha1;
255 time_t archive_time;
256 struct tree *tree;
257 const struct commit *commit;
258 unsigned char sha1[20];
260 /* Remotes are only allowed to fetch actual refs */
261 if (remote && !remote_allow_unreachable) {
262 char *ref = NULL;
263 const char *colon = strchrnul(name, ':');
264 int refnamelen = colon - name;
266 if (!dwim_ref(name, refnamelen, sha1, &ref))
267 die("no such ref: %.*s", refnamelen, name);
268 free(ref);
271 if (get_sha1(name, sha1))
272 die("Not a valid object name");
274 commit = lookup_commit_reference_gently(sha1, 1);
275 if (commit) {
276 commit_sha1 = commit->object.sha1;
277 archive_time = commit->date;
278 } else {
279 commit_sha1 = NULL;
280 archive_time = time(NULL);
283 tree = parse_tree_indirect(sha1);
284 if (tree == NULL)
285 die("not a tree object");
287 if (prefix) {
288 unsigned char tree_sha1[20];
289 unsigned int mode;
290 int err;
292 err = get_tree_entry(tree->object.sha1, prefix,
293 tree_sha1, &mode);
294 if (err || !S_ISDIR(mode))
295 die("current working directory is untracked");
297 tree = parse_tree_indirect(tree_sha1);
299 ar_args->tree = tree;
300 ar_args->commit_sha1 = commit_sha1;
301 ar_args->commit = commit;
302 ar_args->time = archive_time;
305 #define OPT__COMPR(s, v, h, p) \
306 { OPTION_SET_INT, (s), NULL, (v), NULL, (h), \
307 PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL, (p) }
308 #define OPT__COMPR_HIDDEN(s, v, p) \
309 { OPTION_SET_INT, (s), NULL, (v), NULL, "", \
310 PARSE_OPT_NOARG | PARSE_OPT_NONEG | PARSE_OPT_HIDDEN, NULL, (p) }
312 static int parse_archive_args(int argc, const char **argv,
313 const struct archiver **ar, struct archiver_args *args,
314 const char *name_hint, int is_remote)
316 const char *format = NULL;
317 const char *base = NULL;
318 const char *remote = NULL;
319 const char *exec = NULL;
320 const char *output = NULL;
321 int compression_level = -1;
322 int verbose = 0;
323 int i;
324 int list = 0;
325 int worktree_attributes = 0;
326 struct option opts[] = {
327 OPT_GROUP(""),
328 OPT_STRING(0, "format", &format, N_("fmt"), N_("archive format")),
329 OPT_STRING(0, "prefix", &base, N_("prefix"),
330 N_("prepend prefix to each pathname in the archive")),
331 OPT_STRING('o', "output", &output, N_("file"),
332 N_("write the archive to this file")),
333 OPT_BOOL(0, "worktree-attributes", &worktree_attributes,
334 N_("read .gitattributes in working directory")),
335 OPT__VERBOSE(&verbose, N_("report archived files on stderr")),
336 OPT__COMPR('0', &compression_level, N_("store only"), 0),
337 OPT__COMPR('1', &compression_level, N_("compress faster"), 1),
338 OPT__COMPR_HIDDEN('2', &compression_level, 2),
339 OPT__COMPR_HIDDEN('3', &compression_level, 3),
340 OPT__COMPR_HIDDEN('4', &compression_level, 4),
341 OPT__COMPR_HIDDEN('5', &compression_level, 5),
342 OPT__COMPR_HIDDEN('6', &compression_level, 6),
343 OPT__COMPR_HIDDEN('7', &compression_level, 7),
344 OPT__COMPR_HIDDEN('8', &compression_level, 8),
345 OPT__COMPR('9', &compression_level, N_("compress better"), 9),
346 OPT_GROUP(""),
347 OPT_BOOL('l', "list", &list,
348 N_("list supported archive formats")),
349 OPT_GROUP(""),
350 OPT_STRING(0, "remote", &remote, N_("repo"),
351 N_("retrieve the archive from remote repository <repo>")),
352 OPT_STRING(0, "exec", &exec, N_("command"),
353 N_("path to the remote git-upload-archive command")),
354 OPT_END()
357 argc = parse_options(argc, argv, NULL, opts, archive_usage, 0);
359 if (remote)
360 die("Unexpected option --remote");
361 if (exec)
362 die("Option --exec can only be used together with --remote");
363 if (output)
364 die("Unexpected option --output");
366 if (!base)
367 base = "";
369 if (list) {
370 for (i = 0; i < nr_archivers; i++)
371 if (!is_remote || archivers[i]->flags & ARCHIVER_REMOTE)
372 printf("%s\n", archivers[i]->name);
373 exit(0);
376 if (!format && name_hint)
377 format = archive_format_from_filename(name_hint);
378 if (!format)
379 format = "tar";
381 /* We need at least one parameter -- tree-ish */
382 if (argc < 1)
383 usage_with_options(archive_usage, opts);
384 *ar = lookup_archiver(format);
385 if (!*ar || (is_remote && !((*ar)->flags & ARCHIVER_REMOTE)))
386 die("Unknown archive format '%s'", format);
388 args->compression_level = Z_DEFAULT_COMPRESSION;
389 if (compression_level != -1) {
390 if ((*ar)->flags & ARCHIVER_WANT_COMPRESSION_LEVELS)
391 args->compression_level = compression_level;
392 else {
393 die("Argument not supported for format '%s': -%d",
394 format, compression_level);
397 args->verbose = verbose;
398 args->base = base;
399 args->baselen = strlen(base);
400 args->worktree_attributes = worktree_attributes;
402 return argc;
405 static int git_default_archive_config(const char *var, const char *value,
406 void *cb)
408 if (!strcmp(var, "uploadarchive.allowunreachable"))
409 remote_allow_unreachable = git_config_bool(var, value);
410 return git_default_config(var, value, cb);
413 int write_archive(int argc, const char **argv, const char *prefix,
414 int setup_prefix, const char *name_hint, int remote)
416 int nongit = 0;
417 const struct archiver *ar = NULL;
418 struct archiver_args args;
420 if (setup_prefix && prefix == NULL)
421 prefix = setup_git_directory_gently(&nongit);
423 git_config(git_default_archive_config, NULL);
424 init_tar_archiver();
425 init_zip_archiver();
427 argc = parse_archive_args(argc, argv, &ar, &args, name_hint, remote);
428 if (nongit) {
430 * We know this will die() with an error, so we could just
431 * die ourselves; but its error message will be more specific
432 * than what we could write here.
434 setup_git_directory();
437 parse_treeish_arg(argv, &args, prefix, remote);
438 parse_pathspec_arg(argv + 1, &args);
440 return ar->write_archive(ar, &args);
443 static int match_extension(const char *filename, const char *ext)
445 int prefixlen = strlen(filename) - strlen(ext);
448 * We need 1 character for the '.', and 1 character to ensure that the
449 * prefix is non-empty (k.e., we don't match .tar.gz with no actual
450 * filename).
452 if (prefixlen < 2 || filename[prefixlen - 1] != '.')
453 return 0;
454 return !strcmp(filename + prefixlen, ext);
457 const char *archive_format_from_filename(const char *filename)
459 int i;
461 for (i = 0; i < nr_archivers; i++)
462 if (match_extension(filename, archivers[i]->name))
463 return archivers[i]->name;
464 return NULL;