checkout.c 57.4 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 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 "pathspec.h"
28
#include "buf_text.h"
29
#include "merge_file.h"
30
#include "path.h"
31

32
/* See docs/checkout-internals.md for more information */
33

34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
enum {
	CHECKOUT_ACTION__NONE = 0,
	CHECKOUT_ACTION__REMOVE = 1,
	CHECKOUT_ACTION__UPDATE_BLOB = 2,
	CHECKOUT_ACTION__UPDATE_SUBMODULE = 4,
	CHECKOUT_ACTION__CONFLICT = 8,
	CHECKOUT_ACTION__UPDATE_CONFLICT = 16,
	CHECKOUT_ACTION__MAX = 16,
	CHECKOUT_ACTION__DEFER_REMOVE = 32,
	CHECKOUT_ACTION__REMOVE_AND_UPDATE =
		(CHECKOUT_ACTION__UPDATE_BLOB | CHECKOUT_ACTION__REMOVE),
};

typedef struct {
	git_repository *repo;
49
	git_diff *diff;
50
	git_checkout_options opts;
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
	bool opts_free_baseline;
	char *pfx;
	git_index *index;
	git_pool pool;
	git_vector removes;
	git_vector conflicts;
	git_buf path;
	size_t workdir_len;
	unsigned int strategy;
	int can_symlink;
	bool reload_submodules;
	size_t total_steps;
	size_t completed_steps;
} 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,
73
		one_to_two:1,
Edward Thomson committed
74 75
		binary:1,
		submodule:1;
76 77
} checkout_conflictdata;

78
static int checkout_notify(
79
	checkout_data *data,
80 81
	git_checkout_notify_t why,
	const git_diff_delta *delta,
82
	const git_index_entry *wditem)
83
{
84
	git_diff_file wdfile;
85
	const git_diff_file *baseline = NULL, *target = NULL, *workdir = NULL;
86
	const char *path = NULL;
87

88 89
	if (!data->opts.notify_cb ||
		(why & data->opts.notify_flags) == 0)
90 91
		return 0;

92 93
	if (wditem) {
		memset(&wdfile, 0, sizeof(wdfile));
94

95
		git_oid_cpy(&wdfile.id, &wditem->id);
96 97
		wdfile.path = wditem->path;
		wdfile.size = wditem->file_size;
98
		wdfile.flags = GIT_DIFF_FLAG_VALID_ID;
99
		wdfile.mode = wditem->mode;
100

101
		workdir = &wdfile;
102 103

		path = wditem->path;
104 105
	}

106
	if (delta) {
107 108 109 110 111
		switch (delta->status) {
		case GIT_DELTA_UNMODIFIED:
		case GIT_DELTA_MODIFIED:
		case GIT_DELTA_TYPECHANGE:
		default:
112 113
			baseline = &delta->old_file;
			target = &delta->new_file;
114 115 116 117
			break;
		case GIT_DELTA_ADDED:
		case GIT_DELTA_IGNORED:
		case GIT_DELTA_UNTRACKED:
118
			target = &delta->new_file;
119 120
			break;
		case GIT_DELTA_DELETED:
121
			baseline = &delta->old_file;
122 123
			break;
		}
124 125

		path = delta->old_file.path;
126 127
	}

128 129 130 131 132 133 134
	{
		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");
	}
135 136 137
}

static bool checkout_is_workdir_modified(
138
	checkout_data *data,
139 140
	const git_diff_file *baseitem,
	const git_index_entry *wditem)
141 142
{
	git_oid oid;
143
	const git_index_entry *ie;
144

145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
	/* handle "modified" submodule */
	if (wditem->mode == GIT_FILEMODE_COMMIT) {
		git_submodule *sm;
		unsigned int sm_status = 0;
		const git_oid *sm_oid = NULL;

		if (git_submodule_lookup(&sm, data->repo, wditem->path) < 0 ||
			git_submodule_status(&sm_status, sm) < 0)
			return true;

		if (GIT_SUBMODULE_STATUS_IS_WD_DIRTY(sm_status))
			return true;

		sm_oid = git_submodule_wd_id(sm);
		if (!sm_oid)
			return false;

162
		return (git_oid__cmp(&baseitem->id, sm_oid) != 0);
163 164
	}

165 166 167 168 169 170 171 172
	/* 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
	 * of hashing the file.
	 */
	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)
173
			return (git_oid__cmp(&baseitem->id, &ie->id) != 0);
174 175
	}

176 177 178 179
	/* 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)
180 181 182
		return true;

	if (git_diff__oid_for_file(
183 184
			data->repo, wditem->path, wditem->mode,
			wditem->file_size, &oid) < 0)
185 186
		return false;

187
	return (git_oid__cmp(&baseitem->id, &oid) != 0);
188 189 190 191 192 193
}

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

static int checkout_action_common(
194
	int *action,
195
	checkout_data *data,
196
	const git_diff_delta *delta,
197 198 199 200 201
	const git_index_entry *wd)
{
	git_checkout_notify_t notify = GIT_CHECKOUT_NOTIFY_NONE;

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

204
	if ((*action & CHECKOUT_ACTION__UPDATE_BLOB) != 0) {
205
		if (S_ISGITLINK(delta->new_file.mode))
206
			*action = (*action & ~CHECKOUT_ACTION__UPDATE_BLOB) |
207 208
				CHECKOUT_ACTION__UPDATE_SUBMODULE;

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

213 214 215
		notify = GIT_CHECKOUT_NOTIFY_UPDATED;
	}

216
	if ((*action & CHECKOUT_ACTION__CONFLICT) != 0)
217 218
		notify = GIT_CHECKOUT_NOTIFY_CONFLICT;

219
	return checkout_notify(data, notify, delta, wd);
220 221 222
}

static int checkout_action_no_wd(
223
	int *action,
224 225
	checkout_data *data,
	const git_diff_delta *delta)
226
{
227 228 229
	int error = 0;

	*action = CHECKOUT_ACTION__NONE;
230

231 232
	switch (delta->status) {
	case GIT_DELTA_UNMODIFIED: /* case 12 */
233 234 235 236
		error = checkout_notify(data, GIT_CHECKOUT_NOTIFY_DIRTY, delta, NULL);
		if (error)
			return error;
		*action = CHECKOUT_ACTION_IF(SAFE_CREATE, UPDATE_BLOB, NONE);
237 238
		break;
	case GIT_DELTA_ADDED:    /* case 2 or 28 (and 5 but not really) */
239
		*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
240
		break;
241
	case GIT_DELTA_MODIFIED: /* case 13 (and 35 but not really) */
242
		*action = CHECKOUT_ACTION_IF(SAFE_CREATE, UPDATE_BLOB, CONFLICT);
