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

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

#define GIT_MODULES_FILE ".gitmodules"
27

28 29 30
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
31 32
	{GIT_CVAR_STRING, "merge", GIT_SUBMODULE_UPDATE_MERGE},
	{GIT_CVAR_STRING, "none", GIT_SUBMODULE_UPDATE_NONE},
33 34
	{GIT_CVAR_FALSE, NULL, GIT_SUBMODULE_UPDATE_NONE},
	{GIT_CVAR_TRUE, NULL, GIT_SUBMODULE_UPDATE_CHECKOUT},
35 36
};

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

46 47 48 49 50 51
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},
};

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

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

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

70
	return h;
71 72
}

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

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

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

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

91 92
static int submodule_alloc(git_submodule **out, git_repository *repo, const char *name);
static git_config_backend *open_gitmodules(git_repository *repo, int gitmod);
93
static git_config *gitmodules_snapshot(git_repository *repo);
94 95
static int get_url_base(git_buf *url, git_repository *repo);
static int lookup_head_remote_key(git_buf *remote_key, git_repository *repo);
96 97
static int submodule_load_each(const git_config_entry *entry, void *payload);
static int submodule_read_config(git_submodule *sm, git_config *cfg);
98
static int submodule_load_from_wd_lite(git_submodule *);
99 100
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);
101 102
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
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119

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
 */

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

	giterr_set(GITERR_SUBMODULE, (error == GIT_ENOTFOUND) ?
		"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
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;
}

150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
/**
 * Find out the name of a submodule from its path
 */
static int name_from_path(git_buf *out, git_config *cfg, const char *path)
{
	const char *key = "submodule\\..*\\.path";
	git_config_iterator *iter;
	git_config_entry *entry;
	int error;

	if ((error = git_config_iterator_glob_new(&iter, cfg, key)) < 0)
		return error;

	while ((error = git_config_next(&entry, iter)) == 0) {
		const char *fdot, *ldot;
		/* TODO: this should maybe be strcasecmp on a case-insensitive fs */
		if (strcmp(path, entry->value) != 0)
			continue;

		fdot = strchr(entry->name, '.');
		ldot = strrchr(entry->name, '.');

		git_buf_clear(out);
		git_buf_put(out, fdot + 1, ldot - fdot - 1);
174
		goto cleanup;
175 176 177 178 179 180 181
	}

	if (error == GIT_ITEROVER) {
		giterr_set(GITERR_SUBMODULE, "could not find a submodule name for '%s'", path);
		error = GIT_ENOTFOUND;
	}

182 183
cleanup:
	git_config_iterator_free(iter);
184 185 186
	return error;
}

187
int git_submodule_lookup(
188 189 190 191 192
	git_submodule **out, /* NULL if user only wants to test existence */
	git_repository *repo,
	const char *name)    /* trailing slash is allowed */
{
	int error;
193
	unsigned int location;
194
	git_submodule *sm;
195 196 197

	assert(repo && name);

198 199
	if ((error = submodule_alloc(&sm, repo, name)) < 0)
		return error;
Russell Belfer committed
200

201 202
	if ((error = git_submodule_reload(sm, false)) < 0) {
		git_submodule_free(sm);
Russell Belfer committed
203
		return error;
204
	}
Russell Belfer committed
205

206 207 208 209 210
	if ((error = git_submodule_location(&location, sm)) < 0) {
		git_submodule_free(sm);
		return error;
	}

211
	/* If it's not configured or we're looking by path  */
212 213
	if (location == 0 || location == GIT_SUBMODULE_STATUS_IN_WD) {
		git_config_backend *mods;
214
		const char *pattern = "submodule\\..*\\.path";
215 216 217 218 219 220 221 222
		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;
223

224 225 226 227 228 229 230 231 232
		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
233
			git_buf_free(&path);
234
			return error;
235
		}
236 237 238 239

		if (data.name) {
			git__free(sm->name);
			sm->name = data.name;
240
			sm->path = git_buf_detach(&path);
241 242 243 244 245 246 247

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

		git_buf_free(&path);
250 251
	}

252 253 254 255 256 257 258
	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) {
259 260
		git_submodule_free(sm);
		error = GIT_ENOTFOUND;
Russell Belfer committed
261

262
		/* If it's not configured, we still check if there's a repo at the path */
Russell Belfer committed
263 264
		if (git_repository_workdir(repo)) {
			git_buf path = GIT_BUF_INIT;
265
			if (git_buf_join3(&path,
266
					  '/', git_repository_workdir(repo), name, DOT_GIT) < 0)
Russell Belfer committed
267 268
				return -1;

269
			if (git_path_exists(path.ptr))
Russell Belfer committed
270 271 272 273 274
				error = GIT_EEXISTS;

			git_buf_free(&path);
		}

275
		submodule_set_lookup_error(error, name);
276
		return error;
Russell Belfer committed
277 278
	}

279 280 281 282 283 284
	if (out)
		*out = sm;
	else
		git_submodule_free(sm);

	return 0;
Russell Belfer committed
285
}
286

287 288 289 290 291
static void submodule_free_dup(void *sm)
{
	git_submodule_free(sm);
}

