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

#include <assert.h>

10 11
#include "checkout.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 "pathspec.h"
30
#include "buf_text.h"
31
#include "diff_xdiff.h"
32
#include "path.h"
33
#include "attr.h"
34 35 36
#include "pool.h"
#include "strmap.h"

37
GIT__USE_STRMAP
38

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

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

typedef struct {
	git_repository *repo;
57
	git_iterator *target;
58
	git_diff *diff;
59
	git_checkout_options opts;
60 61 62 63 64
	bool opts_free_baseline;
	char *pfx;
	git_index *index;
	git_pool pool;
	git_vector removes;
65 66 67 68
	git_vector remove_conflicts;
	git_vector update_conflicts;
	git_vector *update_reuc;
	git_vector *update_names;
69 70
	git_buf path;
	size_t workdir_len;
71
	git_buf tmp;
72 73 74 75 76
	unsigned int strategy;
	int can_symlink;
	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
static bool checkout_is_workdir_modified(
164
	checkout_data *data,
165
	const git_diff_file *baseitem,
166
	const git_diff_file *newitem,
167
	const git_index_entry *wditem)
168 169
{
	git_oid oid;
170
	const git_index_entry *ie;
171

172 173 174 175 176
	/* handle "modified" submodule */
	if (wditem->mode == GIT_FILEMODE_COMMIT) {
		git_submodule *sm;
		unsigned int sm_status = 0;
		const git_oid *sm_oid = NULL;
177
		bool rval = false;
178

179 180
		if (git_submodule_lookup(&sm, data->repo, wditem->path) < 0) {
			giterr_clear();
181
			return true;
182
		}
183

184
		if (git_submodule_status(&sm_status, data->repo, wditem->path, GIT_SUBMODULE_IGNORE_UNSPECIFIED) < 0 ||
185 186 187 188 189 190
			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);
191

192 193
		git_submodule_free(sm);
		return rval;
194 195
	}

196 197
	/* 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
198 199 200
	 * 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.)
201 202 203 204 205
	 */
	if ((ie = git_index_get_bypath(data->index, wditem->path, 0)) != NULL) {
		if (wditem->mtime.seconds == ie->mtime.seconds &&
			wditem->mtime.nanoseconds == ie->mtime.nanoseconds &&
			wditem->file_size == ie->file_size)
206
			return !is_workdir_base_or_new(&ie->id, baseitem, newitem);
207 208
	}

209 210 211 212
	/* 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)
213 214
		return true;

215
	if (git_diff__oid_for_entry(&oid, data->diff, wditem, wditem->mode, NULL) < 0)
216 217
		return false;

218 219 220 221
	/* 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);
222 223 224 225 226 227
}

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

static int checkout_action_common(
228
	int *action,
229
	checkout_data *data,
230
	const git_diff_delta *delta,
231 232 233 234 235
	const git_index_entry *wd)
{
	git_checkout_notify_t notify = GIT_CHECKOUT_NOTIFY_NONE;

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

238
	if ((*action & CHECKOUT_ACTION__UPDATE_BLOB) != 0) {
239
		if (S_ISGITLINK(delta->new_file.mode))
240
			*action = (*action & ~CHECKOUT_ACTION__UPDATE_BLOB) |
241 242
				CHECKOUT_ACTION__UPDATE_SUBMODULE;

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

247 248 249 250 251 252
		/* 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;

253 254 255
		notify = GIT_CHECKOUT_NOTIFY_UPDATED;
	}

256
	if ((*action & CHECKOUT_ACTION__CONFLICT) != 0)
257 258
		notify = GIT_CHECKOUT_NOTIFY_CONFLICT;

259
	return checkout_notify(data, notify, delta, wd);
260 261 262
}

static int checkout_action_no_wd(
263
	int *action,
264 265
	checkout_data *data,
	const git_diff_delta *delta)
266
{
267 268 269
	int error = 0;

	*action = CHECKOUT_ACTION__NONE;
270

271 272
	switch (delta->status) {
	case GIT_DELTA_UNMODIFIED: /* case 12 */
273 274 275
		error = checkout_notify(data, GIT_CHECKOUT_NOTIFY_DIRTY, delta, NULL);
		if (error)
			return error;
276
		*action = CHECKOUT_ACTION_IF(RECREATE_MISSING, UPDATE_BLOB, NONE);
277 278
		break;
	case GIT_DELTA_ADDED:    /* case 2 or 28 (and 5 but not really) */
279
		*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
280
		break;
281
	case GIT_DELTA_MODIFIED: /* case 13 (and 35 but not really) */
282
		*action = CHECKOUT_ACTION_IF(RECREATE_MISSING, UPDATE_BLOB, CONFLICT);
283
		break;
284 285
	case GIT_DELTA_TYPECHANGE: /* case 21 (B->T) and 28 (T->B)*/
		if (delta->new_file.mode == GIT_FILEMODE_TREE)
286
			*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
287 288
		break;
	case GIT_DELTA_DELETED: /* case 8 or 25 */
289
		*action = CHECKOUT_ACTION_IF(SAFE, REMOVE, NONE);
290
		break;
291 292
	default: /* impossible */
		break;
293 294
	}

295
	return checkout_action_common(action, data, delta, NULL);
296 297
}

298 299 300 301 302 303 304 305 306 307 308
static bool wd_item_is_removable(git_iterator *iter, const git_index_entry *wd)
{
	git_buf *full = NULL;

	if (wd->mode != GIT_FILEMODE_TREE)
		return true;
	if (git_iterator_current_workdir_path(&full, iter) < 0)
		return true;
	return !full || !git_path_contains(full, DOT_GIT);
}

309 310 311 312 313 314 315 316
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 */
317 318 319
static int checkout_action_wd_only(
	checkout_data *data,
	git_iterator *workdir,
320
	const git_index_entry **wditem,
321 322
	git_vector *pathspec)
{
323
	int error = 0;
324
	bool remove = false;
325
	git_checkout_notify_t notify = GIT_CHECKOUT_NOTIFY_NONE;
326
	const git_index_entry *wd = *wditem;
327

328
	if (!git_pathspec__match(
329 330
			pathspec, wd->path,
			(data->strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH) != 0,
331
			git_iterator_ignore_case(workdir), NULL, NULL))
332
		return git_iterator_advance(wditem, workdir);
333

334
	/* check if item is tracked in the index but not in the checkout diff */
335
	if (data->index != NULL) {
336 337
		size_t pos;

338
		error = git_index__find_pos(
339 340
			&pos, data->index, wd->path, 0, GIT_INDEX_STAGE_ANY);

341
		if (wd->mode != GIT_FILEMODE_TREE) {
342
			if (!error) { /* found by git_index__find_pos call */
343 344
				notify = GIT_CHECKOUT_NOTIFY_DIRTY;
				remove = ((data->strategy & GIT_CHECKOUT_FORCE) != 0);
345 346
			} else if (error != GIT_ENOTFOUND)
				return error;
347
			else
348
				error = 0; /* git_index__find_pos does not set error msg */
349 350 351 352 353 354 355 356 357 358 359
		} 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);

			if (e != NULL && data->diff->pfxcomp(e->path, wd->path) == 0) {
				notify = GIT_CHECKOUT_NOTIFY_DIRTY;
				remove = ((data->strategy & GIT_CHECKOUT_FORCE) != 0);
			}
		}
360
	}
361

362 363 364 365 366 367 368 369 370 371 372 373
	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;

		if (remove && wd_item_is_removable(workdir, wd))
			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 */
374 375
		bool over = false, removable = wd_item_is_removable(workdir, wd);
		git_iterator_status_t untracked_state;
376 377 378 379 380

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

382 383
		error = git_iterator_advance_over_with_status(
			wditem, &untracked_state, workdir);
384 385 386 387
		if (error == GIT_ITEROVER)
			over = true;
		else if (error < 0)
			return error;
388

389
		if (untracked_state == GIT_ITERATOR_STATUS_IGNORED) {
390 391 392 393 394 395
			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);
		}
