]> git.ipfire.org Git - thirdparty/git.git/blob - submodule.c
clone: allow "--bare" with "-o"
[thirdparty/git.git] / submodule.c
1
2 #include "cache.h"
3 #include "repository.h"
4 #include "config.h"
5 #include "submodule-config.h"
6 #include "submodule.h"
7 #include "dir.h"
8 #include "diff.h"
9 #include "commit.h"
10 #include "revision.h"
11 #include "run-command.h"
12 #include "diffcore.h"
13 #include "refs.h"
14 #include "string-list.h"
15 #include "oid-array.h"
16 #include "strvec.h"
17 #include "blob.h"
18 #include "thread-utils.h"
19 #include "quote.h"
20 #include "remote.h"
21 #include "worktree.h"
22 #include "parse-options.h"
23 #include "object-store.h"
24 #include "commit-reach.h"
25 #include "shallow.h"
26
27 static int config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
28 static int initialized_fetch_ref_tips;
29 static struct oid_array ref_tips_before_fetch;
30 static struct oid_array ref_tips_after_fetch;
31
32 /*
33 * Check if the .gitmodules file is unmerged. Parsing of the .gitmodules file
34 * will be disabled because we can't guess what might be configured in
35 * .gitmodules unless the user resolves the conflict.
36 */
37 int is_gitmodules_unmerged(struct index_state *istate)
38 {
39 int pos = index_name_pos(istate, GITMODULES_FILE, strlen(GITMODULES_FILE));
40 if (pos < 0) { /* .gitmodules not found or isn't merged */
41 pos = -1 - pos;
42 if (istate->cache_nr > pos) { /* there is a .gitmodules */
43 const struct cache_entry *ce = istate->cache[pos];
44 if (ce_namelen(ce) == strlen(GITMODULES_FILE) &&
45 !strcmp(ce->name, GITMODULES_FILE))
46 return 1;
47 }
48 }
49
50 return 0;
51 }
52
53 /*
54 * Check if the .gitmodules file is safe to write.
55 *
56 * Writing to the .gitmodules file requires that the file exists in the
57 * working tree or, if it doesn't, that a brand new .gitmodules file is going
58 * to be created (i.e. it's neither in the index nor in the current branch).
59 *
60 * It is not safe to write to .gitmodules if it's not in the working tree but
61 * it is in the index or in the current branch, because writing new values
62 * (and staging them) would blindly overwrite ALL the old content.
63 */
64 int is_writing_gitmodules_ok(void)
65 {
66 struct object_id oid;
67 return file_exists(GITMODULES_FILE) ||
68 (get_oid(GITMODULES_INDEX, &oid) < 0 && get_oid(GITMODULES_HEAD, &oid) < 0);
69 }
70
71 /*
72 * Check if the .gitmodules file has unstaged modifications. This must be
73 * checked before allowing modifications to the .gitmodules file with the
74 * intention to stage them later, because when continuing we would stage the
75 * modifications the user didn't stage herself too. That might change in a
76 * future version when we learn to stage the changes we do ourselves without
77 * staging any previous modifications.
78 */
79 int is_staging_gitmodules_ok(struct index_state *istate)
80 {
81 int pos = index_name_pos(istate, GITMODULES_FILE, strlen(GITMODULES_FILE));
82
83 if ((pos >= 0) && (pos < istate->cache_nr)) {
84 struct stat st;
85 if (lstat(GITMODULES_FILE, &st) == 0 &&
86 ie_modified(istate, istate->cache[pos], &st, 0) & DATA_CHANGED)
87 return 0;
88 }
89
90 return 1;
91 }
92
93 static int for_each_remote_ref_submodule(const char *submodule,
94 each_ref_fn fn, void *cb_data)
95 {
96 return refs_for_each_remote_ref(get_submodule_ref_store(submodule),
97 fn, cb_data);
98 }
99
100 /*
101 * Try to update the "path" entry in the "submodule.<name>" section of the
102 * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
103 * with the correct path=<oldpath> setting was found and we could update it.
104 */
105 int update_path_in_gitmodules(const char *oldpath, const char *newpath)
106 {
107 struct strbuf entry = STRBUF_INIT;
108 const struct submodule *submodule;
109 int ret;
110
111 if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
112 return -1;
113
114 if (is_gitmodules_unmerged(the_repository->index))
115 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
116
117 submodule = submodule_from_path(the_repository, null_oid(), oldpath);
118 if (!submodule || !submodule->name) {
119 warning(_("Could not find section in .gitmodules where path=%s"), oldpath);
120 return -1;
121 }
122 strbuf_addstr(&entry, "submodule.");
123 strbuf_addstr(&entry, submodule->name);
124 strbuf_addstr(&entry, ".path");
125 ret = config_set_in_gitmodules_file_gently(entry.buf, newpath);
126 strbuf_release(&entry);
127 return ret;
128 }
129
130 /*
131 * Try to remove the "submodule.<name>" section from .gitmodules where the given
132 * path is configured. Return 0 only if a .gitmodules file was found, a section
133 * with the correct path=<path> setting was found and we could remove it.
134 */
135 int remove_path_from_gitmodules(const char *path)
136 {
137 struct strbuf sect = STRBUF_INIT;
138 const struct submodule *submodule;
139
140 if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
141 return -1;
142
143 if (is_gitmodules_unmerged(the_repository->index))
144 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
145
146 submodule = submodule_from_path(the_repository, null_oid(), path);
147 if (!submodule || !submodule->name) {
148 warning(_("Could not find section in .gitmodules where path=%s"), path);
149 return -1;
150 }
151 strbuf_addstr(&sect, "submodule.");
152 strbuf_addstr(&sect, submodule->name);
153 if (git_config_rename_section_in_file(GITMODULES_FILE, sect.buf, NULL) < 0) {
154 /* Maybe the user already did that, don't error out here */
155 warning(_("Could not remove .gitmodules entry for %s"), path);
156 strbuf_release(&sect);
157 return -1;
158 }
159 strbuf_release(&sect);
160 return 0;
161 }
162
163 void stage_updated_gitmodules(struct index_state *istate)
164 {
165 if (add_file_to_index(istate, GITMODULES_FILE, 0))
166 die(_("staging updated .gitmodules failed"));
167 }
168
169 static struct string_list added_submodule_odb_paths = STRING_LIST_INIT_NODUP;
170
171 void add_submodule_odb_by_path(const char *path)
172 {
173 string_list_insert(&added_submodule_odb_paths, xstrdup(path));
174 }
175
176 int register_all_submodule_odb_as_alternates(void)
177 {
178 int i;
179 int ret = added_submodule_odb_paths.nr;
180
181 for (i = 0; i < added_submodule_odb_paths.nr; i++)
182 add_to_alternates_memory(added_submodule_odb_paths.items[i].string);
183 if (ret) {
184 string_list_clear(&added_submodule_odb_paths, 0);
185 trace2_data_intmax("submodule", the_repository,
186 "register_all_submodule_odb_as_alternates/registered", ret);
187 if (git_env_bool("GIT_TEST_FATAL_REGISTER_SUBMODULE_ODB", 0))
188 BUG("register_all_submodule_odb_as_alternates() called");
189 }
190 return ret;
191 }
192
193 void set_diffopt_flags_from_submodule_config(struct diff_options *diffopt,
194 const char *path)
195 {
196 const struct submodule *submodule = submodule_from_path(the_repository,
197 null_oid(),
198 path);
199 if (submodule) {
200 const char *ignore;
201 char *key;
202
203 key = xstrfmt("submodule.%s.ignore", submodule->name);
204 if (repo_config_get_string_tmp(the_repository, key, &ignore))
205 ignore = submodule->ignore;
206 free(key);
207
208 if (ignore)
209 handle_ignore_submodules_arg(diffopt, ignore);
210 else if (is_gitmodules_unmerged(the_repository->index))
211 diffopt->flags.ignore_submodules = 1;
212 }
213 }
214
215 /* Cheap function that only determines if we're interested in submodules at all */
216 int git_default_submodule_config(const char *var, const char *value, void *cb)
217 {
218 if (!strcmp(var, "submodule.recurse")) {
219 int v = git_config_bool(var, value) ?
220 RECURSE_SUBMODULES_ON : RECURSE_SUBMODULES_OFF;
221 config_update_recurse_submodules = v;
222 }
223 return 0;
224 }
225
226 int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
227 const char *arg, int unset)
228 {
229 if (unset) {
230 config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
231 return 0;
232 }
233 if (arg)
234 config_update_recurse_submodules =
235 parse_update_recurse_submodules_arg(opt->long_name,
236 arg);
237 else
238 config_update_recurse_submodules = RECURSE_SUBMODULES_ON;
239
240 return 0;
241 }
242
243 /*
244 * Determine if a submodule has been initialized at a given 'path'
245 */
246 /*
247 * NEEDSWORK: Emit a warning if submodule.active exists, but is valueless,
248 * ie, the config looks like: "[submodule] active\n".
249 * Since that is an invalid pathspec, we should inform the user.
250 */
251 int is_tree_submodule_active(struct repository *repo,
252 const struct object_id *treeish_name,
253 const char *path)
254 {
255 int ret = 0;
256 char *key = NULL;
257 char *value = NULL;
258 const struct string_list *sl;
259 const struct submodule *module;
260
261 module = submodule_from_path(repo, treeish_name, path);
262
263 /* early return if there isn't a path->module mapping */
264 if (!module)
265 return 0;
266
267 /* submodule.<name>.active is set */
268 key = xstrfmt("submodule.%s.active", module->name);
269 if (!repo_config_get_bool(repo, key, &ret)) {
270 free(key);
271 return ret;
272 }
273 free(key);
274
275 /* submodule.active is set */
276 sl = repo_config_get_value_multi(repo, "submodule.active");
277 if (sl) {
278 struct pathspec ps;
279 struct strvec args = STRVEC_INIT;
280 const struct string_list_item *item;
281
282 for_each_string_list_item(item, sl) {
283 strvec_push(&args, item->string);
284 }
285
286 parse_pathspec(&ps, 0, 0, NULL, args.v);
287 ret = match_pathspec(repo->index, &ps, path, strlen(path), 0, NULL, 1);
288
289 strvec_clear(&args);
290 clear_pathspec(&ps);
291 return ret;
292 }
293
294 /* fallback to checking if the URL is set */
295 key = xstrfmt("submodule.%s.url", module->name);
296 ret = !repo_config_get_string(repo, key, &value);
297
298 free(value);
299 free(key);
300 return ret;
301 }
302
303 int is_submodule_active(struct repository *repo, const char *path)
304 {
305 return is_tree_submodule_active(repo, null_oid(), path);
306 }
307
308 int is_submodule_populated_gently(const char *path, int *return_error_code)
309 {
310 int ret = 0;
311 char *gitdir = xstrfmt("%s/.git", path);
312
313 if (resolve_gitdir_gently(gitdir, return_error_code))
314 ret = 1;
315
316 free(gitdir);
317 return ret;
318 }
319
320 /*
321 * Dies if the provided 'prefix' corresponds to an unpopulated submodule
322 */
323 void die_in_unpopulated_submodule(struct index_state *istate,
324 const char *prefix)
325 {
326 int i, prefixlen;
327
328 if (!prefix)
329 return;
330
331 prefixlen = strlen(prefix);
332
333 for (i = 0; i < istate->cache_nr; i++) {
334 struct cache_entry *ce = istate->cache[i];
335 int ce_len = ce_namelen(ce);
336
337 if (!S_ISGITLINK(ce->ce_mode))
338 continue;
339 if (prefixlen <= ce_len)
340 continue;
341 if (strncmp(ce->name, prefix, ce_len))
342 continue;
343 if (prefix[ce_len] != '/')
344 continue;
345
346 die(_("in unpopulated submodule '%s'"), ce->name);
347 }
348 }
349
350 /*
351 * Dies if any paths in the provided pathspec descends into a submodule
352 */
353 void die_path_inside_submodule(struct index_state *istate,
354 const struct pathspec *ps)
355 {
356 int i, j;
357
358 for (i = 0; i < istate->cache_nr; i++) {
359 struct cache_entry *ce = istate->cache[i];
360 int ce_len = ce_namelen(ce);
361
362 if (!S_ISGITLINK(ce->ce_mode))
363 continue;
364
365 for (j = 0; j < ps->nr ; j++) {
366 const struct pathspec_item *item = &ps->items[j];
367
368 if (item->len <= ce_len)
369 continue;
370 if (item->match[ce_len] != '/')
371 continue;
372 if (strncmp(ce->name, item->match, ce_len))
373 continue;
374 if (item->len == ce_len + 1)
375 continue;
376
377 die(_("Pathspec '%s' is in submodule '%.*s'"),
378 item->original, ce_len, ce->name);
379 }
380 }
381 }
382
383 enum submodule_update_type parse_submodule_update_type(const char *value)
384 {
385 if (!strcmp(value, "none"))
386 return SM_UPDATE_NONE;
387 else if (!strcmp(value, "checkout"))
388 return SM_UPDATE_CHECKOUT;
389 else if (!strcmp(value, "rebase"))
390 return SM_UPDATE_REBASE;
391 else if (!strcmp(value, "merge"))
392 return SM_UPDATE_MERGE;
393 else if (*value == '!')
394 return SM_UPDATE_COMMAND;
395 else
396 return SM_UPDATE_UNSPECIFIED;
397 }
398
399 int parse_submodule_update_strategy(const char *value,
400 struct submodule_update_strategy *dst)
401 {
402 enum submodule_update_type type;
403
404 free((void*)dst->command);
405 dst->command = NULL;
406
407 type = parse_submodule_update_type(value);
408 if (type == SM_UPDATE_UNSPECIFIED)
409 return -1;
410
411 dst->type = type;
412 if (type == SM_UPDATE_COMMAND)
413 dst->command = xstrdup(value + 1);
414
415 return 0;
416 }
417
418 const char *submodule_strategy_to_string(const struct submodule_update_strategy *s)
419 {
420 struct strbuf sb = STRBUF_INIT;
421 switch (s->type) {
422 case SM_UPDATE_CHECKOUT:
423 return "checkout";
424 case SM_UPDATE_MERGE:
425 return "merge";
426 case SM_UPDATE_REBASE:
427 return "rebase";
428 case SM_UPDATE_NONE:
429 return "none";
430 case SM_UPDATE_UNSPECIFIED:
431 return NULL;
432 case SM_UPDATE_COMMAND:
433 strbuf_addf(&sb, "!%s", s->command);
434 return strbuf_detach(&sb, NULL);
435 }
436 return NULL;
437 }
438
439 void handle_ignore_submodules_arg(struct diff_options *diffopt,
440 const char *arg)
441 {
442 diffopt->flags.ignore_submodule_set = 1;
443 diffopt->flags.ignore_submodules = 0;
444 diffopt->flags.ignore_untracked_in_submodules = 0;
445 diffopt->flags.ignore_dirty_submodules = 0;
446
447 if (!strcmp(arg, "all"))
448 diffopt->flags.ignore_submodules = 1;
449 else if (!strcmp(arg, "untracked"))
450 diffopt->flags.ignore_untracked_in_submodules = 1;
451 else if (!strcmp(arg, "dirty"))
452 diffopt->flags.ignore_dirty_submodules = 1;
453 else if (strcmp(arg, "none"))
454 die(_("bad --ignore-submodules argument: %s"), arg);
455 /*
456 * Please update _git_status() in git-completion.bash when you
457 * add new options
458 */
459 }
460
461 static int prepare_submodule_diff_summary(struct repository *r, struct rev_info *rev,
462 const char *path,
463 struct commit *left, struct commit *right,
464 struct commit_list *merge_bases)
465 {
466 struct commit_list *list;
467
468 repo_init_revisions(r, rev, NULL);
469 setup_revisions(0, NULL, rev, NULL);
470 rev->left_right = 1;
471 rev->first_parent_only = 1;
472 left->object.flags |= SYMMETRIC_LEFT;
473 add_pending_object(rev, &left->object, path);
474 add_pending_object(rev, &right->object, path);
475 for (list = merge_bases; list; list = list->next) {
476 list->item->object.flags |= UNINTERESTING;
477 add_pending_object(rev, &list->item->object,
478 oid_to_hex(&list->item->object.oid));
479 }
480 return prepare_revision_walk(rev);
481 }
482
483 static void print_submodule_diff_summary(struct repository *r, struct rev_info *rev, struct diff_options *o)
484 {
485 static const char format[] = " %m %s";
486 struct strbuf sb = STRBUF_INIT;
487 struct commit *commit;
488
489 while ((commit = get_revision(rev))) {
490 struct pretty_print_context ctx = {0};
491 ctx.date_mode = rev->date_mode;
492 ctx.output_encoding = get_log_output_encoding();
493 strbuf_setlen(&sb, 0);
494 repo_format_commit_message(r, commit, format, &sb,
495 &ctx);
496 strbuf_addch(&sb, '\n');
497 if (commit->object.flags & SYMMETRIC_LEFT)
498 diff_emit_submodule_del(o, sb.buf);
499 else
500 diff_emit_submodule_add(o, sb.buf);
501 }
502 strbuf_release(&sb);
503 }
504
505 void prepare_submodule_repo_env(struct strvec *out)
506 {
507 prepare_other_repo_env(out, DEFAULT_GIT_DIR_ENVIRONMENT);
508 }
509
510 static void prepare_submodule_repo_env_in_gitdir(struct strvec *out)
511 {
512 prepare_other_repo_env(out, ".");
513 }
514
515 /*
516 * Initialize a repository struct for a submodule based on the provided 'path'.
517 *
518 * Returns the repository struct on success,
519 * NULL when the submodule is not present.
520 */
521 static struct repository *open_submodule(const char *path)
522 {
523 struct strbuf sb = STRBUF_INIT;
524 struct repository *out = xmalloc(sizeof(*out));
525
526 if (submodule_to_gitdir(&sb, path) || repo_init(out, sb.buf, NULL)) {
527 strbuf_release(&sb);
528 free(out);
529 return NULL;
530 }
531
532 /* Mark it as a submodule */
533 out->submodule_prefix = xstrdup(path);
534
535 strbuf_release(&sb);
536 return out;
537 }
538
539 /*
540 * Helper function to display the submodule header line prior to the full
541 * summary output.
542 *
543 * If it can locate the submodule git directory it will create a repository
544 * handle for the submodule and lookup both the left and right commits and
545 * put them into the left and right pointers.
546 */
547 static void show_submodule_header(struct diff_options *o,
548 const char *path,
549 struct object_id *one, struct object_id *two,
550 unsigned dirty_submodule,
551 struct repository *sub,
552 struct commit **left, struct commit **right,
553 struct commit_list **merge_bases)
554 {
555 const char *message = NULL;
556 struct strbuf sb = STRBUF_INIT;
557 int fast_forward = 0, fast_backward = 0;
558
559 if (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED)
560 diff_emit_submodule_untracked(o, path);
561
562 if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
563 diff_emit_submodule_modified(o, path);
564
565 if (is_null_oid(one))
566 message = "(new submodule)";
567 else if (is_null_oid(two))
568 message = "(submodule deleted)";
569
570 if (!sub) {
571 if (!message)
572 message = "(commits not present)";
573 goto output_header;
574 }
575
576 /*
577 * Attempt to lookup the commit references, and determine if this is
578 * a fast forward or fast backwards update.
579 */
580 *left = lookup_commit_reference(sub, one);
581 *right = lookup_commit_reference(sub, two);
582
583 /*
584 * Warn about missing commits in the submodule project, but only if
585 * they aren't null.
586 */
587 if ((!is_null_oid(one) && !*left) ||
588 (!is_null_oid(two) && !*right))
589 message = "(commits not present)";
590
591 *merge_bases = repo_get_merge_bases(sub, *left, *right);
592 if (*merge_bases) {
593 if ((*merge_bases)->item == *left)
594 fast_forward = 1;
595 else if ((*merge_bases)->item == *right)
596 fast_backward = 1;
597 }
598
599 if (oideq(one, two)) {
600 strbuf_release(&sb);
601 return;
602 }
603
604 output_header:
605 strbuf_addf(&sb, "Submodule %s ", path);
606 strbuf_add_unique_abbrev(&sb, one, DEFAULT_ABBREV);
607 strbuf_addstr(&sb, (fast_backward || fast_forward) ? ".." : "...");
608 strbuf_add_unique_abbrev(&sb, two, DEFAULT_ABBREV);
609 if (message)
610 strbuf_addf(&sb, " %s\n", message);
611 else
612 strbuf_addf(&sb, "%s:\n", fast_backward ? " (rewind)" : "");
613 diff_emit_submodule_header(o, sb.buf);
614
615 strbuf_release(&sb);
616 }
617
618 void show_submodule_diff_summary(struct diff_options *o, const char *path,
619 struct object_id *one, struct object_id *two,
620 unsigned dirty_submodule)
621 {
622 struct rev_info rev = REV_INFO_INIT;
623 struct commit *left = NULL, *right = NULL;
624 struct commit_list *merge_bases = NULL;
625 struct repository *sub;
626
627 sub = open_submodule(path);
628 show_submodule_header(o, path, one, two, dirty_submodule,
629 sub, &left, &right, &merge_bases);
630
631 /*
632 * If we don't have both a left and a right pointer, there is no
633 * reason to try and display a summary. The header line should contain
634 * all the information the user needs.
635 */
636 if (!left || !right || !sub)
637 goto out;
638
639 /* Treat revision walker failure the same as missing commits */
640 if (prepare_submodule_diff_summary(sub, &rev, path, left, right, merge_bases)) {
641 diff_emit_submodule_error(o, "(revision walker failed)\n");
642 goto out;
643 }
644
645 print_submodule_diff_summary(sub, &rev, o);
646
647 out:
648 free_commit_list(merge_bases);
649 release_revisions(&rev);
650 clear_commit_marks(left, ~0);
651 clear_commit_marks(right, ~0);
652 if (sub) {
653 repo_clear(sub);
654 free(sub);
655 }
656 }
657
658 void show_submodule_inline_diff(struct diff_options *o, const char *path,
659 struct object_id *one, struct object_id *two,
660 unsigned dirty_submodule)
661 {
662 const struct object_id *old_oid = the_hash_algo->empty_tree, *new_oid = the_hash_algo->empty_tree;
663 struct commit *left = NULL, *right = NULL;
664 struct commit_list *merge_bases = NULL;
665 struct child_process cp = CHILD_PROCESS_INIT;
666 struct strbuf sb = STRBUF_INIT;
667 struct repository *sub;
668
669 sub = open_submodule(path);
670 show_submodule_header(o, path, one, two, dirty_submodule,
671 sub, &left, &right, &merge_bases);
672
673 /* We need a valid left and right commit to display a difference */
674 if (!(left || is_null_oid(one)) ||
675 !(right || is_null_oid(two)))
676 goto done;
677
678 if (left)
679 old_oid = one;
680 if (right)
681 new_oid = two;
682
683 cp.git_cmd = 1;
684 cp.dir = path;
685 cp.out = -1;
686 cp.no_stdin = 1;
687
688 /* TODO: other options may need to be passed here. */
689 strvec_pushl(&cp.args, "diff", "--submodule=diff", NULL);
690 strvec_pushf(&cp.args, "--color=%s", want_color(o->use_color) ?
691 "always" : "never");
692
693 if (o->flags.reverse_diff) {
694 strvec_pushf(&cp.args, "--src-prefix=%s%s/",
695 o->b_prefix, path);
696 strvec_pushf(&cp.args, "--dst-prefix=%s%s/",
697 o->a_prefix, path);
698 } else {
699 strvec_pushf(&cp.args, "--src-prefix=%s%s/",
700 o->a_prefix, path);
701 strvec_pushf(&cp.args, "--dst-prefix=%s%s/",
702 o->b_prefix, path);
703 }
704 strvec_push(&cp.args, oid_to_hex(old_oid));
705 /*
706 * If the submodule has modified content, we will diff against the
707 * work tree, under the assumption that the user has asked for the
708 * diff format and wishes to actually see all differences even if they
709 * haven't yet been committed to the submodule yet.
710 */
711 if (!(dirty_submodule & DIRTY_SUBMODULE_MODIFIED))
712 strvec_push(&cp.args, oid_to_hex(new_oid));
713
714 prepare_submodule_repo_env(&cp.env);
715
716 if (!is_directory(path)) {
717 /* fall back to absorbed git dir, if any */
718 if (!sub)
719 goto done;
720 cp.dir = sub->gitdir;
721 strvec_push(&cp.env, GIT_DIR_ENVIRONMENT "=.");
722 strvec_push(&cp.env, GIT_WORK_TREE_ENVIRONMENT "=.");
723 }
724
725 if (start_command(&cp)) {
726 diff_emit_submodule_error(o, "(diff failed)\n");
727 goto done;
728 }
729
730 while (strbuf_getwholeline_fd(&sb, cp.out, '\n') != EOF)
731 diff_emit_submodule_pipethrough(o, sb.buf, sb.len);
732
733 if (finish_command(&cp))
734 diff_emit_submodule_error(o, "(diff failed)\n");
735
736 done:
737 strbuf_release(&sb);
738 free_commit_list(merge_bases);
739 if (left)
740 clear_commit_marks(left, ~0);
741 if (right)
742 clear_commit_marks(right, ~0);
743 if (sub) {
744 repo_clear(sub);
745 free(sub);
746 }
747 }
748
749 int should_update_submodules(void)
750 {
751 return config_update_recurse_submodules == RECURSE_SUBMODULES_ON;
752 }
753
754 const struct submodule *submodule_from_ce(const struct cache_entry *ce)
755 {
756 if (!S_ISGITLINK(ce->ce_mode))
757 return NULL;
758
759 if (!should_update_submodules())
760 return NULL;
761
762 return submodule_from_path(the_repository, null_oid(), ce->name);
763 }
764
765
766 struct collect_changed_submodules_cb_data {
767 struct repository *repo;
768 struct string_list *changed;
769 const struct object_id *commit_oid;
770 };
771
772 /*
773 * this would normally be two functions: default_name_from_path() and
774 * path_from_default_name(). Since the default name is the same as
775 * the submodule path we can get away with just one function which only
776 * checks whether there is a submodule in the working directory at that
777 * location.
778 */
779 static const char *default_name_or_path(const char *path_or_name)
780 {
781 int error_code;
782
783 if (!is_submodule_populated_gently(path_or_name, &error_code))
784 return NULL;
785
786 return path_or_name;
787 }
788
789 /*
790 * Holds relevant information for a changed submodule. Used as the .util
791 * member of the changed submodule name string_list_item.
792 *
793 * (super_oid, path) allows the submodule config to be read from _some_
794 * .gitmodules file. We store this information the first time we find a
795 * superproject commit that points to the submodule, but this is
796 * arbitrary - we can choose any (super_oid, path) that matches the
797 * submodule's name.
798 *
799 * NEEDSWORK: Storing an arbitrary commit is undesirable because we can't
800 * guarantee that we're reading the commit that the user would expect. A better
801 * scheme would be to just fetch a submodule by its name. This requires two
802 * steps:
803 * - Create a function that behaves like repo_submodule_init(), but accepts a
804 * submodule name instead of treeish_name and path. This should be easy
805 * because repo_submodule_init() internally uses the submodule's name.
806 *
807 * - Replace most instances of 'struct submodule' (which is the .gitmodules
808 * config) with just the submodule name. This is OK because we expect
809 * submodule settings to be stored in .git/config (via "git submodule init"),
810 * not .gitmodules. This also lets us delete get_non_gitmodules_submodule(),
811 * which constructs a bogus 'struct submodule' for the sake of giving a
812 * placeholder name to a gitlink.
813 */
814 struct changed_submodule_data {
815 /*
816 * The first superproject commit in the rev walk that points to
817 * the submodule.
818 */
819 const struct object_id *super_oid;
820 /*
821 * Path to the submodule in the superproject commit referenced
822 * by 'super_oid'.
823 */
824 char *path;
825 /* The submodule commits that have changed in the rev walk. */
826 struct oid_array new_commits;
827 };
828
829 static void changed_submodule_data_clear(struct changed_submodule_data *cs_data)
830 {
831 oid_array_clear(&cs_data->new_commits);
832 free(cs_data->path);
833 }
834
835 static void collect_changed_submodules_cb(struct diff_queue_struct *q,
836 struct diff_options *options,
837 void *data)
838 {
839 struct collect_changed_submodules_cb_data *me = data;
840 struct string_list *changed = me->changed;
841 const struct object_id *commit_oid = me->commit_oid;
842 int i;
843
844 for (i = 0; i < q->nr; i++) {
845 struct diff_filepair *p = q->queue[i];
846 const struct submodule *submodule;
847 const char *name;
848 struct string_list_item *item;
849 struct changed_submodule_data *cs_data;
850
851 if (!S_ISGITLINK(p->two->mode))
852 continue;
853
854 submodule = submodule_from_path(me->repo,
855 commit_oid, p->two->path);
856 if (submodule)
857 name = submodule->name;
858 else {
859 name = default_name_or_path(p->two->path);
860 /* make sure name does not collide with existing one */
861 if (name)
862 submodule = submodule_from_name(me->repo,
863 commit_oid, name);
864 if (submodule) {
865 warning(_("Submodule in commit %s at path: "
866 "'%s' collides with a submodule named "
867 "the same. Skipping it."),
868 oid_to_hex(commit_oid), p->two->path);
869 name = NULL;
870 }
871 }
872
873 if (!name)
874 continue;
875
876 item = string_list_insert(changed, name);
877 if (item->util)
878 cs_data = item->util;
879 else {
880 item->util = xcalloc(1, sizeof(struct changed_submodule_data));
881 cs_data = item->util;
882 cs_data->super_oid = commit_oid;
883 cs_data->path = xstrdup(p->two->path);
884 }
885 oid_array_append(&cs_data->new_commits, &p->two->oid);
886 }
887 }
888
889 /*
890 * Collect the paths of submodules in 'changed' which have changed based on
891 * the revisions as specified in 'argv'. Each entry in 'changed' will also
892 * have a corresponding 'struct oid_array' (in the 'util' field) which lists
893 * what the submodule pointers were updated to during the change.
894 */
895 static void collect_changed_submodules(struct repository *r,
896 struct string_list *changed,
897 struct strvec *argv)
898 {
899 struct rev_info rev;
900 const struct commit *commit;
901 int save_warning;
902 struct setup_revision_opt s_r_opt = {
903 .assume_dashdash = 1,
904 };
905
906 save_warning = warn_on_object_refname_ambiguity;
907 warn_on_object_refname_ambiguity = 0;
908 repo_init_revisions(r, &rev, NULL);
909 setup_revisions(argv->nr, argv->v, &rev, &s_r_opt);
910 warn_on_object_refname_ambiguity = save_warning;
911 if (prepare_revision_walk(&rev))
912 die(_("revision walk setup failed"));
913
914 while ((commit = get_revision(&rev))) {
915 struct rev_info diff_rev;
916 struct collect_changed_submodules_cb_data data;
917 data.repo = r;
918 data.changed = changed;
919 data.commit_oid = &commit->object.oid;
920
921 repo_init_revisions(r, &diff_rev, NULL);
922 diff_rev.diffopt.output_format |= DIFF_FORMAT_CALLBACK;
923 diff_rev.diffopt.format_callback = collect_changed_submodules_cb;
924 diff_rev.diffopt.format_callback_data = &data;
925 diff_rev.dense_combined_merges = 1;
926 diff_tree_combined_merge(commit, &diff_rev);
927 release_revisions(&diff_rev);
928 }
929
930 reset_revision_walk();
931 release_revisions(&rev);
932 }
933
934 static void free_submodules_data(struct string_list *submodules)
935 {
936 struct string_list_item *item;
937 for_each_string_list_item(item, submodules)
938 changed_submodule_data_clear(item->util);
939
940 string_list_clear(submodules, 1);
941 }
942
943 static int has_remote(const char *refname, const struct object_id *oid,
944 int flags, void *cb_data)
945 {
946 return 1;
947 }
948
949 static int append_oid_to_argv(const struct object_id *oid, void *data)
950 {
951 struct strvec *argv = data;
952 strvec_push(argv, oid_to_hex(oid));
953 return 0;
954 }
955
956 struct has_commit_data {
957 struct repository *repo;
958 int result;
959 const char *path;
960 const struct object_id *super_oid;
961 };
962
963 static int check_has_commit(const struct object_id *oid, void *data)
964 {
965 struct has_commit_data *cb = data;
966 struct repository subrepo;
967 enum object_type type;
968
969 if (repo_submodule_init(&subrepo, cb->repo, cb->path, cb->super_oid)) {
970 cb->result = 0;
971 /* subrepo failed to init, so don't clean it up. */
972 return 0;
973 }
974
975 type = oid_object_info(&subrepo, oid, NULL);
976
977 switch (type) {
978 case OBJ_COMMIT:
979 goto cleanup;
980 case OBJ_BAD:
981 /*
982 * Object is missing or invalid. If invalid, an error message
983 * has already been printed.
984 */
985 cb->result = 0;
986 goto cleanup;
987 default:
988 die(_("submodule entry '%s' (%s) is a %s, not a commit"),
989 cb->path, oid_to_hex(oid), type_name(type));
990 }
991 cleanup:
992 repo_clear(&subrepo);
993 return 0;
994 }
995
996 static int submodule_has_commits(struct repository *r,
997 const char *path,
998 const struct object_id *super_oid,
999 struct oid_array *commits)
1000 {
1001 struct has_commit_data has_commit = {
1002 .repo = r,
1003 .result = 1,
1004 .path = path,
1005 .super_oid = super_oid
1006 };
1007
1008 oid_array_for_each_unique(commits, check_has_commit, &has_commit);
1009
1010 if (has_commit.result) {
1011 /*
1012 * Even if the submodule is checked out and the commit is
1013 * present, make sure it exists in the submodule's object store
1014 * and that it is reachable from a ref.
1015 */
1016 struct child_process cp = CHILD_PROCESS_INIT;
1017 struct strbuf out = STRBUF_INIT;
1018
1019 strvec_pushl(&cp.args, "rev-list", "-n", "1", NULL);
1020 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
1021 strvec_pushl(&cp.args, "--not", "--all", NULL);
1022
1023 prepare_submodule_repo_env(&cp.env);
1024 cp.git_cmd = 1;
1025 cp.no_stdin = 1;
1026 cp.dir = path;
1027
1028 if (capture_command(&cp, &out, GIT_MAX_HEXSZ + 1) || out.len)
1029 has_commit.result = 0;
1030
1031 strbuf_release(&out);
1032 }
1033
1034 return has_commit.result;
1035 }
1036
1037 static int submodule_needs_pushing(struct repository *r,
1038 const char *path,
1039 struct oid_array *commits)
1040 {
1041 if (!submodule_has_commits(r, path, null_oid(), commits))
1042 /*
1043 * NOTE: We do consider it safe to return "no" here. The
1044 * correct answer would be "We do not know" instead of
1045 * "No push needed", but it is quite hard to change
1046 * the submodule pointer without having the submodule
1047 * around. If a user did however change the submodules
1048 * without having the submodule around, this indicates
1049 * an expert who knows what they are doing or a
1050 * maintainer integrating work from other people. In
1051 * both cases it should be safe to skip this check.
1052 */
1053 return 0;
1054
1055 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
1056 struct child_process cp = CHILD_PROCESS_INIT;
1057 struct strbuf buf = STRBUF_INIT;
1058 int needs_pushing = 0;
1059
1060 strvec_push(&cp.args, "rev-list");
1061 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
1062 strvec_pushl(&cp.args, "--not", "--remotes", "-n", "1" , NULL);
1063
1064 prepare_submodule_repo_env(&cp.env);
1065 cp.git_cmd = 1;
1066 cp.no_stdin = 1;
1067 cp.out = -1;
1068 cp.dir = path;
1069 if (start_command(&cp))
1070 die(_("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s"),
1071 path);
1072 if (strbuf_read(&buf, cp.out, the_hash_algo->hexsz + 1))
1073 needs_pushing = 1;
1074 finish_command(&cp);
1075 close(cp.out);
1076 strbuf_release(&buf);
1077 return needs_pushing;
1078 }
1079
1080 return 0;
1081 }
1082
1083 int find_unpushed_submodules(struct repository *r,
1084 struct oid_array *commits,
1085 const char *remotes_name,
1086 struct string_list *needs_pushing)
1087 {
1088 struct string_list submodules = STRING_LIST_INIT_DUP;
1089 struct string_list_item *name;
1090 struct strvec argv = STRVEC_INIT;
1091
1092 /* argv.v[0] will be ignored by setup_revisions */
1093 strvec_push(&argv, "find_unpushed_submodules");
1094 oid_array_for_each_unique(commits, append_oid_to_argv, &argv);
1095 strvec_push(&argv, "--not");
1096 strvec_pushf(&argv, "--remotes=%s", remotes_name);
1097
1098 collect_changed_submodules(r, &submodules, &argv);
1099
1100 for_each_string_list_item(name, &submodules) {
1101 struct changed_submodule_data *cs_data = name->util;
1102 const struct submodule *submodule;
1103 const char *path = NULL;
1104
1105 submodule = submodule_from_name(r, null_oid(), name->string);
1106 if (submodule)
1107 path = submodule->path;
1108 else
1109 path = default_name_or_path(name->string);
1110
1111 if (!path)
1112 continue;
1113
1114 if (submodule_needs_pushing(r, path, &cs_data->new_commits))
1115 string_list_insert(needs_pushing, path);
1116 }
1117
1118 free_submodules_data(&submodules);
1119 strvec_clear(&argv);
1120
1121 return needs_pushing->nr;
1122 }
1123
1124 static int push_submodule(const char *path,
1125 const struct remote *remote,
1126 const struct refspec *rs,
1127 const struct string_list *push_options,
1128 int dry_run)
1129 {
1130 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
1131 struct child_process cp = CHILD_PROCESS_INIT;
1132 strvec_push(&cp.args, "push");
1133 if (dry_run)
1134 strvec_push(&cp.args, "--dry-run");
1135
1136 if (push_options && push_options->nr) {
1137 const struct string_list_item *item;
1138 for_each_string_list_item(item, push_options)
1139 strvec_pushf(&cp.args, "--push-option=%s",
1140 item->string);
1141 }
1142
1143 if (remote->origin != REMOTE_UNCONFIGURED) {
1144 int i;
1145 strvec_push(&cp.args, remote->name);
1146 for (i = 0; i < rs->raw_nr; i++)
1147 strvec_push(&cp.args, rs->raw[i]);
1148 }
1149
1150 prepare_submodule_repo_env(&cp.env);
1151 cp.git_cmd = 1;
1152 cp.no_stdin = 1;
1153 cp.dir = path;
1154 if (run_command(&cp))
1155 return 0;
1156 close(cp.out);
1157 }
1158
1159 return 1;
1160 }
1161
1162 /*
1163 * Perform a check in the submodule to see if the remote and refspec work.
1164 * Die if the submodule can't be pushed.
1165 */
1166 static void submodule_push_check(const char *path, const char *head,
1167 const struct remote *remote,
1168 const struct refspec *rs)
1169 {
1170 struct child_process cp = CHILD_PROCESS_INIT;
1171 int i;
1172
1173 strvec_push(&cp.args, "submodule--helper");
1174 strvec_push(&cp.args, "push-check");
1175 strvec_push(&cp.args, head);
1176 strvec_push(&cp.args, remote->name);
1177
1178 for (i = 0; i < rs->raw_nr; i++)
1179 strvec_push(&cp.args, rs->raw[i]);
1180
1181 prepare_submodule_repo_env(&cp.env);
1182 cp.git_cmd = 1;
1183 cp.no_stdin = 1;
1184 cp.no_stdout = 1;
1185 cp.dir = path;
1186
1187 /*
1188 * Simply indicate if 'submodule--helper push-check' failed.
1189 * More detailed error information will be provided by the
1190 * child process.
1191 */
1192 if (run_command(&cp))
1193 die(_("process for submodule '%s' failed"), path);
1194 }
1195
1196 int push_unpushed_submodules(struct repository *r,
1197 struct oid_array *commits,
1198 const struct remote *remote,
1199 const struct refspec *rs,
1200 const struct string_list *push_options,
1201 int dry_run)
1202 {
1203 int i, ret = 1;
1204 struct string_list needs_pushing = STRING_LIST_INIT_DUP;
1205
1206 if (!find_unpushed_submodules(r, commits,
1207 remote->name, &needs_pushing))
1208 return 1;
1209
1210 /*
1211 * Verify that the remote and refspec can be propagated to all
1212 * submodules. This check can be skipped if the remote and refspec
1213 * won't be propagated due to the remote being unconfigured (e.g. a URL
1214 * instead of a remote name).
1215 */
1216 if (remote->origin != REMOTE_UNCONFIGURED) {
1217 char *head;
1218 struct object_id head_oid;
1219
1220 head = resolve_refdup("HEAD", 0, &head_oid, NULL);
1221 if (!head)
1222 die(_("Failed to resolve HEAD as a valid ref."));
1223
1224 for (i = 0; i < needs_pushing.nr; i++)
1225 submodule_push_check(needs_pushing.items[i].string,
1226 head, remote, rs);
1227 free(head);
1228 }
1229
1230 /* Actually push the submodules */
1231 for (i = 0; i < needs_pushing.nr; i++) {
1232 const char *path = needs_pushing.items[i].string;
1233 fprintf(stderr, _("Pushing submodule '%s'\n"), path);
1234 if (!push_submodule(path, remote, rs,
1235 push_options, dry_run)) {
1236 fprintf(stderr, _("Unable to push submodule '%s'\n"), path);
1237 ret = 0;
1238 }
1239 }
1240
1241 string_list_clear(&needs_pushing, 0);
1242
1243 return ret;
1244 }
1245
1246 static int append_oid_to_array(const char *ref, const struct object_id *oid,
1247 int flags, void *data)
1248 {
1249 struct oid_array *array = data;
1250 oid_array_append(array, oid);
1251 return 0;
1252 }
1253
1254 void check_for_new_submodule_commits(struct object_id *oid)
1255 {
1256 if (!initialized_fetch_ref_tips) {
1257 for_each_ref(append_oid_to_array, &ref_tips_before_fetch);
1258 initialized_fetch_ref_tips = 1;
1259 }
1260
1261 oid_array_append(&ref_tips_after_fetch, oid);
1262 }
1263
1264 /*
1265 * Returns 1 if there is at least one submodule gitdir in
1266 * $GIT_DIR/modules and 0 otherwise. This follows
1267 * submodule_name_to_gitdir(), which looks for submodules in
1268 * $GIT_DIR/modules, not $GIT_COMMON_DIR.
1269 *
1270 * A submodule can be moved to $GIT_DIR/modules manually by running "git
1271 * submodule absorbgitdirs", or it may be initialized there by "git
1272 * submodule update".
1273 */
1274 static int repo_has_absorbed_submodules(struct repository *r)
1275 {
1276 int ret;
1277 struct strbuf buf = STRBUF_INIT;
1278
1279 strbuf_repo_git_path(&buf, r, "modules/");
1280 ret = file_exists(buf.buf) && !is_empty_dir(buf.buf);
1281 strbuf_release(&buf);
1282 return ret;
1283 }
1284
1285 static void calculate_changed_submodule_paths(struct repository *r,
1286 struct string_list *changed_submodule_names)
1287 {
1288 struct strvec argv = STRVEC_INIT;
1289 struct string_list_item *name;
1290
1291 /* No need to check if no submodules would be fetched */
1292 if (!submodule_from_path(r, NULL, NULL) &&
1293 !repo_has_absorbed_submodules(r))
1294 return;
1295
1296 strvec_push(&argv, "--"); /* argv[0] program name */
1297 oid_array_for_each_unique(&ref_tips_after_fetch,
1298 append_oid_to_argv, &argv);
1299 strvec_push(&argv, "--not");
1300 oid_array_for_each_unique(&ref_tips_before_fetch,
1301 append_oid_to_argv, &argv);
1302
1303 /*
1304 * Collect all submodules (whether checked out or not) for which new
1305 * commits have been recorded upstream in "changed_submodule_names".
1306 */
1307 collect_changed_submodules(r, changed_submodule_names, &argv);
1308
1309 for_each_string_list_item(name, changed_submodule_names) {
1310 struct changed_submodule_data *cs_data = name->util;
1311 const struct submodule *submodule;
1312 const char *path = NULL;
1313
1314 submodule = submodule_from_name(r, null_oid(), name->string);
1315 if (submodule)
1316 path = submodule->path;
1317 else
1318 path = default_name_or_path(name->string);
1319
1320 if (!path)
1321 continue;
1322
1323 if (submodule_has_commits(r, path, null_oid(), &cs_data->new_commits)) {
1324 changed_submodule_data_clear(cs_data);
1325 *name->string = '\0';
1326 }
1327 }
1328
1329 string_list_remove_empty_items(changed_submodule_names, 1);
1330
1331 strvec_clear(&argv);
1332 oid_array_clear(&ref_tips_before_fetch);
1333 oid_array_clear(&ref_tips_after_fetch);
1334 initialized_fetch_ref_tips = 0;
1335 }
1336
1337 int submodule_touches_in_range(struct repository *r,
1338 struct object_id *excl_oid,
1339 struct object_id *incl_oid)
1340 {
1341 struct string_list subs = STRING_LIST_INIT_DUP;
1342 struct strvec args = STRVEC_INIT;
1343 int ret;
1344
1345 /* No need to check if there are no submodules configured */
1346 if (!submodule_from_path(r, NULL, NULL))
1347 return 0;
1348
1349 strvec_push(&args, "--"); /* args[0] program name */
1350 strvec_push(&args, oid_to_hex(incl_oid));
1351 if (!is_null_oid(excl_oid)) {
1352 strvec_push(&args, "--not");
1353 strvec_push(&args, oid_to_hex(excl_oid));
1354 }
1355
1356 collect_changed_submodules(r, &subs, &args);
1357 ret = subs.nr;
1358
1359 strvec_clear(&args);
1360
1361 free_submodules_data(&subs);
1362 return ret;
1363 }
1364
1365 struct submodule_parallel_fetch {
1366 /*
1367 * The index of the last index entry processed by
1368 * get_fetch_task_from_index().
1369 */
1370 int index_count;
1371 /*
1372 * The index of the last string_list entry processed by
1373 * get_fetch_task_from_changed().
1374 */
1375 int changed_count;
1376 struct strvec args;
1377 struct repository *r;
1378 const char *prefix;
1379 int command_line_option;
1380 int default_option;
1381 int quiet;
1382 int result;
1383
1384 /*
1385 * Names of submodules that have new commits. Generated by
1386 * walking the newly fetched superproject commits.
1387 */
1388 struct string_list changed_submodule_names;
1389 /*
1390 * Names of submodules that have already been processed. Lets us
1391 * avoid fetching the same submodule more than once.
1392 */
1393 struct string_list seen_submodule_names;
1394
1395 /* Pending fetches by OIDs */
1396 struct fetch_task **oid_fetch_tasks;
1397 int oid_fetch_tasks_nr, oid_fetch_tasks_alloc;
1398
1399 struct strbuf submodules_with_errors;
1400 };
1401 #define SPF_INIT { \
1402 .args = STRVEC_INIT, \
1403 .changed_submodule_names = STRING_LIST_INIT_DUP, \
1404 .seen_submodule_names = STRING_LIST_INIT_DUP, \
1405 .submodules_with_errors = STRBUF_INIT, \
1406 }
1407
1408 static int get_fetch_recurse_config(const struct submodule *submodule,
1409 struct submodule_parallel_fetch *spf)
1410 {
1411 if (spf->command_line_option != RECURSE_SUBMODULES_DEFAULT)
1412 return spf->command_line_option;
1413
1414 if (submodule) {
1415 char *key;
1416 const char *value;
1417
1418 int fetch_recurse = submodule->fetch_recurse;
1419 key = xstrfmt("submodule.%s.fetchRecurseSubmodules", submodule->name);
1420 if (!repo_config_get_string_tmp(spf->r, key, &value)) {
1421 fetch_recurse = parse_fetch_recurse_submodules_arg(key, value);
1422 }
1423 free(key);
1424
1425 if (fetch_recurse != RECURSE_SUBMODULES_NONE)
1426 /* local config overrules everything except commandline */
1427 return fetch_recurse;
1428 }
1429
1430 return spf->default_option;
1431 }
1432
1433 /*
1434 * Fetch in progress (if callback data) or
1435 * pending (if in oid_fetch_tasks in struct submodule_parallel_fetch)
1436 */
1437 struct fetch_task {
1438 struct repository *repo;
1439 const struct submodule *sub;
1440 unsigned free_sub : 1; /* Do we need to free the submodule? */
1441 const char *default_argv; /* The default fetch mode. */
1442 struct strvec git_args; /* Args for the child git process. */
1443
1444 struct oid_array *commits; /* Ensure these commits are fetched */
1445 };
1446
1447 /**
1448 * When a submodule is not defined in .gitmodules, we cannot access it
1449 * via the regular submodule-config. Create a fake submodule, which we can
1450 * work on.
1451 */
1452 static const struct submodule *get_non_gitmodules_submodule(const char *path)
1453 {
1454 struct submodule *ret = NULL;
1455 const char *name = default_name_or_path(path);
1456
1457 if (!name)
1458 return NULL;
1459
1460 ret = xmalloc(sizeof(*ret));
1461 memset(ret, 0, sizeof(*ret));
1462 ret->path = name;
1463 ret->name = name;
1464
1465 return (const struct submodule *) ret;
1466 }
1467
1468 static void fetch_task_release(struct fetch_task *p)
1469 {
1470 if (p->free_sub)
1471 free((void*)p->sub);
1472 p->free_sub = 0;
1473 p->sub = NULL;
1474
1475 if (p->repo)
1476 repo_clear(p->repo);
1477 FREE_AND_NULL(p->repo);
1478
1479 strvec_clear(&p->git_args);
1480 }
1481
1482 static struct repository *get_submodule_repo_for(struct repository *r,
1483 const char *path,
1484 const struct object_id *treeish_name)
1485 {
1486 struct repository *ret = xmalloc(sizeof(*ret));
1487
1488 if (repo_submodule_init(ret, r, path, treeish_name)) {
1489 free(ret);
1490 return NULL;
1491 }
1492
1493 return ret;
1494 }
1495
1496 static struct fetch_task *fetch_task_create(struct submodule_parallel_fetch *spf,
1497 const char *path,
1498 const struct object_id *treeish_name)
1499 {
1500 struct fetch_task *task = xmalloc(sizeof(*task));
1501 memset(task, 0, sizeof(*task));
1502
1503 task->sub = submodule_from_path(spf->r, treeish_name, path);
1504
1505 if (!task->sub) {
1506 /*
1507 * No entry in .gitmodules? Technically not a submodule,
1508 * but historically we supported repositories that happen to be
1509 * in-place where a gitlink is. Keep supporting them.
1510 */
1511 task->sub = get_non_gitmodules_submodule(path);
1512 if (!task->sub)
1513 goto cleanup;
1514
1515 task->free_sub = 1;
1516 }
1517
1518 if (string_list_lookup(&spf->seen_submodule_names, task->sub->name))
1519 goto cleanup;
1520
1521 switch (get_fetch_recurse_config(task->sub, spf))
1522 {
1523 default:
1524 case RECURSE_SUBMODULES_DEFAULT:
1525 case RECURSE_SUBMODULES_ON_DEMAND:
1526 if (!task->sub ||
1527 !string_list_lookup(
1528 &spf->changed_submodule_names,
1529 task->sub->name))
1530 goto cleanup;
1531 task->default_argv = "on-demand";
1532 break;
1533 case RECURSE_SUBMODULES_ON:
1534 task->default_argv = "yes";
1535 break;
1536 case RECURSE_SUBMODULES_OFF:
1537 goto cleanup;
1538 }
1539
1540 task->repo = get_submodule_repo_for(spf->r, path, treeish_name);
1541
1542 return task;
1543
1544 cleanup:
1545 fetch_task_release(task);
1546 free(task);
1547 return NULL;
1548 }
1549
1550 static struct fetch_task *
1551 get_fetch_task_from_index(struct submodule_parallel_fetch *spf,
1552 struct strbuf *err)
1553 {
1554 for (; spf->index_count < spf->r->index->cache_nr; spf->index_count++) {
1555 const struct cache_entry *ce =
1556 spf->r->index->cache[spf->index_count];
1557 struct fetch_task *task;
1558
1559 if (!S_ISGITLINK(ce->ce_mode))
1560 continue;
1561
1562 task = fetch_task_create(spf, ce->name, null_oid());
1563 if (!task)
1564 continue;
1565
1566 if (task->repo) {
1567 if (!spf->quiet)
1568 strbuf_addf(err, _("Fetching submodule %s%s\n"),
1569 spf->prefix, ce->name);
1570
1571 spf->index_count++;
1572 return task;
1573 } else {
1574 struct strbuf empty_submodule_path = STRBUF_INIT;
1575
1576 fetch_task_release(task);
1577 free(task);
1578
1579 /*
1580 * An empty directory is normal,
1581 * the submodule is not initialized
1582 */
1583 strbuf_addf(&empty_submodule_path, "%s/%s/",
1584 spf->r->worktree,
1585 ce->name);
1586 if (S_ISGITLINK(ce->ce_mode) &&
1587 !is_empty_dir(empty_submodule_path.buf)) {
1588 spf->result = 1;
1589 strbuf_addf(err,
1590 _("Could not access submodule '%s'\n"),
1591 ce->name);
1592 }
1593 strbuf_release(&empty_submodule_path);
1594 }
1595 }
1596 return NULL;
1597 }
1598
1599 static struct fetch_task *
1600 get_fetch_task_from_changed(struct submodule_parallel_fetch *spf,
1601 struct strbuf *err)
1602 {
1603 for (; spf->changed_count < spf->changed_submodule_names.nr;
1604 spf->changed_count++) {
1605 struct string_list_item item =
1606 spf->changed_submodule_names.items[spf->changed_count];
1607 struct changed_submodule_data *cs_data = item.util;
1608 struct fetch_task *task;
1609
1610 if (!is_tree_submodule_active(spf->r, cs_data->super_oid,cs_data->path))
1611 continue;
1612
1613 task = fetch_task_create(spf, cs_data->path,
1614 cs_data->super_oid);
1615 if (!task)
1616 continue;
1617
1618 if (!task->repo) {
1619 strbuf_addf(err, _("Could not access submodule '%s' at commit %s\n"),
1620 cs_data->path,
1621 find_unique_abbrev(cs_data->super_oid, DEFAULT_ABBREV));
1622
1623 fetch_task_release(task);
1624 free(task);
1625 continue;
1626 }
1627
1628 if (!spf->quiet)
1629 strbuf_addf(err,
1630 _("Fetching submodule %s%s at commit %s\n"),
1631 spf->prefix, task->sub->path,
1632 find_unique_abbrev(cs_data->super_oid,
1633 DEFAULT_ABBREV));
1634
1635 spf->changed_count++;
1636 /*
1637 * NEEDSWORK: Submodules set/unset a value for
1638 * core.worktree when they are populated/unpopulated by
1639 * "git checkout" (and similar commands, see
1640 * submodule_move_head() and
1641 * connect_work_tree_and_git_dir()), but if the
1642 * submodule is unpopulated in another way (e.g. "git
1643 * rm", "rm -r"), core.worktree will still be set even
1644 * though the directory doesn't exist, and the child
1645 * process will crash while trying to chdir into the
1646 * nonexistent directory.
1647 *
1648 * In this case, we know that the submodule has no
1649 * working tree, so we can work around this by
1650 * setting "--work-tree=." (--bare does not work because
1651 * worktree settings take precedence over bare-ness).
1652 * However, this is not necessarily true in other cases,
1653 * so a generalized solution is still necessary.
1654 *
1655 * Possible solutions:
1656 * - teach "git [add|rm]" to unset core.worktree and
1657 * discourage users from removing submodules without
1658 * using a Git command.
1659 * - teach submodule child processes to ignore stale
1660 * core.worktree values.
1661 */
1662 strvec_push(&task->git_args, "--work-tree=.");
1663 return task;
1664 }
1665 return NULL;
1666 }
1667
1668 static int get_next_submodule(struct child_process *cp, struct strbuf *err,
1669 void *data, void **task_cb)
1670 {
1671 struct submodule_parallel_fetch *spf = data;
1672 struct fetch_task *task =
1673 get_fetch_task_from_index(spf, err);
1674 if (!task)
1675 task = get_fetch_task_from_changed(spf, err);
1676
1677 if (task) {
1678 struct strbuf submodule_prefix = STRBUF_INIT;
1679
1680 child_process_init(cp);
1681 cp->dir = task->repo->gitdir;
1682 prepare_submodule_repo_env_in_gitdir(&cp->env);
1683 cp->git_cmd = 1;
1684 strvec_init(&cp->args);
1685 if (task->git_args.nr)
1686 strvec_pushv(&cp->args, task->git_args.v);
1687 strvec_pushv(&cp->args, spf->args.v);
1688 strvec_push(&cp->args, task->default_argv);
1689 strvec_push(&cp->args, "--submodule-prefix");
1690
1691 strbuf_addf(&submodule_prefix, "%s%s/",
1692 spf->prefix,
1693 task->sub->path);
1694 strvec_push(&cp->args, submodule_prefix.buf);
1695 *task_cb = task;
1696
1697 strbuf_release(&submodule_prefix);
1698 string_list_insert(&spf->seen_submodule_names, task->sub->name);
1699 return 1;
1700 }
1701
1702 if (spf->oid_fetch_tasks_nr) {
1703 struct fetch_task *task =
1704 spf->oid_fetch_tasks[spf->oid_fetch_tasks_nr - 1];
1705 struct strbuf submodule_prefix = STRBUF_INIT;
1706 spf->oid_fetch_tasks_nr--;
1707
1708 strbuf_addf(&submodule_prefix, "%s%s/",
1709 spf->prefix, task->sub->path);
1710
1711 child_process_init(cp);
1712 prepare_submodule_repo_env_in_gitdir(&cp->env);
1713 cp->git_cmd = 1;
1714 cp->dir = task->repo->gitdir;
1715
1716 strvec_init(&cp->args);
1717 strvec_pushv(&cp->args, spf->args.v);
1718 strvec_push(&cp->args, "on-demand");
1719 strvec_push(&cp->args, "--submodule-prefix");
1720 strvec_push(&cp->args, submodule_prefix.buf);
1721
1722 /* NEEDSWORK: have get_default_remote from submodule--helper */
1723 strvec_push(&cp->args, "origin");
1724 oid_array_for_each_unique(task->commits,
1725 append_oid_to_argv, &cp->args);
1726
1727 *task_cb = task;
1728 strbuf_release(&submodule_prefix);
1729 return 1;
1730 }
1731
1732 return 0;
1733 }
1734
1735 static int fetch_start_failure(struct strbuf *err,
1736 void *cb, void *task_cb)
1737 {
1738 struct submodule_parallel_fetch *spf = cb;
1739 struct fetch_task *task = task_cb;
1740
1741 spf->result = 1;
1742
1743 fetch_task_release(task);
1744 return 0;
1745 }
1746
1747 static int commit_missing_in_sub(const struct object_id *oid, void *data)
1748 {
1749 struct repository *subrepo = data;
1750
1751 enum object_type type = oid_object_info(subrepo, oid, NULL);
1752
1753 return type != OBJ_COMMIT;
1754 }
1755
1756 static int fetch_finish(int retvalue, struct strbuf *err,
1757 void *cb, void *task_cb)
1758 {
1759 struct submodule_parallel_fetch *spf = cb;
1760 struct fetch_task *task = task_cb;
1761
1762 struct string_list_item *it;
1763 struct changed_submodule_data *cs_data;
1764
1765 if (!task || !task->sub)
1766 BUG("callback cookie bogus");
1767
1768 if (retvalue) {
1769 /*
1770 * NEEDSWORK: This indicates that the overall fetch
1771 * failed, even though there may be a subsequent fetch
1772 * by commit hash that might work. It may be a good
1773 * idea to not indicate failure in this case, and only
1774 * indicate failure if the subsequent fetch fails.
1775 */
1776 spf->result = 1;
1777
1778 strbuf_addf(&spf->submodules_with_errors, "\t%s\n",
1779 task->sub->name);
1780 }
1781
1782 /* Is this the second time we process this submodule? */
1783 if (task->commits)
1784 goto out;
1785
1786 it = string_list_lookup(&spf->changed_submodule_names, task->sub->name);
1787 if (!it)
1788 /* Could be an unchanged submodule, not contained in the list */
1789 goto out;
1790
1791 cs_data = it->util;
1792 oid_array_filter(&cs_data->new_commits,
1793 commit_missing_in_sub,
1794 task->repo);
1795
1796 /* Are there commits we want, but do not exist? */
1797 if (cs_data->new_commits.nr) {
1798 task->commits = &cs_data->new_commits;
1799 ALLOC_GROW(spf->oid_fetch_tasks,
1800 spf->oid_fetch_tasks_nr + 1,
1801 spf->oid_fetch_tasks_alloc);
1802 spf->oid_fetch_tasks[spf->oid_fetch_tasks_nr] = task;
1803 spf->oid_fetch_tasks_nr++;
1804 return 0;
1805 }
1806
1807 out:
1808 fetch_task_release(task);
1809
1810 return 0;
1811 }
1812
1813 int fetch_submodules(struct repository *r,
1814 const struct strvec *options,
1815 const char *prefix, int command_line_option,
1816 int default_option,
1817 int quiet, int max_parallel_jobs)
1818 {
1819 int i;
1820 struct submodule_parallel_fetch spf = SPF_INIT;
1821
1822 spf.r = r;
1823 spf.command_line_option = command_line_option;
1824 spf.default_option = default_option;
1825 spf.quiet = quiet;
1826 spf.prefix = prefix;
1827
1828 if (!r->worktree)
1829 goto out;
1830
1831 if (repo_read_index(r) < 0)
1832 die(_("index file corrupt"));
1833
1834 strvec_push(&spf.args, "fetch");
1835 for (i = 0; i < options->nr; i++)
1836 strvec_push(&spf.args, options->v[i]);
1837 strvec_push(&spf.args, "--recurse-submodules-default");
1838 /* default value, "--submodule-prefix" and its value are added later */
1839
1840 calculate_changed_submodule_paths(r, &spf.changed_submodule_names);
1841 string_list_sort(&spf.changed_submodule_names);
1842 run_processes_parallel_tr2(max_parallel_jobs,
1843 get_next_submodule,
1844 fetch_start_failure,
1845 fetch_finish,
1846 &spf,
1847 "submodule", "parallel/fetch");
1848
1849 if (spf.submodules_with_errors.len > 0)
1850 fprintf(stderr, _("Errors during submodule fetch:\n%s"),
1851 spf.submodules_with_errors.buf);
1852
1853
1854 strvec_clear(&spf.args);
1855 out:
1856 free_submodules_data(&spf.changed_submodule_names);
1857 return spf.result;
1858 }
1859
1860 unsigned is_submodule_modified(const char *path, int ignore_untracked)
1861 {
1862 struct child_process cp = CHILD_PROCESS_INIT;
1863 struct strbuf buf = STRBUF_INIT;
1864 FILE *fp;
1865 unsigned dirty_submodule = 0;
1866 const char *git_dir;
1867 int ignore_cp_exit_code = 0;
1868
1869 strbuf_addf(&buf, "%s/.git", path);
1870 git_dir = read_gitfile(buf.buf);
1871 if (!git_dir)
1872 git_dir = buf.buf;
1873 if (!is_git_directory(git_dir)) {
1874 if (is_directory(git_dir))
1875 die(_("'%s' not recognized as a git repository"), git_dir);
1876 strbuf_release(&buf);
1877 /* The submodule is not checked out, so it is not modified */
1878 return 0;
1879 }
1880 strbuf_reset(&buf);
1881
1882 strvec_pushl(&cp.args, "status", "--porcelain=2", NULL);
1883 if (ignore_untracked)
1884 strvec_push(&cp.args, "-uno");
1885
1886 prepare_submodule_repo_env(&cp.env);
1887 cp.git_cmd = 1;
1888 cp.no_stdin = 1;
1889 cp.out = -1;
1890 cp.dir = path;
1891 if (start_command(&cp))
1892 die(_("Could not run 'git status --porcelain=2' in submodule %s"), path);
1893
1894 fp = xfdopen(cp.out, "r");
1895 while (strbuf_getwholeline(&buf, fp, '\n') != EOF) {
1896 /* regular untracked files */
1897 if (buf.buf[0] == '?')
1898 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1899
1900 if (buf.buf[0] == 'u' ||
1901 buf.buf[0] == '1' ||
1902 buf.buf[0] == '2') {
1903 /* T = line type, XY = status, SSSS = submodule state */
1904 if (buf.len < strlen("T XY SSSS"))
1905 BUG("invalid status --porcelain=2 line %s",
1906 buf.buf);
1907
1908 if (buf.buf[5] == 'S' && buf.buf[8] == 'U')
1909 /* nested untracked file */
1910 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1911
1912 if (buf.buf[0] == 'u' ||
1913 buf.buf[0] == '2' ||
1914 memcmp(buf.buf + 5, "S..U", 4))
1915 /* other change */
1916 dirty_submodule |= DIRTY_SUBMODULE_MODIFIED;
1917 }
1918
1919 if ((dirty_submodule & DIRTY_SUBMODULE_MODIFIED) &&
1920 ((dirty_submodule & DIRTY_SUBMODULE_UNTRACKED) ||
1921 ignore_untracked)) {
1922 /*
1923 * We're not interested in any further information from
1924 * the child any more, neither output nor its exit code.
1925 */
1926 ignore_cp_exit_code = 1;
1927 break;
1928 }
1929 }
1930 fclose(fp);
1931
1932 if (finish_command(&cp) && !ignore_cp_exit_code)
1933 die(_("'git status --porcelain=2' failed in submodule %s"), path);
1934
1935 strbuf_release(&buf);
1936 return dirty_submodule;
1937 }
1938
1939 int submodule_uses_gitfile(const char *path)
1940 {
1941 struct child_process cp = CHILD_PROCESS_INIT;
1942 struct strbuf buf = STRBUF_INIT;
1943 const char *git_dir;
1944
1945 strbuf_addf(&buf, "%s/.git", path);
1946 git_dir = read_gitfile(buf.buf);
1947 if (!git_dir) {
1948 strbuf_release(&buf);
1949 return 0;
1950 }
1951 strbuf_release(&buf);
1952
1953 /* Now test that all nested submodules use a gitfile too */
1954 strvec_pushl(&cp.args,
1955 "submodule", "foreach", "--quiet", "--recursive",
1956 "test -f .git", NULL);
1957
1958 prepare_submodule_repo_env(&cp.env);
1959 cp.git_cmd = 1;
1960 cp.no_stdin = 1;
1961 cp.no_stderr = 1;
1962 cp.no_stdout = 1;
1963 cp.dir = path;
1964 if (run_command(&cp))
1965 return 0;
1966
1967 return 1;
1968 }
1969
1970 /*
1971 * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
1972 * when doing so.
1973 *
1974 * Return 1 if we'd lose data, return 0 if the removal is fine,
1975 * and negative values for errors.
1976 */
1977 int bad_to_remove_submodule(const char *path, unsigned flags)
1978 {
1979 ssize_t len;
1980 struct child_process cp = CHILD_PROCESS_INIT;
1981 struct strbuf buf = STRBUF_INIT;
1982 int ret = 0;
1983
1984 if (!file_exists(path) || is_empty_dir(path))
1985 return 0;
1986
1987 if (!submodule_uses_gitfile(path))
1988 return 1;
1989
1990 strvec_pushl(&cp.args, "status", "--porcelain",
1991 "--ignore-submodules=none", NULL);
1992
1993 if (flags & SUBMODULE_REMOVAL_IGNORE_UNTRACKED)
1994 strvec_push(&cp.args, "-uno");
1995 else
1996 strvec_push(&cp.args, "-uall");
1997
1998 if (!(flags & SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED))
1999 strvec_push(&cp.args, "--ignored");
2000
2001 prepare_submodule_repo_env(&cp.env);
2002 cp.git_cmd = 1;
2003 cp.no_stdin = 1;
2004 cp.out = -1;
2005 cp.dir = path;
2006 if (start_command(&cp)) {
2007 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
2008 die(_("could not start 'git status' in submodule '%s'"),
2009 path);
2010 ret = -1;
2011 goto out;
2012 }
2013
2014 len = strbuf_read(&buf, cp.out, 1024);
2015 if (len > 2)
2016 ret = 1;
2017 close(cp.out);
2018
2019 if (finish_command(&cp)) {
2020 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
2021 die(_("could not run 'git status' in submodule '%s'"),
2022 path);
2023 ret = -1;
2024 }
2025 out:
2026 strbuf_release(&buf);
2027 return ret;
2028 }
2029
2030 void submodule_unset_core_worktree(const struct submodule *sub)
2031 {
2032 struct strbuf config_path = STRBUF_INIT;
2033
2034 submodule_name_to_gitdir(&config_path, the_repository, sub->name);
2035 strbuf_addstr(&config_path, "/config");
2036
2037 if (git_config_set_in_file_gently(config_path.buf, "core.worktree", NULL))
2038 warning(_("Could not unset core.worktree setting in submodule '%s'"),
2039 sub->path);
2040
2041 strbuf_release(&config_path);
2042 }
2043
2044 static const char *get_super_prefix_or_empty(void)
2045 {
2046 const char *s = get_super_prefix();
2047 if (!s)
2048 s = "";
2049 return s;
2050 }
2051
2052 static int submodule_has_dirty_index(const struct submodule *sub)
2053 {
2054 struct child_process cp = CHILD_PROCESS_INIT;
2055
2056 prepare_submodule_repo_env(&cp.env);
2057
2058 cp.git_cmd = 1;
2059 strvec_pushl(&cp.args, "diff-index", "--quiet",
2060 "--cached", "HEAD", NULL);
2061 cp.no_stdin = 1;
2062 cp.no_stdout = 1;
2063 cp.dir = sub->path;
2064 if (start_command(&cp))
2065 die(_("could not recurse into submodule '%s'"), sub->path);
2066
2067 return finish_command(&cp);
2068 }
2069
2070 static void submodule_reset_index(const char *path)
2071 {
2072 struct child_process cp = CHILD_PROCESS_INIT;
2073 prepare_submodule_repo_env(&cp.env);
2074
2075 cp.git_cmd = 1;
2076 cp.no_stdin = 1;
2077 cp.dir = path;
2078
2079 strvec_pushf(&cp.args, "--super-prefix=%s%s/",
2080 get_super_prefix_or_empty(), path);
2081 /* TODO: determine if this might overwright untracked files */
2082 strvec_pushl(&cp.args, "read-tree", "-u", "--reset", NULL);
2083
2084 strvec_push(&cp.args, empty_tree_oid_hex());
2085
2086 if (run_command(&cp))
2087 die(_("could not reset submodule index"));
2088 }
2089
2090 /**
2091 * Moves a submodule at a given path from a given head to another new head.
2092 * For edge cases (a submodule coming into existence or removing a submodule)
2093 * pass NULL for old or new respectively.
2094 */
2095 int submodule_move_head(const char *path,
2096 const char *old_head,
2097 const char *new_head,
2098 unsigned flags)
2099 {
2100 int ret = 0;
2101 struct child_process cp = CHILD_PROCESS_INIT;
2102 const struct submodule *sub;
2103 int *error_code_ptr, error_code;
2104
2105 if (!is_submodule_active(the_repository, path))
2106 return 0;
2107
2108 if (flags & SUBMODULE_MOVE_HEAD_FORCE)
2109 /*
2110 * Pass non NULL pointer to is_submodule_populated_gently
2111 * to prevent die()-ing. We'll use connect_work_tree_and_git_dir
2112 * to fixup the submodule in the force case later.
2113 */
2114 error_code_ptr = &error_code;
2115 else
2116 error_code_ptr = NULL;
2117
2118 if (old_head && !is_submodule_populated_gently(path, error_code_ptr))
2119 return 0;
2120
2121 sub = submodule_from_path(the_repository, null_oid(), path);
2122
2123 if (!sub)
2124 BUG("could not get submodule information for '%s'", path);
2125
2126 if (old_head && !(flags & SUBMODULE_MOVE_HEAD_FORCE)) {
2127 /* Check if the submodule has a dirty index. */
2128 if (submodule_has_dirty_index(sub))
2129 return error(_("submodule '%s' has dirty index"), path);
2130 }
2131
2132 if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
2133 if (old_head) {
2134 if (!submodule_uses_gitfile(path))
2135 absorb_git_dir_into_superproject(path,
2136 ABSORB_GITDIR_RECURSE_SUBMODULES);
2137 } else {
2138 struct strbuf gitdir = STRBUF_INIT;
2139 submodule_name_to_gitdir(&gitdir, the_repository,
2140 sub->name);
2141 connect_work_tree_and_git_dir(path, gitdir.buf, 0);
2142 strbuf_release(&gitdir);
2143
2144 /* make sure the index is clean as well */
2145 submodule_reset_index(path);
2146 }
2147
2148 if (old_head && (flags & SUBMODULE_MOVE_HEAD_FORCE)) {
2149 struct strbuf gitdir = STRBUF_INIT;
2150 submodule_name_to_gitdir(&gitdir, the_repository,
2151 sub->name);
2152 connect_work_tree_and_git_dir(path, gitdir.buf, 1);
2153 strbuf_release(&gitdir);
2154 }
2155 }
2156
2157 prepare_submodule_repo_env(&cp.env);
2158
2159 cp.git_cmd = 1;
2160 cp.no_stdin = 1;
2161 cp.dir = path;
2162
2163 strvec_pushf(&cp.args, "--super-prefix=%s%s/",
2164 get_super_prefix_or_empty(), path);
2165 strvec_pushl(&cp.args, "read-tree", "--recurse-submodules", NULL);
2166
2167 if (flags & SUBMODULE_MOVE_HEAD_DRY_RUN)
2168 strvec_push(&cp.args, "-n");
2169 else
2170 strvec_push(&cp.args, "-u");
2171
2172 if (flags & SUBMODULE_MOVE_HEAD_FORCE)
2173 strvec_push(&cp.args, "--reset");
2174 else
2175 strvec_push(&cp.args, "-m");
2176
2177 if (!(flags & SUBMODULE_MOVE_HEAD_FORCE))
2178 strvec_push(&cp.args, old_head ? old_head : empty_tree_oid_hex());
2179
2180 strvec_push(&cp.args, new_head ? new_head : empty_tree_oid_hex());
2181
2182 if (run_command(&cp)) {
2183 ret = error(_("Submodule '%s' could not be updated."), path);
2184 goto out;
2185 }
2186
2187 if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
2188 if (new_head) {
2189 child_process_init(&cp);
2190 /* also set the HEAD accordingly */
2191 cp.git_cmd = 1;
2192 cp.no_stdin = 1;
2193 cp.dir = path;
2194
2195 prepare_submodule_repo_env(&cp.env);
2196 strvec_pushl(&cp.args, "update-ref", "HEAD",
2197 "--no-deref", new_head, NULL);
2198
2199 if (run_command(&cp)) {
2200 ret = -1;
2201 goto out;
2202 }
2203 } else {
2204 struct strbuf sb = STRBUF_INIT;
2205
2206 strbuf_addf(&sb, "%s/.git", path);
2207 unlink_or_warn(sb.buf);
2208 strbuf_release(&sb);
2209
2210 if (is_empty_dir(path))
2211 rmdir_or_warn(path);
2212
2213 submodule_unset_core_worktree(sub);
2214 }
2215 }
2216 out:
2217 return ret;
2218 }
2219
2220 int validate_submodule_git_dir(char *git_dir, const char *submodule_name)
2221 {
2222 size_t len = strlen(git_dir), suffix_len = strlen(submodule_name);
2223 char *p;
2224 int ret = 0;
2225
2226 if (len <= suffix_len || (p = git_dir + len - suffix_len)[-1] != '/' ||
2227 strcmp(p, submodule_name))
2228 BUG("submodule name '%s' not a suffix of git dir '%s'",
2229 submodule_name, git_dir);
2230
2231 /*
2232 * We prevent the contents of sibling submodules' git directories to
2233 * clash.
2234 *
2235 * Example: having a submodule named `hippo` and another one named
2236 * `hippo/hooks` would result in the git directories
2237 * `.git/modules/hippo/` and `.git/modules/hippo/hooks/`, respectively,
2238 * but the latter directory is already designated to contain the hooks
2239 * of the former.
2240 */
2241 for (; *p; p++) {
2242 if (is_dir_sep(*p)) {
2243 char c = *p;
2244
2245 *p = '\0';
2246 if (is_git_directory(git_dir))
2247 ret = -1;
2248 *p = c;
2249
2250 if (ret < 0)
2251 return error(_("submodule git dir '%s' is "
2252 "inside git dir '%.*s'"),
2253 git_dir,
2254 (int)(p - git_dir), git_dir);
2255 }
2256 }
2257
2258 return 0;
2259 }
2260
2261 /*
2262 * Embeds a single submodules git directory into the superprojects git dir,
2263 * non recursively.
2264 */
2265 static void relocate_single_git_dir_into_superproject(const char *path)
2266 {
2267 char *old_git_dir = NULL, *real_old_git_dir = NULL, *real_new_git_dir = NULL;
2268 struct strbuf new_gitdir = STRBUF_INIT;
2269 const struct submodule *sub;
2270
2271 if (submodule_uses_worktrees(path))
2272 die(_("relocate_gitdir for submodule '%s' with "
2273 "more than one worktree not supported"), path);
2274
2275 old_git_dir = xstrfmt("%s/.git", path);
2276 if (read_gitfile(old_git_dir))
2277 /* If it is an actual gitfile, it doesn't need migration. */
2278 return;
2279
2280 real_old_git_dir = real_pathdup(old_git_dir, 1);
2281
2282 sub = submodule_from_path(the_repository, null_oid(), path);
2283 if (!sub)
2284 die(_("could not lookup name for submodule '%s'"), path);
2285
2286 submodule_name_to_gitdir(&new_gitdir, the_repository, sub->name);
2287 if (validate_submodule_git_dir(new_gitdir.buf, sub->name) < 0)
2288 die(_("refusing to move '%s' into an existing git dir"),
2289 real_old_git_dir);
2290 if (safe_create_leading_directories_const(new_gitdir.buf) < 0)
2291 die(_("could not create directory '%s'"), new_gitdir.buf);
2292 real_new_git_dir = real_pathdup(new_gitdir.buf, 1);
2293
2294 fprintf(stderr, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
2295 get_super_prefix_or_empty(), path,
2296 real_old_git_dir, real_new_git_dir);
2297
2298 relocate_gitdir(path, real_old_git_dir, real_new_git_dir);
2299
2300 free(old_git_dir);
2301 free(real_old_git_dir);
2302 free(real_new_git_dir);
2303 strbuf_release(&new_gitdir);
2304 }
2305
2306 /*
2307 * Migrate the git directory of the submodule given by path from
2308 * having its git directory within the working tree to the git dir nested
2309 * in its superprojects git dir under modules/.
2310 */
2311 void absorb_git_dir_into_superproject(const char *path,
2312 unsigned flags)
2313 {
2314 int err_code;
2315 const char *sub_git_dir;
2316 struct strbuf gitdir = STRBUF_INIT;
2317 strbuf_addf(&gitdir, "%s/.git", path);
2318 sub_git_dir = resolve_gitdir_gently(gitdir.buf, &err_code);
2319
2320 /* Not populated? */
2321 if (!sub_git_dir) {
2322 const struct submodule *sub;
2323 struct strbuf sub_gitdir = STRBUF_INIT;
2324
2325 if (err_code == READ_GITFILE_ERR_STAT_FAILED) {
2326 /* unpopulated as expected */
2327 strbuf_release(&gitdir);
2328 return;
2329 }
2330
2331 if (err_code != READ_GITFILE_ERR_NOT_A_REPO)
2332 /* We don't know what broke here. */
2333 read_gitfile_error_die(err_code, path, NULL);
2334
2335 /*
2336 * Maybe populated, but no git directory was found?
2337 * This can happen if the superproject is a submodule
2338 * itself and was just absorbed. The absorption of the
2339 * superproject did not rewrite the git file links yet,
2340 * fix it now.
2341 */
2342 sub = submodule_from_path(the_repository, null_oid(), path);
2343 if (!sub)
2344 die(_("could not lookup name for submodule '%s'"), path);
2345 submodule_name_to_gitdir(&sub_gitdir, the_repository, sub->name);
2346 connect_work_tree_and_git_dir(path, sub_gitdir.buf, 0);
2347 strbuf_release(&sub_gitdir);
2348 } else {
2349 /* Is it already absorbed into the superprojects git dir? */
2350 char *real_sub_git_dir = real_pathdup(sub_git_dir, 1);
2351 char *real_common_git_dir = real_pathdup(get_git_common_dir(), 1);
2352
2353 if (!starts_with(real_sub_git_dir, real_common_git_dir))
2354 relocate_single_git_dir_into_superproject(path);
2355
2356 free(real_sub_git_dir);
2357 free(real_common_git_dir);
2358 }
2359 strbuf_release(&gitdir);
2360
2361 if (flags & ABSORB_GITDIR_RECURSE_SUBMODULES) {
2362 struct child_process cp = CHILD_PROCESS_INIT;
2363 struct strbuf sb = STRBUF_INIT;
2364
2365 if (flags & ~ABSORB_GITDIR_RECURSE_SUBMODULES)
2366 BUG("we don't know how to pass the flags down?");
2367
2368 strbuf_addstr(&sb, get_super_prefix_or_empty());
2369 strbuf_addstr(&sb, path);
2370 strbuf_addch(&sb, '/');
2371
2372 cp.dir = path;
2373 cp.git_cmd = 1;
2374 cp.no_stdin = 1;
2375 strvec_pushl(&cp.args, "--super-prefix", sb.buf,
2376 "submodule--helper",
2377 "absorb-git-dirs", NULL);
2378 prepare_submodule_repo_env(&cp.env);
2379 if (run_command(&cp))
2380 die(_("could not recurse into submodule '%s'"), path);
2381
2382 strbuf_release(&sb);
2383 }
2384 }
2385
2386 int get_superproject_working_tree(struct strbuf *buf)
2387 {
2388 struct child_process cp = CHILD_PROCESS_INIT;
2389 struct strbuf sb = STRBUF_INIT;
2390 struct strbuf one_up = STRBUF_INIT;
2391 const char *cwd = xgetcwd();
2392 int ret = 0;
2393 const char *subpath;
2394 int code;
2395 ssize_t len;
2396
2397 if (!is_inside_work_tree())
2398 /*
2399 * FIXME:
2400 * We might have a superproject, but it is harder
2401 * to determine.
2402 */
2403 return 0;
2404
2405 if (!strbuf_realpath(&one_up, "../", 0))
2406 return 0;
2407
2408 subpath = relative_path(cwd, one_up.buf, &sb);
2409 strbuf_release(&one_up);
2410
2411 prepare_submodule_repo_env(&cp.env);
2412 strvec_pop(&cp.env);
2413
2414 strvec_pushl(&cp.args, "--literal-pathspecs", "-C", "..",
2415 "ls-files", "-z", "--stage", "--full-name", "--",
2416 subpath, NULL);
2417 strbuf_reset(&sb);
2418
2419 cp.no_stdin = 1;
2420 cp.no_stderr = 1;
2421 cp.out = -1;
2422 cp.git_cmd = 1;
2423
2424 if (start_command(&cp))
2425 die(_("could not start ls-files in .."));
2426
2427 len = strbuf_read(&sb, cp.out, PATH_MAX);
2428 close(cp.out);
2429
2430 if (starts_with(sb.buf, "160000")) {
2431 int super_sub_len;
2432 int cwd_len = strlen(cwd);
2433 char *super_sub, *super_wt;
2434
2435 /*
2436 * There is a superproject having this repo as a submodule.
2437 * The format is <mode> SP <hash> SP <stage> TAB <full name> \0,
2438 * We're only interested in the name after the tab.
2439 */
2440 super_sub = strchr(sb.buf, '\t') + 1;
2441 super_sub_len = strlen(super_sub);
2442
2443 if (super_sub_len > cwd_len ||
2444 strcmp(&cwd[cwd_len - super_sub_len], super_sub))
2445 BUG("returned path string doesn't match cwd?");
2446
2447 super_wt = xstrdup(cwd);
2448 super_wt[cwd_len - super_sub_len] = '\0';
2449
2450 strbuf_realpath(buf, super_wt, 1);
2451 ret = 1;
2452 free(super_wt);
2453 }
2454 strbuf_release(&sb);
2455
2456 code = finish_command(&cp);
2457
2458 if (code == 128)
2459 /* '../' is not a git repository */
2460 return 0;
2461 if (code == 0 && len == 0)
2462 /* There is an unrelated git repository at '../' */
2463 return 0;
2464 if (code)
2465 die(_("ls-tree returned unexpected return code %d"), code);
2466
2467 return ret;
2468 }
2469
2470 /*
2471 * Put the gitdir for a submodule (given relative to the main
2472 * repository worktree) into `buf`, or return -1 on error.
2473 */
2474 int submodule_to_gitdir(struct strbuf *buf, const char *submodule)
2475 {
2476 const struct submodule *sub;
2477 const char *git_dir;
2478 int ret = 0;
2479
2480 strbuf_reset(buf);
2481 strbuf_addstr(buf, submodule);
2482 strbuf_complete(buf, '/');
2483 strbuf_addstr(buf, ".git");
2484
2485 git_dir = read_gitfile(buf->buf);
2486 if (git_dir) {
2487 strbuf_reset(buf);
2488 strbuf_addstr(buf, git_dir);
2489 }
2490 if (!is_git_directory(buf->buf)) {
2491 sub = submodule_from_path(the_repository, null_oid(),
2492 submodule);
2493 if (!sub) {
2494 ret = -1;
2495 goto cleanup;
2496 }
2497 strbuf_reset(buf);
2498 submodule_name_to_gitdir(buf, the_repository, sub->name);
2499 }
2500
2501 cleanup:
2502 return ret;
2503 }
2504
2505 void submodule_name_to_gitdir(struct strbuf *buf, struct repository *r,
2506 const char *submodule_name)
2507 {
2508 /*
2509 * NEEDSWORK: The current way of mapping a submodule's name to
2510 * its location in .git/modules/ has problems with some naming
2511 * schemes. For example, if a submodule is named "foo" and
2512 * another is named "foo/bar" (whether present in the same
2513 * superproject commit or not - the problem will arise if both
2514 * superproject commits have been checked out at any point in
2515 * time), or if two submodule names only have different cases in
2516 * a case-insensitive filesystem.
2517 *
2518 * There are several solutions, including encoding the path in
2519 * some way, introducing a submodule.<name>.gitdir config in
2520 * .git/config (not .gitmodules) that allows overriding what the
2521 * gitdir of a submodule would be (and teach Git, upon noticing
2522 * a clash, to automatically determine a non-clashing name and
2523 * to write such a config), or introducing a
2524 * submodule.<name>.gitdir config in .gitmodules that repo
2525 * administrators can explicitly set. Nothing has been decided,
2526 * so for now, just append the name at the end of the path.
2527 */
2528 strbuf_repo_git_path(buf, r, "modules/");
2529 strbuf_addstr(buf, submodule_name);
2530 }