243
		break;
244 245
	case GIT_DELTA_TYPECHANGE: /* case 21 (B->T) and 28 (T->B)*/
		if (delta->new_file.mode == GIT_FILEMODE_TREE)
246
			*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
247 248
		break;
	case GIT_DELTA_DELETED: /* case 8 or 25 */
249
		*action = CHECKOUT_ACTION_IF(SAFE, REMOVE, NONE);
250
		break;
251 252
	default: /* impossible */
		break;
253 254
	}

255
	return checkout_action_common(action, data, delta, NULL);
256 257 258 259 260 261 262 263
}

static int checkout_action_wd_only(
	checkout_data *data,
	git_iterator *workdir,
	const git_index_entry *wd,
	git_vector *pathspec)
{
264
	int error = 0;
265
	bool remove = false;
266 267
	git_checkout_notify_t notify = GIT_CHECKOUT_NOTIFY_NONE;

268
	if (!git_pathspec__match(
269 270
			pathspec, wd->path,
			(data->strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH) != 0,
271
			git_iterator_ignore_case(workdir), NULL, NULL))
272 273
		return 0;

274
	/* check if item is tracked in the index but not in the checkout diff */
275 276
	if (data->index != NULL) {
		if (wd->mode != GIT_FILEMODE_TREE) {
277
			if (!(error = git_index_find(NULL, data->index, wd->path))) {
278 279
				notify = GIT_CHECKOUT_NOTIFY_DIRTY;
				remove = ((data->strategy & GIT_CHECKOUT_FORCE) != 0);
280 281
			} else if (error != GIT_ENOTFOUND)
				return error;
282 283
			else
				giterr_clear();
284 285 286 287 288 289 290 291 292 293 294 295
		} else {
			/* for tree entries, we have to see if there are any index
			 * entries that are contained inside that tree
			 */
			size_t pos = git_index__prefix_position(data->index, wd->path);
			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);
			}
		}
296
	}
297 298 299

	if (notify != GIT_CHECKOUT_NOTIFY_NONE)
		/* found in index */;
300
	else if (git_iterator_current_is_ignored(workdir)) {
301 302
		notify = GIT_CHECKOUT_NOTIFY_IGNORED;
		remove = ((data->strategy & GIT_CHECKOUT_REMOVE_IGNORED) != 0);
303 304
	}
	else {
305 306
		notify = GIT_CHECKOUT_NOTIFY_UNTRACKED;
		remove = ((data->strategy & GIT_CHECKOUT_REMOVE_UNTRACKED) != 0);
307 308
	}

309
	error = checkout_notify(data, notify, NULL, wd);
310

311
	if (!error && remove) {
312 313 314
		char *path = git_pool_strdup(&data->pool, wd->path);
		GITERR_CHECK_ALLOC(path);

315
		error = git_vector_insert(&data->removes, path);
316 317
	}

318
	return error;
319 320
}

321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
static bool submodule_is_config_only(
	checkout_data *data,
	const char *path)
{
	git_submodule *sm = NULL;
	unsigned int sm_loc = 0;

	if (git_submodule_lookup(&sm, data->repo, path) < 0 ||
		git_submodule_location(&sm_loc, sm) < 0 ||
		sm_loc == GIT_SUBMODULE_STATUS_IN_CONFIG)
		return true;

	return false;
}

336
static int checkout_action_with_wd(
337
	int *action,
338 339
	checkout_data *data,
	const git_diff_delta *delta,
340
	git_iterator *workdir,
341 342
	const git_index_entry *wd)
{
343
	*action = CHECKOUT_ACTION__NONE;
344 345 346

	switch (delta->status) {
	case GIT_DELTA_UNMODIFIED: /* case 14/15 or 33 */
347
		if (checkout_is_workdir_modified(data, &delta->old_file, wd)) {
348 349 350
			GITERR_CHECK_ERROR(
				checkout_notify(data, GIT_CHECKOUT_NOTIFY_DIRTY, delta, wd) );
			*action = CHECKOUT_ACTION_IF(FORCE, UPDATE_BLOB, NONE);
351
		}
352 353
		break;
	case GIT_DELTA_ADDED: /* case 3, 4 or 6 */
354 355 356 357
		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);
358 359 360
		break;
	case GIT_DELTA_DELETED: /* case 9 or 10 (or 26 but not really) */
		if (checkout_is_workdir_modified(data, &delta->old_file, wd))
361
			*action = CHECKOUT_ACTION_IF(FORCE, REMOVE, CONFLICT);
362
		else
363
			*action = CHECKOUT_ACTION_IF(SAFE, REMOVE, NONE);
364 365 366
		break;
	case GIT_DELTA_MODIFIED: /* case 16, 17, 18 (or 36 but not really) */
		if (checkout_is_workdir_modified(data, &delta->old_file, wd))
367
			*action = CHECKOUT_ACTION_IF(FORCE, UPDATE_BLOB, CONFLICT);
368
		else
369
			*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
370 371
		break;
	case GIT_DELTA_TYPECHANGE: /* case 22, 23, 29, 30 */
372 373 374 375 376
		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...
				 */
377
				*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
378 379 380 381 382
			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))
383
					*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
384
				else
385
					*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
386
			} else
387
				*action = CHECKOUT_ACTION_IF(FORCE, REMOVE, CONFLICT);
388
		}
389
		else if (checkout_is_workdir_modified(data, &delta->old_file, wd))
390
			*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
391
		else
392
			*action = CHECKOUT_ACTION_IF(SAFE, REMOVE_AND_UPDATE, NONE);
393 394 395

		/* don't update if the typechange is to a tree */
		if (delta->new_file.mode == GIT_FILEMODE_TREE)
396
			*action = (*action & ~CHECKOUT_ACTION__UPDATE_BLOB);
397 398 399
		break;
	default: /* impossible */
		break;
400 401
	}

402
	return checkout_action_common(action, data, delta, wd);
403
}
404

405
static int checkout_action_with_wd_blocker(
406
	int *action,
407 408 409 410
	checkout_data *data,
	const git_diff_delta *delta,
	const git_index_entry *wd)
{
411
	*action = CHECKOUT_ACTION__NONE;
412

413 414 415
	switch (delta->status) {
	case GIT_DELTA_UNMODIFIED:
		/* should show delta as dirty / deleted */
416 417 418
		GITERR_CHECK_ERROR(
			checkout_notify(data, GIT_CHECKOUT_NOTIFY_DIRTY, delta, wd) );
		*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, NONE);
419 420 421
		break;
	case GIT_DELTA_ADDED:
	case GIT_DELTA_MODIFIED:
422
		*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
423 424
		break;
	case GIT_DELTA_DELETED:
425
		*action = CHECKOUT_ACTION_IF(FORCE, REMOVE, CONFLICT);
426 427 428
		break;
	case GIT_DELTA_TYPECHANGE:
		/* not 100% certain about this... */
429
		*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
430 431 432
		break;
	default: /* impossible */
		break;
433 434
	}

