1#include "cache.h"
2#include "lockfile.h"
3#include "bundle.h"
4#include "object.h"
5#include "commit.h"
6#include "diff.h"
7#include "revision.h"
8#include "list-objects.h"
9#include "run-command.h"
10#include "refs.h"
11#include "argv-array.h"
12static const char bundle_signature[] = "# v2 git bundle\n";
14static void add_to_ref_list(const struct object_id *oid, const char *name,
16 struct ref_list *list)
17{
18 ALLOC_GROW(list->list, list->nr + 1, list->alloc);
19 oidcpy(&list->list[list->nr].oid, oid);
20 list->list[list->nr].name = xstrdup(name);
21 list->nr++;
22}
23static int parse_bundle_header(int fd, struct bundle_header *header,
25 const char *report_path)
26{
27 struct strbuf buf = STRBUF_INIT;
28 int status = 0;
29 /* The bundle header begins with the signature */
31 if (strbuf_getwholeline_fd(&buf, fd, '\n') ||
32 strcmp(buf.buf, bundle_signature)) {
33 if (report_path)
34 error(_("'%s' does not look like a v2 bundle file"),
35 report_path);
36 status = -1;
37 goto abort;
38 }
39 /* The bundle header ends with an empty line */
41 while (!strbuf_getwholeline_fd(&buf, fd, '\n') &&
42 buf.len && buf.buf[0] != '\n') {
43 struct object_id oid;
44 int is_prereq = 0;
45 const char *p;
46 if (*buf.buf == '-') {
48 is_prereq = 1;
49 strbuf_remove(&buf, 0, 1);
50 }
51 strbuf_rtrim(&buf);
52 /*
54 * Tip lines have object name, SP, and refname.
55 * Prerequisites have object name that is optionally
56 * followed by SP and subject line.
57 */
58 if (parse_oid_hex(buf.buf, &oid, &p) ||
59 (*p && !isspace(*p)) ||
60 (!is_prereq && !*p)) {
61 if (report_path)
62 error(_("unrecognized header: %s%s (%d)"),
63 (is_prereq ? "-" : ""), buf.buf, (int)buf.len);
64 status = -1;
65 break;
66 } else {
67 if (is_prereq)
68 add_to_ref_list(&oid, "", &header->prerequisites);
69 else
70 add_to_ref_list(&oid, p + 1, &header->references);
71 }
72 }
73 abort:
75 if (status) {
76 close(fd);
77 fd = -1;
78 }
79 strbuf_release(&buf);
80 return fd;
81}
82int read_bundle_header(const char *path, struct bundle_header *header)
84{
85 int fd = open(path, O_RDONLY);
86 if (fd < 0)
88 return error(_("could not open '%s'"), path);
89 return parse_bundle_header(fd, header, path);
90}
91int is_bundle(const char *path, int quiet)
93{
94 struct bundle_header header;
95 int fd = open(path, O_RDONLY);
96 if (fd < 0)
98 return 0;
99 memset(&header, 0, sizeof(header));
100 fd = parse_bundle_header(fd, &header, quiet ? NULL : path);
101 if (fd >= 0)
102 close(fd);
103 return (fd >= 0);
104}
105static int list_refs(struct ref_list *r, int argc, const char **argv)
107{
108 int i;
109 for (i = 0; i < r->nr; i++) {
111 if (argc > 1) {
112 int j;
113 for (j = 1; j < argc; j++)
114 if (!strcmp(r->list[i].name, argv[j]))
115 break;
116 if (j == argc)
117 continue;
118 }
119 printf("%s %s\n", oid_to_hex(&r->list[i].oid),
120 r->list[i].name);
121 }
122 return 0;
123}
124/* Remember to update object flag allocation in object.h */
126#define PREREQ_MARK (1u<<16)
127int verify_bundle(struct bundle_header *header, int verbose)
129{
130 /*
131 * Do fast check, then if any prereqs are missing then go line by line
132 * to be verbose about the errors
133 */
134 struct ref_list *p = &header->prerequisites;
135 struct rev_info revs;
136 const char *argv[] = {NULL, "--all", NULL};
137 struct object_array refs;
138 struct commit *commit;
139 int i, ret = 0, req_nr;
140 const char *message = _("Repository lacks these prerequisite commits:");
141 init_revisions(&revs, NULL);
143 for (i = 0; i < p->nr; i++) {
144 struct ref_list_entry *e = p->list + i;
145 struct object *o = parse_object(&e->oid);
146 if (o) {
147 o->flags |= PREREQ_MARK;
148 add_pending_object(&revs, o, e->name);
149 continue;
150 }
151 if (++ret == 1)
152 error("%s", message);
153 error("%s %s", oid_to_hex(&e->oid), e->name);
154 }
155 if (revs.pending.nr != p->nr)
156 return ret;
157 req_nr = revs.pending.nr;
158 setup_revisions(2, argv, &revs, NULL);
159 /* Save pending objects, so they can be cleaned up later. */
161 refs = revs.pending;
162 revs.leak_pending = 1;
163 /*
165 * prepare_revision_walk (together with .leak_pending = 1) makes us
166 * the sole owner of the list of pending objects.
167 */
168 if (prepare_revision_walk(&revs))
169 die(_("revision walk setup failed"));
170 i = req_nr;
172 while (i && (commit = get_revision(&revs)))
173 if (commit->object.flags & PREREQ_MARK)
174 i--;
175 for (i = 0; i < req_nr; i++)
177 if (!(refs.objects[i].item->flags & SHOWN)) {
178 if (++ret == 1)
179 error("%s", message);
180 error("%s %s", oid_to_hex(&refs.objects[i].item->oid),
181 refs.objects[i].name);
182 }
183 /* Clean up objects used, as they will be reused. */
185 clear_commit_marks_for_object_array(&refs, ALL_REV_FLAGS);
186 object_array_clear(&refs);
188 if (verbose) {
190 struct ref_list *r;
191 r = &header->references;
193 printf_ln(Q_("The bundle contains this ref:",
194 "The bundle contains these %d refs:",
195 r->nr),
196 r->nr);
197 list_refs(r, 0, NULL);
198 r = &header->prerequisites;
199 if (!r->nr) {
200 printf_ln(_("The bundle records a complete history."));
201 } else {
202 printf_ln(Q_("The bundle requires this ref:",
203 "The bundle requires these %d refs:",
204 r->nr),
205 r->nr);
206 list_refs(r, 0, NULL);
207 }
208 }
209 return ret;
210}
211int list_bundle_refs(struct bundle_header *header, int argc, const char **argv)
213{
214 return list_refs(&header->references, argc, argv);
215}
216static int is_tag_in_date_range(struct object *tag, struct rev_info *revs)
218{
219 unsigned long size;
220 enum object_type type;
221 char *buf = NULL, *line, *lineend;
222 timestamp_t date;
223 int result = 1;
224 if (revs->max_age == -1 && revs->min_age == -1)
226 goto out;
227 buf = read_sha1_file(tag->oid.hash, &type, &size);
229 if (!buf)
230 goto out;
231 line = memmem(buf, size, "\ntagger ", 8);
232 if (!line++)
233 goto out;
234 lineend = memchr(line, '\n', buf + size - line);
235 line = memchr(line, '>', lineend ? lineend - line : buf + size - line);
236 if (!line++)
237 goto out;
238 date = parse_timestamp(line, NULL, 10);
239 result = (revs->max_age == -1 || revs->max_age < date) &&
240 (revs->min_age == -1 || revs->min_age > date);
241out:
242 free(buf);
243 return result;
244}
245/* Write the pack data to bundle_fd, then close it if it is > 1. */
248static int write_pack_data(int bundle_fd, struct rev_info *revs)
249{
250 struct child_process pack_objects = CHILD_PROCESS_INIT;
251 int i;
252 argv_array_pushl(&pack_objects.args,
254 "pack-objects", "--all-progress-implied",
255 "--stdout", "--thin", "--delta-base-offset",
256 NULL);
257 pack_objects.in = -1;
258 pack_objects.out = bundle_fd;
259 pack_objects.git_cmd = 1;
260 if (start_command(&pack_objects))
261 return error(_("Could not spawn pack-objects"));
262 for (i = 0; i < revs->pending.nr; i++) {
264 struct object *object = revs->pending.objects[i].item;
265 if (object->flags & UNINTERESTING)
266 write_or_die(pack_objects.in, "^", 1);
267 write_or_die(pack_objects.in, oid_to_hex(&object->oid), GIT_SHA1_HEXSZ);
268 write_or_die(pack_objects.in, "\n", 1);
269 }
270 close(pack_objects.in);
271 if (finish_command(&pack_objects))
272 return error(_("pack-objects died"));
273 return 0;
274}
275static int compute_and_write_prerequisites(int bundle_fd,
277 struct rev_info *revs,
278 int argc, const char **argv)
279{
280 struct child_process rls = CHILD_PROCESS_INIT;
281 struct strbuf buf = STRBUF_INIT;
282 FILE *rls_fout;
283 int i;
284 argv_array_pushl(&rls.args,
286 "rev-list", "--boundary", "--pretty=oneline",
287 NULL);
288 for (i = 1; i < argc; i++)
289 argv_array_push(&rls.args, argv[i]);
290 rls.out = -1;
291 rls.git_cmd = 1;
292 if (start_command(&rls))
293 return -1;
294 rls_fout = xfdopen(rls.out, "r");
295 while (strbuf_getwholeline(&buf, rls_fout, '\n') != EOF) {
296 struct object_id oid;
297 if (buf.len > 0 && buf.buf[0] == '-') {
298 write_or_die(bundle_fd, buf.buf, buf.len);
299 if (!get_oid_hex(buf.buf + 1, &oid)) {
300 struct object *object = parse_object_or_die(&oid,
301 buf.buf);
302 object->flags |= UNINTERESTING;
303 add_pending_object(revs, object, buf.buf);
304 }
305 } else if (!get_oid_hex(buf.buf, &oid)) {
306 struct object *object = parse_object_or_die(&oid,
307 buf.buf);
308 object->flags |= SHOWN;
309 }
310 }
311 strbuf_release(&buf);
312 fclose(rls_fout);
313 if (finish_command(&rls))
314 return error(_("rev-list died"));
315 return 0;
316}
317/*
319 * Write out bundle refs based on the tips already
320 * parsed into revs.pending. As a side effect, may
321 * manipulate revs.pending to include additional
322 * necessary objects (like tags).
323 *
324 * Returns the number of refs written, or negative
325 * on error.
326 */
327static int write_bundle_refs(int bundle_fd, struct rev_info *revs)
328{
329 int i;
330 int ref_count = 0;
331 for (i = 0; i < revs->pending.nr; i++) {
333 struct object_array_entry *e = revs->pending.objects + i;
334 struct object_id oid;
335 char *ref;
336 const char *display_ref;
337 int flag;
338 if (e->item->flags & UNINTERESTING)
340 continue;
341 if (dwim_ref(e->name, strlen(e->name), oid.hash, &ref) != 1)
342 goto skip_write_ref;
343 if (read_ref_full(e->name, RESOLVE_REF_READING, oid.hash, &flag))
344 flag = 0;
345 display_ref = (flag & REF_ISSYMREF) ? e->name : ref;
346 if (e->item->type == OBJ_TAG &&
348 !is_tag_in_date_range(e->item, revs)) {
349 e->item->flags |= UNINTERESTING;
350 goto skip_write_ref;
351 }
352 /*
354 * Make sure the refs we wrote out is correct; --max-count and
355 * other limiting options could have prevented all the tips
356 * from getting output.
357 *
358 * Non commit objects such as tags and blobs do not have
359 * this issue as they are not affected by those extra
360 * constraints.
361 */
362 if (!(e->item->flags & SHOWN) && e->item->type == OBJ_COMMIT) {
363 warning(_("ref '%s' is excluded by the rev-list options"),
364 e->name);
365 goto skip_write_ref;
366 }
367 /*
368 * If you run "git bundle create bndl v1.0..v2.0", the
369 * name of the positive ref is "v2.0" but that is the
370 * commit that is referenced by the tag, and not the tag
371 * itself.
372 */
373 if (oidcmp(&oid, &e->item->oid)) {
374 /*
375 * Is this the positive end of a range expressed
376 * in terms of a tag (e.g. v2.0 from the range
377 * "v1.0..v2.0")?
378 */
379 struct commit *one = lookup_commit_reference(&oid);
380 struct object *obj;
381 if (e->item == &(one->object)) {
383 /*
384 * Need to include e->name as an
385 * independent ref to the pack-objects
386 * input, so that the tag is included
387 * in the output; otherwise we would
388 * end up triggering "empty bundle"
389 * error.
390 */
391 obj = parse_object_or_die(&oid, e->name);
392 obj->flags |= SHOWN;
393 add_pending_object(revs, obj, e->name);
394 }
395 goto skip_write_ref;
396 }
397 ref_count++;
399 write_or_die(bundle_fd, oid_to_hex(&e->item->oid), 40);
400 write_or_die(bundle_fd, " ", 1);
401 write_or_die(bundle_fd, display_ref, strlen(display_ref));
402 write_or_die(bundle_fd, "\n", 1);
403 skip_write_ref:
404 free(ref);
405 }
406 /* end header */
408 write_or_die(bundle_fd, "\n", 1);
409 return ref_count;
410}
411int create_bundle(struct bundle_header *header, const char *path,
413 int argc, const char **argv)
414{
415 static struct lock_file lock;
416 int bundle_fd = -1;
417 int bundle_to_stdout;
418 int ref_count = 0;
419 struct rev_info revs;
420 bundle_to_stdout = !strcmp(path, "-");
422 if (bundle_to_stdout)
423 bundle_fd = 1;
424 else {
425 bundle_fd = hold_lock_file_for_update(&lock, path,
426 LOCK_DIE_ON_ERROR);
427 /*
429 * write_pack_data() will close the fd passed to it,
430 * but commit_lock_file() will also try to close the
431 * lockfile's fd. So make a copy of the file
432 * descriptor to avoid trying to close it twice.
433 */
434 bundle_fd = dup(bundle_fd);
435 if (bundle_fd < 0)
436 die_errno("unable to dup file descriptor");
437 }
438 /* write signature */
440 write_or_die(bundle_fd, bundle_signature, strlen(bundle_signature));
441 /* init revs to list objects for pack-objects later */
443 save_commit_buffer = 0;
444 init_revisions(&revs, NULL);
445 /* write prerequisites */
447 if (compute_and_write_prerequisites(bundle_fd, &revs, argc, argv))
448 goto err;
449 argc = setup_revisions(argc, argv, &revs, NULL);
451 if (argc > 1) {
453 error(_("unrecognized argument: %s"), argv[1]);
454 goto err;
455 }
456 object_array_remove_duplicates(&revs.pending);
458 ref_count = write_bundle_refs(bundle_fd, &revs);
460 if (!ref_count)
461 die(_("Refusing to create empty bundle."));
462 else if (ref_count < 0)
463 goto err;
464 /* write pack */
466 if (write_pack_data(bundle_fd, &revs)) {
467 bundle_fd = -1; /* already closed by the above call */
468 goto err;
469 }
470 if (!bundle_to_stdout) {
472 if (commit_lock_file(&lock))
473 die_errno(_("cannot create '%s'"), path);
474 }
475 return 0;
476err:
477 if (!bundle_to_stdout) {
478 if (0 <= bundle_fd)
479 close(bundle_fd);
480 rollback_lock_file(&lock);
481 }
482 return -1;
483}
484int unbundle(struct bundle_header *header, int bundle_fd, int flags)
486{
487 const char *argv_index_pack[] = {"index-pack",
488 "--fix-thin", "--stdin", NULL, NULL};
489 struct child_process ip = CHILD_PROCESS_INIT;
490 if (flags & BUNDLE_VERBOSE)
492 argv_index_pack[3] = "-v";
493 if (verify_bundle(header, 0))
495 return -1;
496 ip.argv = argv_index_pack;
497 ip.in = bundle_fd;
498 ip.no_stdout = 1;
499 ip.git_cmd = 1;
500 if (run_command(&ip))
501 return error(_("index-pack died"));
502 return 0;
503}