292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
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;

	pos = kh_put(str, map, sm->name, &error);
	/* 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;
}

324
static int submodules_from_index(git_strmap *map, git_index *idx, git_config *cfg)
325 326 327 328
{
       int error;
       git_iterator *i;
       const git_index_entry *entry;
329
       git_buf name = GIT_BUF_INIT;
330

331
       if ((error = git_iterator_for_index(&i, git_index_owner(idx), idx, NULL)) < 0)
332 333 334 335 336 337
               return error;

       while (!(error = git_iterator_advance(&entry, i))) {
               khiter_t pos = git_strmap_lookup_index(map, entry->path);
               git_submodule *sm;

338 339 340 341 342
	       git_buf_clear(&name);
	       if (!name_from_path(&name, cfg, entry->path)) {
		       git_strmap_lookup_index(map, name.ptr);
	       }

343 344 345 346 347 348 349 350
               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)) {
351
                       if (!submodule_get_or_create(&sm, git_index_owner(idx), map, name.ptr ? name.ptr : entry->path)) {
352 353 354 355 356 357 358 359 360
                               submodule_update_from_index_entry(sm, entry);
                               git_submodule_free(sm);
                       }
               }
       }

       if (error == GIT_ITEROVER)
               error = 0;

361
       git_buf_free(&name);
362 363 364 365 366
       git_iterator_free(i);

       return error;
}

367
static int submodules_from_head(git_strmap *map, git_tree *head, git_config *cfg)
368 369 370 371
{
       int error;
       git_iterator *i;
       const git_index_entry *entry;
372
       git_buf name = GIT_BUF_INIT;
373

374
       if ((error = git_iterator_for_tree(&i, head, NULL)) < 0)
375 376 377 378 379 380
               return error;

       while (!(error = git_iterator_advance(&entry, i))) {
               khiter_t pos = git_strmap_lookup_index(map, entry->path);
               git_submodule *sm;

381 382 383 384 385
	       git_buf_clear(&name);
	       if (!name_from_path(&name, cfg, entry->path)) {
		       git_strmap_lookup_index(map, name.ptr);
	       }

386 387 388 389 390 391 392 393
               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)) {
394
                       if (!submodule_get_or_create(&sm, git_tree_owner(head), map, name.ptr ? name.ptr : entry->path)) {
395 396 397 398 399 400 401 402 403 404
                               submodule_update_from_head_data(
                                       sm, entry->mode, &entry->id);
                               git_submodule_free(sm);
                       }
               }
       }

       if (error == GIT_ITEROVER)
               error = 0;

405
       git_buf_free(&name);
406 407 408 409 410 411 412
       git_iterator_free(i);

       return error;
}

/* If have_sm is true, sm is populated, otherwise map an repo are. */
typedef struct {
413
	git_config *mods;
414 415 416 417 418 419 420 421 422 423 424 425
	git_strmap *map;
	git_repository *repo;
} lfc_data;

