checkout.c 74.1 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 12
#include "git2/repository.h"
#include "git2/refs.h"
#include "git2/tree.h"
13
#include "git2/blob.h"
14
#include "git2/config.h"
15
#include "git2/diff.h"
16
#include "git2/submodule.h"
Vicent Marti committed
17
#include "git2/sys/index.h"
18
#include "git2/sys/filter.h"
19
#include "git2/merge.h"
20 21

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

36
/* See docs/checkout-internals.md for more information */
37

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

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

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

84 85 86 87 88
	unsigned int name_collision:1,
	             directoryfile:1,
	             one_to_two:1,
	             binary:1,
	             submodule:1;
89 90
} checkout_conflictdata;

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

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

105 106
	if (wditem) {
		memset(&wdfile, 0, sizeof(wdfile));
107

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

114
		workdir = &wdfile;
115 116

		path = wditem->path;
117 118
	}

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

		path = delta->old_file.path;
140 141
	}

142 143 144 145
	{
		int error = data->opts.notify_cb(
			why, path, baseline, target, workdir, data->opts.notify_payload);

146
		return git_error_set_after_callback_function(
147 148
			error, "git_checkout notification");
	}
149 150
}

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

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

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

	return (a != b);
174 175
}

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

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

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

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

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

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

	if (ie != NULL &&
219 220 221 222
	    !git_index_entry_newer_than_index(ie, data->index) &&
	    git_index_time_eq(&wditem->mtime, &ie->mtime) &&
	    wditem->file_size == ie->file_size &&
	    !is_filemode_changed(wditem->mode, ie->mode, data->respect_filemode)) {
223 224 225

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

229 230 231 232
	/* 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)
233 234
		return true;

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

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

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

245 246 247 248
	/* 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);
249 250 251 252 253 254
}

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

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

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

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

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

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

279 280 281
		notify = GIT_CHECKOUT_NOTIFY_UPDATED;
	}

282
	if ((*action & CHECKOUT_ACTION__CONFLICT) != 0)
283 284
		notify = GIT_CHECKOUT_NOTIFY_CONFLICT;

285
	return checkout_notify(data, notify, delta, wd);
286 287 288
}

static int checkout_action_no_wd(
289
	int *action,
290 291
	checkout_data *data,
	const git_diff_delta *delta)
292
{
293 294 295
	int error = 0;

	*action = CHECKOUT_ACTION__NONE;
296

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

321
	return checkout_action_common(action, data, delta, NULL);
322 323
}

324
static int checkout_target_fullpath(
325
	git_str **out, checkout_data *data, const char *path)
326
{
327
	git_str_truncate(&data->target_path, data->target_len);
328

329
	if (path && git_str_puts(&data->target_path, path) < 0)
330 331
		return -1;

332
	if (git_path_validate_str_length(data->repo, &data->target_path) < 0)
333 334
		return -1;

335 336 337 338 339 340 341 342
	*out = &data->target_path;

	return 0;
}

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

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

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

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

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

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

373
	if (!git_pathspec__match(
374 375
			pathspec, wd->path,
			(data->strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH) != 0,
376 377 378 379 380 381 382
			git_iterator_ignore_case(workdir), NULL, NULL)) {

		if (wd->mode == GIT_FILEMODE_TREE)
			return git_iterator_advance_into(wditem, workdir);
		else
			return git_iterator_advance(wditem, workdir);
	}
383

384
	/* check if item is tracked in the index but not in the checkout diff */
385
	if (data->index != NULL) {
386 387
		size_t pos;

388
		error = git_index__find_pos(
389 390
			&pos, data->index, wd->path, 0, GIT_INDEX_STAGE_ANY);

391
		if (wd->mode != GIT_FILEMODE_TREE) {
392
			if (!error) { /* found by git_index__find_pos call */
393 394
				notify = GIT_CHECKOUT_NOTIFY_DIRTY;
				remove = ((data->strategy & GIT_CHECKOUT_FORCE) != 0);
395 396
			} else if (error != GIT_ENOTFOUND)
				return error;
397
			else
398
				error = 0; /* git_index__find_pos does not set error msg */
399 400 401 402 403 404
		} 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);

405 406
			if (e != NULL && data->diff->pfxcomp(e->path, wd->path) == 0)
				return git_iterator_advance_into(wditem, workdir);
407
		}
408
	}
409

410 411 412 413 414
	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;

415
		if (remove && wd_item_is_removable(data, wd))
416 417 418 419 420 421
			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 */
422
		bool over = false, removable = wd_item_is_removable(data, wd);
423
		git_iterator_status_t untracked_state;
424 425 426

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

430
		error = git_iterator_advance_over(
431
			wditem, &untracked_state, workdir);
432 433 434 435
		if (error == GIT_ITEROVER)
			over = true;
		else if (error < 0)
			return error;
436

437
		if (untracked_state == GIT_ITERATOR_STATUS_IGNORED) {
438 439 440 441 442 443
			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);
		}
444

445 446 447 448 449 450 451 452
		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;
453 454
	}

455
	return error;
456 457
}

458 459 460 461 462 463
static bool submodule_is_config_only(
	checkout_data *data,
	const char *path)
{
	git_submodule *sm = NULL;
	unsigned int sm_loc = 0;
464
	bool rval = false;
465

466
	if (git_submodule_lookup(&sm, data->repo, path) < 0)
467 468
		return true;

469 470 471 472 473 474
	if (git_submodule_location(&sm_loc, sm) < 0 ||
		sm_loc == GIT_SUBMODULE_STATUS_IN_CONFIG)
		rval = true;

	git_submodule_free(sm);

475
	return rval;
476 477
}

478 479
static bool checkout_is_empty_dir(checkout_data *data, const char *path)
{
480
	git_str *fullpath;
481 482

	if (checkout_target_fullpath(&fullpath, data, path) < 0)
483
		return false;
484

485
	return git_fs_path_is_empty_dir(fullpath->ptr);
486 487
}

488
static int checkout_action_with_wd(
489
	int *action,
490 491
	checkout_data *data,
	const git_diff_delta *delta,
492
	git_iterator *workdir,
493 494
	const git_index_entry *wd)
{
495
	*action = CHECKOUT_ACTION__NONE;
496 497 498

	switch (delta->status) {
	case GIT_DELTA_UNMODIFIED: /* case 14/15 or 33 */
499
		if (checkout_is_workdir_modified(data, &delta->old_file, &delta->new_file, wd)) {
500
			GIT_ERROR_CHECK_ERROR(
501 502
				checkout_notify(data, GIT_CHECKOUT_NOTIFY_DIRTY, delta, wd) );
			*action = CHECKOUT_ACTION_IF(FORCE, UPDATE_BLOB, NONE);
503
		}
504 505
		break;
	case GIT_DELTA_ADDED: /* case 3, 4 or 6 */
506 507 508 509
		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);
510 511
		break;
	case GIT_DELTA_DELETED: /* case 9 or 10 (or 26 but not really) */
512
		if (checkout_is_workdir_modified(data, &delta->old_file, &delta->new_file, wd))
513
			*action = CHECKOUT_ACTION_IF(FORCE, REMOVE, CONFLICT);
514
		else
515
			*action = CHECKOUT_ACTION_IF(SAFE, REMOVE, NONE);
516 517
		break;
	case GIT_DELTA_MODIFIED: /* case 16, 17, 18 (or 36 but not really) */
518 519
		if (wd->mode != GIT_FILEMODE_COMMIT &&
			checkout_is_workdir_modified(data, &delta->old_file, &delta->new_file, wd))
520
			*action = CHECKOUT_ACTION_IF(FORCE, UPDATE_BLOB, CONFLICT);
521
		else
522
			*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
523 524
		break;
	case GIT_DELTA_TYPECHANGE: /* case 22, 23, 29, 30 */
525 526 527 528 529
		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...
				 */
530
				*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
531 532 533 534 535
			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))
536
					*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
537
				else
538
					*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
539
			} else