435
	return checkout_action_common(action, data, delta, wd);
436 437 438
}

static int checkout_action_with_wd_dir(
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 19 or 24 (or 34 but not really) */
449 450 451 452
		GITERR_CHECK_ERROR(
			checkout_notify(data, GIT_CHECKOUT_NOTIFY_DIRTY, delta, NULL));
		GITERR_CHECK_ERROR(
			checkout_notify(data, GIT_CHECKOUT_NOTIFY_UNTRACKED, NULL, wd));
453 454 455
		break;
	case GIT_DELTA_ADDED:/* case 4 (and 7 for dir) */
	case GIT_DELTA_MODIFIED: /* case 20 (or 37 but not really) */
456 457 458
		if (delta->old_file.mode == GIT_FILEMODE_COMMIT)
			/* expected submodule (and maybe found one) */;
		else if (delta->new_file.mode != GIT_FILEMODE_TREE)
459 460 461
			*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);
462 463
		break;
	case GIT_DELTA_DELETED: /* case 11 (and 27 for dir) */
464 465 466
		if (delta->old_file.mode != GIT_FILEMODE_TREE)
			GITERR_CHECK_ERROR(
				checkout_notify(data, GIT_CHECKOUT_NOTIFY_UNTRACKED, NULL, wd));
467 468 469
		break;
	case GIT_DELTA_TYPECHANGE: /* case 24 or 31 */
		if (delta->old_file.mode == GIT_FILEMODE_TREE) {
470 471 472 473 474 475
			/* 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.
			 */
476 477 478
			*action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
			if (*action != CHECKOUT_ACTION__NONE)
				*action |= CHECKOUT_ACTION__DEFER_REMOVE;
479
		}
480 481
		else if (delta->new_file.mode != GIT_FILEMODE_TREE)
			/* For typechange to dir, dir is already created so no action */
482
			*action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
483 484 485
		break;
	default: /* impossible */
		break;
486 487
	}

488
	return checkout_action_common(action, data, delta, wd);
489 490
}

491
static int checkout_action(
492
	int *action,
493
	checkout_data *data,
494
	git_diff_delta *delta,
495
	git_iterator *workdir,
496
	const git_index_entry **wditem,
497 498
	git_vector *pathspec)
{
499
	int cmp = -1, error;
500 501
	int (*strcomp)(const char *, const char *) = data->diff->strcomp;
	int (*pfxcomp)(const char *str, const char *pfx) = data->diff->pfxcomp;
502
	int (*advance)(const git_index_entry **, git_iterator *) = NULL;
503 504 505 506

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

	while (1) {
507 508
		const git_index_entry *wd = *wditem;

509
		if (!wd)
510
			return checkout_action_no_wd(action, data, delta);
511

512 513 514 515 516 517 518 519 520 521 522 523 524
		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);

525
			if (cmp == 0) {
526 527
				if (wd->mode == GIT_FILEMODE_TREE) {
					/* case 2 - entry prefixed by workdir tree */
528 529 530
					error = git_iterator_advance_into_or_over(wditem, workdir);
					if (error < 0 && error != GIT_ITEROVER)
						goto done;
531 532 533 534 535
					continue;
				}

				/* case 3 maybe - wd contains non-dir where dir expected */
				if (delta->old_file.path[strlen(wd->path)] == '/') {
536 537 538 539
					error = checkout_action_with_wd_blocker(
						action, data, delta, wd);
					advance = git_iterator_advance;
					goto done;
540
				}
541
			}
542

543
			/* case 1 - handle wd item (if it matches pathspec) */
544 545 546 547
			error = checkout_action_wd_only(data, workdir, wd, pathspec);
			if (error)
				goto done;
			if ((error = git_iterator_advance(wditem, workdir)) < 0 &&
548
				error != GIT_ITEROVER)
549
				goto done;
550 551
			continue;
		}
552

553 554
		if (cmp == 0) {
			/* case 4 */
555
			error = checkout_action_with_wd(action, data, delta, workdir, wd);
556 557
			advance = git_iterator_advance;
			goto done;
558
		}
559

560
		cmp = pfxcomp(wd->path, delta->old_file.path);
561

562
		if (cmp == 0) { /* case 5 */
563
			if (wd->path[strlen(delta->old_file.path)] != '/')
564
				return checkout_action_no_wd(action, data, delta);
565 566 567

			if (delta->status == GIT_DELTA_TYPECHANGE) {
				if (delta->old_file.mode == GIT_FILEMODE_TREE) {
568
					error = checkout_action_with_wd(action, data, delta, workdir, wd);
569 570
					advance = git_iterator_advance_into;
					goto done;
571 572 573 574 575 576
				}

				if (delta->new_file.mode == GIT_FILEMODE_TREE ||
					delta->new_file.mode == GIT_FILEMODE_COMMIT ||
					delta->old_file.mode == GIT_FILEMODE_COMMIT)
				{
577
					error = checkout_action_with_wd(action, data, delta, workdir, wd);
578 579
					advance = git_iterator_advance;
					goto done;
580
				}
581 582
			}

583
			return checkout_action_with_wd_dir(action, data, delta, workdir, wd);
584
		}
585

586
		/* case 6 - wd is after delta */
587
		return checkout_action_no_wd(action, data, delta);
588 589
	}

590 591 592 593 594 595 596 597 598
done:
	if (!error && advance != NULL &&
		(error = advance(wditem, workdir)) < 0) {
		*wditem = NULL;
		if (error == GIT_ITEROVER)
			error = 0;
	}

	return error;
599 600
}

601 602 603 604 605 606 607 608 609
static int checkout_remaining_wd_items(
	checkout_data *data,
	git_iterator *workdir,
	const git_index_entry *wd,
	git_vector *spec)
{
	int error = 0;

	while (wd && !error) {
610
		if (!(error = checkout_action_wd_only(data, workdir, wd, spec)))
611
			error = git_iterator_advance(&wd, workdir);
612 613
	}

614 615 616
	if (error == GIT_ITEROVER)
		error = 0;

617 618 619
	return error;
}

620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
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;
}

int checkout_conflictdata_empty(const git_vector *conflicts, size_t idx)
{
	checkout_conflictdata *conflict;

	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
688 689 690 691 692 693 694 695
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;
}

696 697 698 699 700
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
701 702 703
	if (conflict->submodule)
		return 0;