static int all_submodules(git_repository *repo, git_strmap *map)
{
	int error = 0;
	git_index *idx = NULL;
	git_tree *head = NULL;
	const char *wd = NULL;
	git_buf path = GIT_BUF_INIT;
	git_submodule *sm;
426
	git_config *mods = NULL;
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
	uint32_t mask;

	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;

	/* clear submodule flags that are to be refreshed */
	mask = 0;
	mask |= GIT_SUBMODULE_STATUS_IN_INDEX |
		GIT_SUBMODULE_STATUS__INDEX_FLAGS |
		GIT_SUBMODULE_STATUS__INDEX_OID_VALID |
		GIT_SUBMODULE_STATUS__INDEX_MULTIPLE_ENTRIES;

	mask |= GIT_SUBMODULE_STATUS_IN_HEAD |
		GIT_SUBMODULE_STATUS__HEAD_OID_VALID;
	mask |= GIT_SUBMODULE_STATUS_IN_CONFIG;
	if (mask != 0)
		mask |= GIT_SUBMODULE_STATUS_IN_WD |
			GIT_SUBMODULE_STATUS__WD_SCANNED |
			GIT_SUBMODULE_STATUS__WD_FLAGS |
			GIT_SUBMODULE_STATUS__WD_OID_VALID;

457 458 459 460 461 462 463 464 465 466 467 468 469 470
	/* add submodule information from .gitmodules */
	if (wd) {
		lfc_data data = { 0 };
		data.map = map;
		data.repo = repo;

		if ((mods = gitmodules_snapshot(repo)) == NULL)
			goto cleanup;

		data.mods = mods;
		if ((error = git_config_foreach(
			    mods, submodule_load_each, &data)) < 0)
			goto cleanup;
	}
471 472
	/* add back submodule information from index */
	if (idx) {
473
		if ((error = submodules_from_index(map, idx, mods)) < 0)
474 475 476 477
			goto cleanup;
	}
	/* add submodule information from HEAD */
	if (head) {
478
		if ((error = submodules_from_head(map, head, mods)) < 0)
479 480 481 482 483 484 485 486 487 488
			goto cleanup;
	}
	/* shallow scan submodules in work tree as needed */
	if (wd && mask != 0) {
		git_strmap_foreach_value(map, sm, {
				submodule_load_from_wd_lite(sm);
			});
	}

cleanup:
489
	git_config_free(mods);
490 491 492 493 494 495 496
	/* 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
497 498
int git_submodule_foreach(
	git_repository *repo,
499
	git_submodule_cb callback,
Russell Belfer committed
500 501
	void *payload)
{
502 503 504
	git_vector snapshot = GIT_VECTOR_INIT;
	git_strmap *submodules;
	git_submodule *sm;
Russell Belfer committed
505
	int error;
506
	size_t i;
Russell Belfer committed
507

508
	if ((error = git_strmap_alloc(&submodules)) < 0)
Russell Belfer committed
509 510
		return error;

511 512
	if ((error = all_submodules(repo, submodules)) < 0)
		goto done;
513 514

	if (!(error = git_vector_init(
515
			&snapshot, kh_size(submodules), submodule_cmp))) {
516

517
		git_strmap_foreach_value(submodules, sm, {
518
			if ((error = git_vector_insert(&snapshot, sm)) < 0)
Russell Belfer committed
519
				break;
520 521 522 523 524 525 526 527 528 529
			GIT_REFCOUNT_INC(sm);
		});
	}

	if (error < 0)
		goto done;

	git_vector_uniq(&snapshot, submodule_free_dup);

	git_vector_foreach(&snapshot, i, sm) {
530
		if ((error = callback(sm, sm->name, payload)) != 0) {
531
			giterr_set_after_callback(error);
Russell Belfer committed
532
			break;
533
		}
534
	}
Russell Belfer committed
535

536 537 538 539
done:
	git_vector_foreach(&snapshot, i, sm)
		git_submodule_free(sm);
	git_vector_free(&snapshot);
Russell Belfer committed
540

541 542 543 544
	git_strmap_foreach_value(submodules, sm, {
		git_submodule_free(sm);
	});
	git_strmap_free(submodules);
Russell Belfer committed
545

546
	return error;
Russell Belfer committed
547 548
}

549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
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) {
		error = git_buf_join3(
			&repodir, '/', git_repository_path(parent_repo), "modules", path);
		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
599
int git_submodule_add_setup(
600
	git_submodule **out,
Russell Belfer committed
601 602 603 604 605 606
	git_repository *repo,
	const char *url,
	const char *path,
	int use_gitlink)
{
	int error = 0;
Ben Straub committed
607
	git_config_backend *mods = NULL;
608
	git_submodule *sm = NULL;
Russell Belfer committed
609 610 611 612 613 614 615
	git_buf name = GIT_BUF_INIT, real_url = GIT_BUF_INIT;
	git_repository *subrepo = NULL;

	assert(repo && url && path);

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

616
	if (git_submodule_lookup(NULL, repo, path) < 0)
Russell Belfer committed
617 618 619
		giterr_clear();
	else {
		giterr_set(GITERR_SUBMODULE,
620
			"Attempt to add submodule '%s' that already exists", path);
Russell Belfer committed
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
		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) {
		giterr_set(GITERR_SUBMODULE, "Submodule path must be a relative path");
		error = -1;
		goto cleanup;
	}

	/* update .gitmodules */

637
	if (!(mods = open_gitmodules(repo, GITMODULES_CREATE))) {
Russell Belfer committed
638
		giterr_set(GITERR_SUBMODULE,
639
			"Adding submodules to a bare repository is not supported");
Russell Belfer committed
640 641 642 643 644 645 646 647
		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 ||
648
		(error = git_config_file_set_string(mods, name.ptr, url)) < 0)
Russell Belfer committed
649 650 651 652 653 654 655 656 657 658
		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;

659 660
	/* if the repo does not already exist, then init a new repo and add it.
	 * Otherwise, just add the existing repo.
Russell Belfer committed
661
	 */
662 663
	if (!(git_path_exists(name.ptr) &&
		git_path_contains(&name, DOT_GIT))) {
664 665 666 667 668 669

		/* 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
670 671 672
			goto cleanup;
	}

673
	if ((error = git_submodule_lookup(&sm, repo, path)) < 0)
674
		goto cleanup;
Russell Belfer committed
675

676
	error = git_submodule_init(sm, false);
677

Russell Belfer committed
678
cleanup:
679 680 681 682 683 684
	if (error && sm) {
		git_submodule_free(sm);
		sm = NULL;
	}
	if (out != NULL)
		*out = sm;
Russell Belfer committed
685

686
	git_config_file_free(mods);
Russell Belfer committed
687 688 689 690 691 692 693
	git_repository_free(subrepo);
	git_buf_free(&real_url);
	git_buf_free(&name);

	return error;
}

694 695 696 697 698 699 700
int git_submodule_repo_init(
	git_repository **out,
	const git_submodule *sm,
	int use_gitlink)
{
	int error;
	git_repository *sub_repo = NULL;
701 702 703
	const char *configured_url;
	git_config *cfg = NULL;
	git_buf buf = GIT_BUF_INIT;
704 705 706

	assert(out && sm);

707 708
	/* get the configured remote url of the submodule */
	if ((error = git_buf_printf(&buf, "submodule.%s.url", sm->name)) < 0 ||
709
		(error = git_repository_config_snapshot(&cfg, sm->repo)) < 0 ||
710 711 712
		(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;
713 714 715

	*out = sub_repo;

716 717 718
done:
	git_config_free(cfg);
	git_buf_free(&buf);
719 720 721
	return error;
}

Russell Belfer committed
722 723 724 725 726 727 728
int git_submodule_add_finalize(git_submodule *sm)
{
	int error;
	git_index *index;

	assert(sm);

729
	if ((error = git_repository_index__weakptr(&index, sm->repo)) < 0 ||
730
		(error = git_index_add_bypath(index, GIT_MODULES_FILE)) < 0)
Russell Belfer committed
731 732
		return error;

733
	return git_submodule_add_to_index(sm, true);
Russell Belfer committed
734 735
}

736
int git_submodule_add_to_index(git_submodule *sm, int write_index)
Russell Belfer committed
737 738
{
	int error;
739
	git_repository *sm_repo = NULL;
Russell Belfer committed
740 741 742 743 744 745 746 747
	git_index *index;
	git_buf path = GIT_BUF_INIT;
	git_commit *head;
	git_index_entry entry;
	struct stat st;

	assert(sm);

748 749 750
	/* force reload of wd OID by git_submodule_open */
	sm->flags = sm->flags & ~GIT_SUBMODULE_STATUS__WD_OID_VALID;

751
	if ((error = git_repository_index__weakptr(&index, sm->repo)) < 0 ||
Russell Belfer committed
752
		(error = git_buf_joinpath(
753
			&path, git_repository_workdir(sm->repo), sm->path)) < 0 ||
Russell Belfer committed
754 755 756 757 758 759 760 761 762 763
		(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,
			"Cannot add submodule without working directory");
		error = -1;
		goto cleanup;
	}
764 765

	memset(&entry, 0, sizeof(entry));
766
	entry.path = sm->path;
767 768
	git_index_entry__init_from_stat(
		&entry, &st, !(git_index_caps(index) & GIT_INDEXCAP_NO_FILEMODE));
Russell Belfer committed
769 770 771 772 773 774 775 776

	/* 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,
			"Cannot add submodule without HEAD to index");
		error = -1;
		goto cleanup;
	}
777
	git_oid_cpy(&entry.id, &sm->wd_oid);
Russell Belfer committed
778 779 780 781

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

782
	entry.ctime.seconds = (int32_t)git_commit_time(head);
Russell Belfer committed
783
	entry.ctime.nanoseconds = 0;
784
	entry.mtime.seconds = (int32_t)git_commit_time(head);
Russell Belfer committed
785 786 787 788
	entry.mtime.nanoseconds = 0;

	git_commit_free(head);

789
	/* add it */
Edward Thomson committed
790
	error = git_index_add(index, &entry);
Russell Belfer committed
791

792 793 794 795 796 797 798 799
	/* 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
800 801 802 803 804 805
cleanup:
	git_repository_free(sm_repo);
	git_buf_free(&path);
	return error;
}

806 807 808 809
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)
810
		if (_sm_update_map[i].map_value == (int)update)
811 812 813 814
			return _sm_update_map[i].str_match;
	return NULL;
}

Russell Belfer committed
815 816 817
git_repository *git_submodule_owner(git_submodule *submodule)
{
	assert(submodule);
818
	return submodule->repo;
Russell Belfer committed
819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
}

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;
}

839 840 841
int git_submodule_resolve_url(git_buf *out, git_repository *repo, const char *url)
{
	int error = 0;
842
	git_buf normalized = GIT_BUF_INIT;
843

844 845 846
	assert(out && repo && url);

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

848
	/* We do this in all platforms in case someone on Windows created the .gitmodules */
849
	if (strchr(url, '\\')) {
850
		if ((error = git_path_normalize_slashes(&normalized, url)) < 0)
851 852 853 854 855
			return error;

		url = normalized.ptr;
	}

856

857
	if (git_path_is_relative(url)) {
858
		if (!(error = get_url_base(out, repo)))
859 860 861 862 863 864 865 866
			error = git_path_apply_relative(out, url);
	} else if (strchr(url, ':') != NULL || url[0] == '/') {
		error = git_buf_sets(out, url);
	} else {
		giterr_set(GITERR_SUBMODULE, "Invalid format for submodule URL");
		error = -1;
	}

867
	git_buf_free(&normalized);
868 869 870
	return error;
}

871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895
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;
}

896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911
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);
}