540
				*action = CHECKOUT_ACTION_IF(FORCE, REMOVE, CONFLICT);
541
		}
542
		else if (checkout_is_workdir_modified(data, &delta->old_file, &delta->new_file, wd))
543
			*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
544
		else
545
			*action = CHECKOUT_ACTION_IF(SAFE, REMOVE_AND_UPDATE, NONE);
546 547 548

		/* don't update if the typechange is to a tree */
		if (delta->new_file.mode == GIT_FILEMODE_TREE)
549
			*action = (*action & ~CHECKOUT_ACTION__UPDATE_BLOB);
550 551 552
		break;
	default: /* impossible */
		break;
553 554
	}

555
	return checkout_action_common(action, data, delta, wd);
556
}
557

558
static int checkout_action_with_wd_blocker(
559
	int *action,
560 561 562 563
	checkout_data *data,
	const git_diff_delta *delta,
	const git_index_entry *wd)
{
564
	*action = CHECKOUT_ACTION__NONE;
565

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

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

static int checkout_action_with_wd_dir(
592
	int *action,
593 594
	checkout_data *data,
	const git_diff_delta *delta,
595
	git_iterator *workdir,
596 597
	const git_index_entry *wd)
{
598
	*action = CHECKOUT_ACTION__NONE;
599 600 601

	switch (delta->status) {
	case GIT_DELTA_UNMODIFIED: /* case 19 or 24 (or 34 but not really) */
602
		GIT_ERROR_CHECK_ERROR(
603
			checkout_notify(data, GIT_CHECKOUT_NOTIFY_DIRTY, delta, NULL));
604
		GIT_ERROR_CHECK_ERROR(
605
			checkout_notify(data, GIT_CHECKOUT_NOTIFY_UNTRACKED, NULL, wd));
606
		*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, NONE);
607 608 609
		break;
	case GIT_DELTA_ADDED:/* case 4 (and 7 for dir) */
	case GIT_DELTA_MODIFIED: /* case 20 (or 37 but not really) */
610 611 612
		if (delta->old_file.mode == GIT_FILEMODE_COMMIT)
			/* expected submodule (and maybe found one) */;
		else if (delta->new_file.mode != GIT_FILEMODE_TREE)
613 614 615
			*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);
616 617
		break;
	case GIT_DELTA_DELETED: /* case 11 (and 27 for dir) */
618
		if (delta->old_file.mode != GIT_FILEMODE_TREE)
619
			GIT_ERROR_CHECK_ERROR(
620
				checkout_notify(data, GIT_CHECKOUT_NOTIFY_UNTRACKED, NULL, wd));
621 622 623
		break;
	case GIT_DELTA_TYPECHANGE: /* case 24 or 31 */
		if (delta->old_file.mode == GIT_FILEMODE_TREE) {
624 625 626 627 628 629
			/* 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.
			 */
630
			*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
631
		}
632 633
		else if (delta->new_file.mode != GIT_FILEMODE_TREE)
			/* For typechange to dir, dir is already created so no action */
634
			*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
635 636 637
		break;
	default: /* impossible */
		break;
638 639
	}

640
	return checkout_action_common(action, data, delta, wd);
641 642
}

643 644 645 646 647 648 649 650 651 652 653 654 655 656
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;
}

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

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

	while (1) {
673 674
		const git_index_entry *wd = *wditem;

675
		if (!wd)
676
			return checkout_action_no_wd(action, data, delta);
677

678 679 680 681 682 683 684 685 686 687 688 689 690
		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);

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

				/* case 3 maybe - wd contains non-dir where dir expected */
				if (delta->old_file.path[strlen(wd->path)] == '/') {
702 703 704 705
					error = checkout_action_with_wd_blocker(
						action, data, delta, wd);
					advance = git_iterator_advance;
					goto done;
706
				}
707
			}
708

709
			/* case 1 - handle wd item (if it matches pathspec) */
710 711
			error = checkout_action_wd_only(data, workdir, wditem, pathspec);
			if (error && error != GIT_ITEROVER)
712
				goto done;
713 714
			continue;
		}
715

716 717
		if (cmp == 0) {
			/* case 4 */
718
			error = checkout_action_with_wd(action, data, delta, workdir, wd);
719 720
			advance = git_iterator_advance;
			goto done;
721
		}
722

723
		cmp = pfxcomp(wd->path, delta->old_file.path);
724

725
		if (cmp == 0) { /* case 5 */
726
			if (wd->path[strlen(delta->old_file.path)] != '/')
727
				return checkout_action_no_wd(action, data, delta);
728 729 730

			if (delta->status == GIT_DELTA_TYPECHANGE) {
				if (delta->old_file.mode == GIT_FILEMODE_TREE) {
731
					error = checkout_action_with_wd(action, data, delta, workdir, wd);
732 733
					advance = git_iterator_advance_into;
					goto done;
734 735 736 737 738 739
				}

				if (delta->new_file.mode == GIT_FILEMODE_TREE ||
					delta->new_file.mode == GIT_FILEMODE_COMMIT ||
					delta->old_file.mode == GIT_FILEMODE_COMMIT)
				{
740
					error = checkout_action_with_wd(action, data, delta, workdir, wd);
741 742
					advance = git_iterator_advance;
					goto done;
743
				}
744 745
			}

746 747 748
			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);
749
		}
750

751
		/* case 6 - wd is after delta */
752
		return checkout_action_no_wd(action, data, delta);
753 754
	}

755 756 757 758 759 760 761 762 763
done:
	if (!error && advance != NULL &&
		(error = advance(wditem, workdir)) < 0) {
		*wditem = NULL;
		if (error == GIT_ITEROVER)
			error = 0;
	}

	return error;
764 765
}

766 767 768 769 770 771 772 773
static int checkout_remaining_wd_items(
	checkout_data *data,
	git_iterator *workdir,
	const git_index_entry *wd,
	git_vector *spec)
{
	int error = 0;

774 775
	while (wd && !error)
		error = checkout_action_wd_only(data, workdir, &wd, spec);
776

777 778 779
	if (error == GIT_ITEROVER)
		error = 0;

780 781 782
	return error;
}

783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803
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 &&
804
	    (diff = checkout_idxentry_cmp(ca->ours, cb->theirs)) == 0)
805 806 807 808 809
		diff = checkout_idxentry_cmp(ca->theirs, cb->theirs);

	return diff;
}

810
static int checkout_conflictdata_empty(
811
	const git_vector *conflicts, size_t idx, void *payload)
812 813 814
{
	checkout_conflictdata *conflict;

815 816
	GIT_UNUSED(payload);

817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
	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
854 855 856 857 858 859 860 861
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;
}

862 863 864 865 866
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
867 868 869
	if (conflict->submodule)
		return 0;

870
	if (conflict->ancestor) {
871
		if ((error = git_blob_lookup(&ancestor_blob, repo, &conflict->ancestor->id)) < 0)
872 873 874 875 876 877
			goto done;

		conflict->binary = git_blob_is_binary(ancestor_blob);
	}

	if (!conflict->binary && conflict->ours) {
878
		if ((error = git_blob_lookup(&our_blob, repo, &conflict->ours->id)) < 0)
879 880 881 882 883 884
			goto done;

		conflict->binary = git_blob_is_binary(our_blob);
	}

	if (!conflict->binary && conflict->theirs) {
885
		if ((error = git_blob_lookup(&their_blob, repo, &conflict->theirs->id)) < 0)
886 887 888 889 890 891 892 893 894 895 896 897 898
			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;
}

899 900 901 902 903 904 905 906 907 908 909
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));
910
	GIT_ERROR_CHECK_ALLOC(conflict);
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935

	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)
936 937 938 939 940
{
	git_index_conflict_iterator *iterator = NULL;
	const git_index_entry *ancestor, *ours, *theirs;
	int error = 0;

941
	if ((error = git_index_conflict_iterator_new(&iterator, index)) < 0)
942 943 944 945 946 947 948
		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;

949
		if ((error = cb(ancestor, ours, theirs, payload)) < 0)
950
			goto done;
951 952 953 954 955 956 957 958 959 960 961
	}

	if (error == GIT_ITEROVER)
		error = 0;

