Andrew's git / gitweb.git / builtin/submodule--helper.c
?
builtin / submodule--helper.con commit submodule--helper: plug mem leak in print_default_remote (e6be8e2)
   1#include "builtin.h"
   2#include "repository.h"
   3#include "cache.h"
   4#include "config.h"
   5#include "parse-options.h"
   6#include "quote.h"
   7#include "pathspec.h"
   8#include "dir.h"
   9#include "submodule.h"
  10#include "submodule-config.h"
  11#include "string-list.h"
  12#include "run-command.h"
  13#include "remote.h"
  14#include "refs.h"
  15#include "refspec.h"
  16#include "connect.h"
  17#include "revision.h"
  18#include "diffcore.h"
  19#include "diff.h"
  20#include "object-store.h"
  21
  22#define OPT_QUIET (1 << 0)
  23#define OPT_CACHED (1 << 1)
  24#define OPT_RECURSIVE (1 << 2)
  25#define OPT_FORCE (1 << 3)
  26
  27typedef void (*each_submodule_fn)(const struct cache_entry *list_item,
  28                                  void *cb_data);
  29
  30static char *get_default_remote(void)
  31{
  32        char *dest = NULL, *ret;
  33        struct strbuf sb = STRBUF_INIT;
  34        const char *refname = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
  35
  36        if (!refname)
  37                die(_("No such ref: %s"), "HEAD");
  38
  39        /* detached HEAD */
  40        if (!strcmp(refname, "HEAD"))
  41                return xstrdup("origin");
  42
  43        if (!skip_prefix(refname, "refs/heads/", &refname))
  44                die(_("Expecting a full ref name, got %s"), refname);
  45
  46        strbuf_addf(&sb, "branch.%s.remote", refname);
  47        if (git_config_get_string(sb.buf, &dest))
  48                ret = xstrdup("origin");
  49        else
  50                ret = dest;
  51
  52        strbuf_release(&sb);
  53        return ret;
  54}
  55
  56static int print_default_remote(int argc, const char **argv, const char *prefix)
  57{
  58        char *remote;
  59
  60        if (argc != 1)
  61                die(_("submodule--helper print-default-remote takes no arguments"));
  62
  63        remote = get_default_remote();
  64        if (remote)
  65                printf("%s\n", remote);
  66
  67        free(remote);
  68        return 0;
  69}
  70
  71static int starts_with_dot_slash(const char *str)
  72{
  73        return str[0] == '.' && is_dir_sep(str[1]);
  74}
  75
  76static int starts_with_dot_dot_slash(const char *str)
  77{
  78        return str[0] == '.' && str[1] == '.' && is_dir_sep(str[2]);
  79}
  80
  81/*
  82 * Returns 1 if it was the last chop before ':'.
  83 */
  84static int chop_last_dir(char **remoteurl, int is_relative)
  85{
  86        char *rfind = find_last_dir_sep(*remoteurl);
  87        if (rfind) {
  88                *rfind = '\0';
  89                return 0;
  90        }
  91
  92        rfind = strrchr(*remoteurl, ':');
  93        if (rfind) {
  94                *rfind = '\0';
  95                return 1;
  96        }
  97
  98        if (is_relative || !strcmp(".", *remoteurl))
  99                die(_("cannot strip one component off url '%s'"),
 100                        *remoteurl);
 101
 102        free(*remoteurl);
 103        *remoteurl = xstrdup(".");
 104        return 0;
 105}
 106
 107/*
 108 * The `url` argument is the URL that navigates to the submodule origin
 109 * repo. When relative, this URL is relative to the superproject origin
 110 * URL repo. The `up_path` argument, if specified, is the relative
 111 * path that navigates from the submodule working tree to the superproject
 112 * working tree. Returns the origin URL of the submodule.
 113 *
 114 * Return either an absolute URL or filesystem path (if the superproject
 115 * origin URL is an absolute URL or filesystem path, respectively) or a
 116 * relative file system path (if the superproject origin URL is a relative
 117 * file system path).
 118 *
 119 * When the output is a relative file system path, the path is either
 120 * relative to the submodule working tree, if up_path is specified, or to
 121 * the superproject working tree otherwise.
 122 *
 123 * NEEDSWORK: This works incorrectly on the domain and protocol part.
 124 * remote_url      url              outcome          expectation
 125 * http://a.com/b  ../c             http://a.com/c   as is
 126 * http://a.com/b/ ../c             http://a.com/c   same as previous line, but
 127 *                                                   ignore trailing slash in url
 128 * http://a.com/b  ../../c          http://c         error out
 129 * http://a.com/b  ../../../c       http:/c          error out
 130 * http://a.com/b  ../../../../c    http:c           error out
 131 * http://a.com/b  ../../../../../c    .:c           error out
 132 * NEEDSWORK: Given how chop_last_dir() works, this function is broken
 133 * when a local part has a colon in its path component, too.
 134 */
 135static char *relative_url(const char *remote_url,
 136                                const char *url,
 137                                const char *up_path)
 138{
 139        int is_relative = 0;
 140        int colonsep = 0;
 141        char *out;
 142        char *remoteurl = xstrdup(remote_url);
 143        struct strbuf sb = STRBUF_INIT;
 144        size_t len = strlen(remoteurl);
 145
 146        if (is_dir_sep(remoteurl[len-1]))
 147                remoteurl[len-1] = '\0';
 148
 149        if (!url_is_local_not_ssh(remoteurl) || is_absolute_path(remoteurl))
 150                is_relative = 0;
 151        else {
 152                is_relative = 1;
 153                /*
 154                 * Prepend a './' to ensure all relative
 155                 * remoteurls start with './' or '../'
 156                 */
 157                if (!starts_with_dot_slash(remoteurl) &&
 158                    !starts_with_dot_dot_slash(remoteurl)) {
 159                        strbuf_reset(&sb);
 160                        strbuf_addf(&sb, "./%s", remoteurl);
 161                        free(remoteurl);
 162                        remoteurl = strbuf_detach(&sb, NULL);
 163                }
 164        }
 165        /*
 166         * When the url starts with '../', remove that and the
 167         * last directory in remoteurl.
 168         */
 169        while (url) {
 170                if (starts_with_dot_dot_slash(url)) {
 171                        url += 3;
 172                        colonsep |= chop_last_dir(&remoteurl, is_relative);
 173                } else if (starts_with_dot_slash(url))
 174                        url += 2;
 175                else
 176                        break;
 177        }
 178        strbuf_reset(&sb);
 179        strbuf_addf(&sb, "%s%s%s", remoteurl, colonsep ? ":" : "/", url);
 180        if (ends_with(url, "/"))
 181                strbuf_setlen(&sb, sb.len - 1);
 182        free(remoteurl);
 183
 184        if (starts_with_dot_slash(sb.buf))
 185                out = xstrdup(sb.buf + 2);
 186        else
 187                out = xstrdup(sb.buf);
 188        strbuf_reset(&sb);
 189
 190        if (!up_path || !is_relative)
 191                return out;
 192
 193        strbuf_addf(&sb, "%s%s", up_path, out);
 194        free(out);
 195        return strbuf_detach(&sb, NULL);
 196}
 197
 198static int resolve_relative_url(int argc, const char **argv, const char *prefix)
 199{
 200        char *remoteurl = NULL;
 201        char *remote = get_default_remote();
 202        const char *up_path = NULL;
 203        char *res;
 204        const char *url;
 205        struct strbuf sb = STRBUF_INIT;
 206
 207        if (argc != 2 && argc != 3)
 208                die("resolve-relative-url only accepts one or two arguments");
 209
 210        url = argv[1];
 211        strbuf_addf(&sb, "remote.%s.url", remote);
 212        free(remote);
 213
 214        if (git_config_get_string(sb.buf, &remoteurl))
 215                /* the repository is its own authoritative upstream */
 216                remoteurl = xgetcwd();
 217
 218        if (argc == 3)
 219                up_path = argv[2];
 220
 221        res = relative_url(remoteurl, url, up_path);
 222        puts(res);
 223        free(res);
 224        free(remoteurl);
 225        return 0;
 226}
 227
 228static int resolve_relative_url_test(int argc, const char **argv, const char *prefix)
 229{
 230        char *remoteurl, *res;
 231        const char *up_path, *url;
 232
 233        if (argc != 4)
 234                die("resolve-relative-url-test only accepts three arguments: <up_path> <remoteurl> <url>");
 235
 236        up_path = argv[1];
 237        remoteurl = xstrdup(argv[2]);
 238        url = argv[3];
 239
 240        if (!strcmp(up_path, "(null)"))
 241                up_path = NULL;
 242
 243        res = relative_url(remoteurl, url, up_path);
 244        puts(res);
 245        free(res);
 246        free(remoteurl);
 247        return 0;
 248}
 249
 250/* the result should be freed by the caller. */
 251static char *get_submodule_displaypath(const char *path, const char *prefix)
 252{
 253        const char *super_prefix = get_super_prefix();
 254
 255        if (prefix && super_prefix) {
 256                BUG("cannot have prefix '%s' and superprefix '%s'",
 257                    prefix, super_prefix);
 258        } else if (prefix) {
 259                struct strbuf sb = STRBUF_INIT;
 260                char *displaypath = xstrdup(relative_path(path, prefix, &sb));
 261                strbuf_release(&sb);
 262                return displaypath;
 263        } else if (super_prefix) {
 264                return xstrfmt("%s%s", super_prefix, path);
 265        } else {
 266                return xstrdup(path);
 267        }
 268}
 269
 270static char *compute_rev_name(const char *sub_path, const char* object_id)
 271{
 272        struct strbuf sb = STRBUF_INIT;
 273        const char ***d;
 274
 275        static const char *describe_bare[] = { NULL };
 276
 277        static const char *describe_tags[] = { "--tags", NULL };
 278
 279        static const char *describe_contains[] = { "--contains", NULL };
 280
 281        static const char *describe_all_always[] = { "--all", "--always", NULL };
 282
 283        static const char **describe_argv[] = { describe_bare, describe_tags,
 284                                                describe_contains,
 285                                                describe_all_always, NULL };
 286
 287        for (d = describe_argv; *d; d++) {
 288                struct child_process cp = CHILD_PROCESS_INIT;
 289                prepare_submodule_repo_env(&cp.env_array);
 290                cp.dir = sub_path;
 291                cp.git_cmd = 1;
 292                cp.no_stderr = 1;
 293
 294                argv_array_push(&cp.args, "describe");
 295                argv_array_pushv(&cp.args, *d);
 296                argv_array_push(&cp.args, object_id);
 297
 298                if (!capture_command(&cp, &sb, 0)) {
 299                        strbuf_strip_suffix(&sb, "\n");
 300                        return strbuf_detach(&sb, NULL);
 301                }
 302        }
 303
 304        strbuf_release(&sb);
 305        return NULL;
 306}
 307
 308struct module_list {
 309        const struct cache_entry **entries;
 310        int alloc, nr;
 311};
 312#define MODULE_LIST_INIT { NULL, 0, 0 }
 313
 314static int module_list_compute(int argc, const char **argv,
 315                               const char *prefix,
 316                               struct pathspec *pathspec,
 317                               struct module_list *list)
 318{
 319        int i, result = 0;
 320        char *ps_matched = NULL;
 321        parse_pathspec(pathspec, 0,
 322                       PATHSPEC_PREFER_FULL,
 323                       prefix, argv);
 324
 325        if (pathspec->nr)
 326                ps_matched = xcalloc(pathspec->nr, 1);
 327
 328        if (read_cache() < 0)
 329                die(_("index file corrupt"));
 330
 331        for (i = 0; i < active_nr; i++) {
 332                const struct cache_entry *ce = active_cache[i];
 333
 334                if (!match_pathspec(pathspec, ce->name, ce_namelen(ce),
 335                                    0, ps_matched, 1) ||
 336                    !S_ISGITLINK(ce->ce_mode))
 337                        continue;
 338
 339                ALLOC_GROW(list->entries, list->nr + 1, list->alloc);
 340                list->entries[list->nr++] = ce;
 341                while (i + 1 < active_nr &&
 342                       !strcmp(ce->name, active_cache[i + 1]->name))
 343                        /*
 344                         * Skip entries with the same name in different stages
 345                         * to make sure an entry is returned only once.
 346                         */
 347                        i++;
 348        }
 349
 350        if (ps_matched && report_path_error(ps_matched, pathspec, prefix))
 351                result = -1;
 352
 353        free(ps_matched);
 354
 355        return result;
 356}
 357
 358static void module_list_active(struct module_list *list)
 359{
 360        int i;
 361        struct module_list active_modules = MODULE_LIST_INIT;
 362
 363        for (i = 0; i < list->nr; i++) {
 364                const struct cache_entry *ce = list->entries[i];
 365
 366                if (!is_submodule_active(the_repository, ce->name))
 367                        continue;
 368
 369                ALLOC_GROW(active_modules.entries,
 370                           active_modules.nr + 1,
 371                           active_modules.alloc);
 372                active_modules.entries[active_modules.nr++] = ce;
 373        }
 374
 375        free(list->entries);
 376        *list = active_modules;
 377}
 378
 379static char *get_up_path(const char *path)
 380{
 381        int i;
 382        struct strbuf sb = STRBUF_INIT;
 383
 384        for (i = count_slashes(path); i; i--)
 385                strbuf_addstr(&sb, "../");
 386
 387        /*
 388         * Check if 'path' ends with slash or not
 389         * for having the same output for dir/sub_dir
 390         * and dir/sub_dir/
 391         */
 392        if (!is_dir_sep(path[strlen(path) - 1]))
 393                strbuf_addstr(&sb, "../");
 394
 395        return strbuf_detach(&sb, NULL);
 396}
 397
 398static int module_list(int argc, const char **argv, const char *prefix)
 399{
 400        int i;
 401        struct pathspec pathspec;
 402        struct module_list list = MODULE_LIST_INIT;
 403
 404        struct option module_list_options[] = {
 405                OPT_STRING(0, "prefix", &prefix,
 406                           N_("path"),
 407                           N_("alternative anchor for relative paths")),
 408                OPT_END()
 409        };
 410
 411        const char *const git_submodule_helper_usage[] = {
 412                N_("git submodule--helper list [--prefix=<path>] [<path>...]"),
 413                NULL
 414        };
 415
 416        argc = parse_options(argc, argv, prefix, module_list_options,
 417                             git_submodule_helper_usage, 0);
 418
 419        if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
 420                return 1;
 421
 422        for (i = 0; i < list.nr; i++) {
 423                const struct cache_entry *ce = list.entries[i];
 424
 425                if (ce_stage(ce))
 426                        printf("%06o %s U\t", ce->ce_mode, sha1_to_hex(null_sha1));
 427                else
 428                        printf("%06o %s %d\t", ce->ce_mode,
 429                               oid_to_hex(&ce->oid), ce_stage(ce));
 430
 431                fprintf(stdout, "%s\n", ce->name);
 432        }
 433        return 0;
 434}
 435
 436static void for_each_listed_submodule(const struct module_list *list,
 437                                      each_submodule_fn fn, void *cb_data)
 438{
 439        int i;
 440        for (i = 0; i < list->nr; i++)
 441                fn(list->entries[i], cb_data);
 442}
 443
 444struct init_cb {
 445        const char *prefix;
 446        unsigned int flags;
 447};
 448
 449#define INIT_CB_INIT { NULL, 0 }
 450
 451static void init_submodule(const char *path, const char *prefix,
 452                           unsigned int flags)
 453{
 454        const struct submodule *sub;
 455        struct strbuf sb = STRBUF_INIT;
 456        char *upd = NULL, *url = NULL, *displaypath;
 457
 458        displaypath = get_submodule_displaypath(path, prefix);
 459
 460        sub = submodule_from_path(the_repository, &null_oid, path);
 461
 462        if (!sub)
 463                die(_("No url found for submodule path '%s' in .gitmodules"),
 464                        displaypath);
 465
 466        /*
 467         * NEEDSWORK: In a multi-working-tree world, this needs to be
 468         * set in the per-worktree config.
 469         *
 470         * Set active flag for the submodule being initialized
 471         */
 472        if (!is_submodule_active(the_repository, path)) {
 473                strbuf_addf(&sb, "submodule.%s.active", sub->name);
 474                git_config_set_gently(sb.buf, "true");
 475                strbuf_reset(&sb);
 476        }
 477
 478        /*
 479         * Copy url setting when it is not set yet.
 480         * To look up the url in .git/config, we must not fall back to
 481         * .gitmodules, so look it up directly.
 482         */
 483        strbuf_addf(&sb, "submodule.%s.url", sub->name);
 484        if (git_config_get_string(sb.buf, &url)) {
 485                if (!sub->url)
 486                        die(_("No url found for submodule path '%s' in .gitmodules"),
 487                                displaypath);
 488
 489                url = xstrdup(sub->url);
 490
 491                /* Possibly a url relative to parent */
 492                if (starts_with_dot_dot_slash(url) ||
 493                    starts_with_dot_slash(url)) {
 494                        char *remoteurl, *relurl;
 495                        char *remote = get_default_remote();
 496                        struct strbuf remotesb = STRBUF_INIT;
 497                        strbuf_addf(&remotesb, "remote.%s.url", remote);
 498                        free(remote);
 499
 500                        if (git_config_get_string(remotesb.buf, &remoteurl)) {
 501                                warning(_("could not lookup configuration '%s'. Assuming this repository is its own authoritative upstream."), remotesb.buf);
 502                                remoteurl = xgetcwd();
 503                        }
 504                        relurl = relative_url(remoteurl, url, NULL);
 505                        strbuf_release(&remotesb);
 506                        free(remoteurl);
 507                        free(url);
 508                        url = relurl;
 509                }
 510
 511                if (git_config_set_gently(sb.buf, url))
 512                        die(_("Failed to register url for submodule path '%s'"),
 513                            displaypath);
 514                if (!(flags & OPT_QUIET))
 515                        fprintf(stderr,
 516                                _("Submodule '%s' (%s) registered for path '%s'\n"),
 517                                sub->name, url, displaypath);
 518        }
 519        strbuf_reset(&sb);
 520
 521        /* Copy "update" setting when it is not set yet */
 522        strbuf_addf(&sb, "submodule.%s.update", sub->name);
 523        if (git_config_get_string(sb.buf, &upd) &&
 524            sub->update_strategy.type != SM_UPDATE_UNSPECIFIED) {
 525                if (sub->update_strategy.type == SM_UPDATE_COMMAND) {
 526                        fprintf(stderr, _("warning: command update mode suggested for submodule '%s'\n"),
 527                                sub->name);
 528                        upd = xstrdup("none");
 529                } else
 530                        upd = xstrdup(submodule_strategy_to_string(&sub->update_strategy));
 531
 532                if (git_config_set_gently(sb.buf, upd))
 533                        die(_("Failed to register update mode for submodule path '%s'"), displaypath);
 534        }
 535        strbuf_release(&sb);
 536        free(displaypath);
 537        free(url);
 538        free(upd);
 539}
 540
 541static void init_submodule_cb(const struct cache_entry *list_item, void *cb_data)
 542{
 543        struct init_cb *info = cb_data;
 544        init_submodule(list_item->name, info->prefix, info->flags);
 545}
 546
 547static int module_init(int argc, const char **argv, const char *prefix)
 548{
 549        struct init_cb info = INIT_CB_INIT;
 550        struct pathspec pathspec;
 551        struct module_list list = MODULE_LIST_INIT;
 552        int quiet = 0;
 553
 554        struct option module_init_options[] = {
 555                OPT__QUIET(&quiet, N_("Suppress output for initializing a submodule")),
 556                OPT_END()
 557        };
 558
 559        const char *const git_submodule_helper_usage[] = {
 560                N_("git submodule--helper init [<path>]"),
 561                NULL
 562        };
 563
 564        argc = parse_options(argc, argv, prefix, module_init_options,
 565                             git_submodule_helper_usage, 0);
 566
 567        if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
 568                return 1;
 569
 570        /*
 571         * If there are no path args and submodule.active is set then,
 572         * by default, only initialize 'active' modules.
 573         */
 574        if (!argc && git_config_get_value_multi("submodule.active"))
 575                module_list_active(&list);
 576
 577        info.prefix = prefix;
 578        if (quiet)
 579                info.flags |= OPT_QUIET;
 580
 581        for_each_listed_submodule(&list, init_submodule_cb, &info);
 582
 583        return 0;
 584}
 585
 586struct status_cb {
 587        const char *prefix;
 588        unsigned int flags;
 589};
 590
 591#define STATUS_CB_INIT { NULL, 0 }
 592
 593static void print_status(unsigned int flags, char state, const char *path,
 594                         const struct object_id *oid, const char *displaypath)
 595{
 596        if (flags & OPT_QUIET)
 597                return;
 598
 599        printf("%c%s %s", state, oid_to_hex(oid), displaypath);
 600
 601        if (state == ' ' || state == '+') {
 602                const char *name = compute_rev_name(path, oid_to_hex(oid));
 603
 604                if (name)
 605                        printf(" (%s)", name);
 606        }
 607
 608        printf("\n");
 609}
 610
 611static int handle_submodule_head_ref(const char *refname,
 612                                     const struct object_id *oid, int flags,
 613                                     void *cb_data)
 614{
 615        struct object_id *output = cb_data;
 616        if (oid)
 617                oidcpy(output, oid);
 618
 619        return 0;
 620}
 621
 622static void status_submodule(const char *path, const struct object_id *ce_oid,
 623                             unsigned int ce_flags, const char *prefix,
 624                             unsigned int flags)
 625{
 626        char *displaypath;
 627        struct argv_array diff_files_args = ARGV_ARRAY_INIT;
 628        struct rev_info rev;
 629        int diff_files_result;
 630
 631        if (!submodule_from_path(the_repository, &null_oid, path))
 632                die(_("no submodule mapping found in .gitmodules for path '%s'"),
 633                      path);
 634
 635        displaypath = get_submodule_displaypath(path, prefix);
 636
 637        if ((CE_STAGEMASK & ce_flags) >> CE_STAGESHIFT) {
 638                print_status(flags, 'U', path, &null_oid, displaypath);
 639                goto cleanup;
 640        }
 641
 642        if (!is_submodule_active(the_repository, path)) {
 643                print_status(flags, '-', path, ce_oid, displaypath);
 644                goto cleanup;
 645        }
 646
 647        argv_array_pushl(&diff_files_args, "diff-files",
 648                         "--ignore-submodules=dirty", "--quiet", "--",
 649                         path, NULL);
 650
 651        git_config(git_diff_basic_config, NULL);
 652        init_revisions(&rev, prefix);
 653        rev.abbrev = 0;
 654        diff_files_args.argc = setup_revisions(diff_files_args.argc,
 655                                               diff_files_args.argv,
 656                                               &rev, NULL);
 657        diff_files_result = run_diff_files(&rev, 0);
 658
 659        if (!diff_result_code(&rev.diffopt, diff_files_result)) {
 660                print_status(flags, ' ', path, ce_oid,
 661                             displaypath);
 662        } else if (!(flags & OPT_CACHED)) {
 663                struct object_id oid;
 664                struct ref_store *refs = get_submodule_ref_store(path);
 665
 666                if (!refs) {
 667                        print_status(flags, '-', path, ce_oid, displaypath);
 668                        goto cleanup;
 669                }
 670                if (refs_head_ref(refs, handle_submodule_head_ref, &oid))
 671                        die(_("could not resolve HEAD ref inside the "
 672                              "submodule '%s'"), path);
 673
 674                print_status(flags, '+', path, &oid, displaypath);
 675        } else {
 676                print_status(flags, '+', path, ce_oid, displaypath);
 677        }
 678
 679        if (flags & OPT_RECURSIVE) {
 680                struct child_process cpr = CHILD_PROCESS_INIT;
 681
 682                cpr.git_cmd = 1;
 683                cpr.dir = path;
 684                prepare_submodule_repo_env(&cpr.env_array);
 685
 686                argv_array_push(&cpr.args, "--super-prefix");
 687                argv_array_pushf(&cpr.args, "%s/", displaypath);
 688                argv_array_pushl(&cpr.args, "submodule--helper", "status",
 689                                 "--recursive", NULL);
 690
 691                if (flags & OPT_CACHED)
 692                        argv_array_push(&cpr.args, "--cached");
 693
 694                if (flags & OPT_QUIET)
 695                        argv_array_push(&cpr.args, "--quiet");
 696
 697                if (run_command(&cpr))
 698                        die(_("failed to recurse into submodule '%s'"), path);
 699        }
 700
 701cleanup:
 702        argv_array_clear(&diff_files_args);
 703        free(displaypath);
 704}
 705
 706static void status_submodule_cb(const struct cache_entry *list_item,
 707                                void *cb_data)
 708{
 709        struct status_cb *info = cb_data;
 710        status_submodule(list_item->name, &list_item->oid, list_item->ce_flags,
 711                         info->prefix, info->flags);
 712}
 713
 714static int module_status(int argc, const char **argv, const char *prefix)
 715{
 716        struct status_cb info = STATUS_CB_INIT;
 717        struct pathspec pathspec;
 718        struct module_list list = MODULE_LIST_INIT;
 719        int quiet = 0;
 720
 721        struct option module_status_options[] = {
 722                OPT__QUIET(&quiet, N_("Suppress submodule status output")),
 723                OPT_BIT(0, "cached", &info.flags, N_("Use commit stored in the index instead of the one stored in the submodule HEAD"), OPT_CACHED),
 724                OPT_BIT(0, "recursive", &info.flags, N_("recurse into nested submodules"), OPT_RECURSIVE),
 725                OPT_END()
 726        };
 727
 728        const char *const git_submodule_helper_usage[] = {
 729                N_("git submodule status [--quiet] [--cached] [--recursive] [<path>...]"),
 730                NULL
 731        };
 732
 733        argc = parse_options(argc, argv, prefix, module_status_options,
 734                             git_submodule_helper_usage, 0);
 735
 736        if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
 737                return 1;
 738
 739        info.prefix = prefix;
 740        if (quiet)
 741                info.flags |= OPT_QUIET;
 742
 743        for_each_listed_submodule(&list, status_submodule_cb, &info);
 744
 745        return 0;
 746}
 747
 748static int module_name(int argc, const char **argv, const char *prefix)
 749{
 750        const struct submodule *sub;
 751
 752        if (argc != 2)
 753                usage(_("git submodule--helper name <path>"));
 754
 755        sub = submodule_from_path(the_repository, &null_oid, argv[1]);
 756
 757        if (!sub)
 758                die(_("no submodule mapping found in .gitmodules for path '%s'"),
 759                    argv[1]);
 760
 761        printf("%s\n", sub->name);
 762
 763        return 0;
 764}
 765
 766struct sync_cb {
 767        const char *prefix;
 768        unsigned int flags;
 769};
 770
 771#define SYNC_CB_INIT { NULL, 0 }
 772
 773static void sync_submodule(const char *path, const char *prefix,
 774                           unsigned int flags)
 775{
 776        const struct submodule *sub;
 777        char *remote_key = NULL;
 778        char *sub_origin_url, *super_config_url, *displaypath;
 779        struct strbuf sb = STRBUF_INIT;
 780        struct child_process cp = CHILD_PROCESS_INIT;
 781        char *sub_config_path = NULL;
 782
 783        if (!is_submodule_active(the_repository, path))
 784                return;
 785
 786        sub = submodule_from_path(the_repository, &null_oid, path);
 787
 788        if (sub && sub->url) {
 789                if (starts_with_dot_dot_slash(sub->url) ||
 790                    starts_with_dot_slash(sub->url)) {
 791                        char *remote_url, *up_path;
 792                        char *remote = get_default_remote();
 793                        strbuf_addf(&sb, "remote.%s.url", remote);
 794
 795                        if (git_config_get_string(sb.buf, &remote_url))
 796                                remote_url = xgetcwd();
 797
 798                        up_path = get_up_path(path);
 799                        sub_origin_url = relative_url(remote_url, sub->url, up_path);
 800                        super_config_url = relative_url(remote_url, sub->url, NULL);
 801
 802                        free(remote);
 803                        free(up_path);
 804                        free(remote_url);
 805                } else {
 806                        sub_origin_url = xstrdup(sub->url);
 807                        super_config_url = xstrdup(sub->url);
 808                }
 809        } else {
 810                sub_origin_url = xstrdup("");
 811                super_config_url = xstrdup("");
 812        }
 813
 814        displaypath = get_submodule_displaypath(path, prefix);
 815
 816        if (!(flags & OPT_QUIET))
 817                printf(_("Synchronizing submodule url for '%s'\n"),
 818                         displaypath);
 819
 820        strbuf_reset(&sb);
 821        strbuf_addf(&sb, "submodule.%s.url", sub->name);
 822        if (git_config_set_gently(sb.buf, super_config_url))
 823                die(_("failed to register url for submodule path '%s'"),
 824                      displaypath);
 825
 826        if (!is_submodule_populated_gently(path, NULL))
 827                goto cleanup;
 828
 829        prepare_submodule_repo_env(&cp.env_array);
 830        cp.git_cmd = 1;
 831        cp.dir = path;
 832        argv_array_pushl(&cp.args, "submodule--helper",
 833                         "print-default-remote", NULL);
 834
 835        strbuf_reset(&sb);
 836        if (capture_command(&cp, &sb, 0))
 837                die(_("failed to get the default remote for submodule '%s'"),
 838                      path);
 839
 840        strbuf_strip_suffix(&sb, "\n");
 841        remote_key = xstrfmt("remote.%s.url", sb.buf);
 842
 843        strbuf_reset(&sb);
 844        submodule_to_gitdir(&sb, path);
 845        strbuf_addstr(&sb, "/config");
 846
 847        if (git_config_set_in_file_gently(sb.buf, remote_key, sub_origin_url))
 848                die(_("failed to update remote for submodule '%s'"),
 849                      path);
 850
 851        if (flags & OPT_RECURSIVE) {
 852                struct child_process cpr = CHILD_PROCESS_INIT;
 853
 854                cpr.git_cmd = 1;
 855                cpr.dir = path;
 856                prepare_submodule_repo_env(&cpr.env_array);
 857
 858                argv_array_push(&cpr.args, "--super-prefix");
 859                argv_array_pushf(&cpr.args, "%s/", displaypath);
 860                argv_array_pushl(&cpr.args, "submodule--helper", "sync",
 861                                 "--recursive", NULL);
 862
 863                if (flags & OPT_QUIET)
 864                        argv_array_push(&cpr.args, "--quiet");
 865
 866                if (run_command(&cpr))
 867                        die(_("failed to recurse into submodule '%s'"),
 868                              path);
 869        }
 870
 871cleanup:
 872        free(super_config_url);
 873        free(sub_origin_url);
 874        strbuf_release(&sb);
 875        free(remote_key);
 876        free(displaypath);
 877        free(sub_config_path);
 878}
 879
 880static void sync_submodule_cb(const struct cache_entry *list_item, void *cb_data)
 881{
 882        struct sync_cb *info = cb_data;
 883        sync_submodule(list_item->name, info->prefix, info->flags);
 884
 885}
 886
 887static int module_sync(int argc, const char **argv, const char *prefix)
 888{
 889        struct sync_cb info = SYNC_CB_INIT;
 890        struct pathspec pathspec;
 891        struct module_list list = MODULE_LIST_INIT;
 892        int quiet = 0;
 893        int recursive = 0;
 894
 895        struct option module_sync_options[] = {
 896                OPT__QUIET(&quiet, N_("Suppress output of synchronizing submodule url")),
 897                OPT_BOOL(0, "recursive", &recursive,
 898                        N_("Recurse into nested submodules")),
 899                OPT_END()
 900        };
 901
 902        const char *const git_submodule_helper_usage[] = {
 903                N_("git submodule--helper sync [--quiet] [--recursive] [<path>]"),
 904                NULL
 905        };
 906
 907        argc = parse_options(argc, argv, prefix, module_sync_options,
 908                             git_submodule_helper_usage, 0);
 909
 910        if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
 911                return 1;
 912
 913        info.prefix = prefix;
 914        if (quiet)
 915                info.flags |= OPT_QUIET;
 916        if (recursive)
 917                info.flags |= OPT_RECURSIVE;
 918
 919        for_each_listed_submodule(&list, sync_submodule_cb, &info);
 920
 921        return 0;
 922}
 923
 924struct deinit_cb {
 925        const char *prefix;
 926        unsigned int flags;
 927};
 928#define DEINIT_CB_INIT { NULL, 0 }
 929
 930static void deinit_submodule(const char *path, const char *prefix,
 931                             unsigned int flags)
 932{
 933        const struct submodule *sub;
 934        char *displaypath = NULL;
 935        struct child_process cp_config = CHILD_PROCESS_INIT;
 936        struct strbuf sb_config = STRBUF_INIT;
 937        char *sub_git_dir = xstrfmt("%s/.git", path);
 938
 939        sub = submodule_from_path(the_repository, &null_oid, path);
 940
 941        if (!sub || !sub->name)
 942                goto cleanup;
 943
 944        displaypath = get_submodule_displaypath(path, prefix);
 945
 946        /* remove the submodule work tree (unless the user already did it) */
 947        if (is_directory(path)) {
 948                struct strbuf sb_rm = STRBUF_INIT;
 949                const char *format;
 950
 951                /*
 952                 * protect submodules containing a .git directory
 953                 * NEEDSWORK: instead of dying, automatically call
 954                 * absorbgitdirs and (possibly) warn.
 955                 */
 956                if (is_directory(sub_git_dir))
 957                        die(_("Submodule work tree '%s' contains a .git "
 958                              "directory (use 'rm -rf' if you really want "
 959                              "to remove it including all of its history)"),
 960                            displaypath);
 961
 962                if (!(flags & OPT_FORCE)) {
 963                        struct child_process cp_rm = CHILD_PROCESS_INIT;
 964                        cp_rm.git_cmd = 1;
 965                        argv_array_pushl(&cp_rm.args, "rm", "-qn",
 966                                         path, NULL);
 967
 968                        if (run_command(&cp_rm))
 969                                die(_("Submodule work tree '%s' contains local "
 970                                      "modifications; use '-f' to discard them"),
 971                                      displaypath);
 972                }
 973
 974                strbuf_addstr(&sb_rm, path);
 975
 976                if (!remove_dir_recursively(&sb_rm, 0))
 977                        format = _("Cleared directory '%s'\n");
 978                else
 979                        format = _("Could not remove submodule work tree '%s'\n");
 980
 981                if (!(flags & OPT_QUIET))
 982                        printf(format, displaypath);
 983
 984                strbuf_release(&sb_rm);
 985        }
 986
 987        if (mkdir(path, 0777))
 988                printf(_("could not create empty submodule directory %s"),
 989                      displaypath);
 990
 991        cp_config.git_cmd = 1;
 992        argv_array_pushl(&cp_config.args, "config", "--get-regexp", NULL);
 993        argv_array_pushf(&cp_config.args, "submodule.%s\\.", sub->name);
 994
 995        /* remove the .git/config entries (unless the user already did it) */
 996        if (!capture_command(&cp_config, &sb_config, 0) && sb_config.len) {
 997                char *sub_key = xstrfmt("submodule.%s", sub->name);
 998                /*
 999                 * remove the whole section so we have a clean state when
1000                 * the user later decides to init this submodule again
1001                 */
1002                git_config_rename_section_in_file(NULL, sub_key, NULL);
1003                if (!(flags & OPT_QUIET))
1004                        printf(_("Submodule '%s' (%s) unregistered for path '%s'\n"),
1005                                 sub->name, sub->url, displaypath);
1006                free(sub_key);
1007        }
1008
1009cleanup:
1010        free(displaypath);
1011        free(sub_git_dir);
1012        strbuf_release(&sb_config);
1013}
1014
1015static void deinit_submodule_cb(const struct cache_entry *list_item,
1016                                void *cb_data)
1017{
1018        struct deinit_cb *info = cb_data;
1019        deinit_submodule(list_item->name, info->prefix, info->flags);
1020}
1021
1022static int module_deinit(int argc, const char **argv, const char *prefix)
1023{
1024        struct deinit_cb info = DEINIT_CB_INIT;
1025        struct pathspec pathspec;
1026        struct module_list list = MODULE_LIST_INIT;
1027        int quiet = 0;
1028        int force = 0;
1029        int all = 0;
1030
1031        struct option module_deinit_options[] = {
1032                OPT__QUIET(&quiet, N_("Suppress submodule status output")),
1033                OPT__FORCE(&force, N_("Remove submodule working trees even if they contain local changes"), 0),
1034                OPT_BOOL(0, "all", &all, N_("Unregister all submodules")),
1035                OPT_END()
1036        };
1037
1038        const char *const git_submodule_helper_usage[] = {
1039                N_("git submodule deinit [--quiet] [-f | --force] [--all | [--] [<path>...]]"),
1040                NULL
1041        };
1042
1043        argc = parse_options(argc, argv, prefix, module_deinit_options,
1044                             git_submodule_helper_usage, 0);
1045
1046        if (all && argc) {
1047                error("pathspec and --all are incompatible");
1048                usage_with_options(git_submodule_helper_usage,
1049                                   module_deinit_options);
1050        }
1051
1052        if (!argc && !all)
1053                die(_("Use '--all' if you really want to deinitialize all submodules"));
1054
1055        if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
1056                return 1;
1057
1058        info.prefix = prefix;
1059        if (quiet)
1060                info.flags |= OPT_QUIET;
1061        if (force)
1062                info.flags |= OPT_FORCE;
1063
1064        for_each_listed_submodule(&list, deinit_submodule_cb, &info);
1065
1066        return 0;
1067}
1068
1069static int clone_submodule(const char *path, const char *gitdir, const char *url,
1070                           const char *depth, struct string_list *reference, int dissociate,
1071                           int quiet, int progress)
1072{
1073        struct child_process cp = CHILD_PROCESS_INIT;
1074
1075        argv_array_push(&cp.args, "clone");
1076        argv_array_push(&cp.args, "--no-checkout");
1077        if (quiet)
1078                argv_array_push(&cp.args, "--quiet");
1079        if (progress)
1080                argv_array_push(&cp.args, "--progress");
1081        if (depth && *depth)
1082                argv_array_pushl(&cp.args, "--depth", depth, NULL);
1083        if (reference->nr) {
1084                struct string_list_item *item;
1085                for_each_string_list_item(item, reference)
1086                        argv_array_pushl(&cp.args, "--reference",
1087                                         item->string, NULL);
1088        }
1089        if (dissociate)
1090                argv_array_push(&cp.args, "--dissociate");
1091        if (gitdir && *gitdir)
1092                argv_array_pushl(&cp.args, "--separate-git-dir", gitdir, NULL);
1093
1094        argv_array_push(&cp.args, url);
1095        argv_array_push(&cp.args, path);
1096
1097        cp.git_cmd = 1;
1098        prepare_submodule_repo_env(&cp.env_array);
1099        cp.no_stdin = 1;
1100
1101        return run_command(&cp);
1102}
1103
1104struct submodule_alternate_setup {
1105        const char *submodule_name;
1106        enum SUBMODULE_ALTERNATE_ERROR_MODE {
1107                SUBMODULE_ALTERNATE_ERROR_DIE,
1108                SUBMODULE_ALTERNATE_ERROR_INFO,
1109                SUBMODULE_ALTERNATE_ERROR_IGNORE
1110        } error_mode;
1111        struct string_list *reference;
1112};
1113#define SUBMODULE_ALTERNATE_SETUP_INIT { NULL, \
1114        SUBMODULE_ALTERNATE_ERROR_IGNORE, NULL }
1115
1116static int add_possible_reference_from_superproject(
1117                struct alternate_object_database *alt, void *sas_cb)
1118{
1119        struct submodule_alternate_setup *sas = sas_cb;
1120
1121        /*
1122         * If the alternate object store is another repository, try the
1123         * standard layout with .git/(modules/<name>)+/objects
1124         */
1125        if (ends_with(alt->path, "/objects")) {
1126                char *sm_alternate;
1127                struct strbuf sb = STRBUF_INIT;
1128                struct strbuf err = STRBUF_INIT;
1129                strbuf_add(&sb, alt->path, strlen(alt->path) - strlen("objects"));
1130
1131                /*
1132                 * We need to end the new path with '/' to mark it as a dir,
1133                 * otherwise a submodule name containing '/' will be broken
1134                 * as the last part of a missing submodule reference would
1135                 * be taken as a file name.
1136                 */
1137                strbuf_addf(&sb, "modules/%s/", sas->submodule_name);
1138
1139                sm_alternate = compute_alternate_path(sb.buf, &err);
1140                if (sm_alternate) {
1141                        string_list_append(sas->reference, xstrdup(sb.buf));
1142                        free(sm_alternate);
1143                } else {
1144                        switch (sas->error_mode) {
1145                        case SUBMODULE_ALTERNATE_ERROR_DIE:
1146                                die(_("submodule '%s' cannot add alternate: %s"),
1147                                    sas->submodule_name, err.buf);
1148                        case SUBMODULE_ALTERNATE_ERROR_INFO:
1149                                fprintf(stderr, _("submodule '%s' cannot add alternate: %s"),
1150                                        sas->submodule_name, err.buf);
1151                        case SUBMODULE_ALTERNATE_ERROR_IGNORE:
1152                                ; /* nothing */
1153                        }
1154                }
1155                strbuf_release(&sb);
1156        }
1157
1158        return 0;
1159}
1160
1161static void prepare_possible_alternates(const char *sm_name,
1162                struct string_list *reference)
1163{
1164        char *sm_alternate = NULL, *error_strategy = NULL;
1165        struct submodule_alternate_setup sas = SUBMODULE_ALTERNATE_SETUP_INIT;
1166
1167        git_config_get_string("submodule.alternateLocation", &sm_alternate);
1168        if (!sm_alternate)
1169                return;
1170
1171        git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
1172
1173        if (!error_strategy)
1174                error_strategy = xstrdup("die");
1175
1176        sas.submodule_name = sm_name;
1177        sas.reference = reference;
1178        if (!strcmp(error_strategy, "die"))
1179                sas.error_mode = SUBMODULE_ALTERNATE_ERROR_DIE;
1180        else if (!strcmp(error_strategy, "info"))
1181                sas.error_mode = SUBMODULE_ALTERNATE_ERROR_INFO;
1182        else if (!strcmp(error_strategy, "ignore"))
1183                sas.error_mode = SUBMODULE_ALTERNATE_ERROR_IGNORE;
1184        else
1185                die(_("Value '%s' for submodule.alternateErrorStrategy is not recognized"), error_strategy);
1186
1187        if (!strcmp(sm_alternate, "superproject"))
1188                foreach_alt_odb(add_possible_reference_from_superproject, &sas);
1189        else if (!strcmp(sm_alternate, "no"))
1190                ; /* do nothing */
1191        else
1192                die(_("Value '%s' for submodule.alternateLocation is not recognized"), sm_alternate);
1193
1194        free(sm_alternate);
1195        free(error_strategy);
1196}
1197
1198static int module_clone(int argc, const char **argv, const char *prefix)
1199{
1200        const char *name = NULL, *url = NULL, *depth = NULL;
1201        int quiet = 0;
1202        int progress = 0;
1203        char *p, *path = NULL, *sm_gitdir;
1204        struct strbuf sb = STRBUF_INIT;
1205        struct string_list reference = STRING_LIST_INIT_NODUP;
1206        int dissociate = 0;
1207        char *sm_alternate = NULL, *error_strategy = NULL;
1208
1209        struct option module_clone_options[] = {
1210                OPT_STRING(0, "prefix", &prefix,
1211                           N_("path"),
1212                           N_("alternative anchor for relative paths")),
1213                OPT_STRING(0, "path", &path,
1214                           N_("path"),
1215                           N_("where the new submodule will be cloned to")),
1216                OPT_STRING(0, "name", &name,
1217                           N_("string"),
1218                           N_("name of the new submodule")),
1219                OPT_STRING(0, "url", &url,
1220                           N_("string"),
1221                           N_("url where to clone the submodule from")),
1222                OPT_STRING_LIST(0, "reference", &reference,
1223                           N_("repo"),
1224                           N_("reference repository")),
1225                OPT_BOOL(0, "dissociate", &dissociate,
1226                           N_("use --reference only while cloning")),
1227                OPT_STRING(0, "depth", &depth,
1228                           N_("string"),
1229                           N_("depth for shallow clones")),
1230                OPT__QUIET(&quiet, "Suppress output for cloning a submodule"),
1231                OPT_BOOL(0, "progress", &progress,
1232                           N_("force cloning progress")),
1233                OPT_END()
1234        };
1235
1236        const char *const git_submodule_helper_usage[] = {
1237                N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
1238                   "[--reference <repository>] [--name <name>] [--depth <depth>] "
1239                   "--url <url> --path <path>"),
1240                NULL
1241        };
1242
1243        argc = parse_options(argc, argv, prefix, module_clone_options,
1244                             git_submodule_helper_usage, 0);
1245
1246        if (argc || !url || !path || !*path)
1247                usage_with_options(git_submodule_helper_usage,
1248                                   module_clone_options);
1249
1250        strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), name);
1251        sm_gitdir = absolute_pathdup(sb.buf);
1252        strbuf_reset(&sb);
1253
1254        if (!is_absolute_path(path)) {
1255                strbuf_addf(&sb, "%s/%s", get_git_work_tree(), path);
1256                path = strbuf_detach(&sb, NULL);
1257        } else
1258                path = xstrdup(path);
1259
1260        if (!file_exists(sm_gitdir)) {
1261                if (safe_create_leading_directories_const(sm_gitdir) < 0)
1262                        die(_("could not create directory '%s'"), sm_gitdir);
1263
1264                prepare_possible_alternates(name, &reference);
1265
1266                if (clone_submodule(path, sm_gitdir, url, depth, &reference, dissociate,
1267                                    quiet, progress))
1268                        die(_("clone of '%s' into submodule path '%s' failed"),
1269                            url, path);
1270        } else {
1271                if (safe_create_leading_directories_const(path) < 0)
1272                        die(_("could not create directory '%s'"), path);
1273                strbuf_addf(&sb, "%s/index", sm_gitdir);
1274                unlink_or_warn(sb.buf);
1275                strbuf_reset(&sb);
1276        }
1277
1278        connect_work_tree_and_git_dir(path, sm_gitdir, 0);
1279
1280        p = git_pathdup_submodule(path, "config");
1281        if (!p)
1282                die(_("could not get submodule directory for '%s'"), path);
1283
1284        /* setup alternateLocation and alternateErrorStrategy in the cloned submodule if needed */
1285        git_config_get_string("submodule.alternateLocation", &sm_alternate);
1286        if (sm_alternate)
1287                git_config_set_in_file(p, "submodule.alternateLocation",
1288                                           sm_alternate);
1289        git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
1290        if (error_strategy)
1291                git_config_set_in_file(p, "submodule.alternateErrorStrategy",
1292                                           error_strategy);
1293
1294        free(sm_alternate);
1295        free(error_strategy);
1296
1297        strbuf_release(&sb);
1298        free(sm_gitdir);
1299        free(path);
1300        free(p);
1301        return 0;
1302}
1303
1304struct submodule_update_clone {
1305        /* index into 'list', the list of submodules to look into for cloning */
1306        int current;
1307        struct module_list list;
1308        unsigned warn_if_uninitialized : 1;
1309
1310        /* update parameter passed via commandline */
1311        struct submodule_update_strategy update;
1312
1313        /* configuration parameters which are passed on to the children */
1314        int progress;
1315        int quiet;
1316        int recommend_shallow;
1317        struct string_list references;
1318        int dissociate;
1319        const char *depth;
1320        const char *recursive_prefix;
1321        const char *prefix;
1322
1323        /* Machine-readable status lines to be consumed by git-submodule.sh */
1324        struct string_list projectlines;
1325
1326        /* If we want to stop as fast as possible and return an error */
1327        unsigned quickstop : 1;
1328
1329        /* failed clones to be retried again */
1330        const struct cache_entry **failed_clones;
1331        int failed_clones_nr, failed_clones_alloc;
1332};
1333#define SUBMODULE_UPDATE_CLONE_INIT {0, MODULE_LIST_INIT, 0, \
1334        SUBMODULE_UPDATE_STRATEGY_INIT, 0, 0, -1, STRING_LIST_INIT_DUP, 0, \
1335        NULL, NULL, NULL, \
1336        STRING_LIST_INIT_DUP, 0, NULL, 0, 0}
1337
1338
1339static void next_submodule_warn_missing(struct submodule_update_clone *suc,
1340                struct strbuf *out, const char *displaypath)
1341{
1342        /*
1343         * Only mention uninitialized submodules when their
1344         * paths have been specified.
1345         */
1346        if (suc->warn_if_uninitialized) {
1347                strbuf_addf(out,
1348                        _("Submodule path '%s' not initialized"),
1349                        displaypath);
1350                strbuf_addch(out, '\n');
1351                strbuf_addstr(out,
1352                        _("Maybe you want to use 'update --init'?"));
1353                strbuf_addch(out, '\n');
1354        }
1355}
1356
1357/**
1358 * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
1359 * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
1360 */
1361static int prepare_to_clone_next_submodule(const struct cache_entry *ce,
1362                                           struct child_process *child,
1363                                           struct submodule_update_clone *suc,
1364                                           struct strbuf *out)
1365{
1366        const struct submodule *sub = NULL;
1367        const char *url = NULL;
1368        const char *update_string;
1369        enum submodule_update_type update_type;
1370        char *key;
1371        struct strbuf displaypath_sb = STRBUF_INIT;
1372        struct strbuf sb = STRBUF_INIT;
1373        const char *displaypath = NULL;
1374        int needs_cloning = 0;
1375
1376        if (ce_stage(ce)) {
1377                if (suc->recursive_prefix)
1378                        strbuf_addf(&sb, "%s/%s", suc->recursive_prefix, ce->name);
1379                else
1380                        strbuf_addstr(&sb, ce->name);
1381                strbuf_addf(out, _("Skipping unmerged submodule %s"), sb.buf);
1382                strbuf_addch(out, '\n');
1383                goto cleanup;
1384        }
1385
1386        sub = submodule_from_path(the_repository, &null_oid, ce->name);
1387
1388        if (suc->recursive_prefix)
1389                displaypath = relative_path(suc->recursive_prefix,
1390                                            ce->name, &displaypath_sb);
1391        else
1392                displaypath = ce->name;
1393
1394        if (!sub) {
1395                next_submodule_warn_missing(suc, out, displaypath);
1396                goto cleanup;
1397        }
1398
1399        key = xstrfmt("submodule.%s.update", sub->name);
1400        if (!repo_config_get_string_const(the_repository, key, &update_string)) {
1401                update_type = parse_submodule_update_type(update_string);
1402        } else {
1403                update_type = sub->update_strategy.type;
1404        }
1405        free(key);
1406
1407        if (suc->update.type == SM_UPDATE_NONE
1408            || (suc->update.type == SM_UPDATE_UNSPECIFIED
1409                && update_type == SM_UPDATE_NONE)) {
1410                strbuf_addf(out, _("Skipping submodule '%s'"), displaypath);
1411                strbuf_addch(out, '\n');
1412                goto cleanup;
1413        }
1414
1415        /* Check if the submodule has been initialized. */
1416        if (!is_submodule_active(the_repository, ce->name)) {
1417                next_submodule_warn_missing(suc, out, displaypath);
1418                goto cleanup;
1419        }
1420
1421        strbuf_reset(&sb);
1422        strbuf_addf(&sb, "submodule.%s.url", sub->name);
1423        if (repo_config_get_string_const(the_repository, sb.buf, &url))
1424                url = sub->url;
1425
1426        strbuf_reset(&sb);
1427        strbuf_addf(&sb, "%s/.git", ce->name);
1428        needs_cloning = !file_exists(sb.buf);
1429
1430        strbuf_reset(&sb);
1431        strbuf_addf(&sb, "%06o %s %d %d\t%s\n", ce->ce_mode,
1432                        oid_to_hex(&ce->oid), ce_stage(ce),
1433                        needs_cloning, ce->name);
1434        string_list_append(&suc->projectlines, sb.buf);
1435
1436        if (!needs_cloning)
1437                goto cleanup;
1438
1439        child->git_cmd = 1;
1440        child->no_stdin = 1;
1441        child->stdout_to_stderr = 1;
1442        child->err = -1;
1443        argv_array_push(&child->args, "submodule--helper");
1444        argv_array_push(&child->args, "clone");
1445        if (suc->progress)
1446                argv_array_push(&child->args, "--progress");
1447        if (suc->quiet)
1448                argv_array_push(&child->args, "--quiet");
1449        if (suc->prefix)
1450                argv_array_pushl(&child->args, "--prefix", suc->prefix, NULL);
1451        if (suc->recommend_shallow && sub->recommend_shallow == 1)
1452                argv_array_push(&child->args, "--depth=1");
1453        argv_array_pushl(&child->args, "--path", sub->path, NULL);
1454        argv_array_pushl(&child->args, "--name", sub->name, NULL);
1455        argv_array_pushl(&child->args, "--url", url, NULL);
1456        if (suc->references.nr) {
1457                struct string_list_item *item;
1458                for_each_string_list_item(item, &suc->references)
1459                        argv_array_pushl(&child->args, "--reference", item->string, NULL);
1460        }
1461        if (suc->dissociate)
1462                argv_array_push(&child->args, "--dissociate");
1463        if (suc->depth)
1464                argv_array_push(&child->args, suc->depth);
1465
1466cleanup:
1467        strbuf_reset(&displaypath_sb);
1468        strbuf_reset(&sb);
1469
1470        return needs_cloning;
1471}
1472
1473static int update_clone_get_next_task(struct child_process *child,
1474                                      struct strbuf *err,
1475                                      void *suc_cb,
1476                                      void **idx_task_cb)
1477{
1478        struct submodule_update_clone *suc = suc_cb;
1479        const struct cache_entry *ce;
1480        int index;
1481
1482        for (; suc->current < suc->list.nr; suc->current++) {
1483                ce = suc->list.entries[suc->current];
1484                if (prepare_to_clone_next_submodule(ce, child, suc, err)) {
1485                        int *p = xmalloc(sizeof(*p));
1486                        *p = suc->current;
1487                        *idx_task_cb = p;
1488                        suc->current++;
1489                        return 1;
1490                }
1491        }
1492
1493        /*
1494         * The loop above tried cloning each submodule once, now try the
1495         * stragglers again, which we can imagine as an extension of the
1496         * entry list.
1497         */
1498        index = suc->current - suc->list.nr;
1499        if (index < suc->failed_clones_nr) {
1500                int *p;
1501                ce = suc->failed_clones[index];
1502                if (!prepare_to_clone_next_submodule(ce, child, suc, err)) {
1503                        suc->current ++;
1504                        strbuf_addstr(err, "BUG: submodule considered for "
1505                                           "cloning, doesn't need cloning "
1506                                           "any more?\n");
1507                        return 0;
1508                }
1509                p = xmalloc(sizeof(*p));
1510                *p = suc->current;
1511                *idx_task_cb = p;
1512                suc->current ++;
1513                return 1;
1514        }
1515
1516        return 0;
1517}
1518
1519static int update_clone_start_failure(struct strbuf *err,
1520                                      void *suc_cb,
1521                                      void *idx_task_cb)
1522{
1523        struct submodule_update_clone *suc = suc_cb;
1524        suc->quickstop = 1;
1525        return 1;
1526}
1527
1528static int update_clone_task_finished(int result,
1529                                      struct strbuf *err,
1530                                      void *suc_cb,
1531                                      void *idx_task_cb)
1532{
1533        const struct cache_entry *ce;
1534        struct submodule_update_clone *suc = suc_cb;
1535
1536        int *idxP = idx_task_cb;
1537        int idx = *idxP;
1538        free(idxP);
1539
1540        if (!result)
1541                return 0;
1542
1543        if (idx < suc->list.nr) {
1544                ce  = suc->list.entries[idx];
1545                strbuf_addf(err, _("Failed to clone '%s'. Retry scheduled"),
1546                            ce->name);
1547                strbuf_addch(err, '\n');
1548                ALLOC_GROW(suc->failed_clones,
1549                           suc->failed_clones_nr + 1,
1550                           suc->failed_clones_alloc);
1551                suc->failed_clones[suc->failed_clones_nr++] = ce;
1552                return 0;
1553        } else {
1554                idx -= suc->list.nr;
1555                ce  = suc->failed_clones[idx];
1556                strbuf_addf(err, _("Failed to clone '%s' a second time, aborting"),
1557                            ce->name);
1558                strbuf_addch(err, '\n');
1559                suc->quickstop = 1;
1560                return 1;
1561        }
1562
1563        return 0;
1564}
1565
1566static int gitmodules_update_clone_config(const char *var, const char *value,
1567                                          void *cb)
1568{
1569        int *max_jobs = cb;
1570        if (!strcmp(var, "submodule.fetchjobs"))
1571                *max_jobs = parse_submodule_fetchjobs(var, value);
1572        return 0;
1573}
1574
1575static int update_clone(int argc, const char **argv, const char *prefix)
1576{
1577        const char *update = NULL;
1578        int max_jobs = 1;
1579        struct string_list_item *item;
1580        struct pathspec pathspec;
1581        struct submodule_update_clone suc = SUBMODULE_UPDATE_CLONE_INIT;
1582
1583        struct option module_update_clone_options[] = {
1584                OPT_STRING(0, "prefix", &prefix,
1585                           N_("path"),
1586                           N_("path into the working tree")),
1587                OPT_STRING(0, "recursive-prefix", &suc.recursive_prefix,
1588                           N_("path"),
1589                           N_("path into the working tree, across nested "
1590                              "submodule boundaries")),
1591                OPT_STRING(0, "update", &update,
1592                           N_("string"),
1593                           N_("rebase, merge, checkout or none")),
1594                OPT_STRING_LIST(0, "reference", &suc.references, N_("repo"),
1595                           N_("reference repository")),
1596                OPT_BOOL(0, "dissociate", &suc.dissociate,
1597                           N_("use --reference only while cloning")),
1598                OPT_STRING(0, "depth", &suc.depth, "<depth>",
1599                           N_("Create a shallow clone truncated to the "
1600                              "specified number of revisions")),
1601                OPT_INTEGER('j', "jobs", &max_jobs,
1602                            N_("parallel jobs")),
1603                OPT_BOOL(0, "recommend-shallow", &suc.recommend_shallow,
1604                            N_("whether the initial clone should follow the shallow recommendation")),
1605                OPT__QUIET(&suc.quiet, N_("don't print cloning progress")),
1606                OPT_BOOL(0, "progress", &suc.progress,
1607                            N_("force cloning progress")),
1608                OPT_END()
1609        };
1610
1611        const char *const git_submodule_helper_usage[] = {
1612                N_("git submodule--helper update_clone [--prefix=<path>] [<path>...]"),
1613                NULL
1614        };
1615        suc.prefix = prefix;
1616
1617        config_from_gitmodules(gitmodules_update_clone_config, &max_jobs);
1618        git_config(gitmodules_update_clone_config, &max_jobs);
1619
1620        argc = parse_options(argc, argv, prefix, module_update_clone_options,
1621                             git_submodule_helper_usage, 0);
1622
1623        if (update)
1624                if (parse_submodule_update_strategy(update, &suc.update) < 0)
1625                        die(_("bad value for update parameter"));
1626
1627        if (module_list_compute(argc, argv, prefix, &pathspec, &suc.list) < 0)
1628                return 1;
1629
1630        if (pathspec.nr)
1631                suc.warn_if_uninitialized = 1;
1632
1633        run_processes_parallel(max_jobs,
1634                               update_clone_get_next_task,
1635                               update_clone_start_failure,
1636                               update_clone_task_finished,
1637                               &suc);
1638
1639        /*
1640         * We saved the output and put it out all at once now.
1641         * That means:
1642         * - the listener does not have to interleave their (checkout)
1643         *   work with our fetching.  The writes involved in a
1644         *   checkout involve more straightforward sequential I/O.
1645         * - the listener can avoid doing any work if fetching failed.
1646         */
1647        if (suc.quickstop)
1648                return 1;
1649
1650        for_each_string_list_item(item, &suc.projectlines)
1651                fprintf(stdout, "%s", item->string);
1652
1653        return 0;
1654}
1655
1656static int resolve_relative_path(int argc, const char **argv, const char *prefix)
1657{
1658        struct strbuf sb = STRBUF_INIT;
1659        if (argc != 3)
1660                die("submodule--helper relative-path takes exactly 2 arguments, got %d", argc);
1661
1662        printf("%s", relative_path(argv[1], argv[2], &sb));
1663        strbuf_release(&sb);
1664        return 0;
1665}
1666
1667static const char *remote_submodule_branch(const char *path)
1668{
1669        const struct submodule *sub;
1670        const char *branch = NULL;
1671        char *key;
1672
1673        sub = submodule_from_path(the_repository, &null_oid, path);
1674        if (!sub)
1675                return NULL;
1676
1677        key = xstrfmt("submodule.%s.branch", sub->name);
1678        if (repo_config_get_string_const(the_repository, key, &branch))
1679                branch = sub->branch;
1680        free(key);
1681
1682        if (!branch)
1683                return "master";
1684
1685        if (!strcmp(branch, ".")) {
1686                const char *refname = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
1687
1688                if (!refname)
1689                        die(_("No such ref: %s"), "HEAD");
1690
1691                /* detached HEAD */
1692                if (!strcmp(refname, "HEAD"))
1693                        die(_("Submodule (%s) branch configured to inherit "
1694                              "branch from superproject, but the superproject "
1695                              "is not on any branch"), sub->name);
1696
1697                if (!skip_prefix(refname, "refs/heads/", &refname))
1698                        die(_("Expecting a full ref name, got %s"), refname);
1699                return refname;
1700        }
1701
1702        return branch;
1703}
1704
1705static int resolve_remote_submodule_branch(int argc, const char **argv,
1706                const char *prefix)
1707{
1708        const char *ret;
1709        struct strbuf sb = STRBUF_INIT;
1710        if (argc != 2)
1711                die("submodule--helper remote-branch takes exactly one arguments, got %d", argc);
1712
1713        ret = remote_submodule_branch(argv[1]);
1714        if (!ret)
1715                die("submodule %s doesn't exist", argv[1]);
1716
1717        printf("%s", ret);
1718        strbuf_release(&sb);
1719        return 0;
1720}
1721
1722static int push_check(int argc, const char **argv, const char *prefix)
1723{
1724        struct remote *remote;
1725        const char *superproject_head;
1726        char *head;
1727        int detached_head = 0;
1728        struct object_id head_oid;
1729
1730        if (argc < 3)
1731                die("submodule--helper push-check requires at least 2 arguments");
1732
1733        /*
1734         * superproject's resolved head ref.
1735         * if HEAD then the superproject is in a detached head state, otherwise
1736         * it will be the resolved head ref.
1737         */
1738        superproject_head = argv[1];
1739        argv++;
1740        argc--;
1741        /* Get the submodule's head ref and determine if it is detached */
1742        head = resolve_refdup("HEAD", 0, &head_oid, NULL);
1743        if (!head)
1744                die(_("Failed to resolve HEAD as a valid ref."));
1745        if (!strcmp(head, "HEAD"))
1746                detached_head = 1;
1747
1748        /*
1749         * The remote must be configured.
1750         * This is to avoid pushing to the exact same URL as the parent.
1751         */
1752        remote = pushremote_get(argv[1]);
1753        if (!remote || remote->origin == REMOTE_UNCONFIGURED)
1754                die("remote '%s' not configured", argv[1]);
1755
1756        /* Check the refspec */
1757        if (argc > 2) {
1758                int i;
1759                struct ref *local_refs = get_local_heads();
1760                struct refspec refspec = REFSPEC_INIT_PUSH;
1761
1762                refspec_appendn(&refspec, argv + 2, argc - 2);
1763
1764                for (i = 0; i < refspec.nr; i++) {
1765                        const struct refspec_item *rs = &refspec.items[i];
1766
1767                        if (rs->pattern || rs->matching)
1768                                continue;
1769
1770                        /* LHS must match a single ref */
1771                        switch (count_refspec_match(rs->src, local_refs, NULL)) {
1772                        case 1:
1773                                break;
1774                        case 0:
1775                                /*
1776                                 * If LHS matches 'HEAD' then we need to ensure
1777                                 * that it matches the same named branch
1778                                 * checked out in the superproject.
1779                                 */
1780                                if (!strcmp(rs->src, "HEAD")) {
1781                                        if (!detached_head &&
1782                                            !strcmp(head, superproject_head))
1783                                                break;
1784                                        die("HEAD does not match the named branch in the superproject");
1785                                }
1786                                /* fallthrough */
1787                        default:
1788                                die("src refspec '%s' must name a ref",
1789                                    rs->src);
1790                        }
1791                }
1792                refspec_clear(&refspec);
1793        }
1794        free(head);
1795
1796        return 0;
1797}
1798
1799static int absorb_git_dirs(int argc, const char **argv, const char *prefix)
1800{
1801        int i;
1802        struct pathspec pathspec;
1803        struct module_list list = MODULE_LIST_INIT;
1804        unsigned flags = ABSORB_GITDIR_RECURSE_SUBMODULES;
1805
1806        struct option embed_gitdir_options[] = {
1807                OPT_STRING(0, "prefix", &prefix,
1808                           N_("path"),
1809                           N_("path into the working tree")),
1810                OPT_BIT(0, "--recursive", &flags, N_("recurse into submodules"),
1811                        ABSORB_GITDIR_RECURSE_SUBMODULES),
1812                OPT_END()
1813        };
1814
1815        const char *const git_submodule_helper_usage[] = {
1816                N_("git submodule--helper embed-git-dir [<path>...]"),
1817                NULL
1818        };
1819
1820        argc = parse_options(argc, argv, prefix, embed_gitdir_options,
1821                             git_submodule_helper_usage, 0);
1822
1823        if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
1824                return 1;
1825
1826        for (i = 0; i < list.nr; i++)
1827                absorb_git_dir_into_superproject(prefix,
1828                                list.entries[i]->name, flags);
1829
1830        return 0;
1831}
1832
1833static int is_active(int argc, const char **argv, const char *prefix)
1834{
1835        if (argc != 2)
1836                die("submodule--helper is-active takes exactly 1 argument");
1837
1838        return !is_submodule_active(the_repository, argv[1]);
1839}
1840
1841/*
1842 * Exit non-zero if any of the submodule names given on the command line is
1843 * invalid. If no names are given, filter stdin to print only valid names
1844 * (which is primarily intended for testing).
1845 */
1846static int check_name(int argc, const char **argv, const char *prefix)
1847{
1848        if (argc > 1) {
1849                while (*++argv) {
1850                        if (check_submodule_name(*argv) < 0)
1851                                return 1;
1852                }
1853        } else {
1854                struct strbuf buf = STRBUF_INIT;
1855                while (strbuf_getline(&buf, stdin) != EOF) {
1856                        if (!check_submodule_name(buf.buf))
1857                                printf("%s\n", buf.buf);
1858                }
1859                strbuf_release(&buf);
1860        }
1861        return 0;
1862}
1863
1864#define SUPPORT_SUPER_PREFIX (1<<0)
1865
1866struct cmd_struct {
1867        const char *cmd;
1868        int (*fn)(int, const char **, const char *);
1869        unsigned option;
1870};
1871
1872static struct cmd_struct commands[] = {
1873        {"list", module_list, 0},
1874        {"name", module_name, 0},
1875        {"clone", module_clone, 0},
1876        {"update-clone", update_clone, 0},
1877        {"relative-path", resolve_relative_path, 0},
1878        {"resolve-relative-url", resolve_relative_url, 0},
1879        {"resolve-relative-url-test", resolve_relative_url_test, 0},
1880        {"init", module_init, SUPPORT_SUPER_PREFIX},
1881        {"status", module_status, SUPPORT_SUPER_PREFIX},
1882        {"print-default-remote", print_default_remote, 0},
1883        {"sync", module_sync, SUPPORT_SUPER_PREFIX},
1884        {"deinit", module_deinit, 0},
1885        {"remote-branch", resolve_remote_submodule_branch, 0},
1886        {"push-check", push_check, 0},
1887        {"absorb-git-dirs", absorb_git_dirs, SUPPORT_SUPER_PREFIX},
1888        {"is-active", is_active, 0},
1889        {"check-name", check_name, 0},
1890};
1891
1892int cmd_submodule__helper(int argc, const char **argv, const char *prefix)
1893{
1894        int i;
1895        if (argc < 2 || !strcmp(argv[1], "-h"))
1896                usage("git submodule--helper <command>");
1897
1898        for (i = 0; i < ARRAY_SIZE(commands); i++) {
1899                if (!strcmp(argv[1], commands[i].cmd)) {
1900                        if (get_super_prefix() &&
1901                            !(commands[i].option & SUPPORT_SUPER_PREFIX))
1902                                die(_("%s doesn't support --super-prefix"),
1903                                    commands[i].cmd);
1904                        return commands[i].fn(argc - 1, argv + 1, prefix);
1905                }
1906        }
1907
1908        die(_("'%s' is not a valid submodule--helper "
1909              "subcommand"), argv[1]);
1910}