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