Andrew's git / gitweb.git / builtin/submodule--helper.c
?
builtin / submodule--helper.con commit submodule: convert is_submodule_initialized to work on a repository (627d934)
   1#include "builtin.h"
   2#include "repository.h"
   3#include "cache.h"
   4#include "config.h"
   5#include "parse-options.h"
   6#include "quote.h"
   7#include "pathspec.h"
   8#include "dir.h"
   9#include "utf8.h"
  10#include "submodule.h"
  11#include "submodule-config.h"
  12#include "string-list.h"
  13#include "run-command.h"
  14#include "remote.h"
  15#include "refs.h"
  16#include "connect.h"
  17
  18static char *get_default_remote(void)
  19{
  20        char *dest = NULL, *ret;
  21        unsigned char sha1[20];
  22        struct strbuf sb = STRBUF_INIT;
  23        const char *refname = resolve_ref_unsafe("HEAD", 0, sha1, NULL);
  24
  25        if (!refname)
  26                die(_("No such ref: %s"), "HEAD");
  27
  28        /* detached HEAD */
  29        if (!strcmp(refname, "HEAD"))
  30                return xstrdup("origin");
  31
  32        if (!skip_prefix(refname, "refs/heads/", &refname))
  33                die(_("Expecting a full ref name, got %s"), refname);
  34
  35        strbuf_addf(&sb, "branch.%s.remote", refname);
  36        if (git_config_get_string(sb.buf, &dest))
  37                ret = xstrdup("origin");
  38        else
  39                ret = dest;
  40
  41        strbuf_release(&sb);
  42        return ret;
  43}
  44
  45static int starts_with_dot_slash(const char *str)
  46{
  47        return str[0] == '.' && is_dir_sep(str[1]);
  48}
  49
  50static int starts_with_dot_dot_slash(const char *str)
  51{
  52        return str[0] == '.' && str[1] == '.' && is_dir_sep(str[2]);
  53}
  54
  55/*
  56 * Returns 1 if it was the last chop before ':'.
  57 */
  58static int chop_last_dir(char **remoteurl, int is_relative)
  59{
  60        char *rfind = find_last_dir_sep(*remoteurl);
  61        if (rfind) {
  62                *rfind = '\0';
  63                return 0;
  64        }
  65
  66        rfind = strrchr(*remoteurl, ':');
  67        if (rfind) {
  68                *rfind = '\0';
  69                return 1;
  70        }
  71
  72        if (is_relative || !strcmp(".", *remoteurl))
  73                die(_("cannot strip one component off url '%s'"),
  74                        *remoteurl);
  75
  76        free(*remoteurl);
  77        *remoteurl = xstrdup(".");
  78        return 0;
  79}
  80
  81/*
  82 * The `url` argument is the URL that navigates to the submodule origin
  83 * repo. When relative, this URL is relative to the superproject origin
  84 * URL repo. The `up_path` argument, if specified, is the relative
  85 * path that navigates from the submodule working tree to the superproject
  86 * working tree. Returns the origin URL of the submodule.
  87 *
  88 * Return either an absolute URL or filesystem path (if the superproject
  89 * origin URL is an absolute URL or filesystem path, respectively) or a
  90 * relative file system path (if the superproject origin URL is a relative
  91 * file system path).
  92 *
  93 * When the output is a relative file system path, the path is either
  94 * relative to the submodule working tree, if up_path is specified, or to
  95 * the superproject working tree otherwise.
  96 *
  97 * NEEDSWORK: This works incorrectly on the domain and protocol part.
  98 * remote_url      url              outcome          expectation
  99 * http://a.com/b  ../c             http://a.com/c   as is
 100 * http://a.com/b/ ../c             http://a.com/c   same as previous line, but
 101 *                                                   ignore trailing slash in url
 102 * http://a.com/b  ../../c          http://c         error out
 103 * http://a.com/b  ../../../c       http:/c          error out
 104 * http://a.com/b  ../../../../c    http:c           error out
 105 * http://a.com/b  ../../../../../c    .:c           error out
 106 * NEEDSWORK: Given how chop_last_dir() works, this function is broken
 107 * when a local part has a colon in its path component, too.
 108 */
 109static char *relative_url(const char *remote_url,
 110                                const char *url,
 111                                const char *up_path)
 112{
 113        int is_relative = 0;
 114        int colonsep = 0;
 115        char *out;
 116        char *remoteurl = xstrdup(remote_url);
 117        struct strbuf sb = STRBUF_INIT;
 118        size_t len = strlen(remoteurl);
 119
 120        if (is_dir_sep(remoteurl[len-1]))
 121                remoteurl[len-1] = '\0';
 122
 123        if (!url_is_local_not_ssh(remoteurl) || is_absolute_path(remoteurl))
 124                is_relative = 0;
 125        else {
 126                is_relative = 1;
 127                /*
 128                 * Prepend a './' to ensure all relative
 129                 * remoteurls start with './' or '../'
 130                 */
 131                if (!starts_with_dot_slash(remoteurl) &&
 132                    !starts_with_dot_dot_slash(remoteurl)) {
 133                        strbuf_reset(&sb);
 134                        strbuf_addf(&sb, "./%s", remoteurl);
 135                        free(remoteurl);
 136                        remoteurl = strbuf_detach(&sb, NULL);
 137                }
 138        }
 139        /*
 140         * When the url starts with '../', remove that and the
 141         * last directory in remoteurl.
 142         */
 143        while (url) {
 144                if (starts_with_dot_dot_slash(url)) {
 145                        url += 3;
 146                        colonsep |= chop_last_dir(&remoteurl, is_relative);
 147                } else if (starts_with_dot_slash(url))
 148                        url += 2;
 149                else
 150                        break;
 151        }
 152        strbuf_reset(&sb);
 153        strbuf_addf(&sb, "%s%s%s", remoteurl, colonsep ? ":" : "/", url);
 154        if (ends_with(url, "/"))
 155                strbuf_setlen(&sb, sb.len - 1);
 156        free(remoteurl);
 157
 158        if (starts_with_dot_slash(sb.buf))
 159                out = xstrdup(sb.buf + 2);
 160        else
 161                out = xstrdup(sb.buf);
 162        strbuf_reset(&sb);
 163
 164        if (!up_path || !is_relative)
 165                return out;
 166
 167        strbuf_addf(&sb, "%s%s", up_path, out);
 168        free(out);
 169        return strbuf_detach(&sb, NULL);
 170}
 171
 172static int resolve_relative_url(int argc, const char **argv, const char *prefix)
 173{
 174        char *remoteurl = NULL;
 175        char *remote = get_default_remote();
 176        const char *up_path = NULL;
 177        char *res;
 178        const char *url;
 179        struct strbuf sb = STRBUF_INIT;
 180
 181        if (argc != 2 && argc != 3)
 182                die("resolve-relative-url only accepts one or two arguments");
 183
 184        url = argv[1];
 185        strbuf_addf(&sb, "remote.%s.url", remote);
 186        free(remote);
 187
 188        if (git_config_get_string(sb.buf, &remoteurl))
 189                /* the repository is its own authoritative upstream */
 190                remoteurl = xgetcwd();
 191
 192        if (argc == 3)
 193                up_path = argv[2];
 194
 195        res = relative_url(remoteurl, url, up_path);
 196        puts(res);
 197        free(res);
 198        free(remoteurl);
 199        return 0;
 200}
 201
 202static int resolve_relative_url_test(int argc, const char **argv, const char *prefix)
 203{
 204        char *remoteurl, *res;
 205        const char *up_path, *url;
 206
 207        if (argc != 4)
 208                die("resolve-relative-url-test only accepts three arguments: <up_path> <remoteurl> <url>");
 209
 210        up_path = argv[1];
 211        remoteurl = xstrdup(argv[2]);
 212        url = argv[3];
 213
 214        if (!strcmp(up_path, "(null)"))
 215                up_path = NULL;
 216
 217        res = relative_url(remoteurl, url, up_path);
 218        puts(res);
 219        free(res);
 220        free(remoteurl);
 221        return 0;
 222}
 223
 224struct module_list {
 225        const struct cache_entry **entries;
 226        int alloc, nr;
 227};
 228#define MODULE_LIST_INIT { NULL, 0, 0 }
 229
 230static int module_list_compute(int argc, const char **argv,
 231                               const char *prefix,
 232                               struct pathspec *pathspec,
 233                               struct module_list *list)
 234{
 235        int i, result = 0;
 236        char *ps_matched = NULL;
 237        parse_pathspec(pathspec, 0,
 238                       PATHSPEC_PREFER_FULL,
 239                       prefix, argv);
 240
 241        if (pathspec->nr)
 242                ps_matched = xcalloc(pathspec->nr, 1);
 243
 244        if (read_cache() < 0)
 245                die(_("index file corrupt"));
 246
 247        for (i = 0; i < active_nr; i++) {
 248                const struct cache_entry *ce = active_cache[i];
 249
 250                if (!match_pathspec(pathspec, ce->name, ce_namelen(ce),
 251                                    0, ps_matched, 1) ||
 252                    !S_ISGITLINK(ce->ce_mode))
 253                        continue;
 254
 255                ALLOC_GROW(list->entries, list->nr + 1, list->alloc);
 256                list->entries[list->nr++] = ce;
 257                while (i + 1 < active_nr &&
 258                       !strcmp(ce->name, active_cache[i + 1]->name))
 259                        /*
 260                         * Skip entries with the same name in different stages
 261                         * to make sure an entry is returned only once.
 262                         */
 263                        i++;
 264        }
 265
 266        if (ps_matched && report_path_error(ps_matched, pathspec, prefix))
 267                result = -1;
 268
 269        free(ps_matched);
 270
 271        return result;
 272}
 273
 274static void module_list_active(struct module_list *list)
 275{
 276        int i;
 277        struct module_list active_modules = MODULE_LIST_INIT;
 278
 279        gitmodules_config();
 280
 281        for (i = 0; i < list->nr; i++) {
 282                const struct cache_entry *ce = list->entries[i];
 283
 284                if (!is_submodule_active(the_repository, ce->name))
 285                        continue;
 286
 287                ALLOC_GROW(active_modules.entries,
 288                           active_modules.nr + 1,
 289                           active_modules.alloc);
 290                active_modules.entries[active_modules.nr++] = ce;
 291        }
 292
 293        free(list->entries);
 294        *list = active_modules;
 295}
 296
 297static int module_list(int argc, const char **argv, const char *prefix)
 298{
 299        int i;
 300        struct pathspec pathspec;
 301        struct module_list list = MODULE_LIST_INIT;
 302
 303        struct option module_list_options[] = {
 304                OPT_STRING(0, "prefix", &prefix,
 305                           N_("path"),
 306                           N_("alternative anchor for relative paths")),
 307                OPT_END()
 308        };
 309
 310        const char *const git_submodule_helper_usage[] = {
 311                N_("git submodule--helper list [--prefix=<path>] [<path>...]"),
 312                NULL
 313        };
 314
 315        argc = parse_options(argc, argv, prefix, module_list_options,
 316                             git_submodule_helper_usage, 0);
 317
 318        if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
 319                return 1;
 320
 321        for (i = 0; i < list.nr; i++) {
 322                const struct cache_entry *ce = list.entries[i];
 323
 324                if (ce_stage(ce))
 325                        printf("%06o %s U\t", ce->ce_mode, sha1_to_hex(null_sha1));
 326                else
 327                        printf("%06o %s %d\t", ce->ce_mode,
 328                               oid_to_hex(&ce->oid), ce_stage(ce));
 329
 330                utf8_fprintf(stdout, "%s\n", ce->name);
 331        }
 332        return 0;
 333}
 334
 335static void init_submodule(const char *path, const char *prefix, int quiet)
 336{
 337        const struct submodule *sub;
 338        struct strbuf sb = STRBUF_INIT;
 339        char *upd = NULL, *url = NULL, *displaypath;
 340
 341        /* Only loads from .gitmodules, no overlay with .git/config */
 342        gitmodules_config();
 343
 344        if (prefix && get_super_prefix())
 345                die("BUG: cannot have prefix and superprefix");
 346        else if (prefix)
 347                displaypath = xstrdup(relative_path(path, prefix, &sb));
 348        else if (get_super_prefix()) {
 349                strbuf_addf(&sb, "%s%s", get_super_prefix(), path);
 350                displaypath = strbuf_detach(&sb, NULL);
 351        } else
 352                displaypath = xstrdup(path);
 353
 354        sub = submodule_from_path(null_sha1, path);
 355
 356        if (!sub)
 357                die(_("No url found for submodule path '%s' in .gitmodules"),
 358                        displaypath);
 359
 360        /*
 361         * NEEDSWORK: In a multi-working-tree world, this needs to be
 362         * set in the per-worktree config.
 363         *
 364         * Set active flag for the submodule being initialized
 365         */
 366        if (!is_submodule_active(the_repository, path)) {
 367                strbuf_reset(&sb);
 368                strbuf_addf(&sb, "submodule.%s.active", sub->name);
 369                git_config_set_gently(sb.buf, "true");
 370        }
 371
 372        /*
 373         * Copy url setting when it is not set yet.
 374         * To look up the url in .git/config, we must not fall back to
 375         * .gitmodules, so look it up directly.
 376         */
 377        strbuf_reset(&sb);
 378        strbuf_addf(&sb, "submodule.%s.url", sub->name);
 379        if (git_config_get_string(sb.buf, &url)) {
 380                if (!sub->url)
 381                        die(_("No url found for submodule path '%s' in .gitmodules"),
 382                                displaypath);
 383
 384                url = xstrdup(sub->url);
 385
 386                /* Possibly a url relative to parent */
 387                if (starts_with_dot_dot_slash(url) ||
 388                    starts_with_dot_slash(url)) {
 389                        char *remoteurl, *relurl;
 390                        char *remote = get_default_remote();
 391                        struct strbuf remotesb = STRBUF_INIT;
 392                        strbuf_addf(&remotesb, "remote.%s.url", remote);
 393                        free(remote);
 394
 395                        if (git_config_get_string(remotesb.buf, &remoteurl)) {
 396                                warning(_("could not lookup configuration '%s'. Assuming this repository is its own authoritative upstream."), remotesb.buf);
 397                                remoteurl = xgetcwd();
 398                        }
 399                        relurl = relative_url(remoteurl, url, NULL);
 400                        strbuf_release(&remotesb);
 401                        free(remoteurl);
 402                        free(url);
 403                        url = relurl;
 404                }
 405
 406                if (git_config_set_gently(sb.buf, url))
 407                        die(_("Failed to register url for submodule path '%s'"),
 408                            displaypath);
 409                if (!quiet)
 410                        fprintf(stderr,
 411                                _("Submodule '%s' (%s) registered for path '%s'\n"),
 412                                sub->name, url, displaypath);
 413        }
 414
 415        /* Copy "update" setting when it is not set yet */
 416        strbuf_reset(&sb);
 417        strbuf_addf(&sb, "submodule.%s.update", sub->name);
 418        if (git_config_get_string(sb.buf, &upd) &&
 419            sub->update_strategy.type != SM_UPDATE_UNSPECIFIED) {
 420                if (sub->update_strategy.type == SM_UPDATE_COMMAND) {
 421                        fprintf(stderr, _("warning: command update mode suggested for submodule '%s'\n"),
 422                                sub->name);
 423                        upd = xstrdup("none");
 424                } else
 425                        upd = xstrdup(submodule_strategy_to_string(&sub->update_strategy));
 426
 427                if (git_config_set_gently(sb.buf, upd))
 428                        die(_("Failed to register update mode for submodule path '%s'"), displaypath);
 429        }
 430        strbuf_release(&sb);
 431        free(displaypath);
 432        free(url);
 433        free(upd);
 434}
 435
 436static int module_init(int argc, const char **argv, const char *prefix)
 437{
 438        struct pathspec pathspec;
 439        struct module_list list = MODULE_LIST_INIT;
 440        int quiet = 0;
 441        int i;
 442
 443        struct option module_init_options[] = {
 444                OPT__QUIET(&quiet, N_("Suppress output for initializing a submodule")),
 445                OPT_END()
 446        };
 447
 448        const char *const git_submodule_helper_usage[] = {
 449                N_("git submodule--helper init [<path>]"),
 450                NULL
 451        };
 452
 453        argc = parse_options(argc, argv, prefix, module_init_options,
 454                             git_submodule_helper_usage, 0);
 455
 456        if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
 457                return 1;
 458
 459        /*
 460         * If there are no path args and submodule.active is set then,
 461         * by default, only initialize 'active' modules.
 462         */
 463        if (!argc && git_config_get_value_multi("submodule.active"))
 464                module_list_active(&list);
 465
 466        for (i = 0; i < list.nr; i++)
 467                init_submodule(list.entries[i]->name, prefix, quiet);
 468
 469        return 0;
 470}
 471
 472static int module_name(int argc, const char **argv, const char *prefix)
 473{
 474        const struct submodule *sub;
 475
 476        if (argc != 2)
 477                usage(_("git submodule--helper name <path>"));
 478
 479        gitmodules_config();
 480        sub = submodule_from_path(null_sha1, argv[1]);
 481
 482        if (!sub)
 483                die(_("no submodule mapping found in .gitmodules for path '%s'"),
 484                    argv[1]);
 485
 486        printf("%s\n", sub->name);
 487
 488        return 0;
 489}
 490
 491static int clone_submodule(const char *path, const char *gitdir, const char *url,
 492                           const char *depth, struct string_list *reference,
 493                           int quiet, int progress)
 494{
 495        struct child_process cp = CHILD_PROCESS_INIT;
 496
 497        argv_array_push(&cp.args, "clone");
 498        argv_array_push(&cp.args, "--no-checkout");
 499        if (quiet)
 500                argv_array_push(&cp.args, "--quiet");
 501        if (progress)
 502                argv_array_push(&cp.args, "--progress");
 503        if (depth && *depth)
 504                argv_array_pushl(&cp.args, "--depth", depth, NULL);
 505        if (reference->nr) {
 506                struct string_list_item *item;
 507                for_each_string_list_item(item, reference)
 508                        argv_array_pushl(&cp.args, "--reference",
 509                                         item->string, NULL);
 510        }
 511        if (gitdir && *gitdir)
 512                argv_array_pushl(&cp.args, "--separate-git-dir", gitdir, NULL);
 513
 514        argv_array_push(&cp.args, url);
 515        argv_array_push(&cp.args, path);
 516
 517        cp.git_cmd = 1;
 518        prepare_submodule_repo_env(&cp.env_array);
 519        cp.no_stdin = 1;
 520
 521        return run_command(&cp);
 522}
 523
 524struct submodule_alternate_setup {
 525        const char *submodule_name;
 526        enum SUBMODULE_ALTERNATE_ERROR_MODE {
 527                SUBMODULE_ALTERNATE_ERROR_DIE,
 528                SUBMODULE_ALTERNATE_ERROR_INFO,
 529                SUBMODULE_ALTERNATE_ERROR_IGNORE
 530        } error_mode;
 531        struct string_list *reference;
 532};
 533#define SUBMODULE_ALTERNATE_SETUP_INIT { NULL, \
 534        SUBMODULE_ALTERNATE_ERROR_IGNORE, NULL }
 535
 536static int add_possible_reference_from_superproject(
 537                struct alternate_object_database *alt, void *sas_cb)
 538{
 539        struct submodule_alternate_setup *sas = sas_cb;
 540
 541        /*
 542         * If the alternate object store is another repository, try the
 543         * standard layout with .git/(modules/<name>)+/objects
 544         */
 545        if (ends_with(alt->path, "/objects")) {
 546                char *sm_alternate;
 547                struct strbuf sb = STRBUF_INIT;
 548                struct strbuf err = STRBUF_INIT;
 549                strbuf_add(&sb, alt->path, strlen(alt->path) - strlen("objects"));
 550
 551                /*
 552                 * We need to end the new path with '/' to mark it as a dir,
 553                 * otherwise a submodule name containing '/' will be broken
 554                 * as the last part of a missing submodule reference would
 555                 * be taken as a file name.
 556                 */
 557                strbuf_addf(&sb, "modules/%s/", sas->submodule_name);
 558
 559                sm_alternate = compute_alternate_path(sb.buf, &err);
 560                if (sm_alternate) {
 561                        string_list_append(sas->reference, xstrdup(sb.buf));
 562                        free(sm_alternate);
 563                } else {
 564                        switch (sas->error_mode) {
 565                        case SUBMODULE_ALTERNATE_ERROR_DIE:
 566                                die(_("submodule '%s' cannot add alternate: %s"),
 567                                    sas->submodule_name, err.buf);
 568                        case SUBMODULE_ALTERNATE_ERROR_INFO:
 569                                fprintf(stderr, _("submodule '%s' cannot add alternate: %s"),
 570                                        sas->submodule_name, err.buf);
 571                        case SUBMODULE_ALTERNATE_ERROR_IGNORE:
 572                                ; /* nothing */
 573                        }
 574                }
 575                strbuf_release(&sb);
 576        }
 577
 578        return 0;
 579}
 580
 581static void prepare_possible_alternates(const char *sm_name,
 582                struct string_list *reference)
 583{
 584        char *sm_alternate = NULL, *error_strategy = NULL;
 585        struct submodule_alternate_setup sas = SUBMODULE_ALTERNATE_SETUP_INIT;
 586
 587        git_config_get_string("submodule.alternateLocation", &sm_alternate);
 588        if (!sm_alternate)
 589                return;
 590
 591        git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
 592
 593        if (!error_strategy)
 594                error_strategy = xstrdup("die");
 595
 596        sas.submodule_name = sm_name;
 597        sas.reference = reference;
 598        if (!strcmp(error_strategy, "die"))
 599                sas.error_mode = SUBMODULE_ALTERNATE_ERROR_DIE;
 600        else if (!strcmp(error_strategy, "info"))
 601                sas.error_mode = SUBMODULE_ALTERNATE_ERROR_INFO;
 602        else if (!strcmp(error_strategy, "ignore"))
 603                sas.error_mode = SUBMODULE_ALTERNATE_ERROR_IGNORE;
 604        else
 605                die(_("Value '%s' for submodule.alternateErrorStrategy is not recognized"), error_strategy);
 606
 607        if (!strcmp(sm_alternate, "superproject"))
 608                foreach_alt_odb(add_possible_reference_from_superproject, &sas);
 609        else if (!strcmp(sm_alternate, "no"))
 610                ; /* do nothing */
 611        else
 612                die(_("Value '%s' for submodule.alternateLocation is not recognized"), sm_alternate);
 613
 614        free(sm_alternate);
 615        free(error_strategy);
 616}
 617
 618static int module_clone(int argc, const char **argv, const char *prefix)
 619{
 620        const char *name = NULL, *url = NULL, *depth = NULL;
 621        int quiet = 0;
 622        int progress = 0;
 623        char *p, *path = NULL, *sm_gitdir;
 624        struct strbuf sb = STRBUF_INIT;
 625        struct string_list reference = STRING_LIST_INIT_NODUP;
 626        char *sm_alternate = NULL, *error_strategy = NULL;
 627
 628        struct option module_clone_options[] = {
 629                OPT_STRING(0, "prefix", &prefix,
 630                           N_("path"),
 631                           N_("alternative anchor for relative paths")),
 632                OPT_STRING(0, "path", &path,
 633                           N_("path"),
 634                           N_("where the new submodule will be cloned to")),
 635                OPT_STRING(0, "name", &name,
 636                           N_("string"),
 637                           N_("name of the new submodule")),
 638                OPT_STRING(0, "url", &url,
 639                           N_("string"),
 640                           N_("url where to clone the submodule from")),
 641                OPT_STRING_LIST(0, "reference", &reference,
 642                           N_("repo"),
 643                           N_("reference repository")),
 644                OPT_STRING(0, "depth", &depth,
 645                           N_("string"),
 646                           N_("depth for shallow clones")),
 647                OPT__QUIET(&quiet, "Suppress output for cloning a submodule"),
 648                OPT_BOOL(0, "progress", &progress,
 649                           N_("force cloning progress")),
 650                OPT_END()
 651        };
 652
 653        const char *const git_submodule_helper_usage[] = {
 654                N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
 655                   "[--reference <repository>] [--name <name>] [--depth <depth>] "
 656                   "--url <url> --path <path>"),
 657                NULL
 658        };
 659
 660        argc = parse_options(argc, argv, prefix, module_clone_options,
 661                             git_submodule_helper_usage, 0);
 662
 663        if (argc || !url || !path || !*path)
 664                usage_with_options(git_submodule_helper_usage,
 665                                   module_clone_options);
 666
 667        strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), name);
 668        sm_gitdir = absolute_pathdup(sb.buf);
 669        strbuf_reset(&sb);
 670
 671        if (!is_absolute_path(path)) {
 672                strbuf_addf(&sb, "%s/%s", get_git_work_tree(), path);
 673                path = strbuf_detach(&sb, NULL);
 674        } else
 675                path = xstrdup(path);
 676
 677        if (!file_exists(sm_gitdir)) {
 678                if (safe_create_leading_directories_const(sm_gitdir) < 0)
 679                        die(_("could not create directory '%s'"), sm_gitdir);
 680
 681                prepare_possible_alternates(name, &reference);
 682
 683                if (clone_submodule(path, sm_gitdir, url, depth, &reference,
 684                                    quiet, progress))
 685                        die(_("clone of '%s' into submodule path '%s' failed"),
 686                            url, path);
 687        } else {
 688                if (safe_create_leading_directories_const(path) < 0)
 689                        die(_("could not create directory '%s'"), path);
 690                strbuf_addf(&sb, "%s/index", sm_gitdir);
 691                unlink_or_warn(sb.buf);
 692                strbuf_reset(&sb);
 693        }
 694
 695        /* Connect module worktree and git dir */
 696        connect_work_tree_and_git_dir(path, sm_gitdir);
 697
 698        p = git_pathdup_submodule(path, "config");
 699        if (!p)
 700                die(_("could not get submodule directory for '%s'"), path);
 701
 702        /* setup alternateLocation and alternateErrorStrategy in the cloned submodule if needed */
 703        git_config_get_string("submodule.alternateLocation", &sm_alternate);
 704        if (sm_alternate)
 705                git_config_set_in_file(p, "submodule.alternateLocation",
 706                                           sm_alternate);
 707        git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
 708        if (error_strategy)
 709                git_config_set_in_file(p, "submodule.alternateErrorStrategy",
 710                                           error_strategy);
 711
 712        free(sm_alternate);
 713        free(error_strategy);
 714
 715        strbuf_release(&sb);
 716        free(sm_gitdir);
 717        free(path);
 718        free(p);
 719        return 0;
 720}
 721
 722struct submodule_update_clone {
 723        /* index into 'list', the list of submodules to look into for cloning */
 724        int current;
 725        struct module_list list;
 726        unsigned warn_if_uninitialized : 1;
 727
 728        /* update parameter passed via commandline */
 729        struct submodule_update_strategy update;
 730
 731        /* configuration parameters which are passed on to the children */
 732        int progress;
 733        int quiet;
 734        int recommend_shallow;
 735        struct string_list references;
 736        const char *depth;
 737        const char *recursive_prefix;
 738        const char *prefix;
 739
 740        /* Machine-readable status lines to be consumed by git-submodule.sh */
 741        struct string_list projectlines;
 742
 743        /* If we want to stop as fast as possible and return an error */
 744        unsigned quickstop : 1;
 745
 746        /* failed clones to be retried again */
 747        const struct cache_entry **failed_clones;
 748        int failed_clones_nr, failed_clones_alloc;
 749};
 750#define SUBMODULE_UPDATE_CLONE_INIT {0, MODULE_LIST_INIT, 0, \
 751        SUBMODULE_UPDATE_STRATEGY_INIT, 0, 0, -1, STRING_LIST_INIT_DUP, \
 752        NULL, NULL, NULL, \
 753        STRING_LIST_INIT_DUP, 0, NULL, 0, 0}
 754
 755
 756static void next_submodule_warn_missing(struct submodule_update_clone *suc,
 757                struct strbuf *out, const char *displaypath)
 758{
 759        /*
 760         * Only mention uninitialized submodules when their
 761         * paths have been specified.
 762         */
 763        if (suc->warn_if_uninitialized) {
 764                strbuf_addf(out,
 765                        _("Submodule path '%s' not initialized"),
 766                        displaypath);
 767                strbuf_addch(out, '\n');
 768                strbuf_addstr(out,
 769                        _("Maybe you want to use 'update --init'?"));
 770                strbuf_addch(out, '\n');
 771        }
 772}
 773
 774/**
 775 * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
 776 * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
 777 */
 778static int prepare_to_clone_next_submodule(const struct cache_entry *ce,
 779                                           struct child_process *child,
 780                                           struct submodule_update_clone *suc,
 781                                           struct strbuf *out)
 782{
 783        const struct submodule *sub = NULL;
 784        struct strbuf displaypath_sb = STRBUF_INIT;
 785        struct strbuf sb = STRBUF_INIT;
 786        const char *displaypath = NULL;
 787        int needs_cloning = 0;
 788
 789        if (ce_stage(ce)) {
 790                if (suc->recursive_prefix)
 791                        strbuf_addf(&sb, "%s/%s", suc->recursive_prefix, ce->name);
 792                else
 793                        strbuf_addstr(&sb, ce->name);
 794                strbuf_addf(out, _("Skipping unmerged submodule %s"), sb.buf);
 795                strbuf_addch(out, '\n');
 796                goto cleanup;
 797        }
 798
 799        sub = submodule_from_path(null_sha1, ce->name);
 800
 801        if (suc->recursive_prefix)
 802                displaypath = relative_path(suc->recursive_prefix,
 803                                            ce->name, &displaypath_sb);
 804        else
 805                displaypath = ce->name;
 806
 807        if (!sub) {
 808                next_submodule_warn_missing(suc, out, displaypath);
 809                goto cleanup;
 810        }
 811
 812        if (suc->update.type == SM_UPDATE_NONE
 813            || (suc->update.type == SM_UPDATE_UNSPECIFIED
 814                && sub->update_strategy.type == SM_UPDATE_NONE)) {
 815                strbuf_addf(out, _("Skipping submodule '%s'"), displaypath);
 816                strbuf_addch(out, '\n');
 817                goto cleanup;
 818        }
 819
 820        /* Check if the submodule has been initialized. */
 821        if (!is_submodule_active(the_repository, ce->name)) {
 822                next_submodule_warn_missing(suc, out, displaypath);
 823                goto cleanup;
 824        }
 825
 826        strbuf_reset(&sb);
 827        strbuf_addf(&sb, "%s/.git", ce->name);
 828        needs_cloning = !file_exists(sb.buf);
 829
 830        strbuf_reset(&sb);
 831        strbuf_addf(&sb, "%06o %s %d %d\t%s\n", ce->ce_mode,
 832                        oid_to_hex(&ce->oid), ce_stage(ce),
 833                        needs_cloning, ce->name);
 834        string_list_append(&suc->projectlines, sb.buf);
 835
 836        if (!needs_cloning)
 837                goto cleanup;
 838
 839        child->git_cmd = 1;
 840        child->no_stdin = 1;
 841        child->stdout_to_stderr = 1;
 842        child->err = -1;
 843        argv_array_push(&child->args, "submodule--helper");
 844        argv_array_push(&child->args, "clone");
 845        if (suc->progress)
 846                argv_array_push(&child->args, "--progress");
 847        if (suc->quiet)
 848                argv_array_push(&child->args, "--quiet");
 849        if (suc->prefix)
 850                argv_array_pushl(&child->args, "--prefix", suc->prefix, NULL);
 851        if (suc->recommend_shallow && sub->recommend_shallow == 1)
 852                argv_array_push(&child->args, "--depth=1");
 853        argv_array_pushl(&child->args, "--path", sub->path, NULL);
 854        argv_array_pushl(&child->args, "--name", sub->name, NULL);
 855        argv_array_pushl(&child->args, "--url", sub->url, NULL);
 856        if (suc->references.nr) {
 857                struct string_list_item *item;
 858                for_each_string_list_item(item, &suc->references)
 859                        argv_array_pushl(&child->args, "--reference", item->string, NULL);
 860        }
 861        if (suc->depth)
 862                argv_array_push(&child->args, suc->depth);
 863
 864cleanup:
 865        strbuf_reset(&displaypath_sb);
 866        strbuf_reset(&sb);
 867
 868        return needs_cloning;
 869}
 870
 871static int update_clone_get_next_task(struct child_process *child,
 872                                      struct strbuf *err,
 873                                      void *suc_cb,
 874                                      void **idx_task_cb)
 875{
 876        struct submodule_update_clone *suc = suc_cb;
 877        const struct cache_entry *ce;
 878        int index;
 879
 880        for (; suc->current < suc->list.nr; suc->current++) {
 881                ce = suc->list.entries[suc->current];
 882                if (prepare_to_clone_next_submodule(ce, child, suc, err)) {
 883                        int *p = xmalloc(sizeof(*p));
 884                        *p = suc->current;
 885                        *idx_task_cb = p;
 886                        suc->current++;
 887                        return 1;
 888                }
 889        }
 890
 891        /*
 892         * The loop above tried cloning each submodule once, now try the
 893         * stragglers again, which we can imagine as an extension of the
 894         * entry list.
 895         */
 896        index = suc->current - suc->list.nr;
 897        if (index < suc->failed_clones_nr) {
 898                int *p;
 899                ce = suc->failed_clones[index];
 900                if (!prepare_to_clone_next_submodule(ce, child, suc, err)) {
 901                        suc->current ++;
 902                        strbuf_addstr(err, "BUG: submodule considered for "
 903                                           "cloning, doesn't need cloning "
 904                                           "any more?\n");
 905                        return 0;
 906                }
 907                p = xmalloc(sizeof(*p));
 908                *p = suc->current;
 909                *idx_task_cb = p;
 910                suc->current ++;
 911                return 1;
 912        }
 913
 914        return 0;
 915}
 916
 917static int update_clone_start_failure(struct strbuf *err,
 918                                      void *suc_cb,
 919                                      void *idx_task_cb)
 920{
 921        struct submodule_update_clone *suc = suc_cb;
 922        suc->quickstop = 1;
 923        return 1;
 924}
 925
 926static int update_clone_task_finished(int result,
 927                                      struct strbuf *err,
 928                                      void *suc_cb,
 929                                      void *idx_task_cb)
 930{
 931        const struct cache_entry *ce;
 932        struct submodule_update_clone *suc = suc_cb;
 933
 934        int *idxP = *(int**)idx_task_cb;
 935        int idx = *idxP;
 936        free(idxP);
 937
 938        if (!result)
 939                return 0;
 940
 941        if (idx < suc->list.nr) {
 942                ce  = suc->list.entries[idx];
 943                strbuf_addf(err, _("Failed to clone '%s'. Retry scheduled"),
 944                            ce->name);
 945                strbuf_addch(err, '\n');
 946                ALLOC_GROW(suc->failed_clones,
 947                           suc->failed_clones_nr + 1,
 948                           suc->failed_clones_alloc);
 949                suc->failed_clones[suc->failed_clones_nr++] = ce;
 950                return 0;
 951        } else {
 952                idx -= suc->list.nr;
 953                ce  = suc->failed_clones[idx];
 954                strbuf_addf(err, _("Failed to clone '%s' a second time, aborting"),
 955                            ce->name);
 956                strbuf_addch(err, '\n');
 957                suc->quickstop = 1;
 958                return 1;
 959        }
 960
 961        return 0;
 962}
 963
 964static int update_clone(int argc, const char **argv, const char *prefix)
 965{
 966        const char *update = NULL;
 967        int max_jobs = -1;
 968        struct string_list_item *item;
 969        struct pathspec pathspec;
 970        struct submodule_update_clone suc = SUBMODULE_UPDATE_CLONE_INIT;
 971
 972        struct option module_update_clone_options[] = {
 973                OPT_STRING(0, "prefix", &prefix,
 974                           N_("path"),
 975                           N_("path into the working tree")),
 976                OPT_STRING(0, "recursive-prefix", &suc.recursive_prefix,
 977                           N_("path"),
 978                           N_("path into the working tree, across nested "
 979                              "submodule boundaries")),
 980                OPT_STRING(0, "update", &update,
 981                           N_("string"),
 982                           N_("rebase, merge, checkout or none")),
 983                OPT_STRING_LIST(0, "reference", &suc.references, N_("repo"),
 984                           N_("reference repository")),
 985                OPT_STRING(0, "depth", &suc.depth, "<depth>",
 986                           N_("Create a shallow clone truncated to the "
 987                              "specified number of revisions")),
 988                OPT_INTEGER('j', "jobs", &max_jobs,
 989                            N_("parallel jobs")),
 990                OPT_BOOL(0, "recommend-shallow", &suc.recommend_shallow,
 991                            N_("whether the initial clone should follow the shallow recommendation")),
 992                OPT__QUIET(&suc.quiet, N_("don't print cloning progress")),
 993                OPT_BOOL(0, "progress", &suc.progress,
 994                            N_("force cloning progress")),
 995                OPT_END()
 996        };
 997
 998        const char *const git_submodule_helper_usage[] = {
 999                N_("git submodule--helper update_clone [--prefix=<path>] [<path>...]"),
1000                NULL
1001        };
1002        suc.prefix = prefix;
1003
1004        argc = parse_options(argc, argv, prefix, module_update_clone_options,
1005                             git_submodule_helper_usage, 0);
1006
1007        if (update)
1008                if (parse_submodule_update_strategy(update, &suc.update) < 0)
1009                        die(_("bad value for update parameter"));
1010
1011        if (module_list_compute(argc, argv, prefix, &pathspec, &suc.list) < 0)
1012                return 1;
1013
1014        if (pathspec.nr)
1015                suc.warn_if_uninitialized = 1;
1016
1017        /* Overlay the parsed .gitmodules file with .git/config */
1018        gitmodules_config();
1019        git_config(submodule_config, NULL);
1020
1021        if (max_jobs < 0)
1022                max_jobs = parallel_submodules();
1023
1024        run_processes_parallel(max_jobs,
1025                               update_clone_get_next_task,
1026                               update_clone_start_failure,
1027                               update_clone_task_finished,
1028                               &suc);
1029
1030        /*
1031         * We saved the output and put it out all at once now.
1032         * That means:
1033         * - the listener does not have to interleave their (checkout)
1034         *   work with our fetching.  The writes involved in a
1035         *   checkout involve more straightforward sequential I/O.
1036         * - the listener can avoid doing any work if fetching failed.
1037         */
1038        if (suc.quickstop)
1039                return 1;
1040
1041        for_each_string_list_item(item, &suc.projectlines)
1042                utf8_fprintf(stdout, "%s", item->string);
1043
1044        return 0;
1045}
1046
1047static int resolve_relative_path(int argc, const char **argv, const char *prefix)
1048{
1049        struct strbuf sb = STRBUF_INIT;
1050        if (argc != 3)
1051                die("submodule--helper relative-path takes exactly 2 arguments, got %d", argc);
1052
1053        printf("%s", relative_path(argv[1], argv[2], &sb));
1054        strbuf_release(&sb);
1055        return 0;
1056}
1057
1058static const char *remote_submodule_branch(const char *path)
1059{
1060        const struct submodule *sub;
1061        gitmodules_config();
1062        git_config(submodule_config, NULL);
1063
1064        sub = submodule_from_path(null_sha1, path);
1065        if (!sub)
1066                return NULL;
1067
1068        if (!sub->branch)
1069                return "master";
1070
1071        if (!strcmp(sub->branch, ".")) {
1072                unsigned char sha1[20];
1073                const char *refname = resolve_ref_unsafe("HEAD", 0, sha1, NULL);
1074
1075                if (!refname)
1076                        die(_("No such ref: %s"), "HEAD");
1077
1078                /* detached HEAD */
1079                if (!strcmp(refname, "HEAD"))
1080                        die(_("Submodule (%s) branch configured to inherit "
1081                              "branch from superproject, but the superproject "
1082                              "is not on any branch"), sub->name);
1083
1084                if (!skip_prefix(refname, "refs/heads/", &refname))
1085                        die(_("Expecting a full ref name, got %s"), refname);
1086                return refname;
1087        }
1088
1089        return sub->branch;
1090}
1091
1092static int resolve_remote_submodule_branch(int argc, const char **argv,
1093                const char *prefix)
1094{
1095        const char *ret;
1096        struct strbuf sb = STRBUF_INIT;
1097        if (argc != 2)
1098                die("submodule--helper remote-branch takes exactly one arguments, got %d", argc);
1099
1100        ret = remote_submodule_branch(argv[1]);
1101        if (!ret)
1102                die("submodule %s doesn't exist", argv[1]);
1103
1104        printf("%s", ret);
1105        strbuf_release(&sb);
1106        return 0;
1107}
1108
1109static int push_check(int argc, const char **argv, const char *prefix)
1110{
1111        struct remote *remote;
1112
1113        if (argc < 2)
1114                die("submodule--helper push-check requires at least 1 argument");
1115
1116        /*
1117         * The remote must be configured.
1118         * This is to avoid pushing to the exact same URL as the parent.
1119         */
1120        remote = pushremote_get(argv[1]);
1121        if (!remote || remote->origin == REMOTE_UNCONFIGURED)
1122                die("remote '%s' not configured", argv[1]);
1123
1124        /* Check the refspec */
1125        if (argc > 2) {
1126                int i, refspec_nr = argc - 2;
1127                struct ref *local_refs = get_local_heads();
1128                struct refspec *refspec = parse_push_refspec(refspec_nr,
1129                                                             argv + 2);
1130
1131                for (i = 0; i < refspec_nr; i++) {
1132                        struct refspec *rs = refspec + i;
1133
1134                        if (rs->pattern || rs->matching)
1135                                continue;
1136
1137                        /*
1138                         * LHS must match a single ref
1139                         * NEEDSWORK: add logic to special case 'HEAD' once
1140                         * working with submodules in a detached head state
1141                         * ceases to be the norm.
1142                         */
1143                        if (count_refspec_match(rs->src, local_refs, NULL) != 1)
1144                                die("src refspec '%s' must name a ref",
1145                                    rs->src);
1146                }
1147                free_refspec(refspec_nr, refspec);
1148        }
1149
1150        return 0;
1151}
1152
1153static int absorb_git_dirs(int argc, const char **argv, const char *prefix)
1154{
1155        int i;
1156        struct pathspec pathspec;
1157        struct module_list list = MODULE_LIST_INIT;
1158        unsigned flags = ABSORB_GITDIR_RECURSE_SUBMODULES;
1159
1160        struct option embed_gitdir_options[] = {
1161                OPT_STRING(0, "prefix", &prefix,
1162                           N_("path"),
1163                           N_("path into the working tree")),
1164                OPT_BIT(0, "--recursive", &flags, N_("recurse into submodules"),
1165                        ABSORB_GITDIR_RECURSE_SUBMODULES),
1166                OPT_END()
1167        };
1168
1169        const char *const git_submodule_helper_usage[] = {
1170                N_("git submodule--helper embed-git-dir [<path>...]"),
1171                NULL
1172        };
1173
1174        argc = parse_options(argc, argv, prefix, embed_gitdir_options,
1175                             git_submodule_helper_usage, 0);
1176
1177        gitmodules_config();
1178        git_config(submodule_config, NULL);
1179
1180        if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
1181                return 1;
1182
1183        for (i = 0; i < list.nr; i++)
1184                absorb_git_dir_into_superproject(prefix,
1185                                list.entries[i]->name, flags);
1186
1187        return 0;
1188}
1189
1190static int is_active(int argc, const char **argv, const char *prefix)
1191{
1192        if (argc != 2)
1193                die("submodule--helper is-active takes exactly 1 argument");
1194
1195        gitmodules_config();
1196
1197        return !is_submodule_active(the_repository, argv[1]);
1198}
1199
1200#define SUPPORT_SUPER_PREFIX (1<<0)
1201
1202struct cmd_struct {
1203        const char *cmd;
1204        int (*fn)(int, const char **, const char *);
1205        unsigned option;
1206};
1207
1208static struct cmd_struct commands[] = {
1209        {"list", module_list, 0},
1210        {"name", module_name, 0},
1211        {"clone", module_clone, 0},
1212        {"update-clone", update_clone, 0},
1213        {"relative-path", resolve_relative_path, 0},
1214        {"resolve-relative-url", resolve_relative_url, 0},
1215        {"resolve-relative-url-test", resolve_relative_url_test, 0},
1216        {"init", module_init, SUPPORT_SUPER_PREFIX},
1217        {"remote-branch", resolve_remote_submodule_branch, 0},
1218        {"push-check", push_check, 0},
1219        {"absorb-git-dirs", absorb_git_dirs, SUPPORT_SUPER_PREFIX},
1220        {"is-active", is_active, 0},
1221};
1222
1223int cmd_submodule__helper(int argc, const char **argv, const char *prefix)
1224{
1225        int i;
1226        if (argc < 2 || !strcmp(argv[1], "-h"))
1227                usage("git submodule--helper <command>");
1228
1229        for (i = 0; i < ARRAY_SIZE(commands); i++) {
1230                if (!strcmp(argv[1], commands[i].cmd)) {
1231                        if (get_super_prefix() &&
1232                            !(commands[i].option & SUPPORT_SUPER_PREFIX))
1233                                die(_("%s doesn't support --super-prefix"),
1234                                    commands[i].cmd);
1235                        return commands[i].fn(argc - 1, argv + 1, prefix);
1236                }
1237        }
1238
1239        die(_("'%s' is not a valid submodule--helper "
1240              "subcommand"), argv[1]);
1241}