submodule.c 56.2 KB
Newer Older
1
/*
Edward Thomson committed
2
 * Copyright (C) the libgit2 contributors. All rights reserved.
3 4 5 6 7
 *
 * This file is part of libgit2, distributed under the GNU GPL v2 with
 * a Linking Exception. For full terms see the included COPYING file.
 */

8 9
#include "submodule.h"

10
#include "git2/config.h"
11
#include "git2/sys/config.h"
12 13 14
#include "git2/types.h"
#include "git2/index.h"
#include "buffer.h"
15
#include "buf_text.h"
16 17 18 19 20
#include "vector.h"
#include "posix.h"
#include "config_file.h"
#include "config.h"
#include "repository.h"
Russell Belfer committed
21 22
#include "tree.h"
#include "iterator.h"
23 24
#include "path.h"
#include "index.h"
25
#include "worktree.h"
Russell Belfer committed
26 27

#define GIT_MODULES_FILE ".gitmodules"
28

29 30 31
static git_cvar_map _sm_update_map[] = {
	{GIT_CVAR_STRING, "checkout", GIT_SUBMODULE_UPDATE_CHECKOUT},
	{GIT_CVAR_STRING, "rebase", GIT_SUBMODULE_UPDATE_REBASE},
Russell Belfer committed
32 33
	{GIT_CVAR_STRING, "merge", GIT_SUBMODULE_UPDATE_MERGE},
	{GIT_CVAR_STRING, "none", GIT_SUBMODULE_UPDATE_NONE},
34 35
	{GIT_CVAR_FALSE, NULL, GIT_SUBMODULE_UPDATE_NONE},
	{GIT_CVAR_TRUE, NULL, GIT_SUBMODULE_UPDATE_CHECKOUT},
36 37
};

38
static git_cvar_map _sm_ignore_map[] = {
Russell Belfer committed
39
	{GIT_CVAR_STRING, "none", GIT_SUBMODULE_IGNORE_NONE},
40
	{GIT_CVAR_STRING, "untracked", GIT_SUBMODULE_IGNORE_UNTRACKED},
Russell Belfer committed
41 42
	{GIT_CVAR_STRING, "dirty", GIT_SUBMODULE_IGNORE_DIRTY},
	{GIT_CVAR_STRING, "all", GIT_SUBMODULE_IGNORE_ALL},
43 44
	{GIT_CVAR_FALSE, NULL, GIT_SUBMODULE_IGNORE_NONE},
	{GIT_CVAR_TRUE, NULL, GIT_SUBMODULE_IGNORE_ALL},
45 46
};

47 48 49 50 51 52
static git_cvar_map _sm_recurse_map[] = {
	{GIT_CVAR_STRING, "on-demand", GIT_SUBMODULE_RECURSE_ONDEMAND},
	{GIT_CVAR_FALSE, NULL, GIT_SUBMODULE_RECURSE_NO},
	{GIT_CVAR_TRUE, NULL, GIT_SUBMODULE_RECURSE_YES},
};

53 54 55 56 57 58 59 60 61 62
enum {
	CACHE_OK = 0,
	CACHE_REFRESH = 1,
	CACHE_FLUSH = 2
};
enum {
	GITMODULES_EXISTING = 0,
	GITMODULES_CREATE = 1,
};

63
static kh_inline khint_t str_hash_no_trailing_slash(const char *s)
64
{
65
	khint_t h;
66

67
	for (h = 0; *s; ++s)
68
		if (s[1] != '\0' || *s != '/')
69
			h = (h << 5) - h + *s;
70

71
	return h;
72 73
}

74
static kh_inline int str_equal_no_trailing_slash(const char *a, const char *b)
75
{
76 77
	size_t alen = a ? strlen(a) : 0;
	size_t blen = b ? strlen(b) : 0;
78

79
	if (alen > 0 && a[alen - 1] == '/')
80
		alen--;
81
	if (blen > 0 && b[blen - 1] == '/')
82 83
		blen--;

84 85
	return (alen == 0 && blen == 0) ||
		(alen == blen && strncmp(a, b, alen) == 0);
86 87
}

Russell Belfer committed
88 89
__KHASH_IMPL(
	str, static kh_inline, const char *, void *, 1,
90
	str_hash_no_trailing_slash, str_equal_no_trailing_slash)
Russell Belfer committed
91

92 93
static int submodule_alloc(git_submodule **out, git_repository *repo, const char *name);
static git_config_backend *open_gitmodules(git_repository *repo, int gitmod);
94
static int gitmodules_snapshot(git_config **snap, git_repository *repo);
95 96
static int get_url_base(git_buf *url, git_repository *repo);
static int lookup_head_remote_key(git_buf *remote_key, git_repository *repo);
97
static int lookup_default_remote(git_remote **remote, git_repository *repo);
98 99
static int submodule_load_each(const git_config_entry *entry, void *payload);
static int submodule_read_config(git_submodule *sm, git_config *cfg);
100
static int submodule_load_from_wd_lite(git_submodule *);
101 102
static void submodule_get_index_status(unsigned int *, git_submodule *);
static void submodule_get_wd_status(unsigned int *, git_submodule *, git_repository *, git_submodule_ignore_t);
103 104
static void submodule_update_from_index_entry(git_submodule *sm, const git_index_entry *ie);
static void submodule_update_from_head_data(git_submodule *sm, mode_t mode, const git_oid *id);
Russell Belfer committed
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121

static int submodule_cmp(const void *a, const void *b)
{
	return strcmp(((git_submodule *)a)->name, ((git_submodule *)b)->name);
}

static int submodule_config_key_trunc_puts(git_buf *key, const char *suffix)
{
	ssize_t idx = git_buf_rfind(key, '.');
	git_buf_truncate(key, (size_t)(idx + 1));
	return git_buf_puts(key, suffix);
}

/*
 * PUBLIC APIS
 */

122 123 124 125 126 127
static void submodule_set_lookup_error(int error, const char *name)
{
	if (!error)
		return;

	giterr_set(GITERR_SUBMODULE, (error == GIT_ENOTFOUND) ?
128 129
		"no submodule named '%s'" :
		"submodule '%s' has not been added yet", name);
130 131
}

132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
typedef struct {
	const char *path;
	char *name;
} fbp_data;

static int find_by_path(const git_config_entry *entry, void *payload)
{
	fbp_data *data = payload;

	if (!strcmp(entry->value, data->path)) {
		const char *fdot, *ldot;
		fdot = strchr(entry->name, '.');
		ldot = strrchr(entry->name, '.');
		data->name = git__strndup(fdot + 1, ldot - fdot - 1);
		GITERR_CHECK_ALLOC(data->name);
	}

	return 0;
}

152 153 154 155
/*
 * Checks to see if the submodule shares its name with a file or directory that
 * already exists on the index. If so, the submodule cannot be added.
 */
156
static int is_path_occupied(bool *occupied, git_repository *repo, const char *path)
157 158
{
	int error = 0;
159 160
	git_index *index;
	git_buf dir = GIT_BUF_INIT;
161
	*occupied = false;
162 163

	if ((error = git_repository_index__weakptr(&index, repo)) < 0)
164
		goto out;
165

166 167 168 169 170 171
	if ((error = git_index_find(NULL, index, path)) != GIT_ENOTFOUND) {
		if (!error) {
			giterr_set(GITERR_SUBMODULE,
				"File '%s' already exists in the index", path);
			*occupied = true;
		}
172
		goto out;
173 174
	}

175 176 177 178 179
	if ((error = git_buf_sets(&dir, path)) < 0)
		goto out;

	if ((error = git_path_to_dir(&dir)) < 0)
		goto out;
180

181 182 183 184 185 186 187
	if ((error = git_index_find_prefix(NULL, index, dir.ptr)) != GIT_ENOTFOUND) {
		if (!error) {
			giterr_set(GITERR_SUBMODULE,
				"Directory '%s' already exists in the index", path);
			*occupied = true;
		}
		goto out;
188
	}
189

190
	error = 0;
191

192 193 194
out:
	git_buf_free(&dir);
	return error;
195 196
}

197
/**
198
 * Release the name map returned by 'load_submodule_names'.
199
 */
200 201
static void free_submodule_names(git_strmap *names)
{
202 203
	git_buf *name;

204 205
	if (names == NULL)
		return;
206

207 208 209 210
	git_strmap_foreach_value(names, name, {
		git__free(name);
	});
	git_strmap_free(names);
211

212 213 214 215 216 217 218 219
	return;
}

/**
 * Map submodule paths to names.
 * TODO: for some use-cases, this might need case-folding on a
 * case-insensitive filesystem
 */
220
static int load_submodule_names(git_strmap **out, git_repository *repo, git_config *cfg)
221 222
{
	const char *key = "submodule\\..*\\.path";
223
	git_config_iterator *iter = NULL;
224
	git_config_entry *entry;
225
	git_buf buf = GIT_BUF_INIT;
226
	git_strmap *names;
227
	int rval, isvalid;
228
	int error = 0;
229

230 231 232 233 234
	*out = NULL;

	if ((error = git_strmap_alloc(&names)) < 0)
		goto out;

235
	if ((error = git_config_iterator_glob_new(&iter, cfg, key)) < 0)
236
		goto out;
237

238
	while (git_config_next(&entry, iter) == 0) {
239 240 241 242
		const char *fdot, *ldot;
		fdot = strchr(entry->name, '.');
		ldot = strrchr(entry->name, '.');

243
		if (git_strmap_exists(names, entry->value)) {
244 245 246 247 248 249
			giterr_set(GITERR_SUBMODULE,
				   "duplicated submodule path '%s'", entry->value);
			error = -1;
			goto out;
		}

250
		git_buf_clear(&buf);
251
		git_buf_put(&buf, fdot + 1, ldot - fdot - 1);
252
		isvalid = git_submodule_name_is_valid(repo, buf.ptr, 0);
253 254 255 256
		if (isvalid < 0) {
			error = isvalid;
			goto out;
		}
257
		if (!isvalid)
258 259
			continue;

260
		git_strmap_insert(names, entry->value, git_buf_detach(&buf), &rval);
261
		if (rval < 0) {
262
			giterr_set(GITERR_NOMEMORY, "error inserting submodule into hash table");
263 264
			return -1;
		}
265
	}
266 267
	if (error == GIT_ITEROVER)
		error = 0;
268

269 270 271
	*out = names;
	names = NULL;

272
out:
273
	free_submodule_names(names);
274
	git_buf_free(&buf);
275
	git_config_iterator_free(iter);
276
	return error;
277 278
}