912 913 914 915 916 917
const char *git_submodule_branch(git_submodule *submodule)
{
	assert(submodule);
	return submodule->branch;
}

918
int git_submodule_set_branch(git_repository *repo, const char *name, const char *branch)
919 920
{

921
	assert(repo && name);
922

923
	return write_var(repo, name, "branch", branch);
924 925
}

926
int git_submodule_set_url(git_repository *repo, const char *name, const char *url)
Russell Belfer committed
927
{
928
	assert(repo && name && url);
Russell Belfer committed
929

930
	return write_var(repo, name, "url", url);
Russell Belfer committed
931 932
}

933
const git_oid *git_submodule_index_id(git_submodule *submodule)
Russell Belfer committed
934 935 936 937 938 939 940 941 942
{
	assert(submodule);

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

943
const git_oid *git_submodule_head_id(git_submodule *submodule)
Russell Belfer committed
944 945 946 947 948 949 950 951 952
{
	assert(submodule);

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

953
const git_oid *git_submodule_wd_id(git_submodule *submodule)
Russell Belfer committed
954 955 956
{
	assert(submodule);

957
	/* load unless we think we have a valid oid */
Russell Belfer committed
958 959 960 961
	if (!(submodule->flags & GIT_SUBMODULE_STATUS__WD_OID_VALID)) {
		git_repository *subrepo;

		/* calling submodule open grabs the HEAD OID if possible */
962
		if (!git_submodule_open_bare(&subrepo, submodule))
Russell Belfer committed
963
			git_repository_free(subrepo);
964 965
		else
			giterr_clear();
Russell Belfer committed
966 967 968 969 970 971 972 973 974 975 976
	}

	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);
977 978
	return (submodule->ignore < GIT_SUBMODULE_IGNORE_NONE) ?
		GIT_SUBMODULE_IGNORE_NONE : submodule->ignore;
Russell Belfer committed
979 980
}

981 982
int git_submodule_set_ignore(git_repository *repo, const char *name, git_submodule_ignore_t ignore)
{
983
	assert(repo && name);
984

985
	return write_mapped_var(repo, name, _sm_ignore_map, ARRAY_SIZE(_sm_ignore_map), "ignore", ignore);
986 987
}

988
git_submodule_update_t git_submodule_update_strategy(git_submodule *submodule)
Russell Belfer committed
989 990
{
	assert(submodule);
991 992
	return (submodule->update < GIT_SUBMODULE_UPDATE_CHECKOUT) ?
		GIT_SUBMODULE_UPDATE_CHECKOUT : submodule->update;
Russell Belfer committed
993 994
}

995
int git_submodule_set_update(git_repository *repo, const char *name, git_submodule_update_t update)
Russell Belfer committed
996
{
997
	assert(repo && name);
Russell Belfer committed
998

999
	return write_mapped_var(repo, name, _sm_update_map, ARRAY_SIZE(_sm_update_map), "update", update);
Russell Belfer committed
1000 1001
}

1002
git_submodule_recurse_t git_submodule_fetch_recurse_submodules(
1003 1004 1005 1006 1007 1008
	git_submodule *submodule)
{
	assert(submodule);
	return submodule->fetch_recurse;
}

1009
int git_submodule_set_fetch_recurse_submodules(git_repository *repo, const char *name, git_submodule_recurse_t recurse)
1010
{
1011 1012
	assert(repo && name);

1013
	return write_mapped_var(repo, name, _sm_recurse_map, ARRAY_SIZE(_sm_recurse_map), "fetchRecurseSubmodules", recurse);
1014 1015
}

1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
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:
1041
	 * <repo-dir>/modules/<name>/ with a gitlink in the
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
	 * sub-repo workdir directory to that repository.
	 */
	error = git_buf_join3(
		&repodir, '/', git_repository_path(parent_repo), "modules", path);
	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)
{
1070 1071
	git_submodule *sm;

1072
	GIT_UNUSED(bare);
1073 1074

	sm = payload;
1075 1076 1077 1078

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

1079 1080 1081 1082 1083 1084 1085
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;
}

1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
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 */
1107
	memcpy(&clone_options.fetch_opts, &update_options.fetch_opts, sizeof(git_fetch_options));
1108 1109

	/* Get the status of the submodule to determine if it is already initialized  */
1110
	if ((error = git_submodule_status(&submodule_status, sm->repo, sm->name, GIT_SUBMODULE_IGNORE_UNSPECIFIED)) < 0)
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
		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;

			if (error == GIT_ENOTFOUND && !init) {
				giterr_set(GITERR_SUBMODULE, "Submodule is not initialized.");
				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;

		/*
1158
		 * Do not perform checkout as part of clone, instead we
1159 1160 1161 1162 1163 1164
		 * will checkout the specific commit manually.
		 */
		clone_options.checkout_opts.checkout_strategy = GIT_CHECKOUT_NONE;
		update_options.checkout_opts.checkout_strategy = update_options.clone_checkout_strategy;

		if ((error = git_clone(&sub_repo, submodule_url, sm->path, &clone_options)) < 0 ||
1165
			(error = git_repository_set_head_detached(sub_repo, git_submodule_index_id(sm))) < 0 ||
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176
			(error = git_checkout_head(sub_repo, &update_options.checkout_opts)) != 0)
			goto done;
	} else {
		/**
		 * 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.
		 */
		if ((error = git_submodule_open(&sub_repo, sm)) < 0 ||
			(error = git_object_lookup(&target_commit, sub_repo, git_submodule_index_id(sm), GIT_OBJ_COMMIT)) < 0 ||
			(error = git_checkout_tree(sub_repo, target_commit, &update_options.checkout_opts)) != 0 ||
1177
			(error = git_repository_set_head_detached(sub_repo, git_submodule_index_id(sm))) < 0)
1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196
			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;
}

