Andrew's git / gitweb.git / builtin/submodule--helper.c
?
builtin / submodule--helper.con commit clone: pass --progress decision to recursive submodules (72c5f88)
   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,
 446                           int quiet, int progress)
 447{
 448        struct child_process cp = CHILD_PROCESS_INIT;
 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 (progress)
 455                argv_array_push(&cp.args, "--progress");
 456        if (depth && *depth)
 457                argv_array_pushl(&cp.args, "--depth", depth, NULL);
 458        if (reference->nr) {
 459                struct string_list_item *item;
 460                for_each_string_list_item(item, reference)
 461                        argv_array_pushl(&cp.args, "--reference",
 462                                         item->string, NULL);
 463        }
 464        if (gitdir && *gitdir)
 465                argv_array_pushl(&cp.args, "--separate-git-dir", gitdir, NULL);
 466
 467        argv_array_push(&cp.args, url);
 468        argv_array_push(&cp.args, path);
 469
 470        cp.git_cmd = 1;
 471        prepare_submodule_repo_env(&cp.env_array);
 472        cp.no_stdin = 1;
 473
 474        return run_command(&cp);
 475}
 476
 477struct submodule_alternate_setup {
 478        const char *submodule_name;
 479        enum SUBMODULE_ALTERNATE_ERROR_MODE {
 480                SUBMODULE_ALTERNATE_ERROR_DIE,
 481                SUBMODULE_ALTERNATE_ERROR_INFO,
 482                SUBMODULE_ALTERNATE_ERROR_IGNORE
 483        } error_mode;
 484        struct string_list *reference;
 485};
 486#define SUBMODULE_ALTERNATE_SETUP_INIT { NULL, \
 487        SUBMODULE_ALTERNATE_ERROR_IGNORE, NULL }
 488
 489static int add_possible_reference_from_superproject(
 490                struct alternate_object_database *alt, void *sas_cb)
 491{
 492        struct submodule_alternate_setup *sas = sas_cb;
 493
 494        /* directory name, minus trailing slash */
 495        size_t namelen = alt->name - alt->base - 1;
 496        struct strbuf name = STRBUF_INIT;
 497        strbuf_add(&name, alt->base, namelen);
 498
 499        /*
 500         * If the alternate object store is another repository, try the
 501         * standard layout with .git/modules/<name>/objects
 502         */
 503        if (ends_with(name.buf, ".git/objects")) {
 504                char *sm_alternate;
 505                struct strbuf sb = STRBUF_INIT;
 506                struct strbuf err = STRBUF_INIT;
 507                strbuf_add(&sb, name.buf, name.len - strlen("objects"));
 508                /*
 509                 * We need to end the new path with '/' to mark it as a dir,
 510                 * otherwise a submodule name containing '/' will be broken
 511                 * as the last part of a missing submodule reference would
 512                 * be taken as a file name.
 513                 */
 514                strbuf_addf(&sb, "modules/%s/", sas->submodule_name);
 515
 516                sm_alternate = compute_alternate_path(sb.buf, &err);
 517                if (sm_alternate) {
 518                        string_list_append(sas->reference, xstrdup(sb.buf));
 519                        free(sm_alternate);
 520                } else {
 521                        switch (sas->error_mode) {
 522                        case SUBMODULE_ALTERNATE_ERROR_DIE:
 523                                die(_("submodule '%s' cannot add alternate: %s"),
 524                                    sas->submodule_name, err.buf);
 525                        case SUBMODULE_ALTERNATE_ERROR_INFO:
 526                                fprintf(stderr, _("submodule '%s' cannot add alternate: %s"),
 527                                        sas->submodule_name, err.buf);
 528                        case SUBMODULE_ALTERNATE_ERROR_IGNORE:
 529                                ; /* nothing */
 530                        }
 531                }
 532                strbuf_release(&sb);
 533        }
 534
 535        strbuf_release(&name);
 536        return 0;
 537}
 538
 539static void prepare_possible_alternates(const char *sm_name,
 540                struct string_list *reference)
 541{
 542        char *sm_alternate = NULL, *error_strategy = NULL;
 543        struct submodule_alternate_setup sas = SUBMODULE_ALTERNATE_SETUP_INIT;
 544
 545        git_config_get_string("submodule.alternateLocation", &sm_alternate);
 546        if (!sm_alternate)
 547                return;
 548
 549        git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
 550
 551        if (!error_strategy)
 552                error_strategy = xstrdup("die");
 553
 554        sas.submodule_name = sm_name;
 555        sas.reference = reference;
 556        if (!strcmp(error_strategy, "die"))
 557                sas.error_mode = SUBMODULE_ALTERNATE_ERROR_DIE;
 558        else if (!strcmp(error_strategy, "info"))
 559                sas.error_mode = SUBMODULE_ALTERNATE_ERROR_INFO;
 560        else if (!strcmp(error_strategy, "ignore"))
 561                sas.error_mode = SUBMODULE_ALTERNATE_ERROR_IGNORE;
 562        else
 563                die(_("Value '%s' for submodule.alternateErrorStrategy is not recognized"), error_strategy);
 564
 565        if (!strcmp(sm_alternate, "superproject"))
 566                foreach_alt_odb(add_possible_reference_from_superproject, &sas);
 567        else if (!strcmp(sm_alternate, "no"))
 568                ; /* do nothing */
 569        else
 570                die(_("Value '%s' for submodule.alternateLocation is not recognized"), sm_alternate);
 571
 572        free(sm_alternate);
 573        free(error_strategy);
 574}
 575
 576static int module_clone(int argc, const char **argv, const char *prefix)
 577{
 578        const char *name = NULL, *url = NULL, *depth = NULL;
 579        int quiet = 0;
 580        int progress = 0;
 581        FILE *submodule_dot_git;
 582        char *p, *path = NULL, *sm_gitdir;
 583        struct strbuf rel_path = STRBUF_INIT;
 584        struct strbuf sb = STRBUF_INIT;
 585        struct string_list reference = STRING_LIST_INIT_NODUP;
 586
 587        struct option module_clone_options[] = {
 588                OPT_STRING(0, "prefix", &prefix,
 589                           N_("path"),
 590                           N_("alternative anchor for relative paths")),
 591                OPT_STRING(0, "path", &path,
 592                           N_("path"),
 593                           N_("where the new submodule will be cloned to")),
 594                OPT_STRING(0, "name", &name,
 595                           N_("string"),
 596                           N_("name of the new submodule")),
 597                OPT_STRING(0, "url", &url,
 598                           N_("string"),
 599                           N_("url where to clone the submodule from")),
 600                OPT_STRING_LIST(0, "reference", &reference,
 601                           N_("repo"),
 602                           N_("reference repository")),
 603                OPT_STRING(0, "depth", &depth,
 604                           N_("string"),
 605                           N_("depth for shallow clones")),
 606                OPT__QUIET(&quiet, "Suppress output for cloning a submodule"),
 607                OPT_BOOL(0, "progress", &progress,
 608                           N_("force cloning progress")),
 609                OPT_END()
 610        };
 611
 612        const char *const git_submodule_helper_usage[] = {
 613                N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
 614                   "[--reference <repository>] [--name <name>] [--depth <depth>] "
 615                   "--url <url> --path <path>"),
 616                NULL
 617        };
 618
 619        argc = parse_options(argc, argv, prefix, module_clone_options,
 620                             git_submodule_helper_usage, 0);
 621
 622        if (argc || !url || !path || !*path)
 623                usage_with_options(git_submodule_helper_usage,
 624                                   module_clone_options);
 625
 626        strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), name);
 627        sm_gitdir = xstrdup(absolute_path(sb.buf));
 628        strbuf_reset(&sb);
 629
 630        if (!is_absolute_path(path)) {
 631                strbuf_addf(&sb, "%s/%s", get_git_work_tree(), path);
 632                path = strbuf_detach(&sb, NULL);
 633        } else
 634                path = xstrdup(path);
 635
 636        if (!file_exists(sm_gitdir)) {
 637                if (safe_create_leading_directories_const(sm_gitdir) < 0)
 638                        die(_("could not create directory '%s'"), sm_gitdir);
 639
 640                prepare_possible_alternates(name, &reference);
 641
 642                if (clone_submodule(path, sm_gitdir, url, depth, &reference,
 643                                    quiet, progress))
 644                        die(_("clone of '%s' into submodule path '%s' failed"),
 645                            url, path);
 646        } else {
 647                if (safe_create_leading_directories_const(path) < 0)
 648                        die(_("could not create directory '%s'"), path);
 649                strbuf_addf(&sb, "%s/index", sm_gitdir);
 650                unlink_or_warn(sb.buf);
 651                strbuf_reset(&sb);
 652        }
 653
 654        /* Write a .git file in the submodule to redirect to the superproject. */
 655        strbuf_addf(&sb, "%s/.git", path);
 656        if (safe_create_leading_directories_const(sb.buf) < 0)
 657                die(_("could not create leading directories of '%s'"), sb.buf);
 658        submodule_dot_git = fopen(sb.buf, "w");
 659        if (!submodule_dot_git)
 660                die_errno(_("cannot open file '%s'"), sb.buf);
 661
 662        fprintf_or_die(submodule_dot_git, "gitdir: %s\n",
 663                       relative_path(sm_gitdir, path, &rel_path));
 664        if (fclose(submodule_dot_git))
 665                die(_("could not close file %s"), sb.buf);
 666        strbuf_reset(&sb);
 667        strbuf_reset(&rel_path);
 668
 669        /* Redirect the worktree of the submodule in the superproject's config */
 670        p = git_pathdup_submodule(path, "config");
 671        if (!p)
 672                die(_("could not get submodule directory for '%s'"), path);
 673        git_config_set_in_file(p, "core.worktree",
 674                               relative_path(path, sm_gitdir, &rel_path));
 675        strbuf_release(&sb);
 676        strbuf_release(&rel_path);
 677        free(sm_gitdir);
 678        free(path);
 679        free(p);
 680        return 0;
 681}
 682
 683struct submodule_update_clone {
 684        /* index into 'list', the list of submodules to look into for cloning */
 685        int current;
 686        struct module_list list;
 687        unsigned warn_if_uninitialized : 1;
 688
 689        /* update parameter passed via commandline */
 690        struct submodule_update_strategy update;
 691
 692        /* configuration parameters which are passed on to the children */
 693        int progress;
 694        int quiet;
 695        int recommend_shallow;
 696        struct string_list references;
 697        const char *depth;
 698        const char *recursive_prefix;
 699        const char *prefix;
 700
 701        /* Machine-readable status lines to be consumed by git-submodule.sh */
 702        struct string_list projectlines;
 703
 704        /* If we want to stop as fast as possible and return an error */
 705        unsigned quickstop : 1;
 706
 707        /* failed clones to be retried again */
 708        const struct cache_entry **failed_clones;
 709        int failed_clones_nr, failed_clones_alloc;
 710};
 711#define SUBMODULE_UPDATE_CLONE_INIT {0, MODULE_LIST_INIT, 0, \
 712        SUBMODULE_UPDATE_STRATEGY_INIT, 0, 0, -1, STRING_LIST_INIT_DUP, \
 713        NULL, NULL, NULL, \
 714        STRING_LIST_INIT_DUP, 0, NULL, 0, 0}
 715
 716
 717static void next_submodule_warn_missing(struct submodule_update_clone *suc,
 718                struct strbuf *out, const char *displaypath)
 719{
 720        /*
 721         * Only mention uninitialized submodules when their
 722         * paths have been specified.
 723         */
 724        if (suc->warn_if_uninitialized) {
 725                strbuf_addf(out,
 726                        _("Submodule path '%s' not initialized"),
 727                        displaypath);
 728                strbuf_addch(out, '\n');
 729                strbuf_addstr(out,
 730                        _("Maybe you want to use 'update --init'?"));
 731                strbuf_addch(out, '\n');
 732        }
 733}
 734
 735/**
 736 * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
 737 * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
 738 */
 739static int prepare_to_clone_next_submodule(const struct cache_entry *ce,
 740                                           struct child_process *child,
 741                                           struct submodule_update_clone *suc,
 742                                           struct strbuf *out)
 743{
 744        const struct submodule *sub = NULL;
 745        struct strbuf displaypath_sb = STRBUF_INIT;
 746        struct strbuf sb = STRBUF_INIT;
 747        const char *displaypath = NULL;
 748        char *url = NULL;
 749        int needs_cloning = 0;
 750
 751        if (ce_stage(ce)) {
 752                if (suc->recursive_prefix)
 753                        strbuf_addf(&sb, "%s/%s", suc->recursive_prefix, ce->name);
 754                else
 755                        strbuf_addf(&sb, "%s", ce->name);
 756                strbuf_addf(out, _("Skipping unmerged submodule %s"), sb.buf);
 757                strbuf_addch(out, '\n');
 758                goto cleanup;
 759        }
 760
 761        sub = submodule_from_path(null_sha1, ce->name);
 762
 763        if (suc->recursive_prefix)
 764                displaypath = relative_path(suc->recursive_prefix,
 765                                            ce->name, &displaypath_sb);
 766        else
 767                displaypath = ce->name;
 768
 769        if (!sub) {
 770                next_submodule_warn_missing(suc, out, displaypath);
 771                goto cleanup;
 772        }
 773
 774        if (suc->update.type == SM_UPDATE_NONE
 775            || (suc->update.type == SM_UPDATE_UNSPECIFIED
 776                && sub->update_strategy.type == SM_UPDATE_NONE)) {
 777                strbuf_addf(out, _("Skipping submodule '%s'"), displaypath);
 778                strbuf_addch(out, '\n');
 779                goto cleanup;
 780        }
 781
 782        /*
 783         * Looking up the url in .git/config.
 784         * We must not fall back to .gitmodules as we only want
 785         * to process configured submodules.
 786         */
 787        strbuf_reset(&sb);
 788        strbuf_addf(&sb, "submodule.%s.url", sub->name);
 789        git_config_get_string(sb.buf, &url);
 790        if (!url) {
 791                next_submodule_warn_missing(suc, out, displaypath);
 792                goto cleanup;
 793        }
 794
 795        strbuf_reset(&sb);
 796        strbuf_addf(&sb, "%s/.git", ce->name);
 797        needs_cloning = !file_exists(sb.buf);
 798
 799        strbuf_reset(&sb);
 800        strbuf_addf(&sb, "%06o %s %d %d\t%s\n", ce->ce_mode,
 801                        sha1_to_hex(ce->sha1), ce_stage(ce),
 802                        needs_cloning, ce->name);
 803        string_list_append(&suc->projectlines, sb.buf);
 804
 805        if (!needs_cloning)
 806                goto cleanup;
 807
 808        child->git_cmd = 1;
 809        child->no_stdin = 1;
 810        child->stdout_to_stderr = 1;
 811        child->err = -1;
 812        argv_array_push(&child->args, "submodule--helper");
 813        argv_array_push(&child->args, "clone");
 814        if (suc->progress)
 815                argv_array_push(&child->args, "--progress");
 816        if (suc->quiet)
 817                argv_array_push(&child->args, "--quiet");
 818        if (suc->prefix)
 819                argv_array_pushl(&child->args, "--prefix", suc->prefix, NULL);
 820        if (suc->recommend_shallow && sub->recommend_shallow == 1)
 821                argv_array_push(&child->args, "--depth=1");
 822        argv_array_pushl(&child->args, "--path", sub->path, NULL);
 823        argv_array_pushl(&child->args, "--name", sub->name, NULL);
 824        argv_array_pushl(&child->args, "--url", url, NULL);
 825        if (suc->references.nr) {
 826                struct string_list_item *item;
 827                for_each_string_list_item(item, &suc->references)
 828                        argv_array_pushl(&child->args, "--reference", item->string, NULL);
 829        }
 830        if (suc->depth)
 831                argv_array_push(&child->args, suc->depth);
 832
 833cleanup:
 834        free(url);
 835        strbuf_reset(&displaypath_sb);
 836        strbuf_reset(&sb);
 837
 838        return needs_cloning;
 839}
 840
 841static int update_clone_get_next_task(struct child_process *child,
 842                                      struct strbuf *err,
 843                                      void *suc_cb,
 844                                      void **idx_task_cb)
 845{
 846        struct submodule_update_clone *suc = suc_cb;
 847        const struct cache_entry *ce;
 848        int index;
 849
 850        for (; suc->current < suc->list.nr; suc->current++) {
 851                ce = suc->list.entries[suc->current];
 852                if (prepare_to_clone_next_submodule(ce, child, suc, err)) {
 853                        int *p = xmalloc(sizeof(*p));
 854                        *p = suc->current;
 855                        *idx_task_cb = p;
 856                        suc->current++;
 857                        return 1;
 858                }
 859        }
 860
 861        /*
 862         * The loop above tried cloning each submodule once, now try the
 863         * stragglers again, which we can imagine as an extension of the
 864         * entry list.
 865         */
 866        index = suc->current - suc->list.nr;
 867        if (index < suc->failed_clones_nr) {
 868                int *p;
 869                ce = suc->failed_clones[index];
 870                if (!prepare_to_clone_next_submodule(ce, child, suc, err)) {
 871                        suc->current ++;
 872                        strbuf_addf(err, "BUG: submodule considered for cloning,"
 873                                    "doesn't need cloning any more?\n");
 874                        return 0;
 875                }
 876                p = xmalloc(sizeof(*p));
 877                *p = suc->current;
 878                *idx_task_cb = p;
 879                suc->current ++;
 880                return 1;
 881        }
 882
 883        return 0;
 884}
 885
 886static int update_clone_start_failure(struct strbuf *err,
 887                                      void *suc_cb,
 888                                      void *idx_task_cb)
 889{
 890        struct submodule_update_clone *suc = suc_cb;
 891        suc->quickstop = 1;
 892        return 1;
 893}
 894
 895static int update_clone_task_finished(int result,
 896                                      struct strbuf *err,
 897                                      void *suc_cb,
 898                                      void *idx_task_cb)
 899{
 900        const struct cache_entry *ce;
 901        struct submodule_update_clone *suc = suc_cb;
 902
 903        int *idxP = *(int**)idx_task_cb;
 904        int idx = *idxP;
 905        free(idxP);
 906
 907        if (!result)
 908                return 0;
 909
 910        if (idx < suc->list.nr) {
 911                ce  = suc->list.entries[idx];
 912                strbuf_addf(err, _("Failed to clone '%s'. Retry scheduled"),
 913                            ce->name);
 914                strbuf_addch(err, '\n');
 915                ALLOC_GROW(suc->failed_clones,
 916                           suc->failed_clones_nr + 1,
 917                           suc->failed_clones_alloc);
 918                suc->failed_clones[suc->failed_clones_nr++] = ce;
 919                return 0;
 920        } else {
 921                idx -= suc->list.nr;
 922                ce  = suc->failed_clones[idx];
 923                strbuf_addf(err, _("Failed to clone '%s' a second time, aborting"),
 924                            ce->name);
 925                strbuf_addch(err, '\n');
 926                suc->quickstop = 1;
 927                return 1;
 928        }
 929
 930        return 0;
 931}
 932
 933static int update_clone(int argc, const char **argv, const char *prefix)
 934{
 935        const char *update = NULL;
 936        int max_jobs = -1;
 937        struct string_list_item *item;
 938        struct pathspec pathspec;
 939        struct submodule_update_clone suc = SUBMODULE_UPDATE_CLONE_INIT;
 940
 941        struct option module_update_clone_options[] = {
 942                OPT_STRING(0, "prefix", &prefix,
 943                           N_("path"),
 944                           N_("path into the working tree")),
 945                OPT_STRING(0, "recursive-prefix", &suc.recursive_prefix,
 946                           N_("path"),
 947                           N_("path into the working tree, across nested "
 948                              "submodule boundaries")),
 949                OPT_STRING(0, "update", &update,
 950                           N_("string"),
 951                           N_("rebase, merge, checkout or none")),
 952                OPT_STRING_LIST(0, "reference", &suc.references, N_("repo"),
 953                           N_("reference repository")),
 954                OPT_STRING(0, "depth", &suc.depth, "<depth>",
 955                           N_("Create a shallow clone truncated to the "
 956                              "specified number of revisions")),
 957                OPT_INTEGER('j', "jobs", &max_jobs,
 958                            N_("parallel jobs")),
 959                OPT_BOOL(0, "recommend-shallow", &suc.recommend_shallow,
 960                            N_("whether the initial clone should follow the shallow recommendation")),
 961                OPT__QUIET(&suc.quiet, N_("don't print cloning progress")),
 962                OPT_BOOL(0, "progress", &suc.progress,
 963                            N_("force cloning progress")),
 964                OPT_END()
 965        };
 966
 967        const char *const git_submodule_helper_usage[] = {
 968                N_("git submodule--helper update_clone [--prefix=<path>] [<path>...]"),
 969                NULL
 970        };
 971        suc.prefix = prefix;
 972
 973        argc = parse_options(argc, argv, prefix, module_update_clone_options,
 974                             git_submodule_helper_usage, 0);
 975
 976        if (update)
 977                if (parse_submodule_update_strategy(update, &suc.update) < 0)
 978                        die(_("bad value for update parameter"));
 979
 980        if (module_list_compute(argc, argv, prefix, &pathspec, &suc.list) < 0)
 981                return 1;
 982
 983        if (pathspec.nr)
 984                suc.warn_if_uninitialized = 1;
 985
 986        /* Overlay the parsed .gitmodules file with .git/config */
 987        gitmodules_config();
 988        git_config(submodule_config, NULL);
 989
 990        if (max_jobs < 0)
 991                max_jobs = parallel_submodules();
 992
 993        run_processes_parallel(max_jobs,
 994                               update_clone_get_next_task,
 995                               update_clone_start_failure,
 996                               update_clone_task_finished,
 997                               &suc);
 998
 999        /*
1000         * We saved the output and put it out all at once now.
1001         * That means:
1002         * - the listener does not have to interleave their (checkout)
1003         *   work with our fetching.  The writes involved in a
1004         *   checkout involve more straightforward sequential I/O.
1005         * - the listener can avoid doing any work if fetching failed.
1006         */
1007        if (suc.quickstop)
1008                return 1;
1009
1010        for_each_string_list_item(item, &suc.projectlines)
1011                utf8_fprintf(stdout, "%s", item->string);
1012
1013        return 0;
1014}
1015
1016static int resolve_relative_path(int argc, const char **argv, const char *prefix)
1017{
1018        struct strbuf sb = STRBUF_INIT;
1019        if (argc != 3)
1020                die("submodule--helper relative-path takes exactly 2 arguments, got %d", argc);
1021
1022        printf("%s", relative_path(argv[1], argv[2], &sb));
1023        strbuf_release(&sb);
1024        return 0;
1025}
1026
1027static const char *remote_submodule_branch(const char *path)
1028{
1029        const struct submodule *sub;
1030        gitmodules_config();
1031        git_config(submodule_config, NULL);
1032
1033        sub = submodule_from_path(null_sha1, path);
1034        if (!sub)
1035                return NULL;
1036
1037        if (!sub->branch)
1038                return "master";
1039
1040        if (!strcmp(sub->branch, ".")) {
1041                unsigned char sha1[20];
1042                const char *refname = resolve_ref_unsafe("HEAD", 0, sha1, NULL);
1043
1044                if (!refname)
1045                        die(_("No such ref: %s"), "HEAD");
1046
1047                /* detached HEAD */
1048                if (!strcmp(refname, "HEAD"))
1049                        die(_("Submodule (%s) branch configured to inherit "
1050                              "branch from superproject, but the superproject "
1051                              "is not on any branch"), sub->name);
1052
1053                if (!skip_prefix(refname, "refs/heads/", &refname))
1054                        die(_("Expecting a full ref name, got %s"), refname);
1055                return refname;
1056        }
1057
1058        return sub->branch;
1059}
1060
1061static int resolve_remote_submodule_branch(int argc, const char **argv,
1062                const char *prefix)
1063{
1064        const char *ret;
1065        struct strbuf sb = STRBUF_INIT;
1066        if (argc != 2)
1067                die("submodule--helper remote-branch takes exactly one arguments, got %d", argc);
1068
1069        ret = remote_submodule_branch(argv[1]);
1070        if (!ret)
1071                die("submodule %s doesn't exist", argv[1]);
1072
1073        printf("%s", ret);
1074        strbuf_release(&sb);
1075        return 0;
1076}
1077
1078struct cmd_struct {
1079        const char *cmd;
1080        int (*fn)(int, const char **, const char *);
1081};
1082
1083static struct cmd_struct commands[] = {
1084        {"list", module_list},
1085        {"name", module_name},
1086        {"clone", module_clone},
1087        {"update-clone", update_clone},
1088        {"relative-path", resolve_relative_path},
1089        {"resolve-relative-url", resolve_relative_url},
1090        {"resolve-relative-url-test", resolve_relative_url_test},
1091        {"init", module_init},
1092        {"remote-branch", resolve_remote_submodule_branch}
1093};
1094
1095int cmd_submodule__helper(int argc, const char **argv, const char *prefix)
1096{
1097        int i;
1098        if (argc < 2)
1099                die(_("submodule--helper subcommand must be "
1100                      "called with a subcommand"));
1101
1102        for (i = 0; i < ARRAY_SIZE(commands); i++)
1103                if (!strcmp(argv[1], commands[i].cmd))
1104                        return commands[i].fn(argc - 1, argv + 1, prefix);
1105
1106        die(_("'%s' is not a valid submodule--helper "
1107              "subcommand"), argv[1]);
1108}