396

397 398 399 400 401 402 403 404
		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;
405 406
	}

407
	return error;
408 409
}

410 411 412 413 414 415
static bool submodule_is_config_only(
	checkout_data *data,
	const char *path)
{
	git_submodule *sm = NULL;
	unsigned int sm_loc = 0;
416
	bool rval = false;
417

418
	if (git_submodule_lookup(&sm, data->repo, path) < 0)
419 420
		return true;

421 422 423 424 425 426
	if (git_submodule_location(&sm_loc, sm) < 0 ||
		sm_loc == GIT_SUBMODULE_STATUS_IN_CONFIG)
		rval = true;

	git_submodule_free(sm);

427
	return rval;
428 429
}

430 431 432 433 434 435 436 437
static bool checkout_is_empty_dir(checkout_data *data, const char *path)
{
	git_buf_truncate(&data->path, data->workdir_len);
	if (git_buf_puts(&data->path, path) < 0)
		return false;
	return git_path_is_empty_dir(data->path.ptr);
}

438
static int checkout_action_with_wd(
439
	int *action,
440 441
	checkout_data *data,
	const git_diff_delta *delta,
442
	git_iterator *workdir,
443 444
	const git_index_entry *wd)
{
445
	*action = CHECKOUT_ACTION__NONE;
446 447 448

	switch (delta->status) {
	case GIT_DELTA_UNMODIFIED: /* case 14/15 or 33 */
449
		if (checkout_is_workdir_modified(data, &delta->old_file, &delta->new_file, wd)) {
450 451 452
			GITERR_CHECK_ERROR(
				checkout_notify(data, GIT_CHECKOUT_NOTIFY_DIRTY, delta, wd) );
			*action = CHECKOUT_ACTION_IF(FORCE, UPDATE_BLOB, NONE);
453
		}
454 455
		break;
	case GIT_DELTA_ADDED: /* case 3, 4 or 6 */
456 457 458 459
		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);
460 461
		break;
	case GIT_DELTA_DELETED: /* case 9 or 10 (or 26 but not really) */
462
		if (checkout_is_workdir_modified(data, &delta->old_file, &delta->new_file, wd))
463
			*action = CHECKOUT_ACTION_IF(FORCE, REMOVE, CONFLICT);
464
		else
465
			*action = CHECKOUT_ACTION_IF(SAFE, REMOVE, NONE);
466 467
		break;
	case GIT_DELTA_MODIFIED: /* case 16, 17, 18 (or 36 but not really) */
468
		if (checkout_is_workdir_modified(data, &delta->old_file, &delta->new_file, wd))
469
			*action = CHECKOUT_ACTION_IF(FORCE, UPDATE_BLOB, CONFLICT);
470
		else
471
			*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
472 473
		break;
	case GIT_DELTA_TYPECHANGE: /* case 22, 23, 29, 30 */
474 475 476 477 478
		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...
				 */
479
				*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
480 481 482 483 484
			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))
485
					*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
486
				else
487
					*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
488
			} else
489
				*action = CHECKOUT_ACTION_IF(FORCE, REMOVE, CONFLICT);
490
		}
491
		else if (checkout_is_workdir_modified(data, &delta->old_file, &delta->new_file, wd))
492
			*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
493
		else
494
			*action = CHECKOUT_ACTION_IF(SAFE, REMOVE_AND_UPDATE, NONE);
495 496 497

		/* don't update if the typechange is to a tree */
		if (delta->new_file.mode == GIT_FILEMODE_TREE)
498
			*action = (*action & ~CHECKOUT_ACTION__UPDATE_BLOB);
499 500 501
		break;
	default: /* impossible */
		break;
502 503
	}

504
	return checkout_action_common(action, data, delta, wd);
505
}
506

507
static int checkout_action_with_wd_blocker(
508
	int *action,
509 510 511 512
	checkout_data *data,
	const git_diff_delta *delta,
	const git_index_entry *wd)
{
513
	*action = CHECKOUT_ACTION__NONE;
514

515 516 517
	switch (delta->status) {
	case GIT_DELTA_UNMODIFIED:
		/* should show delta as dirty / deleted */
518 519 520
		GITERR_CHECK_ERROR(
			checkout_notify(data, GIT_CHECKOUT_NOTIFY_DIRTY, delta, wd) );
		*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, NONE);
521 522 523
		break;
	case GIT_DELTA_ADDED:
	case GIT_DELTA_MODIFIED:
524
		*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
525 526
		break;
	case GIT_DELTA_DELETED:
527
		*action = CHECKOUT_ACTION_IF(FORCE, REMOVE, CONFLICT);
528 529 530
		break;
	case GIT_DELTA_TYPECHANGE:
		/* not 100% certain about this... */
531
		*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
532 533 534
		break;
	default: /* impossible */
		break;
535 536
	}

537
	return checkout_action_common(action, data, delta, wd);
538 539 540
}

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

	switch (delta->status) {
	case GIT_DELTA_UNMODIFIED: /* case 19 or 24 (or 34 but not really) */
551 552 553 554
		GITERR_CHECK_ERROR(
			checkout_notify(data, GIT_CHECKOUT_NOTIFY_DIRTY, delta, NULL));
		GITERR_CHECK_ERROR(
			checkout_notify(data, GIT_CHECKOUT_NOTIFY_UNTRACKED, NULL, wd));
555
		*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, NONE);
556 557 558
		break;
	case GIT_DELTA_ADDED:/* case 4 (and 7 for dir) */
	case GIT_DELTA_MODIFIED: /* case 20 (or 37 but not really) */
559 560 561
		if (delta->old_file.mode == GIT_FILEMODE_COMMIT)
			/* expected submodule (and maybe found one) */;
		else if (delta->new_file.mode != GIT_FILEMODE_TREE)
562 563 564
			*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);
565 566
		break;
	case GIT_DELTA_DELETED: /* case 11 (and 27 for dir) */
567 568 569
		if (delta->old_file.mode != GIT_FILEMODE_TREE)
			GITERR_CHECK_ERROR(
				checkout_notify(data, GIT_CHECKOUT_NOTIFY_UNTRACKED, NULL, wd));
570 571 572
		break;
	case GIT_DELTA_TYPECHANGE: /* case 24 or 31 */
		if (delta->old_file.mode == GIT_FILEMODE_TREE) {
573 574 575 576 577 578
			/* 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.
			 */
579
			*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
580
		}
581 582
		else if (delta->new_file.mode != GIT_FILEMODE_TREE)
			/* For typechange to dir, dir is already created so no action */
583
			*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
584 585 586
		break;
	default: /* impossible */
		break;
587 588
	}

589
	return checkout_action_common(action, data, delta, wd);
590 591
}

592 593 594 595 596 597 598 599 600 601 602 603 604 605
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;
}

