Git 1.6.6
[git/git.git] / archive.c
CommitLineData
18125644
LH
1#include "cache.h"
2#include "commit.h"
c0885435 3#include "tree-walk.h"
18125644 4#include "attr.h"
562e25ab 5#include "archive.h"
4fac1d3a 6#include "parse-options.h"
ba053ea9 7#include "unpack-trees.h"
4fac1d3a
RS
8
9static 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};
c0885435
RS
16
17#define USES_ZLIB_COMPRESSION 1
18
120a385a 19static const struct archiver {
f15f736d
RS
20 const char *name;
21 write_archive_fn_t write_archive;
22 unsigned int flags;
23} archivers[] = {
c0885435
RS
24 { "tar", write_tar_archive },
25 { "zip", write_zip_archive, USES_ZLIB_COMPRESSION },
26};
27
18125644
LH
28static void format_subst(const struct commit *commit,
29 const char *src, size_t len,
30 struct strbuf *buf)
31{
32 char *to_free = NULL;
f285a2d7 33 struct strbuf fmt = STRBUF_INIT;
dd2e794a
TR
34 struct pretty_print_context ctx = {0};
35 ctx.date_mode = DATE_NORMAL;
18125644
LH
36
37 if (src == buf->buf)
38 to_free = strbuf_detach(buf, NULL);
18125644
LH
39 for (;;) {
40 const char *b, *c;
41
42 b = memmem(src, len, "$Format:", 8);
75b7dfbd 43 if (!b)
18125644 44 break;
75b7dfbd 45 c = memchr(b + 8, '$', (src + len) - b - 8);
18125644
LH
46 if (!c)
47 break;
48
49 strbuf_reset(&fmt);
50 strbuf_add(&fmt, b + 8, c - b - 8);
51
52 strbuf_add(buf, src, b - src);
dd2e794a 53 format_commit_message(commit, fmt.buf, buf, &ctx);
18125644
LH
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}
61
1d11d5bb
RS
62static 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)
18125644
LH
65{
66 void *buffer;
67
68 buffer = read_sha1_file(sha1, type, sizep);
69 if (buffer && S_ISREG(mode)) {
f285a2d7 70 struct strbuf buf = STRBUF_INIT;
18125644
LH
71 size_t size = 0;
72
18125644
LH
73 strbuf_attach(&buf, buffer, *sizep, *sizep + 1);
74 convert_to_working_tree(path, buf.buf, buf.len, &buf);
1d11d5bb
RS
75 if (commit)
76 format_subst(commit, buf.buf, buf.len, &buf);
18125644
LH
77 buffer = strbuf_detach(&buf, &size);
78 *sizep = size;
79 }
80
81 return buffer;
82}
83
1d11d5bb 84static void setup_archive_check(struct git_attr_check *check)
008d896d
RS
85{
86 static struct git_attr *attr_export_ignore;
1d11d5bb 87 static struct git_attr *attr_export_subst;
008d896d 88
1d11d5bb 89 if (!attr_export_ignore) {
008d896d 90 attr_export_ignore = git_attr("export-ignore", 13);
1d11d5bb
RS
91 attr_export_subst = git_attr("export-subst", 12);
92 }
008d896d 93 check[0].attr = attr_export_ignore;
1d11d5bb 94 check[1].attr = attr_export_subst;
008d896d 95}
562e25ab
RS
96
97struct archiver_context {
98 struct archiver_args *args;
99 write_archive_entry_fn_t write_entry;
100};
101
102static int write_archive_entry(const unsigned char *sha1, const char *base,
103 int baselen, const char *filename, unsigned mode, int stage,
104 void *context)
105{
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;
1d11d5bb
RS
110 struct git_attr_check check[2];
111 const char *path_without_prefix;
112 int convert = 0;
562e25ab
RS
113 int err;
114 enum object_type type;
115 unsigned long size;
116 void *buffer;
117
118 strbuf_reset(&path);
119 strbuf_grow(&path, PATH_MAX);
ebfbdb34 120 strbuf_add(&path, args->base, args->baselen);
562e25ab
RS
121 strbuf_add(&path, base, baselen);
122 strbuf_addstr(&path, filename);
1d11d5bb 123 path_without_prefix = path.buf + args->baselen;
562e25ab 124
1d11d5bb
RS
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 }
562e25ab
RS
131
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;
d3bee161 139 return (S_ISDIR(mode) ? READ_TREE_RECURSIVE : 0);
562e25ab
RS
140 }
141
1d11d5bb
RS
142 buffer = sha1_file_to_archive(path_without_prefix, sha1, mode,
143 &type, &size, convert ? args->commit : NULL);
562e25ab
RS
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;
151}
152
153int write_archive_entries(struct archiver_args *args,
154 write_archive_entry_fn_t write_entry)
155{
156 struct archiver_context context;
ba053ea9
NTND
157 struct unpack_trees_options opts;
158 struct tree_desc t;
562e25ab
RS
159 int err;
160
161 if (args->baselen > 0 && args->base[args->baselen - 1] == '/') {
162 size_t len = args->baselen;
163
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 }
173
174 context.args = args;
175 context.write_entry = write_entry;
176
ba053ea9
NTND
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 }
192
ebfbdb34
RS
193 err = read_tree_recursive(args->tree, "", 0, 0, args->pathspec,
194 write_archive_entry, &context);
562e25ab
RS
195 if (err == READ_TREE_RECURSIVE)
196 err = 0;
197 return err;
198}
6e94e683 199
c0885435
RS
200static const struct archiver *lookup_archiver(const char *name)
201{
202 int i;
203
4fac1d3a
RS
204 if (!name)
205 return NULL;
206
c0885435
RS
207 for (i = 0; i < ARRAY_SIZE(archivers); i++) {
208 if (!strcmp(name, archivers[i].name))
209 return &archivers[i];
210 }
211 return NULL;
212}
213
214static void parse_pathspec_arg(const char **pathspec,
215 struct archiver_args *ar_args)
216{
ebfbdb34 217 ar_args->pathspec = get_pathspec("", pathspec);
c0885435
RS
218}
219
220static void parse_treeish_arg(const char **argv,
221 struct archiver_args *ar_args, const char *prefix)
222{
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];
229
230 if (get_sha1(name, sha1))
231 die("Not a valid object name");
232
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 }
241
242 tree = parse_tree_indirect(sha1);
243 if (tree == NULL)
244 die("not a tree object");
245
246 if (prefix) {
247 unsigned char tree_sha1[20];
248 unsigned int mode;
249 int err;
250
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");
255
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;
262}
263
4fac1d3a
RS
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) }
270
c0885435
RS
271static int parse_archive_args(int argc, const char **argv,
272 const struct archiver **ar, struct archiver_args *args)
273{
274 const char *format = "tar";
4fac1d3a
RS
275 const char *base = NULL;
276 const char *remote = NULL;
277 const char *exec = NULL;
aec0c1bb 278 const char *output = NULL;
c0885435
RS
279 int compression_level = -1;
280 int verbose = 0;
281 int i;
4fac1d3a 282 int list = 0;
ba053ea9 283 int worktree_attributes = 0;
4fac1d3a
RS
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"),
05d3951e 289 OPT_STRING('o', "output", &output, "file",
aec0c1bb 290 "write the archive to this file"),
ba053ea9
NTND
291 OPT_BOOLEAN(0, "worktree-attributes", &worktree_attributes,
292 "read .gitattributes in working directory"),
4fac1d3a
RS
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 };
314
37782920 315 argc = parse_options(argc, argv, NULL, opts, archive_usage, 0);
4fac1d3a
RS
316
317 if (remote)
318 die("Unexpected option --remote");
319 if (exec)
320 die("Option --exec can only be used together with --remote");
52e77876
RS
321 if (output)
322 die("Unexpected option --output");
4fac1d3a
RS
323
324 if (!base)
325 base = "";
326
327 if (list) {
328 for (i = 0; i < ARRAY_SIZE(archivers); i++)
329 printf("%s\n", archivers[i].name);
330 exit(0);
c0885435
RS
331 }
332
333 /* We need at least one parameter -- tree-ish */
4fac1d3a
RS
334 if (argc < 1)
335 usage_with_options(archive_usage, opts);
c0885435
RS
336 *ar = lookup_archiver(format);
337 if (!*ar)
338 die("Unknown archive format '%s'", format);
339
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);
ba053ea9 352 args->worktree_attributes = worktree_attributes;
c0885435 353
4fac1d3a 354 return argc;
c0885435
RS
355}
356
6e94e683
RS
357int write_archive(int argc, const char **argv, const char *prefix,
358 int setup_prefix)
359{
360 const struct archiver *ar = NULL;
361 struct archiver_args args;
6e94e683 362
4fac1d3a 363 argc = parse_archive_args(argc, argv, &ar, &args);
6e94e683
RS
364 if (setup_prefix && prefix == NULL)
365 prefix = setup_git_directory();
366
6e94e683
RS
367 parse_treeish_arg(argv, &args, prefix);
368 parse_pathspec_arg(argv + 1, &args);
369
ddff8563
CB
370 git_config(git_default_config, NULL);
371
6e94e683
RS
372 return ar->write_archive(&args);
373}