done:
	git_index_conflict_iterator_free(iterator);

	return error;
}

962 963 964 965
static int checkout_conflicts_load(checkout_data *data, git_iterator *workdir, git_vector *pathspec)
{
	git_index *index;

Dimitris Apostolou committed
966
	/* Only write conflicts from sources that have them: indexes. */
967
	if ((index = git_iterator_index(data->target)) == NULL)
968 969 970 971 972 973 974 975 976 977 978 979 980 981
		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;
}

982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
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;

1006
	if (git_vector_bsearch2(&pos, &data->update_conflicts, checkout_conflicts_cmp_ancestor, path) < 0)
1007 1008
		return NULL;

1009
	return git_vector_get(&data->update_conflicts, pos);
1010 1011 1012 1013 1014 1015 1016 1017 1018
}

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

1019
	git_vector_foreach(&data->update_conflicts, i, conflict) {
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
		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) {
1052
		git_error_set(GIT_ERROR_INDEX, "a NAME entry exists without an ancestor");
1053 1054 1055 1056 1057
		error = -1;
		goto done;
	}

	if (!name_entry->ours && !name_entry->theirs) {
1058
		git_error_set(GIT_ERROR_INDEX, "a NAME entry exists without an ours or theirs");
1059 1060 1061 1062 1063 1064
		error = -1;
		goto done;
	}

	if ((ancestor = checkout_conflicts_search_ancestor(data,
		name_entry->ancestor)) == NULL) {
1065
		git_error_set(GIT_ERROR_INDEX,
1066
			"a NAME entry referenced ancestor entry '%s' which does not exist in the main index",
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
			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) {
1077
			git_error_set(GIT_ERROR_INDEX,
1078
				"a NAME entry referenced our entry '%s' which does not exist in the main index",
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
				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) {
1092
			git_error_set(GIT_ERROR_INDEX,
1093
				"a NAME entry referenced their entry '%s' which does not exist in the main index",
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
				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)
{
1111
	git_index *index;
1112 1113 1114 1115 1116
	const git_index_name_entry *name_entry;
	checkout_conflictdata *ancestor_conflict, *our_conflict, *their_conflict;
	size_t i, names;
	int error = 0;

1117
	if ((index = git_iterator_index(data->target)) == NULL)
1118 1119
		return 0;

1120
	/* Juggle entries based on renames */
1121
	names = git_index_name_entrycount(index);
Russell Belfer committed
1122

1123
	for (i = 0; i < names; i++) {
1124
		name_entry = git_index_name_get_byindex(index, i);
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157

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

1158
	git_vector_remove_matching(
1159
		&data->update_conflicts, checkout_conflictdata_empty, NULL);
1160 1161 1162 1163 1164 1165 1166 1167

done:
	return error;
}

static int checkout_conflicts_mark_directoryfile(
	checkout_data *data)
{
1168
	git_index *index;
1169 1170 1171 1172
	checkout_conflictdata *conflict;
	const git_index_entry *entry;
	size_t i, j, len;
	const char *path;
1173
	int prefixed, error = 0;
1174

1175
	if ((index = git_iterator_index(data->target)) == NULL)
1176 1177 1178
		return 0;

	len = git_index_entrycount(index);
1179 1180

	/* Find d/f conflicts */
1181
	git_vector_foreach(&data->update_conflicts, i, conflict) {
1182
		if ((conflict->ours && conflict->theirs) ||
1183
		    (!conflict->ours && !conflict->theirs))
1184 1185 1186 1187 1188
			continue;

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

1189
		if ((error = git_index_find(&j, index, path)) < 0) {
1190
			if (error == GIT_ENOTFOUND)
1191
				git_error_set(GIT_ERROR_INDEX,
1192
					"index inconsistency, could not find entry for expected conflict '%s'", path);
1193 1194 1195 1196 1197

			goto done;
		}

		for (; j < len; j++) {
1198
			if ((entry = git_index_get_byindex(index, j)) == NULL) {
1199
				git_error_set(GIT_ERROR_INDEX,
1200
					"index inconsistency, truncated index while loading expected conflict '%s'", path);
1201 1202 1203 1204
				error = -1;
				goto done;
			}

1205
			prefixed = git_fs_path_equal_or_prefixed(path, entry->path, NULL);
1206

1207
			if (prefixed == GIT_FS_PATH_EQUAL)
1208 1209
				continue;

1210
			if (prefixed == GIT_FS_PATH_PREFIX)
1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
				conflict->directoryfile = 1;

			break;
		}
	}

done:
	return error;
}

1221
static int checkout_get_update_conflicts(
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231
	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 ||
1232 1233
	    (error = checkout_conflicts_coalesce_renames(data)) < 0 ||
	    (error = checkout_conflicts_mark_directoryfile(data)) < 0)
1234 1235 1236 1237 1238 1239
		goto done;

done:
	return error;
}

1240 1241 1242 1243 1244 1245 1246 1247 1248
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;

1249
	GIT_ASSERT_ARG(ancestor || ours || theirs);
1250

1251 1252 1253 1254 1255 1256
	if (ancestor)
		name = git__strdup(ancestor->path);
	else if (ours)
		name = git__strdup(ours->path);
	else if (theirs)
		name = git__strdup(theirs->path);
1257 1258
	else
		abort();
1259

1260
	GIT_ERROR_CHECK_ALLOC(name);
1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275

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

1276 1277 1278 1279 1280
static int checkout_verify_paths(
	git_repository *repo,
	int action,
	git_diff_delta *delta)
{
1281
	unsigned int flags = GIT_PATH_REJECT_WORKDIR_DEFAULTS;
1282 1283

	if (action & CHECKOUT_ACTION__REMOVE) {
1284
		if (!git_path_is_valid(repo, delta->old_file.path, delta->old_file.mode, flags)) {
1285
			git_error_set(GIT_ERROR_CHECKOUT, "cannot remove invalid path '%s'", delta->old_file.path);
1286 1287 1288 1289 1290
			return -1;
		}
	}

	if (action & ~CHECKOUT_ACTION__REMOVE) {
1291
		if (!git_path_is_valid(repo, delta->new_file.path, delta->new_file.mode, flags)) {
1292
			git_error_set(GIT_ERROR_CHECKOUT, "cannot checkout to invalid path '%s'", delta->new_file.path);
1293 1294 1295 1296 1297 1298 1299
			return -1;
		}
	}

	return 0;
}

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

1314 1315
	if (git_pool_init(&pathpool, 1) < 0)
		return -1;
1316

1317
	if (data->opts.paths.count > 0 &&
1318
	    git_pathspec__vinit(&pathspec, &data->opts.paths, &pathpool) < 0)
1319 1320
		return -1;

1321
	if ((error = git_iterator_current(&wditem, workdir)) < 0 &&
1322
	    error != GIT_ITEROVER)
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335
		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) {
1336 1337 1338
		if ((error = checkout_action(&act, data, delta, workdir, &wditem, &pathspec)) == 0)
			error = checkout_verify_paths(data->repo, act, delta);

1339
		if (error != 0)
1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352
			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]++;
	}
1353

1354
	error = checkout_remaining_wd_items(data, workdir, wditem, &pathspec);
1355
	if (error)
1356
		goto fail;
1357

1358 1359 1360
	counts[CHECKOUT_ACTION__REMOVE] += data->removes.length;

	if (counts[CHECKOUT_ACTION__CONFLICT] > 0 &&
1361
	    (data->strategy & GIT_CHECKOUT_ALLOW_CONFLICTS) == 0) {
1362
		git_error_set(GIT_ERROR_CHECKOUT, "%"PRIuZ" %s checkout",
1363
			counts[CHECKOUT_ACTION__CONFLICT],
1364 1365
			counts[CHECKOUT_ACTION__CONFLICT] == 1 ?
			"conflict prevents" : "conflicts prevent");
1366
		error = GIT_ECONFLICT;
1367 1368 1369
		goto fail;
	}

1370

1371
	if ((error = checkout_get_remove_conflicts(data, workdir, &pathspec)) < 0 ||
1372
	    (error = checkout_get_update_conflicts(data, workdir, &pathspec)) < 0)
1373 1374
		goto fail;

1375 1376
	counts[CHECKOUT_ACTION__REMOVE_CONFLICT] = git_vector_length(&data->remove_conflicts);
	counts[CHECKOUT_ACTION__UPDATE_CONFLICT] = git_vector_length(&data->update_conflicts);
1377

1378
	git_pathspec__vfree(&pathspec);
1379 1380 1381 1382 1383 1384 1385 1386 1387 1388
	git_pool_clear(&pathpool);

	return 0;

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

1389
	git_pathspec__vfree(&pathspec);
1390 1391 1392 1393 1394
	git_pool_clear(&pathpool);

	return error;
}

