Merge branch 'jn/maint-1.6.3-check-ref-format-doc' into maint-1.6.4
[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, base, baselen);
119         strbuf_addstr(&path, filename);
120         path_without_prefix = path.buf + args->baselen;
121
122         setup_archive_check(check);
123         if (!git_checkattr(path_without_prefix, ARRAY_SIZE(check), check)) {
124                 if (ATTR_TRUE(check[0].value))
125                         return 0;
126                 convert = ATTR_TRUE(check[1].value);
127         }
128
129         if (S_ISDIR(mode) || S_ISGITLINK(mode)) {
130                 strbuf_addch(&path, '/');
131                 if (args->verbose)
132                         fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
133                 err = write_entry(args, sha1, path.buf, path.len, mode, NULL, 0);
134                 if (err)
135                         return err;
136                 return (S_ISDIR(mode) ? READ_TREE_RECURSIVE : 0);
137         }
138
139         buffer = sha1_file_to_archive(path_without_prefix, sha1, mode,
140                         &type, &size, convert ? args->commit : NULL);
141         if (!buffer)
142                 return error("cannot read %s", sha1_to_hex(sha1));
143         if (args->verbose)
144                 fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
145         err = write_entry(args, sha1, path.buf, path.len, mode, buffer, size);
146         free(buffer);
147         return err;
148 }
149
150 int write_archive_entries(struct archiver_args *args,
151                 write_archive_entry_fn_t write_entry)
152 {
153         struct archiver_context context;
154         struct unpack_trees_options opts;
155         struct tree_desc t;
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,
166                                 len, 040777, NULL, 0);
167                 if (err)
168                         return err;
169         }
170
171         context.args = args;
172         context.write_entry = write_entry;
173
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
190         err =  read_tree_recursive(args->tree, args->base, args->baselen, 0,
191                         args->pathspec, write_archive_entry, &context);
192         if (err == READ_TREE_RECURSIVE)
193                 err = 0;
194         return err;
195 }
196
197 static const struct archiver *lookup_archiver(const char *name)
198 {
199         int i;
200
201         if (!name)
202                 return NULL;
203
204         for (i = 0; i < ARRAY_SIZE(archivers); i++) {
205                 if (!strcmp(name, archivers[i].name))
206                         return &archivers[i];
207         }
208         return NULL;
209 }
210
211 static void parse_pathspec_arg(const char **pathspec,
212                 struct archiver_args *ar_args)
213 {
214         ar_args->pathspec = get_pathspec(ar_args->base, pathspec);
215 }
216
217 static void parse_treeish_arg(const char **argv,
218                 struct archiver_args *ar_args, const char *prefix)
219 {
220         const char *name = argv[0];
221         const unsigned char *commit_sha1;
222         time_t archive_time;
223         struct tree *tree;
224         const struct commit *commit;
225         unsigned char sha1[20];
226
227         if (get_sha1(name, sha1))
228                 die("Not a valid object name");
229
230         commit = lookup_commit_reference_gently(sha1, 1);
231         if (commit) {
232                 commit_sha1 = commit->object.sha1;
233                 archive_time = commit->date;
234         } else {
235                 commit_sha1 = NULL;
236                 archive_time = time(NULL);
237         }
238
239         tree = parse_tree_indirect(sha1);
240         if (tree == NULL)
241                 die("not a tree object");
242
243         if (prefix) {
244                 unsigned char tree_sha1[20];
245                 unsigned int mode;
246                 int err;
247
248                 err = get_tree_entry(tree->object.sha1, prefix,
249                                      tree_sha1, &mode);
250                 if (err || !S_ISDIR(mode))
251                         die("current working directory is untracked");
252
253                 tree = parse_tree_indirect(tree_sha1);
254         }
255         ar_args->tree = tree;
256         ar_args->commit_sha1 = commit_sha1;
257         ar_args->commit = commit;
258         ar_args->time = archive_time;
259 }
260
261 #define OPT__COMPR(s, v, h, p) \
262         { OPTION_SET_INT, (s), NULL, (v), NULL, (h), \
263           PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL, (p) }
264 #define OPT__COMPR_HIDDEN(s, v, p) \
265         { OPTION_SET_INT, (s), NULL, (v), NULL, "", \
266           PARSE_OPT_NOARG | PARSE_OPT_NONEG | PARSE_OPT_HIDDEN, NULL, (p) }
267
268 static int parse_archive_args(int argc, const char **argv,
269                 const struct archiver **ar, struct archiver_args *args)
270 {
271         const char *format = "tar";
272         const char *base = NULL;
273         const char *remote = NULL;
274         const char *exec = NULL;
275         const char *output = NULL;
276         int compression_level = -1;
277         int verbose = 0;
278         int i;
279         int list = 0;
280         int worktree_attributes = 0;
281         struct option opts[] = {
282                 OPT_GROUP(""),
283                 OPT_STRING(0, "format", &format, "fmt", "archive format"),
284                 OPT_STRING(0, "prefix", &base, "prefix",
285                         "prepend prefix to each pathname in the archive"),
286                 OPT_STRING(0, "output", &output, "file",
287                         "write the archive to this file"),
288                 OPT_BOOLEAN(0, "worktree-attributes", &worktree_attributes,
289                         "read .gitattributes in working directory"),
290                 OPT__VERBOSE(&verbose),
291                 OPT__COMPR('0', &compression_level, "store only", 0),
292                 OPT__COMPR('1', &compression_level, "compress faster", 1),
293                 OPT__COMPR_HIDDEN('2', &compression_level, 2),
294                 OPT__COMPR_HIDDEN('3', &compression_level, 3),
295                 OPT__COMPR_HIDDEN('4', &compression_level, 4),
296                 OPT__COMPR_HIDDEN('5', &compression_level, 5),
297                 OPT__COMPR_HIDDEN('6', &compression_level, 6),
298                 OPT__COMPR_HIDDEN('7', &compression_level, 7),
299                 OPT__COMPR_HIDDEN('8', &compression_level, 8),
300                 OPT__COMPR('9', &compression_level, "compress better", 9),
301                 OPT_GROUP(""),
302                 OPT_BOOLEAN('l', "list", &list,
303                         "list supported archive formats"),
304                 OPT_GROUP(""),
305                 OPT_STRING(0, "remote", &remote, "repo",
306                         "retrieve the archive from remote repository <repo>"),
307                 OPT_STRING(0, "exec", &exec, "cmd",
308                         "path to the remote git-upload-archive command"),
309                 OPT_END()
310         };
311
312         argc = parse_options(argc, argv, NULL, opts, archive_usage, 0);
313
314         if (remote)
315                 die("Unexpected option --remote");
316         if (exec)
317                 die("Option --exec can only be used together with --remote");
318         if (output)
319                 die("Unexpected option --output");
320
321         if (!base)
322                 base = "";
323
324         if (list) {
325                 for (i = 0; i < ARRAY_SIZE(archivers); i++)
326                         printf("%s\n", archivers[i].name);
327                 exit(0);
328         }
329
330         /* We need at least one parameter -- tree-ish */
331         if (argc < 1)
332                 usage_with_options(archive_usage, opts);
333         *ar = lookup_archiver(format);
334         if (!*ar)
335                 die("Unknown archive format '%s'", format);
336
337         args->compression_level = Z_DEFAULT_COMPRESSION;
338         if (compression_level != -1) {
339                 if ((*ar)->flags & USES_ZLIB_COMPRESSION)
340                         args->compression_level = compression_level;
341                 else {
342                         die("Argument not supported for format '%s': -%d",
343                                         format, compression_level);
344                 }
345         }
346         args->verbose = verbose;
347         args->base = base;
348         args->baselen = strlen(base);
349         args->worktree_attributes = worktree_attributes;
350
351         return argc;
352 }
353
354 int write_archive(int argc, const char **argv, const char *prefix,
355                 int setup_prefix)
356 {
357         const struct archiver *ar = NULL;
358         struct archiver_args args;
359
360         argc = parse_archive_args(argc, argv, &ar, &args);
361         if (setup_prefix && prefix == NULL)
362                 prefix = setup_git_directory();
363
364         parse_treeish_arg(argv, &args, prefix);
365         parse_pathspec_arg(argv + 1, &args);
366
367         git_config(git_default_config, NULL);
368
369         return ar->write_archive(&args);
370 }