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