1197
int git_submodule_init(git_submodule *sm, int overwrite)
Russell Belfer committed
1198 1199
{
	int error;
1200
	const char *val;
1201
	git_buf key = GIT_BUF_INIT, effective_submodule_url = GIT_BUF_INIT;
1202
	git_config *cfg = NULL;
Russell Belfer committed
1203

1204
	if (!sm->url) {
Russell Belfer committed
1205
		giterr_set(GITERR_SUBMODULE,
1206
			"No URL configured for submodule '%s'", sm->name);
Russell Belfer committed
1207 1208 1209
		return -1;
	}

1210
	if ((error = git_repository_config(&cfg, sm->repo)) < 0)
Russell Belfer committed
1211 1212
		return error;

1213 1214
	/* write "submodule.NAME.url" */

1215
	if ((error = git_submodule_resolve_url(&effective_submodule_url, sm->repo, sm->url)) < 0 ||
1216
		(error = git_buf_printf(&key, "submodule.%s.url", sm->name)) < 0 ||
1217
		(error = git_config__update_entry(
1218
			cfg, key.ptr, effective_submodule_url.ptr, overwrite != 0, false)) < 0)
1219 1220
		goto cleanup;

Russell Belfer committed
1221 1222
	/* write "submodule.NAME.update" if not default */

1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235
	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);
1236
	git_buf_free(&effective_submodule_url);
Russell Belfer committed
1237 1238 1239 1240

	return error;
}

1241
int git_submodule_sync(git_submodule *sm)
Russell Belfer committed
1242
{
1243 1244 1245
	int error = 0;
	git_config *cfg = NULL;
	git_buf key = GIT_BUF_INIT;
1246
	git_repository *smrepo = NULL;
1247 1248

	if (!sm->url) {
Russell Belfer committed
1249
		giterr_set(GITERR_SUBMODULE,
1250
			"No URL configured for submodule '%s'", sm->name);
Russell Belfer committed
1251 1252 1253 1254 1255
		return -1;
	}

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

1256 1257 1258 1259 1260 1261
	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 */

1262 1263 1264 1265
	if (!error &&
		(sm->flags & GIT_SUBMODULE_STATUS_IN_WD) != 0 &&
		!(error = git_submodule_open(&smrepo, sm)))
	{
1266 1267 1268 1269 1270
		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) {
1271
			giterr_clear();
1272
			error = git_buf_sets(&key, "remote.origin.url");
1273 1274
		} else {
			error = git_buf_join3(
1275
				&key, '.', "remote", remote_name.ptr, "url");
1276
			git_buf_free(&remote_name);
1277 1278
		}

1279 1280
		if (!error)
			error = git_config__update_entry(cfg, key.ptr, sm->url, true, false);
1281 1282 1283 1284 1285 1286 1287

		git_repository_free(smrepo);
	}

	git_buf_free(&key);

	return error;
Russell Belfer committed
1288 1289
}

1290 1291
static int git_submodule__open(
	git_repository **subrepo, git_submodule *sm, bool bare)
Russell Belfer committed
1292 1293 1294
{
	int error;
	git_buf path = GIT_BUF_INIT;
1295 1296
	unsigned int flags = GIT_REPOSITORY_OPEN_NO_SEARCH;
	const char *wd;
Russell Belfer committed
1297

1298
	assert(sm && subrepo);
Russell Belfer committed
1299

1300 1301 1302
	if (git_repository__ensure_not_bare(
			sm->repo, "open submodule repository") < 0)
		return GIT_EBAREREPO;
Russell Belfer committed
1303

1304
	wd = git_repository_workdir(sm->repo);
Russell Belfer committed
1305

1306 1307
	if (git_buf_joinpath(&path, wd, sm->path) < 0 ||
		git_buf_joinpath(&path, path.ptr, DOT_GIT) < 0)
Russell Belfer committed
1308 1309
		return -1;

1310 1311 1312 1313
	sm->flags = sm->flags &
		~(GIT_SUBMODULE_STATUS_IN_WD |
		  GIT_SUBMODULE_STATUS__WD_OID_VALID |
		  GIT_SUBMODULE_STATUS__WD_SCANNED);
Russell Belfer committed
1314

1315 1316
	if (bare)
		flags |= GIT_REPOSITORY_OPEN_BARE;
Russell Belfer committed
1317

1318
	error = git_repository_open_ext(subrepo, path.ptr, flags, wd);
1319

1320 1321 1322 1323
	/* if we opened the submodule successfully, grab HEAD OID, etc. */
	if (!error) {
		sm->flags |= GIT_SUBMODULE_STATUS_IN_WD |
			GIT_SUBMODULE_STATUS__WD_SCANNED;
1324

1325 1326 1327 1328 1329 1330 1331 1332 1333
		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" */
1334

1335 1336 1337
		if (git_path_isdir(path.ptr))
			sm->flags |= GIT_SUBMODULE_STATUS__WD_SCANNED;
	}
1338

1339
	git_buf_free(&path);
1340

1341 1342
	return error;
}
1343

1344 1345 1346 1347
int git_submodule_open_bare(git_repository **subrepo, git_submodule *sm)
{
	return git_submodule__open(subrepo, sm, true);
}
Russell Belfer committed
1348

1349 1350 1351
int git_submodule_open(git_repository **subrepo, git_submodule *sm)
{
	return git_submodule__open(subrepo, sm, false);
Russell Belfer committed
1352 1353
}

1354 1355
static void submodule_update_from_index_entry(
	git_submodule *sm, const git_index_entry *ie)
