git.oblomov.eu Git - git/blob - submodule.c

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