checkout.c 72.8 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 "checkout.h"

10 11
#include <assert.h>

12 13 14
#include "git2/repository.h"
#include "git2/refs.h"
#include "git2/tree.h"
15
#include "git2/blob.h"
16
#include "git2/config.h"
17
#include "git2/diff.h"
18
#include "git2/submodule.h"
Vicent Marti committed
19
#include "git2/sys/index.h"
20
#include "git2/sys/filter.h"
21
#include "git2/merge.h"
22 23

#include "refs.h"
24
#include "repository.h"
25
#include "index.h"
Ben Straub committed
26
#include "filter.h"
Ben Straub committed
27
#include "blob.h"
28
#include "diff.h"
29
#include "diff_generate.h"
30
#include "pathspec.h"
31
#include "buf_text.h"
32
#include "diff_xdiff.h"
33
#include "path.h"
34
#include "attr.h"
35 36 37
#include "pool.h"
#include "strmap.h"

38
/* See docs/checkout-internals.md for more information */
39

40 41 42 43 44 45
enum {
	CHECKOUT_ACTION__NONE = 0,
	CHECKOUT_ACTION__REMOVE = 1,
	CHECKOUT_ACTION__UPDATE_BLOB = 2,
	CHECKOUT_ACTION__UPDATE_SUBMODULE = 4,
	CHECKOUT_ACTION__CONFLICT = 8,
46 47 48 49
	CHECKOUT_ACTION__REMOVE_CONFLICT = 16,
	CHECKOUT_ACTION__UPDATE_CONFLICT = 32,
	CHECKOUT_ACTION__MAX = 32,
	CHECKOUT_ACTION__DEFER_REMOVE = 64,
50 51 52 53 54 55
	CHECKOUT_ACTION__REMOVE_AND_UPDATE =
		(CHECKOUT_ACTION__UPDATE_BLOB | CHECKOUT_ACTION__REMOVE),
};

typedef struct {
	git_repository *repo;
56
	git_iterator *target;
57
	git_diff *diff;
58
	git_checkout_options opts;
59 60 61 62 63
	bool opts_free_baseline;
	char *pfx;
	git_index *index;
	git_pool pool;
	git_vector removes;
64 65 66 67
	git_vector remove_conflicts;
	git_vector update_conflicts;
	git_vector *update_reuc;
	git_vector *update_names;
68 69
	git_buf target_path;
	size_t target_len;
70
	git_buf tmp;
71 72
	unsigned int strategy;
	int can_symlink;
73
	int respect_filemode;
74 75 76
	bool reload_submodules;
	size_t total_steps;
	size_t completed_steps;
77
	git_checkout_perfdata perfdata;
78
	git_strmap *mkdir_map;
79
	git_attr_session attr_session;
80 81 82 83 84 85 86 87 88
} checkout_data;

typedef struct {
	const git_index_entry *ancestor;
	const git_index_entry *ours;
	const git_index_entry *theirs;

	int name_collision:1,
		directoryfile:1,
89
		one_to_two:1,
Edward Thomson committed
90 91
		binary:1,
		submodule:1;
92 93
} checkout_conflictdata;

94
static int checkout_notify(
95
	checkout_data *data,
96 97
	git_checkout_notify_t why,
	const git_diff_delta *delta,
98
	const git_index_entry *wditem)
99
{
100
	git_diff_file wdfile;
101
	const git_diff_file *baseline = NULL, *target = NULL, *workdir = NULL;
102
	const char *path = NULL;
103

104 105
	if (!data->opts.notify_cb ||
		(why & data->opts.notify_flags) == 0)
106 107
		return 0;

108 109
	if (wditem) {
		memset(&wdfile, 0, sizeof(wdfile));
110

111
		git_oid_cpy(&wdfile.id, &wditem->id);
112 113
		wdfile.path = wditem->path;
		wdfile.size = wditem->file_size;
114
		wdfile.flags = GIT_DIFF_FLAG_VALID_ID;
115
		wdfile.mode = wditem->mode;
116

117
		workdir = &wdfile;
118 119

		path = wditem->path;
120 121
	}

122
	if (delta) {
123 124 125 126 127
		switch (delta->status) {
		case GIT_DELTA_UNMODIFIED:
		case GIT_DELTA_MODIFIED:
		case GIT_DELTA_TYPECHANGE:
		default:
128 129
			baseline = &delta->old_file;
			target = &delta->new_file;
130 131 132 133
			break;
		case GIT_DELTA_ADDED:
		case GIT_DELTA_IGNORED:
		case GIT_DELTA_UNTRACKED:
134
		case GIT_DELTA_UNREADABLE:
135
			target = &delta->new_file;
136 137
			break;
		case GIT_DELTA_DELETED:
138
			baseline = &delta->old_file;
139 140
			break;
		}
141 142

		path = delta->old_file.path;
143 144
	}

145 146 147 148 149 150 151
	{
		int error = data->opts.notify_cb(
			why, path, baseline, target, workdir, data->opts.notify_payload);

		return giterr_set_after_callback_function(
			error, "git_checkout notification");
	}
152 153
}

154 155 156 157 158 159 160 161 162
GIT_INLINE(bool) is_workdir_base_or_new(
	const git_oid *workdir_id,
	const git_diff_file *baseitem,
	const git_diff_file *newitem)
{
	return (git_oid__cmp(&baseitem->id, workdir_id) == 0 ||
		git_oid__cmp(&newitem->id, workdir_id) == 0);
}

163
GIT_INLINE(bool) is_filemode_changed(git_filemode_t a, git_filemode_t b, int respect_filemode)
164
{
165 166 167 168 169 170 171 172 173 174 175 176
	/* If core.filemode = false, ignore links in the repository and executable bit changes */
	if (!respect_filemode) {
		if (a == S_IFLNK)
			a = GIT_FILEMODE_BLOB;
		if (b == S_IFLNK)
			b = GIT_FILEMODE_BLOB;

		a &= ~0111;
		b &= ~0111;
	}

	return (a != b);
177 178
}

179
static bool checkout_is_workdir_modified(
180
	checkout_data *data,
181
	const git_diff_file *baseitem,
182
	const git_diff_file *newitem,
183
	const git_index_entry *wditem)
184 185
{
	git_oid oid;
186
	const git_index_entry *ie;
187

188 189 190 191 192
	/* handle "modified" submodule */
	if (wditem->mode == GIT_FILEMODE_COMMIT) {
		git_submodule *sm;
		unsigned int sm_status = 0;
		const git_oid *sm_oid = NULL;
193
		bool rval = false;
194

195 196
		if (git_submodule_lookup(&sm, data->repo, wditem->path) < 0) {
			giterr_clear();
197
			return true;
198
		}
199

200
		if (git_submodule_status(&sm_status, data->repo, wditem->path, GIT_SUBMODULE_IGNORE_UNSPECIFIED) < 0 ||
201 202 203 204 205 206
			GIT_SUBMODULE_STATUS_IS_WD_DIRTY(sm_status))
			rval = true;
		else if ((sm_oid = git_submodule_wd_id(sm)) == NULL)
			rval = false;
		else
			rval = (git_oid__cmp(&baseitem->id, sm_oid) != 0);
207

208 209
		git_submodule_free(sm);
		return rval;
210 211
	}

212 213 214 215 216 217
	/*
	 * Look at the cache to decide if the workdir is modified: if the
	 * cache contents match the workdir contents, then we do not need
	 * to examine the working directory directly, instead we can
	 * examine the cache to see if _it_ has been modified.  This allows
	 * us to avoid touching the disk.
218
	 */
219 220 221 222 223
	ie = git_index_get_bypath(data->index, wditem->path, 0);

	if (ie != NULL &&
		git_index_time_eq(&wditem->mtime, &ie->mtime) &&
		wditem->file_size == ie->file_size &&
224
		!is_filemode_changed(wditem->mode, ie->mode, data->respect_filemode)) {
225 226 227

		/* The workdir is modified iff the index entry is modified */
		return !is_workdir_base_or_new(&ie->id, baseitem, newitem) ||
228
			is_filemode_changed(baseitem->mode, ie->mode, data->respect_filemode);
229 230
	}

231 232 233 234
	/* depending on where base is coming from, we may or may not know
	 * the actual size of the data, so we can't rely on this shortcut.
	 */
	if (baseitem->size && wditem->file_size != baseitem->size)
235 236
		return true;

237 238 239 240
	/* if the workdir item is a directory, it cannot be a modified file */
	if (S_ISDIR(wditem->mode))
		return false;

241
	if (is_filemode_changed(baseitem->mode, wditem->mode, data->respect_filemode))
242 243
		return true;

244
	if (git_diff__oid_for_entry(&oid, data->diff, wditem, wditem->mode, NULL) < 0)
245 246
		return false;

247 248 249 250
	/* Allow the checkout if the workdir is not modified *or* if the checkout
	 * target's contents are already in the working directory.
	 */
	return !is_workdir_base_or_new(&oid, baseitem, newitem);
251 252 253 254 255 256
}