Russell Belfer committed
1356
{
1357
	bool already_found = (sm->flags & GIT_SUBMODULE_STATUS_IN_INDEX) != 0;
Russell Belfer committed
1358

1359 1360 1361 1362 1363 1364 1365
	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
1366
			git_oid_cpy(&sm->index_oid, &ie->id);
Russell Belfer committed
1367

1368 1369 1370 1371 1372 1373 1374 1375 1376
		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
1377

1378
	if (git_repository_index__weakptr(&index, sm->repo) < 0)
Russell Belfer committed
1379 1380
		return -1;

1381
	sm->flags = sm->flags &
1382 1383 1384
		~(GIT_SUBMODULE_STATUS_IN_INDEX |
		  GIT_SUBMODULE_STATUS__INDEX_OID_VALID);

1385 1386
	if (!(ie = git_index_get_bypath(index, sm->path, 0)))
		return 0;
Russell Belfer committed
1387

1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402
	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
1403
	}
1404
}
Russell Belfer committed
1405

1406 1407 1408
static int submodule_update_head(git_submodule *submodule)
{
	git_tree *head = NULL;
nulltoken committed
1409
	git_tree_entry *te = NULL;
Russell Belfer committed
1410

1411 1412 1413
	submodule->flags = submodule->flags &
		~(GIT_SUBMODULE_STATUS_IN_HEAD |
		  GIT_SUBMODULE_STATUS__HEAD_OID_VALID);
Russell Belfer committed
1414

1415 1416 1417 1418 1419
	/* 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
1420
		submodule_update_from_head_data(submodule, te->attr, git_tree_entry_id(te));
Russell Belfer committed
1421

nulltoken committed
1422
	git_tree_entry_free(te);
1423 1424 1425
	git_tree_free(head);
	return 0;
}
1426

1427
int git_submodule_reload(git_submodule *sm, int force)
1428 1429
{
	int error = 0;
1430
	git_config *mods;
Russell Belfer committed
1431

1432 1433
	GIT_UNUSED(force);

1434 1435
	assert(sm);

1436 1437 1438 1439 1440 1441
	if (!git_repository_is_bare(sm->repo)) {
		/* refresh config data */
		mods = gitmodules_snapshot(sm->repo);
		if (mods != NULL) {
			error = submodule_read_config(sm, mods);
			git_config_free(mods);
Russell Belfer committed
1442

1443 1444 1445
			if (error < 0)
				return error;
		}
1446

1447 1448 1449 1450 1451
		/* refresh wd data */
		sm->flags &=
			~(GIT_SUBMODULE_STATUS_IN_WD |
			  GIT_SUBMODULE_STATUS__WD_OID_VALID |
			  GIT_SUBMODULE_STATUS__WD_FLAGS);
Russell Belfer committed
1452

1453
		error = submodule_load_from_wd_lite(sm);
1454
	}
1455

1456 1457
	if (error == 0 && (error = submodule_update_index(sm)) == 0)
		error = submodule_update_head(sm);
1458

1459
	return error;
Russell Belfer committed
1460 1461
}

1462 1463
static void submodule_copy_oid_maybe(
	git_oid *tgt, const git_oid *src, bool valid)
Russell Belfer committed
1464
{
1465 1466 1467 1468 1469 1470 1471
	if (tgt) {
		if (valid)
			memcpy(tgt, src, sizeof(*tgt));
		else
			memset(tgt, 0, sizeof(*tgt));
	}
}
1472

1473 1474 1475 1476 1477 1478 1479 1480 1481 1482
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
1483

1484
	if (ign == GIT_SUBMODULE_IGNORE_UNSPECIFIED)
1485
		ign = sm->ignore;
1486

1487 1488 1489 1490
	/* only return location info if ignore == all */
	if (ign == GIT_SUBMODULE_IGNORE_ALL) {
		*out_status = (sm->flags & GIT_SUBMODULE_STATUS__IN_FLAGS);
		return 0;
1491
	}
Russell Belfer committed
1492

1493 1494 1495 1496 1497 1498 1499
	/* 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
1500

1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530
	/* 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
1531 1532
}

1533
int git_submodule_status(unsigned int *status, git_repository *repo, const char *name, git_submodule_ignore_t ignore)
1534
{
1535 1536 1537 1538 1539 1540 1541 1542
	git_submodule *sm;
	int error;

	assert(status && repo && name);

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

1543
	error = git_submodule__status(status, NULL, NULL, NULL, sm, ignore);
1544
	git_submodule_free(sm);
1545

1546
	return error;
1547
}
1548

1549 1550 1551 1552 1553 1554
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);
1555 1556 1557
}


Russell Belfer committed
1558 1559 1560 1561
/*
 * INTERNAL FUNCTIONS
 */

1562
static int submodule_alloc(
1563
	git_submodule **out, git_repository *repo, const char *name)
1564
{
1565
	size_t namelen;
1566
	git_submodule *sm;
1567

1568
	if (!name || !(namelen = strlen(name))) {
1569
		giterr_set(GITERR_SUBMODULE, "Invalid submodule name");
1570
		return -1;
1571 1572
	}

1573
	sm = git__calloc(1, sizeof(git_submodule));
1574
	GITERR_CHECK_ALLOC(sm);
1575

1576 1577 1578
	sm->name = sm->path = git__strdup(name);
	if (!sm->name) {
		git__free(sm);
1579
		return -1;
1580
	}
Russell Belfer committed
1581

1582
	GIT_REFCOUNT_INC(sm);
1583 1584
	sm->ignore = sm->ignore_default = GIT_SUBMODULE_IGNORE_NONE;
	sm->update = sm->update_default = GIT_SUBMODULE_UPDATE_CHECKOUT;
1585
	sm->fetch_recurse = sm->fetch_recurse_default = GIT_SUBMODULE_RECURSE_NO;
1586
	sm->repo   = repo;
1587
	sm->branch = NULL;
1588

1589 1590
	*out = sm;
	return 0;
Russell Belfer committed
1591 1592
}

1593
static void submodule_release(git_submodule *sm)
Russell Belfer committed
1594 1595 1596 1597
{
	if (!sm)
		return;

1598
	if (sm->repo) {
1599
		sm->repo = NULL;
1600 1601
	}

1602 1603 1604 1605
	if (sm->path != sm->name)
		git__free(sm->path);
	git__free(sm->name);
	git__free(sm->url);
1606
	git__free(sm->branch);
1607 1608 1609
	git__memzero(sm, sizeof(*sm));
	git__free(sm);
}
Russell Belfer committed
1610

