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