#define CHECKOUT_ACTION_IF(FLAG,YES,NO) \
	((data->strategy & GIT_CHECKOUT_##FLAG) ? CHECKOUT_ACTION__##YES : CHECKOUT_ACTION__##NO)

static int checkout_action_common(
257
	int *action,
258
	checkout_data *data,
259
	const git_diff_delta *delta,
260 261 262 263 264
	const git_index_entry *wd)
{
	git_checkout_notify_t notify = GIT_CHECKOUT_NOTIFY_NONE;

	if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0)
265
		*action = (*action & ~CHECKOUT_ACTION__REMOVE);
266

267
	if ((*action & CHECKOUT_ACTION__UPDATE_BLOB) != 0) {
268
		if (S_ISGITLINK(delta->new_file.mode))
269
			*action = (*action & ~CHECKOUT_ACTION__UPDATE_BLOB) |
270 271
				CHECKOUT_ACTION__UPDATE_SUBMODULE;

272 273
		/* to "update" a symlink, we must remove the old one first */
		if (delta->new_file.mode == GIT_FILEMODE_LINK && wd != NULL)
274
			*action |= CHECKOUT_ACTION__REMOVE;
275

276 277 278 279 280 281
		/* if the file is on disk and doesn't match our mode, force update */
		if (wd &&
			GIT_PERMS_IS_EXEC(wd->mode) !=
			GIT_PERMS_IS_EXEC(delta->new_file.mode))
				*action |= CHECKOUT_ACTION__REMOVE;

282 283 284
		notify = GIT_CHECKOUT_NOTIFY_UPDATED;
	}

285
	if ((*action & CHECKOUT_ACTION__CONFLICT) != 0)
286 287
		notify = GIT_CHECKOUT_NOTIFY_CONFLICT;

288
	return checkout_notify(data, notify, delta, wd);
289 290 291
}

static int checkout_action_no_wd(
292
	int *action,
293 294
	checkout_data *data,
	const git_diff_delta *delta)
295
{
296 297 298
	int error = 0;

	*action = CHECKOUT_ACTION__NONE;
299

300 301
	switch (delta->status) {
	case GIT_DELTA_UNMODIFIED: /* case 12 */
302 303 304
		error = checkout_notify(data, GIT_CHECKOUT_NOTIFY_DIRTY, delta, NULL);
		if (error)
			return error;
305
		*action = CHECKOUT_ACTION_IF(RECREATE_MISSING, UPDATE_BLOB, NONE);
306 307
		break;
	case GIT_DELTA_ADDED:    /* case 2 or 28 (and 5 but not really) */
308
		*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
309
		break;
310
	case GIT_DELTA_MODIFIED: /* case 13 (and 35 but not really) */
311
		*action = CHECKOUT_ACTION_IF(RECREATE_MISSING, UPDATE_BLOB, CONFLICT);
312
		break;
313 314
	case GIT_DELTA_TYPECHANGE: /* case 21 (B->T) and 28 (T->B)*/
		if (delta->new_file.mode == GIT_FILEMODE_TREE)
315
			*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
316 317
		break;
	case GIT_DELTA_DELETED: /* case 8 or 25 */
318
		*action = CHECKOUT_ACTION_IF(SAFE, REMOVE, NONE);
319
		break;
320 321
	default: /* impossible */
		break;
322 323
	}

324
	return checkout_action_common(action, data, delta, NULL);
325 326
}

327 328
static int checkout_target_fullpath(
	git_buf **out, checkout_data *data, const char *path)
329
{
330 331 332 333 334 335 336 337 338 339 340 341 342 343
	git_buf_truncate(&data->target_path, data->target_len);

	if (path && git_buf_puts(&data->target_path, path) < 0)
		return -1;

	*out = &data->target_path;

	return 0;
}

static bool wd_item_is_removable(
	checkout_data *data, const git_index_entry *wd)
{
	git_buf *full;
344 345 346

	if (wd->mode != GIT_FILEMODE_TREE)
		return true;
347 348 349 350

	if (checkout_target_fullpath(&full, data, wd->path) < 0)
		return false;

351 352 353
	return !full || !git_path_contains(full, DOT_GIT);
}

354 355 356 357 358 359 360 361
static int checkout_queue_remove(checkout_data *data, const char *path)
{
	char *copy = git_pool_strdup(&data->pool, path);
	GITERR_CHECK_ALLOC(copy);
	return git_vector_insert(&data->removes, copy);
}

/* note that this advances the iterator over the wd item */
362 363 364
static int checkout_action_wd_only(
	checkout_data *data,
	git_iterator *workdir,
365
	const git_index_entry **wditem,
366 367
	git_vector *pathspec)
{
368
	int error = 0;
369
	bool remove = false;
370
	git_checkout_notify_t notify = GIT_CHECKOUT_NOTIFY_NONE;
371
	const git_index_entry *wd = *wditem;
372

373
	if (!git_pathspec__match(
374 375
			pathspec, wd->path,
			(data->strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH) != 0,
376
			git_iterator_ignore_case(workdir), NULL, NULL))
377
		return git_iterator_advance(wditem, workdir);
378

379
	/* check if item is tracked in the index but not in the checkout diff */
380
	if (data->index != NULL) {
381 382
		size_t pos;

383
		error = git_index__find_pos(
384 385
			&pos, data->index, wd->path, 0, GIT_INDEX_STAGE_ANY);

386
		if (wd->mode != GIT_FILEMODE_TREE) {
387
			if (!error) { /* found by git_index__find_pos call */
388 389
				notify = GIT_CHECKOUT_NOTIFY_DIRTY;
				remove = ((data->strategy & GIT_CHECKOUT_FORCE) != 0);
390 391
			} else if (error != GIT_ENOTFOUND)
				return error;
392
			else
393
				error = 0; /* git_index__find_pos does not set error msg */
394 395 396 397 398 399
		} else {
			/* for tree entries, we have to see if there are any index
			 * entries that are contained inside that tree
			 */
			const git_index_entry *e = git_index_get_byindex(data->index, pos);

400 401
			if (e != NULL && data->diff->pfxcomp(e->path, wd->path) == 0)
				return git_iterator_advance_into(wditem, workdir);
402
		}
403
	}
404

405 406 407 408 409
	if (notify != GIT_CHECKOUT_NOTIFY_NONE) {
		/* if we found something in the index, notify and advance */
		if ((error = checkout_notify(data, notify, NULL, wd)) != 0)
			return error;

410
		if (remove && wd_item_is_removable(data, wd))
411 412 413 414 415 416
			error = checkout_queue_remove(data, wd->path);

		if (!error)
			error = git_iterator_advance(wditem, workdir);
	} else {
		/* untracked or ignored - can't know which until we advance through */
417
		bool over = false, removable = wd_item_is_removable(data, wd);
418
		git_iterator_status_t untracked_state;
419 420 421 422 423

		/* copy the entry for issuing notification callback later */
		git_index_entry saved_wd = *wd;
		git_buf_sets(&data->tmp, wd->path);
		saved_wd.path = data->tmp.ptr;
424

425
		error = git_iterator_advance_over(
426
			wditem, &untracked_state, workdir);
427 428 429 430
		if (error == GIT_ITEROVER)
			over = true;
		else if (error < 0)
			return error;
431

432
		if (untracked_state == GIT_ITERATOR_STATUS_IGNORED) {
433 434 435 436 437 438
			notify = GIT_CHECKOUT_NOTIFY_IGNORED;
			remove = ((data->strategy & GIT_CHECKOUT_REMOVE_IGNORED) != 0);
		} else {
			notify = GIT_CHECKOUT_NOTIFY_UNTRACKED;
			remove = ((data->strategy & GIT_CHECKOUT_REMOVE_UNTRACKED) != 0);
		}
439

440 441 442 443 444 445 446 447
		if ((error = checkout_notify(data, notify, NULL, &saved_wd)) != 0)
			return error;

		if (remove && removable)
			error = checkout_queue_remove(data, saved_wd.path);

		if (!error && over) /* restore ITEROVER if needed */
			error = GIT_ITEROVER;
448 449
	}

450
	return error;
451 452
}

453 454 455 456 457 458
static bool submodule_is_config_only(
	checkout_data *data,
	const char *path)
{
	git_submodule *sm = NULL;
	unsigned int sm_loc = 0;
459
	bool rval = false;
460

461
	if (git_submodule_lookup(&sm, data->repo, path) < 0)
462 463
		return true;

464 465 466 467 468 469
	if (git_submodule_location(&sm_loc, sm) < 0 ||
		sm_loc == GIT_SUBMODULE_STATUS_IN_CONFIG)
		rval = true;

	git_submodule_free(sm);

470
	return rval;
471 472
}

473 474
static bool checkout_is_empty_dir(checkout_data *data, const char *path)
{
475 476 477
	git_buf *fullpath;

	if (checkout_target_fullpath(&fullpath, data, path) < 0)
478
		return false;
479 480

	return git_path_is_empty_dir(fullpath->ptr);
481 482
}

483
static int checkout_action_with_wd(
484
	int *action,
485 486
	checkout_data *data,
	const git_diff_delta *delta,
487
	git_iterator *workdir,
488 489
	const git_index_entry *wd)
{
490
	*action = CHECKOUT_ACTION__NONE;
491 492 493

	switch (delta->status) {
	case GIT_DELTA_UNMODIFIED: /* case 14/15 or 33 */
494
		if (checkout_is_workdir_modified(data, &delta->old_file, &delta->new_file, wd)) {
495 496 497
			GITERR_CHECK_ERROR(
				checkout_notify(data, GIT_CHECKOUT_NOTIFY_DIRTY, delta, wd) );
			*action = CHECKOUT_ACTION_IF(FORCE, UPDATE_BLOB, NONE);
498
		}
499 500
		break;
	case GIT_DELTA_ADDED: /* case 3, 4 or 6 */
501 502 503 504
		if (git_iterator_current_is_ignored(workdir))
			*action = CHECKOUT_ACTION_IF(DONT_OVERWRITE_IGNORED, CONFLICT, UPDATE_BLOB);
		else
			*action = CHECKOUT_ACTION_IF(FORCE, UPDATE_BLOB, CONFLICT);
505 506
		break;
	case GIT_DELTA_DELETED: /* case 9 or 10 (or 26 but not really) */
507
		if (checkout_is_workdir_modified(data, &delta->old_file, &delta->new_file, wd))
508
			*action = CHECKOUT_ACTION_IF(FORCE, REMOVE, CONFLICT);
509
		else
510
			*action = CHECKOUT_ACTION_IF(SAFE, REMOVE, NONE);
511 512
		break;
	case GIT_DELTA_MODIFIED: /* case 16, 17, 18 (or 36 but not really) */
513 514
		if (wd->mode != GIT_FILEMODE_COMMIT &&
			checkout_is_workdir_modified(data, &delta->old_file, &delta->new_file, wd))
515
			*action = CHECKOUT_ACTION_IF(FORCE, UPDATE_BLOB, CONFLICT);
516
		else
517
			*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
518 519
		break;
	case GIT_DELTA_TYPECHANGE: /* case 22, 23, 29, 30 */
520 521 522 523 524
		if (delta->old_file.mode == GIT_FILEMODE_TREE) {
			if (wd->mode == GIT_FILEMODE_TREE)
				/* either deleting items in old tree will delete the wd dir,
				 * or we'll get a conflict when we attempt blob update...
				 */
525
				*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
526 527 528 529 530
			else if (wd->mode == GIT_FILEMODE_COMMIT) {
				/* workdir is possibly a "phantom" submodule - treat as a
				 * tree if the only submodule info came from the config
				 */
				if (submodule_is_config_only(data, wd->path))
531
					*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
532
				else
533
					*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
534
			} else
535
				*action = CHECKOUT_ACTION_IF(FORCE, REMOVE, CONFLICT);
536
		}
537
		else if (checkout_is_workdir_modified(data, &delta->old_file, &delta->new_file, wd))
538
			*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
539
		else
540
			*action = CHECKOUT_ACTION_IF(SAFE, REMOVE_AND_UPDATE, NONE);
541 542 543

		/* don't update if the typechange is to a tree */
		if (delta->new_file.mode == GIT_FILEMODE_TREE)
544
			*action = (*action & ~CHECKOUT_ACTION__UPDATE_BLOB);
545 546 547
		break;
	default: /* impossible */
		break;
548 549
	}

550
	return checkout_action_common(action, data, delta, wd);
551
}
552

553
static int checkout_action_with_wd_blocker(
554
	int *action,
555 556 557 558
	checkout_data *data,
	const git_diff_delta *delta,
	const git_index_entry *wd)
{
559
	*action = CHECKOUT_ACTION__NONE;
560

561 562 563
	switch (delta->status) {
	case GIT_DELTA_UNMODIFIED:
		/* should show delta as dirty / deleted */
564 565 566
		GITERR_CHECK_ERROR(
			checkout_notify(data, GIT_CHECKOUT_NOTIFY_DIRTY, delta, wd) );
		*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, NONE);
567 568 569
		break;
	case GIT_DELTA_ADDED:
	case GIT_DELTA_MODIFIED:
570
		*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
571 572
		break;
	case GIT_DELTA_DELETED:
573
		*action = CHECKOUT_ACTION_IF(FORCE, REMOVE, CONFLICT);
574 575 576
		break;
	case GIT_DELTA_TYPECHANGE:
		/* not 100% certain about this... */
577
		*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
578 579 580
		break;
	default: /* impossible */
		break;
581 582
	}

583
	return checkout_action_common(action, data, delta, wd);
584 585 586
}

static int checkout_action_with_wd_dir(
587
	int *action,
588 589
	checkout_data *data,
	const git_diff_delta *delta,
590
	git_iterator *workdir,
591 592
	const git_index_entry *wd)
{
593
	*action = CHECKOUT_ACTION__NONE;
594 595 596

	switch (delta->status) {
	case GIT_DELTA_UNMODIFIED: /* case 19 or 24 (or 34 but not really) */
597 598 599 600
		GITERR_CHECK_ERROR(
			checkout_notify(data, GIT_CHECKOUT_NOTIFY_DIRTY, delta, NULL));
		GITERR_CHECK_ERROR(
			checkout_notify(data, GIT_CHECKOUT_NOTIFY_UNTRACKED, NULL, wd));
601
		*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, NONE);
602 603 604
		break;
	case GIT_DELTA_ADDED:/* case 4 (and 7 for dir) */
	case GIT_DELTA_MODIFIED: /* case 20 (or 37 but not really) */
605 606 607
		if (delta->old_file.mode == GIT_FILEMODE_COMMIT)
			/* expected submodule (and maybe found one) */;
		else if (delta->new_file.mode != GIT_FILEMODE_TREE)
608 609 610
			*action = git_iterator_current_is_ignored(workdir) ?
				CHECKOUT_ACTION_IF(DONT_OVERWRITE_IGNORED, CONFLICT, REMOVE_AND_UPDATE) :
				CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
611 612
		break;
	case GIT_DELTA_DELETED: /* case 11 (and 27 for dir) */
613 614 615
		if (delta->old_file.mode != GIT_FILEMODE_TREE)
			GITERR_CHECK_ERROR(
				checkout_notify(data, GIT_CHECKOUT_NOTIFY_UNTRACKED, NULL, wd));
616 617 618
		break;
	case GIT_DELTA_TYPECHANGE: /* case 24 or 31 */
		if (delta->old_file.mode == GIT_FILEMODE_TREE) {
619 620 621 622 623 624
			/* For typechange from dir, remove dir and add blob, but it is
			 * not safe to remove dir if it contains modified files.
			 * However, safely removing child files will remove the parent
			 * directory if is it left empty, so we can defer removing the
			 * dir and it will succeed if no children are left.
			 */
625
			*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
626
		}
627 628
		else if (delta->new_file.mode != GIT_FILEMODE_TREE)
			/* For typechange to dir, dir is already created so no action */
629
			*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
630 631 632
		break;
	default: /* impossible */
		break;
633 634
	}

635
	return checkout_action_common(action, data, delta, wd);
636 637
}

638 639 640 641 642 643 644 645 646 647 648 649 650 651
static int checkout_action_with_wd_dir_empty(
	int *action,
	checkout_data *data,
	const git_diff_delta *delta)
{
	int error = checkout_action_no_wd(action, data, delta);

	/* We can always safely remove an empty directory. */
	if (error == 0 && *action != CHECKOUT_ACTION__NONE)
		*action |= CHECKOUT_ACTION__REMOVE;

	return error;
}