1611 1612 1613 1614 1615
void git_submodule_free(git_submodule *sm)
{
	if (!sm)
		return;
	GIT_REFCOUNT_DEC(sm, submodule_release);
Russell Belfer committed
1616 1617
}

1618 1619 1620 1621 1622
static int submodule_config_error(const char *property, const char *value)
{
	giterr_set(GITERR_INVALID,
		"Invalid value for submodule '%s' property: '%s'", property, value);
	return -1;
1623 1624
}

1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652
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;
}

1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666
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;
}

1667
static int get_value(const char **out, git_config *cfg, git_buf *buf, const char *name, const char *field)
1668
{
1669
	int error;
1670

1671
	git_buf_clear(buf);
1672

1673 1674 1675
	if ((error = git_buf_printf(buf, "submodule.%s.%s", name, field)) < 0 ||
	    (error = git_config_get_string(out, cfg, buf->ptr)) < 0)
		return error;
1676

1677 1678
	return error;
}
1679

1680 1681 1682 1683 1684
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
1685

1686 1687 1688
	/*
	 * 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)
1689
	 */
1690

1691 1692 1693 1694
	if ((error = get_value(&value, cfg, &key, sm->name, "path")) == 0) {
		in_config = 1;
	/*
	 * TODO: if case insensitive filesystem, then the following strcmp
1695 1696
	 * should be strcasecmp
	 */
1697
		if (strcmp(sm->name, value) != 0) {
Carlos Martín Nieto committed
1698 1699
			if (sm->path != sm->name)
				git__free(sm->path);
1700 1701
			sm->path = git__strdup(value);
			GITERR_CHECK_ALLOC(sm->path);
1702
		}
1703
	} else if (error != GIT_ENOTFOUND) {
1704
		goto cleanup;
1705
	}
1706

1707 1708 1709 1710 1711
	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) {
1712
		goto cleanup;
1713 1714
	}

1715 1716 1717 1718 1719
	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) {
1720
		goto cleanup;
1721
	}
1722

1723 1724
	if ((error = get_value(&value, cfg, &key, sm->name, "update")) == 0) {
		in_config = 1;
1725
		if ((error = git_submodule_parse_update(&sm->update, value)) < 0)
1726
			goto cleanup;
1727
		sm->update_default = sm->update;
1728
	} else if (error != GIT_ENOTFOUND) {
1729
		goto cleanup;
1730
	}
1731 1732 1733

	if ((error = get_value(&value, cfg, &key, sm->name, "fetchRecurseSubmodules")) == 0) {
		in_config = 1;
1734
		if ((error = git_submodule_parse_recurse(&sm->fetch_recurse, value)) < 0)
1735
			goto cleanup;
1736
		sm->fetch_recurse_default = sm->fetch_recurse;
1737
	} else if (error != GIT_ENOTFOUND) {
1738
		goto cleanup;
1739
	}
1740 1741 1742

	if ((error = get_value(&value, cfg, &key, sm->name, "ignore")) == 0) {
		in_config = 1;
1743
		if ((error = git_submodule_parse_ignore(&sm->ignore, value)) < 0)
1744
			goto cleanup;
1745
		sm->ignore_default = sm->ignore;
1746
	} else if (error != GIT_ENOTFOUND) {
1747
		goto cleanup;
1748
	}
1749 1750 1751 1752

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

1753 1754 1755 1756 1757
	error = 0;

cleanup:
	git_buf_free(&key);
	return error;
1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790
}

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;
	int error;

	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;

	/*
	 * 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);
1791 1792 1793 1794
	if (git_strmap_valid_index(map, pos)) {
		error = 0;
		goto done;
	}
1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809

	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;
	}

	git_strmap_insert(map, sm->name, sm, error);
	assert(error != 0);
	if (error < 0)
		goto done;

	error = 0;
1810

1811 1812
done:
	git_buf_free(&name);
1813
	return error;
1814 1815
}

1816
static int submodule_load_from_wd_lite(git_submodule *sm)
Russell Belfer committed
1817 1818 1819
{
	git_buf path = GIT_BUF_INIT;

1820
	if (git_buf_joinpath(&path, git_repository_workdir(sm->repo), sm->path) < 0)
1821
		return -1;
Russell Belfer committed
1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832

	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;
}

1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861
/**
 * Returns a snapshot of $WORK_TREE/.gitmodules.
 *
 * We ignore any errors and just pretend the file isn't there.
 */
static git_config *gitmodules_snapshot(git_repository *repo)
{
	const char *workdir = git_repository_workdir(repo);
	git_config *mods = NULL, *snap = NULL;
	git_buf path = GIT_BUF_INIT;

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

		if (git_config_open_ondisk(&mods, path.ptr) < 0)
			mods = NULL;
	}

	git_buf_free(&path);

	if (mods) {
		git_config_snapshot(&snap, mods);
		git_config_free(mods);
	}

	return snap;
}

Ben Straub committed
1862
static git_config_backend *open_gitmodules(
1863
	git_repository *repo,
1864
	int okay_to_create)
Russell Belfer committed
1865
{
1866
	const char *workdir = git_repository_workdir(repo);
Russell Belfer committed
1867
	git_buf path = GIT_BUF_INIT;
Ben Straub committed
1868
	git_config_backend *mods = NULL;
Russell Belfer committed
1869 1870 1871 1872 1873 1874 1875 1876

	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)
1877
				mods = NULL;
Russell Belfer committed
1878
			/* open should only fail here if the file is malformed */
1879
			else if (git_config_file_open(mods, GIT_CONFIG_LEVEL_LOCAL) < 0) {
Russell Belfer committed
1880 1881 1882
				git_config_file_free(mods);
				mods = NULL;
			}
1883 1884 1885
		}
	}

1886 1887
	git_buf_free(&path);

Russell Belfer committed
1888 1889 1890
	return mods;
}

Russell Belfer committed
1891 1892
/* 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)
1893
{
Russell Belfer committed
1894
	int error;
Russell Belfer committed
1895 1896 1897 1898 1899 1900 1901
	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;

1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913
	/**
	 * 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
1914
	/* lookup remote tracking branch of HEAD */
