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