Sync with 2.10.1
[git] / 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 #include "remote.h"
13 #include "refs.h"
14 #include "connect.h"
15
16 static char *get_default_remote(void)
17 {
18         char *dest = NULL, *ret;
19         unsigned char sha1[20];
20         struct strbuf sb = STRBUF_INIT;
21         const char *refname = resolve_ref_unsafe("HEAD", 0, sha1, NULL);
22
23         if (!refname)
24                 die(_("No such ref: %s"), "HEAD");
25
26         /* detached HEAD */
27         if (!strcmp(refname, "HEAD"))
28                 return xstrdup("origin");
29
30         if (!skip_prefix(refname, "refs/heads/", &refname))
31                 die(_("Expecting a full ref name, got %s"), refname);
32
33         strbuf_addf(&sb, "branch.%s.remote", refname);
34         if (git_config_get_string(sb.buf, &dest))
35                 ret = xstrdup("origin");
36         else
37                 ret = dest;
38
39         strbuf_release(&sb);
40         return ret;
41 }
42
43 static int starts_with_dot_slash(const char *str)
44 {
45         return str[0] == '.' && is_dir_sep(str[1]);
46 }
47
48 static int starts_with_dot_dot_slash(const char *str)
49 {
50         return str[0] == '.' && str[1] == '.' && is_dir_sep(str[2]);
51 }
52
53 /*
54  * Returns 1 if it was the last chop before ':'.
55  */
56 static int chop_last_dir(char **remoteurl, int is_relative)
57 {
58         char *rfind = find_last_dir_sep(*remoteurl);
59         if (rfind) {
60                 *rfind = '\0';
61                 return 0;
62         }
63
64         rfind = strrchr(*remoteurl, ':');
65         if (rfind) {
66                 *rfind = '\0';
67                 return 1;
68         }
69
70         if (is_relative || !strcmp(".", *remoteurl))
71                 die(_("cannot strip one component off url '%s'"),
72                         *remoteurl);
73
74         free(*remoteurl);
75         *remoteurl = xstrdup(".");
76         return 0;
77 }
78
79 /*
80  * The `url` argument is the URL that navigates to the submodule origin
81  * repo. When relative, this URL is relative to the superproject origin
82  * URL repo. The `up_path` argument, if specified, is the relative
83  * path that navigates from the submodule working tree to the superproject
84  * working tree. Returns the origin URL of the submodule.
85  *
86  * Return either an absolute URL or filesystem path (if the superproject
87  * origin URL is an absolute URL or filesystem path, respectively) or a
88  * relative file system path (if the superproject origin URL is a relative
89  * file system path).
90  *
91  * When the output is a relative file system path, the path is either
92  * relative to the submodule working tree, if up_path is specified, or to
93  * the superproject working tree otherwise.
94  *
95  * NEEDSWORK: This works incorrectly on the domain and protocol part.
96  * remote_url      url              outcome          expectation
97  * http://a.com/b  ../c             http://a.com/c   as is
98  * http://a.com/b  ../../c          http://c         error out
99  * http://a.com/b  ../../../c       http:/c          error out
100  * http://a.com/b  ../../../../c    http:c           error out
101  * http://a.com/b  ../../../../../c    .:c           error out
102  * NEEDSWORK: Given how chop_last_dir() works, this function is broken
103  * when a local part has a colon in its path component, too.
104  */
105 static char *relative_url(const char *remote_url,
106                                 const char *url,
107                                 const char *up_path)
108 {
109         int is_relative = 0;
110         int colonsep = 0;
111         char *out;
112         char *remoteurl = xstrdup(remote_url);
113         struct strbuf sb = STRBUF_INIT;
114         size_t len = strlen(remoteurl);
115
116         if (is_dir_sep(remoteurl[len]))
117                 remoteurl[len] = '\0';
118
119         if (!url_is_local_not_ssh(remoteurl) || is_absolute_path(remoteurl))
120                 is_relative = 0;
121         else {
122                 is_relative = 1;
123                 /*
124                  * Prepend a './' to ensure all relative
125                  * remoteurls start with './' or '../'
126                  */
127                 if (!starts_with_dot_slash(remoteurl) &&
128                     !starts_with_dot_dot_slash(remoteurl)) {
129                         strbuf_reset(&sb);
130                         strbuf_addf(&sb, "./%s", remoteurl);
131                         free(remoteurl);
132                         remoteurl = strbuf_detach(&sb, NULL);
133                 }
134         }
135         /*
136          * When the url starts with '../', remove that and the
137          * last directory in remoteurl.
138          */
139         while (url) {
140                 if (starts_with_dot_dot_slash(url)) {
141                         url += 3;
142                         colonsep |= chop_last_dir(&remoteurl, is_relative);
143                 } else if (starts_with_dot_slash(url))
144                         url += 2;
145                 else
146                         break;
147         }
148         strbuf_reset(&sb);
149         strbuf_addf(&sb, "%s%s%s", remoteurl, colonsep ? ":" : "/", url);
150         free(remoteurl);
151
152         if (starts_with_dot_slash(sb.buf))
153                 out = xstrdup(sb.buf + 2);
154         else
155                 out = xstrdup(sb.buf);
156         strbuf_reset(&sb);
157
158         if (!up_path || !is_relative)
159                 return out;
160
161         strbuf_addf(&sb, "%s%s", up_path, out);
162         free(out);
163         return strbuf_detach(&sb, NULL);
164 }
165
166 static int resolve_relative_url(int argc, const char **argv, const char *prefix)
167 {
168         char *remoteurl = NULL;
169         char *remote = get_default_remote();
170         const char *up_path = NULL;
171         char *res;
172         const char *url;
173         struct strbuf sb = STRBUF_INIT;
174
175         if (argc != 2 && argc != 3)
176                 die("resolve-relative-url only accepts one or two arguments");
177
178         url = argv[1];
179         strbuf_addf(&sb, "remote.%s.url", remote);
180         free(remote);
181
182         if (git_config_get_string(sb.buf, &remoteurl))
183                 /* the repository is its own authoritative upstream */
184                 remoteurl = xgetcwd();
185
186         if (argc == 3)
187                 up_path = argv[2];
188
189         res = relative_url(remoteurl, url, up_path);
190         puts(res);
191         free(res);
192         free(remoteurl);
193         return 0;
194 }
195
196 static int resolve_relative_url_test(int argc, const char **argv, const char *prefix)
197 {
198         char *remoteurl, *res;
199         const char *up_path, *url;
200
201         if (argc != 4)
202                 die("resolve-relative-url-test only accepts three arguments: <up_path> <remoteurl> <url>");
203
204         up_path = argv[1];
205         remoteurl = xstrdup(argv[2]);
206         url = argv[3];
207
208         if (!strcmp(up_path, "(null)"))
209                 up_path = NULL;
210
211         res = relative_url(remoteurl, url, up_path);
212         puts(res);
213         free(res);
214         free(remoteurl);
215         return 0;
216 }
217
218 struct module_list {
219         const struct cache_entry **entries;
220         int alloc, nr;
221 };
222 #define MODULE_LIST_INIT { NULL, 0, 0 }
223
224 static int module_list_compute(int argc, const char **argv,
225                                const char *prefix,
226                                struct pathspec *pathspec,
227                                struct module_list *list)
228 {
229         int i, result = 0;
230         char *ps_matched = NULL;
231         parse_pathspec(pathspec, 0,
232                        PATHSPEC_PREFER_FULL |
233                        PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP,
234                        prefix, argv);
235
236         if (pathspec->nr)
237                 ps_matched = xcalloc(pathspec->nr, 1);
238
239         if (read_cache() < 0)
240                 die(_("index file corrupt"));
241
242         for (i = 0; i < active_nr; i++) {
243                 const struct cache_entry *ce = active_cache[i];
244
245                 if (!match_pathspec(pathspec, ce->name, ce_namelen(ce),
246                                     0, ps_matched, 1) ||
247                     !S_ISGITLINK(ce->ce_mode))
248                         continue;
249
250                 ALLOC_GROW(list->entries, list->nr + 1, list->alloc);
251                 list->entries[list->nr++] = ce;
252                 while (i + 1 < active_nr &&
253                        !strcmp(ce->name, active_cache[i + 1]->name))
254                         /*
255                          * Skip entries with the same name in different stages
256                          * to make sure an entry is returned only once.
257                          */
258                         i++;
259         }
260
261         if (ps_matched && report_path_error(ps_matched, pathspec, prefix))
262                 result = -1;
263
264         free(ps_matched);
265
266         return result;
267 }
268
269 static int module_list(int argc, const char **argv, const char *prefix)
270 {
271         int i;
272         struct pathspec pathspec;
273         struct module_list list = MODULE_LIST_INIT;
274
275         struct option module_list_options[] = {
276                 OPT_STRING(0, "prefix", &prefix,
277                            N_("path"),
278                            N_("alternative anchor for relative paths")),
279                 OPT_END()
280         };
281
282         const char *const git_submodule_helper_usage[] = {
283                 N_("git submodule--helper list [--prefix=<path>] [<path>...]"),
284                 NULL
285         };
286
287         argc = parse_options(argc, argv, prefix, module_list_options,
288                              git_submodule_helper_usage, 0);
289
290         if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
291                 return 1;
292
293         for (i = 0; i < list.nr; i++) {
294                 const struct cache_entry *ce = list.entries[i];
295
296                 if (ce_stage(ce))
297                         printf("%06o %s U\t", ce->ce_mode, sha1_to_hex(null_sha1));
298                 else
299                         printf("%06o %s %d\t", ce->ce_mode,
300                                oid_to_hex(&ce->oid), ce_stage(ce));
301
302                 utf8_fprintf(stdout, "%s\n", ce->name);
303         }
304         return 0;
305 }
306
307 static void init_submodule(const char *path, const char *prefix, int quiet)
308 {
309         const struct submodule *sub;
310         struct strbuf sb = STRBUF_INIT;
311         char *upd = NULL, *url = NULL, *displaypath;
312
313         /* Only loads from .gitmodules, no overlay with .git/config */
314         gitmodules_config();
315
316         if (prefix) {
317                 strbuf_addf(&sb, "%s%s", prefix, path);
318                 displaypath = strbuf_detach(&sb, NULL);
319         } else
320                 displaypath = xstrdup(path);
321
322         sub = submodule_from_path(null_sha1, path);
323
324         if (!sub)
325                 die(_("No url found for submodule path '%s' in .gitmodules"),
326                         displaypath);
327
328         /*
329          * Copy url setting when it is not set yet.
330          * To look up the url in .git/config, we must not fall back to
331          * .gitmodules, so look it up directly.
332          */
333         strbuf_reset(&sb);
334         strbuf_addf(&sb, "submodule.%s.url", sub->name);
335         if (git_config_get_string(sb.buf, &url)) {
336                 url = xstrdup(sub->url);
337
338                 if (!url)
339                         die(_("No url found for submodule path '%s' in .gitmodules"),
340                                 displaypath);
341
342                 /* Possibly a url relative to parent */
343                 if (starts_with_dot_dot_slash(url) ||
344                     starts_with_dot_slash(url)) {
345                         char *remoteurl, *relurl;
346                         char *remote = get_default_remote();
347                         struct strbuf remotesb = STRBUF_INIT;
348                         strbuf_addf(&remotesb, "remote.%s.url", remote);
349                         free(remote);
350
351                         if (git_config_get_string(remotesb.buf, &remoteurl))
352                                 /*
353                                  * The repository is its own
354                                  * authoritative upstream
355                                  */
356                                 remoteurl = xgetcwd();
357                         relurl = relative_url(remoteurl, url, NULL);
358                         strbuf_release(&remotesb);
359                         free(remoteurl);
360                         free(url);
361                         url = relurl;
362                 }
363
364                 if (git_config_set_gently(sb.buf, url))
365                         die(_("Failed to register url for submodule path '%s'"),
366                             displaypath);
367                 if (!quiet)
368                         fprintf(stderr,
369                                 _("Submodule '%s' (%s) registered for path '%s'\n"),
370                                 sub->name, url, displaypath);
371         }
372
373         /* Copy "update" setting when it is not set yet */
374         strbuf_reset(&sb);
375         strbuf_addf(&sb, "submodule.%s.update", sub->name);
376         if (git_config_get_string(sb.buf, &upd) &&
377             sub->update_strategy.type != SM_UPDATE_UNSPECIFIED) {
378                 if (sub->update_strategy.type == SM_UPDATE_COMMAND) {
379                         fprintf(stderr, _("warning: command update mode suggested for submodule '%s'\n"),
380                                 sub->name);
381                         upd = xstrdup("none");
382                 } else
383                         upd = xstrdup(submodule_strategy_to_string(&sub->update_strategy));
384
385                 if (git_config_set_gently(sb.buf, upd))
386                         die(_("Failed to register update mode for submodule path '%s'"), displaypath);
387         }
388         strbuf_release(&sb);
389         free(displaypath);
390         free(url);
391         free(upd);
392 }
393
394 static int module_init(int argc, const char **argv, const char *prefix)
395 {
396         struct pathspec pathspec;
397         struct module_list list = MODULE_LIST_INIT;
398         int quiet = 0;
399         int i;
400
401         struct option module_init_options[] = {
402                 OPT_STRING(0, "prefix", &prefix,
403                            N_("path"),
404                            N_("alternative anchor for relative paths")),
405                 OPT__QUIET(&quiet, N_("Suppress output for initializing a submodule")),
406                 OPT_END()
407         };
408
409         const char *const git_submodule_helper_usage[] = {
410                 N_("git submodule--helper init [<path>]"),
411                 NULL
412         };
413
414         argc = parse_options(argc, argv, prefix, module_init_options,
415                              git_submodule_helper_usage, 0);
416
417         if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
418                 return 1;
419
420         for (i = 0; i < list.nr; i++)
421                 init_submodule(list.entries[i]->name, prefix, quiet);
422
423         return 0;
424 }
425
426 static int module_name(int argc, const char **argv, const char *prefix)
427 {
428         const struct submodule *sub;
429
430         if (argc != 2)
431                 usage(_("git submodule--helper name <path>"));
432
433         gitmodules_config();
434         sub = submodule_from_path(null_sha1, argv[1]);
435
436         if (!sub)
437                 die(_("no submodule mapping found in .gitmodules for path '%s'"),
438                     argv[1]);
439
440         printf("%s\n", sub->name);
441
442         return 0;
443 }
444
445 static int clone_submodule(const char *path, const char *gitdir, const char *url,
446                            const char *depth, struct string_list *reference,
447                            int quiet, int progress)
448 {
449         struct child_process cp = CHILD_PROCESS_INIT;
450
451         argv_array_push(&cp.args, "clone");
452         argv_array_push(&cp.args, "--no-checkout");
453         if (quiet)
454                 argv_array_push(&cp.args, "--quiet");
455         if (progress)
456                 argv_array_push(&cp.args, "--progress");
457         if (depth && *depth)
458                 argv_array_pushl(&cp.args, "--depth", depth, NULL);
459         if (reference->nr) {
460                 struct string_list_item *item;
461                 for_each_string_list_item(item, reference)
462                         argv_array_pushl(&cp.args, "--reference",
463                                          item->string, NULL);
464         }
465         if (gitdir && *gitdir)
466                 argv_array_pushl(&cp.args, "--separate-git-dir", gitdir, NULL);
467
468         argv_array_push(&cp.args, url);
469         argv_array_push(&cp.args, path);
470
471         cp.git_cmd = 1;
472         prepare_submodule_repo_env(&cp.env_array);
473         cp.no_stdin = 1;
474
475         return run_command(&cp);
476 }
477
478 struct submodule_alternate_setup {
479         const char *submodule_name;
480         enum SUBMODULE_ALTERNATE_ERROR_MODE {
481                 SUBMODULE_ALTERNATE_ERROR_DIE,
482                 SUBMODULE_ALTERNATE_ERROR_INFO,
483                 SUBMODULE_ALTERNATE_ERROR_IGNORE
484         } error_mode;
485         struct string_list *reference;
486 };
487 #define SUBMODULE_ALTERNATE_SETUP_INIT { NULL, \
488         SUBMODULE_ALTERNATE_ERROR_IGNORE, NULL }
489
490 static int add_possible_reference_from_superproject(
491                 struct alternate_object_database *alt, void *sas_cb)
492 {
493         struct submodule_alternate_setup *sas = sas_cb;
494
495         /* directory name, minus trailing slash */
496         size_t namelen = alt->name - alt->base - 1;
497         struct strbuf name = STRBUF_INIT;
498         strbuf_add(&name, alt->base, namelen);
499
500         /*
501          * If the alternate object store is another repository, try the
502          * standard layout with .git/modules/<name>/objects
503          */
504         if (ends_with(name.buf, ".git/objects")) {
505                 char *sm_alternate;
506                 struct strbuf sb = STRBUF_INIT;
507                 struct strbuf err = STRBUF_INIT;
508                 strbuf_add(&sb, name.buf, name.len - strlen("objects"));
509                 /*
510                  * We need to end the new path with '/' to mark it as a dir,
511                  * otherwise a submodule name containing '/' will be broken
512                  * as the last part of a missing submodule reference would
513                  * be taken as a file name.
514                  */
515                 strbuf_addf(&sb, "modules/%s/", sas->submodule_name);
516
517                 sm_alternate = compute_alternate_path(sb.buf, &err);
518                 if (sm_alternate) {
519                         string_list_append(sas->reference, xstrdup(sb.buf));
520                         free(sm_alternate);
521                 } else {
522                         switch (sas->error_mode) {
523                         case SUBMODULE_ALTERNATE_ERROR_DIE:
524                                 die(_("submodule '%s' cannot add alternate: %s"),
525                                     sas->submodule_name, err.buf);
526                         case SUBMODULE_ALTERNATE_ERROR_INFO:
527                                 fprintf(stderr, _("submodule '%s' cannot add alternate: %s"),
528                                         sas->submodule_name, err.buf);
529                         case SUBMODULE_ALTERNATE_ERROR_IGNORE:
530                                 ; /* nothing */
531                         }
532                 }
533                 strbuf_release(&sb);
534         }
535
536         strbuf_release(&name);
537         return 0;
538 }
539
540 static void prepare_possible_alternates(const char *sm_name,
541                 struct string_list *reference)
542 {
543         char *sm_alternate = NULL, *error_strategy = NULL;
544         struct submodule_alternate_setup sas = SUBMODULE_ALTERNATE_SETUP_INIT;
545
546         git_config_get_string("submodule.alternateLocation", &sm_alternate);
547         if (!sm_alternate)
548                 return;
549
550         git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
551
552         if (!error_strategy)
553                 error_strategy = xstrdup("die");
554
555         sas.submodule_name = sm_name;
556         sas.reference = reference;
557         if (!strcmp(error_strategy, "die"))
558                 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_DIE;
559         else if (!strcmp(error_strategy, "info"))
560                 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_INFO;
561         else if (!strcmp(error_strategy, "ignore"))
562                 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_IGNORE;
563         else
564                 die(_("Value '%s' for submodule.alternateErrorStrategy is not recognized"), error_strategy);
565
566         if (!strcmp(sm_alternate, "superproject"))
567                 foreach_alt_odb(add_possible_reference_from_superproject, &sas);
568         else if (!strcmp(sm_alternate, "no"))
569                 ; /* do nothing */
570         else
571                 die(_("Value '%s' for submodule.alternateLocation is not recognized"), sm_alternate);
572
573         free(sm_alternate);
574         free(error_strategy);
575 }
576
577 static int module_clone(int argc, const char **argv, const char *prefix)
578 {
579         const char *name = NULL, *url = NULL, *depth = NULL;
580         int quiet = 0;
581         int progress = 0;
582         FILE *submodule_dot_git;
583         char *p, *path = NULL, *sm_gitdir;
584         struct strbuf rel_path = STRBUF_INIT;
585         struct strbuf sb = STRBUF_INIT;
586         struct string_list reference = STRING_LIST_INIT_NODUP;
587
588         struct option module_clone_options[] = {
589                 OPT_STRING(0, "prefix", &prefix,
590                            N_("path"),
591                            N_("alternative anchor for relative paths")),
592                 OPT_STRING(0, "path", &path,
593                            N_("path"),
594                            N_("where the new submodule will be cloned to")),
595                 OPT_STRING(0, "name", &name,
596                            N_("string"),
597                            N_("name of the new submodule")),
598                 OPT_STRING(0, "url", &url,
599                            N_("string"),
600                            N_("url where to clone the submodule from")),
601                 OPT_STRING_LIST(0, "reference", &reference,
602                            N_("repo"),
603                            N_("reference repository")),
604                 OPT_STRING(0, "depth", &depth,
605                            N_("string"),
606                            N_("depth for shallow clones")),
607                 OPT__QUIET(&quiet, "Suppress output for cloning a submodule"),
608                 OPT_BOOL(0, "progress", &progress,
609                            N_("force cloning progress")),
610                 OPT_END()
611         };
612
613         const char *const git_submodule_helper_usage[] = {
614                 N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
615                    "[--reference <repository>] [--name <name>] [--depth <depth>] "
616                    "--url <url> --path <path>"),
617                 NULL
618         };
619
620         argc = parse_options(argc, argv, prefix, module_clone_options,
621                              git_submodule_helper_usage, 0);
622
623         if (argc || !url || !path || !*path)
624                 usage_with_options(git_submodule_helper_usage,
625                                    module_clone_options);
626
627         strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), name);
628         sm_gitdir = xstrdup(absolute_path(sb.buf));
629         strbuf_reset(&sb);
630
631         if (!is_absolute_path(path)) {
632                 strbuf_addf(&sb, "%s/%s", get_git_work_tree(), path);
633                 path = strbuf_detach(&sb, NULL);
634         } else
635                 path = xstrdup(path);
636
637         if (!file_exists(sm_gitdir)) {
638                 if (safe_create_leading_directories_const(sm_gitdir) < 0)
639                         die(_("could not create directory '%s'"), sm_gitdir);
640
641                 prepare_possible_alternates(name, &reference);
642
643                 if (clone_submodule(path, sm_gitdir, url, depth, &reference,
644                                     quiet, progress))
645                         die(_("clone of '%s' into submodule path '%s' failed"),
646                             url, path);
647         } else {
648                 if (safe_create_leading_directories_const(path) < 0)
649                         die(_("could not create directory '%s'"), path);
650                 strbuf_addf(&sb, "%s/index", sm_gitdir);
651                 unlink_or_warn(sb.buf);
652                 strbuf_reset(&sb);
653         }
654
655         /* Write a .git file in the submodule to redirect to the superproject. */
656         strbuf_addf(&sb, "%s/.git", path);
657         if (safe_create_leading_directories_const(sb.buf) < 0)
658                 die(_("could not create leading directories of '%s'"), sb.buf);
659         submodule_dot_git = fopen(sb.buf, "w");
660         if (!submodule_dot_git)
661                 die_errno(_("cannot open file '%s'"), sb.buf);
662
663         fprintf_or_die(submodule_dot_git, "gitdir: %s\n",
664                        relative_path(sm_gitdir, path, &rel_path));
665         if (fclose(submodule_dot_git))
666                 die(_("could not close file %s"), sb.buf);
667         strbuf_reset(&sb);
668         strbuf_reset(&rel_path);
669
670         /* Redirect the worktree of the submodule in the superproject's config */
671         p = git_pathdup_submodule(path, "config");
672         if (!p)
673                 die(_("could not get submodule directory for '%s'"), path);
674         git_config_set_in_file(p, "core.worktree",
675                                relative_path(path, sm_gitdir, &rel_path));
676         strbuf_release(&sb);
677         strbuf_release(&rel_path);
678         free(sm_gitdir);
679         free(path);
680         free(p);
681         return 0;
682 }
683
684 struct submodule_update_clone {
685         /* index into 'list', the list of submodules to look into for cloning */
686         int current;
687         struct module_list list;
688         unsigned warn_if_uninitialized : 1;
689
690         /* update parameter passed via commandline */
691         struct submodule_update_strategy update;
692
693         /* configuration parameters which are passed on to the children */
694         int progress;
695         int quiet;
696         int recommend_shallow;
697         struct string_list references;
698         const char *depth;
699         const char *recursive_prefix;
700         const char *prefix;
701
702         /* Machine-readable status lines to be consumed by git-submodule.sh */
703         struct string_list projectlines;
704
705         /* If we want to stop as fast as possible and return an error */
706         unsigned quickstop : 1;
707
708         /* failed clones to be retried again */
709         const struct cache_entry **failed_clones;
710         int failed_clones_nr, failed_clones_alloc;
711 };
712 #define SUBMODULE_UPDATE_CLONE_INIT {0, MODULE_LIST_INIT, 0, \
713         SUBMODULE_UPDATE_STRATEGY_INIT, 0, 0, -1, STRING_LIST_INIT_DUP, \
714         NULL, NULL, NULL, \
715         STRING_LIST_INIT_DUP, 0, NULL, 0, 0}
716
717
718 static void next_submodule_warn_missing(struct submodule_update_clone *suc,
719                 struct strbuf *out, const char *displaypath)
720 {
721         /*
722          * Only mention uninitialized submodules when their
723          * paths have been specified.
724          */
725         if (suc->warn_if_uninitialized) {
726                 strbuf_addf(out,
727                         _("Submodule path '%s' not initialized"),
728                         displaypath);
729                 strbuf_addch(out, '\n');
730                 strbuf_addstr(out,
731                         _("Maybe you want to use 'update --init'?"));
732                 strbuf_addch(out, '\n');
733         }
734 }
735
736 /**
737  * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
738  * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
739  */
740 static int prepare_to_clone_next_submodule(const struct cache_entry *ce,
741                                            struct child_process *child,
742                                            struct submodule_update_clone *suc,
743                                            struct strbuf *out)
744 {
745         const struct submodule *sub = NULL;
746         struct strbuf displaypath_sb = STRBUF_INIT;
747         struct strbuf sb = STRBUF_INIT;
748         const char *displaypath = NULL;
749         char *url = NULL;
750         int needs_cloning = 0;
751
752         if (ce_stage(ce)) {
753                 if (suc->recursive_prefix)
754                         strbuf_addf(&sb, "%s/%s", suc->recursive_prefix, ce->name);
755                 else
756                         strbuf_addf(&sb, "%s", ce->name);
757                 strbuf_addf(out, _("Skipping unmerged submodule %s"), sb.buf);
758                 strbuf_addch(out, '\n');
759                 goto cleanup;
760         }
761
762         sub = submodule_from_path(null_sha1, ce->name);
763
764         if (suc->recursive_prefix)
765                 displaypath = relative_path(suc->recursive_prefix,
766                                             ce->name, &displaypath_sb);
767         else
768                 displaypath = ce->name;
769
770         if (!sub) {
771                 next_submodule_warn_missing(suc, out, displaypath);
772                 goto cleanup;
773         }
774
775         if (suc->update.type == SM_UPDATE_NONE
776             || (suc->update.type == SM_UPDATE_UNSPECIFIED
777                 && sub->update_strategy.type == SM_UPDATE_NONE)) {
778                 strbuf_addf(out, _("Skipping submodule '%s'"), displaypath);
779                 strbuf_addch(out, '\n');
780                 goto cleanup;
781         }
782
783         /*
784          * Looking up the url in .git/config.
785          * We must not fall back to .gitmodules as we only want
786          * to process configured submodules.
787          */
788         strbuf_reset(&sb);
789         strbuf_addf(&sb, "submodule.%s.url", sub->name);
790         git_config_get_string(sb.buf, &url);
791         if (!url) {
792                 next_submodule_warn_missing(suc, out, displaypath);
793                 goto cleanup;
794         }
795
796         strbuf_reset(&sb);
797         strbuf_addf(&sb, "%s/.git", ce->name);
798         needs_cloning = !file_exists(sb.buf);
799
800         strbuf_reset(&sb);
801         strbuf_addf(&sb, "%06o %s %d %d\t%s\n", ce->ce_mode,
802                         oid_to_hex(&ce->oid), ce_stage(ce),
803                         needs_cloning, ce->name);
804         string_list_append(&suc->projectlines, sb.buf);
805
806         if (!needs_cloning)
807                 goto cleanup;
808
809         child->git_cmd = 1;
810         child->no_stdin = 1;
811         child->stdout_to_stderr = 1;
812         child->err = -1;
813         argv_array_push(&child->args, "submodule--helper");
814         argv_array_push(&child->args, "clone");
815         if (suc->progress)
816                 argv_array_push(&child->args, "--progress");
817         if (suc->quiet)
818                 argv_array_push(&child->args, "--quiet");
819         if (suc->prefix)
820                 argv_array_pushl(&child->args, "--prefix", suc->prefix, NULL);
821         if (suc->recommend_shallow && sub->recommend_shallow == 1)
822                 argv_array_push(&child->args, "--depth=1");
823         argv_array_pushl(&child->args, "--path", sub->path, NULL);
824         argv_array_pushl(&child->args, "--name", sub->name, NULL);
825         argv_array_pushl(&child->args, "--url", url, NULL);
826         if (suc->references.nr) {
827                 struct string_list_item *item;
828                 for_each_string_list_item(item, &suc->references)
829                         argv_array_pushl(&child->args, "--reference", item->string, NULL);
830         }
831         if (suc->depth)
832                 argv_array_push(&child->args, suc->depth);
833
834 cleanup:
835         free(url);
836         strbuf_reset(&displaypath_sb);
837         strbuf_reset(&sb);
838
839         return needs_cloning;
840 }
841
842 static int update_clone_get_next_task(struct child_process *child,
843                                       struct strbuf *err,
844                                       void *suc_cb,
845                                       void **idx_task_cb)
846 {
847         struct submodule_update_clone *suc = suc_cb;
848         const struct cache_entry *ce;
849         int index;
850
851         for (; suc->current < suc->list.nr; suc->current++) {
852                 ce = suc->list.entries[suc->current];
853                 if (prepare_to_clone_next_submodule(ce, child, suc, err)) {
854                         int *p = xmalloc(sizeof(*p));
855                         *p = suc->current;
856                         *idx_task_cb = p;
857                         suc->current++;
858                         return 1;
859                 }
860         }
861
862         /*
863          * The loop above tried cloning each submodule once, now try the
864          * stragglers again, which we can imagine as an extension of the
865          * entry list.
866          */
867         index = suc->current - suc->list.nr;
868         if (index < suc->failed_clones_nr) {
869                 int *p;
870                 ce = suc->failed_clones[index];
871                 if (!prepare_to_clone_next_submodule(ce, child, suc, err)) {
872                         suc->current ++;
873                         strbuf_addstr(err, "BUG: submodule considered for "
874                                            "cloning, doesn't need cloning "
875                                            "any more?\n");
876                         return 0;
877                 }
878                 p = xmalloc(sizeof(*p));
879                 *p = suc->current;
880                 *idx_task_cb = p;
881                 suc->current ++;
882                 return 1;
883         }
884
885         return 0;
886 }
887
888 static int update_clone_start_failure(struct strbuf *err,
889                                       void *suc_cb,
890                                       void *idx_task_cb)
891 {
892         struct submodule_update_clone *suc = suc_cb;
893         suc->quickstop = 1;
894         return 1;
895 }
896
897 static int update_clone_task_finished(int result,
898                                       struct strbuf *err,
899                                       void *suc_cb,
900                                       void *idx_task_cb)
901 {
902         const struct cache_entry *ce;
903         struct submodule_update_clone *suc = suc_cb;
904
905         int *idxP = *(int**)idx_task_cb;
906         int idx = *idxP;
907         free(idxP);
908
909         if (!result)
910                 return 0;
911
912         if (idx < suc->list.nr) {
913                 ce  = suc->list.entries[idx];
914                 strbuf_addf(err, _("Failed to clone '%s'. Retry scheduled"),
915                             ce->name);
916                 strbuf_addch(err, '\n');
917                 ALLOC_GROW(suc->failed_clones,
918                            suc->failed_clones_nr + 1,
919                            suc->failed_clones_alloc);
920                 suc->failed_clones[suc->failed_clones_nr++] = ce;
921                 return 0;
922         } else {
923                 idx -= suc->list.nr;
924                 ce  = suc->failed_clones[idx];
925                 strbuf_addf(err, _("Failed to clone '%s' a second time, aborting"),
926                             ce->name);
927                 strbuf_addch(err, '\n');
928                 suc->quickstop = 1;
929                 return 1;
930         }
931
932         return 0;
933 }
934
935 static int update_clone(int argc, const char **argv, const char *prefix)
936 {
937         const char *update = NULL;
938         int max_jobs = -1;
939         struct string_list_item *item;
940         struct pathspec pathspec;
941         struct submodule_update_clone suc = SUBMODULE_UPDATE_CLONE_INIT;
942
943         struct option module_update_clone_options[] = {
944                 OPT_STRING(0, "prefix", &prefix,
945                            N_("path"),
946                            N_("path into the working tree")),
947                 OPT_STRING(0, "recursive-prefix", &suc.recursive_prefix,
948                            N_("path"),
949                            N_("path into the working tree, across nested "
950                               "submodule boundaries")),
951                 OPT_STRING(0, "update", &update,
952                            N_("string"),
953                            N_("rebase, merge, checkout or none")),
954                 OPT_STRING_LIST(0, "reference", &suc.references, N_("repo"),
955                            N_("reference repository")),
956                 OPT_STRING(0, "depth", &suc.depth, "<depth>",
957                            N_("Create a shallow clone truncated to the "
958                               "specified number of revisions")),
959                 OPT_INTEGER('j', "jobs", &max_jobs,
960                             N_("parallel jobs")),
961                 OPT_BOOL(0, "recommend-shallow", &suc.recommend_shallow,
962                             N_("whether the initial clone should follow the shallow recommendation")),
963                 OPT__QUIET(&suc.quiet, N_("don't print cloning progress")),
964                 OPT_BOOL(0, "progress", &suc.progress,
965                             N_("force cloning progress")),
966                 OPT_END()
967         };
968
969         const char *const git_submodule_helper_usage[] = {
970                 N_("git submodule--helper update_clone [--prefix=<path>] [<path>...]"),
971                 NULL
972         };
973         suc.prefix = prefix;
974
975         argc = parse_options(argc, argv, prefix, module_update_clone_options,
976                              git_submodule_helper_usage, 0);
977
978         if (update)
979                 if (parse_submodule_update_strategy(update, &suc.update) < 0)
980                         die(_("bad value for update parameter"));
981
982         if (module_list_compute(argc, argv, prefix, &pathspec, &suc.list) < 0)
983                 return 1;
984
985         if (pathspec.nr)
986                 suc.warn_if_uninitialized = 1;
987
988         /* Overlay the parsed .gitmodules file with .git/config */
989         gitmodules_config();
990         git_config(submodule_config, NULL);
991
992         if (max_jobs < 0)
993                 max_jobs = parallel_submodules();
994
995         run_processes_parallel(max_jobs,
996                                update_clone_get_next_task,
997                                update_clone_start_failure,
998                                update_clone_task_finished,
999                                &suc);
1000
1001         /*
1002          * We saved the output and put it out all at once now.
1003          * That means:
1004          * - the listener does not have to interleave their (checkout)
1005          *   work with our fetching.  The writes involved in a
1006          *   checkout involve more straightforward sequential I/O.
1007          * - the listener can avoid doing any work if fetching failed.
1008          */
1009         if (suc.quickstop)
1010                 return 1;
1011
1012         for_each_string_list_item(item, &suc.projectlines)
1013                 utf8_fprintf(stdout, "%s", item->string);
1014
1015         return 0;
1016 }
1017
1018 static int resolve_relative_path(int argc, const char **argv, const char *prefix)
1019 {
1020         struct strbuf sb = STRBUF_INIT;
1021         if (argc != 3)
1022                 die("submodule--helper relative-path takes exactly 2 arguments, got %d", argc);
1023
1024         printf("%s", relative_path(argv[1], argv[2], &sb));
1025         strbuf_release(&sb);
1026         return 0;
1027 }
1028
1029 static const char *remote_submodule_branch(const char *path)
1030 {
1031         const struct submodule *sub;
1032         gitmodules_config();
1033         git_config(submodule_config, NULL);
1034
1035         sub = submodule_from_path(null_sha1, path);
1036         if (!sub)
1037                 return NULL;
1038
1039         if (!sub->branch)
1040                 return "master";
1041
1042         if (!strcmp(sub->branch, ".")) {
1043                 unsigned char sha1[20];
1044                 const char *refname = resolve_ref_unsafe("HEAD", 0, sha1, NULL);
1045
1046                 if (!refname)
1047                         die(_("No such ref: %s"), "HEAD");
1048
1049                 /* detached HEAD */
1050                 if (!strcmp(refname, "HEAD"))
1051                         die(_("Submodule (%s) branch configured to inherit "
1052                               "branch from superproject, but the superproject "
1053                               "is not on any branch"), sub->name);
1054
1055                 if (!skip_prefix(refname, "refs/heads/", &refname))
1056                         die(_("Expecting a full ref name, got %s"), refname);
1057                 return refname;
1058         }
1059
1060         return sub->branch;
1061 }
1062
1063 static int resolve_remote_submodule_branch(int argc, const char **argv,
1064                 const char *prefix)
1065 {
1066         const char *ret;
1067         struct strbuf sb = STRBUF_INIT;
1068         if (argc != 2)
1069                 die("submodule--helper remote-branch takes exactly one arguments, got %d", argc);
1070
1071         ret = remote_submodule_branch(argv[1]);
1072         if (!ret)
1073                 die("submodule %s doesn't exist", argv[1]);
1074
1075         printf("%s", ret);
1076         strbuf_release(&sb);
1077         return 0;
1078 }
1079
1080 struct cmd_struct {
1081         const char *cmd;
1082         int (*fn)(int, const char **, const char *);
1083 };
1084
1085 static struct cmd_struct commands[] = {
1086         {"list", module_list},
1087         {"name", module_name},
1088         {"clone", module_clone},
1089         {"update-clone", update_clone},
1090         {"relative-path", resolve_relative_path},
1091         {"resolve-relative-url", resolve_relative_url},
1092         {"resolve-relative-url-test", resolve_relative_url_test},
1093         {"init", module_init},
1094         {"remote-branch", resolve_remote_submodule_branch}
1095 };
1096
1097 int cmd_submodule__helper(int argc, const char **argv, const char *prefix)
1098 {
1099         int i;
1100         if (argc < 2)
1101                 die(_("submodule--helper subcommand must be "
1102                       "called with a subcommand"));
1103
1104         for (i = 0; i < ARRAY_SIZE(commands); i++)
1105                 if (!strcmp(argv[1], commands[i].cmd))
1106                         return commands[i].fn(argc - 1, argv + 1, prefix);
1107
1108         die(_("'%s' is not a valid submodule--helper "
1109               "subcommand"), argv[1]);
1110 }