checkout.c 72.4 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 73 74 75
	unsigned int strategy;
	int can_symlink;
	bool reload_submodules;
	size_t total_steps;
	size_t completed_steps;
76
	git_checkout_perfdata perfdata;
77
	git_strmap *mkdir_map;
78
	git_attr_session attr_session;
79 80 81 82 83 84 85 86 87
} 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,
88
		one_to_two:1,
Edward Thomson committed
89 90
		binary:1,
		submodule:1;
91 92
} checkout_conflictdata;

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

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

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

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

116
		workdir = &wdfile;
117 118

		path = wditem->path;
119 120
	}

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

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

144 145 146 147 148 149 150
	{
		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");
	}
151 152
}

153 154 155 156 157 158 159 160 161
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);
}

162 163
GIT_INLINE(bool) is_file_mode_changed(git_filemode_t a, git_filemode_t b)
{
164 165 166 167 168 169 170
#ifdef GIT_WIN32
	/*
	 * On Win32 we do not support the executable bit; the file will
	 * always be 0100644 on disk, don't bother doing a test.
	 */
	return false;
#else
171
	return (S_ISREG(a) && S_ISREG(b) && a != b);
172
#endif
173 174
}

175
static bool checkout_is_workdir_modified(
176
	checkout_data *data,
177
	const git_diff_file *baseitem,
178
	const git_diff_file *newitem,
179
	const git_index_entry *wditem)
180 181
{
	git_oid oid;
182
	const git_index_entry *ie;
183

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

191 192
		if (git_submodule_lookup(&sm, data->repo, wditem->path) < 0) {
			giterr_clear();
193
			return true;
194
		}
195

196
		if (git_submodule_status(&sm_status, data->repo, wditem->path, GIT_SUBMODULE_IGNORE_UNSPECIFIED) < 0 ||
197 198 199 200 201 202
			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);
203

204 205
		git_submodule_free(sm);
		return rval;
206 207
	}

208 209
	/* Look at the cache to decide if the workdir is modified.  If not,
	 * we can simply compare the oid in the cache to the baseitem instead
210 211 212
	 * of hashing the file.  If so, we allow the checkout to proceed if the
	 * oid is identical (ie, the staged item is what we're trying to check
	 * out.)
213 214
	 */
	if ((ie = git_index_get_bypath(data->index, wditem->path, 0)) != NULL) {
215
		if (git_index_time_eq(&wditem->mtime, &ie->mtime) &&
216 217
			wditem->file_size == ie->file_size &&
			!is_file_mode_changed(wditem->mode, ie->mode))
218
			return !is_workdir_base_or_new(&ie->id, baseitem, newitem);
219 220
	}

221 222 223 224
	/* 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)
225 226
		return true;

227 228 229 230
	/* if the workdir item is a directory, it cannot be a modified file */
	if (S_ISDIR(wditem->mode))
		return false;

231 232 233
	if (is_file_mode_changed(baseitem->mode, wditem->mode))
		return true;

234
	if (git_diff__oid_for_entry(&oid, data->diff, wditem, wditem->mode, NULL) < 0)
235 236
		return false;

237 238 239 240
	/* 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);
241 242 243 244 245 246
}

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

static int checkout_action_common(
247
	int *action,
248
	checkout_data *data,
249
	const git_diff_delta *delta,
250 251 252 253 254
	const git_index_entry *wd)
{
	git_checkout_notify_t notify = GIT_CHECKOUT_NOTIFY_NONE;

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

257
	if ((*action & CHECKOUT_ACTION__UPDATE_BLOB) != 0) {
258
		if (S_ISGITLINK(delta->new_file.mode))
259
			*action = (*action & ~CHECKOUT_ACTION__UPDATE_BLOB) |
260 261
				CHECKOUT_ACTION__UPDATE_SUBMODULE;

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

266 267 268 269 270 271
		/* 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;

272 273 274
		notify = GIT_CHECKOUT_NOTIFY_UPDATED;
	}

275
	if ((*action & CHECKOUT_ACTION__CONFLICT) != 0)
276 277
		notify = GIT_CHECKOUT_NOTIFY_CONFLICT;

278
	return checkout_notify(data, notify, delta, wd);
279 280 281
}

static int checkout_action_no_wd(
282
	int *action,
283 284
	checkout_data *data,
	const git_diff_delta *delta)
285
{
286 287 288
	int error = 0;

	*action = CHECKOUT_ACTION__NONE;
289

290 291
	switch (delta->status) {
	case GIT_DELTA_UNMODIFIED: /* case 12 */
292 293 294
		error = checkout_notify(data, GIT_CHECKOUT_NOTIFY_DIRTY, delta, NULL);
		if (error)
			return error;
295
		*action = CHECKOUT_ACTION_IF(RECREATE_MISSING, UPDATE_BLOB, NONE);
296 297
		break;
	case GIT_DELTA_ADDED:    /* case 2 or 28 (and 5 but not really) */
298
		*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
299
		break;
300
	case GIT_DELTA_MODIFIED: /* case 13 (and 35 but not really) */
301
		*action = CHECKOUT_ACTION_IF(RECREATE_MISSING, UPDATE_BLOB, CONFLICT);
302
		break;
303 304
	case GIT_DELTA_TYPECHANGE: /* case 21 (B->T) and 28 (T->B)*/
		if (delta->new_file.mode == GIT_FILEMODE_TREE)
305
			*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
306 307
		break;
	case GIT_DELTA_DELETED: /* case 8 or 25 */
308
		*action = CHECKOUT_ACTION_IF(SAFE, REMOVE, NONE);
309
		break;
310 311
	default: /* impossible */
		break;
312 313
	}

314
	return checkout_action_common(action, data, delta, NULL);
315 316
}

317 318
static int checkout_target_fullpath(
	git_buf **out, checkout_data *data, const char *path)
319
{
320 321 322 323 324 325 326 327 328 329 330 331 332 333
	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;
334 335 336

	if (wd->mode != GIT_FILEMODE_TREE)
		return true;
337 338 339 340

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

341 342 343
	return !full || !git_path_contains(full, DOT_GIT);
}

344 345 346 347 348 349 350 351
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 */
352 353 354
static int checkout_action_wd_only(
	checkout_data *data,
	git_iterator *workdir,
355
	const git_index_entry **wditem,
356 357
	git_vector *pathspec)
{
358
	int error = 0;
359
	bool remove = false;
360
	git_checkout_notify_t notify = GIT_CHECKOUT_NOTIFY_NONE;
361
	const git_index_entry *wd = *wditem;
362

363
	if (!git_pathspec__match(
364 365
			pathspec, wd->path,
			(data->strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH) != 0,
366
			git_iterator_ignore_case(workdir), NULL, NULL))
367
		return git_iterator_advance(wditem, workdir);
368

369
	/* check if item is tracked in the index but not in the checkout diff */
370
	if (data->index != NULL) {
371 372
		size_t pos;

373
		error = git_index__find_pos(
374 375
			&pos, data->index, wd->path, 0, GIT_INDEX_STAGE_ANY);

376
		if (wd->mode != GIT_FILEMODE_TREE) {
377
			if (!error) { /* found by git_index__find_pos call */
378 379
				notify = GIT_CHECKOUT_NOTIFY_DIRTY;
				remove = ((data->strategy & GIT_CHECKOUT_FORCE) != 0);
380 381
			} else if (error != GIT_ENOTFOUND)
				return error;
382
			else
383
				error = 0; /* git_index__find_pos does not set error msg */
384 385 386 387 388 389
		} 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);

390 391
			if (e != NULL && data->diff->pfxcomp(e->path, wd->path) == 0)
				return git_iterator_advance_into(wditem, workdir);
392
		}
393
	}
394

395 396 397 398 399
	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;

400
		if (remove && wd_item_is_removable(data, wd))
401 402 403 404 405 406
			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 */
407
		bool over = false, removable = wd_item_is_removable(data, wd);
408
		git_iterator_status_t untracked_state;
409 410 411 412 413

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

415
		error = git_iterator_advance_over(
416
			wditem, &untracked_state, workdir);
417 418 419 420
		if (error == GIT_ITEROVER)
			over = true;
		else if (error < 0)
			return error;
421

422
		if (untracked_state == GIT_ITERATOR_STATUS_IGNORED) {
423 424 425 426 427 428
			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);
		}
