builtin/submodule--helper.c

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