Code

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