606
static int checkout_action(
607
	int *action,
608
	checkout_data *data,
609
	git_diff_delta *delta,
610
	git_iterator *workdir,
611
	const git_index_entry **wditem,
612 613
	git_vector *pathspec)
{
614
	int cmp = -1, error;
615 616
	int (*strcomp)(const char *, const char *) = data->diff->strcomp;
	int (*pfxcomp)(const char *str, const char *pfx) = data->diff->pfxcomp;
617
	int (*advance)(const git_index_entry **, git_iterator *) = NULL;
618 619 620 621

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

	while (1) {
622 623
		const git_index_entry *wd = *wditem;

624
		if (!wd)
625
			return checkout_action_no_wd(action, data, delta);
626

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

640
			if (cmp == 0) {
641 642
				if (wd->mode == GIT_FILEMODE_TREE) {
					/* case 2 - entry prefixed by workdir tree */
643 644 645
					error = git_iterator_advance_into_or_over(wditem, workdir);
					if (error < 0 && error != GIT_ITEROVER)
						goto done;
646 647 648 649 650
					continue;
				}

				/* case 3 maybe - wd contains non-dir where dir expected */
				if (delta->old_file.path[strlen(wd->path)] == '/') {
651 652 653 654
					error = checkout_action_with_wd_blocker(
						action, data, delta, wd);
					advance = git_iterator_advance;
					goto done;
655
				}
656
			}
657

658
			/* case 1 - handle wd item (if it matches pathspec) */
659 660
			error = checkout_action_wd_only(data, workdir, wditem, pathspec);
			if (error && error != GIT_ITEROVER)
661
				goto done;
662 663
			continue;
		}
664

665 666
		if (cmp == 0) {
			/* case 4 */
667
			error = checkout_action_with_wd(action, data, delta, workdir, wd);
668 669
			advance = git_iterator_advance;
			goto done;
670
		}
671

672
		cmp = pfxcomp(wd->path, delta->old_file.path);
673

674
		if (cmp == 0) { /* case 5 */
675
			if (wd->path[strlen(delta->old_file.path)] != '/')
676
				return checkout_action_no_wd(action, data, delta);
677 678 679

			if (delta->status == GIT_DELTA_TYPECHANGE) {
				if (delta->old_file.mode == GIT_FILEMODE_TREE) {
680
					error = checkout_action_with_wd(action, data, delta, workdir, wd);
681 682
					advance = git_iterator_advance_into;
					goto done;
683 684 685 686 687 688
				}

				if (delta->new_file.mode == GIT_FILEMODE_TREE ||
					delta->new_file.mode == GIT_FILEMODE_COMMIT ||
					delta->old_file.mode == GIT_FILEMODE_COMMIT)
				{
689
					error = checkout_action_with_wd(action, data, delta, workdir, wd);
690 691
					advance = git_iterator_advance;
					goto done;
692
				}
693 694
			}

695 696 697
			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);
698
		}
699

700
		/* case 6 - wd is after delta */
701
		return checkout_action_no_wd(action, data, delta);
702 703
	}

704 705 706 707 708 709 710 711 712
done:
	if (!error && advance != NULL &&
		(error = advance(wditem, workdir)) < 0) {
		*wditem = NULL;
		if (error == GIT_ITEROVER)
			error = 0;
	}

	return error;
713 714
}

715 716 717 718 719 720 721 722
static int checkout_remaining_wd_items(
	checkout_data *data,
	git_iterator *workdir,
	const git_index_entry *wd,
	git_vector *spec)
{
	int error = 0;

723 724
	while (wd && !error)
		error = checkout_action_wd_only(data, workdir, &wd, spec);
725

726 727 728
	if (error == GIT_ITEROVER)
		error = 0;

729 730 731
	return error;
}

732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758
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;
}

759 760
int checkout_conflictdata_empty(
	const git_vector *conflicts, size_t idx, void *payload)
761 762 763
{
	checkout_conflictdata *conflict;

764 765
	GIT_UNUSED(payload);

766 767 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 795 796 797 798 799 800 801 802
	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
803 804 805 806 807 808 809 810
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;
}

811 812 813 814 815
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
816 817 818
	if (conflict->submodule)
		return 0;

819
	if (conflict->ancestor) {
820
		if ((error = git_blob_lookup(&ancestor_blob, repo, &conflict->ancestor->id)) < 0)
821 822 823 824 825 826
			goto done;

		conflict->binary = git_blob_is_binary(ancestor_blob);
	}

	if (!conflict->binary && conflict->ours) {
827
		if ((error = git_blob_lookup(&our_blob, repo, &conflict->ours->id)) < 0)
828 829 830 831 832 833
			goto done;

		conflict->binary = git_blob_is_binary(our_blob);
	}

	if (!conflict->binary && conflict->theirs) {
834
		if ((error = git_blob_lookup(&their_blob, repo, &conflict->theirs->id)) < 0)
835 836 837 838 839 840 841 842 843 844 845 846 847
			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;
}

848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884
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)
885 886 887 888 889
{
	git_index_conflict_iterator *iterator = NULL;
	const git_index_entry *ancestor, *ours, *theirs;
	int error = 0;

890
	if ((error = git_index_conflict_iterator_new(&iterator, index)) < 0)
891 892 893 894 895 896 897
		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;

898
		if ((error = cb(ancestor, ours, theirs, payload)) < 0)
899
			goto done;
900 901 902 903 904 905 906 907 908 909 910
	}

	if (error == GIT_ITEROVER)
		error = 0;

done:
	git_index_conflict_iterator_free(iterator);

	return error;
}

911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
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. */
	if ((index = git_iterator_get_index(data->target)) == NULL)
		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;
}

931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
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;

955
	if (git_vector_bsearch2(&pos, &data->update_conflicts, checkout_conflicts_cmp_ancestor, path) < 0)
956 957
		return NULL;

958
	return git_vector_get(&data->update_conflicts, pos);
959 960 961 962 963 964 965 966 967
}

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

