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