652
static int checkout_action(
653
	int *action,
654
	checkout_data *data,
655
	git_diff_delta *delta,
656
	git_iterator *workdir,
657
	const git_index_entry **wditem,
658 659
	git_vector *pathspec)
{
660
	int cmp = -1, error;
661 662
	int (*strcomp)(const char *, const char *) = data->diff->strcomp;
	int (*pfxcomp)(const char *str, const char *pfx) = data->diff->pfxcomp;
663
	int (*advance)(const git_index_entry **, git_iterator *) = NULL;
664 665 666 667

	/* move workdir iterator to follow along with deltas */

	while (1) {
668 669
		const git_index_entry *wd = *wditem;

670
		if (!wd)
671
			return checkout_action_no_wd(action, data, delta);
672

673 674 675 676 677 678 679 680 681 682 683 684 685
		cmp = strcomp(wd->path, delta->old_file.path);

		/* 1. wd before delta ("a/a" before "a/b")
		 * 2. wd prefixes delta & should expand ("a/" before "a/b")
		 * 3. wd prefixes delta & cannot expand ("a/b" before "a/b/c")
		 * 4. wd equals delta ("a/b" and "a/b")
		 * 5. wd after delta & delta prefixes wd ("a/b/c" after "a/b/" or "a/b")
		 * 6. wd after delta ("a/c" after "a/b")
		 */

		if (cmp < 0) {
			cmp = pfxcomp(delta->old_file.path, wd->path);

686
			if (cmp == 0) {
687 688
				if (wd->mode == GIT_FILEMODE_TREE) {
					/* case 2 - entry prefixed by workdir tree */
689
					error = git_iterator_advance_into(wditem, workdir);
690 691
					if (error < 0 && error != GIT_ITEROVER)
						goto done;
692 693 694 695 696
					continue;
				}

				/* case 3 maybe - wd contains non-dir where dir expected */
				if (delta->old_file.path[strlen(wd->path)] == '/') {
697 698 699 700
					error = checkout_action_with_wd_blocker(
						action, data, delta, wd);
					advance = git_iterator_advance;
					goto done;
701
				}
702
			}
703

704
			/* case 1 - handle wd item (if it matches pathspec) */
705 706
			error = checkout_action_wd_only(data, workdir, wditem, pathspec);
			if (error && error != GIT_ITEROVER)
707
				goto done;
708 709
			continue;
		}
710

711 712
		if (cmp == 0) {
			/* case 4 */
713
			error = checkout_action_with_wd(action, data, delta, workdir, wd);
714 715
			advance = git_iterator_advance;
			goto done;
716
		}
717

718
		cmp = pfxcomp(wd->path, delta->old_file.path);
719

720
		if (cmp == 0) { /* case 5 */
721
			if (wd->path[strlen(delta->old_file.path)] != '/')
722
				return checkout_action_no_wd(action, data, delta);
723 724 725

			if (delta->status == GIT_DELTA_TYPECHANGE) {
				if (delta->old_file.mode == GIT_FILEMODE_TREE) {
726
					error = checkout_action_with_wd(action, data, delta, workdir, wd);
727 728
					advance = git_iterator_advance_into;
					goto done;
729 730 731 732 733 734
				}

				if (delta->new_file.mode == GIT_FILEMODE_TREE ||
					delta->new_file.mode == GIT_FILEMODE_COMMIT ||
					delta->old_file.mode == GIT_FILEMODE_COMMIT)
				{
735
					error = checkout_action_with_wd(action, data, delta, workdir, wd);
736 737
					advance = git_iterator_advance;
					goto done;
738
				}
739 740
			}

741 742 743
			return checkout_is_empty_dir(data, wd->path) ?
				checkout_action_with_wd_dir_empty(action, data, delta) :
				checkout_action_with_wd_dir(action, data, delta, workdir, wd);
744
		}
745

746
		/* case 6 - wd is after delta */
747
		return checkout_action_no_wd(action, data, delta);
748 749
	}

750 751 752 753 754 755 756 757 758
done:
	if (!error && advance != NULL &&
		(error = advance(wditem, workdir)) < 0) {
		*wditem = NULL;
		if (error == GIT_ITEROVER)
			error = 0;
	}

	return error;
759 760
}

761 762 763 764 765 766 767 768
static int checkout_remaining_wd_items(
	checkout_data *data,
	git_iterator *workdir,
	const git_index_entry *wd,
	git_vector *spec)
{
	int error = 0;

769 770
	while (wd && !error)
		error = checkout_action_wd_only(data, workdir, &wd, spec);
771

772 773 774
	if (error == GIT_ITEROVER)
		error = 0;

775 776 777
	return error;
}

778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
GIT_INLINE(int) checkout_idxentry_cmp(
	const git_index_entry *a,
	const git_index_entry *b)
{
	if (!a && !b)
		return 0;
	else if (!a && b)
		return -1;
	else if(a && !b)
		return 1;
	else
		return strcmp(a->path, b->path);
}

static int checkout_conflictdata_cmp(const void *a, const void *b)
{
	const checkout_conflictdata *ca = a;
	const checkout_conflictdata *cb = b;
	int diff;

	if ((diff = checkout_idxentry_cmp(ca->ancestor, cb->ancestor)) == 0 &&
		(diff = checkout_idxentry_cmp(ca->ours, cb->theirs)) == 0)
		diff = checkout_idxentry_cmp(ca->theirs, cb->theirs);

	return diff;
}

805 806
int checkout_conflictdata_empty(
	const git_vector *conflicts, size_t idx, void *payload)
807 808 809
{
	checkout_conflictdata *conflict;

810 811
	GIT_UNUSED(payload);

812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848
	if ((conflict = git_vector_get(conflicts, idx)) == NULL)
		return -1;

	if (conflict->ancestor || conflict->ours || conflict->theirs)
		return 0;

	git__free(conflict);
	return 1;
}

GIT_INLINE(bool) conflict_pathspec_match(
	checkout_data *data,
	git_iterator *workdir,
	git_vector *pathspec,
	const git_index_entry *ancestor,
	const git_index_entry *ours,
	const git_index_entry *theirs)
{
	/* if the pathspec matches ours *or* theirs, proceed */
	if (ours && git_pathspec__match(pathspec, ours->path,
		(data->strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH) != 0,
		git_iterator_ignore_case(workdir), NULL, NULL))
		return true;

	if (theirs && git_pathspec__match(pathspec, theirs->path,
		(data->strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH) != 0,
		git_iterator_ignore_case(workdir), NULL, NULL))
		return true;

	if (ancestor && git_pathspec__match(pathspec, ancestor->path,
		(data->strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH) != 0,
		git_iterator_ignore_case(workdir), NULL, NULL))
		return true;

	return false;
}

Edward Thomson committed
849 850 851 852 853 854 855 856
GIT_INLINE(int) checkout_conflict_detect_submodule(checkout_conflictdata *conflict)
{
	conflict->submodule = ((conflict->ancestor && S_ISGITLINK(conflict->ancestor->mode)) ||
		(conflict->ours && S_ISGITLINK(conflict->ours->mode)) ||
		(conflict->theirs && S_ISGITLINK(conflict->theirs->mode)));
	return 0;
}

857 858 859 860 861
GIT_INLINE(int) checkout_conflict_detect_binary(git_repository *repo, checkout_conflictdata *conflict)
{
	git_blob *ancestor_blob = NULL, *our_blob = NULL, *their_blob = NULL;
	int error = 0;

Edward Thomson committed
862 863 864
	if (conflict->submodule)
		return 0;

865
	if (conflict->ancestor) {
866
		if ((error = git_blob_lookup(&ancestor_blob, repo, &conflict->ancestor->id)) < 0)
867 868 869 870 871 872
			goto done;

		conflict->binary = git_blob_is_binary(ancestor_blob);
	}

	if (!conflict->binary && conflict->ours) {
873
		if ((error = git_blob_lookup(&our_blob, repo, &conflict->ours->id)) < 0)
874 875 876 877 878 879
			goto done;

		conflict->binary = git_blob_is_binary(our_blob);
	}

	if (!conflict->binary && conflict->theirs) {
880
		if ((error = git_blob_lookup(&their_blob, repo, &conflict->theirs->id)) < 0)
881 882 883 884 885 886 887 888 889 890 891 892 893
			goto done;

		conflict->binary = git_blob_is_binary(their_blob);
	}

done:
	git_blob_free(ancestor_blob);
	git_blob_free(our_blob);
	git_blob_free(their_blob);

	return error;
}

894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
static int checkout_conflict_append_update(
	const git_index_entry *ancestor,
	const git_index_entry *ours,
	const git_index_entry *theirs,
	void *payload)
{
	checkout_data *data = payload;
	checkout_conflictdata *conflict;
	int error;

	conflict = git__calloc(1, sizeof(checkout_conflictdata));
	GITERR_CHECK_ALLOC(conflict);

	conflict->ancestor = ancestor;
	conflict->ours = ours;
	conflict->theirs = theirs;

	if ((error = checkout_conflict_detect_submodule(conflict)) < 0 ||
		(error = checkout_conflict_detect_binary(data->repo, conflict)) < 0)
	{
		git__free(conflict);
		return error;
	}

	if (git_vector_insert(&data->update_conflicts, conflict))
		return -1;

	return 0;
}

static int checkout_conflicts_foreach(
	checkout_data *data,
	git_index *index,
	git_iterator *workdir,
	git_vector *pathspec,
	int (*cb)(const git_index_entry *, const git_index_entry *, const git_index_entry *, void *),
	void *payload)
931 932 933 934 935
{
	git_index_conflict_iterator *iterator = NULL;
	const git_index_entry *ancestor, *ours, *theirs;
	int error = 0;

936
	if ((error = git_index_conflict_iterator_new(&iterator, index)) < 0)
937 938 939 940 941 942 943
		goto done;

	/* Collect the conflicts */
	while ((error = git_index_conflict_next(&ancestor, &ours, &theirs, iterator)) == 0) {
		if (!conflict_pathspec_match(data, workdir, pathspec, ancestor, ours, theirs))
			continue;

944
		if ((error = cb(ancestor, ours, theirs, payload)) < 0)
945
			goto done;
946 947 948 949 950 951 952 953 954 955 956
	}

	if (error == GIT_ITEROVER)
		error = 0;

done:
	git_index_conflict_iterator_free(iterator);

	return error;
}

957 958 959 960 961
static int checkout_conflicts_load(checkout_data *data, git_iterator *workdir, git_vector *pathspec)
{
	git_index *index;

	/* Only write conficts from sources that have them: indexes. */
962
	if ((index = git_iterator_index(data->target)) == NULL)
963 964 965 966 967 968 969 970 971 972 973 974 975 976
		return 0;

	data->update_conflicts._cmp = checkout_conflictdata_cmp;

	if (checkout_conflicts_foreach(data, index, workdir, pathspec, checkout_conflict_append_update, data) < 0)
		return -1;

	/* Collect the REUC and NAME entries */
	data->update_reuc = &index->reuc;
	data->update_names = &index->names;

	return 0;
}

977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
GIT_INLINE(int) checkout_conflicts_cmp_entry(
	const char *path,
	const git_index_entry *entry)
{
	return strcmp((const char *)path, entry->path);
}

static int checkout_conflicts_cmp_ancestor(const void *p, const void *c)
{
	const char *path = p;
	const checkout_conflictdata *conflict = c;

	if (!conflict->ancestor)
		return 1;

	return checkout_conflicts_cmp_entry(path, conflict->ancestor);
}

static checkout_conflictdata *checkout_conflicts_search_ancestor(
	checkout_data *data,
	const char *path)
{
	size_t pos;

1001
	if (git_vector_bsearch2(&pos, &data->update_conflicts, checkout_conflicts_cmp_ancestor, path) < 0)
1002 1003
		return NULL;

1004
	return git_vector_get(&data->update_conflicts, pos);
1005 1006 1007 1008 1009 1010 1011 1012 1013
}

static checkout_conflictdata *checkout_conflicts_search_branch(
	checkout_data *data,
	const char *path)
{
	checkout_conflictdata *conflict;
	size_t i;

1014
	git_vector_foreach(&data->update_conflicts, i, conflict) {
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 1041 1042 1043 1044 1045 1046
		int cmp = -1;

		if (conflict->ancestor)
			break;

		if (conflict->ours)
			cmp = checkout_conflicts_cmp_entry(path, conflict->ours);
		else if (conflict->theirs)
			cmp = checkout_conflicts_cmp_entry(path, conflict->theirs);

		if (cmp == 0)
			return conflict;
	}

	return NULL;
}