279
int git_submodule_lookup(
280 281 282 283 284
	git_submodule **out, /* NULL if user only wants to test existence */
	git_repository *repo,
	const char *name)    /* trailing slash is allowed */
{
	int error;
285
	unsigned int location;
286
	git_submodule *sm;
287 288 289

	assert(repo && name);

290 291 292 293 294
	if (repo->is_bare) {
		giterr_set(GITERR_SUBMODULE, "cannot get submodules without a working tree");
		return -1;
	}

295 296 297 298 299 300 301 302 303 304 305
	if (repo->submodule_cache != NULL) {
		khiter_t pos = git_strmap_lookup_index(repo->submodule_cache, name);
		if (git_strmap_valid_index(repo->submodule_cache, pos)) {
			if (out) {
				*out = git_strmap_value_at(repo->submodule_cache, pos);
				GIT_REFCOUNT_INC(*out);
			}
			return 0;
		}
	}

306 307
	if ((error = submodule_alloc(&sm, repo, name)) < 0)
		return error;
Russell Belfer committed
308

309 310
	if ((error = git_submodule_reload(sm, false)) < 0) {
		git_submodule_free(sm);
Russell Belfer committed
311
		return error;
312
	}
Russell Belfer committed
313

314 315 316 317 318
	if ((error = git_submodule_location(&location, sm)) < 0) {
		git_submodule_free(sm);
		return error;
	}

319
	/* If it's not configured or we're looking by path  */
320 321
	if (location == 0 || location == GIT_SUBMODULE_STATUS_IN_WD) {
		git_config_backend *mods;
322
		const char *pattern = "submodule\\..*\\.path";
323 324 325 326 327 328 329 330
		git_buf path = GIT_BUF_INIT;
		fbp_data data = { NULL, NULL };

		git_buf_puts(&path, name);
		while (path.ptr[path.size-1] == '/') {
			path.ptr[--path.size] = '\0';
		}
		data.path = path.ptr;
331

332 333 334 335 336 337 338 339 340
		mods = open_gitmodules(repo, GITMODULES_EXISTING);

		if (mods)
			error = git_config_file_foreach_match(mods, pattern, find_by_path, &data);

		git_config_file_free(mods);

		if (error < 0) {
			git_submodule_free(sm);
Carlos Martín Nieto committed
341
			git_buf_free(&path);
342
			return error;
343
		}
344 345 346 347

		if (data.name) {
			git__free(sm->name);
			sm->name = data.name;
348
			sm->path = git_buf_detach(&path);
349 350 351 352 353 354 355

			/* Try to load again with the right name */
			if ((error = git_submodule_reload(sm, false)) < 0) {
				git_submodule_free(sm);
				return error;
			}
		}
356 357

		git_buf_free(&path);
358 359
	}

360 361 362 363 364 365 366
	if ((error = git_submodule_location(&location, sm)) < 0) {
		git_submodule_free(sm);
		return error;
	}

	/* If we still haven't found it, do the WD check */
	if (location == 0 || location == GIT_SUBMODULE_STATUS_IN_WD) {
367 368
		git_submodule_free(sm);
		error = GIT_ENOTFOUND;
Russell Belfer committed
369

370
		/* If it's not configured, we still check if there's a repo at the path */
Russell Belfer committed
371 372
		if (git_repository_workdir(repo)) {
			git_buf path = GIT_BUF_INIT;
373
			if (git_buf_join3(&path,
374
					  '/', git_repository_workdir(repo), name, DOT_GIT) < 0)
Russell Belfer committed
375 376
				return -1;

377
			if (git_path_exists(path.ptr))
Russell Belfer committed
378 379 380 381 382
				error = GIT_EEXISTS;

			git_buf_free(&path);
		}

383
		submodule_set_lookup_error(error, name);
384
		return error;
Russell Belfer committed
385 386
	}

387 388 389 390 391 392
	if (out)
		*out = sm;
	else
		git_submodule_free(sm);

	return 0;
Russell Belfer committed
393
}
394

395
int git_submodule_name_is_valid(git_repository *repo, const char *name, int flags)
396
{
397 398 399
	git_buf buf = GIT_BUF_INIT;
	int error, isvalid;

400 401 402
	if (flags == 0)
		flags = GIT_PATH_REJECT_FILESYSTEM_DEFAULTS;

403
	/* Avoid allocating a new string if we can avoid it */
404
	if (strchr(name, '\\') != NULL) {
405 406 407 408 409 410
		if ((error = git_path_normalize_slashes(&buf, name)) < 0)
			return error;
	} else {
		git_buf_attach_notowned(&buf, name, strlen(name));
	}

411
	isvalid =  git_path_isvalid(repo, buf.ptr, 0, flags);
412 413 414
	git_buf_free(&buf);

	return isvalid;
415 416
}

417 418 419 420 421
static void submodule_free_dup(void *sm)
{
	git_submodule_free(sm);
}

422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
static int submodule_get_or_create(git_submodule **out, git_repository *repo, git_strmap *map, const char *name)
{
	int error = 0;
	khiter_t pos;
	git_submodule *sm = NULL;

	pos = git_strmap_lookup_index(map, name);
	if (git_strmap_valid_index(map, pos)) {
		sm = git_strmap_value_at(map, pos);
		goto done;
	}

	/* if the submodule doesn't exist yet in the map, create it */
	if ((error = submodule_alloc(&sm, repo, name)) < 0)
		return error;

438
	pos = git_strmap_put(map, sm->name, &error);
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
	/* nobody can beat us to adding it */
	assert(error != 0);
	if (error < 0) {
		git_submodule_free(sm);
		return error;
	}

	git_strmap_set_value_at(map, pos, sm);

done:
	GIT_REFCOUNT_INC(sm);
	*out = sm;
	return 0;
}

454
static int submodules_from_index(git_strmap *map, git_index *idx, git_config *cfg)
455
{
David Turner committed
456
	int error;
457
	git_iterator *i = NULL;
David Turner committed
458
	const git_index_entry *entry;
459
	git_strmap *names;
460

461
	if ((error = load_submodule_names(&names, git_index_owner(idx), cfg)))
462
		goto done;
463

David Turner committed
464
	if ((error = git_iterator_for_index(&i, git_index_owner(idx), idx, NULL)) < 0)
465
		goto done;
466

David Turner committed
467 468 469 470 471 472 473 474 475 476 477 478
	while (!(error = git_iterator_advance(&entry, i))) {
		khiter_t pos = git_strmap_lookup_index(map, entry->path);
		git_submodule *sm;

		if (git_strmap_valid_index(map, pos)) {
			sm = git_strmap_value_at(map, pos);

			if (S_ISGITLINK(entry->mode))
				submodule_update_from_index_entry(sm, entry);
			else
				sm->flags |= GIT_SUBMODULE_STATUS__INDEX_NOT_SUBMODULE;
		} else if (S_ISGITLINK(entry->mode)) {
479 480 481 482 483 484 485 486 487
			khiter_t name_pos;
			const char *name;

			name_pos = git_strmap_lookup_index(names, entry->path);
			if (git_strmap_valid_index(names, name_pos)) {
				name = git_strmap_value_at(names, name_pos);
			} else {
				name = entry->path;
			}
488

489
			if (!submodule_get_or_create(&sm, git_index_owner(idx), map, name)) {
David Turner committed
490 491 492 493 494
				submodule_update_from_index_entry(sm, entry);
				git_submodule_free(sm);
			}
		}
	}
495

David Turner committed
496 497
	if (error == GIT_ITEROVER)
		error = 0;
498

499
done:
David Turner committed
500
	git_iterator_free(i);
501
	free_submodule_names(names);
502

David Turner committed
503
	return error;
504 505
}

506
static int submodules_from_head(git_strmap *map, git_tree *head, git_config *cfg)
507
{
David Turner committed
508
	int error;
509
	git_iterator *i = NULL;
David Turner committed
510
	const git_index_entry *entry;
511 512 513
	git_strmap *names;

	if ((error = load_submodule_names(&names, git_tree_owner(head), cfg)))
514
		goto done;
515

David Turner committed
516
	if ((error = git_iterator_for_tree(&i, head, NULL)) < 0)
517
		goto done;
518

David Turner committed
519 520 521 522 523 524 525 526 527 528 529 530
	while (!(error = git_iterator_advance(&entry, i))) {
		khiter_t pos = git_strmap_lookup_index(map, entry->path);
		git_submodule *sm;

		if (git_strmap_valid_index(map, pos)) {
			sm = git_strmap_value_at(map, pos);

			if (S_ISGITLINK(entry->mode))
				submodule_update_from_head_data(sm, entry->mode, &entry->id);
			else
				sm->flags |= GIT_SUBMODULE_STATUS__HEAD_NOT_SUBMODULE;
		} else if (S_ISGITLINK(entry->mode)) {
531 532 533 534 535 536 537 538 539
			khiter_t name_pos;
			const char *name;

			name_pos = git_strmap_lookup_index(names, entry->path);
			if (git_strmap_valid_index(names, name_pos)) {
				name = git_strmap_value_at(names, name_pos);
			} else {
				name = entry->path;
			}
540

541
			if (!submodule_get_or_create(&sm, git_tree_owner(head), map, name)) {
David Turner committed
542 543 544 545 546 547
				submodule_update_from_head_data(
					sm, entry->mode, &entry->id);
				git_submodule_free(sm);
			}
		}
	}
548

David Turner committed
549 550
	if (error == GIT_ITEROVER)
		error = 0;
551

552
done:
David Turner committed
553
	git_iterator_free(i);
554
	free_submodule_names(names);
555

David Turner committed
556
	return error;
557 558 559 560
}

/* If have_sm is true, sm is populated, otherwise map an repo are. */
typedef struct {
561
	git_config *mods;
562 563 564 565
	git_strmap *map;
	git_repository *repo;
} lfc_data;

566
int git_submodule__map(git_repository *repo, git_strmap *map)
567 568 569 570 571 572 573
{
	int error = 0;
	git_index *idx = NULL;
	git_tree *head = NULL;
	const char *wd = NULL;
	git_buf path = GIT_BUF_INIT;
	git_submodule *sm;
574
	git_config *mods = NULL;
575 576 577 578 579 580 581 582 583 584 585 586 587

	assert(repo && map);

	/* get sources that we will need to check */
	if (git_repository_index(&idx, repo) < 0)
		giterr_clear();
	if (git_repository_head_tree(&head, repo) < 0)
		giterr_clear();

	wd = git_repository_workdir(repo);
	if (wd && (error = git_buf_joinpath(&path, wd, GIT_MODULES_FILE)) < 0)
		goto cleanup;

588 589 590 591 592 593
	/* add submodule information from .gitmodules */
	if (wd) {
		lfc_data data = { 0 };
		data.map = map;
		data.repo = repo;

594 595 596
		if ((error = gitmodules_snapshot(&mods, repo)) < 0) {
			if (error == GIT_ENOTFOUND)
				error = 0;
597
			goto cleanup;
598
		}
599 600 601 602 603 604

		data.mods = mods;
		if ((error = git_config_foreach(
			    mods, submodule_load_each, &data)) < 0)
			goto cleanup;
	}
605
	/* add back submodule information from index */
606
	if (mods && idx) {
607
		if ((error = submodules_from_index(map, idx, mods)) < 0)
608 609 610
			goto cleanup;
	}
	/* add submodule information from HEAD */
611
	if (mods && head) {
612
		if ((error = submodules_from_head(map, head, mods)) < 0)
613 614 615
			goto cleanup;
	}
	/* shallow scan submodules in work tree as needed */
616
	if (wd) {
617 618 619 620 621 622
		git_strmap_foreach_value(map, sm, {
				submodule_load_from_wd_lite(sm);
			});
	}

cleanup:
623
	git_config_free(mods);
624 625 626 627 628 629 630
	/* TODO: if we got an error, mark submodule config as invalid? */
	git_index_free(idx);
	git_tree_free(head);
	git_buf_free(&path);
	return error;
}