429

430 431 432 433 434 435 436 437
		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;
438 439
	}

440
	return error;
441 442
}

443 444 445 446 447 448
static bool submodule_is_config_only(
	checkout_data *data,
	const char *path)
{
	git_submodule *sm = NULL;
	unsigned int sm_loc = 0;
449
	bool rval = false;
450

451
	if (git_submodule_lookup(&sm, data->repo, path) < 0)
452 453
		return true;

454 455 456 457 458 459
	if (git_submodule_location(&sm_loc, sm) < 0 ||
		sm_loc == GIT_SUBMODULE_STATUS_IN_CONFIG)
		rval = true;

	git_submodule_free(sm);

460
	return rval;
461 462
}

463 464
static bool checkout_is_empty_dir(checkout_data *data, const char *path)
{
465 466 467
	git_buf *fullpath;

	if (checkout_target_fullpath(&fullpath, data, path) < 0)
468
		return false;
469 470

	return git_path_is_empty_dir(fullpath->ptr);
471 472
}

473
static int checkout_action_with_wd(
474
	int *action,
475 476
	checkout_data *data,
	const git_diff_delta *delta,
477
	git_iterator *workdir,
478 479
	const git_index_entry *wd)
{
480
	*action = CHECKOUT_ACTION__NONE;
481 482 483

	switch (delta->status) {
	case GIT_DELTA_UNMODIFIED: /* case 14/15 or 33 */
484
		if (checkout_is_workdir_modified(data, &delta->old_file, &delta->new_file, wd)) {
485 486 487
			GITERR_CHECK_ERROR(
				checkout_notify(data, GIT_CHECKOUT_NOTIFY_DIRTY, delta, wd) );
			*action = CHECKOUT_ACTION_IF(FORCE, UPDATE_BLOB, NONE);
488
		}
489 490
		break;
	case GIT_DELTA_ADDED: /* case 3, 4 or 6 */
491 492 493 494
		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);
495 496
		break;
	case GIT_DELTA_DELETED: /* case 9 or 10 (or 26 but not really) */
497
		if (checkout_is_workdir_modified(data, &delta->old_file, &delta->new_file, wd))
498
			*action = CHECKOUT_ACTION_IF(FORCE, REMOVE, CONFLICT);
499
		else
500
			*action = CHECKOUT_ACTION_IF(SAFE, REMOVE, NONE);
501 502
		break;
	case GIT_DELTA_MODIFIED: /* case 16, 17, 18 (or 36 but not really) */
503 504
		if (wd->mode != GIT_FILEMODE_COMMIT &&
			checkout_is_workdir_modified(data, &delta->old_file, &delta->new_file, wd))
505
			*action = CHECKOUT_ACTION_IF(FORCE, UPDATE_BLOB, CONFLICT);
506
		else
507
			*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
508 509
		break;
	case GIT_DELTA_TYPECHANGE: /* case 22, 23, 29, 30 */
510 511 512 513 514
		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...
				 */
515
				*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
516 517 518 519 520
			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))
521
					*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
522
				else
523
					*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
524
			} else
525
				*action = CHECKOUT_ACTION_IF(FORCE, REMOVE, CONFLICT);
526
		}
527
		else if (checkout_is_workdir_modified(data, &delta->old_file, &delta->new_file, wd))
528
			*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
529
		else
530
			*action = CHECKOUT_ACTION_IF(SAFE, REMOVE_AND_UPDATE, NONE);
531 532 533

		/* don't update if the typechange is to a tree */
		if (delta->new_file.mode == GIT_FILEMODE_TREE)
534
			*action = (*action & ~CHECKOUT_ACTION__UPDATE_BLOB);
535 536 537
		break;
	default: /* impossible */
		break;
538 539
	}

540
	return checkout_action_common(action, data, delta, wd);
541
}
542

543
static int checkout_action_with_wd_blocker(
544
	int *action,
545 546 547 548
	checkout_data *data,
	const git_diff_delta *delta,
	const git_index_entry *wd)
{
549
	*action = CHECKOUT_ACTION__NONE;
550

551 552 553
	switch (delta->status) {
	case GIT_DELTA_UNMODIFIED:
		/* should show delta as dirty / deleted */
554 555 556
		GITERR_CHECK_ERROR(
			checkout_notify(data, GIT_CHECKOUT_NOTIFY_DIRTY, delta, wd) );
		*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, NONE);
557 558 559
		break;
	case GIT_DELTA_ADDED:
	case GIT_DELTA_MODIFIED:
560
		*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
561 562
		break;
	case GIT_DELTA_DELETED:
563
		*action = CHECKOUT_ACTION_IF(FORCE, REMOVE, CONFLICT);
564 565 566
		break;
	case GIT_DELTA_TYPECHANGE:
		/* not 100% certain about this... */
567
		*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
568 569 570
		break;
	default: /* impossible */
		break;
571 572
	}

573
	return checkout_action_common(action, data, delta, wd);
574 575 576
}

static int checkout_action_with_wd_dir(
577
	int *action,
578 579
	checkout_data *data,
	const git_diff_delta *delta,
580
	git_iterator *workdir,
581 582
	const git_index_entry *wd)
{
583
	*action = CHECKOUT_ACTION__NONE;
584 585 586

	switch (delta->status) {
	case GIT_DELTA_UNMODIFIED: /* case 19 or 24 (or 34 but not really) */
587 588 589 590
		GITERR_CHECK_ERROR(
			checkout_notify(data, GIT_CHECKOUT_NOTIFY_DIRTY, delta, NULL));
		GITERR_CHECK_ERROR(
			checkout_notify(data, GIT_CHECKOUT_NOTIFY_UNTRACKED, NULL, wd));
591
		*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, NONE);
592 593 594
		break;
	case GIT_DELTA_ADDED:/* case 4 (and 7 for dir) */
	case GIT_DELTA_MODIFIED: /* case 20 (or 37 but not really) */
595 596 597
		if (delta->old_file.mode == GIT_FILEMODE_COMMIT)
			/* expected submodule (and maybe found one) */;
		else if (delta->new_file.mode != GIT_FILEMODE_TREE)
598 599 600
			*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);
601 602
		break;
	case GIT_DELTA_DELETED: /* case 11 (and 27 for dir) */
603 604 605
		if (delta->old_file.mode != GIT_FILEMODE_TREE)
			GITERR_CHECK_ERROR(
				checkout_notify(data, GIT_CHECKOUT_NOTIFY_UNTRACKED, NULL, wd));
606 607 608
		break;
	case GIT_DELTA_TYPECHANGE: /* case 24 or 31 */
		if (delta->old_file.mode == GIT_FILEMODE_TREE) {
609 610 611 612 613 614
			/* 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.
			 */
615
			*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
616
		}
617 618
		else if (delta->new_file.mode != GIT_FILEMODE_TREE)
			/* For typechange to dir, dir is already created so no action */
619
			*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
620 621 622
		break;
	default: /* impossible */
		break;
623 624
	}

625
	return checkout_action_common(action, data, delta, wd);
626 627
}

628 629 630 631 632 633 634 635 636 637 638 639 640 641
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;
}

642
static int checkout_action(
643
	int *action,
644
	checkout_data *data,
645
	git_diff_delta *delta,
646
	git_iterator *workdir,
647
	const git_index_entry **wditem,
648 649
	git_vector *pathspec)
{
650
	int cmp = -1, error;
651 652
	int (*strcomp)(const char *, const char *) = data->diff->strcomp;
	int (*pfxcomp)(const char *str, const char *pfx) = data->diff->pfxcomp;
653
	int (*advance)(const git_index_entry **, git_iterator *) = NULL;
654 655 656 657

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

	while (1) {
658 659
		const git_index_entry *wd = *wditem;

660
		if (!wd)
661
			return checkout_action_no_wd(action, data, delta);
662

663 664 665 666 667 668 669 670 671 672 673 674 675
		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);

676
			if (cmp == 0) {
677 678
				if (wd->mode == GIT_FILEMODE_TREE) {
					/* case 2 - entry prefixed by workdir tree */
679
					error = git_iterator_advance_into(wditem, workdir);
680 681
					if (error < 0 && error != GIT_ITEROVER)
						goto done;
682 683 684 685 686
					continue;
				}

				/* case 3 maybe - wd contains non-dir where dir expected */
				if (delta->old_file.path[strlen(wd->path)] == '/') {
687 688 689 690
					error = checkout_action_with_wd_blocker(
						action, data, delta, wd);
					advance = git_iterator_advance;
					goto done;
691
				}
692
			}
693

694
			/* case 1 - handle wd item (if it matches pathspec) */
695 696
			error = checkout_action_wd_only(data, workdir, wditem, pathspec);
			if (error && error != GIT_ITEROVER)
697
				goto done;
698 699
			continue;
		}
