bundle.c

   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 "strvec.h"
  14 #include "list-objects-filter-options.h"
  15
  16 static const char v2_bundle_signature[] = "# v2 git bundle\n";
  17 static const char v3_bundle_signature[] = "# v3 git bundle\n";
  18 static struct {
  19         int version;
  20         const char *signature;
  21 } bundle_sigs[] = {
  22         { 2, v2_bundle_signature },
  23         { 3, v3_bundle_signature },
  24 };
  25
  26 void bundle_header_init(struct bundle_header *header)
  27 {
  28         struct bundle_header blank = BUNDLE_HEADER_INIT;
  29         memcpy(header, &blank, sizeof(*header));
  30 }
  31
  32 void bundle_header_release(struct bundle_header *header)
  33 {
  34         string_list_clear(&header->prerequisites, 1);
  35         string_list_clear(&header->references, 1);
  36         list_objects_filter_release(&header->filter);
  37 }
  38
  39 static int parse_capability(struct bundle_header *header, const char *capability)
  40 {
  41         const char *arg;
  42         if (skip_prefix(capability, "object-format=", &arg)) {
  43                 int algo = hash_algo_by_name(arg);
  44                 if (algo == GIT_HASH_UNKNOWN)
  45                         return error(_("unrecognized bundle hash algorithm: %s"), arg);
  46                 header->hash_algo = &hash_algos[algo];
  47                 return 0;
  48         }
  49         if (skip_prefix(capability, "filter=", &arg)) {
  50                 parse_list_objects_filter(&header->filter, arg);
  51                 return 0;
  52         }
  53         return error(_("unknown capability '%s'"), capability);
  54 }
  55
  56 static int parse_bundle_signature(struct bundle_header *header, const char *line)
  57 {
  58         int i;
  59
  60         for (i = 0; i < ARRAY_SIZE(bundle_sigs); i++) {
  61                 if (!strcmp(line, bundle_sigs[i].signature)) {
  62                         header->version = bundle_sigs[i].version;
  63                         return 0;
  64                 }
  65         }
  66         return -1;
  67 }
  68
  69 static int parse_bundle_header(int fd, struct bundle_header *header,
  70                                const char *report_path)
  71 {
  72         struct strbuf buf = STRBUF_INIT;
  73         int status = 0;
  74
  75         /* The bundle header begins with the signature */
  76         if (strbuf_getwholeline_fd(&buf, fd, '\n') ||
  77             parse_bundle_signature(header, buf.buf)) {
  78                 if (report_path)
  79                         error(_("'%s' does not look like a v2 or v3 bundle file"),
  80                               report_path);
  81                 status = -1;
  82                 goto abort;
  83         }
  84
  85         header->hash_algo = the_hash_algo;
  86
  87         /* The bundle header ends with an empty line */
  88         while (!strbuf_getwholeline_fd(&buf, fd, '\n') &&
  89                buf.len && buf.buf[0] != '\n') {
  90                 struct object_id oid;
  91                 int is_prereq = 0;
  92                 const char *p;
  93
  94                 strbuf_rtrim(&buf);
  95
  96                 if (header->version == 3 && *buf.buf == '@') {
  97                         if (parse_capability(header, buf.buf + 1)) {
  98                                 status = -1;
  99                                 break;
 100                         }
 101                         continue;
 102                 }
 103
 104                 if (*buf.buf == '-') {
 105                         is_prereq = 1;
 106                         strbuf_remove(&buf, 0, 1);
 107                 }
 108
 109                 /*
 110                  * Tip lines have object name, SP, and refname.
 111                  * Prerequisites have object name that is optionally
 112                  * followed by SP and subject line.
 113                  */
 114                 if (parse_oid_hex_algop(buf.buf, &oid, &p, header->hash_algo) ||
 115                     (*p && !isspace(*p)) ||
 116                     (!is_prereq && !*p)) {
 117                         if (report_path)
 118                                 error(_("unrecognized header: %s%s (%d)"),
 119                                       (is_prereq ? "-" : ""), buf.buf, (int)buf.len);
 120                         status = -1;
 121                         break;
 122                 } else {
 123                         struct object_id *dup = oiddup(&oid);
 124                         if (is_prereq)
 125                                 string_list_append(&header->prerequisites, "")->util = dup;
 126                         else
 127                                 string_list_append(&header->references, p + 1)->util = dup;
 128                 }
 129         }
 130
 131  abort:
 132         if (status) {
 133                 close(fd);
 134                 fd = -1;
 135         }
 136         strbuf_release(&buf);
 137         return fd;
 138 }
 139
 140 int read_bundle_header(const char *path, struct bundle_header *header)
 141 {
 142         int fd = open(path, O_RDONLY);
 143
 144         if (fd < 0)
 145                 return error(_("could not open '%s'"), path);
 146         return parse_bundle_header(fd, header, path);
 147 }
 148
 149 int is_bundle(const char *path, int quiet)
 150 {
 151         struct bundle_header header = BUNDLE_HEADER_INIT;
 152         int fd = open(path, O_RDONLY);
 153
 154         if (fd < 0)
 155                 return 0;
 156         fd = parse_bundle_header(fd, &header, quiet ? NULL : path);
 157         if (fd >= 0)
 158                 close(fd);
 159         bundle_header_release(&header);
 160         return (fd >= 0);
 161 }
 162
 163 static int list_refs(struct string_list *r, int argc, const char **argv)
 164 {
 165         int i;
 166
 167         for (i = 0; i < r->nr; i++) {
 168                 struct object_id *oid;
 169                 const char *name;
 170
 171                 if (argc > 1) {
 172                         int j;
 173                         for (j = 1; j < argc; j++)
 174                                 if (!strcmp(r->items[i].string, argv[j]))
 175                                         break;
 176                         if (j == argc)
 177                                 continue;
 178                 }
 179
 180                 oid = r->items[i].util;
 181                 name = r->items[i].string;
 182                 printf("%s %s\n", oid_to_hex(oid), name);
 183         }
 184         return 0;
 185 }
 186
 187 /* Remember to update object flag allocation in object.h */
 188 #define PREREQ_MARK (1u<<16)
 189
 190 int verify_bundle(struct repository *r,
 191                   struct bundle_header *header,
 192                   int verbose)
 193 {
 194         /*
 195          * Do fast check, then if any prereqs are missing then go line by line
 196          * to be verbose about the errors
 197          */
 198         struct string_list *p = &header->prerequisites;
 199         struct rev_info revs;
 200         const char *argv[] = {NULL, "--all", NULL};
 201         struct commit *commit;
 202         int i, ret = 0, req_nr;
 203         const char *message = _("Repository lacks these prerequisite commits:");
 204
 205         if (!r || !r->objects || !r->objects->odb)
 206                 return error(_("need a repository to verify a bundle"));
 207
 208         repo_init_revisions(r, &revs, NULL);
 209         for (i = 0; i < p->nr; i++) {
 210                 struct string_list_item *e = p->items + i;
 211                 const char *name = e->string;
 212                 struct object_id *oid = e->util;
 213                 struct object *o = parse_object(r, oid);
 214                 if (o) {
 215                         o->flags |= PREREQ_MARK;
 216                         add_pending_object(&revs, o, name);
 217                         continue;
 218                 }
 219                 if (++ret == 1)
 220                         error("%s", message);
 221                 error("%s %s", oid_to_hex(oid), name);
 222         }
 223         if (revs.pending.nr != p->nr)
 224                 return ret;
 225         req_nr = revs.pending.nr;
 226         setup_revisions(2, argv, &revs, NULL);
 227
 228         list_objects_filter_copy(&revs.filter, &header->filter);
 229
 230         if (prepare_revision_walk(&revs))
 231                 die(_("revision walk setup failed"));
 232
 233         i = req_nr;
 234         while (i && (commit = get_revision(&revs)))
 235                 if (commit->object.flags & PREREQ_MARK)
 236                         i--;
 237
 238         for (i = 0; i < p->nr; i++) {
 239                 struct string_list_item *e = p->items + i;
 240                 const char *name = e->string;
 241                 const struct object_id *oid = e->util;
 242                 struct object *o = parse_object(r, oid);
 243                 assert(o); /* otherwise we'd have returned early */
 244                 if (o->flags & SHOWN)
 245                         continue;
 246                 if (++ret == 1)
 247                         error("%s", message);
 248                 error("%s %s", oid_to_hex(oid), name);
 249         }
 250
 251         /* Clean up objects used, as they will be reused. */
 252         for (i = 0; i < p->nr; i++) {
 253                 struct string_list_item *e = p->items + i;
 254                 struct object_id *oid = e->util;
 255                 commit = lookup_commit_reference_gently(r, oid, 1);
 256                 if (commit)
 257                         clear_commit_marks(commit, ALL_REV_FLAGS);
 258         }
 259
 260         if (verbose) {
 261                 struct string_list *r;
 262
 263                 r = &header->references;
 264                 printf_ln(Q_("The bundle contains this ref:",
 265                              "The bundle contains these %d refs:",
 266                              r->nr),
 267                           r->nr);
 268                 list_refs(r, 0, NULL);
 269
 270                 if (header->filter.choice) {
 271                         printf_ln("The bundle uses this filter: %s",
 272                                   list_objects_filter_spec(&header->filter));
 273                 }
 274
 275                 r = &header->prerequisites;
 276                 if (!r->nr) {
 277                         printf_ln(_("The bundle records a complete history."));
 278                 } else {
 279                         printf_ln(Q_("The bundle requires this ref:",
 280                                      "The bundle requires these %d refs:",
 281                                      r->nr),
 282                                   r->nr);
 283                         list_refs(r, 0, NULL);
 284                 }
 285         }
 286         return ret;
 287 }
 288
 289 int list_bundle_refs(struct bundle_header *header, int argc, const char **argv)
 290 {
 291         return list_refs(&header->references, argc, argv);
 292 }
 293
 294 static int is_tag_in_date_range(struct object *tag, struct rev_info *revs)
 295 {
 296         unsigned long size;
 297         enum object_type type;
 298         char *buf = NULL, *line, *lineend;
 299         timestamp_t date;
 300         int result = 1;
 301
 302         if (revs->max_age == -1 && revs->min_age == -1)
 303                 goto out;
 304
 305         buf = read_object_file(&tag->oid, &type, &size);
 306         if (!buf)
 307                 goto out;
 308         line = memmem(buf, size, "\ntagger ", 8);
 309         if (!line++)
 310                 goto out;
 311         lineend = memchr(line, '\n', buf + size - line);
 312         line = memchr(line, '>', lineend ? lineend - line : buf + size - line);
 313         if (!line++)
 314                 goto out;
 315         date = parse_timestamp(line, NULL, 10);
 316         result = (revs->max_age == -1 || revs->max_age < date) &&
 317                 (revs->min_age == -1 || revs->min_age > date);
 318 out:
 319         free(buf);
 320         return result;
 321 }
 322
 323
 324 /* Write the pack data to bundle_fd */
 325 static int write_pack_data(int bundle_fd, struct rev_info *revs, struct strvec *pack_options)
 326 {
 327         struct child_process pack_objects = CHILD_PROCESS_INIT;
 328         int i;
 329
 330         strvec_pushl(&pack_objects.args,
 331                      "pack-objects",
 332                      "--stdout", "--thin", "--delta-base-offset",
 333                      NULL);
 334         strvec_pushv(&pack_objects.args, pack_options->v);
 335         if (revs->filter.choice)
 336                 strvec_pushf(&pack_objects.args, "--filter=%s",
 337                              list_objects_filter_spec(&revs->filter));
 338         pack_objects.in = -1;
 339         pack_objects.out = bundle_fd;
 340         pack_objects.git_cmd = 1;
 341
 342         /*
 343          * start_command() will close our descriptor if it's >1. Duplicate it
 344          * to avoid surprising the caller.
 345          */
 346         if (pack_objects.out > 1) {
 347                 pack_objects.out = dup(pack_objects.out);
 348                 if (pack_objects.out < 0) {
 349                         error_errno(_("unable to dup bundle descriptor"));
 350                         child_process_clear(&pack_objects);
 351                         return -1;
 352                 }
 353         }
 354
 355         if (start_command(&pack_objects))
 356                 return error(_("Could not spawn pack-objects"));
 357
 358         for (i = 0; i < revs->pending.nr; i++) {
 359                 struct object *object = revs->pending.objects[i].item;
 360                 if (object->flags & UNINTERESTING)
 361                         write_or_die(pack_objects.in, "^", 1);
 362                 write_or_die(pack_objects.in, oid_to_hex(&object->oid), the_hash_algo->hexsz);
 363                 write_or_die(pack_objects.in, "\n", 1);
 364         }
 365         close(pack_objects.in);
 366         if (finish_command(&pack_objects))
 367                 return error(_("pack-objects died"));
 368         return 0;
 369 }
 370
 371 /*
 372  * Write out bundle refs based on the tips already
 373  * parsed into revs.pending. As a side effect, may
 374  * manipulate revs.pending to include additional
 375  * necessary objects (like tags).
 376  *
 377  * Returns the number of refs written, or negative
 378  * on error.
 379  */
 380 static int write_bundle_refs(int bundle_fd, struct rev_info *revs)
 381 {
 382         int i;
 383         int ref_count = 0;
 384
 385         for (i = 0; i < revs->pending.nr; i++) {
 386                 struct object_array_entry *e = revs->pending.objects + i;
 387                 struct object_id oid;
 388                 char *ref;
 389                 const char *display_ref;
 390                 int flag;
 391
 392                 if (e->item->flags & UNINTERESTING)
 393                         continue;
 394                 if (dwim_ref(e->name, strlen(e->name), &oid, &ref, 0) != 1)
 395                         goto skip_write_ref;
 396                 if (read_ref_full(e->name, RESOLVE_REF_READING, &oid, &flag))
 397                         flag = 0;
 398                 display_ref = (flag & REF_ISSYMREF) ? e->name : ref;
 399
 400                 if (e->item->type == OBJ_TAG &&
 401                                 !is_tag_in_date_range(e->item, revs)) {
 402                         e->item->flags |= UNINTERESTING;
 403                         goto skip_write_ref;
 404                 }
 405
 406                 /*
 407                  * Make sure the refs we wrote out is correct; --max-count and
 408                  * other limiting options could have prevented all the tips
 409                  * from getting output.
 410                  *
 411                  * Non commit objects such as tags and blobs do not have
 412                  * this issue as they are not affected by those extra
 413                  * constraints.
 414                  */
 415                 if (!(e->item->flags & SHOWN) && e->item->type == OBJ_COMMIT) {
 416                         warning(_("ref '%s' is excluded by the rev-list options"),
 417                                 e->name);
 418                         goto skip_write_ref;
 419                 }
 420                 /*
 421                  * If you run "git bundle create bndl v1.0..v2.0", the
 422                  * name of the positive ref is "v2.0" but that is the
 423                  * commit that is referenced by the tag, and not the tag
 424                  * itself.
 425                  */
 426                 if (!oideq(&oid, &e->item->oid)) {
 427                         /*
 428                          * Is this the positive end of a range expressed
 429                          * in terms of a tag (e.g. v2.0 from the range
 430                          * "v1.0..v2.0")?
 431                          */
 432                         struct commit *one = lookup_commit_reference(revs->repo, &oid);
 433                         struct object *obj;
 434
 435                         if (e->item == &(one->object)) {
 436                                 /*
 437                                  * Need to include e->name as an
 438                                  * independent ref to the pack-objects
 439                                  * input, so that the tag is included
 440                                  * in the output; otherwise we would
 441                                  * end up triggering "empty bundle"
 442                                  * error.
 443                                  */
 444                                 obj = parse_object_or_die(&oid, e->name);
 445                                 obj->flags |= SHOWN;
 446                                 add_pending_object(revs, obj, e->name);
 447                         }
 448                         goto skip_write_ref;
 449                 }
 450
 451                 ref_count++;
 452                 write_or_die(bundle_fd, oid_to_hex(&e->item->oid), the_hash_algo->hexsz);
 453                 write_or_die(bundle_fd, " ", 1);
 454                 write_or_die(bundle_fd, display_ref, strlen(display_ref));
 455                 write_or_die(bundle_fd, "\n", 1);
 456  skip_write_ref:
 457                 free(ref);
 458         }
 459
 460         /* end header */
 461         write_or_die(bundle_fd, "\n", 1);
 462         return ref_count;
 463 }
 464
 465 struct bundle_prerequisites_info {
 466         struct object_array *pending;
 467         int fd;
 468 };
 469
 470 static void write_bundle_prerequisites(struct commit *commit, void *data)
 471 {
 472         struct bundle_prerequisites_info *bpi = data;
 473         struct object *object;
 474         struct pretty_print_context ctx = { 0 };
 475         struct strbuf buf = STRBUF_INIT;
 476
 477         if (!(commit->object.flags & BOUNDARY))
 478                 return;
 479         strbuf_addf(&buf, "-%s ", oid_to_hex(&commit->object.oid));
 480         write_or_die(bpi->fd, buf.buf, buf.len);
 481
 482         ctx.fmt = CMIT_FMT_ONELINE;
 483         ctx.output_encoding = get_log_output_encoding();
 484         strbuf_reset(&buf);
 485         pretty_print_commit(&ctx, commit, &buf);
 486         strbuf_trim(&buf);
 487
 488         object = (struct object *)commit;
 489         object->flags |= UNINTERESTING;
 490         add_object_array_with_path(object, buf.buf, bpi->pending, S_IFINVALID,
 491                                    NULL);
 492         strbuf_addch(&buf, '\n');
 493         write_or_die(bpi->fd, buf.buf, buf.len);
 494         strbuf_release(&buf);
 495 }
 496
 497 int create_bundle(struct repository *r, const char *path,
 498                   int argc, const char **argv, struct strvec *pack_options, int version)
 499 {
 500         struct lock_file lock = LOCK_INIT;
 501         int bundle_fd = -1;
 502         int bundle_to_stdout;
 503         int ref_count = 0;
 504         struct rev_info revs, revs_copy;
 505         int min_version = 2;
 506         struct bundle_prerequisites_info bpi;
 507         int i;
 508
 509         /* init revs to list objects for pack-objects later */
 510         save_commit_buffer = 0;
 511         repo_init_revisions(r, &revs, NULL);
 512
 513         /*
 514          * Pre-initialize the '--objects' flag so we can parse a
 515          * --filter option successfully.
 516          */
 517         revs.tree_objects = revs.blob_objects = 1;
 518
 519         argc = setup_revisions(argc, argv, &revs, NULL);
 520
 521         /*
 522          * Reasons to require version 3:
 523          *
 524          * 1. @object-format is required because our hash algorithm is not
 525          *    SHA1.
 526          * 2. @filter is required because we parsed an object filter.
 527          */
 528         if (the_hash_algo != &hash_algos[GIT_HASH_SHA1] || revs.filter.choice)
 529                 min_version = 3;
 530
 531         if (argc > 1) {
 532                 error(_("unrecognized argument: %s"), argv[1]);
 533                 goto err;
 534         }
 535
 536         bundle_to_stdout = !strcmp(path, "-");
 537         if (bundle_to_stdout)
 538                 bundle_fd = 1;
 539         else
 540                 bundle_fd = hold_lock_file_for_update(&lock, path,
 541                                                       LOCK_DIE_ON_ERROR);
 542
 543         if (version == -1)
 544                 version = min_version;
 545
 546         if (version < 2 || version > 3) {
 547                 die(_("unsupported bundle version %d"), version);
 548         } else if (version < min_version) {
 549                 die(_("cannot write bundle version %d with algorithm %s"), version, the_hash_algo->name);
 550         } else if (version == 2) {
 551                 write_or_die(bundle_fd, v2_bundle_signature, strlen(v2_bundle_signature));
 552         } else {
 553                 const char *capability = "@object-format=";
 554                 write_or_die(bundle_fd, v3_bundle_signature, strlen(v3_bundle_signature));
 555                 write_or_die(bundle_fd, capability, strlen(capability));
 556                 write_or_die(bundle_fd, the_hash_algo->name, strlen(the_hash_algo->name));
 557                 write_or_die(bundle_fd, "\n", 1);
 558
 559                 if (revs.filter.choice) {
 560                         const char *value = expand_list_objects_filter_spec(&revs.filter);
 561                         capability = "@filter=";
 562                         write_or_die(bundle_fd, capability, strlen(capability));
 563                         write_or_die(bundle_fd, value, strlen(value));
 564                         write_or_die(bundle_fd, "\n", 1);
 565                 }
 566         }
 567
 568         /* save revs.pending in revs_copy for later use */
 569         memcpy(&revs_copy, &revs, sizeof(revs));
 570         revs_copy.pending.nr = 0;
 571         revs_copy.pending.alloc = 0;
 572         revs_copy.pending.objects = NULL;
 573         for (i = 0; i < revs.pending.nr; i++) {
 574                 struct object_array_entry *e = revs.pending.objects + i;
 575                 if (e)
 576                         add_object_array_with_path(e->item, e->name,
 577                                                    &revs_copy.pending,
 578                                                    e->mode, e->path);
 579         }
 580
 581         /* write prerequisites */
 582         revs.boundary = 1;
 583         if (prepare_revision_walk(&revs))
 584                 die("revision walk setup failed");
 585         bpi.fd = bundle_fd;
 586         bpi.pending = &revs_copy.pending;
 587
 588         /*
 589          * Remove any object walking here. We only care about commits and
 590          * tags here. The revs_copy has the right instances of these values.
 591          */
 592         revs.blob_objects = revs.tree_objects = 0;
 593         traverse_commit_list(&revs, write_bundle_prerequisites, NULL, &bpi);
 594         object_array_remove_duplicates(&revs_copy.pending);
 595
 596         /* write bundle refs */
 597         ref_count = write_bundle_refs(bundle_fd, &revs_copy);
 598         if (!ref_count)
 599                 die(_("Refusing to create empty bundle."));
 600         else if (ref_count < 0)
 601                 goto err;
 602
 603         /* write pack */
 604         if (write_pack_data(bundle_fd, &revs_copy, pack_options))
 605                 goto err;
 606
 607         if (!bundle_to_stdout) {
 608                 if (commit_lock_file(&lock))
 609                         die_errno(_("cannot create '%s'"), path);
 610         }
 611         return 0;
 612 err:
 613         rollback_lock_file(&lock);
 614         return -1;
 615 }
 616
 617 int unbundle(struct repository *r, struct bundle_header *header,
 618              int bundle_fd, struct strvec *extra_index_pack_args)
 619 {
 620         struct child_process ip = CHILD_PROCESS_INIT;
 621         strvec_pushl(&ip.args, "index-pack", "--fix-thin", "--stdin", NULL);
 622
 623         if (extra_index_pack_args) {
 624                 strvec_pushv(&ip.args, extra_index_pack_args->v);
 625                 strvec_clear(extra_index_pack_args);
 626         }
 627
 628         if (verify_bundle(r, header, 0))
 629                 return -1;
 630         ip.in = bundle_fd;
 631         ip.no_stdout = 1;
 632         ip.git_cmd = 1;
 633         if (run_command(&ip))
 634                 return error(_("index-pack died"));
 635         return 0;
 636 }