Merge branch 'jc/renormalize-merge-kill-safer-crlf' into maint
[git] / submodule.c
1 #include "cache.h"
2 #include "submodule-config.h"
3 #include "submodule.h"
4 #include "dir.h"
5 #include "diff.h"
6 #include "commit.h"
7 #include "revision.h"
8 #include "run-command.h"
9 #include "diffcore.h"
10 #include "refs.h"
11 #include "string-list.h"
12 #include "sha1-array.h"
13 #include "argv-array.h"
14 #include "blob.h"
15 #include "thread-utils.h"
16 #include "quote.h"
17
18 static int config_fetch_recurse_submodules = RECURSE_SUBMODULES_ON_DEMAND;
19 static int parallel_jobs = 1;
20 static struct string_list changed_submodule_paths = STRING_LIST_INIT_NODUP;
21 static int initialized_fetch_ref_tips;
22 static struct sha1_array ref_tips_before_fetch;
23 static struct sha1_array ref_tips_after_fetch;
24
25 /*
26  * The following flag is set if the .gitmodules file is unmerged. We then
27  * disable recursion for all submodules where .git/config doesn't have a
28  * matching config entry because we can't guess what might be configured in
29  * .gitmodules unless the user resolves the conflict. When a command line
30  * option is given (which always overrides configuration) this flag will be
31  * ignored.
32  */
33 static int gitmodules_is_unmerged;
34
35 /*
36  * This flag is set if the .gitmodules file had unstaged modifications on
37  * startup. This must be checked before allowing modifications to the
38  * .gitmodules file with the intention to stage them later, because when
39  * continuing we would stage the modifications the user didn't stage herself
40  * too. That might change in a future version when we learn to stage the
41  * changes we do ourselves without staging any previous modifications.
42  */
43 static int gitmodules_is_modified;
44
45 int is_staging_gitmodules_ok(void)
46 {
47         return !gitmodules_is_modified;
48 }
49
50 /*
51  * Try to update the "path" entry in the "submodule.<name>" section of the
52  * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
53  * with the correct path=<oldpath> setting was found and we could update it.
54  */
55 int update_path_in_gitmodules(const char *oldpath, const char *newpath)
56 {
57         struct strbuf entry = STRBUF_INIT;
58         const struct submodule *submodule;
59
60         if (!file_exists(".gitmodules")) /* Do nothing without .gitmodules */
61                 return -1;
62
63         if (gitmodules_is_unmerged)
64                 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
65
66         submodule = submodule_from_path(null_sha1, oldpath);
67         if (!submodule || !submodule->name) {
68                 warning(_("Could not find section in .gitmodules where path=%s"), oldpath);
69                 return -1;
70         }
71         strbuf_addstr(&entry, "submodule.");
72         strbuf_addstr(&entry, submodule->name);
73         strbuf_addstr(&entry, ".path");
74         if (git_config_set_in_file_gently(".gitmodules", entry.buf, newpath) < 0) {
75                 /* Maybe the user already did that, don't error out here */
76                 warning(_("Could not update .gitmodules entry %s"), entry.buf);
77                 strbuf_release(&entry);
78                 return -1;
79         }
80         strbuf_release(&entry);
81         return 0;
82 }
83
84 /*
85  * Try to remove the "submodule.<name>" section from .gitmodules where the given
86  * path is configured. Return 0 only if a .gitmodules file was found, a section
87  * with the correct path=<path> setting was found and we could remove it.
88  */
89 int remove_path_from_gitmodules(const char *path)
90 {
91         struct strbuf sect = STRBUF_INIT;
92         const struct submodule *submodule;
93
94         if (!file_exists(".gitmodules")) /* Do nothing without .gitmodules */
95                 return -1;
96
97         if (gitmodules_is_unmerged)
98                 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
99
100         submodule = submodule_from_path(null_sha1, path);
101         if (!submodule || !submodule->name) {
102                 warning(_("Could not find section in .gitmodules where path=%s"), path);
103                 return -1;
104         }
105         strbuf_addstr(&sect, "submodule.");
106         strbuf_addstr(&sect, submodule->name);
107         if (git_config_rename_section_in_file(".gitmodules", sect.buf, NULL) < 0) {
108                 /* Maybe the user already did that, don't error out here */
109                 warning(_("Could not remove .gitmodules entry for %s"), path);
110                 strbuf_release(&sect);
111                 return -1;
112         }
113         strbuf_release(&sect);
114         return 0;
115 }
116
117 void stage_updated_gitmodules(void)
118 {
119         if (add_file_to_cache(".gitmodules", 0))
120                 die(_("staging updated .gitmodules failed"));
121 }
122
123 static int add_submodule_odb(const char *path)
124 {
125         struct strbuf objects_directory = STRBUF_INIT;
126         int ret = 0;
127
128         ret = strbuf_git_path_submodule(&objects_directory, path, "objects/");
129         if (ret)
130                 goto done;
131         if (!is_directory(objects_directory.buf)) {
132                 ret = -1;
133                 goto done;
134         }
135         add_to_alternates_memory(objects_directory.buf);
136 done:
137         strbuf_release(&objects_directory);
138         return ret;
139 }
140
141 void set_diffopt_flags_from_submodule_config(struct diff_options *diffopt,
142                                              const char *path)
143 {
144         const struct submodule *submodule = submodule_from_path(null_sha1, path);
145         if (submodule) {
146                 if (submodule->ignore)
147                         handle_ignore_submodules_arg(diffopt, submodule->ignore);
148                 else if (gitmodules_is_unmerged)
149                         DIFF_OPT_SET(diffopt, IGNORE_SUBMODULES);
150         }
151 }
152
153 int submodule_config(const char *var, const char *value, void *cb)
154 {
155         if (!strcmp(var, "submodule.fetchjobs")) {
156                 parallel_jobs = git_config_int(var, value);
157                 if (parallel_jobs < 0)
158                         die(_("negative values not allowed for submodule.fetchJobs"));
159                 return 0;
160         } else if (starts_with(var, "submodule."))
161                 return parse_submodule_config_option(var, value);
162         else if (!strcmp(var, "fetch.recursesubmodules")) {
163                 config_fetch_recurse_submodules = parse_fetch_recurse_submodules_arg(var, value);
164                 return 0;
165         }
166         return 0;
167 }
168
169 void gitmodules_config(void)
170 {
171         const char *work_tree = get_git_work_tree();
172         if (work_tree) {
173                 struct strbuf gitmodules_path = STRBUF_INIT;
174                 int pos;
175                 strbuf_addstr(&gitmodules_path, work_tree);
176                 strbuf_addstr(&gitmodules_path, "/.gitmodules");
177                 if (read_cache() < 0)
178                         die("index file corrupt");
179                 pos = cache_name_pos(".gitmodules", 11);
180                 if (pos < 0) { /* .gitmodules not found or isn't merged */
181                         pos = -1 - pos;
182                         if (active_nr > pos) {  /* there is a .gitmodules */
183                                 const struct cache_entry *ce = active_cache[pos];
184                                 if (ce_namelen(ce) == 11 &&
185                                     !memcmp(ce->name, ".gitmodules", 11))
186                                         gitmodules_is_unmerged = 1;
187                         }
188                 } else if (pos < active_nr) {
189                         struct stat st;
190                         if (lstat(".gitmodules", &st) == 0 &&
191                             ce_match_stat(active_cache[pos], &st, 0) & DATA_CHANGED)
192                                 gitmodules_is_modified = 1;
193                 }
194
195                 if (!gitmodules_is_unmerged)
196                         git_config_from_file(submodule_config, gitmodules_path.buf, NULL);
197                 strbuf_release(&gitmodules_path);
198         }
199 }
200
201 int parse_submodule_update_strategy(const char *value,
202                 struct submodule_update_strategy *dst)
203 {
204         free((void*)dst->command);
205         dst->command = NULL;
206         if (!strcmp(value, "none"))
207                 dst->type = SM_UPDATE_NONE;
208         else if (!strcmp(value, "checkout"))
209                 dst->type = SM_UPDATE_CHECKOUT;
210         else if (!strcmp(value, "rebase"))
211                 dst->type = SM_UPDATE_REBASE;
212         else if (!strcmp(value, "merge"))
213                 dst->type = SM_UPDATE_MERGE;
214         else if (skip_prefix(value, "!", &value)) {
215                 dst->type = SM_UPDATE_COMMAND;
216                 dst->command = xstrdup(value);
217         } else
218                 return -1;
219         return 0;
220 }
221
222 const char *submodule_strategy_to_string(const struct submodule_update_strategy *s)
223 {
224         struct strbuf sb = STRBUF_INIT;
225         switch (s->type) {
226         case SM_UPDATE_CHECKOUT:
227                 return "checkout";
228         case SM_UPDATE_MERGE:
229                 return "merge";
230         case SM_UPDATE_REBASE:
231                 return "rebase";
232         case SM_UPDATE_NONE:
233                 return "none";
234         case SM_UPDATE_UNSPECIFIED:
235                 return NULL;
236         case SM_UPDATE_COMMAND:
237                 strbuf_addf(&sb, "!%s", s->command);
238                 return strbuf_detach(&sb, NULL);
239         }
240         return NULL;
241 }
242
243 void handle_ignore_submodules_arg(struct diff_options *diffopt,
244                                   const char *arg)
245 {
246         DIFF_OPT_CLR(diffopt, IGNORE_SUBMODULES);
247         DIFF_OPT_CLR(diffopt, IGNORE_UNTRACKED_IN_SUBMODULES);
248         DIFF_OPT_CLR(diffopt, IGNORE_DIRTY_SUBMODULES);
249
250         if (!strcmp(arg, "all"))
251                 DIFF_OPT_SET(diffopt, IGNORE_SUBMODULES);
252         else if (!strcmp(arg, "untracked"))
253                 DIFF_OPT_SET(diffopt, IGNORE_UNTRACKED_IN_SUBMODULES);
254         else if (!strcmp(arg, "dirty"))
255                 DIFF_OPT_SET(diffopt, IGNORE_DIRTY_SUBMODULES);
256         else if (strcmp(arg, "none"))
257                 die("bad --ignore-submodules argument: %s", arg);
258 }
259
260 static int prepare_submodule_summary(struct rev_info *rev, const char *path,
261                 struct commit *left, struct commit *right,
262                 struct commit_list *merge_bases)
263 {
264         struct commit_list *list;
265
266         init_revisions(rev, NULL);
267         setup_revisions(0, NULL, rev, NULL);
268         rev->left_right = 1;
269         rev->first_parent_only = 1;
270         left->object.flags |= SYMMETRIC_LEFT;
271         add_pending_object(rev, &left->object, path);
272         add_pending_object(rev, &right->object, path);
273         for (list = merge_bases; list; list = list->next) {
274                 list->item->object.flags |= UNINTERESTING;
275                 add_pending_object(rev, &list->item->object,
276                         oid_to_hex(&list->item->object.oid));
277         }
278         return prepare_revision_walk(rev);
279 }
280
281 static void print_submodule_summary(struct rev_info *rev, FILE *f,
282                 const char *line_prefix,
283                 const char *del, const char *add, const char *reset)
284 {
285         static const char format[] = "  %m %s";
286         struct strbuf sb = STRBUF_INIT;
287         struct commit *commit;
288
289         while ((commit = get_revision(rev))) {
290                 struct pretty_print_context ctx = {0};
291                 ctx.date_mode = rev->date_mode;
292                 ctx.output_encoding = get_log_output_encoding();
293                 strbuf_setlen(&sb, 0);
294                 strbuf_addstr(&sb, line_prefix);
295                 if (commit->object.flags & SYMMETRIC_LEFT) {
296                         if (del)
297                                 strbuf_addstr(&sb, del);
298                 }
299                 else if (add)
300                         strbuf_addstr(&sb, add);
301                 format_commit_message(commit, format, &sb, &ctx);
302                 if (reset)
303                         strbuf_addstr(&sb, reset);
304                 strbuf_addch(&sb, '\n');
305                 fprintf(f, "%s", sb.buf);
306         }
307         strbuf_release(&sb);
308 }
309
310 /* Helper function to display the submodule header line prior to the full
311  * summary output. If it can locate the submodule objects directory it will
312  * attempt to lookup both the left and right commits and put them into the
313  * left and right pointers.
314  */
315 static void show_submodule_header(FILE *f, const char *path,
316                 const char *line_prefix,
317                 struct object_id *one, struct object_id *two,
318                 unsigned dirty_submodule, const char *meta,
319                 const char *reset,
320                 struct commit **left, struct commit **right,
321                 struct commit_list **merge_bases)
322 {
323         const char *message = NULL;
324         struct strbuf sb = STRBUF_INIT;
325         int fast_forward = 0, fast_backward = 0;
326
327         if (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED)
328                 fprintf(f, "%sSubmodule %s contains untracked content\n",
329                         line_prefix, path);
330         if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
331                 fprintf(f, "%sSubmodule %s contains modified content\n",
332                         line_prefix, path);
333
334         if (is_null_oid(one))
335                 message = "(new submodule)";
336         else if (is_null_oid(two))
337                 message = "(submodule deleted)";
338
339         if (add_submodule_odb(path)) {
340                 if (!message)
341                         message = "(not initialized)";
342                 goto output_header;
343         }
344
345         /*
346          * Attempt to lookup the commit references, and determine if this is
347          * a fast forward or fast backwards update.
348          */
349         *left = lookup_commit_reference(one->hash);
350         *right = lookup_commit_reference(two->hash);
351
352         /*
353          * Warn about missing commits in the submodule project, but only if
354          * they aren't null.
355          */
356         if ((!is_null_oid(one) && !*left) ||
357              (!is_null_oid(two) && !*right))
358                 message = "(commits not present)";
359
360         *merge_bases = get_merge_bases(*left, *right);
361         if (*merge_bases) {
362                 if ((*merge_bases)->item == *left)
363                         fast_forward = 1;
364                 else if ((*merge_bases)->item == *right)
365                         fast_backward = 1;
366         }
367
368         if (!oidcmp(one, two)) {
369                 strbuf_release(&sb);
370                 return;
371         }
372
373 output_header:
374         strbuf_addf(&sb, "%s%sSubmodule %s ", line_prefix, meta, path);
375         strbuf_add_unique_abbrev(&sb, one->hash, DEFAULT_ABBREV);
376         strbuf_addstr(&sb, (fast_backward || fast_forward) ? ".." : "...");
377         strbuf_add_unique_abbrev(&sb, two->hash, DEFAULT_ABBREV);
378         if (message)
379                 strbuf_addf(&sb, " %s%s\n", message, reset);
380         else
381                 strbuf_addf(&sb, "%s:%s\n", fast_backward ? " (rewind)" : "", reset);
382         fwrite(sb.buf, sb.len, 1, f);
383
384         strbuf_release(&sb);
385 }
386
387 void show_submodule_summary(FILE *f, const char *path,
388                 const char *line_prefix,
389                 struct object_id *one, struct object_id *two,
390                 unsigned dirty_submodule, const char *meta,
391                 const char *del, const char *add, const char *reset)
392 {
393         struct rev_info rev;
394         struct commit *left = NULL, *right = NULL;
395         struct commit_list *merge_bases = NULL;
396
397         show_submodule_header(f, path, line_prefix, one, two, dirty_submodule,
398                               meta, reset, &left, &right, &merge_bases);
399
400         /*
401          * If we don't have both a left and a right pointer, there is no
402          * reason to try and display a summary. The header line should contain
403          * all the information the user needs.
404          */
405         if (!left || !right)
406                 goto out;
407
408         /* Treat revision walker failure the same as missing commits */
409         if (prepare_submodule_summary(&rev, path, left, right, merge_bases)) {
410                 fprintf(f, "%s(revision walker failed)\n", line_prefix);
411                 goto out;
412         }
413
414         print_submodule_summary(&rev, f, line_prefix, del, add, reset);
415
416 out:
417         if (merge_bases)
418                 free_commit_list(merge_bases);
419         clear_commit_marks(left, ~0);
420         clear_commit_marks(right, ~0);
421 }
422
423 void show_submodule_inline_diff(FILE *f, const char *path,
424                 const char *line_prefix,
425                 struct object_id *one, struct object_id *two,
426                 unsigned dirty_submodule, const char *meta,
427                 const char *del, const char *add, const char *reset,
428                 const struct diff_options *o)
429 {
430         const struct object_id *old = &empty_tree_oid, *new = &empty_tree_oid;
431         struct commit *left = NULL, *right = NULL;
432         struct commit_list *merge_bases = NULL;
433         struct strbuf submodule_dir = STRBUF_INIT;
434         struct child_process cp = CHILD_PROCESS_INIT;
435
436         show_submodule_header(f, path, line_prefix, one, two, dirty_submodule,
437                               meta, reset, &left, &right, &merge_bases);
438
439         /* We need a valid left and right commit to display a difference */
440         if (!(left || is_null_oid(one)) ||
441             !(right || is_null_oid(two)))
442                 goto done;
443
444         if (left)
445                 old = one;
446         if (right)
447                 new = two;
448
449         fflush(f);
450         cp.git_cmd = 1;
451         cp.dir = path;
452         cp.out = dup(fileno(f));
453         cp.no_stdin = 1;
454
455         /* TODO: other options may need to be passed here. */
456         argv_array_push(&cp.args, "diff");
457         argv_array_pushf(&cp.args, "--line-prefix=%s", line_prefix);
458         if (DIFF_OPT_TST(o, REVERSE_DIFF)) {
459                 argv_array_pushf(&cp.args, "--src-prefix=%s%s/",
460                                  o->b_prefix, path);
461                 argv_array_pushf(&cp.args, "--dst-prefix=%s%s/",
462                                  o->a_prefix, path);
463         } else {
464                 argv_array_pushf(&cp.args, "--src-prefix=%s%s/",
465                                  o->a_prefix, path);
466                 argv_array_pushf(&cp.args, "--dst-prefix=%s%s/",
467                                  o->b_prefix, path);
468         }
469         argv_array_push(&cp.args, oid_to_hex(old));
470         /*
471          * If the submodule has modified content, we will diff against the
472          * work tree, under the assumption that the user has asked for the
473          * diff format and wishes to actually see all differences even if they
474          * haven't yet been committed to the submodule yet.
475          */
476         if (!(dirty_submodule & DIRTY_SUBMODULE_MODIFIED))
477                 argv_array_push(&cp.args, oid_to_hex(new));
478
479         if (run_command(&cp))
480                 fprintf(f, "(diff failed)\n");
481
482 done:
483         strbuf_release(&submodule_dir);
484         if (merge_bases)
485                 free_commit_list(merge_bases);
486         if (left)
487                 clear_commit_marks(left, ~0);
488         if (right)
489                 clear_commit_marks(right, ~0);
490 }
491
492 void set_config_fetch_recurse_submodules(int value)
493 {
494         config_fetch_recurse_submodules = value;
495 }
496
497 static int has_remote(const char *refname, const struct object_id *oid,
498                       int flags, void *cb_data)
499 {
500         return 1;
501 }
502
503 static int append_sha1_to_argv(const unsigned char sha1[20], void *data)
504 {
505         struct argv_array *argv = data;
506         argv_array_push(argv, sha1_to_hex(sha1));
507         return 0;
508 }
509
510 static int check_has_commit(const unsigned char sha1[20], void *data)
511 {
512         int *has_commit = data;
513
514         if (!lookup_commit_reference(sha1))
515                 *has_commit = 0;
516
517         return 0;
518 }
519
520 static int submodule_has_commits(const char *path, struct sha1_array *commits)
521 {
522         int has_commit = 1;
523
524         if (add_submodule_odb(path))
525                 return 0;
526
527         sha1_array_for_each_unique(commits, check_has_commit, &has_commit);
528         return has_commit;
529 }
530
531 static int submodule_needs_pushing(const char *path, struct sha1_array *commits)
532 {
533         if (!submodule_has_commits(path, commits))
534                 /*
535                  * NOTE: We do consider it safe to return "no" here. The
536                  * correct answer would be "We do not know" instead of
537                  * "No push needed", but it is quite hard to change
538                  * the submodule pointer without having the submodule
539                  * around. If a user did however change the submodules
540                  * without having the submodule around, this indicates
541                  * an expert who knows what they are doing or a
542                  * maintainer integrating work from other people. In
543                  * both cases it should be safe to skip this check.
544                  */
545                 return 0;
546
547         if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
548                 struct child_process cp = CHILD_PROCESS_INIT;
549                 struct strbuf buf = STRBUF_INIT;
550                 int needs_pushing = 0;
551
552                 argv_array_push(&cp.args, "rev-list");
553                 sha1_array_for_each_unique(commits, append_sha1_to_argv, &cp.args);
554                 argv_array_pushl(&cp.args, "--not", "--remotes", "-n", "1" , NULL);
555
556                 prepare_submodule_repo_env(&cp.env_array);
557                 cp.git_cmd = 1;
558                 cp.no_stdin = 1;
559                 cp.out = -1;
560                 cp.dir = path;
561                 if (start_command(&cp))
562                         die("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s",
563                                         path);
564                 if (strbuf_read(&buf, cp.out, 41))
565                         needs_pushing = 1;
566                 finish_command(&cp);
567                 close(cp.out);
568                 strbuf_release(&buf);
569                 return needs_pushing;
570         }
571
572         return 0;
573 }
574
575 static struct sha1_array *submodule_commits(struct string_list *submodules,
576                                             const char *path)
577 {
578         struct string_list_item *item;
579
580         item = string_list_insert(submodules, path);
581         if (item->util)
582                 return (struct sha1_array *) item->util;
583
584         /* NEEDSWORK: should we have sha1_array_init()? */
585         item->util = xcalloc(1, sizeof(struct sha1_array));
586         return (struct sha1_array *) item->util;
587 }
588
589 static void collect_submodules_from_diff(struct diff_queue_struct *q,
590                                          struct diff_options *options,
591                                          void *data)
592 {
593         int i;
594         struct string_list *submodules = data;
595
596         for (i = 0; i < q->nr; i++) {
597                 struct diff_filepair *p = q->queue[i];
598                 struct sha1_array *commits;
599                 if (!S_ISGITLINK(p->two->mode))
600                         continue;
601                 commits = submodule_commits(submodules, p->two->path);
602                 sha1_array_append(commits, p->two->oid.hash);
603         }
604 }
605
606 static void find_unpushed_submodule_commits(struct commit *commit,
607                 struct string_list *needs_pushing)
608 {
609         struct rev_info rev;
610
611         init_revisions(&rev, NULL);
612         rev.diffopt.output_format |= DIFF_FORMAT_CALLBACK;
613         rev.diffopt.format_callback = collect_submodules_from_diff;
614         rev.diffopt.format_callback_data = needs_pushing;
615         diff_tree_combined_merge(commit, 1, &rev);
616 }
617
618 static void free_submodules_sha1s(struct string_list *submodules)
619 {
620         struct string_list_item *item;
621         for_each_string_list_item(item, submodules)
622                 sha1_array_clear((struct sha1_array *) item->util);
623         string_list_clear(submodules, 1);
624 }
625
626 int find_unpushed_submodules(struct sha1_array *commits,
627                 const char *remotes_name, struct string_list *needs_pushing)
628 {
629         struct rev_info rev;
630         struct commit *commit;
631         struct string_list submodules = STRING_LIST_INIT_DUP;
632         struct string_list_item *submodule;
633         struct argv_array argv = ARGV_ARRAY_INIT;
634
635         init_revisions(&rev, NULL);
636
637         /* argv.argv[0] will be ignored by setup_revisions */
638         argv_array_push(&argv, "find_unpushed_submodules");
639         sha1_array_for_each_unique(commits, append_sha1_to_argv, &argv);
640         argv_array_push(&argv, "--not");
641         argv_array_pushf(&argv, "--remotes=%s", remotes_name);
642
643         setup_revisions(argv.argc, argv.argv, &rev, NULL);
644         if (prepare_revision_walk(&rev))
645                 die("revision walk setup failed");
646
647         while ((commit = get_revision(&rev)) != NULL)
648                 find_unpushed_submodule_commits(commit, &submodules);
649
650         reset_revision_walk();
651         argv_array_clear(&argv);
652
653         for_each_string_list_item(submodule, &submodules) {
654                 struct sha1_array *commits = (struct sha1_array *) submodule->util;
655
656                 if (submodule_needs_pushing(submodule->string, commits))
657                         string_list_insert(needs_pushing, submodule->string);
658         }
659         free_submodules_sha1s(&submodules);
660
661         return needs_pushing->nr;
662 }
663
664 static int push_submodule(const char *path, int dry_run)
665 {
666         if (add_submodule_odb(path))
667                 return 1;
668
669         if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
670                 struct child_process cp = CHILD_PROCESS_INIT;
671                 argv_array_push(&cp.args, "push");
672                 if (dry_run)
673                         argv_array_push(&cp.args, "--dry-run");
674
675                 prepare_submodule_repo_env(&cp.env_array);
676                 cp.git_cmd = 1;
677                 cp.no_stdin = 1;
678                 cp.dir = path;
679                 if (run_command(&cp))
680                         return 0;
681                 close(cp.out);
682         }
683
684         return 1;
685 }
686
687 int push_unpushed_submodules(struct sha1_array *commits,
688                              const char *remotes_name,
689                              int dry_run)
690 {
691         int i, ret = 1;
692         struct string_list needs_pushing = STRING_LIST_INIT_DUP;
693
694         if (!find_unpushed_submodules(commits, remotes_name, &needs_pushing))
695                 return 1;
696
697         for (i = 0; i < needs_pushing.nr; i++) {
698                 const char *path = needs_pushing.items[i].string;
699                 fprintf(stderr, "Pushing submodule '%s'\n", path);
700                 if (!push_submodule(path, dry_run)) {
701                         fprintf(stderr, "Unable to push submodule '%s'\n", path);
702                         ret = 0;
703                 }
704         }
705
706         string_list_clear(&needs_pushing, 0);
707
708         return ret;
709 }
710
711 static int is_submodule_commit_present(const char *path, unsigned char sha1[20])
712 {
713         int is_present = 0;
714         if (!add_submodule_odb(path) && lookup_commit_reference(sha1)) {
715                 /* Even if the submodule is checked out and the commit is
716                  * present, make sure it is reachable from a ref. */
717                 struct child_process cp = CHILD_PROCESS_INIT;
718                 const char *argv[] = {"rev-list", "-n", "1", NULL, "--not", "--all", NULL};
719                 struct strbuf buf = STRBUF_INIT;
720
721                 argv[3] = sha1_to_hex(sha1);
722                 cp.argv = argv;
723                 prepare_submodule_repo_env(&cp.env_array);
724                 cp.git_cmd = 1;
725                 cp.no_stdin = 1;
726                 cp.dir = path;
727                 if (!capture_command(&cp, &buf, 1024) && !buf.len)
728                         is_present = 1;
729
730                 strbuf_release(&buf);
731         }
732         return is_present;
733 }
734
735 static void submodule_collect_changed_cb(struct diff_queue_struct *q,
736                                          struct diff_options *options,
737                                          void *data)
738 {
739         int i;
740         for (i = 0; i < q->nr; i++) {
741                 struct diff_filepair *p = q->queue[i];
742                 if (!S_ISGITLINK(p->two->mode))
743                         continue;
744
745                 if (S_ISGITLINK(p->one->mode)) {
746                         /* NEEDSWORK: We should honor the name configured in
747                          * the .gitmodules file of the commit we are examining
748                          * here to be able to correctly follow submodules
749                          * being moved around. */
750                         struct string_list_item *path;
751                         path = unsorted_string_list_lookup(&changed_submodule_paths, p->two->path);
752                         if (!path && !is_submodule_commit_present(p->two->path, p->two->oid.hash))
753                                 string_list_append(&changed_submodule_paths, xstrdup(p->two->path));
754                 } else {
755                         /* Submodule is new or was moved here */
756                         /* NEEDSWORK: When the .git directories of submodules
757                          * live inside the superprojects .git directory some
758                          * day we should fetch new submodules directly into
759                          * that location too when config or options request
760                          * that so they can be checked out from there. */
761                         continue;
762                 }
763         }
764 }
765
766 static int add_sha1_to_array(const char *ref, const struct object_id *oid,
767                              int flags, void *data)
768 {
769         sha1_array_append(data, oid->hash);
770         return 0;
771 }
772
773 void check_for_new_submodule_commits(unsigned char new_sha1[20])
774 {
775         if (!initialized_fetch_ref_tips) {
776                 for_each_ref(add_sha1_to_array, &ref_tips_before_fetch);
777                 initialized_fetch_ref_tips = 1;
778         }
779
780         sha1_array_append(&ref_tips_after_fetch, new_sha1);
781 }
782
783 static int add_sha1_to_argv(const unsigned char sha1[20], void *data)
784 {
785         argv_array_push(data, sha1_to_hex(sha1));
786         return 0;
787 }
788
789 static void calculate_changed_submodule_paths(void)
790 {
791         struct rev_info rev;
792         struct commit *commit;
793         struct argv_array argv = ARGV_ARRAY_INIT;
794
795         /* No need to check if there are no submodules configured */
796         if (!submodule_from_path(NULL, NULL))
797                 return;
798
799         init_revisions(&rev, NULL);
800         argv_array_push(&argv, "--"); /* argv[0] program name */
801         sha1_array_for_each_unique(&ref_tips_after_fetch,
802                                    add_sha1_to_argv, &argv);
803         argv_array_push(&argv, "--not");
804         sha1_array_for_each_unique(&ref_tips_before_fetch,
805                                    add_sha1_to_argv, &argv);
806         setup_revisions(argv.argc, argv.argv, &rev, NULL);
807         if (prepare_revision_walk(&rev))
808                 die("revision walk setup failed");
809
810         /*
811          * Collect all submodules (whether checked out or not) for which new
812          * commits have been recorded upstream in "changed_submodule_paths".
813          */
814         while ((commit = get_revision(&rev))) {
815                 struct commit_list *parent = commit->parents;
816                 while (parent) {
817                         struct diff_options diff_opts;
818                         diff_setup(&diff_opts);
819                         DIFF_OPT_SET(&diff_opts, RECURSIVE);
820                         diff_opts.output_format |= DIFF_FORMAT_CALLBACK;
821                         diff_opts.format_callback = submodule_collect_changed_cb;
822                         diff_setup_done(&diff_opts);
823                         diff_tree_sha1(parent->item->object.oid.hash, commit->object.oid.hash, "", &diff_opts);
824                         diffcore_std(&diff_opts);
825                         diff_flush(&diff_opts);
826                         parent = parent->next;
827                 }
828         }
829
830         argv_array_clear(&argv);
831         sha1_array_clear(&ref_tips_before_fetch);
832         sha1_array_clear(&ref_tips_after_fetch);
833         initialized_fetch_ref_tips = 0;
834 }
835
836 struct submodule_parallel_fetch {
837         int count;
838         struct argv_array args;
839         const char *work_tree;
840         const char *prefix;
841         int command_line_option;
842         int quiet;
843         int result;
844 };
845 #define SPF_INIT {0, ARGV_ARRAY_INIT, NULL, NULL, 0, 0, 0}
846
847 static int get_next_submodule(struct child_process *cp,
848                               struct strbuf *err, void *data, void **task_cb)
849 {
850         int ret = 0;
851         struct submodule_parallel_fetch *spf = data;
852
853         for (; spf->count < active_nr; spf->count++) {
854                 struct strbuf submodule_path = STRBUF_INIT;
855                 struct strbuf submodule_git_dir = STRBUF_INIT;
856                 struct strbuf submodule_prefix = STRBUF_INIT;
857                 const struct cache_entry *ce = active_cache[spf->count];
858                 const char *git_dir, *default_argv;
859                 const struct submodule *submodule;
860
861                 if (!S_ISGITLINK(ce->ce_mode))
862                         continue;
863
864                 submodule = submodule_from_path(null_sha1, ce->name);
865                 if (!submodule)
866                         submodule = submodule_from_name(null_sha1, ce->name);
867
868                 default_argv = "yes";
869                 if (spf->command_line_option == RECURSE_SUBMODULES_DEFAULT) {
870                         if (submodule &&
871                             submodule->fetch_recurse !=
872                                                 RECURSE_SUBMODULES_NONE) {
873                                 if (submodule->fetch_recurse ==
874                                                 RECURSE_SUBMODULES_OFF)
875                                         continue;
876                                 if (submodule->fetch_recurse ==
877                                                 RECURSE_SUBMODULES_ON_DEMAND) {
878                                         if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
879                                                 continue;
880                                         default_argv = "on-demand";
881                                 }
882                         } else {
883                                 if ((config_fetch_recurse_submodules == RECURSE_SUBMODULES_OFF) ||
884                                     gitmodules_is_unmerged)
885                                         continue;
886                                 if (config_fetch_recurse_submodules == RECURSE_SUBMODULES_ON_DEMAND) {
887                                         if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
888                                                 continue;
889                                         default_argv = "on-demand";
890                                 }
891                         }
892                 } else if (spf->command_line_option == RECURSE_SUBMODULES_ON_DEMAND) {
893                         if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
894                                 continue;
895                         default_argv = "on-demand";
896                 }
897
898                 strbuf_addf(&submodule_path, "%s/%s", spf->work_tree, ce->name);
899                 strbuf_addf(&submodule_git_dir, "%s/.git", submodule_path.buf);
900                 strbuf_addf(&submodule_prefix, "%s%s/", spf->prefix, ce->name);
901                 git_dir = read_gitfile(submodule_git_dir.buf);
902                 if (!git_dir)
903                         git_dir = submodule_git_dir.buf;
904                 if (is_directory(git_dir)) {
905                         child_process_init(cp);
906                         cp->dir = strbuf_detach(&submodule_path, NULL);
907                         prepare_submodule_repo_env(&cp->env_array);
908                         cp->git_cmd = 1;
909                         if (!spf->quiet)
910                                 strbuf_addf(err, "Fetching submodule %s%s\n",
911                                             spf->prefix, ce->name);
912                         argv_array_init(&cp->args);
913                         argv_array_pushv(&cp->args, spf->args.argv);
914                         argv_array_push(&cp->args, default_argv);
915                         argv_array_push(&cp->args, "--submodule-prefix");
916                         argv_array_push(&cp->args, submodule_prefix.buf);
917                         ret = 1;
918                 }
919                 strbuf_release(&submodule_path);
920                 strbuf_release(&submodule_git_dir);
921                 strbuf_release(&submodule_prefix);
922                 if (ret) {
923                         spf->count++;
924                         return 1;
925                 }
926         }
927         return 0;
928 }
929
930 static int fetch_start_failure(struct strbuf *err,
931                                void *cb, void *task_cb)
932 {
933         struct submodule_parallel_fetch *spf = cb;
934
935         spf->result = 1;
936
937         return 0;
938 }
939
940 static int fetch_finish(int retvalue, struct strbuf *err,
941                         void *cb, void *task_cb)
942 {
943         struct submodule_parallel_fetch *spf = cb;
944
945         if (retvalue)
946                 spf->result = 1;
947
948         return 0;
949 }
950
951 int fetch_populated_submodules(const struct argv_array *options,
952                                const char *prefix, int command_line_option,
953                                int quiet, int max_parallel_jobs)
954 {
955         int i;
956         struct submodule_parallel_fetch spf = SPF_INIT;
957
958         spf.work_tree = get_git_work_tree();
959         spf.command_line_option = command_line_option;
960         spf.quiet = quiet;
961         spf.prefix = prefix;
962
963         if (!spf.work_tree)
964                 goto out;
965
966         if (read_cache() < 0)
967                 die("index file corrupt");
968
969         argv_array_push(&spf.args, "fetch");
970         for (i = 0; i < options->argc; i++)
971                 argv_array_push(&spf.args, options->argv[i]);
972         argv_array_push(&spf.args, "--recurse-submodules-default");
973         /* default value, "--submodule-prefix" and its value are added later */
974
975         if (max_parallel_jobs < 0)
976                 max_parallel_jobs = parallel_jobs;
977
978         calculate_changed_submodule_paths();
979         run_processes_parallel(max_parallel_jobs,
980                                get_next_submodule,
981                                fetch_start_failure,
982                                fetch_finish,
983                                &spf);
984
985         argv_array_clear(&spf.args);
986 out:
987         string_list_clear(&changed_submodule_paths, 1);
988         return spf.result;
989 }
990
991 unsigned is_submodule_modified(const char *path, int ignore_untracked)
992 {
993         ssize_t len;
994         struct child_process cp = CHILD_PROCESS_INIT;
995         const char *argv[] = {
996                 "status",
997                 "--porcelain",
998                 NULL,
999                 NULL,
1000         };
1001         struct strbuf buf = STRBUF_INIT;
1002         unsigned dirty_submodule = 0;
1003         const char *line, *next_line;
1004         const char *git_dir;
1005
1006         strbuf_addf(&buf, "%s/.git", path);
1007         git_dir = read_gitfile(buf.buf);
1008         if (!git_dir)
1009                 git_dir = buf.buf;
1010         if (!is_directory(git_dir)) {
1011                 strbuf_release(&buf);
1012                 /* The submodule is not checked out, so it is not modified */
1013                 return 0;
1014
1015         }
1016         strbuf_reset(&buf);
1017
1018         if (ignore_untracked)
1019                 argv[2] = "-uno";
1020
1021         cp.argv = argv;
1022         prepare_submodule_repo_env(&cp.env_array);
1023         cp.git_cmd = 1;
1024         cp.no_stdin = 1;
1025         cp.out = -1;
1026         cp.dir = path;
1027         if (start_command(&cp))
1028                 die("Could not run 'git status --porcelain' in submodule %s", path);
1029
1030         len = strbuf_read(&buf, cp.out, 1024);
1031         line = buf.buf;
1032         while (len > 2) {
1033                 if ((line[0] == '?') && (line[1] == '?')) {
1034                         dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1035                         if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
1036                                 break;
1037                 } else {
1038                         dirty_submodule |= DIRTY_SUBMODULE_MODIFIED;
1039                         if (ignore_untracked ||
1040                             (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED))
1041                                 break;
1042                 }
1043                 next_line = strchr(line, '\n');
1044                 if (!next_line)
1045                         break;
1046                 next_line++;
1047                 len -= (next_line - line);
1048                 line = next_line;
1049         }
1050         close(cp.out);
1051
1052         if (finish_command(&cp))
1053                 die("'git status --porcelain' failed in submodule %s", path);
1054
1055         strbuf_release(&buf);
1056         return dirty_submodule;
1057 }
1058
1059 int submodule_uses_gitfile(const char *path)
1060 {
1061         struct child_process cp = CHILD_PROCESS_INIT;
1062         const char *argv[] = {
1063                 "submodule",
1064                 "foreach",
1065                 "--quiet",
1066                 "--recursive",
1067                 "test -f .git",
1068                 NULL,
1069         };
1070         struct strbuf buf = STRBUF_INIT;
1071         const char *git_dir;
1072
1073         strbuf_addf(&buf, "%s/.git", path);
1074         git_dir = read_gitfile(buf.buf);
1075         if (!git_dir) {
1076                 strbuf_release(&buf);
1077                 return 0;
1078         }
1079         strbuf_release(&buf);
1080
1081         /* Now test that all nested submodules use a gitfile too */
1082         cp.argv = argv;
1083         prepare_submodule_repo_env(&cp.env_array);
1084         cp.git_cmd = 1;
1085         cp.no_stdin = 1;
1086         cp.no_stderr = 1;
1087         cp.no_stdout = 1;
1088         cp.dir = path;
1089         if (run_command(&cp))
1090                 return 0;
1091
1092         return 1;
1093 }
1094
1095 int ok_to_remove_submodule(const char *path)
1096 {
1097         ssize_t len;
1098         struct child_process cp = CHILD_PROCESS_INIT;
1099         const char *argv[] = {
1100                 "status",
1101                 "--porcelain",
1102                 "-u",
1103                 "--ignore-submodules=none",
1104                 NULL,
1105         };
1106         struct strbuf buf = STRBUF_INIT;
1107         int ok_to_remove = 1;
1108
1109         if (!file_exists(path) || is_empty_dir(path))
1110                 return 1;
1111
1112         if (!submodule_uses_gitfile(path))
1113                 return 0;
1114
1115         cp.argv = argv;
1116         prepare_submodule_repo_env(&cp.env_array);
1117         cp.git_cmd = 1;
1118         cp.no_stdin = 1;
1119         cp.out = -1;
1120         cp.dir = path;
1121         if (start_command(&cp))
1122                 die("Could not run 'git status --porcelain -uall --ignore-submodules=none' in submodule %s", path);
1123
1124         len = strbuf_read(&buf, cp.out, 1024);
1125         if (len > 2)
1126                 ok_to_remove = 0;
1127         close(cp.out);
1128
1129         if (finish_command(&cp))
1130                 die("'git status --porcelain -uall --ignore-submodules=none' failed in submodule %s", path);
1131
1132         strbuf_release(&buf);
1133         return ok_to_remove;
1134 }
1135
1136 static int find_first_merges(struct object_array *result, const char *path,
1137                 struct commit *a, struct commit *b)
1138 {
1139         int i, j;
1140         struct object_array merges = OBJECT_ARRAY_INIT;
1141         struct commit *commit;
1142         int contains_another;
1143
1144         char merged_revision[42];
1145         const char *rev_args[] = { "rev-list", "--merges", "--ancestry-path",
1146                                    "--all", merged_revision, NULL };
1147         struct rev_info revs;
1148         struct setup_revision_opt rev_opts;
1149
1150         memset(result, 0, sizeof(struct object_array));
1151         memset(&rev_opts, 0, sizeof(rev_opts));
1152
1153         /* get all revisions that merge commit a */
1154         snprintf(merged_revision, sizeof(merged_revision), "^%s",
1155                         oid_to_hex(&a->object.oid));
1156         init_revisions(&revs, NULL);
1157         rev_opts.submodule = path;
1158         setup_revisions(ARRAY_SIZE(rev_args)-1, rev_args, &revs, &rev_opts);
1159
1160         /* save all revisions from the above list that contain b */
1161         if (prepare_revision_walk(&revs))
1162                 die("revision walk setup failed");
1163         while ((commit = get_revision(&revs)) != NULL) {
1164                 struct object *o = &(commit->object);
1165                 if (in_merge_bases(b, commit))
1166                         add_object_array(o, NULL, &merges);
1167         }
1168         reset_revision_walk();
1169
1170         /* Now we've got all merges that contain a and b. Prune all
1171          * merges that contain another found merge and save them in
1172          * result.
1173          */
1174         for (i = 0; i < merges.nr; i++) {
1175                 struct commit *m1 = (struct commit *) merges.objects[i].item;
1176
1177                 contains_another = 0;
1178                 for (j = 0; j < merges.nr; j++) {
1179                         struct commit *m2 = (struct commit *) merges.objects[j].item;
1180                         if (i != j && in_merge_bases(m2, m1)) {
1181                                 contains_another = 1;
1182                                 break;
1183                         }
1184                 }
1185
1186                 if (!contains_another)
1187                         add_object_array(merges.objects[i].item, NULL, result);
1188         }
1189
1190         free(merges.objects);
1191         return result->nr;
1192 }
1193
1194 static void print_commit(struct commit *commit)
1195 {
1196         struct strbuf sb = STRBUF_INIT;
1197         struct pretty_print_context ctx = {0};
1198         ctx.date_mode.type = DATE_NORMAL;
1199         format_commit_message(commit, " %h: %m %s", &sb, &ctx);
1200         fprintf(stderr, "%s\n", sb.buf);
1201         strbuf_release(&sb);
1202 }
1203
1204 #define MERGE_WARNING(path, msg) \
1205         warning("Failed to merge submodule %s (%s)", path, msg);
1206
1207 int merge_submodule(unsigned char result[20], const char *path,
1208                     const unsigned char base[20], const unsigned char a[20],
1209                     const unsigned char b[20], int search)
1210 {
1211         struct commit *commit_base, *commit_a, *commit_b;
1212         int parent_count;
1213         struct object_array merges;
1214
1215         int i;
1216
1217         /* store a in result in case we fail */
1218         hashcpy(result, a);
1219
1220         /* we can not handle deletion conflicts */
1221         if (is_null_sha1(base))
1222                 return 0;
1223         if (is_null_sha1(a))
1224                 return 0;
1225         if (is_null_sha1(b))
1226                 return 0;
1227
1228         if (add_submodule_odb(path)) {
1229                 MERGE_WARNING(path, "not checked out");
1230                 return 0;
1231         }
1232
1233         if (!(commit_base = lookup_commit_reference(base)) ||
1234             !(commit_a = lookup_commit_reference(a)) ||
1235             !(commit_b = lookup_commit_reference(b))) {
1236                 MERGE_WARNING(path, "commits not present");
1237                 return 0;
1238         }
1239
1240         /* check whether both changes are forward */
1241         if (!in_merge_bases(commit_base, commit_a) ||
1242             !in_merge_bases(commit_base, commit_b)) {
1243                 MERGE_WARNING(path, "commits don't follow merge-base");
1244                 return 0;
1245         }
1246
1247         /* Case #1: a is contained in b or vice versa */
1248         if (in_merge_bases(commit_a, commit_b)) {
1249                 hashcpy(result, b);
1250                 return 1;
1251         }
1252         if (in_merge_bases(commit_b, commit_a)) {
1253                 hashcpy(result, a);
1254                 return 1;
1255         }
1256
1257         /*
1258          * Case #2: There are one or more merges that contain a and b in
1259          * the submodule. If there is only one, then present it as a
1260          * suggestion to the user, but leave it marked unmerged so the
1261          * user needs to confirm the resolution.
1262          */
1263
1264         /* Skip the search if makes no sense to the calling context.  */
1265         if (!search)
1266                 return 0;
1267
1268         /* find commit which merges them */
1269         parent_count = find_first_merges(&merges, path, commit_a, commit_b);
1270         switch (parent_count) {
1271         case 0:
1272                 MERGE_WARNING(path, "merge following commits not found");
1273                 break;
1274
1275         case 1:
1276                 MERGE_WARNING(path, "not fast-forward");
1277                 fprintf(stderr, "Found a possible merge resolution "
1278                                 "for the submodule:\n");
1279                 print_commit((struct commit *) merges.objects[0].item);
1280                 fprintf(stderr,
1281                         "If this is correct simply add it to the index "
1282                         "for example\n"
1283                         "by using:\n\n"
1284                         "  git update-index --cacheinfo 160000 %s \"%s\"\n\n"
1285                         "which will accept this suggestion.\n",
1286                         oid_to_hex(&merges.objects[0].item->oid), path);
1287                 break;
1288
1289         default:
1290                 MERGE_WARNING(path, "multiple merges found");
1291                 for (i = 0; i < merges.nr; i++)
1292                         print_commit((struct commit *) merges.objects[i].item);
1293         }
1294
1295         free(merges.objects);
1296         return 0;
1297 }
1298
1299 /* Update gitfile and core.worktree setting to connect work tree and git dir */
1300 void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir)
1301 {
1302         struct strbuf file_name = STRBUF_INIT;
1303         struct strbuf rel_path = STRBUF_INIT;
1304         const char *real_work_tree = xstrdup(real_path(work_tree));
1305
1306         /* Update gitfile */
1307         strbuf_addf(&file_name, "%s/.git", work_tree);
1308         write_file(file_name.buf, "gitdir: %s",
1309                    relative_path(git_dir, real_work_tree, &rel_path));
1310
1311         /* Update core.worktree setting */
1312         strbuf_reset(&file_name);
1313         strbuf_addf(&file_name, "%s/config", git_dir);
1314         git_config_set_in_file(file_name.buf, "core.worktree",
1315                                relative_path(real_work_tree, git_dir,
1316                                              &rel_path));
1317
1318         strbuf_release(&file_name);
1319         strbuf_release(&rel_path);
1320         free((void *)real_work_tree);
1321 }
1322
1323 int parallel_submodules(void)
1324 {
1325         return parallel_jobs;
1326 }
1327
1328 void prepare_submodule_repo_env(struct argv_array *out)
1329 {
1330         const char * const *var;
1331
1332         for (var = local_repo_env; *var; var++) {
1333                 if (strcmp(*var, CONFIG_DATA_ENVIRONMENT))
1334                         argv_array_push(out, *var);
1335         }
1336         argv_array_push(out, "GIT_DIR=.git");
1337 }