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"
14static const char bundle_signature[] = "# v2 git bundle\n";
16static void add_to_ref_list(const struct object_id *oid, const char *name,
18 struct ref_list *list)
19{
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++;
24}
25static int parse_bundle_header(int fd, struct bundle_header *header,
27 const char *report_path)
28{
29 struct strbuf buf = STRBUF_INIT;
30 int status = 0;
31 /* 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;
40 }
41 /* 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;
48 if (*buf.buf == '-') {
50 is_prereq = 1;
51 strbuf_remove(&buf, 0, 1);
52 }
53 strbuf_rtrim(&buf);
54 /*
56 * Tip lines have object name, SP, and refname.
57 * Prerequisites have object name that is optionally
58 * followed by SP and subject line.
59 */
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);
73 }
74 }
75 abort:
77 if (status) {
78 close(fd);
79 fd = -1;
80 }
81 strbuf_release(&buf);
82 return fd;
83}
84int read_bundle_header(const char *path, struct bundle_header *header)
86{
87 int fd = open(path, O_RDONLY);
88 if (fd < 0)
90 return error(_("could not open '%s'"), path);
91 return parse_bundle_header(fd, header, path);
92}
93int is_bundle(const char *path, int quiet)
95{
96 struct bundle_header header;
97 int fd = open(path, O_RDONLY);
98 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);
106}
107static int list_refs(struct ref_list *r, int argc, const char **argv)
109{
110 int i;
111 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;
120 }
121 printf("%s %s\n", oid_to_hex(&r->list[i].oid),
122 r->list[i].name);
123 }
124 return 0;
125}
126/* Remember to update object flag allocation in object.h */
128#define PREREQ_MARK (1u<<16)
129int verify_bundle(struct repository *r,
131 struct bundle_header *header,
132 int verbose)
133{
134 /*
135 * Do fast check, then if any prereqs are missing then go line by line
136 * to be verbose about the errors
137 */
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:");
144 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;
153 }
154 if (++ret == 1)
155 error("%s", message);
156 error("%s %s", oid_to_hex(&e->oid), e->name);
157 }
158 if (revs.pending.nr != p->nr)
159 return ret;
160 req_nr = revs.pending.nr;
161 setup_revisions(2, argv, &revs, NULL);
162 if (prepare_revision_walk(&revs))
164 die(_("revision walk setup failed"));
165 i = req_nr;
167 while (i && (commit = get_revision(&revs)))
168 if (commit->object.flags & PREREQ_MARK)
169 i--;
170 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);
180 }
181 /* 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);
188 }
189 if (verbose) {
191 struct ref_list *r;
192 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);
208 }
209 }
210 return ret;
211}
212int list_bundle_refs(struct bundle_header *header, int argc, const char **argv)
214{
215 return list_refs(&header->references, argc, argv);
216}
217static int is_tag_in_date_range(struct object *tag, struct rev_info *revs)
219{
220 unsigned long size;
221 enum object_type type;
222 char *buf = NULL, *line, *lineend;
223 timestamp_t date;
224 int result = 1;
225 if (revs->max_age == -1 && revs->min_age == -1)
227 goto out;
228 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);
242out:
243 free(buf);
244 return result;
245}
246/* Write the pack data to bundle_fd, then close it if it is > 1. */
249static int write_pack_data(int bundle_fd, struct rev_info *revs)
250{
251 struct child_process pack_objects = CHILD_PROCESS_INIT;
252 int i;
253 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;
261 if (start_command(&pack_objects))
262 return error(_("Could not spawn pack-objects"));
263 for (i = 0; i < revs->pending.nr; i++) {
265 struct object *object = revs->pending.objects[i].item;
266 if (object->flags & UNINTERESTING)
267 write_or_die(pack_objects.in, "^", 1);
268 write_or_die(pack_objects.in, oid_to_hex(&object->oid), GIT_SHA1_HEXSZ);
269 write_or_die(pack_objects.in, "\n", 1);
270 }
271 close(pack_objects.in);
272 if (finish_command(&pack_objects))
273 return error(_("pack-objects died"));
274 return 0;
275}
276static int compute_and_write_prerequisites(int bundle_fd,
278 struct rev_info *revs,
279 int argc, const char **argv)
280{
281 struct child_process rls = CHILD_PROCESS_INIT;
282 struct strbuf buf = STRBUF_INIT;
283 FILE *rls_fout;
284 int i;
285 argv_array_pushl(&rls.args,
287 "rev-list", "--boundary", "--pretty=oneline",
288 NULL);
289 for (i = 1; i < argc; i++)
290 argv_array_push(&rls.args, argv[i]);
291 rls.out = -1;
292 rls.git_cmd = 1;
293 if (start_command(&rls))
294 return -1;
295 rls_fout = xfdopen(rls.out, "r");
296 while (strbuf_getwholeline(&buf, rls_fout, '\n') != EOF) {
297 struct object_id oid;
298 if (buf.len > 0 && buf.buf[0] == '-') {
299 write_or_die(bundle_fd, buf.buf, buf.len);
300 if (!get_oid_hex(buf.buf + 1, &oid)) {
301 struct object *object = parse_object_or_die(&oid,
302 buf.buf);
303 object->flags |= UNINTERESTING;
304 add_pending_object(revs, object, buf.buf);
305 }
306 } else if (!get_oid_hex(buf.buf, &oid)) {
307 struct object *object = parse_object_or_die(&oid,
308 buf.buf);
309 object->flags |= SHOWN;
310 }
311 }
312 strbuf_release(&buf);
313 fclose(rls_fout);
314 if (finish_command(&rls))
315 return error(_("rev-list died"));
316 return 0;
317}
318/*
320 * Write out bundle refs based on the tips already
321 * parsed into revs.pending. As a side effect, may
322 * manipulate revs.pending to include additional
323 * necessary objects (like tags).
324 *
325 * Returns the number of refs written, or negative
326 * on error.
327 */
328static int write_bundle_refs(int bundle_fd, struct rev_info *revs)
329{
330 int i;
331 int ref_count = 0;
332 for (i = 0; i < revs->pending.nr; i++) {
334 struct object_array_entry *e = revs->pending.objects + i;
335 struct object_id oid;
336 char *ref;
337 const char *display_ref;
338 int flag;
339 if (e->item->flags & UNINTERESTING)
341 continue;
342 if (dwim_ref(e->name, strlen(e->name), &oid, &ref) != 1)
343 goto skip_write_ref;
344 if (read_ref_full(e->name, RESOLVE_REF_READING, &oid, &flag))
345 flag = 0;
346 display_ref = (flag & REF_ISSYMREF) ? e->name : ref;
347 if (e->item->type == OBJ_TAG &&
349 !is_tag_in_date_range(e->item, revs)) {
350 e->item->flags |= UNINTERESTING;
351 goto skip_write_ref;
352 }
353 /*
355 * Make sure the refs we wrote out is correct; --max-count and
356 * other limiting options could have prevented all the tips
357 * from getting output.
358 *
359 * Non commit objects such as tags and blobs do not have
360 * this issue as they are not affected by those extra
361 * constraints.
362 */
363 if (!(e->item->flags & SHOWN) && e->item->type == OBJ_COMMIT) {
364 warning(_("ref '%s' is excluded by the rev-list options"),
365 e->name);
366 goto skip_write_ref;
367 }
368 /*
369 * If you run "git bundle create bndl v1.0..v2.0", the
370 * name of the positive ref is "v2.0" but that is the
371 * commit that is referenced by the tag, and not the tag
372 * itself.
373 */
374 if (!oideq(&oid, &e->item->oid)) {
375 /*
376 * Is this the positive end of a range expressed
377 * in terms of a tag (e.g. v2.0 from the range
378 * "v1.0..v2.0")?
379 */
380 struct commit *one = lookup_commit_reference(revs->repo, &oid);
381 struct object *obj;
382 if (e->item == &(one->object)) {
384 /*
385 * Need to include e->name as an
386 * independent ref to the pack-objects
387 * input, so that the tag is included
388 * in the output; otherwise we would
389 * end up triggering "empty bundle"
390 * error.
391 */
392 obj = parse_object_or_die(&oid, e->name);
393 obj->flags |= SHOWN;
394 add_pending_object(revs, obj, e->name);
395 }
396 goto skip_write_ref;
397 }
398 ref_count++;
400 write_or_die(bundle_fd, oid_to_hex(&e->item->oid), 40);
401 write_or_die(bundle_fd, " ", 1);
402 write_or_die(bundle_fd, display_ref, strlen(display_ref));
403 write_or_die(bundle_fd, "\n", 1);
404 skip_write_ref:
405 free(ref);
406 }
407 /* end header */
409 write_or_die(bundle_fd, "\n", 1);
410 return ref_count;
411}
412int create_bundle(struct repository *r, struct bundle_header *header,
414 const char *path, int argc, const char **argv)
415{
416 struct lock_file lock = LOCK_INIT;
417 int bundle_fd = -1;
418 int bundle_to_stdout;
419 int ref_count = 0;
420 struct rev_info revs;
421 bundle_to_stdout = !strcmp(path, "-");
423 if (bundle_to_stdout)
424 bundle_fd = 1;
425 else {
426 bundle_fd = hold_lock_file_for_update(&lock, path,
427 LOCK_DIE_ON_ERROR);
428 /*
430 * write_pack_data() will close the fd passed to it,
431 * but commit_lock_file() will also try to close the
432 * lockfile's fd. So make a copy of the file
433 * descriptor to avoid trying to close it twice.
434 */
435 bundle_fd = dup(bundle_fd);
436 if (bundle_fd < 0)
437 die_errno("unable to dup file descriptor");
438 }
439 /* write signature */
441 write_or_die(bundle_fd, bundle_signature, strlen(bundle_signature));
442 /* init revs to list objects for pack-objects later */
444 save_commit_buffer = 0;
445 repo_init_revisions(r, &revs, NULL);
446 /* write prerequisites */
448 if (compute_and_write_prerequisites(bundle_fd, &revs, argc, argv))
449 goto err;
450 argc = setup_revisions(argc, argv, &revs, NULL);
452 if (argc > 1) {
454 error(_("unrecognized argument: %s"), argv[1]);
455 goto err;
456 }
457 object_array_remove_duplicates(&revs.pending);
459 ref_count = write_bundle_refs(bundle_fd, &revs);
461 if (!ref_count)
462 die(_("Refusing to create empty bundle."));
463 else if (ref_count < 0)
464 goto err;
465 /* write pack */
467 if (write_pack_data(bundle_fd, &revs)) {
468 bundle_fd = -1; /* already closed by the above call */
469 goto err;
470 }
471 if (!bundle_to_stdout) {
473 if (commit_lock_file(&lock))
474 die_errno(_("cannot create '%s'"), path);
475 }
476 return 0;
477err:
478 if (!bundle_to_stdout) {
479 if (0 <= bundle_fd)
480 close(bundle_fd);
481 rollback_lock_file(&lock);
482 }
483 return -1;
484}
485int unbundle(struct repository *r, struct bundle_header *header,
487 int bundle_fd, int flags)
488{
489 const char *argv_index_pack[] = {"index-pack",
490 "--fix-thin", "--stdin", NULL, NULL};
491 struct child_process ip = CHILD_PROCESS_INIT;
492 if (flags & BUNDLE_VERBOSE)
494 argv_index_pack[3] = "-v";
495 if (verify_bundle(r, header, 0))
497 return -1;
498 ip.argv = argv_index_pack;
499 ip.in = bundle_fd;
500 ip.no_stdout = 1;
501 ip.git_cmd = 1;
502 if (run_command(&ip))
503 return error(_("index-pack died"));
504 return 0;
505}