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