Andrew's git / gitweb.git / builtin/submodule--helper.c
?
builtin / submodule--helper.con commit Merge branch 'sb/z-is-gnutar-ism' (2049e7e)
   1#include "builtin.h"
   2#include "cache.h"
   3#include "parse-options.h"
   4#include "quote.h"
   5#include "pathspec.h"
   6#include "dir.h"
   7#include "utf8.h"
   8#include "submodule.h"
   9#include "submodule-config.h"
  10#include "string-list.h"
  11#include "run-command.h"
  12#include "remote.h"
  13#include "refs.h"
  14#include "connect.h"
  15
  16static char *get_default_remote(void)
  17{
  18        char *dest = NULL, *ret;
  19        unsigned char sha1[20];
  20        struct strbuf sb = STRBUF_INIT;
  21        const char *refname = resolve_ref_unsafe("HEAD", 0, sha1, NULL);
  22
  23        if (!refname)
  24                die(_("No such ref: %s"), "HEAD");
  25
  26        /* detached HEAD */
  27        if (!strcmp(refname, "HEAD"))
  28                return xstrdup("origin");
  29
  30        if (!skip_prefix(refname, "refs/heads/", &refname))
  31                die(_("Expecting a full ref name, got %s"), refname);
  32
  33        strbuf_addf(&sb, "branch.%s.remote", refname);
  34        if (git_config_get_string(sb.buf, &dest))
  35                ret = xstrdup("origin");
  36        else
  37                ret = dest;
  38
  39        strbuf_release(&sb);
  40        return ret;
  41}
  42
  43static int starts_with_dot_slash(const char *str)
  44{
  45        return str[0] == '.' && is_dir_sep(str[1]);
  46}
  47
  48static int starts_with_dot_dot_slash(const char *str)
  49{
  50        return str[0] == '.' && str[1] == '.' && is_dir_sep(str[2]);
  51}
  52
  53/*
  54 * Returns 1 if it was the last chop before ':'.
  55 */
  56static int chop_last_dir(char **remoteurl, int is_relative)
  57{
  58        char *rfind = find_last_dir_sep(*remoteurl);
  59        if (rfind) {
  60                *rfind = '\0';
  61                return 0;
  62        }
  63
  64        rfind = strrchr(*remoteurl, ':');
  65        if (rfind) {
  66                *rfind = '\0';
  67                return 1;
  68        }
  69
  70        if (is_relative || !strcmp(".", *remoteurl))
  71                die(_("cannot strip one component off url '%s'"),
  72                        *remoteurl);
  73
  74        free(*remoteurl);
  75        *remoteurl = xstrdup(".");
  76        return 0;
  77}
  78
  79/*
  80 * The `url` argument is the URL that navigates to the submodule origin
  81 * repo. When relative, this URL is relative to the superproject origin
  82 * URL repo. The `up_path` argument, if specified, is the relative
  83 * path that navigates from the submodule working tree to the superproject
  84 * working tree. Returns the origin URL of the submodule.
  85 *
  86 * Return either an absolute URL or filesystem path (if the superproject
  87 * origin URL is an absolute URL or filesystem path, respectively) or a
  88 * relative file system path (if the superproject origin URL is a relative
  89 * file system path).
  90 *
  91 * When the output is a relative file system path, the path is either
  92 * relative to the submodule working tree, if up_path is specified, or to
  93 * the superproject working tree otherwise.
  94 *
  95 * NEEDSWORK: This works incorrectly on the domain and protocol part.
  96 * remote_url      url              outcome          expectation
  97 * http://a.com/b  ../c             http://a.com/c   as is
  98 * http://a.com/b  ../../c          http://c         error out
  99 * http://a.com/b  ../../../c       http:/c          error out
 100 * http://a.com/b  ../../../../c    http:c           error out
 101 * http://a.com/b  ../../../../../c    .:c           error out
 102 * NEEDSWORK: Given how chop_last_dir() works, this function is broken
 103 * when a local part has a colon in its path component, too.
 104 */
 105static char *relative_url(const char *remote_url,
 106                                const char *url,
 107                                const char *up_path)
 108{
 109        int is_relative = 0;
 110        int colonsep = 0;
 111        char *out;
 112        char *remoteurl = xstrdup(remote_url);
 113        struct strbuf sb = STRBUF_INIT;
 114        size_t len = strlen(remoteurl);
 115
 116        if (is_dir_sep(remoteurl[len]))
 117                remoteurl[len] = '\0';
 118
 119        if (!url_is_local_not_ssh(remoteurl) || is_absolute_path(remoteurl))
 120                is_relative = 0;
 121        else {
 122                is_relative = 1;
 123                /*
 124                 * Prepend a './' to ensure all relative
 125                 * remoteurls start with './' or '../'
 126                 */
 127                if (!starts_with_dot_slash(remoteurl) &&
 128                    !starts_with_dot_dot_slash(remoteurl)) {
 129                        strbuf_reset(&sb);
 130                        strbuf_addf(&sb, "./%s", remoteurl);
 131                        free(remoteurl);
 132                        remoteurl = strbuf_detach(&sb, NULL);
 133                }
 134        }
 135        /*
 136         * When the url starts with '../', remove that and the
 137         * last directory in remoteurl.
 138         */
 139        while (url) {
 140                if (starts_with_dot_dot_slash(url)) {
 141                        url += 3;
 142                        colonsep |= chop_last_dir(&remoteurl, is_relative);
 143                } else if (starts_with_dot_slash(url))
 144                        url += 2;
 145                else
 146                        break;
 147        }
 148        strbuf_reset(&sb);
 149        strbuf_addf(&sb, "%s%s%s", remoteurl, colonsep ? ":" : "/", url);
 150        free(remoteurl);
 151
 152        if (starts_with_dot_slash(sb.buf))
 153                out = xstrdup(sb.buf + 2);
 154        else
 155                out = xstrdup(sb.buf);
 156        strbuf_reset(&sb);
 157
 158        if (!up_path || !is_relative)
 159                return out;
 160
 161        strbuf_addf(&sb, "%s%s", up_path, out);
 162        free(out);
 163        return strbuf_detach(&sb, NULL);
 164}
 165
 166static int resolve_relative_url(int argc, const char **argv, const char *prefix)
 167{
 168        char *remoteurl = NULL;
 169        char *remote = get_default_remote();
 170        const char *up_path = NULL;
 171        char *res;
 172        const char *url;
 173        struct strbuf sb = STRBUF_INIT;
 174
 175        if (argc != 2 && argc != 3)
 176                die("resolve-relative-url only accepts one or two arguments");
 177
 178        url = argv[1];
 179        strbuf_addf(&sb, "remote.%s.url", remote);
 180        free(remote);
 181
 182        if (git_config_get_string(sb.buf, &remoteurl))
 183                /* the repository is its own authoritative upstream */
 184                remoteurl = xgetcwd();
 185
 186        if (argc == 3)
 187                up_path = argv[2];
 188
 189        res = relative_url(remoteurl, url, up_path);
 190        puts(res);
 191        free(res);
 192        free(remoteurl);
 193        return 0;
 194}
 195
 196static int resolve_relative_url_test(int argc, const char **argv, const char *prefix)
 197{
 198        char *remoteurl, *res;
 199        const char *up_path, *url;
 200
 201        if (argc != 4)
 202                die("resolve-relative-url-test only accepts three arguments: <up_path> <remoteurl> <url>");
 203
 204        up_path = argv[1];
 205        remoteurl = xstrdup(argv[2]);
 206        url = argv[3];
 207
 208        if (!strcmp(up_path, "(null)"))
 209                up_path = NULL;
 210
 211        res = relative_url(remoteurl, url, up_path);
 212        puts(res);
 213        free(res);
 214        free(remoteurl);
 215        return 0;
 216}
 217
 218struct module_list {
 219        const struct cache_entry **entries;
 220        int alloc, nr;
 221};
 222#define MODULE_LIST_INIT { NULL, 0, 0 }
 223
 224static int module_list_compute(int argc, const char **argv,
 225                               const char *prefix,
 226                               struct pathspec *pathspec,
 227                               struct module_list *list)
 228{
 229        int i, result = 0;
 230        char *ps_matched = NULL;
 231        parse_pathspec(pathspec, 0,
 232                       PATHSPEC_PREFER_FULL |
 233                       PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP,
 234                       prefix, argv);
 235
 236        if (pathspec->nr)
 237                ps_matched = xcalloc(pathspec->nr, 1);
 238
 239        if (read_cache() < 0)
 240                die(_("index file corrupt"));
 241
 242        for (i = 0; i < active_nr; i++) {
 243                const struct cache_entry *ce = active_cache[i];
 244
 245                if (!match_pathspec(pathspec, ce->name, ce_namelen(ce),
 246                                    0, ps_matched, 1) ||
 247                    !S_ISGITLINK(ce->ce_mode))
 248                        continue;
 249
 250                ALLOC_GROW(list->entries, list->nr + 1, list->alloc);
 251                list->entries[list->nr++] = ce;
 252                while (i + 1 < active_nr &&
 253                       !strcmp(ce->name, active_cache[i + 1]->name))
 254                        /*
 255                         * Skip entries with the same name in different stages
 256                         * to make sure an entry is returned only once.
 257                         */
 258                        i++;
 259        }
 260
 261        if (ps_matched && report_path_error(ps_matched, pathspec, prefix))
 262                result = -1;
 263
 264        free(ps_matched);
 265
 266        return result;
 267}
 268
 269static int module_list(int argc, const char **argv, const char *prefix)
 270{
 271        int i;
 272        struct pathspec pathspec;
 273        struct module_list list = MODULE_LIST_INIT;
 274
 275        struct option module_list_options[] = {
 276                OPT_STRING(0, "prefix", &prefix,
 277                           N_("path"),
 278                           N_("alternative anchor for relative paths")),
 279                OPT_END()
 280        };
 281
 282        const char *const git_submodule_helper_usage[] = {
 283                N_("git submodule--helper list [--prefix=<path>] [<path>...]"),
 284                NULL
 285        };
 286
 287        argc = parse_options(argc, argv, prefix, module_list_options,
 288                             git_submodule_helper_usage, 0);
 289
 290        if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0) {
 291                printf("#unmatched\n");
 292                return 1;
 293        }
 294
 295        for (i = 0; i < list.nr; i++) {
 296                const struct cache_entry *ce = list.entries[i];
 297
 298                if (ce_stage(ce))
 299                        printf("%06o %s U\t", ce->ce_mode, sha1_to_hex(null_sha1));
 300                else
 301                        printf("%06o %s %d\t", ce->ce_mode, sha1_to_hex(ce->sha1), ce_stage(ce));
 302
 303                utf8_fprintf(stdout, "%s\n", ce->name);
 304        }
 305        return 0;
 306}
 307
 308static void init_submodule(const char *path, const char *prefix, int quiet)
 309{
 310        const struct submodule *sub;
 311        struct strbuf sb = STRBUF_INIT;
 312        char *upd = NULL, *url = NULL, *displaypath;
 313
 314        /* Only loads from .gitmodules, no overlay with .git/config */
 315        gitmodules_config();
 316
 317        if (prefix) {
 318                strbuf_addf(&sb, "%s%s", prefix, path);
 319                displaypath = strbuf_detach(&sb, NULL);
 320        } else
 321                displaypath = xstrdup(path);
 322
 323        sub = submodule_from_path(null_sha1, path);
 324
 325        if (!sub)
 326                die(_("No url found for submodule path '%s' in .gitmodules"),
 327                        displaypath);
 328
 329        /*
 330         * Copy url setting when it is not set yet.
 331         * To look up the url in .git/config, we must not fall back to
 332         * .gitmodules, so look it up directly.
 333         */
 334        strbuf_reset(&sb);
 335        strbuf_addf(&sb, "submodule.%s.url", sub->name);
 336        if (git_config_get_string(sb.buf, &url)) {
 337                url = xstrdup(sub->url);
 338
 339                if (!url)
 340                        die(_("No url found for submodule path '%s' in .gitmodules"),
 341                                displaypath);
 342
 343                /* Possibly a url relative to parent */
 344                if (starts_with_dot_dot_slash(url) ||
 345                    starts_with_dot_slash(url)) {
 346                        char *remoteurl, *relurl;
 347                        char *remote = get_default_remote();
 348                        struct strbuf remotesb = STRBUF_INIT;
 349                        strbuf_addf(&remotesb, "remote.%s.url", remote);
 350                        free(remote);
 351
 352                        if (git_config_get_string(remotesb.buf, &remoteurl))
 353                                /*
 354                                 * The repository is its own
 355                                 * authoritative upstream
 356                                 */
 357                                remoteurl = xgetcwd();
 358                        relurl = relative_url(remoteurl, url, NULL);
 359                        strbuf_release(&remotesb);
 360                        free(remoteurl);
 361                        free(url);
 362                        url = relurl;
 363                }
 364
 365                if (git_config_set_gently(sb.buf, url))
 366                        die(_("Failed to register url for submodule path '%s'"),
 367                            displaypath);
 368                if (!quiet)
 369                        fprintf(stderr,
 370                                _("Submodule '%s' (%s) registered for path '%s'\n"),
 371                                sub->name, url, displaypath);
 372        }
 373
 374        /* Copy "update" setting when it is not set yet */
 375        strbuf_reset(&sb);
 376        strbuf_addf(&sb, "submodule.%s.update", sub->name);
 377        if (git_config_get_string(sb.buf, &upd) &&
 378            sub->update_strategy.type != SM_UPDATE_UNSPECIFIED) {
 379                if (sub->update_strategy.type == SM_UPDATE_COMMAND) {
 380                        fprintf(stderr, _("warning: command update mode suggested for submodule '%s'\n"),
 381                                sub->name);
 382                        upd = xstrdup("none");
 383                } else
 384                        upd = xstrdup(submodule_strategy_to_string(&sub->update_strategy));
 385
 386                if (git_config_set_gently(sb.buf, upd))
 387                        die(_("Failed to register update mode for submodule path '%s'"), displaypath);
 388        }
 389        strbuf_release(&sb);
 390        free(displaypath);
 391        free(url);
 392        free(upd);
 393}
 394
 395static int module_init(int argc, const char **argv, const char *prefix)
 396{
 397        struct pathspec pathspec;
 398        struct module_list list = MODULE_LIST_INIT;
 399        int quiet = 0;
 400        int i;
 401
 402        struct option module_init_options[] = {
 403                OPT_STRING(0, "prefix", &prefix,
 404                           N_("path"),
 405                           N_("alternative anchor for relative paths")),
 406                OPT__QUIET(&quiet, N_("Suppress output for initializing a submodule")),
 407                OPT_END()
 408        };
 409
 410        const char *const git_submodule_helper_usage[] = {
 411                N_("git submodule--helper init [<path>]"),
 412                NULL
 413        };
 414
 415        argc = parse_options(argc, argv, prefix, module_init_options,
 416                             git_submodule_helper_usage, 0);
 417
 418        if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
 419                return 1;
 420
 421        for (i = 0; i < list.nr; i++)
 422                init_submodule(list.entries[i]->name, prefix, quiet);
 423
 424        return 0;
 425}
 426
 427static int module_name(int argc, const char **argv, const char *prefix)
 428{
 429        const struct submodule *sub;
 430
 431        if (argc != 2)
 432                usage(_("git submodule--helper name <path>"));
 433
 434        gitmodules_config();
 435        sub = submodule_from_path(null_sha1, argv[1]);
 436
 437        if (!sub)
 438                die(_("no submodule mapping found in .gitmodules for path '%s'"),
 439                    argv[1]);
 440
 441        printf("%s\n", sub->name);
 442
 443        return 0;
 444}
 445
 446/*
 447 * Rules to sanitize configuration variables that are Ok to be passed into
 448 * submodule operations from the parent project using "-c". Should only
 449 * include keys which are both (a) safe and (b) necessary for proper
 450 * operation.
 451 */
 452static int submodule_config_ok(const char *var)
 453{
 454        if (starts_with(var, "credential."))
 455                return 1;
 456        return 0;
 457}
 458
 459static int sanitize_submodule_config(const char *var, const char *value, void *data)
 460{
 461        struct strbuf *out = data;
 462
 463        if (submodule_config_ok(var)) {
 464                if (out->len)
 465                        strbuf_addch(out, ' ');
 466
 467                if (value)
 468                        sq_quotef(out, "%s=%s", var, value);
 469                else
 470                        sq_quote_buf(out, var);
 471        }
 472
 473        return 0;
 474}
 475
 476static void prepare_submodule_repo_env(struct argv_array *out)
 477{
 478        const char * const *var;
 479
 480        for (var = local_repo_env; *var; var++) {
 481                if (!strcmp(*var, CONFIG_DATA_ENVIRONMENT)) {
 482                        struct strbuf sanitized_config = STRBUF_INIT;
 483                        git_config_from_parameters(sanitize_submodule_config,
 484                                                   &sanitized_config);
 485                        argv_array_pushf(out, "%s=%s", *var, sanitized_config.buf);
 486                        strbuf_release(&sanitized_config);
 487                } else {
 488                        argv_array_push(out, *var);
 489                }
 490        }
 491
 492}
 493
 494static int clone_submodule(const char *path, const char *gitdir, const char *url,
 495                           const char *depth, const char *reference, int quiet)
 496{
 497        struct child_process cp;
 498        child_process_init(&cp);
 499
 500        argv_array_push(&cp.args, "clone");
 501        argv_array_push(&cp.args, "--no-checkout");
 502        if (quiet)
 503                argv_array_push(&cp.args, "--quiet");
 504        if (depth && *depth)
 505                argv_array_pushl(&cp.args, "--depth", depth, NULL);
 506        if (reference && *reference)
 507                argv_array_pushl(&cp.args, "--reference", reference, NULL);
 508        if (gitdir && *gitdir)
 509                argv_array_pushl(&cp.args, "--separate-git-dir", gitdir, NULL);
 510
 511        argv_array_push(&cp.args, url);
 512        argv_array_push(&cp.args, path);
 513
 514        cp.git_cmd = 1;
 515        prepare_submodule_repo_env(&cp.env_array);
 516        cp.no_stdin = 1;
 517
 518        return run_command(&cp);
 519}
 520
 521static int module_clone(int argc, const char **argv, const char *prefix)
 522{
 523        const char *name = NULL, *url = NULL;
 524        const char *reference = NULL, *depth = NULL;
 525        int quiet = 0;
 526        FILE *submodule_dot_git;
 527        char *p, *path = NULL, *sm_gitdir;
 528        struct strbuf rel_path = STRBUF_INIT;
 529        struct strbuf sb = STRBUF_INIT;
 530
 531        struct option module_clone_options[] = {
 532                OPT_STRING(0, "prefix", &prefix,
 533                           N_("path"),
 534                           N_("alternative anchor for relative paths")),
 535                OPT_STRING(0, "path", &path,
 536                           N_("path"),
 537                           N_("where the new submodule will be cloned to")),
 538                OPT_STRING(0, "name", &name,
 539                           N_("string"),
 540                           N_("name of the new submodule")),
 541                OPT_STRING(0, "url", &url,
 542                           N_("string"),
 543                           N_("url where to clone the submodule from")),
 544                OPT_STRING(0, "reference", &reference,
 545                           N_("string"),
 546                           N_("reference repository")),
 547                OPT_STRING(0, "depth", &depth,
 548                           N_("string"),
 549                           N_("depth for shallow clones")),
 550                OPT__QUIET(&quiet, "Suppress output for cloning a submodule"),
 551                OPT_END()
 552        };
 553
 554        const char *const git_submodule_helper_usage[] = {
 555                N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
 556                   "[--reference <repository>] [--name <name>] [--depth <depth>] "
 557                   "--url <url> --path <path>"),
 558                NULL
 559        };
 560
 561        argc = parse_options(argc, argv, prefix, module_clone_options,
 562                             git_submodule_helper_usage, 0);
 563
 564        if (argc || !url || !path || !*path)
 565                usage_with_options(git_submodule_helper_usage,
 566                                   module_clone_options);
 567
 568        strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), name);
 569        sm_gitdir = xstrdup(absolute_path(sb.buf));
 570        strbuf_reset(&sb);
 571
 572        if (!is_absolute_path(path)) {
 573                strbuf_addf(&sb, "%s/%s", get_git_work_tree(), path);
 574                path = strbuf_detach(&sb, NULL);
 575        } else
 576                path = xstrdup(path);
 577
 578        if (!file_exists(sm_gitdir)) {
 579                if (safe_create_leading_directories_const(sm_gitdir) < 0)
 580                        die(_("could not create directory '%s'"), sm_gitdir);
 581                if (clone_submodule(path, sm_gitdir, url, depth, reference, quiet))
 582                        die(_("clone of '%s' into submodule path '%s' failed"),
 583                            url, path);
 584        } else {
 585                if (safe_create_leading_directories_const(path) < 0)
 586                        die(_("could not create directory '%s'"), path);
 587                strbuf_addf(&sb, "%s/index", sm_gitdir);
 588                unlink_or_warn(sb.buf);
 589                strbuf_reset(&sb);
 590        }
 591
 592        /* Write a .git file in the submodule to redirect to the superproject. */
 593        strbuf_addf(&sb, "%s/.git", path);
 594        if (safe_create_leading_directories_const(sb.buf) < 0)
 595                die(_("could not create leading directories of '%s'"), sb.buf);
 596        submodule_dot_git = fopen(sb.buf, "w");
 597        if (!submodule_dot_git)
 598                die_errno(_("cannot open file '%s'"), sb.buf);
 599
 600        fprintf_or_die(submodule_dot_git, "gitdir: %s\n",
 601                       relative_path(sm_gitdir, path, &rel_path));
 602        if (fclose(submodule_dot_git))
 603                die(_("could not close file %s"), sb.buf);
 604        strbuf_reset(&sb);
 605        strbuf_reset(&rel_path);
 606
 607        /* Redirect the worktree of the submodule in the superproject's config */
 608        p = git_pathdup_submodule(path, "config");
 609        if (!p)
 610                die(_("could not get submodule directory for '%s'"), path);
 611        git_config_set_in_file(p, "core.worktree",
 612                               relative_path(path, sm_gitdir, &rel_path));
 613        strbuf_release(&sb);
 614        strbuf_release(&rel_path);
 615        free(sm_gitdir);
 616        free(path);
 617        free(p);
 618        return 0;
 619}
 620
 621static int module_sanitize_config(int argc, const char **argv, const char *prefix)
 622{
 623        struct strbuf sanitized_config = STRBUF_INIT;
 624
 625        if (argc > 1)
 626                usage(_("git submodule--helper sanitize-config"));
 627
 628        git_config_from_parameters(sanitize_submodule_config, &sanitized_config);
 629        if (sanitized_config.len)
 630                printf("%s\n", sanitized_config.buf);
 631
 632        strbuf_release(&sanitized_config);
 633
 634        return 0;
 635}
 636
 637struct submodule_update_clone {
 638        /* index into 'list', the list of submodules to look into for cloning */
 639        int current;
 640        struct module_list list;
 641        unsigned warn_if_uninitialized : 1;
 642
 643        /* update parameter passed via commandline */
 644        struct submodule_update_strategy update;
 645
 646        /* configuration parameters which are passed on to the children */
 647        int quiet;
 648        const char *reference;
 649        const char *depth;
 650        const char *recursive_prefix;
 651        const char *prefix;
 652
 653        /* Machine-readable status lines to be consumed by git-submodule.sh */
 654        struct string_list projectlines;
 655
 656        /* If we want to stop as fast as possible and return an error */
 657        unsigned quickstop : 1;
 658};
 659#define SUBMODULE_UPDATE_CLONE_INIT {0, MODULE_LIST_INIT, 0, \
 660        SUBMODULE_UPDATE_STRATEGY_INIT, 0, NULL, NULL, NULL, NULL, \
 661        STRING_LIST_INIT_DUP, 0}
 662
 663
 664static void next_submodule_warn_missing(struct submodule_update_clone *suc,
 665                struct strbuf *out, const char *displaypath)
 666{
 667        /*
 668         * Only mention uninitialized submodules when their
 669         * paths have been specified.
 670         */
 671        if (suc->warn_if_uninitialized) {
 672                strbuf_addf(out,
 673                        _("Submodule path '%s' not initialized"),
 674                        displaypath);
 675                strbuf_addch(out, '\n');
 676                strbuf_addstr(out,
 677                        _("Maybe you want to use 'update --init'?"));
 678                strbuf_addch(out, '\n');
 679        }
 680}
 681
 682/**
 683 * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
 684 * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
 685 */
 686static int prepare_to_clone_next_submodule(const struct cache_entry *ce,
 687                                           struct child_process *child,
 688                                           struct submodule_update_clone *suc,
 689                                           struct strbuf *out)
 690{
 691        const struct submodule *sub = NULL;
 692        struct strbuf displaypath_sb = STRBUF_INIT;
 693        struct strbuf sb = STRBUF_INIT;
 694        const char *displaypath = NULL;
 695        char *url = NULL;
 696        int needs_cloning = 0;
 697
 698        if (ce_stage(ce)) {
 699                if (suc->recursive_prefix)
 700                        strbuf_addf(&sb, "%s/%s", suc->recursive_prefix, ce->name);
 701                else
 702                        strbuf_addf(&sb, "%s", ce->name);
 703                strbuf_addf(out, _("Skipping unmerged submodule %s"), sb.buf);
 704                strbuf_addch(out, '\n');
 705                goto cleanup;
 706        }
 707
 708        sub = submodule_from_path(null_sha1, ce->name);
 709
 710        if (suc->recursive_prefix)
 711                displaypath = relative_path(suc->recursive_prefix,
 712                                            ce->name, &displaypath_sb);
 713        else
 714                displaypath = ce->name;
 715
 716        if (!sub) {
 717                next_submodule_warn_missing(suc, out, displaypath);
 718                goto cleanup;
 719        }
 720
 721        if (suc->update.type == SM_UPDATE_NONE
 722            || (suc->update.type == SM_UPDATE_UNSPECIFIED
 723                && sub->update_strategy.type == SM_UPDATE_NONE)) {
 724                strbuf_addf(out, _("Skipping submodule '%s'"), displaypath);
 725                strbuf_addch(out, '\n');
 726                goto cleanup;
 727        }
 728
 729        /*
 730         * Looking up the url in .git/config.
 731         * We must not fall back to .gitmodules as we only want
 732         * to process configured submodules.
 733         */
 734        strbuf_reset(&sb);
 735        strbuf_addf(&sb, "submodule.%s.url", sub->name);
 736        git_config_get_string(sb.buf, &url);
 737        if (!url) {
 738                next_submodule_warn_missing(suc, out, displaypath);
 739                goto cleanup;
 740        }
 741
 742        strbuf_reset(&sb);
 743        strbuf_addf(&sb, "%s/.git", ce->name);
 744        needs_cloning = !file_exists(sb.buf);
 745
 746        strbuf_reset(&sb);
 747        strbuf_addf(&sb, "%06o %s %d %d\t%s\n", ce->ce_mode,
 748                        sha1_to_hex(ce->sha1), ce_stage(ce),
 749                        needs_cloning, ce->name);
 750        string_list_append(&suc->projectlines, sb.buf);
 751
 752        if (!needs_cloning)
 753                goto cleanup;
 754
 755        child->git_cmd = 1;
 756        child->no_stdin = 1;
 757        child->stdout_to_stderr = 1;
 758        child->err = -1;
 759        argv_array_push(&child->args, "submodule--helper");
 760        argv_array_push(&child->args, "clone");
 761        if (suc->quiet)
 762                argv_array_push(&child->args, "--quiet");
 763        if (suc->prefix)
 764                argv_array_pushl(&child->args, "--prefix", suc->prefix, NULL);
 765        argv_array_pushl(&child->args, "--path", sub->path, NULL);
 766        argv_array_pushl(&child->args, "--name", sub->name, NULL);
 767        argv_array_pushl(&child->args, "--url", url, NULL);
 768        if (suc->reference)
 769                argv_array_push(&child->args, suc->reference);
 770        if (suc->depth)
 771                argv_array_push(&child->args, suc->depth);
 772
 773cleanup:
 774        free(url);
 775        strbuf_reset(&displaypath_sb);
 776        strbuf_reset(&sb);
 777
 778        return needs_cloning;
 779}
 780
 781static int update_clone_get_next_task(struct child_process *child,
 782                                      struct strbuf *err,
 783                                      void *suc_cb,
 784                                      void **void_task_cb)
 785{
 786        struct submodule_update_clone *suc = suc_cb;
 787
 788        for (; suc->current < suc->list.nr; suc->current++) {
 789                const struct cache_entry *ce = suc->list.entries[suc->current];
 790                if (prepare_to_clone_next_submodule(ce, child, suc, err)) {
 791                        suc->current++;
 792                        return 1;
 793                }
 794        }
 795        return 0;
 796}
 797
 798static int update_clone_start_failure(struct strbuf *err,
 799                                      void *suc_cb,
 800                                      void *void_task_cb)
 801{
 802        struct submodule_update_clone *suc = suc_cb;
 803        suc->quickstop = 1;
 804        return 1;
 805}
 806
 807static int update_clone_task_finished(int result,
 808                                      struct strbuf *err,
 809                                      void *suc_cb,
 810                                      void *void_task_cb)
 811{
 812        struct submodule_update_clone *suc = suc_cb;
 813
 814        if (!result)
 815                return 0;
 816
 817        suc->quickstop = 1;
 818        return 1;
 819}
 820
 821static int update_clone(int argc, const char **argv, const char *prefix)
 822{
 823        const char *update = NULL;
 824        int max_jobs = -1;
 825        struct string_list_item *item;
 826        struct pathspec pathspec;
 827        struct submodule_update_clone suc = SUBMODULE_UPDATE_CLONE_INIT;
 828
 829        struct option module_update_clone_options[] = {
 830                OPT_STRING(0, "prefix", &prefix,
 831                           N_("path"),
 832                           N_("path into the working tree")),
 833                OPT_STRING(0, "recursive-prefix", &suc.recursive_prefix,
 834                           N_("path"),
 835                           N_("path into the working tree, across nested "
 836                              "submodule boundaries")),
 837                OPT_STRING(0, "update", &update,
 838                           N_("string"),
 839                           N_("rebase, merge, checkout or none")),
 840                OPT_STRING(0, "reference", &suc.reference, N_("repo"),
 841                           N_("reference repository")),
 842                OPT_STRING(0, "depth", &suc.depth, "<depth>",
 843                           N_("Create a shallow clone truncated to the "
 844                              "specified number of revisions")),
 845                OPT_INTEGER('j', "jobs", &max_jobs,
 846                            N_("parallel jobs")),
 847                OPT__QUIET(&suc.quiet, N_("don't print cloning progress")),
 848                OPT_END()
 849        };
 850
 851        const char *const git_submodule_helper_usage[] = {
 852                N_("git submodule--helper update_clone [--prefix=<path>] [<path>...]"),
 853                NULL
 854        };
 855        suc.prefix = prefix;
 856
 857        argc = parse_options(argc, argv, prefix, module_update_clone_options,
 858                             git_submodule_helper_usage, 0);
 859
 860        if (update)
 861                if (parse_submodule_update_strategy(update, &suc.update) < 0)
 862                        die(_("bad value for update parameter"));
 863
 864        if (module_list_compute(argc, argv, prefix, &pathspec, &suc.list) < 0)
 865                return 1;
 866
 867        if (pathspec.nr)
 868                suc.warn_if_uninitialized = 1;
 869
 870        /* Overlay the parsed .gitmodules file with .git/config */
 871        gitmodules_config();
 872        git_config(submodule_config, NULL);
 873
 874        if (max_jobs < 0)
 875                max_jobs = parallel_submodules();
 876
 877        run_processes_parallel(max_jobs,
 878                               update_clone_get_next_task,
 879                               update_clone_start_failure,
 880                               update_clone_task_finished,
 881                               &suc);
 882
 883        /*
 884         * We saved the output and put it out all at once now.
 885         * That means:
 886         * - the listener does not have to interleave their (checkout)
 887         *   work with our fetching.  The writes involved in a
 888         *   checkout involve more straightforward sequential I/O.
 889         * - the listener can avoid doing any work if fetching failed.
 890         */
 891        if (suc.quickstop)
 892                return 1;
 893
 894        for_each_string_list_item(item, &suc.projectlines)
 895                utf8_fprintf(stdout, "%s", item->string);
 896
 897        return 0;
 898}
 899
 900struct cmd_struct {
 901        const char *cmd;
 902        int (*fn)(int, const char **, const char *);
 903};
 904
 905static struct cmd_struct commands[] = {
 906        {"list", module_list},
 907        {"name", module_name},
 908        {"clone", module_clone},
 909        {"sanitize-config", module_sanitize_config},
 910        {"update-clone", update_clone},
 911        {"resolve-relative-url", resolve_relative_url},
 912        {"resolve-relative-url-test", resolve_relative_url_test},
 913        {"init", module_init}
 914};
 915
 916int cmd_submodule__helper(int argc, const char **argv, const char *prefix)
 917{
 918        int i;
 919        if (argc < 2)
 920                die(_("submodule--helper subcommand must be "
 921                      "called with a subcommand"));
 922
 923        for (i = 0; i < ARRAY_SIZE(commands); i++)
 924                if (!strcmp(argv[1], commands[i].cmd))
 925                        return commands[i].fn(argc - 1, argv + 1, prefix);
 926
 927        die(_("'%s' is not a valid submodule--helper "
 928              "subcommand"), argv[1]);
 929}