subtree: t7900: rename last_commit_message to last_commit_subject
[git] / submodule.c
1
2 #include "cache.h"
3 #include "repository.h"
4 #include "config.h"
5 #include "submodule-config.h"
6 #include "submodule.h"
7 #include "dir.h"
8 #include "diff.h"
9 #include "commit.h"
10 #include "revision.h"
11 #include "run-command.h"
12 #include "diffcore.h"
13 #include "refs.h"
14 #include "string-list.h"
15 #include "oid-array.h"
16 #include "strvec.h"
17 #include "blob.h"
18 #include "thread-utils.h"
19 #include "quote.h"
20 #include "remote.h"
21 #include "worktree.h"
22 #include "parse-options.h"
23 #include "object-store.h"
24 #include "commit-reach.h"
25
26 static int config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
27 static int initialized_fetch_ref_tips;
28 static struct oid_array ref_tips_before_fetch;
29 static struct oid_array ref_tips_after_fetch;
30
31 /*
32  * Check if the .gitmodules file is unmerged. Parsing of the .gitmodules file
33  * will be disabled because we can't guess what might be configured in
34  * .gitmodules unless the user resolves the conflict.
35  */
36 int is_gitmodules_unmerged(const struct index_state *istate)
37 {
38         int pos = index_name_pos(istate, GITMODULES_FILE, strlen(GITMODULES_FILE));
39         if (pos < 0) { /* .gitmodules not found or isn't merged */
40                 pos = -1 - pos;
41                 if (istate->cache_nr > pos) {  /* there is a .gitmodules */
42                         const struct cache_entry *ce = istate->cache[pos];
43                         if (ce_namelen(ce) == strlen(GITMODULES_FILE) &&
44                             !strcmp(ce->name, GITMODULES_FILE))
45                                 return 1;
46                 }
47         }
48
49         return 0;
50 }
51
52 /*
53  * Check if the .gitmodules file is safe to write.
54  *
55  * Writing to the .gitmodules file requires that the file exists in the
56  * working tree or, if it doesn't, that a brand new .gitmodules file is going
57  * to be created (i.e. it's neither in the index nor in the current branch).
58  *
59  * It is not safe to write to .gitmodules if it's not in the working tree but
60  * it is in the index or in the current branch, because writing new values
61  * (and staging them) would blindly overwrite ALL the old content.
62  */
63 int is_writing_gitmodules_ok(void)
64 {
65         struct object_id oid;
66         return file_exists(GITMODULES_FILE) ||
67                 (get_oid(GITMODULES_INDEX, &oid) < 0 && get_oid(GITMODULES_HEAD, &oid) < 0);
68 }
69
70 /*
71  * Check if the .gitmodules file has unstaged modifications.  This must be
72  * checked before allowing modifications to the .gitmodules file with the
73  * intention to stage them later, because when continuing we would stage the
74  * modifications the user didn't stage herself too. That might change in a
75  * future version when we learn to stage the changes we do ourselves without
76  * staging any previous modifications.
77  */
78 int is_staging_gitmodules_ok(struct index_state *istate)
79 {
80         int pos = index_name_pos(istate, GITMODULES_FILE, strlen(GITMODULES_FILE));
81
82         if ((pos >= 0) && (pos < istate->cache_nr)) {
83                 struct stat st;
84                 if (lstat(GITMODULES_FILE, &st) == 0 &&
85                     ie_modified(istate, istate->cache[pos], &st, 0) & DATA_CHANGED)
86                         return 0;
87         }
88
89         return 1;
90 }
91
92 static int for_each_remote_ref_submodule(const char *submodule,
93                                          each_ref_fn fn, void *cb_data)
94 {
95         return refs_for_each_remote_ref(get_submodule_ref_store(submodule),
96                                         fn, cb_data);
97 }
98
99 /*
100  * Try to update the "path" entry in the "submodule.<name>" section of the
101  * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
102  * with the correct path=<oldpath> setting was found and we could update it.
103  */
104 int update_path_in_gitmodules(const char *oldpath, const char *newpath)
105 {
106         struct strbuf entry = STRBUF_INIT;
107         const struct submodule *submodule;
108         int ret;
109
110         if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
111                 return -1;
112
113         if (is_gitmodules_unmerged(the_repository->index))
114                 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
115
116         submodule = submodule_from_path(the_repository, &null_oid, oldpath);
117         if (!submodule || !submodule->name) {
118                 warning(_("Could not find section in .gitmodules where path=%s"), oldpath);
119                 return -1;
120         }
121         strbuf_addstr(&entry, "submodule.");
122         strbuf_addstr(&entry, submodule->name);
123         strbuf_addstr(&entry, ".path");
124         ret = config_set_in_gitmodules_file_gently(entry.buf, newpath);
125         strbuf_release(&entry);
126         return ret;
127 }
128
129 /*
130  * Try to remove the "submodule.<name>" section from .gitmodules where the given
131  * path is configured. Return 0 only if a .gitmodules file was found, a section
132  * with the correct path=<path> setting was found and we could remove it.
133  */
134 int remove_path_from_gitmodules(const char *path)
135 {
136         struct strbuf sect = STRBUF_INIT;
137         const struct submodule *submodule;
138
139         if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
140                 return -1;
141
142         if (is_gitmodules_unmerged(the_repository->index))
143                 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
144
145         submodule = submodule_from_path(the_repository, &null_oid, path);
146         if (!submodule || !submodule->name) {
147                 warning(_("Could not find section in .gitmodules where path=%s"), path);
148                 return -1;
149         }
150         strbuf_addstr(&sect, "submodule.");
151         strbuf_addstr(&sect, submodule->name);
152         if (git_config_rename_section_in_file(GITMODULES_FILE, sect.buf, NULL) < 0) {
153                 /* Maybe the user already did that, don't error out here */
154                 warning(_("Could not remove .gitmodules entry for %s"), path);
155                 strbuf_release(&sect);
156                 return -1;
157         }
158         strbuf_release(&sect);
159         return 0;
160 }
161
162 void stage_updated_gitmodules(struct index_state *istate)
163 {
164         if (add_file_to_index(istate, GITMODULES_FILE, 0))
165                 die(_("staging updated .gitmodules failed"));
166 }
167
168 /* TODO: remove this function, use repo_submodule_init instead. */
169 int add_submodule_odb(const char *path)
170 {
171         struct strbuf objects_directory = STRBUF_INIT;
172         int ret = 0;
173
174         ret = strbuf_git_path_submodule(&objects_directory, path, "objects/");
175         if (ret)
176                 goto done;
177         if (!is_directory(objects_directory.buf)) {
178                 ret = -1;
179                 goto done;
180         }
181         add_to_alternates_memory(objects_directory.buf);
182 done:
183         strbuf_release(&objects_directory);
184         return ret;
185 }
186
187 void set_diffopt_flags_from_submodule_config(struct diff_options *diffopt,
188                                              const char *path)
189 {
190         const struct submodule *submodule = submodule_from_path(the_repository,
191                                                                 &null_oid, path);
192         if (submodule) {
193                 const char *ignore;
194                 char *key;
195
196                 key = xstrfmt("submodule.%s.ignore", submodule->name);
197                 if (repo_config_get_string_tmp(the_repository, key, &ignore))
198                         ignore = submodule->ignore;
199                 free(key);
200
201                 if (ignore)
202                         handle_ignore_submodules_arg(diffopt, ignore);
203                 else if (is_gitmodules_unmerged(the_repository->index))
204                         diffopt->flags.ignore_submodules = 1;
205         }
206 }
207
208 /* Cheap function that only determines if we're interested in submodules at all */
209 int git_default_submodule_config(const char *var, const char *value, void *cb)
210 {
211         if (!strcmp(var, "submodule.recurse")) {
212                 int v = git_config_bool(var, value) ?
213                         RECURSE_SUBMODULES_ON : RECURSE_SUBMODULES_OFF;
214                 config_update_recurse_submodules = v;
215         }
216         return 0;
217 }
218
219 int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
220                                                      const char *arg, int unset)
221 {
222         if (unset) {
223                 config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
224                 return 0;
225         }
226         if (arg)
227                 config_update_recurse_submodules =
228                         parse_update_recurse_submodules_arg(opt->long_name,
229                                                             arg);
230         else
231                 config_update_recurse_submodules = RECURSE_SUBMODULES_ON;
232
233         return 0;
234 }
235
236 /*
237  * Determine if a submodule has been initialized at a given 'path'
238  */
239 int is_submodule_active(struct repository *repo, const char *path)
240 {
241         int ret = 0;
242         char *key = NULL;
243         char *value = NULL;
244         const struct string_list *sl;
245         const struct submodule *module;
246
247         module = submodule_from_path(repo, &null_oid, path);
248
249         /* early return if there isn't a path->module mapping */
250         if (!module)
251                 return 0;
252
253         /* submodule.<name>.active is set */
254         key = xstrfmt("submodule.%s.active", module->name);
255         if (!repo_config_get_bool(repo, key, &ret)) {
256                 free(key);
257                 return ret;
258         }
259         free(key);
260
261         /* submodule.active is set */
262         sl = repo_config_get_value_multi(repo, "submodule.active");
263         if (sl) {
264                 struct pathspec ps;
265                 struct strvec args = STRVEC_INIT;
266                 const struct string_list_item *item;
267
268                 for_each_string_list_item(item, sl) {
269                         strvec_push(&args, item->string);
270                 }
271
272                 parse_pathspec(&ps, 0, 0, NULL, args.v);
273                 ret = match_pathspec(repo->index, &ps, path, strlen(path), 0, NULL, 1);
274
275                 strvec_clear(&args);
276                 clear_pathspec(&ps);
277                 return ret;
278         }
279
280         /* fallback to checking if the URL is set */
281         key = xstrfmt("submodule.%s.url", module->name);
282         ret = !repo_config_get_string(repo, key, &value);
283
284         free(value);
285         free(key);
286         return ret;
287 }
288
289 int is_submodule_populated_gently(const char *path, int *return_error_code)
290 {
291         int ret = 0;
292         char *gitdir = xstrfmt("%s/.git", path);
293
294         if (resolve_gitdir_gently(gitdir, return_error_code))
295                 ret = 1;
296
297         free(gitdir);
298         return ret;
299 }
300
301 /*
302  * Dies if the provided 'prefix' corresponds to an unpopulated submodule
303  */
304 void die_in_unpopulated_submodule(const struct index_state *istate,
305                                   const char *prefix)
306 {
307         int i, prefixlen;
308
309         if (!prefix)
310                 return;
311
312         prefixlen = strlen(prefix);
313
314         for (i = 0; i < istate->cache_nr; i++) {
315                 struct cache_entry *ce = istate->cache[i];
316                 int ce_len = ce_namelen(ce);
317
318                 if (!S_ISGITLINK(ce->ce_mode))
319                         continue;
320                 if (prefixlen <= ce_len)
321                         continue;
322                 if (strncmp(ce->name, prefix, ce_len))
323                         continue;
324                 if (prefix[ce_len] != '/')
325                         continue;
326
327                 die(_("in unpopulated submodule '%s'"), ce->name);
328         }
329 }
330
331 /*
332  * Dies if any paths in the provided pathspec descends into a submodule
333  */
334 void die_path_inside_submodule(const struct index_state *istate,
335                                const struct pathspec *ps)
336 {
337         int i, j;
338
339         for (i = 0; i < istate->cache_nr; i++) {
340                 struct cache_entry *ce = istate->cache[i];
341                 int ce_len = ce_namelen(ce);
342
343                 if (!S_ISGITLINK(ce->ce_mode))
344                         continue;
345
346                 for (j = 0; j < ps->nr ; j++) {
347                         const struct pathspec_item *item = &ps->items[j];
348
349                         if (item->len <= ce_len)
350                                 continue;
351                         if (item->match[ce_len] != '/')
352                                 continue;
353                         if (strncmp(ce->name, item->match, ce_len))
354                                 continue;
355                         if (item->len == ce_len + 1)
356                                 continue;
357
358                         die(_("Pathspec '%s' is in submodule '%.*s'"),
359                             item->original, ce_len, ce->name);
360                 }
361         }
362 }
363
364 enum submodule_update_type parse_submodule_update_type(const char *value)
365 {
366         if (!strcmp(value, "none"))
367                 return SM_UPDATE_NONE;
368         else if (!strcmp(value, "checkout"))
369                 return SM_UPDATE_CHECKOUT;
370         else if (!strcmp(value, "rebase"))
371                 return SM_UPDATE_REBASE;
372         else if (!strcmp(value, "merge"))
373                 return SM_UPDATE_MERGE;
374         else if (*value == '!')
375                 return SM_UPDATE_COMMAND;
376         else
377                 return SM_UPDATE_UNSPECIFIED;
378 }
379
380 int parse_submodule_update_strategy(const char *value,
381                 struct submodule_update_strategy *dst)
382 {
383         enum submodule_update_type type;
384
385         free((void*)dst->command);
386         dst->command = NULL;
387
388         type = parse_submodule_update_type(value);
389         if (type == SM_UPDATE_UNSPECIFIED)
390                 return -1;
391
392         dst->type = type;
393         if (type == SM_UPDATE_COMMAND)
394                 dst->command = xstrdup(value + 1);
395
396         return 0;
397 }
398
399 const char *submodule_strategy_to_string(const struct submodule_update_strategy *s)
400 {
401         struct strbuf sb = STRBUF_INIT;
402         switch (s->type) {
403         case SM_UPDATE_CHECKOUT:
404                 return "checkout";
405         case SM_UPDATE_MERGE:
406                 return "merge";
407         case SM_UPDATE_REBASE:
408                 return "rebase";
409         case SM_UPDATE_NONE:
410                 return "none";
411         case SM_UPDATE_UNSPECIFIED:
412                 return NULL;
413         case SM_UPDATE_COMMAND:
414                 strbuf_addf(&sb, "!%s", s->command);
415                 return strbuf_detach(&sb, NULL);
416         }
417         return NULL;
418 }
419
420 void handle_ignore_submodules_arg(struct diff_options *diffopt,
421                                   const char *arg)
422 {
423         diffopt->flags.ignore_submodule_set = 1;
424         diffopt->flags.ignore_submodules = 0;
425         diffopt->flags.ignore_untracked_in_submodules = 0;
426         diffopt->flags.ignore_dirty_submodules = 0;
427
428         if (!strcmp(arg, "all"))
429                 diffopt->flags.ignore_submodules = 1;
430         else if (!strcmp(arg, "untracked"))
431                 diffopt->flags.ignore_untracked_in_submodules = 1;
432         else if (!strcmp(arg, "dirty"))
433                 diffopt->flags.ignore_dirty_submodules = 1;
434         else if (strcmp(arg, "none"))
435                 die(_("bad --ignore-submodules argument: %s"), arg);
436         /*
437          * Please update _git_status() in git-completion.bash when you
438          * add new options
439          */
440 }
441
442 static int prepare_submodule_diff_summary(struct repository *r, struct rev_info *rev,
443                                           const char *path,
444                                           struct commit *left, struct commit *right,
445                                           struct commit_list *merge_bases)
446 {
447         struct commit_list *list;
448
449         repo_init_revisions(r, rev, NULL);
450         setup_revisions(0, NULL, rev, NULL);
451         rev->left_right = 1;
452         rev->first_parent_only = 1;
453         left->object.flags |= SYMMETRIC_LEFT;
454         add_pending_object(rev, &left->object, path);
455         add_pending_object(rev, &right->object, path);
456         for (list = merge_bases; list; list = list->next) {
457                 list->item->object.flags |= UNINTERESTING;
458                 add_pending_object(rev, &list->item->object,
459                         oid_to_hex(&list->item->object.oid));
460         }
461         return prepare_revision_walk(rev);
462 }
463
464 static void print_submodule_diff_summary(struct repository *r, struct rev_info *rev, struct diff_options *o)
465 {
466         static const char format[] = "  %m %s";
467         struct strbuf sb = STRBUF_INIT;
468         struct commit *commit;
469
470         while ((commit = get_revision(rev))) {
471                 struct pretty_print_context ctx = {0};
472                 ctx.date_mode = rev->date_mode;
473                 ctx.output_encoding = get_log_output_encoding();
474                 strbuf_setlen(&sb, 0);
475                 repo_format_commit_message(r, commit, format, &sb,
476                                       &ctx);
477                 strbuf_addch(&sb, '\n');
478                 if (commit->object.flags & SYMMETRIC_LEFT)
479                         diff_emit_submodule_del(o, sb.buf);
480                 else
481                         diff_emit_submodule_add(o, sb.buf);
482         }
483         strbuf_release(&sb);
484 }
485
486 static void prepare_submodule_repo_env_no_git_dir(struct strvec *out)
487 {
488         const char * const *var;
489
490         for (var = local_repo_env; *var; var++) {
491                 if (strcmp(*var, CONFIG_DATA_ENVIRONMENT))
492                         strvec_push(out, *var);
493         }
494 }
495
496 void prepare_submodule_repo_env(struct strvec *out)
497 {
498         prepare_submodule_repo_env_no_git_dir(out);
499         strvec_pushf(out, "%s=%s", GIT_DIR_ENVIRONMENT,
500                      DEFAULT_GIT_DIR_ENVIRONMENT);
501 }
502
503 static void prepare_submodule_repo_env_in_gitdir(struct strvec *out)
504 {
505         prepare_submodule_repo_env_no_git_dir(out);
506         strvec_pushf(out, "%s=.", GIT_DIR_ENVIRONMENT);
507 }
508
509 /*
510  * Initialize a repository struct for a submodule based on the provided 'path'.
511  *
512  * Unlike repo_submodule_init, this tolerates submodules not present
513  * in .gitmodules. This function exists only to preserve historical behavior,
514  *
515  * Returns the repository struct on success,
516  * NULL when the submodule is not present.
517  */
518 static struct repository *open_submodule(const char *path)
519 {
520         struct strbuf sb = STRBUF_INIT;
521         struct repository *out = xmalloc(sizeof(*out));
522
523         if (submodule_to_gitdir(&sb, path) || repo_init(out, sb.buf, NULL)) {
524                 strbuf_release(&sb);
525                 free(out);
526                 return NULL;
527         }
528
529         /* Mark it as a submodule */
530         out->submodule_prefix = xstrdup(path);
531
532         strbuf_release(&sb);
533         return out;
534 }
535
536 /*
537  * Helper function to display the submodule header line prior to the full
538  * summary output.
539  *
540  * If it can locate the submodule git directory it will create a repository
541  * handle for the submodule and lookup both the left and right commits and
542  * put them into the left and right pointers.
543  */
544 static void show_submodule_header(struct diff_options *o,
545                 const char *path,
546                 struct object_id *one, struct object_id *two,
547                 unsigned dirty_submodule,
548                 struct repository *sub,
549                 struct commit **left, struct commit **right,
550                 struct commit_list **merge_bases)
551 {
552         const char *message = NULL;
553         struct strbuf sb = STRBUF_INIT;
554         int fast_forward = 0, fast_backward = 0;
555
556         if (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED)
557                 diff_emit_submodule_untracked(o, path);
558
559         if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
560                 diff_emit_submodule_modified(o, path);
561
562         if (is_null_oid(one))
563                 message = "(new submodule)";
564         else if (is_null_oid(two))
565                 message = "(submodule deleted)";
566
567         if (!sub) {
568                 if (!message)
569                         message = "(commits not present)";
570                 goto output_header;
571         }
572
573         /*
574          * Attempt to lookup the commit references, and determine if this is
575          * a fast forward or fast backwards update.
576          */
577         *left = lookup_commit_reference(sub, one);
578         *right = lookup_commit_reference(sub, two);
579
580         /*
581          * Warn about missing commits in the submodule project, but only if
582          * they aren't null.
583          */
584         if ((!is_null_oid(one) && !*left) ||
585              (!is_null_oid(two) && !*right))
586                 message = "(commits not present)";
587
588         *merge_bases = repo_get_merge_bases(sub, *left, *right);
589         if (*merge_bases) {
590                 if ((*merge_bases)->item == *left)
591                         fast_forward = 1;
592                 else if ((*merge_bases)->item == *right)
593                         fast_backward = 1;
594         }
595
596         if (oideq(one, two)) {
597                 strbuf_release(&sb);
598                 return;
599         }
600
601 output_header:
602         strbuf_addf(&sb, "Submodule %s ", path);
603         strbuf_add_unique_abbrev(&sb, one, DEFAULT_ABBREV);
604         strbuf_addstr(&sb, (fast_backward || fast_forward) ? ".." : "...");
605         strbuf_add_unique_abbrev(&sb, two, DEFAULT_ABBREV);
606         if (message)
607                 strbuf_addf(&sb, " %s\n", message);
608         else
609                 strbuf_addf(&sb, "%s:\n", fast_backward ? " (rewind)" : "");
610         diff_emit_submodule_header(o, sb.buf);
611
612         strbuf_release(&sb);
613 }
614
615 void show_submodule_diff_summary(struct diff_options *o, const char *path,
616                 struct object_id *one, struct object_id *two,
617                 unsigned dirty_submodule)
618 {
619         struct rev_info rev;
620         struct commit *left = NULL, *right = NULL;
621         struct commit_list *merge_bases = NULL;
622         struct repository *sub;
623
624         sub = open_submodule(path);
625         show_submodule_header(o, path, one, two, dirty_submodule,
626                               sub, &left, &right, &merge_bases);
627
628         /*
629          * If we don't have both a left and a right pointer, there is no
630          * reason to try and display a summary. The header line should contain
631          * all the information the user needs.
632          */
633         if (!left || !right || !sub)
634                 goto out;
635
636         /* Treat revision walker failure the same as missing commits */
637         if (prepare_submodule_diff_summary(sub, &rev, path, left, right, merge_bases)) {
638                 diff_emit_submodule_error(o, "(revision walker failed)\n");
639                 goto out;
640         }
641
642         print_submodule_diff_summary(sub, &rev, o);
643
644 out:
645         if (merge_bases)
646                 free_commit_list(merge_bases);
647         clear_commit_marks(left, ~0);
648         clear_commit_marks(right, ~0);
649         if (sub) {
650                 repo_clear(sub);
651                 free(sub);
652         }
653 }
654
655 void show_submodule_inline_diff(struct diff_options *o, const char *path,
656                 struct object_id *one, struct object_id *two,
657                 unsigned dirty_submodule)
658 {
659         const struct object_id *old_oid = the_hash_algo->empty_tree, *new_oid = the_hash_algo->empty_tree;
660         struct commit *left = NULL, *right = NULL;
661         struct commit_list *merge_bases = NULL;
662         struct child_process cp = CHILD_PROCESS_INIT;
663         struct strbuf sb = STRBUF_INIT;
664         struct repository *sub;
665
666         sub = open_submodule(path);
667         show_submodule_header(o, path, one, two, dirty_submodule,
668                               sub, &left, &right, &merge_bases);
669
670         /* We need a valid left and right commit to display a difference */
671         if (!(left || is_null_oid(one)) ||
672             !(right || is_null_oid(two)))
673                 goto done;
674
675         if (left)
676                 old_oid = one;
677         if (right)
678                 new_oid = two;
679
680         cp.git_cmd = 1;
681         cp.dir = path;
682         cp.out = -1;
683         cp.no_stdin = 1;
684
685         /* TODO: other options may need to be passed here. */
686         strvec_pushl(&cp.args, "diff", "--submodule=diff", NULL);
687         strvec_pushf(&cp.args, "--color=%s", want_color(o->use_color) ?
688                          "always" : "never");
689
690         if (o->flags.reverse_diff) {
691                 strvec_pushf(&cp.args, "--src-prefix=%s%s/",
692                              o->b_prefix, path);
693                 strvec_pushf(&cp.args, "--dst-prefix=%s%s/",
694                              o->a_prefix, path);
695         } else {
696                 strvec_pushf(&cp.args, "--src-prefix=%s%s/",
697                              o->a_prefix, path);
698                 strvec_pushf(&cp.args, "--dst-prefix=%s%s/",
699                              o->b_prefix, path);
700         }
701         strvec_push(&cp.args, oid_to_hex(old_oid));
702         /*
703          * If the submodule has modified content, we will diff against the
704          * work tree, under the assumption that the user has asked for the
705          * diff format and wishes to actually see all differences even if they
706          * haven't yet been committed to the submodule yet.
707          */
708         if (!(dirty_submodule & DIRTY_SUBMODULE_MODIFIED))
709                 strvec_push(&cp.args, oid_to_hex(new_oid));
710
711         prepare_submodule_repo_env(&cp.env_array);
712         if (start_command(&cp))
713                 diff_emit_submodule_error(o, "(diff failed)\n");
714
715         while (strbuf_getwholeline_fd(&sb, cp.out, '\n') != EOF)
716                 diff_emit_submodule_pipethrough(o, sb.buf, sb.len);
717
718         if (finish_command(&cp))
719                 diff_emit_submodule_error(o, "(diff failed)\n");
720
721 done:
722         strbuf_release(&sb);
723         if (merge_bases)
724                 free_commit_list(merge_bases);
725         if (left)
726                 clear_commit_marks(left, ~0);
727         if (right)
728                 clear_commit_marks(right, ~0);
729         if (sub) {
730                 repo_clear(sub);
731                 free(sub);
732         }
733 }
734
735 int should_update_submodules(void)
736 {
737         return config_update_recurse_submodules == RECURSE_SUBMODULES_ON;
738 }
739
740 const struct submodule *submodule_from_ce(const struct cache_entry *ce)
741 {
742         if (!S_ISGITLINK(ce->ce_mode))
743                 return NULL;
744
745         if (!should_update_submodules())
746                 return NULL;
747
748         return submodule_from_path(the_repository, &null_oid, ce->name);
749 }
750
751 static struct oid_array *submodule_commits(struct string_list *submodules,
752                                            const char *name)
753 {
754         struct string_list_item *item;
755
756         item = string_list_insert(submodules, name);
757         if (item->util)
758                 return (struct oid_array *) item->util;
759
760         /* NEEDSWORK: should we have oid_array_init()? */
761         item->util = xcalloc(1, sizeof(struct oid_array));
762         return (struct oid_array *) item->util;
763 }
764
765 struct collect_changed_submodules_cb_data {
766         struct repository *repo;
767         struct string_list *changed;
768         const struct object_id *commit_oid;
769 };
770
771 /*
772  * this would normally be two functions: default_name_from_path() and
773  * path_from_default_name(). Since the default name is the same as
774  * the submodule path we can get away with just one function which only
775  * checks whether there is a submodule in the working directory at that
776  * location.
777  */
778 static const char *default_name_or_path(const char *path_or_name)
779 {
780         int error_code;
781
782         if (!is_submodule_populated_gently(path_or_name, &error_code))
783                 return NULL;
784
785         return path_or_name;
786 }
787
788 static void collect_changed_submodules_cb(struct diff_queue_struct *q,
789                                           struct diff_options *options,
790                                           void *data)
791 {
792         struct collect_changed_submodules_cb_data *me = data;
793         struct string_list *changed = me->changed;
794         const struct object_id *commit_oid = me->commit_oid;
795         int i;
796
797         for (i = 0; i < q->nr; i++) {
798                 struct diff_filepair *p = q->queue[i];
799                 struct oid_array *commits;
800                 const struct submodule *submodule;
801                 const char *name;
802
803                 if (!S_ISGITLINK(p->two->mode))
804                         continue;
805
806                 submodule = submodule_from_path(me->repo,
807                                                 commit_oid, p->two->path);
808                 if (submodule)
809                         name = submodule->name;
810                 else {
811                         name = default_name_or_path(p->two->path);
812                         /* make sure name does not collide with existing one */
813                         if (name)
814                                 submodule = submodule_from_name(me->repo,
815                                                                 commit_oid, name);
816                         if (submodule) {
817                                 warning(_("Submodule in commit %s at path: "
818                                         "'%s' collides with a submodule named "
819                                         "the same. Skipping it."),
820                                         oid_to_hex(commit_oid), p->two->path);
821                                 name = NULL;
822                         }
823                 }
824
825                 if (!name)
826                         continue;
827
828                 commits = submodule_commits(changed, name);
829                 oid_array_append(commits, &p->two->oid);
830         }
831 }
832
833 /*
834  * Collect the paths of submodules in 'changed' which have changed based on
835  * the revisions as specified in 'argv'.  Each entry in 'changed' will also
836  * have a corresponding 'struct oid_array' (in the 'util' field) which lists
837  * what the submodule pointers were updated to during the change.
838  */
839 static void collect_changed_submodules(struct repository *r,
840                                        struct string_list *changed,
841                                        struct strvec *argv)
842 {
843         struct rev_info rev;
844         const struct commit *commit;
845         int save_warning;
846         struct setup_revision_opt s_r_opt = {
847                 .assume_dashdash = 1,
848         };
849
850         save_warning = warn_on_object_refname_ambiguity;
851         warn_on_object_refname_ambiguity = 0;
852         repo_init_revisions(r, &rev, NULL);
853         setup_revisions(argv->nr, argv->v, &rev, &s_r_opt);
854         warn_on_object_refname_ambiguity = save_warning;
855         if (prepare_revision_walk(&rev))
856                 die(_("revision walk setup failed"));
857
858         while ((commit = get_revision(&rev))) {
859                 struct rev_info diff_rev;
860                 struct collect_changed_submodules_cb_data data;
861                 data.repo = r;
862                 data.changed = changed;
863                 data.commit_oid = &commit->object.oid;
864
865                 repo_init_revisions(r, &diff_rev, NULL);
866                 diff_rev.diffopt.output_format |= DIFF_FORMAT_CALLBACK;
867                 diff_rev.diffopt.format_callback = collect_changed_submodules_cb;
868                 diff_rev.diffopt.format_callback_data = &data;
869                 diff_rev.dense_combined_merges = 1;
870                 diff_tree_combined_merge(commit, &diff_rev);
871         }
872
873         reset_revision_walk();
874 }
875
876 static void free_submodules_oids(struct string_list *submodules)
877 {
878         struct string_list_item *item;
879         for_each_string_list_item(item, submodules)
880                 oid_array_clear((struct oid_array *) item->util);
881         string_list_clear(submodules, 1);
882 }
883
884 static int has_remote(const char *refname, const struct object_id *oid,
885                       int flags, void *cb_data)
886 {
887         return 1;
888 }
889
890 static int append_oid_to_argv(const struct object_id *oid, void *data)
891 {
892         struct strvec *argv = data;
893         strvec_push(argv, oid_to_hex(oid));
894         return 0;
895 }
896
897 struct has_commit_data {
898         struct repository *repo;
899         int result;
900         const char *path;
901 };
902
903 static int check_has_commit(const struct object_id *oid, void *data)
904 {
905         struct has_commit_data *cb = data;
906
907         enum object_type type = oid_object_info(cb->repo, oid, NULL);
908
909         switch (type) {
910         case OBJ_COMMIT:
911                 return 0;
912         case OBJ_BAD:
913                 /*
914                  * Object is missing or invalid. If invalid, an error message
915                  * has already been printed.
916                  */
917                 cb->result = 0;
918                 return 0;
919         default:
920                 die(_("submodule entry '%s' (%s) is a %s, not a commit"),
921                     cb->path, oid_to_hex(oid), type_name(type));
922         }
923 }
924
925 static int submodule_has_commits(struct repository *r,
926                                  const char *path,
927                                  struct oid_array *commits)
928 {
929         struct has_commit_data has_commit = { r, 1, path };
930
931         /*
932          * Perform a cheap, but incorrect check for the existence of 'commits'.
933          * This is done by adding the submodule's object store to the in-core
934          * object store, and then querying for each commit's existence.  If we
935          * do not have the commit object anywhere, there is no chance we have
936          * it in the object store of the correct submodule and have it
937          * reachable from a ref, so we can fail early without spawning rev-list
938          * which is expensive.
939          */
940         if (add_submodule_odb(path))
941                 return 0;
942
943         oid_array_for_each_unique(commits, check_has_commit, &has_commit);
944
945         if (has_commit.result) {
946                 /*
947                  * Even if the submodule is checked out and the commit is
948                  * present, make sure it exists in the submodule's object store
949                  * and that it is reachable from a ref.
950                  */
951                 struct child_process cp = CHILD_PROCESS_INIT;
952                 struct strbuf out = STRBUF_INIT;
953
954                 strvec_pushl(&cp.args, "rev-list", "-n", "1", NULL);
955                 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
956                 strvec_pushl(&cp.args, "--not", "--all", NULL);
957
958                 prepare_submodule_repo_env(&cp.env_array);
959                 cp.git_cmd = 1;
960                 cp.no_stdin = 1;
961                 cp.dir = path;
962
963                 if (capture_command(&cp, &out, GIT_MAX_HEXSZ + 1) || out.len)
964                         has_commit.result = 0;
965
966                 strbuf_release(&out);
967         }
968
969         return has_commit.result;
970 }
971
972 static int submodule_needs_pushing(struct repository *r,
973                                    const char *path,
974                                    struct oid_array *commits)
975 {
976         if (!submodule_has_commits(r, path, commits))
977                 /*
978                  * NOTE: We do consider it safe to return "no" here. The
979                  * correct answer would be "We do not know" instead of
980                  * "No push needed", but it is quite hard to change
981                  * the submodule pointer without having the submodule
982                  * around. If a user did however change the submodules
983                  * without having the submodule around, this indicates
984                  * an expert who knows what they are doing or a
985                  * maintainer integrating work from other people. In
986                  * both cases it should be safe to skip this check.
987                  */
988                 return 0;
989
990         if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
991                 struct child_process cp = CHILD_PROCESS_INIT;
992                 struct strbuf buf = STRBUF_INIT;
993                 int needs_pushing = 0;
994
995                 strvec_push(&cp.args, "rev-list");
996                 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
997                 strvec_pushl(&cp.args, "--not", "--remotes", "-n", "1" , NULL);
998
999                 prepare_submodule_repo_env(&cp.env_array);
1000                 cp.git_cmd = 1;
1001                 cp.no_stdin = 1;
1002                 cp.out = -1;
1003                 cp.dir = path;
1004                 if (start_command(&cp))
1005                         die(_("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s"),
1006                                         path);
1007                 if (strbuf_read(&buf, cp.out, the_hash_algo->hexsz + 1))
1008                         needs_pushing = 1;
1009                 finish_command(&cp);
1010                 close(cp.out);
1011                 strbuf_release(&buf);
1012                 return needs_pushing;
1013         }
1014
1015         return 0;
1016 }
1017
1018 int find_unpushed_submodules(struct repository *r,
1019                              struct oid_array *commits,
1020                              const char *remotes_name,
1021                              struct string_list *needs_pushing)
1022 {
1023         struct string_list submodules = STRING_LIST_INIT_DUP;
1024         struct string_list_item *name;
1025         struct strvec argv = STRVEC_INIT;
1026
1027         /* argv.v[0] will be ignored by setup_revisions */
1028         strvec_push(&argv, "find_unpushed_submodules");
1029         oid_array_for_each_unique(commits, append_oid_to_argv, &argv);
1030         strvec_push(&argv, "--not");
1031         strvec_pushf(&argv, "--remotes=%s", remotes_name);
1032
1033         collect_changed_submodules(r, &submodules, &argv);
1034
1035         for_each_string_list_item(name, &submodules) {
1036                 struct oid_array *commits = name->util;
1037                 const struct submodule *submodule;
1038                 const char *path = NULL;
1039
1040                 submodule = submodule_from_name(r, &null_oid, name->string);
1041                 if (submodule)
1042                         path = submodule->path;
1043                 else
1044                         path = default_name_or_path(name->string);
1045
1046                 if (!path)
1047                         continue;
1048
1049                 if (submodule_needs_pushing(r, path, commits))
1050                         string_list_insert(needs_pushing, path);
1051         }
1052
1053         free_submodules_oids(&submodules);
1054         strvec_clear(&argv);
1055
1056         return needs_pushing->nr;
1057 }
1058
1059 static int push_submodule(const char *path,
1060                           const struct remote *remote,
1061                           const struct refspec *rs,
1062                           const struct string_list *push_options,
1063                           int dry_run)
1064 {
1065         if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
1066                 struct child_process cp = CHILD_PROCESS_INIT;
1067                 strvec_push(&cp.args, "push");
1068                 if (dry_run)
1069                         strvec_push(&cp.args, "--dry-run");
1070
1071                 if (push_options && push_options->nr) {
1072                         const struct string_list_item *item;
1073                         for_each_string_list_item(item, push_options)
1074                                 strvec_pushf(&cp.args, "--push-option=%s",
1075                                              item->string);
1076                 }
1077
1078                 if (remote->origin != REMOTE_UNCONFIGURED) {
1079                         int i;
1080                         strvec_push(&cp.args, remote->name);
1081                         for (i = 0; i < rs->raw_nr; i++)
1082                                 strvec_push(&cp.args, rs->raw[i]);
1083                 }
1084
1085                 prepare_submodule_repo_env(&cp.env_array);
1086                 cp.git_cmd = 1;
1087                 cp.no_stdin = 1;
1088                 cp.dir = path;
1089                 if (run_command(&cp))
1090                         return 0;
1091                 close(cp.out);
1092         }
1093
1094         return 1;
1095 }
1096
1097 /*
1098  * Perform a check in the submodule to see if the remote and refspec work.
1099  * Die if the submodule can't be pushed.
1100  */
1101 static void submodule_push_check(const char *path, const char *head,
1102                                  const struct remote *remote,
1103                                  const struct refspec *rs)
1104 {
1105         struct child_process cp = CHILD_PROCESS_INIT;
1106         int i;
1107
1108         strvec_push(&cp.args, "submodule--helper");
1109         strvec_push(&cp.args, "push-check");
1110         strvec_push(&cp.args, head);
1111         strvec_push(&cp.args, remote->name);
1112
1113         for (i = 0; i < rs->raw_nr; i++)
1114                 strvec_push(&cp.args, rs->raw[i]);
1115
1116         prepare_submodule_repo_env(&cp.env_array);
1117         cp.git_cmd = 1;
1118         cp.no_stdin = 1;
1119         cp.no_stdout = 1;
1120         cp.dir = path;
1121
1122         /*
1123          * Simply indicate if 'submodule--helper push-check' failed.
1124          * More detailed error information will be provided by the
1125          * child process.
1126          */
1127         if (run_command(&cp))
1128                 die(_("process for submodule '%s' failed"), path);
1129 }
1130
1131 int push_unpushed_submodules(struct repository *r,
1132                              struct oid_array *commits,
1133                              const struct remote *remote,
1134                              const struct refspec *rs,
1135                              const struct string_list *push_options,
1136                              int dry_run)
1137 {
1138         int i, ret = 1;
1139         struct string_list needs_pushing = STRING_LIST_INIT_DUP;
1140
1141         if (!find_unpushed_submodules(r, commits,
1142                                       remote->name, &needs_pushing))
1143                 return 1;
1144
1145         /*
1146          * Verify that the remote and refspec can be propagated to all
1147          * submodules.  This check can be skipped if the remote and refspec
1148          * won't be propagated due to the remote being unconfigured (e.g. a URL
1149          * instead of a remote name).
1150          */
1151         if (remote->origin != REMOTE_UNCONFIGURED) {
1152                 char *head;
1153                 struct object_id head_oid;
1154
1155                 head = resolve_refdup("HEAD", 0, &head_oid, NULL);
1156                 if (!head)
1157                         die(_("Failed to resolve HEAD as a valid ref."));
1158
1159                 for (i = 0; i < needs_pushing.nr; i++)
1160                         submodule_push_check(needs_pushing.items[i].string,
1161                                              head, remote, rs);
1162                 free(head);
1163         }
1164
1165         /* Actually push the submodules */
1166         for (i = 0; i < needs_pushing.nr; i++) {
1167                 const char *path = needs_pushing.items[i].string;
1168                 fprintf(stderr, _("Pushing submodule '%s'\n"), path);
1169                 if (!push_submodule(path, remote, rs,
1170                                     push_options, dry_run)) {
1171                         fprintf(stderr, _("Unable to push submodule '%s'\n"), path);
1172                         ret = 0;
1173                 }
1174         }
1175
1176         string_list_clear(&needs_pushing, 0);
1177
1178         return ret;
1179 }
1180
1181 static int append_oid_to_array(const char *ref, const struct object_id *oid,
1182                                int flags, void *data)
1183 {
1184         struct oid_array *array = data;
1185         oid_array_append(array, oid);
1186         return 0;
1187 }
1188
1189 void check_for_new_submodule_commits(struct object_id *oid)
1190 {
1191         if (!initialized_fetch_ref_tips) {
1192                 for_each_ref(append_oid_to_array, &ref_tips_before_fetch);
1193                 initialized_fetch_ref_tips = 1;
1194         }
1195
1196         oid_array_append(&ref_tips_after_fetch, oid);
1197 }
1198
1199 static void calculate_changed_submodule_paths(struct repository *r,
1200                 struct string_list *changed_submodule_names)
1201 {
1202         struct strvec argv = STRVEC_INIT;
1203         struct string_list_item *name;
1204
1205         /* No need to check if there are no submodules configured */
1206         if (!submodule_from_path(r, NULL, NULL))
1207                 return;
1208
1209         strvec_push(&argv, "--"); /* argv[0] program name */
1210         oid_array_for_each_unique(&ref_tips_after_fetch,
1211                                    append_oid_to_argv, &argv);
1212         strvec_push(&argv, "--not");
1213         oid_array_for_each_unique(&ref_tips_before_fetch,
1214                                    append_oid_to_argv, &argv);
1215
1216         /*
1217          * Collect all submodules (whether checked out or not) for which new
1218          * commits have been recorded upstream in "changed_submodule_names".
1219          */
1220         collect_changed_submodules(r, changed_submodule_names, &argv);
1221
1222         for_each_string_list_item(name, changed_submodule_names) {
1223                 struct oid_array *commits = name->util;
1224                 const struct submodule *submodule;
1225                 const char *path = NULL;
1226
1227                 submodule = submodule_from_name(r, &null_oid, name->string);
1228                 if (submodule)
1229                         path = submodule->path;
1230                 else
1231                         path = default_name_or_path(name->string);
1232
1233                 if (!path)
1234                         continue;
1235
1236                 if (submodule_has_commits(r, path, commits)) {
1237                         oid_array_clear(commits);
1238                         *name->string = '\0';
1239                 }
1240         }
1241
1242         string_list_remove_empty_items(changed_submodule_names, 1);
1243
1244         strvec_clear(&argv);
1245         oid_array_clear(&ref_tips_before_fetch);
1246         oid_array_clear(&ref_tips_after_fetch);
1247         initialized_fetch_ref_tips = 0;
1248 }
1249
1250 int submodule_touches_in_range(struct repository *r,
1251                                struct object_id *excl_oid,
1252                                struct object_id *incl_oid)
1253 {
1254         struct string_list subs = STRING_LIST_INIT_DUP;
1255         struct strvec args = STRVEC_INIT;
1256         int ret;
1257
1258         /* No need to check if there are no submodules configured */
1259         if (!submodule_from_path(r, NULL, NULL))
1260                 return 0;
1261
1262         strvec_push(&args, "--"); /* args[0] program name */
1263         strvec_push(&args, oid_to_hex(incl_oid));
1264         if (!is_null_oid(excl_oid)) {
1265                 strvec_push(&args, "--not");
1266                 strvec_push(&args, oid_to_hex(excl_oid));
1267         }
1268
1269         collect_changed_submodules(r, &subs, &args);
1270         ret = subs.nr;
1271
1272         strvec_clear(&args);
1273
1274         free_submodules_oids(&subs);
1275         return ret;
1276 }
1277
1278 struct submodule_parallel_fetch {
1279         int count;
1280         struct strvec args;
1281         struct repository *r;
1282         const char *prefix;
1283         int command_line_option;
1284         int default_option;
1285         int quiet;
1286         int result;
1287
1288         struct string_list changed_submodule_names;
1289
1290         /* Pending fetches by OIDs */
1291         struct fetch_task **oid_fetch_tasks;
1292         int oid_fetch_tasks_nr, oid_fetch_tasks_alloc;
1293
1294         struct strbuf submodules_with_errors;
1295 };
1296 #define SPF_INIT {0, STRVEC_INIT, NULL, NULL, 0, 0, 0, 0, \
1297                   STRING_LIST_INIT_DUP, \
1298                   NULL, 0, 0, STRBUF_INIT}
1299
1300 static int get_fetch_recurse_config(const struct submodule *submodule,
1301                                     struct submodule_parallel_fetch *spf)
1302 {
1303         if (spf->command_line_option != RECURSE_SUBMODULES_DEFAULT)
1304                 return spf->command_line_option;
1305
1306         if (submodule) {
1307                 char *key;
1308                 const char *value;
1309
1310                 int fetch_recurse = submodule->fetch_recurse;
1311                 key = xstrfmt("submodule.%s.fetchRecurseSubmodules", submodule->name);
1312                 if (!repo_config_get_string_tmp(spf->r, key, &value)) {
1313                         fetch_recurse = parse_fetch_recurse_submodules_arg(key, value);
1314                 }
1315                 free(key);
1316
1317                 if (fetch_recurse != RECURSE_SUBMODULES_NONE)
1318                         /* local config overrules everything except commandline */
1319                         return fetch_recurse;
1320         }
1321
1322         return spf->default_option;
1323 }
1324
1325 /*
1326  * Fetch in progress (if callback data) or
1327  * pending (if in oid_fetch_tasks in struct submodule_parallel_fetch)
1328  */
1329 struct fetch_task {
1330         struct repository *repo;
1331         const struct submodule *sub;
1332         unsigned free_sub : 1; /* Do we need to free the submodule? */
1333
1334         struct oid_array *commits; /* Ensure these commits are fetched */
1335 };
1336
1337 /**
1338  * When a submodule is not defined in .gitmodules, we cannot access it
1339  * via the regular submodule-config. Create a fake submodule, which we can
1340  * work on.
1341  */
1342 static const struct submodule *get_non_gitmodules_submodule(const char *path)
1343 {
1344         struct submodule *ret = NULL;
1345         const char *name = default_name_or_path(path);
1346
1347         if (!name)
1348                 return NULL;
1349
1350         ret = xmalloc(sizeof(*ret));
1351         memset(ret, 0, sizeof(*ret));
1352         ret->path = name;
1353         ret->name = name;
1354
1355         return (const struct submodule *) ret;
1356 }
1357
1358 static struct fetch_task *fetch_task_create(struct repository *r,
1359                                             const char *path)
1360 {
1361         struct fetch_task *task = xmalloc(sizeof(*task));
1362         memset(task, 0, sizeof(*task));
1363
1364         task->sub = submodule_from_path(r, &null_oid, path);
1365         if (!task->sub) {
1366                 /*
1367                  * No entry in .gitmodules? Technically not a submodule,
1368                  * but historically we supported repositories that happen to be
1369                  * in-place where a gitlink is. Keep supporting them.
1370                  */
1371                 task->sub = get_non_gitmodules_submodule(path);
1372                 if (!task->sub) {
1373                         free(task);
1374                         return NULL;
1375                 }
1376
1377                 task->free_sub = 1;
1378         }
1379
1380         return task;
1381 }
1382
1383 static void fetch_task_release(struct fetch_task *p)
1384 {
1385         if (p->free_sub)
1386                 free((void*)p->sub);
1387         p->free_sub = 0;
1388         p->sub = NULL;
1389
1390         if (p->repo)
1391                 repo_clear(p->repo);
1392         FREE_AND_NULL(p->repo);
1393 }
1394
1395 static struct repository *get_submodule_repo_for(struct repository *r,
1396                                                  const struct submodule *sub)
1397 {
1398         struct repository *ret = xmalloc(sizeof(*ret));
1399
1400         if (repo_submodule_init(ret, r, sub)) {
1401                 /*
1402                  * No entry in .gitmodules? Technically not a submodule,
1403                  * but historically we supported repositories that happen to be
1404                  * in-place where a gitlink is. Keep supporting them.
1405                  */
1406                 struct strbuf gitdir = STRBUF_INIT;
1407                 strbuf_repo_worktree_path(&gitdir, r, "%s/.git", sub->path);
1408                 if (repo_init(ret, gitdir.buf, NULL)) {
1409                         strbuf_release(&gitdir);
1410                         free(ret);
1411                         return NULL;
1412                 }
1413                 strbuf_release(&gitdir);
1414         }
1415
1416         return ret;
1417 }
1418
1419 static int get_next_submodule(struct child_process *cp,
1420                               struct strbuf *err, void *data, void **task_cb)
1421 {
1422         struct submodule_parallel_fetch *spf = data;
1423
1424         for (; spf->count < spf->r->index->cache_nr; spf->count++) {
1425                 const struct cache_entry *ce = spf->r->index->cache[spf->count];
1426                 const char *default_argv;
1427                 struct fetch_task *task;
1428
1429                 if (!S_ISGITLINK(ce->ce_mode))
1430                         continue;
1431
1432                 task = fetch_task_create(spf->r, ce->name);
1433                 if (!task)
1434                         continue;
1435
1436                 switch (get_fetch_recurse_config(task->sub, spf))
1437                 {
1438                 default:
1439                 case RECURSE_SUBMODULES_DEFAULT:
1440                 case RECURSE_SUBMODULES_ON_DEMAND:
1441                         if (!task->sub ||
1442                             !string_list_lookup(
1443                                         &spf->changed_submodule_names,
1444                                         task->sub->name))
1445                                 continue;
1446                         default_argv = "on-demand";
1447                         break;
1448                 case RECURSE_SUBMODULES_ON:
1449                         default_argv = "yes";
1450                         break;
1451                 case RECURSE_SUBMODULES_OFF:
1452                         continue;
1453                 }
1454
1455                 task->repo = get_submodule_repo_for(spf->r, task->sub);
1456                 if (task->repo) {
1457                         struct strbuf submodule_prefix = STRBUF_INIT;
1458                         child_process_init(cp);
1459                         cp->dir = task->repo->gitdir;
1460                         prepare_submodule_repo_env_in_gitdir(&cp->env_array);
1461                         cp->git_cmd = 1;
1462                         if (!spf->quiet)
1463                                 strbuf_addf(err, _("Fetching submodule %s%s\n"),
1464                                             spf->prefix, ce->name);
1465                         strvec_init(&cp->args);
1466                         strvec_pushv(&cp->args, spf->args.v);
1467                         strvec_push(&cp->args, default_argv);
1468                         strvec_push(&cp->args, "--submodule-prefix");
1469
1470                         strbuf_addf(&submodule_prefix, "%s%s/",
1471                                                        spf->prefix,
1472                                                        task->sub->path);
1473                         strvec_push(&cp->args, submodule_prefix.buf);
1474
1475                         spf->count++;
1476                         *task_cb = task;
1477
1478                         strbuf_release(&submodule_prefix);
1479                         return 1;
1480                 } else {
1481                         struct strbuf empty_submodule_path = STRBUF_INIT;
1482
1483                         fetch_task_release(task);
1484                         free(task);
1485
1486                         /*
1487                          * An empty directory is normal,
1488                          * the submodule is not initialized
1489                          */
1490                         strbuf_addf(&empty_submodule_path, "%s/%s/",
1491                                                         spf->r->worktree,
1492                                                         ce->name);
1493                         if (S_ISGITLINK(ce->ce_mode) &&
1494                             !is_empty_dir(empty_submodule_path.buf)) {
1495                                 spf->result = 1;
1496                                 strbuf_addf(err,
1497                                             _("Could not access submodule '%s'\n"),
1498                                             ce->name);
1499                         }
1500                         strbuf_release(&empty_submodule_path);
1501                 }
1502         }
1503
1504         if (spf->oid_fetch_tasks_nr) {
1505                 struct fetch_task *task =
1506                         spf->oid_fetch_tasks[spf->oid_fetch_tasks_nr - 1];
1507                 struct strbuf submodule_prefix = STRBUF_INIT;
1508                 spf->oid_fetch_tasks_nr--;
1509
1510                 strbuf_addf(&submodule_prefix, "%s%s/",
1511                             spf->prefix, task->sub->path);
1512
1513                 child_process_init(cp);
1514                 prepare_submodule_repo_env_in_gitdir(&cp->env_array);
1515                 cp->git_cmd = 1;
1516                 cp->dir = task->repo->gitdir;
1517
1518                 strvec_init(&cp->args);
1519                 strvec_pushv(&cp->args, spf->args.v);
1520                 strvec_push(&cp->args, "on-demand");
1521                 strvec_push(&cp->args, "--submodule-prefix");
1522                 strvec_push(&cp->args, submodule_prefix.buf);
1523
1524                 /* NEEDSWORK: have get_default_remote from submodule--helper */
1525                 strvec_push(&cp->args, "origin");
1526                 oid_array_for_each_unique(task->commits,
1527                                           append_oid_to_argv, &cp->args);
1528
1529                 *task_cb = task;
1530                 strbuf_release(&submodule_prefix);
1531                 return 1;
1532         }
1533
1534         return 0;
1535 }
1536
1537 static int fetch_start_failure(struct strbuf *err,
1538                                void *cb, void *task_cb)
1539 {
1540         struct submodule_parallel_fetch *spf = cb;
1541         struct fetch_task *task = task_cb;
1542
1543         spf->result = 1;
1544
1545         fetch_task_release(task);
1546         return 0;
1547 }
1548
1549 static int commit_missing_in_sub(const struct object_id *oid, void *data)
1550 {
1551         struct repository *subrepo = data;
1552
1553         enum object_type type = oid_object_info(subrepo, oid, NULL);
1554
1555         return type != OBJ_COMMIT;
1556 }
1557
1558 static int fetch_finish(int retvalue, struct strbuf *err,
1559                         void *cb, void *task_cb)
1560 {
1561         struct submodule_parallel_fetch *spf = cb;
1562         struct fetch_task *task = task_cb;
1563
1564         struct string_list_item *it;
1565         struct oid_array *commits;
1566
1567         if (!task || !task->sub)
1568                 BUG("callback cookie bogus");
1569
1570         if (retvalue) {
1571                 /*
1572                  * NEEDSWORK: This indicates that the overall fetch
1573                  * failed, even though there may be a subsequent fetch
1574                  * by commit hash that might work. It may be a good
1575                  * idea to not indicate failure in this case, and only
1576                  * indicate failure if the subsequent fetch fails.
1577                  */
1578                 spf->result = 1;
1579
1580                 strbuf_addf(&spf->submodules_with_errors, "\t%s\n",
1581                             task->sub->name);
1582         }
1583
1584         /* Is this the second time we process this submodule? */
1585         if (task->commits)
1586                 goto out;
1587
1588         it = string_list_lookup(&spf->changed_submodule_names, task->sub->name);
1589         if (!it)
1590                 /* Could be an unchanged submodule, not contained in the list */
1591                 goto out;
1592
1593         commits = it->util;
1594         oid_array_filter(commits,
1595                          commit_missing_in_sub,
1596                          task->repo);
1597
1598         /* Are there commits we want, but do not exist? */
1599         if (commits->nr) {
1600                 task->commits = commits;
1601                 ALLOC_GROW(spf->oid_fetch_tasks,
1602                            spf->oid_fetch_tasks_nr + 1,
1603                            spf->oid_fetch_tasks_alloc);
1604                 spf->oid_fetch_tasks[spf->oid_fetch_tasks_nr] = task;
1605                 spf->oid_fetch_tasks_nr++;
1606                 return 0;
1607         }
1608
1609 out:
1610         fetch_task_release(task);
1611
1612         return 0;
1613 }
1614
1615 int fetch_populated_submodules(struct repository *r,
1616                                const struct strvec *options,
1617                                const char *prefix, int command_line_option,
1618                                int default_option,
1619                                int quiet, int max_parallel_jobs)
1620 {
1621         int i;
1622         struct submodule_parallel_fetch spf = SPF_INIT;
1623
1624         spf.r = r;
1625         spf.command_line_option = command_line_option;
1626         spf.default_option = default_option;
1627         spf.quiet = quiet;
1628         spf.prefix = prefix;
1629
1630         if (!r->worktree)
1631                 goto out;
1632
1633         if (repo_read_index(r) < 0)
1634                 die(_("index file corrupt"));
1635
1636         strvec_push(&spf.args, "fetch");
1637         for (i = 0; i < options->nr; i++)
1638                 strvec_push(&spf.args, options->v[i]);
1639         strvec_push(&spf.args, "--recurse-submodules-default");
1640         /* default value, "--submodule-prefix" and its value are added later */
1641
1642         calculate_changed_submodule_paths(r, &spf.changed_submodule_names);
1643         string_list_sort(&spf.changed_submodule_names);
1644         run_processes_parallel_tr2(max_parallel_jobs,
1645                                    get_next_submodule,
1646                                    fetch_start_failure,
1647                                    fetch_finish,
1648                                    &spf,
1649                                    "submodule", "parallel/fetch");
1650
1651         if (spf.submodules_with_errors.len > 0)
1652                 fprintf(stderr, _("Errors during submodule fetch:\n%s"),
1653                         spf.submodules_with_errors.buf);
1654
1655
1656         strvec_clear(&spf.args);
1657 out:
1658         free_submodules_oids(&spf.changed_submodule_names);
1659         return spf.result;
1660 }
1661
1662 unsigned is_submodule_modified(const char *path, int ignore_untracked)
1663 {
1664         struct child_process cp = CHILD_PROCESS_INIT;
1665         struct strbuf buf = STRBUF_INIT;
1666         FILE *fp;
1667         unsigned dirty_submodule = 0;
1668         const char *git_dir;
1669         int ignore_cp_exit_code = 0;
1670
1671         strbuf_addf(&buf, "%s/.git", path);
1672         git_dir = read_gitfile(buf.buf);
1673         if (!git_dir)
1674                 git_dir = buf.buf;
1675         if (!is_git_directory(git_dir)) {
1676                 if (is_directory(git_dir))
1677                         die(_("'%s' not recognized as a git repository"), git_dir);
1678                 strbuf_release(&buf);
1679                 /* The submodule is not checked out, so it is not modified */
1680                 return 0;
1681         }
1682         strbuf_reset(&buf);
1683
1684         strvec_pushl(&cp.args, "status", "--porcelain=2", NULL);
1685         if (ignore_untracked)
1686                 strvec_push(&cp.args, "-uno");
1687
1688         prepare_submodule_repo_env(&cp.env_array);
1689         cp.git_cmd = 1;
1690         cp.no_stdin = 1;
1691         cp.out = -1;
1692         cp.dir = path;
1693         if (start_command(&cp))
1694                 die(_("Could not run 'git status --porcelain=2' in submodule %s"), path);
1695
1696         fp = xfdopen(cp.out, "r");
1697         while (strbuf_getwholeline(&buf, fp, '\n') != EOF) {
1698                 /* regular untracked files */
1699                 if (buf.buf[0] == '?')
1700                         dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1701
1702                 if (buf.buf[0] == 'u' ||
1703                     buf.buf[0] == '1' ||
1704                     buf.buf[0] == '2') {
1705                         /* T = line type, XY = status, SSSS = submodule state */
1706                         if (buf.len < strlen("T XY SSSS"))
1707                                 BUG("invalid status --porcelain=2 line %s",
1708                                     buf.buf);
1709
1710                         if (buf.buf[5] == 'S' && buf.buf[8] == 'U')
1711                                 /* nested untracked file */
1712                                 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1713
1714                         if (buf.buf[0] == 'u' ||
1715                             buf.buf[0] == '2' ||
1716                             memcmp(buf.buf + 5, "S..U", 4))
1717                                 /* other change */
1718                                 dirty_submodule |= DIRTY_SUBMODULE_MODIFIED;
1719                 }
1720
1721                 if ((dirty_submodule & DIRTY_SUBMODULE_MODIFIED) &&
1722                     ((dirty_submodule & DIRTY_SUBMODULE_UNTRACKED) ||
1723                      ignore_untracked)) {
1724                         /*
1725                          * We're not interested in any further information from
1726                          * the child any more, neither output nor its exit code.
1727                          */
1728                         ignore_cp_exit_code = 1;
1729                         break;
1730                 }
1731         }
1732         fclose(fp);
1733
1734         if (finish_command(&cp) && !ignore_cp_exit_code)
1735                 die(_("'git status --porcelain=2' failed in submodule %s"), path);
1736
1737         strbuf_release(&buf);
1738         return dirty_submodule;
1739 }
1740
1741 int submodule_uses_gitfile(const char *path)
1742 {
1743         struct child_process cp = CHILD_PROCESS_INIT;
1744         struct strbuf buf = STRBUF_INIT;
1745         const char *git_dir;
1746
1747         strbuf_addf(&buf, "%s/.git", path);
1748         git_dir = read_gitfile(buf.buf);
1749         if (!git_dir) {
1750                 strbuf_release(&buf);
1751                 return 0;
1752         }
1753         strbuf_release(&buf);
1754
1755         /* Now test that all nested submodules use a gitfile too */
1756         strvec_pushl(&cp.args,
1757                      "submodule", "foreach", "--quiet", "--recursive",
1758                      "test -f .git", NULL);
1759
1760         prepare_submodule_repo_env(&cp.env_array);
1761         cp.git_cmd = 1;
1762         cp.no_stdin = 1;
1763         cp.no_stderr = 1;
1764         cp.no_stdout = 1;
1765         cp.dir = path;
1766         if (run_command(&cp))
1767                 return 0;
1768
1769         return 1;
1770 }
1771
1772 /*
1773  * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
1774  * when doing so.
1775  *
1776  * Return 1 if we'd lose data, return 0 if the removal is fine,
1777  * and negative values for errors.
1778  */
1779 int bad_to_remove_submodule(const char *path, unsigned flags)
1780 {
1781         ssize_t len;
1782         struct child_process cp = CHILD_PROCESS_INIT;
1783         struct strbuf buf = STRBUF_INIT;
1784         int ret = 0;
1785
1786         if (!file_exists(path) || is_empty_dir(path))
1787                 return 0;
1788
1789         if (!submodule_uses_gitfile(path))
1790                 return 1;
1791
1792         strvec_pushl(&cp.args, "status", "--porcelain",
1793                      "--ignore-submodules=none", NULL);
1794
1795         if (flags & SUBMODULE_REMOVAL_IGNORE_UNTRACKED)
1796                 strvec_push(&cp.args, "-uno");
1797         else
1798                 strvec_push(&cp.args, "-uall");
1799
1800         if (!(flags & SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED))
1801                 strvec_push(&cp.args, "--ignored");
1802
1803         prepare_submodule_repo_env(&cp.env_array);
1804         cp.git_cmd = 1;
1805         cp.no_stdin = 1;
1806         cp.out = -1;
1807         cp.dir = path;
1808         if (start_command(&cp)) {
1809                 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
1810                         die(_("could not start 'git status' in submodule '%s'"),
1811                                 path);
1812                 ret = -1;
1813                 goto out;
1814         }
1815
1816         len = strbuf_read(&buf, cp.out, 1024);
1817         if (len > 2)
1818                 ret = 1;
1819         close(cp.out);
1820
1821         if (finish_command(&cp)) {
1822                 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
1823                         die(_("could not run 'git status' in submodule '%s'"),
1824                                 path);
1825                 ret = -1;
1826         }
1827 out:
1828         strbuf_release(&buf);
1829         return ret;
1830 }
1831
1832 void submodule_unset_core_worktree(const struct submodule *sub)
1833 {
1834         char *config_path = xstrfmt("%s/modules/%s/config",
1835                                     get_git_dir(), sub->name);
1836
1837         if (git_config_set_in_file_gently(config_path, "core.worktree", NULL))
1838                 warning(_("Could not unset core.worktree setting in submodule '%s'"),
1839                           sub->path);
1840
1841         free(config_path);
1842 }
1843
1844 static const char *get_super_prefix_or_empty(void)
1845 {
1846         const char *s = get_super_prefix();
1847         if (!s)
1848                 s = "";
1849         return s;
1850 }
1851
1852 static int submodule_has_dirty_index(const struct submodule *sub)
1853 {
1854         struct child_process cp = CHILD_PROCESS_INIT;
1855
1856         prepare_submodule_repo_env(&cp.env_array);
1857
1858         cp.git_cmd = 1;
1859         strvec_pushl(&cp.args, "diff-index", "--quiet",
1860                      "--cached", "HEAD", NULL);
1861         cp.no_stdin = 1;
1862         cp.no_stdout = 1;
1863         cp.dir = sub->path;
1864         if (start_command(&cp))
1865                 die(_("could not recurse into submodule '%s'"), sub->path);
1866
1867         return finish_command(&cp);
1868 }
1869
1870 static void submodule_reset_index(const char *path)
1871 {
1872         struct child_process cp = CHILD_PROCESS_INIT;
1873         prepare_submodule_repo_env(&cp.env_array);
1874
1875         cp.git_cmd = 1;
1876         cp.no_stdin = 1;
1877         cp.dir = path;
1878
1879         strvec_pushf(&cp.args, "--super-prefix=%s%s/",
1880                      get_super_prefix_or_empty(), path);
1881         strvec_pushl(&cp.args, "read-tree", "-u", "--reset", NULL);
1882
1883         strvec_push(&cp.args, empty_tree_oid_hex());
1884
1885         if (run_command(&cp))
1886                 die(_("could not reset submodule index"));
1887 }
1888
1889 /**
1890  * Moves a submodule at a given path from a given head to another new head.
1891  * For edge cases (a submodule coming into existence or removing a submodule)
1892  * pass NULL for old or new respectively.
1893  */
1894 int submodule_move_head(const char *path,
1895                          const char *old_head,
1896                          const char *new_head,
1897                          unsigned flags)
1898 {
1899         int ret = 0;
1900         struct child_process cp = CHILD_PROCESS_INIT;
1901         const struct submodule *sub;
1902         int *error_code_ptr, error_code;
1903
1904         if (!is_submodule_active(the_repository, path))
1905                 return 0;
1906
1907         if (flags & SUBMODULE_MOVE_HEAD_FORCE)
1908                 /*
1909                  * Pass non NULL pointer to is_submodule_populated_gently
1910                  * to prevent die()-ing. We'll use connect_work_tree_and_git_dir
1911                  * to fixup the submodule in the force case later.
1912                  */
1913                 error_code_ptr = &error_code;
1914         else
1915                 error_code_ptr = NULL;
1916
1917         if (old_head && !is_submodule_populated_gently(path, error_code_ptr))
1918                 return 0;
1919
1920         sub = submodule_from_path(the_repository, &null_oid, path);
1921
1922         if (!sub)
1923                 BUG("could not get submodule information for '%s'", path);
1924
1925         if (old_head && !(flags & SUBMODULE_MOVE_HEAD_FORCE)) {
1926                 /* Check if the submodule has a dirty index. */
1927                 if (submodule_has_dirty_index(sub))
1928                         return error(_("submodule '%s' has dirty index"), path);
1929         }
1930
1931         if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
1932                 if (old_head) {
1933                         if (!submodule_uses_gitfile(path))
1934                                 absorb_git_dir_into_superproject(path,
1935                                         ABSORB_GITDIR_RECURSE_SUBMODULES);
1936                 } else {
1937                         char *gitdir = xstrfmt("%s/modules/%s",
1938                                     get_git_dir(), sub->name);
1939                         connect_work_tree_and_git_dir(path, gitdir, 0);
1940                         free(gitdir);
1941
1942                         /* make sure the index is clean as well */
1943                         submodule_reset_index(path);
1944                 }
1945
1946                 if (old_head && (flags & SUBMODULE_MOVE_HEAD_FORCE)) {
1947                         char *gitdir = xstrfmt("%s/modules/%s",
1948                                     get_git_dir(), sub->name);
1949                         connect_work_tree_and_git_dir(path, gitdir, 1);
1950                         free(gitdir);
1951                 }
1952         }
1953
1954         prepare_submodule_repo_env(&cp.env_array);
1955
1956         cp.git_cmd = 1;
1957         cp.no_stdin = 1;
1958         cp.dir = path;
1959
1960         strvec_pushf(&cp.args, "--super-prefix=%s%s/",
1961                      get_super_prefix_or_empty(), path);
1962         strvec_pushl(&cp.args, "read-tree", "--recurse-submodules", NULL);
1963
1964         if (flags & SUBMODULE_MOVE_HEAD_DRY_RUN)
1965                 strvec_push(&cp.args, "-n");
1966         else
1967                 strvec_push(&cp.args, "-u");
1968
1969         if (flags & SUBMODULE_MOVE_HEAD_FORCE)
1970                 strvec_push(&cp.args, "--reset");
1971         else
1972                 strvec_push(&cp.args, "-m");
1973
1974         if (!(flags & SUBMODULE_MOVE_HEAD_FORCE))
1975                 strvec_push(&cp.args, old_head ? old_head : empty_tree_oid_hex());
1976
1977         strvec_push(&cp.args, new_head ? new_head : empty_tree_oid_hex());
1978
1979         if (run_command(&cp)) {
1980                 ret = error(_("Submodule '%s' could not be updated."), path);
1981                 goto out;
1982         }
1983
1984         if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
1985                 if (new_head) {
1986                         child_process_init(&cp);
1987                         /* also set the HEAD accordingly */
1988                         cp.git_cmd = 1;
1989                         cp.no_stdin = 1;
1990                         cp.dir = path;
1991
1992                         prepare_submodule_repo_env(&cp.env_array);
1993                         strvec_pushl(&cp.args, "update-ref", "HEAD",
1994                                      "--no-deref", new_head, NULL);
1995
1996                         if (run_command(&cp)) {
1997                                 ret = -1;
1998                                 goto out;
1999                         }
2000                 } else {
2001                         struct strbuf sb = STRBUF_INIT;
2002
2003                         strbuf_addf(&sb, "%s/.git", path);
2004                         unlink_or_warn(sb.buf);
2005                         strbuf_release(&sb);
2006
2007                         if (is_empty_dir(path))
2008                                 rmdir_or_warn(path);
2009
2010                         submodule_unset_core_worktree(sub);
2011                 }
2012         }
2013 out:
2014         return ret;
2015 }
2016
2017 int validate_submodule_git_dir(char *git_dir, const char *submodule_name)
2018 {
2019         size_t len = strlen(git_dir), suffix_len = strlen(submodule_name);
2020         char *p;
2021         int ret = 0;
2022
2023         if (len <= suffix_len || (p = git_dir + len - suffix_len)[-1] != '/' ||
2024             strcmp(p, submodule_name))
2025                 BUG("submodule name '%s' not a suffix of git dir '%s'",
2026                     submodule_name, git_dir);
2027
2028         /*
2029          * We prevent the contents of sibling submodules' git directories to
2030          * clash.
2031          *
2032          * Example: having a submodule named `hippo` and another one named
2033          * `hippo/hooks` would result in the git directories
2034          * `.git/modules/hippo/` and `.git/modules/hippo/hooks/`, respectively,
2035          * but the latter directory is already designated to contain the hooks
2036          * of the former.
2037          */
2038         for (; *p; p++) {
2039                 if (is_dir_sep(*p)) {
2040                         char c = *p;
2041
2042                         *p = '\0';
2043                         if (is_git_directory(git_dir))
2044                                 ret = -1;
2045                         *p = c;
2046
2047                         if (ret < 0)
2048                                 return error(_("submodule git dir '%s' is "
2049                                                "inside git dir '%.*s'"),
2050                                              git_dir,
2051                                              (int)(p - git_dir), git_dir);
2052                 }
2053         }
2054
2055         return 0;
2056 }
2057
2058 /*
2059  * Embeds a single submodules git directory into the superprojects git dir,
2060  * non recursively.
2061  */
2062 static void relocate_single_git_dir_into_superproject(const char *path)
2063 {
2064         char *old_git_dir = NULL, *real_old_git_dir = NULL, *real_new_git_dir = NULL;
2065         char *new_git_dir;
2066         const struct submodule *sub;
2067
2068         if (submodule_uses_worktrees(path))
2069                 die(_("relocate_gitdir for submodule '%s' with "
2070                       "more than one worktree not supported"), path);
2071
2072         old_git_dir = xstrfmt("%s/.git", path);
2073         if (read_gitfile(old_git_dir))
2074                 /* If it is an actual gitfile, it doesn't need migration. */
2075                 return;
2076
2077         real_old_git_dir = real_pathdup(old_git_dir, 1);
2078
2079         sub = submodule_from_path(the_repository, &null_oid, path);
2080         if (!sub)
2081                 die(_("could not lookup name for submodule '%s'"), path);
2082
2083         new_git_dir = git_pathdup("modules/%s", sub->name);
2084         if (validate_submodule_git_dir(new_git_dir, sub->name) < 0)
2085                 die(_("refusing to move '%s' into an existing git dir"),
2086                     real_old_git_dir);
2087         if (safe_create_leading_directories_const(new_git_dir) < 0)
2088                 die(_("could not create directory '%s'"), new_git_dir);
2089         real_new_git_dir = real_pathdup(new_git_dir, 1);
2090         free(new_git_dir);
2091
2092         fprintf(stderr, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
2093                 get_super_prefix_or_empty(), path,
2094                 real_old_git_dir, real_new_git_dir);
2095
2096         relocate_gitdir(path, real_old_git_dir, real_new_git_dir);
2097
2098         free(old_git_dir);
2099         free(real_old_git_dir);
2100         free(real_new_git_dir);
2101 }
2102
2103 /*
2104  * Migrate the git directory of the submodule given by path from
2105  * having its git directory within the working tree to the git dir nested
2106  * in its superprojects git dir under modules/.
2107  */
2108 void absorb_git_dir_into_superproject(const char *path,
2109                                       unsigned flags)
2110 {
2111         int err_code;
2112         const char *sub_git_dir;
2113         struct strbuf gitdir = STRBUF_INIT;
2114         strbuf_addf(&gitdir, "%s/.git", path);
2115         sub_git_dir = resolve_gitdir_gently(gitdir.buf, &err_code);
2116
2117         /* Not populated? */
2118         if (!sub_git_dir) {
2119                 const struct submodule *sub;
2120
2121                 if (err_code == READ_GITFILE_ERR_STAT_FAILED) {
2122                         /* unpopulated as expected */
2123                         strbuf_release(&gitdir);
2124                         return;
2125                 }
2126
2127                 if (err_code != READ_GITFILE_ERR_NOT_A_REPO)
2128                         /* We don't know what broke here. */
2129                         read_gitfile_error_die(err_code, path, NULL);
2130
2131                 /*
2132                 * Maybe populated, but no git directory was found?
2133                 * This can happen if the superproject is a submodule
2134                 * itself and was just absorbed. The absorption of the
2135                 * superproject did not rewrite the git file links yet,
2136                 * fix it now.
2137                 */
2138                 sub = submodule_from_path(the_repository, &null_oid, path);
2139                 if (!sub)
2140                         die(_("could not lookup name for submodule '%s'"), path);
2141                 connect_work_tree_and_git_dir(path,
2142                         git_path("modules/%s", sub->name), 0);
2143         } else {
2144                 /* Is it already absorbed into the superprojects git dir? */
2145                 char *real_sub_git_dir = real_pathdup(sub_git_dir, 1);
2146                 char *real_common_git_dir = real_pathdup(get_git_common_dir(), 1);
2147
2148                 if (!starts_with(real_sub_git_dir, real_common_git_dir))
2149                         relocate_single_git_dir_into_superproject(path);
2150
2151                 free(real_sub_git_dir);
2152                 free(real_common_git_dir);
2153         }
2154         strbuf_release(&gitdir);
2155
2156         if (flags & ABSORB_GITDIR_RECURSE_SUBMODULES) {
2157                 struct child_process cp = CHILD_PROCESS_INIT;
2158                 struct strbuf sb = STRBUF_INIT;
2159
2160                 if (flags & ~ABSORB_GITDIR_RECURSE_SUBMODULES)
2161                         BUG("we don't know how to pass the flags down?");
2162
2163                 strbuf_addstr(&sb, get_super_prefix_or_empty());
2164                 strbuf_addstr(&sb, path);
2165                 strbuf_addch(&sb, '/');
2166
2167                 cp.dir = path;
2168                 cp.git_cmd = 1;
2169                 cp.no_stdin = 1;
2170                 strvec_pushl(&cp.args, "--super-prefix", sb.buf,
2171                              "submodule--helper",
2172                              "absorb-git-dirs", NULL);
2173                 prepare_submodule_repo_env(&cp.env_array);
2174                 if (run_command(&cp))
2175                         die(_("could not recurse into submodule '%s'"), path);
2176
2177                 strbuf_release(&sb);
2178         }
2179 }
2180
2181 int get_superproject_working_tree(struct strbuf *buf)
2182 {
2183         struct child_process cp = CHILD_PROCESS_INIT;
2184         struct strbuf sb = STRBUF_INIT;
2185         struct strbuf one_up = STRBUF_INIT;
2186         const char *cwd = xgetcwd();
2187         int ret = 0;
2188         const char *subpath;
2189         int code;
2190         ssize_t len;
2191
2192         if (!is_inside_work_tree())
2193                 /*
2194                  * FIXME:
2195                  * We might have a superproject, but it is harder
2196                  * to determine.
2197                  */
2198                 return 0;
2199
2200         if (!strbuf_realpath(&one_up, "../", 0))
2201                 return 0;
2202
2203         subpath = relative_path(cwd, one_up.buf, &sb);
2204         strbuf_release(&one_up);
2205
2206         prepare_submodule_repo_env(&cp.env_array);
2207         strvec_pop(&cp.env_array);
2208
2209         strvec_pushl(&cp.args, "--literal-pathspecs", "-C", "..",
2210                      "ls-files", "-z", "--stage", "--full-name", "--",
2211                      subpath, NULL);
2212         strbuf_reset(&sb);
2213
2214         cp.no_stdin = 1;
2215         cp.no_stderr = 1;
2216         cp.out = -1;
2217         cp.git_cmd = 1;
2218
2219         if (start_command(&cp))
2220                 die(_("could not start ls-files in .."));
2221
2222         len = strbuf_read(&sb, cp.out, PATH_MAX);
2223         close(cp.out);
2224
2225         if (starts_with(sb.buf, "160000")) {
2226                 int super_sub_len;
2227                 int cwd_len = strlen(cwd);
2228                 char *super_sub, *super_wt;
2229
2230                 /*
2231                  * There is a superproject having this repo as a submodule.
2232                  * The format is <mode> SP <hash> SP <stage> TAB <full name> \0,
2233                  * We're only interested in the name after the tab.
2234                  */
2235                 super_sub = strchr(sb.buf, '\t') + 1;
2236                 super_sub_len = strlen(super_sub);
2237
2238                 if (super_sub_len > cwd_len ||
2239                     strcmp(&cwd[cwd_len - super_sub_len], super_sub))
2240                         BUG("returned path string doesn't match cwd?");
2241
2242                 super_wt = xstrdup(cwd);
2243                 super_wt[cwd_len - super_sub_len] = '\0';
2244
2245                 strbuf_realpath(buf, super_wt, 1);
2246                 ret = 1;
2247                 free(super_wt);
2248         }
2249         strbuf_release(&sb);
2250
2251         code = finish_command(&cp);
2252
2253         if (code == 128)
2254                 /* '../' is not a git repository */
2255                 return 0;
2256         if (code == 0 && len == 0)
2257                 /* There is an unrelated git repository at '../' */
2258                 return 0;
2259         if (code)
2260                 die(_("ls-tree returned unexpected return code %d"), code);
2261
2262         return ret;
2263 }
2264
2265 /*
2266  * Put the gitdir for a submodule (given relative to the main
2267  * repository worktree) into `buf`, or return -1 on error.
2268  */
2269 int submodule_to_gitdir(struct strbuf *buf, const char *submodule)
2270 {
2271         const struct submodule *sub;
2272         const char *git_dir;
2273         int ret = 0;
2274
2275         strbuf_reset(buf);
2276         strbuf_addstr(buf, submodule);
2277         strbuf_complete(buf, '/');
2278         strbuf_addstr(buf, ".git");
2279
2280         git_dir = read_gitfile(buf->buf);
2281         if (git_dir) {
2282                 strbuf_reset(buf);
2283                 strbuf_addstr(buf, git_dir);
2284         }
2285         if (!is_git_directory(buf->buf)) {
2286                 sub = submodule_from_path(the_repository, &null_oid, submodule);
2287                 if (!sub) {
2288                         ret = -1;
2289                         goto cleanup;
2290                 }
2291                 strbuf_reset(buf);
2292                 strbuf_git_path(buf, "%s/%s", "modules", sub->name);
2293         }
2294
2295 cleanup:
2296         return ret;
2297 }