Merge branch 'jn/bisect-coding-style'
[git] / bundle.c
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"
10 #include "argv-array.h"
11
12 static const char bundle_signature[] = "# v2 git bundle\n";
13
14 static void add_to_ref_list(const unsigned char *sha1, const char *name,
15                 struct ref_list *list)
16 {
17         if (list->nr + 1 >= list->alloc) {
18                 list->alloc = alloc_nr(list->nr + 1);
19                 list->list = xrealloc(list->list,
20                                 list->alloc * sizeof(list->list[0]));
21         }
22         memcpy(list->list[list->nr].sha1, sha1, 20);
23         list->list[list->nr].name = xstrdup(name);
24         list->nr++;
25 }
26
27 static int parse_bundle_header(int fd, struct bundle_header *header,
28                                const char *report_path)
29 {
30         struct strbuf buf = STRBUF_INIT;
31         int status = 0;
32
33         /* The bundle header begins with the signature */
34         if (strbuf_getwholeline_fd(&buf, fd, '\n') ||
35             strcmp(buf.buf, bundle_signature)) {
36                 if (report_path)
37                         error(_("'%s' does not look like a v2 bundle file"),
38                               report_path);
39                 status = -1;
40                 goto abort;
41         }
42
43         /* The bundle header ends with an empty line */
44         while (!strbuf_getwholeline_fd(&buf, fd, '\n') &&
45                buf.len && buf.buf[0] != '\n') {
46                 unsigned char sha1[20];
47                 int is_prereq = 0;
48
49                 if (*buf.buf == '-') {
50                         is_prereq = 1;
51                         strbuf_remove(&buf, 0, 1);
52                 }
53                 strbuf_rtrim(&buf);
54
55                 /*
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 (get_sha1_hex(buf.buf, sha1) ||
61                     (buf.len > 40 && !isspace(buf.buf[40])) ||
62                     (!is_prereq && buf.len <= 40)) {
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(sha1, "", &header->prerequisites);
71                         else
72                                 add_to_ref_list(sha1, buf.buf + 41, &header->references);
73                 }
74         }
75
76  abort:
77         if (status) {
78                 close(fd);
79                 fd = -1;
80         }
81         strbuf_release(&buf);
82         return fd;
83 }
84
85 int read_bundle_header(const char *path, struct bundle_header *header)
86 {
87         int fd = open(path, O_RDONLY);
88
89         if (fd < 0)
90                 return error(_("could not open '%s'"), path);
91         return parse_bundle_header(fd, header, path);
92 }
93
94 int is_bundle(const char *path, int quiet)
95 {
96         struct bundle_header header;
97         int fd = open(path, O_RDONLY);
98
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);
106 }
107
108 static int list_refs(struct ref_list *r, int argc, const char **argv)
109 {
110         int i;
111
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;
120                 }
121                 printf("%s %s\n", sha1_to_hex(r->list[i].sha1),
122                                 r->list[i].name);
123         }
124         return 0;
125 }
126
127 #define PREREQ_MARK (1u<<16)
128
129 int verify_bundle(struct bundle_header *header, int verbose)
130 {
131         /*
132          * Do fast check, then if any prereqs are missing then go line by line
133          * to be verbose about the errors
134          */
135         struct ref_list *p = &header->prerequisites;
136         struct rev_info revs;
137         const char *argv[] = {NULL, "--all", NULL};
138         struct object_array refs;
139         struct commit *commit;
140         int i, ret = 0, req_nr;
141         const char *message = _("Repository lacks these prerequisite commits:");
142
143         init_revisions(&revs, NULL);
144         for (i = 0; i < p->nr; i++) {
145                 struct ref_list_entry *e = p->list + i;
146                 struct object *o = parse_object(e->sha1);
147                 if (o) {
148                         o->flags |= PREREQ_MARK;
149                         add_pending_object(&revs, o, e->name);
150                         continue;
151                 }
152                 if (++ret == 1)
153                         error("%s", message);
154                 error("%s %s", sha1_to_hex(e->sha1), e->name);
155         }
156         if (revs.pending.nr != p->nr)
157                 return ret;
158         req_nr = revs.pending.nr;
159         setup_revisions(2, argv, &revs, NULL);
160
161         refs = revs.pending;
162         revs.leak_pending = 1;
163
164         if (prepare_revision_walk(&revs))
165                 die(_("revision walk setup failed"));
166
167         i = req_nr;
168         while (i && (commit = get_revision(&revs)))
169                 if (commit->object.flags & PREREQ_MARK)
170                         i--;
171
172         for (i = 0; i < req_nr; i++)
173                 if (!(refs.objects[i].item->flags & SHOWN)) {
174                         if (++ret == 1)
175                                 error("%s", message);
176                         error("%s %s", sha1_to_hex(refs.objects[i].item->sha1),
177                                 refs.objects[i].name);
178                 }
179
180         clear_commit_marks_for_object_array(&refs, ALL_REV_FLAGS);
181         free(refs.objects);
182
183         if (verbose) {
184                 struct ref_list *r;
185
186                 r = &header->references;
187                 printf_ln(Q_("The bundle contains this ref:",
188                              "The bundle contains these %d refs:",
189                              r->nr),
190                           r->nr);
191                 list_refs(r, 0, NULL);
192                 r = &header->prerequisites;
193                 if (!r->nr) {
194                         printf_ln(_("The bundle records a complete history."));
195                 } else {
196                         printf_ln(Q_("The bundle requires this ref:",
197                                      "The bundle requires these %d refs:",
198                                      r->nr),
199                                   r->nr);
200                         list_refs(r, 0, NULL);
201                 }
202         }
203         return ret;
204 }
205
206 int list_bundle_refs(struct bundle_header *header, int argc, const char **argv)
207 {
208         return list_refs(&header->references, argc, argv);
209 }
210
211 static int is_tag_in_date_range(struct object *tag, struct rev_info *revs)
212 {
213         unsigned long size;
214         enum object_type type;
215         char *buf, *line, *lineend;
216         unsigned long date;
217
218         if (revs->max_age == -1 && revs->min_age == -1)
219                 return 1;
220
221         buf = read_sha1_file(tag->sha1, &type, &size);
222         if (!buf)
223                 return 1;
224         line = memmem(buf, size, "\ntagger ", 8);
225         if (!line++)
226                 return 1;
227         lineend = memchr(line, buf + size - line, '\n');
228         line = memchr(line, lineend ? lineend - line : buf + size - line, '>');
229         if (!line++)
230                 return 1;
231         date = strtoul(line, NULL, 10);
232         free(buf);
233         return (revs->max_age == -1 || revs->max_age < date) &&
234                 (revs->min_age == -1 || revs->min_age > date);
235 }
236
237 int create_bundle(struct bundle_header *header, const char *path,
238                   int argc, const char **argv)
239 {
240         static struct lock_file lock;
241         int bundle_fd = -1;
242         int bundle_to_stdout;
243         struct argv_array argv_boundary = ARGV_ARRAY_INIT;
244         struct argv_array argv_pack = ARGV_ARRAY_INIT;
245         int i, ref_count = 0;
246         struct strbuf buf = STRBUF_INIT;
247         struct rev_info revs;
248         struct child_process rls;
249         FILE *rls_fout;
250
251         bundle_to_stdout = !strcmp(path, "-");
252         if (bundle_to_stdout)
253                 bundle_fd = 1;
254         else
255                 bundle_fd = hold_lock_file_for_update(&lock, path,
256                                                       LOCK_DIE_ON_ERROR);
257
258         /* write signature */
259         write_or_die(bundle_fd, bundle_signature, strlen(bundle_signature));
260
261         /* init revs to list objects for pack-objects later */
262         save_commit_buffer = 0;
263         init_revisions(&revs, NULL);
264
265         /* write prerequisites */
266         argv_array_pushl(&argv_boundary,
267                          "rev-list", "--boundary", "--pretty=oneline",
268                          NULL);
269         for (i = 1; i < argc; i++)
270                 argv_array_push(&argv_boundary, argv[i]);
271
272         memset(&rls, 0, sizeof(rls));
273         rls.argv = argv_boundary.argv;
274         rls.out = -1;
275         rls.git_cmd = 1;
276         if (start_command(&rls))
277                 return -1;
278         rls_fout = xfdopen(rls.out, "r");
279         while (strbuf_getwholeline(&buf, rls_fout, '\n') != EOF) {
280                 unsigned char sha1[20];
281                 if (buf.len > 0 && buf.buf[0] == '-') {
282                         write_or_die(bundle_fd, buf.buf, buf.len);
283                         if (!get_sha1_hex(buf.buf + 1, sha1)) {
284                                 struct object *object = parse_object_or_die(sha1, buf.buf);
285                                 object->flags |= UNINTERESTING;
286                                 add_pending_object(&revs, object, buf.buf);
287                         }
288                 } else if (!get_sha1_hex(buf.buf, sha1)) {
289                         struct object *object = parse_object_or_die(sha1, buf.buf);
290                         object->flags |= SHOWN;
291                 }
292         }
293         strbuf_release(&buf);
294         fclose(rls_fout);
295         if (finish_command(&rls))
296                 return error(_("rev-list died"));
297
298         /* write references */
299         argc = setup_revisions(argc, argv, &revs, NULL);
300
301         if (argc > 1)
302                 return error(_("unrecognized argument: %s"), argv[1]);
303
304         object_array_remove_duplicates(&revs.pending);
305
306         for (i = 0; i < revs.pending.nr; i++) {
307                 struct object_array_entry *e = revs.pending.objects + i;
308                 unsigned char sha1[20];
309                 char *ref;
310                 const char *display_ref;
311                 int flag;
312
313                 if (e->item->flags & UNINTERESTING)
314                         continue;
315                 if (dwim_ref(e->name, strlen(e->name), sha1, &ref) != 1)
316                         continue;
317                 if (read_ref_full(e->name, sha1, 1, &flag))
318                         flag = 0;
319                 display_ref = (flag & REF_ISSYMREF) ? e->name : ref;
320
321                 if (e->item->type == OBJ_TAG &&
322                                 !is_tag_in_date_range(e->item, &revs)) {
323                         e->item->flags |= UNINTERESTING;
324                         continue;
325                 }
326
327                 /*
328                  * Make sure the refs we wrote out is correct; --max-count and
329                  * other limiting options could have prevented all the tips
330                  * from getting output.
331                  *
332                  * Non commit objects such as tags and blobs do not have
333                  * this issue as they are not affected by those extra
334                  * constraints.
335                  */
336                 if (!(e->item->flags & SHOWN) && e->item->type == OBJ_COMMIT) {
337                         warning(_("ref '%s' is excluded by the rev-list options"),
338                                 e->name);
339                         free(ref);
340                         continue;
341                 }
342                 /*
343                  * If you run "git bundle create bndl v1.0..v2.0", the
344                  * name of the positive ref is "v2.0" but that is the
345                  * commit that is referenced by the tag, and not the tag
346                  * itself.
347                  */
348                 if (hashcmp(sha1, e->item->sha1)) {
349                         /*
350                          * Is this the positive end of a range expressed
351                          * in terms of a tag (e.g. v2.0 from the range
352                          * "v1.0..v2.0")?
353                          */
354                         struct commit *one = lookup_commit_reference(sha1);
355                         struct object *obj;
356
357                         if (e->item == &(one->object)) {
358                                 /*
359                                  * Need to include e->name as an
360                                  * independent ref to the pack-objects
361                                  * input, so that the tag is included
362                                  * in the output; otherwise we would
363                                  * end up triggering "empty bundle"
364                                  * error.
365                                  */
366                                 obj = parse_object_or_die(sha1, e->name);
367                                 obj->flags |= SHOWN;
368                                 add_pending_object(&revs, obj, e->name);
369                         }
370                         free(ref);
371                         continue;
372                 }
373
374                 ref_count++;
375                 write_or_die(bundle_fd, sha1_to_hex(e->item->sha1), 40);
376                 write_or_die(bundle_fd, " ", 1);
377                 write_or_die(bundle_fd, display_ref, strlen(display_ref));
378                 write_or_die(bundle_fd, "\n", 1);
379                 free(ref);
380         }
381         if (!ref_count)
382                 die(_("Refusing to create empty bundle."));
383
384         /* end header */
385         write_or_die(bundle_fd, "\n", 1);
386
387         /* write pack */
388         argv_array_pushl(&argv_pack,
389                          "pack-objects", "--all-progress-implied",
390                          "--stdout", "--thin", "--delta-base-offset",
391                          NULL);
392         memset(&rls, 0, sizeof(rls));
393         rls.argv = argv_pack.argv;
394         rls.in = -1;
395         rls.out = bundle_fd;
396         rls.git_cmd = 1;
397         if (start_command(&rls))
398                 return error(_("Could not spawn pack-objects"));
399
400         /*
401          * start_command closed bundle_fd if it was > 1
402          * so set the lock fd to -1 so commit_lock_file()
403          * won't fail trying to close it.
404          */
405         lock.fd = -1;
406
407         for (i = 0; i < revs.pending.nr; i++) {
408                 struct object *object = revs.pending.objects[i].item;
409                 if (object->flags & UNINTERESTING)
410                         write_or_die(rls.in, "^", 1);
411                 write_or_die(rls.in, sha1_to_hex(object->sha1), 40);
412                 write_or_die(rls.in, "\n", 1);
413         }
414         close(rls.in);
415         if (finish_command(&rls))
416                 return error(_("pack-objects died"));
417         if (!bundle_to_stdout) {
418                 if (commit_lock_file(&lock))
419                         die_errno(_("cannot create '%s'"), path);
420         }
421         return 0;
422 }
423
424 int unbundle(struct bundle_header *header, int bundle_fd, int flags)
425 {
426         const char *argv_index_pack[] = {"index-pack",
427                                          "--fix-thin", "--stdin", NULL, NULL};
428         struct child_process ip;
429
430         if (flags & BUNDLE_VERBOSE)
431                 argv_index_pack[3] = "-v";
432
433         if (verify_bundle(header, 0))
434                 return -1;
435         memset(&ip, 0, sizeof(ip));
436         ip.argv = argv_index_pack;
437         ip.in = bundle_fd;
438         ip.no_stdout = 1;
439         ip.git_cmd = 1;
440         if (run_command(&ip))
441                 return error(_("index-pack died"));
442         return 0;
443 }