1395 1396
static bool should_remove_existing(checkout_data *data)
{
1397
	int ignorecase;
1398

1399
	if (git_repository__configmap_lookup(&ignorecase, data->repo, GIT_CONFIGMAP_IGNORECASE) < 0) {
1400 1401
		ignorecase = 0;
	}
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411

	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

1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424
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;

1425
	error = git_futils_mkdir_relative(
1426 1427 1428 1429 1430 1431 1432 1433 1434
		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;
}

1435 1436 1437
static int mkpath2file(
	checkout_data *data, const char *path, unsigned int mode)
{
1438 1439
	struct stat st;
	bool remove_existing = should_remove_existing(data);
1440 1441 1442
	unsigned int flags =
		(remove_existing ? MKDIR_REMOVE_EXISTING : MKDIR_NORMAL) |
		GIT_MKDIR_SKIP_LAST;
1443 1444
	int error;

1445 1446
	if ((error = checkout_mkdir(
			data, path, data->opts.target_directory, mode, flags)) < 0)
1447 1448
		return error;

1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460
	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) {
1461
			git_error_set(GIT_ERROR_OS, "failed to stat '%s'", path);
1462 1463
			return GIT_EEXISTS;
		} else {
1464
			git_error_clear();
1465 1466
		}
	}
1467 1468

	return error;
1469 1470
}

1471
struct checkout_stream {
1472
	git_writestream base;
1473 1474 1475 1476
	const char *path;
	int fd;
	int open;
};
1477

1478
static int checkout_stream_write(
1479
	git_writestream *s, const char *buffer, size_t len)
1480 1481 1482
{
	struct checkout_stream *stream = (struct checkout_stream *)s;
	int ret;
1483

1484
	if ((ret = p_write(stream->fd, buffer, len)) < 0)
1485
		git_error_set(GIT_ERROR_OS, "could not write to '%s'", stream->path);
1486

1487 1488
	return ret;
}
1489

1490
static int checkout_stream_close(git_writestream *s)
1491 1492
{
	struct checkout_stream *stream = (struct checkout_stream *)s;
1493 1494 1495

	GIT_ASSERT_ARG(stream);
	GIT_ASSERT_ARG(stream->open);
1496

1497
	stream->open = 0;
1498
	return p_close(stream->fd);
1499
}
1500

1501
static void checkout_stream_free(git_writestream *s)
1502 1503
{
	GIT_UNUSED(s);
Ben Straub committed
1504 1505
}

1506
static int blob_content_to_file(
1507
	checkout_data *data,
1508
	struct stat *st,
1509 1510
	git_blob *blob,
	const char *path,
1511
	const char *hint_path,
1512
	mode_t entry_filemode)
1513
{
1514
	int flags = data->opts.file_open_flags;
1515 1516
	mode_t file_mode = data->opts.file_mode ?
		data->opts.file_mode : entry_filemode;
1517
	git_filter_session filter_session = GIT_FILTER_SESSION_INIT;
1518 1519
	struct checkout_stream writer;
	mode_t mode;
1520
	git_filter_list *fl = NULL;
1521
	int fd;
1522
	int error = 0;
1523

1524
	GIT_ASSERT(hint_path != NULL);
1525

1526 1527 1528 1529 1530 1531 1532 1533 1534
	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) {
1535
		git_error_set(GIT_ERROR_OS, "could not open '%s' for writing", path);
1536 1537 1538
		return fd;
	}

1539 1540
	filter_session.attr_session = &data->attr_session;
	filter_session.temp_buf = &data->tmp;
1541

1542
	if (!data->opts.disable_filters &&
1543
		(error = git_filter_list__load(
1544
			&fl, data->repo, blob, hint_path,
1545
			GIT_FILTER_TO_WORKTREE, &filter_session))) {
1546
		p_close(fd);
1547
		return error;
1548
	}
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558

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

1561
	GIT_ASSERT(writer.open == 0);
1562

1563
	git_filter_list_free(fl);
1564

1565 1566
	if (error < 0)
		return error;
1567

1568 1569 1570 1571
	if (st) {
		data->perfdata.stat_calls++;

		if ((error = p_stat(path, st)) < 0) {
1572
			git_error_set(GIT_ERROR_OS, "failed to stat '%s'", path);
1573 1574 1575 1576 1577 1578 1579
			return error;
		}

		st->st_mode = entry_filemode;
	}

	return 0;
1580 1581
}

1582
static int blob_content_to_link(
1583
	checkout_data *data,
1584 1585
	struct stat *st,
	git_blob *blob,
1586
	const char *path)
1587
{
1588
	git_str linktarget = GIT_STR_INIT;
1589
	int error;
1590

1591
	if ((error = mkpath2file(data, path, data->opts.dir_mode)) < 0)
Linquize committed
1592
		return error;
1593

1594 1595
	if ((error = git_blob__getbuf(&linktarget, blob)) < 0)
		return error;
1596

1597
	if (data->can_symlink) {
1598
		if ((error = p_symlink(git_str_cstr(&linktarget), path)) < 0)
1599
			git_error_set(GIT_ERROR_OS, "could not create symlink %s", path);
1600
	} else {
1601
		error = git_futils_fake_symlink(git_str_cstr(&linktarget), path);
1602 1603 1604
	}

	if (!error) {
1605 1606
		data->perfdata.stat_calls++;

1607
		if ((error = p_lstat(path, st)) < 0)
1608
			git_error_set(GIT_ERROR_CHECKOUT, "could not stat symlink %s", path);
1609 1610 1611

		st->st_mode = GIT_FILEMODE_LINK;
	}
1612

1613
	git_str_dispose(&linktarget);
1614 1615

	return error;
1616 1617
}

1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629
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 */
1630
	git_index_entry__init_from_stat(&entry, st, true);
1631
	git_oid_cpy(&entry.id, &file->id);
1632 1633 1634 1635

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

