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