700

701 702
		if (cmp == 0) {
			/* case 4 */
703
			error = checkout_action_with_wd(action, data, delta, workdir, wd);
704 705
			advance = git_iterator_advance;
			goto done;
706
		}
707

708
		cmp = pfxcomp(wd->path, delta->old_file.path);
709

710
		if (cmp == 0) { /* case 5 */
711
			if (wd->path[strlen(delta->old_file.path)] != '/')
712
				return checkout_action_no_wd(action, data, delta);
713 714 715

			if (delta->status == GIT_DELTA_TYPECHANGE) {
				if (delta->old_file.mode == GIT_FILEMODE_TREE) {
716
					error = checkout_action_with_wd(action, data, delta, workdir, wd);
717 718
					advance = git_iterator_advance_into;
					goto done;
719 720 721 722 723 724
				}

				if (delta->new_file.mode == GIT_FILEMODE_TREE ||
					delta->new_file.mode == GIT_FILEMODE_COMMIT ||
					delta->old_file.mode == GIT_FILEMODE_COMMIT)
				{
725
					error = checkout_action_with_wd(action, data, delta, workdir, wd);
726 727
					advance = git_iterator_advance;
					goto done;
728
				}
729 730
			}

731 732 733
			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);
734
		}
735

736
		/* case 6 - wd is after delta */
737
		return checkout_action_no_wd(action, data, delta);
738 739
	}

740 741 742 743 744 745 746 747 748
done:
	if (!error && advance != NULL &&
		(error = advance(wditem, workdir)) < 0) {
		*wditem = NULL;
		if (error == GIT_ITEROVER)
			error = 0;
	}

	return error;
749 750
}

751 752 753 754 755 756 757 758
static int checkout_remaining_wd_items(
	checkout_data *data,
	git_iterator *workdir,
	const git_index_entry *wd,
	git_vector *spec)
{
	int error = 0;

759 760
	while (wd && !error)
		error = checkout_action_wd_only(data, workdir, &wd, spec);
761

762 763 764
	if (error == GIT_ITEROVER)
		error = 0;

765 766 767
	return error;
}

768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
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;
}

795 796
int checkout_conflictdata_empty(
	const git_vector *conflicts, size_t idx, void *payload)
797 798 799
{
	checkout_conflictdata *conflict;

800 801
	GIT_UNUSED(payload);

802 803 804 805 806 807 808 809 810 811 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
	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
839 840 841 842 843 844 845 846
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;
}

847 848 849 850 851
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
852 853 854
	if (conflict->submodule)
		return 0;

855
	if (conflict->ancestor) {
856
		if ((error = git_blob_lookup(&ancestor_blob, repo, &conflict->ancestor->id)) < 0)
857 858 859 860 861 862
			goto done;

		conflict->binary = git_blob_is_binary(ancestor_blob);
	}

	if (!conflict->binary && conflict->ours) {
863
		if ((error = git_blob_lookup(&our_blob, repo, &conflict->ours->id)) < 0)
864 865 866 867 868 869
			goto done;

		conflict->binary = git_blob_is_binary(our_blob);
	}

	if (!conflict->binary && conflict->theirs) {
870
		if ((error = git_blob_lookup(&their_blob, repo, &conflict->theirs->id)) < 0)
871 872 873 874 875 876 877 878 879 880 881 882 883
			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;
}

884 885 886 887 888 889 890 891 892 893 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
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)
921 922 923 924 925
{
	git_index_conflict_iterator *iterator = NULL;
	const git_index_entry *ancestor, *ours, *theirs;
	int error = 0;

926
	if ((error = git_index_conflict_iterator_new(&iterator, index)) < 0)
927 928 929 930 931 932 933
		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;

934
		if ((error = cb(ancestor, ours, theirs, payload)) < 0)
935
			goto done;
936 937 938 939 940 941 942 943 944 945 946
	}

	if (error == GIT_ITEROVER)
		error = 0;

done:
	git_index_conflict_iterator_free(iterator);

	return error;
}

947 948 949 950 951
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. */
952
	if ((index = git_iterator_index(data->target)) == NULL)
953 954 955 956 957 958 959 960 961 962 963 964 965 966
		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;
}

967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990
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;

991
	if (git_vector_bsearch2(&pos, &data->update_conflicts, checkout_conflicts_cmp_ancestor, path) < 0)
992 993
		return NULL;

994
	return git_vector_get(&data->update_conflicts, pos);
995 996 997 998 999 1000 1001 1002 1003
}

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

1004
	git_vector_foreach(&data->update_conflicts, i, conflict) {
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
		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) {
1037
		giterr_set(GITERR_INDEX, "a NAME entry exists without an ancestor");
1038 1039 1040 1041 1042
		error = -1;
		goto done;
	}

	if (!name_entry->ours && !name_entry->theirs) {
1043
		giterr_set(GITERR_INDEX, "a NAME entry exists without an ours or theirs");
1044 1045 1046 1047 1048 1049 1050
		error = -1;
		goto done;
	}

	if ((ancestor = checkout_conflicts_search_ancestor(data,
		name_entry->ancestor)) == NULL) {
		giterr_set(GITERR_INDEX,
1051
			"a NAME entry referenced ancestor entry '%s' which does not exist in the main index",
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
			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,
1063
				"a NAME entry referenced our entry '%s' which does not exist in the main index",
1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
				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,
1078
				"a NAME entry referenced their entry '%s' which does not exist in the main index",
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
				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)
{
1096
	git_index *index;
1097 1098 1099 1100 1101
	const git_index_name_entry *name_entry;
	checkout_conflictdata *ancestor_conflict, *our_conflict, *their_conflict;
	size_t i, names;
	int error = 0;

1102
	if ((index = git_iterator_index(data->target)) == NULL)
1103 1104
		return 0;

1105
	/* Juggle entries based on renames */
1106
	names = git_index_name_entrycount(index);
Russell Belfer committed
1107

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

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

1143
	git_vector_remove_matching(
1144
		&data->update_conflicts, checkout_conflictdata_empty, NULL);
1145 1146 1147 1148 1149 1150 1151 1152

done:
	return error;
}

static int checkout_conflicts_mark_directoryfile(
	checkout_data *data)
{
1153
	git_index *index;
1154 1155 1156 1157
	checkout_conflictdata *conflict;
	const git_index_entry *entry;
	size_t i, j, len;
	const char *path;
1158
	int prefixed, error = 0;
1159

1160
	if ((index = git_iterator_index(data->target)) == NULL)
1161 1162 1163
		return 0;

	len = git_index_entrycount(index);
1164 1165

	/* Find d/f conflicts */
1166
	git_vector_foreach(&data->update_conflicts, i, conflict) {
1167 1168 1169 1170 1171 1172 1173
		if ((conflict->ours && conflict->theirs) ||
			(!conflict->ours && !conflict->theirs))
			continue;

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

1174
		if ((error = git_index_find(&j, index, path)) < 0) {
1175 1176
			if (error == GIT_ENOTFOUND)
				giterr_set(GITERR_INDEX,
1177
					"index inconsistency, could not find entry for expected conflict '%s'", path);
1178 1179 1180 1181 1182

			goto done;
		}

		for (; j < len; j++) {
1183
			if ((entry = git_index_get_byindex(index, j)) == NULL) {
1184
				giterr_set(GITERR_INDEX,
1185
					"index inconsistency, truncated index while loading expected conflict '%s'", path);
1186 1187 1188 1189
				error = -1;
				goto done;
			}

1190
			prefixed = git_path_equal_or_prefixed(path, entry->path, NULL);
1191

1192
			if (prefixed == GIT_PATH_EQUAL)
1193 1194
				continue;

1195
			if (prefixed == GIT_PATH_PREFIX)
1196 1197 1198 1199 1200 1201 1202 1203 1204 1205
				conflict->directoryfile = 1;

			break;
		}
	}

done:
	return error;
}

1206
static int checkout_get_update_conflicts(
1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224
	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;
}

1225 1226 1227 1228 1229 1230 1231 1232 1233
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;

1234 1235
	assert(ancestor || ours || theirs);

1236 1237 1238 1239 1240 1241
	if (ancestor)
		name = git__strdup(ancestor->path);
	else if (ours)
		name = git__strdup(ours->path);
	else if (theirs)
		name = git__strdup(theirs->path);
1242 1243
	else
		abort();
1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260

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

1261 1262 1263 1264 1265
static int checkout_verify_paths(
	git_repository *repo,
	int action,
	git_diff_delta *delta)
{
1266
	unsigned int flags = GIT_PATH_REJECT_WORKDIR_DEFAULTS;
1267 1268 1269

	if (action & CHECKOUT_ACTION__REMOVE) {
		if (!git_path_isvalid(repo, delta->old_file.path, flags)) {
1270
			giterr_set(GITERR_CHECKOUT, "cannot remove invalid path '%s'", delta->old_file.path);
1271 1272 1273 1274 1275 1276
			return -1;
		}
	}

	if (action & ~CHECKOUT_ACTION__REMOVE) {
		if (!git_path_isvalid(repo, delta->new_file.path, flags)) {
1277
			giterr_set(GITERR_CHECKOUT, "cannot checkout to invalid path '%s'", delta->new_file.path);
1278 1279 1280 1281 1282 1283 1284
			return -1;
		}
	}

	return 0;
}

1285 1286 1287
static int checkout_get_actions(
	uint32_t **actions_ptr,
	size_t **counts_ptr,
1288 1289
	checkout_data *data,
	git_iterator *workdir)
1290
{
1291
	int error = 0, act;
1292 1293
	const git_index_entry *wditem;
	git_vector pathspec = GIT_VECTOR_INIT, *deltas;
1294
	git_pool pathpool;
1295 1296 1297 1298
	git_diff_delta *delta;
	size_t i, *counts = NULL;
	uint32_t *actions = NULL;

1299 1300
	git_pool_init(&pathpool, 1);

1301
	if (data->opts.paths.count > 0 &&
1302
		git_pathspec__vinit(&pathspec, &data->opts.paths, &pathpool) < 0)
1303 1304
		return -1;

1305 1306
	if ((error = git_iterator_current(&wditem, workdir)) < 0 &&
		error != GIT_ITEROVER)
1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319
		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) {
1320 1321 1322
		if ((error = checkout_action(&act, data, delta, workdir, &wditem, &pathspec)) == 0)
			error = checkout_verify_paths(data->repo, act, delta);

1323
		if (error != 0)
1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
			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]++;
	}
