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