Russell Belfer committed
631 632
int git_submodule_foreach(
	git_repository *repo,
633
	git_submodule_cb callback,
Russell Belfer committed
634 635
	void *payload)
{
636 637 638
	git_vector snapshot = GIT_VECTOR_INIT;
	git_strmap *submodules;
	git_submodule *sm;
Russell Belfer committed
639
	int error;
640
	size_t i;
Russell Belfer committed
641

642 643 644 645 646
	if (repo->is_bare) {
		giterr_set(GITERR_SUBMODULE, "cannot get submodules without a working tree");
		return -1;
	}

647
	if ((error = git_strmap_alloc(&submodules)) < 0)
Russell Belfer committed
648 649
		return error;

650
	if ((error = git_submodule__map(repo, submodules)) < 0)
651
		goto done;
652 653

	if (!(error = git_vector_init(
654
			&snapshot, git_strmap_num_entries(submodules), submodule_cmp))) {
655

656
		git_strmap_foreach_value(submodules, sm, {
657
			if ((error = git_vector_insert(&snapshot, sm)) < 0)
Russell Belfer committed
658
				break;
659 660 661 662 663 664 665 666 667 668
			GIT_REFCOUNT_INC(sm);
		});
	}

	if (error < 0)
		goto done;

	git_vector_uniq(&snapshot, submodule_free_dup);

	git_vector_foreach(&snapshot, i, sm) {
669
		if ((error = callback(sm, sm->name, payload)) != 0) {
670
			giterr_set_after_callback(error);
Russell Belfer committed
671
			break;
672
		}
673
	}
Russell Belfer committed
674

675 676 677 678
done:
	git_vector_foreach(&snapshot, i, sm)
		git_submodule_free(sm);
	git_vector_free(&snapshot);
Russell Belfer committed
679

680 681 682 683
	git_strmap_foreach_value(submodules, sm, {
		git_submodule_free(sm);
	});
	git_strmap_free(submodules);
Russell Belfer committed
684

685
	return error;
Russell Belfer committed
686 687
}

688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
static int submodule_repo_init(
	git_repository **out,
	git_repository *parent_repo,
	const char *path,
	const char *url,
	bool use_gitlink)
{
	int error = 0;
	git_buf workdir = GIT_BUF_INIT, repodir = GIT_BUF_INIT;
	git_repository_init_options initopt = GIT_REPOSITORY_INIT_OPTIONS_INIT;
	git_repository *subrepo = NULL;

	error = git_buf_joinpath(&workdir, git_repository_workdir(parent_repo), path);
	if (error < 0)
		goto cleanup;

	initopt.flags = GIT_REPOSITORY_INIT_MKPATH | GIT_REPOSITORY_INIT_NO_REINIT;
	initopt.origin_url = url;

	/* init submodule repository and add origin remote as needed */

	/* New style: sub-repo goes in <repo-dir>/modules/<name>/ with a
	 * gitlink in the sub-repo workdir directory to that repository
	 *
	 * Old style: sub-repo goes directly into repo/<name>/.git/
	 */
	 if (use_gitlink) {
715 716 717 718
		error = git_repository_item_path(&repodir, parent_repo, GIT_REPOSITORY_ITEM_MODULES);
		if (error < 0)
			goto cleanup;
		error = git_buf_joinpath(&repodir, repodir.ptr, path);
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739
		if (error < 0)
			goto cleanup;

		initopt.workdir_path = workdir.ptr;
		initopt.flags |=
			GIT_REPOSITORY_INIT_NO_DOTGIT_DIR |
			GIT_REPOSITORY_INIT_RELATIVE_GITLINK;

		error = git_repository_init_ext(&subrepo, repodir.ptr, &initopt);
	} else
		error = git_repository_init_ext(&subrepo, workdir.ptr, &initopt);

cleanup:
	git_buf_free(&workdir);
	git_buf_free(&repodir);

	*out = subrepo;

	return error;
}

Russell Belfer committed
740
int git_submodule_add_setup(
741
	git_submodule **out,
Russell Belfer committed
742 743 744 745 746 747
	git_repository *repo,
	const char *url,
	const char *path,
	int use_gitlink)
{
	int error = 0;
Ben Straub committed
748
	git_config_backend *mods = NULL;
749
	git_submodule *sm = NULL;
Russell Belfer committed
750 751
	git_buf name = GIT_BUF_INIT, real_url = GIT_BUF_INIT;
	git_repository *subrepo = NULL;
752
	bool path_occupied;
Russell Belfer committed
753 754 755 756 757

	assert(repo && url && path);

	/* see if there is already an entry for this submodule */

758
	if (git_submodule_lookup(NULL, repo, path) < 0)
Russell Belfer committed
759 760 761
		giterr_clear();
	else {
		giterr_set(GITERR_SUBMODULE,
762
			"attempt to add submodule '%s' that already exists", path);
Russell Belfer committed
763 764 765 766 767 768 769 770 771
		return GIT_EEXISTS;
	}

	/* validate and normalize path */

	if (git__prefixcmp(path, git_repository_workdir(repo)) == 0)
		path += strlen(git_repository_workdir(repo));

	if (git_path_root(path) >= 0) {
772
		giterr_set(GITERR_SUBMODULE, "submodule path must be a relative path");
Russell Belfer committed
773 774 775 776
		error = -1;
		goto cleanup;
	}

777
	if ((error = is_path_occupied(&path_occupied, repo, path)) < 0)
778 779
		goto cleanup;

780 781 782 783 784
	if (path_occupied) {
		error = GIT_EEXISTS;
		goto cleanup;
	}

Russell Belfer committed
785 786
	/* update .gitmodules */

787
	if (!(mods = open_gitmodules(repo, GITMODULES_CREATE))) {
Russell Belfer committed
788
		giterr_set(GITERR_SUBMODULE,
789
			"adding submodules to a bare repository is not supported");
Russell Belfer committed
790 791 792 793 794 795 796 797
		return -1;
	}

	if ((error = git_buf_printf(&name, "submodule.%s.path", path)) < 0 ||
		(error = git_config_file_set_string(mods, name.ptr, path)) < 0)
		goto cleanup;

	if ((error = submodule_config_key_trunc_puts(&name, "url")) < 0 ||
798
		(error = git_config_file_set_string(mods, name.ptr, url)) < 0)
Russell Belfer committed
799 800 801 802 803 804 805 806 807 808
		goto cleanup;

	git_buf_clear(&name);

	/* init submodule repository and add origin remote as needed */

	error = git_buf_joinpath(&name, git_repository_workdir(repo), path);
	if (error < 0)
		goto cleanup;

809 810
	/* if the repo does not already exist, then init a new repo and add it.
	 * Otherwise, just add the existing repo.
Russell Belfer committed
811
	 */
812 813
	if (!(git_path_exists(name.ptr) &&
		git_path_contains(&name, DOT_GIT))) {
814 815 816 817 818 819

		/* resolve the actual URL to use */
		if ((error = git_submodule_resolve_url(&real_url, repo, url)) < 0)
			goto cleanup;

		 if ((error = submodule_repo_init(&subrepo, repo, path, real_url.ptr, use_gitlink)) < 0)
Russell Belfer committed
820 821 822
			goto cleanup;
	}

823
	if ((error = git_submodule_lookup(&sm, repo, path)) < 0)
824
		goto cleanup;
Russell Belfer committed
825

826
	error = git_submodule_init(sm, false);
827

Russell Belfer committed
828
cleanup:
829 830 831 832 833 834
	if (error && sm) {
		git_submodule_free(sm);
		sm = NULL;
	}
	if (out != NULL)
		*out = sm;
Russell Belfer committed
835

836
	git_config_file_free(mods);
Russell Belfer committed
837 838 839 840 841 842 843
	git_repository_free(subrepo);
	git_buf_free(&real_url);
	git_buf_free(&name);

	return error;
}

844 845 846 847 848 849 850
int git_submodule_repo_init(
	git_repository **out,
	const git_submodule *sm,
	int use_gitlink)
{
	int error;
	git_repository *sub_repo = NULL;
851 852 853
	const char *configured_url;
	git_config *cfg = NULL;
	git_buf buf = GIT_BUF_INIT;
854 855 856

	assert(out && sm);

857 858
	/* get the configured remote url of the submodule */
	if ((error = git_buf_printf(&buf, "submodule.%s.url", sm->name)) < 0 ||
859
		(error = git_repository_config_snapshot(&cfg, sm->repo)) < 0 ||
860 861 862
		(error = git_config_get_string(&configured_url, cfg, buf.ptr)) < 0 ||
		(error = submodule_repo_init(&sub_repo, sm->repo, sm->path, configured_url, use_gitlink)) < 0)
		goto done;
863 864 865

	*out = sub_repo;

866 867 868
done:
	git_config_free(cfg);
	git_buf_free(&buf);
869 870 871
	return error;
}

Russell Belfer committed
872 873 874 875 876 877 878
int git_submodule_add_finalize(git_submodule *sm)
{
	int error;
	git_index *index;

	assert(sm);

879
	if ((error = git_repository_index__weakptr(&index, sm->repo)) < 0 ||
880
		(error = git_index_add_bypath(index, GIT_MODULES_FILE)) < 0)
Russell Belfer committed
881 882
		return error;

883
	return git_submodule_add_to_index(sm, true);
Russell Belfer committed
884 885
}