1337

1338
	error = checkout_remaining_wd_items(data, workdir, wditem, &pathspec);
1339
	if (error)
1340
		goto fail;
1341

1342 1343 1344 1345 1346
	counts[CHECKOUT_ACTION__REMOVE] += data->removes.length;

	if (counts[CHECKOUT_ACTION__CONFLICT] > 0 &&
		(data->strategy & GIT_CHECKOUT_ALLOW_CONFLICTS) == 0)
	{
1347 1348
		giterr_set(GITERR_CHECKOUT, "%"PRIuZ" %s checkout",
			counts[CHECKOUT_ACTION__CONFLICT],
1349 1350
			counts[CHECKOUT_ACTION__CONFLICT] == 1 ?
			"conflict prevents" : "conflicts prevent");
1351
		error = GIT_ECONFLICT;
1352 1353 1354
		goto fail;
	}

1355

1356 1357
	if ((error = checkout_get_remove_conflicts(data, workdir, &pathspec)) < 0 ||
		(error = checkout_get_update_conflicts(data, workdir, &pathspec)) < 0)
1358 1359
		goto fail;

1360 1361
	counts[CHECKOUT_ACTION__REMOVE_CONFLICT] = git_vector_length(&data->remove_conflicts);
	counts[CHECKOUT_ACTION__UPDATE_CONFLICT] = git_vector_length(&data->update_conflicts);
1362

1363
	git_pathspec__vfree(&pathspec);
1364 1365 1366 1367 1368 1369 1370 1371 1372 1373
	git_pool_clear(&pathpool);

	return 0;

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

1374
	git_pathspec__vfree(&pathspec);
1375 1376 1377 1378 1379
	git_pool_clear(&pathpool);

	return error;
}

1380 1381
static bool should_remove_existing(checkout_data *data)
{
1382
	int ignorecase;
1383

1384 1385 1386
	if (git_repository__cvar(&ignorecase, data->repo, GIT_CVAR_IGNORECASE) < 0) {
		ignorecase = 0;
	}
1387 1388 1389 1390 1391 1392 1393 1394 1395 1396

	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

1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409
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;

1410
	error = git_futils_mkdir_relative(
1411 1412 1413 1414 1415 1416 1417 1418 1419
		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;
}

1420 1421 1422
static int mkpath2file(
	checkout_data *data, const char *path, unsigned int mode)
{
1423 1424
	struct stat st;
	bool remove_existing = should_remove_existing(data);
1425 1426 1427
	unsigned int flags =
		(remove_existing ? MKDIR_REMOVE_EXISTING : MKDIR_NORMAL) |
		GIT_MKDIR_SKIP_LAST;
1428 1429
	int error;

1430 1431
	if ((error = checkout_mkdir(
			data, path, data->opts.target_directory, mode, flags)) < 0)
1432 1433
		return error;

1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445
	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) {
1446
			giterr_set(GITERR_OS, "failed to stat '%s'", path);
1447 1448 1449 1450 1451
			return GIT_EEXISTS;
		} else {
			giterr_clear();
		}
	}
1452 1453

	return error;
1454 1455
}

1456
struct checkout_stream {
1457
	git_writestream base;
1458 1459 1460 1461
	const char *path;
	int fd;
	int open;
};
1462

1463
static int checkout_stream_write(
1464
	git_writestream *s, const char *buffer, size_t len)
1465 1466 1467
{
	struct checkout_stream *stream = (struct checkout_stream *)s;
	int ret;
1468

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

1472 1473
	return ret;
}
1474

1475
static int checkout_stream_close(git_writestream *s)
1476 1477 1478
{
	struct checkout_stream *stream = (struct checkout_stream *)s;
	assert(stream && stream->open);
1479

1480
	stream->open = 0;
1481
	return p_close(stream->fd);
1482
}
1483

1484
static void checkout_stream_free(git_writestream *s)
1485 1486
{
	GIT_UNUSED(s);
Ben Straub committed
1487 1488
}

1489
static int blob_content_to_file(
1490
	checkout_data *data,
1491
	struct stat *st,
1492 1493
	git_blob *blob,
	const char *path,
1494
	const char *hint_path,
1495
	mode_t entry_filemode)
1496
{
1497
	int flags = data->opts.file_open_flags;
1498 1499
	mode_t file_mode = data->opts.file_mode ?
		data->opts.file_mode : entry_filemode;
1500
	git_filter_options filter_opts = GIT_FILTER_OPTIONS_INIT;
1501 1502
	struct checkout_stream writer;
	mode_t mode;
1503
	git_filter_list *fl = NULL;
1504
	int fd;
1505
	int error = 0;
1506

1507 1508 1509
	if (hint_path == NULL)
		hint_path = path;

1510 1511 1512 1513 1514 1515 1516 1517 1518
	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) {
1519
		giterr_set(GITERR_OS, "could not open '%s' for writing", path);
1520 1521 1522
		return fd;
	}

1523
	filter_opts.attr_session = &data->attr_session;
1524
	filter_opts.temp_buf = &data->tmp;
1525

1526
	if (!data->opts.disable_filters &&
1527 1528
		(error = git_filter_list__load_ext(
			&fl, data->repo, blob, hint_path,
1529 1530
			GIT_FILTER_TO_WORKTREE, &filter_opts))) {
		p_close(fd);
1531
		return error;
1532
	}
