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