886
int git_submodule_add_to_index(git_submodule *sm, int write_index)
Russell Belfer committed
887 888
{
	int error;
889
	git_repository *sm_repo = NULL;
Russell Belfer committed
890 891 892 893 894 895 896 897
	git_index *index;
	git_buf path = GIT_BUF_INIT;
	git_commit *head;
	git_index_entry entry;
	struct stat st;

	assert(sm);

898 899 900
	/* force reload of wd OID by git_submodule_open */
	sm->flags = sm->flags & ~GIT_SUBMODULE_STATUS__WD_OID_VALID;

901
	if ((error = git_repository_index__weakptr(&index, sm->repo)) < 0 ||
Russell Belfer committed
902
		(error = git_buf_joinpath(
903
			&path, git_repository_workdir(sm->repo), sm->path)) < 0 ||
Russell Belfer committed
904 905 906 907 908 909
		(error = git_submodule_open(&sm_repo, sm)) < 0)
		goto cleanup;

	/* read stat information for submodule working directory */
	if (p_stat(path.ptr, &st) < 0) {
		giterr_set(GITERR_SUBMODULE,
910
			"cannot add submodule without working directory");
Russell Belfer committed
911 912 913
		error = -1;
		goto cleanup;
	}
914 915

	memset(&entry, 0, sizeof(entry));
916
	entry.path = sm->path;
917 918
	git_index_entry__init_from_stat(
		&entry, &st, !(git_index_caps(index) & GIT_INDEXCAP_NO_FILEMODE));
Russell Belfer committed
919 920 921 922

	/* calling git_submodule_open will have set sm->wd_oid if possible */
	if ((sm->flags & GIT_SUBMODULE_STATUS__WD_OID_VALID) == 0) {
		giterr_set(GITERR_SUBMODULE,
923
			"cannot add submodule without HEAD to index");
Russell Belfer committed
924 925 926
		error = -1;
		goto cleanup;
	}
927
	git_oid_cpy(&entry.id, &sm->wd_oid);
Russell Belfer committed
928 929 930 931

	if ((error = git_commit_lookup(&head, sm_repo, &sm->wd_oid)) < 0)
		goto cleanup;

932
	entry.ctime.seconds = (int32_t)git_commit_time(head);
Russell Belfer committed
933
	entry.ctime.nanoseconds = 0;
934
	entry.mtime.seconds = (int32_t)git_commit_time(head);
Russell Belfer committed
935 936 937 938
	entry.mtime.nanoseconds = 0;

	git_commit_free(head);

939
	/* add it */
Edward Thomson committed
940
	error = git_index_add(index, &entry);
Russell Belfer committed
941

942 943 944 945 946 947 948 949
	/* write it, if requested */
	if (!error && write_index) {
		error = git_index_write(index);

		if (!error)
			git_oid_cpy(&sm->index_oid, &sm->wd_oid);
	}

Russell Belfer committed
950 951 952 953 954 955
cleanup:
	git_repository_free(sm_repo);
	git_buf_free(&path);
	return error;
}

956 957 958 959
const char *git_submodule_update_to_str(git_submodule_update_t update)
{
	int i;
	for (i = 0; i < (int)ARRAY_SIZE(_sm_update_map); ++i)
960
		if (_sm_update_map[i].map_value == (int)update)
961 962 963 964
			return _sm_update_map[i].str_match;
	return NULL;
}

Russell Belfer committed
965 966 967
git_repository *git_submodule_owner(git_submodule *submodule)
{
	assert(submodule);
968
	return submodule->repo;
Russell Belfer committed
969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988
}

const char *git_submodule_name(git_submodule *submodule)
{
	assert(submodule);
	return submodule->name;
}

const char *git_submodule_path(git_submodule *submodule)
{
	assert(submodule);
	return submodule->path;
}

const char *git_submodule_url(git_submodule *submodule)
{
	assert(submodule);
	return submodule->url;
}

989 990 991
int git_submodule_resolve_url(git_buf *out, git_repository *repo, const char *url)
{
	int error = 0;
992
	git_buf normalized = GIT_BUF_INIT;
993

994 995 996
	assert(out && repo && url);

	git_buf_sanitize(out);
Carlos Martín Nieto committed
997

998
	/* We do this in all platforms in case someone on Windows created the .gitmodules */
999
	if (strchr(url, '\\')) {
1000
		if ((error = git_path_normalize_slashes(&normalized, url)) < 0)
1001 1002 1003 1004 1005
			return error;

		url = normalized.ptr;
	}

1006

1007
	if (git_path_is_relative(url)) {
1008
		if (!(error = get_url_base(out, repo)))
1009 1010 1011 1012
			error = git_path_apply_relative(out, url);
	} else if (strchr(url, ':') != NULL || url[0] == '/') {
		error = git_buf_sets(out, url);
	} else {
1013
		giterr_set(GITERR_SUBMODULE, "invalid format for submodule URL");
1014 1015 1016
		error = -1;
	}

1017
	git_buf_free(&normalized);
1018 1019 1020
	return error;
}

1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
static int write_var(git_repository *repo, const char *name, const char *var, const char *val)
{
	git_buf key = GIT_BUF_INIT;
	git_config_backend *mods;
	int error;

	mods = open_gitmodules(repo, GITMODULES_CREATE);
	if (!mods)
		return -1;

	if ((error = git_buf_printf(&key, "submodule.%s.%s", name, var)) < 0)
		goto cleanup;

	if (val)
		error = git_config_file_set_string(mods, key.ptr, val);
	else
		error = git_config_file_delete(mods, key.ptr);

	git_buf_free(&key);

cleanup:
	git_config_file_free(mods);
	return error;
}

1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
static int write_mapped_var(git_repository *repo, const char *name, git_cvar_map *maps, size_t nmaps, const char *var, int ival)
{
	git_cvar_t type;
	const char *val;

	if (git_config_lookup_map_enum(&type, &val, maps, nmaps, ival) < 0) {
		giterr_set(GITERR_SUBMODULE, "invalid value for %s", var);
		return -1;
	}

	if (type == GIT_CVAR_TRUE)
		val = "true";

	return write_var(repo, name, var, val);
}

1062 1063 1064 1065 1066 1067
const char *git_submodule_branch(git_submodule *submodule)
{
	assert(submodule);
	return submodule->branch;
}

1068
int git_submodule_set_branch(git_repository *repo, const char *name, const char *branch)
1069 1070
{

1071
	assert(repo && name);
1072

1073
	return write_var(repo, name, "branch", branch);
1074 1075
}

1076
int git_submodule_set_url(git_repository *repo, const char *name, const char *url)
Russell Belfer committed
1077
{
1078
	assert(repo && name && url);
Russell Belfer committed
1079

1080
	return write_var(repo, name, "url", url);
Russell Belfer committed
1081 1082
}

1083
const git_oid *git_submodule_index_id(git_submodule *submodule)
Russell Belfer committed
1084 1085 1086 1087 1088 1089 1090 1091 1092
{
	assert(submodule);

	if (submodule->flags & GIT_SUBMODULE_STATUS__INDEX_OID_VALID)
		return &submodule->index_oid;
	else
		return NULL;
}

1093
const git_oid *git_submodule_head_id(git_submodule *submodule)
Russell Belfer committed
1094 1095 1096 1097 1098 1099 1100 1101 1102
{
	assert(submodule);

	if (submodule->flags & GIT_SUBMODULE_STATUS__HEAD_OID_VALID)
		return &submodule->head_oid;
	else
		return NULL;
}

1103
const git_oid *git_submodule_wd_id(git_submodule *submodule)
Russell Belfer committed
1104 1105 1106
{
	assert(submodule);

1107
	/* load unless we think we have a valid oid */
Russell Belfer committed
1108 1109 1110 1111
	if (!(submodule->flags & GIT_SUBMODULE_STATUS__WD_OID_VALID)) {
		git_repository *subrepo;

		/* calling submodule open grabs the HEAD OID if possible */
1112
		if (!git_submodule_open_bare(&subrepo, submodule))
Russell Belfer committed
1113
			git_repository_free(subrepo);
1114 1115
		else
			giterr_clear();
Russell Belfer committed
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
	}

	if (submodule->flags & GIT_SUBMODULE_STATUS__WD_OID_VALID)
		return &submodule->wd_oid;
	else
		return NULL;
}

git_submodule_ignore_t git_submodule_ignore(git_submodule *submodule)
{
	assert(submodule);
1127 1128
	return (submodule->ignore < GIT_SUBMODULE_IGNORE_NONE) ?
		GIT_SUBMODULE_IGNORE_NONE : submodule->ignore;
Russell Belfer committed
1129 1130
}

1131 1132
int git_submodule_set_ignore(git_repository *repo, const char *name, git_submodule_ignore_t ignore)
{
1133
	assert(repo && name);
1134

1135
	return write_mapped_var(repo, name, _sm_ignore_map, ARRAY_SIZE(_sm_ignore_map), "ignore", ignore);
1136 1137
}

1138
git_submodule_update_t git_submodule_update_strategy(git_submodule *submodule)
Russell Belfer committed
1139 1140
{
	assert(submodule);
1141 1142
	return (submodule->update < GIT_SUBMODULE_UPDATE_CHECKOUT) ?
		GIT_SUBMODULE_UPDATE_CHECKOUT : submodule->update;
Russell Belfer committed
1143 1144
}

1145
int git_submodule_set_update(git_repository *repo, const char *name, git_submodule_update_t update)
Russell Belfer committed
1146
{
1147
	assert(repo && name);
Russell Belfer committed
1148

1149
	return write_mapped_var(repo, name, _sm_update_map, ARRAY_SIZE(_sm_update_map), "update", update);
Russell Belfer committed
1150 1151
}

1152
git_submodule_recurse_t git_submodule_fetch_recurse_submodules(
1153 1154 1155 1156 1157 1158
	git_submodule *submodule)
{
	assert(submodule);
	return submodule->fetch_recurse;
}

1159
int git_submodule_set_fetch_recurse_submodules(git_repository *repo, const char *name, git_submodule_recurse_t recurse)
1160
{
1161 1162
	assert(repo && name);

1163
	return write_mapped_var(repo, name, _sm_recurse_map, ARRAY_SIZE(_sm_recurse_map), "fetchRecurseSubmodules", recurse);
1164 1165
}

1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190
static int submodule_repo_create(
	git_repository **out,
	git_repository *parent_repo,
	const char *path)
{
	int error = 0;
	git_buf workdir = GIT_BUF_INIT, repodir = GIT_BUF_INIT;
	git_repository_init_options initopt = GIT_REPOSITORY_INIT_OPTIONS_INIT;
	git_repository *subrepo = NULL;

	initopt.flags =
		GIT_REPOSITORY_INIT_MKPATH |
		GIT_REPOSITORY_INIT_NO_REINIT |
		GIT_REPOSITORY_INIT_NO_DOTGIT_DIR |
		GIT_REPOSITORY_INIT_RELATIVE_GITLINK;

	/* Workdir: path to sub-repo working directory */
	error = git_buf_joinpath(&workdir, git_repository_workdir(parent_repo), path);
	if (error < 0)
		goto cleanup;

	initopt.workdir_path = workdir.ptr;

	/**
	 * Repodir: path to the sub-repo. sub-repo goes in:
1191
	 * <repo-dir>/modules/<name>/ with a gitlink in the
1192 1193
	 * sub-repo workdir directory to that repository.
	 */
1194 1195 1196 1197
	error = git_repository_item_path(&repodir, parent_repo, GIT_REPOSITORY_ITEM_MODULES);
	if (error < 0)
		goto cleanup;
	error = git_buf_joinpath(&repodir, repodir.ptr, path);
1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
	if (error < 0)
		goto cleanup;

	error = git_repository_init_ext(&subrepo, repodir.ptr, &initopt);

cleanup:
	git_buf_free(&workdir);
	git_buf_free(&repodir);

	*out = subrepo;

	return error;
}

