1#include "cache.h"
2#include "submodule.h"
3#include "dir.h"
4#include "diff.h"
5#include "commit.h"
6#include "revision.h"
7#include "run-command.h"
8#include "diffcore.h"
9#include "refs.h"
10#include "string-list.h"
11struct string_list config_name_for_path;
13struct string_list config_fetch_recurse_submodules_for_name;
14struct string_list config_ignore_for_name;
15static int config_fetch_recurse_submodules = RECURSE_SUBMODULES_ON_DEMAND;
16struct string_list changed_submodule_paths;
17static int add_submodule_odb(const char *path)
19{
20 struct strbuf objects_directory = STRBUF_INIT;
21 struct alternate_object_database *alt_odb;
22 int ret = 0;
23 const char *git_dir;
24 strbuf_addf(&objects_directory, "%s/.git", path);
26 git_dir = read_gitfile_gently(objects_directory.buf);
27 if (git_dir) {
28 strbuf_reset(&objects_directory);
29 strbuf_addstr(&objects_directory, git_dir);
30 }
31 strbuf_addstr(&objects_directory, "/objects/");
32 if (!is_directory(objects_directory.buf)) {
33 ret = -1;
34 goto done;
35 }
36 /* avoid adding it twice */
37 for (alt_odb = alt_odb_list; alt_odb; alt_odb = alt_odb->next)
38 if (alt_odb->name - alt_odb->base == objects_directory.len &&
39 !strncmp(alt_odb->base, objects_directory.buf,
40 objects_directory.len))
41 goto done;
42 alt_odb = xmalloc(objects_directory.len + 42 + sizeof(*alt_odb));
44 alt_odb->next = alt_odb_list;
45 strcpy(alt_odb->base, objects_directory.buf);
46 alt_odb->name = alt_odb->base + objects_directory.len;
47 alt_odb->name[2] = '/';
48 alt_odb->name[40] = '\0';
49 alt_odb->name[41] = '\0';
50 alt_odb_list = alt_odb;
51 prepare_alt_odb();
52done:
53 strbuf_release(&objects_directory);
54 return ret;
55}
56void set_diffopt_flags_from_submodule_config(struct diff_options *diffopt,
58 const char *path)
59{
60 struct string_list_item *path_option, *ignore_option;
61 path_option = unsorted_string_list_lookup(&config_name_for_path, path);
62 if (path_option) {
63 ignore_option = unsorted_string_list_lookup(&config_ignore_for_name, path_option->util);
64 if (ignore_option)
65 handle_ignore_submodules_arg(diffopt, ignore_option->util);
66 }
67}
68int submodule_config(const char *var, const char *value, void *cb)
70{
71 if (!prefixcmp(var, "submodule."))
72 return parse_submodule_config_option(var, value);
73 else if (!strcmp(var, "fetch.recursesubmodules")) {
74 config_fetch_recurse_submodules = git_config_bool(var, value);
75 return 0;
76 }
77 return 0;
78}
79void gitmodules_config(void)
81{
82 const char *work_tree = get_git_work_tree();
83 if (work_tree) {
84 struct strbuf gitmodules_path = STRBUF_INIT;
85 strbuf_addstr(&gitmodules_path, work_tree);
86 strbuf_addstr(&gitmodules_path, "/.gitmodules");
87 git_config_from_file(submodule_config, gitmodules_path.buf, NULL);
88 strbuf_release(&gitmodules_path);
89 }
90}
91int parse_submodule_config_option(const char *var, const char *value)
93{
94 int len;
95 struct string_list_item *config;
96 struct strbuf submodname = STRBUF_INIT;
97 var += 10; /* Skip "submodule." */
99 len = strlen(var);
101 if ((len > 5) && !strcmp(var + len - 5, ".path")) {
102 strbuf_add(&submodname, var, len - 5);
103 config = unsorted_string_list_lookup(&config_name_for_path, value);
104 if (config)
105 free(config->util);
106 else
107 config = string_list_append(&config_name_for_path, xstrdup(value));
108 config->util = strbuf_detach(&submodname, NULL);
109 strbuf_release(&submodname);
110 } else if ((len > 23) && !strcmp(var + len - 23, ".fetchrecursesubmodules")) {
111 strbuf_add(&submodname, var, len - 23);
112 config = unsorted_string_list_lookup(&config_fetch_recurse_submodules_for_name, submodname.buf);
113 if (!config)
114 config = string_list_append(&config_fetch_recurse_submodules_for_name,
115 strbuf_detach(&submodname, NULL));
116 config->util = git_config_bool(var, value) ? (void *)1 : NULL;
117 strbuf_release(&submodname);
118 } else if ((len > 7) && !strcmp(var + len - 7, ".ignore")) {
119 if (strcmp(value, "untracked") && strcmp(value, "dirty") &&
120 strcmp(value, "all") && strcmp(value, "none")) {
121 warning("Invalid parameter \"%s\" for config option \"submodule.%s.ignore\"", value, var);
122 return 0;
123 }
124 strbuf_add(&submodname, var, len - 7);
126 config = unsorted_string_list_lookup(&config_ignore_for_name, submodname.buf);
127 if (config)
128 free(config->util);
129 else
130 config = string_list_append(&config_ignore_for_name,
131 strbuf_detach(&submodname, NULL));
132 strbuf_release(&submodname);
133 config->util = xstrdup(value);
134 return 0;
135 }
136 return 0;
137}
138void handle_ignore_submodules_arg(struct diff_options *diffopt,
140 const char *arg)
141{
142 DIFF_OPT_CLR(diffopt, IGNORE_SUBMODULES);
143 DIFF_OPT_CLR(diffopt, IGNORE_UNTRACKED_IN_SUBMODULES);
144 DIFF_OPT_CLR(diffopt, IGNORE_DIRTY_SUBMODULES);
145 if (!strcmp(arg, "all"))
147 DIFF_OPT_SET(diffopt, IGNORE_SUBMODULES);
148 else if (!strcmp(arg, "untracked"))
149 DIFF_OPT_SET(diffopt, IGNORE_UNTRACKED_IN_SUBMODULES);
150 else if (!strcmp(arg, "dirty"))
151 DIFF_OPT_SET(diffopt, IGNORE_DIRTY_SUBMODULES);
152 else if (strcmp(arg, "none"))
153 die("bad --ignore-submodules argument: %s", arg);
154}
155int parse_fetch_recurse_submodules_arg(const char *opt, const char *arg)
157{
158 switch (git_config_maybe_bool(opt, arg)) {
159 case 1:
160 return RECURSE_SUBMODULES_ON;
161 case 0:
162 return RECURSE_SUBMODULES_OFF;
163 default:
164 if (!strcmp(arg, "on-demand"))
165 return RECURSE_SUBMODULES_ON_DEMAND;
166 die("bad %s argument: %s", opt, arg);
167 }
168}
169void show_submodule_summary(FILE *f, const char *path,
171 unsigned char one[20], unsigned char two[20],
172 unsigned dirty_submodule,
173 const char *del, const char *add, const char *reset)
174{
175 struct rev_info rev;
176 struct commit *commit, *left = left, *right = right;
177 struct commit_list *merge_bases, *list;
178 const char *message = NULL;
179 struct strbuf sb = STRBUF_INIT;
180 static const char *format = " %m %s";
181 int fast_forward = 0, fast_backward = 0;
182 if (is_null_sha1(two))
184 message = "(submodule deleted)";
185 else if (add_submodule_odb(path))
186 message = "(not checked out)";
187 else if (is_null_sha1(one))
188 message = "(new submodule)";
189 else if (!(left = lookup_commit_reference(one)) ||
190 !(right = lookup_commit_reference(two)))
191 message = "(commits not present)";
192 if (!message) {
194 init_revisions(&rev, NULL);
195 setup_revisions(0, NULL, &rev, NULL);
196 rev.left_right = 1;
197 rev.first_parent_only = 1;
198 left->object.flags |= SYMMETRIC_LEFT;
199 add_pending_object(&rev, &left->object, path);
200 add_pending_object(&rev, &right->object, path);
201 merge_bases = get_merge_bases(left, right, 1);
202 if (merge_bases) {
203 if (merge_bases->item == left)
204 fast_forward = 1;
205 else if (merge_bases->item == right)
206 fast_backward = 1;
207 }
208 for (list = merge_bases; list; list = list->next) {
209 list->item->object.flags |= UNINTERESTING;
210 add_pending_object(&rev, &list->item->object,
211 sha1_to_hex(list->item->object.sha1));
212 }
213 if (prepare_revision_walk(&rev))
214 message = "(revision walker failed)";
215 }
216 if (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED)
218 fprintf(f, "Submodule %s contains untracked content\n", path);
219 if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
220 fprintf(f, "Submodule %s contains modified content\n", path);
221 if (!hashcmp(one, two)) {
223 strbuf_release(&sb);
224 return;
225 }
226 strbuf_addf(&sb, "Submodule %s %s..", path,
228 find_unique_abbrev(one, DEFAULT_ABBREV));
229 if (!fast_backward && !fast_forward)
230 strbuf_addch(&sb, '.');
231 strbuf_addf(&sb, "%s", find_unique_abbrev(two, DEFAULT_ABBREV));
232 if (message)
233 strbuf_addf(&sb, " %s\n", message);
234 else
235 strbuf_addf(&sb, "%s:\n", fast_backward ? " (rewind)" : "");
236 fwrite(sb.buf, sb.len, 1, f);
237 if (!message) {
239 while ((commit = get_revision(&rev))) {
240 struct pretty_print_context ctx = {0};
241 ctx.date_mode = rev.date_mode;
242 strbuf_setlen(&sb, 0);
243 if (commit->object.flags & SYMMETRIC_LEFT) {
244 if (del)
245 strbuf_addstr(&sb, del);
246 }
247 else if (add)
248 strbuf_addstr(&sb, add);
249 format_commit_message(commit, format, &sb, &ctx);
250 if (reset)
251 strbuf_addstr(&sb, reset);
252 strbuf_addch(&sb, '\n');
253 fprintf(f, "%s", sb.buf);
254 }
255 clear_commit_marks(left, ~0);
256 clear_commit_marks(right, ~0);
257 }
258 strbuf_release(&sb);
259}
260void set_config_fetch_recurse_submodules(int value)
262{
263 config_fetch_recurse_submodules = value;
264}
265static void submodule_collect_changed_cb(struct diff_queue_struct *q,
267 struct diff_options *options,
268 void *data)
269{
270 int i;
271 for (i = 0; i < q->nr; i++) {
272 struct diff_filepair *p = q->queue[i];
273 if (!S_ISGITLINK(p->two->mode))
274 continue;
275 if (S_ISGITLINK(p->one->mode)) {
277 /* NEEDSWORK: We should honor the name configured in
278 * the .gitmodules file of the commit we are examining
279 * here to be able to correctly follow submodules
280 * being moved around. */
281 struct string_list_item *path;
282 path = unsorted_string_list_lookup(&changed_submodule_paths, p->two->path);
283 if (!path)
284 string_list_append(&changed_submodule_paths, xstrdup(p->two->path));
285 } else {
286 /* Submodule is new or was moved here */
287 /* NEEDSWORK: When the .git directories of submodules
288 * live inside the superprojects .git directory some
289 * day we should fetch new submodules directly into
290 * that location too when config or options request
291 * that so they can be checked out from there. */
292 continue;
293 }
294 }
295}
296void check_for_new_submodule_commits(unsigned char new_sha1[20])
298{
299 struct rev_info rev;
300 struct commit *commit;
301 const char *argv[] = {NULL, NULL, "--not", "--all", NULL};
302 int argc = ARRAY_SIZE(argv) - 1;
303 init_revisions(&rev, NULL);
305 argv[1] = xstrdup(sha1_to_hex(new_sha1));
306 setup_revisions(argc, argv, &rev, NULL);
307 if (prepare_revision_walk(&rev))
308 die("revision walk setup failed");
309 /*
311 * Collect all submodules (whether checked out or not) for which new
312 * commits have been recorded upstream in "changed_submodule_paths".
313 */
314 while ((commit = get_revision(&rev))) {
315 struct commit_list *parent = commit->parents;
316 while (parent) {
317 struct diff_options diff_opts;
318 diff_setup(&diff_opts);
319 diff_opts.output_format |= DIFF_FORMAT_CALLBACK;
320 diff_opts.format_callback = submodule_collect_changed_cb;
321 if (diff_setup_done(&diff_opts) < 0)
322 die("diff_setup_done failed");
323 diff_tree_sha1(parent->item->object.sha1, commit->object.sha1, "", &diff_opts);
324 diffcore_std(&diff_opts);
325 diff_flush(&diff_opts);
326 parent = parent->next;
327 }
328 }
329 free((char *)argv[1]);
330}
331int fetch_populated_submodules(int num_options, const char **options,
333 const char *prefix, int ignore_config,
334 int quiet)
335{
336 int i, result = 0, argc = 0, default_argc;
337 struct child_process cp;
338 const char **argv;
339 struct string_list_item *name_for_path;
340 const char *work_tree = get_git_work_tree();
341 if (!work_tree)
342 goto out;
343 if (!the_index.initialized)
345 if (read_cache() < 0)
346 die("index file corrupt");
347 /* 6: "fetch" (options) --recurse-submodules-default default "--submodule-prefix" prefix NULL */
349 argv = xcalloc(num_options + 6, sizeof(const char *));
350 argv[argc++] = "fetch";
351 for (i = 0; i < num_options; i++)
352 argv[argc++] = options[i];
353 argv[argc++] = "--recurse-submodules-default";
354 default_argc = argc++;
355 argv[argc++] = "--submodule-prefix";
356 memset(&cp, 0, sizeof(cp));
358 cp.argv = argv;
359 cp.env = local_repo_env;
360 cp.git_cmd = 1;
361 cp.no_stdin = 1;
362 for (i = 0; i < active_nr; i++) {
364 struct strbuf submodule_path = STRBUF_INIT;
365 struct strbuf submodule_git_dir = STRBUF_INIT;
366 struct strbuf submodule_prefix = STRBUF_INIT;
367 struct cache_entry *ce = active_cache[i];
368 const char *git_dir, *name, *default_argv;
369 if (!S_ISGITLINK(ce->ce_mode))
371 continue;
372 name = ce->name;
374 name_for_path = unsorted_string_list_lookup(&config_name_for_path, ce->name);
375 if (name_for_path)
376 name = name_for_path->util;
377 default_argv = "yes";
379 if (!ignore_config) {
380 struct string_list_item *fetch_recurse_submodules_option;
381 fetch_recurse_submodules_option = unsorted_string_list_lookup(&config_fetch_recurse_submodules_for_name, name);
382 if (fetch_recurse_submodules_option) {
383 if (!fetch_recurse_submodules_option->util)
384 continue;
385 } else {
386 if (config_fetch_recurse_submodules == RECURSE_SUBMODULES_OFF)
387 continue;
388 if (config_fetch_recurse_submodules == RECURSE_SUBMODULES_ON_DEMAND) {
389 if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
390 continue;
391 default_argv = "on-demand";
392 }
393 }
394 }
395 strbuf_addf(&submodule_path, "%s/%s", work_tree, ce->name);
397 strbuf_addf(&submodule_git_dir, "%s/.git", submodule_path.buf);
398 strbuf_addf(&submodule_prefix, "%s%s/", prefix, ce->name);
399 git_dir = read_gitfile_gently(submodule_git_dir.buf);
400 if (!git_dir)
401 git_dir = submodule_git_dir.buf;
402 if (is_directory(git_dir)) {
403 if (!quiet)
404 printf("Fetching submodule %s%s\n", prefix, ce->name);
405 cp.dir = submodule_path.buf;
406 argv[default_argc] = default_argv;
407 argv[argc] = submodule_prefix.buf;
408 if (run_command(&cp))
409 result = 1;
410 }
411 strbuf_release(&submodule_path);
412 strbuf_release(&submodule_git_dir);
413 strbuf_release(&submodule_prefix);
414 }
415 free(argv);
416out:
417 string_list_clear(&changed_submodule_paths, 1);
418 return result;
419}
420unsigned is_submodule_modified(const char *path, int ignore_untracked)
422{
423 ssize_t len;
424 struct child_process cp;
425 const char *argv[] = {
426 "status",
427 "--porcelain",
428 NULL,
429 NULL,
430 };
431 struct strbuf buf = STRBUF_INIT;
432 unsigned dirty_submodule = 0;
433 const char *line, *next_line;
434 const char *git_dir;
435 strbuf_addf(&buf, "%s/.git", path);
437 git_dir = read_gitfile_gently(buf.buf);
438 if (!git_dir)
439 git_dir = buf.buf;
440 if (!is_directory(git_dir)) {
441 strbuf_release(&buf);
442 /* The submodule is not checked out, so it is not modified */
443 return 0;
444 }
446 strbuf_reset(&buf);
447 if (ignore_untracked)
449 argv[2] = "-uno";
450 memset(&cp, 0, sizeof(cp));
452 cp.argv = argv;
453 cp.env = local_repo_env;
454 cp.git_cmd = 1;
455 cp.no_stdin = 1;
456 cp.out = -1;
457 cp.dir = path;
458 if (start_command(&cp))
459 die("Could not run git status --porcelain");
460 len = strbuf_read(&buf, cp.out, 1024);
462 line = buf.buf;
463 while (len > 2) {
464 if ((line[0] == '?') && (line[1] == '?')) {
465 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
466 if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
467 break;
468 } else {
469 dirty_submodule |= DIRTY_SUBMODULE_MODIFIED;
470 if (ignore_untracked ||
471 (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED))
472 break;
473 }
474 next_line = strchr(line, '\n');
475 if (!next_line)
476 break;
477 next_line++;
478 len -= (next_line - line);
479 line = next_line;
480 }
481 close(cp.out);
482 if (finish_command(&cp))
484 die("git status --porcelain failed");
485 strbuf_release(&buf);
487 return dirty_submodule;
488}
489static int find_first_merges(struct object_array *result, const char *path,
491 struct commit *a, struct commit *b)
492{
493 int i, j;
494 struct object_array merges;
495 struct commit *commit;
496 int contains_another;
497 char merged_revision[42];
499 const char *rev_args[] = { "rev-list", "--merges", "--ancestry-path",
500 "--all", merged_revision, NULL };
501 struct rev_info revs;
502 struct setup_revision_opt rev_opts;
503 memset(&merges, 0, sizeof(merges));
505 memset(result, 0, sizeof(struct object_array));
506 memset(&rev_opts, 0, sizeof(rev_opts));
507 /* get all revisions that merge commit a */
509 snprintf(merged_revision, sizeof(merged_revision), "^%s",
510 sha1_to_hex(a->object.sha1));
511 init_revisions(&revs, NULL);
512 rev_opts.submodule = path;
513 setup_revisions(sizeof(rev_args)/sizeof(char *)-1, rev_args, &revs, &rev_opts);
514 /* save all revisions from the above list that contain b */
516 if (prepare_revision_walk(&revs))
517 die("revision walk setup failed");
518 while ((commit = get_revision(&revs)) != NULL) {
519 struct object *o = &(commit->object);
520 if (in_merge_bases(b, &commit, 1))
521 add_object_array(o, NULL, &merges);
522 }
523 /* Now we've got all merges that contain a and b. Prune all
525 * merges that contain another found merge and save them in
526 * result.
527 */
528 for (i = 0; i < merges.nr; i++) {
529 struct commit *m1 = (struct commit *) merges.objects[i].item;
530 contains_another = 0;
532 for (j = 0; j < merges.nr; j++) {
533 struct commit *m2 = (struct commit *) merges.objects[j].item;
534 if (i != j && in_merge_bases(m2, &m1, 1)) {
535 contains_another = 1;
536 break;
537 }
538 }
539 if (!contains_another)
541 add_object_array(merges.objects[i].item,
542 merges.objects[i].name, result);
543 }
544 free(merges.objects);
546 return result->nr;
547}
548static void print_commit(struct commit *commit)
550{
551 struct strbuf sb = STRBUF_INIT;
552 struct pretty_print_context ctx = {0};
553 ctx.date_mode = DATE_NORMAL;
554 format_commit_message(commit, " %h: %m %s", &sb, &ctx);
555 fprintf(stderr, "%s\n", sb.buf);
556 strbuf_release(&sb);
557}
558#define MERGE_WARNING(path, msg) \
560 warning("Failed to merge submodule %s (%s)", path, msg);
561int merge_submodule(unsigned char result[20], const char *path,
563 const unsigned char base[20], const unsigned char a[20],
564 const unsigned char b[20])
565{
566 struct commit *commit_base, *commit_a, *commit_b;
567 int parent_count;
568 struct object_array merges;
569 int i;
571 /* store a in result in case we fail */
573 hashcpy(result, a);
574 /* we can not handle deletion conflicts */
576 if (is_null_sha1(base))
577 return 0;
578 if (is_null_sha1(a))
579 return 0;
580 if (is_null_sha1(b))
581 return 0;
582 if (add_submodule_odb(path)) {
584 MERGE_WARNING(path, "not checked out");
585 return 0;
586 }
587 if (!(commit_base = lookup_commit_reference(base)) ||
589 !(commit_a = lookup_commit_reference(a)) ||
590 !(commit_b = lookup_commit_reference(b))) {
591 MERGE_WARNING(path, "commits not present");
592 return 0;
593 }
594 /* check whether both changes are forward */
596 if (!in_merge_bases(commit_base, &commit_a, 1) ||
597 !in_merge_bases(commit_base, &commit_b, 1)) {
598 MERGE_WARNING(path, "commits don't follow merge-base");
599 return 0;
600 }
601 /* Case #1: a is contained in b or vice versa */
603 if (in_merge_bases(commit_a, &commit_b, 1)) {
604 hashcpy(result, b);
605 return 1;
606 }
607 if (in_merge_bases(commit_b, &commit_a, 1)) {
608 hashcpy(result, a);
609 return 1;
610 }
611 /*
613 * Case #2: There are one or more merges that contain a and b in
614 * the submodule. If there is only one, then present it as a
615 * suggestion to the user, but leave it marked unmerged so the
616 * user needs to confirm the resolution.
617 */
618 /* find commit which merges them */
620 parent_count = find_first_merges(&merges, path, commit_a, commit_b);
621 switch (parent_count) {
622 case 0:
623 MERGE_WARNING(path, "merge following commits not found");
624 break;
625 case 1:
627 MERGE_WARNING(path, "not fast-forward");
628 fprintf(stderr, "Found a possible merge resolution "
629 "for the submodule:\n");
630 print_commit((struct commit *) merges.objects[0].item);
631 fprintf(stderr,
632 "If this is correct simply add it to the index "
633 "for example\n"
634 "by using:\n\n"
635 " git update-index --cacheinfo 160000 %s \"%s\"\n\n"
636 "which will accept this suggestion.\n",
637 sha1_to_hex(merges.objects[0].item->sha1), path);
638 break;
639 default:
641 MERGE_WARNING(path, "multiple merges found");
642 for (i = 0; i < merges.nr; i++)
643 print_commit((struct commit *) merges.objects[i].item);
644 }
645 free(merges.objects);
647 return 0;
648}