1533 1534 1535 1536 1537 1538 1539 1540 1541 1542

	/* 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
1543
	error = git_filter_list_stream_blob(fl, blob, &writer.base);
1544

1545
	assert(writer.open == 0);
1546

1547
	git_filter_list_free(fl);
1548

1549 1550
	if (error < 0)
		return error;
1551

1552 1553 1554 1555
	if (st) {
		data->perfdata.stat_calls++;

		if ((error = p_stat(path, st)) < 0) {
1556
			giterr_set(GITERR_OS, "failed to stat '%s'", path);
1557 1558 1559 1560 1561 1562 1563
			return error;
		}

		st->st_mode = entry_filemode;
	}

	return 0;
1564 1565
}

1566
static int blob_content_to_link(
1567
	checkout_data *data,
1568 1569
	struct stat *st,
	git_blob *blob,
1570
	const char *path)
1571 1572 1573
{
	git_buf linktarget = GIT_BUF_INIT;
	int error;
1574

1575
	if ((error = mkpath2file(data, path, data->opts.dir_mode)) < 0)
Linquize committed
1576
		return error;
1577

1578 1579
	if ((error = git_blob__getbuf(&linktarget, blob)) < 0)
		return error;
1580

1581
	if (data->can_symlink) {
1582
		if ((error = p_symlink(git_buf_cstr(&linktarget), path)) < 0)
1583
			giterr_set(GITERR_OS, "could not create symlink %s", path);
1584
	} else {
1585
		error = git_futils_fake_symlink(git_buf_cstr(&linktarget), path);
1586 1587 1588
	}

	if (!error) {
1589 1590
		data->perfdata.stat_calls++;

1591
		if ((error = p_lstat(path, st)) < 0)
1592
			giterr_set(GITERR_CHECKOUT, "could not stat symlink %s", path);
1593 1594 1595

		st->st_mode = GIT_FILEMODE_LINK;
	}
1596

1597 1598 1599
	git_buf_free(&linktarget);

	return error;
1600 1601
}

1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613
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 */
1614
	git_index_entry__init_from_stat(&entry, st, true);
1615
	git_oid_cpy(&entry.id, &file->id);
1616 1617 1618 1619

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

1620 1621 1622 1623
static int checkout_submodule_update_index(
	checkout_data *data,
	const git_diff_file *file)
{
1624
	git_buf *fullpath;
1625 1626 1627 1628 1629 1630
	struct stat st;

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

1631
	if (checkout_target_fullpath(&fullpath, data, file->path) < 0)
1632 1633
		return -1;

1634
	data->perfdata.stat_calls++;
1635
	if (p_stat(fullpath->ptr, &st) < 0) {
1636
		giterr_set(
1637
			GITERR_CHECKOUT, "could not stat submodule %s\n", file->path);
1638 1639 1640 1641 1642 1643 1644 1645
		return GIT_ENOTFOUND;
	}

	st.st_mode = GIT_FILEMODE_COMMIT;

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

1646
static int checkout_submodule(
1647
	checkout_data *data,
1648 1649
	const git_diff_file *file)
{
1650
	bool remove_existing = should_remove_existing(data);
1651 1652
	int error = 0;

1653
	/* Until submodules are supported, UPDATE_ONLY means do nothing here */
1654
	if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0)
1655 1656
		return 0;

1657 1658
	if ((error = checkout_mkdir(
			data,
1659 1660
			file->path, data->opts.target_directory, data->opts.dir_mode,
			remove_existing ? MKDIR_REMOVE_EXISTING : MKDIR_NORMAL)) < 0)
1661
		return error;
1662

1663
	if ((error = git_submodule_lookup(NULL, data->repo, file->path)) < 0) {
1664 1665 1666 1667 1668 1669 1670 1671
		/* 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);
		}

1672
		return error;
1673
	}
1674

1675
	/* TODO: Support checkout_strategy options.  Two circumstances:
1676 1677 1678 1679
	 * 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
	 *
1680 1681
	 * Checkout will not execute a pull on the submodule, but a clone
	 * command should probably be able to.  Do we need a submodule callback?
1682 1683
	 */

1684
	return checkout_submodule_update_index(data, file);
1685 1686
}

1687
static void report_progress(
1688
	checkout_data *data,
1689
	const char *path)
1690
{
1691 1692
	if (data->opts.progress_cb)
		data->opts.progress_cb(
1693
			path, data->completed_steps, data->total_steps,
1694
			data->opts.progress_payload);
1695 1696
}

1697 1698
static int checkout_safe_for_update_only(
	checkout_data *data, const char *path, mode_t expected_mode)
1699 1700 1701
{
	struct stat st;

1702 1703
	data->perfdata.stat_calls++;

1704 1705 1706 1707 1708 1709
	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 */
1710
		giterr_set(GITERR_OS, "failed to stat '%s'", path);
1711 1712 1713 1714 1715 1716 1717 1718 1719 1720
		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;
}

1721
static int checkout_write_content(
1722
	checkout_data *data,
1723 1724 1725 1726 1727
	const git_oid *oid,
	const char *full_path,
	const char *hint_path,
	unsigned int mode,
	struct stat *st)
1728
{
1729
	int error = 0;
1730
	git_blob *blob;
1731

1732
	if ((error = git_blob_lookup(&blob, data->repo, oid)) < 0)
1733 1734
		return error;

1735
	if (S_ISLNK(mode))
1736
		error = blob_content_to_link(data, st, blob, full_path);
1737
	else
1738
		error = blob_content_to_file(data, st, blob, full_path, hint_path, mode);
1739 1740 1741

	git_blob_free(blob);

1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752
	/* 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;
	}

1753 1754 1755 1756 1757 1758 1759
	return error;
}

static int checkout_blob(
	checkout_data *data,
	const git_diff_file *file)
{
1760
	git_buf *fullpath;
1761
	struct stat st;
1762
	int error = 0;
1763

1764
	if (checkout_target_fullpath(&fullpath, data, file->path) < 0)
1765 1766 1767
		return -1;

	if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0) {
1768
		int rval = checkout_safe_for_update_only(
1769 1770
			data, fullpath->ptr, file->mode);

1771 1772 1773 1774
		if (rval <= 0)
			return rval;
	}

1775
	error = checkout_write_content(
1776
		data, &file->id, fullpath->ptr, NULL, file->mode, &st);
1777

1778 1779 1780 1781
	/* update the index unless prevented */
	if (!error && (data->strategy & GIT_CHECKOUT_DONT_UPDATE_INDEX) == 0)
		error = checkout_update_index(data, file, &st);

1782 1783 1784 1785
	/* update the submodule data if this was a new .gitmodules file */
	if (!error && strcmp(file->path, ".gitmodules") == 0)
		data->reload_submodules = true;

1786 1787 1788
	return error;
}

1789 1790
static int checkout_remove_the_old(
	unsigned int *actions,
1791
	checkout_data *data)
1792
{
1793
	int error = 0;
1794
	git_diff_delta *delta;
1795
	const char *str;
1796
	size_t i;
1797
	git_buf *fullpath;
1798 1799
	uint32_t flg = GIT_RMDIR_EMPTY_PARENTS |
		GIT_RMDIR_REMOVE_FILES | GIT_RMDIR_REMOVE_BLOCKERS;
1800

1801 1802 1803
	if (data->opts.checkout_strategy & GIT_CHECKOUT_SKIP_LOCKED_DIRECTORIES)
		flg |= GIT_RMDIR_SKIP_NONEMPTY;

1804 1805
	if (checkout_target_fullpath(&fullpath, data, NULL) < 0)
		return -1;
1806

1807
	git_vector_foreach(&data->diff->deltas, i, delta) {
1808
		if (actions[i] & CHECKOUT_ACTION__REMOVE) {
1809 1810 1811
			error = git_futils_rmdir_r(
				delta->old_file.path, fullpath->ptr, flg);

1812
			if (error < 0)
1813 1814 1815
				return error;

			data->completed_steps++;
1816
			report_progress(data, delta->old_file.path);
1817 1818 1819 1820 1821 1822 1823

			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);
			}
1824 1825 1826
		}
	}

1827
	git_vector_foreach(&data->removes, i, str) {
1828
		error = git_futils_rmdir_r(str, fullpath->ptr, flg);
1829 1830 1831 1832
		if (error < 0)
			return error;

		data->completed_steps++;
1833
		report_progress(data, str);
1834 1835 1836 1837

		if ((data->strategy & GIT_CHECKOUT_DONT_UPDATE_INDEX) == 0 &&
			data->index != NULL)
		{
1838 1839 1840 1841
			if (str[strlen(str) - 1] == '/')
				(void)git_index_remove_directory(data->index, str, 0);
			else
				(void)git_index_remove(data->index, str, 0);
1842
		}
1843 1844 1845 1846 1847 1848 1849 1850 1851
	}

	return 0;
}

