builtin/submodule--helper.c

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