git-rebase: document suppression of duplicate commits
[git] / builtin-archive.c
1 /*
2  * Copyright (c) 2006 Franck Bui-Huu
3  * Copyright (c) 2006 Rene Scharfe
4  */
5 #include "cache.h"
6 #include "builtin.h"
7 #include "archive.h"
8 #include "commit.h"
9 #include "tree-walk.h"
10 #include "exec_cmd.h"
11 #include "pkt-line.h"
12 #include "sideband.h"
13 #include "attr.h"
14
15 static const char archive_usage[] = \
16 "git-archive --format=<fmt> [--prefix=<prefix>/] [--verbose] [<extra>] <tree-ish> [path...]";
17
18 static struct archiver_desc
19 {
20         const char *name;
21         write_archive_fn_t write_archive;
22         parse_extra_args_fn_t parse_extra;
23 } archivers[] = {
24         { "tar", write_tar_archive, NULL },
25         { "zip", write_zip_archive, parse_extra_zip_args },
26 };
27
28 static int run_remote_archiver(const char *remote, int argc,
29                                const char **argv)
30 {
31         char *url, buf[LARGE_PACKET_MAX];
32         int fd[2], i, len, rv;
33         pid_t pid;
34         const char *exec = "git-upload-archive";
35         int exec_at = 0;
36
37         for (i = 1; i < argc; i++) {
38                 const char *arg = argv[i];
39                 if (!prefixcmp(arg, "--exec=")) {
40                         if (exec_at)
41                                 die("multiple --exec specified");
42                         exec = arg + 7;
43                         exec_at = i;
44                         break;
45                 }
46         }
47
48         url = xstrdup(remote);
49         pid = git_connect(fd, url, exec, 0);
50         if (pid < 0)
51                 return pid;
52
53         for (i = 1; i < argc; i++) {
54                 if (i == exec_at)
55                         continue;
56                 packet_write(fd[1], "argument %s\n", argv[i]);
57         }
58         packet_flush(fd[1]);
59
60         len = packet_read_line(fd[0], buf, sizeof(buf));
61         if (!len)
62                 die("git-archive: expected ACK/NAK, got EOF");
63         if (buf[len-1] == '\n')
64                 buf[--len] = 0;
65         if (strcmp(buf, "ACK")) {
66                 if (len > 5 && !prefixcmp(buf, "NACK "))
67                         die("git-archive: NACK %s", buf + 5);
68                 die("git-archive: protocol error");
69         }
70
71         len = packet_read_line(fd[0], buf, sizeof(buf));
72         if (len)
73                 die("git-archive: expected a flush");
74
75         /* Now, start reading from fd[0] and spit it out to stdout */
76         rv = recv_sideband("archive", fd[0], 1, 2);
77         close(fd[0]);
78         close(fd[1]);
79         rv |= finish_connect(pid);
80
81         return !!rv;
82 }
83
84 static void format_subst(const struct commit *commit,
85                          const char *src, size_t len,
86                          struct strbuf *buf)
87 {
88         char *to_free = NULL;
89         struct strbuf fmt;
90
91         if (src == buf->buf)
92                 to_free = strbuf_detach(buf, NULL);
93         strbuf_init(&fmt, 0);
94         for (;;) {
95                 const char *b, *c;
96
97                 b = memmem(src, len, "$Format:", 8);
98                 if (!b || src + len < b + 9)
99                         break;
100                 c = memchr(b + 8, '$', len - 8);
101                 if (!c)
102                         break;
103
104                 strbuf_reset(&fmt);
105                 strbuf_add(&fmt, b + 8, c - b - 8);
106
107                 strbuf_add(buf, src, b - src);
108                 format_commit_message(commit, fmt.buf, buf);
109                 len -= c + 1 - src;
110                 src  = c + 1;
111         }
112         strbuf_add(buf, src, len);
113         strbuf_release(&fmt);
114         free(to_free);
115 }
116
117 static int convert_to_archive(const char *path,
118                               const void *src, size_t len,
119                               struct strbuf *buf,
120                               const struct commit *commit)
121 {
122         static struct git_attr *attr_export_subst;
123         struct git_attr_check check[1];
124
125         if (!commit)
126                 return 0;
127
128         if (!attr_export_subst)
129                 attr_export_subst = git_attr("export-subst", 12);
130
131         check[0].attr = attr_export_subst;
132         if (git_checkattr(path, ARRAY_SIZE(check), check))
133                 return 0;
134         if (!ATTR_TRUE(check[0].value))
135                 return 0;
136
137         format_subst(commit, src, len, buf);
138         return 1;
139 }
140
141 void *sha1_file_to_archive(const char *path, const unsigned char *sha1,
142                            unsigned int mode, enum object_type *type,
143                            unsigned long *sizep,
144                            const struct commit *commit)
145 {
146         void *buffer;
147
148         buffer = read_sha1_file(sha1, type, sizep);
149         if (buffer && S_ISREG(mode)) {
150                 struct strbuf buf;
151
152                 strbuf_init(&buf, 0);
153                 strbuf_attach(&buf, buffer, *sizep, *sizep + 1);
154                 convert_to_working_tree(path, buf.buf, buf.len, &buf);
155                 convert_to_archive(path, buf.buf, buf.len, &buf, commit);
156                 buffer = strbuf_detach(&buf, sizep);
157         }
158
159         return buffer;
160 }
161
162 static int init_archiver(const char *name, struct archiver *ar)
163 {
164         int rv = -1, i;
165
166         for (i = 0; i < ARRAY_SIZE(archivers); i++) {
167                 if (!strcmp(name, archivers[i].name)) {
168                         memset(ar, 0, sizeof(*ar));
169                         ar->name = archivers[i].name;
170                         ar->write_archive = archivers[i].write_archive;
171                         ar->parse_extra = archivers[i].parse_extra;
172                         rv = 0;
173                         break;
174                 }
175         }
176         return rv;
177 }
178
179 void parse_pathspec_arg(const char **pathspec, struct archiver_args *ar_args)
180 {
181         ar_args->pathspec = get_pathspec(ar_args->base, pathspec);
182 }
183
184 void parse_treeish_arg(const char **argv, struct archiver_args *ar_args,
185                        const char *prefix)
186 {
187         const char *name = argv[0];
188         const unsigned char *commit_sha1;
189         time_t archive_time;
190         struct tree *tree;
191         const struct commit *commit;
192         unsigned char sha1[20];
193
194         if (get_sha1(name, sha1))
195                 die("Not a valid object name");
196
197         commit = lookup_commit_reference_gently(sha1, 1);
198         if (commit) {
199                 commit_sha1 = commit->object.sha1;
200                 archive_time = commit->date;
201         } else {
202                 commit_sha1 = NULL;
203                 archive_time = time(NULL);
204         }
205
206         tree = parse_tree_indirect(sha1);
207         if (tree == NULL)
208                 die("not a tree object");
209
210         if (prefix) {
211                 unsigned char tree_sha1[20];
212                 unsigned int mode;
213                 int err;
214
215                 err = get_tree_entry(tree->object.sha1, prefix,
216                                      tree_sha1, &mode);
217                 if (err || !S_ISDIR(mode))
218                         die("current working directory is untracked");
219
220                 tree = parse_tree_indirect(tree_sha1);
221         }
222         ar_args->tree = tree;
223         ar_args->commit_sha1 = commit_sha1;
224         ar_args->commit = commit;
225         ar_args->time = archive_time;
226 }
227
228 int parse_archive_args(int argc, const char **argv, struct archiver *ar)
229 {
230         const char *extra_argv[MAX_EXTRA_ARGS];
231         int extra_argc = 0;
232         const char *format = "tar";
233         const char *base = "";
234         int verbose = 0;
235         int i;
236
237         for (i = 1; i < argc; i++) {
238                 const char *arg = argv[i];
239
240                 if (!strcmp(arg, "--list") || !strcmp(arg, "-l")) {
241                         for (i = 0; i < ARRAY_SIZE(archivers); i++)
242                                 printf("%s\n", archivers[i].name);
243                         exit(0);
244                 }
245                 if (!strcmp(arg, "--verbose") || !strcmp(arg, "-v")) {
246                         verbose = 1;
247                         continue;
248                 }
249                 if (!prefixcmp(arg, "--format=")) {
250                         format = arg + 9;
251                         continue;
252                 }
253                 if (!prefixcmp(arg, "--prefix=")) {
254                         base = arg + 9;
255                         continue;
256                 }
257                 if (!strcmp(arg, "--")) {
258                         i++;
259                         break;
260                 }
261                 if (arg[0] == '-') {
262                         if (extra_argc > MAX_EXTRA_ARGS - 1)
263                                 die("Too many extra options");
264                         extra_argv[extra_argc++] = arg;
265                         continue;
266                 }
267                 break;
268         }
269
270         /* We need at least one parameter -- tree-ish */
271         if (argc - 1 < i)
272                 usage(archive_usage);
273         if (init_archiver(format, ar) < 0)
274                 die("Unknown archive format '%s'", format);
275
276         if (extra_argc) {
277                 if (!ar->parse_extra)
278                         die("'%s' format does not handle %s",
279                             ar->name, extra_argv[0]);
280                 ar->args.extra = ar->parse_extra(extra_argc, extra_argv);
281         }
282         ar->args.verbose = verbose;
283         ar->args.base = base;
284
285         return i;
286 }
287
288 static const char *extract_remote_arg(int *ac, const char **av)
289 {
290         int ix, iy, cnt = *ac;
291         int no_more_options = 0;
292         const char *remote = NULL;
293
294         for (ix = iy = 1; ix < cnt; ix++) {
295                 const char *arg = av[ix];
296                 if (!strcmp(arg, "--"))
297                         no_more_options = 1;
298                 if (!no_more_options) {
299                         if (!prefixcmp(arg, "--remote=")) {
300                                 if (remote)
301                                         die("Multiple --remote specified");
302                                 remote = arg + 9;
303                                 continue;
304                         }
305                         if (arg[0] != '-')
306                                 no_more_options = 1;
307                 }
308                 if (ix != iy)
309                         av[iy] = arg;
310                 iy++;
311         }
312         if (remote) {
313                 av[--cnt] = NULL;
314                 *ac = cnt;
315         }
316         return remote;
317 }
318
319 int cmd_archive(int argc, const char **argv, const char *prefix)
320 {
321         struct archiver ar;
322         int tree_idx;
323         const char *remote = NULL;
324
325         remote = extract_remote_arg(&argc, argv);
326         if (remote)
327                 return run_remote_archiver(remote, argc, argv);
328
329         setvbuf(stderr, NULL, _IOLBF, BUFSIZ);
330
331         memset(&ar, 0, sizeof(ar));
332         tree_idx = parse_archive_args(argc, argv, &ar);
333         if (prefix == NULL)
334                 prefix = setup_git_directory();
335
336         argv += tree_idx;
337         parse_treeish_arg(argv, &ar.args, prefix);
338         parse_pathspec_arg(argv + 1, &ar.args);
339
340         return ar.write_archive(&ar.args);
341 }