704
	if (conflict->ancestor) {
705
		if ((error = git_blob_lookup(&ancestor_blob, repo, &conflict->ancestor->id)) < 0)
706 707 708 709 710 711
			goto done;

		conflict->binary = git_blob_is_binary(ancestor_blob);
	}

	if (!conflict->binary && conflict->ours) {
712
		if ((error = git_blob_lookup(&our_blob, repo, &conflict->ours->id)) < 0)
713 714 715 716 717 718
			goto done;

		conflict->binary = git_blob_is_binary(our_blob);
	}

	if (!conflict->binary && conflict->theirs) {
719
		if ((error = git_blob_lookup(&their_blob, repo, &conflict->theirs->id)) < 0)
720 721 722 723 724 725 726 727 728 729 730 731 732
			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;
}

733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
static int checkout_conflicts_load(checkout_data *data, git_iterator *workdir, git_vector *pathspec)
{
	git_index_conflict_iterator *iterator = NULL;
	const git_index_entry *ancestor, *ours, *theirs;
	checkout_conflictdata *conflict;
	int error = 0;

	if ((error = git_index_conflict_iterator_new(&iterator, data->index)) < 0)
		goto done;

	data->conflicts._cmp = checkout_conflictdata_cmp;

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

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

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

Edward Thomson committed
757
		if ((error = checkout_conflict_detect_submodule(conflict)) < 0 ||
Ben Straub committed
758 759 760
		    (error = checkout_conflict_detect_binary(data->repo, conflict)) < 0)
		{
			git__free(conflict);
761
			goto done;
Ben Straub committed
762
		}
763

764 765 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 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 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 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911
		git_vector_insert(&data->conflicts, conflict);
	}

	if (error == GIT_ITEROVER)
		error = 0;

done:
	git_index_conflict_iterator_free(iterator);

	return error;
}

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;

	if (git_vector_bsearch2(&pos, &data->conflicts, checkout_conflicts_cmp_ancestor, path) < 0)
		return NULL;

	return git_vector_get(&data->conflicts, pos);
}

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

	git_vector_foreach(&data->conflicts, i, conflict) {
		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)
{
	const git_index_name_entry *name_entry;
	checkout_conflictdata *ancestor_conflict, *our_conflict, *their_conflict;
	size_t i, names;
	int error = 0;

	/* Juggle entries based on renames */
	names = git_index_name_entrycount(data->index);
Russell Belfer committed
912

913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
	for (i = 0; i < names; i++) {
		name_entry = git_index_name_get_byindex(data->index, i);

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

	git_vector_remove_matching(&data->conflicts, checkout_conflictdata_empty);

done:
	return error;
}

static int checkout_conflicts_mark_directoryfile(
	checkout_data *data)
{
	checkout_conflictdata *conflict;
	const git_index_entry *entry;
	size_t i, j, len;
	const char *path;
961
	int prefixed, error = 0;
962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989

	len = git_index_entrycount(data->index);

	/* Find d/f conflicts */
	git_vector_foreach(&data->conflicts, i, conflict) {
		if ((conflict->ours && conflict->theirs) ||
			(!conflict->ours && !conflict->theirs))
			continue;

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

		if ((error = git_index_find(&j, data->index, path)) < 0) {
			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++) {
			if ((entry = git_index_get_byindex(data->index, j)) == NULL) {
				giterr_set(GITERR_INDEX,
					"Index inconsistency, truncated index while loading expected conflict '%s'", path);
				error = -1;
				goto done;
			}

990
			prefixed = git_path_equal_or_prefixed(path, entry->path);
991

992
			if (prefixed == GIT_PATH_EQUAL)
993 994
				continue;

995
			if (prefixed == GIT_PATH_PREFIX)
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
				conflict->directoryfile = 1;

			break;
		}
	}

done:
	return error;
}

static int checkout_get_conflicts(
	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;
}

1025 1026 1027
static int checkout_get_actions(
	uint32_t **actions_ptr,
	size_t **counts_ptr,
1028 1029
	checkout_data *data,
	git_iterator *workdir)
1030
{
1031
	int error = 0, act;
1032 1033 1034 1035 1036 1037 1038
	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;

1039
	if (data->opts.paths.count > 0 &&
1040
		git_pathspec__vinit(&pathspec, &data->opts.paths, &pathpool) < 0)
1041 1042
		return -1;

1043 1044
	if ((error = git_iterator_current(&wditem, workdir)) < 0 &&
		error != GIT_ITEROVER)
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
		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) {
1058
		error = checkout_action(&act, data, delta, workdir, &wditem, &pathspec);
1059
		if (error != 0)
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
			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]++;
	}
1073

1074
	error = checkout_remaining_wd_items(data, workdir, wditem, &pathspec);
1075
	if (error)
1076
		goto fail;
1077

1078 1079 1080 1081 1082
	counts[CHECKOUT_ACTION__REMOVE] += data->removes.length;

	if (counts[CHECKOUT_ACTION__CONFLICT] > 0 &&
		(data->strategy & GIT_CHECKOUT_ALLOW_CONFLICTS) == 0)
	{
1083 1084 1085 1086
		giterr_set(GITERR_CHECKOUT, "%d %s checkout",
			(int)counts[CHECKOUT_ACTION__CONFLICT],
			counts[CHECKOUT_ACTION__CONFLICT] == 1 ?
			"conflict prevents" : "conflicts prevent");
1087
		error = GIT_EMERGECONFLICT;
1088 1089 1090
		goto fail;
	}

1091

1092
	if ((error = checkout_get_conflicts(data, workdir, &pathspec)) < 0)
1093 1094 1095 1096
		goto fail;

	counts[CHECKOUT_ACTION__UPDATE_CONFLICT] = git_vector_length(&data->conflicts);

1097
	git_pathspec__vfree(&pathspec);
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
	git_pool_clear(&pathpool);

	return 0;

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

1108
	git_pathspec__vfree(&pathspec);
1109 1110 1111 1112 1113
	git_pool_clear(&pathpool);

	return error;
}

1114
static int buffer_to_file(
1115
	struct stat *st,
1116
	git_buf *buf,
1117
	const char *path,
1118
	mode_t dir_mode,
1119 1120 1121
	int file_open_flags,
	mode_t file_mode)
{
1122
	int error;
1123

1124 1125
	if ((error = git_futils_mkpath2file(path, dir_mode)) < 0)
		return error;
1126

1127
	if ((error = git_futils_writebuffer(
1128
			buf, path, file_open_flags, file_mode)) < 0)
1129
		return error;
1130

1131 1132
	if (st != NULL && (error = p_stat(path, st)) < 0)
		giterr_set(GITERR_OS, "Error statting '%s'", path);
1133

1134
	else if (GIT_PERMS_IS_EXEC(file_mode) &&
1135
			(error = p_chmod(path, file_mode)) < 0)
1136 1137
		giterr_set(GITERR_OS, "Failed to set permissions on '%s'", path);

1138
	return error;
Ben Straub committed
1139 1140
}

