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