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