968
	git_vector_foreach(&data->update_conflicts, i, conflict) {
969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 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 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
		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) {
		giterr_set(GITERR_INDEX, "A NAME entry exists without an ancestor");
		error = -1;
		goto done;
	}

	if (!name_entry->ours && !name_entry->theirs) {
		giterr_set(GITERR_INDEX, "A NAME entry exists without an ours or theirs");
		error = -1;
		goto done;
	}

	if ((ancestor = checkout_conflicts_search_ancestor(data,
		name_entry->ancestor)) == NULL) {
		giterr_set(GITERR_INDEX,
			"A NAME entry referenced ancestor entry '%s' which does not exist in the main index",
			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,
				"A NAME entry referenced our entry '%s' which does not exist in the main index",
				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,
				"A NAME entry referenced their entry '%s' which does not exist in the main index",
				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)
{
1060
	git_index *index;
1061 1062 1063 1064 1065
	const git_index_name_entry *name_entry;
	checkout_conflictdata *ancestor_conflict, *our_conflict, *their_conflict;
	size_t i, names;
	int error = 0;

1066 1067 1068
	if ((index = git_iterator_get_index(data->target)) == NULL)
		return 0;

1069
	/* Juggle entries based on renames */
1070
	names = git_index_name_entrycount(index);
Russell Belfer committed
1071

1072
	for (i = 0; i < names; i++) {
1073
		name_entry = git_index_name_get_byindex(index, i);
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106

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

1107
	git_vector_remove_matching(
1108
		&data->update_conflicts, checkout_conflictdata_empty, NULL);
1109 1110 1111 1112 1113 1114 1115 1116

done:
	return error;
}

static int checkout_conflicts_mark_directoryfile(
	checkout_data *data)
{
1117
	git_index *index;
1118 1119 1120 1121
	checkout_conflictdata *conflict;
	const git_index_entry *entry;
	size_t i, j, len;
	const char *path;
1122
	int prefixed, error = 0;
1123

1124 1125 1126 1127
	if ((index = git_iterator_get_index(data->target)) == NULL)
		return 0;

	len = git_index_entrycount(index);
1128 1129

	/* Find d/f conflicts */
1130
	git_vector_foreach(&data->update_conflicts, i, conflict) {
1131 1132 1133 1134 1135 1136 1137
		if ((conflict->ours && conflict->theirs) ||
			(!conflict->ours && !conflict->theirs))
			continue;

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

1138
		if ((error = git_index_find(&j, index, path)) < 0) {
1139 1140 1141 1142 1143 1144 1145 1146
			if (error == GIT_ENOTFOUND)
				giterr_set(GITERR_INDEX,
					"Index inconsistency, could not find entry for expected conflict '%s'", path);

			goto done;
		}

		for (; j < len; j++) {
1147
			if ((entry = git_index_get_byindex(index, j)) == NULL) {
1148 1149 1150 1151 1152 1153
				giterr_set(GITERR_INDEX,
					"Index inconsistency, truncated index while loading expected conflict '%s'", path);
				error = -1;
				goto done;
			}

1154
			prefixed = git_path_equal_or_prefixed(path, entry->path, NULL);
1155

1156
			if (prefixed == GIT_PATH_EQUAL)
1157 1158
				continue;

1159
			if (prefixed == GIT_PATH_PREFIX)
1160 1161 1162 1163 1164 1165 1166 1167 1168 1169
				conflict->directoryfile = 1;

			break;
		}
	}

done:
	return error;
}

1170
static int checkout_get_update_conflicts(
1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188
	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;
}

1189 1190 1191 1192 1193 1194 1195 1196 1197
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;

1198 1199
	assert(ancestor || ours || theirs);

1200 1201 1202 1203 1204 1205
	if (ancestor)
		name = git__strdup(ancestor->path);
	else if (ours)
		name = git__strdup(ours->path);
	else if (theirs)
		name = git__strdup(theirs->path);
1206 1207
	else
		abort();
1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224

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

1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240
static int checkout_verify_paths(
	git_repository *repo,
	int action,
	git_diff_delta *delta)
{
	unsigned int flags = GIT_PATH_REJECT_DEFAULTS | GIT_PATH_REJECT_DOT_GIT;

	if (action & CHECKOUT_ACTION__REMOVE) {
		if (!git_path_isvalid(repo, delta->old_file.path, flags)) {
			giterr_set(GITERR_CHECKOUT, "Cannot remove invalid path '%s'", delta->old_file.path);
			return -1;
		}
	}

	if (action & ~CHECKOUT_ACTION__REMOVE) {
		if (!git_path_isvalid(repo, delta->new_file.path, flags)) {
1241
			giterr_set(GITERR_CHECKOUT, "Cannot checkout to invalid path '%s'", delta->new_file.path);
1242 1243 1244 1245 1246 1247 1248
			return -1;
		}
	}

	return 0;
}

1249 1250 1251
static int checkout_get_actions(
	uint32_t **actions_ptr,
	size_t **counts_ptr,
1252 1253
	checkout_data *data,
	git_iterator *workdir)
1254
{
1255
	int error = 0, act;
1256 1257 1258 1259 1260 1261 1262
	const git_index_entry *wditem;
	git_vector pathspec = GIT_VECTOR_INIT, *deltas;
	git_pool pathpool = GIT_POOL_INIT_STRINGPOOL;
	git_diff_delta *delta;
	size_t i, *counts = NULL;
	uint32_t *actions = NULL;

1263
	if (data->opts.paths.count > 0 &&
1264
		git_pathspec__vinit(&pathspec, &data->opts.paths, &pathpool) < 0)
1265 1266
		return -1;

1267 1268
	if ((error = git_iterator_current(&wditem, workdir)) < 0 &&
		error != GIT_ITEROVER)
1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281
		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) {
1282 1283 1284
		if ((error = checkout_action(&act, data, delta, workdir, &wditem, &pathspec)) == 0)
			error = checkout_verify_paths(data->repo, act, delta);

1285
		if (error != 0)
1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298
			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]++;
	}
1299

1300
	error = checkout_remaining_wd_items(data, workdir, wditem, &pathspec);
1301
	if (error)
1302
		goto fail;
1303

1304 1305 1306 1307 1308
	counts[CHECKOUT_ACTION__REMOVE] += data->removes.length;

	if (counts[CHECKOUT_ACTION__CONFLICT] > 0 &&
		(data->strategy & GIT_CHECKOUT_ALLOW_CONFLICTS) == 0)
	{
1309 1310
		giterr_set(GITERR_CHECKOUT, "%"PRIuZ" %s checkout",
			counts[CHECKOUT_ACTION__CONFLICT],
1311 1312
			counts[CHECKOUT_ACTION__CONFLICT] == 1 ?
			"conflict prevents" : "conflicts prevent");
1313
		error = GIT_ECONFLICT;
1314 1315 1316
		goto fail;
	}

1317

1318 1319
	if ((error = checkout_get_remove_conflicts(data, workdir, &pathspec)) < 0 ||
		(error = checkout_get_update_conflicts(data, workdir, &pathspec)) < 0)
1320 1321
		goto fail;

1322 1323
	counts[CHECKOUT_ACTION__REMOVE_CONFLICT] = git_vector_length(&data->remove_conflicts);
	counts[CHECKOUT_ACTION__UPDATE_CONFLICT] = git_vector_length(&data->update_conflicts);
1324

1325
	git_pathspec__vfree(&pathspec);
1326 1327 1328 1329 1330 1331 1332 1333 1334 1335
	git_pool_clear(&pathpool);

	return 0;

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

1336
	git_pathspec__vfree(&pathspec);
1337 1338 1339 1340 1341
	git_pool_clear(&pathpool);

	return error;
}

1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356
static bool should_remove_existing(checkout_data *data)
{
	int ignorecase = 0;

	git_repository__cvar(&ignorecase, data->repo, GIT_CVAR_IGNORECASE);

	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

1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379
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;

	error = git_futils_mkdir_ext(
		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;
}

1380 1381 1382
static int mkpath2file(
	checkout_data *data, const char *path, unsigned int mode)
{
1383 1384
	struct stat st;
	bool remove_existing = should_remove_existing(data);
1385 1386 1387
	unsigned int flags =
		(remove_existing ? MKDIR_REMOVE_EXISTING : MKDIR_NORMAL) |
		GIT_MKDIR_SKIP_LAST;
1388 1389
	int error;

1390 1391
	if ((error = checkout_mkdir(
			data, path, data->opts.target_directory, mode, flags)) < 0)
1392 1393
		return error;

1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411
	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) {
			giterr_set(GITERR_OS, "Failed to stat file '%s'", path);
			return GIT_EEXISTS;
		} else {
			giterr_clear();
		}
	}
1412 1413

	return error;
1414 1415
}

1416
struct checkout_stream {
1417
	git_writestream base;
1418 1419 1420 1421
	const char *path;
	int fd;
	int open;
};
1422

1423
static int checkout_stream_write(
1424
	git_writestream *s, const char *buffer, size_t len)
1425 1426 1427
{
	struct checkout_stream *stream = (struct checkout_stream *)s;
	int ret;
1428

1429 1430
	if ((ret = p_write(stream->fd, buffer, len)) < 0)
		giterr_set(GITERR_OS, "Could not write to '%s'", stream->path);
1431

1432 1433
	return ret;
}
1434

1435
static int checkout_stream_close(git_writestream *s)
1436 1437 1438
{
	struct checkout_stream *stream = (struct checkout_stream *)s;
	assert(stream && stream->open);
1439

1440
	stream->open = 0;
1441
	return p_close(stream->fd);
1442
}
1443

1444
static void checkout_stream_free(git_writestream *s)
1445 1446
{
	GIT_UNUSED(s);
Ben Straub committed
1447 1448
}

1449
static int blob_content_to_file(
1450
	checkout_data *data,
1451
	struct stat *st,
1452 1453
	git_blob *blob,
	const char *path,
1454
	const char *hint_path,
1455
	mode_t entry_filemode)
1456
{
1457
	int flags = data->opts.file_open_flags;
1458 1459
	mode_t file_mode = data->opts.file_mode ?
		data->opts.file_mode : entry_filemode;
1460
	git_filter_options filter_opts = GIT_FILTER_OPTIONS_INIT;
1461 1462
	struct checkout_stream writer;
	mode_t mode;
1463
	git_filter_list *fl = NULL;
1464
	int fd;
1465
	int error = 0;
1466

1467 1468 1469
	if (hint_path == NULL)
		hint_path = path;

1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482
	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) {
		giterr_set(GITERR_OS, "Could not open '%s' for writing", path);
		return fd;
	}

1483
	filter_opts.attr_session = &data->attr_session;
1484
	filter_opts.temp_buf = &data->tmp;
1485

1486
	if (!data->opts.disable_filters &&
1487 1488 1489
		(error = git_filter_list__load_ext(
			&fl, data->repo, blob, hint_path,
			GIT_FILTER_TO_WORKTREE, &filter_opts)))
1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500
		return error;

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

1503
	assert(writer.open == 0);
1504

1505
	git_filter_list_free(fl);
1506

1507 1508
	if (error < 0)
		return error;
1509