1141
static int blob_content_to_file(
1142
	struct stat *st,
1143 1144
	git_blob *blob,
	const char *path,
1145
	const char * hint_path,
1146
	mode_t entry_filemode,
1147
	git_checkout_options *opts)
1148
{
1149 1150
	int error = 0;
	mode_t file_mode = opts->file_mode ? opts->file_mode : entry_filemode;
1151
	git_buf out = GIT_BUF_INIT;
1152
	git_filter_list *fl = NULL;
1153

1154 1155 1156
	if (hint_path == NULL)
		hint_path = path;

1157
	if (!opts->disable_filters)
1158
		error = git_filter_list_load(
1159
			&fl, git_blob_owner(blob), blob, hint_path, GIT_FILTER_TO_WORKTREE);
1160

1161 1162
	if (!error)
		error = git_filter_list_apply_to_blob(&out, fl, blob);
1163

1164
	git_filter_list_free(fl);
1165

1166 1167 1168
	if (!error) {
		error = buffer_to_file(
			st, &out, path, opts->dir_mode, opts->file_open_flags, file_mode);
1169

1170
		st->st_mode = entry_filemode;
1171

1172
		git_buf_free(&out);
1173
	}
1174 1175

	return error;
1176 1177
}

1178
static int blob_content_to_link(
1179 1180 1181 1182 1183
	struct stat *st,
	git_blob *blob,
	const char *path,
	mode_t dir_mode,
	int can_symlink)
1184 1185 1186
{
	git_buf linktarget = GIT_BUF_INIT;
	int error;
1187

1188
	if ((error = git_futils_mkpath2file(path, dir_mode)) < 0)
Linquize committed
1189
		return error;
1190

1191 1192
	if ((error = git_blob__getbuf(&linktarget, blob)) < 0)
		return error;
1193

1194 1195
	if (can_symlink) {
		if ((error = p_symlink(git_buf_cstr(&linktarget), path)) < 0)
1196
			giterr_set(GITERR_OS, "Could not create symlink %s\n", path);
1197
	} else {
1198
		error = git_futils_fake_symlink(git_buf_cstr(&linktarget), path);
1199 1200 1201 1202 1203 1204 1205 1206
	}

	if (!error) {
		if ((error = p_lstat(path, st)) < 0)
			giterr_set(GITERR_CHECKOUT, "Could not stat symlink %s", path);

		st->st_mode = GIT_FILEMODE_LINK;
	}
1207

1208 1209 1210
	git_buf_free(&linktarget);

	return error;
1211 1212
}

1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224
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 */
1225
	git_index_entry__init_from_stat(&entry, st, true);
1226
	git_oid_cpy(&entry.id, &file->id);
1227 1228 1229 1230

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

1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255
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;

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

1256
static int checkout_submodule(
1257
	checkout_data *data,
1258 1259
	const git_diff_file *file)
{
1260
	int error = 0;
1261
	git_submodule *sm;
1262

1263
	/* Until submodules are supported, UPDATE_ONLY means do nothing here */
1264
	if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0)
1265 1266
		return 0;

1267
	if ((error = git_futils_mkdir(
1268
			file->path, data->opts.target_directory,
1269 1270
			data->opts.dir_mode, GIT_MKDIR_PATH)) < 0)
		return error;
1271

1272 1273 1274 1275 1276 1277 1278 1279 1280
	if ((error = git_submodule_lookup(&sm, data->repo, file->path)) < 0) {
		/* 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);
		}

1281
		return error;
1282
	}
1283

1284
	/* TODO: Support checkout_strategy options.  Two circumstances:
1285 1286 1287 1288
	 * 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
	 *
1289 1290
	 * Checkout will not execute a pull on the submodule, but a clone
	 * command should probably be able to.  Do we need a submodule callback?
1291 1292
	 */

1293
	return checkout_submodule_update_index(data, file);
1294 1295
}

1296
static void report_progress(
1297
	checkout_data *data,
1298
	const char *path)
1299
{
1300 1301
	if (data->opts.progress_cb)
		data->opts.progress_cb(
1302
			path, data->completed_steps, data->total_steps,
1303
			data->opts.progress_payload);
1304 1305
}

1306
static int checkout_safe_for_update_only(const char *path, mode_t expected_mode)
1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
{
	struct stat st;

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

1327
static int checkout_write_content(
1328
	checkout_data *data,
1329 1330 1331 1332 1333
	const git_oid *oid,
	const char *full_path,
	const char *hint_path,
	unsigned int mode,
	struct stat *st)
1334
{
1335
	int error = 0;
1336
	git_blob *blob;
1337

1338
	if ((error = git_blob_lookup(&blob, data->repo, oid)) < 0)
1339 1340
		return error;

1341
	if (S_ISLNK(mode))
1342
		error = blob_content_to_link(
1343
			st, blob, full_path, data->opts.dir_mode, data->can_symlink);
1344
	else
1345
		error = blob_content_to_file(
1346
			st, blob, full_path, hint_path, mode, &data->opts);
1347 1348 1349

	git_blob_free(blob);

1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360
	/* 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;
	}

1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375
	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) {
1376
		int rval = checkout_safe_for_update_only(
1377 1378 1379 1380 1381
			git_buf_cstr(&data->path), file->mode);
		if (rval <= 0)
			return rval;
	}

1382
	error = checkout_write_content(
1383
		data, &file->id, git_buf_cstr(&data->path), NULL, file->mode, &st);
1384

1385 1386 1387 1388
	/* update the index unless prevented */
	if (!error && (data->strategy & GIT_CHECKOUT_DONT_UPDATE_INDEX) == 0)
		error = checkout_update_index(data, file, &st);

1389 1390 1391 1392
	/* update the submodule data if this was a new .gitmodules file */
	if (!error && strcmp(file->path, ".gitmodules") == 0)
		data->reload_submodules = true;

1393 1394 1395
	return error;
}

1396 1397
static int checkout_remove_the_old(
	unsigned int *actions,
1398
	checkout_data *data)
1399
{
1400
	int error = 0;
1401
	git_diff_delta *delta;
1402
	const char *str;
1403
	size_t i;
1404 1405 1406
	const char *workdir = git_buf_cstr(&data->path);
	uint32_t flg = GIT_RMDIR_EMPTY_PARENTS |
		GIT_RMDIR_REMOVE_FILES | GIT_RMDIR_REMOVE_BLOCKERS;
1407

1408 1409 1410
	if (data->opts.checkout_strategy & GIT_CHECKOUT_SKIP_LOCKED_DIRECTORIES)
		flg |= GIT_RMDIR_SKIP_NONEMPTY;

1411
	git_buf_truncate(&data->path, data->workdir_len);
1412

1413
	git_vector_foreach(&data->diff->deltas, i, delta) {
1414
		if (actions[i] & CHECKOUT_ACTION__REMOVE) {
1415
			error = git_futils_rmdir_r(delta->old_file.path, workdir, flg);
1416
			if (error < 0)
1417 1418 1419
				return error;

			data->completed_steps++;
1420
			report_progress(data, delta->old_file.path);
1421 1422 1423 1424 1425 1426 1427

			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);
			}
1428 1429 1430
		}
	}

