git.oblomov.eu Git - git/blob - builtin/submodule--helper.c

   1 #define USE_THE_INDEX_COMPATIBILITY_MACROS
   2 #include "builtin.h"
   3 #include "repository.h"
   4 #include "cache.h"
   5 #include "config.h"
   6 #include "parse-options.h"
   7 #include "quote.h"
   8 #include "pathspec.h"
   9 #include "dir.h"
  10 #include "submodule.h"
  11 #include "submodule-config.h"
  12 #include "string-list.h"
  13 #include "run-command.h"
  14 #include "remote.h"
  15 #include "refs.h"
  16 #include "refspec.h"
  17 #include "connect.h"
  18 #include "revision.h"
  19 #include "diffcore.h"
  20 #include "diff.h"
  21 #include "object-store.h"
  22 #include "dir.h"
  23 #include "advice.h"
  24
  25 #define OPT_QUIET (1 << 0)
  26 #define OPT_CACHED (1 << 1)
  27 #define OPT_RECURSIVE (1 << 2)
  28 #define OPT_FORCE (1 << 3)
  29
  30 typedef void (*each_submodule_fn)(const struct cache_entry *list_item,
  31                                   void *cb_data);
  32
  33 static char *get_default_remote(void)
  34 {
  35         char *dest = NULL, *ret;
  36         struct strbuf sb = STRBUF_INIT;
  37         const char *refname = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
  38
  39         if (!refname)
  40                 die(_("No such ref: %s"), "HEAD");
  41
  42         /* detached HEAD */
  43         if (!strcmp(refname, "HEAD"))
  44                 return xstrdup("origin");
  45
  46         if (!skip_prefix(refname, "refs/heads/", &refname))
  47                 die(_("Expecting a full ref name, got %s"), refname);
  48
  49         strbuf_addf(&sb, "branch.%s.remote", refname);
  50         if (git_config_get_string(sb.buf, &dest))
  51                 ret = xstrdup("origin");
  52         else
  53                 ret = dest;
  54
  55         strbuf_release(&sb);
  56         return ret;
  57 }
  58
  59 static int print_default_remote(int argc, const char **argv, const char *prefix)
  60 {
  61         char *remote;
  62
  63         if (argc != 1)
  64                 die(_("submodule--helper print-default-remote takes no arguments"));
  65
  66         remote = get_default_remote();
  67         if (remote)
  68                 printf("%s\n", remote);
  69
  70         free(remote);
  71         return 0;
  72 }
  73
  74 static int starts_with_dot_slash(const char *str)
  75 {
  76         return str[0] == '.' && is_dir_sep(str[1]);
  77 }
  78
  79 static int starts_with_dot_dot_slash(const char *str)
  80 {
  81         return str[0] == '.' && str[1] == '.' && is_dir_sep(str[2]);
  82 }
  83
  84 /*
  85  * Returns 1 if it was the last chop before ':'.
  86  */
  87 static int chop_last_dir(char **remoteurl, int is_relative)
  88 {
  89         char *rfind = find_last_dir_sep(*remoteurl);
  90         if (rfind) {
  91                 *rfind = '\0';
  92                 return 0;
  93         }
  94
  95         rfind = strrchr(*remoteurl, ':');
  96         if (rfind) {
  97                 *rfind = '\0';
  98                 return 1;
  99         }
 100
 101         if (is_relative || !strcmp(".", *remoteurl))
 102                 die(_("cannot strip one component off url '%s'"),
 103                         *remoteurl);
 104
 105         free(*remoteurl);
 106         *remoteurl = xstrdup(".");
 107         return 0;
 108 }
 109
 110 /*
 111  * The `url` argument is the URL that navigates to the submodule origin
 112  * repo. When relative, this URL is relative to the superproject origin
 113  * URL repo. The `up_path` argument, if specified, is the relative
 114  * path that navigates from the submodule working tree to the superproject
 115  * working tree. Returns the origin URL of the submodule.
 116  *
 117  * Return either an absolute URL or filesystem path (if the superproject
 118  * origin URL is an absolute URL or filesystem path, respectively) or a
 119  * relative file system path (if the superproject origin URL is a relative
 120  * file system path).
 121  *
 122  * When the output is a relative file system path, the path is either
 123  * relative to the submodule working tree, if up_path is specified, or to
 124  * the superproject working tree otherwise.
 125  *
 126  * NEEDSWORK: This works incorrectly on the domain and protocol part.
 127  * remote_url      url              outcome          expectation
 128  * http://a.com/b  ../c             http://a.com/c   as is
 129  * http://a.com/b/ ../c             http://a.com/c   same as previous line, but
 130  *                                                   ignore trailing slash in url
 131  * http://a.com/b  ../../c          http://c         error out
 132  * http://a.com/b  ../../../c       http:/c          error out
 133  * http://a.com/b  ../../../../c    http:c           error out
 134  * http://a.com/b  ../../../../../c    .:c           error out
 135  * NEEDSWORK: Given how chop_last_dir() works, this function is broken
 136  * when a local part has a colon in its path component, too.
 137  */
 138 static char *relative_url(const char *remote_url,
 139                                 const char *url,
 140                                 const char *up_path)
 141 {
 142         int is_relative = 0;
 143         int colonsep = 0;
 144         char *out;
 145         char *remoteurl = xstrdup(remote_url);
 146         struct strbuf sb = STRBUF_INIT;
 147         size_t len = strlen(remoteurl);
 148
 149         if (is_dir_sep(remoteurl[len-1]))
 150                 remoteurl[len-1] = '\0';
 151
 152         if (!url_is_local_not_ssh(remoteurl) || is_absolute_path(remoteurl))
 153                 is_relative = 0;
 154         else {
 155                 is_relative = 1;
 156                 /*
 157                  * Prepend a './' to ensure all relative
 158                  * remoteurls start with './' or '../'
 159                  */
 160                 if (!starts_with_dot_slash(remoteurl) &&
 161                     !starts_with_dot_dot_slash(remoteurl)) {
 162                         strbuf_reset(&sb);
 163                         strbuf_addf(&sb, "./%s", remoteurl);
 164                         free(remoteurl);
 165                         remoteurl = strbuf_detach(&sb, NULL);
 166                 }
 167         }
 168         /*
 169          * When the url starts with '../', remove that and the
 170          * last directory in remoteurl.
 171          */
 172         while (url) {
 173                 if (starts_with_dot_dot_slash(url)) {
 174                         url += 3;
 175                         colonsep |= chop_last_dir(&remoteurl, is_relative);
 176                 } else if (starts_with_dot_slash(url))
 177                         url += 2;
 178                 else
 179                         break;
 180         }
 181         strbuf_reset(&sb);
 182         strbuf_addf(&sb, "%s%s%s", remoteurl, colonsep ? ":" : "/", url);
 183         if (ends_with(url, "/"))
 184                 strbuf_setlen(&sb, sb.len - 1);
 185         free(remoteurl);
 186
 187         if (starts_with_dot_slash(sb.buf))
 188                 out = xstrdup(sb.buf + 2);
 189         else
 190                 out = xstrdup(sb.buf);
 191         strbuf_reset(&sb);
 192
 193         if (!up_path || !is_relative)
 194                 return out;
 195
 196         strbuf_addf(&sb, "%s%s", up_path, out);
 197         free(out);
 198         return strbuf_detach(&sb, NULL);
 199 }
 200
 201 static int resolve_relative_url(int argc, const char **argv, const char *prefix)
 202 {
 203         char *remoteurl = NULL;
 204         char *remote = get_default_remote();
 205         const char *up_path = NULL;
 206         char *res;
 207         const char *url;
 208         struct strbuf sb = STRBUF_INIT;
 209
 210         if (argc != 2 && argc != 3)
 211                 die("resolve-relative-url only accepts one or two arguments");
 212
 213         url = argv[1];
 214         strbuf_addf(&sb, "remote.%s.url", remote);
 215         free(remote);
 216
 217         if (git_config_get_string(sb.buf, &remoteurl))
 218                 /* the repository is its own authoritative upstream */
 219                 remoteurl = xgetcwd();
 220
 221         if (argc == 3)
 222                 up_path = argv[2];
 223
 224         res = relative_url(remoteurl, url, up_path);
 225         puts(res);
 226         free(res);
 227         free(remoteurl);
 228         return 0;
 229 }
 230
 231 static int resolve_relative_url_test(int argc, const char **argv, const char *prefix)
 232 {
 233         char *remoteurl, *res;
 234         const char *up_path, *url;
 235
 236         if (argc != 4)
 237                 die("resolve-relative-url-test only accepts three arguments: <up_path> <remoteurl> <url>");
 238
 239         up_path = argv[1];
 240         remoteurl = xstrdup(argv[2]);
 241         url = argv[3];
 242
 243         if (!strcmp(up_path, "(null)"))
 244                 up_path = NULL;
 245
 246         res = relative_url(remoteurl, url, up_path);
 247         puts(res);
 248         free(res);
 249         free(remoteurl);
 250         return 0;
 251 }
 252
 253 /* the result should be freed by the caller. */
 254 static char *get_submodule_displaypath(const char *path, const char *prefix)
 255 {
 256         const char *super_prefix = get_super_prefix();
 257
 258         if (prefix && super_prefix) {
 259                 BUG("cannot have prefix '%s' and superprefix '%s'",
 260                     prefix, super_prefix);
 261         } else if (prefix) {
 262                 struct strbuf sb = STRBUF_INIT;
 263                 char *displaypath = xstrdup(relative_path(path, prefix, &sb));
 264                 strbuf_release(&sb);
 265                 return displaypath;
 266         } else if (super_prefix) {
 267                 return xstrfmt("%s%s", super_prefix, path);
 268         } else {
 269                 return xstrdup(path);
 270         }
 271 }
 272
 273 static char *compute_rev_name(const char *sub_path, const char* object_id)
 274 {
 275         struct strbuf sb = STRBUF_INIT;
 276         const char ***d;
 277
 278         static const char *describe_bare[] = { NULL };
 279
 280         static const char *describe_tags[] = { "--tags", NULL };
 281
 282         static const char *describe_contains[] = { "--contains", NULL };
 283
 284         static const char *describe_all_always[] = { "--all", "--always", NULL };
 285
 286         static const char **describe_argv[] = { describe_bare, describe_tags,
 287                                                 describe_contains,
 288                                                 describe_all_always, NULL };
 289
 290         for (d = describe_argv; *d; d++) {
 291                 struct child_process cp = CHILD_PROCESS_INIT;
 292                 prepare_submodule_repo_env(&cp.env_array);
 293                 cp.dir = sub_path;
 294                 cp.git_cmd = 1;
 295                 cp.no_stderr = 1;
 296
 297                 argv_array_push(&cp.args, "describe");
 298                 argv_array_pushv(&cp.args, *d);
 299                 argv_array_push(&cp.args, object_id);
 300
 301                 if (!capture_command(&cp, &sb, 0)) {
 302                         strbuf_strip_suffix(&sb, "\n");
 303                         return strbuf_detach(&sb, NULL);
 304                 }
 305         }
 306
 307         strbuf_release(&sb);
 308         return NULL;
 309 }
 310
 311 struct module_list {
 312         const struct cache_entry **entries;
 313         int alloc, nr;
 314 };
 315 #define MODULE_LIST_INIT { NULL, 0, 0 }
 316
 317 static int module_list_compute(int argc, const char **argv,
 318                                const char *prefix,
 319                                struct pathspec *pathspec,
 320                                struct module_list *list)
 321 {
 322         int i, result = 0;
 323         char *ps_matched = NULL;
 324         parse_pathspec(pathspec, 0,
 325                        PATHSPEC_PREFER_FULL,
 326                        prefix, argv);
 327
 328         if (pathspec->nr)
 329                 ps_matched = xcalloc(pathspec->nr, 1);
 330
 331         if (read_cache() < 0)
 332                 die(_("index file corrupt"));
 333
 334         for (i = 0; i < active_nr; i++) {
 335                 const struct cache_entry *ce = active_cache[i];
 336
 337                 if (!match_pathspec(&the_index, pathspec, ce->name, ce_namelen(ce),
 338                                     0, ps_matched, 1) ||
 339                     !S_ISGITLINK(ce->ce_mode))
 340                         continue;
 341
 342                 ALLOC_GROW(list->entries, list->nr + 1, list->alloc);
 343                 list->entries[list->nr++] = ce;
 344                 while (i + 1 < active_nr &&
 345                        !strcmp(ce->name, active_cache[i + 1]->name))
 346                         /*
 347                          * Skip entries with the same name in different stages
 348                          * to make sure an entry is returned only once.
 349                          */
 350                         i++;
 351         }
 352
 353         if (ps_matched && report_path_error(ps_matched, pathspec))
 354                 result = -1;
 355
 356         free(ps_matched);
 357
 358         return result;
 359 }
 360
 361 static void module_list_active(struct module_list *list)
 362 {
 363         int i;
 364         struct module_list active_modules = MODULE_LIST_INIT;
 365
 366         for (i = 0; i < list->nr; i++) {
 367                 const struct cache_entry *ce = list->entries[i];
 368
 369                 if (!is_submodule_active(the_repository, ce->name))
 370                         continue;
 371
 372                 ALLOC_GROW(active_modules.entries,
 373                            active_modules.nr + 1,
 374                            active_modules.alloc);
 375                 active_modules.entries[active_modules.nr++] = ce;
 376         }
 377
 378         free(list->entries);
 379         *list = active_modules;
 380 }
 381
 382 static char *get_up_path(const char *path)
 383 {
 384         int i;
 385         struct strbuf sb = STRBUF_INIT;
 386
 387         for (i = count_slashes(path); i; i--)
 388                 strbuf_addstr(&sb, "../");
 389
 390         /*
 391          * Check if 'path' ends with slash or not
 392          * for having the same output for dir/sub_dir
 393          * and dir/sub_dir/
 394          */
 395         if (!is_dir_sep(path[strlen(path) - 1]))
 396                 strbuf_addstr(&sb, "../");
 397
 398         return strbuf_detach(&sb, NULL);
 399 }
 400
 401 static int module_list(int argc, const char **argv, const char *prefix)
 402 {
 403         int i;
 404         struct pathspec pathspec;
 405         struct module_list list = MODULE_LIST_INIT;
 406
 407         struct option module_list_options[] = {
 408                 OPT_STRING(0, "prefix", &prefix,
 409                            N_("path"),
 410                            N_("alternative anchor for relative paths")),
 411                 OPT_END()
 412         };
 413
 414         const char *const git_submodule_helper_usage[] = {
 415                 N_("git submodule--helper list [--prefix=<path>] [<path>...]"),
 416                 NULL
 417         };
 418
 419         argc = parse_options(argc, argv, prefix, module_list_options,
 420                              git_submodule_helper_usage, 0);
 421
 422         if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
 423                 return 1;
 424
 425         for (i = 0; i < list.nr; i++) {
 426                 const struct cache_entry *ce = list.entries[i];
 427
 428                 if (ce_stage(ce))
 429                         printf("%06o %s U\t", ce->ce_mode, oid_to_hex(&null_oid));
 430                 else
 431                         printf("%06o %s %d\t", ce->ce_mode,
 432                                oid_to_hex(&ce->oid), ce_stage(ce));
 433
 434                 fprintf(stdout, "%s\n", ce->name);
 435         }
 436         return 0;
 437 }
 438
 439 static void for_each_listed_submodule(const struct module_list *list,
 440                                       each_submodule_fn fn, void *cb_data)
 441 {
 442         int i;
 443         for (i = 0; i < list->nr; i++)
 444                 fn(list->entries[i], cb_data);
 445 }
 446
 447 struct cb_foreach {
 448         int argc;
 449         const char **argv;
 450         const char *prefix;
 451         int quiet;
 452         int recursive;
 453 };
 454 #define CB_FOREACH_INIT { 0 }
 455
 456 static void runcommand_in_submodule_cb(const struct cache_entry *list_item,
 457                                        void *cb_data)
 458 {
 459         struct cb_foreach *info = cb_data;
 460         const char *path = list_item->name;
 461         const struct object_id *ce_oid = &list_item->oid;
 462
 463         const struct submodule *sub;
 464         struct child_process cp = CHILD_PROCESS_INIT;
 465         char *displaypath;
 466
 467         displaypath = get_submodule_displaypath(path, info->prefix);
 468
 469         sub = submodule_from_path(the_repository, &null_oid, path);
 470
 471         if (!sub)
 472                 die(_("No url found for submodule path '%s' in .gitmodules"),
 473                         displaypath);
 474
 475         if (!is_submodule_populated_gently(path, NULL))
 476                 goto cleanup;
 477
 478         prepare_submodule_repo_env(&cp.env_array);
 479
 480         /*
 481          * For the purpose of executing <command> in the submodule,
 482          * separate shell is used for the purpose of running the
 483          * child process.
 484          */
 485         cp.use_shell = 1;
 486         cp.dir = path;
 487
 488         /*
 489          * NEEDSWORK: the command currently has access to the variables $name,
 490          * $sm_path, $displaypath, $sha1 and $toplevel only when the command
 491          * contains a single argument. This is done for maintaining a faithful
 492          * translation from shell script.
 493          */
 494         if (info->argc == 1) {
 495                 char *toplevel = xgetcwd();
 496                 struct strbuf sb = STRBUF_INIT;
 497
 498                 argv_array_pushf(&cp.env_array, "name=%s", sub->name);
 499                 argv_array_pushf(&cp.env_array, "sm_path=%s", path);
 500                 argv_array_pushf(&cp.env_array, "displaypath=%s", displaypath);
 501                 argv_array_pushf(&cp.env_array, "sha1=%s",
 502                                 oid_to_hex(ce_oid));
 503                 argv_array_pushf(&cp.env_array, "toplevel=%s", toplevel);
 504
 505                 /*
 506                  * Since the path variable was accessible from the script
 507                  * before porting, it is also made available after porting.
 508                  * The environment variable "PATH" has a very special purpose
 509                  * on windows. And since environment variables are
 510                  * case-insensitive in windows, it interferes with the
 511                  * existing PATH variable. Hence, to avoid that, we expose
 512                  * path via the args argv_array and not via env_array.
 513                  */
 514                 sq_quote_buf(&sb, path);
 515                 argv_array_pushf(&cp.args, "path=%s; %s",
 516                                  sb.buf, info->argv[0]);
 517                 strbuf_release(&sb);
 518                 free(toplevel);
 519         } else {
 520                 argv_array_pushv(&cp.args, info->argv);
 521         }
 522
 523         if (!info->quiet)
 524                 printf(_("Entering '%s'\n"), displaypath);
 525
 526         if (info->argv[0] && run_command(&cp))
 527                 die(_("run_command returned non-zero status for %s\n."),
 528                         displaypath);
 529
 530         if (info->recursive) {
 531                 struct child_process cpr = CHILD_PROCESS_INIT;
 532
 533                 cpr.git_cmd = 1;
 534                 cpr.dir = path;
 535                 prepare_submodule_repo_env(&cpr.env_array);
 536
 537                 argv_array_pushl(&cpr.args, "--super-prefix", NULL);
 538                 argv_array_pushf(&cpr.args, "%s/", displaypath);
 539                 argv_array_pushl(&cpr.args, "submodule--helper", "foreach", "--recursive",
 540                                 NULL);
 541
 542                 if (info->quiet)
 543                         argv_array_push(&cpr.args, "--quiet");
 544
 545                 argv_array_push(&cpr.args, "--");
 546                 argv_array_pushv(&cpr.args, info->argv);
 547
 548                 if (run_command(&cpr))
 549                         die(_("run_command returned non-zero status while "
 550                                 "recursing in the nested submodules of %s\n."),
 551                                 displaypath);
 552         }
 553
 554 cleanup:
 555         free(displaypath);
 556 }
 557
 558 static int module_foreach(int argc, const char **argv, const char *prefix)
 559 {
 560         struct cb_foreach info = CB_FOREACH_INIT;
 561         struct pathspec pathspec;
 562         struct module_list list = MODULE_LIST_INIT;
 563
 564         struct option module_foreach_options[] = {
 565                 OPT__QUIET(&info.quiet, N_("Suppress output of entering each submodule command")),
 566                 OPT_BOOL(0, "recursive", &info.recursive,
 567                          N_("Recurse into nested submodules")),
 568                 OPT_END()
 569         };
 570
 571         const char *const git_submodule_helper_usage[] = {
 572                 N_("git submodule--helper foreach [--quiet] [--recursive] [--] <command>"),
 573                 NULL
 574         };
 575
 576         argc = parse_options(argc, argv, prefix, module_foreach_options,
 577                              git_submodule_helper_usage, 0);
 578
 579         if (module_list_compute(0, NULL, prefix, &pathspec, &list) < 0)
 580                 return 1;
 581
 582         info.argc = argc;
 583         info.argv = argv;
 584         info.prefix = prefix;
 585
 586         for_each_listed_submodule(&list, runcommand_in_submodule_cb, &info);
 587
 588         return 0;
 589 }
 590
 591 static char *compute_submodule_clone_url(const char *rel_url)
 592 {
 593         char *remoteurl, *relurl;
 594         char *remote = get_default_remote();
 595         struct strbuf remotesb = STRBUF_INIT;
 596
 597         strbuf_addf(&remotesb, "remote.%s.url", remote);
 598         if (git_config_get_string(remotesb.buf, &remoteurl)) {
 599                 warning(_("could not look up configuration '%s'. Assuming this repository is its own authoritative upstream."), remotesb.buf);
 600                 remoteurl = xgetcwd();
 601         }
 602         relurl = relative_url(remoteurl, rel_url, NULL);
 603
 604         free(remote);
 605         free(remoteurl);
 606         strbuf_release(&remotesb);
 607
 608         return relurl;
 609 }
 610
 611 struct init_cb {
 612         const char *prefix;
 613         unsigned int flags;
 614 };
 615
 616 #define INIT_CB_INIT { NULL, 0 }
 617
 618 static void init_submodule(const char *path, const char *prefix,
 619                            unsigned int flags)
 620 {
 621         const struct submodule *sub;
 622         struct strbuf sb = STRBUF_INIT;
 623         char *upd = NULL, *url = NULL, *displaypath;
 624
 625         displaypath = get_submodule_displaypath(path, prefix);
 626
 627         sub = submodule_from_path(the_repository, &null_oid, path);
 628
 629         if (!sub)
 630                 die(_("No url found for submodule path '%s' in .gitmodules"),
 631                         displaypath);
 632
 633         /*
 634          * NEEDSWORK: In a multi-working-tree world, this needs to be
 635          * set in the per-worktree config.
 636          *
 637          * Set active flag for the submodule being initialized
 638          */
 639         if (!is_submodule_active(the_repository, path)) {
 640                 strbuf_addf(&sb, "submodule.%s.active", sub->name);
 641                 git_config_set_gently(sb.buf, "true");
 642                 strbuf_reset(&sb);
 643         }
 644
 645         /*
 646          * Copy url setting when it is not set yet.
 647          * To look up the url in .git/config, we must not fall back to
 648          * .gitmodules, so look it up directly.
 649          */
 650         strbuf_addf(&sb, "submodule.%s.url", sub->name);
 651         if (git_config_get_string(sb.buf, &url)) {
 652                 if (!sub->url)
 653                         die(_("No url found for submodule path '%s' in .gitmodules"),
 654                                 displaypath);
 655
 656                 url = xstrdup(sub->url);
 657
 658                 /* Possibly a url relative to parent */
 659                 if (starts_with_dot_dot_slash(url) ||
 660                     starts_with_dot_slash(url)) {
 661                         char *oldurl = url;
 662                         url = compute_submodule_clone_url(oldurl);
 663                         free(oldurl);
 664                 }
 665
 666                 if (git_config_set_gently(sb.buf, url))
 667                         die(_("Failed to register url for submodule path '%s'"),
 668                             displaypath);
 669                 if (!(flags & OPT_QUIET))
 670                         fprintf(stderr,
 671                                 _("Submodule '%s' (%s) registered for path '%s'\n"),
 672                                 sub->name, url, displaypath);
 673         }
 674         strbuf_reset(&sb);
 675
 676         /* Copy "update" setting when it is not set yet */
 677         strbuf_addf(&sb, "submodule.%s.update", sub->name);
 678         if (git_config_get_string(sb.buf, &upd) &&
 679             sub->update_strategy.type != SM_UPDATE_UNSPECIFIED) {
 680                 if (sub->update_strategy.type == SM_UPDATE_COMMAND) {
 681                         fprintf(stderr, _("warning: command update mode suggested for submodule '%s'\n"),
 682                                 sub->name);
 683                         upd = xstrdup("none");
 684                 } else
 685                         upd = xstrdup(submodule_strategy_to_string(&sub->update_strategy));
 686
 687                 if (git_config_set_gently(sb.buf, upd))
 688                         die(_("Failed to register update mode for submodule path '%s'"), displaypath);
 689         }
 690         strbuf_release(&sb);
 691         free(displaypath);
 692         free(url);
 693         free(upd);
 694 }
 695
 696 static void init_submodule_cb(const struct cache_entry *list_item, void *cb_data)
 697 {
 698         struct init_cb *info = cb_data;
 699         init_submodule(list_item->name, info->prefix, info->flags);
 700 }
 701
 702 static int module_init(int argc, const char **argv, const char *prefix)
 703 {
 704         struct init_cb info = INIT_CB_INIT;
 705         struct pathspec pathspec;
 706         struct module_list list = MODULE_LIST_INIT;
 707         int quiet = 0;
 708
 709         struct option module_init_options[] = {
 710                 OPT__QUIET(&quiet, N_("Suppress output for initializing a submodule")),
 711                 OPT_END()
 712         };
 713
 714         const char *const git_submodule_helper_usage[] = {
 715                 N_("git submodule--helper init [<options>] [<path>]"),
 716                 NULL
 717         };
 718
 719         argc = parse_options(argc, argv, prefix, module_init_options,
 720                              git_submodule_helper_usage, 0);
 721
 722         if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
 723                 return 1;
 724
 725         /*
 726          * If there are no path args and submodule.active is set then,
 727          * by default, only initialize 'active' modules.
 728          */
 729         if (!argc && git_config_get_value_multi("submodule.active"))
 730                 module_list_active(&list);
 731
 732         info.prefix = prefix;
 733         if (quiet)
 734                 info.flags |= OPT_QUIET;
 735
 736         for_each_listed_submodule(&list, init_submodule_cb, &info);
 737
 738         return 0;
 739 }
 740
 741 struct status_cb {
 742         const char *prefix;
 743         unsigned int flags;
 744 };
 745
 746 #define STATUS_CB_INIT { NULL, 0 }
 747
 748 static void print_status(unsigned int flags, char state, const char *path,
 749                          const struct object_id *oid, const char *displaypath)
 750 {
 751         if (flags & OPT_QUIET)
 752                 return;
 753
 754         printf("%c%s %s", state, oid_to_hex(oid), displaypath);
 755
 756         if (state == ' ' || state == '+') {
 757                 const char *name = compute_rev_name(path, oid_to_hex(oid));
 758
 759                 if (name)
 760                         printf(" (%s)", name);
 761         }
 762
 763         printf("\n");
 764 }
 765
 766 static int handle_submodule_head_ref(const char *refname,
 767                                      const struct object_id *oid, int flags,
 768                                      void *cb_data)
 769 {
 770         struct object_id *output = cb_data;
 771         if (oid)
 772                 oidcpy(output, oid);
 773
 774         return 0;
 775 }
 776
 777 static void status_submodule(const char *path, const struct object_id *ce_oid,
 778                              unsigned int ce_flags, const char *prefix,
 779                              unsigned int flags)
 780 {
 781         char *displaypath;
 782         struct argv_array diff_files_args = ARGV_ARRAY_INIT;
 783         struct rev_info rev;
 784         int diff_files_result;
 785
 786         if (!submodule_from_path(the_repository, &null_oid, path))
 787                 die(_("no submodule mapping found in .gitmodules for path '%s'"),
 788                       path);
 789
 790         displaypath = get_submodule_displaypath(path, prefix);
 791
 792         if ((CE_STAGEMASK & ce_flags) >> CE_STAGESHIFT) {
 793                 print_status(flags, 'U', path, &null_oid, displaypath);
 794                 goto cleanup;
 795         }
 796
 797         if (!is_submodule_active(the_repository, path)) {
 798                 print_status(flags, '-', path, ce_oid, displaypath);
 799                 goto cleanup;
 800         }
 801
 802         argv_array_pushl(&diff_files_args, "diff-files",
 803                          "--ignore-submodules=dirty", "--quiet", "--",
 804                          path, NULL);
 805
 806         git_config(git_diff_basic_config, NULL);
 807
 808         repo_init_revisions(the_repository, &rev, NULL);
 809         rev.abbrev = 0;
 810         diff_files_args.argc = setup_revisions(diff_files_args.argc,
 811                                                diff_files_args.argv,
 812                                                &rev, NULL);
 813         diff_files_result = run_diff_files(&rev, 0);
 814
 815         if (!diff_result_code(&rev.diffopt, diff_files_result)) {
 816                 print_status(flags, ' ', path, ce_oid,
 817                              displaypath);
 818         } else if (!(flags & OPT_CACHED)) {
 819                 struct object_id oid;
 820                 struct ref_store *refs = get_submodule_ref_store(path);
 821
 822                 if (!refs) {
 823                         print_status(flags, '-', path, ce_oid, displaypath);
 824                         goto cleanup;
 825                 }
 826                 if (refs_head_ref(refs, handle_submodule_head_ref, &oid))
 827                         die(_("could not resolve HEAD ref inside the "
 828                               "submodule '%s'"), path);
 829
 830                 print_status(flags, '+', path, &oid, displaypath);
 831         } else {
 832                 print_status(flags, '+', path, ce_oid, displaypath);
 833         }
 834
 835         if (flags & OPT_RECURSIVE) {
 836                 struct child_process cpr = CHILD_PROCESS_INIT;
 837
 838                 cpr.git_cmd = 1;
 839                 cpr.dir = path;
 840                 prepare_submodule_repo_env(&cpr.env_array);
 841
 842                 argv_array_push(&cpr.args, "--super-prefix");
 843                 argv_array_pushf(&cpr.args, "%s/", displaypath);
 844                 argv_array_pushl(&cpr.args, "submodule--helper", "status",
 845                                  "--recursive", NULL);
 846
 847                 if (flags & OPT_CACHED)
 848                         argv_array_push(&cpr.args, "--cached");
 849
 850                 if (flags & OPT_QUIET)
 851                         argv_array_push(&cpr.args, "--quiet");
 852
 853                 if (run_command(&cpr))
 854                         die(_("failed to recurse into submodule '%s'"), path);
 855         }
 856
 857 cleanup:
 858         argv_array_clear(&diff_files_args);
 859         free(displaypath);
 860 }
 861
 862 static void status_submodule_cb(const struct cache_entry *list_item,
 863                                 void *cb_data)
 864 {
 865         struct status_cb *info = cb_data;
 866         status_submodule(list_item->name, &list_item->oid, list_item->ce_flags,
 867                          info->prefix, info->flags);
 868 }
 869
 870 static int module_status(int argc, const char **argv, const char *prefix)
 871 {
 872         struct status_cb info = STATUS_CB_INIT;
 873         struct pathspec pathspec;
 874         struct module_list list = MODULE_LIST_INIT;
 875         int quiet = 0;
 876
 877         struct option module_status_options[] = {
 878                 OPT__QUIET(&quiet, N_("Suppress submodule status output")),
 879                 OPT_BIT(0, "cached", &info.flags, N_("Use commit stored in the index instead of the one stored in the submodule HEAD"), OPT_CACHED),
 880                 OPT_BIT(0, "recursive", &info.flags, N_("recurse into nested submodules"), OPT_RECURSIVE),
 881                 OPT_END()
 882         };
 883
 884         const char *const git_submodule_helper_usage[] = {
 885                 N_("git submodule status [--quiet] [--cached] [--recursive] [<path>...]"),
 886                 NULL
 887         };
 888
 889         argc = parse_options(argc, argv, prefix, module_status_options,
 890                              git_submodule_helper_usage, 0);
 891
 892         if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
 893                 return 1;
 894
 895         info.prefix = prefix;
 896         if (quiet)
 897                 info.flags |= OPT_QUIET;
 898
 899         for_each_listed_submodule(&list, status_submodule_cb, &info);
 900
 901         return 0;
 902 }
 903
 904 static int module_name(int argc, const char **argv, const char *prefix)
 905 {
 906         const struct submodule *sub;
 907
 908         if (argc != 2)
 909                 usage(_("git submodule--helper name <path>"));
 910
 911         sub = submodule_from_path(the_repository, &null_oid, argv[1]);
 912
 913         if (!sub)
 914                 die(_("no submodule mapping found in .gitmodules for path '%s'"),
 915                     argv[1]);
 916
 917         printf("%s\n", sub->name);
 918
 919         return 0;
 920 }
 921
 922 struct sync_cb {
 923         const char *prefix;
 924         unsigned int flags;
 925 };
 926
 927 #define SYNC_CB_INIT { NULL, 0 }
 928
 929 static void sync_submodule(const char *path, const char *prefix,
 930                            unsigned int flags)
 931 {
 932         const struct submodule *sub;
 933         char *remote_key = NULL;
 934         char *sub_origin_url, *super_config_url, *displaypath;
 935         struct strbuf sb = STRBUF_INIT;
 936         struct child_process cp = CHILD_PROCESS_INIT;
 937         char *sub_config_path = NULL;
 938
 939         if (!is_submodule_active(the_repository, path))
 940                 return;
 941
 942         sub = submodule_from_path(the_repository, &null_oid, path);
 943
 944         if (sub && sub->url) {
 945                 if (starts_with_dot_dot_slash(sub->url) ||
 946                     starts_with_dot_slash(sub->url)) {
 947                         char *remote_url, *up_path;
 948                         char *remote = get_default_remote();
 949                         strbuf_addf(&sb, "remote.%s.url", remote);
 950
 951                         if (git_config_get_string(sb.buf, &remote_url))
 952                                 remote_url = xgetcwd();
 953
 954                         up_path = get_up_path(path);
 955                         sub_origin_url = relative_url(remote_url, sub->url, up_path);
 956                         super_config_url = relative_url(remote_url, sub->url, NULL);
 957
 958                         free(remote);
 959                         free(up_path);
 960                         free(remote_url);
 961                 } else {
 962                         sub_origin_url = xstrdup(sub->url);
 963                         super_config_url = xstrdup(sub->url);
 964                 }
 965         } else {
 966                 sub_origin_url = xstrdup("");
 967                 super_config_url = xstrdup("");
 968         }
 969
 970         displaypath = get_submodule_displaypath(path, prefix);
 971
 972         if (!(flags & OPT_QUIET))
 973                 printf(_("Synchronizing submodule url for '%s'\n"),
 974                          displaypath);
 975
 976         strbuf_reset(&sb);
 977         strbuf_addf(&sb, "submodule.%s.url", sub->name);
 978         if (git_config_set_gently(sb.buf, super_config_url))
 979                 die(_("failed to register url for submodule path '%s'"),
 980                       displaypath);
 981
 982         if (!is_submodule_populated_gently(path, NULL))
 983                 goto cleanup;
 984
 985         prepare_submodule_repo_env(&cp.env_array);
 986         cp.git_cmd = 1;
 987         cp.dir = path;
 988         argv_array_pushl(&cp.args, "submodule--helper",
 989                          "print-default-remote", NULL);
 990
 991         strbuf_reset(&sb);
 992         if (capture_command(&cp, &sb, 0))
 993                 die(_("failed to get the default remote for submodule '%s'"),
 994                       path);
 995
 996         strbuf_strip_suffix(&sb, "\n");
 997         remote_key = xstrfmt("remote.%s.url", sb.buf);
 998
 999         strbuf_reset(&sb);
1000         submodule_to_gitdir(&sb, path);
1001         strbuf_addstr(&sb, "/config");
1002
1003         if (git_config_set_in_file_gently(sb.buf, remote_key, sub_origin_url))
1004                 die(_("failed to update remote for submodule '%s'"),
1005                       path);
1006
1007         if (flags & OPT_RECURSIVE) {
1008                 struct child_process cpr = CHILD_PROCESS_INIT;
1009
1010                 cpr.git_cmd = 1;
1011                 cpr.dir = path;
1012                 prepare_submodule_repo_env(&cpr.env_array);
1013
1014                 argv_array_push(&cpr.args, "--super-prefix");
1015                 argv_array_pushf(&cpr.args, "%s/", displaypath);
1016                 argv_array_pushl(&cpr.args, "submodule--helper", "sync",
1017                                  "--recursive", NULL);
1018
1019                 if (flags & OPT_QUIET)
1020                         argv_array_push(&cpr.args, "--quiet");
1021
1022                 if (run_command(&cpr))
1023                         die(_("failed to recurse into submodule '%s'"),
1024                               path);
1025         }
1026
1027 cleanup:
1028         free(super_config_url);
1029         free(sub_origin_url);
1030         strbuf_release(&sb);
1031         free(remote_key);
1032         free(displaypath);
1033         free(sub_config_path);
1034 }
1035
1036 static void sync_submodule_cb(const struct cache_entry *list_item, void *cb_data)
1037 {
1038         struct sync_cb *info = cb_data;
1039         sync_submodule(list_item->name, info->prefix, info->flags);
1040 }
1041
1042 static int module_sync(int argc, const char **argv, const char *prefix)
1043 {
1044         struct sync_cb info = SYNC_CB_INIT;
1045         struct pathspec pathspec;
1046         struct module_list list = MODULE_LIST_INIT;
1047         int quiet = 0;
1048         int recursive = 0;
1049
1050         struct option module_sync_options[] = {
1051                 OPT__QUIET(&quiet, N_("Suppress output of synchronizing submodule url")),
1052                 OPT_BOOL(0, "recursive", &recursive,
1053                         N_("Recurse into nested submodules")),
1054                 OPT_END()
1055         };
1056
1057         const char *const git_submodule_helper_usage[] = {
1058                 N_("git submodule--helper sync [--quiet] [--recursive] [<path>]"),
1059                 NULL
1060         };
1061
1062         argc = parse_options(argc, argv, prefix, module_sync_options,
1063                              git_submodule_helper_usage, 0);
1064
1065         if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
1066                 return 1;
1067
1068         info.prefix = prefix;
1069         if (quiet)
1070                 info.flags |= OPT_QUIET;
1071         if (recursive)
1072                 info.flags |= OPT_RECURSIVE;
1073
1074         for_each_listed_submodule(&list, sync_submodule_cb, &info);
1075
1076         return 0;
1077 }
1078
1079 struct deinit_cb {
1080         const char *prefix;
1081         unsigned int flags;
1082 };
1083 #define DEINIT_CB_INIT { NULL, 0 }
1084
1085 static void deinit_submodule(const char *path, const char *prefix,
1086                              unsigned int flags)
1087 {
1088         const struct submodule *sub;
1089         char *displaypath = NULL;
1090         struct child_process cp_config = CHILD_PROCESS_INIT;
1091         struct strbuf sb_config = STRBUF_INIT;
1092         char *sub_git_dir = xstrfmt("%s/.git", path);
1093
1094         sub = submodule_from_path(the_repository, &null_oid, path);
1095
1096         if (!sub || !sub->name)
1097                 goto cleanup;
1098
1099         displaypath = get_submodule_displaypath(path, prefix);
1100
1101         /* remove the submodule work tree (unless the user already did it) */
1102         if (is_directory(path)) {
1103                 struct strbuf sb_rm = STRBUF_INIT;
1104                 const char *format;
1105
1106                 /*
1107                  * protect submodules containing a .git directory
1108                  * NEEDSWORK: instead of dying, automatically call
1109                  * absorbgitdirs and (possibly) warn.
1110                  */
1111                 if (is_directory(sub_git_dir))
1112                         die(_("Submodule work tree '%s' contains a .git "
1113                               "directory (use 'rm -rf' if you really want "
1114                               "to remove it including all of its history)"),
1115                             displaypath);
1116
1117                 if (!(flags & OPT_FORCE)) {
1118                         struct child_process cp_rm = CHILD_PROCESS_INIT;
1119                         cp_rm.git_cmd = 1;
1120                         argv_array_pushl(&cp_rm.args, "rm", "-qn",
1121                                          path, NULL);
1122
1123                         if (run_command(&cp_rm))
1124                                 die(_("Submodule work tree '%s' contains local "
1125                                       "modifications; use '-f' to discard them"),
1126                                       displaypath);
1127                 }
1128
1129                 strbuf_addstr(&sb_rm, path);
1130
1131                 if (!remove_dir_recursively(&sb_rm, 0))
1132                         format = _("Cleared directory '%s'\n");
1133                 else
1134                         format = _("Could not remove submodule work tree '%s'\n");
1135
1136                 if (!(flags & OPT_QUIET))
1137                         printf(format, displaypath);
1138
1139                 submodule_unset_core_worktree(sub);
1140
1141                 strbuf_release(&sb_rm);
1142         }
1143
1144         if (mkdir(path, 0777))
1145                 printf(_("could not create empty submodule directory %s"),
1146                       displaypath);
1147
1148         cp_config.git_cmd = 1;
1149         argv_array_pushl(&cp_config.args, "config", "--get-regexp", NULL);
1150         argv_array_pushf(&cp_config.args, "submodule.%s\\.", sub->name);
1151
1152         /* remove the .git/config entries (unless the user already did it) */
1153         if (!capture_command(&cp_config, &sb_config, 0) && sb_config.len) {
1154                 char *sub_key = xstrfmt("submodule.%s", sub->name);
1155                 /*
1156                  * remove the whole section so we have a clean state when
1157                  * the user later decides to init this submodule again
1158                  */
1159                 git_config_rename_section_in_file(NULL, sub_key, NULL);
1160                 if (!(flags & OPT_QUIET))
1161                         printf(_("Submodule '%s' (%s) unregistered for path '%s'\n"),
1162                                  sub->name, sub->url, displaypath);
1163                 free(sub_key);
1164         }
1165
1166 cleanup:
1167         free(displaypath);
1168         free(sub_git_dir);
1169         strbuf_release(&sb_config);
1170 }
1171
1172 static void deinit_submodule_cb(const struct cache_entry *list_item,
1173                                 void *cb_data)
1174 {
1175         struct deinit_cb *info = cb_data;
1176         deinit_submodule(list_item->name, info->prefix, info->flags);
1177 }
1178
1179 static int module_deinit(int argc, const char **argv, const char *prefix)
1180 {
1181         struct deinit_cb info = DEINIT_CB_INIT;
1182         struct pathspec pathspec;
1183         struct module_list list = MODULE_LIST_INIT;
1184         int quiet = 0;
1185         int force = 0;
1186         int all = 0;
1187
1188         struct option module_deinit_options[] = {
1189                 OPT__QUIET(&quiet, N_("Suppress submodule status output")),
1190                 OPT__FORCE(&force, N_("Remove submodule working trees even if they contain local changes"), 0),
1191                 OPT_BOOL(0, "all", &all, N_("Unregister all submodules")),
1192                 OPT_END()
1193         };
1194
1195         const char *const git_submodule_helper_usage[] = {
1196                 N_("git submodule deinit [--quiet] [-f | --force] [--all | [--] [<path>...]]"),
1197                 NULL
1198         };
1199
1200         argc = parse_options(argc, argv, prefix, module_deinit_options,
1201                              git_submodule_helper_usage, 0);
1202
1203         if (all && argc) {
1204                 error("pathspec and --all are incompatible");
1205                 usage_with_options(git_submodule_helper_usage,
1206                                    module_deinit_options);
1207         }
1208
1209         if (!argc && !all)
1210                 die(_("Use '--all' if you really want to deinitialize all submodules"));
1211
1212         if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
1213                 return 1;
1214
1215         info.prefix = prefix;
1216         if (quiet)
1217                 info.flags |= OPT_QUIET;
1218         if (force)
1219                 info.flags |= OPT_FORCE;
1220
1221         for_each_listed_submodule(&list, deinit_submodule_cb, &info);
1222
1223         return 0;
1224 }
1225
1226 static int clone_submodule(const char *path, const char *gitdir, const char *url,
1227                            const char *depth, struct string_list *reference, int dissociate,
1228                            int quiet, int progress, int single_branch)
1229 {
1230         struct child_process cp = CHILD_PROCESS_INIT;
1231
1232         argv_array_push(&cp.args, "clone");
1233         argv_array_push(&cp.args, "--no-checkout");
1234         if (quiet)
1235                 argv_array_push(&cp.args, "--quiet");
1236         if (progress)
1237                 argv_array_push(&cp.args, "--progress");
1238         if (depth && *depth)
1239                 argv_array_pushl(&cp.args, "--depth", depth, NULL);
1240         if (reference->nr) {
1241                 struct string_list_item *item;
1242                 for_each_string_list_item(item, reference)
1243                         argv_array_pushl(&cp.args, "--reference",
1244                                          item->string, NULL);
1245         }
1246         if (dissociate)
1247                 argv_array_push(&cp.args, "--dissociate");
1248         if (gitdir && *gitdir)
1249                 argv_array_pushl(&cp.args, "--separate-git-dir", gitdir, NULL);
1250         if (single_branch >= 0)
1251                 argv_array_push(&cp.args, single_branch ?
1252                                           "--single-branch" :
1253                                           "--no-single-branch");
1254
1255         argv_array_push(&cp.args, "--");
1256         argv_array_push(&cp.args, url);
1257         argv_array_push(&cp.args, path);
1258
1259         cp.git_cmd = 1;
1260         prepare_submodule_repo_env(&cp.env_array);
1261         cp.no_stdin = 1;
1262
1263         return run_command(&cp);
1264 }
1265
1266 struct submodule_alternate_setup {
1267         const char *submodule_name;
1268         enum SUBMODULE_ALTERNATE_ERROR_MODE {
1269                 SUBMODULE_ALTERNATE_ERROR_DIE,
1270                 SUBMODULE_ALTERNATE_ERROR_INFO,
1271                 SUBMODULE_ALTERNATE_ERROR_IGNORE
1272         } error_mode;
1273         struct string_list *reference;
1274 };
1275 #define SUBMODULE_ALTERNATE_SETUP_INIT { NULL, \
1276         SUBMODULE_ALTERNATE_ERROR_IGNORE, NULL }
1277
1278 static const char alternate_error_advice[] = N_(
1279 "An alternate computed from a superproject's alternate is invalid.\n"
1280 "To allow Git to clone without an alternate in such a case, set\n"
1281 "submodule.alternateErrorStrategy to 'info' or, equivalently, clone with\n"
1282 "'--reference-if-able' instead of '--reference'."
1283 );
1284
1285 static int add_possible_reference_from_superproject(
1286                 struct object_directory *odb, void *sas_cb)
1287 {
1288         struct submodule_alternate_setup *sas = sas_cb;
1289         size_t len;
1290
1291         /*
1292          * If the alternate object store is another repository, try the
1293          * standard layout with .git/(modules/<name>)+/objects
1294          */
1295         if (strip_suffix(odb->path, "/objects", &len)) {
1296                 char *sm_alternate;
1297                 struct strbuf sb = STRBUF_INIT;
1298                 struct strbuf err = STRBUF_INIT;
1299                 strbuf_add(&sb, odb->path, len);
1300
1301                 /*
1302                  * We need to end the new path with '/' to mark it as a dir,
1303                  * otherwise a submodule name containing '/' will be broken
1304                  * as the last part of a missing submodule reference would
1305                  * be taken as a file name.
1306                  */
1307                 strbuf_addf(&sb, "/modules/%s/", sas->submodule_name);
1308
1309                 sm_alternate = compute_alternate_path(sb.buf, &err);
1310                 if (sm_alternate) {
1311                         string_list_append(sas->reference, xstrdup(sb.buf));
1312                         free(sm_alternate);
1313                 } else {
1314                         switch (sas->error_mode) {
1315                         case SUBMODULE_ALTERNATE_ERROR_DIE:
1316                                 if (advice_submodule_alternate_error_strategy_die)
1317                                         advise(_(alternate_error_advice));
1318                                 die(_("submodule '%s' cannot add alternate: %s"),
1319                                     sas->submodule_name, err.buf);
1320                         case SUBMODULE_ALTERNATE_ERROR_INFO:
1321                                 fprintf_ln(stderr, _("submodule '%s' cannot add alternate: %s"),
1322                                         sas->submodule_name, err.buf);
1323                         case SUBMODULE_ALTERNATE_ERROR_IGNORE:
1324                                 ; /* nothing */
1325                         }
1326                 }
1327                 strbuf_release(&sb);
1328         }
1329
1330         return 0;
1331 }
1332
1333 static void prepare_possible_alternates(const char *sm_name,
1334                 struct string_list *reference)
1335 {
1336         char *sm_alternate = NULL, *error_strategy = NULL;
1337         struct submodule_alternate_setup sas = SUBMODULE_ALTERNATE_SETUP_INIT;
1338
1339         git_config_get_string("submodule.alternateLocation", &sm_alternate);
1340         if (!sm_alternate)
1341                 return;
1342
1343         git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
1344
1345         if (!error_strategy)
1346                 error_strategy = xstrdup("die");
1347
1348         sas.submodule_name = sm_name;
1349         sas.reference = reference;
1350         if (!strcmp(error_strategy, "die"))
1351                 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_DIE;
1352         else if (!strcmp(error_strategy, "info"))
1353                 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_INFO;
1354         else if (!strcmp(error_strategy, "ignore"))
1355                 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_IGNORE;
1356         else
1357                 die(_("Value '%s' for submodule.alternateErrorStrategy is not recognized"), error_strategy);
1358
1359         if (!strcmp(sm_alternate, "superproject"))
1360                 foreach_alt_odb(add_possible_reference_from_superproject, &sas);
1361         else if (!strcmp(sm_alternate, "no"))
1362                 ; /* do nothing */
1363         else
1364                 die(_("Value '%s' for submodule.alternateLocation is not recognized"), sm_alternate);
1365
1366         free(sm_alternate);
1367         free(error_strategy);
1368 }
1369
1370 static int module_clone(int argc, const char **argv, const char *prefix)
1371 {
1372         const char *name = NULL, *url = NULL, *depth = NULL;
1373         int quiet = 0;
1374         int progress = 0;
1375         char *p, *path = NULL, *sm_gitdir;
1376         struct strbuf sb = STRBUF_INIT;
1377         struct string_list reference = STRING_LIST_INIT_NODUP;
1378         int dissociate = 0, require_init = 0;
1379         char *sm_alternate = NULL, *error_strategy = NULL;
1380         int single_branch = -1;
1381
1382         struct option module_clone_options[] = {
1383                 OPT_STRING(0, "prefix", &prefix,
1384                            N_("path"),
1385                            N_("alternative anchor for relative paths")),
1386                 OPT_STRING(0, "path", &path,
1387                            N_("path"),
1388                            N_("where the new submodule will be cloned to")),
1389                 OPT_STRING(0, "name", &name,
1390                            N_("string"),
1391                            N_("name of the new submodule")),
1392                 OPT_STRING(0, "url", &url,
1393                            N_("string"),
1394                            N_("url where to clone the submodule from")),
1395                 OPT_STRING_LIST(0, "reference", &reference,
1396                            N_("repo"),
1397                            N_("reference repository")),
1398                 OPT_BOOL(0, "dissociate", &dissociate,
1399                            N_("use --reference only while cloning")),
1400                 OPT_STRING(0, "depth", &depth,
1401                            N_("string"),
1402                            N_("depth for shallow clones")),
1403                 OPT__QUIET(&quiet, "Suppress output for cloning a submodule"),
1404                 OPT_BOOL(0, "progress", &progress,
1405                            N_("force cloning progress")),
1406                 OPT_BOOL(0, "require-init", &require_init,
1407                            N_("disallow cloning into non-empty directory")),
1408                 OPT_BOOL(0, "single-branch", &single_branch,
1409                          N_("clone only one branch, HEAD or --branch")),
1410                 OPT_END()
1411         };
1412
1413         const char *const git_submodule_helper_usage[] = {
1414                 N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
1415                    "[--reference <repository>] [--name <name>] [--depth <depth>] "
1416                    "[--single-branch] "
1417                    "--url <url> --path <path>"),
1418                 NULL
1419         };
1420
1421         argc = parse_options(argc, argv, prefix, module_clone_options,
1422                              git_submodule_helper_usage, 0);
1423
1424         if (argc || !url || !path || !*path)
1425                 usage_with_options(git_submodule_helper_usage,
1426                                    module_clone_options);
1427
1428         strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), name);
1429         sm_gitdir = absolute_pathdup(sb.buf);
1430         strbuf_reset(&sb);
1431
1432         if (!is_absolute_path(path)) {
1433                 strbuf_addf(&sb, "%s/%s", get_git_work_tree(), path);
1434                 path = strbuf_detach(&sb, NULL);
1435         } else
1436                 path = xstrdup(path);
1437
1438         if (validate_submodule_git_dir(sm_gitdir, name) < 0)
1439                 die(_("refusing to create/use '%s' in another submodule's "
1440                         "git dir"), sm_gitdir);
1441
1442         if (!file_exists(sm_gitdir)) {
1443                 if (safe_create_leading_directories_const(sm_gitdir) < 0)
1444                         die(_("could not create directory '%s'"), sm_gitdir);
1445
1446                 prepare_possible_alternates(name, &reference);
1447
1448                 if (clone_submodule(path, sm_gitdir, url, depth, &reference, dissociate,
1449                                     quiet, progress, single_branch))
1450                         die(_("clone of '%s' into submodule path '%s' failed"),
1451                             url, path);
1452         } else {
1453                 if (require_init && !access(path, X_OK) && !is_empty_dir(path))
1454                         die(_("directory not empty: '%s'"), path);
1455                 if (safe_create_leading_directories_const(path) < 0)
1456                         die(_("could not create directory '%s'"), path);
1457                 strbuf_addf(&sb, "%s/index", sm_gitdir);
1458                 unlink_or_warn(sb.buf);
1459                 strbuf_reset(&sb);
1460         }
1461
1462         connect_work_tree_and_git_dir(path, sm_gitdir, 0);
1463
1464         p = git_pathdup_submodule(path, "config");
1465         if (!p)
1466                 die(_("could not get submodule directory for '%s'"), path);
1467
1468         /* setup alternateLocation and alternateErrorStrategy in the cloned submodule if needed */
1469         git_config_get_string("submodule.alternateLocation", &sm_alternate);
1470         if (sm_alternate)
1471                 git_config_set_in_file(p, "submodule.alternateLocation",
1472                                            sm_alternate);
1473         git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
1474         if (error_strategy)
1475                 git_config_set_in_file(p, "submodule.alternateErrorStrategy",
1476                                            error_strategy);
1477
1478         free(sm_alternate);
1479         free(error_strategy);
1480
1481         strbuf_release(&sb);
1482         free(sm_gitdir);
1483         free(path);
1484         free(p);
1485         return 0;
1486 }
1487
1488 static void determine_submodule_update_strategy(struct repository *r,
1489                                                 int just_cloned,
1490                                                 const char *path,
1491                                                 const char *update,
1492                                                 struct submodule_update_strategy *out)
1493 {
1494         const struct submodule *sub = submodule_from_path(r, &null_oid, path);
1495         char *key;
1496         const char *val;
1497
1498         key = xstrfmt("submodule.%s.update", sub->name);
1499
1500         if (update) {
1501                 if (parse_submodule_update_strategy(update, out) < 0)
1502                         die(_("Invalid update mode '%s' for submodule path '%s'"),
1503                                 update, path);
1504         } else if (!repo_config_get_string_const(r, key, &val)) {
1505                 if (parse_submodule_update_strategy(val, out) < 0)
1506                         die(_("Invalid update mode '%s' configured for submodule path '%s'"),
1507                                 val, path);
1508         } else if (sub->update_strategy.type != SM_UPDATE_UNSPECIFIED) {
1509                 if (sub->update_strategy.type == SM_UPDATE_COMMAND)
1510                         BUG("how did we read update = !command from .gitmodules?");
1511                 out->type = sub->update_strategy.type;
1512                 out->command = sub->update_strategy.command;
1513         } else
1514                 out->type = SM_UPDATE_CHECKOUT;
1515
1516         if (just_cloned &&
1517             (out->type == SM_UPDATE_MERGE ||
1518              out->type == SM_UPDATE_REBASE ||
1519              out->type == SM_UPDATE_NONE))
1520                 out->type = SM_UPDATE_CHECKOUT;
1521
1522         free(key);
1523 }
1524
1525 static int module_update_module_mode(int argc, const char **argv, const char *prefix)
1526 {
1527         const char *path, *update = NULL;
1528         int just_cloned;
1529         struct submodule_update_strategy update_strategy = { .type = SM_UPDATE_CHECKOUT };
1530
1531         if (argc < 3 || argc > 4)
1532                 die("submodule--helper update-module-clone expects <just-cloned> <path> [<update>]");
1533
1534         just_cloned = git_config_int("just_cloned", argv[1]);
1535         path = argv[2];
1536
1537         if (argc == 4)
1538                 update = argv[3];
1539
1540         determine_submodule_update_strategy(the_repository,
1541                                             just_cloned, path, update,
1542                                             &update_strategy);
1543         fputs(submodule_strategy_to_string(&update_strategy), stdout);
1544
1545         return 0;
1546 }
1547
1548 struct update_clone_data {
1549         const struct submodule *sub;
1550         struct object_id oid;
1551         unsigned just_cloned;
1552 };
1553
1554 struct submodule_update_clone {
1555         /* index into 'list', the list of submodules to look into for cloning */
1556         int current;
1557         struct module_list list;
1558         unsigned warn_if_uninitialized : 1;
1559
1560         /* update parameter passed via commandline */
1561         struct submodule_update_strategy update;
1562
1563         /* configuration parameters which are passed on to the children */
1564         int progress;
1565         int quiet;
1566         int recommend_shallow;
1567         struct string_list references;
1568         int dissociate;
1569         unsigned require_init;
1570         const char *depth;
1571         const char *recursive_prefix;
1572         const char *prefix;
1573         int single_branch;
1574
1575         /* to be consumed by git-submodule.sh */
1576         struct update_clone_data *update_clone;
1577         int update_clone_nr; int update_clone_alloc;
1578
1579         /* If we want to stop as fast as possible and return an error */
1580         unsigned quickstop : 1;
1581
1582         /* failed clones to be retried again */
1583         const struct cache_entry **failed_clones;
1584         int failed_clones_nr, failed_clones_alloc;
1585
1586         int max_jobs;
1587 };
1588 #define SUBMODULE_UPDATE_CLONE_INIT { \
1589         .list = MODULE_LIST_INIT, \
1590         .update = SUBMODULE_UPDATE_STRATEGY_INIT, \
1591         .recommend_shallow = -1, \
1592         .references = STRING_LIST_INIT_DUP, \
1593         .single_branch = -1, \
1594         .max_jobs = 1, \
1595 }
1596
1597
1598 static void next_submodule_warn_missing(struct submodule_update_clone *suc,
1599                 struct strbuf *out, const char *displaypath)
1600 {
1601         /*
1602          * Only mention uninitialized submodules when their
1603          * paths have been specified.
1604          */
1605         if (suc->warn_if_uninitialized) {
1606                 strbuf_addf(out,
1607                         _("Submodule path '%s' not initialized"),
1608                         displaypath);
1609                 strbuf_addch(out, '\n');
1610                 strbuf_addstr(out,
1611                         _("Maybe you want to use 'update --init'?"));
1612                 strbuf_addch(out, '\n');
1613         }
1614 }
1615
1616 /**
1617  * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
1618  * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
1619  */
1620 static int prepare_to_clone_next_submodule(const struct cache_entry *ce,
1621                                            struct child_process *child,
1622                                            struct submodule_update_clone *suc,
1623                                            struct strbuf *out)
1624 {
1625         const struct submodule *sub = NULL;
1626         const char *url = NULL;
1627         const char *update_string;
1628         enum submodule_update_type update_type;
1629         char *key;
1630         struct strbuf displaypath_sb = STRBUF_INIT;
1631         struct strbuf sb = STRBUF_INIT;
1632         const char *displaypath = NULL;
1633         int needs_cloning = 0;
1634         int need_free_url = 0;
1635
1636         if (ce_stage(ce)) {
1637                 if (suc->recursive_prefix)
1638                         strbuf_addf(&sb, "%s/%s", suc->recursive_prefix, ce->name);
1639                 else
1640                         strbuf_addstr(&sb, ce->name);
1641                 strbuf_addf(out, _("Skipping unmerged submodule %s"), sb.buf);
1642                 strbuf_addch(out, '\n');
1643                 goto cleanup;
1644         }
1645
1646         sub = submodule_from_path(the_repository, &null_oid, ce->name);
1647
1648         if (suc->recursive_prefix)
1649                 displaypath = relative_path(suc->recursive_prefix,
1650                                             ce->name, &displaypath_sb);
1651         else
1652                 displaypath = ce->name;
1653
1654         if (!sub) {
1655                 next_submodule_warn_missing(suc, out, displaypath);
1656                 goto cleanup;
1657         }
1658
1659         key = xstrfmt("submodule.%s.update", sub->name);
1660         if (!repo_config_get_string_const(the_repository, key, &update_string)) {
1661                 update_type = parse_submodule_update_type(update_string);
1662         } else {
1663                 update_type = sub->update_strategy.type;
1664         }
1665         free(key);
1666
1667         if (suc->update.type == SM_UPDATE_NONE
1668             || (suc->update.type == SM_UPDATE_UNSPECIFIED
1669                 && update_type == SM_UPDATE_NONE)) {
1670                 strbuf_addf(out, _("Skipping submodule '%s'"), displaypath);
1671                 strbuf_addch(out, '\n');
1672                 goto cleanup;
1673         }
1674
1675         /* Check if the submodule has been initialized. */
1676         if (!is_submodule_active(the_repository, ce->name)) {
1677                 next_submodule_warn_missing(suc, out, displaypath);
1678                 goto cleanup;
1679         }
1680
1681         strbuf_reset(&sb);
1682         strbuf_addf(&sb, "submodule.%s.url", sub->name);
1683         if (repo_config_get_string_const(the_repository, sb.buf, &url)) {
1684                 if (starts_with_dot_slash(sub->url) ||
1685                     starts_with_dot_dot_slash(sub->url)) {
1686                         url = compute_submodule_clone_url(sub->url);
1687                         need_free_url = 1;
1688                 } else
1689                         url = sub->url;
1690         }
1691
1692         strbuf_reset(&sb);
1693         strbuf_addf(&sb, "%s/.git", ce->name);
1694         needs_cloning = !file_exists(sb.buf);
1695
1696         ALLOC_GROW(suc->update_clone, suc->update_clone_nr + 1,
1697                    suc->update_clone_alloc);
1698         oidcpy(&suc->update_clone[suc->update_clone_nr].oid, &ce->oid);
1699         suc->update_clone[suc->update_clone_nr].just_cloned = needs_cloning;
1700         suc->update_clone[suc->update_clone_nr].sub = sub;
1701         suc->update_clone_nr++;
1702
1703         if (!needs_cloning)
1704                 goto cleanup;
1705
1706         child->git_cmd = 1;
1707         child->no_stdin = 1;
1708         child->stdout_to_stderr = 1;
1709         child->err = -1;
1710         argv_array_push(&child->args, "submodule--helper");
1711         argv_array_push(&child->args, "clone");
1712         if (suc->progress)
1713                 argv_array_push(&child->args, "--progress");
1714         if (suc->quiet)
1715                 argv_array_push(&child->args, "--quiet");
1716         if (suc->prefix)
1717                 argv_array_pushl(&child->args, "--prefix", suc->prefix, NULL);
1718         if (suc->recommend_shallow && sub->recommend_shallow == 1)
1719                 argv_array_push(&child->args, "--depth=1");
1720         if (suc->require_init)
1721                 argv_array_push(&child->args, "--require-init");
1722         argv_array_pushl(&child->args, "--path", sub->path, NULL);
1723         argv_array_pushl(&child->args, "--name", sub->name, NULL);
1724         argv_array_pushl(&child->args, "--url", url, NULL);
1725         if (suc->references.nr) {
1726                 struct string_list_item *item;
1727                 for_each_string_list_item(item, &suc->references)
1728                         argv_array_pushl(&child->args, "--reference", item->string, NULL);
1729         }
1730         if (suc->dissociate)
1731                 argv_array_push(&child->args, "--dissociate");
1732         if (suc->depth)
1733                 argv_array_push(&child->args, suc->depth);
1734         if (suc->single_branch >= 0)
1735                 argv_array_push(&child->args, suc->single_branch ?
1736                                               "--single-branch" :
1737                                               "--no-single-branch");
1738
1739 cleanup:
1740         strbuf_reset(&displaypath_sb);
1741         strbuf_reset(&sb);
1742         if (need_free_url)
1743                 free((void*)url);
1744
1745         return needs_cloning;
1746 }
1747
1748 static int update_clone_get_next_task(struct child_process *child,
1749                                       struct strbuf *err,
1750                                       void *suc_cb,
1751                                       void **idx_task_cb)
1752 {
1753         struct submodule_update_clone *suc = suc_cb;
1754         const struct cache_entry *ce;
1755         int index;
1756
1757         for (; suc->current < suc->list.nr; suc->current++) {
1758                 ce = suc->list.entries[suc->current];
1759                 if (prepare_to_clone_next_submodule(ce, child, suc, err)) {
1760                         int *p = xmalloc(sizeof(*p));
1761                         *p = suc->current;
1762                         *idx_task_cb = p;
1763                         suc->current++;
1764                         return 1;
1765                 }
1766         }
1767
1768         /*
1769          * The loop above tried cloning each submodule once, now try the
1770          * stragglers again, which we can imagine as an extension of the
1771          * entry list.
1772          */
1773         index = suc->current - suc->list.nr;
1774         if (index < suc->failed_clones_nr) {
1775                 int *p;
1776                 ce = suc->failed_clones[index];
1777                 if (!prepare_to_clone_next_submodule(ce, child, suc, err)) {
1778                         suc->current ++;
1779                         strbuf_addstr(err, "BUG: submodule considered for "
1780                                            "cloning, doesn't need cloning "
1781                                            "any more?\n");
1782                         return 0;
1783                 }
1784                 p = xmalloc(sizeof(*p));
1785                 *p = suc->current;
1786                 *idx_task_cb = p;
1787                 suc->current ++;
1788                 return 1;
1789         }
1790
1791         return 0;
1792 }
1793
1794 static int update_clone_start_failure(struct strbuf *err,
1795                                       void *suc_cb,
1796                                       void *idx_task_cb)
1797 {
1798         struct submodule_update_clone *suc = suc_cb;
1799         suc->quickstop = 1;
1800         return 1;
1801 }
1802
1803 static int update_clone_task_finished(int result,
1804                                       struct strbuf *err,
1805                                       void *suc_cb,
1806                                       void *idx_task_cb)
1807 {
1808         const struct cache_entry *ce;
1809         struct submodule_update_clone *suc = suc_cb;
1810
1811         int *idxP = idx_task_cb;
1812         int idx = *idxP;
1813         free(idxP);
1814
1815         if (!result)
1816                 return 0;
1817
1818         if (idx < suc->list.nr) {
1819                 ce  = suc->list.entries[idx];
1820                 strbuf_addf(err, _("Failed to clone '%s'. Retry scheduled"),
1821                             ce->name);
1822                 strbuf_addch(err, '\n');
1823                 ALLOC_GROW(suc->failed_clones,
1824                            suc->failed_clones_nr + 1,
1825                            suc->failed_clones_alloc);
1826                 suc->failed_clones[suc->failed_clones_nr++] = ce;
1827                 return 0;
1828         } else {
1829                 idx -= suc->list.nr;
1830                 ce  = suc->failed_clones[idx];
1831                 strbuf_addf(err, _("Failed to clone '%s' a second time, aborting"),
1832                             ce->name);
1833                 strbuf_addch(err, '\n');
1834                 suc->quickstop = 1;
1835                 return 1;
1836         }
1837
1838         return 0;
1839 }
1840
1841 static int git_update_clone_config(const char *var, const char *value,
1842                                    void *cb)
1843 {
1844         int *max_jobs = cb;
1845         if (!strcmp(var, "submodule.fetchjobs"))
1846                 *max_jobs = parse_submodule_fetchjobs(var, value);
1847         return 0;
1848 }
1849
1850 static void update_submodule(struct update_clone_data *ucd)
1851 {
1852         fprintf(stdout, "dummy %s %d\t%s\n",
1853                 oid_to_hex(&ucd->oid),
1854                 ucd->just_cloned,
1855                 ucd->sub->path);
1856 }
1857
1858 static int update_submodules(struct submodule_update_clone *suc)
1859 {
1860         int i;
1861
1862         run_processes_parallel_tr2(suc->max_jobs, update_clone_get_next_task,
1863                                    update_clone_start_failure,
1864                                    update_clone_task_finished, suc, "submodule",
1865                                    "parallel/update");
1866
1867         /*
1868          * We saved the output and put it out all at once now.
1869          * That means:
1870          * - the listener does not have to interleave their (checkout)
1871          *   work with our fetching.  The writes involved in a
1872          *   checkout involve more straightforward sequential I/O.
1873          * - the listener can avoid doing any work if fetching failed.
1874          */
1875         if (suc->quickstop)
1876                 return 1;
1877
1878         for (i = 0; i < suc->update_clone_nr; i++)
1879                 update_submodule(&suc->update_clone[i]);
1880
1881         return 0;
1882 }
1883
1884 static int update_clone(int argc, const char **argv, const char *prefix)
1885 {
1886         const char *update = NULL;
1887         struct pathspec pathspec;
1888         struct submodule_update_clone suc = SUBMODULE_UPDATE_CLONE_INIT;
1889
1890         struct option module_update_clone_options[] = {
1891                 OPT_STRING(0, "prefix", &prefix,
1892                            N_("path"),
1893                            N_("path into the working tree")),
1894                 OPT_STRING(0, "recursive-prefix", &suc.recursive_prefix,
1895                            N_("path"),
1896                            N_("path into the working tree, across nested "
1897                               "submodule boundaries")),
1898                 OPT_STRING(0, "update", &update,
1899                            N_("string"),
1900                            N_("rebase, merge, checkout or none")),
1901                 OPT_STRING_LIST(0, "reference", &suc.references, N_("repo"),
1902                            N_("reference repository")),
1903                 OPT_BOOL(0, "dissociate", &suc.dissociate,
1904                            N_("use --reference only while cloning")),
1905                 OPT_STRING(0, "depth", &suc.depth, "<depth>",
1906                            N_("Create a shallow clone truncated to the "
1907                               "specified number of revisions")),
1908                 OPT_INTEGER('j', "jobs", &suc.max_jobs,
1909                             N_("parallel jobs")),
1910                 OPT_BOOL(0, "recommend-shallow", &suc.recommend_shallow,
1911                             N_("whether the initial clone should follow the shallow recommendation")),
1912                 OPT__QUIET(&suc.quiet, N_("don't print cloning progress")),
1913                 OPT_BOOL(0, "progress", &suc.progress,
1914                             N_("force cloning progress")),
1915                 OPT_BOOL(0, "require-init", &suc.require_init,
1916                            N_("disallow cloning into non-empty directory")),
1917                 OPT_BOOL(0, "single-branch", &suc.single_branch,
1918                          N_("clone only one branch, HEAD or --branch")),
1919                 OPT_END()
1920         };
1921
1922         const char *const git_submodule_helper_usage[] = {
1923                 N_("git submodule--helper update-clone [--prefix=<path>] [<path>...]"),
1924                 NULL
1925         };
1926         suc.prefix = prefix;
1927
1928         update_clone_config_from_gitmodules(&suc.max_jobs);
1929         git_config(git_update_clone_config, &suc.max_jobs);
1930
1931         argc = parse_options(argc, argv, prefix, module_update_clone_options,
1932                              git_submodule_helper_usage, 0);
1933
1934         if (update)
1935                 if (parse_submodule_update_strategy(update, &suc.update) < 0)
1936                         die(_("bad value for update parameter"));
1937
1938         if (module_list_compute(argc, argv, prefix, &pathspec, &suc.list) < 0)
1939                 return 1;
1940
1941         if (pathspec.nr)
1942                 suc.warn_if_uninitialized = 1;
1943
1944         return update_submodules(&suc);
1945 }
1946
1947 static int resolve_relative_path(int argc, const char **argv, const char *prefix)
1948 {
1949         struct strbuf sb = STRBUF_INIT;
1950         if (argc != 3)
1951                 die("submodule--helper relative-path takes exactly 2 arguments, got %d", argc);
1952
1953         printf("%s", relative_path(argv[1], argv[2], &sb));
1954         strbuf_release(&sb);
1955         return 0;
1956 }
1957
1958 static const char *remote_submodule_branch(const char *path)
1959 {
1960         const struct submodule *sub;
1961         const char *branch = NULL;
1962         char *key;
1963
1964         sub = submodule_from_path(the_repository, &null_oid, path);
1965         if (!sub)
1966                 return NULL;
1967
1968         key = xstrfmt("submodule.%s.branch", sub->name);
1969         if (repo_config_get_string_const(the_repository, key, &branch))
1970                 branch = sub->branch;
1971         free(key);
1972
1973         if (!branch)
1974                 return "master";
1975
1976         if (!strcmp(branch, ".")) {
1977                 const char *refname = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
1978
1979                 if (!refname)
1980                         die(_("No such ref: %s"), "HEAD");
1981
1982                 /* detached HEAD */
1983                 if (!strcmp(refname, "HEAD"))
1984                         die(_("Submodule (%s) branch configured to inherit "
1985                               "branch from superproject, but the superproject "
1986                               "is not on any branch"), sub->name);
1987
1988                 if (!skip_prefix(refname, "refs/heads/", &refname))
1989                         die(_("Expecting a full ref name, got %s"), refname);
1990                 return refname;
1991         }
1992
1993         return branch;
1994 }
1995
1996 static int resolve_remote_submodule_branch(int argc, const char **argv,
1997                 const char *prefix)
1998 {
1999         const char *ret;
2000         struct strbuf sb = STRBUF_INIT;
2001         if (argc != 2)
2002                 die("submodule--helper remote-branch takes exactly one arguments, got %d", argc);
2003
2004         ret = remote_submodule_branch(argv[1]);
2005         if (!ret)
2006                 die("submodule %s doesn't exist", argv[1]);
2007
2008         printf("%s", ret);
2009         strbuf_release(&sb);
2010         return 0;
2011 }
2012
2013 static int push_check(int argc, const char **argv, const char *prefix)
2014 {
2015         struct remote *remote;
2016         const char *superproject_head;
2017         char *head;
2018         int detached_head = 0;
2019         struct object_id head_oid;
2020
2021         if (argc < 3)
2022                 die("submodule--helper push-check requires at least 2 arguments");
2023
2024         /*
2025          * superproject's resolved head ref.
2026          * if HEAD then the superproject is in a detached head state, otherwise
2027          * it will be the resolved head ref.
2028          */
2029         superproject_head = argv[1];
2030         argv++;
2031         argc--;
2032         /* Get the submodule's head ref and determine if it is detached */
2033         head = resolve_refdup("HEAD", 0, &head_oid, NULL);
2034         if (!head)
2035                 die(_("Failed to resolve HEAD as a valid ref."));
2036         if (!strcmp(head, "HEAD"))
2037                 detached_head = 1;
2038
2039         /*
2040          * The remote must be configured.
2041          * This is to avoid pushing to the exact same URL as the parent.
2042          */
2043         remote = pushremote_get(argv[1]);
2044         if (!remote || remote->origin == REMOTE_UNCONFIGURED)
2045                 die("remote '%s' not configured", argv[1]);
2046
2047         /* Check the refspec */
2048         if (argc > 2) {
2049                 int i;
2050                 struct ref *local_refs = get_local_heads();
2051                 struct refspec refspec = REFSPEC_INIT_PUSH;
2052
2053                 refspec_appendn(&refspec, argv + 2, argc - 2);
2054
2055                 for (i = 0; i < refspec.nr; i++) {
2056                         const struct refspec_item *rs = &refspec.items[i];
2057
2058                         if (rs->pattern || rs->matching)
2059                                 continue;
2060
2061                         /* LHS must match a single ref */
2062                         switch (count_refspec_match(rs->src, local_refs, NULL)) {
2063                         case 1:
2064                                 break;
2065                         case 0:
2066                                 /*
2067                                  * If LHS matches 'HEAD' then we need to ensure
2068                                  * that it matches the same named branch
2069                                  * checked out in the superproject.
2070                                  */
2071                                 if (!strcmp(rs->src, "HEAD")) {
2072                                         if (!detached_head &&
2073                                             !strcmp(head, superproject_head))
2074                                                 break;
2075                                         die("HEAD does not match the named branch in the superproject");
2076                                 }
2077                                 /* fallthrough */
2078                         default:
2079                                 die("src refspec '%s' must name a ref",
2080                                     rs->src);
2081                         }
2082                 }
2083                 refspec_clear(&refspec);
2084         }
2085         free(head);
2086
2087         return 0;
2088 }
2089
2090 static int ensure_core_worktree(int argc, const char **argv, const char *prefix)
2091 {
2092         const struct submodule *sub;
2093         const char *path;
2094         char *cw;
2095         struct repository subrepo;
2096
2097         if (argc != 2)
2098                 BUG("submodule--helper ensure-core-worktree <path>");
2099
2100         path = argv[1];
2101
2102         sub = submodule_from_path(the_repository, &null_oid, path);
2103         if (!sub)
2104                 BUG("We could get the submodule handle before?");
2105
2106         if (repo_submodule_init(&subrepo, the_repository, sub))
2107                 die(_("could not get a repository handle for submodule '%s'"), path);
2108
2109         if (!repo_config_get_string(&subrepo, "core.worktree", &cw)) {
2110                 char *cfg_file, *abs_path;
2111                 const char *rel_path;
2112                 struct strbuf sb = STRBUF_INIT;
2113
2114                 cfg_file = repo_git_path(&subrepo, "config");
2115
2116                 abs_path = absolute_pathdup(path);
2117                 rel_path = relative_path(abs_path, subrepo.gitdir, &sb);
2118
2119                 git_config_set_in_file(cfg_file, "core.worktree", rel_path);
2120
2121                 free(cfg_file);
2122                 free(abs_path);
2123                 strbuf_release(&sb);
2124         }
2125
2126         return 0;
2127 }
2128
2129 static int absorb_git_dirs(int argc, const char **argv, const char *prefix)
2130 {
2131         int i;
2132         struct pathspec pathspec;
2133         struct module_list list = MODULE_LIST_INIT;
2134         unsigned flags = ABSORB_GITDIR_RECURSE_SUBMODULES;
2135
2136         struct option embed_gitdir_options[] = {
2137                 OPT_STRING(0, "prefix", &prefix,
2138                            N_("path"),
2139                            N_("path into the working tree")),
2140                 OPT_BIT(0, "--recursive", &flags, N_("recurse into submodules"),
2141                         ABSORB_GITDIR_RECURSE_SUBMODULES),
2142                 OPT_END()
2143         };
2144
2145         const char *const git_submodule_helper_usage[] = {
2146                 N_("git submodule--helper absorb-git-dirs [<options>] [<path>...]"),
2147                 NULL
2148         };
2149
2150         argc = parse_options(argc, argv, prefix, embed_gitdir_options,
2151                              git_submodule_helper_usage, 0);
2152
2153         if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
2154                 return 1;
2155
2156         for (i = 0; i < list.nr; i++)
2157                 absorb_git_dir_into_superproject(list.entries[i]->name, flags);
2158
2159         return 0;
2160 }
2161
2162 static int is_active(int argc, const char **argv, const char *prefix)
2163 {
2164         if (argc != 2)
2165                 die("submodule--helper is-active takes exactly 1 argument");
2166
2167         return !is_submodule_active(the_repository, argv[1]);
2168 }
2169
2170 /*
2171  * Exit non-zero if any of the submodule names given on the command line is
2172  * invalid. If no names are given, filter stdin to print only valid names
2173  * (which is primarily intended for testing).
2174  */
2175 static int check_name(int argc, const char **argv, const char *prefix)
2176 {
2177         if (argc > 1) {
2178                 while (*++argv) {
2179                         if (check_submodule_name(*argv) < 0)
2180                                 return 1;
2181                 }
2182         } else {
2183                 struct strbuf buf = STRBUF_INIT;
2184                 while (strbuf_getline(&buf, stdin) != EOF) {
2185                         if (!check_submodule_name(buf.buf))
2186                                 printf("%s\n", buf.buf);
2187                 }
2188                 strbuf_release(&buf);
2189         }
2190         return 0;
2191 }
2192
2193 static int module_config(int argc, const char **argv, const char *prefix)
2194 {
2195         enum {
2196                 CHECK_WRITEABLE = 1,
2197                 DO_UNSET = 2
2198         } command = 0;
2199
2200         struct option module_config_options[] = {
2201                 OPT_CMDMODE(0, "check-writeable", &command,
2202                             N_("check if it is safe to write to the .gitmodules file"),
2203                             CHECK_WRITEABLE),
2204                 OPT_CMDMODE(0, "unset", &command,
2205                             N_("unset the config in the .gitmodules file"),
2206                             DO_UNSET),
2207                 OPT_END()
2208         };
2209         const char *const git_submodule_helper_usage[] = {
2210                 N_("git submodule--helper config <name> [<value>]"),
2211                 N_("git submodule--helper config --unset <name>"),
2212                 N_("git submodule--helper config --check-writeable"),
2213                 NULL
2214         };
2215
2216         argc = parse_options(argc, argv, prefix, module_config_options,
2217                              git_submodule_helper_usage, PARSE_OPT_KEEP_ARGV0);
2218
2219         if (argc == 1 && command == CHECK_WRITEABLE)
2220                 return is_writing_gitmodules_ok() ? 0 : -1;
2221
2222         /* Equivalent to ACTION_GET in builtin/config.c */
2223         if (argc == 2 && command != DO_UNSET)
2224                 return print_config_from_gitmodules(the_repository, argv[1]);
2225
2226         /* Equivalent to ACTION_SET in builtin/config.c */
2227         if (argc == 3 || (argc == 2 && command == DO_UNSET)) {
2228                 const char *value = (argc == 3) ? argv[2] : NULL;
2229
2230                 if (!is_writing_gitmodules_ok())
2231                         die(_("please make sure that the .gitmodules file is in the working tree"));
2232
2233                 return config_set_in_gitmodules_file_gently(argv[1], value);
2234         }
2235
2236         usage_with_options(git_submodule_helper_usage, module_config_options);
2237 }
2238
2239 #define SUPPORT_SUPER_PREFIX (1<<0)
2240
2241 struct cmd_struct {
2242         const char *cmd;
2243         int (*fn)(int, const char **, const char *);
2244         unsigned option;
2245 };
2246
2247 static struct cmd_struct commands[] = {
2248         {"list", module_list, 0},
2249         {"name", module_name, 0},
2250         {"clone", module_clone, 0},
2251         {"update-module-mode", module_update_module_mode, 0},
2252         {"update-clone", update_clone, 0},
2253         {"ensure-core-worktree", ensure_core_worktree, 0},
2254         {"relative-path", resolve_relative_path, 0},
2255         {"resolve-relative-url", resolve_relative_url, 0},
2256         {"resolve-relative-url-test", resolve_relative_url_test, 0},
2257         {"foreach", module_foreach, SUPPORT_SUPER_PREFIX},
2258         {"init", module_init, SUPPORT_SUPER_PREFIX},
2259         {"status", module_status, SUPPORT_SUPER_PREFIX},
2260         {"print-default-remote", print_default_remote, 0},
2261         {"sync", module_sync, SUPPORT_SUPER_PREFIX},
2262         {"deinit", module_deinit, 0},
2263         {"remote-branch", resolve_remote_submodule_branch, 0},
2264         {"push-check", push_check, 0},
2265         {"absorb-git-dirs", absorb_git_dirs, SUPPORT_SUPER_PREFIX},
2266         {"is-active", is_active, 0},
2267         {"check-name", check_name, 0},
2268         {"config", module_config, 0},
2269 };
2270
2271 int cmd_submodule__helper(int argc, const char **argv, const char *prefix)
2272 {
2273         int i;
2274         if (argc < 2 || !strcmp(argv[1], "-h"))
2275                 usage("git submodule--helper <command>");
2276
2277         for (i = 0; i < ARRAY_SIZE(commands); i++) {
2278                 if (!strcmp(argv[1], commands[i].cmd)) {
2279                         if (get_super_prefix() &&
2280                             !(commands[i].option & SUPPORT_SUPER_PREFIX))
2281                                 die(_("%s doesn't support --super-prefix"),
2282                                     commands[i].cmd);
2283                         return commands[i].fn(argc - 1, argv + 1, prefix);
2284                 }
2285         }
2286
2287         die(_("'%s' is not a valid submodule--helper "
2288               "subcommand"), argv[1]);
2289 }