Merge branch 'maint'
[git] / archive.c
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"
8
9 static char const * const archive_usage[] = {
10         "git archive [options] <tree-ish> [path...]",
11         "git archive --list",
12         "git archive --remote <repo> [--exec <cmd>] [options] <tree-ish> [path...]",
13         "git archive --remote <repo> [--exec <cmd>] --list",
14         NULL
15 };
16
17 #define USES_ZLIB_COMPRESSION 1
18
19 static const struct archiver {
20         const char *name;
21         write_archive_fn_t write_archive;
22         unsigned int flags;
23 } archivers[] = {
24         { "tar", write_tar_archive },
25         { "zip", write_zip_archive, USES_ZLIB_COMPRESSION },
26 };
27
28 static void format_subst(const struct commit *commit,
29                          const char *src, size_t len,
30                          struct strbuf *buf)
31 {
32         char *to_free = NULL;
33         struct strbuf fmt = STRBUF_INIT;
34
35         if (src == buf->buf)
36                 to_free = strbuf_detach(buf, NULL);
37         for (;;) {
38                 const char *b, *c;
39
40                 b = memmem(src, len, "$Format:", 8);
41                 if (!b)
42                         break;
43                 c = memchr(b + 8, '$', (src + len) - b - 8);
44                 if (!c)
45                         break;
46
47                 strbuf_reset(&fmt);
48                 strbuf_add(&fmt, b + 8, c - b - 8);
49
50                 strbuf_add(buf, src, b - src);
51                 format_commit_message(commit, fmt.buf, buf, DATE_NORMAL);
52                 len -= c + 1 - src;
53                 src  = c + 1;
54         }
55         strbuf_add(buf, src, len);
56         strbuf_release(&fmt);
57         free(to_free);
58 }
59
60 static void *sha1_file_to_archive(const char *path, const unsigned char *sha1,
61                 unsigned int mode, enum object_type *type,
62                 unsigned long *sizep, const struct commit *commit)
63 {
64         void *buffer;
65
66         buffer = read_sha1_file(sha1, type, sizep);
67         if (buffer && S_ISREG(mode)) {
68                 struct strbuf buf = STRBUF_INIT;
69                 size_t size = 0;
70
71                 strbuf_attach(&buf, buffer, *sizep, *sizep + 1);
72                 convert_to_working_tree(path, buf.buf, buf.len, &buf);
73                 if (commit)
74                         format_subst(commit, buf.buf, buf.len, &buf);
75                 buffer = strbuf_detach(&buf, &size);
76                 *sizep = size;
77         }
78
79         return buffer;
80 }
81
82 static void setup_archive_check(struct git_attr_check *check)
83 {
84         static struct git_attr *attr_export_ignore;
85         static struct git_attr *attr_export_subst;
86
87         if (!attr_export_ignore) {
88                 attr_export_ignore = git_attr("export-ignore", 13);
89                 attr_export_subst = git_attr("export-subst", 12);
90         }
91         check[0].attr = attr_export_ignore;
92         check[1].attr = attr_export_subst;
93 }
94
95 struct archiver_context {
96         struct archiver_args *args;
97         write_archive_entry_fn_t write_entry;
98 };
99
100 static int write_archive_entry(const unsigned char *sha1, const char *base,
101                 int baselen, const char *filename, unsigned mode, int stage,
102                 void *context)
103 {
104         static struct strbuf path = STRBUF_INIT;
105         struct archiver_context *c = context;
106         struct archiver_args *args = c->args;
107         write_archive_entry_fn_t write_entry = c->write_entry;
108         struct git_attr_check check[2];
109         const char *path_without_prefix;
110         int convert = 0;
111         int err;
112         enum object_type type;
113         unsigned long size;
114         void *buffer;
115
116         strbuf_reset(&path);
117         strbuf_grow(&path, PATH_MAX);
118         strbuf_add(&path, args->base, args->baselen);
119         strbuf_add(&path, base, baselen);
120         strbuf_addstr(&path, filename);
121         path_without_prefix = path.buf + args->baselen;
122
123         setup_archive_check(check);
124         if (!git_checkattr(path_without_prefix, ARRAY_SIZE(check), check)) {
125                 if (ATTR_TRUE(check[0].value))
126                         return 0;
127                 convert = ATTR_TRUE(check[1].value);
128         }
129
130         if (S_ISDIR(mode) || S_ISGITLINK(mode)) {
131                 strbuf_addch(&path, '/');
132                 if (args->verbose)
133                         fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
134                 err = write_entry(args, sha1, path.buf, path.len, mode, NULL, 0);
135                 if (err)
136                         return err;
137                 return (S_ISDIR(mode) ? READ_TREE_RECURSIVE : 0);
138         }
139
140         buffer = sha1_file_to_archive(path_without_prefix, sha1, mode,
141                         &type, &size, convert ? args->commit : NULL);
142         if (!buffer)
143                 return error("cannot read %s", sha1_to_hex(sha1));
144         if (args->verbose)
145                 fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
146         err = write_entry(args, sha1, path.buf, path.len, mode, buffer, size);
147         free(buffer);
148         return err;
149 }
150
151 int write_archive_entries(struct archiver_args *args,
152                 write_archive_entry_fn_t write_entry)
153 {
154         struct archiver_context context;
155         struct unpack_trees_options opts;
156         struct tree_desc t;
157         int err;
158
159         if (args->baselen > 0 && args->base[args->baselen - 1] == '/') {
160                 size_t len = args->baselen;
161
162                 while (len > 1 && args->base[len - 2] == '/')
163                         len--;
164                 if (args->verbose)
165                         fprintf(stderr, "%.*s\n", (int)len, args->base);
166                 err = write_entry(args, args->tree->object.sha1, args->base,
167                                 len, 040777, NULL, 0);
168                 if (err)
169                         return err;
170         }
171
172         context.args = args;
173         context.write_entry = write_entry;
174
175         /*
176          * Setup index and instruct attr to read index only
177          */
178         if (!args->worktree_attributes) {
179                 memset(&opts, 0, sizeof(opts));
180                 opts.index_only = 1;
181                 opts.head_idx = -1;
182                 opts.src_index = &the_index;
183                 opts.dst_index = &the_index;
184                 opts.fn = oneway_merge;
185                 init_tree_desc(&t, args->tree->buffer, args->tree->size);
186                 if (unpack_trees(1, &t, &opts))
187                         return -1;
188                 git_attr_set_direction(GIT_ATTR_INDEX, &the_index);
189         }
190
191         err = read_tree_recursive(args->tree, "", 0, 0, args->pathspec,
192                                   write_archive_entry, &context);
193         if (err == READ_TREE_RECURSIVE)
194                 err = 0;
195         return err;
196 }
197
198 static const struct archiver *lookup_archiver(const char *name)
199 {
200         int i;
201
202         if (!name)
203                 return NULL;
204
205         for (i = 0; i < ARRAY_SIZE(archivers); i++) {
206                 if (!strcmp(name, archivers[i].name))
207                         return &archivers[i];
208         }
209         return NULL;
210 }
211
212 static void parse_pathspec_arg(const char **pathspec,
213                 struct archiver_args *ar_args)
214 {
215         ar_args->pathspec = get_pathspec("", pathspec);
216 }
217
218 static void parse_treeish_arg(const char **argv,
219                 struct archiver_args *ar_args, const char *prefix)
220 {
221         const char *name = argv[0];
222         const unsigned char *commit_sha1;
223         time_t archive_time;
224         struct tree *tree;
225         const struct commit *commit;
226         unsigned char sha1[20];
227
228         if (get_sha1(name, sha1))
229                 die("Not a valid object name");
230
231         commit = lookup_commit_reference_gently(sha1, 1);
232         if (commit) {
233                 commit_sha1 = commit->object.sha1;
234                 archive_time = commit->date;
235         } else {
236                 commit_sha1 = NULL;
237                 archive_time = time(NULL);
238         }
239
240         tree = parse_tree_indirect(sha1);
241         if (tree == NULL)
242                 die("not a tree object");
243
244         if (prefix) {
245                 unsigned char tree_sha1[20];
246                 unsigned int mode;
247                 int err;
248
249                 err = get_tree_entry(tree->object.sha1, prefix,
250                                      tree_sha1, &mode);
251                 if (err || !S_ISDIR(mode))
252                         die("current working directory is untracked");
253
254                 tree = parse_tree_indirect(tree_sha1);
255         }
256         ar_args->tree = tree;
257         ar_args->commit_sha1 = commit_sha1;
258         ar_args->commit = commit;
259         ar_args->time = archive_time;
260 }
261
262 #define OPT__COMPR(s, v, h, p) \
263         { OPTION_SET_INT, (s), NULL, (v), NULL, (h), \
264           PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL, (p) }
265 #define OPT__COMPR_HIDDEN(s, v, p) \
266         { OPTION_SET_INT, (s), NULL, (v), NULL, "", \
267           PARSE_OPT_NOARG | PARSE_OPT_NONEG | PARSE_OPT_HIDDEN, NULL, (p) }
268
269 static int parse_archive_args(int argc, const char **argv,
270                 const struct archiver **ar, struct archiver_args *args)
271 {
272         const char *format = "tar";
273         const char *base = NULL;
274         const char *remote = NULL;
275         const char *exec = NULL;
276         const char *output = NULL;
277         int compression_level = -1;
278         int verbose = 0;
279         int i;
280         int list = 0;
281         int worktree_attributes = 0;
282         struct option opts[] = {
283                 OPT_GROUP(""),
284                 OPT_STRING(0, "format", &format, "fmt", "archive format"),
285                 OPT_STRING(0, "prefix", &base, "prefix",
286                         "prepend prefix to each pathname in the archive"),
287                 OPT_STRING('o', "output", &output, "file",
288                         "write the archive to this file"),
289                 OPT_BOOLEAN(0, "worktree-attributes", &worktree_attributes,
290                         "read .gitattributes in working directory"),
291                 OPT__VERBOSE(&verbose),
292                 OPT__COMPR('0', &compression_level, "store only", 0),
293                 OPT__COMPR('1', &compression_level, "compress faster", 1),
294                 OPT__COMPR_HIDDEN('2', &compression_level, 2),
295                 OPT__COMPR_HIDDEN('3', &compression_level, 3),
296                 OPT__COMPR_HIDDEN('4', &compression_level, 4),
297                 OPT__COMPR_HIDDEN('5', &compression_level, 5),
298                 OPT__COMPR_HIDDEN('6', &compression_level, 6),
299                 OPT__COMPR_HIDDEN('7', &compression_level, 7),
300                 OPT__COMPR_HIDDEN('8', &compression_level, 8),
301                 OPT__COMPR('9', &compression_level, "compress better", 9),
302                 OPT_GROUP(""),
303                 OPT_BOOLEAN('l', "list", &list,
304                         "list supported archive formats"),
305                 OPT_GROUP(""),
306                 OPT_STRING(0, "remote", &remote, "repo",
307                         "retrieve the archive from remote repository <repo>"),
308                 OPT_STRING(0, "exec", &exec, "cmd",
309                         "path to the remote git-upload-archive command"),
310                 OPT_END()
311         };
312
313         argc = parse_options(argc, argv, NULL, opts, archive_usage, 0);
314
315         if (remote)
316                 die("Unexpected option --remote");
317         if (exec)
318                 die("Option --exec can only be used together with --remote");
319         if (output)
320                 die("Unexpected option --output");
321
322         if (!base)
323                 base = "";
324
325         if (list) {
326                 for (i = 0; i < ARRAY_SIZE(archivers); i++)
327                         printf("%s\n", archivers[i].name);
328                 exit(0);
329         }
330
331         /* We need at least one parameter -- tree-ish */
332         if (argc < 1)
333                 usage_with_options(archive_usage, opts);
334         *ar = lookup_archiver(format);
335         if (!*ar)
336                 die("Unknown archive format '%s'", format);
337
338         args->compression_level = Z_DEFAULT_COMPRESSION;
339         if (compression_level != -1) {
340                 if ((*ar)->flags & USES_ZLIB_COMPRESSION)
341                         args->compression_level = compression_level;
342                 else {
343                         die("Argument not supported for format '%s': -%d",
344                                         format, compression_level);
345                 }
346         }
347         args->verbose = verbose;
348         args->base = base;
349         args->baselen = strlen(base);
350         args->worktree_attributes = worktree_attributes;
351
352         return argc;
353 }
354
355 int write_archive(int argc, const char **argv, const char *prefix,
356                 int setup_prefix)
357 {
358         const struct archiver *ar = NULL;
359         struct archiver_args args;
360
361         argc = parse_archive_args(argc, argv, &ar, &args);
362         if (setup_prefix && prefix == NULL)
363                 prefix = setup_git_directory();
364
365         parse_treeish_arg(argv, &args, prefix);
366         parse_pathspec_arg(argv + 1, &args);
367
368         git_config(git_default_config, NULL);
369
370         return ar->write_archive(&args);
371 }