1636 1637 1638 1639
static int checkout_submodule_update_index(
	checkout_data *data,
	const git_diff_file *file)
{
1640
	git_str *fullpath;
1641 1642 1643 1644 1645 1646
	struct stat st;

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

1647
	if (checkout_target_fullpath(&fullpath, data, file->path) < 0)
1648 1649
		return -1;

1650
	data->perfdata.stat_calls++;
1651
	if (p_stat(fullpath->ptr, &st) < 0) {
1652 1653
		git_error_set(
			GIT_ERROR_CHECKOUT, "could not stat submodule %s\n", file->path);
1654 1655 1656 1657 1658 1659 1660 1661
		return GIT_ENOTFOUND;
	}

	st.st_mode = GIT_FILEMODE_COMMIT;

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

1662
static int checkout_submodule(
1663
	checkout_data *data,
1664 1665
	const git_diff_file *file)
{
1666
	bool remove_existing = should_remove_existing(data);
1667 1668
	int error = 0;

1669
	/* Until submodules are supported, UPDATE_ONLY means do nothing here */
1670
	if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0)
1671 1672
		return 0;

1673 1674
	if ((error = checkout_mkdir(
			data,
1675 1676
			file->path, data->opts.target_directory, data->opts.dir_mode,
			remove_existing ? MKDIR_REMOVE_EXISTING : MKDIR_NORMAL)) < 0)
1677
		return error;
1678

1679
	if ((error = git_submodule_lookup(NULL, data->repo, file->path)) < 0) {
1680 1681 1682 1683
		/* 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) {
1684
			git_error_clear();
1685 1686 1687
			return checkout_submodule_update_index(data, file);
		}

1688
		return error;
1689
	}
1690

1691
	/* TODO: Support checkout_strategy options.  Two circumstances:
1692 1693 1694 1695
	 * 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
	 *
1696 1697
	 * Checkout will not execute a pull on the submodule, but a clone
	 * command should probably be able to.  Do we need a submodule callback?
1698 1699
	 */

1700
	return checkout_submodule_update_index(data, file);
1701 1702
}

1703
static void report_progress(
1704
	checkout_data *data,
1705
	const char *path)
1706
{
1707 1708
	if (data->opts.progress_cb)
		data->opts.progress_cb(
1709
			path, data->completed_steps, data->total_steps,
1710
			data->opts.progress_payload);
1711 1712
}

1713 1714
static int checkout_safe_for_update_only(
	checkout_data *data, const char *path, mode_t expected_mode)
1715 1716 1717
{
	struct stat st;

1718 1719
	data->perfdata.stat_calls++;

1720 1721 1722 1723 1724 1725
	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 */
1726
		git_error_set(GIT_ERROR_OS, "failed to stat '%s'", path);
1727 1728 1729 1730 1731 1732 1733 1734 1735 1736
		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;
}

1737
static int checkout_write_content(
1738
	checkout_data *data,
1739 1740 1741 1742 1743
	const git_oid *oid,
	const char *full_path,
	const char *hint_path,
	unsigned int mode,
	struct stat *st)
1744
{
1745
	int error = 0;
1746
	git_blob *blob;
1747

1748
	if ((error = git_blob_lookup(&blob, data->repo, oid)) < 0)
1749 1750
		return error;

1751
	if (S_ISLNK(mode))
1752
		error = blob_content_to_link(data, st, blob, full_path);
1753
	else
1754
		error = blob_content_to_file(data, st, blob, full_path, hint_path, mode);
1755 1756 1757

	git_blob_free(blob);

1758 1759 1760 1761 1762 1763 1764
	/* 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))
	{
1765
		git_error_clear();
1766 1767 1768
		error = 0;
	}

1769 1770 1771 1772 1773 1774 1775
	return error;
}

static int checkout_blob(
	checkout_data *data,
	const git_diff_file *file)
{
1776
	git_str *fullpath;
1777
	struct stat st;
1778
	int error = 0;
1779

1780
	if (checkout_target_fullpath(&fullpath, data, file->path) < 0)
1781 1782 1783
		return -1;

	if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0) {
1784
		int rval = checkout_safe_for_update_only(
1785 1786
			data, fullpath->ptr, file->mode);

1787 1788 1789 1790
		if (rval <= 0)
			return rval;
	}

1791
	error = checkout_write_content(
1792
		data, &file->id, fullpath->ptr, file->path, file->mode, &st);
1793

1794 1795 1796 1797
	/* update the index unless prevented */
	if (!error && (data->strategy & GIT_CHECKOUT_DONT_UPDATE_INDEX) == 0)
		error = checkout_update_index(data, file, &st);

1798 1799 1800 1801
	/* update the submodule data if this was a new .gitmodules file */
	if (!error && strcmp(file->path, ".gitmodules") == 0)
		data->reload_submodules = true;

1802 1803 1804
	return error;
}

1805 1806
static int checkout_remove_the_old(
	unsigned int *actions,
1807
	checkout_data *data)
1808
{
1809
	int error = 0;
1810
	git_diff_delta *delta;
1811
	const char *str;
1812
	size_t i;
1813
	git_str *fullpath;
1814 1815
	uint32_t flg = GIT_RMDIR_EMPTY_PARENTS |
		GIT_RMDIR_REMOVE_FILES | GIT_RMDIR_REMOVE_BLOCKERS;
1816

1817 1818 1819
	if (data->opts.checkout_strategy & GIT_CHECKOUT_SKIP_LOCKED_DIRECTORIES)
		flg |= GIT_RMDIR_SKIP_NONEMPTY;

1820 1821
	if (checkout_target_fullpath(&fullpath, data, NULL) < 0)
		return -1;
1822

1823
	git_vector_foreach(&data->diff->deltas, i, delta) {
1824
		if (actions[i] & CHECKOUT_ACTION__REMOVE) {
1825 1826 1827
			error = git_futils_rmdir_r(
				delta->old_file.path, fullpath->ptr, flg);

1828
			if (error < 0)
1829 1830 1831
				return error;

			data->completed_steps++;
1832
			report_progress(data, delta->old_file.path);
1833 1834 1835 1836 1837 1838 1839

			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);
			}
1840 1841 1842
		}
	}

1843
	git_vector_foreach(&data->removes, i, str) {
1844
		error = git_futils_rmdir_r(str, fullpath->ptr, flg);
1845 1846 1847 1848
		if (error < 0)
			return error;

		data->completed_steps++;
1849
		report_progress(data, str);
1850 1851 1852 1853

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

	return 0;
}

1864 1865
static int checkout_create_the_new(
	unsigned int *actions,
1866
	checkout_data *data)
1867
{
1868
	int error = 0;
1869 1870 1871
	git_diff_delta *delta;
	size_t i;

1872
	git_vector_foreach(&data->diff->deltas, i, delta) {
1873 1874
		if (actions[i] & CHECKOUT_ACTION__UPDATE_BLOB && !S_ISLNK(delta->new_file.mode)) {
			if ((error = checkout_blob(data, &delta->new_file)) < 0)
1875
				return error;
1876 1877 1878 1879
			data->completed_steps++;
			report_progress(data, delta->new_file.path);
		}
	}
1880

1881 1882 1883 1884
	git_vector_foreach(&data->diff->deltas, i, delta) {
		if (actions[i] & CHECKOUT_ACTION__UPDATE_BLOB && S_ISLNK(delta->new_file.mode)) {
			if ((error = checkout_blob(data, &delta->new_file)) < 0)
				return error;
1885
			data->completed_steps++;
1886
			report_progress(data, delta->new_file.path);
1887 1888 1889 1890 1891 1892 1893 1894
		}
	}

	return 0;
}

static int checkout_create_submodules(
	unsigned int *actions,
1895
	checkout_data *data)
1896 1897 1898 1899
{
	git_diff_delta *delta;
	size_t i;

1900
	git_vector_foreach(&data->diff->deltas, i, delta) {
1901
		if (actions[i] & CHECKOUT_ACTION__UPDATE_SUBMODULE) {
1902
			int error = checkout_submodule(data, &delta->new_file);
1903 1904 1905 1906
			if (error < 0)
				return error;

			data->completed_steps++;
1907
			report_progress(data, delta->new_file.path);
1908 1909 1910
		}
	}

1911
	return 0;
1912 1913
}

1914 1915 1916 1917 1918 1919 1920
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)) &&
1921
		!(error = git_reference_peel(&head, ref, GIT_OBJECT_TREE)))
1922 1923 1924 1925 1926 1927 1928
		*out = (git_tree *)head;

	git_reference_free(ref);

	return error;
}

1929 1930

static int conflict_entry_name(
1931
	git_str *out,
1932 1933 1934
	const char *side_name,
	const char *filename)
{
1935 1936 1937
	if (git_str_puts(out, side_name) < 0 ||
		git_str_putc(out, ':') < 0 ||
		git_str_puts(out, filename) < 0)
1938 1939 1940 1941 1942
		return -1;

	return 0;
}

