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