The third batch
[git.git] / bundle.c
blobb45666c49b1c19a63d816527a761d0177d9633ce
1 #include "cache.h"
2 #include "lockfile.h"
3 #include "bundle.h"
4 #include "object-store.h"
5 #include "repository.h"
6 #include "object.h"
7 #include "commit.h"
8 #include "diff.h"
9 #include "revision.h"
10 #include "list-objects.h"
11 #include "run-command.h"
12 #include "refs.h"
13 #include "argv-array.h"
15 static const char bundle_signature[] = "# v2 git bundle\n";
17 static void add_to_ref_list(const struct object_id *oid, const char *name,
18 struct ref_list *list)
20 ALLOC_GROW(list->list, list->nr + 1, list->alloc);
21 oidcpy(&list->list[list->nr].oid, oid);
22 list->list[list->nr].name = xstrdup(name);
23 list->nr++;
26 static int parse_bundle_header(int fd, struct bundle_header *header,
27 const char *report_path)
29 struct strbuf buf = STRBUF_INIT;
30 int status = 0;
32 /* The bundle header begins with the signature */
33 if (strbuf_getwholeline_fd(&buf, fd, '\n') ||
34 strcmp(buf.buf, bundle_signature)) {
35 if (report_path)
36 error(_("'%s' does not look like a v2 bundle file"),
37 report_path);
38 status = -1;
39 goto abort;
42 /* The bundle header ends with an empty line */
43 while (!strbuf_getwholeline_fd(&buf, fd, '\n') &&
44 buf.len && buf.buf[0] != '\n') {
45 struct object_id oid;
46 int is_prereq = 0;
47 const char *p;
49 if (*buf.buf == '-') {
50 is_prereq = 1;
51 strbuf_remove(&buf, 0, 1);
53 strbuf_rtrim(&buf);
56 * Tip lines have object name, SP, and refname.
57 * Prerequisites have object name that is optionally
58 * followed by SP and subject line.
60 if (parse_oid_hex(buf.buf, &oid, &p) ||
61 (*p && !isspace(*p)) ||
62 (!is_prereq && !*p)) {
63 if (report_path)
64 error(_("unrecognized header: %s%s (%d)"),
65 (is_prereq ? "-" : ""), buf.buf, (int)buf.len);
66 status = -1;
67 break;
68 } else {
69 if (is_prereq)
70 add_to_ref_list(&oid, "", &header->prerequisites);
71 else
72 add_to_ref_list(&oid, p + 1, &header->references);
76 abort:
77 if (status) {
78 close(fd);
79 fd = -1;
81 strbuf_release(&buf);
82 return fd;
85 int read_bundle_header(const char *path, struct bundle_header *header)
87 int fd = open(path, O_RDONLY);
89 if (fd < 0)
90 return error(_("could not open '%s'"), path);
91 return parse_bundle_header(fd, header, path);
94 int is_bundle(const char *path, int quiet)
96 struct bundle_header header;
97 int fd = open(path, O_RDONLY);
99 if (fd < 0)
100 return 0;
101 memset(&header, 0, sizeof(header));
102 fd = parse_bundle_header(fd, &header, quiet ? NULL : path);
103 if (fd >= 0)
104 close(fd);
105 return (fd >= 0);
108 static int list_refs(struct ref_list *r, int argc, const char **argv)
110 int i;
112 for (i = 0; i < r->nr; i++) {
113 if (argc > 1) {
114 int j;
115 for (j = 1; j < argc; j++)
116 if (!strcmp(r->list[i].name, argv[j]))
117 break;
118 if (j == argc)
119 continue;
121 printf("%s %s\n", oid_to_hex(&r->list[i].oid),
122 r->list[i].name);
124 return 0;
127 /* Remember to update object flag allocation in object.h */
128 #define PREREQ_MARK (1u<<16)
130 int verify_bundle(struct repository *r,
131 struct bundle_header *header,
132 int verbose)
135 * Do fast check, then if any prereqs are missing then go line by line
136 * to be verbose about the errors
138 struct ref_list *p = &header->prerequisites;
139 struct rev_info revs;
140 const char *argv[] = {NULL, "--all", NULL};
141 struct commit *commit;
142 int i, ret = 0, req_nr;
143 const char *message = _("Repository lacks these prerequisite commits:");
145 repo_init_revisions(r, &revs, NULL);
146 for (i = 0; i < p->nr; i++) {
147 struct ref_list_entry *e = p->list + i;
148 struct object *o = parse_object(r, &e->oid);
149 if (o) {
150 o->flags |= PREREQ_MARK;
151 add_pending_object(&revs, o, e->name);
152 continue;
154 if (++ret == 1)
155 error("%s", message);
156 error("%s %s", oid_to_hex(&e->oid), e->name);
158 if (revs.pending.nr != p->nr)
159 return ret;
160 req_nr = revs.pending.nr;
161 setup_revisions(2, argv, &revs, NULL);
163 if (prepare_revision_walk(&revs))
164 die(_("revision walk setup failed"));
166 i = req_nr;
167 while (i && (commit = get_revision(&revs)))
168 if (commit->object.flags & PREREQ_MARK)
169 i--;
171 for (i = 0; i < p->nr; i++) {
172 struct ref_list_entry *e = p->list + i;
173 struct object *o = parse_object(r, &e->oid);
174 assert(o); /* otherwise we'd have returned early */
175 if (o->flags & SHOWN)
176 continue;
177 if (++ret == 1)
178 error("%s", message);
179 error("%s %s", oid_to_hex(&e->oid), e->name);
182 /* Clean up objects used, as they will be reused. */
183 for (i = 0; i < p->nr; i++) {
184 struct ref_list_entry *e = p->list + i;
185 commit = lookup_commit_reference_gently(r, &e->oid, 1);
186 if (commit)
187 clear_commit_marks(commit, ALL_REV_FLAGS);
190 if (verbose) {
191 struct ref_list *r;
193 r = &header->references;
194 printf_ln(Q_("The bundle contains this ref:",
195 "The bundle contains these %d refs:",
196 r->nr),
197 r->nr);
198 list_refs(r, 0, NULL);
199 r = &header->prerequisites;
200 if (!r->nr) {
201 printf_ln(_("The bundle records a complete history."));
202 } else {
203 printf_ln(Q_("The bundle requires this ref:",
204 "The bundle requires these %d refs:",
205 r->nr),
206 r->nr);
207 list_refs(r, 0, NULL);
210 return ret;
213 int list_bundle_refs(struct bundle_header *header, int argc, const char **argv)
215 return list_refs(&header->references, argc, argv);
218 static int is_tag_in_date_range(struct object *tag, struct rev_info *revs)
220 unsigned long size;
221 enum object_type type;
222 char *buf = NULL, *line, *lineend;
223 timestamp_t date;
224 int result = 1;
226 if (revs->max_age == -1 && revs->min_age == -1)
227 goto out;
229 buf = read_object_file(&tag->oid, &type, &size);
230 if (!buf)
231 goto out;
232 line = memmem(buf, size, "\ntagger ", 8);
233 if (!line++)
234 goto out;
235 lineend = memchr(line, '\n', buf + size - line);
236 line = memchr(line, '>', lineend ? lineend - line : buf + size - line);
237 if (!line++)
238 goto out;
239 date = parse_timestamp(line, NULL, 10);
240 result = (revs->max_age == -1 || revs->max_age < date) &&
241 (revs->min_age == -1 || revs->min_age > date);
242 out:
243 free(buf);
244 return result;
248 /* Write the pack data to bundle_fd */
249 static int write_pack_data(int bundle_fd, struct rev_info *revs)
251 struct child_process pack_objects = CHILD_PROCESS_INIT;
252 int i;
254 argv_array_pushl(&pack_objects.args,
255 "pack-objects", "--all-progress-implied",
256 "--stdout", "--thin", "--delta-base-offset",
257 NULL);
258 pack_objects.in = -1;
259 pack_objects.out = bundle_fd;
260 pack_objects.git_cmd = 1;
263 * start_command() will close our descriptor if it's >1. Duplicate it
264 * to avoid surprising the caller.
266 if (pack_objects.out > 1) {
267 pack_objects.out = dup(pack_objects.out);
268 if (pack_objects.out < 0) {
269 error_errno(_("unable to dup bundle descriptor"));
270 child_process_clear(&pack_objects);
271 return -1;
275 if (start_command(&pack_objects))
276 return error(_("Could not spawn pack-objects"));
278 for (i = 0; i < revs->pending.nr; i++) {
279 struct object *object = revs->pending.objects[i].item;
280 if (object->flags & UNINTERESTING)
281 write_or_die(pack_objects.in, "^", 1);
282 write_or_die(pack_objects.in, oid_to_hex(&object->oid), GIT_SHA1_HEXSZ);
283 write_or_die(pack_objects.in, "\n", 1);
285 close(pack_objects.in);
286 if (finish_command(&pack_objects))
287 return error(_("pack-objects died"));
288 return 0;
291 static int compute_and_write_prerequisites(int bundle_fd,
292 struct rev_info *revs,
293 int argc, const char **argv)
295 struct child_process rls = CHILD_PROCESS_INIT;
296 struct strbuf buf = STRBUF_INIT;
297 FILE *rls_fout;
298 int i;
300 argv_array_pushl(&rls.args,
301 "rev-list", "--boundary", "--pretty=oneline",
302 NULL);
303 for (i = 1; i < argc; i++)
304 argv_array_push(&rls.args, argv[i]);
305 rls.out = -1;
306 rls.git_cmd = 1;
307 if (start_command(&rls))
308 return -1;
309 rls_fout = xfdopen(rls.out, "r");
310 while (strbuf_getwholeline(&buf, rls_fout, '\n') != EOF) {
311 struct object_id oid;
312 if (buf.len > 0 && buf.buf[0] == '-') {
313 write_or_die(bundle_fd, buf.buf, buf.len);
314 if (!get_oid_hex(buf.buf + 1, &oid)) {
315 struct object *object = parse_object_or_die(&oid,
316 buf.buf);
317 object->flags |= UNINTERESTING;
318 add_pending_object(revs, object, buf.buf);
320 } else if (!get_oid_hex(buf.buf, &oid)) {
321 struct object *object = parse_object_or_die(&oid,
322 buf.buf);
323 object->flags |= SHOWN;
326 strbuf_release(&buf);
327 fclose(rls_fout);
328 if (finish_command(&rls))
329 return error(_("rev-list died"));
330 return 0;
334 * Write out bundle refs based on the tips already
335 * parsed into revs.pending. As a side effect, may
336 * manipulate revs.pending to include additional
337 * necessary objects (like tags).
339 * Returns the number of refs written, or negative
340 * on error.
342 static int write_bundle_refs(int bundle_fd, struct rev_info *revs)
344 int i;
345 int ref_count = 0;
347 for (i = 0; i < revs->pending.nr; i++) {
348 struct object_array_entry *e = revs->pending.objects + i;
349 struct object_id oid;
350 char *ref;
351 const char *display_ref;
352 int flag;
354 if (e->item->flags & UNINTERESTING)
355 continue;
356 if (dwim_ref(e->name, strlen(e->name), &oid, &ref) != 1)
357 goto skip_write_ref;
358 if (read_ref_full(e->name, RESOLVE_REF_READING, &oid, &flag))
359 flag = 0;
360 display_ref = (flag & REF_ISSYMREF) ? e->name : ref;
362 if (e->item->type == OBJ_TAG &&
363 !is_tag_in_date_range(e->item, revs)) {
364 e->item->flags |= UNINTERESTING;
365 goto skip_write_ref;
369 * Make sure the refs we wrote out is correct; --max-count and
370 * other limiting options could have prevented all the tips
371 * from getting output.
373 * Non commit objects such as tags and blobs do not have
374 * this issue as they are not affected by those extra
375 * constraints.
377 if (!(e->item->flags & SHOWN) && e->item->type == OBJ_COMMIT) {
378 warning(_("ref '%s' is excluded by the rev-list options"),
379 e->name);
380 goto skip_write_ref;
383 * If you run "git bundle create bndl v1.0..v2.0", the
384 * name of the positive ref is "v2.0" but that is the
385 * commit that is referenced by the tag, and not the tag
386 * itself.
388 if (!oideq(&oid, &e->item->oid)) {
390 * Is this the positive end of a range expressed
391 * in terms of a tag (e.g. v2.0 from the range
392 * "v1.0..v2.0")?
394 struct commit *one = lookup_commit_reference(revs->repo, &oid);
395 struct object *obj;
397 if (e->item == &(one->object)) {
399 * Need to include e->name as an
400 * independent ref to the pack-objects
401 * input, so that the tag is included
402 * in the output; otherwise we would
403 * end up triggering "empty bundle"
404 * error.
406 obj = parse_object_or_die(&oid, e->name);
407 obj->flags |= SHOWN;
408 add_pending_object(revs, obj, e->name);
410 goto skip_write_ref;
413 ref_count++;
414 write_or_die(bundle_fd, oid_to_hex(&e->item->oid), 40);
415 write_or_die(bundle_fd, " ", 1);
416 write_or_die(bundle_fd, display_ref, strlen(display_ref));
417 write_or_die(bundle_fd, "\n", 1);
418 skip_write_ref:
419 free(ref);
422 /* end header */
423 write_or_die(bundle_fd, "\n", 1);
424 return ref_count;
427 int create_bundle(struct repository *r, const char *path,
428 int argc, const char **argv)
430 struct lock_file lock = LOCK_INIT;
431 int bundle_fd = -1;
432 int bundle_to_stdout;
433 int ref_count = 0;
434 struct rev_info revs;
436 bundle_to_stdout = !strcmp(path, "-");
437 if (bundle_to_stdout)
438 bundle_fd = 1;
439 else
440 bundle_fd = hold_lock_file_for_update(&lock, path,
441 LOCK_DIE_ON_ERROR);
443 /* write signature */
444 write_or_die(bundle_fd, bundle_signature, strlen(bundle_signature));
446 /* init revs to list objects for pack-objects later */
447 save_commit_buffer = 0;
448 repo_init_revisions(r, &revs, NULL);
450 /* write prerequisites */
451 if (compute_and_write_prerequisites(bundle_fd, &revs, argc, argv))
452 goto err;
454 argc = setup_revisions(argc, argv, &revs, NULL);
456 if (argc > 1) {
457 error(_("unrecognized argument: %s"), argv[1]);
458 goto err;
461 object_array_remove_duplicates(&revs.pending);
463 ref_count = write_bundle_refs(bundle_fd, &revs);
464 if (!ref_count)
465 die(_("Refusing to create empty bundle."));
466 else if (ref_count < 0)
467 goto err;
469 /* write pack */
470 if (write_pack_data(bundle_fd, &revs))
471 goto err;
473 if (!bundle_to_stdout) {
474 if (commit_lock_file(&lock))
475 die_errno(_("cannot create '%s'"), path);
477 return 0;
478 err:
479 rollback_lock_file(&lock);
480 return -1;
483 int unbundle(struct repository *r, struct bundle_header *header,
484 int bundle_fd, int flags)
486 const char *argv_index_pack[] = {"index-pack",
487 "--fix-thin", "--stdin", NULL, NULL};
488 struct child_process ip = CHILD_PROCESS_INIT;
490 if (flags & BUNDLE_VERBOSE)
491 argv_index_pack[3] = "-v";
493 if (verify_bundle(r, header, 0))
494 return -1;
495 ip.argv = argv_index_pack;
496 ip.in = bundle_fd;
497 ip.no_stdout = 1;
498 ip.git_cmd = 1;
499 if (run_command(&ip))
500 return error(_("index-pack died"));
501 return 0;