Merge branch 'jk/submodule-c-credential'
[git.git] / submodule.c
blob90825e17fab5872d2e4c94a3cab84c696eb69248
1 #include "cache.h"
2 #include "submodule-config.h"
3 #include "submodule.h"
4 #include "dir.h"
5 #include "diff.h"
6 #include "commit.h"
7 #include "revision.h"
8 #include "run-command.h"
9 #include "diffcore.h"
10 #include "refs.h"
11 #include "string-list.h"
12 #include "sha1-array.h"
13 #include "argv-array.h"
14 #include "blob.h"
15 #include "thread-utils.h"
17 static int config_fetch_recurse_submodules = RECURSE_SUBMODULES_ON_DEMAND;
18 static int parallel_jobs = 1;
19 static struct string_list changed_submodule_paths;
20 static int initialized_fetch_ref_tips;
21 static struct sha1_array ref_tips_before_fetch;
22 static struct sha1_array ref_tips_after_fetch;
25 * The following flag is set if the .gitmodules file is unmerged. We then
26 * disable recursion for all submodules where .git/config doesn't have a
27 * matching config entry because we can't guess what might be configured in
28 * .gitmodules unless the user resolves the conflict. When a command line
29 * option is given (which always overrides configuration) this flag will be
30 * ignored.
32 static int gitmodules_is_unmerged;
35 * This flag is set if the .gitmodules file had unstaged modifications on
36 * startup. This must be checked before allowing modifications to the
37 * .gitmodules file with the intention to stage them later, because when
38 * continuing we would stage the modifications the user didn't stage herself
39 * too. That might change in a future version when we learn to stage the
40 * changes we do ourselves without staging any previous modifications.
42 static int gitmodules_is_modified;
44 int is_staging_gitmodules_ok(void)
46 return !gitmodules_is_modified;
50 * Try to update the "path" entry in the "submodule.<name>" section of the
51 * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
52 * with the correct path=<oldpath> setting was found and we could update it.
54 int update_path_in_gitmodules(const char *oldpath, const char *newpath)
56 struct strbuf entry = STRBUF_INIT;
57 const struct submodule *submodule;
59 if (!file_exists(".gitmodules")) /* Do nothing without .gitmodules */
60 return -1;
62 if (gitmodules_is_unmerged)
63 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
65 submodule = submodule_from_path(null_sha1, oldpath);
66 if (!submodule || !submodule->name) {
67 warning(_("Could not find section in .gitmodules where path=%s"), oldpath);
68 return -1;
70 strbuf_addstr(&entry, "submodule.");
71 strbuf_addstr(&entry, submodule->name);
72 strbuf_addstr(&entry, ".path");
73 if (git_config_set_in_file_gently(".gitmodules", entry.buf, newpath) < 0) {
74 /* Maybe the user already did that, don't error out here */
75 warning(_("Could not update .gitmodules entry %s"), entry.buf);
76 strbuf_release(&entry);
77 return -1;
79 strbuf_release(&entry);
80 return 0;
84 * Try to remove the "submodule.<name>" section from .gitmodules where the given
85 * path is configured. Return 0 only if a .gitmodules file was found, a section
86 * with the correct path=<path> setting was found and we could remove it.
88 int remove_path_from_gitmodules(const char *path)
90 struct strbuf sect = STRBUF_INIT;
91 const struct submodule *submodule;
93 if (!file_exists(".gitmodules")) /* Do nothing without .gitmodules */
94 return -1;
96 if (gitmodules_is_unmerged)
97 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
99 submodule = submodule_from_path(null_sha1, path);
100 if (!submodule || !submodule->name) {
101 warning(_("Could not find section in .gitmodules where path=%s"), path);
102 return -1;
104 strbuf_addstr(&sect, "submodule.");
105 strbuf_addstr(&sect, submodule->name);
106 if (git_config_rename_section_in_file(".gitmodules", sect.buf, NULL) < 0) {
107 /* Maybe the user already did that, don't error out here */
108 warning(_("Could not remove .gitmodules entry for %s"), path);
109 strbuf_release(&sect);
110 return -1;
112 strbuf_release(&sect);
113 return 0;
116 void stage_updated_gitmodules(void)
118 if (add_file_to_cache(".gitmodules", 0))
119 die(_("staging updated .gitmodules failed"));
122 static int add_submodule_odb(const char *path)
124 struct strbuf objects_directory = STRBUF_INIT;
125 struct alternate_object_database *alt_odb;
126 int ret = 0;
127 size_t alloc;
129 strbuf_git_path_submodule(&objects_directory, path, "objects/");
130 if (!is_directory(objects_directory.buf)) {
131 ret = -1;
132 goto done;
134 /* avoid adding it twice */
135 prepare_alt_odb();
136 for (alt_odb = alt_odb_list; alt_odb; alt_odb = alt_odb->next)
137 if (alt_odb->name - alt_odb->base == objects_directory.len &&
138 !strncmp(alt_odb->base, objects_directory.buf,
139 objects_directory.len))
140 goto done;
142 alloc = st_add(objects_directory.len, 42); /* for "12/345..." sha1 */
143 alt_odb = xmalloc(st_add(sizeof(*alt_odb), alloc));
144 alt_odb->next = alt_odb_list;
145 xsnprintf(alt_odb->base, alloc, "%s", objects_directory.buf);
146 alt_odb->name = alt_odb->base + objects_directory.len;
147 alt_odb->name[2] = '/';
148 alt_odb->name[40] = '\0';
149 alt_odb->name[41] = '\0';
150 alt_odb_list = alt_odb;
152 /* add possible alternates from the submodule */
153 read_info_alternates(objects_directory.buf, 0);
154 done:
155 strbuf_release(&objects_directory);
156 return ret;
159 void set_diffopt_flags_from_submodule_config(struct diff_options *diffopt,
160 const char *path)
162 const struct submodule *submodule = submodule_from_path(null_sha1, path);
163 if (submodule) {
164 if (submodule->ignore)
165 handle_ignore_submodules_arg(diffopt, submodule->ignore);
166 else if (gitmodules_is_unmerged)
167 DIFF_OPT_SET(diffopt, IGNORE_SUBMODULES);
171 int submodule_config(const char *var, const char *value, void *cb)
173 if (!strcmp(var, "submodule.fetchjobs")) {
174 parallel_jobs = git_config_int(var, value);
175 if (parallel_jobs < 0)
176 die(_("negative values not allowed for submodule.fetchJobs"));
177 return 0;
178 } else if (starts_with(var, "submodule."))
179 return parse_submodule_config_option(var, value);
180 else if (!strcmp(var, "fetch.recursesubmodules")) {
181 config_fetch_recurse_submodules = parse_fetch_recurse_submodules_arg(var, value);
182 return 0;
184 return 0;
187 void gitmodules_config(void)
189 const char *work_tree = get_git_work_tree();
190 if (work_tree) {
191 struct strbuf gitmodules_path = STRBUF_INIT;
192 int pos;
193 strbuf_addstr(&gitmodules_path, work_tree);
194 strbuf_addstr(&gitmodules_path, "/.gitmodules");
195 if (read_cache() < 0)
196 die("index file corrupt");
197 pos = cache_name_pos(".gitmodules", 11);
198 if (pos < 0) { /* .gitmodules not found or isn't merged */
199 pos = -1 - pos;
200 if (active_nr > pos) { /* there is a .gitmodules */
201 const struct cache_entry *ce = active_cache[pos];
202 if (ce_namelen(ce) == 11 &&
203 !memcmp(ce->name, ".gitmodules", 11))
204 gitmodules_is_unmerged = 1;
206 } else if (pos < active_nr) {
207 struct stat st;
208 if (lstat(".gitmodules", &st) == 0 &&
209 ce_match_stat(active_cache[pos], &st, 0) & DATA_CHANGED)
210 gitmodules_is_modified = 1;
213 if (!gitmodules_is_unmerged)
214 git_config_from_file(submodule_config, gitmodules_path.buf, NULL);
215 strbuf_release(&gitmodules_path);
219 int parse_submodule_update_strategy(const char *value,
220 struct submodule_update_strategy *dst)
222 free((void*)dst->command);
223 dst->command = NULL;
224 if (!strcmp(value, "none"))
225 dst->type = SM_UPDATE_NONE;
226 else if (!strcmp(value, "checkout"))
227 dst->type = SM_UPDATE_CHECKOUT;
228 else if (!strcmp(value, "rebase"))
229 dst->type = SM_UPDATE_REBASE;
230 else if (!strcmp(value, "merge"))
231 dst->type = SM_UPDATE_MERGE;
232 else if (skip_prefix(value, "!", &value)) {
233 dst->type = SM_UPDATE_COMMAND;
234 dst->command = xstrdup(value);
235 } else
236 return -1;
237 return 0;
240 void handle_ignore_submodules_arg(struct diff_options *diffopt,
241 const char *arg)
243 DIFF_OPT_CLR(diffopt, IGNORE_SUBMODULES);
244 DIFF_OPT_CLR(diffopt, IGNORE_UNTRACKED_IN_SUBMODULES);
245 DIFF_OPT_CLR(diffopt, IGNORE_DIRTY_SUBMODULES);
247 if (!strcmp(arg, "all"))
248 DIFF_OPT_SET(diffopt, IGNORE_SUBMODULES);
249 else if (!strcmp(arg, "untracked"))
250 DIFF_OPT_SET(diffopt, IGNORE_UNTRACKED_IN_SUBMODULES);
251 else if (!strcmp(arg, "dirty"))
252 DIFF_OPT_SET(diffopt, IGNORE_DIRTY_SUBMODULES);
253 else if (strcmp(arg, "none"))
254 die("bad --ignore-submodules argument: %s", arg);
257 static int prepare_submodule_summary(struct rev_info *rev, const char *path,
258 struct commit *left, struct commit *right,
259 int *fast_forward, int *fast_backward)
261 struct commit_list *merge_bases, *list;
263 init_revisions(rev, NULL);
264 setup_revisions(0, NULL, rev, NULL);
265 rev->left_right = 1;
266 rev->first_parent_only = 1;
267 left->object.flags |= SYMMETRIC_LEFT;
268 add_pending_object(rev, &left->object, path);
269 add_pending_object(rev, &right->object, path);
270 merge_bases = get_merge_bases(left, right);
271 if (merge_bases) {
272 if (merge_bases->item == left)
273 *fast_forward = 1;
274 else if (merge_bases->item == right)
275 *fast_backward = 1;
277 for (list = merge_bases; list; list = list->next) {
278 list->item->object.flags |= UNINTERESTING;
279 add_pending_object(rev, &list->item->object,
280 oid_to_hex(&list->item->object.oid));
282 return prepare_revision_walk(rev);
285 static void print_submodule_summary(struct rev_info *rev, FILE *f,
286 const char *line_prefix,
287 const char *del, const char *add, const char *reset)
289 static const char format[] = " %m %s";
290 struct strbuf sb = STRBUF_INIT;
291 struct commit *commit;
293 while ((commit = get_revision(rev))) {
294 struct pretty_print_context ctx = {0};
295 ctx.date_mode = rev->date_mode;
296 ctx.output_encoding = get_log_output_encoding();
297 strbuf_setlen(&sb, 0);
298 strbuf_addstr(&sb, line_prefix);
299 if (commit->object.flags & SYMMETRIC_LEFT) {
300 if (del)
301 strbuf_addstr(&sb, del);
303 else if (add)
304 strbuf_addstr(&sb, add);
305 format_commit_message(commit, format, &sb, &ctx);
306 if (reset)
307 strbuf_addstr(&sb, reset);
308 strbuf_addch(&sb, '\n');
309 fprintf(f, "%s", sb.buf);
311 strbuf_release(&sb);
314 void show_submodule_summary(FILE *f, const char *path,
315 const char *line_prefix,
316 unsigned char one[20], unsigned char two[20],
317 unsigned dirty_submodule, const char *meta,
318 const char *del, const char *add, const char *reset)
320 struct rev_info rev;
321 struct commit *left = NULL, *right = NULL;
322 const char *message = NULL;
323 struct strbuf sb = STRBUF_INIT;
324 int fast_forward = 0, fast_backward = 0;
326 if (is_null_sha1(two))
327 message = "(submodule deleted)";
328 else if (add_submodule_odb(path))
329 message = "(not checked out)";
330 else if (is_null_sha1(one))
331 message = "(new submodule)";
332 else if (!(left = lookup_commit_reference(one)) ||
333 !(right = lookup_commit_reference(two)))
334 message = "(commits not present)";
335 else if (prepare_submodule_summary(&rev, path, left, right,
336 &fast_forward, &fast_backward))
337 message = "(revision walker failed)";
339 if (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED)
340 fprintf(f, "%sSubmodule %s contains untracked content\n",
341 line_prefix, path);
342 if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
343 fprintf(f, "%sSubmodule %s contains modified content\n",
344 line_prefix, path);
346 if (!hashcmp(one, two)) {
347 strbuf_release(&sb);
348 return;
351 strbuf_addf(&sb, "%s%sSubmodule %s %s..", line_prefix, meta, path,
352 find_unique_abbrev(one, DEFAULT_ABBREV));
353 if (!fast_backward && !fast_forward)
354 strbuf_addch(&sb, '.');
355 strbuf_addf(&sb, "%s", find_unique_abbrev(two, DEFAULT_ABBREV));
356 if (message)
357 strbuf_addf(&sb, " %s%s\n", message, reset);
358 else
359 strbuf_addf(&sb, "%s:%s\n", fast_backward ? " (rewind)" : "", reset);
360 fwrite(sb.buf, sb.len, 1, f);
362 if (!message) /* only NULL if we succeeded in setting up the walk */
363 print_submodule_summary(&rev, f, line_prefix, del, add, reset);
364 if (left)
365 clear_commit_marks(left, ~0);
366 if (right)
367 clear_commit_marks(right, ~0);
369 strbuf_release(&sb);
372 void set_config_fetch_recurse_submodules(int value)
374 config_fetch_recurse_submodules = value;
377 static int has_remote(const char *refname, const struct object_id *oid,
378 int flags, void *cb_data)
380 return 1;
383 static int submodule_needs_pushing(const char *path, const unsigned char sha1[20])
385 if (add_submodule_odb(path) || !lookup_commit_reference(sha1))
386 return 0;
388 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
389 struct child_process cp = CHILD_PROCESS_INIT;
390 const char *argv[] = {"rev-list", NULL, "--not", "--remotes", "-n", "1" , NULL};
391 struct strbuf buf = STRBUF_INIT;
392 int needs_pushing = 0;
394 argv[1] = sha1_to_hex(sha1);
395 cp.argv = argv;
396 cp.env = local_repo_env;
397 cp.git_cmd = 1;
398 cp.no_stdin = 1;
399 cp.out = -1;
400 cp.dir = path;
401 if (start_command(&cp))
402 die("Could not run 'git rev-list %s --not --remotes -n 1' command in submodule %s",
403 sha1_to_hex(sha1), path);
404 if (strbuf_read(&buf, cp.out, 41))
405 needs_pushing = 1;
406 finish_command(&cp);
407 close(cp.out);
408 strbuf_release(&buf);
409 return needs_pushing;
412 return 0;
415 static void collect_submodules_from_diff(struct diff_queue_struct *q,
416 struct diff_options *options,
417 void *data)
419 int i;
420 struct string_list *needs_pushing = data;
422 for (i = 0; i < q->nr; i++) {
423 struct diff_filepair *p = q->queue[i];
424 if (!S_ISGITLINK(p->two->mode))
425 continue;
426 if (submodule_needs_pushing(p->two->path, p->two->sha1))
427 string_list_insert(needs_pushing, p->two->path);
431 static void find_unpushed_submodule_commits(struct commit *commit,
432 struct string_list *needs_pushing)
434 struct rev_info rev;
436 init_revisions(&rev, NULL);
437 rev.diffopt.output_format |= DIFF_FORMAT_CALLBACK;
438 rev.diffopt.format_callback = collect_submodules_from_diff;
439 rev.diffopt.format_callback_data = needs_pushing;
440 diff_tree_combined_merge(commit, 1, &rev);
443 int find_unpushed_submodules(unsigned char new_sha1[20],
444 const char *remotes_name, struct string_list *needs_pushing)
446 struct rev_info rev;
447 struct commit *commit;
448 const char *argv[] = {NULL, NULL, "--not", "NULL", NULL};
449 int argc = ARRAY_SIZE(argv) - 1;
450 char *sha1_copy;
452 struct strbuf remotes_arg = STRBUF_INIT;
454 strbuf_addf(&remotes_arg, "--remotes=%s", remotes_name);
455 init_revisions(&rev, NULL);
456 sha1_copy = xstrdup(sha1_to_hex(new_sha1));
457 argv[1] = sha1_copy;
458 argv[3] = remotes_arg.buf;
459 setup_revisions(argc, argv, &rev, NULL);
460 if (prepare_revision_walk(&rev))
461 die("revision walk setup failed");
463 while ((commit = get_revision(&rev)) != NULL)
464 find_unpushed_submodule_commits(commit, needs_pushing);
466 reset_revision_walk();
467 free(sha1_copy);
468 strbuf_release(&remotes_arg);
470 return needs_pushing->nr;
473 static int push_submodule(const char *path)
475 if (add_submodule_odb(path))
476 return 1;
478 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
479 struct child_process cp = CHILD_PROCESS_INIT;
480 const char *argv[] = {"push", NULL};
482 cp.argv = argv;
483 cp.env = local_repo_env;
484 cp.git_cmd = 1;
485 cp.no_stdin = 1;
486 cp.dir = path;
487 if (run_command(&cp))
488 return 0;
489 close(cp.out);
492 return 1;
495 int push_unpushed_submodules(unsigned char new_sha1[20], const char *remotes_name)
497 int i, ret = 1;
498 struct string_list needs_pushing = STRING_LIST_INIT_DUP;
500 if (!find_unpushed_submodules(new_sha1, remotes_name, &needs_pushing))
501 return 1;
503 for (i = 0; i < needs_pushing.nr; i++) {
504 const char *path = needs_pushing.items[i].string;
505 fprintf(stderr, "Pushing submodule '%s'\n", path);
506 if (!push_submodule(path)) {
507 fprintf(stderr, "Unable to push submodule '%s'\n", path);
508 ret = 0;
512 string_list_clear(&needs_pushing, 0);
514 return ret;
517 static int is_submodule_commit_present(const char *path, unsigned char sha1[20])
519 int is_present = 0;
520 if (!add_submodule_odb(path) && lookup_commit_reference(sha1)) {
521 /* Even if the submodule is checked out and the commit is
522 * present, make sure it is reachable from a ref. */
523 struct child_process cp = CHILD_PROCESS_INIT;
524 const char *argv[] = {"rev-list", "-n", "1", NULL, "--not", "--all", NULL};
525 struct strbuf buf = STRBUF_INIT;
527 argv[3] = sha1_to_hex(sha1);
528 cp.argv = argv;
529 cp.env = local_repo_env;
530 cp.git_cmd = 1;
531 cp.no_stdin = 1;
532 cp.dir = path;
533 if (!capture_command(&cp, &buf, 1024) && !buf.len)
534 is_present = 1;
536 strbuf_release(&buf);
538 return is_present;
541 static void submodule_collect_changed_cb(struct diff_queue_struct *q,
542 struct diff_options *options,
543 void *data)
545 int i;
546 for (i = 0; i < q->nr; i++) {
547 struct diff_filepair *p = q->queue[i];
548 if (!S_ISGITLINK(p->two->mode))
549 continue;
551 if (S_ISGITLINK(p->one->mode)) {
552 /* NEEDSWORK: We should honor the name configured in
553 * the .gitmodules file of the commit we are examining
554 * here to be able to correctly follow submodules
555 * being moved around. */
556 struct string_list_item *path;
557 path = unsorted_string_list_lookup(&changed_submodule_paths, p->two->path);
558 if (!path && !is_submodule_commit_present(p->two->path, p->two->sha1))
559 string_list_append(&changed_submodule_paths, xstrdup(p->two->path));
560 } else {
561 /* Submodule is new or was moved here */
562 /* NEEDSWORK: When the .git directories of submodules
563 * live inside the superprojects .git directory some
564 * day we should fetch new submodules directly into
565 * that location too when config or options request
566 * that so they can be checked out from there. */
567 continue;
572 static int add_sha1_to_array(const char *ref, const struct object_id *oid,
573 int flags, void *data)
575 sha1_array_append(data, oid->hash);
576 return 0;
579 void check_for_new_submodule_commits(unsigned char new_sha1[20])
581 if (!initialized_fetch_ref_tips) {
582 for_each_ref(add_sha1_to_array, &ref_tips_before_fetch);
583 initialized_fetch_ref_tips = 1;
586 sha1_array_append(&ref_tips_after_fetch, new_sha1);
589 static void add_sha1_to_argv(const unsigned char sha1[20], void *data)
591 argv_array_push(data, sha1_to_hex(sha1));
594 static void calculate_changed_submodule_paths(void)
596 struct rev_info rev;
597 struct commit *commit;
598 struct argv_array argv = ARGV_ARRAY_INIT;
600 /* No need to check if there are no submodules configured */
601 if (!submodule_from_path(NULL, NULL))
602 return;
604 init_revisions(&rev, NULL);
605 argv_array_push(&argv, "--"); /* argv[0] program name */
606 sha1_array_for_each_unique(&ref_tips_after_fetch,
607 add_sha1_to_argv, &argv);
608 argv_array_push(&argv, "--not");
609 sha1_array_for_each_unique(&ref_tips_before_fetch,
610 add_sha1_to_argv, &argv);
611 setup_revisions(argv.argc, argv.argv, &rev, NULL);
612 if (prepare_revision_walk(&rev))
613 die("revision walk setup failed");
616 * Collect all submodules (whether checked out or not) for which new
617 * commits have been recorded upstream in "changed_submodule_paths".
619 while ((commit = get_revision(&rev))) {
620 struct commit_list *parent = commit->parents;
621 while (parent) {
622 struct diff_options diff_opts;
623 diff_setup(&diff_opts);
624 DIFF_OPT_SET(&diff_opts, RECURSIVE);
625 diff_opts.output_format |= DIFF_FORMAT_CALLBACK;
626 diff_opts.format_callback = submodule_collect_changed_cb;
627 diff_setup_done(&diff_opts);
628 diff_tree_sha1(parent->item->object.oid.hash, commit->object.oid.hash, "", &diff_opts);
629 diffcore_std(&diff_opts);
630 diff_flush(&diff_opts);
631 parent = parent->next;
635 argv_array_clear(&argv);
636 sha1_array_clear(&ref_tips_before_fetch);
637 sha1_array_clear(&ref_tips_after_fetch);
638 initialized_fetch_ref_tips = 0;
641 struct submodule_parallel_fetch {
642 int count;
643 struct argv_array args;
644 const char *work_tree;
645 const char *prefix;
646 int command_line_option;
647 int quiet;
648 int result;
650 #define SPF_INIT {0, ARGV_ARRAY_INIT, NULL, NULL, 0, 0, 0}
652 static int get_next_submodule(struct child_process *cp,
653 struct strbuf *err, void *data, void **task_cb)
655 int ret = 0;
656 struct submodule_parallel_fetch *spf = data;
658 for (; spf->count < active_nr; spf->count++) {
659 struct strbuf submodule_path = STRBUF_INIT;
660 struct strbuf submodule_git_dir = STRBUF_INIT;
661 struct strbuf submodule_prefix = STRBUF_INIT;
662 const struct cache_entry *ce = active_cache[spf->count];
663 const char *git_dir, *default_argv;
664 const struct submodule *submodule;
666 if (!S_ISGITLINK(ce->ce_mode))
667 continue;
669 submodule = submodule_from_path(null_sha1, ce->name);
670 if (!submodule)
671 submodule = submodule_from_name(null_sha1, ce->name);
673 default_argv = "yes";
674 if (spf->command_line_option == RECURSE_SUBMODULES_DEFAULT) {
675 if (submodule &&
676 submodule->fetch_recurse !=
677 RECURSE_SUBMODULES_NONE) {
678 if (submodule->fetch_recurse ==
679 RECURSE_SUBMODULES_OFF)
680 continue;
681 if (submodule->fetch_recurse ==
682 RECURSE_SUBMODULES_ON_DEMAND) {
683 if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
684 continue;
685 default_argv = "on-demand";
687 } else {
688 if ((config_fetch_recurse_submodules == RECURSE_SUBMODULES_OFF) ||
689 gitmodules_is_unmerged)
690 continue;
691 if (config_fetch_recurse_submodules == RECURSE_SUBMODULES_ON_DEMAND) {
692 if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
693 continue;
694 default_argv = "on-demand";
697 } else if (spf->command_line_option == RECURSE_SUBMODULES_ON_DEMAND) {
698 if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
699 continue;
700 default_argv = "on-demand";
703 strbuf_addf(&submodule_path, "%s/%s", spf->work_tree, ce->name);
704 strbuf_addf(&submodule_git_dir, "%s/.git", submodule_path.buf);
705 strbuf_addf(&submodule_prefix, "%s%s/", spf->prefix, ce->name);
706 git_dir = read_gitfile(submodule_git_dir.buf);
707 if (!git_dir)
708 git_dir = submodule_git_dir.buf;
709 if (is_directory(git_dir)) {
710 child_process_init(cp);
711 cp->dir = strbuf_detach(&submodule_path, NULL);
712 cp->env = local_repo_env;
713 cp->git_cmd = 1;
714 if (!spf->quiet)
715 strbuf_addf(err, "Fetching submodule %s%s\n",
716 spf->prefix, ce->name);
717 argv_array_init(&cp->args);
718 argv_array_pushv(&cp->args, spf->args.argv);
719 argv_array_push(&cp->args, default_argv);
720 argv_array_push(&cp->args, "--submodule-prefix");
721 argv_array_push(&cp->args, submodule_prefix.buf);
722 ret = 1;
724 strbuf_release(&submodule_path);
725 strbuf_release(&submodule_git_dir);
726 strbuf_release(&submodule_prefix);
727 if (ret) {
728 spf->count++;
729 return 1;
732 return 0;
735 static int fetch_start_failure(struct strbuf *err,
736 void *cb, void *task_cb)
738 struct submodule_parallel_fetch *spf = cb;
740 spf->result = 1;
742 return 0;
745 static int fetch_finish(int retvalue, struct strbuf *err,
746 void *cb, void *task_cb)
748 struct submodule_parallel_fetch *spf = cb;
750 if (retvalue)
751 spf->result = 1;
753 return 0;
756 int fetch_populated_submodules(const struct argv_array *options,
757 const char *prefix, int command_line_option,
758 int quiet, int max_parallel_jobs)
760 int i;
761 struct submodule_parallel_fetch spf = SPF_INIT;
763 spf.work_tree = get_git_work_tree();
764 spf.command_line_option = command_line_option;
765 spf.quiet = quiet;
766 spf.prefix = prefix;
768 if (!spf.work_tree)
769 goto out;
771 if (read_cache() < 0)
772 die("index file corrupt");
774 argv_array_push(&spf.args, "fetch");
775 for (i = 0; i < options->argc; i++)
776 argv_array_push(&spf.args, options->argv[i]);
777 argv_array_push(&spf.args, "--recurse-submodules-default");
778 /* default value, "--submodule-prefix" and its value are added later */
780 if (max_parallel_jobs < 0)
781 max_parallel_jobs = parallel_jobs;
783 calculate_changed_submodule_paths();
784 run_processes_parallel(max_parallel_jobs,
785 get_next_submodule,
786 fetch_start_failure,
787 fetch_finish,
788 &spf);
790 argv_array_clear(&spf.args);
791 out:
792 string_list_clear(&changed_submodule_paths, 1);
793 return spf.result;
796 unsigned is_submodule_modified(const char *path, int ignore_untracked)
798 ssize_t len;
799 struct child_process cp = CHILD_PROCESS_INIT;
800 const char *argv[] = {
801 "status",
802 "--porcelain",
803 NULL,
804 NULL,
806 struct strbuf buf = STRBUF_INIT;
807 unsigned dirty_submodule = 0;
808 const char *line, *next_line;
809 const char *git_dir;
811 strbuf_addf(&buf, "%s/.git", path);
812 git_dir = read_gitfile(buf.buf);
813 if (!git_dir)
814 git_dir = buf.buf;
815 if (!is_directory(git_dir)) {
816 strbuf_release(&buf);
817 /* The submodule is not checked out, so it is not modified */
818 return 0;
821 strbuf_reset(&buf);
823 if (ignore_untracked)
824 argv[2] = "-uno";
826 cp.argv = argv;
827 cp.env = local_repo_env;
828 cp.git_cmd = 1;
829 cp.no_stdin = 1;
830 cp.out = -1;
831 cp.dir = path;
832 if (start_command(&cp))
833 die("Could not run 'git status --porcelain' in submodule %s", path);
835 len = strbuf_read(&buf, cp.out, 1024);
836 line = buf.buf;
837 while (len > 2) {
838 if ((line[0] == '?') && (line[1] == '?')) {
839 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
840 if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
841 break;
842 } else {
843 dirty_submodule |= DIRTY_SUBMODULE_MODIFIED;
844 if (ignore_untracked ||
845 (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED))
846 break;
848 next_line = strchr(line, '\n');
849 if (!next_line)
850 break;
851 next_line++;
852 len -= (next_line - line);
853 line = next_line;
855 close(cp.out);
857 if (finish_command(&cp))
858 die("'git status --porcelain' failed in submodule %s", path);
860 strbuf_release(&buf);
861 return dirty_submodule;
864 int submodule_uses_gitfile(const char *path)
866 struct child_process cp = CHILD_PROCESS_INIT;
867 const char *argv[] = {
868 "submodule",
869 "foreach",
870 "--quiet",
871 "--recursive",
872 "test -f .git",
873 NULL,
875 struct strbuf buf = STRBUF_INIT;
876 const char *git_dir;
878 strbuf_addf(&buf, "%s/.git", path);
879 git_dir = read_gitfile(buf.buf);
880 if (!git_dir) {
881 strbuf_release(&buf);
882 return 0;
884 strbuf_release(&buf);
886 /* Now test that all nested submodules use a gitfile too */
887 cp.argv = argv;
888 cp.env = local_repo_env;
889 cp.git_cmd = 1;
890 cp.no_stdin = 1;
891 cp.no_stderr = 1;
892 cp.no_stdout = 1;
893 cp.dir = path;
894 if (run_command(&cp))
895 return 0;
897 return 1;
900 int ok_to_remove_submodule(const char *path)
902 ssize_t len;
903 struct child_process cp = CHILD_PROCESS_INIT;
904 const char *argv[] = {
905 "status",
906 "--porcelain",
907 "-u",
908 "--ignore-submodules=none",
909 NULL,
911 struct strbuf buf = STRBUF_INIT;
912 int ok_to_remove = 1;
914 if (!file_exists(path) || is_empty_dir(path))
915 return 1;
917 if (!submodule_uses_gitfile(path))
918 return 0;
920 cp.argv = argv;
921 cp.env = local_repo_env;
922 cp.git_cmd = 1;
923 cp.no_stdin = 1;
924 cp.out = -1;
925 cp.dir = path;
926 if (start_command(&cp))
927 die("Could not run 'git status --porcelain -uall --ignore-submodules=none' in submodule %s", path);
929 len = strbuf_read(&buf, cp.out, 1024);
930 if (len > 2)
931 ok_to_remove = 0;
932 close(cp.out);
934 if (finish_command(&cp))
935 die("'git status --porcelain -uall --ignore-submodules=none' failed in submodule %s", path);
937 strbuf_release(&buf);
938 return ok_to_remove;
941 static int find_first_merges(struct object_array *result, const char *path,
942 struct commit *a, struct commit *b)
944 int i, j;
945 struct object_array merges = OBJECT_ARRAY_INIT;
946 struct commit *commit;
947 int contains_another;
949 char merged_revision[42];
950 const char *rev_args[] = { "rev-list", "--merges", "--ancestry-path",
951 "--all", merged_revision, NULL };
952 struct rev_info revs;
953 struct setup_revision_opt rev_opts;
955 memset(result, 0, sizeof(struct object_array));
956 memset(&rev_opts, 0, sizeof(rev_opts));
958 /* get all revisions that merge commit a */
959 snprintf(merged_revision, sizeof(merged_revision), "^%s",
960 oid_to_hex(&a->object.oid));
961 init_revisions(&revs, NULL);
962 rev_opts.submodule = path;
963 setup_revisions(ARRAY_SIZE(rev_args)-1, rev_args, &revs, &rev_opts);
965 /* save all revisions from the above list that contain b */
966 if (prepare_revision_walk(&revs))
967 die("revision walk setup failed");
968 while ((commit = get_revision(&revs)) != NULL) {
969 struct object *o = &(commit->object);
970 if (in_merge_bases(b, commit))
971 add_object_array(o, NULL, &merges);
973 reset_revision_walk();
975 /* Now we've got all merges that contain a and b. Prune all
976 * merges that contain another found merge and save them in
977 * result.
979 for (i = 0; i < merges.nr; i++) {
980 struct commit *m1 = (struct commit *) merges.objects[i].item;
982 contains_another = 0;
983 for (j = 0; j < merges.nr; j++) {
984 struct commit *m2 = (struct commit *) merges.objects[j].item;
985 if (i != j && in_merge_bases(m2, m1)) {
986 contains_another = 1;
987 break;
991 if (!contains_another)
992 add_object_array(merges.objects[i].item, NULL, result);
995 free(merges.objects);
996 return result->nr;
999 static void print_commit(struct commit *commit)
1001 struct strbuf sb = STRBUF_INIT;
1002 struct pretty_print_context ctx = {0};
1003 ctx.date_mode.type = DATE_NORMAL;
1004 format_commit_message(commit, " %h: %m %s", &sb, &ctx);
1005 fprintf(stderr, "%s\n", sb.buf);
1006 strbuf_release(&sb);
1009 #define MERGE_WARNING(path, msg) \
1010 warning("Failed to merge submodule %s (%s)", path, msg);
1012 int merge_submodule(unsigned char result[20], const char *path,
1013 const unsigned char base[20], const unsigned char a[20],
1014 const unsigned char b[20], int search)
1016 struct commit *commit_base, *commit_a, *commit_b;
1017 int parent_count;
1018 struct object_array merges;
1020 int i;
1022 /* store a in result in case we fail */
1023 hashcpy(result, a);
1025 /* we can not handle deletion conflicts */
1026 if (is_null_sha1(base))
1027 return 0;
1028 if (is_null_sha1(a))
1029 return 0;
1030 if (is_null_sha1(b))
1031 return 0;
1033 if (add_submodule_odb(path)) {
1034 MERGE_WARNING(path, "not checked out");
1035 return 0;
1038 if (!(commit_base = lookup_commit_reference(base)) ||
1039 !(commit_a = lookup_commit_reference(a)) ||
1040 !(commit_b = lookup_commit_reference(b))) {
1041 MERGE_WARNING(path, "commits not present");
1042 return 0;
1045 /* check whether both changes are forward */
1046 if (!in_merge_bases(commit_base, commit_a) ||
1047 !in_merge_bases(commit_base, commit_b)) {
1048 MERGE_WARNING(path, "commits don't follow merge-base");
1049 return 0;
1052 /* Case #1: a is contained in b or vice versa */
1053 if (in_merge_bases(commit_a, commit_b)) {
1054 hashcpy(result, b);
1055 return 1;
1057 if (in_merge_bases(commit_b, commit_a)) {
1058 hashcpy(result, a);
1059 return 1;
1063 * Case #2: There are one or more merges that contain a and b in
1064 * the submodule. If there is only one, then present it as a
1065 * suggestion to the user, but leave it marked unmerged so the
1066 * user needs to confirm the resolution.
1069 /* Skip the search if makes no sense to the calling context. */
1070 if (!search)
1071 return 0;
1073 /* find commit which merges them */
1074 parent_count = find_first_merges(&merges, path, commit_a, commit_b);
1075 switch (parent_count) {
1076 case 0:
1077 MERGE_WARNING(path, "merge following commits not found");
1078 break;
1080 case 1:
1081 MERGE_WARNING(path, "not fast-forward");
1082 fprintf(stderr, "Found a possible merge resolution "
1083 "for the submodule:\n");
1084 print_commit((struct commit *) merges.objects[0].item);
1085 fprintf(stderr,
1086 "If this is correct simply add it to the index "
1087 "for example\n"
1088 "by using:\n\n"
1089 " git update-index --cacheinfo 160000 %s \"%s\"\n\n"
1090 "which will accept this suggestion.\n",
1091 oid_to_hex(&merges.objects[0].item->oid), path);
1092 break;
1094 default:
1095 MERGE_WARNING(path, "multiple merges found");
1096 for (i = 0; i < merges.nr; i++)
1097 print_commit((struct commit *) merges.objects[i].item);
1100 free(merges.objects);
1101 return 0;
1104 /* Update gitfile and core.worktree setting to connect work tree and git dir */
1105 void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir)
1107 struct strbuf file_name = STRBUF_INIT;
1108 struct strbuf rel_path = STRBUF_INIT;
1109 const char *real_work_tree = xstrdup(real_path(work_tree));
1111 /* Update gitfile */
1112 strbuf_addf(&file_name, "%s/.git", work_tree);
1113 write_file(file_name.buf, "gitdir: %s",
1114 relative_path(git_dir, real_work_tree, &rel_path));
1116 /* Update core.worktree setting */
1117 strbuf_reset(&file_name);
1118 strbuf_addf(&file_name, "%s/config", git_dir);
1119 git_config_set_in_file(file_name.buf, "core.worktree",
1120 relative_path(real_work_tree, git_dir,
1121 &rel_path));
1123 strbuf_release(&file_name);
1124 strbuf_release(&rel_path);
1125 free((void *)real_work_tree);
1128 int parallel_submodules(void)
1130 return parallel_jobs;