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