1915 1916 1917 1918 1919
	if ((error = git_branch_upstream_name(
		&upstream_name,
		repo,
		git_reference_name(head))) < 0)
		goto done;
Russell Belfer committed
1920

1921 1922 1923
	/* lookup remote of remote tracking branch */
	if ((error = git_branch_remote_name(remote_name, repo, upstream_name.ptr)) < 0)
		goto done;
Russell Belfer committed
1924

1925 1926
done:
	git_buf_free(&upstream_name);
Russell Belfer committed
1927
	git_reference_free(head);
1928

1929 1930
	return error;
}
1931

Russell Belfer committed
1932 1933
/* Lookup the remote of the local tracking branch HEAD points to */
static int lookup_head_remote(git_remote **remote, git_repository *repo)
1934 1935
{
	int error;
Russell Belfer committed
1936
	git_buf remote_name = GIT_BUF_INIT;
1937

Russell Belfer committed
1938 1939
	/* lookup remote of remote tracking branch name */
	if (!(error = lookup_head_remote_key(&remote_name, repo)))
1940
		error = git_remote_lookup(remote, repo, remote_name.ptr);
1941

Russell Belfer committed
1942
	git_buf_free(&remote_name);
Russell Belfer committed
1943

1944 1945
	return error;
}
Russell Belfer committed
1946

Russell Belfer committed
1947 1948
/* Lookup remote, either from HEAD or fall back on origin */
static int lookup_default_remote(git_remote **remote, git_repository *repo)
1949
{
Russell Belfer committed
1950
	int error = lookup_head_remote(remote, repo);
Russell Belfer committed
1951

Russell Belfer committed
1952 1953
	/* if that failed, use 'origin' instead */
	if (error == GIT_ENOTFOUND)
1954
		error = git_remote_lookup(remote, repo, "origin");
Russell Belfer committed
1955

Russell Belfer committed
1956 1957 1958 1959 1960
	if (error == GIT_ENOTFOUND)
		giterr_set(
			GITERR_SUBMODULE,
			"Cannot get default remote for submodule - no local tracking "
			"branch for HEAD and origin does not exist");
Russell Belfer committed
1961 1962

	return error;
1963 1964
}

Russell Belfer committed
1965
static int get_url_base(git_buf *url, git_repository *repo)
1966 1967
{
	int error;
Russell Belfer committed
1968
	git_remote *remote = NULL;
1969

Russell Belfer committed
1970 1971 1972 1973 1974 1975 1976 1977 1978
	if (!(error = lookup_default_remote(&remote, repo))) {
		error = git_buf_sets(url, git_remote_url(remote));
		git_remote_free(remote);
	}
	else if (error == GIT_ENOTFOUND) {
		/* if repository does not have a default remote, use workdir instead */
		giterr_clear();
		error = git_buf_sets(url, git_repository_workdir(repo));
	}
1979 1980 1981 1982

	return error;
}

1983
static void submodule_get_index_status(unsigned int *status, git_submodule *sm)
Russell Belfer committed
1984
{
1985 1986
	const git_oid *head_oid  = git_submodule_head_id(sm);
	const git_oid *index_oid = git_submodule_index_id(sm);
Russell Belfer committed
1987

1988 1989
	*status = *status & ~GIT_SUBMODULE_STATUS__INDEX_FLAGS;

1990 1991 1992 1993 1994 1995 1996 1997
	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
1998 1999
}

2000

2001 2002 2003 2004 2005
static void submodule_get_wd_status(
	unsigned int *status,
	git_submodule *sm,
	git_repository *sm_repo,
	git_submodule_ignore_t ign)
2006
{
2007 2008 2009 2010
	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;
2011
	git_index *index = NULL;
2012
	git_diff_options opt = GIT_DIFF_OPTIONS_INIT;
2013
	git_diff *diff;
2014

2015
	*status = *status & ~GIT_SUBMODULE_STATUS__WD_FLAGS;
Russell Belfer committed
2016

2017 2018 2019
	if (!index_oid) {
		if (wd_oid)
			*status |= GIT_SUBMODULE_STATUS_WD_ADDED;
Russell Belfer committed
2020
	}
2021 2022 2023 2024 2025 2026
	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
2027
	}
2028 2029
	else if (!git_oid_equal(index_oid, wd_oid))
		*status |= GIT_SUBMODULE_STATUS_WD_MODIFIED;
Russell Belfer committed
2030

2031 2032 2033
	/* if we have no repo, then we're done */
	if (!sm_repo)
		return;
2034

2035 2036 2037 2038
	/* 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).
	 */
2039

2040 2041
	if (ign == GIT_SUBMODULE_IGNORE_NONE)
		opt.flags |= GIT_DIFF_INCLUDE_UNTRACKED;
Russell Belfer committed
2042

2043 2044
	(void)git_repository_index__weakptr(&index, sm_repo);

2045
	/* if we don't have an unborn head, check diff with index */
2046 2047 2048 2049
	if (git_repository_head_tree(&sm_head, sm_repo) < 0)
		giterr_clear();
	else {
		/* perform head to index diff on submodule */
2050
		if (git_diff_tree_to_index(&diff, sm_repo, sm_head, index, &opt) < 0)
2051 2052
			giterr_clear();
		else {
2053
			if (git_diff_num_deltas(diff) > 0)
2054
				*status |= GIT_SUBMODULE_STATUS_WD_INDEX_MODIFIED;
2055
			git_diff_free(diff);
2056 2057
			diff = NULL;
		}
Russell Belfer committed
2058

2059
		git_tree_free(sm_head);
2060
	}
2061

2062
	/* perform index-to-workdir diff on submodule */
2063
	if (git_diff_index_to_workdir(&diff, sm_repo, index, &opt) < 0)
2064 2065 2066 2067
		giterr_clear();
	else {
		size_t untracked =
			git_diff_num_deltas_of_type(diff, GIT_DELTA_UNTRACKED);
2068

2069 2070
		if (untracked > 0)
			*status |= GIT_SUBMODULE_STATUS_WD_UNTRACKED;
2071

2072 2073
		if (git_diff_num_deltas(diff) != untracked)
			*status |= GIT_SUBMODULE_STATUS_WD_WD_MODIFIED;
Russell Belfer committed
2074

2075
		git_diff_free(diff);
2076
		diff = NULL;
2077
	}
2078
}