Merge branch 'eb/doc-log-manpage'
[git/jnareb-git.git] / bundle.c
blobff97adcb891caf98dcc655e71e29eaec5dae0135
1 #include "cache.h"
2 #include "bundle.h"
3 #include "object.h"
4 #include "commit.h"
5 #include "diff.h"
6 #include "revision.h"
7 #include "list-objects.h"
8 #include "run-command.h"
9 #include "refs.h"
11 static const char bundle_signature[] = "# v2 git bundle\n";
13 static void add_to_ref_list(const unsigned char *sha1, const char *name,
14 struct ref_list *list)
16 if (list->nr + 1 >= list->alloc) {
17 list->alloc = alloc_nr(list->nr + 1);
18 list->list = xrealloc(list->list,
19 list->alloc * sizeof(list->list[0]));
21 memcpy(list->list[list->nr].sha1, sha1, 20);
22 list->list[list->nr].name = xstrdup(name);
23 list->nr++;
26 /* returns an fd */
27 int read_bundle_header(const char *path, struct bundle_header *header)
29 char buffer[1024];
30 int fd;
31 long fpos;
32 FILE *ffd = fopen(path, "rb");
34 if (!ffd)
35 return error("could not open '%s'", path);
36 if (!fgets(buffer, sizeof(buffer), ffd) ||
37 strcmp(buffer, bundle_signature)) {
38 fclose(ffd);
39 return error("'%s' does not look like a v2 bundle file", path);
41 while (fgets(buffer, sizeof(buffer), ffd)
42 && buffer[0] != '\n') {
43 int is_prereq = buffer[0] == '-';
44 int offset = is_prereq ? 1 : 0;
45 int len = strlen(buffer);
46 unsigned char sha1[20];
47 struct ref_list *list = is_prereq ? &header->prerequisites
48 : &header->references;
49 char delim;
51 if (len && buffer[len - 1] == '\n')
52 buffer[len - 1] = '\0';
53 if (get_sha1_hex(buffer + offset, sha1)) {
54 warning("unrecognized header: %s", buffer);
55 continue;
57 delim = buffer[40 + offset];
58 if (!isspace(delim) && (delim != '\0' || !is_prereq))
59 die ("invalid header: %s", buffer);
60 add_to_ref_list(sha1, isspace(delim) ?
61 buffer + 41 + offset : "", list);
63 fpos = ftell(ffd);
64 fclose(ffd);
65 fd = open(path, O_RDONLY);
66 if (fd < 0)
67 return error("could not open '%s'", path);
68 lseek(fd, fpos, SEEK_SET);
69 return fd;
72 static int list_refs(struct ref_list *r, int argc, const char **argv)
74 int i;
76 for (i = 0; i < r->nr; i++) {
77 if (argc > 1) {
78 int j;
79 for (j = 1; j < argc; j++)
80 if (!strcmp(r->list[i].name, argv[j]))
81 break;
82 if (j == argc)
83 continue;
85 printf("%s %s\n", sha1_to_hex(r->list[i].sha1),
86 r->list[i].name);
88 return 0;
91 #define PREREQ_MARK (1u<<16)
93 int verify_bundle(struct bundle_header *header, int verbose)
96 * Do fast check, then if any prereqs are missing then go line by line
97 * to be verbose about the errors
99 struct ref_list *p = &header->prerequisites;
100 struct rev_info revs;
101 const char *argv[] = {NULL, "--all", NULL};
102 struct object_array refs;
103 struct commit *commit;
104 int i, ret = 0, req_nr;
105 const char *message = "Repository lacks these prerequisite commits:";
107 init_revisions(&revs, NULL);
108 for (i = 0; i < p->nr; i++) {
109 struct ref_list_entry *e = p->list + i;
110 struct object *o = parse_object(e->sha1);
111 if (o) {
112 o->flags |= PREREQ_MARK;
113 add_pending_object(&revs, o, e->name);
114 continue;
116 if (++ret == 1)
117 error("%s", message);
118 error("%s %s", sha1_to_hex(e->sha1), e->name);
120 if (revs.pending.nr != p->nr)
121 return ret;
122 req_nr = revs.pending.nr;
123 setup_revisions(2, argv, &revs, NULL);
125 memset(&refs, 0, sizeof(struct object_array));
126 for (i = 0; i < revs.pending.nr; i++) {
127 struct object_array_entry *e = revs.pending.objects + i;
128 add_object_array(e->item, e->name, &refs);
131 if (prepare_revision_walk(&revs))
132 die("revision walk setup failed");
134 i = req_nr;
135 while (i && (commit = get_revision(&revs)))
136 if (commit->object.flags & PREREQ_MARK)
137 i--;
139 for (i = 0; i < req_nr; i++)
140 if (!(refs.objects[i].item->flags & SHOWN)) {
141 if (++ret == 1)
142 error("%s", message);
143 error("%s %s", sha1_to_hex(refs.objects[i].item->sha1),
144 refs.objects[i].name);
147 for (i = 0; i < refs.nr; i++)
148 clear_commit_marks((struct commit *)refs.objects[i].item, -1);
150 if (verbose) {
151 struct ref_list *r;
153 r = &header->references;
154 printf("The bundle contains %d ref%s\n",
155 r->nr, (1 < r->nr) ? "s" : "");
156 list_refs(r, 0, NULL);
157 r = &header->prerequisites;
158 printf("The bundle requires these %d ref%s\n",
159 r->nr, (1 < r->nr) ? "s" : "");
160 list_refs(r, 0, NULL);
162 return ret;
165 int list_bundle_refs(struct bundle_header *header, int argc, const char **argv)
167 return list_refs(&header->references, argc, argv);
170 static int is_tag_in_date_range(struct object *tag, struct rev_info *revs)
172 unsigned long size;
173 enum object_type type;
174 char *buf, *line, *lineend;
175 unsigned long date;
177 if (revs->max_age == -1 && revs->min_age == -1)
178 return 1;
180 buf = read_sha1_file(tag->sha1, &type, &size);
181 if (!buf)
182 return 1;
183 line = memmem(buf, size, "\ntagger ", 8);
184 if (!line++)
185 return 1;
186 lineend = memchr(line, buf + size - line, '\n');
187 line = memchr(line, lineend ? lineend - line : buf + size - line, '>');
188 if (!line++)
189 return 1;
190 date = strtoul(line, NULL, 10);
191 free(buf);
192 return (revs->max_age == -1 || revs->max_age < date) &&
193 (revs->min_age == -1 || revs->min_age > date);
196 int create_bundle(struct bundle_header *header, const char *path,
197 int argc, const char **argv)
199 static struct lock_file lock;
200 int bundle_fd = -1;
201 int bundle_to_stdout;
202 const char **argv_boundary = xmalloc((argc + 4) * sizeof(const char *));
203 const char **argv_pack = xmalloc(5 * sizeof(const char *));
204 int i, ref_count = 0;
205 char buffer[1024];
206 struct rev_info revs;
207 struct child_process rls;
208 FILE *rls_fout;
210 bundle_to_stdout = !strcmp(path, "-");
211 if (bundle_to_stdout)
212 bundle_fd = 1;
213 else
214 bundle_fd = hold_lock_file_for_update(&lock, path,
215 LOCK_DIE_ON_ERROR);
217 /* write signature */
218 write_or_die(bundle_fd, bundle_signature, strlen(bundle_signature));
220 /* init revs to list objects for pack-objects later */
221 save_commit_buffer = 0;
222 init_revisions(&revs, NULL);
224 /* write prerequisites */
225 memcpy(argv_boundary + 3, argv + 1, argc * sizeof(const char *));
226 argv_boundary[0] = "rev-list";
227 argv_boundary[1] = "--boundary";
228 argv_boundary[2] = "--pretty=oneline";
229 argv_boundary[argc + 2] = NULL;
230 memset(&rls, 0, sizeof(rls));
231 rls.argv = argv_boundary;
232 rls.out = -1;
233 rls.git_cmd = 1;
234 if (start_command(&rls))
235 return -1;
236 rls_fout = xfdopen(rls.out, "r");
237 while (fgets(buffer, sizeof(buffer), rls_fout)) {
238 unsigned char sha1[20];
239 if (buffer[0] == '-') {
240 write_or_die(bundle_fd, buffer, strlen(buffer));
241 if (!get_sha1_hex(buffer + 1, sha1)) {
242 struct object *object = parse_object(sha1);
243 object->flags |= UNINTERESTING;
244 add_pending_object(&revs, object, buffer);
246 } else if (!get_sha1_hex(buffer, sha1)) {
247 struct object *object = parse_object(sha1);
248 object->flags |= SHOWN;
251 fclose(rls_fout);
252 if (finish_command(&rls))
253 return error("rev-list died");
255 /* write references */
256 argc = setup_revisions(argc, argv, &revs, NULL);
258 if (argc > 1)
259 return error("unrecognized argument: %s'", argv[1]);
261 object_array_remove_duplicates(&revs.pending);
263 for (i = 0; i < revs.pending.nr; i++) {
264 struct object_array_entry *e = revs.pending.objects + i;
265 unsigned char sha1[20];
266 char *ref;
267 const char *display_ref;
268 int flag;
270 if (e->item->flags & UNINTERESTING)
271 continue;
272 if (dwim_ref(e->name, strlen(e->name), sha1, &ref) != 1)
273 continue;
274 if (!resolve_ref(e->name, sha1, 1, &flag))
275 flag = 0;
276 display_ref = (flag & REF_ISSYMREF) ? e->name : ref;
278 if (e->item->type == OBJ_TAG &&
279 !is_tag_in_date_range(e->item, &revs)) {
280 e->item->flags |= UNINTERESTING;
281 continue;
285 * Make sure the refs we wrote out is correct; --max-count and
286 * other limiting options could have prevented all the tips
287 * from getting output.
289 * Non commit objects such as tags and blobs do not have
290 * this issue as they are not affected by those extra
291 * constraints.
293 if (!(e->item->flags & SHOWN) && e->item->type == OBJ_COMMIT) {
294 warning("ref '%s' is excluded by the rev-list options",
295 e->name);
296 free(ref);
297 continue;
300 * If you run "git bundle create bndl v1.0..v2.0", the
301 * name of the positive ref is "v2.0" but that is the
302 * commit that is referenced by the tag, and not the tag
303 * itself.
305 if (hashcmp(sha1, e->item->sha1)) {
307 * Is this the positive end of a range expressed
308 * in terms of a tag (e.g. v2.0 from the range
309 * "v1.0..v2.0")?
311 struct commit *one = lookup_commit_reference(sha1);
312 struct object *obj;
314 if (e->item == &(one->object)) {
316 * Need to include e->name as an
317 * independent ref to the pack-objects
318 * input, so that the tag is included
319 * in the output; otherwise we would
320 * end up triggering "empty bundle"
321 * error.
323 obj = parse_object(sha1);
324 obj->flags |= SHOWN;
325 add_pending_object(&revs, obj, e->name);
327 free(ref);
328 continue;
331 ref_count++;
332 write_or_die(bundle_fd, sha1_to_hex(e->item->sha1), 40);
333 write_or_die(bundle_fd, " ", 1);
334 write_or_die(bundle_fd, display_ref, strlen(display_ref));
335 write_or_die(bundle_fd, "\n", 1);
336 free(ref);
338 if (!ref_count)
339 die ("Refusing to create empty bundle.");
341 /* end header */
342 write_or_die(bundle_fd, "\n", 1);
344 /* write pack */
345 argv_pack[0] = "pack-objects";
346 argv_pack[1] = "--all-progress-implied";
347 argv_pack[2] = "--stdout";
348 argv_pack[3] = "--thin";
349 argv_pack[4] = NULL;
350 memset(&rls, 0, sizeof(rls));
351 rls.argv = argv_pack;
352 rls.in = -1;
353 rls.out = bundle_fd;
354 rls.git_cmd = 1;
355 if (start_command(&rls))
356 return error("Could not spawn pack-objects");
359 * start_command closed bundle_fd if it was > 1
360 * so set the lock fd to -1 so commit_lock_file()
361 * won't fail trying to close it.
363 lock.fd = -1;
365 for (i = 0; i < revs.pending.nr; i++) {
366 struct object *object = revs.pending.objects[i].item;
367 if (object->flags & UNINTERESTING)
368 write_or_die(rls.in, "^", 1);
369 write_or_die(rls.in, sha1_to_hex(object->sha1), 40);
370 write_or_die(rls.in, "\n", 1);
372 close(rls.in);
373 if (finish_command(&rls))
374 return error ("pack-objects died");
375 if (!bundle_to_stdout)
376 commit_lock_file(&lock);
377 return 0;
380 int unbundle(struct bundle_header *header, int bundle_fd)
382 const char *argv_index_pack[] = {"index-pack",
383 "--fix-thin", "--stdin", NULL};
384 struct child_process ip;
386 if (verify_bundle(header, 0))
387 return -1;
388 memset(&ip, 0, sizeof(ip));
389 ip.argv = argv_index_pack;
390 ip.in = bundle_fd;
391 ip.no_stdout = 1;
392 ip.git_cmd = 1;
393 if (run_command(&ip))
394 return error("index-pack died");
395 return 0;