1431 1432 1433 1434 1435 1436
	git_vector_foreach(&data->removes, i, str) {
		error = git_futils_rmdir_r(str, workdir, flg);
		if (error < 0)
			return error;

		data->completed_steps++;
1437
		report_progress(data, str);
1438 1439 1440 1441

		if ((data->strategy & GIT_CHECKOUT_DONT_UPDATE_INDEX) == 0 &&
			data->index != NULL)
		{
1442 1443 1444 1445
			if (str[strlen(str) - 1] == '/')
				(void)git_index_remove_directory(data->index, str, 0);
			else
				(void)git_index_remove(data->index, str, 0);
1446
		}
1447 1448 1449 1450 1451 1452 1453 1454 1455
	}

	return 0;
}

static int checkout_deferred_remove(git_repository *repo, const char *path)
{
#if 0
	int error = git_futils_rmdir_r(
1456
		path, data->opts.target_directory, GIT_RMDIR_EMPTY_PARENTS);
1457 1458 1459 1460 1461 1462 1463 1464 1465 1466

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

	return error;
#else
	GIT_UNUSED(repo);
	GIT_UNUSED(path);
1467
	assert(false);
1468
	return 0;
1469
#endif
1470 1471 1472 1473
}

static int checkout_create_the_new(
	unsigned int *actions,
1474
	checkout_data *data)
1475
{
1476
	int error = 0;
1477 1478 1479
	git_diff_delta *delta;
	size_t i;

1480
	git_vector_foreach(&data->diff->deltas, i, delta) {
1481 1482 1483 1484 1485 1486 1487 1488 1489
		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;
		}

1490
		if (actions[i] & CHECKOUT_ACTION__UPDATE_BLOB) {
1491
			error = checkout_blob(data, &delta->new_file);
1492
			if (error < 0)
1493 1494 1495
				return error;

			data->completed_steps++;
1496
			report_progress(data, delta->new_file.path);
1497 1498 1499 1500 1501 1502 1503 1504
		}
	}

	return 0;
}

static int checkout_create_submodules(
	unsigned int *actions,
1505
	checkout_data *data)
1506
{
1507
	int error = 0;
1508 1509 1510
	git_diff_delta *delta;
	size_t i;

1511 1512 1513 1514 1515
	/* initial reload of submodules if .gitmodules was changed */
	if (data->reload_submodules &&
		(error = git_submodule_reload_all(data->repo)) < 0)
		return error;

1516
	git_vector_foreach(&data->diff->deltas, i, delta) {
1517 1518 1519 1520 1521 1522 1523 1524 1525
		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;
		}

1526
		if (actions[i] & CHECKOUT_ACTION__UPDATE_SUBMODULE) {
1527
			int error = checkout_submodule(data, &delta->new_file);
1528 1529 1530 1531
			if (error < 0)
				return error;

			data->completed_steps++;
1532
			report_progress(data, delta->new_file.path);
1533 1534 1535
		}
	}

1536 1537
	/* final reload once submodules have been updated */
	return git_submodule_reload_all(data->repo);
1538 1539
}

1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554
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;
}

1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631

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 &&
1632
		(error = checkout_safe_for_update_only(git_buf_cstr(&data->path), side->mode)) <= 0)
1633 1634
		return error;

1635
	return checkout_write_content(data,
1636
		&side->id, git_buf_cstr(&data->path), hint_path, side->mode, &st);
1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683
}

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,
		path_suffixed = GIT_BUF_INIT, path_workdir = GIT_BUF_INIT;
1684 1685
	git_merge_file_options opts = GIT_MERGE_FILE_OPTIONS_INIT;
	git_merge_file_result result = {0};
1686 1687 1688
	git_filebuf output = GIT_FILEBUF_INIT;
	int error = 0;

1689
	if (data->opts.checkout_strategy & GIT_CHECKOUT_CONFLICT_STYLE_DIFF3)
1690
		opts.flags |= GIT_MERGE_FILE_STYLE_DIFF3;
1691

1692 1693 1694 1695 1696 1697
	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";
1698 1699 1700 1701 1702 1703 1704 1705

	/* 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(
1706
			&our_label, opts.our_label, conflict->ours->path)) < 0 ||
1707
			(error = conflict_entry_name(
1708
			&their_label, opts.their_label, conflict->theirs->path)) < 0)
1709 1710
			goto done;

1711 1712
		opts.our_label = git_buf_cstr(&our_label);
		opts.their_label = git_buf_cstr(&their_label);
1713 1714
	}

1715 1716
	if ((error = git_merge_file_from_index(&result, data->repo,
		conflict->ancestor, conflict->ours, conflict->theirs, &opts)) < 0)
1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728
		goto done;

	if (result.path == NULL || result.mode == 0) {
		giterr_set(GITERR_CHECKOUT, "Could not merge contents of file");
		error = GIT_EMERGECONFLICT;
		goto done;
	}

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

	if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0 &&
1729
		(error = checkout_safe_for_update_only(git_buf_cstr(&path_workdir), result.mode)) <= 0)
1730 1731 1732
		goto done;

	if ((error = git_futils_mkpath2file(path_workdir.ptr, 0755)) < 0 ||
1733
		(error = git_filebuf_open(&output, path_workdir.ptr, GIT_FILEBUF_DO_NOT_BUFFER, result.mode)) < 0 ||
1734
		(error = git_filebuf_write(&output, result.ptr, result.len)) < 0 ||
1735
		(error = git_filebuf_commit(&output)) < 0)
1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755
		goto done;

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

static int checkout_create_conflicts(checkout_data *data)
{
	checkout_conflictdata *conflict;
	size_t i;
	int error = 0;

	git_vector_foreach(&data->conflicts, i, conflict) {
1756

1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799
		/* 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
1800 1801 1802 1803
		/* If any side is a gitlink, do nothing. */
		else if (conflict->submodule)
			error = 0;

