Andrew's git / gitweb.git / builtin/submodule--helper.c
?
builtin / submodule--helper.con commit clone: factor out checking for an alternate path (9eeea7d)
   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                return 1;
 292
 293        for (i = 0; i < list.nr; i++) {
 294                const struct cache_entry *ce = list.entries[i];
 295
 296                if (ce_stage(ce))
 297                        printf("%06o %s U\t", ce->ce_mode, sha1_to_hex(null_sha1));
 298                else
 299                        printf("%06o %s %d\t", ce->ce_mode, sha1_to_hex(ce->sha1), ce_stage(ce));
 300
 301                utf8_fprintf(stdout, "%s\n", ce->name);
 302        }
 303        return 0;
 304}
 305
 306static void init_submodule(const char *path, const char *prefix, int quiet)
 307{
 308        const struct submodule *sub;
 309        struct strbuf sb = STRBUF_INIT;
 310        char *upd = NULL, *url = NULL, *displaypath;
 311
 312        /* Only loads from .gitmodules, no overlay with .git/config */
 313        gitmodules_config();
 314
 315        if (prefix) {
 316                strbuf_addf(&sb, "%s%s", prefix, path);
 317                displaypath = strbuf_detach(&sb, NULL);
 318        } else
 319                displaypath = xstrdup(path);
 320
 321        sub = submodule_from_path(null_sha1, path);
 322
 323        if (!sub)
 324                die(_("No url found for submodule path '%s' in .gitmodules"),
 325                        displaypath);
 326
 327        /*
 328         * Copy url setting when it is not set yet.
 329         * To look up the url in .git/config, we must not fall back to
 330         * .gitmodules, so look it up directly.
 331         */
 332        strbuf_reset(&sb);
 333        strbuf_addf(&sb, "submodule.%s.url", sub->name);
 334        if (git_config_get_string(sb.buf, &url)) {
 335                url = xstrdup(sub->url);
 336
 337                if (!url)
 338                        die(_("No url found for submodule path '%s' in .gitmodules"),
 339                                displaypath);
 340
 341                /* Possibly a url relative to parent */
 342                if (starts_with_dot_dot_slash(url) ||
 343                    starts_with_dot_slash(url)) {
 344                        char *remoteurl, *relurl;
 345                        char *remote = get_default_remote();
 346                        struct strbuf remotesb = STRBUF_INIT;
 347                        strbuf_addf(&remotesb, "remote.%s.url", remote);
 348                        free(remote);
 349
 350                        if (git_config_get_string(remotesb.buf, &remoteurl))
 351                                /*
 352                                 * The repository is its own
 353                                 * authoritative upstream
 354                                 */
 355                                remoteurl = xgetcwd();
 356                        relurl = relative_url(remoteurl, url, NULL);
 357                        strbuf_release(&remotesb);
 358                        free(remoteurl);
 359                        free(url);
 360                        url = relurl;
 361                }
 362
 363                if (git_config_set_gently(sb.buf, url))
 364                        die(_("Failed to register url for submodule path '%s'"),
 365                            displaypath);
 366                if (!quiet)
 367                        fprintf(stderr,
 368                                _("Submodule '%s' (%s) registered for path '%s'\n"),
 369                                sub->name, url, displaypath);
 370        }
 371
 372        /* Copy "update" setting when it is not set yet */
 373        strbuf_reset(&sb);
 374        strbuf_addf(&sb, "submodule.%s.update", sub->name);
 375        if (git_config_get_string(sb.buf, &upd) &&
 376            sub->update_strategy.type != SM_UPDATE_UNSPECIFIED) {
 377                if (sub->update_strategy.type == SM_UPDATE_COMMAND) {
 378                        fprintf(stderr, _("warning: command update mode suggested for submodule '%s'\n"),
 379                                sub->name);
 380                        upd = xstrdup("none");
 381                } else
 382                        upd = xstrdup(submodule_strategy_to_string(&sub->update_strategy));
 383
 384                if (git_config_set_gently(sb.buf, upd))
 385                        die(_("Failed to register update mode for submodule path '%s'"), displaypath);
 386        }
 387        strbuf_release(&sb);
 388        free(displaypath);
 389        free(url);
 390        free(upd);
 391}
 392
 393static int module_init(int argc, const char **argv, const char *prefix)
 394{
 395        struct pathspec pathspec;
 396        struct module_list list = MODULE_LIST_INIT;
 397        int quiet = 0;
 398        int i;
 399
 400        struct option module_init_options[] = {
 401                OPT_STRING(0, "prefix", &prefix,
 402                           N_("path"),
 403                           N_("alternative anchor for relative paths")),
 404                OPT__QUIET(&quiet, N_("Suppress output for initializing a submodule")),
 405                OPT_END()
 406        };
 407
 408        const char *const git_submodule_helper_usage[] = {
 409                N_("git submodule--helper init [<path>]"),
 410                NULL
 411        };
 412
 413        argc = parse_options(argc, argv, prefix, module_init_options,
 414                             git_submodule_helper_usage, 0);
 415
 416        if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
 417                return 1;
 418
 419        for (i = 0; i < list.nr; i++)
 420                init_submodule(list.entries[i]->name, prefix, quiet);
 421
 422        return 0;
 423}
 424
 425static int module_name(int argc, const char **argv, const char *prefix)
 426{
 427        const struct submodule *sub;
 428
 429        if (argc != 2)
 430                usage(_("git submodule--helper name <path>"));
 431
 432        gitmodules_config();
 433        sub = submodule_from_path(null_sha1, argv[1]);
 434
 435        if (!sub)
 436                die(_("no submodule mapping found in .gitmodules for path '%s'"),
 437                    argv[1]);
 438
 439        printf("%s\n", sub->name);
 440
 441        return 0;
 442}
 443
 444static int clone_submodule(const char *path, const char *gitdir, const char *url,
 445                           const char *depth, struct string_list *reference, int quiet)
 446{
 447        struct child_process cp;
 448        child_process_init(&cp);
 449
 450        argv_array_push(&cp.args, "clone");
 451        argv_array_push(&cp.args, "--no-checkout");
 452        if (quiet)
 453                argv_array_push(&cp.args, "--quiet");
 454        if (depth && *depth)
 455                argv_array_pushl(&cp.args, "--depth", depth, NULL);
 456        if (reference->nr) {
 457                struct string_list_item *item;
 458                for_each_string_list_item(item, reference)
 459                        argv_array_pushl(&cp.args, "--reference",
 460                                         item->string, NULL);
 461        }
 462        if (gitdir && *gitdir)
 463                argv_array_pushl(&cp.args, "--separate-git-dir", gitdir, NULL);
 464
 465        argv_array_push(&cp.args, url);
 466        argv_array_push(&cp.args, path);
 467
 468        cp.git_cmd = 1;
 469        prepare_submodule_repo_env(&cp.env_array);
 470        cp.no_stdin = 1;
 471
 472        return run_command(&cp);
 473}
 474
 475static int module_clone(int argc, const char **argv, const char *prefix)
 476{
 477        const char *name = NULL, *url = NULL, *depth = NULL;
 478        int quiet = 0;
 479        FILE *submodule_dot_git;
 480        char *p, *path = NULL, *sm_gitdir;
 481        struct strbuf rel_path = STRBUF_INIT;
 482        struct strbuf sb = STRBUF_INIT;
 483        struct string_list reference = STRING_LIST_INIT_NODUP;
 484
 485        struct option module_clone_options[] = {
 486                OPT_STRING(0, "prefix", &prefix,
 487                           N_("path"),
 488                           N_("alternative anchor for relative paths")),
 489                OPT_STRING(0, "path", &path,
 490                           N_("path"),
 491                           N_("where the new submodule will be cloned to")),
 492                OPT_STRING(0, "name", &name,
 493                           N_("string"),
 494                           N_("name of the new submodule")),
 495                OPT_STRING(0, "url", &url,
 496                           N_("string"),
 497                           N_("url where to clone the submodule from")),
 498                OPT_STRING_LIST(0, "reference", &reference,
 499                           N_("repo"),
 500                           N_("reference repository")),
 501                OPT_STRING(0, "depth", &depth,
 502                           N_("string"),
 503                           N_("depth for shallow clones")),
 504                OPT__QUIET(&quiet, "Suppress output for cloning a submodule"),
 505                OPT_END()
 506        };
 507
 508        const char *const git_submodule_helper_usage[] = {
 509                N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
 510                   "[--reference <repository>] [--name <name>] [--depth <depth>] "
 511                   "--url <url> --path <path>"),
 512                NULL
 513        };
 514
 515        argc = parse_options(argc, argv, prefix, module_clone_options,
 516                             git_submodule_helper_usage, 0);
 517
 518        if (argc || !url || !path || !*path)
 519                usage_with_options(git_submodule_helper_usage,
 520                                   module_clone_options);
 521
 522        strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), name);
 523        sm_gitdir = xstrdup(absolute_path(sb.buf));
 524        strbuf_reset(&sb);
 525
 526        if (!is_absolute_path(path)) {
 527                strbuf_addf(&sb, "%s/%s", get_git_work_tree(), path);
 528                path = strbuf_detach(&sb, NULL);
 529        } else
 530                path = xstrdup(path);
 531
 532        if (!file_exists(sm_gitdir)) {
 533                if (safe_create_leading_directories_const(sm_gitdir) < 0)
 534                        die(_("could not create directory '%s'"), sm_gitdir);
 535                if (clone_submodule(path, sm_gitdir, url, depth, &reference, quiet))
 536                        die(_("clone of '%s' into submodule path '%s' failed"),
 537                            url, path);
 538        } else {
 539                if (safe_create_leading_directories_const(path) < 0)
 540                        die(_("could not create directory '%s'"), path);
 541                strbuf_addf(&sb, "%s/index", sm_gitdir);
 542                unlink_or_warn(sb.buf);
 543                strbuf_reset(&sb);
 544        }
 545
 546        /* Write a .git file in the submodule to redirect to the superproject. */
 547        strbuf_addf(&sb, "%s/.git", path);
 548        if (safe_create_leading_directories_const(sb.buf) < 0)
 549                die(_("could not create leading directories of '%s'"), sb.buf);
 550        submodule_dot_git = fopen(sb.buf, "w");
 551        if (!submodule_dot_git)
 552                die_errno(_("cannot open file '%s'"), sb.buf);
 553
 554        fprintf_or_die(submodule_dot_git, "gitdir: %s\n",
 555                       relative_path(sm_gitdir, path, &rel_path));
 556        if (fclose(submodule_dot_git))
 557                die(_("could not close file %s"), sb.buf);
 558        strbuf_reset(&sb);
 559        strbuf_reset(&rel_path);
 560
 561        /* Redirect the worktree of the submodule in the superproject's config */
 562        p = git_pathdup_submodule(path, "config");
 563        if (!p)
 564                die(_("could not get submodule directory for '%s'"), path);
 565        git_config_set_in_file(p, "core.worktree",
 566                               relative_path(path, sm_gitdir, &rel_path));
 567        strbuf_release(&sb);
 568        strbuf_release(&rel_path);
 569        free(sm_gitdir);
 570        free(path);
 571        free(p);
 572        return 0;
 573}
 574
 575struct submodule_update_clone {
 576        /* index into 'list', the list of submodules to look into for cloning */
 577        int current;
 578        struct module_list list;
 579        unsigned warn_if_uninitialized : 1;
 580
 581        /* update parameter passed via commandline */
 582        struct submodule_update_strategy update;
 583
 584        /* configuration parameters which are passed on to the children */
 585        int quiet;
 586        int recommend_shallow;
 587        struct string_list references;
 588        const char *depth;
 589        const char *recursive_prefix;
 590        const char *prefix;
 591
 592        /* Machine-readable status lines to be consumed by git-submodule.sh */
 593        struct string_list projectlines;
 594
 595        /* If we want to stop as fast as possible and return an error */
 596        unsigned quickstop : 1;
 597
 598        /* failed clones to be retried again */
 599        const struct cache_entry **failed_clones;
 600        int failed_clones_nr, failed_clones_alloc;
 601};
 602#define SUBMODULE_UPDATE_CLONE_INIT {0, MODULE_LIST_INIT, 0, \
 603        SUBMODULE_UPDATE_STRATEGY_INIT, 0, -1, STRING_LIST_INIT_DUP, \
 604        NULL, NULL, NULL, \
 605        STRING_LIST_INIT_DUP, 0, NULL, 0, 0}
 606
 607
 608static void next_submodule_warn_missing(struct submodule_update_clone *suc,
 609                struct strbuf *out, const char *displaypath)
 610{
 611        /*
 612         * Only mention uninitialized submodules when their
 613         * paths have been specified.
 614         */
 615        if (suc->warn_if_uninitialized) {
 616                strbuf_addf(out,
 617                        _("Submodule path '%s' not initialized"),
 618                        displaypath);
 619                strbuf_addch(out, '\n');
 620                strbuf_addstr(out,
 621                        _("Maybe you want to use 'update --init'?"));
 622                strbuf_addch(out, '\n');
 623        }
 624}
 625
 626/**
 627 * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
 628 * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
 629 */
 630static int prepare_to_clone_next_submodule(const struct cache_entry *ce,
 631                                           struct child_process *child,
 632                                           struct submodule_update_clone *suc,
 633                                           struct strbuf *out)
 634{
 635        const struct submodule *sub = NULL;
 636        struct strbuf displaypath_sb = STRBUF_INIT;
 637        struct strbuf sb = STRBUF_INIT;
 638        const char *displaypath = NULL;
 639        char *url = NULL;
 640        int needs_cloning = 0;
 641
 642        if (ce_stage(ce)) {
 643                if (suc->recursive_prefix)
 644                        strbuf_addf(&sb, "%s/%s", suc->recursive_prefix, ce->name);
 645                else
 646                        strbuf_addf(&sb, "%s", ce->name);
 647                strbuf_addf(out, _("Skipping unmerged submodule %s"), sb.buf);
 648                strbuf_addch(out, '\n');
 649                goto cleanup;
 650        }
 651
 652        sub = submodule_from_path(null_sha1, ce->name);
 653
 654        if (suc->recursive_prefix)
 655                displaypath = relative_path(suc->recursive_prefix,
 656                                            ce->name, &displaypath_sb);
 657        else
 658                displaypath = ce->name;
 659
 660        if (!sub) {
 661                next_submodule_warn_missing(suc, out, displaypath);
 662                goto cleanup;
 663        }
 664
 665        if (suc->update.type == SM_UPDATE_NONE
 666            || (suc->update.type == SM_UPDATE_UNSPECIFIED
 667                && sub->update_strategy.type == SM_UPDATE_NONE)) {
 668                strbuf_addf(out, _("Skipping submodule '%s'"), displaypath);
 669                strbuf_addch(out, '\n');
 670                goto cleanup;
 671        }
 672
 673        /*
 674         * Looking up the url in .git/config.
 675         * We must not fall back to .gitmodules as we only want
 676         * to process configured submodules.
 677         */
 678        strbuf_reset(&sb);
 679        strbuf_addf(&sb, "submodule.%s.url", sub->name);
 680        git_config_get_string(sb.buf, &url);
 681        if (!url) {
 682                next_submodule_warn_missing(suc, out, displaypath);
 683                goto cleanup;
 684        }
 685
 686        strbuf_reset(&sb);
 687        strbuf_addf(&sb, "%s/.git", ce->name);
 688        needs_cloning = !file_exists(sb.buf);
 689
 690        strbuf_reset(&sb);
 691        strbuf_addf(&sb, "%06o %s %d %d\t%s\n", ce->ce_mode,
 692                        sha1_to_hex(ce->sha1), ce_stage(ce),
 693                        needs_cloning, ce->name);
 694        string_list_append(&suc->projectlines, sb.buf);
 695
 696        if (!needs_cloning)
 697                goto cleanup;
 698
 699        child->git_cmd = 1;
 700        child->no_stdin = 1;
 701        child->stdout_to_stderr = 1;
 702        child->err = -1;
 703        argv_array_push(&child->args, "submodule--helper");
 704        argv_array_push(&child->args, "clone");
 705        if (suc->quiet)
 706                argv_array_push(&child->args, "--quiet");
 707        if (suc->prefix)
 708                argv_array_pushl(&child->args, "--prefix", suc->prefix, NULL);
 709        if (suc->recommend_shallow && sub->recommend_shallow == 1)
 710                argv_array_push(&child->args, "--depth=1");
 711        argv_array_pushl(&child->args, "--path", sub->path, NULL);
 712        argv_array_pushl(&child->args, "--name", sub->name, NULL);
 713        argv_array_pushl(&child->args, "--url", url, NULL);
 714        if (suc->references.nr) {
 715                struct string_list_item *item;
 716                for_each_string_list_item(item, &suc->references)
 717                        argv_array_pushl(&child->args, "--reference", item->string, NULL);
 718        }
 719        if (suc->depth)
 720                argv_array_push(&child->args, suc->depth);
 721
 722cleanup:
 723        free(url);
 724        strbuf_reset(&displaypath_sb);
 725        strbuf_reset(&sb);
 726
 727        return needs_cloning;
 728}
 729
 730static int update_clone_get_next_task(struct child_process *child,
 731                                      struct strbuf *err,
 732                                      void *suc_cb,
 733                                      void **idx_task_cb)
 734{
 735        struct submodule_update_clone *suc = suc_cb;
 736        const struct cache_entry *ce;
 737        int index;
 738
 739        for (; suc->current < suc->list.nr; suc->current++) {
 740                ce = suc->list.entries[suc->current];
 741                if (prepare_to_clone_next_submodule(ce, child, suc, err)) {
 742                        int *p = xmalloc(sizeof(*p));
 743                        *p = suc->current;
 744                        *idx_task_cb = p;
 745                        suc->current++;
 746                        return 1;
 747                }
 748        }
 749
 750        /*
 751         * The loop above tried cloning each submodule once, now try the
 752         * stragglers again, which we can imagine as an extension of the
 753         * entry list.
 754         */
 755        index = suc->current - suc->list.nr;
 756        if (index < suc->failed_clones_nr) {
 757                int *p;
 758                ce = suc->failed_clones[index];
 759                if (!prepare_to_clone_next_submodule(ce, child, suc, err))
 760                        die("BUG: ce was a submodule before?");
 761                p = xmalloc(sizeof(*p));
 762                *p = suc->current;
 763                *idx_task_cb = p;
 764                suc->current ++;
 765                return 1;
 766        }
 767
 768        return 0;
 769}
 770
 771static int update_clone_start_failure(struct strbuf *err,
 772                                      void *suc_cb,
 773                                      void *idx_task_cb)
 774{
 775        struct submodule_update_clone *suc = suc_cb;
 776        suc->quickstop = 1;
 777        return 1;
 778}
 779
 780static int update_clone_task_finished(int result,
 781                                      struct strbuf *err,
 782                                      void *suc_cb,
 783                                      void *idx_task_cb)
 784{
 785        const struct cache_entry *ce;
 786        struct submodule_update_clone *suc = suc_cb;
 787
 788        int *idxP = *(int**)idx_task_cb;
 789        int idx = *idxP;
 790        free(idxP);
 791
 792        if (!result)
 793                return 0;
 794
 795        if (idx < suc->list.nr) {
 796                ce  = suc->list.entries[idx];
 797                strbuf_addf(err, _("Failed to clone '%s'. Retry scheduled"),
 798                            ce->name);
 799                strbuf_addch(err, '\n');
 800                ALLOC_GROW(suc->failed_clones,
 801                           suc->failed_clones_nr + 1,
 802                           suc->failed_clones_alloc);
 803                suc->failed_clones[suc->failed_clones_nr++] = ce;
 804                return 0;
 805        } else {
 806                idx -= suc->list.nr;
 807                ce  = suc->failed_clones[idx];
 808                strbuf_addf(err, _("Failed to clone '%s' a second time, aborting"),
 809                            ce->name);
 810                strbuf_addch(err, '\n');
 811                suc->quickstop = 1;
 812                return 1;
 813        }
 814
 815        return 0;
 816}
 817
 818static int update_clone(int argc, const char **argv, const char *prefix)
 819{
 820        const char *update = NULL;
 821        int max_jobs = -1;
 822        struct string_list_item *item;
 823        struct pathspec pathspec;
 824        struct submodule_update_clone suc = SUBMODULE_UPDATE_CLONE_INIT;
 825
 826        struct option module_update_clone_options[] = {
 827                OPT_STRING(0, "prefix", &prefix,
 828                           N_("path"),
 829                           N_("path into the working tree")),
 830                OPT_STRING(0, "recursive-prefix", &suc.recursive_prefix,
 831                           N_("path"),
 832                           N_("path into the working tree, across nested "
 833                              "submodule boundaries")),
 834                OPT_STRING(0, "update", &update,
 835                           N_("string"),
 836                           N_("rebase, merge, checkout or none")),
 837                OPT_STRING_LIST(0, "reference", &suc.references, N_("repo"),
 838                           N_("reference repository")),
 839                OPT_STRING(0, "depth", &suc.depth, "<depth>",
 840                           N_("Create a shallow clone truncated to the "
 841                              "specified number of revisions")),
 842                OPT_INTEGER('j', "jobs", &max_jobs,
 843                            N_("parallel jobs")),
 844                OPT_BOOL(0, "recommend-shallow", &suc.recommend_shallow,
 845                            N_("whether the initial clone should follow the shallow recommendation")),
 846                OPT__QUIET(&suc.quiet, N_("don't print cloning progress")),
 847                OPT_END()
 848        };
 849
 850        const char *const git_submodule_helper_usage[] = {
 851                N_("git submodule--helper update_clone [--prefix=<path>] [<path>...]"),
 852                NULL
 853        };
 854        suc.prefix = prefix;
 855
 856        argc = parse_options(argc, argv, prefix, module_update_clone_options,
 857                             git_submodule_helper_usage, 0);
 858
 859        if (update)
 860                if (parse_submodule_update_strategy(update, &suc.update) < 0)
 861                        die(_("bad value for update parameter"));
 862
 863        if (module_list_compute(argc, argv, prefix, &pathspec, &suc.list) < 0)
 864                return 1;
 865
 866        if (pathspec.nr)
 867                suc.warn_if_uninitialized = 1;
 868
 869        /* Overlay the parsed .gitmodules file with .git/config */
 870        gitmodules_config();
 871        git_config(submodule_config, NULL);
 872
 873        if (max_jobs < 0)
 874                max_jobs = parallel_submodules();
 875
 876        run_processes_parallel(max_jobs,
 877                               update_clone_get_next_task,
 878                               update_clone_start_failure,
 879                               update_clone_task_finished,
 880                               &suc);
 881
 882        /*
 883         * We saved the output and put it out all at once now.
 884         * That means:
 885         * - the listener does not have to interleave their (checkout)
 886         *   work with our fetching.  The writes involved in a
 887         *   checkout involve more straightforward sequential I/O.
 888         * - the listener can avoid doing any work if fetching failed.
 889         */
 890        if (suc.quickstop)
 891                return 1;
 892
 893        for_each_string_list_item(item, &suc.projectlines)
 894                utf8_fprintf(stdout, "%s", item->string);
 895
 896        return 0;
 897}
 898
 899static int resolve_relative_path(int argc, const char **argv, const char *prefix)
 900{
 901        struct strbuf sb = STRBUF_INIT;
 902        if (argc != 3)
 903                die("submodule--helper relative_path takes exactly 2 arguments, got %d", argc);
 904
 905        printf("%s", relative_path(argv[1], argv[2], &sb));
 906        strbuf_release(&sb);
 907        return 0;
 908}
 909
 910struct cmd_struct {
 911        const char *cmd;
 912        int (*fn)(int, const char **, const char *);
 913};
 914
 915static struct cmd_struct commands[] = {
 916        {"list", module_list},
 917        {"name", module_name},
 918        {"clone", module_clone},
 919        {"update-clone", update_clone},
 920        {"relative-path", resolve_relative_path},
 921        {"resolve-relative-url", resolve_relative_url},
 922        {"resolve-relative-url-test", resolve_relative_url_test},
 923        {"init", module_init}
 924};
 925
 926int cmd_submodule__helper(int argc, const char **argv, const char *prefix)
 927{
 928        int i;
 929        if (argc < 2)
 930                die(_("submodule--helper subcommand must be "
 931                      "called with a subcommand"));
 932
 933        for (i = 0; i < ARRAY_SIZE(commands); i++)
 934                if (!strcmp(argv[1], commands[i].cmd))
 935                        return commands[i].fn(argc - 1, argv + 1, prefix);
 936
 937        die(_("'%s' is not a valid submodule--helper "
 938              "subcommand"), argv[1]);
 939}