submodule.c

   1 #define NO_THE_INDEX_COMPATIBILITY_MACROS
   2
   3 #include "cache.h"
   4 #include "repository.h"
   5 #include "config.h"
   6 #include "submodule-config.h"
   7 #include "submodule.h"
   8 #include "dir.h"
   9 #include "diff.h"
  10 #include "commit.h"
  11 #include "revision.h"
  12 #include "run-command.h"
  13 #include "diffcore.h"
  14 #include "refs.h"
  15 #include "string-list.h"
  16 #include "sha1-array.h"
  17 #include "argv-array.h"
  18 #include "blob.h"
  19 #include "thread-utils.h"
  20 #include "quote.h"
  21 #include "remote.h"
  22 #include "worktree.h"
  23 #include "parse-options.h"
  24 #include "object-store.h"
  25
  26 static int config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
  27 static struct string_list changed_submodule_names = STRING_LIST_INIT_DUP;
  28 static int initialized_fetch_ref_tips;
  29 static struct oid_array ref_tips_before_fetch;
  30 static struct oid_array ref_tips_after_fetch;
  31
  32 /*
  33  * Check if the .gitmodules file is unmerged. Parsing of the .gitmodules file
  34  * will be disabled because we can't guess what might be configured in
  35  * .gitmodules unless the user resolves the conflict.
  36  */
  37 int is_gitmodules_unmerged(const struct index_state *istate)
  38 {
  39         int pos = index_name_pos(istate, GITMODULES_FILE, strlen(GITMODULES_FILE));
  40         if (pos < 0) { /* .gitmodules not found or isn't merged */
  41                 pos = -1 - pos;
  42                 if (istate->cache_nr > pos) {  /* there is a .gitmodules */
  43                         const struct cache_entry *ce = istate->cache[pos];
  44                         if (ce_namelen(ce) == strlen(GITMODULES_FILE) &&
  45                             !strcmp(ce->name, GITMODULES_FILE))
  46                                 return 1;
  47                 }
  48         }
  49
  50         return 0;
  51 }
  52
  53 /*
  54  * Check if the .gitmodules file has unstaged modifications.  This must be
  55  * checked before allowing modifications to the .gitmodules file with the
  56  * intention to stage them later, because when continuing we would stage the
  57  * modifications the user didn't stage herself too. That might change in a
  58  * future version when we learn to stage the changes we do ourselves without
  59  * staging any previous modifications.
  60  */
  61 int is_staging_gitmodules_ok(struct index_state *istate)
  62 {
  63         int pos = index_name_pos(istate, GITMODULES_FILE, strlen(GITMODULES_FILE));
  64
  65         if ((pos >= 0) && (pos < istate->cache_nr)) {
  66                 struct stat st;
  67                 if (lstat(GITMODULES_FILE, &st) == 0 &&
  68                     ie_match_stat(istate, istate->cache[pos], &st, 0) & DATA_CHANGED)
  69                         return 0;
  70         }
  71
  72         return 1;
  73 }
  74
  75 static int for_each_remote_ref_submodule(const char *submodule,
  76                                          each_ref_fn fn, void *cb_data)
  77 {
  78         return refs_for_each_remote_ref(get_submodule_ref_store(submodule),
  79                                         fn, cb_data);
  80 }
  81
  82 /*
  83  * Try to update the "path" entry in the "submodule.<name>" section of the
  84  * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
  85  * with the correct path=<oldpath> setting was found and we could update it.
  86  */
  87 int update_path_in_gitmodules(const char *oldpath, const char *newpath)
  88 {
  89         struct strbuf entry = STRBUF_INIT;
  90         const struct submodule *submodule;
  91
  92         if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
  93                 return -1;
  94
  95         if (is_gitmodules_unmerged(the_repository->index))
  96                 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
  97
  98         submodule = submodule_from_path(the_repository, &null_oid, oldpath);
  99         if (!submodule || !submodule->name) {
 100                 warning(_("Could not find section in .gitmodules where path=%s"), oldpath);
 101                 return -1;
 102         }
 103         strbuf_addstr(&entry, "submodule.");
 104         strbuf_addstr(&entry, submodule->name);
 105         strbuf_addstr(&entry, ".path");
 106         if (git_config_set_in_file_gently(GITMODULES_FILE, entry.buf, newpath) < 0) {
 107                 /* Maybe the user already did that, don't error out here */
 108                 warning(_("Could not update .gitmodules entry %s"), entry.buf);
 109                 strbuf_release(&entry);
 110                 return -1;
 111         }
 112         strbuf_release(&entry);
 113         return 0;
 114 }
 115
 116 /*
 117  * Try to remove the "submodule.<name>" section from .gitmodules where the given
 118  * path is configured. Return 0 only if a .gitmodules file was found, a section
 119  * with the correct path=<path> setting was found and we could remove it.
 120  */
 121 int remove_path_from_gitmodules(const char *path)
 122 {
 123         struct strbuf sect = STRBUF_INIT;
 124         const struct submodule *submodule;
 125
 126         if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
 127                 return -1;
 128
 129         if (is_gitmodules_unmerged(the_repository->index))
 130                 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
 131
 132         submodule = submodule_from_path(the_repository, &null_oid, path);
 133         if (!submodule || !submodule->name) {
 134                 warning(_("Could not find section in .gitmodules where path=%s"), path);
 135                 return -1;
 136         }
 137         strbuf_addstr(&sect, "submodule.");
 138         strbuf_addstr(&sect, submodule->name);
 139         if (git_config_rename_section_in_file(GITMODULES_FILE, sect.buf, NULL) < 0) {
 140                 /* Maybe the user already did that, don't error out here */
 141                 warning(_("Could not remove .gitmodules entry for %s"), path);
 142                 strbuf_release(&sect);
 143                 return -1;
 144         }
 145         strbuf_release(&sect);
 146         return 0;
 147 }
 148
 149 void stage_updated_gitmodules(struct index_state *istate)
 150 {
 151         if (add_file_to_index(istate, GITMODULES_FILE, 0))
 152                 die(_("staging updated .gitmodules failed"));
 153 }
 154
 155 /* TODO: remove this function, use repo_submodule_init instead. */
 156 int add_submodule_odb(const char *path)
 157 {
 158         struct strbuf objects_directory = STRBUF_INIT;
 159         int ret = 0;
 160
 161         ret = strbuf_git_path_submodule(&objects_directory, path, "objects/");
 162         if (ret)
 163                 goto done;
 164         if (!is_directory(objects_directory.buf)) {
 165                 ret = -1;
 166                 goto done;
 167         }
 168         add_to_alternates_memory(objects_directory.buf);
 169 done:
 170         strbuf_release(&objects_directory);
 171         return ret;
 172 }
 173
 174 void set_diffopt_flags_from_submodule_config(struct diff_options *diffopt,
 175                                              const char *path)
 176 {
 177         const struct submodule *submodule = submodule_from_path(the_repository,
 178                                                                 &null_oid, path);
 179         if (submodule) {
 180                 const char *ignore;
 181                 char *key;
 182
 183                 key = xstrfmt("submodule.%s.ignore", submodule->name);
 184                 if (repo_config_get_string_const(the_repository, key, &ignore))
 185                         ignore = submodule->ignore;
 186                 free(key);
 187
 188                 if (ignore)
 189                         handle_ignore_submodules_arg(diffopt, ignore);
 190                 else if (is_gitmodules_unmerged(the_repository->index))
 191                         diffopt->flags.ignore_submodules = 1;
 192         }
 193 }
 194
 195 /* Cheap function that only determines if we're interested in submodules at all */
 196 int git_default_submodule_config(const char *var, const char *value, void *cb)
 197 {
 198         if (!strcmp(var, "submodule.recurse")) {
 199                 int v = git_config_bool(var, value) ?
 200                         RECURSE_SUBMODULES_ON : RECURSE_SUBMODULES_OFF;
 201                 config_update_recurse_submodules = v;
 202         }
 203         return 0;
 204 }
 205
 206 int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
 207                                                      const char *arg, int unset)
 208 {
 209         if (unset) {
 210                 config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
 211                 return 0;
 212         }
 213         if (arg)
 214                 config_update_recurse_submodules =
 215                         parse_update_recurse_submodules_arg(opt->long_name,
 216                                                             arg);
 217         else
 218                 config_update_recurse_submodules = RECURSE_SUBMODULES_ON;
 219
 220         return 0;
 221 }
 222
 223 /*
 224  * Determine if a submodule has been initialized at a given 'path'
 225  */
 226 int is_submodule_active(struct repository *repo, const char *path)
 227 {
 228         int ret = 0;
 229         char *key = NULL;
 230         char *value = NULL;
 231         const struct string_list *sl;
 232         const struct submodule *module;
 233
 234         module = submodule_from_path(repo, &null_oid, path);
 235
 236         /* early return if there isn't a path->module mapping */
 237         if (!module)
 238                 return 0;
 239
 240         /* submodule.<name>.active is set */
 241         key = xstrfmt("submodule.%s.active", module->name);
 242         if (!repo_config_get_bool(repo, key, &ret)) {
 243                 free(key);
 244                 return ret;
 245         }
 246         free(key);
 247
 248         /* submodule.active is set */
 249         sl = repo_config_get_value_multi(repo, "submodule.active");
 250         if (sl) {
 251                 struct pathspec ps;
 252                 struct argv_array args = ARGV_ARRAY_INIT;
 253                 const struct string_list_item *item;
 254
 255                 for_each_string_list_item(item, sl) {
 256                         argv_array_push(&args, item->string);
 257                 }
 258
 259                 parse_pathspec(&ps, 0, 0, NULL, args.argv);
 260                 ret = match_pathspec(repo->index, &ps, path, strlen(path), 0, NULL, 1);
 261
 262                 argv_array_clear(&args);
 263                 clear_pathspec(&ps);
 264                 return ret;
 265         }
 266
 267         /* fallback to checking if the URL is set */
 268         key = xstrfmt("submodule.%s.url", module->name);
 269         ret = !repo_config_get_string(repo, key, &value);
 270
 271         free(value);
 272         free(key);
 273         return ret;
 274 }
 275
 276 int is_submodule_populated_gently(const char *path, int *return_error_code)
 277 {
 278         int ret = 0;
 279         char *gitdir = xstrfmt("%s/.git", path);
 280
 281         if (resolve_gitdir_gently(gitdir, return_error_code))
 282                 ret = 1;
 283
 284         free(gitdir);
 285         return ret;
 286 }
 287
 288 /*
 289  * Dies if the provided 'prefix' corresponds to an unpopulated submodule
 290  */
 291 void die_in_unpopulated_submodule(const struct index_state *istate,
 292                                   const char *prefix)
 293 {
 294         int i, prefixlen;
 295
 296         if (!prefix)
 297                 return;
 298
 299         prefixlen = strlen(prefix);
 300
 301         for (i = 0; i < istate->cache_nr; i++) {
 302                 struct cache_entry *ce = istate->cache[i];
 303                 int ce_len = ce_namelen(ce);
 304
 305                 if (!S_ISGITLINK(ce->ce_mode))
 306                         continue;
 307                 if (prefixlen <= ce_len)
 308                         continue;
 309                 if (strncmp(ce->name, prefix, ce_len))
 310                         continue;
 311                 if (prefix[ce_len] != '/')
 312                         continue;
 313
 314                 die(_("in unpopulated submodule '%s'"), ce->name);
 315         }
 316 }
 317
 318 /*
 319  * Dies if any paths in the provided pathspec descends into a submodule
 320  */
 321 void die_path_inside_submodule(const struct index_state *istate,
 322                                const struct pathspec *ps)
 323 {
 324         int i, j;
 325
 326         for (i = 0; i < istate->cache_nr; i++) {
 327                 struct cache_entry *ce = istate->cache[i];
 328                 int ce_len = ce_namelen(ce);
 329
 330                 if (!S_ISGITLINK(ce->ce_mode))
 331                         continue;
 332
 333                 for (j = 0; j < ps->nr ; j++) {
 334                         const struct pathspec_item *item = &ps->items[j];
 335
 336                         if (item->len <= ce_len)
 337                                 continue;
 338                         if (item->match[ce_len] != '/')
 339                                 continue;
 340                         if (strncmp(ce->name, item->match, ce_len))
 341                                 continue;
 342                         if (item->len == ce_len + 1)
 343                                 continue;
 344
 345                         die(_("Pathspec '%s' is in submodule '%.*s'"),
 346                             item->original, ce_len, ce->name);
 347                 }
 348         }
 349 }
 350
 351 enum submodule_update_type parse_submodule_update_type(const char *value)
 352 {
 353         if (!strcmp(value, "none"))
 354                 return SM_UPDATE_NONE;
 355         else if (!strcmp(value, "checkout"))
 356                 return SM_UPDATE_CHECKOUT;
 357         else if (!strcmp(value, "rebase"))
 358                 return SM_UPDATE_REBASE;
 359         else if (!strcmp(value, "merge"))
 360                 return SM_UPDATE_MERGE;
 361         else if (*value == '!')
 362                 return SM_UPDATE_COMMAND;
 363         else
 364                 return SM_UPDATE_UNSPECIFIED;
 365 }
 366
 367 int parse_submodule_update_strategy(const char *value,
 368                 struct submodule_update_strategy *dst)
 369 {
 370         enum submodule_update_type type;
 371
 372         free((void*)dst->command);
 373         dst->command = NULL;
 374
 375         type = parse_submodule_update_type(value);
 376         if (type == SM_UPDATE_UNSPECIFIED)
 377                 return -1;
 378
 379         dst->type = type;
 380         if (type == SM_UPDATE_COMMAND)
 381                 dst->command = xstrdup(value + 1);
 382
 383         return 0;
 384 }
 385
 386 const char *submodule_strategy_to_string(const struct submodule_update_strategy *s)
 387 {
 388         struct strbuf sb = STRBUF_INIT;
 389         switch (s->type) {
 390         case SM_UPDATE_CHECKOUT:
 391                 return "checkout";
 392         case SM_UPDATE_MERGE:
 393                 return "merge";
 394         case SM_UPDATE_REBASE:
 395                 return "rebase";
 396         case SM_UPDATE_NONE:
 397                 return "none";
 398         case SM_UPDATE_UNSPECIFIED:
 399                 return NULL;
 400         case SM_UPDATE_COMMAND:
 401                 strbuf_addf(&sb, "!%s", s->command);
 402                 return strbuf_detach(&sb, NULL);
 403         }
 404         return NULL;
 405 }
 406
 407 void handle_ignore_submodules_arg(struct diff_options *diffopt,
 408                                   const char *arg)
 409 {
 410         diffopt->flags.ignore_submodules = 0;
 411         diffopt->flags.ignore_untracked_in_submodules = 0;
 412         diffopt->flags.ignore_dirty_submodules = 0;
 413
 414         if (!strcmp(arg, "all"))
 415                 diffopt->flags.ignore_submodules = 1;
 416         else if (!strcmp(arg, "untracked"))
 417                 diffopt->flags.ignore_untracked_in_submodules = 1;
 418         else if (!strcmp(arg, "dirty"))
 419                 diffopt->flags.ignore_dirty_submodules = 1;
 420         else if (strcmp(arg, "none"))
 421                 die("bad --ignore-submodules argument: %s", arg);
 422 }
 423
 424 static int prepare_submodule_summary(struct rev_info *rev, const char *path,
 425                 struct commit *left, struct commit *right,
 426                 struct commit_list *merge_bases)
 427 {
 428         struct commit_list *list;
 429
 430         init_revisions(rev, NULL);
 431         setup_revisions(0, NULL, rev, NULL);
 432         rev->left_right = 1;
 433         rev->first_parent_only = 1;
 434         left->object.flags |= SYMMETRIC_LEFT;
 435         add_pending_object(rev, &left->object, path);
 436         add_pending_object(rev, &right->object, path);
 437         for (list = merge_bases; list; list = list->next) {
 438                 list->item->object.flags |= UNINTERESTING;
 439                 add_pending_object(rev, &list->item->object,
 440                         oid_to_hex(&list->item->object.oid));
 441         }
 442         return prepare_revision_walk(rev);
 443 }
 444
 445 static void print_submodule_summary(struct rev_info *rev, struct diff_options *o)
 446 {
 447         static const char format[] = "  %m %s";
 448         struct strbuf sb = STRBUF_INIT;
 449         struct commit *commit;
 450
 451         while ((commit = get_revision(rev))) {
 452                 struct pretty_print_context ctx = {0};
 453                 ctx.date_mode = rev->date_mode;
 454                 ctx.output_encoding = get_log_output_encoding();
 455                 strbuf_setlen(&sb, 0);
 456                 format_commit_message(commit, format, &sb, &ctx);
 457                 strbuf_addch(&sb, '\n');
 458                 if (commit->object.flags & SYMMETRIC_LEFT)
 459                         diff_emit_submodule_del(o, sb.buf);
 460                 else
 461                         diff_emit_submodule_add(o, sb.buf);
 462         }
 463         strbuf_release(&sb);
 464 }
 465
 466 static void prepare_submodule_repo_env_no_git_dir(struct argv_array *out)
 467 {
 468         const char * const *var;
 469
 470         for (var = local_repo_env; *var; var++) {
 471                 if (strcmp(*var, CONFIG_DATA_ENVIRONMENT))
 472                         argv_array_push(out, *var);
 473         }
 474 }
 475
 476 void prepare_submodule_repo_env(struct argv_array *out)
 477 {
 478         prepare_submodule_repo_env_no_git_dir(out);
 479         argv_array_pushf(out, "%s=%s", GIT_DIR_ENVIRONMENT,
 480                          DEFAULT_GIT_DIR_ENVIRONMENT);
 481 }
 482
 483 /* Helper function to display the submodule header line prior to the full
 484  * summary output. If it can locate the submodule objects directory it will
 485  * attempt to lookup both the left and right commits and put them into the
 486  * left and right pointers.
 487  */
 488 static void show_submodule_header(struct diff_options *o, const char *path,
 489                 struct object_id *one, struct object_id *two,
 490                 unsigned dirty_submodule,
 491                 struct commit **left, struct commit **right,
 492                 struct commit_list **merge_bases)
 493 {
 494         const char *message = NULL;
 495         struct strbuf sb = STRBUF_INIT;
 496         int fast_forward = 0, fast_backward = 0;
 497
 498         if (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED)
 499                 diff_emit_submodule_untracked(o, path);
 500
 501         if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
 502                 diff_emit_submodule_modified(o, path);
 503
 504         if (is_null_oid(one))
 505                 message = "(new submodule)";
 506         else if (is_null_oid(two))
 507                 message = "(submodule deleted)";
 508
 509         if (add_submodule_odb(path)) {
 510                 if (!message)
 511                         message = "(commits not present)";
 512                 goto output_header;
 513         }
 514
 515         /*
 516          * Attempt to lookup the commit references, and determine if this is
 517          * a fast forward or fast backwards update.
 518          */
 519         *left = lookup_commit_reference(the_repository, one);
 520         *right = lookup_commit_reference(the_repository, two);
 521
 522         /*
 523          * Warn about missing commits in the submodule project, but only if
 524          * they aren't null.
 525          */
 526         if ((!is_null_oid(one) && !*left) ||
 527              (!is_null_oid(two) && !*right))
 528                 message = "(commits not present)";
 529
 530         *merge_bases = get_merge_bases(*left, *right);
 531         if (*merge_bases) {
 532                 if ((*merge_bases)->item == *left)
 533                         fast_forward = 1;
 534                 else if ((*merge_bases)->item == *right)
 535                         fast_backward = 1;
 536         }
 537
 538         if (!oidcmp(one, two)) {
 539                 strbuf_release(&sb);
 540                 return;
 541         }
 542
 543 output_header:
 544         strbuf_addf(&sb, "Submodule %s ", path);
 545         strbuf_add_unique_abbrev(&sb, one, DEFAULT_ABBREV);
 546         strbuf_addstr(&sb, (fast_backward || fast_forward) ? ".." : "...");
 547         strbuf_add_unique_abbrev(&sb, two, DEFAULT_ABBREV);
 548         if (message)
 549                 strbuf_addf(&sb, " %s\n", message);
 550         else
 551                 strbuf_addf(&sb, "%s:\n", fast_backward ? " (rewind)" : "");
 552         diff_emit_submodule_header(o, sb.buf);
 553
 554         strbuf_release(&sb);
 555 }
 556
 557 void show_submodule_summary(struct diff_options *o, const char *path,
 558                 struct object_id *one, struct object_id *two,
 559                 unsigned dirty_submodule)
 560 {
 561         struct rev_info rev;
 562         struct commit *left = NULL, *right = NULL;
 563         struct commit_list *merge_bases = NULL;
 564
 565         show_submodule_header(o, path, one, two, dirty_submodule,
 566                               &left, &right, &merge_bases);
 567
 568         /*
 569          * If we don't have both a left and a right pointer, there is no
 570          * reason to try and display a summary. The header line should contain
 571          * all the information the user needs.
 572          */
 573         if (!left || !right)
 574                 goto out;
 575
 576         /* Treat revision walker failure the same as missing commits */
 577         if (prepare_submodule_summary(&rev, path, left, right, merge_bases)) {
 578                 diff_emit_submodule_error(o, "(revision walker failed)\n");
 579                 goto out;
 580         }
 581
 582         print_submodule_summary(&rev, o);
 583
 584 out:
 585         if (merge_bases)
 586                 free_commit_list(merge_bases);
 587         clear_commit_marks(left, ~0);
 588         clear_commit_marks(right, ~0);
 589 }
 590
 591 void show_submodule_inline_diff(struct diff_options *o, const char *path,
 592                 struct object_id *one, struct object_id *two,
 593                 unsigned dirty_submodule)
 594 {
 595         const struct object_id *old_oid = the_hash_algo->empty_tree, *new_oid = the_hash_algo->empty_tree;
 596         struct commit *left = NULL, *right = NULL;
 597         struct commit_list *merge_bases = NULL;
 598         struct child_process cp = CHILD_PROCESS_INIT;
 599         struct strbuf sb = STRBUF_INIT;
 600
 601         show_submodule_header(o, path, one, two, dirty_submodule,
 602                               &left, &right, &merge_bases);
 603
 604         /* We need a valid left and right commit to display a difference */
 605         if (!(left || is_null_oid(one)) ||
 606             !(right || is_null_oid(two)))
 607                 goto done;
 608
 609         if (left)
 610                 old_oid = one;
 611         if (right)
 612                 new_oid = two;
 613
 614         cp.git_cmd = 1;
 615         cp.dir = path;
 616         cp.out = -1;
 617         cp.no_stdin = 1;
 618
 619         /* TODO: other options may need to be passed here. */
 620         argv_array_pushl(&cp.args, "diff", "--submodule=diff", NULL);
 621         argv_array_pushf(&cp.args, "--color=%s", want_color(o->use_color) ?
 622                          "always" : "never");
 623
 624         if (o->flags.reverse_diff) {
 625                 argv_array_pushf(&cp.args, "--src-prefix=%s%s/",
 626                                  o->b_prefix, path);
 627                 argv_array_pushf(&cp.args, "--dst-prefix=%s%s/",
 628                                  o->a_prefix, path);
 629         } else {
 630                 argv_array_pushf(&cp.args, "--src-prefix=%s%s/",
 631                                  o->a_prefix, path);
 632                 argv_array_pushf(&cp.args, "--dst-prefix=%s%s/",
 633                                  o->b_prefix, path);
 634         }
 635         argv_array_push(&cp.args, oid_to_hex(old_oid));
 636         /*
 637          * If the submodule has modified content, we will diff against the
 638          * work tree, under the assumption that the user has asked for the
 639          * diff format and wishes to actually see all differences even if they
 640          * haven't yet been committed to the submodule yet.
 641          */
 642         if (!(dirty_submodule & DIRTY_SUBMODULE_MODIFIED))
 643                 argv_array_push(&cp.args, oid_to_hex(new_oid));
 644
 645         prepare_submodule_repo_env(&cp.env_array);
 646         if (start_command(&cp))
 647                 diff_emit_submodule_error(o, "(diff failed)\n");
 648
 649         while (strbuf_getwholeline_fd(&sb, cp.out, '\n') != EOF)
 650                 diff_emit_submodule_pipethrough(o, sb.buf, sb.len);
 651
 652         if (finish_command(&cp))
 653                 diff_emit_submodule_error(o, "(diff failed)\n");
 654
 655 done:
 656         strbuf_release(&sb);
 657         if (merge_bases)
 658                 free_commit_list(merge_bases);
 659         if (left)
 660                 clear_commit_marks(left, ~0);
 661         if (right)
 662                 clear_commit_marks(right, ~0);
 663 }
 664
 665 int should_update_submodules(void)
 666 {
 667         return config_update_recurse_submodules == RECURSE_SUBMODULES_ON;
 668 }
 669
 670 const struct submodule *submodule_from_ce(const struct cache_entry *ce)
 671 {
 672         if (!S_ISGITLINK(ce->ce_mode))
 673                 return NULL;
 674
 675         if (!should_update_submodules())
 676                 return NULL;
 677
 678         return submodule_from_path(the_repository, &null_oid, ce->name);
 679 }
 680
 681 static struct oid_array *submodule_commits(struct string_list *submodules,
 682                                            const char *name)
 683 {
 684         struct string_list_item *item;
 685
 686         item = string_list_insert(submodules, name);
 687         if (item->util)
 688                 return (struct oid_array *) item->util;
 689
 690         /* NEEDSWORK: should we have oid_array_init()? */
 691         item->util = xcalloc(1, sizeof(struct oid_array));
 692         return (struct oid_array *) item->util;
 693 }
 694
 695 struct collect_changed_submodules_cb_data {
 696         struct string_list *changed;
 697         const struct object_id *commit_oid;
 698 };
 699
 700 /*
 701  * this would normally be two functions: default_name_from_path() and
 702  * path_from_default_name(). Since the default name is the same as
 703  * the submodule path we can get away with just one function which only
 704  * checks whether there is a submodule in the working directory at that
 705  * location.
 706  */
 707 static const char *default_name_or_path(const char *path_or_name)
 708 {
 709         int error_code;
 710
 711         if (!is_submodule_populated_gently(path_or_name, &error_code))
 712                 return NULL;
 713
 714         return path_or_name;
 715 }
 716
 717 static void collect_changed_submodules_cb(struct diff_queue_struct *q,
 718                                           struct diff_options *options,
 719                                           void *data)
 720 {
 721         struct collect_changed_submodules_cb_data *me = data;
 722         struct string_list *changed = me->changed;
 723         const struct object_id *commit_oid = me->commit_oid;
 724         int i;
 725
 726         for (i = 0; i < q->nr; i++) {
 727                 struct diff_filepair *p = q->queue[i];
 728                 struct oid_array *commits;
 729                 const struct submodule *submodule;
 730                 const char *name;
 731
 732                 if (!S_ISGITLINK(p->two->mode))
 733                         continue;
 734
 735                 submodule = submodule_from_path(the_repository,
 736                                                 commit_oid, p->two->path);
 737                 if (submodule)
 738                         name = submodule->name;
 739                 else {
 740                         name = default_name_or_path(p->two->path);
 741                         /* make sure name does not collide with existing one */
 742                         if (name)
 743                                 submodule = submodule_from_name(the_repository,
 744                                                                 commit_oid, name);
 745                         if (submodule) {
 746                                 warning("Submodule in commit %s at path: "
 747                                         "'%s' collides with a submodule named "
 748                                         "the same. Skipping it.",
 749                                         oid_to_hex(commit_oid), p->two->path);
 750                                 name = NULL;
 751                         }
 752                 }
 753
 754                 if (!name)
 755                         continue;
 756
 757                 commits = submodule_commits(changed, name);
 758                 oid_array_append(commits, &p->two->oid);
 759         }
 760 }
 761
 762 /*
 763  * Collect the paths of submodules in 'changed' which have changed based on
 764  * the revisions as specified in 'argv'.  Each entry in 'changed' will also
 765  * have a corresponding 'struct oid_array' (in the 'util' field) which lists
 766  * what the submodule pointers were updated to during the change.
 767  */
 768 static void collect_changed_submodules(struct string_list *changed,
 769                                        struct argv_array *argv)
 770 {
 771         struct rev_info rev;
 772         const struct commit *commit;
 773
 774         init_revisions(&rev, NULL);
 775         setup_revisions(argv->argc, argv->argv, &rev, NULL);
 776         if (prepare_revision_walk(&rev))
 777                 die("revision walk setup failed");
 778
 779         while ((commit = get_revision(&rev))) {
 780                 struct rev_info diff_rev;
 781                 struct collect_changed_submodules_cb_data data;
 782                 data.changed = changed;
 783                 data.commit_oid = &commit->object.oid;
 784
 785                 init_revisions(&diff_rev, NULL);
 786                 diff_rev.diffopt.output_format |= DIFF_FORMAT_CALLBACK;
 787                 diff_rev.diffopt.format_callback = collect_changed_submodules_cb;
 788                 diff_rev.diffopt.format_callback_data = &data;
 789                 diff_tree_combined_merge(commit, 1, &diff_rev);
 790         }
 791
 792         reset_revision_walk();
 793 }
 794
 795 static void free_submodules_oids(struct string_list *submodules)
 796 {
 797         struct string_list_item *item;
 798         for_each_string_list_item(item, submodules)
 799                 oid_array_clear((struct oid_array *) item->util);
 800         string_list_clear(submodules, 1);
 801 }
 802
 803 static int has_remote(const char *refname, const struct object_id *oid,
 804                       int flags, void *cb_data)
 805 {
 806         return 1;
 807 }
 808
 809 static int append_oid_to_argv(const struct object_id *oid, void *data)
 810 {
 811         struct argv_array *argv = data;
 812         argv_array_push(argv, oid_to_hex(oid));
 813         return 0;
 814 }
 815
 816 struct has_commit_data {
 817         int result;
 818         const char *path;
 819 };
 820
 821 static int check_has_commit(const struct object_id *oid, void *data)
 822 {
 823         struct has_commit_data *cb = data;
 824
 825         enum object_type type = oid_object_info(the_repository, oid, NULL);
 826
 827         switch (type) {
 828         case OBJ_COMMIT:
 829                 return 0;
 830         case OBJ_BAD:
 831                 /*
 832                  * Object is missing or invalid. If invalid, an error message
 833                  * has already been printed.
 834                  */
 835                 cb->result = 0;
 836                 return 0;
 837         default:
 838                 die(_("submodule entry '%s' (%s) is a %s, not a commit"),
 839                     cb->path, oid_to_hex(oid), type_name(type));
 840         }
 841 }
 842
 843 static int submodule_has_commits(const char *path, struct oid_array *commits)
 844 {
 845         struct has_commit_data has_commit = { 1, path };
 846
 847         /*
 848          * Perform a cheap, but incorrect check for the existence of 'commits'.
 849          * This is done by adding the submodule's object store to the in-core
 850          * object store, and then querying for each commit's existence.  If we
 851          * do not have the commit object anywhere, there is no chance we have
 852          * it in the object store of the correct submodule and have it
 853          * reachable from a ref, so we can fail early without spawning rev-list
 854          * which is expensive.
 855          */
 856         if (add_submodule_odb(path))
 857                 return 0;
 858
 859         oid_array_for_each_unique(commits, check_has_commit, &has_commit);
 860
 861         if (has_commit.result) {
 862                 /*
 863                  * Even if the submodule is checked out and the commit is
 864                  * present, make sure it exists in the submodule's object store
 865                  * and that it is reachable from a ref.
 866                  */
 867                 struct child_process cp = CHILD_PROCESS_INIT;
 868                 struct strbuf out = STRBUF_INIT;
 869
 870                 argv_array_pushl(&cp.args, "rev-list", "-n", "1", NULL);
 871                 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
 872                 argv_array_pushl(&cp.args, "--not", "--all", NULL);
 873
 874                 prepare_submodule_repo_env(&cp.env_array);
 875                 cp.git_cmd = 1;
 876                 cp.no_stdin = 1;
 877                 cp.dir = path;
 878
 879                 if (capture_command(&cp, &out, GIT_MAX_HEXSZ + 1) || out.len)
 880                         has_commit.result = 0;
 881
 882                 strbuf_release(&out);
 883         }
 884
 885         return has_commit.result;
 886 }
 887
 888 static int submodule_needs_pushing(const char *path, struct oid_array *commits)
 889 {
 890         if (!submodule_has_commits(path, commits))
 891                 /*
 892                  * NOTE: We do consider it safe to return "no" here. The
 893                  * correct answer would be "We do not know" instead of
 894                  * "No push needed", but it is quite hard to change
 895                  * the submodule pointer without having the submodule
 896                  * around. If a user did however change the submodules
 897                  * without having the submodule around, this indicates
 898                  * an expert who knows what they are doing or a
 899                  * maintainer integrating work from other people. In
 900                  * both cases it should be safe to skip this check.
 901                  */
 902                 return 0;
 903
 904         if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
 905                 struct child_process cp = CHILD_PROCESS_INIT;
 906                 struct strbuf buf = STRBUF_INIT;
 907                 int needs_pushing = 0;
 908
 909                 argv_array_push(&cp.args, "rev-list");
 910                 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
 911                 argv_array_pushl(&cp.args, "--not", "--remotes", "-n", "1" , NULL);
 912
 913                 prepare_submodule_repo_env(&cp.env_array);
 914                 cp.git_cmd = 1;
 915                 cp.no_stdin = 1;
 916                 cp.out = -1;
 917                 cp.dir = path;
 918                 if (start_command(&cp))
 919                         die("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s",
 920                                         path);
 921                 if (strbuf_read(&buf, cp.out, 41))
 922                         needs_pushing = 1;
 923                 finish_command(&cp);
 924                 close(cp.out);
 925                 strbuf_release(&buf);
 926                 return needs_pushing;
 927         }
 928
 929         return 0;
 930 }
 931
 932 int find_unpushed_submodules(struct oid_array *commits,
 933                 const char *remotes_name, struct string_list *needs_pushing)
 934 {
 935         struct string_list submodules = STRING_LIST_INIT_DUP;
 936         struct string_list_item *name;
 937         struct argv_array argv = ARGV_ARRAY_INIT;
 938
 939         /* argv.argv[0] will be ignored by setup_revisions */
 940         argv_array_push(&argv, "find_unpushed_submodules");
 941         oid_array_for_each_unique(commits, append_oid_to_argv, &argv);
 942         argv_array_push(&argv, "--not");
 943         argv_array_pushf(&argv, "--remotes=%s", remotes_name);
 944
 945         collect_changed_submodules(&submodules, &argv);
 946
 947         for_each_string_list_item(name, &submodules) {
 948                 struct oid_array *commits = name->util;
 949                 const struct submodule *submodule;
 950                 const char *path = NULL;
 951
 952                 submodule = submodule_from_name(the_repository, &null_oid, name->string);
 953                 if (submodule)
 954                         path = submodule->path;
 955                 else
 956                         path = default_name_or_path(name->string);
 957
 958                 if (!path)
 959                         continue;
 960
 961                 if (submodule_needs_pushing(path, commits))
 962                         string_list_insert(needs_pushing, path);
 963         }
 964
 965         free_submodules_oids(&submodules);
 966         argv_array_clear(&argv);
 967
 968         return needs_pushing->nr;
 969 }
 970
 971 static int push_submodule(const char *path,
 972                           const struct remote *remote,
 973                           const struct refspec *rs,
 974                           const struct string_list *push_options,
 975                           int dry_run)
 976 {
 977         if (add_submodule_odb(path))
 978                 return 1;
 979
 980         if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
 981                 struct child_process cp = CHILD_PROCESS_INIT;
 982                 argv_array_push(&cp.args, "push");
 983                 if (dry_run)
 984                         argv_array_push(&cp.args, "--dry-run");
 985
 986                 if (push_options && push_options->nr) {
 987                         const struct string_list_item *item;
 988                         for_each_string_list_item(item, push_options)
 989                                 argv_array_pushf(&cp.args, "--push-option=%s",
 990                                                  item->string);
 991                 }
 992
 993                 if (remote->origin != REMOTE_UNCONFIGURED) {
 994                         int i;
 995                         argv_array_push(&cp.args, remote->name);
 996                         for (i = 0; i < rs->raw_nr; i++)
 997                                 argv_array_push(&cp.args, rs->raw[i]);
 998                 }
 999
1000                 prepare_submodule_repo_env(&cp.env_array);
1001                 cp.git_cmd = 1;
1002                 cp.no_stdin = 1;
1003                 cp.dir = path;
1004                 if (run_command(&cp))
1005                         return 0;
1006                 close(cp.out);
1007         }
1008
1009         return 1;
1010 }
1011
1012 /*
1013  * Perform a check in the submodule to see if the remote and refspec work.
1014  * Die if the submodule can't be pushed.
1015  */
1016 static void submodule_push_check(const char *path, const char *head,
1017                                  const struct remote *remote,
1018                                  const struct refspec *rs)
1019 {
1020         struct child_process cp = CHILD_PROCESS_INIT;
1021         int i;
1022
1023         argv_array_push(&cp.args, "submodule--helper");
1024         argv_array_push(&cp.args, "push-check");
1025         argv_array_push(&cp.args, head);
1026         argv_array_push(&cp.args, remote->name);
1027
1028         for (i = 0; i < rs->raw_nr; i++)
1029                 argv_array_push(&cp.args, rs->raw[i]);
1030
1031         prepare_submodule_repo_env(&cp.env_array);
1032         cp.git_cmd = 1;
1033         cp.no_stdin = 1;
1034         cp.no_stdout = 1;
1035         cp.dir = path;
1036
1037         /*
1038          * Simply indicate if 'submodule--helper push-check' failed.
1039          * More detailed error information will be provided by the
1040          * child process.
1041          */
1042         if (run_command(&cp))
1043                 die("process for submodule '%s' failed", path);
1044 }
1045
1046 int push_unpushed_submodules(struct oid_array *commits,
1047                              const struct remote *remote,
1048                              const struct refspec *rs,
1049                              const struct string_list *push_options,
1050                              int dry_run)
1051 {
1052         int i, ret = 1;
1053         struct string_list needs_pushing = STRING_LIST_INIT_DUP;
1054
1055         if (!find_unpushed_submodules(commits, remote->name, &needs_pushing))
1056                 return 1;
1057
1058         /*
1059          * Verify that the remote and refspec can be propagated to all
1060          * submodules.  This check can be skipped if the remote and refspec
1061          * won't be propagated due to the remote being unconfigured (e.g. a URL
1062          * instead of a remote name).
1063          */
1064         if (remote->origin != REMOTE_UNCONFIGURED) {
1065                 char *head;
1066                 struct object_id head_oid;
1067
1068                 head = resolve_refdup("HEAD", 0, &head_oid, NULL);
1069                 if (!head)
1070                         die(_("Failed to resolve HEAD as a valid ref."));
1071
1072                 for (i = 0; i < needs_pushing.nr; i++)
1073                         submodule_push_check(needs_pushing.items[i].string,
1074                                              head, remote, rs);
1075                 free(head);
1076         }
1077
1078         /* Actually push the submodules */
1079         for (i = 0; i < needs_pushing.nr; i++) {
1080                 const char *path = needs_pushing.items[i].string;
1081                 fprintf(stderr, "Pushing submodule '%s'\n", path);
1082                 if (!push_submodule(path, remote, rs,
1083                                     push_options, dry_run)) {
1084                         fprintf(stderr, "Unable to push submodule '%s'\n", path);
1085                         ret = 0;
1086                 }
1087         }
1088
1089         string_list_clear(&needs_pushing, 0);
1090
1091         return ret;
1092 }
1093
1094 static int append_oid_to_array(const char *ref, const struct object_id *oid,
1095                                int flags, void *data)
1096 {
1097         struct oid_array *array = data;
1098         oid_array_append(array, oid);
1099         return 0;
1100 }
1101
1102 void check_for_new_submodule_commits(struct object_id *oid)
1103 {
1104         if (!initialized_fetch_ref_tips) {
1105                 for_each_ref(append_oid_to_array, &ref_tips_before_fetch);
1106                 initialized_fetch_ref_tips = 1;
1107         }
1108
1109         oid_array_append(&ref_tips_after_fetch, oid);
1110 }
1111
1112 static void calculate_changed_submodule_paths(void)
1113 {
1114         struct argv_array argv = ARGV_ARRAY_INIT;
1115         struct string_list changed_submodules = STRING_LIST_INIT_DUP;
1116         const struct string_list_item *name;
1117
1118         /* No need to check if there are no submodules configured */
1119         if (!submodule_from_path(the_repository, NULL, NULL))
1120                 return;
1121
1122         argv_array_push(&argv, "--"); /* argv[0] program name */
1123         oid_array_for_each_unique(&ref_tips_after_fetch,
1124                                    append_oid_to_argv, &argv);
1125         argv_array_push(&argv, "--not");
1126         oid_array_for_each_unique(&ref_tips_before_fetch,
1127                                    append_oid_to_argv, &argv);
1128
1129         /*
1130          * Collect all submodules (whether checked out or not) for which new
1131          * commits have been recorded upstream in "changed_submodule_names".
1132          */
1133         collect_changed_submodules(&changed_submodules, &argv);
1134
1135         for_each_string_list_item(name, &changed_submodules) {
1136                 struct oid_array *commits = name->util;
1137                 const struct submodule *submodule;
1138                 const char *path = NULL;
1139
1140                 submodule = submodule_from_name(the_repository, &null_oid, name->string);
1141                 if (submodule)
1142                         path = submodule->path;
1143                 else
1144                         path = default_name_or_path(name->string);
1145
1146                 if (!path)
1147                         continue;
1148
1149                 if (!submodule_has_commits(path, commits))
1150                         string_list_append(&changed_submodule_names, name->string);
1151         }
1152
1153         free_submodules_oids(&changed_submodules);
1154         argv_array_clear(&argv);
1155         oid_array_clear(&ref_tips_before_fetch);
1156         oid_array_clear(&ref_tips_after_fetch);
1157         initialized_fetch_ref_tips = 0;
1158 }
1159
1160 int submodule_touches_in_range(struct object_id *excl_oid,
1161                                struct object_id *incl_oid)
1162 {
1163         struct string_list subs = STRING_LIST_INIT_DUP;
1164         struct argv_array args = ARGV_ARRAY_INIT;
1165         int ret;
1166
1167         /* No need to check if there are no submodules configured */
1168         if (!submodule_from_path(the_repository, NULL, NULL))
1169                 return 0;
1170
1171         argv_array_push(&args, "--"); /* args[0] program name */
1172         argv_array_push(&args, oid_to_hex(incl_oid));
1173         if (!is_null_oid(excl_oid)) {
1174                 argv_array_push(&args, "--not");
1175                 argv_array_push(&args, oid_to_hex(excl_oid));
1176         }
1177
1178         collect_changed_submodules(&subs, &args);
1179         ret = subs.nr;
1180
1181         argv_array_clear(&args);
1182
1183         free_submodules_oids(&subs);
1184         return ret;
1185 }
1186
1187 struct submodule_parallel_fetch {
1188         int count;
1189         struct argv_array args;
1190         struct repository *r;
1191         const char *prefix;
1192         int command_line_option;
1193         int default_option;
1194         int quiet;
1195         int result;
1196 };
1197 #define SPF_INIT {0, ARGV_ARRAY_INIT, NULL, NULL, 0, 0, 0, 0}
1198
1199 static int get_fetch_recurse_config(const struct submodule *submodule,
1200                                     struct submodule_parallel_fetch *spf)
1201 {
1202         if (spf->command_line_option != RECURSE_SUBMODULES_DEFAULT)
1203                 return spf->command_line_option;
1204
1205         if (submodule) {
1206                 char *key;
1207                 const char *value;
1208
1209                 int fetch_recurse = submodule->fetch_recurse;
1210                 key = xstrfmt("submodule.%s.fetchRecurseSubmodules", submodule->name);
1211                 if (!repo_config_get_string_const(spf->r, key, &value)) {
1212                         fetch_recurse = parse_fetch_recurse_submodules_arg(key, value);
1213                 }
1214                 free(key);
1215
1216                 if (fetch_recurse != RECURSE_SUBMODULES_NONE)
1217                         /* local config overrules everything except commandline */
1218                         return fetch_recurse;
1219         }
1220
1221         return spf->default_option;
1222 }
1223
1224 static int get_next_submodule(struct child_process *cp,
1225                               struct strbuf *err, void *data, void **task_cb)
1226 {
1227         int ret = 0;
1228         struct submodule_parallel_fetch *spf = data;
1229
1230         for (; spf->count < spf->r->index->cache_nr; spf->count++) {
1231                 struct strbuf submodule_path = STRBUF_INIT;
1232                 struct strbuf submodule_git_dir = STRBUF_INIT;
1233                 struct strbuf submodule_prefix = STRBUF_INIT;
1234                 const struct cache_entry *ce = spf->r->index->cache[spf->count];
1235                 const char *git_dir, *default_argv;
1236                 const struct submodule *submodule;
1237                 struct submodule default_submodule = SUBMODULE_INIT;
1238
1239                 if (!S_ISGITLINK(ce->ce_mode))
1240                         continue;
1241
1242                 submodule = submodule_from_path(spf->r, &null_oid, ce->name);
1243                 if (!submodule) {
1244                         const char *name = default_name_or_path(ce->name);
1245                         if (name) {
1246                                 default_submodule.path = default_submodule.name = name;
1247                                 submodule = &default_submodule;
1248                         }
1249                 }
1250
1251                 switch (get_fetch_recurse_config(submodule, spf))
1252                 {
1253                 default:
1254                 case RECURSE_SUBMODULES_DEFAULT:
1255                 case RECURSE_SUBMODULES_ON_DEMAND:
1256                         if (!submodule || !unsorted_string_list_lookup(&changed_submodule_names,
1257                                                          submodule->name))
1258                                 continue;
1259                         default_argv = "on-demand";
1260                         break;
1261                 case RECURSE_SUBMODULES_ON:
1262                         default_argv = "yes";
1263                         break;
1264                 case RECURSE_SUBMODULES_OFF:
1265                         continue;
1266                 }
1267
1268                 strbuf_repo_worktree_path(&submodule_path, spf->r, "%s", ce->name);
1269                 strbuf_addf(&submodule_git_dir, "%s/.git", submodule_path.buf);
1270                 strbuf_addf(&submodule_prefix, "%s%s/", spf->prefix, ce->name);
1271                 git_dir = read_gitfile(submodule_git_dir.buf);
1272                 if (!git_dir)
1273                         git_dir = submodule_git_dir.buf;
1274                 if (is_directory(git_dir)) {
1275                         child_process_init(cp);
1276                         cp->dir = strbuf_detach(&submodule_path, NULL);
1277                         prepare_submodule_repo_env(&cp->env_array);
1278                         cp->git_cmd = 1;
1279                         if (!spf->quiet)
1280                                 strbuf_addf(err, "Fetching submodule %s%s\n",
1281                                             spf->prefix, ce->name);
1282                         argv_array_init(&cp->args);
1283                         argv_array_pushv(&cp->args, spf->args.argv);
1284                         argv_array_push(&cp->args, default_argv);
1285                         argv_array_push(&cp->args, "--submodule-prefix");
1286                         argv_array_push(&cp->args, submodule_prefix.buf);
1287                         ret = 1;
1288                 }
1289                 strbuf_release(&submodule_path);
1290                 strbuf_release(&submodule_git_dir);
1291                 strbuf_release(&submodule_prefix);
1292                 if (ret) {
1293                         spf->count++;
1294                         return 1;
1295                 }
1296         }
1297         return 0;
1298 }
1299
1300 static int fetch_start_failure(struct strbuf *err,
1301                                void *cb, void *task_cb)
1302 {
1303         struct submodule_parallel_fetch *spf = cb;
1304
1305         spf->result = 1;
1306
1307         return 0;
1308 }
1309
1310 static int fetch_finish(int retvalue, struct strbuf *err,
1311                         void *cb, void *task_cb)
1312 {
1313         struct submodule_parallel_fetch *spf = cb;
1314
1315         if (retvalue)
1316                 spf->result = 1;
1317
1318         return 0;
1319 }
1320
1321 int fetch_populated_submodules(struct repository *r,
1322                                const struct argv_array *options,
1323                                const char *prefix, int command_line_option,
1324                                int default_option,
1325                                int quiet, int max_parallel_jobs)
1326 {
1327         int i;
1328         struct submodule_parallel_fetch spf = SPF_INIT;
1329
1330         spf.r = r;
1331         spf.command_line_option = command_line_option;
1332         spf.default_option = default_option;
1333         spf.quiet = quiet;
1334         spf.prefix = prefix;
1335
1336         if (!r->worktree)
1337                 goto out;
1338
1339         if (repo_read_index(r) < 0)
1340                 die("index file corrupt");
1341
1342         argv_array_push(&spf.args, "fetch");
1343         for (i = 0; i < options->argc; i++)
1344                 argv_array_push(&spf.args, options->argv[i]);
1345         argv_array_push(&spf.args, "--recurse-submodules-default");
1346         /* default value, "--submodule-prefix" and its value are added later */
1347
1348         calculate_changed_submodule_paths();
1349         run_processes_parallel(max_parallel_jobs,
1350                                get_next_submodule,
1351                                fetch_start_failure,
1352                                fetch_finish,
1353                                &spf);
1354
1355         argv_array_clear(&spf.args);
1356 out:
1357         string_list_clear(&changed_submodule_names, 1);
1358         return spf.result;
1359 }
1360
1361 unsigned is_submodule_modified(const char *path, int ignore_untracked)
1362 {
1363         struct child_process cp = CHILD_PROCESS_INIT;
1364         struct strbuf buf = STRBUF_INIT;
1365         FILE *fp;
1366         unsigned dirty_submodule = 0;
1367         const char *git_dir;
1368         int ignore_cp_exit_code = 0;
1369
1370         strbuf_addf(&buf, "%s/.git", path);
1371         git_dir = read_gitfile(buf.buf);
1372         if (!git_dir)
1373                 git_dir = buf.buf;
1374         if (!is_git_directory(git_dir)) {
1375                 if (is_directory(git_dir))
1376                         die(_("'%s' not recognized as a git repository"), git_dir);
1377                 strbuf_release(&buf);
1378                 /* The submodule is not checked out, so it is not modified */
1379                 return 0;
1380         }
1381         strbuf_reset(&buf);
1382
1383         argv_array_pushl(&cp.args, "status", "--porcelain=2", NULL);
1384         if (ignore_untracked)
1385                 argv_array_push(&cp.args, "-uno");
1386
1387         prepare_submodule_repo_env(&cp.env_array);
1388         cp.git_cmd = 1;
1389         cp.no_stdin = 1;
1390         cp.out = -1;
1391         cp.dir = path;
1392         if (start_command(&cp))
1393                 die("Could not run 'git status --porcelain=2' in submodule %s", path);
1394
1395         fp = xfdopen(cp.out, "r");
1396         while (strbuf_getwholeline(&buf, fp, '\n') != EOF) {
1397                 /* regular untracked files */
1398                 if (buf.buf[0] == '?')
1399                         dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1400
1401                 if (buf.buf[0] == 'u' ||
1402                     buf.buf[0] == '1' ||
1403                     buf.buf[0] == '2') {
1404                         /* T = line type, XY = status, SSSS = submodule state */
1405                         if (buf.len < strlen("T XY SSSS"))
1406                                 BUG("invalid status --porcelain=2 line %s",
1407                                     buf.buf);
1408
1409                         if (buf.buf[5] == 'S' && buf.buf[8] == 'U')
1410                                 /* nested untracked file */
1411                                 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1412
1413                         if (buf.buf[0] == 'u' ||
1414                             buf.buf[0] == '2' ||
1415                             memcmp(buf.buf + 5, "S..U", 4))
1416                                 /* other change */
1417                                 dirty_submodule |= DIRTY_SUBMODULE_MODIFIED;
1418                 }
1419
1420                 if ((dirty_submodule & DIRTY_SUBMODULE_MODIFIED) &&
1421                     ((dirty_submodule & DIRTY_SUBMODULE_UNTRACKED) ||
1422                      ignore_untracked)) {
1423                         /*
1424                          * We're not interested in any further information from
1425                          * the child any more, neither output nor its exit code.
1426                          */
1427                         ignore_cp_exit_code = 1;
1428                         break;
1429                 }
1430         }
1431         fclose(fp);
1432
1433         if (finish_command(&cp) && !ignore_cp_exit_code)
1434                 die("'git status --porcelain=2' failed in submodule %s", path);
1435
1436         strbuf_release(&buf);
1437         return dirty_submodule;
1438 }
1439
1440 int submodule_uses_gitfile(const char *path)
1441 {
1442         struct child_process cp = CHILD_PROCESS_INIT;
1443         const char *argv[] = {
1444                 "submodule",
1445                 "foreach",
1446                 "--quiet",
1447                 "--recursive",
1448                 "test -f .git",
1449                 NULL,
1450         };
1451         struct strbuf buf = STRBUF_INIT;
1452         const char *git_dir;
1453
1454         strbuf_addf(&buf, "%s/.git", path);
1455         git_dir = read_gitfile(buf.buf);
1456         if (!git_dir) {
1457                 strbuf_release(&buf);
1458                 return 0;
1459         }
1460         strbuf_release(&buf);
1461
1462         /* Now test that all nested submodules use a gitfile too */
1463         cp.argv = argv;
1464         prepare_submodule_repo_env(&cp.env_array);
1465         cp.git_cmd = 1;
1466         cp.no_stdin = 1;
1467         cp.no_stderr = 1;
1468         cp.no_stdout = 1;
1469         cp.dir = path;
1470         if (run_command(&cp))
1471                 return 0;
1472
1473         return 1;
1474 }
1475
1476 /*
1477  * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
1478  * when doing so.
1479  *
1480  * Return 1 if we'd lose data, return 0 if the removal is fine,
1481  * and negative values for errors.
1482  */
1483 int bad_to_remove_submodule(const char *path, unsigned flags)
1484 {
1485         ssize_t len;
1486         struct child_process cp = CHILD_PROCESS_INIT;
1487         struct strbuf buf = STRBUF_INIT;
1488         int ret = 0;
1489
1490         if (!file_exists(path) || is_empty_dir(path))
1491                 return 0;
1492
1493         if (!submodule_uses_gitfile(path))
1494                 return 1;
1495
1496         argv_array_pushl(&cp.args, "status", "--porcelain",
1497                                    "--ignore-submodules=none", NULL);
1498
1499         if (flags & SUBMODULE_REMOVAL_IGNORE_UNTRACKED)
1500                 argv_array_push(&cp.args, "-uno");
1501         else
1502                 argv_array_push(&cp.args, "-uall");
1503
1504         if (!(flags & SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED))
1505                 argv_array_push(&cp.args, "--ignored");
1506
1507         prepare_submodule_repo_env(&cp.env_array);
1508         cp.git_cmd = 1;
1509         cp.no_stdin = 1;
1510         cp.out = -1;
1511         cp.dir = path;
1512         if (start_command(&cp)) {
1513                 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
1514                         die(_("could not start 'git status' in submodule '%s'"),
1515                                 path);
1516                 ret = -1;
1517                 goto out;
1518         }
1519
1520         len = strbuf_read(&buf, cp.out, 1024);
1521         if (len > 2)
1522                 ret = 1;
1523         close(cp.out);
1524
1525         if (finish_command(&cp)) {
1526                 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
1527                         die(_("could not run 'git status' in submodule '%s'"),
1528                                 path);
1529                 ret = -1;
1530         }
1531 out:
1532         strbuf_release(&buf);
1533         return ret;
1534 }
1535
1536 static const char *get_super_prefix_or_empty(void)
1537 {
1538         const char *s = get_super_prefix();
1539         if (!s)
1540                 s = "";
1541         return s;
1542 }
1543
1544 static int submodule_has_dirty_index(const struct submodule *sub)
1545 {
1546         struct child_process cp = CHILD_PROCESS_INIT;
1547
1548         prepare_submodule_repo_env(&cp.env_array);
1549
1550         cp.git_cmd = 1;
1551         argv_array_pushl(&cp.args, "diff-index", "--quiet",
1552                                    "--cached", "HEAD", NULL);
1553         cp.no_stdin = 1;
1554         cp.no_stdout = 1;
1555         cp.dir = sub->path;
1556         if (start_command(&cp))
1557                 die("could not recurse into submodule '%s'", sub->path);
1558
1559         return finish_command(&cp);
1560 }
1561
1562 static void submodule_reset_index(const char *path)
1563 {
1564         struct child_process cp = CHILD_PROCESS_INIT;
1565         prepare_submodule_repo_env(&cp.env_array);
1566
1567         cp.git_cmd = 1;
1568         cp.no_stdin = 1;
1569         cp.dir = path;
1570
1571         argv_array_pushf(&cp.args, "--super-prefix=%s%s/",
1572                                    get_super_prefix_or_empty(), path);
1573         argv_array_pushl(&cp.args, "read-tree", "-u", "--reset", NULL);
1574
1575         argv_array_push(&cp.args, empty_tree_oid_hex());
1576
1577         if (run_command(&cp))
1578                 die("could not reset submodule index");
1579 }
1580
1581 /**
1582  * Moves a submodule at a given path from a given head to another new head.
1583  * For edge cases (a submodule coming into existence or removing a submodule)
1584  * pass NULL for old or new respectively.
1585  */
1586 int submodule_move_head(const char *path,
1587                          const char *old_head,
1588                          const char *new_head,
1589                          unsigned flags)
1590 {
1591         int ret = 0;
1592         struct child_process cp = CHILD_PROCESS_INIT;
1593         const struct submodule *sub;
1594         int *error_code_ptr, error_code;
1595
1596         if (!is_submodule_active(the_repository, path))
1597                 return 0;
1598
1599         if (flags & SUBMODULE_MOVE_HEAD_FORCE)
1600                 /*
1601                  * Pass non NULL pointer to is_submodule_populated_gently
1602                  * to prevent die()-ing. We'll use connect_work_tree_and_git_dir
1603                  * to fixup the submodule in the force case later.
1604                  */
1605                 error_code_ptr = &error_code;
1606         else
1607                 error_code_ptr = NULL;
1608
1609         if (old_head && !is_submodule_populated_gently(path, error_code_ptr))
1610                 return 0;
1611
1612         sub = submodule_from_path(the_repository, &null_oid, path);
1613
1614         if (!sub)
1615                 BUG("could not get submodule information for '%s'", path);
1616
1617         if (old_head && !(flags & SUBMODULE_MOVE_HEAD_FORCE)) {
1618                 /* Check if the submodule has a dirty index. */
1619                 if (submodule_has_dirty_index(sub))
1620                         return error(_("submodule '%s' has dirty index"), path);
1621         }
1622
1623         if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
1624                 if (old_head) {
1625                         if (!submodule_uses_gitfile(path))
1626                                 absorb_git_dir_into_superproject("", path,
1627                                         ABSORB_GITDIR_RECURSE_SUBMODULES);
1628                 } else {
1629                         char *gitdir = xstrfmt("%s/modules/%s",
1630                                     get_git_common_dir(), sub->name);
1631                         connect_work_tree_and_git_dir(path, gitdir, 0);
1632                         free(gitdir);
1633
1634                         /* make sure the index is clean as well */
1635                         submodule_reset_index(path);
1636                 }
1637
1638                 if (old_head && (flags & SUBMODULE_MOVE_HEAD_FORCE)) {
1639                         char *gitdir = xstrfmt("%s/modules/%s",
1640                                     get_git_common_dir(), sub->name);
1641                         connect_work_tree_and_git_dir(path, gitdir, 1);
1642                         free(gitdir);
1643                 }
1644         }
1645
1646         prepare_submodule_repo_env(&cp.env_array);
1647
1648         cp.git_cmd = 1;
1649         cp.no_stdin = 1;
1650         cp.dir = path;
1651
1652         argv_array_pushf(&cp.args, "--super-prefix=%s%s/",
1653                         get_super_prefix_or_empty(), path);
1654         argv_array_pushl(&cp.args, "read-tree", "--recurse-submodules", NULL);
1655
1656         if (flags & SUBMODULE_MOVE_HEAD_DRY_RUN)
1657                 argv_array_push(&cp.args, "-n");
1658         else
1659                 argv_array_push(&cp.args, "-u");
1660
1661         if (flags & SUBMODULE_MOVE_HEAD_FORCE)
1662                 argv_array_push(&cp.args, "--reset");
1663         else
1664                 argv_array_push(&cp.args, "-m");
1665
1666         if (!(flags & SUBMODULE_MOVE_HEAD_FORCE))
1667                 argv_array_push(&cp.args, old_head ? old_head : empty_tree_oid_hex());
1668
1669         argv_array_push(&cp.args, new_head ? new_head : empty_tree_oid_hex());
1670
1671         if (run_command(&cp)) {
1672                 ret = error(_("Submodule '%s' could not be updated."), path);
1673                 goto out;
1674         }
1675
1676         if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
1677                 if (new_head) {
1678                         child_process_init(&cp);
1679                         /* also set the HEAD accordingly */
1680                         cp.git_cmd = 1;
1681                         cp.no_stdin = 1;
1682                         cp.dir = path;
1683
1684                         prepare_submodule_repo_env(&cp.env_array);
1685                         argv_array_pushl(&cp.args, "update-ref", "HEAD",
1686                                          "--no-deref", new_head, NULL);
1687
1688                         if (run_command(&cp)) {
1689                                 ret = -1;
1690                                 goto out;
1691                         }
1692                 } else {
1693                         struct strbuf sb = STRBUF_INIT;
1694
1695                         strbuf_addf(&sb, "%s/.git", path);
1696                         unlink_or_warn(sb.buf);
1697                         strbuf_release(&sb);
1698
1699                         if (is_empty_dir(path))
1700                                 rmdir_or_warn(path);
1701                 }
1702         }
1703 out:
1704         return ret;
1705 }
1706
1707 int validate_submodule_git_dir(char *git_dir, const char *submodule_name)
1708 {
1709         size_t len = strlen(git_dir), suffix_len = strlen(submodule_name);
1710         char *p;
1711         int ret = 0;
1712
1713         if (len <= suffix_len || (p = git_dir + len - suffix_len)[-1] != '/' ||
1714             strcmp(p, submodule_name))
1715                 BUG("submodule name '%s' not a suffix of git dir '%s'",
1716                     submodule_name, git_dir);
1717
1718         /*
1719          * We prevent the contents of sibling submodules' git directories to
1720          * clash.
1721          *
1722          * Example: having a submodule named `hippo` and another one named
1723          * `hippo/hooks` would result in the git directories
1724          * `.git/modules/hippo/` and `.git/modules/hippo/hooks/`, respectively,
1725          * but the latter directory is already designated to contain the hooks
1726          * of the former.
1727          */
1728         for (; *p; p++) {
1729                 if (is_dir_sep(*p)) {
1730                         char c = *p;
1731
1732                         *p = '\0';
1733                         if (is_git_directory(git_dir))
1734                                 ret = -1;
1735                         *p = c;
1736
1737                         if (ret < 0)
1738                                 return error(_("submodule git dir '%s' is "
1739                                                "inside git dir '%.*s'"),
1740                                              git_dir,
1741                                              (int)(p - git_dir), git_dir);
1742                 }
1743         }
1744
1745         return 0;
1746 }
1747
1748 /*
1749  * Embeds a single submodules git directory into the superprojects git dir,
1750  * non recursively.
1751  */
1752 static void relocate_single_git_dir_into_superproject(const char *prefix,
1753                                                       const char *path)
1754 {
1755         char *old_git_dir = NULL, *real_old_git_dir = NULL, *real_new_git_dir = NULL;
1756         char *new_git_dir;
1757         const struct submodule *sub;
1758
1759         if (submodule_uses_worktrees(path))
1760                 die(_("relocate_gitdir for submodule '%s' with "
1761                       "more than one worktree not supported"), path);
1762
1763         old_git_dir = xstrfmt("%s/.git", path);
1764         if (read_gitfile(old_git_dir))
1765                 /* If it is an actual gitfile, it doesn't need migration. */
1766                 return;
1767
1768         real_old_git_dir = real_pathdup(old_git_dir, 1);
1769
1770         sub = submodule_from_path(the_repository, &null_oid, path);
1771         if (!sub)
1772                 die(_("could not lookup name for submodule '%s'"), path);
1773
1774         new_git_dir = git_pathdup("modules/%s", sub->name);
1775         if (validate_submodule_git_dir(new_git_dir, sub->name) < 0)
1776                 die(_("refusing to move '%s' into an existing git dir"),
1777                     real_old_git_dir);
1778         if (safe_create_leading_directories_const(new_git_dir) < 0)
1779                 die(_("could not create directory '%s'"), new_git_dir);
1780         real_new_git_dir = real_pathdup(new_git_dir, 1);
1781         free(new_git_dir);
1782
1783         fprintf(stderr, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
1784                 get_super_prefix_or_empty(), path,
1785                 real_old_git_dir, real_new_git_dir);
1786
1787         relocate_gitdir(path, real_old_git_dir, real_new_git_dir);
1788
1789         free(old_git_dir);
1790         free(real_old_git_dir);
1791         free(real_new_git_dir);
1792 }
1793
1794 /*
1795  * Migrate the git directory of the submodule given by path from
1796  * having its git directory within the working tree to the git dir nested
1797  * in its superprojects git dir under modules/.
1798  */
1799 void absorb_git_dir_into_superproject(const char *prefix,
1800                                       const char *path,
1801                                       unsigned flags)
1802 {
1803         int err_code;
1804         const char *sub_git_dir;
1805         struct strbuf gitdir = STRBUF_INIT;
1806         strbuf_addf(&gitdir, "%s/.git", path);
1807         sub_git_dir = resolve_gitdir_gently(gitdir.buf, &err_code);
1808
1809         /* Not populated? */
1810         if (!sub_git_dir) {
1811                 const struct submodule *sub;
1812
1813                 if (err_code == READ_GITFILE_ERR_STAT_FAILED) {
1814                         /* unpopulated as expected */
1815                         strbuf_release(&gitdir);
1816                         return;
1817                 }
1818
1819                 if (err_code != READ_GITFILE_ERR_NOT_A_REPO)
1820                         /* We don't know what broke here. */
1821                         read_gitfile_error_die(err_code, path, NULL);
1822
1823                 /*
1824                 * Maybe populated, but no git directory was found?
1825                 * This can happen if the superproject is a submodule
1826                 * itself and was just absorbed. The absorption of the
1827                 * superproject did not rewrite the git file links yet,
1828                 * fix it now.
1829                 */
1830                 sub = submodule_from_path(the_repository, &null_oid, path);
1831                 if (!sub)
1832                         die(_("could not lookup name for submodule '%s'"), path);
1833                 connect_work_tree_and_git_dir(path,
1834                         git_path("modules/%s", sub->name), 0);
1835         } else {
1836                 /* Is it already absorbed into the superprojects git dir? */
1837                 char *real_sub_git_dir = real_pathdup(sub_git_dir, 1);
1838                 char *real_common_git_dir = real_pathdup(get_git_common_dir(), 1);
1839
1840                 if (!starts_with(real_sub_git_dir, real_common_git_dir))
1841                         relocate_single_git_dir_into_superproject(prefix, path);
1842
1843                 free(real_sub_git_dir);
1844                 free(real_common_git_dir);
1845         }
1846         strbuf_release(&gitdir);
1847
1848         if (flags & ABSORB_GITDIR_RECURSE_SUBMODULES) {
1849                 struct child_process cp = CHILD_PROCESS_INIT;
1850                 struct strbuf sb = STRBUF_INIT;
1851
1852                 if (flags & ~ABSORB_GITDIR_RECURSE_SUBMODULES)
1853                         BUG("we don't know how to pass the flags down?");
1854
1855                 strbuf_addstr(&sb, get_super_prefix_or_empty());
1856                 strbuf_addstr(&sb, path);
1857                 strbuf_addch(&sb, '/');
1858
1859                 cp.dir = path;
1860                 cp.git_cmd = 1;
1861                 cp.no_stdin = 1;
1862                 argv_array_pushl(&cp.args, "--super-prefix", sb.buf,
1863                                            "submodule--helper",
1864                                            "absorb-git-dirs", NULL);
1865                 prepare_submodule_repo_env(&cp.env_array);
1866                 if (run_command(&cp))
1867                         die(_("could not recurse into submodule '%s'"), path);
1868
1869                 strbuf_release(&sb);
1870         }
1871 }
1872
1873 const char *get_superproject_working_tree(void)
1874 {
1875         struct child_process cp = CHILD_PROCESS_INIT;
1876         struct strbuf sb = STRBUF_INIT;
1877         const char *one_up = real_path_if_valid("../");
1878         const char *cwd = xgetcwd();
1879         const char *ret = NULL;
1880         const char *subpath;
1881         int code;
1882         ssize_t len;
1883
1884         if (!is_inside_work_tree())
1885                 /*
1886                  * FIXME:
1887                  * We might have a superproject, but it is harder
1888                  * to determine.
1889                  */
1890                 return NULL;
1891
1892         if (!one_up)
1893                 return NULL;
1894
1895         subpath = relative_path(cwd, one_up, &sb);
1896
1897         prepare_submodule_repo_env(&cp.env_array);
1898         argv_array_pop(&cp.env_array);
1899
1900         argv_array_pushl(&cp.args, "--literal-pathspecs", "-C", "..",
1901                         "ls-files", "-z", "--stage", "--full-name", "--",
1902                         subpath, NULL);
1903         strbuf_reset(&sb);
1904
1905         cp.no_stdin = 1;
1906         cp.no_stderr = 1;
1907         cp.out = -1;
1908         cp.git_cmd = 1;
1909
1910         if (start_command(&cp))
1911                 die(_("could not start ls-files in .."));
1912
1913         len = strbuf_read(&sb, cp.out, PATH_MAX);
1914         close(cp.out);
1915
1916         if (starts_with(sb.buf, "160000")) {
1917                 int super_sub_len;
1918                 int cwd_len = strlen(cwd);
1919                 char *super_sub, *super_wt;
1920
1921                 /*
1922                  * There is a superproject having this repo as a submodule.
1923                  * The format is <mode> SP <hash> SP <stage> TAB <full name> \0,
1924                  * We're only interested in the name after the tab.
1925                  */
1926                 super_sub = strchr(sb.buf, '\t') + 1;
1927                 super_sub_len = strlen(super_sub);
1928
1929                 if (super_sub_len > cwd_len ||
1930                     strcmp(&cwd[cwd_len - super_sub_len], super_sub))
1931                         BUG("returned path string doesn't match cwd?");
1932
1933                 super_wt = xstrdup(cwd);
1934                 super_wt[cwd_len - super_sub_len] = '\0';
1935
1936                 ret = real_path(super_wt);
1937                 free(super_wt);
1938         }
1939         strbuf_release(&sb);
1940
1941         code = finish_command(&cp);
1942
1943         if (code == 128)
1944                 /* '../' is not a git repository */
1945                 return NULL;
1946         if (code == 0 && len == 0)
1947                 /* There is an unrelated git repository at '../' */
1948                 return NULL;
1949         if (code)
1950                 die(_("ls-tree returned unexpected return code %d"), code);
1951
1952         return ret;
1953 }
1954
1955 /*
1956  * Put the gitdir for a submodule (given relative to the main
1957  * repository worktree) into `buf`, or return -1 on error.
1958  */
1959 int submodule_to_gitdir(struct strbuf *buf, const char *submodule)
1960 {
1961         const struct submodule *sub;
1962         const char *git_dir;
1963         int ret = 0;
1964
1965         strbuf_reset(buf);
1966         strbuf_addstr(buf, submodule);
1967         strbuf_complete(buf, '/');
1968         strbuf_addstr(buf, ".git");
1969
1970         git_dir = read_gitfile(buf->buf);
1971         if (git_dir) {
1972                 strbuf_reset(buf);
1973                 strbuf_addstr(buf, git_dir);
1974         }
1975         if (!is_git_directory(buf->buf)) {
1976                 sub = submodule_from_path(the_repository, &null_oid, submodule);
1977                 if (!sub) {
1978                         ret = -1;
1979                         goto cleanup;
1980                 }
1981                 strbuf_reset(buf);
1982                 strbuf_git_path(buf, "%s/%s", "modules", sub->name);
1983         }
1984
1985 cleanup:
1986         return ret;
1987 }