1804 1805 1806 1807 1808
		/* If any side is binary, write the ours side */
		else if (conflict->binary)
			error = checkout_write_entry(data, conflict, conflict->ours);

		else if (!error)
1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823
			error = checkout_write_merge(data, conflict);

		if (error)
			break;

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

	return error;
}


1824 1825 1826 1827 1828 1829 1830 1831 1832 1833
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);

1834
	git_vector_free_deep(&data->conflicts);
1835

1836 1837 1838 1839
	git__free(data->pfx);
	data->pfx = NULL;

	git_buf_free(&data->path);
1840 1841 1842

	git_index_free(data->index);
	data->index = NULL;
1843 1844 1845 1846
}

static int checkout_data_init(
	checkout_data *data,
1847
	git_iterator *target,
1848
	const git_checkout_options *proposed)
1849
{
1850
	int error = 0;
1851
	git_repository *repo = git_iterator_owner(target);
1852

1853 1854 1855 1856
	memset(data, 0, sizeof(*data));

	if (!repo) {
		giterr_set(GITERR_CHECKOUT, "Cannot checkout nothing");
1857
		return -1;
1858
	}
1859

1860 1861
	if ((!proposed || !proposed->target_directory) &&
		(error = git_repository__ensure_not_bare(repo, "checkout")) < 0)
1862
		return error;
1863

1864 1865 1866
	data->repo = repo;

	GITERR_CHECK_VERSION(
1867
		proposed, GIT_CHECKOUT_OPTIONS_VERSION, "git_checkout_options");
1868 1869

	if (!proposed)
1870
		GIT_INIT_STRUCTURE(&data->opts, GIT_CHECKOUT_OPTIONS_VERSION);
1871
	else
1872
		memmove(&data->opts, proposed, sizeof(git_checkout_options));
1873

1874 1875 1876 1877 1878 1879 1880
	if (!data->opts.target_directory)
		data->opts.target_directory = git_repository_workdir(repo);
	else if (!git_path_isdir(data->opts.target_directory) &&
			 (error = git_futils_mkdir(data->opts.target_directory, NULL,
					GIT_DIR_MODE, GIT_MKDIR_VERIFY_DIR)) < 0)
		goto cleanup;

1881 1882
	/* refresh config and index content unless NO_REFRESH is given */
	if ((data->opts.checkout_strategy & GIT_CHECKOUT_NO_REFRESH) == 0) {
1883 1884 1885 1886
		git_config *cfg;

		if ((error = git_repository_config__weakptr(&cfg, repo)) < 0 ||
			(error = git_config_refresh(cfg)) < 0)
1887 1888
			goto cleanup;

1889 1890 1891 1892
		/* if we are checking out the index, don't reload,
		 * otherwise get index and force reload
		 */
		if ((data->index = git_iterator_get_index(target)) != NULL) {
1893 1894 1895 1896
			GIT_REFCOUNT_INC(data->index);
		} else {
			/* otherwise, grab and reload the index */
			if ((error = git_repository_index(&data->index, data->repo)) < 0 ||
1897
				(error = git_index_read(data->index, true)) < 0)
1898
				goto cleanup;
1899

1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910
			/* cannot checkout if unresolved conflicts exist */
			if ((data->opts.checkout_strategy & GIT_CHECKOUT_FORCE) == 0 &&
				git_index_has_conflicts(data->index)) {
				error = GIT_EMERGECONFLICT;
				giterr_set(GITERR_CHECKOUT,
					"unresolved conflicts exist in the index");
				goto cleanup;
			}

			/* clean conflict data when doing a tree or commit checkout */
			git_index_name_clear(data->index);
Edward Thomson committed
1911
			git_index_reuc_clear(data->index);
1912 1913
		}
	}
1914

1915
	/* if you are forcing, definitely allow safe updates */
1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932
	if ((data->opts.checkout_strategy & GIT_CHECKOUT_FORCE) != 0)
		data->opts.checkout_strategy |= GIT_CHECKOUT_SAFE_CREATE;
	if ((data->opts.checkout_strategy & GIT_CHECKOUT_SAFE_CREATE) != 0)
		data->opts.checkout_strategy |= GIT_CHECKOUT_SAFE;

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

1933 1934 1935
	if ((error = git_repository__cvar(
			 &data->can_symlink, repo, GIT_CVAR_SYMLINKS)) < 0)
		goto cleanup;
1936

1937 1938
	if (!data->opts.baseline) {
		data->opts_free_baseline = true;
1939

1940 1941
		error = checkout_lookup_head_tree(&data->opts.baseline, repo);

1942
		if (error == GIT_EUNBORNBRANCH) {
1943 1944 1945 1946 1947
			error = 0;
			giterr_clear();
		}

		if (error < 0)
1948 1949 1950
			goto cleanup;
	}

1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973
	if ((data->opts.checkout_strategy &
		(GIT_CHECKOUT_CONFLICT_STYLE_MERGE | GIT_CHECKOUT_CONFLICT_STYLE_DIFF3)) == 0) {
		const char *conflict_style;
		git_config *cfg = NULL;

		if ((error = git_repository_config__weakptr(&cfg, repo)) < 0 ||
			(error = git_config_get_string(&conflict_style, cfg, "merge.conflictstyle")) < 0 ||
			error == GIT_ENOTFOUND)
			;
		else if (error)
			goto cleanup;
		else if (strcmp(conflict_style, "merge") == 0)
			data->opts.checkout_strategy |= GIT_CHECKOUT_CONFLICT_STYLE_MERGE;
		else if (strcmp(conflict_style, "diff3") == 0)
			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;
			goto cleanup;
		}
	}

1974
	if ((error = git_vector_init(&data->removes, 0, git__strcmp_cb)) < 0 ||
1975
		(error = git_vector_init(&data->conflicts, 0, NULL)) < 0 ||
1976
		(error = git_pool_init(&data->pool, 1, 0)) < 0 ||
1977 1978
		(error = git_buf_puts(&data->path, data->opts.target_directory)) < 0 ||
		(error = git_path_to_dir(&data->path)) < 0)
1979 1980 1981 1982 1983 1984 1985
		goto cleanup;

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

cleanup:
	if (error < 0)
		checkout_data_clear(data);
1986 1987 1988 1989

	return error;
}

1990 1991
int git_checkout_iterator(
	git_iterator *target,
1992
	const git_checkout_options *opts)