1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521
	if (st) {
		data->perfdata.stat_calls++;

		if ((error = p_stat(path, st)) < 0) {
			giterr_set(GITERR_OS, "Error statting '%s'", path);
			return error;
		}

		st->st_mode = entry_filemode;
	}

	return 0;
1522 1523
}

1524
static int blob_content_to_link(
1525
	checkout_data *data,
1526 1527
	struct stat *st,
	git_blob *blob,
1528
	const char *path)
1529 1530 1531
{
	git_buf linktarget = GIT_BUF_INIT;
	int error;
1532

1533
	if ((error = mkpath2file(data, path, data->opts.dir_mode)) < 0)
Linquize committed
1534
		return error;
1535

1536 1537
	if ((error = git_blob__getbuf(&linktarget, blob)) < 0)
		return error;
1538

1539
	if (data->can_symlink) {
1540
		if ((error = p_symlink(git_buf_cstr(&linktarget), path)) < 0)
1541
			giterr_set(GITERR_OS, "Could not create symlink %s", path);
1542
	} else {
1543
		error = git_futils_fake_symlink(git_buf_cstr(&linktarget), path);
1544 1545 1546
	}

	if (!error) {
1547 1548
		data->perfdata.stat_calls++;

1549 1550 1551 1552 1553
		if ((error = p_lstat(path, st)) < 0)
			giterr_set(GITERR_CHECKOUT, "Could not stat symlink %s", path);

		st->st_mode = GIT_FILEMODE_LINK;
	}
1554

1555 1556 1557
	git_buf_free(&linktarget);

	return error;
1558 1559
}

1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571
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 */
1572
	git_index_entry__init_from_stat(&entry, st, true);
1573
	git_oid_cpy(&entry.id, &file->id);
1574 1575 1576 1577

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

1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591
static int checkout_submodule_update_index(
	checkout_data *data,
	const git_diff_file *file)
{
	struct stat st;

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

	git_buf_truncate(&data->path, data->workdir_len);
	if (git_buf_puts(&data->path, file->path) < 0)
		return -1;

1592
	data->perfdata.stat_calls++;
1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
	if (p_stat(git_buf_cstr(&data->path), &st) < 0) {
		giterr_set(
			GITERR_CHECKOUT, "Could not stat submodule %s\n", file->path);
		return GIT_ENOTFOUND;
	}

	st.st_mode = GIT_FILEMODE_COMMIT;

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

1604
static int checkout_submodule(
1605
	checkout_data *data,
1606 1607
	const git_diff_file *file)
{
1608
	bool remove_existing = should_remove_existing(data);
1609 1610
	int error = 0;

1611
	/* Until submodules are supported, UPDATE_ONLY means do nothing here */
1612
	if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0)
1613 1614
		return 0;

1615 1616
	if ((error = checkout_mkdir(
			data,
1617 1618
			file->path, data->opts.target_directory, data->opts.dir_mode,
			remove_existing ? MKDIR_REMOVE_EXISTING : MKDIR_NORMAL)) < 0)
1619
		return error;
1620

1621
	if ((error = git_submodule_lookup(NULL, data->repo, file->path)) < 0) {
1622 1623 1624 1625 1626 1627 1628 1629
		/* 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);
		}

1630
		return error;
1631
	}
1632

1633
	/* TODO: Support checkout_strategy options.  Two circumstances:
1634 1635 1636 1637
	 * 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
	 *
1638 1639
	 * Checkout will not execute a pull on the submodule, but a clone
	 * command should probably be able to.  Do we need a submodule callback?
1640 1641
	 */

1642
	return checkout_submodule_update_index(data, file);
1643 1644
}

1645
static void report_progress(
1646
	checkout_data *data,
1647
	const char *path)
1648
{
1649 1650
	if (data->opts.progress_cb)
		data->opts.progress_cb(
1651
			path, data->completed_steps, data->total_steps,
1652
			data->opts.progress_payload);
1653 1654
}

1655 1656
static int checkout_safe_for_update_only(
	checkout_data *data, const char *path, mode_t expected_mode)
1657 1658 1659
{
	struct stat st;

1660 1661
	data->perfdata.stat_calls++;

1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678
	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 */
		giterr_set(GITERR_OS, "Failed to stat file '%s'", path);
		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;
}

1679
static int checkout_write_content(
1680
	checkout_data *data,
1681 1682 1683 1684 1685
	const git_oid *oid,
	const char *full_path,
	const char *hint_path,
	unsigned int mode,
	struct stat *st)
1686
{
1687
	int error = 0;
1688
	git_blob *blob;
1689

1690
	if ((error = git_blob_lookup(&blob, data->repo, oid)) < 0)
1691 1692
		return error;

1693
	if (S_ISLNK(mode))
1694
		error = blob_content_to_link(data, st, blob, full_path);
1695
	else
1696
		error = blob_content_to_file(data, st, blob, full_path, hint_path, mode);
1697 1698 1699

	git_blob_free(blob);

1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710
	/* 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;
	}

1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725
	return error;
}

static int checkout_blob(
	checkout_data *data,
	const git_diff_file *file)
{
	int error = 0;
	struct stat st;

	git_buf_truncate(&data->path, data->workdir_len);
	if (git_buf_puts(&data->path, file->path) < 0)
		return -1;

	if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0) {
1726
		int rval = checkout_safe_for_update_only(
1727
			data, git_buf_cstr(&data->path), file->mode);
1728 1729 1730 1731
		if (rval <= 0)
			return rval;
	}

1732
	error = checkout_write_content(
1733
		data, &file->id, git_buf_cstr(&data->path), NULL, file->mode, &st);
1734

1735 1736 1737 1738
	/* update the index unless prevented */
	if (!error && (data->strategy & GIT_CHECKOUT_DONT_UPDATE_INDEX) == 0)
		error = checkout_update_index(data, file, &st);

1739 1740 1741 1742
	/* update the submodule data if this was a new .gitmodules file */
	if (!error && strcmp(file->path, ".gitmodules") == 0)
		data->reload_submodules = true;

1743 1744 1745
	return error;
}

1746 1747
static int checkout_remove_the_old(
	unsigned int *actions,
1748
	checkout_data *data)
1749
{
1750
	int error = 0;
1751
	git_diff_delta *delta;
1752
	const char *str;
1753
	size_t i;
1754 1755 1756
	const char *workdir = git_buf_cstr(&data->path);
	uint32_t flg = GIT_RMDIR_EMPTY_PARENTS |
		GIT_RMDIR_REMOVE_FILES | GIT_RMDIR_REMOVE_BLOCKERS;
1757

1758 1759 1760
	if (data->opts.checkout_strategy & GIT_CHECKOUT_SKIP_LOCKED_DIRECTORIES)
		flg |= GIT_RMDIR_SKIP_NONEMPTY;

1761
	git_buf_truncate(&data->path, data->workdir_len);
1762

1763
	git_vector_foreach(&data->diff->deltas, i, delta) {
1764
		if (actions[i] & CHECKOUT_ACTION__REMOVE) {
1765
			error = git_futils_rmdir_r(delta->old_file.path, workdir, flg);
1766
			if (error < 0)
1767 1768 1769
				return error;

			data->completed_steps++;
1770
			report_progress(data, delta->old_file.path);
1771 1772 1773 1774 1775 1776 1777

			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);
			}
1778 1779 1780
		}
	}

1781 1782 1783 1784 1785 1786
	git_vector_foreach(&data->removes, i, str) {
		error = git_futils_rmdir_r(str, workdir, flg);
		if (error < 0)
			return error;

		data->completed_steps++;
1787
		report_progress(data, str);
1788 1789 1790 1791

		if ((data->strategy & GIT_CHECKOUT_DONT_UPDATE_INDEX) == 0 &&
			data->index != NULL)
		{
1792 1793 1794 1795
			if (str[strlen(str) - 1] == '/')
				(void)git_index_remove_directory(data->index, str, 0);
			else
				(void)git_index_remove(data->index, str, 0);
1796
		}
1797 1798 1799 1800 1801 1802 1803 1804 1805
	}

	return 0;
}

