Merge branch 'rs/hex2chr'
[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, sha1_to_hex(ce->sha1), ce_stage(ce));
300
301                 utf8_fprintf(stdout, "%s\n", ce->name);
302         }
303         return 0;
304 }
305
306 static void init_submodule(const char *path, const char *prefix, int quiet)
307 {
308         const struct submodule *sub;
309         struct strbuf sb = STRBUF_INIT;
310         char *upd = NULL, *url = NULL, *displaypath;
311
312         /* Only loads from .gitmodules, no overlay with .git/config */
313         gitmodules_config();
314
315         if (prefix) {
316                 strbuf_addf(&sb, "%s%s", prefix, path);
317                 displaypath = strbuf_detach(&sb, NULL);
318         } else
319                 displaypath = xstrdup(path);
320
321         sub = submodule_from_path(null_sha1, path);
322
323         if (!sub)
324                 die(_("No url found for submodule path '%s' in .gitmodules"),
325                         displaypath);
326
327         /*
328          * Copy url setting when it is not set yet.
329          * To look up the url in .git/config, we must not fall back to
330          * .gitmodules, so look it up directly.
331          */
332         strbuf_reset(&sb);
333         strbuf_addf(&sb, "submodule.%s.url", sub->name);
334         if (git_config_get_string(sb.buf, &url)) {
335                 url = xstrdup(sub->url);
336
337                 if (!url)
338                         die(_("No url found for submodule path '%s' in .gitmodules"),
339                                 displaypath);
340
341                 /* Possibly a url relative to parent */
342                 if (starts_with_dot_dot_slash(url) ||
343                     starts_with_dot_slash(url)) {
344                         char *remoteurl, *relurl;
345                         char *remote = get_default_remote();
346                         struct strbuf remotesb = STRBUF_INIT;
347                         strbuf_addf(&remotesb, "remote.%s.url", remote);
348                         free(remote);
349
350                         if (git_config_get_string(remotesb.buf, &remoteurl))
351                                 /*
352                                  * The repository is its own
353                                  * authoritative upstream
354                                  */
355                                 remoteurl = xgetcwd();
356                         relurl = relative_url(remoteurl, url, NULL);
357                         strbuf_release(&remotesb);
358                         free(remoteurl);
359                         free(url);
360                         url = relurl;
361                 }
362
363                 if (git_config_set_gently(sb.buf, url))
364                         die(_("Failed to register url for submodule path '%s'"),
365                             displaypath);
366                 if (!quiet)
367                         fprintf(stderr,
368                                 _("Submodule '%s' (%s) registered for path '%s'\n"),
369                                 sub->name, url, displaypath);
370         }
371
372         /* Copy "update" setting when it is not set yet */
373         strbuf_reset(&sb);
374         strbuf_addf(&sb, "submodule.%s.update", sub->name);
375         if (git_config_get_string(sb.buf, &upd) &&
376             sub->update_strategy.type != SM_UPDATE_UNSPECIFIED) {
377                 if (sub->update_strategy.type == SM_UPDATE_COMMAND) {
378                         fprintf(stderr, _("warning: command update mode suggested for submodule '%s'\n"),
379                                 sub->name);
380                         upd = xstrdup("none");
381                 } else
382                         upd = xstrdup(submodule_strategy_to_string(&sub->update_strategy));
383
384                 if (git_config_set_gently(sb.buf, upd))
385                         die(_("Failed to register update mode for submodule path '%s'"), displaypath);
386         }
387         strbuf_release(&sb);
388         free(displaypath);
389         free(url);
390         free(upd);
391 }
392
393 static int module_init(int argc, const char **argv, const char *prefix)
394 {
395         struct pathspec pathspec;
396         struct module_list list = MODULE_LIST_INIT;
397         int quiet = 0;
398         int i;
399
400         struct option module_init_options[] = {
401                 OPT_STRING(0, "prefix", &prefix,
402                            N_("path"),
403                            N_("alternative anchor for relative paths")),
404                 OPT__QUIET(&quiet, N_("Suppress output for initializing a submodule")),
405                 OPT_END()
406         };
407
408         const char *const git_submodule_helper_usage[] = {
409                 N_("git submodule--helper init [<path>]"),
410                 NULL
411         };
412
413         argc = parse_options(argc, argv, prefix, module_init_options,
414                              git_submodule_helper_usage, 0);
415
416         if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
417                 return 1;
418
419         for (i = 0; i < list.nr; i++)
420                 init_submodule(list.entries[i]->name, prefix, quiet);
421
422         return 0;
423 }
424
425 static int module_name(int argc, const char **argv, const char *prefix)
426 {
427         const struct submodule *sub;
428
429         if (argc != 2)
430                 usage(_("git submodule--helper name <path>"));
431
432         gitmodules_config();
433         sub = submodule_from_path(null_sha1, argv[1]);
434
435         if (!sub)
436                 die(_("no submodule mapping found in .gitmodules for path '%s'"),
437                     argv[1]);
438
439         printf("%s\n", sub->name);
440
441         return 0;
442 }
443
444 static int clone_submodule(const char *path, const char *gitdir, const char *url,
445                            const char *depth, struct string_list *reference, int quiet)
446 {
447         struct child_process cp = CHILD_PROCESS_INIT;
448
449         argv_array_push(&cp.args, "clone");
450         argv_array_push(&cp.args, "--no-checkout");
451         if (quiet)
452                 argv_array_push(&cp.args, "--quiet");
453         if (depth && *depth)
454                 argv_array_pushl(&cp.args, "--depth", depth, NULL);
455         if (reference->nr) {
456                 struct string_list_item *item;
457                 for_each_string_list_item(item, reference)
458                         argv_array_pushl(&cp.args, "--reference",
459                                          item->string, NULL);
460         }
461         if (gitdir && *gitdir)
462                 argv_array_pushl(&cp.args, "--separate-git-dir", gitdir, NULL);
463
464         argv_array_push(&cp.args, url);
465         argv_array_push(&cp.args, path);
466
467         cp.git_cmd = 1;
468         prepare_submodule_repo_env(&cp.env_array);
469         cp.no_stdin = 1;
470
471         return run_command(&cp);
472 }
473
474 struct submodule_alternate_setup {
475         const char *submodule_name;
476         enum SUBMODULE_ALTERNATE_ERROR_MODE {
477                 SUBMODULE_ALTERNATE_ERROR_DIE,
478                 SUBMODULE_ALTERNATE_ERROR_INFO,
479                 SUBMODULE_ALTERNATE_ERROR_IGNORE
480         } error_mode;
481         struct string_list *reference;
482 };
483 #define SUBMODULE_ALTERNATE_SETUP_INIT { NULL, \
484         SUBMODULE_ALTERNATE_ERROR_IGNORE, NULL }
485
486 static int add_possible_reference_from_superproject(
487                 struct alternate_object_database *alt, void *sas_cb)
488 {
489         struct submodule_alternate_setup *sas = sas_cb;
490
491         /* directory name, minus trailing slash */
492         size_t namelen = alt->name - alt->base - 1;
493         struct strbuf name = STRBUF_INIT;
494         strbuf_add(&name, alt->base, namelen);
495
496         /*
497          * If the alternate object store is another repository, try the
498          * standard layout with .git/modules/<name>/objects
499          */
500         if (ends_with(name.buf, ".git/objects")) {
501                 char *sm_alternate;
502                 struct strbuf sb = STRBUF_INIT;
503                 struct strbuf err = STRBUF_INIT;
504                 strbuf_add(&sb, name.buf, name.len - strlen("objects"));
505                 /*
506                  * We need to end the new path with '/' to mark it as a dir,
507                  * otherwise a submodule name containing '/' will be broken
508                  * as the last part of a missing submodule reference would
509                  * be taken as a file name.
510                  */
511                 strbuf_addf(&sb, "modules/%s/", sas->submodule_name);
512
513                 sm_alternate = compute_alternate_path(sb.buf, &err);
514                 if (sm_alternate) {
515                         string_list_append(sas->reference, xstrdup(sb.buf));
516                         free(sm_alternate);
517                 } else {
518                         switch (sas->error_mode) {
519                         case SUBMODULE_ALTERNATE_ERROR_DIE:
520                                 die(_("submodule '%s' cannot add alternate: %s"),
521                                     sas->submodule_name, err.buf);
522                         case SUBMODULE_ALTERNATE_ERROR_INFO:
523                                 fprintf(stderr, _("submodule '%s' cannot add alternate: %s"),
524                                         sas->submodule_name, err.buf);
525                         case SUBMODULE_ALTERNATE_ERROR_IGNORE:
526                                 ; /* nothing */
527                         }
528                 }
529                 strbuf_release(&sb);
530         }
531
532         strbuf_release(&name);
533         return 0;
534 }
535
536 static void prepare_possible_alternates(const char *sm_name,
537                 struct string_list *reference)
538 {
539         char *sm_alternate = NULL, *error_strategy = NULL;
540         struct submodule_alternate_setup sas = SUBMODULE_ALTERNATE_SETUP_INIT;
541
542         git_config_get_string("submodule.alternateLocation", &sm_alternate);
543         if (!sm_alternate)
544                 return;
545
546         git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
547
548         if (!error_strategy)
549                 error_strategy = xstrdup("die");
550
551         sas.submodule_name = sm_name;
552         sas.reference = reference;
553         if (!strcmp(error_strategy, "die"))
554                 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_DIE;
555         else if (!strcmp(error_strategy, "info"))
556                 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_INFO;
557         else if (!strcmp(error_strategy, "ignore"))
558                 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_IGNORE;
559         else
560                 die(_("Value '%s' for submodule.alternateErrorStrategy is not recognized"), error_strategy);
561
562         if (!strcmp(sm_alternate, "superproject"))
563                 foreach_alt_odb(add_possible_reference_from_superproject, &sas);
564         else if (!strcmp(sm_alternate, "no"))
565                 ; /* do nothing */
566         else
567                 die(_("Value '%s' for submodule.alternateLocation is not recognized"), sm_alternate);
568
569         free(sm_alternate);
570         free(error_strategy);
571 }
572
573 static int module_clone(int argc, const char **argv, const char *prefix)
574 {
575         const char *name = NULL, *url = NULL, *depth = NULL;
576         int quiet = 0;
577         FILE *submodule_dot_git;
578         char *p, *path = NULL, *sm_gitdir;
579         struct strbuf rel_path = STRBUF_INIT;
580         struct strbuf sb = STRBUF_INIT;
581         struct string_list reference = STRING_LIST_INIT_NODUP;
582
583         struct option module_clone_options[] = {
584                 OPT_STRING(0, "prefix", &prefix,
585                            N_("path"),
586                            N_("alternative anchor for relative paths")),
587                 OPT_STRING(0, "path", &path,
588                            N_("path"),
589                            N_("where the new submodule will be cloned to")),
590                 OPT_STRING(0, "name", &name,
591                            N_("string"),
592                            N_("name of the new submodule")),
593                 OPT_STRING(0, "url", &url,
594                            N_("string"),
595                            N_("url where to clone the submodule from")),
596                 OPT_STRING_LIST(0, "reference", &reference,
597                            N_("repo"),
598                            N_("reference repository")),
599                 OPT_STRING(0, "depth", &depth,
600                            N_("string"),
601                            N_("depth for shallow clones")),
602                 OPT__QUIET(&quiet, "Suppress output for cloning a submodule"),
603                 OPT_END()
604         };
605
606         const char *const git_submodule_helper_usage[] = {
607                 N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
608                    "[--reference <repository>] [--name <name>] [--depth <depth>] "
609                    "--url <url> --path <path>"),
610                 NULL
611         };
612
613         argc = parse_options(argc, argv, prefix, module_clone_options,
614                              git_submodule_helper_usage, 0);
615
616         if (argc || !url || !path || !*path)
617                 usage_with_options(git_submodule_helper_usage,
618                                    module_clone_options);
619
620         strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), name);
621         sm_gitdir = xstrdup(absolute_path(sb.buf));
622         strbuf_reset(&sb);
623
624         if (!is_absolute_path(path)) {
625                 strbuf_addf(&sb, "%s/%s", get_git_work_tree(), path);
626                 path = strbuf_detach(&sb, NULL);
627         } else
628                 path = xstrdup(path);
629
630         if (!file_exists(sm_gitdir)) {
631                 if (safe_create_leading_directories_const(sm_gitdir) < 0)
632                         die(_("could not create directory '%s'"), sm_gitdir);
633
634                 prepare_possible_alternates(name, &reference);
635
636                 if (clone_submodule(path, sm_gitdir, url, depth, &reference, quiet))
637                         die(_("clone of '%s' into submodule path '%s' failed"),
638                             url, path);
639         } else {
640                 if (safe_create_leading_directories_const(path) < 0)
641                         die(_("could not create directory '%s'"), path);
642                 strbuf_addf(&sb, "%s/index", sm_gitdir);
643                 unlink_or_warn(sb.buf);
644                 strbuf_reset(&sb);
645         }
646
647         /* Write a .git file in the submodule to redirect to the superproject. */
648         strbuf_addf(&sb, "%s/.git", path);
649         if (safe_create_leading_directories_const(sb.buf) < 0)
650                 die(_("could not create leading directories of '%s'"), sb.buf);
651         submodule_dot_git = fopen(sb.buf, "w");
652         if (!submodule_dot_git)
653                 die_errno(_("cannot open file '%s'"), sb.buf);
654
655         fprintf_or_die(submodule_dot_git, "gitdir: %s\n",
656                        relative_path(sm_gitdir, path, &rel_path));
657         if (fclose(submodule_dot_git))
658                 die(_("could not close file %s"), sb.buf);
659         strbuf_reset(&sb);
660         strbuf_reset(&rel_path);
661
662         /* Redirect the worktree of the submodule in the superproject's config */
663         p = git_pathdup_submodule(path, "config");
664         if (!p)
665                 die(_("could not get submodule directory for '%s'"), path);
666         git_config_set_in_file(p, "core.worktree",
667                                relative_path(path, sm_gitdir, &rel_path));
668         strbuf_release(&sb);
669         strbuf_release(&rel_path);
670         free(sm_gitdir);
671         free(path);
672         free(p);
673         return 0;
674 }
675
676 struct submodule_update_clone {
677         /* index into 'list', the list of submodules to look into for cloning */
678         int current;
679         struct module_list list;
680         unsigned warn_if_uninitialized : 1;
681
682         /* update parameter passed via commandline */
683         struct submodule_update_strategy update;
684
685         /* configuration parameters which are passed on to the children */
686         int quiet;
687         int recommend_shallow;
688         struct string_list references;
689         const char *depth;
690         const char *recursive_prefix;
691         const char *prefix;
692
693         /* Machine-readable status lines to be consumed by git-submodule.sh */
694         struct string_list projectlines;
695
696         /* If we want to stop as fast as possible and return an error */
697         unsigned quickstop : 1;
698
699         /* failed clones to be retried again */
700         const struct cache_entry **failed_clones;
701         int failed_clones_nr, failed_clones_alloc;
702 };
703 #define SUBMODULE_UPDATE_CLONE_INIT {0, MODULE_LIST_INIT, 0, \
704         SUBMODULE_UPDATE_STRATEGY_INIT, 0, -1, STRING_LIST_INIT_DUP, \
705         NULL, NULL, NULL, \
706         STRING_LIST_INIT_DUP, 0, NULL, 0, 0}
707
708
709 static void next_submodule_warn_missing(struct submodule_update_clone *suc,
710                 struct strbuf *out, const char *displaypath)
711 {
712         /*
713          * Only mention uninitialized submodules when their
714          * paths have been specified.
715          */
716         if (suc->warn_if_uninitialized) {
717                 strbuf_addf(out,
718                         _("Submodule path '%s' not initialized"),
719                         displaypath);
720                 strbuf_addch(out, '\n');
721                 strbuf_addstr(out,
722                         _("Maybe you want to use 'update --init'?"));
723                 strbuf_addch(out, '\n');
724         }
725 }
726
727 /**
728  * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
729  * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
730  */
731 static int prepare_to_clone_next_submodule(const struct cache_entry *ce,
732                                            struct child_process *child,
733                                            struct submodule_update_clone *suc,
734                                            struct strbuf *out)
735 {
736         const struct submodule *sub = NULL;
737         struct strbuf displaypath_sb = STRBUF_INIT;
738         struct strbuf sb = STRBUF_INIT;
739         const char *displaypath = NULL;
740         char *url = NULL;
741         int needs_cloning = 0;
742
743         if (ce_stage(ce)) {
744                 if (suc->recursive_prefix)
745                         strbuf_addf(&sb, "%s/%s", suc->recursive_prefix, ce->name);
746                 else
747                         strbuf_addf(&sb, "%s", ce->name);
748                 strbuf_addf(out, _("Skipping unmerged submodule %s"), sb.buf);
749                 strbuf_addch(out, '\n');
750                 goto cleanup;
751         }
752
753         sub = submodule_from_path(null_sha1, ce->name);
754
755         if (suc->recursive_prefix)
756                 displaypath = relative_path(suc->recursive_prefix,
757                                             ce->name, &displaypath_sb);
758         else
759                 displaypath = ce->name;
760
761         if (!sub) {
762                 next_submodule_warn_missing(suc, out, displaypath);
763                 goto cleanup;
764         }
765
766         if (suc->update.type == SM_UPDATE_NONE
767             || (suc->update.type == SM_UPDATE_UNSPECIFIED
768                 && sub->update_strategy.type == SM_UPDATE_NONE)) {
769                 strbuf_addf(out, _("Skipping submodule '%s'"), displaypath);
770                 strbuf_addch(out, '\n');
771                 goto cleanup;
772         }
773
774         /*
775          * Looking up the url in .git/config.
776          * We must not fall back to .gitmodules as we only want
777          * to process configured submodules.
778          */
779         strbuf_reset(&sb);
780         strbuf_addf(&sb, "submodule.%s.url", sub->name);
781         git_config_get_string(sb.buf, &url);
782         if (!url) {
783                 next_submodule_warn_missing(suc, out, displaypath);
784                 goto cleanup;
785         }
786
787         strbuf_reset(&sb);
788         strbuf_addf(&sb, "%s/.git", ce->name);
789         needs_cloning = !file_exists(sb.buf);
790
791         strbuf_reset(&sb);
792         strbuf_addf(&sb, "%06o %s %d %d\t%s\n", ce->ce_mode,
793                         sha1_to_hex(ce->sha1), ce_stage(ce),
794                         needs_cloning, ce->name);
795         string_list_append(&suc->projectlines, sb.buf);
796
797         if (!needs_cloning)
798                 goto cleanup;
799
800         child->git_cmd = 1;
801         child->no_stdin = 1;
802         child->stdout_to_stderr = 1;
803         child->err = -1;
804         argv_array_push(&child->args, "submodule--helper");
805         argv_array_push(&child->args, "clone");
806         if (suc->quiet)
807                 argv_array_push(&child->args, "--quiet");
808         if (suc->prefix)
809                 argv_array_pushl(&child->args, "--prefix", suc->prefix, NULL);
810         if (suc->recommend_shallow && sub->recommend_shallow == 1)
811                 argv_array_push(&child->args, "--depth=1");
812         argv_array_pushl(&child->args, "--path", sub->path, NULL);
813         argv_array_pushl(&child->args, "--name", sub->name, NULL);
814         argv_array_pushl(&child->args, "--url", url, NULL);
815         if (suc->references.nr) {
816                 struct string_list_item *item;
817                 for_each_string_list_item(item, &suc->references)
818                         argv_array_pushl(&child->args, "--reference", item->string, NULL);
819         }
820         if (suc->depth)
821                 argv_array_push(&child->args, suc->depth);
822
823 cleanup:
824         free(url);
825         strbuf_reset(&displaypath_sb);
826         strbuf_reset(&sb);
827
828         return needs_cloning;
829 }
830
831 static int update_clone_get_next_task(struct child_process *child,
832                                       struct strbuf *err,
833                                       void *suc_cb,
834                                       void **idx_task_cb)
835 {
836         struct submodule_update_clone *suc = suc_cb;
837         const struct cache_entry *ce;
838         int index;
839
840         for (; suc->current < suc->list.nr; suc->current++) {
841                 ce = suc->list.entries[suc->current];
842                 if (prepare_to_clone_next_submodule(ce, child, suc, err)) {
843                         int *p = xmalloc(sizeof(*p));
844                         *p = suc->current;
845                         *idx_task_cb = p;
846                         suc->current++;
847                         return 1;
848                 }
849         }
850
851         /*
852          * The loop above tried cloning each submodule once, now try the
853          * stragglers again, which we can imagine as an extension of the
854          * entry list.
855          */
856         index = suc->current - suc->list.nr;
857         if (index < suc->failed_clones_nr) {
858                 int *p;
859                 ce = suc->failed_clones[index];
860                 if (!prepare_to_clone_next_submodule(ce, child, suc, err)) {
861                         suc->current ++;
862                         strbuf_addf(err, "BUG: submodule considered for cloning,"
863                                     "doesn't need cloning any more?\n");
864                         return 0;
865                 }
866                 p = xmalloc(sizeof(*p));
867                 *p = suc->current;
868                 *idx_task_cb = p;
869                 suc->current ++;
870                 return 1;
871         }
872
873         return 0;
874 }
875
876 static int update_clone_start_failure(struct strbuf *err,
877                                       void *suc_cb,
878                                       void *idx_task_cb)
879 {
880         struct submodule_update_clone *suc = suc_cb;
881         suc->quickstop = 1;
882         return 1;
883 }
884
885 static int update_clone_task_finished(int result,
886                                       struct strbuf *err,
887                                       void *suc_cb,
888                                       void *idx_task_cb)
889 {
890         const struct cache_entry *ce;
891         struct submodule_update_clone *suc = suc_cb;
892
893         int *idxP = *(int**)idx_task_cb;
894         int idx = *idxP;
895         free(idxP);
896
897         if (!result)
898                 return 0;
899
900         if (idx < suc->list.nr) {
901                 ce  = suc->list.entries[idx];
902                 strbuf_addf(err, _("Failed to clone '%s'. Retry scheduled"),
903                             ce->name);
904                 strbuf_addch(err, '\n');
905                 ALLOC_GROW(suc->failed_clones,
906                            suc->failed_clones_nr + 1,
907                            suc->failed_clones_alloc);
908                 suc->failed_clones[suc->failed_clones_nr++] = ce;
909                 return 0;
910         } else {
911                 idx -= suc->list.nr;
912                 ce  = suc->failed_clones[idx];
913                 strbuf_addf(err, _("Failed to clone '%s' a second time, aborting"),
914                             ce->name);
915                 strbuf_addch(err, '\n');
916                 suc->quickstop = 1;
917                 return 1;
918         }
919
920         return 0;
921 }
922
923 static int update_clone(int argc, const char **argv, const char *prefix)
924 {
925         const char *update = NULL;
926         int max_jobs = -1;
927         struct string_list_item *item;
928         struct pathspec pathspec;
929         struct submodule_update_clone suc = SUBMODULE_UPDATE_CLONE_INIT;
930
931         struct option module_update_clone_options[] = {
932                 OPT_STRING(0, "prefix", &prefix,
933                            N_("path"),
934                            N_("path into the working tree")),
935                 OPT_STRING(0, "recursive-prefix", &suc.recursive_prefix,
936                            N_("path"),
937                            N_("path into the working tree, across nested "
938                               "submodule boundaries")),
939                 OPT_STRING(0, "update", &update,
940                            N_("string"),
941                            N_("rebase, merge, checkout or none")),
942                 OPT_STRING_LIST(0, "reference", &suc.references, N_("repo"),
943                            N_("reference repository")),
944                 OPT_STRING(0, "depth", &suc.depth, "<depth>",
945                            N_("Create a shallow clone truncated to the "
946                               "specified number of revisions")),
947                 OPT_INTEGER('j', "jobs", &max_jobs,
948                             N_("parallel jobs")),
949                 OPT_BOOL(0, "recommend-shallow", &suc.recommend_shallow,
950                             N_("whether the initial clone should follow the shallow recommendation")),
951                 OPT__QUIET(&suc.quiet, N_("don't print cloning progress")),
952                 OPT_END()
953         };
954
955         const char *const git_submodule_helper_usage[] = {
956                 N_("git submodule--helper update_clone [--prefix=<path>] [<path>...]"),
957                 NULL
958         };
959         suc.prefix = prefix;
960
961         argc = parse_options(argc, argv, prefix, module_update_clone_options,
962                              git_submodule_helper_usage, 0);
963
964         if (update)
965                 if (parse_submodule_update_strategy(update, &suc.update) < 0)
966                         die(_("bad value for update parameter"));
967
968         if (module_list_compute(argc, argv, prefix, &pathspec, &suc.list) < 0)
969                 return 1;
970
971         if (pathspec.nr)
972                 suc.warn_if_uninitialized = 1;
973
974         /* Overlay the parsed .gitmodules file with .git/config */
975         gitmodules_config();
976         git_config(submodule_config, NULL);
977
978         if (max_jobs < 0)
979                 max_jobs = parallel_submodules();
980
981         run_processes_parallel(max_jobs,
982                                update_clone_get_next_task,
983                                update_clone_start_failure,
984                                update_clone_task_finished,
985                                &suc);
986
987         /*
988          * We saved the output and put it out all at once now.
989          * That means:
990          * - the listener does not have to interleave their (checkout)
991          *   work with our fetching.  The writes involved in a
992          *   checkout involve more straightforward sequential I/O.
993          * - the listener can avoid doing any work if fetching failed.
994          */
995         if (suc.quickstop)
996                 return 1;
997
998         for_each_string_list_item(item, &suc.projectlines)
999                 utf8_fprintf(stdout, "%s", item->string);
1000
1001         return 0;
1002 }
1003
1004 static int resolve_relative_path(int argc, const char **argv, const char *prefix)
1005 {
1006         struct strbuf sb = STRBUF_INIT;
1007         if (argc != 3)
1008                 die("submodule--helper relative-path takes exactly 2 arguments, got %d", argc);
1009
1010         printf("%s", relative_path(argv[1], argv[2], &sb));
1011         strbuf_release(&sb);
1012         return 0;
1013 }
1014
1015 static const char *remote_submodule_branch(const char *path)
1016 {
1017         const struct submodule *sub;
1018         gitmodules_config();
1019         git_config(submodule_config, NULL);
1020
1021         sub = submodule_from_path(null_sha1, path);
1022         if (!sub)
1023                 return NULL;
1024
1025         if (!sub->branch)
1026                 return "master";
1027
1028         if (!strcmp(sub->branch, ".")) {
1029                 unsigned char sha1[20];
1030                 const char *refname = resolve_ref_unsafe("HEAD", 0, sha1, NULL);
1031
1032                 if (!refname)
1033                         die(_("No such ref: %s"), "HEAD");
1034
1035                 /* detached HEAD */
1036                 if (!strcmp(refname, "HEAD"))
1037                         die(_("Submodule (%s) branch configured to inherit "
1038                               "branch from superproject, but the superproject "
1039                               "is not on any branch"), sub->name);
1040
1041                 if (!skip_prefix(refname, "refs/heads/", &refname))
1042                         die(_("Expecting a full ref name, got %s"), refname);
1043                 return refname;
1044         }
1045
1046         return sub->branch;
1047 }
1048
1049 static int resolve_remote_submodule_branch(int argc, const char **argv,
1050                 const char *prefix)
1051 {
1052         const char *ret;
1053         struct strbuf sb = STRBUF_INIT;
1054         if (argc != 2)
1055                 die("submodule--helper remote-branch takes exactly one arguments, got %d", argc);
1056
1057         ret = remote_submodule_branch(argv[1]);
1058         if (!ret)
1059                 die("submodule %s doesn't exist", argv[1]);
1060
1061         printf("%s", ret);
1062         strbuf_release(&sb);
1063         return 0;
1064 }
1065
1066 struct cmd_struct {
1067         const char *cmd;
1068         int (*fn)(int, const char **, const char *);
1069 };
1070
1071 static struct cmd_struct commands[] = {
1072         {"list", module_list},
1073         {"name", module_name},
1074         {"clone", module_clone},
1075         {"update-clone", update_clone},
1076         {"relative-path", resolve_relative_path},
1077         {"resolve-relative-url", resolve_relative_url},
1078         {"resolve-relative-url-test", resolve_relative_url_test},
1079         {"init", module_init},
1080         {"remote-branch", resolve_remote_submodule_branch}
1081 };
1082
1083 int cmd_submodule__helper(int argc, const char **argv, const char *prefix)
1084 {
1085         int i;
1086         if (argc < 2)
1087                 die(_("submodule--helper subcommand must be "
1088                       "called with a subcommand"));
1089
1090         for (i = 0; i < ARRAY_SIZE(commands); i++)
1091                 if (!strcmp(argv[1], commands[i].cmd))
1092                         return commands[i].fn(argc - 1, argv + 1, prefix);
1093
1094         die(_("'%s' is not a valid submodule--helper "
1095               "subcommand"), argv[1]);
1096 }