static int checkout_deferred_remove(git_repository *repo, const char *path)
{
#if 0
	int error = git_futils_rmdir_r(
1852
		path, data->opts.target_directory, GIT_RMDIR_EMPTY_PARENTS);
1853 1854 1855 1856 1857 1858 1859 1860 1861 1862

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

	return error;
#else
	GIT_UNUSED(repo);
	GIT_UNUSED(path);
1863
	assert(false);
1864
	return 0;
1865
#endif
1866 1867 1868 1869
}

static int checkout_create_the_new(
	unsigned int *actions,
1870
	checkout_data *data)
1871
{
1872
	int error = 0;
1873 1874 1875
	git_diff_delta *delta;
	size_t i;

1876
	git_vector_foreach(&data->diff->deltas, i, delta) {
1877 1878 1879 1880 1881 1882 1883 1884 1885
		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;
		}

1886
		if (actions[i] & CHECKOUT_ACTION__UPDATE_BLOB) {
1887
			error = checkout_blob(data, &delta->new_file);
1888
			if (error < 0)
1889 1890 1891
				return error;

			data->completed_steps++;
1892
			report_progress(data, delta->new_file.path);
1893 1894 1895 1896 1897 1898 1899 1900
		}
	}

	return 0;
}

static int checkout_create_submodules(
	unsigned int *actions,
1901
	checkout_data *data)
1902
{
1903
	int error = 0;
1904 1905 1906
	git_diff_delta *delta;
	size_t i;

1907
	git_vector_foreach(&data->diff->deltas, i, delta) {
1908 1909 1910 1911 1912 1913 1914 1915 1916
		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;
		}

1917
		if (actions[i] & CHECKOUT_ACTION__UPDATE_SUBMODULE) {
1918
			int error = checkout_submodule(data, &delta->new_file);
1919 1920 1921 1922
			if (error < 0)
				return error;

			data->completed_steps++;
1923
			report_progress(data, delta->new_file.path);
1924 1925 1926
		}
	}

1927
	return 0;
1928 1929
}

1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944
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;
}

1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 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

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

1982
		giterr_set(GITERR_CHECKOUT, "could not write '%s': working directory file exists", path->ptr);
1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994
		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;
1995
	git_buf *fullpath;
1996 1997 1998 1999 2000
	struct stat st;
	int error;

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

2001
	if (checkout_target_fullpath(&fullpath, data, side->path) < 0)
2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014
		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";

2015
		if (checkout_path_suffixed(fullpath, suffix) < 0)
2016 2017 2018 2019 2020 2021
			return -1;

		hint_path = side->path;
	}

	if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0 &&
2022
		(error = checkout_safe_for_update_only(data, fullpath->ptr, side->mode)) <= 0)
2023 2024
		return error;

2025 2026 2027 2028 2029
	if (!S_ISGITLINK(side->mode))
		return checkout_write_content(data,
					      &side->id, fullpath->ptr, hint_path, side->mode, &st);

	return 0;
2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 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
}

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,
2076 2077
		path_suffixed = GIT_BUF_INIT, path_workdir = GIT_BUF_INIT,
		in_data = GIT_BUF_INIT, out_data = GIT_BUF_INIT;
2078 2079
	git_merge_file_options opts = GIT_MERGE_FILE_OPTIONS_INIT;
	git_merge_file_result result = {0};
2080
	git_filebuf output = GIT_FILEBUF_INIT;
2081
	git_filter_list *fl = NULL;
2082
	git_filter_options filter_opts = GIT_FILTER_OPTIONS_INIT;
2083 2084
	int error = 0;

2085
	if (data->opts.checkout_strategy & GIT_CHECKOUT_CONFLICT_STYLE_DIFF3)
2086
		opts.flags |= GIT_MERGE_FILE_STYLE_DIFF3;
2087

2088 2089 2090 2091 2092 2093
	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";
2094 2095 2096 2097 2098 2099 2100 2101

	/* 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(
2102
			&our_label, opts.our_label, conflict->ours->path)) < 0 ||
2103
			(error = conflict_entry_name(
2104
			&their_label, opts.their_label, conflict->theirs->path)) < 0)
2105 2106
			goto done;

2107 2108
		opts.our_label = git_buf_cstr(&our_label);
		opts.their_label = git_buf_cstr(&their_label);
2109 2110
	}

2111 2112
	if ((error = git_merge_file_from_index(&result, data->repo,
		conflict->ancestor, conflict->ours, conflict->theirs, &opts)) < 0)
2113 2114 2115
		goto done;

	if (result.path == NULL || result.mode == 0) {
2116
		giterr_set(GITERR_CHECKOUT, "could not merge contents of file");
2117
		error = GIT_ECONFLICT;
2118 2119 2120 2121 2122 2123 2124
		goto done;
	}

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

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

2128
	if (!data->opts.disable_filters) {
2129 2130 2131
		in_data.ptr = (char *)result.ptr;
		in_data.size = result.len;

2132
		filter_opts.attr_session = &data->attr_session;
2133
		filter_opts.temp_buf = &data->tmp;
2134 2135 2136 2137

		if ((error = git_filter_list__load_ext(
				&fl, data->repo, NULL, git_buf_cstr(&path_workdir),
				GIT_FILTER_TO_WORKTREE, &filter_opts)) < 0 ||
2138 2139
			(error = git_filter_list_apply_to_data(&out_data, fl, &in_data)) < 0)
			goto done;
2140 2141 2142 2143
	} else {
		out_data.ptr = (char *)result.ptr;
		out_data.size = result.len;
	}
2144

2145
	if ((error = mkpath2file(data, path_workdir.ptr, data->opts.dir_mode)) < 0 ||
2146 2147
		(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 ||
2148
		(error = git_filebuf_commit(&output)) < 0)
2149 2150 2151
		goto done;

done:
2152 2153 2154
	git_filter_list_free(fl);

	git_buf_free(&out_data);
2155 2156 2157 2158 2159 2160 2161 2162 2163 2164
	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;
}

2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178
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);
}

2179 2180 2181 2182 2183 2184 2185
static int checkout_conflict_update_index(
	checkout_data *data,
	checkout_conflictdata *conflict)
{
	int error = 0;

	if (conflict->ancestor)
2186
		error = checkout_conflict_add(data, conflict->ancestor);
2187 2188

	if (!error && conflict->ours)
2189
		error = checkout_conflict_add(data, conflict->ours);
2190 2191

	if (!error && conflict->theirs)
2192
		error = checkout_conflict_add(data, conflict->theirs);
2193 2194 2195 2196

	return error;
}

2197 2198 2199 2200 2201 2202
static int checkout_create_conflicts(checkout_data *data)
{
	checkout_conflictdata *conflict;
	size_t i;
	int error = 0;

2203
	git_vector_foreach(&data->update_conflicts, i, conflict) {
2204

2205 2206 2207 2208 2209 2210 2211 2212 2213 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
		/* 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
2248 2249 2250 2251
		/* If any side is a gitlink, do nothing. */
		else if (conflict->submodule)
			error = 0;

2252 2253 2254 2255 2256
		/* If any side is binary, write the ours side */
		else if (conflict->binary)
			error = checkout_write_entry(data, conflict, conflict->ours);

		else if (!error)
2257 2258
			error = checkout_write_merge(data, conflict);