static int checkout_conflicts_load_byname_entry(
	checkout_conflictdata **ancestor_out,
	checkout_conflictdata **ours_out,
	checkout_conflictdata **theirs_out,
	checkout_data *data,
	const git_index_name_entry *name_entry)
{
	checkout_conflictdata *ancestor, *ours = NULL, *theirs = NULL;
	int error = 0;

	*ancestor_out = NULL;
	*ours_out = NULL;
	*theirs_out = NULL;

	if (!name_entry->ancestor) {
1047
		giterr_set(GITERR_INDEX, "a NAME entry exists without an ancestor");
1048 1049 1050 1051 1052
		error = -1;
		goto done;
	}

	if (!name_entry->ours && !name_entry->theirs) {
1053
		giterr_set(GITERR_INDEX, "a NAME entry exists without an ours or theirs");
1054 1055 1056 1057 1058 1059 1060
		error = -1;
		goto done;
	}

	if ((ancestor = checkout_conflicts_search_ancestor(data,
		name_entry->ancestor)) == NULL) {
		giterr_set(GITERR_INDEX,
1061
			"a NAME entry referenced ancestor entry '%s' which does not exist in the main index",
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
			name_entry->ancestor);
		error = -1;
		goto done;
	}

	if (name_entry->ours) {
		if (strcmp(name_entry->ancestor, name_entry->ours) == 0)
			ours = ancestor;
		else if ((ours = checkout_conflicts_search_branch(data, name_entry->ours)) == NULL ||
			ours->ours == NULL) {
			giterr_set(GITERR_INDEX,
1073
				"a NAME entry referenced our entry '%s' which does not exist in the main index",
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
				name_entry->ours);
			error = -1;
			goto done;
		}
	}

	if (name_entry->theirs) {
		if (strcmp(name_entry->ancestor, name_entry->theirs) == 0)
			theirs = ancestor;
		else if (name_entry->ours && strcmp(name_entry->ours, name_entry->theirs) == 0)
			theirs = ours;
		else if ((theirs = checkout_conflicts_search_branch(data, name_entry->theirs)) == NULL ||
			theirs->theirs == NULL) {
			giterr_set(GITERR_INDEX,
1088
				"a NAME entry referenced their entry '%s' which does not exist in the main index",
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
				name_entry->theirs);
			error = -1;
			goto done;
		}
	}

	*ancestor_out = ancestor;
	*ours_out = ours;
	*theirs_out = theirs;

done:
	return error;
}

static int checkout_conflicts_coalesce_renames(
	checkout_data *data)
{
1106
	git_index *index;
1107 1108 1109 1110 1111
	const git_index_name_entry *name_entry;
	checkout_conflictdata *ancestor_conflict, *our_conflict, *their_conflict;
	size_t i, names;
	int error = 0;

1112
	if ((index = git_iterator_index(data->target)) == NULL)
1113 1114
		return 0;

1115
	/* Juggle entries based on renames */
1116
	names = git_index_name_entrycount(index);
Russell Belfer committed
1117

1118
	for (i = 0; i < names; i++) {
1119
		name_entry = git_index_name_get_byindex(index, i);
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

		if ((error = checkout_conflicts_load_byname_entry(
			&ancestor_conflict, &our_conflict, &their_conflict,
			data, name_entry)) < 0)
			goto done;

		if (our_conflict && our_conflict != ancestor_conflict) {
			ancestor_conflict->ours = our_conflict->ours;
			our_conflict->ours = NULL;

			if (our_conflict->theirs)
				our_conflict->name_collision = 1;

			if (our_conflict->name_collision)
				ancestor_conflict->name_collision = 1;
		}

		if (their_conflict && their_conflict != ancestor_conflict) {
			ancestor_conflict->theirs = their_conflict->theirs;
			their_conflict->theirs = NULL;

			if (their_conflict->ours)
				their_conflict->name_collision = 1;

			if (their_conflict->name_collision)
				ancestor_conflict->name_collision = 1;
		}

		if (our_conflict && our_conflict != ancestor_conflict &&
			their_conflict && their_conflict != ancestor_conflict)
			ancestor_conflict->one_to_two = 1;
	}

1153
	git_vector_remove_matching(
1154
		&data->update_conflicts, checkout_conflictdata_empty, NULL);
1155 1156 1157 1158 1159 1160 1161 1162

done:
	return error;
}

static int checkout_conflicts_mark_directoryfile(
	checkout_data *data)
{
1163
	git_index *index;
1164 1165 1166 1167
	checkout_conflictdata *conflict;
	const git_index_entry *entry;
	size_t i, j, len;
	const char *path;
1168
	int prefixed, error = 0;
1169

1170
	if ((index = git_iterator_index(data->target)) == NULL)
1171 1172 1173
		return 0;

	len = git_index_entrycount(index);
1174 1175

	/* Find d/f conflicts */
1176
	git_vector_foreach(&data->update_conflicts, i, conflict) {
1177 1178 1179 1180 1181 1182 1183
		if ((conflict->ours && conflict->theirs) ||
			(!conflict->ours && !conflict->theirs))
			continue;

		path = conflict->ours ?
			conflict->ours->path : conflict->theirs->path;

1184
		if ((error = git_index_find(&j, index, path)) < 0) {
1185 1186
			if (error == GIT_ENOTFOUND)
				giterr_set(GITERR_INDEX,
1187
					"index inconsistency, could not find entry for expected conflict '%s'", path);
1188 1189 1190 1191 1192

			goto done;
		}

		for (; j < len; j++) {
1193
			if ((entry = git_index_get_byindex(index, j)) == NULL) {
1194
				giterr_set(GITERR_INDEX,
1195
					"index inconsistency, truncated index while loading expected conflict '%s'", path);
1196 1197 1198 1199
				error = -1;
				goto done;
			}

1200
			prefixed = git_path_equal_or_prefixed(path, entry->path, NULL);
1201

1202
			if (prefixed == GIT_PATH_EQUAL)
1203 1204
				continue;

1205
			if (prefixed == GIT_PATH_PREFIX)
1206 1207 1208 1209 1210 1211 1212 1213 1214 1215
				conflict->directoryfile = 1;

			break;
		}
	}

done:
	return error;
}

1216
static int checkout_get_update_conflicts(
1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
	checkout_data *data,
	git_iterator *workdir,
	git_vector *pathspec)
{
	int error = 0;

	if (data->strategy & GIT_CHECKOUT_SKIP_UNMERGED)
		return 0;

	if ((error = checkout_conflicts_load(data, workdir, pathspec)) < 0 ||
		(error = checkout_conflicts_coalesce_renames(data)) < 0 ||
		(error = checkout_conflicts_mark_directoryfile(data)) < 0)
		goto done;

done:
	return error;
}

1235 1236 1237 1238 1239 1240 1241 1242 1243
static int checkout_conflict_append_remove(
	const git_index_entry *ancestor,
	const git_index_entry *ours,
	const git_index_entry *theirs,
	void *payload)
{
	checkout_data *data = payload;
	const char *name;

1244 1245
	assert(ancestor || ours || theirs);

1246 1247 1248 1249 1250 1251
	if (ancestor)
		name = git__strdup(ancestor->path);
	else if (ours)
		name = git__strdup(ours->path);
	else if (theirs)
		name = git__strdup(theirs->path);
1252 1253
	else
		abort();
1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270

	GITERR_CHECK_ALLOC(name);

	return git_vector_insert(&data->remove_conflicts, (char *)name);
}

static int checkout_get_remove_conflicts(
	checkout_data *data,
	git_iterator *workdir,
	git_vector *pathspec)
{
	if ((data->strategy & GIT_CHECKOUT_DONT_UPDATE_INDEX) != 0)
		return 0;

	return checkout_conflicts_foreach(data, data->index, workdir, pathspec, checkout_conflict_append_remove, data);
}

1271 1272 1273 1274 1275
static int checkout_verify_paths(
	git_repository *repo,
	int action,
	git_diff_delta *delta)
{
1276
	unsigned int flags = GIT_PATH_REJECT_WORKDIR_DEFAULTS;
1277 1278

	if (action & CHECKOUT_ACTION__REMOVE) {
1279
		if (!git_path_isvalid(repo, delta->old_file.path, delta->old_file.mode, flags)) {
1280
			giterr_set(GITERR_CHECKOUT, "cannot remove invalid path '%s'", delta->old_file.path);
1281 1282 1283 1284 1285
			return -1;
		}
	}

	if (action & ~CHECKOUT_ACTION__REMOVE) {
1286
		if (!git_path_isvalid(repo, delta->new_file.path, delta->new_file.mode, flags)) {
1287
			giterr_set(GITERR_CHECKOUT, "cannot checkout to invalid path '%s'", delta->new_file.path);
1288 1289 1290 1291 1292 1293 1294
			return -1;
		}
	}

	return 0;
}

1295 1296 1297
static int checkout_get_actions(
	uint32_t **actions_ptr,
	size_t **counts_ptr,
1298 1299
	checkout_data *data,
	git_iterator *workdir)
1300
{
1301
	int error = 0, act;
1302 1303
	const git_index_entry *wditem;
	git_vector pathspec = GIT_VECTOR_INIT, *deltas;
1304
	git_pool pathpool;
1305 1306 1307 1308
	git_diff_delta *delta;
	size_t i, *counts = NULL;
	uint32_t *actions = NULL;

1309 1310
	git_pool_init(&pathpool, 1);

1311
	if (data->opts.paths.count > 0 &&
1312
		git_pathspec__vinit(&pathspec, &data->opts.paths, &pathpool) < 0)
1313 1314
		return -1;

1315 1316
	if ((error = git_iterator_current(&wditem, workdir)) < 0 &&
		error != GIT_ITEROVER)
1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329
		goto fail;

	deltas = &data->diff->deltas;

	*counts_ptr = counts = git__calloc(CHECKOUT_ACTION__MAX+1, sizeof(size_t));
	*actions_ptr = actions = git__calloc(
		deltas->length ? deltas->length : 1, sizeof(uint32_t));
	if (!counts || !actions) {
		error = -1;
		goto fail;
	}

	git_vector_foreach(deltas, i, delta) {
1330 1331 1332
		if ((error = checkout_action(&act, data, delta, workdir, &wditem, &pathspec)) == 0)
			error = checkout_verify_paths(data->repo, act, delta);

1333
		if (error != 0)
1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346
			goto fail;

		actions[i] = act;

		if (act & CHECKOUT_ACTION__REMOVE)
			counts[CHECKOUT_ACTION__REMOVE]++;
		if (act & CHECKOUT_ACTION__UPDATE_BLOB)
			counts[CHECKOUT_ACTION__UPDATE_BLOB]++;
		if (act & CHECKOUT_ACTION__UPDATE_SUBMODULE)
			counts[CHECKOUT_ACTION__UPDATE_SUBMODULE]++;
		if (act & CHECKOUT_ACTION__CONFLICT)
			counts[CHECKOUT_ACTION__CONFLICT]++;
	}
1347

1348
	error = checkout_remaining_wd_items(data, workdir, wditem, &pathspec);
1349
	if (error)
1350
		goto fail;
1351

1352 1353 1354 1355 1356
	counts[CHECKOUT_ACTION__REMOVE] += data->removes.length;

	if (counts[CHECKOUT_ACTION__CONFLICT] > 0 &&
		(data->strategy & GIT_CHECKOUT_ALLOW_CONFLICTS) == 0)
	{
1357 1358
		giterr_set(GITERR_CHECKOUT, "%"PRIuZ" %s checkout",
			counts[CHECKOUT_ACTION__CONFLICT],
1359 1360
			counts[CHECKOUT_ACTION__CONFLICT] == 1 ?
			"conflict prevents" : "conflicts prevent");
1361
		error = GIT_ECONFLICT;
1362 1363 1364
		goto fail;
	}

1365

1366 1367
	if ((error = checkout_get_remove_conflicts(data, workdir, &pathspec)) < 0 ||
		(error = checkout_get_update_conflicts(data, workdir, &pathspec)) < 0)
1368 1369
		goto fail;

1370 1371
	counts[CHECKOUT_ACTION__REMOVE_CONFLICT] = git_vector_length(&data->remove_conflicts);
	counts[CHECKOUT_ACTION__UPDATE_CONFLICT] = git_vector_length(&data->update_conflicts);
1372

1373
	git_pathspec__vfree(&pathspec);
1374 1375 1376 1377 1378 1379 1380 1381 1382 1383
	git_pool_clear(&pathpool);

	return 0;

fail:
	*counts_ptr = NULL;
	git__free(counts);
	*actions_ptr = NULL;
	git__free(actions);

1384
	git_pathspec__vfree(&pathspec);
1385 1386 1387 1388 1389
	git_pool_clear(&pathpool);

	return error;
}

1390 1391
static bool should_remove_existing(checkout_data *data)
{
1392
	int ignorecase;
1393

1394 1395 1396
	if (git_repository__cvar(&ignorecase, data->repo, GIT_CVAR_IGNORECASE) < 0) {
		ignorecase = 0;
	}
1397 1398 1399 1400 1401 1402 1403 1404 1405 1406

	return (ignorecase &&
		(data->strategy & GIT_CHECKOUT_DONT_REMOVE_EXISTING) == 0);
}

#define MKDIR_NORMAL \
	GIT_MKDIR_PATH | GIT_MKDIR_VERIFY_DIR
#define MKDIR_REMOVE_EXISTING \
	MKDIR_NORMAL | GIT_MKDIR_REMOVE_FILES | GIT_MKDIR_REMOVE_SYMLINKS

