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
  13 struct module_list {
  14         const struct cache_entry **entries;
  15         int alloc, nr;
  16 };
  17 #define MODULE_LIST_INIT { NULL, 0, 0 }
  18
  19 static 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
  64 static 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
 103 static 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 static int clone_submodule(const char *path, const char *gitdir, const char *url,
 122                            const char *depth, const char *reference, int quiet)
 123 {
 124         struct child_process cp;
 125         child_process_init(&cp);
 126
 127         argv_array_push(&cp.args, "clone");
 128         argv_array_push(&cp.args, "--no-checkout");
 129         if (quiet)
 130                 argv_array_push(&cp.args, "--quiet");
 131         if (depth && *depth)
 132                 argv_array_pushl(&cp.args, "--depth", depth, NULL);
 133         if (reference && *reference)
 134                 argv_array_pushl(&cp.args, "--reference", reference, NULL);
 135         if (gitdir && *gitdir)
 136                 argv_array_pushl(&cp.args, "--separate-git-dir", gitdir, NULL);
 137
 138         argv_array_push(&cp.args, url);
 139         argv_array_push(&cp.args, path);
 140
 141         cp.git_cmd = 1;
 142         cp.env = local_repo_env;
 143         cp.no_stdin = 1;
 144
 145         return run_command(&cp);
 146 }
 147
 148 static int module_clone(int argc, const char **argv, const char *prefix)
 149 {
 150         const char *name = NULL, *url = NULL;
 151         const char *reference = NULL, *depth = NULL;
 152         int quiet = 0;
 153         FILE *submodule_dot_git;
 154         char *p, *path = NULL, *sm_gitdir;
 155         struct strbuf rel_path = STRBUF_INIT;
 156         struct strbuf sb = STRBUF_INIT;
 157
 158         struct option module_clone_options[] = {
 159                 OPT_STRING(0, "prefix", &prefix,
 160                            N_("path"),
 161                            N_("alternative anchor for relative paths")),
 162                 OPT_STRING(0, "path", &path,
 163                            N_("path"),
 164                            N_("where the new submodule will be cloned to")),
 165                 OPT_STRING(0, "name", &name,
 166                            N_("string"),
 167                            N_("name of the new submodule")),
 168                 OPT_STRING(0, "url", &url,
 169                            N_("string"),
 170                            N_("url where to clone the submodule from")),
 171                 OPT_STRING(0, "reference", &reference,
 172                            N_("string"),
 173                            N_("reference repository")),
 174                 OPT_STRING(0, "depth", &depth,
 175                            N_("string"),
 176                            N_("depth for shallow clones")),
 177                 OPT__QUIET(&quiet, "Suppress output for cloning a submodule"),
 178                 OPT_END()
 179         };
 180
 181         const char *const git_submodule_helper_usage[] = {
 182                 N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
 183                    "[--reference <repository>] [--name <name>] [--url <url>]"
 184                    "[--depth <depth>] [--] [<path>...]"),
 185                 NULL
 186         };
 187
 188         argc = parse_options(argc, argv, prefix, module_clone_options,
 189                              git_submodule_helper_usage, 0);
 190
 191         if (!path || !*path)
 192                 die(_("submodule--helper: unspecified or empty --path"));
 193
 194         strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), name);
 195         sm_gitdir = xstrdup(absolute_path(sb.buf));
 196         strbuf_reset(&sb);
 197
 198         if (!is_absolute_path(path)) {
 199                 strbuf_addf(&sb, "%s/%s", get_git_work_tree(), path);
 200                 path = strbuf_detach(&sb, NULL);
 201         } else
 202                 path = xstrdup(path);
 203
 204         if (!file_exists(sm_gitdir)) {
 205                 if (safe_create_leading_directories_const(sm_gitdir) < 0)
 206                         die(_("could not create directory '%s'"), sm_gitdir);
 207                 if (clone_submodule(path, sm_gitdir, url, depth, reference, quiet))
 208                         die(_("clone of '%s' into submodule path '%s' failed"),
 209                             url, path);
 210         } else {
 211                 if (safe_create_leading_directories_const(path) < 0)
 212                         die(_("could not create directory '%s'"), path);
 213                 strbuf_addf(&sb, "%s/index", sm_gitdir);
 214                 unlink_or_warn(sb.buf);
 215                 strbuf_reset(&sb);
 216         }
 217
 218         /* Write a .git file in the submodule to redirect to the superproject. */
 219         strbuf_addf(&sb, "%s/.git", path);
 220         if (safe_create_leading_directories_const(sb.buf) < 0)
 221                 die(_("could not create leading directories of '%s'"), sb.buf);
 222         submodule_dot_git = fopen(sb.buf, "w");
 223         if (!submodule_dot_git)
 224                 die_errno(_("cannot open file '%s'"), sb.buf);
 225
 226         fprintf_or_die(submodule_dot_git, "gitdir: %s\n",
 227                        relative_path(sm_gitdir, path, &rel_path));
 228         if (fclose(submodule_dot_git))
 229                 die(_("could not close file %s"), sb.buf);
 230         strbuf_reset(&sb);
 231         strbuf_reset(&rel_path);
 232
 233         /* Redirect the worktree of the submodule in the superproject's config */
 234         p = git_pathdup_submodule(path, "config");
 235         if (!p)
 236                 die(_("could not get submodule directory for '%s'"), path);
 237         git_config_set_in_file(p, "core.worktree",
 238                                relative_path(path, sm_gitdir, &rel_path));
 239         strbuf_release(&sb);
 240         strbuf_release(&rel_path);
 241         free(sm_gitdir);
 242         free(path);
 243         free(p);
 244         return 0;
 245 }
 246
 247 struct cmd_struct {
 248         const char *cmd;
 249         int (*fn)(int, const char **, const char *);
 250 };
 251
 252 static struct cmd_struct commands[] = {
 253         {"list", module_list},
 254         {"name", module_name},
 255         {"clone", module_clone},
 256 };
 257
 258 int cmd_submodule__helper(int argc, const char **argv, const char *prefix)
 259 {
 260         int i;
 261         if (argc < 2)
 262                 die(_("fatal: submodule--helper subcommand must be "
 263                       "called with a subcommand"));
 264
 265         for (i = 0; i < ARRAY_SIZE(commands); i++)
 266                 if (!strcmp(argv[1], commands[i].cmd))
 267                         return commands[i].fn(argc - 1, argv + 1, prefix);
 268
 269         die(_("fatal: '%s' is not a valid submodule--helper "
 270               "subcommand"), argv[1]);
 271 }