Documentation/git-submodule.txt: Further clarify the description
[git/dscho.git] / builtin-archive.c
blobd5e3af879e7935ae3d5a6fad11951071e379855e
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"
15 static const char archive_usage[] = \
16 "git archive --format=<fmt> [--prefix=<prefix>/] [--verbose] [<extra>] <tree-ish> [path...]";
18 #define USES_ZLIB_COMPRESSION 1
20 const struct archiver archivers[] = {
21 { "tar", write_tar_archive },
22 { "zip", write_zip_archive, USES_ZLIB_COMPRESSION },
25 static int run_remote_archiver(const char *remote, int argc,
26 const char **argv)
28 char *url, buf[LARGE_PACKET_MAX];
29 int fd[2], i, len, rv;
30 struct child_process *conn;
31 const char *exec = "git-upload-archive";
32 int exec_at = 0;
34 for (i = 1; i < argc; i++) {
35 const char *arg = argv[i];
36 if (!prefixcmp(arg, "--exec=")) {
37 if (exec_at)
38 die("multiple --exec specified");
39 exec = arg + 7;
40 exec_at = i;
41 break;
45 url = xstrdup(remote);
46 conn = git_connect(fd, url, exec, 0);
48 for (i = 1; i < argc; i++) {
49 if (i == exec_at)
50 continue;
51 packet_write(fd[1], "argument %s\n", argv[i]);
53 packet_flush(fd[1]);
55 len = packet_read_line(fd[0], buf, sizeof(buf));
56 if (!len)
57 die("git-archive: expected ACK/NAK, got EOF");
58 if (buf[len-1] == '\n')
59 buf[--len] = 0;
60 if (strcmp(buf, "ACK")) {
61 if (len > 5 && !prefixcmp(buf, "NACK "))
62 die("git-archive: NACK %s", buf + 5);
63 die("git-archive: protocol error");
66 len = packet_read_line(fd[0], buf, sizeof(buf));
67 if (len)
68 die("git-archive: expected a flush");
70 /* Now, start reading from fd[0] and spit it out to stdout */
71 rv = recv_sideband("archive", fd[0], 1, 2);
72 close(fd[0]);
73 close(fd[1]);
74 rv |= finish_connect(conn);
76 return !!rv;
79 static const struct archiver *lookup_archiver(const char *name)
81 int i;
83 for (i = 0; i < ARRAY_SIZE(archivers); i++) {
84 if (!strcmp(name, archivers[i].name))
85 return &archivers[i];
87 return NULL;
90 void parse_pathspec_arg(const char **pathspec, struct archiver_args *ar_args)
92 ar_args->pathspec = get_pathspec(ar_args->base, pathspec);
95 void parse_treeish_arg(const char **argv, struct archiver_args *ar_args,
96 const char *prefix)
98 const char *name = argv[0];
99 const unsigned char *commit_sha1;
100 time_t archive_time;
101 struct tree *tree;
102 const struct commit *commit;
103 unsigned char sha1[20];
105 if (get_sha1(name, sha1))
106 die("Not a valid object name");
108 commit = lookup_commit_reference_gently(sha1, 1);
109 if (commit) {
110 commit_sha1 = commit->object.sha1;
111 archive_time = commit->date;
112 } else {
113 commit_sha1 = NULL;
114 archive_time = time(NULL);
117 tree = parse_tree_indirect(sha1);
118 if (tree == NULL)
119 die("not a tree object");
121 if (prefix) {
122 unsigned char tree_sha1[20];
123 unsigned int mode;
124 int err;
126 err = get_tree_entry(tree->object.sha1, prefix,
127 tree_sha1, &mode);
128 if (err || !S_ISDIR(mode))
129 die("current working directory is untracked");
131 tree = parse_tree_indirect(tree_sha1);
133 ar_args->tree = tree;
134 ar_args->commit_sha1 = commit_sha1;
135 ar_args->commit = commit;
136 ar_args->time = archive_time;
139 int parse_archive_args(int argc, const char **argv, const struct archiver **ar,
140 struct archiver_args *args)
142 const char *format = "tar";
143 const char *base = "";
144 int compression_level = -1;
145 int verbose = 0;
146 int i;
148 for (i = 1; i < argc; i++) {
149 const char *arg = argv[i];
151 if (!strcmp(arg, "--list") || !strcmp(arg, "-l")) {
152 for (i = 0; i < ARRAY_SIZE(archivers); i++)
153 printf("%s\n", archivers[i].name);
154 exit(0);
156 if (!strcmp(arg, "--verbose") || !strcmp(arg, "-v")) {
157 verbose = 1;
158 continue;
160 if (!prefixcmp(arg, "--format=")) {
161 format = arg + 9;
162 continue;
164 if (!prefixcmp(arg, "--prefix=")) {
165 base = arg + 9;
166 continue;
168 if (!strcmp(arg, "--")) {
169 i++;
170 break;
172 if (arg[0] == '-' && isdigit(arg[1]) && arg[2] == '\0') {
173 compression_level = arg[1] - '0';
174 continue;
176 if (arg[0] == '-')
177 die("Unknown argument: %s", arg);
178 break;
181 /* We need at least one parameter -- tree-ish */
182 if (argc - 1 < i)
183 usage(archive_usage);
184 *ar = lookup_archiver(format);
185 if (!*ar)
186 die("Unknown archive format '%s'", format);
188 if (compression_level != -1) {
189 if ((*ar)->flags & USES_ZLIB_COMPRESSION)
190 zlib_compression_level = compression_level;
191 else {
192 die("Argument not supported for format '%s': -%d",
193 format, compression_level);
196 args->verbose = verbose;
197 args->base = base;
198 args->baselen = strlen(base);
200 return i;
203 static const char *extract_remote_arg(int *ac, const char **av)
205 int ix, iy, cnt = *ac;
206 int no_more_options = 0;
207 const char *remote = NULL;
209 for (ix = iy = 1; ix < cnt; ix++) {
210 const char *arg = av[ix];
211 if (!strcmp(arg, "--"))
212 no_more_options = 1;
213 if (!no_more_options) {
214 if (!prefixcmp(arg, "--remote=")) {
215 if (remote)
216 die("Multiple --remote specified");
217 remote = arg + 9;
218 continue;
220 if (arg[0] != '-')
221 no_more_options = 1;
223 if (ix != iy)
224 av[iy] = arg;
225 iy++;
227 if (remote) {
228 av[--cnt] = NULL;
229 *ac = cnt;
231 return remote;
234 int cmd_archive(int argc, const char **argv, const char *prefix)
236 const struct archiver *ar = NULL;
237 struct archiver_args args;
238 int tree_idx;
239 const char *remote = NULL;
241 remote = extract_remote_arg(&argc, argv);
242 if (remote)
243 return run_remote_archiver(remote, argc, argv);
245 setvbuf(stderr, NULL, _IOLBF, BUFSIZ);
247 tree_idx = parse_archive_args(argc, argv, &ar, &args);
248 if (prefix == NULL)
249 prefix = setup_git_directory();
251 argv += tree_idx;
252 parse_treeish_arg(argv, &args, prefix);
253 parse_pathspec_arg(argv + 1, &args);
255 return ar->write_archive(&args);