1#define NO_THE_INDEX_COMPATIBILITY_MACROS
2
3#include "cache.h"
4#include "repository.h"
5#include "config.h"
6#include "submodule-config.h"
7#include "submodule.h"
8#include "dir.h"
9#include "diff.h"
10#include "commit.h"
11#include "revision.h"
12#include "run-command.h"
13#include "diffcore.h"
14#include "refs.h"
15#include "string-list.h"
16#include "sha1-array.h"
17#include "argv-array.h"
18#include "blob.h"
19#include "thread-utils.h"
20#include "quote.h"
21#include "remote.h"
22#include "worktree.h"
23#include "parse-options.h"
24#include "object-store.h"
25#include "commit-reach.h"
26
27static int config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
28static struct string_list changed_submodule_names = STRING_LIST_INIT_DUP;
29static int initialized_fetch_ref_tips;
30static struct oid_array ref_tips_before_fetch;
31static struct oid_array ref_tips_after_fetch;
32
33/*
34 * Check if the .gitmodules file is unmerged. Parsing of the .gitmodules file
35 * will be disabled because we can't guess what might be configured in
36 * .gitmodules unless the user resolves the conflict.
37 */
38int is_gitmodules_unmerged(const struct index_state *istate)
39{
40 int pos = index_name_pos(istate, GITMODULES_FILE, strlen(GITMODULES_FILE));
41 if (pos < 0) { /* .gitmodules not found or isn't merged */
42 pos = -1 - pos;
43 if (istate->cache_nr > pos) { /* there is a .gitmodules */
44 const struct cache_entry *ce = istate->cache[pos];
45 if (ce_namelen(ce) == strlen(GITMODULES_FILE) &&
46 !strcmp(ce->name, GITMODULES_FILE))
47 return 1;
48 }
49 }
50
51 return 0;
52}
53
54/*
55 * Check if the .gitmodules file has unstaged modifications. This must be
56 * checked before allowing modifications to the .gitmodules file with the
57 * intention to stage them later, because when continuing we would stage the
58 * modifications the user didn't stage herself too. That might change in a
59 * future version when we learn to stage the changes we do ourselves without
60 * staging any previous modifications.
61 */
62int is_staging_gitmodules_ok(struct index_state *istate)
63{
64 int pos = index_name_pos(istate, GITMODULES_FILE, strlen(GITMODULES_FILE));
65
66 if ((pos >= 0) && (pos < istate->cache_nr)) {
67 struct stat st;
68 if (lstat(GITMODULES_FILE, &st) == 0 &&
69 ie_match_stat(istate, istate->cache[pos], &st, 0) & DATA_CHANGED)
70 return 0;
71 }
72
73 return 1;
74}
75
76static int for_each_remote_ref_submodule(const char *submodule,
77 each_ref_fn fn, void *cb_data)
78{
79 return refs_for_each_remote_ref(get_submodule_ref_store(submodule),
80 fn, cb_data);
81}
82
83/*
84 * Try to update the "path" entry in the "submodule.<name>" section of the
85 * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
86 * with the correct path=<oldpath> setting was found and we could update it.
87 */
88int update_path_in_gitmodules(const char *oldpath, const char *newpath)
89{
90 struct strbuf entry = STRBUF_INIT;
91 const struct submodule *submodule;
92
93 if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
94 return -1;
95
96 if (is_gitmodules_unmerged(the_repository->index))
97 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
98
99 submodule = submodule_from_path(the_repository, &null_oid, oldpath);
100 if (!submodule || !submodule->name) {
101 warning(_("Could not find section in .gitmodules where path=%s"), oldpath);
102 return -1;
103 }
104 strbuf_addstr(&entry, "submodule.");
105 strbuf_addstr(&entry, submodule->name);
106 strbuf_addstr(&entry, ".path");
107 if (git_config_set_in_file_gently(GITMODULES_FILE, entry.buf, newpath) < 0) {
108 /* Maybe the user already did that, don't error out here */
109 warning(_("Could not update .gitmodules entry %s"), entry.buf);
110 strbuf_release(&entry);
111 return -1;
112 }
113 strbuf_release(&entry);
114 return 0;
115}
116
117/*
118 * Try to remove the "submodule.<name>" section from .gitmodules where the given
119 * path is configured. Return 0 only if a .gitmodules file was found, a section
120 * with the correct path=<path> setting was found and we could remove it.
121 */
122int remove_path_from_gitmodules(const char *path)
123{
124 struct strbuf sect = STRBUF_INIT;
125 const struct submodule *submodule;
126
127 if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
128 return -1;
129
130 if (is_gitmodules_unmerged(the_repository->index))
131 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
132
133 submodule = submodule_from_path(the_repository, &null_oid, path);
134 if (!submodule || !submodule->name) {
135 warning(_("Could not find section in .gitmodules where path=%s"), path);
136 return -1;
137 }
138 strbuf_addstr(§, "submodule.");
139 strbuf_addstr(§, submodule->name);
140 if (git_config_rename_section_in_file(GITMODULES_FILE, sect.buf, NULL) < 0) {
141 /* Maybe the user already did that, don't error out here */
142 warning(_("Could not remove .gitmodules entry for %s"), path);
143 strbuf_release(§);
144 return -1;
145 }
146 strbuf_release(§);
147 return 0;
148}
149
150void stage_updated_gitmodules(struct index_state *istate)
151{
152 if (add_file_to_index(istate, GITMODULES_FILE, 0))
153 die(_("staging updated .gitmodules failed"));
154}
155
156/* TODO: remove this function, use repo_submodule_init instead. */
157int add_submodule_odb(const char *path)
158{
159 struct strbuf objects_directory = STRBUF_INIT;
160 int ret = 0;
161
162 ret = strbuf_git_path_submodule(&objects_directory, path, "objects/");
163 if (ret)
164 goto done;
165 if (!is_directory(objects_directory.buf)) {
166 ret = -1;
167 goto done;
168 }
169 add_to_alternates_memory(objects_directory.buf);
170done:
171 strbuf_release(&objects_directory);
172 return ret;
173}
174
175void set_diffopt_flags_from_submodule_config(struct diff_options *diffopt,
176 const char *path)
177{
178 const struct submodule *submodule = submodule_from_path(the_repository,
179 &null_oid, path);
180 if (submodule) {
181 const char *ignore;
182 char *key;
183
184 key = xstrfmt("submodule.%s.ignore", submodule->name);
185 if (repo_config_get_string_const(the_repository, key, &ignore))
186 ignore = submodule->ignore;
187 free(key);
188
189 if (ignore)
190 handle_ignore_submodules_arg(diffopt, ignore);
191 else if (is_gitmodules_unmerged(the_repository->index))
192 diffopt->flags.ignore_submodules = 1;
193 }
194}
195
196/* Cheap function that only determines if we're interested in submodules at all */
197int git_default_submodule_config(const char *var, const char *value, void *cb)
198{
199 if (!strcmp(var, "submodule.recurse")) {
200 int v = git_config_bool(var, value) ?
201 RECURSE_SUBMODULES_ON : RECURSE_SUBMODULES_OFF;
202 config_update_recurse_submodules = v;
203 }
204 return 0;
205}
206
207int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
208 const char *arg, int unset)
209{
210 if (unset) {
211 config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
212 return 0;
213 }
214 if (arg)
215 config_update_recurse_submodules =
216 parse_update_recurse_submodules_arg(opt->long_name,
217 arg);
218 else
219 config_update_recurse_submodules = RECURSE_SUBMODULES_ON;
220
221 return 0;
222}
223
224/*
225 * Determine if a submodule has been initialized at a given 'path'
226 */
227int is_submodule_active(struct repository *repo, const char *path)
228{
229 int ret = 0;
230 char *key = NULL;
231 char *value = NULL;
232 const struct string_list *sl;
233 const struct submodule *module;
234
235 module = submodule_from_path(repo, &null_oid, path);
236
237 /* early return if there isn't a path->module mapping */
238 if (!module)
239 return 0;
240
241 /* submodule.<name>.active is set */
242 key = xstrfmt("submodule.%s.active", module->name);
243 if (!repo_config_get_bool(repo, key, &ret)) {
244 free(key);
245 return ret;
246 }
247 free(key);
248
249 /* submodule.active is set */
250 sl = repo_config_get_value_multi(repo, "submodule.active");
251 if (sl) {
252 struct pathspec ps;
253 struct argv_array args = ARGV_ARRAY_INIT;
254 const struct string_list_item *item;
255
256 for_each_string_list_item(item, sl) {
257 argv_array_push(&args, item->string);
258 }
259
260 parse_pathspec(&ps, 0, 0, NULL, args.argv);
261 ret = match_pathspec(repo->index, &ps, path, strlen(path), 0, NULL, 1);
262
263 argv_array_clear(&args);
264 clear_pathspec(&ps);
265 return ret;
266 }
267
268 /* fallback to checking if the URL is set */
269 key = xstrfmt("submodule.%s.url", module->name);
270 ret = !repo_config_get_string(repo, key, &value);
271
272 free(value);
273 free(key);
274 return ret;
275}
276
277int is_submodule_populated_gently(const char *path, int *return_error_code)
278{
279 int ret = 0;
280 char *gitdir = xstrfmt("%s/.git", path);
281
282 if (resolve_gitdir_gently(gitdir, return_error_code))
283 ret = 1;
284
285 free(gitdir);
286 return ret;
287}
288
289/*
290 * Dies if the provided 'prefix' corresponds to an unpopulated submodule
291 */
292void die_in_unpopulated_submodule(const struct index_state *istate,
293 const char *prefix)
294{
295 int i, prefixlen;
296
297 if (!prefix)
298 return;
299
300 prefixlen = strlen(prefix);
301
302 for (i = 0; i < istate->cache_nr; i++) {
303 struct cache_entry *ce = istate->cache[i];
304 int ce_len = ce_namelen(ce);
305
306 if (!S_ISGITLINK(ce->ce_mode))
307 continue;
308 if (prefixlen <= ce_len)
309 continue;
310 if (strncmp(ce->name, prefix, ce_len))
311 continue;
312 if (prefix[ce_len] != '/')
313 continue;
314
315 die(_("in unpopulated submodule '%s'"), ce->name);
316 }
317}
318
319/*
320 * Dies if any paths in the provided pathspec descends into a submodule
321 */
322void die_path_inside_submodule(const struct index_state *istate,
323 const struct pathspec *ps)
324{
325 int i, j;
326
327 for (i = 0; i < istate->cache_nr; i++) {
328 struct cache_entry *ce = istate->cache[i];
329 int ce_len = ce_namelen(ce);
330
331 if (!S_ISGITLINK(ce->ce_mode))
332 continue;
333
334 for (j = 0; j < ps->nr ; j++) {
335 const struct pathspec_item *item = &ps->items[j];
336
337 if (item->len <= ce_len)
338 continue;
339 if (item->match[ce_len] != '/')
340 continue;
341 if (strncmp(ce->name, item->match, ce_len))
342 continue;
343 if (item->len == ce_len + 1)
344 continue;
345
346 die(_("Pathspec '%s' is in submodule '%.*s'"),
347 item->original, ce_len, ce->name);
348 }
349 }
350}
351
352enum submodule_update_type parse_submodule_update_type(const char *value)
353{
354 if (!strcmp(value, "none"))
355 return SM_UPDATE_NONE;
356 else if (!strcmp(value, "checkout"))
357 return SM_UPDATE_CHECKOUT;
358 else if (!strcmp(value, "rebase"))
359 return SM_UPDATE_REBASE;
360 else if (!strcmp(value, "merge"))
361 return SM_UPDATE_MERGE;
362 else if (*value == '!')
363 return SM_UPDATE_COMMAND;
364 else
365 return SM_UPDATE_UNSPECIFIED;
366}
367
368int parse_submodule_update_strategy(const char *value,
369 struct submodule_update_strategy *dst)
370{
371 enum submodule_update_type type;
372
373 free((void*)dst->command);
374 dst->command = NULL;
375
376 type = parse_submodule_update_type(value);
377 if (type == SM_UPDATE_UNSPECIFIED)
378 return -1;
379
380 dst->type = type;
381 if (type == SM_UPDATE_COMMAND)
382 dst->command = xstrdup(value + 1);
383
384 return 0;
385}
386
387const char *submodule_strategy_to_string(const struct submodule_update_strategy *s)
388{
389 struct strbuf sb = STRBUF_INIT;
390 switch (s->type) {
391 case SM_UPDATE_CHECKOUT:
392 return "checkout";
393 case SM_UPDATE_MERGE:
394 return "merge";
395 case SM_UPDATE_REBASE:
396 return "rebase";
397 case SM_UPDATE_NONE:
398 return "none";
399 case SM_UPDATE_UNSPECIFIED:
400 return NULL;
401 case SM_UPDATE_COMMAND:
402 strbuf_addf(&sb, "!%s", s->command);
403 return strbuf_detach(&sb, NULL);
404 }
405 return NULL;
406}
407
408void handle_ignore_submodules_arg(struct diff_options *diffopt,
409 const char *arg)
410{
411 diffopt->flags.ignore_submodules = 0;
412 diffopt->flags.ignore_untracked_in_submodules = 0;
413 diffopt->flags.ignore_dirty_submodules = 0;
414
415 if (!strcmp(arg, "all"))
416 diffopt->flags.ignore_submodules = 1;
417 else if (!strcmp(arg, "untracked"))
418 diffopt->flags.ignore_untracked_in_submodules = 1;
419 else if (!strcmp(arg, "dirty"))
420 diffopt->flags.ignore_dirty_submodules = 1;
421 else if (strcmp(arg, "none"))
422 die("bad --ignore-submodules argument: %s", arg);
423}
424
425static int prepare_submodule_summary(struct rev_info *rev, const char *path,
426 struct commit *left, struct commit *right,
427 struct commit_list *merge_bases)
428{
429 struct commit_list *list;
430
431 repo_init_revisions(the_repository, rev, NULL);
432 setup_revisions(0, NULL, rev, NULL);
433 rev->left_right = 1;
434 rev->first_parent_only = 1;
435 left->object.flags |= SYMMETRIC_LEFT;
436 add_pending_object(rev, &left->object, path);
437 add_pending_object(rev, &right->object, path);
438 for (list = merge_bases; list; list = list->next) {
439 list->item->object.flags |= UNINTERESTING;
440 add_pending_object(rev, &list->item->object,
441 oid_to_hex(&list->item->object.oid));
442 }
443 return prepare_revision_walk(rev);
444}
445
446static void print_submodule_summary(struct repository *r, struct rev_info *rev, struct diff_options *o)
447{
448 static const char format[] = " %m %s";
449 struct strbuf sb = STRBUF_INIT;
450 struct commit *commit;
451
452 while ((commit = get_revision(rev))) {
453 struct pretty_print_context ctx = {0};
454 ctx.date_mode = rev->date_mode;
455 ctx.output_encoding = get_log_output_encoding();
456 strbuf_setlen(&sb, 0);
457 repo_format_commit_message(r, commit, format, &sb,
458 &ctx);
459 strbuf_addch(&sb, '\n');
460 if (commit->object.flags & SYMMETRIC_LEFT)
461 diff_emit_submodule_del(o, sb.buf);
462 else
463 diff_emit_submodule_add(o, sb.buf);
464 }
465 strbuf_release(&sb);
466}
467
468static void prepare_submodule_repo_env_no_git_dir(struct argv_array *out)
469{
470 const char * const *var;
471
472 for (var = local_repo_env; *var; var++) {
473 if (strcmp(*var, CONFIG_DATA_ENVIRONMENT))
474 argv_array_push(out, *var);
475 }
476}
477
478void prepare_submodule_repo_env(struct argv_array *out)
479{
480 prepare_submodule_repo_env_no_git_dir(out);
481 argv_array_pushf(out, "%s=%s", GIT_DIR_ENVIRONMENT,
482 DEFAULT_GIT_DIR_ENVIRONMENT);
483}
484
485/*
486 * Initialize a repository struct for a submodule based on the provided 'path'.
487 *
488 * Unlike repo_submodule_init, this tolerates submodules not present
489 * in .gitmodules. This function exists only to preserve historical behavior,
490 *
491 * Returns the repository struct on success,
492 * NULL when the submodule is not present.
493 */
494static struct repository *open_submodule(const char *path)
495{
496 struct strbuf sb = STRBUF_INIT;
497 struct repository *out = xmalloc(sizeof(*out));
498
499 if (submodule_to_gitdir(&sb, path) || repo_init(out, sb.buf, NULL)) {
500 strbuf_release(&sb);
501 free(out);
502 return NULL;
503 }
504
505 /* Mark it as a submodule */
506 out->submodule_prefix = xstrdup(path);
507
508 strbuf_release(&sb);
509 return out;
510}
511
512/*
513 * Helper function to display the submodule header line prior to the full
514 * summary output.
515 *
516 * If it can locate the submodule git directory it will create a repository
517 * handle for the submodule and lookup both the left and right commits and
518 * put them into the left and right pointers.
519 */
520static void show_submodule_header(struct diff_options *o,
521 const char *path,
522 struct object_id *one, struct object_id *two,
523 unsigned dirty_submodule,
524 struct repository *sub,
525 struct commit **left, struct commit **right,
526 struct commit_list **merge_bases)
527{
528 const char *message = NULL;
529 struct strbuf sb = STRBUF_INIT;
530 int fast_forward = 0, fast_backward = 0;
531
532 if (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED)
533 diff_emit_submodule_untracked(o, path);
534
535 if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
536 diff_emit_submodule_modified(o, path);
537
538 if (is_null_oid(one))
539 message = "(new submodule)";
540 else if (is_null_oid(two))
541 message = "(submodule deleted)";
542
543 if (!sub) {
544 if (!message)
545 message = "(commits not present)";
546 goto output_header;
547 }
548
549 /*
550 * Attempt to lookup the commit references, and determine if this is
551 * a fast forward or fast backwards update.
552 */
553 *left = lookup_commit_reference(sub, one);
554 *right = lookup_commit_reference(sub, two);
555
556 /*
557 * Warn about missing commits in the submodule project, but only if
558 * they aren't null.
559 */
560 if ((!is_null_oid(one) && !*left) ||
561 (!is_null_oid(two) && !*right))
562 message = "(commits not present)";
563
564 *merge_bases = repo_get_merge_bases(sub, *left, *right);
565 if (*merge_bases) {
566 if ((*merge_bases)->item == *left)
567 fast_forward = 1;
568 else if ((*merge_bases)->item == *right)
569 fast_backward = 1;
570 }
571
572 if (oideq(one, two)) {
573 strbuf_release(&sb);
574 return;
575 }
576
577output_header:
578 strbuf_addf(&sb, "Submodule %s ", path);
579 strbuf_add_unique_abbrev(&sb, one, DEFAULT_ABBREV);
580 strbuf_addstr(&sb, (fast_backward || fast_forward) ? ".." : "...");
581 strbuf_add_unique_abbrev(&sb, two, DEFAULT_ABBREV);
582 if (message)
583 strbuf_addf(&sb, " %s\n", message);
584 else
585 strbuf_addf(&sb, "%s:\n", fast_backward ? " (rewind)" : "");
586 diff_emit_submodule_header(o, sb.buf);
587
588 strbuf_release(&sb);
589}
590
591void show_submodule_summary(struct diff_options *o, const char *path,
592 struct object_id *one, struct object_id *two,
593 unsigned dirty_submodule)
594{
595 struct rev_info rev;
596 struct commit *left = NULL, *right = NULL;
597 struct commit_list *merge_bases = NULL;
598 struct repository *sub;
599
600 sub = open_submodule(path);
601 show_submodule_header(o, path, one, two, dirty_submodule,
602 sub, &left, &right, &merge_bases);
603
604 /*
605 * If we don't have both a left and a right pointer, there is no
606 * reason to try and display a summary. The header line should contain
607 * all the information the user needs.
608 */
609 if (!left || !right || !sub)
610 goto out;
611
612 /* Treat revision walker failure the same as missing commits */
613 if (prepare_submodule_summary(&rev, path, left, right, merge_bases)) {
614 diff_emit_submodule_error(o, "(revision walker failed)\n");
615 goto out;
616 }
617
618 print_submodule_summary(sub, &rev, o);
619
620out:
621 if (merge_bases)
622 free_commit_list(merge_bases);
623 clear_commit_marks(left, ~0);
624 clear_commit_marks(right, ~0);
625 if (sub) {
626 repo_clear(sub);
627 free(sub);
628 }
629}
630
631void show_submodule_inline_diff(struct diff_options *o, const char *path,
632 struct object_id *one, struct object_id *two,
633 unsigned dirty_submodule)
634{
635 const struct object_id *old_oid = the_hash_algo->empty_tree, *new_oid = the_hash_algo->empty_tree;
636 struct commit *left = NULL, *right = NULL;
637 struct commit_list *merge_bases = NULL;
638 struct child_process cp = CHILD_PROCESS_INIT;
639 struct strbuf sb = STRBUF_INIT;
640 struct repository *sub;
641
642 sub = open_submodule(path);
643 show_submodule_header(o, path, one, two, dirty_submodule,
644 sub, &left, &right, &merge_bases);
645
646 /* We need a valid left and right commit to display a difference */
647 if (!(left || is_null_oid(one)) ||
648 !(right || is_null_oid(two)))
649 goto done;
650
651 if (left)
652 old_oid = one;
653 if (right)
654 new_oid = two;
655
656 cp.git_cmd = 1;
657 cp.dir = path;
658 cp.out = -1;
659 cp.no_stdin = 1;
660
661 /* TODO: other options may need to be passed here. */
662 argv_array_pushl(&cp.args, "diff", "--submodule=diff", NULL);
663 argv_array_pushf(&cp.args, "--color=%s", want_color(o->use_color) ?
664 "always" : "never");
665
666 if (o->flags.reverse_diff) {
667 argv_array_pushf(&cp.args, "--src-prefix=%s%s/",
668 o->b_prefix, path);
669 argv_array_pushf(&cp.args, "--dst-prefix=%s%s/",
670 o->a_prefix, path);
671 } else {
672 argv_array_pushf(&cp.args, "--src-prefix=%s%s/",
673 o->a_prefix, path);
674 argv_array_pushf(&cp.args, "--dst-prefix=%s%s/",
675 o->b_prefix, path);
676 }
677 argv_array_push(&cp.args, oid_to_hex(old_oid));
678 /*
679 * If the submodule has modified content, we will diff against the
680 * work tree, under the assumption that the user has asked for the
681 * diff format and wishes to actually see all differences even if they
682 * haven't yet been committed to the submodule yet.
683 */
684 if (!(dirty_submodule & DIRTY_SUBMODULE_MODIFIED))
685 argv_array_push(&cp.args, oid_to_hex(new_oid));
686
687 prepare_submodule_repo_env(&cp.env_array);
688 if (start_command(&cp))
689 diff_emit_submodule_error(o, "(diff failed)\n");
690
691 while (strbuf_getwholeline_fd(&sb, cp.out, '\n') != EOF)
692 diff_emit_submodule_pipethrough(o, sb.buf, sb.len);
693
694 if (finish_command(&cp))
695 diff_emit_submodule_error(o, "(diff failed)\n");
696
697done:
698 strbuf_release(&sb);
699 if (merge_bases)
700 free_commit_list(merge_bases);
701 if (left)
702 clear_commit_marks(left, ~0);
703 if (right)
704 clear_commit_marks(right, ~0);
705 if (sub) {
706 repo_clear(sub);
707 free(sub);
708 }
709}
710
711int should_update_submodules(void)
712{
713 return config_update_recurse_submodules == RECURSE_SUBMODULES_ON;
714}
715
716const struct submodule *submodule_from_ce(const struct cache_entry *ce)
717{
718 if (!S_ISGITLINK(ce->ce_mode))
719 return NULL;
720
721 if (!should_update_submodules())
722 return NULL;
723
724 return submodule_from_path(the_repository, &null_oid, ce->name);
725}
726
727static struct oid_array *submodule_commits(struct string_list *submodules,
728 const char *name)
729{
730 struct string_list_item *item;
731
732 item = string_list_insert(submodules, name);
733 if (item->util)
734 return (struct oid_array *) item->util;
735
736 /* NEEDSWORK: should we have oid_array_init()? */
737 item->util = xcalloc(1, sizeof(struct oid_array));
738 return (struct oid_array *) item->util;
739}
740
741struct collect_changed_submodules_cb_data {
742 struct string_list *changed;
743 const struct object_id *commit_oid;
744};
745
746/*
747 * this would normally be two functions: default_name_from_path() and
748 * path_from_default_name(). Since the default name is the same as
749 * the submodule path we can get away with just one function which only
750 * checks whether there is a submodule in the working directory at that
751 * location.
752 */
753static const char *default_name_or_path(const char *path_or_name)
754{
755 int error_code;
756
757 if (!is_submodule_populated_gently(path_or_name, &error_code))
758 return NULL;
759
760 return path_or_name;
761}
762
763static void collect_changed_submodules_cb(struct diff_queue_struct *q,
764 struct diff_options *options,
765 void *data)
766{
767 struct collect_changed_submodules_cb_data *me = data;
768 struct string_list *changed = me->changed;
769 const struct object_id *commit_oid = me->commit_oid;
770 int i;
771
772 for (i = 0; i < q->nr; i++) {
773 struct diff_filepair *p = q->queue[i];
774 struct oid_array *commits;
775 const struct submodule *submodule;
776 const char *name;
777
778 if (!S_ISGITLINK(p->two->mode))
779 continue;
780
781 submodule = submodule_from_path(the_repository,
782 commit_oid, p->two->path);
783 if (submodule)
784 name = submodule->name;
785 else {
786 name = default_name_or_path(p->two->path);
787 /* make sure name does not collide with existing one */
788 if (name)
789 submodule = submodule_from_name(the_repository,
790 commit_oid, name);
791 if (submodule) {
792 warning("Submodule in commit %s at path: "
793 "'%s' collides with a submodule named "
794 "the same. Skipping it.",
795 oid_to_hex(commit_oid), p->two->path);
796 name = NULL;
797 }
798 }
799
800 if (!name)
801 continue;
802
803 commits = submodule_commits(changed, name);
804 oid_array_append(commits, &p->two->oid);
805 }
806}
807
808/*
809 * Collect the paths of submodules in 'changed' which have changed based on
810 * the revisions as specified in 'argv'. Each entry in 'changed' will also
811 * have a corresponding 'struct oid_array' (in the 'util' field) which lists
812 * what the submodule pointers were updated to during the change.
813 */
814static void collect_changed_submodules(struct index_state *istate,
815 struct string_list *changed,
816 struct argv_array *argv)
817{
818 struct rev_info rev;
819 const struct commit *commit;
820
821 repo_init_revisions(the_repository, &rev, NULL);
822 setup_revisions(argv->argc, argv->argv, &rev, NULL);
823 if (prepare_revision_walk(&rev))
824 die("revision walk setup failed");
825
826 while ((commit = get_revision(&rev))) {
827 struct rev_info diff_rev;
828 struct collect_changed_submodules_cb_data data;
829 data.changed = changed;
830 data.commit_oid = &commit->object.oid;
831
832 repo_init_revisions(the_repository, &diff_rev, NULL);
833 diff_rev.diffopt.output_format |= DIFF_FORMAT_CALLBACK;
834 diff_rev.diffopt.format_callback = collect_changed_submodules_cb;
835 diff_rev.diffopt.format_callback_data = &data;
836 diff_tree_combined_merge(commit, 1, &diff_rev);
837 }
838
839 reset_revision_walk();
840}
841
842static void free_submodules_oids(struct string_list *submodules)
843{
844 struct string_list_item *item;
845 for_each_string_list_item(item, submodules)
846 oid_array_clear((struct oid_array *) item->util);
847 string_list_clear(submodules, 1);
848}
849
850static int has_remote(const char *refname, const struct object_id *oid,
851 int flags, void *cb_data)
852{
853 return 1;
854}
855
856static int append_oid_to_argv(const struct object_id *oid, void *data)
857{
858 struct argv_array *argv = data;
859 argv_array_push(argv, oid_to_hex(oid));
860 return 0;
861}
862
863struct has_commit_data {
864 int result;
865 const char *path;
866};
867
868static int check_has_commit(const struct object_id *oid, void *data)
869{
870 struct has_commit_data *cb = data;
871
872 enum object_type type = oid_object_info(the_repository, oid, NULL);
873
874 switch (type) {
875 case OBJ_COMMIT:
876 return 0;
877 case OBJ_BAD:
878 /*
879 * Object is missing or invalid. If invalid, an error message
880 * has already been printed.
881 */
882 cb->result = 0;
883 return 0;
884 default:
885 die(_("submodule entry '%s' (%s) is a %s, not a commit"),
886 cb->path, oid_to_hex(oid), type_name(type));
887 }
888}
889
890static int submodule_has_commits(const char *path, struct oid_array *commits)
891{
892 struct has_commit_data has_commit = { 1, path };
893
894 /*
895 * Perform a cheap, but incorrect check for the existence of 'commits'.
896 * This is done by adding the submodule's object store to the in-core
897 * object store, and then querying for each commit's existence. If we
898 * do not have the commit object anywhere, there is no chance we have
899 * it in the object store of the correct submodule and have it
900 * reachable from a ref, so we can fail early without spawning rev-list
901 * which is expensive.
902 */
903 if (add_submodule_odb(path))
904 return 0;
905
906 oid_array_for_each_unique(commits, check_has_commit, &has_commit);
907
908 if (has_commit.result) {
909 /*
910 * Even if the submodule is checked out and the commit is
911 * present, make sure it exists in the submodule's object store
912 * and that it is reachable from a ref.
913 */
914 struct child_process cp = CHILD_PROCESS_INIT;
915 struct strbuf out = STRBUF_INIT;
916
917 argv_array_pushl(&cp.args, "rev-list", "-n", "1", NULL);
918 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
919 argv_array_pushl(&cp.args, "--not", "--all", NULL);
920
921 prepare_submodule_repo_env(&cp.env_array);
922 cp.git_cmd = 1;
923 cp.no_stdin = 1;
924 cp.dir = path;
925
926 if (capture_command(&cp, &out, GIT_MAX_HEXSZ + 1) || out.len)
927 has_commit.result = 0;
928
929 strbuf_release(&out);
930 }
931
932 return has_commit.result;
933}
934
935static int submodule_needs_pushing(const char *path, struct oid_array *commits)
936{
937 if (!submodule_has_commits(path, commits))
938 /*
939 * NOTE: We do consider it safe to return "no" here. The
940 * correct answer would be "We do not know" instead of
941 * "No push needed", but it is quite hard to change
942 * the submodule pointer without having the submodule
943 * around. If a user did however change the submodules
944 * without having the submodule around, this indicates
945 * an expert who knows what they are doing or a
946 * maintainer integrating work from other people. In
947 * both cases it should be safe to skip this check.
948 */
949 return 0;
950
951 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
952 struct child_process cp = CHILD_PROCESS_INIT;
953 struct strbuf buf = STRBUF_INIT;
954 int needs_pushing = 0;
955
956 argv_array_push(&cp.args, "rev-list");
957 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
958 argv_array_pushl(&cp.args, "--not", "--remotes", "-n", "1" , NULL);
959
960 prepare_submodule_repo_env(&cp.env_array);
961 cp.git_cmd = 1;
962 cp.no_stdin = 1;
963 cp.out = -1;
964 cp.dir = path;
965 if (start_command(&cp))
966 die("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s",
967 path);
968 if (strbuf_read(&buf, cp.out, 41))
969 needs_pushing = 1;
970 finish_command(&cp);
971 close(cp.out);
972 strbuf_release(&buf);
973 return needs_pushing;
974 }
975
976 return 0;
977}
978
979int find_unpushed_submodules(struct index_state *istate,
980 struct oid_array *commits,
981 const char *remotes_name,
982 struct string_list *needs_pushing)
983{
984 struct string_list submodules = STRING_LIST_INIT_DUP;
985 struct string_list_item *name;
986 struct argv_array argv = ARGV_ARRAY_INIT;
987
988 /* argv.argv[0] will be ignored by setup_revisions */
989 argv_array_push(&argv, "find_unpushed_submodules");
990 oid_array_for_each_unique(commits, append_oid_to_argv, &argv);
991 argv_array_push(&argv, "--not");
992 argv_array_pushf(&argv, "--remotes=%s", remotes_name);
993
994 collect_changed_submodules(istate, &submodules, &argv);
995
996 for_each_string_list_item(name, &submodules) {
997 struct oid_array *commits = name->util;
998 const struct submodule *submodule;
999 const char *path = NULL;
1000
1001 submodule = submodule_from_name(the_repository, &null_oid, name->string);
1002 if (submodule)
1003 path = submodule->path;
1004 else
1005 path = default_name_or_path(name->string);
1006
1007 if (!path)
1008 continue;
1009
1010 if (submodule_needs_pushing(path, commits))
1011 string_list_insert(needs_pushing, path);
1012 }
1013
1014 free_submodules_oids(&submodules);
1015 argv_array_clear(&argv);
1016
1017 return needs_pushing->nr;
1018}
1019
1020static int push_submodule(const char *path,
1021 const struct remote *remote,
1022 const struct refspec *rs,
1023 const struct string_list *push_options,
1024 int dry_run)
1025{
1026 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
1027 struct child_process cp = CHILD_PROCESS_INIT;
1028 argv_array_push(&cp.args, "push");
1029 if (dry_run)
1030 argv_array_push(&cp.args, "--dry-run");
1031
1032 if (push_options && push_options->nr) {
1033 const struct string_list_item *item;
1034 for_each_string_list_item(item, push_options)
1035 argv_array_pushf(&cp.args, "--push-option=%s",
1036 item->string);
1037 }
1038
1039 if (remote->origin != REMOTE_UNCONFIGURED) {
1040 int i;
1041 argv_array_push(&cp.args, remote->name);
1042 for (i = 0; i < rs->raw_nr; i++)
1043 argv_array_push(&cp.args, rs->raw[i]);
1044 }
1045
1046 prepare_submodule_repo_env(&cp.env_array);
1047 cp.git_cmd = 1;
1048 cp.no_stdin = 1;
1049 cp.dir = path;
1050 if (run_command(&cp))
1051 return 0;
1052 close(cp.out);
1053 }
1054
1055 return 1;
1056}
1057
1058/*
1059 * Perform a check in the submodule to see if the remote and refspec work.
1060 * Die if the submodule can't be pushed.
1061 */
1062static void submodule_push_check(const char *path, const char *head,
1063 const struct remote *remote,
1064 const struct refspec *rs)
1065{
1066 struct child_process cp = CHILD_PROCESS_INIT;
1067 int i;
1068
1069 argv_array_push(&cp.args, "submodule--helper");
1070 argv_array_push(&cp.args, "push-check");
1071 argv_array_push(&cp.args, head);
1072 argv_array_push(&cp.args, remote->name);
1073
1074 for (i = 0; i < rs->raw_nr; i++)
1075 argv_array_push(&cp.args, rs->raw[i]);
1076
1077 prepare_submodule_repo_env(&cp.env_array);
1078 cp.git_cmd = 1;
1079 cp.no_stdin = 1;
1080 cp.no_stdout = 1;
1081 cp.dir = path;
1082
1083 /*
1084 * Simply indicate if 'submodule--helper push-check' failed.
1085 * More detailed error information will be provided by the
1086 * child process.
1087 */
1088 if (run_command(&cp))
1089 die("process for submodule '%s' failed", path);
1090}
1091
1092int push_unpushed_submodules(struct index_state *istate,
1093 struct oid_array *commits,
1094 const struct remote *remote,
1095 const struct refspec *rs,
1096 const struct string_list *push_options,
1097 int dry_run)
1098{
1099 int i, ret = 1;
1100 struct string_list needs_pushing = STRING_LIST_INIT_DUP;
1101
1102 if (!find_unpushed_submodules(istate, commits,
1103 remote->name, &needs_pushing))
1104 return 1;
1105
1106 /*
1107 * Verify that the remote and refspec can be propagated to all
1108 * submodules. This check can be skipped if the remote and refspec
1109 * won't be propagated due to the remote being unconfigured (e.g. a URL
1110 * instead of a remote name).
1111 */
1112 if (remote->origin != REMOTE_UNCONFIGURED) {
1113 char *head;
1114 struct object_id head_oid;
1115
1116 head = resolve_refdup("HEAD", 0, &head_oid, NULL);
1117 if (!head)
1118 die(_("Failed to resolve HEAD as a valid ref."));
1119
1120 for (i = 0; i < needs_pushing.nr; i++)
1121 submodule_push_check(needs_pushing.items[i].string,
1122 head, remote, rs);
1123 free(head);
1124 }
1125
1126 /* Actually push the submodules */
1127 for (i = 0; i < needs_pushing.nr; i++) {
1128 const char *path = needs_pushing.items[i].string;
1129 fprintf(stderr, "Pushing submodule '%s'\n", path);
1130 if (!push_submodule(path, remote, rs,
1131 push_options, dry_run)) {
1132 fprintf(stderr, "Unable to push submodule '%s'\n", path);
1133 ret = 0;
1134 }
1135 }
1136
1137 string_list_clear(&needs_pushing, 0);
1138
1139 return ret;
1140}
1141
1142static int append_oid_to_array(const char *ref, const struct object_id *oid,
1143 int flags, void *data)
1144{
1145 struct oid_array *array = data;
1146 oid_array_append(array, oid);
1147 return 0;
1148}
1149
1150void check_for_new_submodule_commits(struct object_id *oid)
1151{
1152 if (!initialized_fetch_ref_tips) {
1153 for_each_ref(append_oid_to_array, &ref_tips_before_fetch);
1154 initialized_fetch_ref_tips = 1;
1155 }
1156
1157 oid_array_append(&ref_tips_after_fetch, oid);
1158}
1159
1160static void calculate_changed_submodule_paths(struct index_state *istate)
1161{
1162 struct argv_array argv = ARGV_ARRAY_INIT;
1163 struct string_list changed_submodules = STRING_LIST_INIT_DUP;
1164 const struct string_list_item *name;
1165
1166 /* No need to check if there are no submodules configured */
1167 if (!submodule_from_path(the_repository, NULL, NULL))
1168 return;
1169
1170 argv_array_push(&argv, "--"); /* argv[0] program name */
1171 oid_array_for_each_unique(&ref_tips_after_fetch,
1172 append_oid_to_argv, &argv);
1173 argv_array_push(&argv, "--not");
1174 oid_array_for_each_unique(&ref_tips_before_fetch,
1175 append_oid_to_argv, &argv);
1176
1177 /*
1178 * Collect all submodules (whether checked out or not) for which new
1179 * commits have been recorded upstream in "changed_submodule_names".
1180 */
1181 collect_changed_submodules(istate, &changed_submodules, &argv);
1182
1183 for_each_string_list_item(name, &changed_submodules) {
1184 struct oid_array *commits = name->util;
1185 const struct submodule *submodule;
1186 const char *path = NULL;
1187
1188 submodule = submodule_from_name(the_repository, &null_oid, name->string);
1189 if (submodule)
1190 path = submodule->path;
1191 else
1192 path = default_name_or_path(name->string);
1193
1194 if (!path)
1195 continue;
1196
1197 if (!submodule_has_commits(path, commits))
1198 string_list_append(&changed_submodule_names, name->string);
1199 }
1200
1201 free_submodules_oids(&changed_submodules);
1202 argv_array_clear(&argv);
1203 oid_array_clear(&ref_tips_before_fetch);
1204 oid_array_clear(&ref_tips_after_fetch);
1205 initialized_fetch_ref_tips = 0;
1206}
1207
1208int submodule_touches_in_range(struct index_state *istate,
1209 struct object_id *excl_oid,
1210 struct object_id *incl_oid)
1211{
1212 struct string_list subs = STRING_LIST_INIT_DUP;
1213 struct argv_array args = ARGV_ARRAY_INIT;
1214 int ret;
1215
1216 /* No need to check if there are no submodules configured */
1217 if (!submodule_from_path(the_repository, NULL, NULL))
1218 return 0;
1219
1220 argv_array_push(&args, "--"); /* args[0] program name */
1221 argv_array_push(&args, oid_to_hex(incl_oid));
1222 if (!is_null_oid(excl_oid)) {
1223 argv_array_push(&args, "--not");
1224 argv_array_push(&args, oid_to_hex(excl_oid));
1225 }
1226
1227 collect_changed_submodules(istate, &subs, &args);
1228 ret = subs.nr;
1229
1230 argv_array_clear(&args);
1231
1232 free_submodules_oids(&subs);
1233 return ret;
1234}
1235
1236struct submodule_parallel_fetch {
1237 int count;
1238 struct argv_array args;
1239 struct repository *r;
1240 const char *prefix;
1241 int command_line_option;
1242 int default_option;
1243 int quiet;
1244 int result;
1245};
1246#define SPF_INIT {0, ARGV_ARRAY_INIT, NULL, NULL, 0, 0, 0, 0}
1247
1248static int get_fetch_recurse_config(const struct submodule *submodule,
1249 struct submodule_parallel_fetch *spf)
1250{
1251 if (spf->command_line_option != RECURSE_SUBMODULES_DEFAULT)
1252 return spf->command_line_option;
1253
1254 if (submodule) {
1255 char *key;
1256 const char *value;
1257
1258 int fetch_recurse = submodule->fetch_recurse;
1259 key = xstrfmt("submodule.%s.fetchRecurseSubmodules", submodule->name);
1260 if (!repo_config_get_string_const(spf->r, key, &value)) {
1261 fetch_recurse = parse_fetch_recurse_submodules_arg(key, value);
1262 }
1263 free(key);
1264
1265 if (fetch_recurse != RECURSE_SUBMODULES_NONE)
1266 /* local config overrules everything except commandline */
1267 return fetch_recurse;
1268 }
1269
1270 return spf->default_option;
1271}
1272
1273static int get_next_submodule(struct child_process *cp,
1274 struct strbuf *err, void *data, void **task_cb)
1275{
1276 int ret = 0;
1277 struct submodule_parallel_fetch *spf = data;
1278
1279 for (; spf->count < spf->r->index->cache_nr; spf->count++) {
1280 struct strbuf submodule_path = STRBUF_INIT;
1281 struct strbuf submodule_git_dir = STRBUF_INIT;
1282 struct strbuf submodule_prefix = STRBUF_INIT;
1283 const struct cache_entry *ce = spf->r->index->cache[spf->count];
1284 const char *git_dir, *default_argv;
1285 const struct submodule *submodule;
1286 struct submodule default_submodule = SUBMODULE_INIT;
1287
1288 if (!S_ISGITLINK(ce->ce_mode))
1289 continue;
1290
1291 submodule = submodule_from_path(spf->r, &null_oid, ce->name);
1292 if (!submodule) {
1293 const char *name = default_name_or_path(ce->name);
1294 if (name) {
1295 default_submodule.path = default_submodule.name = name;
1296 submodule = &default_submodule;
1297 }
1298 }
1299
1300 switch (get_fetch_recurse_config(submodule, spf))
1301 {
1302 default:
1303 case RECURSE_SUBMODULES_DEFAULT:
1304 case RECURSE_SUBMODULES_ON_DEMAND:
1305 if (!submodule || !unsorted_string_list_lookup(&changed_submodule_names,
1306 submodule->name))
1307 continue;
1308 default_argv = "on-demand";
1309 break;
1310 case RECURSE_SUBMODULES_ON:
1311 default_argv = "yes";
1312 break;
1313 case RECURSE_SUBMODULES_OFF:
1314 continue;
1315 }
1316
1317 strbuf_repo_worktree_path(&submodule_path, spf->r, "%s", ce->name);
1318 strbuf_addf(&submodule_git_dir, "%s/.git", submodule_path.buf);
1319 strbuf_addf(&submodule_prefix, "%s%s/", spf->prefix, ce->name);
1320 git_dir = read_gitfile(submodule_git_dir.buf);
1321 if (!git_dir)
1322 git_dir = submodule_git_dir.buf;
1323 if (is_directory(git_dir)) {
1324 child_process_init(cp);
1325 cp->dir = strbuf_detach(&submodule_path, NULL);
1326 prepare_submodule_repo_env(&cp->env_array);
1327 cp->git_cmd = 1;
1328 if (!spf->quiet)
1329 strbuf_addf(err, "Fetching submodule %s%s\n",
1330 spf->prefix, ce->name);
1331 argv_array_init(&cp->args);
1332 argv_array_pushv(&cp->args, spf->args.argv);
1333 argv_array_push(&cp->args, default_argv);
1334 argv_array_push(&cp->args, "--submodule-prefix");
1335 argv_array_push(&cp->args, submodule_prefix.buf);
1336 ret = 1;
1337 }
1338 strbuf_release(&submodule_path);
1339 strbuf_release(&submodule_git_dir);
1340 strbuf_release(&submodule_prefix);
1341 if (ret) {
1342 spf->count++;
1343 return 1;
1344 }
1345 }
1346 return 0;
1347}
1348
1349static int fetch_start_failure(struct strbuf *err,
1350 void *cb, void *task_cb)
1351{
1352 struct submodule_parallel_fetch *spf = cb;
1353
1354 spf->result = 1;
1355
1356 return 0;
1357}
1358
1359static int fetch_finish(int retvalue, struct strbuf *err,
1360 void *cb, void *task_cb)
1361{
1362 struct submodule_parallel_fetch *spf = cb;
1363
1364 if (retvalue)
1365 spf->result = 1;
1366
1367 return 0;
1368}
1369
1370int fetch_populated_submodules(struct repository *r,
1371 const struct argv_array *options,
1372 const char *prefix, int command_line_option,
1373 int default_option,
1374 int quiet, int max_parallel_jobs)
1375{
1376 int i;
1377 struct submodule_parallel_fetch spf = SPF_INIT;
1378
1379 spf.r = r;
1380 spf.command_line_option = command_line_option;
1381 spf.default_option = default_option;
1382 spf.quiet = quiet;
1383 spf.prefix = prefix;
1384
1385 if (!r->worktree)
1386 goto out;
1387
1388 if (repo_read_index(r) < 0)
1389 die("index file corrupt");
1390
1391 argv_array_push(&spf.args, "fetch");
1392 for (i = 0; i < options->argc; i++)
1393 argv_array_push(&spf.args, options->argv[i]);
1394 argv_array_push(&spf.args, "--recurse-submodules-default");
1395 /* default value, "--submodule-prefix" and its value are added later */
1396
1397 calculate_changed_submodule_paths(r->index);
1398 run_processes_parallel(max_parallel_jobs,
1399 get_next_submodule,
1400 fetch_start_failure,
1401 fetch_finish,
1402 &spf);
1403
1404 argv_array_clear(&spf.args);
1405out:
1406 string_list_clear(&changed_submodule_names, 1);
1407 return spf.result;
1408}
1409
1410unsigned is_submodule_modified(const char *path, int ignore_untracked)
1411{
1412 struct child_process cp = CHILD_PROCESS_INIT;
1413 struct strbuf buf = STRBUF_INIT;
1414 FILE *fp;
1415 unsigned dirty_submodule = 0;
1416 const char *git_dir;
1417 int ignore_cp_exit_code = 0;
1418
1419 strbuf_addf(&buf, "%s/.git", path);
1420 git_dir = read_gitfile(buf.buf);
1421 if (!git_dir)
1422 git_dir = buf.buf;
1423 if (!is_git_directory(git_dir)) {
1424 if (is_directory(git_dir))
1425 die(_("'%s' not recognized as a git repository"), git_dir);
1426 strbuf_release(&buf);
1427 /* The submodule is not checked out, so it is not modified */
1428 return 0;
1429 }
1430 strbuf_reset(&buf);
1431
1432 argv_array_pushl(&cp.args, "status", "--porcelain=2", NULL);
1433 if (ignore_untracked)
1434 argv_array_push(&cp.args, "-uno");
1435
1436 prepare_submodule_repo_env(&cp.env_array);
1437 cp.git_cmd = 1;
1438 cp.no_stdin = 1;
1439 cp.out = -1;
1440 cp.dir = path;
1441 if (start_command(&cp))
1442 die("Could not run 'git status --porcelain=2' in submodule %s", path);
1443
1444 fp = xfdopen(cp.out, "r");
1445 while (strbuf_getwholeline(&buf, fp, '\n') != EOF) {
1446 /* regular untracked files */
1447 if (buf.buf[0] == '?')
1448 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1449
1450 if (buf.buf[0] == 'u' ||
1451 buf.buf[0] == '1' ||
1452 buf.buf[0] == '2') {
1453 /* T = line type, XY = status, SSSS = submodule state */
1454 if (buf.len < strlen("T XY SSSS"))
1455 BUG("invalid status --porcelain=2 line %s",
1456 buf.buf);
1457
1458 if (buf.buf[5] == 'S' && buf.buf[8] == 'U')
1459 /* nested untracked file */
1460 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1461
1462 if (buf.buf[0] == 'u' ||
1463 buf.buf[0] == '2' ||
1464 memcmp(buf.buf + 5, "S..U", 4))
1465 /* other change */
1466 dirty_submodule |= DIRTY_SUBMODULE_MODIFIED;
1467 }
1468
1469 if ((dirty_submodule & DIRTY_SUBMODULE_MODIFIED) &&
1470 ((dirty_submodule & DIRTY_SUBMODULE_UNTRACKED) ||
1471 ignore_untracked)) {
1472 /*
1473 * We're not interested in any further information from
1474 * the child any more, neither output nor its exit code.
1475 */
1476 ignore_cp_exit_code = 1;
1477 break;
1478 }
1479 }
1480 fclose(fp);
1481
1482 if (finish_command(&cp) && !ignore_cp_exit_code)
1483 die("'git status --porcelain=2' failed in submodule %s", path);
1484
1485 strbuf_release(&buf);
1486 return dirty_submodule;
1487}
1488
1489int submodule_uses_gitfile(const char *path)
1490{
1491 struct child_process cp = CHILD_PROCESS_INIT;
1492 const char *argv[] = {
1493 "submodule",
1494 "foreach",
1495 "--quiet",
1496 "--recursive",
1497 "test -f .git",
1498 NULL,
1499 };
1500 struct strbuf buf = STRBUF_INIT;
1501 const char *git_dir;
1502
1503 strbuf_addf(&buf, "%s/.git", path);
1504 git_dir = read_gitfile(buf.buf);
1505 if (!git_dir) {
1506 strbuf_release(&buf);
1507 return 0;
1508 }
1509 strbuf_release(&buf);
1510
1511 /* Now test that all nested submodules use a gitfile too */
1512 cp.argv = argv;
1513 prepare_submodule_repo_env(&cp.env_array);
1514 cp.git_cmd = 1;
1515 cp.no_stdin = 1;
1516 cp.no_stderr = 1;
1517 cp.no_stdout = 1;
1518 cp.dir = path;
1519 if (run_command(&cp))
1520 return 0;
1521
1522 return 1;
1523}
1524
1525/*
1526 * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
1527 * when doing so.
1528 *
1529 * Return 1 if we'd lose data, return 0 if the removal is fine,
1530 * and negative values for errors.
1531 */
1532int bad_to_remove_submodule(const char *path, unsigned flags)
1533{
1534 ssize_t len;
1535 struct child_process cp = CHILD_PROCESS_INIT;
1536 struct strbuf buf = STRBUF_INIT;
1537 int ret = 0;
1538
1539 if (!file_exists(path) || is_empty_dir(path))
1540 return 0;
1541
1542 if (!submodule_uses_gitfile(path))
1543 return 1;
1544
1545 argv_array_pushl(&cp.args, "status", "--porcelain",
1546 "--ignore-submodules=none", NULL);
1547
1548 if (flags & SUBMODULE_REMOVAL_IGNORE_UNTRACKED)
1549 argv_array_push(&cp.args, "-uno");
1550 else
1551 argv_array_push(&cp.args, "-uall");
1552
1553 if (!(flags & SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED))
1554 argv_array_push(&cp.args, "--ignored");
1555
1556 prepare_submodule_repo_env(&cp.env_array);
1557 cp.git_cmd = 1;
1558 cp.no_stdin = 1;
1559 cp.out = -1;
1560 cp.dir = path;
1561 if (start_command(&cp)) {
1562 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
1563 die(_("could not start 'git status' in submodule '%s'"),
1564 path);
1565 ret = -1;
1566 goto out;
1567 }
1568
1569 len = strbuf_read(&buf, cp.out, 1024);
1570 if (len > 2)
1571 ret = 1;
1572 close(cp.out);
1573
1574 if (finish_command(&cp)) {
1575 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
1576 die(_("could not run 'git status' in submodule '%s'"),
1577 path);
1578 ret = -1;
1579 }
1580out:
1581 strbuf_release(&buf);
1582 return ret;
1583}
1584
1585static const char *get_super_prefix_or_empty(void)
1586{
1587 const char *s = get_super_prefix();
1588 if (!s)
1589 s = "";
1590 return s;
1591}
1592
1593static int submodule_has_dirty_index(const struct submodule *sub)
1594{
1595 struct child_process cp = CHILD_PROCESS_INIT;
1596
1597 prepare_submodule_repo_env(&cp.env_array);
1598
1599 cp.git_cmd = 1;
1600 argv_array_pushl(&cp.args, "diff-index", "--quiet",
1601 "--cached", "HEAD", NULL);
1602 cp.no_stdin = 1;
1603 cp.no_stdout = 1;
1604 cp.dir = sub->path;
1605 if (start_command(&cp))
1606 die("could not recurse into submodule '%s'", sub->path);
1607
1608 return finish_command(&cp);
1609}
1610
1611static void submodule_reset_index(const char *path)
1612{
1613 struct child_process cp = CHILD_PROCESS_INIT;
1614 prepare_submodule_repo_env(&cp.env_array);
1615
1616 cp.git_cmd = 1;
1617 cp.no_stdin = 1;
1618 cp.dir = path;
1619
1620 argv_array_pushf(&cp.args, "--super-prefix=%s%s/",
1621 get_super_prefix_or_empty(), path);
1622 argv_array_pushl(&cp.args, "read-tree", "-u", "--reset", NULL);
1623
1624 argv_array_push(&cp.args, empty_tree_oid_hex());
1625
1626 if (run_command(&cp))
1627 die("could not reset submodule index");
1628}
1629
1630/**
1631 * Moves a submodule at a given path from a given head to another new head.
1632 * For edge cases (a submodule coming into existence or removing a submodule)
1633 * pass NULL for old or new respectively.
1634 */
1635int submodule_move_head(const char *path,
1636 const char *old_head,
1637 const char *new_head,
1638 unsigned flags)
1639{
1640 int ret = 0;
1641 struct child_process cp = CHILD_PROCESS_INIT;
1642 const struct submodule *sub;
1643 int *error_code_ptr, error_code;
1644
1645 if (!is_submodule_active(the_repository, path))
1646 return 0;
1647
1648 if (flags & SUBMODULE_MOVE_HEAD_FORCE)
1649 /*
1650 * Pass non NULL pointer to is_submodule_populated_gently
1651 * to prevent die()-ing. We'll use connect_work_tree_and_git_dir
1652 * to fixup the submodule in the force case later.
1653 */
1654 error_code_ptr = &error_code;
1655 else
1656 error_code_ptr = NULL;
1657
1658 if (old_head && !is_submodule_populated_gently(path, error_code_ptr))
1659 return 0;
1660
1661 sub = submodule_from_path(the_repository, &null_oid, path);
1662
1663 if (!sub)
1664 BUG("could not get submodule information for '%s'", path);
1665
1666 if (old_head && !(flags & SUBMODULE_MOVE_HEAD_FORCE)) {
1667 /* Check if the submodule has a dirty index. */
1668 if (submodule_has_dirty_index(sub))
1669 return error(_("submodule '%s' has dirty index"), path);
1670 }
1671
1672 if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
1673 if (old_head) {
1674 if (!submodule_uses_gitfile(path))
1675 absorb_git_dir_into_superproject("", path,
1676 ABSORB_GITDIR_RECURSE_SUBMODULES);
1677 } else {
1678 char *gitdir = xstrfmt("%s/modules/%s",
1679 get_git_common_dir(), sub->name);
1680 connect_work_tree_and_git_dir(path, gitdir, 0);
1681 free(gitdir);
1682
1683 /* make sure the index is clean as well */
1684 submodule_reset_index(path);
1685 }
1686
1687 if (old_head && (flags & SUBMODULE_MOVE_HEAD_FORCE)) {
1688 char *gitdir = xstrfmt("%s/modules/%s",
1689 get_git_common_dir(), sub->name);
1690 connect_work_tree_and_git_dir(path, gitdir, 1);
1691 free(gitdir);
1692 }
1693 }
1694
1695 prepare_submodule_repo_env(&cp.env_array);
1696
1697 cp.git_cmd = 1;
1698 cp.no_stdin = 1;
1699 cp.dir = path;
1700
1701 argv_array_pushf(&cp.args, "--super-prefix=%s%s/",
1702 get_super_prefix_or_empty(), path);
1703 argv_array_pushl(&cp.args, "read-tree", "--recurse-submodules", NULL);
1704
1705 if (flags & SUBMODULE_MOVE_HEAD_DRY_RUN)
1706 argv_array_push(&cp.args, "-n");
1707 else
1708 argv_array_push(&cp.args, "-u");
1709
1710 if (flags & SUBMODULE_MOVE_HEAD_FORCE)
1711 argv_array_push(&cp.args, "--reset");
1712 else
1713 argv_array_push(&cp.args, "-m");
1714
1715 if (!(flags & SUBMODULE_MOVE_HEAD_FORCE))
1716 argv_array_push(&cp.args, old_head ? old_head : empty_tree_oid_hex());
1717
1718 argv_array_push(&cp.args, new_head ? new_head : empty_tree_oid_hex());
1719
1720 if (run_command(&cp)) {
1721 ret = error(_("Submodule '%s' could not be updated."), path);
1722 goto out;
1723 }
1724
1725 if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
1726 if (new_head) {
1727 child_process_init(&cp);
1728 /* also set the HEAD accordingly */
1729 cp.git_cmd = 1;
1730 cp.no_stdin = 1;
1731 cp.dir = path;
1732
1733 prepare_submodule_repo_env(&cp.env_array);
1734 argv_array_pushl(&cp.args, "update-ref", "HEAD",
1735 "--no-deref", new_head, NULL);
1736
1737 if (run_command(&cp)) {
1738 ret = -1;
1739 goto out;
1740 }
1741 } else {
1742 struct strbuf sb = STRBUF_INIT;
1743
1744 strbuf_addf(&sb, "%s/.git", path);
1745 unlink_or_warn(sb.buf);
1746 strbuf_release(&sb);
1747
1748 if (is_empty_dir(path))
1749 rmdir_or_warn(path);
1750 }
1751 }
1752out:
1753 return ret;
1754}
1755
1756/*
1757 * Embeds a single submodules git directory into the superprojects git dir,
1758 * non recursively.
1759 */
1760static void relocate_single_git_dir_into_superproject(const char *prefix,
1761 const char *path)
1762{
1763 char *old_git_dir = NULL, *real_old_git_dir = NULL, *real_new_git_dir = NULL;
1764 const char *new_git_dir;
1765 const struct submodule *sub;
1766
1767 if (submodule_uses_worktrees(path))
1768 die(_("relocate_gitdir for submodule '%s' with "
1769 "more than one worktree not supported"), path);
1770
1771 old_git_dir = xstrfmt("%s/.git", path);
1772 if (read_gitfile(old_git_dir))
1773 /* If it is an actual gitfile, it doesn't need migration. */
1774 return;
1775
1776 real_old_git_dir = real_pathdup(old_git_dir, 1);
1777
1778 sub = submodule_from_path(the_repository, &null_oid, path);
1779 if (!sub)
1780 die(_("could not lookup name for submodule '%s'"), path);
1781
1782 new_git_dir = git_path("modules/%s", sub->name);
1783 if (safe_create_leading_directories_const(new_git_dir) < 0)
1784 die(_("could not create directory '%s'"), new_git_dir);
1785 real_new_git_dir = real_pathdup(new_git_dir, 1);
1786
1787 fprintf(stderr, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
1788 get_super_prefix_or_empty(), path,
1789 real_old_git_dir, real_new_git_dir);
1790
1791 relocate_gitdir(path, real_old_git_dir, real_new_git_dir);
1792
1793 free(old_git_dir);
1794 free(real_old_git_dir);
1795 free(real_new_git_dir);
1796}
1797
1798/*
1799 * Migrate the git directory of the submodule given by path from
1800 * having its git directory within the working tree to the git dir nested
1801 * in its superprojects git dir under modules/.
1802 */
1803void absorb_git_dir_into_superproject(const char *prefix,
1804 const char *path,
1805 unsigned flags)
1806{
1807 int err_code;
1808 const char *sub_git_dir;
1809 struct strbuf gitdir = STRBUF_INIT;
1810 strbuf_addf(&gitdir, "%s/.git", path);
1811 sub_git_dir = resolve_gitdir_gently(gitdir.buf, &err_code);
1812
1813 /* Not populated? */
1814 if (!sub_git_dir) {
1815 const struct submodule *sub;
1816
1817 if (err_code == READ_GITFILE_ERR_STAT_FAILED) {
1818 /* unpopulated as expected */
1819 strbuf_release(&gitdir);
1820 return;
1821 }
1822
1823 if (err_code != READ_GITFILE_ERR_NOT_A_REPO)
1824 /* We don't know what broke here. */
1825 read_gitfile_error_die(err_code, path, NULL);
1826
1827 /*
1828 * Maybe populated, but no git directory was found?
1829 * This can happen if the superproject is a submodule
1830 * itself and was just absorbed. The absorption of the
1831 * superproject did not rewrite the git file links yet,
1832 * fix it now.
1833 */
1834 sub = submodule_from_path(the_repository, &null_oid, path);
1835 if (!sub)
1836 die(_("could not lookup name for submodule '%s'"), path);
1837 connect_work_tree_and_git_dir(path,
1838 git_path("modules/%s", sub->name), 0);
1839 } else {
1840 /* Is it already absorbed into the superprojects git dir? */
1841 char *real_sub_git_dir = real_pathdup(sub_git_dir, 1);
1842 char *real_common_git_dir = real_pathdup(get_git_common_dir(), 1);
1843
1844 if (!starts_with(real_sub_git_dir, real_common_git_dir))
1845 relocate_single_git_dir_into_superproject(prefix, path);
1846
1847 free(real_sub_git_dir);
1848 free(real_common_git_dir);
1849 }
1850 strbuf_release(&gitdir);
1851
1852 if (flags & ABSORB_GITDIR_RECURSE_SUBMODULES) {
1853 struct child_process cp = CHILD_PROCESS_INIT;
1854 struct strbuf sb = STRBUF_INIT;
1855
1856 if (flags & ~ABSORB_GITDIR_RECURSE_SUBMODULES)
1857 BUG("we don't know how to pass the flags down?");
1858
1859 strbuf_addstr(&sb, get_super_prefix_or_empty());
1860 strbuf_addstr(&sb, path);
1861 strbuf_addch(&sb, '/');
1862
1863 cp.dir = path;
1864 cp.git_cmd = 1;
1865 cp.no_stdin = 1;
1866 argv_array_pushl(&cp.args, "--super-prefix", sb.buf,
1867 "submodule--helper",
1868 "absorb-git-dirs", NULL);
1869 prepare_submodule_repo_env(&cp.env_array);
1870 if (run_command(&cp))
1871 die(_("could not recurse into submodule '%s'"), path);
1872
1873 strbuf_release(&sb);
1874 }
1875}
1876
1877const char *get_superproject_working_tree(void)
1878{
1879 struct child_process cp = CHILD_PROCESS_INIT;
1880 struct strbuf sb = STRBUF_INIT;
1881 const char *one_up = real_path_if_valid("../");
1882 const char *cwd = xgetcwd();
1883 const char *ret = NULL;
1884 const char *subpath;
1885 int code;
1886 ssize_t len;
1887
1888 if (!is_inside_work_tree())
1889 /*
1890 * FIXME:
1891 * We might have a superproject, but it is harder
1892 * to determine.
1893 */
1894 return NULL;
1895
1896 if (!one_up)
1897 return NULL;
1898
1899 subpath = relative_path(cwd, one_up, &sb);
1900
1901 prepare_submodule_repo_env(&cp.env_array);
1902 argv_array_pop(&cp.env_array);
1903
1904 argv_array_pushl(&cp.args, "--literal-pathspecs", "-C", "..",
1905 "ls-files", "-z", "--stage", "--full-name", "--",
1906 subpath, NULL);
1907 strbuf_reset(&sb);
1908
1909 cp.no_stdin = 1;
1910 cp.no_stderr = 1;
1911 cp.out = -1;
1912 cp.git_cmd = 1;
1913
1914 if (start_command(&cp))
1915 die(_("could not start ls-files in .."));
1916
1917 len = strbuf_read(&sb, cp.out, PATH_MAX);
1918 close(cp.out);
1919
1920 if (starts_with(sb.buf, "160000")) {
1921 int super_sub_len;
1922 int cwd_len = strlen(cwd);
1923 char *super_sub, *super_wt;
1924
1925 /*
1926 * There is a superproject having this repo as a submodule.
1927 * The format is <mode> SP <hash> SP <stage> TAB <full name> \0,
1928 * We're only interested in the name after the tab.
1929 */
1930 super_sub = strchr(sb.buf, '\t') + 1;
1931 super_sub_len = strlen(super_sub);
1932
1933 if (super_sub_len > cwd_len ||
1934 strcmp(&cwd[cwd_len - super_sub_len], super_sub))
1935 BUG("returned path string doesn't match cwd?");
1936
1937 super_wt = xstrdup(cwd);
1938 super_wt[cwd_len - super_sub_len] = '\0';
1939
1940 ret = real_path(super_wt);
1941 free(super_wt);
1942 }
1943 strbuf_release(&sb);
1944
1945 code = finish_command(&cp);
1946
1947 if (code == 128)
1948 /* '../' is not a git repository */
1949 return NULL;
1950 if (code == 0 && len == 0)
1951 /* There is an unrelated git repository at '../' */
1952 return NULL;
1953 if (code)
1954 die(_("ls-tree returned unexpected return code %d"), code);
1955
1956 return ret;
1957}
1958
1959/*
1960 * Put the gitdir for a submodule (given relative to the main
1961 * repository worktree) into `buf`, or return -1 on error.
1962 */
1963int submodule_to_gitdir(struct strbuf *buf, const char *submodule)
1964{
1965 const struct submodule *sub;
1966 const char *git_dir;
1967 int ret = 0;
1968
1969 strbuf_reset(buf);
1970 strbuf_addstr(buf, submodule);
1971 strbuf_complete(buf, '/');
1972 strbuf_addstr(buf, ".git");
1973
1974 git_dir = read_gitfile(buf->buf);
1975 if (git_dir) {
1976 strbuf_reset(buf);
1977 strbuf_addstr(buf, git_dir);
1978 }
1979 if (!is_git_directory(buf->buf)) {
1980 sub = submodule_from_path(the_repository, &null_oid, submodule);
1981 if (!sub) {
1982 ret = -1;
1983 goto cleanup;
1984 }
1985 strbuf_reset(buf);
1986 strbuf_git_path(buf, "%s/%s", "modules", sub->name);
1987 }
1988
1989cleanup:
1990 return ret;
1991}