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