builtin/submodule--helper.c

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