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