static int checkout_deferred_remove(git_repository *repo, const char *path)
{
#if 0
	int error = git_futils_rmdir_r(
1806
		path, data->opts.target_directory, GIT_RMDIR_EMPTY_PARENTS);
1807 1808 1809 1810 1811 1812 1813 1814 1815 1816

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

	return error;
#else
	GIT_UNUSED(repo);
	GIT_UNUSED(path);
1817
	assert(false);
1818
	return 0;
1819
#endif
1820 1821 1822 1823
}

static int checkout_create_the_new(
	unsigned int *actions,
1824
	checkout_data *data)
1825
{
1826
	int error = 0;
1827 1828 1829
	git_diff_delta *delta;
	size_t i;

1830
	git_vector_foreach(&data->diff->deltas, i, delta) {
1831 1832 1833 1834 1835 1836 1837 1838 1839
		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;
		}

1840
		if (actions[i] & CHECKOUT_ACTION__UPDATE_BLOB) {
1841
			error = checkout_blob(data, &delta->new_file);
1842
			if (error < 0)
1843 1844 1845
				return error;

			data->completed_steps++;
1846
			report_progress(data, delta->new_file.path);
1847 1848 1849 1850 1851 1852 1853 1854
		}
	}

	return 0;
}

static int checkout_create_submodules(
	unsigned int *actions,
1855
	checkout_data *data)
1856
{
1857
	int error = 0;
1858 1859 1860
	git_diff_delta *delta;
	size_t i;

1861
	git_vector_foreach(&data->diff->deltas, i, delta) {
1862 1863 1864 1865 1866 1867 1868 1869 1870
		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;
		}

1871
		if (actions[i] & CHECKOUT_ACTION__UPDATE_SUBMODULE) {
1872
			int error = checkout_submodule(data, &delta->new_file);
1873 1874 1875 1876
			if (error < 0)
				return error;

			data->completed_steps++;
1877
			report_progress(data, delta->new_file.path);
1878 1879 1880
		}
	}

1881
	return 0;
1882 1883
}

1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898
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;
}

1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 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

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

		giterr_set(GITERR_CHECKOUT, "Could not write '%s': working directory file exists", path);
		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;
	struct stat st;
	int error;

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

	git_buf_truncate(&data->path, data->workdir_len);
	if (git_buf_puts(&data->path, side->path) < 0)
		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";

		if (checkout_path_suffixed(&data->path, suffix) < 0)
			return -1;

		hint_path = side->path;
	}

	if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0 &&
1976
		(error = checkout_safe_for_update_only(data, git_buf_cstr(&data->path), side->mode)) <= 0)
1977 1978
		return error;

1979
	return checkout_write_content(data,
1980
		&side->id, git_buf_cstr(&data->path), hint_path, side->mode, &st);
1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026
}

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,
2027 2028
		path_suffixed = GIT_BUF_INIT, path_workdir = GIT_BUF_INIT,
		in_data = GIT_BUF_INIT, out_data = GIT_BUF_INIT;
2029 2030
	git_merge_file_options opts = GIT_MERGE_FILE_OPTIONS_INIT;
	git_merge_file_result result = {0};
2031
	git_filebuf output = GIT_FILEBUF_INIT;
2032
	git_filter_list *fl = NULL;
2033
	git_filter_options filter_opts = GIT_FILTER_OPTIONS_INIT;
2034 2035
	int error = 0;

2036
	if (data->opts.checkout_strategy & GIT_CHECKOUT_CONFLICT_STYLE_DIFF3)
2037
		opts.flags |= GIT_MERGE_FILE_STYLE_DIFF3;
2038

2039 2040 2041 2042 2043 2044
	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";
2045 2046 2047 2048 2049 2050 2051 2052

	/* 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(
2053
			&our_label, opts.our_label, conflict->ours->path)) < 0 ||
2054
			(error = conflict_entry_name(
2055
			&their_label, opts.their_label, conflict->theirs->path)) < 0)
2056 2057
			goto done;

2058 2059
		opts.our_label = git_buf_cstr(&our_label);
		opts.their_label = git_buf_cstr(&their_label);
2060 2061
	}

2062 2063
	if ((error = git_merge_file_from_index(&result, data->repo,
		conflict->ancestor, conflict->ours, conflict->theirs, &opts)) < 0)
2064 2065 2066 2067
		goto done;

	if (result.path == NULL || result.mode == 0) {
		giterr_set(GITERR_CHECKOUT, "Could not merge contents of file");
2068
		error = GIT_ECONFLICT;
2069 2070 2071 2072 2073 2074 2075
		goto done;
	}

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

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

2079
	if (!data->opts.disable_filters) {
2080 2081 2082
		in_data.ptr = (char *)result.ptr;
		in_data.size = result.len;

2083
		filter_opts.attr_session = &data->attr_session;
2084
		filter_opts.temp_buf = &data->tmp;
2085 2086 2087 2088

		if ((error = git_filter_list__load_ext(
				&fl, data->repo, NULL, git_buf_cstr(&path_workdir),
				GIT_FILTER_TO_WORKTREE, &filter_opts)) < 0 ||
2089 2090
			(error = git_filter_list_apply_to_data(&out_data, fl, &in_data)) < 0)
			goto done;
2091 2092 2093 2094
	} else {
		out_data.ptr = (char *)result.ptr;
		out_data.size = result.len;
	}
2095

2096
	if ((error = mkpath2file(data, path_workdir.ptr, data->opts.dir_mode)) < 0 ||
2097 2098
		(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 ||
2099
		(error = git_filebuf_commit(&output)) < 0)
2100 2101 2102
		goto done;

done:
2103 2104 2105
	git_filter_list_free(fl);

	git_buf_free(&out_data);
2106 2107 2108 2109 2110 2111 2112 2113 2114 2115
	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;
}

2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129
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);
}

2130 2131 2132 2133 2134 2135 2136
static int checkout_conflict_update_index(
	checkout_data *data,
	checkout_conflictdata *conflict)
{
	int error = 0;

	if (conflict->ancestor)
2137
		error = checkout_conflict_add(data, conflict->ancestor);
2138 2139

	if (!error && conflict->ours)
2140
		error = checkout_conflict_add(data, conflict->ours);
2141 2142

	if (!error && conflict->theirs)
2143
		error = checkout_conflict_add(data, conflict->theirs);
2144 2145 2146 2147

	return error;
}

2148 2149 2150 2151 2152 2153
static int checkout_create_conflicts(checkout_data *data)
{
	checkout_conflictdata *conflict;
	size_t i;
	int error = 0;

2154
	git_vector_foreach(&data->update_conflicts, i, conflict) {
2155

2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198
		/* 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
2199 2200 2201 2202
		/* If any side is a gitlink, do nothing. */
		else if (conflict->submodule)
			error = 0;

2203 2204 2205 2206 2207
		/* If any side is binary, write the ours side */
		else if (conflict->binary)
			error = checkout_write_entry(data, conflict, conflict->ours);

		else if (!error)
2208 2209
			error = checkout_write_merge(data, conflict);

