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