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