2259 2260 2261 2262 2263 2264
		/* 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);

2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276
		if (error)
			break;

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

	return error;
}

2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291
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;
}

2292 2293 2294 2295 2296 2297 2298 2299 2300 2301
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;

2302 2303
	if (data->update_reuc) {
		git_vector_foreach(data->update_reuc, i, reuc_entry) {
2304 2305 2306 2307 2308 2309 2310 2311
			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;
		}
	}

2312 2313
	if (data->update_names) {
		git_vector_foreach(data->update_names, i, name_entry) {
2314 2315 2316 2317 2318 2319 2320 2321 2322
			if ((error = git_index_name_add(data->index, name_entry->ancestor,
				name_entry->ours, name_entry->theirs)) < 0)
				goto done;
		}
	}

done:
	return error;
}
2323

2324 2325 2326 2327 2328 2329 2330 2331 2332 2333
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);

2334 2335
	git_vector_free_deep(&data->remove_conflicts);
	git_vector_free_deep(&data->update_conflicts);
2336

2337 2338 2339
	git__free(data->pfx);
	data->pfx = NULL;

2340
	git_buf_free(&data->target_path);
2341
	git_buf_free(&data->tmp);
2342 2343 2344

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

2346
	git_strmap_free(data->mkdir_map);
2347
	data->mkdir_map = NULL;
2348

2349
	git_attr_session__free(&data->attr_session);
2350 2351 2352 2353
}

static int checkout_data_init(
	checkout_data *data,
2354
	git_iterator *target,
2355
	const git_checkout_options *proposed)
2356
{
2357
	int error = 0;
2358
	git_repository *repo = git_iterator_owner(target);
2359

2360 2361 2362
	memset(data, 0, sizeof(*data));

	if (!repo) {
2363
		giterr_set(GITERR_CHECKOUT, "cannot checkout nothing");
2364
		return -1;
2365
	}
2366

2367 2368
	if ((!proposed || !proposed->target_directory) &&
		(error = git_repository__ensure_not_bare(repo, "checkout")) < 0)
2369
		return error;
2370

2371
	data->repo = repo;
2372
	data->target = target;
2373 2374

	GITERR_CHECK_VERSION(
2375
		proposed, GIT_CHECKOUT_OPTIONS_VERSION, "git_checkout_options");
2376 2377

	if (!proposed)
2378
		GIT_INIT_STRUCTURE(&data->opts, GIT_CHECKOUT_OPTIONS_VERSION);
2379
	else
2380
		memmove(&data->opts, proposed, sizeof(git_checkout_options));
2381

2382 2383 2384
	if (!data->opts.target_directory)
		data->opts.target_directory = git_repository_workdir(repo);
	else if (!git_path_isdir(data->opts.target_directory) &&
2385 2386 2387
			 (error = checkout_mkdir(data,
				data->opts.target_directory, NULL,
				GIT_DIR_MODE, GIT_MKDIR_VERIFY_DIR)) < 0)
2388 2389
		goto cleanup;

2390 2391
	/* refresh config and index content unless NO_REFRESH is given */
	if ((data->opts.checkout_strategy & GIT_CHECKOUT_NO_REFRESH) == 0) {
2392 2393
		git_config *cfg;

2394
		if ((error = git_repository_config__weakptr(&cfg, repo)) < 0)
2395 2396
			goto cleanup;

2397 2398 2399
		/* 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.)
2400
		 */
2401 2402 2403
		if ((error = git_repository_index(&data->index, data->repo)) < 0)
			goto cleanup;

2404
		if (data->index != git_iterator_index(target)) {
2405
			if ((error = git_index_read(data->index, true)) < 0)
2406
				goto cleanup;
2407

2408 2409 2410
			/* cannot checkout if unresolved conflicts exist */
			if ((data->opts.checkout_strategy & GIT_CHECKOUT_FORCE) == 0 &&
				git_index_has_conflicts(data->index)) {
2411
				error = GIT_ECONFLICT;
2412 2413 2414 2415 2416
				giterr_set(GITERR_CHECKOUT,
					"unresolved conflicts exist in the index");
				goto cleanup;
			}

2417
			/* clean conflict data in the current index */
2418
			git_index_name_clear(data->index);
Edward Thomson committed
2419
			git_index_reuc_clear(data->index);
2420 2421
		}
	}
2422

2423 2424 2425 2426 2427
	/* 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;

2428 2429 2430 2431 2432
	/* 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)
2433
		data->opts.checkout_strategy |= GIT_CHECKOUT_RECREATE_MISSING;
2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446

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

2447 2448 2449
	if ((error = git_repository__cvar(
			 &data->can_symlink, repo, GIT_CVAR_SYMLINKS)) < 0)
		goto cleanup;
2450

2451
	if (!data->opts.baseline && !data->opts.baseline_index) {
2452
		data->opts_free_baseline = true;
2453
		error = 0;
2454

2455 2456 2457 2458 2459
		/* 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);
2460

2461
		if (error == GIT_EUNBORNBRANCH) {
2462 2463 2464 2465 2466
			error = 0;
			giterr_clear();
		}

		if (error < 0)
2467 2468 2469
			goto cleanup;
	}

2470 2471
	if ((data->opts.checkout_strategy &
		(GIT_CHECKOUT_CONFLICT_STYLE_MERGE | GIT_CHECKOUT_CONFLICT_STYLE_DIFF3)) == 0) {
2472
		git_config_entry *conflict_style = NULL;
2473 2474 2475
		git_config *cfg = NULL;

		if ((error = git_repository_config__weakptr(&cfg, repo)) < 0 ||
2476
			(error = git_config_get_entry(&conflict_style, cfg, "merge.conflictstyle")) < 0 ||
2477 2478 2479 2480
			error == GIT_ENOTFOUND)
			;
		else if (error)
			goto cleanup;
2481
		else if (strcmp(conflict_style->value, "merge") == 0)
2482
			data->opts.checkout_strategy |= GIT_CHECKOUT_CONFLICT_STYLE_MERGE;
2483
		else if (strcmp(conflict_style->value, "diff3") == 0)
2484 2485 2486
			data->opts.checkout_strategy |= GIT_CHECKOUT_CONFLICT_STYLE_DIFF3;
		else {
			giterr_set(GITERR_CHECKOUT, "unknown style '%s' given for 'merge.conflictstyle'",
2487
				conflict_style->value);
2488
			error = -1;
2489
			git_config_entry_free(conflict_style);
2490 2491
			goto cleanup;
		}
2492
		git_config_entry_free(conflict_style);
2493 2494
	}

2495 2496
	git_pool_init(&data->pool, 1);

2497
	if ((error = git_vector_init(&data->removes, 0, git__strcmp_cb)) < 0 ||
2498 2499
		(error = git_vector_init(&data->remove_conflicts, 0, NULL)) < 0 ||
		(error = git_vector_init(&data->update_conflicts, 0, NULL)) < 0 ||
2500 2501
		(error = git_buf_puts(&data->target_path, data->opts.target_directory)) < 0 ||
		(error = git_path_to_dir(&data->target_path)) < 0 ||
2502
		(error = git_strmap_alloc(&data->mkdir_map)) < 0)
2503 2504
		goto cleanup;

2505
	data->target_len = git_buf_len(&data->target_path);
2506

2507 2508
	git_attr_session__init(&data->attr_session, data->repo);

2509 2510 2511
cleanup:
	if (error < 0)
		checkout_data_clear(data);
2512 2513 2514 2515

	return error;
}

2516 2517 2518
#define CHECKOUT_INDEX_DONT_WRITE_MASK \
	(GIT_CHECKOUT_DONT_UPDATE_INDEX | GIT_CHECKOUT_DONT_WRITE_INDEX)

2519 2520
int git_checkout_iterator(
	git_iterator *target,
2521
	git_index *index,
2522
	const git_checkout_options *opts)
2523 2524
{
	int error = 0;
2525
	git_iterator *baseline = NULL, *workdir = NULL;
2526 2527
	git_iterator_options baseline_opts = GIT_ITERATOR_OPTIONS_INIT,
		workdir_opts = GIT_ITERATOR_OPTIONS_INIT;
2528
	checkout_data data = {0};
2529
	git_diff_options diff_opts = GIT_DIFF_OPTIONS_INIT;
2530 2531
	uint32_t *actions = NULL;
	size_t *counts = NULL;
2532

2533
	/* initialize structures and options */
2534
	error = checkout_data_init(&data, target, opts);
2535 2536
	if (error < 0)
		return error;
Ben Straub committed
2537

2538 2539
	diff_opts.flags =
		GIT_DIFF_INCLUDE_UNMODIFIED |
2540
		GIT_DIFF_INCLUDE_UNREADABLE |
2541 2542 2543 2544 2545
		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 |
2546 2547
		GIT_DIFF_SKIP_BINARY_CHECK |
		GIT_DIFF_INCLUDE_CASECHANGE;
2548 2549
	if (data.opts.checkout_strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH)
		diff_opts.flags |= GIT_DIFF_DISABLE_PATHSPEC_MATCH;
2550 2551 2552 2553
	if (data.opts.paths.count > 0)
		diff_opts.pathspec = data.opts.paths;

	/* set up iterators */