/**
 * Callback to override sub-repository creation when
 * cloning a sub-repository.
 */
static int git_submodule_update_repo_init_cb(
	git_repository **out,
	const char *path,
	int bare,
	void *payload)
{
1222 1223
	git_submodule *sm;

1224
	GIT_UNUSED(bare);
1225 1226

	sm = payload;
1227 1228 1229 1230

	return submodule_repo_create(out, sm->repo, path);
}

1231 1232 1233 1234 1235 1236 1237
int git_submodule_update_init_options(git_submodule_update_options *opts, unsigned int version)
{
	GIT_INIT_STRUCTURE_FROM_TEMPLATE(
		opts, version, git_submodule_update_options, GIT_SUBMODULE_UPDATE_OPTIONS_INIT);
	return 0;
}

1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
int git_submodule_update(git_submodule *sm, int init, git_submodule_update_options *_update_options)
{
	int error;
	unsigned int submodule_status;
	git_config *config = NULL;
	const char *submodule_url;
	git_repository *sub_repo = NULL;
	git_remote *remote = NULL;
	git_object *target_commit = NULL;
	git_buf buf = GIT_BUF_INIT;
	git_submodule_update_options update_options = GIT_SUBMODULE_UPDATE_OPTIONS_INIT;
	git_clone_options clone_options = GIT_CLONE_OPTIONS_INIT;

	assert(sm);

	if (_update_options)
		memcpy(&update_options, _update_options, sizeof(git_submodule_update_options));

	GITERR_CHECK_VERSION(&update_options, GIT_SUBMODULE_UPDATE_OPTIONS_VERSION, "git_submodule_update_options");

	/* Copy over the remote callbacks */
1259
	memcpy(&clone_options.fetch_opts, &update_options.fetch_opts, sizeof(git_fetch_options));
1260 1261

	/* Get the status of the submodule to determine if it is already initialized  */
1262
	if ((error = git_submodule_status(&submodule_status, sm->repo, sm->name, GIT_SUBMODULE_IGNORE_UNSPECIFIED)) < 0)
1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285
		goto done;

	/*
	 * If submodule work dir is not already initialized, check to see
	 * what we need to do (initialize, clone, return error...)
	 */
	if (submodule_status & GIT_SUBMODULE_STATUS_WD_UNINITIALIZED) {
		/*
		 * Work dir is not initialized, check to see if the submodule
		 * info has been copied into .git/config
		 */
		if ((error = git_repository_config_snapshot(&config, sm->repo)) < 0 ||
			(error = git_buf_printf(&buf, "submodule.%s.url", git_submodule_name(sm))) < 0)
			goto done;

		if ((error = git_config_get_string(&submodule_url, config, git_buf_cstr(&buf))) < 0) {
			/*
			 * If the error is not "not found" or if it is "not found" and we are not
			 * initializing the submodule, then return error.
			 */
			if (error != GIT_ENOTFOUND)
				goto done;

1286
			if (!init) {
1287
				giterr_set(GITERR_SUBMODULE, "submodule is not initialized");
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309
				error = GIT_ERROR;
				goto done;
			}

			/* The submodule has not been initialized yet - initialize it now.*/
			if ((error = git_submodule_init(sm, 0)) < 0)
				goto done;

			git_config_free(config);
			config = NULL;

			if ((error = git_repository_config_snapshot(&config, sm->repo)) < 0 ||
				(error = git_config_get_string(&submodule_url, config, git_buf_cstr(&buf))) < 0)
				goto done;
		}

		/** submodule is initialized - now clone it **/
		/* override repo creation */
		clone_options.repository_cb = git_submodule_update_repo_init_cb;
		clone_options.repository_cb_payload = sm;

		/*
1310
		 * Do not perform checkout as part of clone, instead we
1311 1312 1313 1314 1315
		 * will checkout the specific commit manually.
		 */
		clone_options.checkout_opts.checkout_strategy = GIT_CHECKOUT_NONE;

		if ((error = git_clone(&sub_repo, submodule_url, sm->path, &clone_options)) < 0 ||
1316
			(error = git_repository_set_head_detached(sub_repo, git_submodule_index_id(sm))) < 0 ||
1317 1318 1319
			(error = git_checkout_head(sub_repo, &update_options.checkout_opts)) != 0)
			goto done;
	} else {
1320 1321
		const git_oid *oid;

1322 1323 1324 1325 1326
		/**
		 * Work dir is initialized - look up the commit in the parent repository's index,
		 * update the workdir contents of the subrepository, and set the subrepository's
		 * head to the new commit.
		 */
1327 1328 1329
		if ((error = git_submodule_open(&sub_repo, sm)) < 0)
			goto done;

1330 1331 1332 1333 1334 1335
		if ((oid = git_submodule_index_id(sm)) == NULL) {
			giterr_set(GITERR_SUBMODULE, "could not get ID of submodule in index");
			error = -1;
			goto done;
		}

1336
		/* Look up the target commit in the submodule. */
1337
		if ((error = git_object_lookup(&target_commit, sub_repo, oid, GIT_OBJ_COMMIT)) < 0) {
1338 1339 1340 1341 1342 1343 1344 1345 1346
			/* If it isn't found then fetch and try again. */
			if (error != GIT_ENOTFOUND || !update_options.allow_fetch ||
				(error = lookup_default_remote(&remote, sub_repo)) < 0 ||
				(error = git_remote_fetch(remote, NULL, &update_options.fetch_opts, NULL)) < 0 ||
				(error = git_object_lookup(&target_commit, sub_repo, git_submodule_index_id(sm), GIT_OBJ_COMMIT)) < 0)
				goto done;
		}

		if ((error = git_checkout_tree(sub_repo, target_commit, &update_options.checkout_opts)) != 0 ||
1347
			(error = git_repository_set_head_detached(sub_repo, git_submodule_index_id(sm))) < 0)
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366
			goto done;

		/* Invalidate the wd flags as the workdir has been updated. */
		sm->flags = sm->flags &
			~(GIT_SUBMODULE_STATUS_IN_WD |
		  	GIT_SUBMODULE_STATUS__WD_OID_VALID |
		  	GIT_SUBMODULE_STATUS__WD_SCANNED);
	}

done:
	git_buf_free(&buf);
	git_config_free(config);
	git_object_free(target_commit);
	git_remote_free(remote);
	git_repository_free(sub_repo);

	return error;
}

1367
int git_submodule_init(git_submodule *sm, int overwrite)
Russell Belfer committed
1368 1369
{
	int error;
1370
	const char *val;
1371
	git_buf key = GIT_BUF_INIT, effective_submodule_url = GIT_BUF_INIT;
1372
	git_config *cfg = NULL;
Russell Belfer committed
1373

1374
	if (!sm->url) {
Russell Belfer committed
1375
		giterr_set(GITERR_SUBMODULE,
1376
			"no URL configured for submodule '%s'", sm->name);
Russell Belfer committed
1377 1378 1379
		return -1;
	}

1380
	if ((error = git_repository_config(&cfg, sm->repo)) < 0)
Russell Belfer committed
1381 1382
		return error;

1383 1384
	/* write "submodule.NAME.url" */

1385
	if ((error = git_submodule_resolve_url(&effective_submodule_url, sm->repo, sm->url)) < 0 ||
1386
		(error = git_buf_printf(&key, "submodule.%s.url", sm->name)) < 0 ||
1387
		(error = git_config__update_entry(
1388
			cfg, key.ptr, effective_submodule_url.ptr, overwrite != 0, false)) < 0)
1389 1390
		goto cleanup;

Russell Belfer committed
1391 1392
	/* write "submodule.NAME.update" if not default */

1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405
	val = (sm->update == GIT_SUBMODULE_UPDATE_CHECKOUT) ?
		NULL : git_submodule_update_to_str(sm->update);

	if ((error = git_buf_printf(&key, "submodule.%s.update", sm->name)) < 0 ||
		(error = git_config__update_entry(
			cfg, key.ptr, val, overwrite != 0, false)) < 0)
		goto cleanup;

	/* success */

cleanup:
	git_config_free(cfg);
	git_buf_free(&key);
1406
	git_buf_free(&effective_submodule_url);
Russell Belfer committed
1407 1408 1409 1410

	return error;
}

1411
int git_submodule_sync(git_submodule *sm)
Russell Belfer committed
1412
{
1413 1414 1415
	int error = 0;
	git_config *cfg = NULL;
	git_buf key = GIT_BUF_INIT;
1416
	git_repository *smrepo = NULL;
1417 1418

	if (!sm->url) {
Russell Belfer committed
1419
		giterr_set(GITERR_SUBMODULE,
1420
			"no URL configured for submodule '%s'", sm->name);
Russell Belfer committed
1421 1422 1423 1424 1425
		return -1;
	}

	/* copy URL over to config only if it already exists */

1426 1427 1428 1429 1430 1431
	if (!(error = git_repository_config__weakptr(&cfg, sm->repo)) &&
		!(error = git_buf_printf(&key, "submodule.%s.url", sm->name)))
		error = git_config__update_entry(cfg, key.ptr, sm->url, true, true);

	/* if submodule exists in the working directory, update remote url */

1432 1433 1434 1435
	if (!error &&
		(sm->flags & GIT_SUBMODULE_STATUS_IN_WD) != 0 &&
		!(error = git_submodule_open(&smrepo, sm)))
	{
1436 1437 1438 1439 1440
		git_buf remote_name = GIT_BUF_INIT;

		if ((error = git_repository_config__weakptr(&cfg, smrepo)) < 0)
			/* return error from reading submodule config */;
		else if ((error = lookup_head_remote_key(&remote_name, smrepo)) < 0) {
1441
			giterr_clear();
1442
			error = git_buf_sets(&key, "remote.origin.url");
1443 1444
		} else {
			error = git_buf_join3(
1445
				&key, '.', "remote", remote_name.ptr, "url");
1446
			git_buf_free(&remote_name);
1447 1448
		}

1449 1450
		if (!error)
			error = git_config__update_entry(cfg, key.ptr, sm->url, true, false);
1451 1452 1453 1454 1455 1456 1457

		git_repository_free(smrepo);
	}

	git_buf_free(&key);

	return error;
Russell Belfer committed
1458 1459
}

1460 1461
static int git_submodule__open(
	git_repository **subrepo, git_submodule *sm, bool bare)