1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419
static int checkout_mkdir(
	checkout_data *data,
	const char *path,
	const char *base,
	mode_t mode,
	unsigned int flags)
{
	struct git_futils_mkdir_options mkdir_opts = {0};
	int error;

	mkdir_opts.dir_map = data->mkdir_map;
	mkdir_opts.pool = &data->pool;

1420
	error = git_futils_mkdir_relative(
1421 1422 1423 1424 1425 1426 1427 1428 1429
		path, base, mode, flags, &mkdir_opts);

	data->perfdata.mkdir_calls += mkdir_opts.perfdata.mkdir_calls;
	data->perfdata.stat_calls += mkdir_opts.perfdata.stat_calls;
	data->perfdata.chmod_calls += mkdir_opts.perfdata.chmod_calls;

	return error;
}

1430 1431 1432
static int mkpath2file(
	checkout_data *data, const char *path, unsigned int mode)
{
1433 1434
	struct stat st;
	bool remove_existing = should_remove_existing(data);
1435 1436 1437
	unsigned int flags =
		(remove_existing ? MKDIR_REMOVE_EXISTING : MKDIR_NORMAL) |
		GIT_MKDIR_SKIP_LAST;
1438 1439
	int error;

1440 1441
	if ((error = checkout_mkdir(
			data, path, data->opts.target_directory, mode, flags)) < 0)
1442 1443
		return error;

1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455
	if (remove_existing) {
		data->perfdata.stat_calls++;

		if (p_lstat(path, &st) == 0) {

			/* Some file, symlink or folder already exists at this name.
			 * We would have removed it in remove_the_old unless we're on
			 * a case inensitive filesystem (or the user has asked us not
			 * to).  Remove the similarly named file to write the new.
			 */
			error = git_futils_rmdir_r(path, NULL, GIT_RMDIR_REMOVE_FILES);
		} else if (errno != ENOENT) {
1456
			giterr_set(GITERR_OS, "failed to stat '%s'", path);
1457 1458 1459 1460 1461
			return GIT_EEXISTS;
		} else {
			giterr_clear();
		}
	}
1462 1463

	return error;
1464 1465
}

1466
struct checkout_stream {
1467
	git_writestream base;
1468 1469 1470 1471
	const char *path;
	int fd;
	int open;
};
1472

1473
static int checkout_stream_write(
1474
	git_writestream *s, const char *buffer, size_t len)
1475 1476 1477
{
	struct checkout_stream *stream = (struct checkout_stream *)s;
	int ret;
1478

1479
	if ((ret = p_write(stream->fd, buffer, len)) < 0)
1480
		giterr_set(GITERR_OS, "could not write to '%s'", stream->path);
1481

1482 1483
	return ret;
}
1484

1485
static int checkout_stream_close(git_writestream *s)
1486 1487 1488
{
	struct checkout_stream *stream = (struct checkout_stream *)s;
	assert(stream && stream->open);
1489

1490
	stream->open = 0;
1491
	return p_close(stream->fd);
1492
}
1493

1494
static void checkout_stream_free(git_writestream *s)
1495 1496
{
	GIT_UNUSED(s);
Ben Straub committed
1497 1498
}

1499
static int blob_content_to_file(
1500
	checkout_data *data,
1501
	struct stat *st,
1502 1503
	git_blob *blob,
	const char *path,
1504
	const char *hint_path,
1505
	mode_t entry_filemode)
1506
{
1507
	int flags = data->opts.file_open_flags;
1508 1509
	mode_t file_mode = data->opts.file_mode ?
		data->opts.file_mode : entry_filemode;
1510
	git_filter_options filter_opts = GIT_FILTER_OPTIONS_INIT;
1511 1512
	struct checkout_stream writer;
	mode_t mode;
1513
	git_filter_list *fl = NULL;
1514
	int fd;
1515
	int error = 0;
1516

1517 1518 1519
	if (hint_path == NULL)
		hint_path = path;

1520 1521 1522 1523 1524 1525 1526 1527 1528
	if ((error = mkpath2file(data, path, data->opts.dir_mode)) < 0)
		return error;

	if (flags <= 0)
		flags = O_CREAT | O_TRUNC | O_WRONLY;
	if (!(mode = file_mode))
		mode = GIT_FILEMODE_BLOB;

	if ((fd = p_open(path, flags, mode)) < 0) {
1529
		giterr_set(GITERR_OS, "could not open '%s' for writing", path);
1530 1531 1532
		return fd;
	}

1533
	filter_opts.attr_session = &data->attr_session;
1534
	filter_opts.temp_buf = &data->tmp;
1535

1536
	if (!data->opts.disable_filters &&
1537 1538
		(error = git_filter_list__load_ext(
			&fl, data->repo, blob, hint_path,
1539 1540
			GIT_FILTER_TO_WORKTREE, &filter_opts))) {
		p_close(fd);
1541
		return error;
1542
	}
1543 1544 1545 1546 1547 1548 1549 1550 1551 1552

	/* setup the writer */
	memset(&writer, 0, sizeof(struct checkout_stream));
	writer.base.write = checkout_stream_write;
	writer.base.close = checkout_stream_close;
	writer.base.free = checkout_stream_free;
	writer.path = path;
	writer.fd = fd;
	writer.open = 1;

Leo Yang committed
1553
	error = git_filter_list_stream_blob(fl, blob, &writer.base);
1554

1555
	assert(writer.open == 0);
1556

1557
	git_filter_list_free(fl);
1558

1559 1560
	if (error < 0)
		return error;
1561

1562 1563 1564 1565
	if (st) {
		data->perfdata.stat_calls++;

		if ((error = p_stat(path, st)) < 0) {
1566
			giterr_set(GITERR_OS, "failed to stat '%s'", path);
1567 1568 1569 1570 1571 1572 1573
			return error;
		}

		st->st_mode = entry_filemode;
	}

	return 0;
1574 1575
}

1576
static int blob_content_to_link(
1577
	checkout_data *data,
1578 1579
	struct stat *st,
	git_blob *blob,
1580
	const char *path)
1581 1582 1583
{
	git_buf linktarget = GIT_BUF_INIT;
	int error;
1584

1585
	if ((error = mkpath2file(data, path, data->opts.dir_mode)) < 0)
Linquize committed
1586
		return error;
1587

1588 1589
	if ((error = git_blob__getbuf(&linktarget, blob)) < 0)
		return error;
1590

1591
	if (data->can_symlink) {
1592
		if ((error = p_symlink(git_buf_cstr(&linktarget), path)) < 0)
1593
			giterr_set(GITERR_OS, "could not create symlink %s", path);
1594
	} else {
1595
		error = git_futils_fake_symlink(git_buf_cstr(&linktarget), path);
1596 1597 1598
	}

	if (!error) {
1599 1600
		data->perfdata.stat_calls++;

1601
		if ((error = p_lstat(path, st)) < 0)
1602
			giterr_set(GITERR_CHECKOUT, "could not stat symlink %s", path);
1603 1604 1605

		st->st_mode = GIT_FILEMODE_LINK;
	}
1606

1607 1608 1609
	git_buf_free(&linktarget);

	return error;
1610 1611
}

1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623
static int checkout_update_index(
	checkout_data *data,
	const git_diff_file *file,
	struct stat *st)
{
	git_index_entry entry;

	if (!data->index)
		return 0;

	memset(&entry, 0, sizeof(entry));
	entry.path = (char *)file->path; /* cast to prevent warning */
1624
	git_index_entry__init_from_stat(&entry, st, true);
1625
	git_oid_cpy(&entry.id, &file->id);
1626 1627 1628 1629

	return git_index_add(data->index, &entry);
}

1630 1631 1632 1633
static int checkout_submodule_update_index(
	checkout_data *data,
	const git_diff_file *file)
{
1634
	git_buf *fullpath;
1635 1636 1637 1638 1639 1640
	struct stat st;

	/* update the index unless prevented */
	if ((data->strategy & GIT_CHECKOUT_DONT_UPDATE_INDEX) != 0)
		return 0;

1641
	if (checkout_target_fullpath(&fullpath, data, file->path) < 0)
1642 1643
		return -1;

1644
	data->perfdata.stat_calls++;
1645
	if (p_stat(fullpath->ptr, &st) < 0) {
1646
		giterr_set(
1647
			GITERR_CHECKOUT, "could not stat submodule %s\n", file->path);
1648 1649 1650 1651 1652 1653 1654 1655
		return GIT_ENOTFOUND;
	}

	st.st_mode = GIT_FILEMODE_COMMIT;

	return checkout_update_index(data, file, &st);
}

1656
static int checkout_submodule(
1657
	checkout_data *data,
1658 1659
	const git_diff_file *file)
{
1660
	bool remove_existing = should_remove_existing(data);
1661 1662
	int error = 0;

1663
	/* Until submodules are supported, UPDATE_ONLY means do nothing here */
1664
	if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0)
1665 1666
		return 0;

1667 1668
	if ((error = checkout_mkdir(
			data,
1669 1670
			file->path, data->opts.target_directory, data->opts.dir_mode,
			remove_existing ? MKDIR_REMOVE_EXISTING : MKDIR_NORMAL)) < 0)
1671
		return error;
1672

1673
	if ((error = git_submodule_lookup(NULL, data->repo, file->path)) < 0) {
1674 1675 1676 1677 1678 1679 1680 1681
		/* I've observed repos with submodules in the tree that do not
		 * have a .gitmodules - core Git just makes an empty directory
		 */
		if (error == GIT_ENOTFOUND) {
			giterr_clear();
			return checkout_submodule_update_index(data, file);
		}

1682
		return error;
1683
	}
1684

1685
	/* TODO: Support checkout_strategy options.  Two circumstances:
1686 1687 1688 1689
	 * 1 - submodule already checked out, but we need to move the HEAD
	 *     to the new OID, or
	 * 2 - submodule not checked out and we should recursively check it out
	 *
1690 1691
	 * Checkout will not execute a pull on the submodule, but a clone
	 * command should probably be able to.  Do we need a submodule callback?
1692 1693
	 */

1694
	return checkout_submodule_update_index(data, file);
1695 1696
}

1697
static void report_progress(
1698
	checkout_data *data,
1699
	const char *path)
1700
{
1701 1702
	if (data->opts.progress_cb)
		data->opts.progress_cb(
1703
			path, data->completed_steps, data->total_steps,
1704
			data->opts.progress_payload);
1705 1706
}

1707 1708
static int checkout_safe_for_update_only(
	checkout_data *data, const char *path, mode_t expected_mode)
1709 1710 1711
{
	struct stat st;

1712 1713
	data->perfdata.stat_calls++;

1714 1715 1716 1717 1718 1719
	if (p_lstat(path, &st) < 0) {
		/* if doesn't exist, then no error and no update */
		if (errno == ENOENT || errno == ENOTDIR)
			return 0;

		/* otherwise, stat error and no update */
1720
		giterr_set(GITERR_OS, "failed to stat '%s'", path);
1721 1722 1723 1724 1725 1726 1727 1728 1729 1730
		return -1;
	}

	/* only safe for update if this is the same type of file */
	if ((st.st_mode & ~0777) == (expected_mode & ~0777))
		return 1;

	return 0;
}

1731
static int checkout_write_content(
1732
	checkout_data *data,
1733 1734 1735 1736 1737
	const git_oid *oid,
	const char *full_path,
	const char *hint_path,
	unsigned int mode,
	struct stat *st)
1738
{
1739
	int error = 0;
1740
	git_blob *blob;
1741

1742
	if ((error = git_blob_lookup(&blob, data->repo, oid)) < 0)
1743 1744
		return error;

1745
	if (S_ISLNK(mode))
1746
		error = blob_content_to_link(data, st, blob, full_path);
1747
	else
1748
		error = blob_content_to_file(data, st, blob, full_path, hint_path, mode);
1749 1750 1751

	git_blob_free(blob);

1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762
	/* if we try to create the blob and an existing directory blocks it from
	 * being written, then there must have been a typechange conflict in a
	 * parent directory - suppress the error and try to continue.
	 */
	if ((data->strategy & GIT_CHECKOUT_ALLOW_CONFLICTS) != 0 &&
		(error == GIT_ENOTFOUND || error == GIT_EEXISTS))
	{
		giterr_clear();
		error = 0;
	}

1763 1764 1765 1766 1767 1768 1769
	return error;
}

static int checkout_blob(
	checkout_data *data,
	const git_diff_file *file)
{
1770
	git_buf *fullpath;
1771
	struct stat st;
1772
	int error = 0;
1773

1774
	if (checkout_target_fullpath(&fullpath, data, file->path) < 0)
1775 1776 1777
		return -1;

	if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0) {
1778
		int rval = checkout_safe_for_update_only(
1779 1780
			data, fullpath->ptr, file->mode);

1781 1782 1783 1784
		if (rval <= 0)
			return rval;
	}

1785
	error = checkout_write_content(
1786
		data, &file->id, fullpath->ptr, NULL, file->mode, &st);
1787

1788 1789 1790 1791
	/* update the index unless prevented */
	if (!error && (data->strategy & GIT_CHECKOUT_DONT_UPDATE_INDEX) == 0)
		error = checkout_update_index(data, file, &st);

