Andrew's git - gitweb.git/blob

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