2210 2211 2212 2213 2214 2215
		/* 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);

2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227
		if (error)
			break;

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

	return error;
}

2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242
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;
}

2243 2244 2245 2246 2247 2248 2249 2250 2251 2252
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;

2253 2254
	if (data->update_reuc) {
		git_vector_foreach(data->update_reuc, i, reuc_entry) {
2255 2256 2257 2258 2259 2260 2261 2262
			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;
		}
	}

2263 2264
	if (data->update_names) {
		git_vector_foreach(data->update_names, i, name_entry) {
2265 2266 2267 2268 2269 2270 2271 2272 2273
			if ((error = git_index_name_add(data->index, name_entry->ancestor,
				name_entry->ours, name_entry->theirs)) < 0)
				goto done;
		}
	}

done:
	return error;
}
2274

2275 2276 2277 2278 2279 2280 2281 2282 2283 2284
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);

2285 2286
	git_vector_free_deep(&data->remove_conflicts);
	git_vector_free_deep(&data->update_conflicts);
2287

2288 2289 2290
	git__free(data->pfx);
	data->pfx = NULL;

2291 2292
	git_strmap_free(data->mkdir_map);

2293
	git_buf_free(&data->path);
2294
	git_buf_free(&data->tmp);
2295 2296 2297

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

2299 2300
	git_strmap_free(data->mkdir_map);

2301
	git_attr_session__free(&data->attr_session);
2302 2303 2304 2305
}

static int checkout_data_init(
	checkout_data *data,
2306
	git_iterator *target,
2307
	const git_checkout_options *proposed)
2308
{
2309
	int error = 0;
2310
	git_repository *repo = git_iterator_owner(target);
2311

2312 2313 2314 2315
	memset(data, 0, sizeof(*data));

	if (!repo) {
		giterr_set(GITERR_CHECKOUT, "Cannot checkout nothing");
2316
		return -1;
2317
	}
2318

2319 2320
	if ((!proposed || !proposed->target_directory) &&
		(error = git_repository__ensure_not_bare(repo, "checkout")) < 0)
2321
		return error;
2322

2323
	data->repo = repo;
2324
	data->target = target;
2325 2326

	GITERR_CHECK_VERSION(
2327
		proposed, GIT_CHECKOUT_OPTIONS_VERSION, "git_checkout_options");
2328 2329

	if (!proposed)
2330
		GIT_INIT_STRUCTURE(&data->opts, GIT_CHECKOUT_OPTIONS_VERSION);
2331
	else
2332
		memmove(&data->opts, proposed, sizeof(git_checkout_options));
2333

2334 2335 2336
	if (!data->opts.target_directory)
		data->opts.target_directory = git_repository_workdir(repo);
	else if (!git_path_isdir(data->opts.target_directory) &&
2337 2338 2339
			 (error = checkout_mkdir(data,
				data->opts.target_directory, NULL,
				GIT_DIR_MODE, GIT_MKDIR_VERIFY_DIR)) < 0)
2340 2341
		goto cleanup;

2342 2343
	/* refresh config and index content unless NO_REFRESH is given */
	if ((data->opts.checkout_strategy & GIT_CHECKOUT_NO_REFRESH) == 0) {
2344 2345
		git_config *cfg;

2346
		if ((error = git_repository_config__weakptr(&cfg, repo)) < 0)
2347 2348
			goto cleanup;

2349 2350 2351
		/* 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.)
2352
		 */
2353 2354 2355 2356 2357
		if ((error = git_repository_index(&data->index, data->repo)) < 0)
			goto cleanup;

		if (data->index != git_iterator_get_index(target)) {
			if ((error = git_index_read(data->index, true)) < 0)
2358
				goto cleanup;
2359

2360 2361 2362
			/* cannot checkout if unresolved conflicts exist */
			if ((data->opts.checkout_strategy & GIT_CHECKOUT_FORCE) == 0 &&
				git_index_has_conflicts(data->index)) {
2363
				error = GIT_ECONFLICT;
2364 2365 2366 2367 2368
				giterr_set(GITERR_CHECKOUT,
					"unresolved conflicts exist in the index");
				goto cleanup;
			}

2369
			/* clean conflict data in the current index */
2370
			git_index_name_clear(data->index);
Edward Thomson committed
2371
			git_index_reuc_clear(data->index);
2372 2373
		}
	}
2374

2375 2376 2377 2378 2379
	/* 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;

2380 2381 2382 2383 2384
	/* 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)
2385
		data->opts.checkout_strategy |= GIT_CHECKOUT_RECREATE_MISSING;
2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398

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

2399 2400 2401
	if ((error = git_repository__cvar(
			 &data->can_symlink, repo, GIT_CVAR_SYMLINKS)) < 0)
		goto cleanup;
2402

2403
	if (!data->opts.baseline && !data->opts.baseline_index) {
2404
		data->opts_free_baseline = true;
2405

2406 2407
		error = checkout_lookup_head_tree(&data->opts.baseline, repo);

2408
		if (error == GIT_EUNBORNBRANCH) {
2409 2410 2411 2412 2413
			error = 0;
			giterr_clear();
		}

		if (error < 0)
2414 2415 2416
			goto cleanup;
	}

2417 2418
	if ((data->opts.checkout_strategy &
		(GIT_CHECKOUT_CONFLICT_STYLE_MERGE | GIT_CHECKOUT_CONFLICT_STYLE_DIFF3)) == 0) {
2419
		git_config_entry *conflict_style = NULL;
2420 2421 2422
		git_config *cfg = NULL;

		if ((error = git_repository_config__weakptr(&cfg, repo)) < 0 ||
2423
			(error = git_config_get_entry(&conflict_style, cfg, "merge.conflictstyle")) < 0 ||
2424 2425 2426 2427
			error == GIT_ENOTFOUND)
			;
		else if (error)
			goto cleanup;
2428
		else if (strcmp(conflict_style->value, "merge") == 0)
2429
			data->opts.checkout_strategy |= GIT_CHECKOUT_CONFLICT_STYLE_MERGE;
2430
		else if (strcmp(conflict_style->value, "diff3") == 0)
2431 2432 2433 2434 2435
			data->opts.checkout_strategy |= GIT_CHECKOUT_CONFLICT_STYLE_DIFF3;
		else {
			giterr_set(GITERR_CHECKOUT, "unknown style '%s' given for 'merge.conflictstyle'",
				conflict_style);
			error = -1;
2436
			git_config_entry_free(conflict_style);
2437 2438
			goto cleanup;
		}
2439
		git_config_entry_free(conflict_style);
2440 2441
	}

2442
	if ((error = git_vector_init(&data->removes, 0, git__strcmp_cb)) < 0 ||
2443 2444
		(error = git_vector_init(&data->remove_conflicts, 0, NULL)) < 0 ||
		(error = git_vector_init(&data->update_conflicts, 0, NULL)) < 0 ||
2445
		(error = git_pool_init(&data->pool, 1, 0)) < 0 ||
2446
		(error = git_buf_puts(&data->path, data->opts.target_directory)) < 0 ||
2447 2448
		(error = git_path_to_dir(&data->path)) < 0 ||
		(error = git_strmap_alloc(&data->mkdir_map)) < 0)
2449 2450 2451 2452
		goto cleanup;

	data->workdir_len = git_buf_len(&data->path);

2453 2454
	git_attr_session__init(&data->attr_session, data->repo);

2455 2456 2457
cleanup:
	if (error < 0)
		checkout_data_clear(data);
2458 2459 2460 2461

	return error;
}

2462 2463 2464
#define CHECKOUT_INDEX_DONT_WRITE_MASK \
	(GIT_CHECKOUT_DONT_UPDATE_INDEX | GIT_CHECKOUT_DONT_WRITE_INDEX)

2465 2466
int git_checkout_iterator(
	git_iterator *target,
2467
	git_index *index,
2468
	const git_checkout_options *opts)
2469 2470
{
	int error = 0;
2471 2472
	git_iterator *baseline = NULL, *workdir = NULL;
	checkout_data data = {0};
2473
	git_diff_options diff_opts = GIT_DIFF_OPTIONS_INIT;
2474 2475
	uint32_t *actions = NULL;
	size_t *counts = NULL;
2476
	git_iterator_flag_t iterflags = 0;
2477

2478
	/* initialize structures and options */
2479
	error = checkout_data_init(&data, target, opts);
2480 2481
	if (error < 0)
		return error;
Ben Straub committed
2482

2483 2484
	diff_opts.flags =
		GIT_DIFF_INCLUDE_UNMODIFIED |
2485
		GIT_DIFF_INCLUDE_UNREADABLE |
2486 2487 2488 2489 2490
		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 |
2491 2492
		GIT_DIFF_SKIP_BINARY_CHECK |
		GIT_DIFF_INCLUDE_CASECHANGE;