Russell Belfer committed
1462 1463 1464
{
	int error;
	git_buf path = GIT_BUF_INIT;
1465 1466
	unsigned int flags = GIT_REPOSITORY_OPEN_NO_SEARCH;
	const char *wd;
Russell Belfer committed
1467

1468
	assert(sm && subrepo);
Russell Belfer committed
1469

1470 1471 1472
	if (git_repository__ensure_not_bare(
			sm->repo, "open submodule repository") < 0)
		return GIT_EBAREREPO;
Russell Belfer committed
1473

1474
	wd = git_repository_workdir(sm->repo);
Russell Belfer committed
1475

1476 1477
	if (git_buf_joinpath(&path, wd, sm->path) < 0 ||
		git_buf_joinpath(&path, path.ptr, DOT_GIT) < 0)
Russell Belfer committed
1478 1479
		return -1;

1480 1481 1482 1483
	sm->flags = sm->flags &
		~(GIT_SUBMODULE_STATUS_IN_WD |
		  GIT_SUBMODULE_STATUS__WD_OID_VALID |
		  GIT_SUBMODULE_STATUS__WD_SCANNED);
Russell Belfer committed
1484

1485 1486
	if (bare)
		flags |= GIT_REPOSITORY_OPEN_BARE;
Russell Belfer committed
1487

1488
	error = git_repository_open_ext(subrepo, path.ptr, flags, wd);
1489

1490 1491 1492 1493
	/* if we opened the submodule successfully, grab HEAD OID, etc. */
	if (!error) {
		sm->flags |= GIT_SUBMODULE_STATUS_IN_WD |
			GIT_SUBMODULE_STATUS__WD_SCANNED;
1494

1495 1496 1497 1498 1499 1500 1501 1502 1503
		if (!git_reference_name_to_id(&sm->wd_oid, *subrepo, GIT_HEAD_FILE))
			sm->flags |= GIT_SUBMODULE_STATUS__WD_OID_VALID;
		else
			giterr_clear();
	} else if (git_path_exists(path.ptr)) {
		sm->flags |= GIT_SUBMODULE_STATUS__WD_SCANNED |
			GIT_SUBMODULE_STATUS_IN_WD;
	} else {
		git_buf_rtruncate_at_char(&path, '/'); /* remove "/.git" */
1504

1505 1506 1507
		if (git_path_isdir(path.ptr))
			sm->flags |= GIT_SUBMODULE_STATUS__WD_SCANNED;
	}
1508

1509
	git_buf_free(&path);
1510

1511 1512
	return error;
}
1513

1514 1515 1516 1517
int git_submodule_open_bare(git_repository **subrepo, git_submodule *sm)
{
	return git_submodule__open(subrepo, sm, true);
}
Russell Belfer committed
1518

1519 1520 1521
int git_submodule_open(git_repository **subrepo, git_submodule *sm)
{
	return git_submodule__open(subrepo, sm, false);
Russell Belfer committed
1522 1523
}

1524 1525
static void submodule_update_from_index_entry(
	git_submodule *sm, const git_index_entry *ie)
Russell Belfer committed
1526
{
1527
	bool already_found = (sm->flags & GIT_SUBMODULE_STATUS_IN_INDEX) != 0;
Russell Belfer committed
1528

1529 1530 1531 1532 1533 1534 1535
	if (!S_ISGITLINK(ie->mode)) {
		if (!already_found)
			sm->flags |= GIT_SUBMODULE_STATUS__INDEX_NOT_SUBMODULE;
	} else {
		if (already_found)
			sm->flags |= GIT_SUBMODULE_STATUS__INDEX_MULTIPLE_ENTRIES;
		else
1536
			git_oid_cpy(&sm->index_oid, &ie->id);
Russell Belfer committed
1537

1538 1539 1540 1541 1542 1543 1544 1545 1546
		sm->flags |= GIT_SUBMODULE_STATUS_IN_INDEX |
			GIT_SUBMODULE_STATUS__INDEX_OID_VALID;
	}
}

static int submodule_update_index(git_submodule *sm)
{
	git_index *index;
	const git_index_entry *ie;
Russell Belfer committed
1547

1548
	if (git_repository_index__weakptr(&index, sm->repo) < 0)
Russell Belfer committed
1549 1550
		return -1;

1551
	sm->flags = sm->flags &
1552 1553 1554
		~(GIT_SUBMODULE_STATUS_IN_INDEX |
		  GIT_SUBMODULE_STATUS__INDEX_OID_VALID);

1555 1556
	if (!(ie = git_index_get_bypath(index, sm->path, 0)))
		return 0;
Russell Belfer committed
1557

1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572
	submodule_update_from_index_entry(sm, ie);

	return 0;
}

static void submodule_update_from_head_data(
	git_submodule *sm, mode_t mode, const git_oid *id)
{
	if (!S_ISGITLINK(mode))
		sm->flags |= GIT_SUBMODULE_STATUS__HEAD_NOT_SUBMODULE;
	else {
		git_oid_cpy(&sm->head_oid, id);

		sm->flags |= GIT_SUBMODULE_STATUS_IN_HEAD |
			GIT_SUBMODULE_STATUS__HEAD_OID_VALID;
Russell Belfer committed
1573
	}
1574
}
Russell Belfer committed
1575

1576 1577 1578
static int submodule_update_head(git_submodule *submodule)
{
	git_tree *head = NULL;
nulltoken committed
1579
	git_tree_entry *te = NULL;
Russell Belfer committed
1580

1581 1582 1583
	submodule->flags = submodule->flags &
		~(GIT_SUBMODULE_STATUS_IN_HEAD |
		  GIT_SUBMODULE_STATUS__HEAD_OID_VALID);
Russell Belfer committed
1584

1585 1586 1587 1588 1589
	/* if we can't look up file in current head, then done */
	if (git_repository_head_tree(&head, submodule->repo) < 0 ||
		git_tree_entry_bypath(&te, head, submodule->path) < 0)
		giterr_clear();
	else
1590
		submodule_update_from_head_data(submodule, te->attr, git_tree_entry_id(te));
Russell Belfer committed
1591

nulltoken committed
1592
	git_tree_entry_free(te);
1593 1594 1595
	git_tree_free(head);
	return 0;
}
1596

1597
int git_submodule_reload(git_submodule *sm, int force)
1598
{
1599
	int error = 0, isvalid;
1600
	git_config *mods;
Russell Belfer committed
1601

1602 1603
	GIT_UNUSED(force);

1604 1605
	assert(sm);

1606 1607
	isvalid = git_submodule_name_is_valid(sm->repo, sm->name, 0);
	if (isvalid <= 0) {
1608
		/* This should come with a warning, but we've no API for that */
1609
		return isvalid;
1610 1611
	}

1612 1613
	if (!git_repository_is_bare(sm->repo)) {
		/* refresh config data */
1614 1615
		if ((error = gitmodules_snapshot(&mods, sm->repo)) < 0 && error != GIT_ENOTFOUND)
			return error;
1616 1617 1618
		if (mods != NULL) {
			error = submodule_read_config(sm, mods);
			git_config_free(mods);
Russell Belfer committed
1619

1620 1621 1622
			if (error < 0)
				return error;
		}
1623

1624 1625 1626 1627 1628
		/* refresh wd data */
		sm->flags &=
			~(GIT_SUBMODULE_STATUS_IN_WD |
			  GIT_SUBMODULE_STATUS__WD_OID_VALID |
			  GIT_SUBMODULE_STATUS__WD_FLAGS);
Russell Belfer committed
1629

1630
		error = submodule_load_from_wd_lite(sm);
1631
	}
1632

1633 1634
	if (error == 0 && (error = submodule_update_index(sm)) == 0)
		error = submodule_update_head(sm);
1635

1636
	return error;
Russell Belfer committed
1637 1638
}

1639 1640
static void submodule_copy_oid_maybe(
	git_oid *tgt, const git_oid *src, bool valid)
Russell Belfer committed
1641
{
1642 1643 1644 1645 1646 1647 1648
	if (tgt) {
		if (valid)
			memcpy(tgt, src, sizeof(*tgt));
		else
			memset(tgt, 0, sizeof(*tgt));
	}
}
1649

1650 1651 1652 1653 1654 1655 1656 1657 1658 1659
int git_submodule__status(
	unsigned int *out_status,
	git_oid *out_head_id,
	git_oid *out_index_id,
	git_oid *out_wd_id,
	git_submodule *sm,
	git_submodule_ignore_t ign)
{
	unsigned int status;
	git_repository *smrepo = NULL;
Russell Belfer committed
1660

1661
	if (ign == GIT_SUBMODULE_IGNORE_UNSPECIFIED)
1662
		ign = sm->ignore;
1663

1664 1665 1666 1667
	/* only return location info if ignore == all */
	if (ign == GIT_SUBMODULE_IGNORE_ALL) {
		*out_status = (sm->flags & GIT_SUBMODULE_STATUS__IN_FLAGS);
		return 0;
1668
	}
Russell Belfer committed
1669

1670 1671 1672 1673 1674 1675
	/* If the user has requested caching submodule state, performing these
	 * expensive operations (especially `submodule_update_head`, which is
	 * bottlenecked on `git_repository_head_tree`) eliminates much of the
	 * advantage.  We will, therefore, interpret the request for caching to
	 * apply here to and skip them.
	 */
1676

1677 1678 1679 1680 1681 1682 1683 1684 1685
	if (sm->repo->submodule_cache == NULL) {
		/* refresh the index OID */
		if (submodule_update_index(sm) < 0)
			return -1;

		/* refresh the HEAD OID */
		if (submodule_update_head(sm) < 0)
			return -1;
	}
Russell Belfer committed
1686

1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716
	/* for ignore == dirty, don't scan the working directory */
	if (ign == GIT_SUBMODULE_IGNORE_DIRTY) {
		/* git_submodule_open_bare will load WD OID data */
		if (git_submodule_open_bare(&smrepo, sm) < 0)
			giterr_clear();
		else
			git_repository_free(smrepo);
		smrepo = NULL;
	} else if (git_submodule_open(&smrepo, sm) < 0) {
		giterr_clear();
		smrepo = NULL;
	}

	status = GIT_SUBMODULE_STATUS__CLEAR_INTERNAL(sm->flags);

	submodule_get_index_status(&status, sm);
	submodule_get_wd_status(&status, sm, smrepo, ign);

	git_repository_free(smrepo);

	*out_status = status;

	submodule_copy_oid_maybe(out_head_id, &sm->head_oid,
		(sm->flags & GIT_SUBMODULE_STATUS__HEAD_OID_VALID) != 0);
	submodule_copy_oid_maybe(out_index_id, &sm->index_oid,
		(sm->flags & GIT_SUBMODULE_STATUS__INDEX_OID_VALID) != 0);
	submodule_copy_oid_maybe(out_wd_id, &sm->wd_oid,
		(sm->flags & GIT_SUBMODULE_STATUS__WD_OID_VALID) != 0);

	return 0;
Russell Belfer committed
1717 1718
}

1719
int git_submodule_status(unsigned int *status, git_repository *repo, const char *name, git_submodule_ignore_t ignore)
1720
{
1721 1722 1723 1724 1725 1726 1727 1728
	git_submodule *sm;
	int error;

	assert(status && repo && name);

	if ((error = git_submodule_lookup(&sm, repo, name)) < 0)
		return error;

1729
	error = git_submodule__status(status, NULL, NULL, NULL, sm, ignore);
1730
	git_submodule_free(sm);
1731

1732
	return error;
1733
}
1734

