fast-export: fix regression skipping some merge-commits
[git] / builtin / submodule--helper.c
1 #include "builtin.h"
2 #include "repository.h"
3 #include "cache.h"
4 #include "config.h"
5 #include "parse-options.h"
6 #include "quote.h"
7 #include "pathspec.h"
8 #include "dir.h"
9 #include "submodule.h"
10 #include "submodule-config.h"
11 #include "string-list.h"
12 #include "run-command.h"
13 #include "remote.h"
14 #include "refs.h"
15 #include "connect.h"
16 #include "revision.h"
17 #include "diffcore.h"
18 #include "diff.h"
19
20 #define OPT_QUIET (1 << 0)
21 #define OPT_CACHED (1 << 1)
22 #define OPT_RECURSIVE (1 << 2)
23
24 typedef void (*each_submodule_fn)(const struct cache_entry *list_item,
25                                   void *cb_data);
26
27 static char *get_default_remote(void)
28 {
29         char *dest = NULL, *ret;
30         struct strbuf sb = STRBUF_INIT;
31         const char *refname = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
32
33         if (!refname)
34                 die(_("No such ref: %s"), "HEAD");
35
36         /* detached HEAD */
37         if (!strcmp(refname, "HEAD"))
38                 return xstrdup("origin");
39
40         if (!skip_prefix(refname, "refs/heads/", &refname))
41                 die(_("Expecting a full ref name, got %s"), refname);
42
43         strbuf_addf(&sb, "branch.%s.remote", refname);
44         if (git_config_get_string(sb.buf, &dest))
45                 ret = xstrdup("origin");
46         else
47                 ret = dest;
48
49         strbuf_release(&sb);
50         return ret;
51 }
52
53 static int starts_with_dot_slash(const char *str)
54 {
55         return str[0] == '.' && is_dir_sep(str[1]);
56 }
57
58 static int starts_with_dot_dot_slash(const char *str)
59 {
60         return str[0] == '.' && str[1] == '.' && is_dir_sep(str[2]);
61 }
62
63 /*
64  * Returns 1 if it was the last chop before ':'.
65  */
66 static int chop_last_dir(char **remoteurl, int is_relative)
67 {
68         char *rfind = find_last_dir_sep(*remoteurl);
69         if (rfind) {
70                 *rfind = '\0';
71                 return 0;
72         }
73
74         rfind = strrchr(*remoteurl, ':');
75         if (rfind) {
76                 *rfind = '\0';
77                 return 1;
78         }
79
80         if (is_relative || !strcmp(".", *remoteurl))
81                 die(_("cannot strip one component off url '%s'"),
82                         *remoteurl);
83
84         free(*remoteurl);
85         *remoteurl = xstrdup(".");
86         return 0;
87 }
88
89 /*
90  * The `url` argument is the URL that navigates to the submodule origin
91  * repo. When relative, this URL is relative to the superproject origin
92  * URL repo. The `up_path` argument, if specified, is the relative
93  * path that navigates from the submodule working tree to the superproject
94  * working tree. Returns the origin URL of the submodule.
95  *
96  * Return either an absolute URL or filesystem path (if the superproject
97  * origin URL is an absolute URL or filesystem path, respectively) or a
98  * relative file system path (if the superproject origin URL is a relative
99  * file system path).
100  *
101  * When the output is a relative file system path, the path is either
102  * relative to the submodule working tree, if up_path is specified, or to
103  * the superproject working tree otherwise.
104  *
105  * NEEDSWORK: This works incorrectly on the domain and protocol part.
106  * remote_url      url              outcome          expectation
107  * http://a.com/b  ../c             http://a.com/c   as is
108  * http://a.com/b/ ../c             http://a.com/c   same as previous line, but
109  *                                                   ignore trailing slash in url
110  * http://a.com/b  ../../c          http://c         error out
111  * http://a.com/b  ../../../c       http:/c          error out
112  * http://a.com/b  ../../../../c    http:c           error out
113  * http://a.com/b  ../../../../../c    .:c           error out
114  * NEEDSWORK: Given how chop_last_dir() works, this function is broken
115  * when a local part has a colon in its path component, too.
116  */
117 static char *relative_url(const char *remote_url,
118                                 const char *url,
119                                 const char *up_path)
120 {
121         int is_relative = 0;
122         int colonsep = 0;
123         char *out;
124         char *remoteurl = xstrdup(remote_url);
125         struct strbuf sb = STRBUF_INIT;
126         size_t len = strlen(remoteurl);
127
128         if (is_dir_sep(remoteurl[len-1]))
129                 remoteurl[len-1] = '\0';
130
131         if (!url_is_local_not_ssh(remoteurl) || is_absolute_path(remoteurl))
132                 is_relative = 0;
133         else {
134                 is_relative = 1;
135                 /*
136                  * Prepend a './' to ensure all relative
137                  * remoteurls start with './' or '../'
138                  */
139                 if (!starts_with_dot_slash(remoteurl) &&
140                     !starts_with_dot_dot_slash(remoteurl)) {
141                         strbuf_reset(&sb);
142                         strbuf_addf(&sb, "./%s", remoteurl);
143                         free(remoteurl);
144                         remoteurl = strbuf_detach(&sb, NULL);
145                 }
146         }
147         /*
148          * When the url starts with '../', remove that and the
149          * last directory in remoteurl.
150          */
151         while (url) {
152                 if (starts_with_dot_dot_slash(url)) {
153                         url += 3;
154                         colonsep |= chop_last_dir(&remoteurl, is_relative);
155                 } else if (starts_with_dot_slash(url))
156                         url += 2;
157                 else
158                         break;
159         }
160         strbuf_reset(&sb);
161         strbuf_addf(&sb, "%s%s%s", remoteurl, colonsep ? ":" : "/", url);
162         if (ends_with(url, "/"))
163                 strbuf_setlen(&sb, sb.len - 1);
164         free(remoteurl);
165
166         if (starts_with_dot_slash(sb.buf))
167                 out = xstrdup(sb.buf + 2);
168         else
169                 out = xstrdup(sb.buf);
170         strbuf_reset(&sb);
171
172         if (!up_path || !is_relative)
173                 return out;
174
175         strbuf_addf(&sb, "%s%s", up_path, out);
176         free(out);
177         return strbuf_detach(&sb, NULL);
178 }
179
180 static int resolve_relative_url(int argc, const char **argv, const char *prefix)
181 {
182         char *remoteurl = NULL;
183         char *remote = get_default_remote();
184         const char *up_path = NULL;
185         char *res;
186         const char *url;
187         struct strbuf sb = STRBUF_INIT;
188
189         if (argc != 2 && argc != 3)
190                 die("resolve-relative-url only accepts one or two arguments");
191
192         url = argv[1];
193         strbuf_addf(&sb, "remote.%s.url", remote);
194         free(remote);
195
196         if (git_config_get_string(sb.buf, &remoteurl))
197                 /* the repository is its own authoritative upstream */
198                 remoteurl = xgetcwd();
199
200         if (argc == 3)
201                 up_path = argv[2];
202
203         res = relative_url(remoteurl, url, up_path);
204         puts(res);
205         free(res);
206         free(remoteurl);
207         return 0;
208 }
209
210 static int resolve_relative_url_test(int argc, const char **argv, const char *prefix)
211 {
212         char *remoteurl, *res;
213         const char *up_path, *url;
214
215         if (argc != 4)
216                 die("resolve-relative-url-test only accepts three arguments: <up_path> <remoteurl> <url>");
217
218         up_path = argv[1];
219         remoteurl = xstrdup(argv[2]);
220         url = argv[3];
221
222         if (!strcmp(up_path, "(null)"))
223                 up_path = NULL;
224
225         res = relative_url(remoteurl, url, up_path);
226         puts(res);
227         free(res);
228         free(remoteurl);
229         return 0;
230 }
231
232 /* the result should be freed by the caller. */
233 static char *get_submodule_displaypath(const char *path, const char *prefix)
234 {
235         const char *super_prefix = get_super_prefix();
236
237         if (prefix && super_prefix) {
238                 BUG("cannot have prefix '%s' and superprefix '%s'",
239                     prefix, super_prefix);
240         } else if (prefix) {
241                 struct strbuf sb = STRBUF_INIT;
242                 char *displaypath = xstrdup(relative_path(path, prefix, &sb));
243                 strbuf_release(&sb);
244                 return displaypath;
245         } else if (super_prefix) {
246                 return xstrfmt("%s%s", super_prefix, path);
247         } else {
248                 return xstrdup(path);
249         }
250 }
251
252 static char *compute_rev_name(const char *sub_path, const char* object_id)
253 {
254         struct strbuf sb = STRBUF_INIT;
255         const char ***d;
256
257         static const char *describe_bare[] = { NULL };
258
259         static const char *describe_tags[] = { "--tags", NULL };
260
261         static const char *describe_contains[] = { "--contains", NULL };
262
263         static const char *describe_all_always[] = { "--all", "--always", NULL };
264
265         static const char **describe_argv[] = { describe_bare, describe_tags,
266                                                 describe_contains,
267                                                 describe_all_always, NULL };
268
269         for (d = describe_argv; *d; d++) {
270                 struct child_process cp = CHILD_PROCESS_INIT;
271                 prepare_submodule_repo_env(&cp.env_array);
272                 cp.dir = sub_path;
273                 cp.git_cmd = 1;
274                 cp.no_stderr = 1;
275
276                 argv_array_push(&cp.args, "describe");
277                 argv_array_pushv(&cp.args, *d);
278                 argv_array_push(&cp.args, object_id);
279
280                 if (!capture_command(&cp, &sb, 0)) {
281                         strbuf_strip_suffix(&sb, "\n");
282                         return strbuf_detach(&sb, NULL);
283                 }
284         }
285
286         strbuf_release(&sb);
287         return NULL;
288 }
289
290 struct module_list {
291         const struct cache_entry **entries;
292         int alloc, nr;
293 };
294 #define MODULE_LIST_INIT { NULL, 0, 0 }
295
296 static int module_list_compute(int argc, const char **argv,
297                                const char *prefix,
298                                struct pathspec *pathspec,
299                                struct module_list *list)
300 {
301         int i, result = 0;
302         char *ps_matched = NULL;
303         parse_pathspec(pathspec, 0,
304                        PATHSPEC_PREFER_FULL,
305                        prefix, argv);
306
307         if (pathspec->nr)
308                 ps_matched = xcalloc(pathspec->nr, 1);
309
310         if (read_cache() < 0)
311                 die(_("index file corrupt"));
312
313         for (i = 0; i < active_nr; i++) {
314                 const struct cache_entry *ce = active_cache[i];
315
316                 if (!match_pathspec(pathspec, ce->name, ce_namelen(ce),
317                                     0, ps_matched, 1) ||
318                     !S_ISGITLINK(ce->ce_mode))
319                         continue;
320
321                 ALLOC_GROW(list->entries, list->nr + 1, list->alloc);
322                 list->entries[list->nr++] = ce;
323                 while (i + 1 < active_nr &&
324                        !strcmp(ce->name, active_cache[i + 1]->name))
325                         /*
326                          * Skip entries with the same name in different stages
327                          * to make sure an entry is returned only once.
328                          */
329                         i++;
330         }
331
332         if (ps_matched && report_path_error(ps_matched, pathspec, prefix))
333                 result = -1;
334
335         free(ps_matched);
336
337         return result;
338 }
339
340 static void module_list_active(struct module_list *list)
341 {
342         int i;
343         struct module_list active_modules = MODULE_LIST_INIT;
344
345         for (i = 0; i < list->nr; i++) {
346                 const struct cache_entry *ce = list->entries[i];
347
348                 if (!is_submodule_active(the_repository, ce->name))
349                         continue;
350
351                 ALLOC_GROW(active_modules.entries,
352                            active_modules.nr + 1,
353                            active_modules.alloc);
354                 active_modules.entries[active_modules.nr++] = ce;
355         }
356
357         free(list->entries);
358         *list = active_modules;
359 }
360
361 static int module_list(int argc, const char **argv, const char *prefix)
362 {
363         int i;
364         struct pathspec pathspec;
365         struct module_list list = MODULE_LIST_INIT;
366
367         struct option module_list_options[] = {
368                 OPT_STRING(0, "prefix", &prefix,
369                            N_("path"),
370                            N_("alternative anchor for relative paths")),
371                 OPT_END()
372         };
373
374         const char *const git_submodule_helper_usage[] = {
375                 N_("git submodule--helper list [--prefix=<path>] [<path>...]"),
376                 NULL
377         };
378
379         argc = parse_options(argc, argv, prefix, module_list_options,
380                              git_submodule_helper_usage, 0);
381
382         if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
383                 return 1;
384
385         for (i = 0; i < list.nr; i++) {
386                 const struct cache_entry *ce = list.entries[i];
387
388                 if (ce_stage(ce))
389                         printf("%06o %s U\t", ce->ce_mode, sha1_to_hex(null_sha1));
390                 else
391                         printf("%06o %s %d\t", ce->ce_mode,
392                                oid_to_hex(&ce->oid), ce_stage(ce));
393
394                 fprintf(stdout, "%s\n", ce->name);
395         }
396         return 0;
397 }
398
399 static void for_each_listed_submodule(const struct module_list *list,
400                                       each_submodule_fn fn, void *cb_data)
401 {
402         int i;
403         for (i = 0; i < list->nr; i++)
404                 fn(list->entries[i], cb_data);
405 }
406
407 struct init_cb {
408         const char *prefix;
409         unsigned int flags;
410 };
411
412 #define INIT_CB_INIT { NULL, 0 }
413
414 static void init_submodule(const char *path, const char *prefix,
415                            unsigned int flags)
416 {
417         const struct submodule *sub;
418         struct strbuf sb = STRBUF_INIT;
419         char *upd = NULL, *url = NULL, *displaypath;
420
421         displaypath = get_submodule_displaypath(path, prefix);
422
423         sub = submodule_from_path(&null_oid, path);
424
425         if (!sub)
426                 die(_("No url found for submodule path '%s' in .gitmodules"),
427                         displaypath);
428
429         /*
430          * NEEDSWORK: In a multi-working-tree world, this needs to be
431          * set in the per-worktree config.
432          *
433          * Set active flag for the submodule being initialized
434          */
435         if (!is_submodule_active(the_repository, path)) {
436                 strbuf_addf(&sb, "submodule.%s.active", sub->name);
437                 git_config_set_gently(sb.buf, "true");
438                 strbuf_reset(&sb);
439         }
440
441         /*
442          * Copy url setting when it is not set yet.
443          * To look up the url in .git/config, we must not fall back to
444          * .gitmodules, so look it up directly.
445          */
446         strbuf_addf(&sb, "submodule.%s.url", sub->name);
447         if (git_config_get_string(sb.buf, &url)) {
448                 if (!sub->url)
449                         die(_("No url found for submodule path '%s' in .gitmodules"),
450                                 displaypath);
451
452                 url = xstrdup(sub->url);
453
454                 /* Possibly a url relative to parent */
455                 if (starts_with_dot_dot_slash(url) ||
456                     starts_with_dot_slash(url)) {
457                         char *remoteurl, *relurl;
458                         char *remote = get_default_remote();
459                         struct strbuf remotesb = STRBUF_INIT;
460                         strbuf_addf(&remotesb, "remote.%s.url", remote);
461                         free(remote);
462
463                         if (git_config_get_string(remotesb.buf, &remoteurl)) {
464                                 warning(_("could not lookup configuration '%s'. Assuming this repository is its own authoritative upstream."), remotesb.buf);
465                                 remoteurl = xgetcwd();
466                         }
467                         relurl = relative_url(remoteurl, url, NULL);
468                         strbuf_release(&remotesb);
469                         free(remoteurl);
470                         free(url);
471                         url = relurl;
472                 }
473
474                 if (git_config_set_gently(sb.buf, url))
475                         die(_("Failed to register url for submodule path '%s'"),
476                             displaypath);
477                 if (!(flags & OPT_QUIET))
478                         fprintf(stderr,
479                                 _("Submodule '%s' (%s) registered for path '%s'\n"),
480                                 sub->name, url, displaypath);
481         }
482         strbuf_reset(&sb);
483
484         /* Copy "update" setting when it is not set yet */
485         strbuf_addf(&sb, "submodule.%s.update", sub->name);
486         if (git_config_get_string(sb.buf, &upd) &&
487             sub->update_strategy.type != SM_UPDATE_UNSPECIFIED) {
488                 if (sub->update_strategy.type == SM_UPDATE_COMMAND) {
489                         fprintf(stderr, _("warning: command update mode suggested for submodule '%s'\n"),
490                                 sub->name);
491                         upd = xstrdup("none");
492                 } else
493                         upd = xstrdup(submodule_strategy_to_string(&sub->update_strategy));
494
495                 if (git_config_set_gently(sb.buf, upd))
496                         die(_("Failed to register update mode for submodule path '%s'"), displaypath);
497         }
498         strbuf_release(&sb);
499         free(displaypath);
500         free(url);
501         free(upd);
502 }
503
504 static void init_submodule_cb(const struct cache_entry *list_item, void *cb_data)
505 {
506         struct init_cb *info = cb_data;
507         init_submodule(list_item->name, info->prefix, info->flags);
508 }
509
510 static int module_init(int argc, const char **argv, const char *prefix)
511 {
512         struct init_cb info = INIT_CB_INIT;
513         struct pathspec pathspec;
514         struct module_list list = MODULE_LIST_INIT;
515         int quiet = 0;
516
517         struct option module_init_options[] = {
518                 OPT__QUIET(&quiet, N_("Suppress output for initializing a submodule")),
519                 OPT_END()
520         };
521
522         const char *const git_submodule_helper_usage[] = {
523                 N_("git submodule--helper init [<path>]"),
524                 NULL
525         };
526
527         argc = parse_options(argc, argv, prefix, module_init_options,
528                              git_submodule_helper_usage, 0);
529
530         if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
531                 return 1;
532
533         /*
534          * If there are no path args and submodule.active is set then,
535          * by default, only initialize 'active' modules.
536          */
537         if (!argc && git_config_get_value_multi("submodule.active"))
538                 module_list_active(&list);
539
540         info.prefix = prefix;
541         if (quiet)
542                 info.flags |= OPT_QUIET;
543
544         for_each_listed_submodule(&list, init_submodule_cb, &info);
545
546         return 0;
547 }
548
549 struct status_cb {
550         const char *prefix;
551         unsigned int flags;
552 };
553
554 #define STATUS_CB_INIT { NULL, 0 }
555
556 static void print_status(unsigned int flags, char state, const char *path,
557                          const struct object_id *oid, const char *displaypath)
558 {
559         if (flags & OPT_QUIET)
560                 return;
561
562         printf("%c%s %s", state, oid_to_hex(oid), displaypath);
563
564         if (state == ' ' || state == '+')
565                 printf(" (%s)", compute_rev_name(path, oid_to_hex(oid)));
566
567         printf("\n");
568 }
569
570 static int handle_submodule_head_ref(const char *refname,
571                                      const struct object_id *oid, int flags,
572                                      void *cb_data)
573 {
574         struct object_id *output = cb_data;
575         if (oid)
576                 oidcpy(output, oid);
577
578         return 0;
579 }
580
581 static void status_submodule(const char *path, const struct object_id *ce_oid,
582                              unsigned int ce_flags, const char *prefix,
583                              unsigned int flags)
584 {
585         char *displaypath;
586         struct argv_array diff_files_args = ARGV_ARRAY_INIT;
587         struct rev_info rev;
588         int diff_files_result;
589
590         if (!submodule_from_path(&null_oid, path))
591                 die(_("no submodule mapping found in .gitmodules for path '%s'"),
592                       path);
593
594         displaypath = get_submodule_displaypath(path, prefix);
595
596         if ((CE_STAGEMASK & ce_flags) >> CE_STAGESHIFT) {
597                 print_status(flags, 'U', path, &null_oid, displaypath);
598                 goto cleanup;
599         }
600
601         if (!is_submodule_active(the_repository, path)) {
602                 print_status(flags, '-', path, ce_oid, displaypath);
603                 goto cleanup;
604         }
605
606         argv_array_pushl(&diff_files_args, "diff-files",
607                          "--ignore-submodules=dirty", "--quiet", "--",
608                          path, NULL);
609
610         git_config(git_diff_basic_config, NULL);
611         init_revisions(&rev, prefix);
612         rev.abbrev = 0;
613         diff_files_args.argc = setup_revisions(diff_files_args.argc,
614                                                diff_files_args.argv,
615                                                &rev, NULL);
616         diff_files_result = run_diff_files(&rev, 0);
617
618         if (!diff_result_code(&rev.diffopt, diff_files_result)) {
619                 print_status(flags, ' ', path, ce_oid,
620                              displaypath);
621         } else if (!(flags & OPT_CACHED)) {
622                 struct object_id oid;
623
624                 if (refs_head_ref(get_submodule_ref_store(path),
625                                   handle_submodule_head_ref, &oid))
626                         die(_("could not resolve HEAD ref inside the "
627                               "submodule '%s'"), path);
628
629                 print_status(flags, '+', path, &oid, displaypath);
630         } else {
631                 print_status(flags, '+', path, ce_oid, displaypath);
632         }
633
634         if (flags & OPT_RECURSIVE) {
635                 struct child_process cpr = CHILD_PROCESS_INIT;
636
637                 cpr.git_cmd = 1;
638                 cpr.dir = path;
639                 prepare_submodule_repo_env(&cpr.env_array);
640
641                 argv_array_push(&cpr.args, "--super-prefix");
642                 argv_array_pushf(&cpr.args, "%s/", displaypath);
643                 argv_array_pushl(&cpr.args, "submodule--helper", "status",
644                                  "--recursive", NULL);
645
646                 if (flags & OPT_CACHED)
647                         argv_array_push(&cpr.args, "--cached");
648
649                 if (flags & OPT_QUIET)
650                         argv_array_push(&cpr.args, "--quiet");
651
652                 if (run_command(&cpr))
653                         die(_("failed to recurse into submodule '%s'"), path);
654         }
655
656 cleanup:
657         argv_array_clear(&diff_files_args);
658         free(displaypath);
659 }
660
661 static void status_submodule_cb(const struct cache_entry *list_item,
662                                 void *cb_data)
663 {
664         struct status_cb *info = cb_data;
665         status_submodule(list_item->name, &list_item->oid, list_item->ce_flags,
666                          info->prefix, info->flags);
667 }
668
669 static int module_status(int argc, const char **argv, const char *prefix)
670 {
671         struct status_cb info = STATUS_CB_INIT;
672         struct pathspec pathspec;
673         struct module_list list = MODULE_LIST_INIT;
674         int quiet = 0;
675
676         struct option module_status_options[] = {
677                 OPT__QUIET(&quiet, N_("Suppress submodule status output")),
678                 OPT_BIT(0, "cached", &info.flags, N_("Use commit stored in the index instead of the one stored in the submodule HEAD"), OPT_CACHED),
679                 OPT_BIT(0, "recursive", &info.flags, N_("recurse into nested submodules"), OPT_RECURSIVE),
680                 OPT_END()
681         };
682
683         const char *const git_submodule_helper_usage[] = {
684                 N_("git submodule status [--quiet] [--cached] [--recursive] [<path>...]"),
685                 NULL
686         };
687
688         argc = parse_options(argc, argv, prefix, module_status_options,
689                              git_submodule_helper_usage, 0);
690
691         if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
692                 return 1;
693
694         info.prefix = prefix;
695         if (quiet)
696                 info.flags |= OPT_QUIET;
697
698         for_each_listed_submodule(&list, status_submodule_cb, &info);
699
700         return 0;
701 }
702
703 static int module_name(int argc, const char **argv, const char *prefix)
704 {
705         const struct submodule *sub;
706
707         if (argc != 2)
708                 usage(_("git submodule--helper name <path>"));
709
710         sub = submodule_from_path(&null_oid, argv[1]);
711
712         if (!sub)
713                 die(_("no submodule mapping found in .gitmodules for path '%s'"),
714                     argv[1]);
715
716         printf("%s\n", sub->name);
717
718         return 0;
719 }
720
721 static int clone_submodule(const char *path, const char *gitdir, const char *url,
722                            const char *depth, struct string_list *reference,
723                            int quiet, int progress)
724 {
725         struct child_process cp = CHILD_PROCESS_INIT;
726
727         argv_array_push(&cp.args, "clone");
728         argv_array_push(&cp.args, "--no-checkout");
729         if (quiet)
730                 argv_array_push(&cp.args, "--quiet");
731         if (progress)
732                 argv_array_push(&cp.args, "--progress");
733         if (depth && *depth)
734                 argv_array_pushl(&cp.args, "--depth", depth, NULL);
735         if (reference->nr) {
736                 struct string_list_item *item;
737                 for_each_string_list_item(item, reference)
738                         argv_array_pushl(&cp.args, "--reference",
739                                          item->string, NULL);
740         }
741         if (gitdir && *gitdir)
742                 argv_array_pushl(&cp.args, "--separate-git-dir", gitdir, NULL);
743
744         argv_array_push(&cp.args, url);
745         argv_array_push(&cp.args, path);
746
747         cp.git_cmd = 1;
748         prepare_submodule_repo_env(&cp.env_array);
749         cp.no_stdin = 1;
750
751         return run_command(&cp);
752 }
753
754 struct submodule_alternate_setup {
755         const char *submodule_name;
756         enum SUBMODULE_ALTERNATE_ERROR_MODE {
757                 SUBMODULE_ALTERNATE_ERROR_DIE,
758                 SUBMODULE_ALTERNATE_ERROR_INFO,
759                 SUBMODULE_ALTERNATE_ERROR_IGNORE
760         } error_mode;
761         struct string_list *reference;
762 };
763 #define SUBMODULE_ALTERNATE_SETUP_INIT { NULL, \
764         SUBMODULE_ALTERNATE_ERROR_IGNORE, NULL }
765
766 static int add_possible_reference_from_superproject(
767                 struct alternate_object_database *alt, void *sas_cb)
768 {
769         struct submodule_alternate_setup *sas = sas_cb;
770
771         /*
772          * If the alternate object store is another repository, try the
773          * standard layout with .git/(modules/<name>)+/objects
774          */
775         if (ends_with(alt->path, "/objects")) {
776                 char *sm_alternate;
777                 struct strbuf sb = STRBUF_INIT;
778                 struct strbuf err = STRBUF_INIT;
779                 strbuf_add(&sb, alt->path, strlen(alt->path) - strlen("objects"));
780
781                 /*
782                  * We need to end the new path with '/' to mark it as a dir,
783                  * otherwise a submodule name containing '/' will be broken
784                  * as the last part of a missing submodule reference would
785                  * be taken as a file name.
786                  */
787                 strbuf_addf(&sb, "modules/%s/", sas->submodule_name);
788
789                 sm_alternate = compute_alternate_path(sb.buf, &err);
790                 if (sm_alternate) {
791                         string_list_append(sas->reference, xstrdup(sb.buf));
792                         free(sm_alternate);
793                 } else {
794                         switch (sas->error_mode) {
795                         case SUBMODULE_ALTERNATE_ERROR_DIE:
796                                 die(_("submodule '%s' cannot add alternate: %s"),
797                                     sas->submodule_name, err.buf);
798                         case SUBMODULE_ALTERNATE_ERROR_INFO:
799                                 fprintf(stderr, _("submodule '%s' cannot add alternate: %s"),
800                                         sas->submodule_name, err.buf);
801                         case SUBMODULE_ALTERNATE_ERROR_IGNORE:
802                                 ; /* nothing */
803                         }
804                 }
805                 strbuf_release(&sb);
806         }
807
808         return 0;
809 }
810
811 static void prepare_possible_alternates(const char *sm_name,
812                 struct string_list *reference)
813 {
814         char *sm_alternate = NULL, *error_strategy = NULL;
815         struct submodule_alternate_setup sas = SUBMODULE_ALTERNATE_SETUP_INIT;
816
817         git_config_get_string("submodule.alternateLocation", &sm_alternate);
818         if (!sm_alternate)
819                 return;
820
821         git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
822
823         if (!error_strategy)
824                 error_strategy = xstrdup("die");
825
826         sas.submodule_name = sm_name;
827         sas.reference = reference;
828         if (!strcmp(error_strategy, "die"))
829                 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_DIE;
830         else if (!strcmp(error_strategy, "info"))
831                 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_INFO;
832         else if (!strcmp(error_strategy, "ignore"))
833                 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_IGNORE;
834         else
835                 die(_("Value '%s' for submodule.alternateErrorStrategy is not recognized"), error_strategy);
836
837         if (!strcmp(sm_alternate, "superproject"))
838                 foreach_alt_odb(add_possible_reference_from_superproject, &sas);
839         else if (!strcmp(sm_alternate, "no"))
840                 ; /* do nothing */
841         else
842                 die(_("Value '%s' for submodule.alternateLocation is not recognized"), sm_alternate);
843
844         free(sm_alternate);
845         free(error_strategy);
846 }
847
848 static int module_clone(int argc, const char **argv, const char *prefix)
849 {
850         const char *name = NULL, *url = NULL, *depth = NULL;
851         int quiet = 0;
852         int progress = 0;
853         char *p, *path = NULL, *sm_gitdir;
854         struct strbuf sb = STRBUF_INIT;
855         struct string_list reference = STRING_LIST_INIT_NODUP;
856         char *sm_alternate = NULL, *error_strategy = NULL;
857
858         struct option module_clone_options[] = {
859                 OPT_STRING(0, "prefix", &prefix,
860                            N_("path"),
861                            N_("alternative anchor for relative paths")),
862                 OPT_STRING(0, "path", &path,
863                            N_("path"),
864                            N_("where the new submodule will be cloned to")),
865                 OPT_STRING(0, "name", &name,
866                            N_("string"),
867                            N_("name of the new submodule")),
868                 OPT_STRING(0, "url", &url,
869                            N_("string"),
870                            N_("url where to clone the submodule from")),
871                 OPT_STRING_LIST(0, "reference", &reference,
872                            N_("repo"),
873                            N_("reference repository")),
874                 OPT_STRING(0, "depth", &depth,
875                            N_("string"),
876                            N_("depth for shallow clones")),
877                 OPT__QUIET(&quiet, "Suppress output for cloning a submodule"),
878                 OPT_BOOL(0, "progress", &progress,
879                            N_("force cloning progress")),
880                 OPT_END()
881         };
882
883         const char *const git_submodule_helper_usage[] = {
884                 N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
885                    "[--reference <repository>] [--name <name>] [--depth <depth>] "
886                    "--url <url> --path <path>"),
887                 NULL
888         };
889
890         argc = parse_options(argc, argv, prefix, module_clone_options,
891                              git_submodule_helper_usage, 0);
892
893         if (argc || !url || !path || !*path)
894                 usage_with_options(git_submodule_helper_usage,
895                                    module_clone_options);
896
897         strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), name);
898         sm_gitdir = absolute_pathdup(sb.buf);
899         strbuf_reset(&sb);
900
901         if (!is_absolute_path(path)) {
902                 strbuf_addf(&sb, "%s/%s", get_git_work_tree(), path);
903                 path = strbuf_detach(&sb, NULL);
904         } else
905                 path = xstrdup(path);
906
907         if (!file_exists(sm_gitdir)) {
908                 if (safe_create_leading_directories_const(sm_gitdir) < 0)
909                         die(_("could not create directory '%s'"), sm_gitdir);
910
911                 prepare_possible_alternates(name, &reference);
912
913                 if (clone_submodule(path, sm_gitdir, url, depth, &reference,
914                                     quiet, progress))
915                         die(_("clone of '%s' into submodule path '%s' failed"),
916                             url, path);
917         } else {
918                 if (safe_create_leading_directories_const(path) < 0)
919                         die(_("could not create directory '%s'"), path);
920                 strbuf_addf(&sb, "%s/index", sm_gitdir);
921                 unlink_or_warn(sb.buf);
922                 strbuf_reset(&sb);
923         }
924
925         /* Connect module worktree and git dir */
926         connect_work_tree_and_git_dir(path, sm_gitdir);
927
928         p = git_pathdup_submodule(path, "config");
929         if (!p)
930                 die(_("could not get submodule directory for '%s'"), path);
931
932         /* setup alternateLocation and alternateErrorStrategy in the cloned submodule if needed */
933         git_config_get_string("submodule.alternateLocation", &sm_alternate);
934         if (sm_alternate)
935                 git_config_set_in_file(p, "submodule.alternateLocation",
936                                            sm_alternate);
937         git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
938         if (error_strategy)
939                 git_config_set_in_file(p, "submodule.alternateErrorStrategy",
940                                            error_strategy);
941
942         free(sm_alternate);
943         free(error_strategy);
944
945         strbuf_release(&sb);
946         free(sm_gitdir);
947         free(path);
948         free(p);
949         return 0;
950 }
951
952 struct submodule_update_clone {
953         /* index into 'list', the list of submodules to look into for cloning */
954         int current;
955         struct module_list list;
956         unsigned warn_if_uninitialized : 1;
957
958         /* update parameter passed via commandline */
959         struct submodule_update_strategy update;
960
961         /* configuration parameters which are passed on to the children */
962         int progress;
963         int quiet;
964         int recommend_shallow;
965         struct string_list references;
966         const char *depth;
967         const char *recursive_prefix;
968         const char *prefix;
969
970         /* Machine-readable status lines to be consumed by git-submodule.sh */
971         struct string_list projectlines;
972
973         /* If we want to stop as fast as possible and return an error */
974         unsigned quickstop : 1;
975
976         /* failed clones to be retried again */
977         const struct cache_entry **failed_clones;
978         int failed_clones_nr, failed_clones_alloc;
979 };
980 #define SUBMODULE_UPDATE_CLONE_INIT {0, MODULE_LIST_INIT, 0, \
981         SUBMODULE_UPDATE_STRATEGY_INIT, 0, 0, -1, STRING_LIST_INIT_DUP, \
982         NULL, NULL, NULL, \
983         STRING_LIST_INIT_DUP, 0, NULL, 0, 0}
984
985
986 static void next_submodule_warn_missing(struct submodule_update_clone *suc,
987                 struct strbuf *out, const char *displaypath)
988 {
989         /*
990          * Only mention uninitialized submodules when their
991          * paths have been specified.
992          */
993         if (suc->warn_if_uninitialized) {
994                 strbuf_addf(out,
995                         _("Submodule path '%s' not initialized"),
996                         displaypath);
997                 strbuf_addch(out, '\n');
998                 strbuf_addstr(out,
999                         _("Maybe you want to use 'update --init'?"));
1000                 strbuf_addch(out, '\n');
1001         }
1002 }
1003
1004 /**
1005  * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
1006  * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
1007  */
1008 static int prepare_to_clone_next_submodule(const struct cache_entry *ce,
1009                                            struct child_process *child,
1010                                            struct submodule_update_clone *suc,
1011                                            struct strbuf *out)
1012 {
1013         const struct submodule *sub = NULL;
1014         const char *url = NULL;
1015         const char *update_string;
1016         enum submodule_update_type update_type;
1017         char *key;
1018         struct strbuf displaypath_sb = STRBUF_INIT;
1019         struct strbuf sb = STRBUF_INIT;
1020         const char *displaypath = NULL;
1021         int needs_cloning = 0;
1022
1023         if (ce_stage(ce)) {
1024                 if (suc->recursive_prefix)
1025                         strbuf_addf(&sb, "%s/%s", suc->recursive_prefix, ce->name);
1026                 else
1027                         strbuf_addstr(&sb, ce->name);
1028                 strbuf_addf(out, _("Skipping unmerged submodule %s"), sb.buf);
1029                 strbuf_addch(out, '\n');
1030                 goto cleanup;
1031         }
1032
1033         sub = submodule_from_path(&null_oid, ce->name);
1034
1035         if (suc->recursive_prefix)
1036                 displaypath = relative_path(suc->recursive_prefix,
1037                                             ce->name, &displaypath_sb);
1038         else
1039                 displaypath = ce->name;
1040
1041         if (!sub) {
1042                 next_submodule_warn_missing(suc, out, displaypath);
1043                 goto cleanup;
1044         }
1045
1046         key = xstrfmt("submodule.%s.update", sub->name);
1047         if (!repo_config_get_string_const(the_repository, key, &update_string)) {
1048                 update_type = parse_submodule_update_type(update_string);
1049         } else {
1050                 update_type = sub->update_strategy.type;
1051         }
1052         free(key);
1053
1054         if (suc->update.type == SM_UPDATE_NONE
1055             || (suc->update.type == SM_UPDATE_UNSPECIFIED
1056                 && update_type == SM_UPDATE_NONE)) {
1057                 strbuf_addf(out, _("Skipping submodule '%s'"), displaypath);
1058                 strbuf_addch(out, '\n');
1059                 goto cleanup;
1060         }
1061
1062         /* Check if the submodule has been initialized. */
1063         if (!is_submodule_active(the_repository, ce->name)) {
1064                 next_submodule_warn_missing(suc, out, displaypath);
1065                 goto cleanup;
1066         }
1067
1068         strbuf_reset(&sb);
1069         strbuf_addf(&sb, "submodule.%s.url", sub->name);
1070         if (repo_config_get_string_const(the_repository, sb.buf, &url))
1071                 url = sub->url;
1072
1073         strbuf_reset(&sb);
1074         strbuf_addf(&sb, "%s/.git", ce->name);
1075         needs_cloning = !file_exists(sb.buf);
1076
1077         strbuf_reset(&sb);
1078         strbuf_addf(&sb, "%06o %s %d %d\t%s\n", ce->ce_mode,
1079                         oid_to_hex(&ce->oid), ce_stage(ce),
1080                         needs_cloning, ce->name);
1081         string_list_append(&suc->projectlines, sb.buf);
1082
1083         if (!needs_cloning)
1084                 goto cleanup;
1085
1086         child->git_cmd = 1;
1087         child->no_stdin = 1;
1088         child->stdout_to_stderr = 1;
1089         child->err = -1;
1090         argv_array_push(&child->args, "submodule--helper");
1091         argv_array_push(&child->args, "clone");
1092         if (suc->progress)
1093                 argv_array_push(&child->args, "--progress");
1094         if (suc->quiet)
1095                 argv_array_push(&child->args, "--quiet");
1096         if (suc->prefix)
1097                 argv_array_pushl(&child->args, "--prefix", suc->prefix, NULL);
1098         if (suc->recommend_shallow && sub->recommend_shallow == 1)
1099                 argv_array_push(&child->args, "--depth=1");
1100         argv_array_pushl(&child->args, "--path", sub->path, NULL);
1101         argv_array_pushl(&child->args, "--name", sub->name, NULL);
1102         argv_array_pushl(&child->args, "--url", url, NULL);
1103         if (suc->references.nr) {
1104                 struct string_list_item *item;
1105                 for_each_string_list_item(item, &suc->references)
1106                         argv_array_pushl(&child->args, "--reference", item->string, NULL);
1107         }
1108         if (suc->depth)
1109                 argv_array_push(&child->args, suc->depth);
1110
1111 cleanup:
1112         strbuf_reset(&displaypath_sb);
1113         strbuf_reset(&sb);
1114
1115         return needs_cloning;
1116 }
1117
1118 static int update_clone_get_next_task(struct child_process *child,
1119                                       struct strbuf *err,
1120                                       void *suc_cb,
1121                                       void **idx_task_cb)
1122 {
1123         struct submodule_update_clone *suc = suc_cb;
1124         const struct cache_entry *ce;
1125         int index;
1126
1127         for (; suc->current < suc->list.nr; suc->current++) {
1128                 ce = suc->list.entries[suc->current];
1129                 if (prepare_to_clone_next_submodule(ce, child, suc, err)) {
1130                         int *p = xmalloc(sizeof(*p));
1131                         *p = suc->current;
1132                         *idx_task_cb = p;
1133                         suc->current++;
1134                         return 1;
1135                 }
1136         }
1137
1138         /*
1139          * The loop above tried cloning each submodule once, now try the
1140          * stragglers again, which we can imagine as an extension of the
1141          * entry list.
1142          */
1143         index = suc->current - suc->list.nr;
1144         if (index < suc->failed_clones_nr) {
1145                 int *p;
1146                 ce = suc->failed_clones[index];
1147                 if (!prepare_to_clone_next_submodule(ce, child, suc, err)) {
1148                         suc->current ++;
1149                         strbuf_addstr(err, "BUG: submodule considered for "
1150                                            "cloning, doesn't need cloning "
1151                                            "any more?\n");
1152                         return 0;
1153                 }
1154                 p = xmalloc(sizeof(*p));
1155                 *p = suc->current;
1156                 *idx_task_cb = p;
1157                 suc->current ++;
1158                 return 1;
1159         }
1160
1161         return 0;
1162 }
1163
1164 static int update_clone_start_failure(struct strbuf *err,
1165                                       void *suc_cb,
1166                                       void *idx_task_cb)
1167 {
1168         struct submodule_update_clone *suc = suc_cb;
1169         suc->quickstop = 1;
1170         return 1;
1171 }
1172
1173 static int update_clone_task_finished(int result,
1174                                       struct strbuf *err,
1175                                       void *suc_cb,
1176                                       void *idx_task_cb)
1177 {
1178         const struct cache_entry *ce;
1179         struct submodule_update_clone *suc = suc_cb;
1180
1181         int *idxP = idx_task_cb;
1182         int idx = *idxP;
1183         free(idxP);
1184
1185         if (!result)
1186                 return 0;
1187
1188         if (idx < suc->list.nr) {
1189                 ce  = suc->list.entries[idx];
1190                 strbuf_addf(err, _("Failed to clone '%s'. Retry scheduled"),
1191                             ce->name);
1192                 strbuf_addch(err, '\n');
1193                 ALLOC_GROW(suc->failed_clones,
1194                            suc->failed_clones_nr + 1,
1195                            suc->failed_clones_alloc);
1196                 suc->failed_clones[suc->failed_clones_nr++] = ce;
1197                 return 0;
1198         } else {
1199                 idx -= suc->list.nr;
1200                 ce  = suc->failed_clones[idx];
1201                 strbuf_addf(err, _("Failed to clone '%s' a second time, aborting"),
1202                             ce->name);
1203                 strbuf_addch(err, '\n');
1204                 suc->quickstop = 1;
1205                 return 1;
1206         }
1207
1208         return 0;
1209 }
1210
1211 static int gitmodules_update_clone_config(const char *var, const char *value,
1212                                           void *cb)
1213 {
1214         int *max_jobs = cb;
1215         if (!strcmp(var, "submodule.fetchjobs"))
1216                 *max_jobs = parse_submodule_fetchjobs(var, value);
1217         return 0;
1218 }
1219
1220 static int update_clone(int argc, const char **argv, const char *prefix)
1221 {
1222         const char *update = NULL;
1223         int max_jobs = 1;
1224         struct string_list_item *item;
1225         struct pathspec pathspec;
1226         struct submodule_update_clone suc = SUBMODULE_UPDATE_CLONE_INIT;
1227
1228         struct option module_update_clone_options[] = {
1229                 OPT_STRING(0, "prefix", &prefix,
1230                            N_("path"),
1231                            N_("path into the working tree")),
1232                 OPT_STRING(0, "recursive-prefix", &suc.recursive_prefix,
1233                            N_("path"),
1234                            N_("path into the working tree, across nested "
1235                               "submodule boundaries")),
1236                 OPT_STRING(0, "update", &update,
1237                            N_("string"),
1238                            N_("rebase, merge, checkout or none")),
1239                 OPT_STRING_LIST(0, "reference", &suc.references, N_("repo"),
1240                            N_("reference repository")),
1241                 OPT_STRING(0, "depth", &suc.depth, "<depth>",
1242                            N_("Create a shallow clone truncated to the "
1243                               "specified number of revisions")),
1244                 OPT_INTEGER('j', "jobs", &max_jobs,
1245                             N_("parallel jobs")),
1246                 OPT_BOOL(0, "recommend-shallow", &suc.recommend_shallow,
1247                             N_("whether the initial clone should follow the shallow recommendation")),
1248                 OPT__QUIET(&suc.quiet, N_("don't print cloning progress")),
1249                 OPT_BOOL(0, "progress", &suc.progress,
1250                             N_("force cloning progress")),
1251                 OPT_END()
1252         };
1253
1254         const char *const git_submodule_helper_usage[] = {
1255                 N_("git submodule--helper update_clone [--prefix=<path>] [<path>...]"),
1256                 NULL
1257         };
1258         suc.prefix = prefix;
1259
1260         config_from_gitmodules(gitmodules_update_clone_config, &max_jobs);
1261         git_config(gitmodules_update_clone_config, &max_jobs);
1262
1263         argc = parse_options(argc, argv, prefix, module_update_clone_options,
1264                              git_submodule_helper_usage, 0);
1265
1266         if (update)
1267                 if (parse_submodule_update_strategy(update, &suc.update) < 0)
1268                         die(_("bad value for update parameter"));
1269
1270         if (module_list_compute(argc, argv, prefix, &pathspec, &suc.list) < 0)
1271                 return 1;
1272
1273         if (pathspec.nr)
1274                 suc.warn_if_uninitialized = 1;
1275
1276         run_processes_parallel(max_jobs,
1277                                update_clone_get_next_task,
1278                                update_clone_start_failure,
1279                                update_clone_task_finished,
1280                                &suc);
1281
1282         /*
1283          * We saved the output and put it out all at once now.
1284          * That means:
1285          * - the listener does not have to interleave their (checkout)
1286          *   work with our fetching.  The writes involved in a
1287          *   checkout involve more straightforward sequential I/O.
1288          * - the listener can avoid doing any work if fetching failed.
1289          */
1290         if (suc.quickstop)
1291                 return 1;
1292
1293         for_each_string_list_item(item, &suc.projectlines)
1294                 fprintf(stdout, "%s", item->string);
1295
1296         return 0;
1297 }
1298
1299 static int resolve_relative_path(int argc, const char **argv, const char *prefix)
1300 {
1301         struct strbuf sb = STRBUF_INIT;
1302         if (argc != 3)
1303                 die("submodule--helper relative-path takes exactly 2 arguments, got %d", argc);
1304
1305         printf("%s", relative_path(argv[1], argv[2], &sb));
1306         strbuf_release(&sb);
1307         return 0;
1308 }
1309
1310 static const char *remote_submodule_branch(const char *path)
1311 {
1312         const struct submodule *sub;
1313         const char *branch = NULL;
1314         char *key;
1315
1316         sub = submodule_from_path(&null_oid, path);
1317         if (!sub)
1318                 return NULL;
1319
1320         key = xstrfmt("submodule.%s.branch", sub->name);
1321         if (repo_config_get_string_const(the_repository, key, &branch))
1322                 branch = sub->branch;
1323         free(key);
1324
1325         if (!branch)
1326                 return "master";
1327
1328         if (!strcmp(branch, ".")) {
1329                 const char *refname = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
1330
1331                 if (!refname)
1332                         die(_("No such ref: %s"), "HEAD");
1333
1334                 /* detached HEAD */
1335                 if (!strcmp(refname, "HEAD"))
1336                         die(_("Submodule (%s) branch configured to inherit "
1337                               "branch from superproject, but the superproject "
1338                               "is not on any branch"), sub->name);
1339
1340                 if (!skip_prefix(refname, "refs/heads/", &refname))
1341                         die(_("Expecting a full ref name, got %s"), refname);
1342                 return refname;
1343         }
1344
1345         return branch;
1346 }
1347
1348 static int resolve_remote_submodule_branch(int argc, const char **argv,
1349                 const char *prefix)
1350 {
1351         const char *ret;
1352         struct strbuf sb = STRBUF_INIT;
1353         if (argc != 2)
1354                 die("submodule--helper remote-branch takes exactly one arguments, got %d", argc);
1355
1356         ret = remote_submodule_branch(argv[1]);
1357         if (!ret)
1358                 die("submodule %s doesn't exist", argv[1]);
1359
1360         printf("%s", ret);
1361         strbuf_release(&sb);
1362         return 0;
1363 }
1364
1365 static int push_check(int argc, const char **argv, const char *prefix)
1366 {
1367         struct remote *remote;
1368         const char *superproject_head;
1369         char *head;
1370         int detached_head = 0;
1371         struct object_id head_oid;
1372
1373         if (argc < 3)
1374                 die("submodule--helper push-check requires at least 2 arguments");
1375
1376         /*
1377          * superproject's resolved head ref.
1378          * if HEAD then the superproject is in a detached head state, otherwise
1379          * it will be the resolved head ref.
1380          */
1381         superproject_head = argv[1];
1382         argv++;
1383         argc--;
1384         /* Get the submodule's head ref and determine if it is detached */
1385         head = resolve_refdup("HEAD", 0, &head_oid, NULL);
1386         if (!head)
1387                 die(_("Failed to resolve HEAD as a valid ref."));
1388         if (!strcmp(head, "HEAD"))
1389                 detached_head = 1;
1390
1391         /*
1392          * The remote must be configured.
1393          * This is to avoid pushing to the exact same URL as the parent.
1394          */
1395         remote = pushremote_get(argv[1]);
1396         if (!remote || remote->origin == REMOTE_UNCONFIGURED)
1397                 die("remote '%s' not configured", argv[1]);
1398
1399         /* Check the refspec */
1400         if (argc > 2) {
1401                 int i, refspec_nr = argc - 2;
1402                 struct ref *local_refs = get_local_heads();
1403                 struct refspec *refspec = parse_push_refspec(refspec_nr,
1404                                                              argv + 2);
1405
1406                 for (i = 0; i < refspec_nr; i++) {
1407                         struct refspec *rs = refspec + i;
1408
1409                         if (rs->pattern || rs->matching)
1410                                 continue;
1411
1412                         /* LHS must match a single ref */
1413                         switch (count_refspec_match(rs->src, local_refs, NULL)) {
1414                         case 1:
1415                                 break;
1416                         case 0:
1417                                 /*
1418                                  * If LHS matches 'HEAD' then we need to ensure
1419                                  * that it matches the same named branch
1420                                  * checked out in the superproject.
1421                                  */
1422                                 if (!strcmp(rs->src, "HEAD")) {
1423                                         if (!detached_head &&
1424                                             !strcmp(head, superproject_head))
1425                                                 break;
1426                                         die("HEAD does not match the named branch in the superproject");
1427                                 }
1428                                 /* fallthrough */
1429                         default:
1430                                 die("src refspec '%s' must name a ref",
1431                                     rs->src);
1432                         }
1433                 }
1434                 free_refspec(refspec_nr, refspec);
1435         }
1436         free(head);
1437
1438         return 0;
1439 }
1440
1441 static int absorb_git_dirs(int argc, const char **argv, const char *prefix)
1442 {
1443         int i;
1444         struct pathspec pathspec;
1445         struct module_list list = MODULE_LIST_INIT;
1446         unsigned flags = ABSORB_GITDIR_RECURSE_SUBMODULES;
1447
1448         struct option embed_gitdir_options[] = {
1449                 OPT_STRING(0, "prefix", &prefix,
1450                            N_("path"),
1451                            N_("path into the working tree")),
1452                 OPT_BIT(0, "--recursive", &flags, N_("recurse into submodules"),
1453                         ABSORB_GITDIR_RECURSE_SUBMODULES),
1454                 OPT_END()
1455         };
1456
1457         const char *const git_submodule_helper_usage[] = {
1458                 N_("git submodule--helper embed-git-dir [<path>...]"),
1459                 NULL
1460         };
1461
1462         argc = parse_options(argc, argv, prefix, embed_gitdir_options,
1463                              git_submodule_helper_usage, 0);
1464
1465         if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
1466                 return 1;
1467
1468         for (i = 0; i < list.nr; i++)
1469                 absorb_git_dir_into_superproject(prefix,
1470                                 list.entries[i]->name, flags);
1471
1472         return 0;
1473 }
1474
1475 static int is_active(int argc, const char **argv, const char *prefix)
1476 {
1477         if (argc != 2)
1478                 die("submodule--helper is-active takes exactly 1 argument");
1479
1480         return !is_submodule_active(the_repository, argv[1]);
1481 }
1482
1483 #define SUPPORT_SUPER_PREFIX (1<<0)
1484
1485 struct cmd_struct {
1486         const char *cmd;
1487         int (*fn)(int, const char **, const char *);
1488         unsigned option;
1489 };
1490
1491 static struct cmd_struct commands[] = {
1492         {"list", module_list, 0},
1493         {"name", module_name, 0},
1494         {"clone", module_clone, 0},
1495         {"update-clone", update_clone, 0},
1496         {"relative-path", resolve_relative_path, 0},
1497         {"resolve-relative-url", resolve_relative_url, 0},
1498         {"resolve-relative-url-test", resolve_relative_url_test, 0},
1499         {"init", module_init, SUPPORT_SUPER_PREFIX},
1500         {"status", module_status, SUPPORT_SUPER_PREFIX},
1501         {"remote-branch", resolve_remote_submodule_branch, 0},
1502         {"push-check", push_check, 0},
1503         {"absorb-git-dirs", absorb_git_dirs, SUPPORT_SUPER_PREFIX},
1504         {"is-active", is_active, 0},
1505 };
1506
1507 int cmd_submodule__helper(int argc, const char **argv, const char *prefix)
1508 {
1509         int i;
1510         if (argc < 2 || !strcmp(argv[1], "-h"))
1511                 usage("git submodule--helper <command>");
1512
1513         for (i = 0; i < ARRAY_SIZE(commands); i++) {
1514                 if (!strcmp(argv[1], commands[i].cmd)) {
1515                         if (get_super_prefix() &&
1516                             !(commands[i].option & SUPPORT_SUPER_PREFIX))
1517                                 die(_("%s doesn't support --super-prefix"),
1518                                     commands[i].cmd);
1519                         return commands[i].fn(argc - 1, argv + 1, prefix);
1520                 }
1521         }
1522
1523         die(_("'%s' is not a valid submodule--helper "
1524               "subcommand"), argv[1]);
1525 }