2554

2555
	workdir_opts.flags = git_iterator_ignore_case(target) ?
2556
		GIT_ITERATOR_IGNORE_CASE : GIT_ITERATOR_DONT_IGNORE_CASE;
2557 2558 2559
	workdir_opts.flags |= GIT_ITERATOR_DONT_AUTOEXPAND;
	workdir_opts.start = data.pfx;
	workdir_opts.end = data.pfx;
2560

2561
	if ((error = git_iterator_reset_range(target, data.pfx, data.pfx)) < 0 ||
2562
		(error = git_iterator_for_workdir_ext(
2563
			&workdir, data.repo, data.opts.target_directory, index, NULL,
2564
			&workdir_opts)) < 0)
2565 2566
		goto cleanup;

2567 2568 2569 2570
	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;
2571 2572 2573 2574
	if (opts && (opts->checkout_strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH)) {
		baseline_opts.pathlist.count = opts->paths.count;
		baseline_opts.pathlist.strings = opts->paths.strings;
	}
2575

2576 2577
	if (data.opts.baseline_index) {
		if ((error = git_iterator_for_index(
2578 2579
				&baseline, git_index_owner(data.opts.baseline_index),
				data.opts.baseline_index, &baseline_opts)) < 0)
2580 2581 2582
			goto cleanup;
	} else {
		if ((error = git_iterator_for_tree(
2583
				&baseline, data.opts.baseline, &baseline_opts)) < 0)
2584 2585 2586
			goto cleanup;
	}

2587 2588
	/* Should not have case insensitivity mismatch */
	assert(git_iterator_ignore_case(workdir) == git_iterator_ignore_case(baseline));
2589

2590 2591
	/* Generate baseline-to-target diff which will include an entry for
	 * every possible update that might need to be made.
2592 2593
	 */
	if ((error = git_diff__from_iterators(
2594
			&data.diff, data.repo, baseline, target, &diff_opts)) < 0)
2595 2596
		goto cleanup;

2597
	/* Loop through diff (and working directory iterator) building a list of
2598 2599
	 * actions to be taken, plus look for conflicts and send notifications,
	 * then loop through conflicts.
2600
	 */
2601
	if ((error = checkout_get_actions(&actions, &counts, &data, workdir)) != 0)
2602 2603
		goto cleanup;

2604
	data.total_steps = counts[CHECKOUT_ACTION__REMOVE] +
2605
		counts[CHECKOUT_ACTION__REMOVE_CONFLICT] +
2606
		counts[CHECKOUT_ACTION__UPDATE_BLOB] +
2607 2608
		counts[CHECKOUT_ACTION__UPDATE_SUBMODULE] +
		counts[CHECKOUT_ACTION__UPDATE_CONFLICT];
2609

2610
	report_progress(&data, NULL); /* establish 0 baseline */
2611

2612 2613 2614
	/* To deal with some order dependencies, perform remaining checkout
	 * in three passes: removes, then update blobs, then update submodules.
	 */
2615
	if (counts[CHECKOUT_ACTION__REMOVE] > 0 &&
2616
		(error = checkout_remove_the_old(actions, &data)) < 0)
2617 2618
		goto cleanup;

2619 2620 2621 2622
	if (counts[CHECKOUT_ACTION__REMOVE_CONFLICT] > 0 &&
		(error = checkout_remove_conflicts(&data)) < 0)
		goto cleanup;

2623
	if (counts[CHECKOUT_ACTION__UPDATE_BLOB] > 0 &&
2624
		(error = checkout_create_the_new(actions, &data)) < 0)
2625 2626
		goto cleanup;

2627
	if (counts[CHECKOUT_ACTION__UPDATE_SUBMODULE] > 0 &&
2628
		(error = checkout_create_submodules(actions, &data)) < 0)
2629 2630
		goto cleanup;

2631
	if (counts[CHECKOUT_ACTION__UPDATE_CONFLICT] > 0 &&
2632
		(error = checkout_create_conflicts(&data)) < 0)
2633
		goto cleanup;
2634

2635
	if (data.index != git_iterator_index(target) &&
2636 2637 2638
		(error = checkout_extensions_update_index(&data)) < 0)
		goto cleanup;

2639
	assert(data.completed_steps == data.total_steps);
2640

2641 2642 2643
	if (data.opts.perfdata_cb)
		data.opts.perfdata_cb(&data.perfdata, data.opts.perfdata_payload);

2644
cleanup:
2645
	if (!error && data.index != NULL &&
2646
		(data.strategy & CHECKOUT_INDEX_DONT_WRITE_MASK) == 0)
2647 2648
		error = git_index_write(data.index);

2649
	git_diff_free(data.diff);
2650
	git_iterator_free(workdir);
2651
	git_iterator_free(baseline);
2652 2653
	git__free(actions);
	git__free(counts);
2654
	checkout_data_clear(&data);
2655 2656 2657 2658 2659 2660 2661

	return error;
}

int git_checkout_index(
	git_repository *repo,
	git_index *index,
2662
	const git_checkout_options *opts)
2663
{
2664
	int error, owned = 0;
2665
	git_iterator *index_i;
2666

2667 2668
	if (!index && !repo) {
		giterr_set(GITERR_CHECKOUT,
2669
			"must provide either repository or index to checkout");
2670 2671
		return -1;
	}
2672 2673 2674 2675

	if (index && repo &&
		git_index_owner(index) &&
		git_index_owner(index) != repo) {
2676
		giterr_set(GITERR_CHECKOUT,
2677
			"index to checkout does not match repository");
2678
		return -1;
2679 2680 2681
	} else if(index && repo && !git_index_owner(index)) {
		GIT_REFCOUNT_OWN(index, repo);
		owned = 1;
2682 2683 2684 2685
	}

	if (!repo)
		repo = git_index_owner(index);
2686 2687 2688

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

2691
	if (!(error = git_iterator_for_index(&index_i, repo, index, NULL)))
2692
		error = git_checkout_iterator(index_i, index, opts);
2693

2694 2695 2696
	if (owned)
		GIT_REFCOUNT_OWN(index, NULL);

2697
	git_iterator_free(index_i);
2698
	git_index_free(index);
2699

2700 2701 2702 2703 2704
	return error;
}

int git_checkout_tree(
	git_repository *repo,
Vicent Marti committed
2705
	const git_object *treeish,
2706
	const git_checkout_options *opts)
2707
{
2708
	int error;
2709
	git_index *index;
2710 2711
	git_tree *tree = NULL;
	git_iterator *tree_i = NULL;
2712
	git_iterator_options iter_opts = GIT_ITERATOR_OPTIONS_INIT;
2713

2714 2715
	if (!treeish && !repo) {
		giterr_set(GITERR_CHECKOUT,
2716
			"must provide either repository or tree to checkout");
2717 2718 2719 2720
		return -1;
	}
	if (treeish && repo && git_object_owner(treeish) != repo) {
		giterr_set(GITERR_CHECKOUT,
2721
			"object to checkout does not match repository");
2722 2723 2724 2725 2726
		return -1;
	}

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

2728 2729 2730
	if (treeish) {
		if (git_object_peel((git_object **)&tree, treeish, GIT_OBJ_TREE) < 0) {
			giterr_set(
2731
				GITERR_CHECKOUT, "provided object cannot be peeled to a tree");
2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742
			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;
		}
2743 2744
	}

2745 2746 2747
	if ((error = git_repository_index(&index, repo)) < 0)
		return error;

2748
	if (opts && (opts->checkout_strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH)) {
2749 2750 2751 2752 2753
		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)))
2754
		error = git_checkout_iterator(tree_i, index, opts);
2755

2756
	git_iterator_free(tree_i);
2757
	git_index_free(index);
2758
	git_tree_free(tree);
2759

2760
	return error;
2761 2762
}

2763 2764
int git_checkout_head(
	git_repository *repo,
2765
	const git_checkout_options *opts)
2766
{
2767
	assert(repo);
2768
	return git_checkout_tree(repo, NULL, opts);
2769
}
2770

2771
int git_checkout_init_options(git_checkout_options *opts, unsigned int version)
2772
{
2773 2774 2775
	GIT_INIT_STRUCTURE_FROM_TEMPLATE(
		opts, version, git_checkout_options, GIT_CHECKOUT_OPTIONS_INIT);
	return 0;
2776
}