Andrew's git - gitweb.git/blob - builtin/submodule--helper.c

   1#include "builtin.h"
   2#include "cache.h"
   3#include "parse-options.h"
   4#include "quote.h"
   5#include "pathspec.h"
   6#include "dir.h"
   7#include "utf8.h"
   8#include "submodule.h"
   9#include "submodule-config.h"
  10#include "string-list.h"
  11#include "run-command.h"
  12
  13struct module_list {
  14        const struct cache_entry **entries;
  15        int alloc, nr;
  16};
  17#define MODULE_LIST_INIT { NULL, 0, 0 }
  18
  19static int module_list_compute(int argc, const char **argv,
  20                               const char *prefix,
  21                               struct pathspec *pathspec,
  22                               struct module_list *list)
  23{
  24        int i, result = 0;
  25        char *ps_matched = NULL;
  26        parse_pathspec(pathspec, 0,
  27                       PATHSPEC_PREFER_FULL |
  28                       PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP,
  29                       prefix, argv);
  30
  31        if (pathspec->nr)
  32                ps_matched = xcalloc(pathspec->nr, 1);
  33
  34        if (read_cache() < 0)
  35                die(_("index file corrupt"));
  36
  37        for (i = 0; i < active_nr; i++) {
  38                const struct cache_entry *ce = active_cache[i];
  39
  40                if (!match_pathspec(pathspec, ce->name, ce_namelen(ce),
  41                                    0, ps_matched, 1) ||
  42                    !S_ISGITLINK(ce->ce_mode))
  43                        continue;
  44
  45                ALLOC_GROW(list->entries, list->nr + 1, list->alloc);
  46                list->entries[list->nr++] = ce;
  47                while (i + 1 < active_nr &&
  48                       !strcmp(ce->name, active_cache[i + 1]->name))
  49                        /*
  50                         * Skip entries with the same name in different stages
  51                         * to make sure an entry is returned only once.
  52                         */
  53                        i++;
  54        }
  55
  56        if (ps_matched && report_path_error(ps_matched, pathspec, prefix))
  57                result = -1;
  58
  59        free(ps_matched);
  60
  61        return result;
  62}
  63
  64static int module_list(int argc, const char **argv, const char *prefix)
  65{
  66        int i;
  67        struct pathspec pathspec;
  68        struct module_list list = MODULE_LIST_INIT;
  69
  70        struct option module_list_options[] = {
  71                OPT_STRING(0, "prefix", &prefix,
  72                           N_("path"),
  73                           N_("alternative anchor for relative paths")),
  74                OPT_END()
  75        };
  76
  77        const char *const git_submodule_helper_usage[] = {
  78                N_("git submodule--helper list [--prefix=<path>] [<path>...]"),
  79                NULL
  80        };
  81
  82        argc = parse_options(argc, argv, prefix, module_list_options,
  83                             git_submodule_helper_usage, 0);
  84
  85        if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0) {
  86                printf("#unmatched\n");
  87                return 1;
  88        }
  89
  90        for (i = 0; i < list.nr; i++) {
  91                const struct cache_entry *ce = list.entries[i];
  92
  93                if (ce_stage(ce))
  94                        printf("%06o %s U\t", ce->ce_mode, sha1_to_hex(null_sha1));
  95                else
  96                        printf("%06o %s %d\t", ce->ce_mode, sha1_to_hex(ce->sha1), ce_stage(ce));
  97
  98                utf8_fprintf(stdout, "%s\n", ce->name);
  99        }
 100        return 0;
 101}
 102
 103static int module_name(int argc, const char **argv, const char *prefix)
 104{
 105        const struct submodule *sub;
 106
 107        if (argc != 2)
 108                usage(_("git submodule--helper name <path>"));
 109
 110        gitmodules_config();
 111        sub = submodule_from_path(null_sha1, argv[1]);
 112
 113        if (!sub)
 114                die(_("no submodule mapping found in .gitmodules for path '%s'"),
 115                    argv[1]);
 116
 117        printf("%s\n", sub->name);
 118
 119        return 0;
 120}
 121
 122/*
 123 * Rules to sanitize configuration variables that are Ok to be passed into
 124 * submodule operations from the parent project using "-c". Should only
 125 * include keys which are both (a) safe and (b) necessary for proper
 126 * operation.
 127 */
 128static int submodule_config_ok(const char *var)
 129{
 130        if (starts_with(var, "credential."))
 131                return 1;
 132        return 0;
 133}
 134
 135static int sanitize_submodule_config(const char *var, const char *value, void *data)
 136{
 137        struct strbuf *out = data;
 138
 139        if (submodule_config_ok(var)) {
 140                if (out->len)
 141                        strbuf_addch(out, ' ');
 142
 143                if (value)
 144                        sq_quotef(out, "%s=%s", var, value);
 145                else
 146                        sq_quote_buf(out, var);
 147        }
 148
 149        return 0;
 150}
 151
 152static void prepare_submodule_repo_env(struct argv_array *out)
 153{
 154        const char * const *var;
 155
 156        for (var = local_repo_env; *var; var++) {
 157                if (!strcmp(*var, CONFIG_DATA_ENVIRONMENT)) {
 158                        struct strbuf sanitized_config = STRBUF_INIT;
 159                        git_config_from_parameters(sanitize_submodule_config,
 160                                                   &sanitized_config);
 161                        argv_array_pushf(out, "%s=%s", *var, sanitized_config.buf);
 162                        strbuf_release(&sanitized_config);
 163                } else {
 164                        argv_array_push(out, *var);
 165                }
 166        }
 167
 168}
 169
 170static int clone_submodule(const char *path, const char *gitdir, const char *url,
 171                           const char *depth, const char *reference, int quiet)
 172{
 173        struct child_process cp;
 174        child_process_init(&cp);
 175
 176        argv_array_push(&cp.args, "clone");
 177        argv_array_push(&cp.args, "--no-checkout");
 178        if (quiet)
 179                argv_array_push(&cp.args, "--quiet");
 180        if (depth && *depth)
 181                argv_array_pushl(&cp.args, "--depth", depth, NULL);
 182        if (reference && *reference)
 183                argv_array_pushl(&cp.args, "--reference", reference, NULL);
 184        if (gitdir && *gitdir)
 185                argv_array_pushl(&cp.args, "--separate-git-dir", gitdir, NULL);
 186
 187        argv_array_push(&cp.args, url);
 188        argv_array_push(&cp.args, path);
 189
 190        cp.git_cmd = 1;
 191        prepare_submodule_repo_env(&cp.env_array);
 192        cp.no_stdin = 1;
 193
 194        return run_command(&cp);
 195}
 196
 197static int module_clone(int argc, const char **argv, const char *prefix)
 198{
 199        const char *name = NULL, *url = NULL;
 200        const char *reference = NULL, *depth = NULL;
 201        int quiet = 0;
 202        FILE *submodule_dot_git;
 203        char *p, *path = NULL, *sm_gitdir;
 204        struct strbuf rel_path = STRBUF_INIT;
 205        struct strbuf sb = STRBUF_INIT;
 206
 207        struct option module_clone_options[] = {
 208                OPT_STRING(0, "prefix", &prefix,
 209                           N_("path"),
 210                           N_("alternative anchor for relative paths")),
 211                OPT_STRING(0, "path", &path,
 212                           N_("path"),
 213                           N_("where the new submodule will be cloned to")),
 214                OPT_STRING(0, "name", &name,
 215                           N_("string"),
 216                           N_("name of the new submodule")),
 217                OPT_STRING(0, "url", &url,
 218                           N_("string"),
 219                           N_("url where to clone the submodule from")),
 220                OPT_STRING(0, "reference", &reference,
 221                           N_("string"),
 222                           N_("reference repository")),
 223                OPT_STRING(0, "depth", &depth,
 224                           N_("string"),
 225                           N_("depth for shallow clones")),
 226                OPT__QUIET(&quiet, "Suppress output for cloning a submodule"),
 227                OPT_END()
 228        };
 229
 230        const char *const git_submodule_helper_usage[] = {
 231                N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
 232                   "[--reference <repository>] [--name <name>] [--depth <depth>] "
 233                   "--url <url> --path <path>"),
 234                NULL
 235        };
 236
 237        argc = parse_options(argc, argv, prefix, module_clone_options,
 238                             git_submodule_helper_usage, 0);
 239
 240        if (argc || !url || !path || !*path)
 241                usage_with_options(git_submodule_helper_usage,
 242                                   module_clone_options);
 243
 244        strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), name);
 245        sm_gitdir = xstrdup(absolute_path(sb.buf));
 246        strbuf_reset(&sb);
 247
 248        if (!is_absolute_path(path)) {
 249                strbuf_addf(&sb, "%s/%s", get_git_work_tree(), path);
 250                path = strbuf_detach(&sb, NULL);
 251        } else
 252                path = xstrdup(path);
 253
 254        if (!file_exists(sm_gitdir)) {
 255                if (safe_create_leading_directories_const(sm_gitdir) < 0)
 256                        die(_("could not create directory '%s'"), sm_gitdir);
 257                if (clone_submodule(path, sm_gitdir, url, depth, reference, quiet))
 258                        die(_("clone of '%s' into submodule path '%s' failed"),
 259                            url, path);
 260        } else {
 261                if (safe_create_leading_directories_const(path) < 0)
 262                        die(_("could not create directory '%s'"), path);
 263                strbuf_addf(&sb, "%s/index", sm_gitdir);
 264                unlink_or_warn(sb.buf);
 265                strbuf_reset(&sb);
 266        }
 267
 268        /* Write a .git file in the submodule to redirect to the superproject. */
 269        strbuf_addf(&sb, "%s/.git", path);
 270        if (safe_create_leading_directories_const(sb.buf) < 0)
 271                die(_("could not create leading directories of '%s'"), sb.buf);
 272        submodule_dot_git = fopen(sb.buf, "w");
 273        if (!submodule_dot_git)
 274                die_errno(_("cannot open file '%s'"), sb.buf);
 275
 276        fprintf_or_die(submodule_dot_git, "gitdir: %s\n",
 277                       relative_path(sm_gitdir, path, &rel_path));
 278        if (fclose(submodule_dot_git))
 279                die(_("could not close file %s"), sb.buf);
 280        strbuf_reset(&sb);
 281        strbuf_reset(&rel_path);
 282
 283        /* Redirect the worktree of the submodule in the superproject's config */
 284        p = git_pathdup_submodule(path, "config");
 285        if (!p)
 286                die(_("could not get submodule directory for '%s'"), path);
 287        git_config_set_in_file(p, "core.worktree",
 288                               relative_path(path, sm_gitdir, &rel_path));
 289        strbuf_release(&sb);
 290        strbuf_release(&rel_path);
 291        free(sm_gitdir);
 292        free(path);
 293        free(p);
 294        return 0;
 295}
 296
 297static int module_sanitize_config(int argc, const char **argv, const char *prefix)
 298{
 299        struct strbuf sanitized_config = STRBUF_INIT;
 300
 301        if (argc > 1)
 302                usage(_("git submodule--helper sanitize-config"));
 303
 304        git_config_from_parameters(sanitize_submodule_config, &sanitized_config);
 305        if (sanitized_config.len)
 306                printf("%s\n", sanitized_config.buf);
 307
 308        strbuf_release(&sanitized_config);
 309
 310        return 0;
 311}
 312
 313struct submodule_update_clone {
 314        /* index into 'list', the list of submodules to look into for cloning */
 315        int current;
 316        struct module_list list;
 317        unsigned warn_if_uninitialized : 1;
 318
 319        /* update parameter passed via commandline */
 320        struct submodule_update_strategy update;
 321
 322        /* configuration parameters which are passed on to the children */
 323        int quiet;
 324        const char *reference;
 325        const char *depth;
 326        const char *recursive_prefix;
 327        const char *prefix;
 328
 329        /* Machine-readable status lines to be consumed by git-submodule.sh */
 330        struct string_list projectlines;
 331
 332        /* If we want to stop as fast as possible and return an error */
 333        unsigned quickstop : 1;
 334};
 335#define SUBMODULE_UPDATE_CLONE_INIT {0, MODULE_LIST_INIT, 0, \
 336        SUBMODULE_UPDATE_STRATEGY_INIT, 0, NULL, NULL, NULL, NULL, \
 337        STRING_LIST_INIT_DUP, 0}
 338
 339/**
 340 * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
 341 * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
 342 */
 343static int prepare_to_clone_next_submodule(const struct cache_entry *ce,
 344                                           struct child_process *child,
 345                                           struct submodule_update_clone *suc,
 346                                           struct strbuf *out)
 347{
 348        const struct submodule *sub = NULL;
 349        struct strbuf displaypath_sb = STRBUF_INIT;
 350        struct strbuf sb = STRBUF_INIT;
 351        const char *displaypath = NULL;
 352        char *url = NULL;
 353        int needs_cloning = 0;
 354
 355        if (ce_stage(ce)) {
 356                if (suc->recursive_prefix)
 357                        strbuf_addf(&sb, "%s/%s", suc->recursive_prefix, ce->name);
 358                else
 359                        strbuf_addf(&sb, "%s", ce->name);
 360                strbuf_addf(out, _("Skipping unmerged submodule %s"), sb.buf);
 361                strbuf_addch(out, '\n');
 362                goto cleanup;
 363        }
 364
 365        sub = submodule_from_path(null_sha1, ce->name);
 366
 367        if (suc->recursive_prefix)
 368                displaypath = relative_path(suc->recursive_prefix,
 369                                            ce->name, &displaypath_sb);
 370        else
 371                displaypath = ce->name;
 372
 373        if (suc->update.type == SM_UPDATE_NONE
 374            || (suc->update.type == SM_UPDATE_UNSPECIFIED
 375                && sub->update_strategy.type == SM_UPDATE_NONE)) {
 376                strbuf_addf(out, _("Skipping submodule '%s'"), displaypath);
 377                strbuf_addch(out, '\n');
 378                goto cleanup;
 379        }
 380
 381        /*
 382         * Looking up the url in .git/config.
 383         * We must not fall back to .gitmodules as we only want
 384         * to process configured submodules.
 385         */
 386        strbuf_reset(&sb);
 387        strbuf_addf(&sb, "submodule.%s.url", sub->name);
 388        git_config_get_string(sb.buf, &url);
 389        if (!url) {
 390                /*
 391                 * Only mention uninitialized submodules when their
 392                 * path have been specified
 393                 */
 394                if (suc->warn_if_uninitialized) {
 395                        strbuf_addf(out,
 396                                _("Submodule path '%s' not initialized"),
 397                                displaypath);
 398                        strbuf_addch(out, '\n');
 399                        strbuf_addstr(out,
 400                                _("Maybe you want to use 'update --init'?"));
 401                        strbuf_addch(out, '\n');
 402                }
 403                goto cleanup;
 404        }
 405
 406        strbuf_reset(&sb);
 407        strbuf_addf(&sb, "%s/.git", ce->name);
 408        needs_cloning = !file_exists(sb.buf);
 409
 410        strbuf_reset(&sb);
 411        strbuf_addf(&sb, "%06o %s %d %d\t%s\n", ce->ce_mode,
 412                        sha1_to_hex(ce->sha1), ce_stage(ce),
 413                        needs_cloning, ce->name);
 414        string_list_append(&suc->projectlines, sb.buf);
 415
 416        if (!needs_cloning)
 417                goto cleanup;
 418
 419        child->git_cmd = 1;
 420        child->no_stdin = 1;
 421        child->stdout_to_stderr = 1;
 422        child->err = -1;
 423        argv_array_push(&child->args, "submodule--helper");
 424        argv_array_push(&child->args, "clone");
 425        if (suc->quiet)
 426                argv_array_push(&child->args, "--quiet");
 427        if (suc->prefix)
 428                argv_array_pushl(&child->args, "--prefix", suc->prefix, NULL);
 429        argv_array_pushl(&child->args, "--path", sub->path, NULL);
 430        argv_array_pushl(&child->args, "--name", sub->name, NULL);
 431        argv_array_pushl(&child->args, "--url", url, NULL);
 432        if (suc->reference)
 433                argv_array_push(&child->args, suc->reference);
 434        if (suc->depth)
 435                argv_array_push(&child->args, suc->depth);
 436
 437cleanup:
 438        free(url);
 439        strbuf_reset(&displaypath_sb);
 440        strbuf_reset(&sb);
 441
 442        return needs_cloning;
 443}
 444
 445static int update_clone_get_next_task(struct child_process *child,
 446                                      struct strbuf *err,
 447                                      void *suc_cb,
 448                                      void **void_task_cb)
 449{
 450        struct submodule_update_clone *suc = suc_cb;
 451
 452        for (; suc->current < suc->list.nr; suc->current++) {
 453                const struct cache_entry *ce = suc->list.entries[suc->current];
 454                if (prepare_to_clone_next_submodule(ce, child, suc, err)) {
 455                        suc->current++;
 456                        return 1;
 457                }
 458        }
 459        return 0;
 460}
 461
 462static int update_clone_start_failure(struct strbuf *err,
 463                                      void *suc_cb,
 464                                      void *void_task_cb)
 465{
 466        struct submodule_update_clone *suc = suc_cb;
 467        suc->quickstop = 1;
 468        return 1;
 469}
 470
 471static int update_clone_task_finished(int result,
 472                                      struct strbuf *err,
 473                                      void *suc_cb,
 474                                      void *void_task_cb)
 475{
 476        struct submodule_update_clone *suc = suc_cb;
 477
 478        if (!result)
 479                return 0;
 480
 481        suc->quickstop = 1;
 482        return 1;
 483}
 484
 485static int update_clone(int argc, const char **argv, const char *prefix)
 486{
 487        const char *update = NULL;
 488        int max_jobs = -1;
 489        struct string_list_item *item;
 490        struct pathspec pathspec;
 491        struct submodule_update_clone suc = SUBMODULE_UPDATE_CLONE_INIT;
 492
 493        struct option module_update_clone_options[] = {
 494                OPT_STRING(0, "prefix", &prefix,
 495                           N_("path"),
 496                           N_("path into the working tree")),
 497                OPT_STRING(0, "recursive-prefix", &suc.recursive_prefix,
 498                           N_("path"),
 499                           N_("path into the working tree, across nested "
 500                              "submodule boundaries")),
 501                OPT_STRING(0, "update", &update,
 502                           N_("string"),
 503                           N_("rebase, merge, checkout or none")),
 504                OPT_STRING(0, "reference", &suc.reference, N_("repo"),
 505                           N_("reference repository")),
 506                OPT_STRING(0, "depth", &suc.depth, "<depth>",
 507                           N_("Create a shallow clone truncated to the "
 508                              "specified number of revisions")),
 509                OPT_INTEGER('j', "jobs", &max_jobs,
 510                            N_("parallel jobs")),
 511                OPT__QUIET(&suc.quiet, N_("don't print cloning progress")),
 512                OPT_END()
 513        };
 514
 515        const char *const git_submodule_helper_usage[] = {
 516                N_("git submodule--helper update_clone [--prefix=<path>] [<path>...]"),
 517                NULL
 518        };
 519        suc.prefix = prefix;
 520
 521        argc = parse_options(argc, argv, prefix, module_update_clone_options,
 522                             git_submodule_helper_usage, 0);
 523
 524        if (update)
 525                if (parse_submodule_update_strategy(update, &suc.update) < 0)
 526                        die(_("bad value for update parameter"));
 527
 528        if (module_list_compute(argc, argv, prefix, &pathspec, &suc.list) < 0)
 529                return 1;
 530
 531        if (pathspec.nr)
 532                suc.warn_if_uninitialized = 1;
 533
 534        /* Overlay the parsed .gitmodules file with .git/config */
 535        gitmodules_config();
 536        git_config(submodule_config, NULL);
 537
 538        if (max_jobs < 0)
 539                max_jobs = parallel_submodules();
 540
 541        run_processes_parallel(max_jobs,
 542                               update_clone_get_next_task,
 543                               update_clone_start_failure,
 544                               update_clone_task_finished,
 545                               &suc);
 546
 547        /*
 548         * We saved the output and put it out all at once now.
 549         * That means:
 550         * - the listener does not have to interleave their (checkout)
 551         *   work with our fetching.  The writes involved in a
 552         *   checkout involve more straightforward sequential I/O.
 553         * - the listener can avoid doing any work if fetching failed.
 554         */
 555        if (suc.quickstop)
 556                return 1;
 557
 558        for_each_string_list_item(item, &suc.projectlines)
 559                utf8_fprintf(stdout, "%s", item->string);
 560
 561        return 0;
 562}
 563
 564struct cmd_struct {
 565        const char *cmd;
 566        int (*fn)(int, const char **, const char *);
 567};
 568
 569static struct cmd_struct commands[] = {
 570        {"list", module_list},
 571        {"name", module_name},
 572        {"clone", module_clone},
 573        {"sanitize-config", module_sanitize_config},
 574        {"update-clone", update_clone}
 575};
 576
 577int cmd_submodule__helper(int argc, const char **argv, const char *prefix)
 578{
 579        int i;
 580        if (argc < 2)
 581                die(_("submodule--helper subcommand must be "
 582                      "called with a subcommand"));
 583
 584        for (i = 0; i < ARRAY_SIZE(commands); i++)
 585                if (!strcmp(argv[1], commands[i].cmd))
 586                        return commands[i].fn(argc - 1, argv + 1, prefix);
 587
 588        die(_("'%s' is not a valid submodule--helper "
 589              "subcommand"), argv[1]);
 590}