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