Code

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