1943
static int checkout_path_suffixed(git_str *path, const char *suffix)
1944 1945 1946 1947
{
	size_t path_len;
	int i = 0, error = 0;

1948
	if ((error = git_str_putc(path, '~')) < 0 || (error = git_str_puts(path, suffix)) < 0)
1949 1950
		return -1;

1951
	path_len = git_str_len(path);
1952

1953
	while (git_fs_path_exists(git_str_cstr(path)) && i < INT_MAX) {
1954
		git_str_truncate(path, path_len);
1955

1956 1957
		if ((error = git_str_putc(path, '_')) < 0 ||
			(error = git_str_printf(path, "%d", i)) < 0)
1958 1959 1960 1961 1962 1963
			return error;

		i++;
	}

	if (i == INT_MAX) {
1964
		git_str_truncate(path, path_len);
1965

1966
		git_error_set(GIT_ERROR_CHECKOUT, "could not write '%s': working directory file exists", path->ptr);
1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977
		return GIT_EEXISTS;
	}

	return 0;
}

static int checkout_write_entry(
	checkout_data *data,
	checkout_conflictdata *conflict,
	const git_index_entry *side)
{
1978 1979
	const char *hint_path = NULL, *suffix;
	git_str *fullpath;
1980 1981 1982
	struct stat st;
	int error;

1983
	GIT_ASSERT(side == conflict->ours || side == conflict->theirs);
1984

1985
	if (checkout_target_fullpath(&fullpath, data, side->path) < 0)
1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998
		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";

1999
		if (checkout_path_suffixed(fullpath, suffix) < 0)
2000 2001 2002
			return -1;
	}

2003 2004
	hint_path = side->path;

2005
	if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0 &&
2006
		(error = checkout_safe_for_update_only(data, fullpath->ptr, side->mode)) <= 0)
2007 2008
		return error;

2009 2010 2011 2012 2013
	if (!S_ISGITLINK(side->mode))
		return checkout_write_content(data,
					      &side->id, fullpath->ptr, hint_path, side->mode, &st);

	return 0;