2493 2494
	if (data.opts.checkout_strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH)
		diff_opts.flags |= GIT_DIFF_DISABLE_PATHSPEC_MATCH;
2495 2496 2497 2498
	if (data.opts.paths.count > 0)
		diff_opts.pathspec = data.opts.paths;

	/* set up iterators */
2499 2500 2501 2502

	iterflags = git_iterator_ignore_case(target) ?
		GIT_ITERATOR_IGNORE_CASE : GIT_ITERATOR_DONT_IGNORE_CASE;

2503
	if ((error = git_iterator_reset(target, data.pfx, data.pfx)) < 0 ||
2504
		(error = git_iterator_for_workdir_ext(
2505
			&workdir, data.repo, data.opts.target_directory, index, NULL,
2506
			iterflags | GIT_ITERATOR_DONT_AUTOEXPAND,
2507
			data.pfx, data.pfx)) < 0)
2508 2509
		goto cleanup;

2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521
	if (data.opts.baseline_index) {
		if ((error = git_iterator_for_index(
				&baseline, data.opts.baseline_index,
				iterflags, data.pfx, data.pfx)) < 0)
			goto cleanup;
	} else {
		if ((error = git_iterator_for_tree(
				&baseline, data.opts.baseline,
				iterflags, data.pfx, data.pfx)) < 0)
			goto cleanup;
	}

2522 2523
	/* Should not have case insensitivity mismatch */
	assert(git_iterator_ignore_case(workdir) == git_iterator_ignore_case(baseline));
2524

2525 2526
	/* Generate baseline-to-target diff which will include an entry for
	 * every possible update that might need to be made.
2527 2528
	 */
	if ((error = git_diff__from_iterators(
2529
			&data.diff, data.repo, baseline, target, &diff_opts)) < 0)
2530 2531
		goto cleanup;

2532
	/* Loop through diff (and working directory iterator) building a list of
2533 2534
	 * actions to be taken, plus look for conflicts and send notifications,
	 * then loop through conflicts.
2535
	 */
2536
	if ((error = checkout_get_actions(&actions, &counts, &data, workdir)) != 0)
2537 2538
		goto cleanup;

2539
	data.total_steps = counts[CHECKOUT_ACTION__REMOVE] +
2540
		counts[CHECKOUT_ACTION__REMOVE_CONFLICT] +
2541
		counts[CHECKOUT_ACTION__UPDATE_BLOB] +
2542 2543
		counts[CHECKOUT_ACTION__UPDATE_SUBMODULE] +
		counts[CHECKOUT_ACTION__UPDATE_CONFLICT];
2544

2545
	report_progress(&data, NULL); /* establish 0 baseline */
2546

2547 2548 2549
	/* To deal with some order dependencies, perform remaining checkout
	 * in three passes: removes, then update blobs, then update submodules.
	 */
2550
	if (counts[CHECKOUT_ACTION__REMOVE] > 0 &&
2551
		(error = checkout_remove_the_old(actions, &data)) < 0)
2552 2553
		goto cleanup;

2554 2555 2556 2557
	if (counts[CHECKOUT_ACTION__REMOVE_CONFLICT] > 0 &&
		(error = checkout_remove_conflicts(&data)) < 0)
		goto cleanup;

2558
	if (counts[CHECKOUT_ACTION__UPDATE_BLOB] > 0 &&
2559
		(error = checkout_create_the_new(actions, &data)) < 0)
2560 2561
		goto cleanup;

2562
	if (counts[CHECKOUT_ACTION__UPDATE_SUBMODULE] > 0 &&
2563
		(error = checkout_create_submodules(actions, &data)) < 0)
2564 2565
		goto cleanup;

2566
	if (counts[CHECKOUT_ACTION__UPDATE_CONFLICT] > 0 &&
2567
		(error = checkout_create_conflicts(&data)) < 0)
2568
		goto cleanup;
2569

2570 2571 2572 2573
	if (data.index != git_iterator_get_index(target) &&
		(error = checkout_extensions_update_index(&data)) < 0)
		goto cleanup;

2574
	assert(data.completed_steps == data.total_steps);
2575

2576 2577 2578
	if (data.opts.perfdata_cb)
		data.opts.perfdata_cb(&data.perfdata, data.opts.perfdata_payload);

2579
cleanup:
2580
	if (!error && data.index != NULL &&
2581
		(data.strategy & CHECKOUT_INDEX_DONT_WRITE_MASK) == 0)
2582 2583
		error = git_index_write(data.index);

2584
	git_diff_free(data.diff);
2585
	git_iterator_free(workdir);
2586
	git_iterator_free(baseline);
2587 2588
	git__free(actions);
	git__free(counts);
2589
	checkout_data_clear(&data);
2590 2591 2592 2593 2594 2595 2596

	return error;
}

int git_checkout_index(
	git_repository *repo,
	git_index *index,
2597
	const git_checkout_options *opts)
2598
{
2599
	int error, owned = 0;
2600
	git_iterator *index_i;
2601

2602 2603 2604 2605 2606
	if (!index && !repo) {
		giterr_set(GITERR_CHECKOUT,
			"Must provide either repository or index to checkout");
		return -1;
	}
2607 2608 2609 2610

	if (index && repo &&
		git_index_owner(index) &&
		git_index_owner(index) != repo) {
2611 2612 2613
		giterr_set(GITERR_CHECKOUT,
			"Index to checkout does not match repository");
		return -1;
2614 2615 2616
	} else if(index && repo && !git_index_owner(index)) {
		GIT_REFCOUNT_OWN(index, repo);
		owned = 1;
2617 2618 2619 2620
	}

	if (!repo)
		repo = git_index_owner(index);
2621 2622 2623

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

2626
	if (!(error = git_iterator_for_index(&index_i, index, 0, NULL, NULL)))
2627
		error = git_checkout_iterator(index_i, index, opts);
2628

2629 2630 2631
	if (owned)
		GIT_REFCOUNT_OWN(index, NULL);

2632
	git_iterator_free(index_i);
2633
	git_index_free(index);
2634

2635 2636 2637 2638 2639
	return error;
}

int git_checkout_tree(
	git_repository *repo,
Vicent Marti committed
2640
	const git_object *treeish,
2641
	const git_checkout_options *opts)
2642
{
2643
	int error;
2644
	git_index *index;
2645 2646
	git_tree *tree = NULL;
	git_iterator *tree_i = NULL;
2647

2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660
	if (!treeish && !repo) {
		giterr_set(GITERR_CHECKOUT,
			"Must provide either repository or tree to checkout");
		return -1;
	}
	if (treeish && repo && git_object_owner(treeish) != repo) {
		giterr_set(GITERR_CHECKOUT,
			"Object to checkout does not match repository");
		return -1;
	}

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

2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676
	if (treeish) {
		if (git_object_peel((git_object **)&tree, treeish, GIT_OBJ_TREE) < 0) {
			giterr_set(
				GITERR_CHECKOUT, "Provided object cannot be peeled to a tree");
			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;
		}
2677 2678
	}

2679 2680 2681
	if ((error = git_repository_index(&index, repo)) < 0)
		return error;

2682
	if (!(error = git_iterator_for_tree(&tree_i, tree, 0, NULL, NULL)))
2683
		error = git_checkout_iterator(tree_i, index, opts);
2684

2685
	git_iterator_free(tree_i);
2686
	git_index_free(index);
2687
	git_tree_free(tree);
2688

2689
	return error;
2690 2691
}

2692 2693
int git_checkout_head(
	git_repository *repo,
2694
	const git_checkout_options *opts)
2695
{
2696
	assert(repo);
2697
	return git_checkout_tree(repo, NULL, opts);
2698
}
2699

2700
int git_checkout_init_options(git_checkout_options *opts, unsigned int version)
2701
{
2702 2703 2704
	GIT_INIT_STRUCTURE_FROM_TEMPLATE(
		opts, version, git_checkout_options, GIT_CHECKOUT_OPTIONS_INIT);
	return 0;
2705
}