1792 1793 1794 1795
	/* update the submodule data if this was a new .gitmodules file */
	if (!error && strcmp(file->path, ".gitmodules") == 0)
		data->reload_submodules = true;

1796 1797 1798
	return error;
}

1799 1800
static int checkout_remove_the_old(
	unsigned int *actions,
1801
	checkout_data *data)
1802
{
1803
	int error = 0;
1804
	git_diff_delta *delta;
1805
	const char *str;
1806
	size_t i;
1807
	git_buf *fullpath;
1808 1809
	uint32_t flg = GIT_RMDIR_EMPTY_PARENTS |
		GIT_RMDIR_REMOVE_FILES | GIT_RMDIR_REMOVE_BLOCKERS;
1810

1811 1812 1813
	if (data->opts.checkout_strategy & GIT_CHECKOUT_SKIP_LOCKED_DIRECTORIES)
		flg |= GIT_RMDIR_SKIP_NONEMPTY;

1814 1815
	if (checkout_target_fullpath(&fullpath, data, NULL) < 0)
		return -1;
1816

1817
	git_vector_foreach(&data->diff->deltas, i, delta) {
1818
		if (actions[i] & CHECKOUT_ACTION__REMOVE) {
1819 1820 1821
			error = git_futils_rmdir_r(
				delta->old_file.path, fullpath->ptr, flg);

1822
			if (error < 0)
1823 1824 1825
				return error;

			data->completed_steps++;
1826
			report_progress(data, delta->old_file.path);
1827 1828 1829 1830 1831 1832 1833

			if ((actions[i] & CHECKOUT_ACTION__UPDATE_BLOB) == 0 &&
				(data->strategy & GIT_CHECKOUT_DONT_UPDATE_INDEX) == 0 &&
				data->index != NULL)
			{
				(void)git_index_remove(data->index, delta->old_file.path, 0);
			}
1834 1835 1836
		}
	}

1837
	git_vector_foreach(&data->removes, i, str) {
1838
		error = git_futils_rmdir_r(str, fullpath->ptr, flg);
1839 1840 1841 1842
		if (error < 0)
			return error;

		data->completed_steps++;
1843
		report_progress(data, str);
1844 1845 1846 1847

		if ((data->strategy & GIT_CHECKOUT_DONT_UPDATE_INDEX) == 0 &&
			data->index != NULL)
		{
1848 1849 1850 1851
			if (str[strlen(str) - 1] == '/')
				(void)git_index_remove_directory(data->index, str, 0);
			else
				(void)git_index_remove(data->index, str, 0);
1852
		}
1853 1854 1855 1856 1857 1858 1859 1860 1861
	}

	return 0;
}

static int checkout_deferred_remove(git_repository *repo, const char *path)
{
#if 0
	int error = git_futils_rmdir_r(
1862
		path, data->opts.target_directory, GIT_RMDIR_EMPTY_PARENTS);
1863 1864 1865 1866 1867 1868 1869 1870 1871 1872

	if (error == GIT_ENOTFOUND) {
		error = 0;
		giterr_clear();
	}

	return error;
#else
	GIT_UNUSED(repo);
	GIT_UNUSED(path);
1873
	assert(false);
1874
	return 0;
1875
#endif
1876 1877 1878 1879
}

static int checkout_create_the_new(
	unsigned int *actions,
1880
	checkout_data *data)
1881
{
1882
	int error = 0;
1883 1884 1885
	git_diff_delta *delta;
	size_t i;

1886
	git_vector_foreach(&data->diff->deltas, i, delta) {
1887 1888 1889 1890 1891 1892 1893 1894 1895
		if (actions[i] & CHECKOUT_ACTION__DEFER_REMOVE) {
			/* this had a blocker directory that should only be removed iff
			 * all of the contents of the directory were safely removed
			 */
			if ((error = checkout_deferred_remove(
					data->repo, delta->old_file.path)) < 0)
				return error;
		}

1896
		if (actions[i] & CHECKOUT_ACTION__UPDATE_BLOB) {
1897
			error = checkout_blob(data, &delta->new_file);
1898
			if (error < 0)
1899 1900 1901
				return error;

			data->completed_steps++;
1902
			report_progress(data, delta->new_file.path);
1903 1904 1905 1906 1907 1908 1909 1910
		}
	}

	return 0;
}

static int checkout_create_submodules(
	unsigned int *actions,
1911
	checkout_data *data)
1912
{
1913
	int error = 0;
1914 1915 1916
	git_diff_delta *delta;
	size_t i;

1917
	git_vector_foreach(&data->diff->deltas, i, delta) {
1918 1919 1920 1921 1922 1923 1924 1925 1926
		if (actions[i] & CHECKOUT_ACTION__DEFER_REMOVE) {
			/* this has a blocker directory that should only be removed iff
			 * all of the contents of the directory were safely removed
			 */
			if ((error = checkout_deferred_remove(
					data->repo, delta->old_file.path)) < 0)
				return error;
		}

1927
		if (actions[i] & CHECKOUT_ACTION__UPDATE_SUBMODULE) {
1928
			int error = checkout_submodule(data, &delta->new_file);
1929 1930 1931 1932
			if (error < 0)
				return error;

			data->completed_steps++;
1933
			report_progress(data, delta->new_file.path);
1934 1935 1936
		}
	}

1937
	return 0;
1938 1939
}

1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954
static int checkout_lookup_head_tree(git_tree **out, git_repository *repo)
{
	int error = 0;
	git_reference *ref = NULL;
	git_object *head;

	if (!(error = git_repository_head(&ref, repo)) &&
		!(error = git_reference_peel(&head, ref, GIT_OBJ_TREE)))
		*out = (git_tree *)head;

	git_reference_free(ref);

	return error;
}

1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991

static int conflict_entry_name(
	git_buf *out,
	const char *side_name,
	const char *filename)
{
	if (git_buf_puts(out, side_name) < 0 ||
		git_buf_putc(out, ':') < 0 ||
		git_buf_puts(out, filename) < 0)
		return -1;

	return 0;
}

static int checkout_path_suffixed(git_buf *path, const char *suffix)
{
	size_t path_len;
	int i = 0, error = 0;

	if ((error = git_buf_putc(path, '~')) < 0 || (error = git_buf_puts(path, suffix)) < 0)
		return -1;

	path_len = git_buf_len(path);

	while (git_path_exists(git_buf_cstr(path)) && i < INT_MAX) {
		git_buf_truncate(path, path_len);

		if ((error = git_buf_putc(path, '_')) < 0 ||
			(error = git_buf_printf(path, "%d", i)) < 0)
			return error;

		i++;
	}

	if (i == INT_MAX) {
		git_buf_truncate(path, path_len);

1992
		giterr_set(GITERR_CHECKOUT, "could not write '%s': working directory file exists", path->ptr);
1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004
		return GIT_EEXISTS;
	}

	return 0;
}

static int checkout_write_entry(
	checkout_data *data,
	checkout_conflictdata *conflict,
	const git_index_entry *side)
{
	const char *hint_path = NULL, *suffix;
2005
	git_buf *fullpath;
2006 2007 2008 2009 2010
	struct stat st;
	int error;

	assert (side == conflict->ours || side == conflict->theirs);

2011
	if (checkout_target_fullpath(&fullpath, data, side->path) < 0)
2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024
		return -1;

	if ((conflict->name_collision || conflict->directoryfile) &&
		(data->strategy & GIT_CHECKOUT_USE_OURS) == 0 &&
		(data->strategy & GIT_CHECKOUT_USE_THEIRS) == 0) {

		if (side == conflict->ours)
			suffix = data->opts.our_label ? data->opts.our_label :
				"ours";
		else
			suffix = data->opts.their_label ? data->opts.their_label :
				"theirs";

2025
		if (checkout_path_suffixed(fullpath, suffix) < 0)
2026 2027 2028 2029 2030 2031
			return -1;

		hint_path = side->path;
	}

	if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0 &&
2032
		(error = checkout_safe_for_update_only(data, fullpath->ptr, side->mode)) <= 0)
2033 2034
		return error;

2035 2036 2037 2038 2039
	if (!S_ISGITLINK(side->mode))
		return checkout_write_content(data,
					      &side->id, fullpath->ptr, hint_path, side->mode, &st);

	return 0;
2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085
}

static int checkout_write_entries(
	checkout_data *data,
	checkout_conflictdata *conflict)
{
	int error = 0;

	if ((error = checkout_write_entry(data, conflict, conflict->ours)) >= 0)
		error = checkout_write_entry(data, conflict, conflict->theirs);

	return error;
}

static int checkout_merge_path(
	git_buf *out,
	checkout_data *data,
	checkout_conflictdata *conflict,
	git_merge_file_result *result)
{
	const char *our_label_raw, *their_label_raw, *suffix;
	int error = 0;

	if ((error = git_buf_joinpath(out, git_repository_workdir(data->repo), result->path)) < 0)
		return error;

	/* Most conflicts simply use the filename in the index */
	if (!conflict->name_collision)
		return 0;

	/* Rename 2->1 conflicts need the branch name appended */
	our_label_raw = data->opts.our_label ? data->opts.our_label : "ours";
	their_label_raw = data->opts.their_label ? data->opts.their_label : "theirs";
	suffix = strcmp(result->path, conflict->ours->path) == 0 ? our_label_raw : their_label_raw;

	if ((error = checkout_path_suffixed(out, suffix)) < 0)
		return error;

	return 0;
}

static int checkout_write_merge(
	checkout_data *data,
	checkout_conflictdata *conflict)
{
	git_buf our_label = GIT_BUF_INIT, their_label = GIT_BUF_INIT,
2086 2087
		path_suffixed = GIT_BUF_INIT, path_workdir = GIT_BUF_INIT,
		in_data = GIT_BUF_INIT, out_data = GIT_BUF_INIT;
2088 2089
	git_merge_file_options opts = GIT_MERGE_FILE_OPTIONS_INIT;
	git_merge_file_result result = {0};
2090
	git_filebuf output = GIT_FILEBUF_INIT;
2091
	git_filter_list *fl = NULL;
2092
	git_filter_options filter_opts = GIT_FILTER_OPTIONS_INIT;
2093 2094
	int error = 0;

2095
	if (data->opts.checkout_strategy & GIT_CHECKOUT_CONFLICT_STYLE_DIFF3)
2096
		opts.flags |= GIT_MERGE_FILE_STYLE_DIFF3;
2097

2098 2099 2100 2101 2102 2103
	opts.ancestor_label = data->opts.ancestor_label ?
		data->opts.ancestor_label : "ancestor";
	opts.our_label = data->opts.our_label ?
		data->opts.our_label : "ours";
	opts.their_label = data->opts.their_label ?
		data->opts.their_label : "theirs";
2104 2105 2106 2107 2108 2109 2110 2111

	/* If all the paths are identical, decorate the diff3 file with the branch
	 * names.  Otherwise, append branch_name:path.
	 */
	if (conflict->ours && conflict->theirs &&
		strcmp(conflict->ours->path, conflict->theirs->path) != 0) {

		if ((error = conflict_entry_name(
2112
			&our_label, opts.our_label, conflict->ours->path)) < 0 ||
2113
			(error = conflict_entry_name(
2114
			&their_label, opts.their_label, conflict->theirs->path)) < 0)
2115 2116
			goto done;

2117 2118
		opts.our_label = git_buf_cstr(&our_label);
		opts.their_label = git_buf_cstr(&their_label);
2119 2120
	}

2121 2122
	if ((error = git_merge_file_from_index(&result, data->repo,
		conflict->ancestor, conflict->ours, conflict->theirs, &opts)) < 0)
2123 2124 2125
		goto done;

	if (result.path == NULL || result.mode == 0) {
2126
		giterr_set(GITERR_CHECKOUT, "could not merge contents of file");
2127
		error = GIT_ECONFLICT;
2128 2129 2130 2131 2132 2133 2134
		goto done;
	}

	if ((error = checkout_merge_path(&path_workdir, data, conflict, &result)) < 0)
		goto done;

	if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0 &&
2135
		(error = checkout_safe_for_update_only(data, git_buf_cstr(&path_workdir), result.mode)) <= 0)
2136 2137
		goto done;

2138
	if (!data->opts.disable_filters) {
2139 2140 2141
		in_data.ptr = (char *)result.ptr;
		in_data.size = result.len;

2142
		filter_opts.attr_session = &data->attr_session;
2143
		filter_opts.temp_buf = &data->tmp;
2144 2145 2146 2147

		if ((error = git_filter_list__load_ext(
				&fl, data->repo, NULL, git_buf_cstr(&path_workdir),
				GIT_FILTER_TO_WORKTREE, &filter_opts)) < 0 ||
2148 2149
			(error = git_filter_list_apply_to_data(&out_data, fl, &in_data)) < 0)
			goto done;
2150 2151 2152 2153
	} else {
		out_data.ptr = (char *)result.ptr;
		out_data.size = result.len;
	}
2154

