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