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