2155
	if ((error = mkpath2file(data, path_workdir.ptr, data->opts.dir_mode)) < 0 ||
2156 2157
		(error = git_filebuf_open(&output, git_buf_cstr(&path_workdir), GIT_FILEBUF_DO_NOT_BUFFER, result.mode)) < 0 ||
		(error = git_filebuf_write(&output, out_data.ptr, out_data.size)) < 0 ||
2158
		(error = git_filebuf_commit(&output)) < 0)
2159 2160 2161
		goto done;

done:
2162 2163 2164
	git_filter_list_free(fl);

	git_buf_free(&out_data);
2165 2166 2167 2168 2169 2170 2171 2172 2173 2174
	git_buf_free(&our_label);
	git_buf_free(&their_label);

	git_merge_file_result_free(&result);
	git_buf_free(&path_workdir);
	git_buf_free(&path_suffixed);

	return error;
}

2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188
static int checkout_conflict_add(
	checkout_data *data,
	const git_index_entry *conflict)
{
	int error = git_index_remove(data->index, conflict->path, 0);

	if (error == GIT_ENOTFOUND)
		giterr_clear();
	else if (error < 0)
		return error;

	return git_index_add(data->index, conflict);
}

2189 2190 2191 2192 2193 2194 2195
static int checkout_conflict_update_index(
	checkout_data *data,
	checkout_conflictdata *conflict)
{
	int error = 0;

	if (conflict->ancestor)
2196
		error = checkout_conflict_add(data, conflict->ancestor);
2197 2198

	if (!error && conflict->ours)
2199
		error = checkout_conflict_add(data, conflict->ours);
2200 2201

	if (!error && conflict->theirs)
2202
		error = checkout_conflict_add(data, conflict->theirs);
2203 2204 2205 2206

	return error;
}

2207 2208 2209 2210 2211 2212
static int checkout_create_conflicts(checkout_data *data)
{
	checkout_conflictdata *conflict;
	size_t i;
	int error = 0;

2213
	git_vector_foreach(&data->update_conflicts, i, conflict) {
2214

2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257
		/* Both deleted: nothing to do */
		if (conflict->ours == NULL && conflict->theirs == NULL)
			error = 0;

		else if ((data->strategy & GIT_CHECKOUT_USE_OURS) &&
			conflict->ours)
			error = checkout_write_entry(data, conflict, conflict->ours);
		else if ((data->strategy & GIT_CHECKOUT_USE_THEIRS) &&
			conflict->theirs)
			error = checkout_write_entry(data, conflict, conflict->theirs);

		/* Ignore the other side of name collisions. */
		else if ((data->strategy & GIT_CHECKOUT_USE_OURS) &&
			!conflict->ours && conflict->name_collision)
			error = 0;
		else if ((data->strategy & GIT_CHECKOUT_USE_THEIRS) &&
			!conflict->theirs && conflict->name_collision)
			error = 0;

		/* For modify/delete, name collisions and d/f conflicts, write
		 * the file (potentially with the name mangled.
		 */
		else if (conflict->ours != NULL && conflict->theirs == NULL)
			error = checkout_write_entry(data, conflict, conflict->ours);
		else if (conflict->ours == NULL && conflict->theirs != NULL)
			error = checkout_write_entry(data, conflict, conflict->theirs);

		/* Add/add conflicts and rename 1->2 conflicts, write the
		 * ours/theirs sides (potentially name mangled).
		 */
		else if (conflict->one_to_two)
			error = checkout_write_entries(data, conflict);

		/* If all sides are links, write the ours side */
		else if (S_ISLNK(conflict->ours->mode) &&
			S_ISLNK(conflict->theirs->mode))
			error = checkout_write_entry(data, conflict, conflict->ours);
		/* Link/file conflicts, write the file side */
		else if (S_ISLNK(conflict->ours->mode))
			error = checkout_write_entry(data, conflict, conflict->theirs);
		else if (S_ISLNK(conflict->theirs->mode))
			error = checkout_write_entry(data, conflict, conflict->ours);

Edward Thomson committed
2258 2259 2260 2261
		/* If any side is a gitlink, do nothing. */
		else if (conflict->submodule)
			error = 0;

2262 2263 2264 2265 2266
		/* If any side is binary, write the ours side */
		else if (conflict->binary)
			error = checkout_write_entry(data, conflict, conflict->ours);

		else if (!error)
2267 2268
			error = checkout_write_merge(data, conflict);

2269 2270 2271 2272 2273 2274
		/* Update the index extensions (REUC and NAME) if we're checking
		 * out a different index. (Otherwise just leave them there.)
		 */
		if (!error && (data->strategy & GIT_CHECKOUT_DONT_UPDATE_INDEX) == 0)
			error = checkout_conflict_update_index(data, conflict);

2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286
		if (error)
			break;

		data->completed_steps++;
		report_progress(data,
			conflict->ours ? conflict->ours->path :
			(conflict->theirs ? conflict->theirs->path : conflict->ancestor->path));
	}

	return error;
}

2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301
static int checkout_remove_conflicts(checkout_data *data)
{
	const char *conflict;
	size_t i;

	git_vector_foreach(&data->remove_conflicts, i, conflict) {
		if (git_index_conflict_remove(data->index, conflict) < 0)
			return -1;

		data->completed_steps++;
	}

	return 0;
}

2302 2303 2304 2305 2306 2307 2308 2309 2310 2311
static int checkout_extensions_update_index(checkout_data *data)
{
	const git_index_reuc_entry *reuc_entry;
	const git_index_name_entry *name_entry;
	size_t i;
	int error = 0;

	if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0)
		return 0;

2312 2313
	if (data->update_reuc) {
		git_vector_foreach(data->update_reuc, i, reuc_entry) {
2314 2315 2316 2317 2318 2319 2320 2321
			if ((error = git_index_reuc_add(data->index, reuc_entry->path,
				reuc_entry->mode[0], &reuc_entry->oid[0],
				reuc_entry->mode[1], &reuc_entry->oid[1],
				reuc_entry->mode[2], &reuc_entry->oid[2])) < 0)
				goto done;
		}
	}

2322 2323
	if (data->update_names) {
		git_vector_foreach(data->update_names, i, name_entry) {
2324 2325 2326 2327 2328 2329 2330 2331 2332
			if ((error = git_index_name_add(data->index, name_entry->ancestor,
				name_entry->ours, name_entry->theirs)) < 0)
				goto done;
		}
	}

done:
	return error;
}
2333

2334 2335 2336 2337 2338 2339 2340 2341 2342 2343
static void checkout_data_clear(checkout_data *data)
{
	if (data->opts_free_baseline) {
		git_tree_free(data->opts.baseline);
		data->opts.baseline = NULL;
	}

	git_vector_free(&data->removes);
	git_pool_clear(&data->pool);

2344 2345
	git_vector_free_deep(&data->remove_conflicts);
	git_vector_free_deep(&data->update_conflicts);
2346

2347 2348 2349
	git__free(data->pfx);
	data->pfx = NULL;

2350
	git_buf_free(&data->target_path);
2351
	git_buf_free(&data->tmp);
2352 2353 2354

	git_index_free(data->index);
	data->index = NULL;
2355

2356
	git_strmap_free(data->mkdir_map);
2357
	data->mkdir_map = NULL;
2358

2359
	git_attr_session__free(&data->attr_session);
2360 2361 2362 2363
}

static int checkout_data_init(
	checkout_data *data,
2364
	git_iterator *target,
2365
	const git_checkout_options *proposed)
2366
{
2367
	int error = 0;
2368
	git_repository *repo = git_iterator_owner(target);
2369

2370 2371 2372
	memset(data, 0, sizeof(*data));

	if (!repo) {
2373
		giterr_set(GITERR_CHECKOUT, "cannot checkout nothing");
2374
		return -1;
2375
	}
2376

2377 2378
	if ((!proposed || !proposed->target_directory) &&
		(error = git_repository__ensure_not_bare(repo, "checkout")) < 0)
2379
		return error;
2380

2381
	data->repo = repo;
2382
	data->target = target;
2383 2384

	GITERR_CHECK_VERSION(
2385
		proposed, GIT_CHECKOUT_OPTIONS_VERSION, "git_checkout_options");
2386 2387

	if (!proposed)
2388
		GIT_INIT_STRUCTURE(&data->opts, GIT_CHECKOUT_OPTIONS_VERSION);
2389
	else
2390
		memmove(&data->opts, proposed, sizeof(git_checkout_options));
2391

2392 2393 2394
	if (!data->opts.target_directory)
		data->opts.target_directory = git_repository_workdir(repo);
	else if (!git_path_isdir(data->opts.target_directory) &&
2395 2396 2397
			 (error = checkout_mkdir(data,
				data->opts.target_directory, NULL,
				GIT_DIR_MODE, GIT_MKDIR_VERIFY_DIR)) < 0)
2398 2399
		goto cleanup;

2400 2401
	/* refresh config and index content unless NO_REFRESH is given */
	if ((data->opts.checkout_strategy & GIT_CHECKOUT_NO_REFRESH) == 0) {
2402 2403
		git_config *cfg;

2404
		if ((error = git_repository_config__weakptr(&cfg, repo)) < 0)
2405 2406
			goto cleanup;

2407 2408 2409
		/* Get the repository index and reload it (unless we're checking
		 * out the index; then it has the changes we're trying to check
		 * out and those should not be overwritten.)
2410
		 */
2411 2412 2413
		if ((error = git_repository_index(&data->index, data->repo)) < 0)
			goto cleanup;

2414
		if (data->index != git_iterator_index(target)) {
2415
			if ((error = git_index_read(data->index, true)) < 0)
2416
				goto cleanup;
2417

2418 2419 2420
			/* cannot checkout if unresolved conflicts exist */
			if ((data->opts.checkout_strategy & GIT_CHECKOUT_FORCE) == 0 &&
				git_index_has_conflicts(data->index)) {
2421
				error = GIT_ECONFLICT;
2422 2423 2424 2425 2426
				giterr_set(GITERR_CHECKOUT,
					"unresolved conflicts exist in the index");
				goto cleanup;
			}

2427
			/* clean conflict data in the current index */
2428
			git_index_name_clear(data->index);
Edward Thomson committed
2429
			git_index_reuc_clear(data->index);
2430 2431
		}
	}
2432

2433 2434 2435 2436 2437
	/* if you are forcing, allow all safe updates, plus recreate missing */
	if ((data->opts.checkout_strategy & GIT_CHECKOUT_FORCE) != 0)
		data->opts.checkout_strategy |= GIT_CHECKOUT_SAFE |
			GIT_CHECKOUT_RECREATE_MISSING;

2438 2439 2440 2441 2442
	/* if the repository does not actually have an index file, then this
	 * is an initial checkout (perhaps from clone), so we allow safe updates
	 */
	if (!data->index->on_disk &&
		(data->opts.checkout_strategy & GIT_CHECKOUT_SAFE) != 0)
2443
		data->opts.checkout_strategy |= GIT_CHECKOUT_RECREATE_MISSING;
2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456

	data->strategy = data->opts.checkout_strategy;

	/* opts->disable_filters is false by default */

	if (!data->opts.dir_mode)
		data->opts.dir_mode = GIT_DIR_MODE;

	if (!data->opts.file_open_flags)
		data->opts.file_open_flags = O_CREAT | O_TRUNC | O_WRONLY;

	data->pfx = git_pathspec_prefix(&data->opts.paths);

2457 2458 2459
	if ((error = git_repository__cvar(
			 &data->can_symlink, repo, GIT_CVAR_SYMLINKS)) < 0)
		goto cleanup;
2460

2461 2462 2463 2464
	if ((error = git_repository__cvar(
			 &data->respect_filemode, repo, GIT_CVAR_FILEMODE)) < 0)
		goto cleanup;

2465
	if (!data->opts.baseline && !data->opts.baseline_index) {
2466
		data->opts_free_baseline = true;
2467
		error = 0;
2468

2469 2470 2471 2472 2473
		/* if we don't have an index, this is an initial checkout and
		 * should be against an empty baseline
		 */
		if (data->index->on_disk)
			error = checkout_lookup_head_tree(&data->opts.baseline, repo);
2474

2475
		if (error == GIT_EUNBORNBRANCH) {
2476 2477 2478 2479 2480
			error = 0;
			giterr_clear();
		}

		if (error < 0)
2481 2482 2483
			goto cleanup;
	}

2484 2485
	if ((data->opts.checkout_strategy &
		(GIT_CHECKOUT_CONFLICT_STYLE_MERGE | GIT_CHECKOUT_CONFLICT_STYLE_DIFF3)) == 0) {
2486
		git_config_entry *conflict_style = NULL;
2487 2488 2489
		git_config *cfg = NULL;

		if ((error = git_repository_config__weakptr(&cfg, repo)) < 0 ||
2490
			(error = git_config_get_entry(&conflict_style, cfg, "merge.conflictstyle")) < 0 ||
2491 2492 2493 2494
			error == GIT_ENOTFOUND)
			;
		else if (error)
			goto cleanup;
2495
		else if (strcmp(conflict_style->value, "merge") == 0)
2496
			data->opts.checkout_strategy |= GIT_CHECKOUT_CONFLICT_STYLE_MERGE;
2497
		else if (strcmp(conflict_style->value, "diff3") == 0)
2498 2499 2500
			data->opts.checkout_strategy |= GIT_CHECKOUT_CONFLICT_STYLE_DIFF3;
		else {
			giterr_set(GITERR_CHECKOUT, "unknown style '%s' given for 'merge.conflictstyle'",
2501
				conflict_style->value);
2502
			error = -1;
2503
			git_config_entry_free(conflict_style);
2504 2505
			goto cleanup;
		}
2506
		git_config_entry_free(conflict_style);
2507 2508
	}

2509 2510
	git_pool_init(&data->pool, 1);

2511
	if ((error = git_vector_init(&data->removes, 0, git__strcmp_cb)) < 0 ||
2512 2513
		(error = git_vector_init(&data->remove_conflicts, 0, NULL)) < 0 ||
		(error = git_vector_init(&data->update_conflicts, 0, NULL)) < 0 ||
2514 2515
		(error = git_buf_puts(&data->target_path, data->opts.target_directory)) < 0 ||
		(error = git_path_to_dir(&data->target_path)) < 0 ||
2516
		(error = git_strmap_alloc(&data->mkdir_map)) < 0)
2517 2518
		goto cleanup;

2519
	data->target_len = git_buf_len(&data->target_path);
2520

2521 2522
	git_attr_session__init(&data->attr_session, data->repo);

2523 2524 2525
cleanup:
	if (error < 0)
		checkout_data_clear(data);
2526 2527 2528 2529

	return error;
}