2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028
}

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(
2029
	git_str *out,
2030 2031 2032 2033 2034 2035 2036
	checkout_data *data,
	checkout_conflictdata *conflict,
	git_merge_file_result *result)
{
	const char *our_label_raw, *their_label_raw, *suffix;
	int error = 0;

2037
	if ((error = git_str_joinpath(out, data->opts.target_directory, result->path)) < 0 ||
2038
	    (error = git_path_validate_str_length(data->repo, out)) < 0)
2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059
		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)
{
2060 2061 2062
	git_str our_label = GIT_STR_INIT, their_label = GIT_STR_INIT,
		path_suffixed = GIT_STR_INIT, path_workdir = GIT_STR_INIT,
		in_data = GIT_STR_INIT, out_data = GIT_STR_INIT;
2063 2064
	git_merge_file_options opts = GIT_MERGE_FILE_OPTIONS_INIT;
	git_merge_file_result result = {0};
2065
	git_filebuf output = GIT_FILEBUF_INIT;
2066
	git_filter_list *fl = NULL;
2067
	git_filter_session filter_session = GIT_FILTER_SESSION_INIT;
2068 2069
	int error = 0;

2070
	if (data->opts.checkout_strategy & GIT_CHECKOUT_CONFLICT_STYLE_DIFF3)
2071
		opts.flags |= GIT_MERGE_FILE_STYLE_DIFF3;
2072

2073 2074 2075
	if (data->opts.checkout_strategy & GIT_CHECKOUT_CONFLICT_STYLE_ZDIFF3)
		opts.flags |= GIT_MERGE_FILE_STYLE_ZDIFF3;

2076 2077 2078 2079 2080 2081
	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";
2082 2083 2084 2085 2086 2087 2088 2089

	/* 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(
2090
			&our_label, opts.our_label, conflict->ours->path)) < 0 ||
2091
			(error = conflict_entry_name(
2092
			&their_label, opts.their_label, conflict->theirs->path)) < 0)
2093 2094
			goto done;

2095 2096
		opts.our_label = git_str_cstr(&our_label);
		opts.their_label = git_str_cstr(&their_label);
2097 2098
	}

2099 2100
	if ((error = git_merge_file_from_index(&result, data->repo,
		conflict->ancestor, conflict->ours, conflict->theirs, &opts)) < 0)
2101 2102 2103
		goto done;

	if (result.path == NULL || result.mode == 0) {
2104
		git_error_set(GIT_ERROR_CHECKOUT, "could not merge contents of file");
2105
		error = GIT_ECONFLICT;
2106 2107 2108 2109 2110 2111 2112
		goto done;
	}

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

	if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0 &&
2113
		(error = checkout_safe_for_update_only(data, git_str_cstr(&path_workdir), result.mode)) <= 0)
2114 2115
		goto done;

2116
	if (!data->opts.disable_filters) {
2117 2118 2119
		in_data.ptr = (char *)result.ptr;
		in_data.size = result.len;

2120 2121
		filter_session.attr_session = &data->attr_session;
		filter_session.temp_buf = &data->tmp;
2122

2123
		if ((error = git_filter_list__load(
2124
				&fl, data->repo, NULL, result.path,
2125
				GIT_FILTER_TO_WORKTREE, &filter_session)) < 0 ||
2126
			(error = git_filter_list__convert_buf(&out_data, fl, &in_data)) < 0)
2127
			goto done;
2128 2129 2130 2131
	} else {
		out_data.ptr = (char *)result.ptr;
		out_data.size = result.len;
	}
2132

2133
	if ((error = mkpath2file(data, path_workdir.ptr, data->opts.dir_mode)) < 0 ||
2134
		(error = git_filebuf_open(&output, git_str_cstr(&path_workdir), GIT_FILEBUF_DO_NOT_BUFFER, result.mode)) < 0 ||
2135
		(error = git_filebuf_write(&output, out_data.ptr, out_data.size)) < 0 ||
2136
		(error = git_filebuf_commit(&output)) < 0)
2137 2138 2139
		goto done;

done:
2140 2141
	git_filter_list_free(fl);

2142 2143 2144
	git_str_dispose(&out_data);
	git_str_dispose(&our_label);
	git_str_dispose(&their_label);
2145 2146

	git_merge_file_result_free(&result);
2147 2148
	git_str_dispose(&path_workdir);
	git_str_dispose(&path_suffixed);
2149 2150 2151 2152

	return error;
}

2153 2154 2155 2156 2157 2158 2159
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)
2160
		git_error_clear();
2161 2162 2163 2164 2165 2166
	else if (error < 0)
		return error;

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

2167 2168 2169 2170 2171 2172 2173
static int checkout_conflict_update_index(
	checkout_data *data,
	checkout_conflictdata *conflict)
{
	int error = 0;

	if (conflict->ancestor)
2174
		error = checkout_conflict_add(data, conflict->ancestor);
2175 2176

	if (!error && conflict->ours)
2177
		error = checkout_conflict_add(data, conflict->ours);
2178 2179

	if (!error && conflict->theirs)
2180
		error = checkout_conflict_add(data, conflict->theirs);
2181 2182 2183 2184

	return error;
}

2185 2186 2187 2188 2189 2190
static int checkout_create_conflicts(checkout_data *data)
{
	checkout_conflictdata *conflict;
	size_t i;
	int error = 0;

2191
	git_vector_foreach(&data->update_conflicts, i, conflict) {
2192

2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 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
		/* 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
2236 2237 2238 2239
		/* If any side is a gitlink, do nothing. */
		else if (conflict->submodule)
			error = 0;

2240 2241 2242 2243 2244
		/* If any side is binary, write the ours side */
		else if (conflict->binary)
			error = checkout_write_entry(data, conflict, conflict->ours);

		else if (!error)
2245 2246
			error = checkout_write_merge(data, conflict);

2247 2248 2249 2250 2251 2252
		/* 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);

2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264
		if (error)
			break;

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

	return error;
}

2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279
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;
}

2280 2281 2282 2283 2284 2285 2286 2287 2288 2289
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;

2290 2291
	if (data->update_reuc) {
		git_vector_foreach(data->update_reuc, i, reuc_entry) {
2292 2293 2294 2295 2296 2297 2298 2299
			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;
		}
	}

2300 2301
	if (data->update_names) {
		git_vector_foreach(data->update_names, i, name_entry) {
2302 2303 2304 2305 2306 2307 2308 2309 2310
			if ((error = git_index_name_add(data->index, name_entry->ancestor,
				name_entry->ours, name_entry->theirs)) < 0)
				goto done;
		}
	}

done:
	return error;
}
2311

2312 2313 2314 2315 2316 2317 2318 2319 2320 2321
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);

2322 2323
	git_vector_free_deep(&data->remove_conflicts);
	git_vector_free_deep(&data->update_conflicts);
2324

2325 2326 2327
	git__free(data->pfx);
	data->pfx = NULL;

2328 2329
	git_str_dispose(&data->target_path);
	git_str_dispose(&data->tmp);
2330 2331 2332

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

2334
	git_strmap_free(data->mkdir_map);
2335
	data->mkdir_map = NULL;
2336

2337
	git_attr_session__free(&data->attr_session);
2338 2339
}

2340 2341 2342 2343
static int validate_target_directory(checkout_data *data)
{
	int error;

2344
	if ((error = git_path_validate_length(data->repo, data->opts.target_directory)) < 0)
2345 2346
		return error;

2347
	if (git_fs_path_isdir(data->opts.target_directory))
2348 2349 2350 2351 2352 2353 2354 2355
		return 0;

	error = checkout_mkdir(data, data->opts.target_directory, NULL,
	                       GIT_DIR_MODE, GIT_MKDIR_VERIFY_DIR);

	return error;
}

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

2364 2365 2366
	memset(data, 0, sizeof(*data));

	if (!repo) {
2367
		git_error_set(GIT_ERROR_CHECKOUT, "cannot checkout nothing");
2368
		return -1;
2369
	}
2370

2371 2372
	if ((!proposed || !proposed->target_directory) &&
		(error = git_repository__ensure_not_bare(repo, "checkout")) < 0)
2373
		return error;
2374

2375
	data->repo = repo;
2376
	data->target = target;
2377

2378
	GIT_ERROR_CHECK_VERSION(
2379
		proposed, GIT_CHECKOUT_OPTIONS_VERSION, "git_checkout_options");
2380 2381

	if (!proposed)
2382
		GIT_INIT_STRUCTURE(&data->opts, GIT_CHECKOUT_OPTIONS_VERSION);
2383
	else
2384
		memmove(&data->opts, proposed, sizeof(git_checkout_options));
2385

2386 2387
	if (!data->opts.target_directory)
		data->opts.target_directory = git_repository_workdir(repo);
2388
	else if ((error = validate_target_directory(data)) < 0)
2389 2390
		goto cleanup;

2391 2392 2393
	if ((error = git_repository_index(&data->index, data->repo)) < 0)
		goto cleanup;

2394 2395
	/* refresh config and index content unless NO_REFRESH is given */
	if ((data->opts.checkout_strategy & GIT_CHECKOUT_NO_REFRESH) == 0) {
2396 2397
		git_config *cfg;

2398
		if ((error = git_repository_config__weakptr(&cfg, repo)) < 0)
2399 2400
			goto cleanup;

2401 2402 2403
		/* Reload the repository index (unless we're checking out the
		 * index; then it has the changes we're trying to check out
		 * and those should not be overwritten.)
2404
		 */
2405
		if (data->index != git_iterator_index(target)) {
2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417
			if (data->opts.checkout_strategy & GIT_CHECKOUT_FORCE) {
				/* When forcing, we can blindly re-read the index */
				if ((error = git_index_read(data->index, false)) < 0)
					goto cleanup;
			} else {
				/*
				 * When not being forced, we need to check for unresolved
				 * conflicts and unsaved changes in the index before
				 * proceeding.
				 */
				if (git_index_has_conflicts(data->index)) {
					error = GIT_ECONFLICT;
2418
					git_error_set(GIT_ERROR_CHECKOUT,
2419 2420 2421 2422 2423 2424
						"unresolved conflicts exist in the index");
					goto cleanup;
				}

				if ((error = git_index_read_safely(data->index)) < 0)
					goto cleanup;
2425 2426
			}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2511 2512
	if ((error = git_pool_init(&data->pool, 1)) < 0 ||
	    (error = git_vector_init(&data->removes, 0, git__strcmp_cb)) < 0 ||
2513 2514
	    (error = git_vector_init(&data->remove_conflicts, 0, NULL)) < 0 ||
	    (error = git_vector_init(&data->update_conflicts, 0, NULL)) < 0 ||
2515
	    (error = git_str_puts(&data->target_path, data->opts.target_directory)) < 0 ||
2516
	    (error = git_fs_path_to_dir(&data->target_path)) < 0 ||
2517
	    (error = git_strmap_new(&data->mkdir_map)) < 0)
2518 2519
		goto cleanup;

2520
	data->target_len = git_str_len(&data->target_path);
2521

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

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

	return error;
}

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

2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544
GIT_INLINE(void) setup_pathspecs(
	git_iterator_options *iter_opts,
	const git_checkout_options *checkout_opts)
{
	if (checkout_opts &&
		(checkout_opts->checkout_strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH)) {
		iter_opts->pathlist.count = checkout_opts->paths.count;
		iter_opts->pathlist.strings = checkout_opts->paths.strings;
	}
}

2545 2546
int git_checkout_iterator(
	git_iterator *target,
2547
	git_index *index,
2548
	const git_checkout_options *opts)
2549 2550
{
	int error = 0;
2551
	git_iterator *baseline = NULL, *workdir = NULL;
2552 2553
	git_iterator_options baseline_opts = GIT_ITERATOR_OPTIONS_INIT,
		workdir_opts = GIT_ITERATOR_OPTIONS_INIT;
2554
	checkout_data data = {0};
2555
	git_diff_options diff_opts = GIT_DIFF_OPTIONS_INIT;
2556 2557
	uint32_t *actions = NULL;
	size_t *counts = NULL;
2558

2559
	/* initialize structures and options */
2560
	error = checkout_data_init(&data, target, opts);
2561 2562
	if (error < 0)
		return error;
Ben Straub committed
2563

2564 2565
	diff_opts.flags =
		GIT_DIFF_INCLUDE_UNMODIFIED |
2566
		GIT_DIFF_INCLUDE_UNREADABLE |
2567 2568 2569 2570 2571
		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 |
2572 2573
		GIT_DIFF_SKIP_BINARY_CHECK |
		GIT_DIFF_INCLUDE_CASECHANGE;
2574 2575
	if (data.opts.checkout_strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH)
		diff_opts.flags |= GIT_DIFF_DISABLE_PATHSPEC_MATCH;
2576 2577 2578 2579
	if (data.opts.paths.count > 0)
		diff_opts.pathspec = data.opts.paths;

	/* set up iterators */
2580

2581
	workdir_opts.flags = git_iterator_ignore_case(target) ?
2582
		GIT_ITERATOR_IGNORE_CASE : GIT_ITERATOR_DONT_IGNORE_CASE;
2583 2584 2585
	workdir_opts.flags |= GIT_ITERATOR_DONT_AUTOEXPAND;
	workdir_opts.start = data.pfx;
	workdir_opts.end = data.pfx;
2586

2587 2588
	setup_pathspecs(&workdir_opts, opts);

2589
	if ((error = git_iterator_reset_range(target, data.pfx, data.pfx)) < 0 ||
2590
		(error = git_iterator_for_workdir_ext(
2591
			&workdir, data.repo, data.opts.target_directory, index, NULL,
2592
			&workdir_opts)) < 0)
2593 2594
		goto cleanup;

2595 2596 2597 2598
	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;
2599 2600

	setup_pathspecs(&baseline_opts, opts);
2601

2602 2603
	if (data.opts.baseline_index) {
		if ((error = git_iterator_for_index(
2604 2605
				&baseline, git_index_owner(data.opts.baseline_index),
				data.opts.baseline_index, &baseline_opts)) < 0)
2606 2607 2608
			goto cleanup;
	} else {
		if ((error = git_iterator_for_tree(
2609
				&baseline, data.opts.baseline, &baseline_opts)) < 0)
2610 2611 2612
			goto cleanup;
	}

2613
	/* Should not have case insensitivity mismatch */
2614
	GIT_ASSERT(git_iterator_ignore_case(workdir) == git_iterator_ignore_case(baseline));
2615

2616 2617
	/* Generate baseline-to-target diff which will include an entry for
	 * every possible update that might need to be made.
2618 2619
	 */
	if ((error = git_diff__from_iterators(
2620
			&data.diff, data.repo, baseline, target, &diff_opts)) < 0)
2621 2622
		goto cleanup;

2623
	/* Loop through diff (and working directory iterator) building a list of
2624 2625
	 * actions to be taken, plus look for conflicts and send notifications,
	 * then loop through conflicts.
2626
	 */
2627
	if ((error = checkout_get_actions(&actions, &counts, &data, workdir)) != 0)
2628 2629
		goto cleanup;

2630 2631
	if (data.strategy & GIT_CHECKOUT_DRY_RUN)
		goto cleanup;
2632

2633
	data.total_steps = counts[CHECKOUT_ACTION__REMOVE] +
2634
		counts[CHECKOUT_ACTION__REMOVE_CONFLICT] +
2635
		counts[CHECKOUT_ACTION__UPDATE_BLOB] +
2636 2637
		counts[CHECKOUT_ACTION__UPDATE_SUBMODULE] +
		counts[CHECKOUT_ACTION__UPDATE_CONFLICT];
2638

2639
	report_progress(&data, NULL); /* establish 0 baseline */
2640

2641 2642 2643
	/* To deal with some order dependencies, perform remaining checkout
	 * in three passes: removes, then update blobs, then update submodules.
	 */
2644
	if (counts[CHECKOUT_ACTION__REMOVE] > 0 &&
2645
		(error = checkout_remove_the_old(actions, &data)) < 0)
2646 2647
		goto cleanup;

2648 2649 2650 2651
	if (counts[CHECKOUT_ACTION__REMOVE_CONFLICT] > 0 &&
		(error = checkout_remove_conflicts(&data)) < 0)
		goto cleanup;

2652
	if (counts[CHECKOUT_ACTION__UPDATE_BLOB] > 0 &&
2653
		(error = checkout_create_the_new(actions, &data)) < 0)
2654 2655
		goto cleanup;

2656
	if (counts[CHECKOUT_ACTION__UPDATE_SUBMODULE] > 0 &&
2657
		(error = checkout_create_submodules(actions, &data)) < 0)
2658 2659
		goto cleanup;

2660
	if (counts[CHECKOUT_ACTION__UPDATE_CONFLICT] > 0 &&
2661
		(error = checkout_create_conflicts(&data)) < 0)
2662
		goto cleanup;
2663

2664
	if (data.index != git_iterator_index(target) &&
2665 2666 2667
		(error = checkout_extensions_update_index(&data)) < 0)
		goto cleanup;

2668
	GIT_ASSERT(data.completed_steps == data.total_steps);
2669

2670 2671 2672
	if (data.opts.perfdata_cb)
		data.opts.perfdata_cb(&data.perfdata, data.opts.perfdata_payload);

2673
cleanup:
2674
	if (!error && data.index != NULL &&
2675
		(data.strategy & CHECKOUT_INDEX_DONT_WRITE_MASK) == 0)
2676 2677
		error = git_index_write(data.index);

2678
	git_diff_free(data.diff);
2679
	git_iterator_free(workdir);
2680
	git_iterator_free(baseline);
2681 2682
	git__free(actions);
	git__free(counts);
2683
	checkout_data_clear(&data);
2684 2685 2686 2687 2688 2689 2690

	return error;
}

int git_checkout_index(
	git_repository *repo,
	git_index *index,
2691
	const git_checkout_options *opts)
2692
{
2693
	git_iterator_options iter_opts = GIT_ITERATOR_OPTIONS_INIT;
2694
	int error, owned = 0;
2695
	git_iterator *index_i;
2696

2697
	if (!index && !repo) {
2698
		git_error_set(GIT_ERROR_CHECKOUT,
2699
			"must provide either repository or index to checkout");
2700 2701
		return -1;
	}
2702 2703 2704 2705

	if (index && repo &&
		git_index_owner(index) &&
		git_index_owner(index) != repo) {
2706
		git_error_set(GIT_ERROR_CHECKOUT,
2707
			"index to checkout does not match repository");
2708
		return -1;
2709 2710 2711
	} else if(index && repo && !git_index_owner(index)) {
		GIT_REFCOUNT_OWN(index, repo);
		owned = 1;
2712 2713 2714 2715
	}

	if (!repo)
		repo = git_index_owner(index);
2716 2717 2718

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

2721 2722 2723
	setup_pathspecs(&iter_opts, opts);

	if (!(error = git_iterator_for_index(&index_i, repo, index, &iter_opts)))
2724
		error = git_checkout_iterator(index_i, index, opts);
2725

2726 2727 2728
	if (owned)
		GIT_REFCOUNT_OWN(index, NULL);

2729
	git_iterator_free(index_i);
2730
	git_index_free(index);
2731

2732 2733 2734 2735 2736
	return error;
}

int git_checkout_tree(
	git_repository *repo,
Vicent Marti committed
2737
	const git_object *treeish,
2738
	const git_checkout_options *opts)
2739
{
2740
	int error;
2741
	git_index *index;
2742 2743
	git_tree *tree = NULL;
	git_iterator *tree_i = NULL;
2744
	git_iterator_options iter_opts = GIT_ITERATOR_OPTIONS_INIT;
2745

2746
	if (!treeish && !repo) {
2747
		git_error_set(GIT_ERROR_CHECKOUT,
2748
			"must provide either repository or tree to checkout");
2749 2750 2751
		return -1;
	}
	if (treeish && repo && git_object_owner(treeish) != repo) {
2752
		git_error_set(GIT_ERROR_CHECKOUT,
2753
			"object to checkout does not match repository");
2754 2755 2756 2757 2758
		return -1;
	}

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

2760
	if (treeish) {
2761
		if (git_object_peel((git_object **)&tree, treeish, GIT_OBJECT_TREE) < 0) {
2762 2763
			git_error_set(
				GIT_ERROR_CHECKOUT, "provided object cannot be peeled to a tree");
2764 2765 2766 2767 2768 2769
			return -1;
		}
	}
	else {
		if ((error = checkout_lookup_head_tree(&tree, repo)) < 0) {
			if (error != GIT_EUNBORNBRANCH)
2770 2771
				git_error_set(
					GIT_ERROR_CHECKOUT,
2772 2773 2774
					"HEAD could not be peeled to a tree and no treeish given");
			return error;
		}
2775 2776
	}

2777 2778 2779
	if ((error = git_repository_index(&index, repo)) < 0)
		return error;

2780
	setup_pathspecs(&iter_opts, opts);
2781 2782

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

2785
	git_iterator_free(tree_i);
2786
	git_index_free(index);
2787
	git_tree_free(tree);
2788

2789
	return error;
2790 2791
}

2792 2793
int git_checkout_head(
	git_repository *repo,
2794
	const git_checkout_options *opts)
2795
{
2796 2797
	GIT_ASSERT_ARG(repo);

2798
	return git_checkout_tree(repo, NULL, opts);
2799
}
2800

2801
int git_checkout_options_init(git_checkout_options *opts, unsigned int version)
2802
{
2803 2804 2805
	GIT_INIT_STRUCTURE_FROM_TEMPLATE(
		opts, version, git_checkout_options, GIT_CHECKOUT_OPTIONS_INIT);
	return 0;
2806
}
2807

2808
#ifndef GIT_DEPRECATE_HARD
2809 2810 2811 2812
int git_checkout_init_options(git_checkout_options *opts, unsigned int version)
{
	return git_checkout_options_init(opts, version);
}
2813
#endif