]>
Commit | Line | Data |
---|---|---|
74703a1e SB |
1 | #include "builtin.h" |
2 | #include "cache.h" | |
3 | #include "parse-options.h" | |
4 | #include "quote.h" | |
5 | #include "pathspec.h" | |
6 | #include "dir.h" | |
7 | #include "utf8.h" | |
0ea306ef SB |
8 | #include "submodule.h" |
9 | #include "submodule-config.h" | |
10 | #include "string-list.h" | |
ee8838d1 | 11 | #include "run-command.h" |
63e95beb SB |
12 | #include "remote.h" |
13 | #include "refs.h" | |
14 | #include "connect.h" | |
15 | ||
16 | static char *get_default_remote(void) | |
17 | { | |
18 | char *dest = NULL, *ret; | |
19 | unsigned char sha1[20]; | |
20 | struct strbuf sb = STRBUF_INIT; | |
21 | const char *refname = resolve_ref_unsafe("HEAD", 0, sha1, NULL); | |
22 | ||
23 | if (!refname) | |
24 | die(_("No such ref: %s"), "HEAD"); | |
25 | ||
26 | /* detached HEAD */ | |
27 | if (!strcmp(refname, "HEAD")) | |
28 | return xstrdup("origin"); | |
29 | ||
30 | if (!skip_prefix(refname, "refs/heads/", &refname)) | |
31 | die(_("Expecting a full ref name, got %s"), refname); | |
32 | ||
33 | strbuf_addf(&sb, "branch.%s.remote", refname); | |
34 | if (git_config_get_string(sb.buf, &dest)) | |
35 | ret = xstrdup("origin"); | |
36 | else | |
37 | ret = dest; | |
38 | ||
39 | strbuf_release(&sb); | |
40 | return ret; | |
41 | } | |
42 | ||
43 | static int starts_with_dot_slash(const char *str) | |
44 | { | |
45 | return str[0] == '.' && is_dir_sep(str[1]); | |
46 | } | |
47 | ||
48 | static int starts_with_dot_dot_slash(const char *str) | |
49 | { | |
50 | return str[0] == '.' && str[1] == '.' && is_dir_sep(str[2]); | |
51 | } | |
52 | ||
53 | /* | |
54 | * Returns 1 if it was the last chop before ':'. | |
55 | */ | |
56 | static int chop_last_dir(char **remoteurl, int is_relative) | |
57 | { | |
58 | char *rfind = find_last_dir_sep(*remoteurl); | |
59 | if (rfind) { | |
60 | *rfind = '\0'; | |
61 | return 0; | |
62 | } | |
63 | ||
64 | rfind = strrchr(*remoteurl, ':'); | |
65 | if (rfind) { | |
66 | *rfind = '\0'; | |
67 | return 1; | |
68 | } | |
69 | ||
70 | if (is_relative || !strcmp(".", *remoteurl)) | |
71 | die(_("cannot strip one component off url '%s'"), | |
72 | *remoteurl); | |
73 | ||
74 | free(*remoteurl); | |
75 | *remoteurl = xstrdup("."); | |
76 | return 0; | |
77 | } | |
78 | ||
79 | /* | |
80 | * The `url` argument is the URL that navigates to the submodule origin | |
81 | * repo. When relative, this URL is relative to the superproject origin | |
82 | * URL repo. The `up_path` argument, if specified, is the relative | |
83 | * path that navigates from the submodule working tree to the superproject | |
84 | * working tree. Returns the origin URL of the submodule. | |
85 | * | |
86 | * Return either an absolute URL or filesystem path (if the superproject | |
87 | * origin URL is an absolute URL or filesystem path, respectively) or a | |
88 | * relative file system path (if the superproject origin URL is a relative | |
89 | * file system path). | |
90 | * | |
91 | * When the output is a relative file system path, the path is either | |
92 | * relative to the submodule working tree, if up_path is specified, or to | |
93 | * the superproject working tree otherwise. | |
94 | * | |
95 | * NEEDSWORK: This works incorrectly on the domain and protocol part. | |
96 | * remote_url url outcome expectation | |
97 | * http://a.com/b ../c http://a.com/c as is | |
98 | * http://a.com/b ../../c http://c error out | |
99 | * http://a.com/b ../../../c http:/c error out | |
100 | * http://a.com/b ../../../../c http:c error out | |
101 | * http://a.com/b ../../../../../c .:c error out | |
102 | * NEEDSWORK: Given how chop_last_dir() works, this function is broken | |
103 | * when a local part has a colon in its path component, too. | |
104 | */ | |
105 | static char *relative_url(const char *remote_url, | |
106 | const char *url, | |
107 | const char *up_path) | |
108 | { | |
109 | int is_relative = 0; | |
110 | int colonsep = 0; | |
111 | char *out; | |
112 | char *remoteurl = xstrdup(remote_url); | |
113 | struct strbuf sb = STRBUF_INIT; | |
114 | size_t len = strlen(remoteurl); | |
115 | ||
116 | if (is_dir_sep(remoteurl[len])) | |
117 | remoteurl[len] = '\0'; | |
118 | ||
119 | if (!url_is_local_not_ssh(remoteurl) || is_absolute_path(remoteurl)) | |
120 | is_relative = 0; | |
121 | else { | |
122 | is_relative = 1; | |
123 | /* | |
124 | * Prepend a './' to ensure all relative | |
125 | * remoteurls start with './' or '../' | |
126 | */ | |
127 | if (!starts_with_dot_slash(remoteurl) && | |
128 | !starts_with_dot_dot_slash(remoteurl)) { | |
129 | strbuf_reset(&sb); | |
130 | strbuf_addf(&sb, "./%s", remoteurl); | |
131 | free(remoteurl); | |
132 | remoteurl = strbuf_detach(&sb, NULL); | |
133 | } | |
134 | } | |
135 | /* | |
136 | * When the url starts with '../', remove that and the | |
137 | * last directory in remoteurl. | |
138 | */ | |
139 | while (url) { | |
140 | if (starts_with_dot_dot_slash(url)) { | |
141 | url += 3; | |
142 | colonsep |= chop_last_dir(&remoteurl, is_relative); | |
143 | } else if (starts_with_dot_slash(url)) | |
144 | url += 2; | |
145 | else | |
146 | break; | |
147 | } | |
148 | strbuf_reset(&sb); | |
149 | strbuf_addf(&sb, "%s%s%s", remoteurl, colonsep ? ":" : "/", url); | |
150 | free(remoteurl); | |
151 | ||
152 | if (starts_with_dot_slash(sb.buf)) | |
153 | out = xstrdup(sb.buf + 2); | |
154 | else | |
155 | out = xstrdup(sb.buf); | |
156 | strbuf_reset(&sb); | |
157 | ||
158 | if (!up_path || !is_relative) | |
159 | return out; | |
160 | ||
161 | strbuf_addf(&sb, "%s%s", up_path, out); | |
162 | free(out); | |
163 | return strbuf_detach(&sb, NULL); | |
164 | } | |
165 | ||
166 | static int resolve_relative_url(int argc, const char **argv, const char *prefix) | |
167 | { | |
168 | char *remoteurl = NULL; | |
169 | char *remote = get_default_remote(); | |
170 | const char *up_path = NULL; | |
171 | char *res; | |
172 | const char *url; | |
173 | struct strbuf sb = STRBUF_INIT; | |
174 | ||
175 | if (argc != 2 && argc != 3) | |
176 | die("resolve-relative-url only accepts one or two arguments"); | |
177 | ||
178 | url = argv[1]; | |
179 | strbuf_addf(&sb, "remote.%s.url", remote); | |
180 | free(remote); | |
181 | ||
182 | if (git_config_get_string(sb.buf, &remoteurl)) | |
183 | /* the repository is its own authoritative upstream */ | |
184 | remoteurl = xgetcwd(); | |
185 | ||
186 | if (argc == 3) | |
187 | up_path = argv[2]; | |
188 | ||
189 | res = relative_url(remoteurl, url, up_path); | |
190 | puts(res); | |
191 | free(res); | |
192 | free(remoteurl); | |
193 | return 0; | |
194 | } | |
195 | ||
196 | static int resolve_relative_url_test(int argc, const char **argv, const char *prefix) | |
197 | { | |
198 | char *remoteurl, *res; | |
199 | const char *up_path, *url; | |
200 | ||
201 | if (argc != 4) | |
202 | die("resolve-relative-url-test only accepts three arguments: <up_path> <remoteurl> <url>"); | |
203 | ||
204 | up_path = argv[1]; | |
205 | remoteurl = xstrdup(argv[2]); | |
206 | url = argv[3]; | |
207 | ||
208 | if (!strcmp(up_path, "(null)")) | |
209 | up_path = NULL; | |
210 | ||
211 | res = relative_url(remoteurl, url, up_path); | |
212 | puts(res); | |
213 | free(res); | |
214 | free(remoteurl); | |
215 | return 0; | |
216 | } | |
74703a1e SB |
217 | |
218 | struct module_list { | |
219 | const struct cache_entry **entries; | |
220 | int alloc, nr; | |
221 | }; | |
222 | #define MODULE_LIST_INIT { NULL, 0, 0 } | |
223 | ||
224 | static int module_list_compute(int argc, const char **argv, | |
225 | const char *prefix, | |
226 | struct pathspec *pathspec, | |
227 | struct module_list *list) | |
228 | { | |
229 | int i, result = 0; | |
2b56bb7a | 230 | char *ps_matched = NULL; |
74703a1e SB |
231 | parse_pathspec(pathspec, 0, |
232 | PATHSPEC_PREFER_FULL | | |
233 | PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP, | |
234 | prefix, argv); | |
235 | ||
74703a1e SB |
236 | if (pathspec->nr) |
237 | ps_matched = xcalloc(pathspec->nr, 1); | |
238 | ||
239 | if (read_cache() < 0) | |
240 | die(_("index file corrupt")); | |
241 | ||
242 | for (i = 0; i < active_nr; i++) { | |
243 | const struct cache_entry *ce = active_cache[i]; | |
244 | ||
84ba959b SB |
245 | if (!match_pathspec(pathspec, ce->name, ce_namelen(ce), |
246 | 0, ps_matched, 1) || | |
247 | !S_ISGITLINK(ce->ce_mode)) | |
74703a1e SB |
248 | continue; |
249 | ||
250 | ALLOC_GROW(list->entries, list->nr + 1, list->alloc); | |
251 | list->entries[list->nr++] = ce; | |
252 | while (i + 1 < active_nr && | |
253 | !strcmp(ce->name, active_cache[i + 1]->name)) | |
254 | /* | |
255 | * Skip entries with the same name in different stages | |
256 | * to make sure an entry is returned only once. | |
257 | */ | |
258 | i++; | |
259 | } | |
74703a1e SB |
260 | |
261 | if (ps_matched && report_path_error(ps_matched, pathspec, prefix)) | |
262 | result = -1; | |
263 | ||
264 | free(ps_matched); | |
265 | ||
266 | return result; | |
267 | } | |
268 | ||
269 | static int module_list(int argc, const char **argv, const char *prefix) | |
270 | { | |
271 | int i; | |
272 | struct pathspec pathspec; | |
273 | struct module_list list = MODULE_LIST_INIT; | |
274 | ||
275 | struct option module_list_options[] = { | |
276 | OPT_STRING(0, "prefix", &prefix, | |
277 | N_("path"), | |
278 | N_("alternative anchor for relative paths")), | |
279 | OPT_END() | |
280 | }; | |
281 | ||
282 | const char *const git_submodule_helper_usage[] = { | |
283 | N_("git submodule--helper list [--prefix=<path>] [<path>...]"), | |
284 | NULL | |
285 | }; | |
286 | ||
287 | argc = parse_options(argc, argv, prefix, module_list_options, | |
288 | git_submodule_helper_usage, 0); | |
289 | ||
290 | if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0) { | |
291 | printf("#unmatched\n"); | |
292 | return 1; | |
293 | } | |
294 | ||
295 | for (i = 0; i < list.nr; i++) { | |
296 | const struct cache_entry *ce = list.entries[i]; | |
297 | ||
298 | if (ce_stage(ce)) | |
299 | printf("%06o %s U\t", ce->ce_mode, sha1_to_hex(null_sha1)); | |
300 | else | |
301 | printf("%06o %s %d\t", ce->ce_mode, sha1_to_hex(ce->sha1), ce_stage(ce)); | |
302 | ||
303 | utf8_fprintf(stdout, "%s\n", ce->name); | |
304 | } | |
305 | return 0; | |
306 | } | |
307 | ||
3604242f SB |
308 | static void init_submodule(const char *path, const char *prefix, int quiet) |
309 | { | |
310 | const struct submodule *sub; | |
311 | struct strbuf sb = STRBUF_INIT; | |
312 | char *upd = NULL, *url = NULL, *displaypath; | |
313 | ||
314 | /* Only loads from .gitmodules, no overlay with .git/config */ | |
315 | gitmodules_config(); | |
316 | ||
3604242f SB |
317 | if (prefix) { |
318 | strbuf_addf(&sb, "%s%s", prefix, path); | |
319 | displaypath = strbuf_detach(&sb, NULL); | |
320 | } else | |
d92028a5 SB |
321 | displaypath = xstrdup(path); |
322 | ||
323 | sub = submodule_from_path(null_sha1, path); | |
324 | ||
325 | if (!sub) | |
326 | die(_("No url found for submodule path '%s' in .gitmodules"), | |
327 | displaypath); | |
3604242f SB |
328 | |
329 | /* | |
330 | * Copy url setting when it is not set yet. | |
331 | * To look up the url in .git/config, we must not fall back to | |
332 | * .gitmodules, so look it up directly. | |
333 | */ | |
334 | strbuf_reset(&sb); | |
335 | strbuf_addf(&sb, "submodule.%s.url", sub->name); | |
336 | if (git_config_get_string(sb.buf, &url)) { | |
337 | url = xstrdup(sub->url); | |
338 | ||
339 | if (!url) | |
340 | die(_("No url found for submodule path '%s' in .gitmodules"), | |
341 | displaypath); | |
342 | ||
343 | /* Possibly a url relative to parent */ | |
344 | if (starts_with_dot_dot_slash(url) || | |
345 | starts_with_dot_slash(url)) { | |
346 | char *remoteurl, *relurl; | |
347 | char *remote = get_default_remote(); | |
348 | struct strbuf remotesb = STRBUF_INIT; | |
349 | strbuf_addf(&remotesb, "remote.%s.url", remote); | |
350 | free(remote); | |
351 | ||
352 | if (git_config_get_string(remotesb.buf, &remoteurl)) | |
353 | /* | |
354 | * The repository is its own | |
355 | * authoritative upstream | |
356 | */ | |
357 | remoteurl = xgetcwd(); | |
358 | relurl = relative_url(remoteurl, url, NULL); | |
359 | strbuf_release(&remotesb); | |
360 | free(remoteurl); | |
361 | free(url); | |
362 | url = relurl; | |
363 | } | |
364 | ||
365 | if (git_config_set_gently(sb.buf, url)) | |
366 | die(_("Failed to register url for submodule path '%s'"), | |
367 | displaypath); | |
368 | if (!quiet) | |
369 | printf(_("Submodule '%s' (%s) registered for path '%s'\n"), | |
370 | sub->name, url, displaypath); | |
371 | } | |
372 | ||
373 | /* Copy "update" setting when it is not set yet */ | |
374 | strbuf_reset(&sb); | |
375 | strbuf_addf(&sb, "submodule.%s.update", sub->name); | |
376 | if (git_config_get_string(sb.buf, &upd) && | |
377 | sub->update_strategy.type != SM_UPDATE_UNSPECIFIED) { | |
378 | if (sub->update_strategy.type == SM_UPDATE_COMMAND) { | |
379 | fprintf(stderr, _("warning: command update mode suggested for submodule '%s'\n"), | |
380 | sub->name); | |
381 | upd = xstrdup("none"); | |
382 | } else | |
383 | upd = xstrdup(submodule_strategy_to_string(&sub->update_strategy)); | |
384 | ||
385 | if (git_config_set_gently(sb.buf, upd)) | |
386 | die(_("Failed to register update mode for submodule path '%s'"), displaypath); | |
387 | } | |
388 | strbuf_release(&sb); | |
389 | free(displaypath); | |
390 | free(url); | |
391 | free(upd); | |
392 | } | |
393 | ||
394 | static int module_init(int argc, const char **argv, const char *prefix) | |
395 | { | |
396 | struct pathspec pathspec; | |
397 | struct module_list list = MODULE_LIST_INIT; | |
398 | int quiet = 0; | |
399 | int i; | |
400 | ||
401 | struct option module_init_options[] = { | |
402 | OPT_STRING(0, "prefix", &prefix, | |
403 | N_("path"), | |
404 | N_("alternative anchor for relative paths")), | |
405 | OPT__QUIET(&quiet, N_("Suppress output for initializing a submodule")), | |
406 | OPT_END() | |
407 | }; | |
408 | ||
409 | const char *const git_submodule_helper_usage[] = { | |
410 | N_("git submodule--helper init [<path>]"), | |
411 | NULL | |
412 | }; | |
413 | ||
414 | argc = parse_options(argc, argv, prefix, module_init_options, | |
415 | git_submodule_helper_usage, 0); | |
416 | ||
417 | if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0) | |
418 | return 1; | |
419 | ||
420 | for (i = 0; i < list.nr; i++) | |
421 | init_submodule(list.entries[i]->name, prefix, quiet); | |
422 | ||
423 | return 0; | |
424 | } | |
425 | ||
0ea306ef SB |
426 | static int module_name(int argc, const char **argv, const char *prefix) |
427 | { | |
428 | const struct submodule *sub; | |
429 | ||
430 | if (argc != 2) | |
431 | usage(_("git submodule--helper name <path>")); | |
432 | ||
433 | gitmodules_config(); | |
434 | sub = submodule_from_path(null_sha1, argv[1]); | |
435 | ||
436 | if (!sub) | |
437 | die(_("no submodule mapping found in .gitmodules for path '%s'"), | |
438 | argv[1]); | |
439 | ||
440 | printf("%s\n", sub->name); | |
441 | ||
442 | return 0; | |
443 | } | |
ee8838d1 SB |
444 | static int clone_submodule(const char *path, const char *gitdir, const char *url, |
445 | const char *depth, const char *reference, int quiet) | |
446 | { | |
447 | struct child_process cp; | |
448 | child_process_init(&cp); | |
449 | ||
450 | argv_array_push(&cp.args, "clone"); | |
451 | argv_array_push(&cp.args, "--no-checkout"); | |
452 | if (quiet) | |
453 | argv_array_push(&cp.args, "--quiet"); | |
454 | if (depth && *depth) | |
455 | argv_array_pushl(&cp.args, "--depth", depth, NULL); | |
456 | if (reference && *reference) | |
457 | argv_array_pushl(&cp.args, "--reference", reference, NULL); | |
458 | if (gitdir && *gitdir) | |
459 | argv_array_pushl(&cp.args, "--separate-git-dir", gitdir, NULL); | |
460 | ||
461 | argv_array_push(&cp.args, url); | |
462 | argv_array_push(&cp.args, path); | |
463 | ||
464 | cp.git_cmd = 1; | |
465 | cp.env = local_repo_env; | |
466 | cp.no_stdin = 1; | |
467 | ||
468 | return run_command(&cp); | |
469 | } | |
470 | ||
471 | static int module_clone(int argc, const char **argv, const char *prefix) | |
472 | { | |
f8eaa0ba | 473 | const char *name = NULL, *url = NULL; |
ee8838d1 SB |
474 | const char *reference = NULL, *depth = NULL; |
475 | int quiet = 0; | |
476 | FILE *submodule_dot_git; | |
1ea4d9b7 | 477 | char *p, *path = NULL, *sm_gitdir; |
ee8838d1 SB |
478 | struct strbuf rel_path = STRBUF_INIT; |
479 | struct strbuf sb = STRBUF_INIT; | |
480 | ||
481 | struct option module_clone_options[] = { | |
482 | OPT_STRING(0, "prefix", &prefix, | |
483 | N_("path"), | |
484 | N_("alternative anchor for relative paths")), | |
485 | OPT_STRING(0, "path", &path, | |
486 | N_("path"), | |
487 | N_("where the new submodule will be cloned to")), | |
488 | OPT_STRING(0, "name", &name, | |
489 | N_("string"), | |
490 | N_("name of the new submodule")), | |
491 | OPT_STRING(0, "url", &url, | |
492 | N_("string"), | |
493 | N_("url where to clone the submodule from")), | |
494 | OPT_STRING(0, "reference", &reference, | |
495 | N_("string"), | |
496 | N_("reference repository")), | |
497 | OPT_STRING(0, "depth", &depth, | |
498 | N_("string"), | |
499 | N_("depth for shallow clones")), | |
500 | OPT__QUIET(&quiet, "Suppress output for cloning a submodule"), | |
501 | OPT_END() | |
502 | }; | |
503 | ||
504 | const char *const git_submodule_helper_usage[] = { | |
505 | N_("git submodule--helper clone [--prefix=<path>] [--quiet] " | |
506 | "[--reference <repository>] [--name <name>] [--url <url>]" | |
507 | "[--depth <depth>] [--] [<path>...]"), | |
508 | NULL | |
509 | }; | |
510 | ||
511 | argc = parse_options(argc, argv, prefix, module_clone_options, | |
512 | git_submodule_helper_usage, 0); | |
513 | ||
3c0663e1 SB |
514 | if (!path || !*path) |
515 | die(_("submodule--helper: unspecified or empty --path")); | |
516 | ||
ee8838d1 | 517 | strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), name); |
1ea4d9b7 JH |
518 | sm_gitdir = xstrdup(absolute_path(sb.buf)); |
519 | strbuf_reset(&sb); | |
f8eaa0ba SB |
520 | |
521 | if (!is_absolute_path(path)) { | |
522 | strbuf_addf(&sb, "%s/%s", get_git_work_tree(), path); | |
523 | path = strbuf_detach(&sb, NULL); | |
524 | } else | |
525 | path = xstrdup(path); | |
ee8838d1 SB |
526 | |
527 | if (!file_exists(sm_gitdir)) { | |
528 | if (safe_create_leading_directories_const(sm_gitdir) < 0) | |
529 | die(_("could not create directory '%s'"), sm_gitdir); | |
530 | if (clone_submodule(path, sm_gitdir, url, depth, reference, quiet)) | |
531 | die(_("clone of '%s' into submodule path '%s' failed"), | |
532 | url, path); | |
533 | } else { | |
534 | if (safe_create_leading_directories_const(path) < 0) | |
535 | die(_("could not create directory '%s'"), path); | |
536 | strbuf_addf(&sb, "%s/index", sm_gitdir); | |
537 | unlink_or_warn(sb.buf); | |
538 | strbuf_reset(&sb); | |
539 | } | |
540 | ||
541 | /* Write a .git file in the submodule to redirect to the superproject. */ | |
3c0663e1 | 542 | strbuf_addf(&sb, "%s/.git", path); |
ee8838d1 SB |
543 | if (safe_create_leading_directories_const(sb.buf) < 0) |
544 | die(_("could not create leading directories of '%s'"), sb.buf); | |
545 | submodule_dot_git = fopen(sb.buf, "w"); | |
546 | if (!submodule_dot_git) | |
547 | die_errno(_("cannot open file '%s'"), sb.buf); | |
548 | ||
1f15ba1f SB |
549 | fprintf_or_die(submodule_dot_git, "gitdir: %s\n", |
550 | relative_path(sm_gitdir, path, &rel_path)); | |
ee8838d1 SB |
551 | if (fclose(submodule_dot_git)) |
552 | die(_("could not close file %s"), sb.buf); | |
553 | strbuf_reset(&sb); | |
554 | strbuf_reset(&rel_path); | |
555 | ||
ee8838d1 | 556 | /* Redirect the worktree of the submodule in the superproject's config */ |
ee8838d1 SB |
557 | p = git_pathdup_submodule(path, "config"); |
558 | if (!p) | |
559 | die(_("could not get submodule directory for '%s'"), path); | |
560 | git_config_set_in_file(p, "core.worktree", | |
f8eaa0ba | 561 | relative_path(path, sm_gitdir, &rel_path)); |
ee8838d1 SB |
562 | strbuf_release(&sb); |
563 | strbuf_release(&rel_path); | |
564 | free(sm_gitdir); | |
f8eaa0ba | 565 | free(path); |
ee8838d1 SB |
566 | free(p); |
567 | return 0; | |
568 | } | |
74703a1e | 569 | |
48308681 SB |
570 | struct submodule_update_clone { |
571 | /* index into 'list', the list of submodules to look into for cloning */ | |
572 | int current; | |
573 | struct module_list list; | |
574 | unsigned warn_if_uninitialized : 1; | |
575 | ||
576 | /* update parameter passed via commandline */ | |
577 | struct submodule_update_strategy update; | |
578 | ||
579 | /* configuration parameters which are passed on to the children */ | |
580 | int quiet; | |
581 | const char *reference; | |
582 | const char *depth; | |
583 | const char *recursive_prefix; | |
584 | const char *prefix; | |
585 | ||
586 | /* Machine-readable status lines to be consumed by git-submodule.sh */ | |
587 | struct string_list projectlines; | |
588 | ||
589 | /* If we want to stop as fast as possible and return an error */ | |
590 | unsigned quickstop : 1; | |
591 | }; | |
592 | #define SUBMODULE_UPDATE_CLONE_INIT {0, MODULE_LIST_INIT, 0, \ | |
593 | SUBMODULE_UPDATE_STRATEGY_INIT, 0, NULL, NULL, NULL, NULL, \ | |
594 | STRING_LIST_INIT_DUP, 0} | |
595 | ||
596 | /** | |
597 | * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to | |
598 | * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise. | |
599 | */ | |
600 | static int prepare_to_clone_next_submodule(const struct cache_entry *ce, | |
601 | struct child_process *child, | |
602 | struct submodule_update_clone *suc, | |
603 | struct strbuf *out) | |
604 | { | |
605 | const struct submodule *sub = NULL; | |
606 | struct strbuf displaypath_sb = STRBUF_INIT; | |
607 | struct strbuf sb = STRBUF_INIT; | |
608 | const char *displaypath = NULL; | |
609 | char *url = NULL; | |
610 | int needs_cloning = 0; | |
611 | ||
612 | if (ce_stage(ce)) { | |
613 | if (suc->recursive_prefix) | |
614 | strbuf_addf(&sb, "%s/%s", suc->recursive_prefix, ce->name); | |
615 | else | |
616 | strbuf_addf(&sb, "%s", ce->name); | |
617 | strbuf_addf(out, _("Skipping unmerged submodule %s"), sb.buf); | |
618 | strbuf_addch(out, '\n'); | |
619 | goto cleanup; | |
620 | } | |
621 | ||
622 | sub = submodule_from_path(null_sha1, ce->name); | |
623 | ||
624 | if (suc->recursive_prefix) | |
625 | displaypath = relative_path(suc->recursive_prefix, | |
626 | ce->name, &displaypath_sb); | |
627 | else | |
628 | displaypath = ce->name; | |
629 | ||
630 | if (suc->update.type == SM_UPDATE_NONE | |
631 | || (suc->update.type == SM_UPDATE_UNSPECIFIED | |
632 | && sub->update_strategy.type == SM_UPDATE_NONE)) { | |
633 | strbuf_addf(out, _("Skipping submodule '%s'"), displaypath); | |
634 | strbuf_addch(out, '\n'); | |
635 | goto cleanup; | |
636 | } | |
637 | ||
638 | /* | |
639 | * Looking up the url in .git/config. | |
640 | * We must not fall back to .gitmodules as we only want | |
641 | * to process configured submodules. | |
642 | */ | |
643 | strbuf_reset(&sb); | |
644 | strbuf_addf(&sb, "submodule.%s.url", sub->name); | |
645 | git_config_get_string(sb.buf, &url); | |
646 | if (!url) { | |
647 | /* | |
648 | * Only mention uninitialized submodules when their | |
649 | * path have been specified | |
650 | */ | |
651 | if (suc->warn_if_uninitialized) { | |
652 | strbuf_addf(out, | |
653 | _("Submodule path '%s' not initialized"), | |
654 | displaypath); | |
655 | strbuf_addch(out, '\n'); | |
656 | strbuf_addstr(out, | |
657 | _("Maybe you want to use 'update --init'?")); | |
658 | strbuf_addch(out, '\n'); | |
659 | } | |
660 | goto cleanup; | |
661 | } | |
662 | ||
663 | strbuf_reset(&sb); | |
664 | strbuf_addf(&sb, "%s/.git", ce->name); | |
665 | needs_cloning = !file_exists(sb.buf); | |
666 | ||
667 | strbuf_reset(&sb); | |
668 | strbuf_addf(&sb, "%06o %s %d %d\t%s\n", ce->ce_mode, | |
669 | sha1_to_hex(ce->sha1), ce_stage(ce), | |
670 | needs_cloning, ce->name); | |
671 | string_list_append(&suc->projectlines, sb.buf); | |
672 | ||
673 | if (!needs_cloning) | |
674 | goto cleanup; | |
675 | ||
676 | child->git_cmd = 1; | |
677 | child->no_stdin = 1; | |
678 | child->stdout_to_stderr = 1; | |
679 | child->err = -1; | |
680 | argv_array_push(&child->args, "submodule--helper"); | |
681 | argv_array_push(&child->args, "clone"); | |
682 | if (suc->quiet) | |
683 | argv_array_push(&child->args, "--quiet"); | |
684 | if (suc->prefix) | |
685 | argv_array_pushl(&child->args, "--prefix", suc->prefix, NULL); | |
686 | argv_array_pushl(&child->args, "--path", sub->path, NULL); | |
687 | argv_array_pushl(&child->args, "--name", sub->name, NULL); | |
688 | argv_array_pushl(&child->args, "--url", url, NULL); | |
689 | if (suc->reference) | |
690 | argv_array_push(&child->args, suc->reference); | |
691 | if (suc->depth) | |
692 | argv_array_push(&child->args, suc->depth); | |
693 | ||
694 | cleanup: | |
695 | free(url); | |
696 | strbuf_reset(&displaypath_sb); | |
697 | strbuf_reset(&sb); | |
698 | ||
699 | return needs_cloning; | |
700 | } | |
701 | ||
702 | static int update_clone_get_next_task(struct child_process *child, | |
703 | struct strbuf *err, | |
704 | void *suc_cb, | |
705 | void **void_task_cb) | |
706 | { | |
707 | struct submodule_update_clone *suc = suc_cb; | |
708 | ||
709 | for (; suc->current < suc->list.nr; suc->current++) { | |
710 | const struct cache_entry *ce = suc->list.entries[suc->current]; | |
711 | if (prepare_to_clone_next_submodule(ce, child, suc, err)) { | |
712 | suc->current++; | |
713 | return 1; | |
714 | } | |
715 | } | |
716 | return 0; | |
717 | } | |
718 | ||
719 | static int update_clone_start_failure(struct strbuf *err, | |
720 | void *suc_cb, | |
721 | void *void_task_cb) | |
722 | { | |
723 | struct submodule_update_clone *suc = suc_cb; | |
724 | suc->quickstop = 1; | |
725 | return 1; | |
726 | } | |
727 | ||
728 | static int update_clone_task_finished(int result, | |
729 | struct strbuf *err, | |
730 | void *suc_cb, | |
731 | void *void_task_cb) | |
732 | { | |
733 | struct submodule_update_clone *suc = suc_cb; | |
734 | ||
735 | if (!result) | |
736 | return 0; | |
737 | ||
738 | suc->quickstop = 1; | |
739 | return 1; | |
740 | } | |
741 | ||
742 | static int update_clone(int argc, const char **argv, const char *prefix) | |
743 | { | |
744 | const char *update = NULL; | |
2335b870 | 745 | int max_jobs = -1; |
48308681 SB |
746 | struct string_list_item *item; |
747 | struct pathspec pathspec; | |
748 | struct submodule_update_clone suc = SUBMODULE_UPDATE_CLONE_INIT; | |
749 | ||
750 | struct option module_update_clone_options[] = { | |
751 | OPT_STRING(0, "prefix", &prefix, | |
752 | N_("path"), | |
753 | N_("path into the working tree")), | |
754 | OPT_STRING(0, "recursive-prefix", &suc.recursive_prefix, | |
755 | N_("path"), | |
756 | N_("path into the working tree, across nested " | |
757 | "submodule boundaries")), | |
758 | OPT_STRING(0, "update", &update, | |
759 | N_("string"), | |
760 | N_("rebase, merge, checkout or none")), | |
761 | OPT_STRING(0, "reference", &suc.reference, N_("repo"), | |
762 | N_("reference repository")), | |
763 | OPT_STRING(0, "depth", &suc.depth, "<depth>", | |
764 | N_("Create a shallow clone truncated to the " | |
765 | "specified number of revisions")), | |
2335b870 SB |
766 | OPT_INTEGER('j', "jobs", &max_jobs, |
767 | N_("parallel jobs")), | |
48308681 SB |
768 | OPT__QUIET(&suc.quiet, N_("don't print cloning progress")), |
769 | OPT_END() | |
770 | }; | |
771 | ||
772 | const char *const git_submodule_helper_usage[] = { | |
773 | N_("git submodule--helper update_clone [--prefix=<path>] [<path>...]"), | |
774 | NULL | |
775 | }; | |
776 | suc.prefix = prefix; | |
777 | ||
778 | argc = parse_options(argc, argv, prefix, module_update_clone_options, | |
779 | git_submodule_helper_usage, 0); | |
780 | ||
781 | if (update) | |
782 | if (parse_submodule_update_strategy(update, &suc.update) < 0) | |
783 | die(_("bad value for update parameter")); | |
784 | ||
785 | if (module_list_compute(argc, argv, prefix, &pathspec, &suc.list) < 0) | |
786 | return 1; | |
787 | ||
788 | if (pathspec.nr) | |
789 | suc.warn_if_uninitialized = 1; | |
790 | ||
791 | /* Overlay the parsed .gitmodules file with .git/config */ | |
792 | gitmodules_config(); | |
793 | git_config(submodule_config, NULL); | |
794 | ||
2335b870 SB |
795 | if (max_jobs < 0) |
796 | max_jobs = parallel_submodules(); | |
797 | ||
798 | run_processes_parallel(max_jobs, | |
48308681 SB |
799 | update_clone_get_next_task, |
800 | update_clone_start_failure, | |
801 | update_clone_task_finished, | |
802 | &suc); | |
803 | ||
804 | /* | |
805 | * We saved the output and put it out all at once now. | |
806 | * That means: | |
807 | * - the listener does not have to interleave their (checkout) | |
808 | * work with our fetching. The writes involved in a | |
809 | * checkout involve more straightforward sequential I/O. | |
810 | * - the listener can avoid doing any work if fetching failed. | |
811 | */ | |
812 | if (suc.quickstop) | |
813 | return 1; | |
814 | ||
815 | for_each_string_list_item(item, &suc.projectlines) | |
816 | utf8_fprintf(stdout, "%s", item->string); | |
817 | ||
818 | return 0; | |
819 | } | |
820 | ||
74703a1e SB |
821 | struct cmd_struct { |
822 | const char *cmd; | |
823 | int (*fn)(int, const char **, const char *); | |
824 | }; | |
825 | ||
826 | static struct cmd_struct commands[] = { | |
827 | {"list", module_list}, | |
0ea306ef | 828 | {"name", module_name}, |
ee8838d1 | 829 | {"clone", module_clone}, |
63e95beb SB |
830 | {"update-clone", update_clone}, |
831 | {"resolve-relative-url", resolve_relative_url}, | |
832 | {"resolve-relative-url-test", resolve_relative_url_test}, | |
3604242f | 833 | {"init", module_init} |
74703a1e SB |
834 | }; |
835 | ||
836 | int cmd_submodule__helper(int argc, const char **argv, const char *prefix) | |
837 | { | |
838 | int i; | |
839 | if (argc < 2) | |
cdc04b65 | 840 | die(_("submodule--helper subcommand must be " |
74703a1e SB |
841 | "called with a subcommand")); |
842 | ||
843 | for (i = 0; i < ARRAY_SIZE(commands); i++) | |
844 | if (!strcmp(argv[1], commands[i].cmd)) | |
845 | return commands[i].fn(argc - 1, argv + 1, prefix); | |
846 | ||
cdc04b65 | 847 | die(_("'%s' is not a valid submodule--helper " |
74703a1e SB |
848 | "subcommand"), argv[1]); |
849 | } |