2530 2531 2532
#define CHECKOUT_INDEX_DONT_WRITE_MASK \
	(GIT_CHECKOUT_DONT_UPDATE_INDEX | GIT_CHECKOUT_DONT_WRITE_INDEX)

2533 2534
int git_checkout_iterator(
	git_iterator *target,
2535
	git_index *index,
2536
	const git_checkout_options *opts)
2537 2538
{
	int error = 0;
2539
	git_iterator *baseline = NULL, *workdir = NULL;
2540 2541
	git_iterator_options baseline_opts = GIT_ITERATOR_OPTIONS_INIT,
		workdir_opts = GIT_ITERATOR_OPTIONS_INIT;
2542
	checkout_data data = {0};
2543
	git_diff_options diff_opts = GIT_DIFF_OPTIONS_INIT;
2544 2545
	uint32_t *actions = NULL;
	size_t *counts = NULL;
2546

2547
	/* initialize structures and options */
2548
	error = checkout_data_init(&data, target, opts);
2549 2550
	if (error < 0)
		return error;
Ben Straub committed
2551

2552 2553
	diff_opts.flags =
		GIT_DIFF_INCLUDE_UNMODIFIED |
2554
		GIT_DIFF_INCLUDE_UNREADABLE |
2555 2556 2557 2558 2559
		GIT_DIFF_INCLUDE_UNTRACKED |
		GIT_DIFF_RECURSE_UNTRACKED_DIRS | /* needed to match baseline */
		GIT_DIFF_INCLUDE_IGNORED |
		GIT_DIFF_INCLUDE_TYPECHANGE |
		GIT_DIFF_INCLUDE_TYPECHANGE_TREES |
2560 2561
		GIT_DIFF_SKIP_BINARY_CHECK |
		GIT_DIFF_INCLUDE_CASECHANGE;
2562 2563
	if (data.opts.checkout_strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH)
		diff_opts.flags |= GIT_DIFF_DISABLE_PATHSPEC_MATCH;
2564 2565 2566 2567
	if (data.opts.paths.count > 0)
		diff_opts.pathspec = data.opts.paths;

	/* set up iterators */
2568

2569
	workdir_opts.flags = git_iterator_ignore_case(target) ?
2570
		GIT_ITERATOR_IGNORE_CASE : GIT_ITERATOR_DONT_IGNORE_CASE;
2571 2572 2573
	workdir_opts.flags |= GIT_ITERATOR_DONT_AUTOEXPAND;
	workdir_opts.start = data.pfx;
	workdir_opts.end = data.pfx;
2574

2575
	if ((error = git_iterator_reset_range(target, data.pfx, data.pfx)) < 0 ||
2576
		(error = git_iterator_for_workdir_ext(
2577
			&workdir, data.repo, data.opts.target_directory, index, NULL,
2578
			&workdir_opts)) < 0)
2579 2580
		goto cleanup;

2581 2582 2583 2584
	baseline_opts.flags = git_iterator_ignore_case(target) ?
		GIT_ITERATOR_IGNORE_CASE : GIT_ITERATOR_DONT_IGNORE_CASE;
	baseline_opts.start = data.pfx;
	baseline_opts.end = data.pfx;
2585 2586 2587 2588
	if (opts && (opts->checkout_strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH)) {
		baseline_opts.pathlist.count = opts->paths.count;
		baseline_opts.pathlist.strings = opts->paths.strings;
	}
2589

2590 2591
	if (data.opts.baseline_index) {
		if ((error = git_iterator_for_index(
2592 2593
				&baseline, git_index_owner(data.opts.baseline_index),
				data.opts.baseline_index, &baseline_opts)) < 0)
2594 2595 2596
			goto cleanup;
	} else {
		if ((error = git_iterator_for_tree(
2597
				&baseline, data.opts.baseline, &baseline_opts)) < 0)
2598 2599 2600
			goto cleanup;
	}

2601 2602
	/* Should not have case insensitivity mismatch */
	assert(git_iterator_ignore_case(workdir) == git_iterator_ignore_case(baseline));
2603

2604 2605
	/* Generate baseline-to-target diff which will include an entry for
	 * every possible update that might need to be made.
2606 2607
	 */
	if ((error = git_diff__from_iterators(
2608
			&data.diff, data.repo, baseline, target, &diff_opts)) < 0)
2609 2610
		goto cleanup;

2611
	/* Loop through diff (and working directory iterator) building a list of
2612 2613
	 * actions to be taken, plus look for conflicts and send notifications,
	 * then loop through conflicts.
2614
	 */
2615
	if ((error = checkout_get_actions(&actions, &counts, &data, workdir)) != 0)
2616 2617
		goto cleanup;

2618
	data.total_steps = counts[CHECKOUT_ACTION__REMOVE] +
2619
		counts[CHECKOUT_ACTION__REMOVE_CONFLICT] +
2620
		counts[CHECKOUT_ACTION__UPDATE_BLOB] +
2621 2622
		counts[CHECKOUT_ACTION__UPDATE_SUBMODULE] +
		counts[CHECKOUT_ACTION__UPDATE_CONFLICT];
2623

2624
	report_progress(&data, NULL); /* establish 0 baseline */
2625

2626 2627 2628
	/* To deal with some order dependencies, perform remaining checkout
	 * in three passes: removes, then update blobs, then update submodules.
	 */
2629
	if (counts[CHECKOUT_ACTION__REMOVE] > 0 &&
2630
		(error = checkout_remove_the_old(actions, &data)) < 0)
2631 2632
		goto cleanup;

2633 2634 2635 2636
	if (counts[CHECKOUT_ACTION__REMOVE_CONFLICT] > 0 &&
		(error = checkout_remove_conflicts(&data)) < 0)
		goto cleanup;

2637
	if (counts[CHECKOUT_ACTION__UPDATE_BLOB] > 0 &&
2638
		(error = checkout_create_the_new(actions, &data)) < 0)
2639 2640
		goto cleanup;

2641
	if (counts[CHECKOUT_ACTION__UPDATE_SUBMODULE] > 0 &&
2642
		(error = checkout_create_submodules(actions, &data)) < 0)
2643 2644
		goto cleanup;

2645
	if (counts[CHECKOUT_ACTION__UPDATE_CONFLICT] > 0 &&
2646
		(error = checkout_create_conflicts(&data)) < 0)
2647
		goto cleanup;
2648

2649
	if (data.index != git_iterator_index(target) &&
2650 2651 2652
		(error = checkout_extensions_update_index(&data)) < 0)
		goto cleanup;

2653
	assert(data.completed_steps == data.total_steps);
2654

2655 2656 2657
	if (data.opts.perfdata_cb)
		data.opts.perfdata_cb(&data.perfdata, data.opts.perfdata_payload);

2658
cleanup:
2659
	if (!error && data.index != NULL &&
2660
		(data.strategy & CHECKOUT_INDEX_DONT_WRITE_MASK) == 0)
2661 2662
		error = git_index_write(data.index);

2663
	git_diff_free(data.diff);
2664
	git_iterator_free(workdir);
2665
	git_iterator_free(baseline);
2666 2667
	git__free(actions);
	git__free(counts);
2668
	checkout_data_clear(&data);
2669 2670 2671 2672 2673 2674 2675

	return error;
}

int git_checkout_index(
	git_repository *repo,
	git_index *index,
2676
	const git_checkout_options *opts)
2677
{
2678
	int error, owned = 0;
2679
	git_iterator *index_i;
2680

2681 2682
	if (!index && !repo) {
		giterr_set(GITERR_CHECKOUT,
2683
			"must provide either repository or index to checkout");
2684 2685
		return -1;
	}
2686 2687 2688 2689

	if (index && repo &&
		git_index_owner(index) &&
		git_index_owner(index) != repo) {
2690
		giterr_set(GITERR_CHECKOUT,
2691
			"index to checkout does not match repository");
2692
		return -1;
2693 2694 2695
	} else if(index && repo && !git_index_owner(index)) {
		GIT_REFCOUNT_OWN(index, repo);
		owned = 1;
2696 2697 2698 2699
	}

	if (!repo)
		repo = git_index_owner(index);
2700 2701 2702

	if (!index && (error = git_repository_index__weakptr(&index, repo)) < 0)
		return error;
2703
	GIT_REFCOUNT_INC(index);
2704

2705
	if (!(error = git_iterator_for_index(&index_i, repo, index, NULL)))
2706
		error = git_checkout_iterator(index_i, index, opts);
2707

2708 2709 2710
	if (owned)
		GIT_REFCOUNT_OWN(index, NULL);

2711
	git_iterator_free(index_i);
2712
	git_index_free(index);
2713

2714 2715 2716 2717 2718
	return error;
}

int git_checkout_tree(
	git_repository *repo,
Vicent Marti committed
2719
	const git_object *treeish,
2720
	const git_checkout_options *opts)
2721
{
2722
	int error;
2723
	git_index *index;
2724 2725
	git_tree *tree = NULL;
	git_iterator *tree_i = NULL;
2726
	git_iterator_options iter_opts = GIT_ITERATOR_OPTIONS_INIT;
2727

2728 2729
	if (!treeish && !repo) {
		giterr_set(GITERR_CHECKOUT,
2730
			"must provide either repository or tree to checkout");
2731 2732 2733 2734
		return -1;
	}
	if (treeish && repo && git_object_owner(treeish) != repo) {
		giterr_set(GITERR_CHECKOUT,
2735
			"object to checkout does not match repository");
2736 2737 2738 2739 2740
		return -1;
	}

	if (!repo)
		repo = git_object_owner(treeish);
2741

2742 2743 2744
	if (treeish) {
		if (git_object_peel((git_object **)&tree, treeish, GIT_OBJ_TREE) < 0) {
			giterr_set(
2745
				GITERR_CHECKOUT, "provided object cannot be peeled to a tree");
2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756
			return -1;
		}
	}
	else {
		if ((error = checkout_lookup_head_tree(&tree, repo)) < 0) {
			if (error != GIT_EUNBORNBRANCH)
				giterr_set(
					GITERR_CHECKOUT,
					"HEAD could not be peeled to a tree and no treeish given");
			return error;
		}
2757 2758
	}

2759 2760 2761
	if ((error = git_repository_index(&index, repo)) < 0)
		return error;

2762
	if (opts && (opts->checkout_strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH)) {
2763 2764 2765 2766 2767
		iter_opts.pathlist.count = opts->paths.count;
		iter_opts.pathlist.strings = opts->paths.strings;
	}

	if (!(error = git_iterator_for_tree(&tree_i, tree, &iter_opts)))
2768
		error = git_checkout_iterator(tree_i, index, opts);
2769

2770
	git_iterator_free(tree_i);
2771
	git_index_free(index);
2772
	git_tree_free(tree);
2773

2774
	return error;
2775 2776
}

2777 2778
int git_checkout_head(
	git_repository *repo,
2779
	const git_checkout_options *opts)
2780
{
2781
	assert(repo);
2782
	return git_checkout_tree(repo, NULL, opts);
2783
}
2784

2785
int git_checkout_init_options(git_checkout_options *opts, unsigned int version)
2786
{
2787 2788 2789
	GIT_INIT_STRUCTURE_FROM_TEMPLATE(
		opts, version, git_checkout_options, GIT_CHECKOUT_OPTIONS_INIT);
	return 0;
2790
}