Andrew's git / gitweb.git / builtin/submodule--helper.c
?
builtin / submodule--helper.con commit worktree: rename is_worktree_locked to worktree_lock_reason (d236f12)
   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(&the_index, 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 cb_foreach {
 445        int argc;
 446        const char **argv;
 447        const char *prefix;
 448        int quiet;
 449        int recursive;
 450};
 451#define CB_FOREACH_INIT { 0 }
 452
 453static void runcommand_in_submodule_cb(const struct cache_entry *list_item,
 454                                       void *cb_data)
 455{
 456        struct cb_foreach *info = cb_data;
 457        const char *path = list_item->name;
 458        const struct object_id *ce_oid = &list_item->oid;
 459
 460        const struct submodule *sub;
 461        struct child_process cp = CHILD_PROCESS_INIT;
 462        char *displaypath;
 463
 464        displaypath = get_submodule_displaypath(path, info->prefix);
 465
 466        sub = submodule_from_path(the_repository, &null_oid, path);
 467
 468        if (!sub)
 469                die(_("No url found for submodule path '%s' in .gitmodules"),
 470                        displaypath);
 471
 472        if (!is_submodule_populated_gently(path, NULL))
 473                goto cleanup;
 474
 475        prepare_submodule_repo_env(&cp.env_array);
 476
 477        /*
 478         * For the purpose of executing <command> in the submodule,
 479         * separate shell is used for the purpose of running the
 480         * child process.
 481         */
 482        cp.use_shell = 1;
 483        cp.dir = path;
 484
 485        /*
 486         * NEEDSWORK: the command currently has access to the variables $name,
 487         * $sm_path, $displaypath, $sha1 and $toplevel only when the command
 488         * contains a single argument. This is done for maintaining a faithful
 489         * translation from shell script.
 490         */
 491        if (info->argc == 1) {
 492                char *toplevel = xgetcwd();
 493                struct strbuf sb = STRBUF_INIT;
 494
 495                argv_array_pushf(&cp.env_array, "name=%s", sub->name);
 496                argv_array_pushf(&cp.env_array, "sm_path=%s", path);
 497                argv_array_pushf(&cp.env_array, "displaypath=%s", displaypath);
 498                argv_array_pushf(&cp.env_array, "sha1=%s",
 499                                oid_to_hex(ce_oid));
 500                argv_array_pushf(&cp.env_array, "toplevel=%s", toplevel);
 501
 502                /*
 503                 * Since the path variable was accessible from the script
 504                 * before porting, it is also made available after porting.
 505                 * The environment variable "PATH" has a very special purpose
 506                 * on windows. And since environment variables are
 507                 * case-insensitive in windows, it interferes with the
 508                 * existing PATH variable. Hence, to avoid that, we expose
 509                 * path via the args argv_array and not via env_array.
 510                 */
 511                sq_quote_buf(&sb, path);
 512                argv_array_pushf(&cp.args, "path=%s; %s",
 513                                 sb.buf, info->argv[0]);
 514                strbuf_release(&sb);
 515                free(toplevel);
 516        } else {
 517                argv_array_pushv(&cp.args, info->argv);
 518        }
 519
 520        if (!info->quiet)
 521                printf(_("Entering '%s'\n"), displaypath);
 522
 523        if (info->argv[0] && run_command(&cp))
 524                die(_("run_command returned non-zero status for %s\n."),
 525                        displaypath);
 526
 527        if (info->recursive) {
 528                struct child_process cpr = CHILD_PROCESS_INIT;
 529
 530                cpr.git_cmd = 1;
 531                cpr.dir = path;
 532                prepare_submodule_repo_env(&cpr.env_array);
 533
 534                argv_array_pushl(&cpr.args, "--super-prefix", NULL);
 535                argv_array_pushf(&cpr.args, "%s/", displaypath);
 536                argv_array_pushl(&cpr.args, "submodule--helper", "foreach", "--recursive",
 537                                NULL);
 538
 539                if (info->quiet)
 540                        argv_array_push(&cpr.args, "--quiet");
 541
 542                argv_array_pushv(&cpr.args, info->argv);
 543
 544                if (run_command(&cpr))
 545                        die(_("run_command returned non-zero status while "
 546                                "recursing in the nested submodules of %s\n."),
 547                                displaypath);
 548        }
 549
 550cleanup:
 551        free(displaypath);
 552}
 553
 554static int module_foreach(int argc, const char **argv, const char *prefix)
 555{
 556        struct cb_foreach info = CB_FOREACH_INIT;
 557        struct pathspec pathspec;
 558        struct module_list list = MODULE_LIST_INIT;
 559
 560        struct option module_foreach_options[] = {
 561                OPT__QUIET(&info.quiet, N_("Suppress output of entering each submodule command")),
 562                OPT_BOOL(0, "recursive", &info.recursive,
 563                         N_("Recurse into nested submodules")),
 564                OPT_END()
 565        };
 566
 567        const char *const git_submodule_helper_usage[] = {
 568                N_("git submodule--helper foreach [--quiet] [--recursive] <command>"),
 569                NULL
 570        };
 571
 572        argc = parse_options(argc, argv, prefix, module_foreach_options,
 573                             git_submodule_helper_usage, PARSE_OPT_KEEP_UNKNOWN);
 574
 575        if (module_list_compute(0, NULL, prefix, &pathspec, &list) < 0)
 576                return 1;
 577
 578        info.argc = argc;
 579        info.argv = argv;
 580        info.prefix = prefix;
 581
 582        for_each_listed_submodule(&list, runcommand_in_submodule_cb, &info);
 583
 584        return 0;
 585}
 586
 587struct init_cb {
 588        const char *prefix;
 589        unsigned int flags;
 590};
 591
 592#define INIT_CB_INIT { NULL, 0 }
 593
 594static void init_submodule(const char *path, const char *prefix,
 595                           unsigned int flags)
 596{
 597        const struct submodule *sub;
 598        struct strbuf sb = STRBUF_INIT;
 599        char *upd = NULL, *url = NULL, *displaypath;
 600
 601        displaypath = get_submodule_displaypath(path, prefix);
 602
 603        sub = submodule_from_path(the_repository, &null_oid, path);
 604
 605        if (!sub)
 606                die(_("No url found for submodule path '%s' in .gitmodules"),
 607                        displaypath);
 608
 609        /*
 610         * NEEDSWORK: In a multi-working-tree world, this needs to be
 611         * set in the per-worktree config.
 612         *
 613         * Set active flag for the submodule being initialized
 614         */
 615        if (!is_submodule_active(the_repository, path)) {
 616                strbuf_addf(&sb, "submodule.%s.active", sub->name);
 617                git_config_set_gently(sb.buf, "true");
 618                strbuf_reset(&sb);
 619        }
 620
 621        /*
 622         * Copy url setting when it is not set yet.
 623         * To look up the url in .git/config, we must not fall back to
 624         * .gitmodules, so look it up directly.
 625         */
 626        strbuf_addf(&sb, "submodule.%s.url", sub->name);
 627        if (git_config_get_string(sb.buf, &url)) {
 628                if (!sub->url)
 629                        die(_("No url found for submodule path '%s' in .gitmodules"),
 630                                displaypath);
 631
 632                url = xstrdup(sub->url);
 633
 634                /* Possibly a url relative to parent */
 635                if (starts_with_dot_dot_slash(url) ||
 636                    starts_with_dot_slash(url)) {
 637                        char *remoteurl, *relurl;
 638                        char *remote = get_default_remote();
 639                        struct strbuf remotesb = STRBUF_INIT;
 640                        strbuf_addf(&remotesb, "remote.%s.url", remote);
 641                        free(remote);
 642
 643                        if (git_config_get_string(remotesb.buf, &remoteurl)) {
 644                                warning(_("could not lookup configuration '%s'. Assuming this repository is its own authoritative upstream."), remotesb.buf);
 645                                remoteurl = xgetcwd();
 646                        }
 647                        relurl = relative_url(remoteurl, url, NULL);
 648                        strbuf_release(&remotesb);
 649                        free(remoteurl);
 650                        free(url);
 651                        url = relurl;
 652                }
 653
 654                if (git_config_set_gently(sb.buf, url))
 655                        die(_("Failed to register url for submodule path '%s'"),
 656                            displaypath);
 657                if (!(flags & OPT_QUIET))
 658                        fprintf(stderr,
 659                                _("Submodule '%s' (%s) registered for path '%s'\n"),
 660                                sub->name, url, displaypath);
 661        }
 662        strbuf_reset(&sb);
 663
 664        /* Copy "update" setting when it is not set yet */
 665        strbuf_addf(&sb, "submodule.%s.update", sub->name);
 666        if (git_config_get_string(sb.buf, &upd) &&
 667            sub->update_strategy.type != SM_UPDATE_UNSPECIFIED) {
 668                if (sub->update_strategy.type == SM_UPDATE_COMMAND) {
 669                        fprintf(stderr, _("warning: command update mode suggested for submodule '%s'\n"),
 670                                sub->name);
 671                        upd = xstrdup("none");
 672                } else
 673                        upd = xstrdup(submodule_strategy_to_string(&sub->update_strategy));
 674
 675                if (git_config_set_gently(sb.buf, upd))
 676                        die(_("Failed to register update mode for submodule path '%s'"), displaypath);
 677        }
 678        strbuf_release(&sb);
 679        free(displaypath);
 680        free(url);
 681        free(upd);
 682}
 683
 684static void init_submodule_cb(const struct cache_entry *list_item, void *cb_data)
 685{
 686        struct init_cb *info = cb_data;
 687        init_submodule(list_item->name, info->prefix, info->flags);
 688}
 689
 690static int module_init(int argc, const char **argv, const char *prefix)
 691{
 692        struct init_cb info = INIT_CB_INIT;
 693        struct pathspec pathspec;
 694        struct module_list list = MODULE_LIST_INIT;
 695        int quiet = 0;
 696
 697        struct option module_init_options[] = {
 698                OPT__QUIET(&quiet, N_("Suppress output for initializing a submodule")),
 699                OPT_END()
 700        };
 701
 702        const char *const git_submodule_helper_usage[] = {
 703                N_("git submodule--helper init [<path>]"),
 704                NULL
 705        };
 706
 707        argc = parse_options(argc, argv, prefix, module_init_options,
 708                             git_submodule_helper_usage, 0);
 709
 710        if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
 711                return 1;
 712
 713        /*
 714         * If there are no path args and submodule.active is set then,
 715         * by default, only initialize 'active' modules.
 716         */
 717        if (!argc && git_config_get_value_multi("submodule.active"))
 718                module_list_active(&list);
 719
 720        info.prefix = prefix;
 721        if (quiet)
 722                info.flags |= OPT_QUIET;
 723
 724        for_each_listed_submodule(&list, init_submodule_cb, &info);
 725
 726        return 0;
 727}
 728
 729struct status_cb {
 730        const char *prefix;
 731        unsigned int flags;
 732};
 733
 734#define STATUS_CB_INIT { NULL, 0 }
 735
 736static void print_status(unsigned int flags, char state, const char *path,
 737                         const struct object_id *oid, const char *displaypath)
 738{
 739        if (flags & OPT_QUIET)
 740                return;
 741
 742        printf("%c%s %s", state, oid_to_hex(oid), displaypath);
 743
 744        if (state == ' ' || state == '+') {
 745                const char *name = compute_rev_name(path, oid_to_hex(oid));
 746
 747                if (name)
 748                        printf(" (%s)", name);
 749        }
 750
 751        printf("\n");
 752}
 753
 754static int handle_submodule_head_ref(const char *refname,
 755                                     const struct object_id *oid, int flags,
 756                                     void *cb_data)
 757{
 758        struct object_id *output = cb_data;
 759        if (oid)
 760                oidcpy(output, oid);
 761
 762        return 0;
 763}
 764
 765static void status_submodule(const char *path, const struct object_id *ce_oid,
 766                             unsigned int ce_flags, const char *prefix,
 767                             unsigned int flags)
 768{
 769        char *displaypath;
 770        struct argv_array diff_files_args = ARGV_ARRAY_INIT;
 771        struct rev_info rev;
 772        int diff_files_result;
 773
 774        if (!submodule_from_path(the_repository, &null_oid, path))
 775                die(_("no submodule mapping found in .gitmodules for path '%s'"),
 776                      path);
 777
 778        displaypath = get_submodule_displaypath(path, prefix);
 779
 780        if ((CE_STAGEMASK & ce_flags) >> CE_STAGESHIFT) {
 781                print_status(flags, 'U', path, &null_oid, displaypath);
 782                goto cleanup;
 783        }
 784
 785        if (!is_submodule_active(the_repository, path)) {
 786                print_status(flags, '-', path, ce_oid, displaypath);
 787                goto cleanup;
 788        }
 789
 790        argv_array_pushl(&diff_files_args, "diff-files",
 791                         "--ignore-submodules=dirty", "--quiet", "--",
 792                         path, NULL);
 793
 794        git_config(git_diff_basic_config, NULL);
 795        repo_init_revisions(the_repository, &rev, prefix);
 796        rev.abbrev = 0;
 797        diff_files_args.argc = setup_revisions(diff_files_args.argc,
 798                                               diff_files_args.argv,
 799                                               &rev, NULL);
 800        diff_files_result = run_diff_files(&rev, 0);
 801
 802        if (!diff_result_code(&rev.diffopt, diff_files_result)) {
 803                print_status(flags, ' ', path, ce_oid,
 804                             displaypath);
 805        } else if (!(flags & OPT_CACHED)) {
 806                struct object_id oid;
 807                struct ref_store *refs = get_submodule_ref_store(path);
 808
 809                if (!refs) {
 810                        print_status(flags, '-', path, ce_oid, displaypath);
 811                        goto cleanup;
 812                }
 813                if (refs_head_ref(refs, handle_submodule_head_ref, &oid))
 814                        die(_("could not resolve HEAD ref inside the "
 815                              "submodule '%s'"), path);
 816
 817                print_status(flags, '+', path, &oid, displaypath);
 818        } else {
 819                print_status(flags, '+', path, ce_oid, displaypath);
 820        }
 821
 822        if (flags & OPT_RECURSIVE) {
 823                struct child_process cpr = CHILD_PROCESS_INIT;
 824
 825                cpr.git_cmd = 1;
 826                cpr.dir = path;
 827                prepare_submodule_repo_env(&cpr.env_array);
 828
 829                argv_array_push(&cpr.args, "--super-prefix");
 830                argv_array_pushf(&cpr.args, "%s/", displaypath);
 831                argv_array_pushl(&cpr.args, "submodule--helper", "status",
 832                                 "--recursive", NULL);
 833
 834                if (flags & OPT_CACHED)
 835                        argv_array_push(&cpr.args, "--cached");
 836
 837                if (flags & OPT_QUIET)
 838                        argv_array_push(&cpr.args, "--quiet");
 839
 840                if (run_command(&cpr))
 841                        die(_("failed to recurse into submodule '%s'"), path);
 842        }
 843
 844cleanup:
 845        argv_array_clear(&diff_files_args);
 846        free(displaypath);
 847}
 848
 849static void status_submodule_cb(const struct cache_entry *list_item,
 850                                void *cb_data)
 851{
 852        struct status_cb *info = cb_data;
 853        status_submodule(list_item->name, &list_item->oid, list_item->ce_flags,
 854                         info->prefix, info->flags);
 855}
 856
 857static int module_status(int argc, const char **argv, const char *prefix)
 858{
 859        struct status_cb info = STATUS_CB_INIT;
 860        struct pathspec pathspec;
 861        struct module_list list = MODULE_LIST_INIT;
 862        int quiet = 0;
 863
 864        struct option module_status_options[] = {
 865                OPT__QUIET(&quiet, N_("Suppress submodule status output")),
 866                OPT_BIT(0, "cached", &info.flags, N_("Use commit stored in the index instead of the one stored in the submodule HEAD"), OPT_CACHED),
 867                OPT_BIT(0, "recursive", &info.flags, N_("recurse into nested submodules"), OPT_RECURSIVE),
 868                OPT_END()
 869        };
 870
 871        const char *const git_submodule_helper_usage[] = {
 872                N_("git submodule status [--quiet] [--cached] [--recursive] [<path>...]"),
 873                NULL
 874        };
 875
 876        argc = parse_options(argc, argv, prefix, module_status_options,
 877                             git_submodule_helper_usage, 0);
 878
 879        if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
 880                return 1;
 881
 882        info.prefix = prefix;
 883        if (quiet)
 884                info.flags |= OPT_QUIET;
 885
 886        for_each_listed_submodule(&list, status_submodule_cb, &info);
 887
 888        return 0;
 889}
 890
 891static int module_name(int argc, const char **argv, const char *prefix)
 892{
 893        const struct submodule *sub;
 894
 895        if (argc != 2)
 896                usage(_("git submodule--helper name <path>"));
 897
 898        sub = submodule_from_path(the_repository, &null_oid, argv[1]);
 899
 900        if (!sub)
 901                die(_("no submodule mapping found in .gitmodules for path '%s'"),
 902                    argv[1]);
 903
 904        printf("%s\n", sub->name);
 905
 906        return 0;
 907}
 908
 909struct sync_cb {
 910        const char *prefix;
 911        unsigned int flags;
 912};
 913
 914#define SYNC_CB_INIT { NULL, 0 }
 915
 916static void sync_submodule(const char *path, const char *prefix,
 917                           unsigned int flags)
 918{
 919        const struct submodule *sub;
 920        char *remote_key = NULL;
 921        char *sub_origin_url, *super_config_url, *displaypath;
 922        struct strbuf sb = STRBUF_INIT;
 923        struct child_process cp = CHILD_PROCESS_INIT;
 924        char *sub_config_path = NULL;
 925
 926        if (!is_submodule_active(the_repository, path))
 927                return;
 928
 929        sub = submodule_from_path(the_repository, &null_oid, path);
 930
 931        if (sub && sub->url) {
 932                if (starts_with_dot_dot_slash(sub->url) ||
 933                    starts_with_dot_slash(sub->url)) {
 934                        char *remote_url, *up_path;
 935                        char *remote = get_default_remote();
 936                        strbuf_addf(&sb, "remote.%s.url", remote);
 937
 938                        if (git_config_get_string(sb.buf, &remote_url))
 939                                remote_url = xgetcwd();
 940
 941                        up_path = get_up_path(path);
 942                        sub_origin_url = relative_url(remote_url, sub->url, up_path);
 943                        super_config_url = relative_url(remote_url, sub->url, NULL);
 944
 945                        free(remote);
 946                        free(up_path);
 947                        free(remote_url);
 948                } else {
 949                        sub_origin_url = xstrdup(sub->url);
 950                        super_config_url = xstrdup(sub->url);
 951                }
 952        } else {
 953                sub_origin_url = xstrdup("");
 954                super_config_url = xstrdup("");
 955        }
 956
 957        displaypath = get_submodule_displaypath(path, prefix);
 958
 959        if (!(flags & OPT_QUIET))
 960                printf(_("Synchronizing submodule url for '%s'\n"),
 961                         displaypath);
 962
 963        strbuf_reset(&sb);
 964        strbuf_addf(&sb, "submodule.%s.url", sub->name);
 965        if (git_config_set_gently(sb.buf, super_config_url))
 966                die(_("failed to register url for submodule path '%s'"),
 967                      displaypath);
 968
 969        if (!is_submodule_populated_gently(path, NULL))
 970                goto cleanup;
 971
 972        prepare_submodule_repo_env(&cp.env_array);
 973        cp.git_cmd = 1;
 974        cp.dir = path;
 975        argv_array_pushl(&cp.args, "submodule--helper",
 976                         "print-default-remote", NULL);
 977
 978        strbuf_reset(&sb);
 979        if (capture_command(&cp, &sb, 0))
 980                die(_("failed to get the default remote for submodule '%s'"),
 981                      path);
 982
 983        strbuf_strip_suffix(&sb, "\n");
 984        remote_key = xstrfmt("remote.%s.url", sb.buf);
 985
 986        strbuf_reset(&sb);
 987        submodule_to_gitdir(&sb, path);
 988        strbuf_addstr(&sb, "/config");
 989
 990        if (git_config_set_in_file_gently(sb.buf, remote_key, sub_origin_url))
 991                die(_("failed to update remote for submodule '%s'"),
 992                      path);
 993
 994        if (flags & OPT_RECURSIVE) {
 995                struct child_process cpr = CHILD_PROCESS_INIT;
 996
 997                cpr.git_cmd = 1;
 998                cpr.dir = path;
 999                prepare_submodule_repo_env(&cpr.env_array);
1000
1001                argv_array_push(&cpr.args, "--super-prefix");
1002                argv_array_pushf(&cpr.args, "%s/", displaypath);
1003                argv_array_pushl(&cpr.args, "submodule--helper", "sync",
1004                                 "--recursive", NULL);
1005
1006                if (flags & OPT_QUIET)
1007                        argv_array_push(&cpr.args, "--quiet");
1008
1009                if (run_command(&cpr))
1010                        die(_("failed to recurse into submodule '%s'"),
1011                              path);
1012        }
1013
1014cleanup:
1015        free(super_config_url);
1016        free(sub_origin_url);
1017        strbuf_release(&sb);
1018        free(remote_key);
1019        free(displaypath);
1020        free(sub_config_path);
1021}
1022
1023static void sync_submodule_cb(const struct cache_entry *list_item, void *cb_data)
1024{
1025        struct sync_cb *info = cb_data;
1026        sync_submodule(list_item->name, info->prefix, info->flags);
1027}
1028
1029static int module_sync(int argc, const char **argv, const char *prefix)
1030{
1031        struct sync_cb info = SYNC_CB_INIT;
1032        struct pathspec pathspec;
1033        struct module_list list = MODULE_LIST_INIT;
1034        int quiet = 0;
1035        int recursive = 0;
1036
1037        struct option module_sync_options[] = {
1038                OPT__QUIET(&quiet, N_("Suppress output of synchronizing submodule url")),
1039                OPT_BOOL(0, "recursive", &recursive,
1040                        N_("Recurse into nested submodules")),
1041                OPT_END()
1042        };
1043
1044        const char *const git_submodule_helper_usage[] = {
1045                N_("git submodule--helper sync [--quiet] [--recursive] [<path>]"),
1046                NULL
1047        };
1048
1049        argc = parse_options(argc, argv, prefix, module_sync_options,
1050                             git_submodule_helper_usage, 0);
1051
1052        if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
1053                return 1;
1054
1055        info.prefix = prefix;
1056        if (quiet)
1057                info.flags |= OPT_QUIET;
1058        if (recursive)
1059                info.flags |= OPT_RECURSIVE;
1060
1061        for_each_listed_submodule(&list, sync_submodule_cb, &info);
1062
1063        return 0;
1064}
1065
1066struct deinit_cb {
1067        const char *prefix;
1068        unsigned int flags;
1069};
1070#define DEINIT_CB_INIT { NULL, 0 }
1071
1072static void deinit_submodule(const char *path, const char *prefix,
1073                             unsigned int flags)
1074{
1075        const struct submodule *sub;
1076        char *displaypath = NULL;
1077        struct child_process cp_config = CHILD_PROCESS_INIT;
1078        struct strbuf sb_config = STRBUF_INIT;
1079        char *sub_git_dir = xstrfmt("%s/.git", path);
1080
1081        sub = submodule_from_path(the_repository, &null_oid, path);
1082
1083        if (!sub || !sub->name)
1084                goto cleanup;
1085
1086        displaypath = get_submodule_displaypath(path, prefix);
1087
1088        /* remove the submodule work tree (unless the user already did it) */
1089        if (is_directory(path)) {
1090                struct strbuf sb_rm = STRBUF_INIT;
1091                const char *format;
1092
1093                /*
1094                 * protect submodules containing a .git directory
1095                 * NEEDSWORK: instead of dying, automatically call
1096                 * absorbgitdirs and (possibly) warn.
1097                 */
1098                if (is_directory(sub_git_dir))
1099                        die(_("Submodule work tree '%s' contains a .git "
1100                              "directory (use 'rm -rf' if you really want "
1101                              "to remove it including all of its history)"),
1102                            displaypath);
1103
1104                if (!(flags & OPT_FORCE)) {
1105                        struct child_process cp_rm = CHILD_PROCESS_INIT;
1106                        cp_rm.git_cmd = 1;
1107                        argv_array_pushl(&cp_rm.args, "rm", "-qn",
1108                                         path, NULL);
1109
1110                        if (run_command(&cp_rm))
1111                                die(_("Submodule work tree '%s' contains local "
1112                                      "modifications; use '-f' to discard them"),
1113                                      displaypath);
1114                }
1115
1116                strbuf_addstr(&sb_rm, path);
1117
1118                if (!remove_dir_recursively(&sb_rm, 0))
1119                        format = _("Cleared directory '%s'\n");
1120                else
1121                        format = _("Could not remove submodule work tree '%s'\n");
1122
1123                if (!(flags & OPT_QUIET))
1124                        printf(format, displaypath);
1125
1126                strbuf_release(&sb_rm);
1127        }
1128
1129        if (mkdir(path, 0777))
1130                printf(_("could not create empty submodule directory %s"),
1131                      displaypath);
1132
1133        cp_config.git_cmd = 1;
1134        argv_array_pushl(&cp_config.args, "config", "--get-regexp", NULL);
1135        argv_array_pushf(&cp_config.args, "submodule.%s\\.", sub->name);
1136
1137        /* remove the .git/config entries (unless the user already did it) */
1138        if (!capture_command(&cp_config, &sb_config, 0) && sb_config.len) {
1139                char *sub_key = xstrfmt("submodule.%s", sub->name);
1140                /*
1141                 * remove the whole section so we have a clean state when
1142                 * the user later decides to init this submodule again
1143                 */
1144                git_config_rename_section_in_file(NULL, sub_key, NULL);
1145                if (!(flags & OPT_QUIET))
1146                        printf(_("Submodule '%s' (%s) unregistered for path '%s'\n"),
1147                                 sub->name, sub->url, displaypath);
1148                free(sub_key);
1149        }
1150
1151cleanup:
1152        free(displaypath);
1153        free(sub_git_dir);
1154        strbuf_release(&sb_config);
1155}
1156
1157static void deinit_submodule_cb(const struct cache_entry *list_item,
1158                                void *cb_data)
1159{
1160        struct deinit_cb *info = cb_data;
1161        deinit_submodule(list_item->name, info->prefix, info->flags);
1162}
1163
1164static int module_deinit(int argc, const char **argv, const char *prefix)
1165{
1166        struct deinit_cb info = DEINIT_CB_INIT;
1167        struct pathspec pathspec;
1168        struct module_list list = MODULE_LIST_INIT;
1169        int quiet = 0;
1170        int force = 0;
1171        int all = 0;
1172
1173        struct option module_deinit_options[] = {
1174                OPT__QUIET(&quiet, N_("Suppress submodule status output")),
1175                OPT__FORCE(&force, N_("Remove submodule working trees even if they contain local changes"), 0),
1176                OPT_BOOL(0, "all", &all, N_("Unregister all submodules")),
1177                OPT_END()
1178        };
1179
1180        const char *const git_submodule_helper_usage[] = {
1181                N_("git submodule deinit [--quiet] [-f | --force] [--all | [--] [<path>...]]"),
1182                NULL
1183        };
1184
1185        argc = parse_options(argc, argv, prefix, module_deinit_options,
1186                             git_submodule_helper_usage, 0);
1187
1188        if (all && argc) {
1189                error("pathspec and --all are incompatible");
1190                usage_with_options(git_submodule_helper_usage,
1191                                   module_deinit_options);
1192        }
1193
1194        if (!argc && !all)
1195                die(_("Use '--all' if you really want to deinitialize all submodules"));
1196
1197        if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
1198                return 1;
1199
1200        info.prefix = prefix;
1201        if (quiet)
1202                info.flags |= OPT_QUIET;
1203        if (force)
1204                info.flags |= OPT_FORCE;
1205
1206        for_each_listed_submodule(&list, deinit_submodule_cb, &info);
1207
1208        return 0;
1209}
1210
1211static int clone_submodule(const char *path, const char *gitdir, const char *url,
1212                           const char *depth, struct string_list *reference, int dissociate,
1213                           int quiet, int progress)
1214{
1215        struct child_process cp = CHILD_PROCESS_INIT;
1216
1217        argv_array_push(&cp.args, "clone");
1218        argv_array_push(&cp.args, "--no-checkout");
1219        if (quiet)
1220                argv_array_push(&cp.args, "--quiet");
1221        if (progress)
1222                argv_array_push(&cp.args, "--progress");
1223        if (depth && *depth)
1224                argv_array_pushl(&cp.args, "--depth", depth, NULL);
1225        if (reference->nr) {
1226                struct string_list_item *item;
1227                for_each_string_list_item(item, reference)
1228                        argv_array_pushl(&cp.args, "--reference",
1229                                         item->string, NULL);
1230        }
1231        if (dissociate)
1232                argv_array_push(&cp.args, "--dissociate");
1233        if (gitdir && *gitdir)
1234                argv_array_pushl(&cp.args, "--separate-git-dir", gitdir, NULL);
1235
1236        argv_array_push(&cp.args, "--");
1237        argv_array_push(&cp.args, url);
1238        argv_array_push(&cp.args, path);
1239
1240        cp.git_cmd = 1;
1241        prepare_submodule_repo_env(&cp.env_array);
1242        cp.no_stdin = 1;
1243
1244        return run_command(&cp);
1245}
1246
1247struct submodule_alternate_setup {
1248        const char *submodule_name;
1249        enum SUBMODULE_ALTERNATE_ERROR_MODE {
1250                SUBMODULE_ALTERNATE_ERROR_DIE,
1251                SUBMODULE_ALTERNATE_ERROR_INFO,
1252                SUBMODULE_ALTERNATE_ERROR_IGNORE
1253        } error_mode;
1254        struct string_list *reference;
1255};
1256#define SUBMODULE_ALTERNATE_SETUP_INIT { NULL, \
1257        SUBMODULE_ALTERNATE_ERROR_IGNORE, NULL }
1258
1259static int add_possible_reference_from_superproject(
1260                struct alternate_object_database *alt, void *sas_cb)
1261{
1262        struct submodule_alternate_setup *sas = sas_cb;
1263
1264        /*
1265         * If the alternate object store is another repository, try the
1266         * standard layout with .git/(modules/<name>)+/objects
1267         */
1268        if (ends_with(alt->path, "/objects")) {
1269                char *sm_alternate;
1270                struct strbuf sb = STRBUF_INIT;
1271                struct strbuf err = STRBUF_INIT;
1272                strbuf_add(&sb, alt->path, strlen(alt->path) - strlen("objects"));
1273
1274                /*
1275                 * We need to end the new path with '/' to mark it as a dir,
1276                 * otherwise a submodule name containing '/' will be broken
1277                 * as the last part of a missing submodule reference would
1278                 * be taken as a file name.
1279                 */
1280                strbuf_addf(&sb, "modules/%s/", sas->submodule_name);
1281
1282                sm_alternate = compute_alternate_path(sb.buf, &err);
1283                if (sm_alternate) {
1284                        string_list_append(sas->reference, xstrdup(sb.buf));
1285                        free(sm_alternate);
1286                } else {
1287                        switch (sas->error_mode) {
1288                        case SUBMODULE_ALTERNATE_ERROR_DIE:
1289                                die(_("submodule '%s' cannot add alternate: %s"),
1290                                    sas->submodule_name, err.buf);
1291                        case SUBMODULE_ALTERNATE_ERROR_INFO:
1292                                fprintf(stderr, _("submodule '%s' cannot add alternate: %s"),
1293                                        sas->submodule_name, err.buf);
1294                        case SUBMODULE_ALTERNATE_ERROR_IGNORE:
1295                                ; /* nothing */
1296                        }
1297                }
1298                strbuf_release(&sb);
1299        }
1300
1301        return 0;
1302}
1303
1304static void prepare_possible_alternates(const char *sm_name,
1305                struct string_list *reference)
1306{
1307        char *sm_alternate = NULL, *error_strategy = NULL;
1308        struct submodule_alternate_setup sas = SUBMODULE_ALTERNATE_SETUP_INIT;
1309
1310        git_config_get_string("submodule.alternateLocation", &sm_alternate);
1311        if (!sm_alternate)
1312                return;
1313
1314        git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
1315
1316        if (!error_strategy)
1317                error_strategy = xstrdup("die");
1318
1319        sas.submodule_name = sm_name;
1320        sas.reference = reference;
1321        if (!strcmp(error_strategy, "die"))
1322                sas.error_mode = SUBMODULE_ALTERNATE_ERROR_DIE;
1323        else if (!strcmp(error_strategy, "info"))
1324                sas.error_mode = SUBMODULE_ALTERNATE_ERROR_INFO;
1325        else if (!strcmp(error_strategy, "ignore"))
1326                sas.error_mode = SUBMODULE_ALTERNATE_ERROR_IGNORE;
1327        else
1328                die(_("Value '%s' for submodule.alternateErrorStrategy is not recognized"), error_strategy);
1329
1330        if (!strcmp(sm_alternate, "superproject"))
1331                foreach_alt_odb(add_possible_reference_from_superproject, &sas);
1332        else if (!strcmp(sm_alternate, "no"))
1333                ; /* do nothing */
1334        else
1335                die(_("Value '%s' for submodule.alternateLocation is not recognized"), sm_alternate);
1336
1337        free(sm_alternate);
1338        free(error_strategy);
1339}
1340
1341static int module_clone(int argc, const char **argv, const char *prefix)
1342{
1343        const char *name = NULL, *url = NULL, *depth = NULL;
1344        int quiet = 0;
1345        int progress = 0;
1346        char *p, *path = NULL, *sm_gitdir;
1347        struct strbuf sb = STRBUF_INIT;
1348        struct string_list reference = STRING_LIST_INIT_NODUP;
1349        int dissociate = 0;
1350        char *sm_alternate = NULL, *error_strategy = NULL;
1351
1352        struct option module_clone_options[] = {
1353                OPT_STRING(0, "prefix", &prefix,
1354                           N_("path"),
1355                           N_("alternative anchor for relative paths")),
1356                OPT_STRING(0, "path", &path,
1357                           N_("path"),
1358                           N_("where the new submodule will be cloned to")),
1359                OPT_STRING(0, "name", &name,
1360                           N_("string"),
1361                           N_("name of the new submodule")),
1362                OPT_STRING(0, "url", &url,
1363                           N_("string"),
1364                           N_("url where to clone the submodule from")),
1365                OPT_STRING_LIST(0, "reference", &reference,
1366                           N_("repo"),
1367                           N_("reference repository")),
1368                OPT_BOOL(0, "dissociate", &dissociate,
1369                           N_("use --reference only while cloning")),
1370                OPT_STRING(0, "depth", &depth,
1371                           N_("string"),
1372                           N_("depth for shallow clones")),
1373                OPT__QUIET(&quiet, "Suppress output for cloning a submodule"),
1374                OPT_BOOL(0, "progress", &progress,
1375                           N_("force cloning progress")),
1376                OPT_END()
1377        };
1378
1379        const char *const git_submodule_helper_usage[] = {
1380                N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
1381                   "[--reference <repository>] [--name <name>] [--depth <depth>] "
1382                   "--url <url> --path <path>"),
1383                NULL
1384        };
1385
1386        argc = parse_options(argc, argv, prefix, module_clone_options,
1387                             git_submodule_helper_usage, 0);
1388
1389        if (argc || !url || !path || !*path)
1390                usage_with_options(git_submodule_helper_usage,
1391                                   module_clone_options);
1392
1393        strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), name);
1394        sm_gitdir = absolute_pathdup(sb.buf);
1395        strbuf_reset(&sb);
1396
1397        if (!is_absolute_path(path)) {
1398                strbuf_addf(&sb, "%s/%s", get_git_work_tree(), path);
1399                path = strbuf_detach(&sb, NULL);
1400        } else
1401                path = xstrdup(path);
1402
1403        if (!file_exists(sm_gitdir)) {
1404                if (safe_create_leading_directories_const(sm_gitdir) < 0)
1405                        die(_("could not create directory '%s'"), sm_gitdir);
1406
1407                prepare_possible_alternates(name, &reference);
1408
1409                if (clone_submodule(path, sm_gitdir, url, depth, &reference, dissociate,
1410                                    quiet, progress))
1411                        die(_("clone of '%s' into submodule path '%s' failed"),
1412                            url, path);
1413        } else {
1414                if (safe_create_leading_directories_const(path) < 0)
1415                        die(_("could not create directory '%s'"), path);
1416                strbuf_addf(&sb, "%s/index", sm_gitdir);
1417                unlink_or_warn(sb.buf);
1418                strbuf_reset(&sb);
1419        }
1420
1421        connect_work_tree_and_git_dir(path, sm_gitdir, 0);
1422
1423        p = git_pathdup_submodule(path, "config");
1424        if (!p)
1425                die(_("could not get submodule directory for '%s'"), path);
1426
1427        /* setup alternateLocation and alternateErrorStrategy in the cloned submodule if needed */
1428        git_config_get_string("submodule.alternateLocation", &sm_alternate);
1429        if (sm_alternate)
1430                git_config_set_in_file(p, "submodule.alternateLocation",
1431                                           sm_alternate);
1432        git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
1433        if (error_strategy)
1434                git_config_set_in_file(p, "submodule.alternateErrorStrategy",
1435                                           error_strategy);
1436
1437        free(sm_alternate);
1438        free(error_strategy);
1439
1440        strbuf_release(&sb);
1441        free(sm_gitdir);
1442        free(path);
1443        free(p);
1444        return 0;
1445}
1446
1447static void determine_submodule_update_strategy(struct repository *r,
1448                                                int just_cloned,
1449                                                const char *path,
1450                                                const char *update,
1451                                                struct submodule_update_strategy *out)
1452{
1453        const struct submodule *sub = submodule_from_path(r, &null_oid, path);
1454        char *key;
1455        const char *val;
1456
1457        key = xstrfmt("submodule.%s.update", sub->name);
1458
1459        if (update) {
1460                if (parse_submodule_update_strategy(update, out) < 0)
1461                        die(_("Invalid update mode '%s' for submodule path '%s'"),
1462                                update, path);
1463        } else if (!repo_config_get_string_const(r, key, &val)) {
1464                if (parse_submodule_update_strategy(val, out) < 0)
1465                        die(_("Invalid update mode '%s' configured for submodule path '%s'"),
1466                                val, path);
1467        } else if (sub->update_strategy.type != SM_UPDATE_UNSPECIFIED) {
1468                out->type = sub->update_strategy.type;
1469                out->command = sub->update_strategy.command;
1470        } else
1471                out->type = SM_UPDATE_CHECKOUT;
1472
1473        if (just_cloned &&
1474            (out->type == SM_UPDATE_MERGE ||
1475             out->type == SM_UPDATE_REBASE ||
1476             out->type == SM_UPDATE_NONE))
1477                out->type = SM_UPDATE_CHECKOUT;
1478
1479        free(key);
1480}
1481
1482static int module_update_module_mode(int argc, const char **argv, const char *prefix)
1483{
1484        const char *path, *update = NULL;
1485        int just_cloned;
1486        struct submodule_update_strategy update_strategy = { .type = SM_UPDATE_CHECKOUT };
1487
1488        if (argc < 3 || argc > 4)
1489                die("submodule--helper update-module-clone expects <just-cloned> <path> [<update>]");
1490
1491        just_cloned = git_config_int("just_cloned", argv[1]);
1492        path = argv[2];
1493
1494        if (argc == 4)
1495                update = argv[3];
1496
1497        determine_submodule_update_strategy(the_repository,
1498                                            just_cloned, path, update,
1499                                            &update_strategy);
1500        fputs(submodule_strategy_to_string(&update_strategy), stdout);
1501
1502        return 0;
1503}
1504
1505struct update_clone_data {
1506        const struct submodule *sub;
1507        struct object_id oid;
1508        unsigned just_cloned;
1509};
1510
1511struct submodule_update_clone {
1512        /* index into 'list', the list of submodules to look into for cloning */
1513        int current;
1514        struct module_list list;
1515        unsigned warn_if_uninitialized : 1;
1516
1517        /* update parameter passed via commandline */
1518        struct submodule_update_strategy update;
1519
1520        /* configuration parameters which are passed on to the children */
1521        int progress;
1522        int quiet;
1523        int recommend_shallow;
1524        struct string_list references;
1525        int dissociate;
1526        const char *depth;
1527        const char *recursive_prefix;
1528        const char *prefix;
1529
1530        /* to be consumed by git-submodule.sh */
1531        struct update_clone_data *update_clone;
1532        int update_clone_nr; int update_clone_alloc;
1533
1534        /* If we want to stop as fast as possible and return an error */
1535        unsigned quickstop : 1;
1536
1537        /* failed clones to be retried again */
1538        const struct cache_entry **failed_clones;
1539        int failed_clones_nr, failed_clones_alloc;
1540
1541        int max_jobs;
1542};
1543#define SUBMODULE_UPDATE_CLONE_INIT {0, MODULE_LIST_INIT, 0, \
1544        SUBMODULE_UPDATE_STRATEGY_INIT, 0, 0, -1, STRING_LIST_INIT_DUP, 0, \
1545        NULL, NULL, NULL, \
1546        NULL, 0, 0, 0, NULL, 0, 0, 0}
1547
1548
1549static void next_submodule_warn_missing(struct submodule_update_clone *suc,
1550                struct strbuf *out, const char *displaypath)
1551{
1552        /*
1553         * Only mention uninitialized submodules when their
1554         * paths have been specified.
1555         */
1556        if (suc->warn_if_uninitialized) {
1557                strbuf_addf(out,
1558                        _("Submodule path '%s' not initialized"),
1559                        displaypath);
1560                strbuf_addch(out, '\n');
1561                strbuf_addstr(out,
1562                        _("Maybe you want to use 'update --init'?"));
1563                strbuf_addch(out, '\n');
1564        }
1565}
1566
1567/**
1568 * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
1569 * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
1570 */
1571static int prepare_to_clone_next_submodule(const struct cache_entry *ce,
1572                                           struct child_process *child,
1573                                           struct submodule_update_clone *suc,
1574                                           struct strbuf *out)
1575{
1576        const struct submodule *sub = NULL;
1577        const char *url = NULL;
1578        const char *update_string;
1579        enum submodule_update_type update_type;
1580        char *key;
1581        struct strbuf displaypath_sb = STRBUF_INIT;
1582        struct strbuf sb = STRBUF_INIT;
1583        const char *displaypath = NULL;
1584        int needs_cloning = 0;
1585
1586        if (ce_stage(ce)) {
1587                if (suc->recursive_prefix)
1588                        strbuf_addf(&sb, "%s/%s", suc->recursive_prefix, ce->name);
1589                else
1590                        strbuf_addstr(&sb, ce->name);
1591                strbuf_addf(out, _("Skipping unmerged submodule %s"), sb.buf);
1592                strbuf_addch(out, '\n');
1593                goto cleanup;
1594        }
1595
1596        sub = submodule_from_path(the_repository, &null_oid, ce->name);
1597
1598        if (suc->recursive_prefix)
1599                displaypath = relative_path(suc->recursive_prefix,
1600                                            ce->name, &displaypath_sb);
1601        else
1602                displaypath = ce->name;
1603
1604        if (!sub) {
1605                next_submodule_warn_missing(suc, out, displaypath);
1606                goto cleanup;
1607        }
1608
1609        key = xstrfmt("submodule.%s.update", sub->name);
1610        if (!repo_config_get_string_const(the_repository, key, &update_string)) {
1611                update_type = parse_submodule_update_type(update_string);
1612        } else {
1613                update_type = sub->update_strategy.type;
1614        }
1615        free(key);
1616
1617        if (suc->update.type == SM_UPDATE_NONE
1618            || (suc->update.type == SM_UPDATE_UNSPECIFIED
1619                && update_type == SM_UPDATE_NONE)) {
1620                strbuf_addf(out, _("Skipping submodule '%s'"), displaypath);
1621                strbuf_addch(out, '\n');
1622                goto cleanup;
1623        }
1624
1625        /* Check if the submodule has been initialized. */
1626        if (!is_submodule_active(the_repository, ce->name)) {
1627                next_submodule_warn_missing(suc, out, displaypath);
1628                goto cleanup;
1629        }
1630
1631        strbuf_reset(&sb);
1632        strbuf_addf(&sb, "submodule.%s.url", sub->name);
1633        if (repo_config_get_string_const(the_repository, sb.buf, &url))
1634                url = sub->url;
1635
1636        strbuf_reset(&sb);
1637        strbuf_addf(&sb, "%s/.git", ce->name);
1638        needs_cloning = !file_exists(sb.buf);
1639
1640        ALLOC_GROW(suc->update_clone, suc->update_clone_nr + 1,
1641                   suc->update_clone_alloc);
1642        oidcpy(&suc->update_clone[suc->update_clone_nr].oid, &ce->oid);
1643        suc->update_clone[suc->update_clone_nr].just_cloned = needs_cloning;
1644        suc->update_clone[suc->update_clone_nr].sub = sub;
1645        suc->update_clone_nr++;
1646
1647        if (!needs_cloning)
1648                goto cleanup;
1649
1650        child->git_cmd = 1;
1651        child->no_stdin = 1;
1652        child->stdout_to_stderr = 1;
1653        child->err = -1;
1654        argv_array_push(&child->args, "submodule--helper");
1655        argv_array_push(&child->args, "clone");
1656        if (suc->progress)
1657                argv_array_push(&child->args, "--progress");
1658        if (suc->quiet)
1659                argv_array_push(&child->args, "--quiet");
1660        if (suc->prefix)
1661                argv_array_pushl(&child->args, "--prefix", suc->prefix, NULL);
1662        if (suc->recommend_shallow && sub->recommend_shallow == 1)
1663                argv_array_push(&child->args, "--depth=1");
1664        argv_array_pushl(&child->args, "--path", sub->path, NULL);
1665        argv_array_pushl(&child->args, "--name", sub->name, NULL);
1666        argv_array_pushl(&child->args, "--url", url, NULL);
1667        if (suc->references.nr) {
1668                struct string_list_item *item;
1669                for_each_string_list_item(item, &suc->references)
1670                        argv_array_pushl(&child->args, "--reference", item->string, NULL);
1671        }
1672        if (suc->dissociate)
1673                argv_array_push(&child->args, "--dissociate");
1674        if (suc->depth)
1675                argv_array_push(&child->args, suc->depth);
1676
1677cleanup:
1678        strbuf_reset(&displaypath_sb);
1679        strbuf_reset(&sb);
1680
1681        return needs_cloning;
1682}
1683
1684static int update_clone_get_next_task(struct child_process *child,
1685                                      struct strbuf *err,
1686                                      void *suc_cb,
1687                                      void **idx_task_cb)
1688{
1689        struct submodule_update_clone *suc = suc_cb;
1690        const struct cache_entry *ce;
1691        int index;
1692
1693        for (; suc->current < suc->list.nr; suc->current++) {
1694                ce = suc->list.entries[suc->current];
1695                if (prepare_to_clone_next_submodule(ce, child, suc, err)) {
1696                        int *p = xmalloc(sizeof(*p));
1697                        *p = suc->current;
1698                        *idx_task_cb = p;
1699                        suc->current++;
1700                        return 1;
1701                }
1702        }
1703
1704        /*
1705         * The loop above tried cloning each submodule once, now try the
1706         * stragglers again, which we can imagine as an extension of the
1707         * entry list.
1708         */
1709        index = suc->current - suc->list.nr;
1710        if (index < suc->failed_clones_nr) {
1711                int *p;
1712                ce = suc->failed_clones[index];
1713                if (!prepare_to_clone_next_submodule(ce, child, suc, err)) {
1714                        suc->current ++;
1715                        strbuf_addstr(err, "BUG: submodule considered for "
1716                                           "cloning, doesn't need cloning "
1717                                           "any more?\n");
1718                        return 0;
1719                }
1720                p = xmalloc(sizeof(*p));
1721                *p = suc->current;
1722                *idx_task_cb = p;
1723                suc->current ++;
1724                return 1;
1725        }
1726
1727        return 0;
1728}
1729
1730static int update_clone_start_failure(struct strbuf *err,
1731                                      void *suc_cb,
1732                                      void *idx_task_cb)
1733{
1734        struct submodule_update_clone *suc = suc_cb;
1735        suc->quickstop = 1;
1736        return 1;
1737}
1738
1739static int update_clone_task_finished(int result,
1740                                      struct strbuf *err,
1741                                      void *suc_cb,
1742                                      void *idx_task_cb)
1743{
1744        const struct cache_entry *ce;
1745        struct submodule_update_clone *suc = suc_cb;
1746
1747        int *idxP = idx_task_cb;
1748        int idx = *idxP;
1749        free(idxP);
1750
1751        if (!result)
1752                return 0;
1753
1754        if (idx < suc->list.nr) {
1755                ce  = suc->list.entries[idx];
1756                strbuf_addf(err, _("Failed to clone '%s'. Retry scheduled"),
1757                            ce->name);
1758                strbuf_addch(err, '\n');
1759                ALLOC_GROW(suc->failed_clones,
1760                           suc->failed_clones_nr + 1,
1761                           suc->failed_clones_alloc);
1762                suc->failed_clones[suc->failed_clones_nr++] = ce;
1763                return 0;
1764        } else {
1765                idx -= suc->list.nr;
1766                ce  = suc->failed_clones[idx];
1767                strbuf_addf(err, _("Failed to clone '%s' a second time, aborting"),
1768                            ce->name);
1769                strbuf_addch(err, '\n');
1770                suc->quickstop = 1;
1771                return 1;
1772        }
1773
1774        return 0;
1775}
1776
1777static int git_update_clone_config(const char *var, const char *value,
1778                                   void *cb)
1779{
1780        int *max_jobs = cb;
1781        if (!strcmp(var, "submodule.fetchjobs"))
1782                *max_jobs = parse_submodule_fetchjobs(var, value);
1783        return 0;
1784}
1785
1786static void update_submodule(struct update_clone_data *ucd)
1787{
1788        fprintf(stdout, "dummy %s %d\t%s\n",
1789                oid_to_hex(&ucd->oid),
1790                ucd->just_cloned,
1791                ucd->sub->path);
1792}
1793
1794static int update_submodules(struct submodule_update_clone *suc)
1795{
1796        int i;
1797
1798        run_processes_parallel(suc->max_jobs,
1799                               update_clone_get_next_task,
1800                               update_clone_start_failure,
1801                               update_clone_task_finished,
1802                               suc);
1803
1804        /*
1805         * We saved the output and put it out all at once now.
1806         * That means:
1807         * - the listener does not have to interleave their (checkout)
1808         *   work with our fetching.  The writes involved in a
1809         *   checkout involve more straightforward sequential I/O.
1810         * - the listener can avoid doing any work if fetching failed.
1811         */
1812        if (suc->quickstop)
1813                return 1;
1814
1815        for (i = 0; i < suc->update_clone_nr; i++)
1816                update_submodule(&suc->update_clone[i]);
1817
1818        return 0;
1819}
1820
1821static int update_clone(int argc, const char **argv, const char *prefix)
1822{
1823        const char *update = NULL;
1824        struct pathspec pathspec;
1825        struct submodule_update_clone suc = SUBMODULE_UPDATE_CLONE_INIT;
1826
1827        struct option module_update_clone_options[] = {
1828                OPT_STRING(0, "prefix", &prefix,
1829                           N_("path"),
1830                           N_("path into the working tree")),
1831                OPT_STRING(0, "recursive-prefix", &suc.recursive_prefix,
1832                           N_("path"),
1833                           N_("path into the working tree, across nested "
1834                              "submodule boundaries")),
1835                OPT_STRING(0, "update", &update,
1836                           N_("string"),
1837                           N_("rebase, merge, checkout or none")),
1838                OPT_STRING_LIST(0, "reference", &suc.references, N_("repo"),
1839                           N_("reference repository")),
1840                OPT_BOOL(0, "dissociate", &suc.dissociate,
1841                           N_("use --reference only while cloning")),
1842                OPT_STRING(0, "depth", &suc.depth, "<depth>",
1843                           N_("Create a shallow clone truncated to the "
1844                              "specified number of revisions")),
1845                OPT_INTEGER('j', "jobs", &suc.max_jobs,
1846                            N_("parallel jobs")),
1847                OPT_BOOL(0, "recommend-shallow", &suc.recommend_shallow,
1848                            N_("whether the initial clone should follow the shallow recommendation")),
1849                OPT__QUIET(&suc.quiet, N_("don't print cloning progress")),
1850                OPT_BOOL(0, "progress", &suc.progress,
1851                            N_("force cloning progress")),
1852                OPT_END()
1853        };
1854
1855        const char *const git_submodule_helper_usage[] = {
1856                N_("git submodule--helper update_clone [--prefix=<path>] [<path>...]"),
1857                NULL
1858        };
1859        suc.prefix = prefix;
1860
1861        update_clone_config_from_gitmodules(&suc.max_jobs);
1862        git_config(git_update_clone_config, &suc.max_jobs);
1863
1864        argc = parse_options(argc, argv, prefix, module_update_clone_options,
1865                             git_submodule_helper_usage, 0);
1866
1867        if (update)
1868                if (parse_submodule_update_strategy(update, &suc.update) < 0)
1869                        die(_("bad value for update parameter"));
1870
1871        if (module_list_compute(argc, argv, prefix, &pathspec, &suc.list) < 0)
1872                return 1;
1873
1874        if (pathspec.nr)
1875                suc.warn_if_uninitialized = 1;
1876
1877        return update_submodules(&suc);
1878}
1879
1880static int resolve_relative_path(int argc, const char **argv, const char *prefix)
1881{
1882        struct strbuf sb = STRBUF_INIT;
1883        if (argc != 3)
1884                die("submodule--helper relative-path takes exactly 2 arguments, got %d", argc);
1885
1886        printf("%s", relative_path(argv[1], argv[2], &sb));
1887        strbuf_release(&sb);
1888        return 0;
1889}
1890
1891static const char *remote_submodule_branch(const char *path)
1892{
1893        const struct submodule *sub;
1894        const char *branch = NULL;
1895        char *key;
1896
1897        sub = submodule_from_path(the_repository, &null_oid, path);
1898        if (!sub)
1899                return NULL;
1900
1901        key = xstrfmt("submodule.%s.branch", sub->name);
1902        if (repo_config_get_string_const(the_repository, key, &branch))
1903                branch = sub->branch;
1904        free(key);
1905
1906        if (!branch)
1907                return "master";
1908
1909        if (!strcmp(branch, ".")) {
1910                const char *refname = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
1911
1912                if (!refname)
1913                        die(_("No such ref: %s"), "HEAD");
1914
1915                /* detached HEAD */
1916                if (!strcmp(refname, "HEAD"))
1917                        die(_("Submodule (%s) branch configured to inherit "
1918                              "branch from superproject, but the superproject "
1919                              "is not on any branch"), sub->name);
1920
1921                if (!skip_prefix(refname, "refs/heads/", &refname))
1922                        die(_("Expecting a full ref name, got %s"), refname);
1923                return refname;
1924        }
1925
1926        return branch;
1927}
1928
1929static int resolve_remote_submodule_branch(int argc, const char **argv,
1930                const char *prefix)
1931{
1932        const char *ret;
1933        struct strbuf sb = STRBUF_INIT;
1934        if (argc != 2)
1935                die("submodule--helper remote-branch takes exactly one arguments, got %d", argc);
1936
1937        ret = remote_submodule_branch(argv[1]);
1938        if (!ret)
1939                die("submodule %s doesn't exist", argv[1]);
1940
1941        printf("%s", ret);
1942        strbuf_release(&sb);
1943        return 0;
1944}
1945
1946static int push_check(int argc, const char **argv, const char *prefix)
1947{
1948        struct remote *remote;
1949        const char *superproject_head;
1950        char *head;
1951        int detached_head = 0;
1952        struct object_id head_oid;
1953
1954        if (argc < 3)
1955                die("submodule--helper push-check requires at least 2 arguments");
1956
1957        /*
1958         * superproject's resolved head ref.
1959         * if HEAD then the superproject is in a detached head state, otherwise
1960         * it will be the resolved head ref.
1961         */
1962        superproject_head = argv[1];
1963        argv++;
1964        argc--;
1965        /* Get the submodule's head ref and determine if it is detached */
1966        head = resolve_refdup("HEAD", 0, &head_oid, NULL);
1967        if (!head)
1968                die(_("Failed to resolve HEAD as a valid ref."));
1969        if (!strcmp(head, "HEAD"))
1970                detached_head = 1;
1971
1972        /*
1973         * The remote must be configured.
1974         * This is to avoid pushing to the exact same URL as the parent.
1975         */
1976        remote = pushremote_get(argv[1]);
1977        if (!remote || remote->origin == REMOTE_UNCONFIGURED)
1978                die("remote '%s' not configured", argv[1]);
1979
1980        /* Check the refspec */
1981        if (argc > 2) {
1982                int i;
1983                struct ref *local_refs = get_local_heads();
1984                struct refspec refspec = REFSPEC_INIT_PUSH;
1985
1986                refspec_appendn(&refspec, argv + 2, argc - 2);
1987
1988                for (i = 0; i < refspec.nr; i++) {
1989                        const struct refspec_item *rs = &refspec.items[i];
1990
1991                        if (rs->pattern || rs->matching)
1992                                continue;
1993
1994                        /* LHS must match a single ref */
1995                        switch (count_refspec_match(rs->src, local_refs, NULL)) {
1996                        case 1:
1997                                break;
1998                        case 0:
1999                                /*
2000                                 * If LHS matches 'HEAD' then we need to ensure
2001                                 * that it matches the same named branch
2002                                 * checked out in the superproject.
2003                                 */
2004                                if (!strcmp(rs->src, "HEAD")) {
2005                                        if (!detached_head &&
2006                                            !strcmp(head, superproject_head))
2007                                                break;
2008                                        die("HEAD does not match the named branch in the superproject");
2009                                }
2010                                /* fallthrough */
2011                        default:
2012                                die("src refspec '%s' must name a ref",
2013                                    rs->src);
2014                        }
2015                }
2016                refspec_clear(&refspec);
2017        }
2018        free(head);
2019
2020        return 0;
2021}
2022
2023static int ensure_core_worktree(int argc, const char **argv, const char *prefix)
2024{
2025        const struct submodule *sub;
2026        const char *path;
2027        char *cw;
2028        struct repository subrepo;
2029
2030        if (argc != 2)
2031                BUG("submodule--helper connect-gitdir-workingtree <name> <path>");
2032
2033        path = argv[1];
2034
2035        sub = submodule_from_path(the_repository, &null_oid, path);
2036        if (!sub)
2037                BUG("We could get the submodule handle before?");
2038
2039        if (repo_submodule_init(&subrepo, the_repository, path))
2040                die(_("could not get a repository handle for submodule '%s'"), path);
2041
2042        if (!repo_config_get_string(&subrepo, "core.worktree", &cw)) {
2043                char *cfg_file, *abs_path;
2044                const char *rel_path;
2045                struct strbuf sb = STRBUF_INIT;
2046
2047                cfg_file = repo_git_path(&subrepo, "config");
2048
2049                abs_path = absolute_pathdup(path);
2050                rel_path = relative_path(abs_path, subrepo.gitdir, &sb);
2051
2052                git_config_set_in_file(cfg_file, "core.worktree", rel_path);
2053
2054                free(cfg_file);
2055                free(abs_path);
2056                strbuf_release(&sb);
2057        }
2058
2059        return 0;
2060}
2061
2062static int absorb_git_dirs(int argc, const char **argv, const char *prefix)
2063{
2064        int i;
2065        struct pathspec pathspec;
2066        struct module_list list = MODULE_LIST_INIT;
2067        unsigned flags = ABSORB_GITDIR_RECURSE_SUBMODULES;
2068
2069        struct option embed_gitdir_options[] = {
2070                OPT_STRING(0, "prefix", &prefix,
2071                           N_("path"),
2072                           N_("path into the working tree")),
2073                OPT_BIT(0, "--recursive", &flags, N_("recurse into submodules"),
2074                        ABSORB_GITDIR_RECURSE_SUBMODULES),
2075                OPT_END()
2076        };
2077
2078        const char *const git_submodule_helper_usage[] = {
2079                N_("git submodule--helper embed-git-dir [<path>...]"),
2080                NULL
2081        };
2082
2083        argc = parse_options(argc, argv, prefix, embed_gitdir_options,
2084                             git_submodule_helper_usage, 0);
2085
2086        if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
2087                return 1;
2088
2089        for (i = 0; i < list.nr; i++)
2090                absorb_git_dir_into_superproject(prefix,
2091                                list.entries[i]->name, flags);
2092
2093        return 0;
2094}
2095
2096static int is_active(int argc, const char **argv, const char *prefix)
2097{
2098        if (argc != 2)
2099                die("submodule--helper is-active takes exactly 1 argument");
2100
2101        return !is_submodule_active(the_repository, argv[1]);
2102}
2103
2104/*
2105 * Exit non-zero if any of the submodule names given on the command line is
2106 * invalid. If no names are given, filter stdin to print only valid names
2107 * (which is primarily intended for testing).
2108 */
2109static int check_name(int argc, const char **argv, const char *prefix)
2110{
2111        if (argc > 1) {
2112                while (*++argv) {
2113                        if (check_submodule_name(*argv) < 0)
2114                                return 1;
2115                }
2116        } else {
2117                struct strbuf buf = STRBUF_INIT;
2118                while (strbuf_getline(&buf, stdin) != EOF) {
2119                        if (!check_submodule_name(buf.buf))
2120                                printf("%s\n", buf.buf);
2121                }
2122                strbuf_release(&buf);
2123        }
2124        return 0;
2125}
2126
2127#define SUPPORT_SUPER_PREFIX (1<<0)
2128
2129struct cmd_struct {
2130        const char *cmd;
2131        int (*fn)(int, const char **, const char *);
2132        unsigned option;
2133};
2134
2135static struct cmd_struct commands[] = {
2136        {"list", module_list, 0},
2137        {"name", module_name, 0},
2138        {"clone", module_clone, 0},
2139        {"update-module-mode", module_update_module_mode, 0},
2140        {"update-clone", update_clone, 0},
2141        {"ensure-core-worktree", ensure_core_worktree, 0},
2142        {"relative-path", resolve_relative_path, 0},
2143        {"resolve-relative-url", resolve_relative_url, 0},
2144        {"resolve-relative-url-test", resolve_relative_url_test, 0},
2145        {"foreach", module_foreach, SUPPORT_SUPER_PREFIX},
2146        {"init", module_init, SUPPORT_SUPER_PREFIX},
2147        {"status", module_status, SUPPORT_SUPER_PREFIX},
2148        {"print-default-remote", print_default_remote, 0},
2149        {"sync", module_sync, SUPPORT_SUPER_PREFIX},
2150        {"deinit", module_deinit, 0},
2151        {"remote-branch", resolve_remote_submodule_branch, 0},
2152        {"push-check", push_check, 0},
2153        {"absorb-git-dirs", absorb_git_dirs, SUPPORT_SUPER_PREFIX},
2154        {"is-active", is_active, 0},
2155        {"check-name", check_name, 0},
2156};
2157
2158int cmd_submodule__helper(int argc, const char **argv, const char *prefix)
2159{
2160        int i;
2161        if (argc < 2 || !strcmp(argv[1], "-h"))
2162                usage("git submodule--helper <command>");
2163
2164        for (i = 0; i < ARRAY_SIZE(commands); i++) {
2165                if (!strcmp(argv[1], commands[i].cmd)) {
2166                        if (get_super_prefix() &&
2167                            !(commands[i].option & SUPPORT_SUPER_PREFIX))
2168                                die(_("%s doesn't support --super-prefix"),
2169                                    commands[i].cmd);
2170                        return commands[i].fn(argc - 1, argv + 1, prefix);
2171                }
2172        }
2173
2174        die(_("'%s' is not a valid submodule--helper "
2175              "subcommand"), argv[1]);
2176}