1735 1736 1737 1738 1739 1740
int git_submodule_location(unsigned int *location, git_submodule *sm)
{
	assert(location && sm);

	return git_submodule__status(
		location, NULL, NULL, NULL, sm, GIT_SUBMODULE_IGNORE_ALL);
1741 1742
}

Russell Belfer committed
1743 1744 1745 1746
/*
 * INTERNAL FUNCTIONS
 */

1747
static int submodule_alloc(
1748
	git_submodule **out, git_repository *repo, const char *name)
1749
{
1750
	size_t namelen;
1751
	git_submodule *sm;
1752

1753
	if (!name || !(namelen = strlen(name))) {
1754
		giterr_set(GITERR_SUBMODULE, "invalid submodule name");
1755
		return -1;
1756 1757
	}

1758
	sm = git__calloc(1, sizeof(git_submodule));
1759
	GITERR_CHECK_ALLOC(sm);
1760

1761 1762 1763
	sm->name = sm->path = git__strdup(name);
	if (!sm->name) {
		git__free(sm);
1764
		return -1;
1765
	}
Russell Belfer committed
1766

1767
	GIT_REFCOUNT_INC(sm);
1768 1769
	sm->ignore = sm->ignore_default = GIT_SUBMODULE_IGNORE_NONE;
	sm->update = sm->update_default = GIT_SUBMODULE_UPDATE_CHECKOUT;
1770
	sm->fetch_recurse = sm->fetch_recurse_default = GIT_SUBMODULE_RECURSE_NO;
1771
	sm->repo   = repo;
1772
	sm->branch = NULL;
1773

1774 1775
	*out = sm;
	return 0;
Russell Belfer committed
1776 1777
}

1778
static void submodule_release(git_submodule *sm)
Russell Belfer committed
1779 1780 1781 1782
{
	if (!sm)
		return;

1783
	if (sm->repo) {
1784
		sm->repo = NULL;
1785 1786
	}

1787 1788 1789 1790
	if (sm->path != sm->name)
		git__free(sm->path);
	git__free(sm->name);
	git__free(sm->url);
1791
	git__free(sm->branch);
1792 1793 1794
	git__memzero(sm, sizeof(*sm));
	git__free(sm);
}
Russell Belfer committed
1795

1796 1797 1798 1799 1800
void git_submodule_free(git_submodule *sm)
{
	if (!sm)
		return;
	GIT_REFCOUNT_DEC(sm, submodule_release);
Russell Belfer committed
1801 1802
}

1803 1804 1805
static int submodule_config_error(const char *property, const char *value)
{
	giterr_set(GITERR_INVALID,
1806
		"invalid value for submodule '%s' property: '%s'", property, value);
1807
	return -1;
1808 1809
}

1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837
int git_submodule_parse_ignore(git_submodule_ignore_t *out, const char *value)
{
	int val;

	if (git_config_lookup_map_value(
			&val, _sm_ignore_map, ARRAY_SIZE(_sm_ignore_map), value) < 0) {
		*out = GIT_SUBMODULE_IGNORE_NONE;
		return submodule_config_error("ignore", value);
	}

	*out = (git_submodule_ignore_t)val;
	return 0;
}

int git_submodule_parse_update(git_submodule_update_t *out, const char *value)
{
	int val;

	if (git_config_lookup_map_value(
			&val, _sm_update_map, ARRAY_SIZE(_sm_update_map), value) < 0) {
		*out = GIT_SUBMODULE_UPDATE_CHECKOUT;
		return submodule_config_error("update", value);
	}

	*out = (git_submodule_update_t)val;
	return 0;
}

1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851
int git_submodule_parse_recurse(git_submodule_recurse_t *out, const char *value)
{
	int val;

	if (git_config_lookup_map_value(
			&val, _sm_recurse_map, ARRAY_SIZE(_sm_recurse_map), value) < 0) {
		*out = GIT_SUBMODULE_RECURSE_YES;
		return submodule_config_error("recurse", value);
	}

	*out = (git_submodule_recurse_t)val;
	return 0;
}

1852
static int get_value(const char **out, git_config *cfg, git_buf *buf, const char *name, const char *field)
1853
{
1854
	int error;
1855

1856
	git_buf_clear(buf);
1857

1858 1859 1860
	if ((error = git_buf_printf(buf, "submodule.%s.%s", name, field)) < 0 ||
	    (error = git_config_get_string(out, cfg, buf->ptr)) < 0)
		return error;
1861

1862 1863
	return error;
}
1864

1865 1866 1867 1868 1869
static int submodule_read_config(git_submodule *sm, git_config *cfg)
{
	git_buf key = GIT_BUF_INIT;
	const char *value;
	int error, in_config = 0;
Russell Belfer committed
1870

1871 1872 1873
	/*
	 * TODO: Look up path in index and if it is present but not a GITLINK
	 * then this should be deleted (at least to match git's behavior)
1874
	 */
1875

1876 1877 1878 1879
	if ((error = get_value(&value, cfg, &key, sm->name, "path")) == 0) {
		in_config = 1;
	/*
	 * TODO: if case insensitive filesystem, then the following strcmp
1880 1881
	 * should be strcasecmp
	 */
1882
		if (strcmp(sm->name, value) != 0) {
Carlos Martín Nieto committed
1883 1884
			if (sm->path != sm->name)
				git__free(sm->path);
1885 1886
			sm->path = git__strdup(value);
			GITERR_CHECK_ALLOC(sm->path);
1887
		}
1888
	} else if (error != GIT_ENOTFOUND) {
1889
		goto cleanup;
1890
	}
1891

1892 1893 1894 1895 1896
	if ((error = get_value(&value, cfg, &key, sm->name, "url")) == 0) {
		in_config = 1;
		sm->url = git__strdup(value);
		GITERR_CHECK_ALLOC(sm->url);
	} else if (error != GIT_ENOTFOUND) {
1897
		goto cleanup;
1898 1899
	}

1900 1901 1902 1903 1904
	if ((error = get_value(&value, cfg, &key, sm->name, "branch")) == 0) {
		in_config = 1;
		sm->branch = git__strdup(value);
		GITERR_CHECK_ALLOC(sm->branch);
	} else if (error != GIT_ENOTFOUND) {
1905
		goto cleanup;
1906
	}
1907

1908 1909
	if ((error = get_value(&value, cfg, &key, sm->name, "update")) == 0) {
		in_config = 1;
1910
		if ((error = git_submodule_parse_update(&sm->update, value)) < 0)
1911
			goto cleanup;
1912
		sm->update_default = sm->update;
1913
	} else if (error != GIT_ENOTFOUND) {
1914
		goto cleanup;
1915
	}
1916 1917 1918

	if ((error = get_value(&value, cfg, &key, sm->name, "fetchRecurseSubmodules")) == 0) {
		in_config = 1;
1919
		if ((error = git_submodule_parse_recurse(&sm->fetch_recurse, value)) < 0)
1920
			goto cleanup;
1921
		sm->fetch_recurse_default = sm->fetch_recurse;
1922
	} else if (error != GIT_ENOTFOUND) {
1923
		goto cleanup;
1924
	}
1925 1926 1927

	if ((error = get_value(&value, cfg, &key, sm->name, "ignore")) == 0) {
		in_config = 1;
1928
		if ((error = git_submodule_parse_ignore(&sm->ignore, value)) < 0)
1929
			goto cleanup;
1930
		sm->ignore_default = sm->ignore;
1931
	} else if (error != GIT_ENOTFOUND) {
1932
		goto cleanup;
1933
	}
1934 1935 1936 1937

	if (in_config)
		sm->flags |= GIT_SUBMODULE_STATUS_IN_CONFIG;

1938 1939 1940 1941 1942
	error = 0;

cleanup:
	git_buf_free(&key);
	return error;
1943 1944 1945 1946 1947 1948 1949 1950 1951 1952
}

static int submodule_load_each(const git_config_entry *entry, void *payload)
{
	lfc_data *data = payload;
	const char *namestart, *property;
	git_strmap_iter pos;
	git_strmap *map = data->map;
	git_buf name = GIT_BUF_INIT;
	git_submodule *sm;
1953
	int error, isvalid;
1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968

	if (git__prefixcmp(entry->name, "submodule.") != 0)
		return 0;

	namestart = entry->name + strlen("submodule.");
	property  = strrchr(namestart, '.');

	if (!property || (property == namestart))
		return 0;

	property++;

	if ((error = git_buf_set(&name, namestart, property - namestart -1)) < 0)
		return error;

1969 1970 1971
	isvalid = git_submodule_name_is_valid(data->repo, name.ptr, 0);
	if (isvalid <= 0) {
		error = isvalid;
1972 1973 1974
		goto done;
	}

1975 1976 1977 1978 1979 1980 1981
	/*
	 * Now that we have the submodule's name, we can use that to
	 * figure out whether it's in the map. If it's not, we create
	 * a new submodule, load the config and insert it. If it's
	 * already inserted, we've already loaded it, so we skip.
	 */
	pos = git_strmap_lookup_index(map, name.ptr);
1982 1983 1984 1985
	if (git_strmap_valid_index(map, pos)) {
		error = 0;
		goto done;
	}
1986 1987 1988 1989 1990 1991 1992 1993 1994

	if ((error = submodule_alloc(&sm, data->repo, name.ptr)) < 0)
		goto done;

	if ((error = submodule_read_config(sm, data->mods)) < 0) {
		git_submodule_free(sm);
		goto done;
	}

1995
	git_strmap_insert(map, sm->name, sm, &error);
1996 1997 1998 1999 2000
	assert(error != 0);
	if (error < 0)
		goto done;

	error = 0;
2001

2002 2003
done:
	git_buf_free(&name);
2004
	return error;
2005 2006
}

2007
static int submodule_load_from_wd_lite(git_submodule *sm)
Russell Belfer committed
2008 2009 2010
{
	git_buf path = GIT_BUF_INIT;

2011
	if (git_buf_joinpath(&path, git_repository_workdir(sm->repo), sm->path) < 0)
2012
		return -1;
Russell Belfer committed
2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023

	if (git_path_isdir(path.ptr))
		sm->flags |= GIT_SUBMODULE_STATUS__WD_SCANNED;

	if (git_path_contains(&path, DOT_GIT))
		sm->flags |= GIT_SUBMODULE_STATUS_IN_WD;

	git_buf_free(&path);
	return 0;
}

2024
/**
2025
 * Requests a snapshot of $WORK_TREE/.gitmodules.
2026
 *
2027
 * Returns GIT_ENOTFOUND in case no .gitmodules file exist
2028
 */