1993 1994
{
	int error = 0;
1995 1996
	git_iterator *baseline = NULL, *workdir = NULL;
	checkout_data data = {0};
1997
	git_diff_options diff_opts = GIT_DIFF_OPTIONS_INIT;
1998 1999
	uint32_t *actions = NULL;
	size_t *counts = NULL;
2000
	git_iterator_flag_t iterflags = 0;
2001

2002
	/* initialize structures and options */
2003
	error = checkout_data_init(&data, target, opts);
2004 2005
	if (error < 0)
		return error;
Ben Straub committed
2006

2007 2008 2009 2010 2011 2012 2013 2014
	diff_opts.flags =
		GIT_DIFF_INCLUDE_UNMODIFIED |
		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 |
		GIT_DIFF_SKIP_BINARY_CHECK;
2015 2016
	if (data.opts.checkout_strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH)
		diff_opts.flags |= GIT_DIFF_DISABLE_PATHSPEC_MATCH;
2017 2018 2019 2020
	if (data.opts.paths.count > 0)
		diff_opts.pathspec = data.opts.paths;

	/* set up iterators */
2021 2022 2023 2024

	iterflags = git_iterator_ignore_case(target) ?
		GIT_ITERATOR_IGNORE_CASE : GIT_ITERATOR_DONT_IGNORE_CASE;

2025
	if ((error = git_iterator_reset(target, data.pfx, data.pfx)) < 0 ||
2026 2027 2028
		(error = git_iterator_for_workdir_ext(
			&workdir, data.repo, data.opts.target_directory,
			iterflags | GIT_ITERATOR_DONT_AUTOEXPAND,
2029
			data.pfx, data.pfx)) < 0 ||
2030
		(error = git_iterator_for_tree(
2031 2032
			&baseline, data.opts.baseline,
			iterflags, data.pfx, data.pfx)) < 0)
2033 2034
		goto cleanup;

2035 2036
	/* Should not have case insensitivity mismatch */
	assert(git_iterator_ignore_case(workdir) == git_iterator_ignore_case(baseline));
2037

2038 2039
	/* Generate baseline-to-target diff which will include an entry for
	 * every possible update that might need to be made.
2040 2041
	 */
	if ((error = git_diff__from_iterators(
2042
			&data.diff, data.repo, baseline, target, &diff_opts)) < 0)
2043 2044
		goto cleanup;

2045
	/* Loop through diff (and working directory iterator) building a list of
2046 2047
	 * actions to be taken, plus look for conflicts and send notifications,
	 * then loop through conflicts.
2048
	 */
2049
	if ((error = checkout_get_actions(&actions, &counts, &data, workdir)) != 0)
2050 2051
		goto cleanup;

2052
	data.total_steps = counts[CHECKOUT_ACTION__REMOVE] +
2053
		counts[CHECKOUT_ACTION__UPDATE_BLOB] +
2054 2055
		counts[CHECKOUT_ACTION__UPDATE_SUBMODULE] +
		counts[CHECKOUT_ACTION__UPDATE_CONFLICT];
2056

2057
	report_progress(&data, NULL); /* establish 0 baseline */
2058

2059 2060 2061
	/* To deal with some order dependencies, perform remaining checkout
	 * in three passes: removes, then update blobs, then update submodules.
	 */
2062
	if (counts[CHECKOUT_ACTION__REMOVE] > 0 &&
2063
		(error = checkout_remove_the_old(actions, &data)) < 0)
2064 2065
		goto cleanup;

2066
	if (counts[CHECKOUT_ACTION__UPDATE_BLOB] > 0 &&
2067
		(error = checkout_create_the_new(actions, &data)) < 0)
2068 2069
		goto cleanup;

2070
	if (counts[CHECKOUT_ACTION__UPDATE_SUBMODULE] > 0 &&
2071
		(error = checkout_create_submodules(actions, &data)) < 0)
2072 2073
		goto cleanup;

2074
	if (counts[CHECKOUT_ACTION__UPDATE_CONFLICT] > 0 &&
2075
		(error = checkout_create_conflicts(&data)) < 0)
2076
		goto cleanup;
2077

2078
	assert(data.completed_steps == data.total_steps);
2079

2080
cleanup:
2081 2082 2083 2084
	if (!error && data.index != NULL &&
		(data.strategy & GIT_CHECKOUT_DONT_UPDATE_INDEX) == 0)
		error = git_index_write(data.index);

2085
	git_diff_free(data.diff);
2086
	git_iterator_free(workdir);
2087
	git_iterator_free(baseline);
2088 2089
	git__free(actions);
	git__free(counts);
2090
	checkout_data_clear(&data);
2091 2092 2093 2094 2095 2096 2097

	return error;
}

int git_checkout_index(
	git_repository *repo,
	git_index *index,
2098
	const git_checkout_options *opts)
2099 2100
{
	int error;
2101
	git_iterator *index_i;
2102

2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115
	if (!index && !repo) {
		giterr_set(GITERR_CHECKOUT,
			"Must provide either repository or index to checkout");
		return -1;
	}
	if (index && repo && git_index_owner(index) != repo) {
		giterr_set(GITERR_CHECKOUT,
			"Index to checkout does not match repository");
		return -1;
	}

	if (!repo)
		repo = git_index_owner(index);
2116 2117 2118

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

2121
	if (!(error = git_iterator_for_index(&index_i, index, 0, NULL, NULL)))
2122
		error = git_checkout_iterator(index_i, opts);
2123 2124

	git_iterator_free(index_i);
2125
	git_index_free(index);
2126

2127 2128 2129 2130 2131
	return error;
}

int git_checkout_tree(
	git_repository *repo,
Vicent Marti committed
2132
	const git_object *treeish,
2133
	const git_checkout_options *opts)
2134
{
2135
	int error;
2136 2137
	git_tree *tree = NULL;
	git_iterator *tree_i = NULL;
2138

2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151
	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);
2152

2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167
	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;
		}
2168 2169
	}

2170
	if (!(error = git_iterator_for_tree(&tree_i, tree, 0, NULL, NULL)))
2171
		error = git_checkout_iterator(tree_i, opts);
2172

2173
	git_iterator_free(tree_i);
2174
	git_tree_free(tree);
2175

2176
	return error;
2177 2178
}

2179 2180
int git_checkout_head(
	git_repository *repo,
2181
	const git_checkout_options *opts)
2182
{
2183
	assert(repo);
2184
	return git_checkout_tree(repo, NULL, opts);
2185
}
2186

2187
int git_checkout_init_opts(git_checkout_options* opts, int version)
2188
{
2189 2190
	if (version != GIT_CHECKOUT_OPTIONS_VERSION) {
		giterr_set(GITERR_INVALID, "Invalid version %d for git_checkout_options", version);
2191 2192
		return -1;
	} else {
2193
		git_checkout_options o = GIT_CHECKOUT_OPTIONS_INIT;
2194 2195 2196 2197
		memcpy(opts, &o, sizeof(o));
		return 0;
	}
}