blob: e2ef5698c893c3587e500ac88b46aa9ba68609ea [file] [log] [blame]
Brandon Williamse7241972017-12-12 11:53:52 -08001
Johannes Schindelin752c0c22009-10-19 14:38:32 +02002#include "cache.h"
Brandon Williams69aba532017-06-22 11:43:45 -07003#include "repository.h"
Brandon Williamsb2141fc2017-06-14 11:07:36 -07004#include "config.h"
Heiko Voigt851e18c2015-08-17 17:21:59 -07005#include "submodule-config.h"
Johannes Schindelin752c0c22009-10-19 14:38:32 +02006#include "submodule.h"
7#include "dir.h"
8#include "diff.h"
9#include "commit.h"
10#include "revision.h"
Jens Lehmannee6fc512010-01-16 18:42:24 +010011#include "run-command.h"
Jens Lehmannc7e1a732010-03-04 22:20:33 +010012#include "diffcore.h"
Heiko Voigt68d03e42010-07-07 15:39:13 +020013#include "refs.h"
Jens Lehmannaee9c7d2010-08-06 00:39:25 +020014#include "string-list.h"
Jeff Kingfe299ec2020-03-30 10:03:46 -040015#include "oid-array.h"
Jeff Kingc1189ca2011-09-13 17:57:57 -040016#include "argv-array.h"
Jens Lehmann5fee9952013-07-30 21:50:34 +020017#include "blob.h"
Stefan Bellerfe85ee62015-12-15 16:04:11 -080018#include "thread-utils.h"
Jeff King46387282016-04-28 09:38:20 -040019#include "quote.h"
Brandon Williams06bf4ad2017-04-05 10:47:19 -070020#include "remote.h"
Stefan Bellerf6f85862016-12-12 11:04:35 -080021#include "worktree.h"
Stefan Beller046b4822017-05-31 17:30:47 -070022#include "parse-options.h"
Stefan Beller0d4a1322018-03-23 18:20:56 +010023#include "object-store.h"
Derrick Stolee64043552018-07-20 16:33:04 +000024#include "commit-reach.h"
Jens Lehmannaee9c7d2010-08-06 00:39:25 +020025
Stefan Bellerd7a38032017-05-26 12:10:12 -070026static int config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
Jeff King6859de42011-09-12 15:56:52 -040027static int initialized_fetch_ref_tips;
brian m. carlson910650d2017-03-31 01:40:00 +000028static struct oid_array ref_tips_before_fetch;
29static struct oid_array ref_tips_after_fetch;
Jeff King6859de42011-09-12 15:56:52 -040030
Jens Lehmannd4e98b52011-05-14 18:26:58 +020031/*
Brandon Williams34e2ba02017-08-02 12:49:21 -070032 * Check if the .gitmodules file is unmerged. Parsing of the .gitmodules file
33 * will be disabled because we can't guess what might be configured in
34 * .gitmodules unless the user resolves the conflict.
Jens Lehmannd4e98b52011-05-14 18:26:58 +020035 */
Brandon Williams34e2ba02017-08-02 12:49:21 -070036int is_gitmodules_unmerged(const struct index_state *istate)
37{
38 int pos = index_name_pos(istate, GITMODULES_FILE, strlen(GITMODULES_FILE));
39 if (pos < 0) { /* .gitmodules not found or isn't merged */
40 pos = -1 - pos;
41 if (istate->cache_nr > pos) { /* there is a .gitmodules */
42 const struct cache_entry *ce = istate->cache[pos];
43 if (ce_namelen(ce) == strlen(GITMODULES_FILE) &&
44 !strcmp(ce->name, GITMODULES_FILE))
45 return 1;
46 }
47 }
48
49 return 0;
50}
Johannes Schindelin752c0c22009-10-19 14:38:32 +020051
Jens Lehmann5fee9952013-07-30 21:50:34 +020052/*
Antonio Ospiteb5c259f2018-10-05 15:05:59 +020053 * Check if the .gitmodules file is safe to write.
54 *
55 * Writing to the .gitmodules file requires that the file exists in the
56 * working tree or, if it doesn't, that a brand new .gitmodules file is going
57 * to be created (i.e. it's neither in the index nor in the current branch).
58 *
59 * It is not safe to write to .gitmodules if it's not in the working tree but
60 * it is in the index or in the current branch, because writing new values
61 * (and staging them) would blindly overwrite ALL the old content.
62 */
63int is_writing_gitmodules_ok(void)
64{
65 struct object_id oid;
66 return file_exists(GITMODULES_FILE) ||
67 (get_oid(GITMODULES_INDEX, &oid) < 0 && get_oid(GITMODULES_HEAD, &oid) < 0);
68}
69
70/*
Brandon Williams91b83482017-08-02 12:49:20 -070071 * Check if the .gitmodules file has unstaged modifications. This must be
72 * checked before allowing modifications to the .gitmodules file with the
73 * intention to stage them later, because when continuing we would stage the
74 * modifications the user didn't stage herself too. That might change in a
75 * future version when we learn to stage the changes we do ourselves without
76 * staging any previous modifications.
Jens Lehmann5fee9952013-07-30 21:50:34 +020077 */
Brandon Williams7da9aba2017-12-12 11:53:51 -080078int is_staging_gitmodules_ok(struct index_state *istate)
Jens Lehmann5fee9952013-07-30 21:50:34 +020079{
Brandon Williams91b83482017-08-02 12:49:20 -070080 int pos = index_name_pos(istate, GITMODULES_FILE, strlen(GITMODULES_FILE));
81
82 if ((pos >= 0) && (pos < istate->cache_nr)) {
83 struct stat st;
84 if (lstat(GITMODULES_FILE, &st) == 0 &&
David Turner7edee322020-01-27 13:58:56 -050085 ie_modified(istate, istate->cache[pos], &st, 0) & DATA_CHANGED)
Brandon Williams91b83482017-08-02 12:49:20 -070086 return 0;
87 }
88
89 return 1;
Jens Lehmann5fee9952013-07-30 21:50:34 +020090}
91
Nguyễn Thái Ngọc Duy2e2d4042017-08-23 19:36:57 +070092static int for_each_remote_ref_submodule(const char *submodule,
93 each_ref_fn fn, void *cb_data)
94{
95 return refs_for_each_remote_ref(get_submodule_ref_store(submodule),
96 fn, cb_data);
97}
98
Jens Lehmann06567812013-08-06 21:15:11 +020099/*
100 * Try to update the "path" entry in the "submodule.<name>" section of the
101 * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
102 * with the correct path=<oldpath> setting was found and we could update it.
103 */
104int update_path_in_gitmodules(const char *oldpath, const char *newpath)
105{
106 struct strbuf entry = STRBUF_INIT;
Heiko Voigt851e18c2015-08-17 17:21:59 -0700107 const struct submodule *submodule;
Antonio Ospite45f5ef32018-10-05 15:05:53 +0200108 int ret;
Jens Lehmann06567812013-08-06 21:15:11 +0200109
Brandon Williams4c0eeaf2017-08-02 12:49:16 -0700110 if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
Jens Lehmann06567812013-08-06 21:15:11 +0200111 return -1;
112
Nguyễn Thái Ngọc Duy68f08b42018-08-13 18:14:31 +0200113 if (is_gitmodules_unmerged(the_repository->index))
Jens Lehmann06567812013-08-06 21:15:11 +0200114 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
115
Stefan Beller3b8fb392018-03-28 15:35:29 -0700116 submodule = submodule_from_path(the_repository, &null_oid, oldpath);
Heiko Voigt851e18c2015-08-17 17:21:59 -0700117 if (!submodule || !submodule->name) {
Jens Lehmann06567812013-08-06 21:15:11 +0200118 warning(_("Could not find section in .gitmodules where path=%s"), oldpath);
119 return -1;
120 }
121 strbuf_addstr(&entry, "submodule.");
Heiko Voigt851e18c2015-08-17 17:21:59 -0700122 strbuf_addstr(&entry, submodule->name);
Jens Lehmann06567812013-08-06 21:15:11 +0200123 strbuf_addstr(&entry, ".path");
Antonio Ospite45f5ef32018-10-05 15:05:53 +0200124 ret = config_set_in_gitmodules_file_gently(entry.buf, newpath);
Jens Lehmann06567812013-08-06 21:15:11 +0200125 strbuf_release(&entry);
Antonio Ospite45f5ef32018-10-05 15:05:53 +0200126 return ret;
Jens Lehmann06567812013-08-06 21:15:11 +0200127}
128
Jens Lehmann95c16412013-08-06 21:15:25 +0200129/*
130 * Try to remove the "submodule.<name>" section from .gitmodules where the given
131 * path is configured. Return 0 only if a .gitmodules file was found, a section
132 * with the correct path=<path> setting was found and we could remove it.
133 */
134int remove_path_from_gitmodules(const char *path)
135{
136 struct strbuf sect = STRBUF_INIT;
Heiko Voigt851e18c2015-08-17 17:21:59 -0700137 const struct submodule *submodule;
Jens Lehmann95c16412013-08-06 21:15:25 +0200138
Brandon Williams4c0eeaf2017-08-02 12:49:16 -0700139 if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
Jens Lehmann95c16412013-08-06 21:15:25 +0200140 return -1;
141
Nguyễn Thái Ngọc Duy68f08b42018-08-13 18:14:31 +0200142 if (is_gitmodules_unmerged(the_repository->index))
Jens Lehmann95c16412013-08-06 21:15:25 +0200143 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
144
Stefan Beller3b8fb392018-03-28 15:35:29 -0700145 submodule = submodule_from_path(the_repository, &null_oid, path);
Heiko Voigt851e18c2015-08-17 17:21:59 -0700146 if (!submodule || !submodule->name) {
Jens Lehmann95c16412013-08-06 21:15:25 +0200147 warning(_("Could not find section in .gitmodules where path=%s"), path);
148 return -1;
149 }
150 strbuf_addstr(&sect, "submodule.");
Heiko Voigt851e18c2015-08-17 17:21:59 -0700151 strbuf_addstr(&sect, submodule->name);
Brandon Williams4c0eeaf2017-08-02 12:49:16 -0700152 if (git_config_rename_section_in_file(GITMODULES_FILE, sect.buf, NULL) < 0) {
Jens Lehmann95c16412013-08-06 21:15:25 +0200153 /* Maybe the user already did that, don't error out here */
154 warning(_("Could not remove .gitmodules entry for %s"), path);
155 strbuf_release(&sect);
156 return -1;
157 }
158 strbuf_release(&sect);
159 return 0;
160}
161
Brandon Williams3b8317a2017-12-12 11:53:50 -0800162void stage_updated_gitmodules(struct index_state *istate)
Jens Lehmann5fee9952013-07-30 21:50:34 +0200163{
Brandon Williams3b8317a2017-12-12 11:53:50 -0800164 if (add_file_to_index(istate, GITMODULES_FILE, 0))
Jens Lehmann5fee9952013-07-30 21:50:34 +0200165 die(_("staging updated .gitmodules failed"));
166}
167
Stefan Beller18cfc082018-05-15 13:00:28 -0700168/* TODO: remove this function, use repo_submodule_init instead. */
169int add_submodule_odb(const char *path)
Johannes Schindelin752c0c22009-10-19 14:38:32 +0200170{
171 struct strbuf objects_directory = STRBUF_INIT;
Jens Lehmannde7a7962010-01-31 17:43:49 +0100172 int ret = 0;
Johannes Schindelin752c0c22009-10-19 14:38:32 +0200173
Jacob Keller99b43a62016-08-31 16:27:22 -0700174 ret = strbuf_git_path_submodule(&objects_directory, path, "objects/");
175 if (ret)
176 goto done;
Jens Lehmannde7a7962010-01-31 17:43:49 +0100177 if (!is_directory(objects_directory.buf)) {
178 ret = -1;
179 goto done;
180 }
Jeff Kinga5b34d22016-10-03 16:35:03 -0400181 add_to_alternates_memory(objects_directory.buf);
Jens Lehmannde7a7962010-01-31 17:43:49 +0100182done:
183 strbuf_release(&objects_directory);
184 return ret;
Johannes Schindelin752c0c22009-10-19 14:38:32 +0200185}
186
Jens Lehmannaee9c7d2010-08-06 00:39:25 +0200187void set_diffopt_flags_from_submodule_config(struct diff_options *diffopt,
188 const char *path)
189{
Stefan Beller3b8fb392018-03-28 15:35:29 -0700190 const struct submodule *submodule = submodule_from_path(the_repository,
191 &null_oid, path);
Heiko Voigt851e18c2015-08-17 17:21:59 -0700192 if (submodule) {
Brandon Williamsfdfa9e92017-08-03 11:19:52 -0700193 const char *ignore;
194 char *key;
195
196 key = xstrfmt("submodule.%s.ignore", submodule->name);
197 if (repo_config_get_string_const(the_repository, key, &ignore))
198 ignore = submodule->ignore;
199 free(key);
200
201 if (ignore)
202 handle_ignore_submodules_arg(diffopt, ignore);
Nguyễn Thái Ngọc Duy68f08b42018-08-13 18:14:31 +0200203 else if (is_gitmodules_unmerged(the_repository->index))
Brandon Williams0d1e0e72017-10-31 11:19:11 -0700204 diffopt->flags.ignore_submodules = 1;
Jens Lehmannaee9c7d2010-08-06 00:39:25 +0200205 }
206}
207
Stefan Beller046b4822017-05-31 17:30:47 -0700208/* Cheap function that only determines if we're interested in submodules at all */
209int git_default_submodule_config(const char *var, const char *value, void *cb)
210{
211 if (!strcmp(var, "submodule.recurse")) {
212 int v = git_config_bool(var, value) ?
213 RECURSE_SUBMODULES_ON : RECURSE_SUBMODULES_OFF;
214 config_update_recurse_submodules = v;
215 }
216 return 0;
Stefan Beller1d789d02017-05-26 12:10:13 -0700217}
218
Stefan Bellerd7a38032017-05-26 12:10:12 -0700219int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
220 const char *arg, int unset)
221{
222 if (unset) {
223 config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
224 return 0;
225 }
226 if (arg)
227 config_update_recurse_submodules =
228 parse_update_recurse_submodules_arg(opt->long_name,
229 arg);
230 else
231 config_update_recurse_submodules = RECURSE_SUBMODULES_ON;
232
233 return 0;
234}
235
Brandon Williams5688c282016-12-16 11:03:16 -0800236/*
Brandon Williamsf9f42562016-12-16 11:03:17 -0800237 * Determine if a submodule has been initialized at a given 'path'
238 */
Brandon Williams627d9342017-06-22 11:43:46 -0700239int is_submodule_active(struct repository *repo, const char *path)
Brandon Williamsf9f42562016-12-16 11:03:17 -0800240{
241 int ret = 0;
Brandon Williamsa086f922017-03-17 15:38:01 -0700242 char *key = NULL;
243 char *value = NULL;
244 const struct string_list *sl;
Brandon Williams627d9342017-06-22 11:43:46 -0700245 const struct submodule *module;
246
Stefan Beller0c89fdd2018-03-28 15:35:30 -0700247 module = submodule_from_path(repo, &null_oid, path);
Brandon Williamsf9f42562016-12-16 11:03:17 -0800248
Brandon Williamsa086f922017-03-17 15:38:01 -0700249 /* early return if there isn't a path->module mapping */
250 if (!module)
251 return 0;
Brandon Williamsf9f42562016-12-16 11:03:17 -0800252
Brandon Williamsa086f922017-03-17 15:38:01 -0700253 /* submodule.<name>.active is set */
254 key = xstrfmt("submodule.%s.active", module->name);
Brandon Williams627d9342017-06-22 11:43:46 -0700255 if (!repo_config_get_bool(repo, key, &ret)) {
Brandon Williamsf9f42562016-12-16 11:03:17 -0800256 free(key);
Brandon Williamsa086f922017-03-17 15:38:01 -0700257 return ret;
258 }
259 free(key);
260
261 /* submodule.active is set */
Brandon Williams627d9342017-06-22 11:43:46 -0700262 sl = repo_config_get_value_multi(repo, "submodule.active");
Brandon Williamsa086f922017-03-17 15:38:01 -0700263 if (sl) {
264 struct pathspec ps;
265 struct argv_array args = ARGV_ARRAY_INIT;
266 const struct string_list_item *item;
267
268 for_each_string_list_item(item, sl) {
269 argv_array_push(&args, item->string);
270 }
271
272 parse_pathspec(&ps, 0, 0, NULL, args.argv);
Nguyễn Thái Ngọc Duy68f08b42018-08-13 18:14:31 +0200273 ret = match_pathspec(repo->index, &ps, path, strlen(path), 0, NULL, 1);
Brandon Williamsa086f922017-03-17 15:38:01 -0700274
275 argv_array_clear(&args);
276 clear_pathspec(&ps);
277 return ret;
Brandon Williamsf9f42562016-12-16 11:03:17 -0800278 }
279
Brandon Williamsa086f922017-03-17 15:38:01 -0700280 /* fallback to checking if the URL is set */
281 key = xstrfmt("submodule.%s.url", module->name);
Brandon Williams627d9342017-06-22 11:43:46 -0700282 ret = !repo_config_get_string(repo, key, &value);
Brandon Williamsa086f922017-03-17 15:38:01 -0700283
284 free(value);
285 free(key);
Brandon Williamsf9f42562016-12-16 11:03:17 -0800286 return ret;
287}
288
Stefan Beller15cdc642017-03-14 14:46:31 -0700289int is_submodule_populated_gently(const char *path, int *return_error_code)
Brandon Williams5688c282016-12-16 11:03:16 -0800290{
291 int ret = 0;
292 char *gitdir = xstrfmt("%s/.git", path);
293
Stefan Beller15cdc642017-03-14 14:46:31 -0700294 if (resolve_gitdir_gently(gitdir, return_error_code))
Brandon Williams5688c282016-12-16 11:03:16 -0800295 ret = 1;
296
297 free(gitdir);
298 return ret;
299}
300
Brandon Williamsbdab9722017-05-09 12:17:59 -0700301/*
302 * Dies if the provided 'prefix' corresponds to an unpopulated submodule
303 */
304void die_in_unpopulated_submodule(const struct index_state *istate,
305 const char *prefix)
306{
307 int i, prefixlen;
308
309 if (!prefix)
310 return;
311
312 prefixlen = strlen(prefix);
313
314 for (i = 0; i < istate->cache_nr; i++) {
315 struct cache_entry *ce = istate->cache[i];
316 int ce_len = ce_namelen(ce);
317
318 if (!S_ISGITLINK(ce->ce_mode))
319 continue;
320 if (prefixlen <= ce_len)
321 continue;
322 if (strncmp(ce->name, prefix, ce_len))
323 continue;
324 if (prefix[ce_len] != '/')
325 continue;
326
327 die(_("in unpopulated submodule '%s'"), ce->name);
328 }
329}
330
Brandon Williamsc08397e2017-05-11 15:04:24 -0700331/*
332 * Dies if any paths in the provided pathspec descends into a submodule
333 */
334void die_path_inside_submodule(const struct index_state *istate,
335 const struct pathspec *ps)
336{
337 int i, j;
338
339 for (i = 0; i < istate->cache_nr; i++) {
340 struct cache_entry *ce = istate->cache[i];
341 int ce_len = ce_namelen(ce);
342
343 if (!S_ISGITLINK(ce->ce_mode))
344 continue;
345
346 for (j = 0; j < ps->nr ; j++) {
347 const struct pathspec_item *item = &ps->items[j];
348
349 if (item->len <= ce_len)
350 continue;
351 if (item->match[ce_len] != '/')
352 continue;
353 if (strncmp(ce->name, item->match, ce_len))
354 continue;
355 if (item->len == ce_len + 1)
356 continue;
357
358 die(_("Pathspec '%s' is in submodule '%.*s'"),
359 item->original, ce_len, ce->name);
360 }
361 }
362}
363
Brandon Williamsec6141a2017-08-03 11:19:50 -0700364enum submodule_update_type parse_submodule_update_type(const char *value)
365{
366 if (!strcmp(value, "none"))
367 return SM_UPDATE_NONE;
368 else if (!strcmp(value, "checkout"))
369 return SM_UPDATE_CHECKOUT;
370 else if (!strcmp(value, "rebase"))
371 return SM_UPDATE_REBASE;
372 else if (!strcmp(value, "merge"))
373 return SM_UPDATE_MERGE;
374 else if (*value == '!')
375 return SM_UPDATE_COMMAND;
376 else
377 return SM_UPDATE_UNSPECIFIED;
378}
379
Stefan Bellerea2fa5a2016-02-29 18:07:11 -0800380int parse_submodule_update_strategy(const char *value,
381 struct submodule_update_strategy *dst)
382{
Brandon Williamsec6141a2017-08-03 11:19:50 -0700383 enum submodule_update_type type;
384
Stefan Bellerea2fa5a2016-02-29 18:07:11 -0800385 free((void*)dst->command);
386 dst->command = NULL;
Brandon Williamsec6141a2017-08-03 11:19:50 -0700387
388 type = parse_submodule_update_type(value);
389 if (type == SM_UPDATE_UNSPECIFIED)
Stefan Bellerea2fa5a2016-02-29 18:07:11 -0800390 return -1;
Brandon Williamsec6141a2017-08-03 11:19:50 -0700391
392 dst->type = type;
393 if (type == SM_UPDATE_COMMAND)
394 dst->command = xstrdup(value + 1);
395
Stefan Bellerea2fa5a2016-02-29 18:07:11 -0800396 return 0;
397}
398
Stefan Beller36042422016-04-15 17:50:13 -0700399const char *submodule_strategy_to_string(const struct submodule_update_strategy *s)
400{
401 struct strbuf sb = STRBUF_INIT;
402 switch (s->type) {
403 case SM_UPDATE_CHECKOUT:
404 return "checkout";
405 case SM_UPDATE_MERGE:
406 return "merge";
407 case SM_UPDATE_REBASE:
408 return "rebase";
409 case SM_UPDATE_NONE:
410 return "none";
411 case SM_UPDATE_UNSPECIFIED:
412 return NULL;
413 case SM_UPDATE_COMMAND:
414 strbuf_addf(&sb, "!%s", s->command);
415 return strbuf_detach(&sb, NULL);
416 }
417 return NULL;
418}
419
Jens Lehmann46a958b2010-06-25 16:56:47 +0200420void handle_ignore_submodules_arg(struct diff_options *diffopt,
421 const char *arg)
422{
Brandon Williams0d1e0e72017-10-31 11:19:11 -0700423 diffopt->flags.ignore_submodules = 0;
424 diffopt->flags.ignore_untracked_in_submodules = 0;
425 diffopt->flags.ignore_dirty_submodules = 0;
Johannes Schindelinbe4f2b42010-08-05 10:49:55 +0200426
Jens Lehmann46a958b2010-06-25 16:56:47 +0200427 if (!strcmp(arg, "all"))
Brandon Williams0d1e0e72017-10-31 11:19:11 -0700428 diffopt->flags.ignore_submodules = 1;
Jens Lehmann46a958b2010-06-25 16:56:47 +0200429 else if (!strcmp(arg, "untracked"))
Brandon Williams0d1e0e72017-10-31 11:19:11 -0700430 diffopt->flags.ignore_untracked_in_submodules = 1;
Jens Lehmann46a958b2010-06-25 16:56:47 +0200431 else if (!strcmp(arg, "dirty"))
Brandon Williams0d1e0e72017-10-31 11:19:11 -0700432 diffopt->flags.ignore_dirty_submodules = 1;
Jens Lehmannaee9c7d2010-08-06 00:39:25 +0200433 else if (strcmp(arg, "none"))
Ralf Thielowa4ffbbb2020-01-15 19:07:01 +0100434 die(_("bad --ignore-submodules argument: %s"), arg);
Nguyễn Thái Ngọc Duy5a59a232019-02-16 18:24:41 +0700435 /*
436 * Please update _git_status() in git-completion.bash when you
437 * add new options
438 */
Jens Lehmann46a958b2010-06-25 16:56:47 +0200439}
440
Jonathan Nieder808a95d2011-03-16 02:14:11 -0500441static int prepare_submodule_summary(struct rev_info *rev, const char *path,
442 struct commit *left, struct commit *right,
Jacob Keller8e6df652016-08-31 16:27:24 -0700443 struct commit_list *merge_bases)
Jonathan Nieder808a95d2011-03-16 02:14:11 -0500444{
Jacob Keller8e6df652016-08-31 16:27:24 -0700445 struct commit_list *list;
Jonathan Nieder808a95d2011-03-16 02:14:11 -0500446
Nguyễn Thái Ngọc Duy2abf3502018-09-21 17:57:38 +0200447 repo_init_revisions(the_repository, rev, NULL);
Jonathan Nieder808a95d2011-03-16 02:14:11 -0500448 setup_revisions(0, NULL, rev, NULL);
449 rev->left_right = 1;
450 rev->first_parent_only = 1;
451 left->object.flags |= SYMMETRIC_LEFT;
452 add_pending_object(rev, &left->object, path);
453 add_pending_object(rev, &right->object, path);
Jonathan Nieder808a95d2011-03-16 02:14:11 -0500454 for (list = merge_bases; list; list = list->next) {
455 list->item->object.flags |= UNINTERESTING;
456 add_pending_object(rev, &list->item->object,
brian m. carlsonf2fd0762015-11-10 02:22:28 +0000457 oid_to_hex(&list->item->object.oid));
Jonathan Nieder808a95d2011-03-16 02:14:11 -0500458 }
459 return prepare_revision_walk(rev);
460}
461
Stefan Beller605f0ec2018-12-14 16:09:37 -0800462static void print_submodule_summary(struct repository *r, struct rev_info *rev, struct diff_options *o)
Jonathan Nieder808a95d2011-03-16 02:14:11 -0500463{
464 static const char format[] = " %m %s";
465 struct strbuf sb = STRBUF_INIT;
466 struct commit *commit;
467
468 while ((commit = get_revision(rev))) {
469 struct pretty_print_context ctx = {0};
470 ctx.date_mode = rev->date_mode;
Alexey Shumkinecaee802013-06-26 14:19:50 +0400471 ctx.output_encoding = get_log_output_encoding();
Jonathan Nieder808a95d2011-03-16 02:14:11 -0500472 strbuf_setlen(&sb, 0);
Stefan Beller605f0ec2018-12-14 16:09:37 -0800473 repo_format_commit_message(r, commit, format, &sb,
474 &ctx);
Jonathan Nieder808a95d2011-03-16 02:14:11 -0500475 strbuf_addch(&sb, '\n');
Stefan Bellerf3597132017-06-29 17:07:00 -0700476 if (commit->object.flags & SYMMETRIC_LEFT)
477 diff_emit_submodule_del(o, sb.buf);
478 else
479 diff_emit_submodule_add(o, sb.buf);
Jonathan Nieder808a95d2011-03-16 02:14:11 -0500480 }
481 strbuf_release(&sb);
482}
483
Stefan Beller6cd57572017-03-14 14:46:35 -0700484static void prepare_submodule_repo_env_no_git_dir(struct argv_array *out)
485{
486 const char * const *var;
487
488 for (var = local_repo_env; *var; var++) {
489 if (strcmp(*var, CONFIG_DATA_ENVIRONMENT))
490 argv_array_push(out, *var);
491 }
492}
493
494void prepare_submodule_repo_env(struct argv_array *out)
495{
496 prepare_submodule_repo_env_no_git_dir(out);
497 argv_array_pushf(out, "%s=%s", GIT_DIR_ENVIRONMENT,
498 DEFAULT_GIT_DIR_ENVIRONMENT);
499}
500
Stefan Bellera62387b2018-11-28 16:27:55 -0800501static void prepare_submodule_repo_env_in_gitdir(struct argv_array *out)
502{
503 prepare_submodule_repo_env_no_git_dir(out);
504 argv_array_pushf(out, "%s=.", GIT_DIR_ENVIRONMENT);
505}
506
Stefan Beller605f0ec2018-12-14 16:09:37 -0800507/*
508 * Initialize a repository struct for a submodule based on the provided 'path'.
509 *
510 * Unlike repo_submodule_init, this tolerates submodules not present
511 * in .gitmodules. This function exists only to preserve historical behavior,
512 *
513 * Returns the repository struct on success,
514 * NULL when the submodule is not present.
Jacob Keller8e6df652016-08-31 16:27:24 -0700515 */
Stefan Beller605f0ec2018-12-14 16:09:37 -0800516static struct repository *open_submodule(const char *path)
517{
518 struct strbuf sb = STRBUF_INIT;
519 struct repository *out = xmalloc(sizeof(*out));
520
521 if (submodule_to_gitdir(&sb, path) || repo_init(out, sb.buf, NULL)) {
522 strbuf_release(&sb);
523 free(out);
524 return NULL;
525 }
526
527 /* Mark it as a submodule */
528 out->submodule_prefix = xstrdup(path);
529
530 strbuf_release(&sb);
531 return out;
532}
533
534/*
535 * Helper function to display the submodule header line prior to the full
536 * summary output.
537 *
538 * If it can locate the submodule git directory it will create a repository
539 * handle for the submodule and lookup both the left and right commits and
540 * put them into the left and right pointers.
541 */
542static void show_submodule_header(struct diff_options *o,
543 const char *path,
Jacob Keller602a2832016-08-31 16:27:23 -0700544 struct object_id *one, struct object_id *two,
Stefan Bellerf3597132017-06-29 17:07:00 -0700545 unsigned dirty_submodule,
Stefan Beller605f0ec2018-12-14 16:09:37 -0800546 struct repository *sub,
Jacob Keller8e6df652016-08-31 16:27:24 -0700547 struct commit **left, struct commit **right,
548 struct commit_list **merge_bases)
Johannes Schindelin752c0c22009-10-19 14:38:32 +0200549{
Johannes Schindelin752c0c22009-10-19 14:38:32 +0200550 const char *message = NULL;
551 struct strbuf sb = STRBUF_INIT;
Johannes Schindelin752c0c22009-10-19 14:38:32 +0200552 int fast_forward = 0, fast_backward = 0;
553
Jens Lehmannc7e1a732010-03-04 22:20:33 +0100554 if (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED)
Stefan Bellerf3597132017-06-29 17:07:00 -0700555 diff_emit_submodule_untracked(o, path);
556
Jens Lehmannc7e1a732010-03-04 22:20:33 +0100557 if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
Stefan Bellerf3597132017-06-29 17:07:00 -0700558 diff_emit_submodule_modified(o, path);
Jens Lehmannc7e1a732010-03-04 22:20:33 +0100559
Jacob Keller8e6df652016-08-31 16:27:24 -0700560 if (is_null_oid(one))
561 message = "(new submodule)";
562 else if (is_null_oid(two))
563 message = "(submodule deleted)";
564
Stefan Beller605f0ec2018-12-14 16:09:37 -0800565 if (!sub) {
Jacob Keller8e6df652016-08-31 16:27:24 -0700566 if (!message)
Stefan Beller2d94dd22017-09-26 11:27:56 -0700567 message = "(commits not present)";
Jacob Keller8e6df652016-08-31 16:27:24 -0700568 goto output_header;
569 }
570
571 /*
572 * Attempt to lookup the commit references, and determine if this is
573 * a fast forward or fast backwards update.
574 */
Stefan Beller605f0ec2018-12-14 16:09:37 -0800575 *left = lookup_commit_reference(sub, one);
576 *right = lookup_commit_reference(sub, two);
Jacob Keller8e6df652016-08-31 16:27:24 -0700577
578 /*
579 * Warn about missing commits in the submodule project, but only if
580 * they aren't null.
581 */
582 if ((!is_null_oid(one) && !*left) ||
583 (!is_null_oid(two) && !*right))
584 message = "(commits not present)";
585
Stefan Beller605f0ec2018-12-14 16:09:37 -0800586 *merge_bases = repo_get_merge_bases(sub, *left, *right);
Jacob Keller8e6df652016-08-31 16:27:24 -0700587 if (*merge_bases) {
588 if ((*merge_bases)->item == *left)
589 fast_forward = 1;
590 else if ((*merge_bases)->item == *right)
591 fast_backward = 1;
592 }
593
Jeff King4a7e27e2018-08-28 17:22:40 -0400594 if (oideq(one, two)) {
Jens Lehmannc7e1a732010-03-04 22:20:33 +0100595 strbuf_release(&sb);
596 return;
597 }
598
Jacob Keller8e6df652016-08-31 16:27:24 -0700599output_header:
Stefan Bellerf3597132017-06-29 17:07:00 -0700600 strbuf_addf(&sb, "Submodule %s ", path);
brian m. carlson30e677e2018-03-12 02:27:28 +0000601 strbuf_add_unique_abbrev(&sb, one, DEFAULT_ABBREV);
René Scharfea94bb682016-10-08 17:38:47 +0200602 strbuf_addstr(&sb, (fast_backward || fast_forward) ? ".." : "...");
brian m. carlson30e677e2018-03-12 02:27:28 +0000603 strbuf_add_unique_abbrev(&sb, two, DEFAULT_ABBREV);
Johannes Schindelin752c0c22009-10-19 14:38:32 +0200604 if (message)
Stefan Bellerf3597132017-06-29 17:07:00 -0700605 strbuf_addf(&sb, " %s\n", message);
Johannes Schindelin752c0c22009-10-19 14:38:32 +0200606 else
Stefan Bellerf3597132017-06-29 17:07:00 -0700607 strbuf_addf(&sb, "%s:\n", fast_backward ? " (rewind)" : "");
608 diff_emit_submodule_header(o, sb.buf);
Johannes Schindelin752c0c22009-10-19 14:38:32 +0200609
Johannes Schindelin752c0c22009-10-19 14:38:32 +0200610 strbuf_release(&sb);
611}
Jens Lehmannee6fc512010-01-16 18:42:24 +0100612
Stefan Bellerf3597132017-06-29 17:07:00 -0700613void show_submodule_summary(struct diff_options *o, const char *path,
Jacob Keller8e6df652016-08-31 16:27:24 -0700614 struct object_id *one, struct object_id *two,
Stefan Bellerf3597132017-06-29 17:07:00 -0700615 unsigned dirty_submodule)
Jacob Keller8e6df652016-08-31 16:27:24 -0700616{
617 struct rev_info rev;
618 struct commit *left = NULL, *right = NULL;
619 struct commit_list *merge_bases = NULL;
Stefan Beller605f0ec2018-12-14 16:09:37 -0800620 struct repository *sub;
Jacob Keller8e6df652016-08-31 16:27:24 -0700621
Stefan Beller605f0ec2018-12-14 16:09:37 -0800622 sub = open_submodule(path);
Stefan Bellerf3597132017-06-29 17:07:00 -0700623 show_submodule_header(o, path, one, two, dirty_submodule,
Stefan Beller605f0ec2018-12-14 16:09:37 -0800624 sub, &left, &right, &merge_bases);
Jacob Keller8e6df652016-08-31 16:27:24 -0700625
626 /*
627 * If we don't have both a left and a right pointer, there is no
628 * reason to try and display a summary. The header line should contain
629 * all the information the user needs.
630 */
Stefan Beller605f0ec2018-12-14 16:09:37 -0800631 if (!left || !right || !sub)
Jacob Keller8e6df652016-08-31 16:27:24 -0700632 goto out;
633
634 /* Treat revision walker failure the same as missing commits */
635 if (prepare_submodule_summary(&rev, path, left, right, merge_bases)) {
Stefan Bellerf3597132017-06-29 17:07:00 -0700636 diff_emit_submodule_error(o, "(revision walker failed)\n");
Jacob Keller8e6df652016-08-31 16:27:24 -0700637 goto out;
638 }
639
Stefan Beller605f0ec2018-12-14 16:09:37 -0800640 print_submodule_summary(sub, &rev, o);
Jacob Keller8e6df652016-08-31 16:27:24 -0700641
642out:
643 if (merge_bases)
644 free_commit_list(merge_bases);
645 clear_commit_marks(left, ~0);
646 clear_commit_marks(right, ~0);
Stefan Beller605f0ec2018-12-14 16:09:37 -0800647 if (sub) {
648 repo_clear(sub);
649 free(sub);
650 }
Jacob Keller8e6df652016-08-31 16:27:24 -0700651}
652
Stefan Bellerf3597132017-06-29 17:07:00 -0700653void show_submodule_inline_diff(struct diff_options *o, const char *path,
Jacob Kellerfd47ae62016-08-31 16:27:25 -0700654 struct object_id *one, struct object_id *two,
Stefan Bellerf3597132017-06-29 17:07:00 -0700655 unsigned dirty_submodule)
Jacob Kellerfd47ae62016-08-31 16:27:25 -0700656{
Brandon Williamsbc099912018-02-14 10:59:49 -0800657 const struct object_id *old_oid = the_hash_algo->empty_tree, *new_oid = the_hash_algo->empty_tree;
Jacob Kellerfd47ae62016-08-31 16:27:25 -0700658 struct commit *left = NULL, *right = NULL;
659 struct commit_list *merge_bases = NULL;
Jacob Kellerfd47ae62016-08-31 16:27:25 -0700660 struct child_process cp = CHILD_PROCESS_INIT;
Stefan Bellerf3597132017-06-29 17:07:00 -0700661 struct strbuf sb = STRBUF_INIT;
Stefan Beller605f0ec2018-12-14 16:09:37 -0800662 struct repository *sub;
Jacob Kellerfd47ae62016-08-31 16:27:25 -0700663
Stefan Beller605f0ec2018-12-14 16:09:37 -0800664 sub = open_submodule(path);
Stefan Bellerf3597132017-06-29 17:07:00 -0700665 show_submodule_header(o, path, one, two, dirty_submodule,
Stefan Beller605f0ec2018-12-14 16:09:37 -0800666 sub, &left, &right, &merge_bases);
Jacob Kellerfd47ae62016-08-31 16:27:25 -0700667
668 /* We need a valid left and right commit to display a difference */
669 if (!(left || is_null_oid(one)) ||
670 !(right || is_null_oid(two)))
671 goto done;
672
673 if (left)
Brandon Williamsbc099912018-02-14 10:59:49 -0800674 old_oid = one;
Jacob Kellerfd47ae62016-08-31 16:27:25 -0700675 if (right)
Brandon Williamsbc099912018-02-14 10:59:49 -0800676 new_oid = two;
Jacob Kellerfd47ae62016-08-31 16:27:25 -0700677
Jacob Kellerfd47ae62016-08-31 16:27:25 -0700678 cp.git_cmd = 1;
679 cp.dir = path;
Stefan Bellerf3597132017-06-29 17:07:00 -0700680 cp.out = -1;
Jacob Kellerfd47ae62016-08-31 16:27:25 -0700681 cp.no_stdin = 1;
682
683 /* TODO: other options may need to be passed here. */
Stefan Beller5a522142017-05-04 14:43:55 -0700684 argv_array_pushl(&cp.args, "diff", "--submodule=diff", NULL);
Stefan Bellerf3597132017-06-29 17:07:00 -0700685 argv_array_pushf(&cp.args, "--color=%s", want_color(o->use_color) ?
686 "always" : "never");
Stefan Beller5a522142017-05-04 14:43:55 -0700687
Brandon Williams0d1e0e72017-10-31 11:19:11 -0700688 if (o->flags.reverse_diff) {
Jacob Kellerfd47ae62016-08-31 16:27:25 -0700689 argv_array_pushf(&cp.args, "--src-prefix=%s%s/",
690 o->b_prefix, path);
691 argv_array_pushf(&cp.args, "--dst-prefix=%s%s/",
692 o->a_prefix, path);
693 } else {
694 argv_array_pushf(&cp.args, "--src-prefix=%s%s/",
695 o->a_prefix, path);
696 argv_array_pushf(&cp.args, "--dst-prefix=%s%s/",
697 o->b_prefix, path);
698 }
Brandon Williamsbc099912018-02-14 10:59:49 -0800699 argv_array_push(&cp.args, oid_to_hex(old_oid));
Jacob Kellerfd47ae62016-08-31 16:27:25 -0700700 /*
701 * If the submodule has modified content, we will diff against the
702 * work tree, under the assumption that the user has asked for the
703 * diff format and wishes to actually see all differences even if they
704 * haven't yet been committed to the submodule yet.
705 */
706 if (!(dirty_submodule & DIRTY_SUBMODULE_MODIFIED))
Brandon Williamsbc099912018-02-14 10:59:49 -0800707 argv_array_push(&cp.args, oid_to_hex(new_oid));
Jacob Kellerfd47ae62016-08-31 16:27:25 -0700708
Stefan Beller17b254c2017-03-31 16:17:32 -0700709 prepare_submodule_repo_env(&cp.env_array);
Stefan Bellerf3597132017-06-29 17:07:00 -0700710 if (start_command(&cp))
711 diff_emit_submodule_error(o, "(diff failed)\n");
712
713 while (strbuf_getwholeline_fd(&sb, cp.out, '\n') != EOF)
714 diff_emit_submodule_pipethrough(o, sb.buf, sb.len);
715
716 if (finish_command(&cp))
717 diff_emit_submodule_error(o, "(diff failed)\n");
Jacob Kellerfd47ae62016-08-31 16:27:25 -0700718
719done:
Stefan Bellerf3597132017-06-29 17:07:00 -0700720 strbuf_release(&sb);
Jacob Kellerfd47ae62016-08-31 16:27:25 -0700721 if (merge_bases)
722 free_commit_list(merge_bases);
723 if (left)
724 clear_commit_marks(left, ~0);
725 if (right)
726 clear_commit_marks(right, ~0);
Stefan Beller605f0ec2018-12-14 16:09:37 -0800727 if (sub) {
728 repo_clear(sub);
729 free(sub);
730 }
Jacob Kellerfd47ae62016-08-31 16:27:25 -0700731}
732
Stefan Beller84f89252017-03-14 14:46:34 -0700733int should_update_submodules(void)
734{
735 return config_update_recurse_submodules == RECURSE_SUBMODULES_ON;
736}
737
738const struct submodule *submodule_from_ce(const struct cache_entry *ce)
739{
740 if (!S_ISGITLINK(ce->ce_mode))
741 return NULL;
742
743 if (!should_update_submodules())
744 return NULL;
745
Stefan Beller3b8fb392018-03-28 15:35:29 -0700746 return submodule_from_path(the_repository, &null_oid, ce->name);
Stefan Beller84f89252017-03-14 14:46:34 -0700747}
748
Brandon Williamsaacc5c12017-05-01 18:02:39 -0700749static struct oid_array *submodule_commits(struct string_list *submodules,
Heiko Voigtc68f8372017-10-16 15:58:27 +0200750 const char *name)
Brandon Williamsaacc5c12017-05-01 18:02:39 -0700751{
752 struct string_list_item *item;
753
Heiko Voigtc68f8372017-10-16 15:58:27 +0200754 item = string_list_insert(submodules, name);
Brandon Williamsaacc5c12017-05-01 18:02:39 -0700755 if (item->util)
756 return (struct oid_array *) item->util;
757
758 /* NEEDSWORK: should we have oid_array_init()? */
759 item->util = xcalloc(1, sizeof(struct oid_array));
760 return (struct oid_array *) item->util;
761}
762
Heiko Voigtc68f8372017-10-16 15:58:27 +0200763struct collect_changed_submodules_cb_data {
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +0200764 struct repository *repo;
Heiko Voigtc68f8372017-10-16 15:58:27 +0200765 struct string_list *changed;
766 const struct object_id *commit_oid;
767};
768
769/*
770 * this would normally be two functions: default_name_from_path() and
771 * path_from_default_name(). Since the default name is the same as
772 * the submodule path we can get away with just one function which only
773 * checks whether there is a submodule in the working directory at that
774 * location.
775 */
776static const char *default_name_or_path(const char *path_or_name)
777{
778 int error_code;
779
780 if (!is_submodule_populated_gently(path_or_name, &error_code))
781 return NULL;
782
783 return path_or_name;
784}
785
Brandon Williamsaacc5c12017-05-01 18:02:39 -0700786static void collect_changed_submodules_cb(struct diff_queue_struct *q,
787 struct diff_options *options,
788 void *data)
789{
Heiko Voigtc68f8372017-10-16 15:58:27 +0200790 struct collect_changed_submodules_cb_data *me = data;
791 struct string_list *changed = me->changed;
792 const struct object_id *commit_oid = me->commit_oid;
Brandon Williamsaacc5c12017-05-01 18:02:39 -0700793 int i;
Brandon Williamsaacc5c12017-05-01 18:02:39 -0700794
795 for (i = 0; i < q->nr; i++) {
796 struct diff_filepair *p = q->queue[i];
797 struct oid_array *commits;
Heiko Voigtc68f8372017-10-16 15:58:27 +0200798 const struct submodule *submodule;
799 const char *name;
800
Brandon Williamsaacc5c12017-05-01 18:02:39 -0700801 if (!S_ISGITLINK(p->two->mode))
802 continue;
803
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +0200804 submodule = submodule_from_path(me->repo,
Stefan Beller3b8fb392018-03-28 15:35:29 -0700805 commit_oid, p->two->path);
Heiko Voigtc68f8372017-10-16 15:58:27 +0200806 if (submodule)
807 name = submodule->name;
808 else {
809 name = default_name_or_path(p->two->path);
810 /* make sure name does not collide with existing one */
Stefan Beller5fc84752018-06-14 10:31:07 -0700811 if (name)
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +0200812 submodule = submodule_from_name(me->repo,
Stefan Beller5fc84752018-06-14 10:31:07 -0700813 commit_oid, name);
Heiko Voigtc68f8372017-10-16 15:58:27 +0200814 if (submodule) {
Ralf Thielowa4ffbbb2020-01-15 19:07:01 +0100815 warning(_("Submodule in commit %s at path: "
Heiko Voigtc68f8372017-10-16 15:58:27 +0200816 "'%s' collides with a submodule named "
Ralf Thielowa4ffbbb2020-01-15 19:07:01 +0100817 "the same. Skipping it."),
Stefan Beller5fc84752018-06-14 10:31:07 -0700818 oid_to_hex(commit_oid), p->two->path);
Heiko Voigtc68f8372017-10-16 15:58:27 +0200819 name = NULL;
820 }
Brandon Williamsaacc5c12017-05-01 18:02:39 -0700821 }
Heiko Voigtc68f8372017-10-16 15:58:27 +0200822
823 if (!name)
824 continue;
825
826 commits = submodule_commits(changed, name);
827 oid_array_append(commits, &p->two->oid);
Brandon Williamsaacc5c12017-05-01 18:02:39 -0700828 }
829}
830
831/*
832 * Collect the paths of submodules in 'changed' which have changed based on
833 * the revisions as specified in 'argv'. Each entry in 'changed' will also
834 * have a corresponding 'struct oid_array' (in the 'util' field) which lists
835 * what the submodule pointers were updated to during the change.
836 */
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +0200837static void collect_changed_submodules(struct repository *r,
Nguyễn Thái Ngọc Duy174d1312018-09-21 17:57:35 +0200838 struct string_list *changed,
Brandon Williamsaacc5c12017-05-01 18:02:39 -0700839 struct argv_array *argv)
840{
841 struct rev_info rev;
842 const struct commit *commit;
843
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +0200844 repo_init_revisions(r, &rev, NULL);
Brandon Williamsaacc5c12017-05-01 18:02:39 -0700845 setup_revisions(argv->argc, argv->argv, &rev, NULL);
846 if (prepare_revision_walk(&rev))
Ralf Thielowa4ffbbb2020-01-15 19:07:01 +0100847 die(_("revision walk setup failed"));
Brandon Williamsaacc5c12017-05-01 18:02:39 -0700848
849 while ((commit = get_revision(&rev))) {
850 struct rev_info diff_rev;
Heiko Voigtc68f8372017-10-16 15:58:27 +0200851 struct collect_changed_submodules_cb_data data;
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +0200852 data.repo = r;
Heiko Voigtc68f8372017-10-16 15:58:27 +0200853 data.changed = changed;
854 data.commit_oid = &commit->object.oid;
Brandon Williamsaacc5c12017-05-01 18:02:39 -0700855
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +0200856 repo_init_revisions(r, &diff_rev, NULL);
Brandon Williamsaacc5c12017-05-01 18:02:39 -0700857 diff_rev.diffopt.output_format |= DIFF_FORMAT_CALLBACK;
858 diff_rev.diffopt.format_callback = collect_changed_submodules_cb;
Heiko Voigtc68f8372017-10-16 15:58:27 +0200859 diff_rev.diffopt.format_callback_data = &data;
Brandon Williamsaacc5c12017-05-01 18:02:39 -0700860 diff_tree_combined_merge(commit, 1, &diff_rev);
861 }
862
863 reset_revision_walk();
864}
865
866static void free_submodules_oids(struct string_list *submodules)
867{
868 struct string_list_item *item;
869 for_each_string_list_item(item, submodules)
870 oid_array_clear((struct oid_array *) item->util);
871 string_list_clear(submodules, 1);
872}
873
Michael Haggerty7290ef52015-05-25 18:39:07 +0000874static int has_remote(const char *refname, const struct object_id *oid,
875 int flags, void *cb_data)
Fredrik Gustafssond2b17b32011-08-20 00:08:47 +0200876{
877 return 1;
878}
879
brian m. carlson1b7ba792017-03-31 01:39:59 +0000880static int append_oid_to_argv(const struct object_id *oid, void *data)
Fredrik Gustafssond2b17b32011-08-20 00:08:47 +0200881{
Heiko Voigt9cfa1c22016-11-16 16:11:05 +0100882 struct argv_array *argv = data;
brian m. carlson1b7ba792017-03-31 01:39:59 +0000883 argv_array_push(argv, oid_to_hex(oid));
Heiko Voigt9cfa1c22016-11-16 16:11:05 +0100884 return 0;
885}
886
Stefan Beller3c96aa92017-09-12 10:30:27 -0700887struct has_commit_data {
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +0200888 struct repository *repo;
Stefan Beller3c96aa92017-09-12 10:30:27 -0700889 int result;
890 const char *path;
891};
892
brian m. carlson1b7ba792017-03-31 01:39:59 +0000893static int check_has_commit(const struct object_id *oid, void *data)
Fredrik Gustafssond2b17b32011-08-20 00:08:47 +0200894{
Stefan Beller3c96aa92017-09-12 10:30:27 -0700895 struct has_commit_data *cb = data;
Heiko Voigt5b6607d2016-11-16 16:11:06 +0100896
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +0200897 enum object_type type = oid_object_info(cb->repo, oid, NULL);
Heiko Voigt5b6607d2016-11-16 16:11:06 +0100898
Stefan Beller3c96aa92017-09-12 10:30:27 -0700899 switch (type) {
900 case OBJ_COMMIT:
901 return 0;
902 case OBJ_BAD:
903 /*
904 * Object is missing or invalid. If invalid, an error message
905 * has already been printed.
906 */
907 cb->result = 0;
908 return 0;
909 default:
910 die(_("submodule entry '%s' (%s) is a %s, not a commit"),
Brandon Williamsdebca9d2018-02-14 10:59:24 -0800911 cb->path, oid_to_hex(oid), type_name(type));
Stefan Beller3c96aa92017-09-12 10:30:27 -0700912 }
Heiko Voigt5b6607d2016-11-16 16:11:06 +0100913}
914
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +0200915static int submodule_has_commits(struct repository *r,
916 const char *path,
917 struct oid_array *commits)
Heiko Voigt5b6607d2016-11-16 16:11:06 +0100918{
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +0200919 struct has_commit_data has_commit = { r, 1, path };
Heiko Voigt5b6607d2016-11-16 16:11:06 +0100920
Brandon Williams7c8d2b02017-05-01 18:02:38 -0700921 /*
Ville Skyttä64127572017-06-25 13:20:41 +0300922 * Perform a cheap, but incorrect check for the existence of 'commits'.
Brandon Williams7c8d2b02017-05-01 18:02:38 -0700923 * This is done by adding the submodule's object store to the in-core
Ville Skyttä64127572017-06-25 13:20:41 +0300924 * object store, and then querying for each commit's existence. If we
Brandon Williams7c8d2b02017-05-01 18:02:38 -0700925 * do not have the commit object anywhere, there is no chance we have
926 * it in the object store of the correct submodule and have it
927 * reachable from a ref, so we can fail early without spawning rev-list
928 * which is expensive.
929 */
Heiko Voigt5b6607d2016-11-16 16:11:06 +0100930 if (add_submodule_odb(path))
931 return 0;
932
brian m. carlson910650d2017-03-31 01:40:00 +0000933 oid_array_for_each_unique(commits, check_has_commit, &has_commit);
Brandon Williams7c8d2b02017-05-01 18:02:38 -0700934
Stefan Beller3c96aa92017-09-12 10:30:27 -0700935 if (has_commit.result) {
Brandon Williams7c8d2b02017-05-01 18:02:38 -0700936 /*
937 * Even if the submodule is checked out and the commit is
938 * present, make sure it exists in the submodule's object store
939 * and that it is reachable from a ref.
940 */
941 struct child_process cp = CHILD_PROCESS_INIT;
942 struct strbuf out = STRBUF_INIT;
943
944 argv_array_pushl(&cp.args, "rev-list", "-n", "1", NULL);
945 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
946 argv_array_pushl(&cp.args, "--not", "--all", NULL);
947
948 prepare_submodule_repo_env(&cp.env_array);
949 cp.git_cmd = 1;
950 cp.no_stdin = 1;
951 cp.dir = path;
952
953 if (capture_command(&cp, &out, GIT_MAX_HEXSZ + 1) || out.len)
Stefan Beller3c96aa92017-09-12 10:30:27 -0700954 has_commit.result = 0;
Brandon Williams7c8d2b02017-05-01 18:02:38 -0700955
956 strbuf_release(&out);
957 }
958
Stefan Beller3c96aa92017-09-12 10:30:27 -0700959 return has_commit.result;
Heiko Voigt5b6607d2016-11-16 16:11:06 +0100960}
961
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +0200962static int submodule_needs_pushing(struct repository *r,
963 const char *path,
964 struct oid_array *commits)
Heiko Voigt5b6607d2016-11-16 16:11:06 +0100965{
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +0200966 if (!submodule_has_commits(r, path, commits))
Heiko Voigt250ab242016-11-16 16:11:07 +0100967 /*
968 * NOTE: We do consider it safe to return "no" here. The
969 * correct answer would be "We do not know" instead of
970 * "No push needed", but it is quite hard to change
971 * the submodule pointer without having the submodule
972 * around. If a user did however change the submodules
973 * without having the submodule around, this indicates
974 * an expert who knows what they are doing or a
975 * maintainer integrating work from other people. In
976 * both cases it should be safe to skip this check.
977 */
Fredrik Gustafssond2b17b32011-08-20 00:08:47 +0200978 return 0;
979
980 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
René Scharfed3180272014-08-19 21:09:35 +0200981 struct child_process cp = CHILD_PROCESS_INIT;
Fredrik Gustafssond2b17b32011-08-20 00:08:47 +0200982 struct strbuf buf = STRBUF_INIT;
983 int needs_pushing = 0;
984
Heiko Voigt5b6607d2016-11-16 16:11:06 +0100985 argv_array_push(&cp.args, "rev-list");
brian m. carlson910650d2017-03-31 01:40:00 +0000986 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
Heiko Voigt5b6607d2016-11-16 16:11:06 +0100987 argv_array_pushl(&cp.args, "--not", "--remotes", "-n", "1" , NULL);
988
Jeff Kingc12e8652016-04-28 09:39:15 -0400989 prepare_submodule_repo_env(&cp.env_array);
Fredrik Gustafssond2b17b32011-08-20 00:08:47 +0200990 cp.git_cmd = 1;
991 cp.no_stdin = 1;
992 cp.out = -1;
993 cp.dir = path;
994 if (start_command(&cp))
Ralf Thielowa4ffbbb2020-01-15 19:07:01 +0100995 die(_("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s"),
Heiko Voigt5b6607d2016-11-16 16:11:06 +0100996 path);
brian m. carlsondb1ba2a2019-02-19 00:04:59 +0000997 if (strbuf_read(&buf, cp.out, the_hash_algo->hexsz + 1))
Fredrik Gustafssond2b17b32011-08-20 00:08:47 +0200998 needs_pushing = 1;
999 finish_command(&cp);
1000 close(cp.out);
1001 strbuf_release(&buf);
1002 return needs_pushing;
1003 }
1004
1005 return 0;
1006}
1007
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +02001008int find_unpushed_submodules(struct repository *r,
Nguyễn Thái Ngọc Duy174d1312018-09-21 17:57:35 +02001009 struct oid_array *commits,
1010 const char *remotes_name,
1011 struct string_list *needs_pushing)
Fredrik Gustafssond2b17b32011-08-20 00:08:47 +02001012{
Heiko Voigt14739442016-11-16 16:11:04 +01001013 struct string_list submodules = STRING_LIST_INIT_DUP;
Heiko Voigtc68f8372017-10-16 15:58:27 +02001014 struct string_list_item *name;
Heiko Voigt9cfa1c22016-11-16 16:11:05 +01001015 struct argv_array argv = ARGV_ARRAY_INIT;
Heiko Voigta762e512012-03-29 09:21:23 +02001016
Heiko Voigt9cfa1c22016-11-16 16:11:05 +01001017 /* argv.argv[0] will be ignored by setup_revisions */
1018 argv_array_push(&argv, "find_unpushed_submodules");
brian m. carlson910650d2017-03-31 01:40:00 +00001019 oid_array_for_each_unique(commits, append_oid_to_argv, &argv);
Heiko Voigt9cfa1c22016-11-16 16:11:05 +01001020 argv_array_push(&argv, "--not");
1021 argv_array_pushf(&argv, "--remotes=%s", remotes_name);
1022
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +02001023 collect_changed_submodules(r, &submodules, &argv);
Fredrik Gustafssond2b17b32011-08-20 00:08:47 +02001024
Heiko Voigtc68f8372017-10-16 15:58:27 +02001025 for_each_string_list_item(name, &submodules) {
1026 struct oid_array *commits = name->util;
1027 const struct submodule *submodule;
1028 const char *path = NULL;
1029
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +02001030 submodule = submodule_from_name(r, &null_oid, name->string);
Heiko Voigtc68f8372017-10-16 15:58:27 +02001031 if (submodule)
1032 path = submodule->path;
1033 else
1034 path = default_name_or_path(name->string);
1035
1036 if (!path)
1037 continue;
Heiko Voigt5b6607d2016-11-16 16:11:06 +01001038
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +02001039 if (submodule_needs_pushing(r, path, commits))
Brandon Williamsaacc5c12017-05-01 18:02:39 -07001040 string_list_insert(needs_pushing, path);
Heiko Voigt14739442016-11-16 16:11:04 +01001041 }
Brandon Williams610b2332017-04-28 16:53:58 -07001042
1043 free_submodules_oids(&submodules);
Brandon Williamsaacc5c12017-05-01 18:02:39 -07001044 argv_array_clear(&argv);
Fredrik Gustafssond2b17b32011-08-20 00:08:47 +02001045
Heiko Voigta762e512012-03-29 09:21:23 +02001046 return needs_pushing->nr;
Fredrik Gustafssond2b17b32011-08-20 00:08:47 +02001047}
1048
Brandon Williams2a905562017-04-05 10:47:16 -07001049static int push_submodule(const char *path,
Brandon Williams06bf4ad2017-04-05 10:47:19 -07001050 const struct remote *remote,
Brandon Williams60fba4b2018-05-16 15:58:23 -07001051 const struct refspec *rs,
Brandon Williams2a905562017-04-05 10:47:16 -07001052 const struct string_list *push_options,
1053 int dry_run)
Heiko Voigteb21c732012-03-29 09:21:24 +02001054{
Heiko Voigteb21c732012-03-29 09:21:24 +02001055 if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
René Scharfed3180272014-08-19 21:09:35 +02001056 struct child_process cp = CHILD_PROCESS_INIT;
Brandon Williams0301c822016-11-17 10:46:04 -08001057 argv_array_push(&cp.args, "push");
1058 if (dry_run)
1059 argv_array_push(&cp.args, "--dry-run");
Heiko Voigteb21c732012-03-29 09:21:24 +02001060
Brandon Williams2a905562017-04-05 10:47:16 -07001061 if (push_options && push_options->nr) {
1062 const struct string_list_item *item;
1063 for_each_string_list_item(item, push_options)
1064 argv_array_pushf(&cp.args, "--push-option=%s",
1065 item->string);
1066 }
Brandon Williams06bf4ad2017-04-05 10:47:19 -07001067
1068 if (remote->origin != REMOTE_UNCONFIGURED) {
1069 int i;
1070 argv_array_push(&cp.args, remote->name);
Brandon Williams60fba4b2018-05-16 15:58:23 -07001071 for (i = 0; i < rs->raw_nr; i++)
1072 argv_array_push(&cp.args, rs->raw[i]);
Brandon Williams06bf4ad2017-04-05 10:47:19 -07001073 }
1074
Jeff Kingc12e8652016-04-28 09:39:15 -04001075 prepare_submodule_repo_env(&cp.env_array);
Heiko Voigteb21c732012-03-29 09:21:24 +02001076 cp.git_cmd = 1;
1077 cp.no_stdin = 1;
1078 cp.dir = path;
1079 if (run_command(&cp))
1080 return 0;
1081 close(cp.out);
1082 }
1083
1084 return 1;
1085}
1086
Brandon Williams06bf4ad2017-04-05 10:47:19 -07001087/*
1088 * Perform a check in the submodule to see if the remote and refspec work.
1089 * Die if the submodule can't be pushed.
1090 */
Brandon Williamsc7be7202017-07-20 10:40:37 -07001091static void submodule_push_check(const char *path, const char *head,
1092 const struct remote *remote,
Brandon Williams60fba4b2018-05-16 15:58:23 -07001093 const struct refspec *rs)
Brandon Williams06bf4ad2017-04-05 10:47:19 -07001094{
1095 struct child_process cp = CHILD_PROCESS_INIT;
1096 int i;
1097
1098 argv_array_push(&cp.args, "submodule--helper");
1099 argv_array_push(&cp.args, "push-check");
Brandon Williamsc7be7202017-07-20 10:40:37 -07001100 argv_array_push(&cp.args, head);
Brandon Williams06bf4ad2017-04-05 10:47:19 -07001101 argv_array_push(&cp.args, remote->name);
1102
Brandon Williams60fba4b2018-05-16 15:58:23 -07001103 for (i = 0; i < rs->raw_nr; i++)
1104 argv_array_push(&cp.args, rs->raw[i]);
Brandon Williams06bf4ad2017-04-05 10:47:19 -07001105
1106 prepare_submodule_repo_env(&cp.env_array);
1107 cp.git_cmd = 1;
1108 cp.no_stdin = 1;
1109 cp.no_stdout = 1;
1110 cp.dir = path;
1111
1112 /*
1113 * Simply indicate if 'submodule--helper push-check' failed.
1114 * More detailed error information will be provided by the
1115 * child process.
1116 */
1117 if (run_command(&cp))
Ralf Thielowa4ffbbb2020-01-15 19:07:01 +01001118 die(_("process for submodule '%s' failed"), path);
Brandon Williams06bf4ad2017-04-05 10:47:19 -07001119}
1120
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +02001121int push_unpushed_submodules(struct repository *r,
Nguyễn Thái Ngọc Duy174d1312018-09-21 17:57:35 +02001122 struct oid_array *commits,
Brandon Williams06bf4ad2017-04-05 10:47:19 -07001123 const struct remote *remote,
Brandon Williams60fba4b2018-05-16 15:58:23 -07001124 const struct refspec *rs,
Brandon Williams2a905562017-04-05 10:47:16 -07001125 const struct string_list *push_options,
Brandon Williams0301c822016-11-17 10:46:04 -08001126 int dry_run)
Heiko Voigteb21c732012-03-29 09:21:24 +02001127{
1128 int i, ret = 1;
Tanay Abhraf93d7c62014-07-18 02:19:00 -07001129 struct string_list needs_pushing = STRING_LIST_INIT_DUP;
Heiko Voigteb21c732012-03-29 09:21:24 +02001130
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +02001131 if (!find_unpushed_submodules(r, commits,
Nguyễn Thái Ngọc Duy174d1312018-09-21 17:57:35 +02001132 remote->name, &needs_pushing))
Heiko Voigteb21c732012-03-29 09:21:24 +02001133 return 1;
1134
Brandon Williams06bf4ad2017-04-05 10:47:19 -07001135 /*
1136 * Verify that the remote and refspec can be propagated to all
1137 * submodules. This check can be skipped if the remote and refspec
1138 * won't be propagated due to the remote being unconfigured (e.g. a URL
1139 * instead of a remote name).
1140 */
Brandon Williamsc7be7202017-07-20 10:40:37 -07001141 if (remote->origin != REMOTE_UNCONFIGURED) {
1142 char *head;
1143 struct object_id head_oid;
1144
brian m. carlson0f2dc722017-10-15 22:06:55 +00001145 head = resolve_refdup("HEAD", 0, &head_oid, NULL);
Brandon Williamsc7be7202017-07-20 10:40:37 -07001146 if (!head)
1147 die(_("Failed to resolve HEAD as a valid ref."));
1148
Brandon Williams06bf4ad2017-04-05 10:47:19 -07001149 for (i = 0; i < needs_pushing.nr; i++)
1150 submodule_push_check(needs_pushing.items[i].string,
Brandon Williams60fba4b2018-05-16 15:58:23 -07001151 head, remote, rs);
Brandon Williamsc7be7202017-07-20 10:40:37 -07001152 free(head);
1153 }
Brandon Williams06bf4ad2017-04-05 10:47:19 -07001154
1155 /* Actually push the submodules */
Heiko Voigteb21c732012-03-29 09:21:24 +02001156 for (i = 0; i < needs_pushing.nr; i++) {
1157 const char *path = needs_pushing.items[i].string;
Ralf Thielowa4ffbbb2020-01-15 19:07:01 +01001158 fprintf(stderr, _("Pushing submodule '%s'\n"), path);
Brandon Williams60fba4b2018-05-16 15:58:23 -07001159 if (!push_submodule(path, remote, rs,
Brandon Williams06bf4ad2017-04-05 10:47:19 -07001160 push_options, dry_run)) {
Ralf Thielowa4ffbbb2020-01-15 19:07:01 +01001161 fprintf(stderr, _("Unable to push submodule '%s'\n"), path);
Heiko Voigteb21c732012-03-29 09:21:24 +02001162 ret = 0;
1163 }
1164 }
1165
1166 string_list_clear(&needs_pushing, 0);
1167
1168 return ret;
1169}
1170
Brandon Williams419fd782017-04-28 16:53:57 -07001171static int append_oid_to_array(const char *ref, const struct object_id *oid,
1172 int flags, void *data)
Jeff King6859de42011-09-12 15:56:52 -04001173{
Brandon Williams419fd782017-04-28 16:53:57 -07001174 struct oid_array *array = data;
1175 oid_array_append(array, oid);
Jeff King6859de42011-09-12 15:56:52 -04001176 return 0;
1177}
1178
brian m. carlson2eb80bc2017-03-26 16:01:35 +00001179void check_for_new_submodule_commits(struct object_id *oid)
Jens Lehmann88a21972011-03-06 23:10:46 +01001180{
Jeff King6859de42011-09-12 15:56:52 -04001181 if (!initialized_fetch_ref_tips) {
Brandon Williams419fd782017-04-28 16:53:57 -07001182 for_each_ref(append_oid_to_array, &ref_tips_before_fetch);
Jeff King6859de42011-09-12 15:56:52 -04001183 initialized_fetch_ref_tips = 1;
1184 }
1185
brian m. carlson910650d2017-03-31 01:40:00 +00001186 oid_array_append(&ref_tips_after_fetch, oid);
Jeff King6859de42011-09-12 15:56:52 -04001187}
1188
Stefan Beller16dd6fe2018-11-28 16:27:51 -08001189static void calculate_changed_submodule_paths(struct repository *r,
1190 struct string_list *changed_submodule_names)
Jeff King6859de42011-09-12 15:56:52 -04001191{
Jeff Kingc1189ca2011-09-13 17:57:57 -04001192 struct argv_array argv = ARGV_ARRAY_INIT;
Stefan Bellerbcd73372018-11-28 16:27:52 -08001193 struct string_list_item *name;
Jens Lehmann88a21972011-03-06 23:10:46 +01001194
Jens Lehmann18322ba2011-09-09 20:22:03 +02001195 /* No need to check if there are no submodules configured */
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +02001196 if (!submodule_from_path(r, NULL, NULL))
Jens Lehmann18322ba2011-09-09 20:22:03 +02001197 return;
1198
Jeff Kingc1189ca2011-09-13 17:57:57 -04001199 argv_array_push(&argv, "--"); /* argv[0] program name */
brian m. carlson910650d2017-03-31 01:40:00 +00001200 oid_array_for_each_unique(&ref_tips_after_fetch,
Brandon Williamsd1a84602017-04-28 16:53:59 -07001201 append_oid_to_argv, &argv);
Jeff Kingc1189ca2011-09-13 17:57:57 -04001202 argv_array_push(&argv, "--not");
brian m. carlson910650d2017-03-31 01:40:00 +00001203 oid_array_for_each_unique(&ref_tips_before_fetch,
Brandon Williamsd1a84602017-04-28 16:53:59 -07001204 append_oid_to_argv, &argv);
Jens Lehmann88a21972011-03-06 23:10:46 +01001205
1206 /*
1207 * Collect all submodules (whether checked out or not) for which new
Heiko Voigtc68f8372017-10-16 15:58:27 +02001208 * commits have been recorded upstream in "changed_submodule_names".
Jens Lehmann88a21972011-03-06 23:10:46 +01001209 */
Stefan Bellerbcd73372018-11-28 16:27:52 -08001210 collect_changed_submodules(r, changed_submodule_names, &argv);
Brandon Williamsaacc5c12017-05-01 18:02:39 -07001211
Stefan Bellerbcd73372018-11-28 16:27:52 -08001212 for_each_string_list_item(name, changed_submodule_names) {
Heiko Voigtc68f8372017-10-16 15:58:27 +02001213 struct oid_array *commits = name->util;
1214 const struct submodule *submodule;
1215 const char *path = NULL;
1216
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +02001217 submodule = submodule_from_name(r, &null_oid, name->string);
Heiko Voigtc68f8372017-10-16 15:58:27 +02001218 if (submodule)
1219 path = submodule->path;
1220 else
1221 path = default_name_or_path(name->string);
1222
1223 if (!path)
1224 continue;
Brandon Williamsaacc5c12017-05-01 18:02:39 -07001225
Stefan Bellerbcd73372018-11-28 16:27:52 -08001226 if (submodule_has_commits(r, path, commits)) {
1227 oid_array_clear(commits);
1228 *name->string = '\0';
1229 }
Jens Lehmann88a21972011-03-06 23:10:46 +01001230 }
Jeff King6859de42011-09-12 15:56:52 -04001231
Stefan Bellerbcd73372018-11-28 16:27:52 -08001232 string_list_remove_empty_items(changed_submodule_names, 1);
1233
Jeff Kingc1189ca2011-09-13 17:57:57 -04001234 argv_array_clear(&argv);
brian m. carlson910650d2017-03-31 01:40:00 +00001235 oid_array_clear(&ref_tips_before_fetch);
1236 oid_array_clear(&ref_tips_after_fetch);
Jeff King6859de42011-09-12 15:56:52 -04001237 initialized_fetch_ref_tips = 0;
Jens Lehmann88a21972011-03-06 23:10:46 +01001238}
1239
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +02001240int submodule_touches_in_range(struct repository *r,
Nguyễn Thái Ngọc Duy174d1312018-09-21 17:57:35 +02001241 struct object_id *excl_oid,
Stefan Bellera6d7eb22017-06-23 12:13:02 -07001242 struct object_id *incl_oid)
1243{
1244 struct string_list subs = STRING_LIST_INIT_DUP;
1245 struct argv_array args = ARGV_ARRAY_INIT;
1246 int ret;
1247
Stefan Bellera6d7eb22017-06-23 12:13:02 -07001248 /* No need to check if there are no submodules configured */
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +02001249 if (!submodule_from_path(r, NULL, NULL))
Stefan Bellera6d7eb22017-06-23 12:13:02 -07001250 return 0;
1251
1252 argv_array_push(&args, "--"); /* args[0] program name */
1253 argv_array_push(&args, oid_to_hex(incl_oid));
Jonathan Tan4d36f882018-05-24 13:47:29 -07001254 if (!is_null_oid(excl_oid)) {
1255 argv_array_push(&args, "--not");
1256 argv_array_push(&args, oid_to_hex(excl_oid));
1257 }
Stefan Bellera6d7eb22017-06-23 12:13:02 -07001258
Nguyễn Thái Ngọc Duy6245b982018-10-19 19:34:43 +02001259 collect_changed_submodules(r, &subs, &args);
Stefan Bellera6d7eb22017-06-23 12:13:02 -07001260 ret = subs.nr;
1261
1262 argv_array_clear(&args);
1263
1264 free_submodules_oids(&subs);
1265 return ret;
1266}
1267
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001268struct submodule_parallel_fetch {
1269 int count;
1270 struct argv_array args;
Brandon Williamse7241972017-12-12 11:53:52 -08001271 struct repository *r;
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001272 const char *prefix;
1273 int command_line_option;
Brandon Williams8fa29152017-08-02 12:49:19 -07001274 int default_option;
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001275 int quiet;
1276 int result;
Stefan Beller16dd6fe2018-11-28 16:27:51 -08001277
1278 struct string_list changed_submodule_names;
Stefan Bellerbe76c212018-12-06 13:26:55 -08001279
1280 /* Pending fetches by OIDs */
1281 struct fetch_task **oid_fetch_tasks;
1282 int oid_fetch_tasks_nr, oid_fetch_tasks_alloc;
Emily Shaffer02225402020-01-16 14:20:12 -08001283
1284 struct strbuf submodules_with_errors;
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001285};
Stefan Bellerbe76c212018-12-06 13:26:55 -08001286#define SPF_INIT {0, ARGV_ARRAY_INIT, NULL, NULL, 0, 0, 0, 0, \
1287 STRING_LIST_INIT_DUP, \
Emily Shaffer02225402020-01-16 14:20:12 -08001288 NULL, 0, 0, STRBUF_INIT}
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001289
Heiko Voigt4b4aced2017-10-16 15:59:05 +02001290static int get_fetch_recurse_config(const struct submodule *submodule,
1291 struct submodule_parallel_fetch *spf)
1292{
1293 if (spf->command_line_option != RECURSE_SUBMODULES_DEFAULT)
1294 return spf->command_line_option;
1295
1296 if (submodule) {
1297 char *key;
1298 const char *value;
1299
1300 int fetch_recurse = submodule->fetch_recurse;
1301 key = xstrfmt("submodule.%s.fetchRecurseSubmodules", submodule->name);
Brandon Williamse7241972017-12-12 11:53:52 -08001302 if (!repo_config_get_string_const(spf->r, key, &value)) {
Heiko Voigt4b4aced2017-10-16 15:59:05 +02001303 fetch_recurse = parse_fetch_recurse_submodules_arg(key, value);
1304 }
1305 free(key);
1306
1307 if (fetch_recurse != RECURSE_SUBMODULES_NONE)
1308 /* local config overrules everything except commandline */
1309 return fetch_recurse;
1310 }
1311
1312 return spf->default_option;
1313}
1314
Stefan Bellerbe76c212018-12-06 13:26:55 -08001315/*
1316 * Fetch in progress (if callback data) or
1317 * pending (if in oid_fetch_tasks in struct submodule_parallel_fetch)
1318 */
1319struct fetch_task {
1320 struct repository *repo;
1321 const struct submodule *sub;
1322 unsigned free_sub : 1; /* Do we need to free the submodule? */
1323
1324 struct oid_array *commits; /* Ensure these commits are fetched */
1325};
1326
1327/**
1328 * When a submodule is not defined in .gitmodules, we cannot access it
1329 * via the regular submodule-config. Create a fake submodule, which we can
1330 * work on.
1331 */
1332static const struct submodule *get_non_gitmodules_submodule(const char *path)
1333{
1334 struct submodule *ret = NULL;
1335 const char *name = default_name_or_path(path);
1336
1337 if (!name)
1338 return NULL;
1339
1340 ret = xmalloc(sizeof(*ret));
1341 memset(ret, 0, sizeof(*ret));
1342 ret->path = name;
1343 ret->name = name;
1344
1345 return (const struct submodule *) ret;
1346}
1347
1348static struct fetch_task *fetch_task_create(struct repository *r,
1349 const char *path)
1350{
1351 struct fetch_task *task = xmalloc(sizeof(*task));
1352 memset(task, 0, sizeof(*task));
1353
1354 task->sub = submodule_from_path(r, &null_oid, path);
1355 if (!task->sub) {
1356 /*
1357 * No entry in .gitmodules? Technically not a submodule,
1358 * but historically we supported repositories that happen to be
1359 * in-place where a gitlink is. Keep supporting them.
1360 */
1361 task->sub = get_non_gitmodules_submodule(path);
1362 if (!task->sub) {
1363 free(task);
1364 return NULL;
1365 }
1366
1367 task->free_sub = 1;
1368 }
1369
1370 return task;
1371}
1372
1373static void fetch_task_release(struct fetch_task *p)
1374{
1375 if (p->free_sub)
1376 free((void*)p->sub);
1377 p->free_sub = 0;
1378 p->sub = NULL;
1379
1380 if (p->repo)
1381 repo_clear(p->repo);
1382 FREE_AND_NULL(p->repo);
1383}
1384
Stefan Beller26f80cc2018-11-28 16:27:54 -08001385static struct repository *get_submodule_repo_for(struct repository *r,
1386 const struct submodule *sub)
1387{
1388 struct repository *ret = xmalloc(sizeof(*ret));
1389
1390 if (repo_submodule_init(ret, r, sub)) {
1391 /*
1392 * No entry in .gitmodules? Technically not a submodule,
1393 * but historically we supported repositories that happen to be
1394 * in-place where a gitlink is. Keep supporting them.
1395 */
1396 struct strbuf gitdir = STRBUF_INIT;
1397 strbuf_repo_worktree_path(&gitdir, r, "%s/.git", sub->path);
1398 if (repo_init(ret, gitdir.buf, NULL)) {
1399 strbuf_release(&gitdir);
1400 free(ret);
1401 return NULL;
1402 }
1403 strbuf_release(&gitdir);
1404 }
1405
1406 return ret;
1407}
1408
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001409static int get_next_submodule(struct child_process *cp,
1410 struct strbuf *err, void *data, void **task_cb)
Jens Lehmann7dce19d2010-11-12 13:54:52 +01001411{
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001412 struct submodule_parallel_fetch *spf = data;
Jens Lehmann7dce19d2010-11-12 13:54:52 +01001413
Brandon Williamse7241972017-12-12 11:53:52 -08001414 for (; spf->count < spf->r->index->cache_nr; spf->count++) {
Brandon Williamse7241972017-12-12 11:53:52 -08001415 const struct cache_entry *ce = spf->r->index->cache[spf->count];
Stefan Beller26f80cc2018-11-28 16:27:54 -08001416 const char *default_argv;
Stefan Bellerbe76c212018-12-06 13:26:55 -08001417 struct fetch_task *task;
Jens Lehmann7dce19d2010-11-12 13:54:52 +01001418
1419 if (!S_ISGITLINK(ce->ce_mode))
1420 continue;
1421
Stefan Bellerbe76c212018-12-06 13:26:55 -08001422 task = fetch_task_create(spf->r, ce->name);
1423 if (!task)
1424 continue;
Brandon Williams492c6c42017-08-03 11:19:51 -07001425
Stefan Bellerbe76c212018-12-06 13:26:55 -08001426 switch (get_fetch_recurse_config(task->sub, spf))
Heiko Voigt4b4aced2017-10-16 15:59:05 +02001427 {
1428 default:
1429 case RECURSE_SUBMODULES_DEFAULT:
1430 case RECURSE_SUBMODULES_ON_DEMAND:
Stefan Bellerbe76c212018-12-06 13:26:55 -08001431 if (!task->sub ||
Stefan Beller08a297b2018-11-28 16:27:50 -08001432 !string_list_lookup(
Stefan Beller16dd6fe2018-11-28 16:27:51 -08001433 &spf->changed_submodule_names,
Stefan Bellerbe76c212018-12-06 13:26:55 -08001434 task->sub->name))
Jens Lehmann8f0700d2011-03-06 23:11:21 +01001435 continue;
1436 default_argv = "on-demand";
Heiko Voigt4b4aced2017-10-16 15:59:05 +02001437 break;
1438 case RECURSE_SUBMODULES_ON:
1439 default_argv = "yes";
1440 break;
1441 case RECURSE_SUBMODULES_OFF:
1442 continue;
Jens Lehmannbe254a02010-11-11 00:55:02 +01001443 }
1444
Stefan Bellerbe76c212018-12-06 13:26:55 -08001445 task->repo = get_submodule_repo_for(spf->r, task->sub);
1446 if (task->repo) {
1447 struct strbuf submodule_prefix = STRBUF_INIT;
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001448 child_process_init(cp);
Stefan Bellerbe76c212018-12-06 13:26:55 -08001449 cp->dir = task->repo->gitdir;
Stefan Bellera62387b2018-11-28 16:27:55 -08001450 prepare_submodule_repo_env_in_gitdir(&cp->env_array);
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001451 cp->git_cmd = 1;
1452 if (!spf->quiet)
Ralf Thielowa4ffbbb2020-01-15 19:07:01 +01001453 strbuf_addf(err, _("Fetching submodule %s%s\n"),
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001454 spf->prefix, ce->name);
1455 argv_array_init(&cp->args);
1456 argv_array_pushv(&cp->args, spf->args.argv);
1457 argv_array_push(&cp->args, default_argv);
1458 argv_array_push(&cp->args, "--submodule-prefix");
Stefan Bellerbe76c212018-12-06 13:26:55 -08001459
1460 strbuf_addf(&submodule_prefix, "%s%s/",
1461 spf->prefix,
1462 task->sub->path);
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001463 argv_array_push(&cp->args, submodule_prefix.buf);
Stefan Beller26f80cc2018-11-28 16:27:54 -08001464
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001465 spf->count++;
Stefan Bellerbe76c212018-12-06 13:26:55 -08001466 *task_cb = task;
1467
1468 strbuf_release(&submodule_prefix);
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001469 return 1;
Stefan Beller26f80cc2018-11-28 16:27:54 -08001470 } else {
Stefan Bellerbe76c212018-12-06 13:26:55 -08001471
1472 fetch_task_release(task);
1473 free(task);
1474
Stefan Beller26f80cc2018-11-28 16:27:54 -08001475 /*
1476 * An empty directory is normal,
1477 * the submodule is not initialized
1478 */
1479 if (S_ISGITLINK(ce->ce_mode) &&
1480 !is_empty_dir(ce->name)) {
1481 spf->result = 1;
1482 strbuf_addf(err,
Emily Shaffer303b3c12020-02-06 16:48:33 -08001483 _("Could not access submodule '%s'\n"),
Stefan Beller26f80cc2018-11-28 16:27:54 -08001484 ce->name);
1485 }
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001486 }
Jens Lehmann7dce19d2010-11-12 13:54:52 +01001487 }
Stefan Bellerbe76c212018-12-06 13:26:55 -08001488
1489 if (spf->oid_fetch_tasks_nr) {
1490 struct fetch_task *task =
1491 spf->oid_fetch_tasks[spf->oid_fetch_tasks_nr - 1];
1492 struct strbuf submodule_prefix = STRBUF_INIT;
1493 spf->oid_fetch_tasks_nr--;
1494
1495 strbuf_addf(&submodule_prefix, "%s%s/",
1496 spf->prefix, task->sub->path);
1497
1498 child_process_init(cp);
1499 prepare_submodule_repo_env_in_gitdir(&cp->env_array);
1500 cp->git_cmd = 1;
1501 cp->dir = task->repo->gitdir;
1502
1503 argv_array_init(&cp->args);
1504 argv_array_pushv(&cp->args, spf->args.argv);
1505 argv_array_push(&cp->args, "on-demand");
1506 argv_array_push(&cp->args, "--submodule-prefix");
1507 argv_array_push(&cp->args, submodule_prefix.buf);
1508
1509 /* NEEDSWORK: have get_default_remote from submodule--helper */
1510 argv_array_push(&cp->args, "origin");
1511 oid_array_for_each_unique(task->commits,
1512 append_oid_to_argv, &cp->args);
1513
1514 *task_cb = task;
1515 strbuf_release(&submodule_prefix);
1516 return 1;
1517 }
1518
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001519 return 0;
1520}
1521
Stefan Beller2a73b3d2016-02-29 13:57:06 -08001522static int fetch_start_failure(struct strbuf *err,
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001523 void *cb, void *task_cb)
1524{
1525 struct submodule_parallel_fetch *spf = cb;
Stefan Bellerbe76c212018-12-06 13:26:55 -08001526 struct fetch_task *task = task_cb;
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001527
1528 spf->result = 1;
1529
Stefan Bellerbe76c212018-12-06 13:26:55 -08001530 fetch_task_release(task);
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001531 return 0;
1532}
1533
Stefan Bellerbe76c212018-12-06 13:26:55 -08001534static int commit_missing_in_sub(const struct object_id *oid, void *data)
1535{
1536 struct repository *subrepo = data;
1537
1538 enum object_type type = oid_object_info(subrepo, oid, NULL);
1539
1540 return type != OBJ_COMMIT;
1541}
1542
Stefan Beller2a73b3d2016-02-29 13:57:06 -08001543static int fetch_finish(int retvalue, struct strbuf *err,
1544 void *cb, void *task_cb)
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001545{
1546 struct submodule_parallel_fetch *spf = cb;
Stefan Bellerbe76c212018-12-06 13:26:55 -08001547 struct fetch_task *task = task_cb;
1548
1549 struct string_list_item *it;
1550 struct oid_array *commits;
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001551
Emily Shaffer02225402020-01-16 14:20:12 -08001552 if (!task || !task->sub)
1553 BUG("callback cookie bogus");
1554
1555 if (retvalue) {
Jonathan Tanbd5e5672019-03-13 10:57:38 -07001556 /*
1557 * NEEDSWORK: This indicates that the overall fetch
1558 * failed, even though there may be a subsequent fetch
1559 * by commit hash that might work. It may be a good
1560 * idea to not indicate failure in this case, and only
1561 * indicate failure if the subsequent fetch fails.
1562 */
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001563 spf->result = 1;
1564
Emily Shaffer02225402020-01-16 14:20:12 -08001565 strbuf_addf(&spf->submodules_with_errors, "\t%s\n",
1566 task->sub->name);
1567 }
Stefan Bellerbe76c212018-12-06 13:26:55 -08001568
1569 /* Is this the second time we process this submodule? */
1570 if (task->commits)
1571 goto out;
1572
1573 it = string_list_lookup(&spf->changed_submodule_names, task->sub->name);
1574 if (!it)
1575 /* Could be an unchanged submodule, not contained in the list */
1576 goto out;
1577
1578 commits = it->util;
1579 oid_array_filter(commits,
1580 commit_missing_in_sub,
1581 task->repo);
1582
1583 /* Are there commits we want, but do not exist? */
1584 if (commits->nr) {
1585 task->commits = commits;
1586 ALLOC_GROW(spf->oid_fetch_tasks,
1587 spf->oid_fetch_tasks_nr + 1,
1588 spf->oid_fetch_tasks_alloc);
1589 spf->oid_fetch_tasks[spf->oid_fetch_tasks_nr] = task;
1590 spf->oid_fetch_tasks_nr++;
1591 return 0;
1592 }
1593
1594out:
1595 fetch_task_release(task);
1596
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001597 return 0;
1598}
1599
Brandon Williamse7241972017-12-12 11:53:52 -08001600int fetch_populated_submodules(struct repository *r,
1601 const struct argv_array *options,
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001602 const char *prefix, int command_line_option,
Brandon Williams8fa29152017-08-02 12:49:19 -07001603 int default_option,
Stefan Beller62104ba2015-12-15 16:04:12 -08001604 int quiet, int max_parallel_jobs)
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001605{
1606 int i;
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001607 struct submodule_parallel_fetch spf = SPF_INIT;
1608
Brandon Williamse7241972017-12-12 11:53:52 -08001609 spf.r = r;
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001610 spf.command_line_option = command_line_option;
Brandon Williams8fa29152017-08-02 12:49:19 -07001611 spf.default_option = default_option;
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001612 spf.quiet = quiet;
1613 spf.prefix = prefix;
1614
Brandon Williamse7241972017-12-12 11:53:52 -08001615 if (!r->worktree)
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001616 goto out;
1617
Brandon Williamse7241972017-12-12 11:53:52 -08001618 if (repo_read_index(r) < 0)
Ralf Thielowa4ffbbb2020-01-15 19:07:01 +01001619 die(_("index file corrupt"));
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001620
1621 argv_array_push(&spf.args, "fetch");
1622 for (i = 0; i < options->argc; i++)
1623 argv_array_push(&spf.args, options->argv[i]);
1624 argv_array_push(&spf.args, "--recurse-submodules-default");
1625 /* default value, "--submodule-prefix" and its value are added later */
1626
Stefan Beller16dd6fe2018-11-28 16:27:51 -08001627 calculate_changed_submodule_paths(r, &spf.changed_submodule_names);
1628 string_list_sort(&spf.changed_submodule_names);
Jeff Hostetleree4512e2019-02-22 14:25:01 -08001629 run_processes_parallel_tr2(max_parallel_jobs,
1630 get_next_submodule,
1631 fetch_start_failure,
1632 fetch_finish,
1633 &spf,
1634 "submodule", "parallel/fetch");
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001635
Emily Shaffer02225402020-01-16 14:20:12 -08001636 if (spf.submodules_with_errors.len > 0)
1637 fprintf(stderr, _("Errors during submodule fetch:\n%s"),
1638 spf.submodules_with_errors.buf);
1639
1640
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001641 argv_array_clear(&spf.args);
Jens Lehmann88a21972011-03-06 23:10:46 +01001642out:
Stefan Bellerbcd73372018-11-28 16:27:52 -08001643 free_submodules_oids(&spf.changed_submodule_names);
Stefan Bellerfe85ee62015-12-15 16:04:11 -08001644 return spf.result;
Jens Lehmann7dce19d2010-11-12 13:54:52 +01001645}
1646
Jens Lehmann3bfc4502010-03-13 23:00:27 +01001647unsigned is_submodule_modified(const char *path, int ignore_untracked)
Jens Lehmannee6fc512010-01-16 18:42:24 +01001648{
René Scharfed3180272014-08-19 21:09:35 +02001649 struct child_process cp = CHILD_PROCESS_INIT;
Jens Lehmannee6fc512010-01-16 18:42:24 +01001650 struct strbuf buf = STRBUF_INIT;
Stefan Belleraf6865a2017-03-24 17:36:06 -07001651 FILE *fp;
Jens Lehmannc7e1a732010-03-04 22:20:33 +01001652 unsigned dirty_submodule = 0;
Jens Lehmanneee49b62010-04-10 19:01:12 +02001653 const char *git_dir;
Stefan Belleraf6865a2017-03-24 17:36:06 -07001654 int ignore_cp_exit_code = 0;
Jens Lehmannee6fc512010-01-16 18:42:24 +01001655
Jens Lehmanneee49b62010-04-10 19:01:12 +02001656 strbuf_addf(&buf, "%s/.git", path);
Junio C Hamano13d6ec92011-08-22 14:04:56 -07001657 git_dir = read_gitfile(buf.buf);
Jens Lehmanneee49b62010-04-10 19:01:12 +02001658 if (!git_dir)
1659 git_dir = buf.buf;
Stefan Beller5c896f72017-03-24 17:36:08 -07001660 if (!is_git_directory(git_dir)) {
1661 if (is_directory(git_dir))
1662 die(_("'%s' not recognized as a git repository"), git_dir);
Jens Lehmannee6fc512010-01-16 18:42:24 +01001663 strbuf_release(&buf);
1664 /* The submodule is not checked out, so it is not modified */
1665 return 0;
Jens Lehmannee6fc512010-01-16 18:42:24 +01001666 }
1667 strbuf_reset(&buf);
1668
Stefan Bellerfcecf0b2017-03-24 17:36:07 -07001669 argv_array_pushl(&cp.args, "status", "--porcelain=2", NULL);
Jens Lehmann3bfc4502010-03-13 23:00:27 +01001670 if (ignore_untracked)
Stefan Bellerd0d7fed2017-03-24 17:36:04 -07001671 argv_array_push(&cp.args, "-uno");
Jens Lehmann3bfc4502010-03-13 23:00:27 +01001672
Jeff Kingc12e8652016-04-28 09:39:15 -04001673 prepare_submodule_repo_env(&cp.env_array);
Jens Lehmannee6fc512010-01-16 18:42:24 +01001674 cp.git_cmd = 1;
1675 cp.no_stdin = 1;
1676 cp.out = -1;
Jens Lehmanneee49b62010-04-10 19:01:12 +02001677 cp.dir = path;
Jens Lehmannee6fc512010-01-16 18:42:24 +01001678 if (start_command(&cp))
Ralf Thielowa4ffbbb2020-01-15 19:07:01 +01001679 die(_("Could not run 'git status --porcelain=2' in submodule %s"), path);
Jens Lehmannee6fc512010-01-16 18:42:24 +01001680
Stefan Belleraf6865a2017-03-24 17:36:06 -07001681 fp = xfdopen(cp.out, "r");
1682 while (strbuf_getwholeline(&buf, fp, '\n') != EOF) {
Stefan Bellerfcecf0b2017-03-24 17:36:07 -07001683 /* regular untracked files */
1684 if (buf.buf[0] == '?')
Jens Lehmannc7e1a732010-03-04 22:20:33 +01001685 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
Jens Lehmannee6fc512010-01-16 18:42:24 +01001686
Stefan Beller40069d62017-03-29 15:26:16 -07001687 if (buf.buf[0] == 'u' ||
1688 buf.buf[0] == '1' ||
1689 buf.buf[0] == '2') {
1690 /* T = line type, XY = status, SSSS = submodule state */
1691 if (buf.len < strlen("T XY SSSS"))
Johannes Schindelin033abf92018-05-02 11:38:39 +02001692 BUG("invalid status --porcelain=2 line %s",
Stefan Beller40069d62017-03-29 15:26:16 -07001693 buf.buf);
1694
1695 if (buf.buf[5] == 'S' && buf.buf[8] == 'U')
1696 /* nested untracked file */
1697 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1698
1699 if (buf.buf[0] == 'u' ||
1700 buf.buf[0] == '2' ||
1701 memcmp(buf.buf + 5, "S..U", 4))
1702 /* other change */
1703 dirty_submodule |= DIRTY_SUBMODULE_MODIFIED;
1704 }
Stefan Beller64f9a942017-03-24 17:36:05 -07001705
1706 if ((dirty_submodule & DIRTY_SUBMODULE_MODIFIED) &&
1707 ((dirty_submodule & DIRTY_SUBMODULE_UNTRACKED) ||
Stefan Belleraf6865a2017-03-24 17:36:06 -07001708 ignore_untracked)) {
1709 /*
1710 * We're not interested in any further information from
1711 * the child any more, neither output nor its exit code.
1712 */
1713 ignore_cp_exit_code = 1;
Stefan Beller64f9a942017-03-24 17:36:05 -07001714 break;
Stefan Belleraf6865a2017-03-24 17:36:06 -07001715 }
Jens Lehmannee6fc512010-01-16 18:42:24 +01001716 }
Stefan Belleraf6865a2017-03-24 17:36:06 -07001717 fclose(fp);
Jens Lehmannee6fc512010-01-16 18:42:24 +01001718
Stefan Belleraf6865a2017-03-24 17:36:06 -07001719 if (finish_command(&cp) && !ignore_cp_exit_code)
Ralf Thielowa4ffbbb2020-01-15 19:07:01 +01001720 die(_("'git status --porcelain=2' failed in submodule %s"), path);
Jens Lehmannee6fc512010-01-16 18:42:24 +01001721
Jens Lehmannee6fc512010-01-16 18:42:24 +01001722 strbuf_release(&buf);
Jens Lehmannc7e1a732010-03-04 22:20:33 +01001723 return dirty_submodule;
Jens Lehmannee6fc512010-01-16 18:42:24 +01001724}
Heiko Voigt68d03e42010-07-07 15:39:13 +02001725
Jens Lehmann293ab152012-09-26 20:21:13 +02001726int submodule_uses_gitfile(const char *path)
1727{
René Scharfed3180272014-08-19 21:09:35 +02001728 struct child_process cp = CHILD_PROCESS_INIT;
Jens Lehmann293ab152012-09-26 20:21:13 +02001729 const char *argv[] = {
1730 "submodule",
1731 "foreach",
1732 "--quiet",
1733 "--recursive",
1734 "test -f .git",
1735 NULL,
1736 };
1737 struct strbuf buf = STRBUF_INIT;
1738 const char *git_dir;
1739
1740 strbuf_addf(&buf, "%s/.git", path);
1741 git_dir = read_gitfile(buf.buf);
1742 if (!git_dir) {
1743 strbuf_release(&buf);
1744 return 0;
1745 }
1746 strbuf_release(&buf);
1747
1748 /* Now test that all nested submodules use a gitfile too */
Jens Lehmann293ab152012-09-26 20:21:13 +02001749 cp.argv = argv;
Jeff Kingc12e8652016-04-28 09:39:15 -04001750 prepare_submodule_repo_env(&cp.env_array);
Jens Lehmann293ab152012-09-26 20:21:13 +02001751 cp.git_cmd = 1;
1752 cp.no_stdin = 1;
1753 cp.no_stderr = 1;
1754 cp.no_stdout = 1;
1755 cp.dir = path;
1756 if (run_command(&cp))
1757 return 0;
1758
1759 return 1;
1760}
1761
Stefan Beller83b76962016-12-20 15:20:11 -08001762/*
1763 * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
1764 * when doing so.
1765 *
1766 * Return 1 if we'd lose data, return 0 if the removal is fine,
1767 * and negative values for errors.
1768 */
1769int bad_to_remove_submodule(const char *path, unsigned flags)
Jens Lehmann293ab152012-09-26 20:21:13 +02001770{
Jens Lehmann293ab152012-09-26 20:21:13 +02001771 ssize_t len;
René Scharfed3180272014-08-19 21:09:35 +02001772 struct child_process cp = CHILD_PROCESS_INIT;
Jens Lehmann293ab152012-09-26 20:21:13 +02001773 struct strbuf buf = STRBUF_INIT;
Stefan Beller83b76962016-12-20 15:20:11 -08001774 int ret = 0;
Jens Lehmann293ab152012-09-26 20:21:13 +02001775
René Scharfedbe44fa2015-05-19 23:44:23 +02001776 if (!file_exists(path) || is_empty_dir(path))
Jens Lehmann293ab152012-09-26 20:21:13 +02001777 return 0;
1778
Stefan Beller83b76962016-12-20 15:20:11 -08001779 if (!submodule_uses_gitfile(path))
1780 return 1;
1781
1782 argv_array_pushl(&cp.args, "status", "--porcelain",
Stefan Beller5a1c8242016-12-20 15:20:10 -08001783 "--ignore-submodules=none", NULL);
Stefan Beller83b76962016-12-20 15:20:11 -08001784
1785 if (flags & SUBMODULE_REMOVAL_IGNORE_UNTRACKED)
1786 argv_array_push(&cp.args, "-uno");
1787 else
1788 argv_array_push(&cp.args, "-uall");
1789
1790 if (!(flags & SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED))
1791 argv_array_push(&cp.args, "--ignored");
1792
Jeff Kingc12e8652016-04-28 09:39:15 -04001793 prepare_submodule_repo_env(&cp.env_array);
Jens Lehmann293ab152012-09-26 20:21:13 +02001794 cp.git_cmd = 1;
1795 cp.no_stdin = 1;
1796 cp.out = -1;
1797 cp.dir = path;
Stefan Beller83b76962016-12-20 15:20:11 -08001798 if (start_command(&cp)) {
1799 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
Ralf Thielow35ad44c2017-04-13 18:40:45 +02001800 die(_("could not start 'git status' in submodule '%s'"),
Stefan Beller83b76962016-12-20 15:20:11 -08001801 path);
1802 ret = -1;
1803 goto out;
1804 }
Jens Lehmann293ab152012-09-26 20:21:13 +02001805
1806 len = strbuf_read(&buf, cp.out, 1024);
1807 if (len > 2)
Stefan Beller83b76962016-12-20 15:20:11 -08001808 ret = 1;
Jens Lehmann293ab152012-09-26 20:21:13 +02001809 close(cp.out);
1810
Stefan Beller83b76962016-12-20 15:20:11 -08001811 if (finish_command(&cp)) {
1812 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
Ralf Thielow35ad44c2017-04-13 18:40:45 +02001813 die(_("could not run 'git status' in submodule '%s'"),
Stefan Beller83b76962016-12-20 15:20:11 -08001814 path);
1815 ret = -1;
1816 }
1817out:
Jens Lehmann293ab152012-09-26 20:21:13 +02001818 strbuf_release(&buf);
Stefan Beller83b76962016-12-20 15:20:11 -08001819 return ret;
Jens Lehmann293ab152012-09-26 20:21:13 +02001820}
1821
Stefan Beller898c2e62018-12-14 15:59:43 -08001822void submodule_unset_core_worktree(const struct submodule *sub)
1823{
1824 char *config_path = xstrfmt("%s/modules/%s/config",
Philippe Blaina9472af2020-01-21 15:01:17 +00001825 get_git_dir(), sub->name);
Stefan Beller898c2e62018-12-14 15:59:43 -08001826
1827 if (git_config_set_in_file_gently(config_path, "core.worktree", NULL))
1828 warning(_("Could not unset core.worktree setting in submodule '%s'"),
1829 sub->path);
1830
1831 free(config_path);
1832}
1833
Stefan Beller202275b2017-03-14 14:46:36 -07001834static const char *get_super_prefix_or_empty(void)
1835{
1836 const char *s = get_super_prefix();
1837 if (!s)
1838 s = "";
1839 return s;
1840}
1841
Stefan Beller6e3c1592017-03-14 14:46:37 -07001842static int submodule_has_dirty_index(const struct submodule *sub)
1843{
1844 struct child_process cp = CHILD_PROCESS_INIT;
1845
Stefan Bellerda27bc82017-05-02 12:32:13 -07001846 prepare_submodule_repo_env(&cp.env_array);
Stefan Beller6e3c1592017-03-14 14:46:37 -07001847
1848 cp.git_cmd = 1;
1849 argv_array_pushl(&cp.args, "diff-index", "--quiet",
1850 "--cached", "HEAD", NULL);
1851 cp.no_stdin = 1;
1852 cp.no_stdout = 1;
1853 cp.dir = sub->path;
1854 if (start_command(&cp))
Ralf Thielowa4ffbbb2020-01-15 19:07:01 +01001855 die(_("could not recurse into submodule '%s'"), sub->path);
Stefan Beller6e3c1592017-03-14 14:46:37 -07001856
1857 return finish_command(&cp);
1858}
1859
1860static void submodule_reset_index(const char *path)
1861{
1862 struct child_process cp = CHILD_PROCESS_INIT;
Stefan Bellerda27bc82017-05-02 12:32:13 -07001863 prepare_submodule_repo_env(&cp.env_array);
Stefan Beller6e3c1592017-03-14 14:46:37 -07001864
1865 cp.git_cmd = 1;
1866 cp.no_stdin = 1;
1867 cp.dir = path;
1868
1869 argv_array_pushf(&cp.args, "--super-prefix=%s%s/",
1870 get_super_prefix_or_empty(), path);
1871 argv_array_pushl(&cp.args, "read-tree", "-u", "--reset", NULL);
1872
brian m. carlson939b89a2018-05-02 00:25:59 +00001873 argv_array_push(&cp.args, empty_tree_oid_hex());
Stefan Beller6e3c1592017-03-14 14:46:37 -07001874
1875 if (run_command(&cp))
Ralf Thielowa4ffbbb2020-01-15 19:07:01 +01001876 die(_("could not reset submodule index"));
Stefan Beller6e3c1592017-03-14 14:46:37 -07001877}
1878
1879/**
1880 * Moves a submodule at a given path from a given head to another new head.
1881 * For edge cases (a submodule coming into existence or removing a submodule)
1882 * pass NULL for old or new respectively.
1883 */
1884int submodule_move_head(const char *path,
Brandon Williamsbc099912018-02-14 10:59:49 -08001885 const char *old_head,
1886 const char *new_head,
Stefan Beller6e3c1592017-03-14 14:46:37 -07001887 unsigned flags)
1888{
1889 int ret = 0;
1890 struct child_process cp = CHILD_PROCESS_INIT;
1891 const struct submodule *sub;
Stefan Bellerf2d48992017-04-18 14:37:24 -07001892 int *error_code_ptr, error_code;
Stefan Beller6e3c1592017-03-14 14:46:37 -07001893
Brandon Williams627d9342017-06-22 11:43:46 -07001894 if (!is_submodule_active(the_repository, path))
Stefan Beller823bab02017-04-18 14:37:23 -07001895 return 0;
1896
Stefan Bellerf2d48992017-04-18 14:37:24 -07001897 if (flags & SUBMODULE_MOVE_HEAD_FORCE)
1898 /*
1899 * Pass non NULL pointer to is_submodule_populated_gently
1900 * to prevent die()-ing. We'll use connect_work_tree_and_git_dir
1901 * to fixup the submodule in the force case later.
1902 */
1903 error_code_ptr = &error_code;
1904 else
1905 error_code_ptr = NULL;
1906
Brandon Williamsbc099912018-02-14 10:59:49 -08001907 if (old_head && !is_submodule_populated_gently(path, error_code_ptr))
Stefan Bellerf2d48992017-04-18 14:37:24 -07001908 return 0;
Stefan Beller6e3c1592017-03-14 14:46:37 -07001909
Stefan Beller3b8fb392018-03-28 15:35:29 -07001910 sub = submodule_from_path(the_repository, &null_oid, path);
Stefan Beller6e3c1592017-03-14 14:46:37 -07001911
1912 if (!sub)
Johannes Schindelin033abf92018-05-02 11:38:39 +02001913 BUG("could not get submodule information for '%s'", path);
Stefan Beller6e3c1592017-03-14 14:46:37 -07001914
Brandon Williamsbc099912018-02-14 10:59:49 -08001915 if (old_head && !(flags & SUBMODULE_MOVE_HEAD_FORCE)) {
Stefan Beller6e3c1592017-03-14 14:46:37 -07001916 /* Check if the submodule has a dirty index. */
1917 if (submodule_has_dirty_index(sub))
1918 return error(_("submodule '%s' has dirty index"), path);
1919 }
1920
1921 if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
Brandon Williamsbc099912018-02-14 10:59:49 -08001922 if (old_head) {
Stefan Beller6e3c1592017-03-14 14:46:37 -07001923 if (!submodule_uses_gitfile(path))
Jeff Kingcf7a9012019-05-09 17:27:31 -04001924 absorb_git_dir_into_superproject(path,
Stefan Beller6e3c1592017-03-14 14:46:37 -07001925 ABSORB_GITDIR_RECURSE_SUBMODULES);
1926 } else {
Stefan Bellerf2d48992017-04-18 14:37:24 -07001927 char *gitdir = xstrfmt("%s/modules/%s",
Philippe Blaina9472af2020-01-21 15:01:17 +00001928 get_git_dir(), sub->name);
Stefan Bellerda62f782018-03-28 15:35:31 -07001929 connect_work_tree_and_git_dir(path, gitdir, 0);
Stefan Bellerf2d48992017-04-18 14:37:24 -07001930 free(gitdir);
Stefan Beller6e3c1592017-03-14 14:46:37 -07001931
1932 /* make sure the index is clean as well */
1933 submodule_reset_index(path);
1934 }
Stefan Bellerf2d48992017-04-18 14:37:24 -07001935
Brandon Williamsbc099912018-02-14 10:59:49 -08001936 if (old_head && (flags & SUBMODULE_MOVE_HEAD_FORCE)) {
Stefan Bellerf2d48992017-04-18 14:37:24 -07001937 char *gitdir = xstrfmt("%s/modules/%s",
Philippe Blaina9472af2020-01-21 15:01:17 +00001938 get_git_dir(), sub->name);
Stefan Bellerda62f782018-03-28 15:35:31 -07001939 connect_work_tree_and_git_dir(path, gitdir, 1);
Stefan Bellerf2d48992017-04-18 14:37:24 -07001940 free(gitdir);
1941 }
Stefan Beller6e3c1592017-03-14 14:46:37 -07001942 }
1943
Stefan Bellerda27bc82017-05-02 12:32:13 -07001944 prepare_submodule_repo_env(&cp.env_array);
Stefan Beller6e3c1592017-03-14 14:46:37 -07001945
1946 cp.git_cmd = 1;
1947 cp.no_stdin = 1;
1948 cp.dir = path;
1949
1950 argv_array_pushf(&cp.args, "--super-prefix=%s%s/",
1951 get_super_prefix_or_empty(), path);
Stefan Beller218c8832017-05-02 12:32:14 -07001952 argv_array_pushl(&cp.args, "read-tree", "--recurse-submodules", NULL);
Stefan Beller6e3c1592017-03-14 14:46:37 -07001953
1954 if (flags & SUBMODULE_MOVE_HEAD_DRY_RUN)
1955 argv_array_push(&cp.args, "-n");
1956 else
1957 argv_array_push(&cp.args, "-u");
1958
1959 if (flags & SUBMODULE_MOVE_HEAD_FORCE)
1960 argv_array_push(&cp.args, "--reset");
1961 else
1962 argv_array_push(&cp.args, "-m");
1963
Stefan Beller7dcc1f42018-01-05 12:03:04 -08001964 if (!(flags & SUBMODULE_MOVE_HEAD_FORCE))
brian m. carlson939b89a2018-05-02 00:25:59 +00001965 argv_array_push(&cp.args, old_head ? old_head : empty_tree_oid_hex());
Stefan Beller7dcc1f42018-01-05 12:03:04 -08001966
brian m. carlson939b89a2018-05-02 00:25:59 +00001967 argv_array_push(&cp.args, new_head ? new_head : empty_tree_oid_hex());
Stefan Beller6e3c1592017-03-14 14:46:37 -07001968
1969 if (run_command(&cp)) {
Stefan Bellerba95d4e2018-06-20 15:32:53 -07001970 ret = error(_("Submodule '%s' could not be updated."), path);
Stefan Beller6e3c1592017-03-14 14:46:37 -07001971 goto out;
1972 }
1973
1974 if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
Brandon Williamsbc099912018-02-14 10:59:49 -08001975 if (new_head) {
Stefan Bellera17062c2017-05-02 12:32:12 -07001976 child_process_init(&cp);
Stefan Beller6e3c1592017-03-14 14:46:37 -07001977 /* also set the HEAD accordingly */
Stefan Bellera17062c2017-05-02 12:32:12 -07001978 cp.git_cmd = 1;
1979 cp.no_stdin = 1;
1980 cp.dir = path;
Stefan Beller6e3c1592017-03-14 14:46:37 -07001981
Stefan Beller218c8832017-05-02 12:32:14 -07001982 prepare_submodule_repo_env(&cp.env_array);
Stefan Beller3ef25382017-07-24 10:36:01 -07001983 argv_array_pushl(&cp.args, "update-ref", "HEAD",
Brandon Williamsbc099912018-02-14 10:59:49 -08001984 "--no-deref", new_head, NULL);
Stefan Beller6e3c1592017-03-14 14:46:37 -07001985
Stefan Bellera17062c2017-05-02 12:32:12 -07001986 if (run_command(&cp)) {
Stefan Beller6e3c1592017-03-14 14:46:37 -07001987 ret = -1;
1988 goto out;
1989 }
1990 } else {
1991 struct strbuf sb = STRBUF_INIT;
1992
1993 strbuf_addf(&sb, "%s/.git", path);
1994 unlink_or_warn(sb.buf);
1995 strbuf_release(&sb);
1996
1997 if (is_empty_dir(path))
1998 rmdir_or_warn(path);
Stefan Beller898c2e62018-12-14 15:59:43 -08001999
2000 submodule_unset_core_worktree(sub);
Stefan Beller6e3c1592017-03-14 14:46:37 -07002001 }
2002 }
2003out:
2004 return ret;
2005}
2006
Johannes Schindelina8dee3c2019-10-01 23:27:18 +02002007int validate_submodule_git_dir(char *git_dir, const char *submodule_name)
2008{
2009 size_t len = strlen(git_dir), suffix_len = strlen(submodule_name);
2010 char *p;
2011 int ret = 0;
2012
2013 if (len <= suffix_len || (p = git_dir + len - suffix_len)[-1] != '/' ||
2014 strcmp(p, submodule_name))
2015 BUG("submodule name '%s' not a suffix of git dir '%s'",
2016 submodule_name, git_dir);
2017
2018 /*
2019 * We prevent the contents of sibling submodules' git directories to
2020 * clash.
2021 *
2022 * Example: having a submodule named `hippo` and another one named
2023 * `hippo/hooks` would result in the git directories
2024 * `.git/modules/hippo/` and `.git/modules/hippo/hooks/`, respectively,
2025 * but the latter directory is already designated to contain the hooks
2026 * of the former.
2027 */
2028 for (; *p; p++) {
2029 if (is_dir_sep(*p)) {
2030 char c = *p;
2031
2032 *p = '\0';
2033 if (is_git_directory(git_dir))
2034 ret = -1;
2035 *p = c;
2036
2037 if (ret < 0)
2038 return error(_("submodule git dir '%s' is "
2039 "inside git dir '%.*s'"),
2040 git_dir,
2041 (int)(p - git_dir), git_dir);
2042 }
2043 }
2044
2045 return 0;
2046}
2047
Stefan Bellerf6f85862016-12-12 11:04:35 -08002048/*
2049 * Embeds a single submodules git directory into the superprojects git dir,
2050 * non recursively.
2051 */
Jeff Kingcf7a9012019-05-09 17:27:31 -04002052static void relocate_single_git_dir_into_superproject(const char *path)
Stefan Bellerf6f85862016-12-12 11:04:35 -08002053{
2054 char *old_git_dir = NULL, *real_old_git_dir = NULL, *real_new_git_dir = NULL;
Johannes Schindelina8dee3c2019-10-01 23:27:18 +02002055 char *new_git_dir;
Stefan Bellerf6f85862016-12-12 11:04:35 -08002056 const struct submodule *sub;
2057
2058 if (submodule_uses_worktrees(path))
2059 die(_("relocate_gitdir for submodule '%s' with "
2060 "more than one worktree not supported"), path);
2061
2062 old_git_dir = xstrfmt("%s/.git", path);
2063 if (read_gitfile(old_git_dir))
2064 /* If it is an actual gitfile, it doesn't need migration. */
2065 return;
2066
Johannes Schindelince83ead2017-03-08 16:43:40 +01002067 real_old_git_dir = real_pathdup(old_git_dir, 1);
Stefan Bellerf6f85862016-12-12 11:04:35 -08002068
Stefan Beller3b8fb392018-03-28 15:35:29 -07002069 sub = submodule_from_path(the_repository, &null_oid, path);
Stefan Bellerf6f85862016-12-12 11:04:35 -08002070 if (!sub)
2071 die(_("could not lookup name for submodule '%s'"), path);
2072
Johannes Schindelina8dee3c2019-10-01 23:27:18 +02002073 new_git_dir = git_pathdup("modules/%s", sub->name);
2074 if (validate_submodule_git_dir(new_git_dir, sub->name) < 0)
2075 die(_("refusing to move '%s' into an existing git dir"),
2076 real_old_git_dir);
Stefan Bellerf6f85862016-12-12 11:04:35 -08002077 if (safe_create_leading_directories_const(new_git_dir) < 0)
2078 die(_("could not create directory '%s'"), new_git_dir);
Johannes Schindelince83ead2017-03-08 16:43:40 +01002079 real_new_git_dir = real_pathdup(new_git_dir, 1);
Johannes Schindelina8dee3c2019-10-01 23:27:18 +02002080 free(new_git_dir);
Stefan Bellerf6f85862016-12-12 11:04:35 -08002081
Stefan Bellerf6f85862016-12-12 11:04:35 -08002082 fprintf(stderr, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
Stefan Beller202275b2017-03-14 14:46:36 -07002083 get_super_prefix_or_empty(), path,
Stefan Bellerf6f85862016-12-12 11:04:35 -08002084 real_old_git_dir, real_new_git_dir);
2085
2086 relocate_gitdir(path, real_old_git_dir, real_new_git_dir);
2087
2088 free(old_git_dir);
2089 free(real_old_git_dir);
2090 free(real_new_git_dir);
2091}
2092
2093/*
2094 * Migrate the git directory of the submodule given by path from
2095 * having its git directory within the working tree to the git dir nested
2096 * in its superprojects git dir under modules/.
2097 */
Jeff Kingcf7a9012019-05-09 17:27:31 -04002098void absorb_git_dir_into_superproject(const char *path,
Stefan Bellerf6f85862016-12-12 11:04:35 -08002099 unsigned flags)
2100{
Stefan Bellerec9629b2017-01-25 15:04:50 -08002101 int err_code;
2102 const char *sub_git_dir;
Stefan Bellerf6f85862016-12-12 11:04:35 -08002103 struct strbuf gitdir = STRBUF_INIT;
Stefan Bellerf6f85862016-12-12 11:04:35 -08002104 strbuf_addf(&gitdir, "%s/.git", path);
Stefan Bellerec9629b2017-01-25 15:04:50 -08002105 sub_git_dir = resolve_gitdir_gently(gitdir.buf, &err_code);
Stefan Bellerf6f85862016-12-12 11:04:35 -08002106
2107 /* Not populated? */
Stefan Bellerec9629b2017-01-25 15:04:50 -08002108 if (!sub_git_dir) {
Stefan Bellerec9629b2017-01-25 15:04:50 -08002109 const struct submodule *sub;
Stefan Bellerf6f85862016-12-12 11:04:35 -08002110
Stefan Bellerec9629b2017-01-25 15:04:50 -08002111 if (err_code == READ_GITFILE_ERR_STAT_FAILED) {
2112 /* unpopulated as expected */
2113 strbuf_release(&gitdir);
2114 return;
2115 }
2116
2117 if (err_code != READ_GITFILE_ERR_NOT_A_REPO)
2118 /* We don't know what broke here. */
2119 read_gitfile_error_die(err_code, path, NULL);
2120
2121 /*
2122 * Maybe populated, but no git directory was found?
2123 * This can happen if the superproject is a submodule
2124 * itself and was just absorbed. The absorption of the
2125 * superproject did not rewrite the git file links yet,
2126 * fix it now.
2127 */
Stefan Beller3b8fb392018-03-28 15:35:29 -07002128 sub = submodule_from_path(the_repository, &null_oid, path);
Stefan Bellerec9629b2017-01-25 15:04:50 -08002129 if (!sub)
2130 die(_("could not lookup name for submodule '%s'"), path);
Stefan Beller365444a2017-03-14 14:46:24 -07002131 connect_work_tree_and_git_dir(path,
Stefan Bellerda62f782018-03-28 15:35:31 -07002132 git_path("modules/%s", sub->name), 0);
Stefan Bellerec9629b2017-01-25 15:04:50 -08002133 } else {
2134 /* Is it already absorbed into the superprojects git dir? */
Johannes Schindelince83ead2017-03-08 16:43:40 +01002135 char *real_sub_git_dir = real_pathdup(sub_git_dir, 1);
2136 char *real_common_git_dir = real_pathdup(get_git_common_dir(), 1);
Stefan Bellerec9629b2017-01-25 15:04:50 -08002137
2138 if (!starts_with(real_sub_git_dir, real_common_git_dir))
Jeff Kingcf7a9012019-05-09 17:27:31 -04002139 relocate_single_git_dir_into_superproject(path);
Stefan Bellerec9629b2017-01-25 15:04:50 -08002140
2141 free(real_sub_git_dir);
2142 free(real_common_git_dir);
2143 }
2144 strbuf_release(&gitdir);
Stefan Bellerf6f85862016-12-12 11:04:35 -08002145
2146 if (flags & ABSORB_GITDIR_RECURSE_SUBMODULES) {
2147 struct child_process cp = CHILD_PROCESS_INIT;
2148 struct strbuf sb = STRBUF_INIT;
2149
2150 if (flags & ~ABSORB_GITDIR_RECURSE_SUBMODULES)
Johannes Schindelin033abf92018-05-02 11:38:39 +02002151 BUG("we don't know how to pass the flags down?");
Stefan Bellerf6f85862016-12-12 11:04:35 -08002152
Stefan Beller202275b2017-03-14 14:46:36 -07002153 strbuf_addstr(&sb, get_super_prefix_or_empty());
Stefan Bellerf6f85862016-12-12 11:04:35 -08002154 strbuf_addstr(&sb, path);
2155 strbuf_addch(&sb, '/');
2156
2157 cp.dir = path;
2158 cp.git_cmd = 1;
2159 cp.no_stdin = 1;
2160 argv_array_pushl(&cp.args, "--super-prefix", sb.buf,
2161 "submodule--helper",
2162 "absorb-git-dirs", NULL);
2163 prepare_submodule_repo_env(&cp.env_array);
2164 if (run_command(&cp))
2165 die(_("could not recurse into submodule '%s'"), path);
2166
2167 strbuf_release(&sb);
2168 }
Stefan Bellerf6f85862016-12-12 11:04:35 -08002169}
Stefan Bellerbf0231c2017-03-08 15:07:42 -08002170
Alexandr Miloslavskiy49d3c4b2020-03-10 13:11:24 +00002171int get_superproject_working_tree(struct strbuf *buf)
Stefan Bellerbf0231c2017-03-08 15:07:42 -08002172{
2173 struct child_process cp = CHILD_PROCESS_INIT;
2174 struct strbuf sb = STRBUF_INIT;
Alexandr Miloslavskiy4530a852020-03-10 13:11:23 +00002175 struct strbuf one_up = STRBUF_INIT;
Stefan Bellerbf0231c2017-03-08 15:07:42 -08002176 const char *cwd = xgetcwd();
Alexandr Miloslavskiy49d3c4b2020-03-10 13:11:24 +00002177 int ret = 0;
Stefan Bellerbf0231c2017-03-08 15:07:42 -08002178 const char *subpath;
2179 int code;
2180 ssize_t len;
2181
2182 if (!is_inside_work_tree())
2183 /*
2184 * FIXME:
2185 * We might have a superproject, but it is harder
2186 * to determine.
2187 */
Alexandr Miloslavskiy49d3c4b2020-03-10 13:11:24 +00002188 return 0;
Stefan Bellerbf0231c2017-03-08 15:07:42 -08002189
Alexandr Miloslavskiy4530a852020-03-10 13:11:23 +00002190 if (!strbuf_realpath(&one_up, "../", 0))
Alexandr Miloslavskiy49d3c4b2020-03-10 13:11:24 +00002191 return 0;
Stefan Bellerbf0231c2017-03-08 15:07:42 -08002192
Alexandr Miloslavskiy4530a852020-03-10 13:11:23 +00002193 subpath = relative_path(cwd, one_up.buf, &sb);
2194 strbuf_release(&one_up);
Stefan Bellerbf0231c2017-03-08 15:07:42 -08002195
2196 prepare_submodule_repo_env(&cp.env_array);
2197 argv_array_pop(&cp.env_array);
2198
2199 argv_array_pushl(&cp.args, "--literal-pathspecs", "-C", "..",
2200 "ls-files", "-z", "--stage", "--full-name", "--",
2201 subpath, NULL);
2202 strbuf_reset(&sb);
2203
2204 cp.no_stdin = 1;
2205 cp.no_stderr = 1;
2206 cp.out = -1;
2207 cp.git_cmd = 1;
2208
2209 if (start_command(&cp))
2210 die(_("could not start ls-files in .."));
2211
2212 len = strbuf_read(&sb, cp.out, PATH_MAX);
2213 close(cp.out);
2214
2215 if (starts_with(sb.buf, "160000")) {
2216 int super_sub_len;
2217 int cwd_len = strlen(cwd);
2218 char *super_sub, *super_wt;
2219
2220 /*
2221 * There is a superproject having this repo as a submodule.
2222 * The format is <mode> SP <hash> SP <stage> TAB <full name> \0,
2223 * We're only interested in the name after the tab.
2224 */
2225 super_sub = strchr(sb.buf, '\t') + 1;
Sam McKelviec5cbb272018-09-27 11:10:54 -07002226 super_sub_len = strlen(super_sub);
Stefan Bellerbf0231c2017-03-08 15:07:42 -08002227
2228 if (super_sub_len > cwd_len ||
2229 strcmp(&cwd[cwd_len - super_sub_len], super_sub))
Johannes Schindelinc3c34862018-05-02 11:38:41 +02002230 BUG("returned path string doesn't match cwd?");
Stefan Bellerbf0231c2017-03-08 15:07:42 -08002231
2232 super_wt = xstrdup(cwd);
2233 super_wt[cwd_len - super_sub_len] = '\0';
2234
Alexandr Miloslavskiy49d3c4b2020-03-10 13:11:24 +00002235 strbuf_realpath(buf, super_wt, 1);
2236 ret = 1;
Stefan Bellerbf0231c2017-03-08 15:07:42 -08002237 free(super_wt);
2238 }
2239 strbuf_release(&sb);
2240
2241 code = finish_command(&cp);
2242
2243 if (code == 128)
2244 /* '../' is not a git repository */
Alexandr Miloslavskiy49d3c4b2020-03-10 13:11:24 +00002245 return 0;
Stefan Bellerbf0231c2017-03-08 15:07:42 -08002246 if (code == 0 && len == 0)
2247 /* There is an unrelated git repository at '../' */
Alexandr Miloslavskiy49d3c4b2020-03-10 13:11:24 +00002248 return 0;
Stefan Bellerbf0231c2017-03-08 15:07:42 -08002249 if (code)
2250 die(_("ls-tree returned unexpected return code %d"), code);
2251
2252 return ret;
2253}
Nguyễn Thái Ngọc Duybbbb7de2017-03-26 09:42:30 +07002254
Han-Wen Nienhuys3ce08542017-09-25 17:59:26 +02002255/*
2256 * Put the gitdir for a submodule (given relative to the main
2257 * repository worktree) into `buf`, or return -1 on error.
2258 */
Nguyễn Thái Ngọc Duybbbb7de2017-03-26 09:42:30 +07002259int submodule_to_gitdir(struct strbuf *buf, const char *submodule)
2260{
2261 const struct submodule *sub;
2262 const char *git_dir;
2263 int ret = 0;
2264
2265 strbuf_reset(buf);
2266 strbuf_addstr(buf, submodule);
2267 strbuf_complete(buf, '/');
2268 strbuf_addstr(buf, ".git");
2269
2270 git_dir = read_gitfile(buf->buf);
2271 if (git_dir) {
2272 strbuf_reset(buf);
2273 strbuf_addstr(buf, git_dir);
2274 }
2275 if (!is_git_directory(buf->buf)) {
Stefan Beller3b8fb392018-03-28 15:35:29 -07002276 sub = submodule_from_path(the_repository, &null_oid, submodule);
Nguyễn Thái Ngọc Duybbbb7de2017-03-26 09:42:30 +07002277 if (!sub) {
2278 ret = -1;
2279 goto cleanup;
2280 }
2281 strbuf_reset(buf);
2282 strbuf_git_path(buf, "%s/%s", "modules", sub->name);
2283 }
2284
2285cleanup:
2286 return ret;
2287}