2029
static int gitmodules_snapshot(git_config **snap, git_repository *repo)
2030 2031
{
	const char *workdir = git_repository_workdir(repo);
2032
	git_config *mods = NULL;
2033
	git_buf path = GIT_BUF_INIT;
2034
	int error;
2035

2036 2037
	if (!workdir)
		return GIT_ENOTFOUND;
2038

2039 2040
	if ((error = git_buf_joinpath(&path, workdir, GIT_MODULES_FILE)) < 0)
		return error;
2041

2042 2043 2044 2045 2046 2047 2048
	if ((error = git_config_open_ondisk(&mods, path.ptr)) < 0)
		goto cleanup;

	if ((error = git_config_snapshot(snap, mods)) < 0)
		goto cleanup;

	error = 0;
2049

2050 2051
cleanup:
	if (mods)
2052
		git_config_free(mods);
2053
	git_buf_free(&path);
2054

2055
	return error;
2056 2057
}

Ben Straub committed
2058
static git_config_backend *open_gitmodules(
2059
	git_repository *repo,
2060
	int okay_to_create)
Russell Belfer committed
2061
{
2062
	const char *workdir = git_repository_workdir(repo);
Russell Belfer committed
2063
	git_buf path = GIT_BUF_INIT;
Ben Straub committed
2064
	git_config_backend *mods = NULL;
Russell Belfer committed
2065 2066 2067 2068 2069 2070 2071 2072

	if (workdir != NULL) {
		if (git_buf_joinpath(&path, workdir, GIT_MODULES_FILE) != 0)
			return NULL;

		if (okay_to_create || git_path_isfile(path.ptr)) {
			/* git_config_file__ondisk should only fail if OOM */
			if (git_config_file__ondisk(&mods, path.ptr) < 0)
2073
				mods = NULL;
Russell Belfer committed
2074
			/* open should only fail here if the file is malformed */
2075
			else if (git_config_file_open(mods, GIT_CONFIG_LEVEL_LOCAL, repo) < 0) {
Russell Belfer committed
2076 2077 2078
				git_config_file_free(mods);
				mods = NULL;
			}
2079 2080 2081
		}
	}

2082 2083
	git_buf_free(&path);

Russell Belfer committed
2084 2085 2086
	return mods;
}

Russell Belfer committed
2087 2088
/* Lookup name of remote of the local tracking branch HEAD points to */
static int lookup_head_remote_key(git_buf *remote_name, git_repository *repo)
2089
{
Russell Belfer committed
2090
	int error;
Russell Belfer committed
2091 2092 2093 2094 2095 2096 2097
	git_reference *head = NULL;
	git_buf upstream_name = GIT_BUF_INIT;

	/* lookup and dereference HEAD */
	if ((error = git_repository_head(&head, repo)) < 0)
		return error;

2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109
	/**
	 * If head does not refer to a branch, then return
	 * GIT_ENOTFOUND to indicate that we could not find
	 * a remote key for the local tracking branch HEAD points to.
	 **/
	if (!git_reference_is_branch(head)) {
		giterr_set(GITERR_INVALID,
			"HEAD does not refer to a branch.");
		error = GIT_ENOTFOUND;
		goto done;
	}

Russell Belfer committed
2110
	/* lookup remote tracking branch of HEAD */
2111 2112 2113 2114 2115
	if ((error = git_branch_upstream_name(
		&upstream_name,
		repo,
		git_reference_name(head))) < 0)
		goto done;
Russell Belfer committed
2116

2117 2118 2119
	/* lookup remote of remote tracking branch */
	if ((error = git_branch_remote_name(remote_name, repo, upstream_name.ptr)) < 0)
		goto done;
Russell Belfer committed
2120

2121 2122
done:
	git_buf_free(&upstream_name);
Russell Belfer committed
2123
	git_reference_free(head);
2124

2125 2126
	return error;
}
2127

Russell Belfer committed
2128 2129
/* Lookup the remote of the local tracking branch HEAD points to */
static int lookup_head_remote(git_remote **remote, git_repository *repo)
2130 2131
{
	int error;
Russell Belfer committed
2132
	git_buf remote_name = GIT_BUF_INIT;
2133

Russell Belfer committed
2134 2135
	/* lookup remote of remote tracking branch name */
	if (!(error = lookup_head_remote_key(&remote_name, repo)))
2136
		error = git_remote_lookup(remote, repo, remote_name.ptr);
2137

Russell Belfer committed
2138
	git_buf_free(&remote_name);
Russell Belfer committed
2139

2140 2141
	return error;
}
Russell Belfer committed
2142

Russell Belfer committed
2143 2144
/* Lookup remote, either from HEAD or fall back on origin */
static int lookup_default_remote(git_remote **remote, git_repository *repo)
2145
{
Russell Belfer committed
2146
	int error = lookup_head_remote(remote, repo);
Russell Belfer committed
2147

Russell Belfer committed
2148 2149
	/* if that failed, use 'origin' instead */
	if (error == GIT_ENOTFOUND)
2150
		error = git_remote_lookup(remote, repo, "origin");
Russell Belfer committed
2151

Russell Belfer committed
2152 2153 2154
	if (error == GIT_ENOTFOUND)
		giterr_set(
			GITERR_SUBMODULE,
2155
			"cannot get default remote for submodule - no local tracking "
Russell Belfer committed
2156
			"branch for HEAD and origin does not exist");
Russell Belfer committed
2157 2158

	return error;
2159 2160
}

Russell Belfer committed
2161
static int get_url_base(git_buf *url, git_repository *repo)
2162 2163
{
	int error;
2164
	git_worktree *wt = NULL;
Russell Belfer committed
2165
	git_remote *remote = NULL;
2166

2167
	if ((error = lookup_default_remote(&remote, repo)) == 0) {
Russell Belfer committed
2168
		error = git_buf_sets(url, git_remote_url(remote));
2169 2170 2171 2172
		goto out;
	} else if (error != GIT_ENOTFOUND)
		goto out;
	else
Russell Belfer committed
2173
		giterr_clear();
2174 2175 2176 2177 2178 2179 2180

	/* if repository does not have a default remote, use workdir instead */
	if (git_repository_is_worktree(repo)) {
		if ((error = git_worktree_open_from_repository(&wt, repo)) < 0)
			goto out;
		error = git_buf_sets(url, wt->parent_path);
	} else
Russell Belfer committed
2181
		error = git_buf_sets(url, git_repository_workdir(repo));
2182 2183 2184 2185

out:
	git_remote_free(remote);
	git_worktree_free(wt);
2186 2187 2188 2189

	return error;
}

2190
static void submodule_get_index_status(unsigned int *status, git_submodule *sm)
Russell Belfer committed
2191
{
2192 2193
	const git_oid *head_oid  = git_submodule_head_id(sm);
	const git_oid *index_oid = git_submodule_index_id(sm);
Russell Belfer committed
2194

2195 2196
	*status = *status & ~GIT_SUBMODULE_STATUS__INDEX_FLAGS;

2197 2198 2199 2200 2201 2202 2203 2204
	if (!head_oid) {
		if (index_oid)
			*status |= GIT_SUBMODULE_STATUS_INDEX_ADDED;
	}
	else if (!index_oid)
		*status |= GIT_SUBMODULE_STATUS_INDEX_DELETED;
	else if (!git_oid_equal(head_oid, index_oid))
		*status |= GIT_SUBMODULE_STATUS_INDEX_MODIFIED;
Russell Belfer committed
2205 2206
}

2207

2208 2209 2210 2211 2212
static void submodule_get_wd_status(
	unsigned int *status,
	git_submodule *sm,
	git_repository *sm_repo,
	git_submodule_ignore_t ign)
2213
{
2214 2215 2216 2217
	const git_oid *index_oid = git_submodule_index_id(sm);
	const git_oid *wd_oid =
		(sm->flags & GIT_SUBMODULE_STATUS__WD_OID_VALID) ? &sm->wd_oid : NULL;
	git_tree *sm_head = NULL;
2218
	git_index *index = NULL;
2219
	git_diff_options opt = GIT_DIFF_OPTIONS_INIT;
2220
	git_diff *diff;
2221

2222
	*status = *status & ~GIT_SUBMODULE_STATUS__WD_FLAGS;
Russell Belfer committed
2223

2224 2225 2226
	if (!index_oid) {
		if (wd_oid)
			*status |= GIT_SUBMODULE_STATUS_WD_ADDED;
Russell Belfer committed
2227
	}
2228 2229 2230 2231 2232 2233
	else if (!wd_oid) {
		if ((sm->flags & GIT_SUBMODULE_STATUS__WD_SCANNED) != 0 &&
			(sm->flags & GIT_SUBMODULE_STATUS_IN_WD) == 0)
			*status |= GIT_SUBMODULE_STATUS_WD_UNINITIALIZED;
		else
			*status |= GIT_SUBMODULE_STATUS_WD_DELETED;
Russell Belfer committed
2234
	}
2235 2236
	else if (!git_oid_equal(index_oid, wd_oid))
		*status |= GIT_SUBMODULE_STATUS_WD_MODIFIED;
Russell Belfer committed
2237

2238 2239 2240
	/* if we have no repo, then we're done */
	if (!sm_repo)
		return;
2241

2242 2243 2244 2245
	/* the diffs below could be optimized with an early termination
	 * option to the git_diff functions, but for now this is sufficient
	 * (and certainly no worse that what core git does).
	 */
2246

2247 2248
	if (ign == GIT_SUBMODULE_IGNORE_NONE)
		opt.flags |= GIT_DIFF_INCLUDE_UNTRACKED;
Russell Belfer committed
2249

2250 2251
	(void)git_repository_index__weakptr(&index, sm_repo);

2252
	/* if we don't have an unborn head, check diff with index */
2253 2254 2255 2256
	if (git_repository_head_tree(&sm_head, sm_repo) < 0)
		giterr_clear();
	else {
		/* perform head to index diff on submodule */
2257
		if (git_diff_tree_to_index(&diff, sm_repo, sm_head, index, &opt) < 0)
2258 2259
			giterr_clear();
		else {
2260
			if (git_diff_num_deltas(diff) > 0)
2261
				*status |= GIT_SUBMODULE_STATUS_WD_INDEX_MODIFIED;
2262
			git_diff_free(diff);
2263 2264
			diff = NULL;
		}
Russell Belfer committed
2265

2266
		git_tree_free(sm_head);
2267
	}
2268

2269
	/* perform index-to-workdir diff on submodule */
2270
	if (git_diff_index_to_workdir(&diff, sm_repo, index, &opt) < 0)
2271 2272 2273 2274
		giterr_clear();
	else {
		size_t untracked =
			git_diff_num_deltas_of_type(diff, GIT_DELTA_UNTRACKED);
2275

2276 2277
		if (untracked > 0)
			*status |= GIT_SUBMODULE_STATUS_WD_UNTRACKED;
2278

2279 2280
		if (git_diff_num_deltas(diff) != untracked)
			*status |= GIT_SUBMODULE_STATUS_WD_WD_MODIFIED;
Russell Belfer committed
2281

2282
		git_diff_free(diff);
2283
		diff = NULL;
2284
	}
2285
}