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