stash.c 13.6 KB
Newer Older
nulltoken committed
1
/*
Edward Thomson committed
2
 * Copyright (C) the libgit2 contributors. All rights reserved.
nulltoken committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16
 *
 * 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 "common.h"
#include "repository.h"
#include "commit.h"
#include "tree.h"
#include "reflog.h"
#include "git2/diff.h"
#include "git2/stash.h"
#include "git2/status.h"
#include "git2/checkout.h"
17
#include "git2/index.h"
Ben Straub committed
18
#include "signature.h"
nulltoken committed
19 20 21 22 23 24 25 26 27 28 29

static int create_error(int error, const char *msg)
{
	giterr_set(GITERR_STASH, "Cannot stash changes - %s", msg);
	return error;
}

static int retrieve_head(git_reference **out, git_repository *repo)
{
	int error = git_repository_head(out, repo);

30
	if (error == GIT_EUNBORNBRANCH)
nulltoken committed
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
		return create_error(error, "You do not have the initial commit yet.");

	return error;
}

static int append_abbreviated_oid(git_buf *out, const git_oid *b_commit)
{
	char *formatted_oid;

	formatted_oid = git_oid_allocfmt(b_commit);
	GITERR_CHECK_ALLOC(formatted_oid);

	git_buf_put(out, formatted_oid, 7);
	git__free(formatted_oid);

	return git_buf_oom(out) ? -1 : 0;
}

static int append_commit_description(git_buf *out, git_commit* commit)
{
	const char *message;
52
	size_t pos = 0, len;
nulltoken committed
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84

	if (append_abbreviated_oid(out, git_commit_id(commit)) < 0)
		return -1;

	message = git_commit_message(commit);
	len = strlen(message);

	/* TODO: Replace with proper commit short message
	 * when git_commit_message_short() is implemented.
	 */
	while (pos < len && message[pos] != '\n')
		pos++;

	git_buf_putc(out, ' ');
	git_buf_put(out, message, pos);
	git_buf_putc(out, '\n');

	return git_buf_oom(out) ? -1 : 0;
}

static int retrieve_base_commit_and_message(
	git_commit **b_commit,
	git_buf *stash_message,
	git_repository *repo)
{
	git_reference *head = NULL;
	int error;

	if ((error = retrieve_head(&head, repo)) < 0)
		return error;

	if (strcmp("HEAD", git_reference_name(head)) == 0)
85
		error = git_buf_puts(stash_message, "(no branch): ");
nulltoken committed
86
	else
87
		error = git_buf_printf(
nulltoken committed
88 89 90
			stash_message,
			"%s: ",
			git_reference_name(head) + strlen(GIT_REFS_HEADS_DIR));
91
	if (error < 0)
nulltoken committed
92 93
		goto cleanup;

94 95
	if ((error = git_commit_lookup(
			 b_commit, repo, git_reference_target(head))) < 0)
nulltoken committed
96 97
		goto cleanup;

98 99
	if ((error = append_commit_description(stash_message, *b_commit)) < 0)
		goto cleanup;
nulltoken committed
100 101 102 103 104 105 106 107

cleanup:
	git_reference_free(head);
	return error;
}

static int build_tree_from_index(git_tree **out, git_index *index)
{
108
	int error;
nulltoken committed
109 110
	git_oid i_tree_oid;

111
	if ((error = git_index_write_tree(&i_tree_oid, index)) < 0)
nulltoken committed
112 113 114 115 116 117 118 119
		return -1;

	return git_tree_lookup(out, git_index_owner(index), &i_tree_oid);
}

static int commit_index(
	git_commit **i_commit,
	git_index *index,
120
	const git_signature *stasher,
nulltoken committed
121 122 123 124 125 126
	const char *message,
	const git_commit *parent)
{
	git_tree *i_tree = NULL;
	git_oid i_commit_oid;
	git_buf msg = GIT_BUF_INIT;
127
	int error;
nulltoken committed
128

129
	if ((error = build_tree_from_index(&i_tree, index)) < 0)
nulltoken committed
130 131
		goto cleanup;

132
	if ((error = git_buf_printf(&msg, "index on %s\n", message)) < 0)
nulltoken committed
133 134
		goto cleanup;

135
	if ((error = git_commit_create(
nulltoken committed
136 137 138 139 140 141 142 143 144
		&i_commit_oid,
		git_index_owner(index),
		NULL,
		stasher,
		stasher,
		NULL,
		git_buf_cstr(&msg),
		i_tree,
		1,
145 146
		&parent)) < 0)
		goto cleanup;
nulltoken committed
147 148 149 150 151 152 153 154 155

	error = git_commit_lookup(i_commit, git_index_owner(index), &i_commit_oid);

cleanup:
	git_tree_free(i_tree);
	git_buf_free(&msg);
	return error;
}

Russell Belfer committed
156
struct stash_update_rules {
nulltoken committed
157 158 159 160 161
	bool include_changed;
	bool include_untracked;
	bool include_ignored;
};

Russell Belfer committed
162 163 164 165
static int stash_update_index_from_diff(
	git_index *index,
	const git_diff *diff,
	struct stash_update_rules *data)
nulltoken committed
166
{
Russell Belfer committed
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
	int error = 0;
	size_t d, max_d = git_diff_num_deltas(diff);

	for (d = 0; !error && d < max_d; ++d) {
		const char *add_path = NULL;
		const git_diff_delta *delta = git_diff_get_delta(diff, d);

		switch (delta->status) {
		case GIT_DELTA_IGNORED:
			if (data->include_ignored)
				add_path = delta->new_file.path;
			break;

		case GIT_DELTA_UNTRACKED:
			if (data->include_untracked)
				add_path = delta->new_file.path;
nulltoken committed
183 184
			break;

Russell Belfer committed
185 186 187 188 189
		case GIT_DELTA_ADDED:
		case GIT_DELTA_MODIFIED:
			if (data->include_changed)
				add_path = delta->new_file.path;
			break;
190

Russell Belfer committed
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
		case GIT_DELTA_DELETED:
			if (data->include_changed &&
				!git_index_find(NULL, index, delta->old_file.path))
				error = git_index_remove(index, delta->old_file.path, 0);
			break;

		default:
			/* Unimplemented */
			giterr_set(
				GITERR_INVALID,
				"Cannot update index. Unimplemented status (%d)",
				delta->status);
			return -1;
		}

		if (add_path != NULL)
			error = git_index_add_bypath(index, add_path);
	}

	return error;
nulltoken committed
211 212 213 214 215 216 217 218 219
}

static int build_untracked_tree(
	git_tree **tree_out,
	git_index *index,
	git_commit *i_commit,
	uint32_t flags)
{
	git_tree *i_tree = NULL;
220
	git_diff *diff = NULL;
221
	git_diff_options opts = GIT_DIFF_OPTIONS_INIT;
Russell Belfer committed
222
	struct stash_update_rules data = {0};
223
	int error;
nulltoken committed
224 225 226 227

	git_index_clear(index);

	if (flags & GIT_STASH_INCLUDE_UNTRACKED) {
228 229
		opts.flags |= GIT_DIFF_INCLUDE_UNTRACKED |
			GIT_DIFF_RECURSE_UNTRACKED_DIRS;
nulltoken committed
230 231 232 233 234 235 236 237
		data.include_untracked = true;
	}

	if (flags & GIT_STASH_INCLUDE_IGNORED) {
		opts.flags |= GIT_DIFF_INCLUDE_IGNORED;
		data.include_ignored = true;
	}

238
	if ((error = git_commit_tree(&i_tree, i_commit)) < 0)
nulltoken committed
239 240
		goto cleanup;

241 242
	if ((error = git_diff_tree_to_workdir(
			&diff, git_index_owner(index), i_tree, &opts)) < 0)
nulltoken committed
243 244
		goto cleanup;

Russell Belfer committed
245
	if ((error = stash_update_index_from_diff(index, diff, &data)) < 0)
nulltoken committed
246 247
		goto cleanup;

248
	error = build_tree_from_index(tree_out, index);
nulltoken committed
249 250

cleanup:
251
	git_diff_free(diff);
nulltoken committed
252 253 254 255 256 257 258
	git_tree_free(i_tree);
	return error;
}

static int commit_untracked(
	git_commit **u_commit,
	git_index *index,
259
	const git_signature *stasher,
nulltoken committed
260 261 262 263 264 265 266
	const char *message,
	git_commit *i_commit,
	uint32_t flags)
{
	git_tree *u_tree = NULL;
	git_oid u_commit_oid;
	git_buf msg = GIT_BUF_INIT;
267
	int error;
nulltoken committed
268

269
	if ((error = build_untracked_tree(&u_tree, index, i_commit, flags)) < 0)
nulltoken committed
270 271
		goto cleanup;

272
	if ((error = git_buf_printf(&msg, "untracked files on %s\n", message)) < 0)
nulltoken committed
273 274
		goto cleanup;

275
	if ((error = git_commit_create(
nulltoken committed
276 277 278 279 280 281 282 283 284
		&u_commit_oid,
		git_index_owner(index),
		NULL,
		stasher,
		stasher,
		NULL,
		git_buf_cstr(&msg),
		u_tree,
		0,
285 286
		NULL)) < 0)
		goto cleanup;
nulltoken committed
287 288 289 290 291 292 293 294 295 296 297 298 299 300

	error = git_commit_lookup(u_commit, git_index_owner(index), &u_commit_oid);

cleanup:
	git_tree_free(u_tree);
	git_buf_free(&msg);
	return error;
}

static int build_workdir_tree(
	git_tree **tree_out,
	git_index *index,
	git_commit *b_commit)
{
301
	git_repository *repo = git_index_owner(index);
nulltoken committed
302
	git_tree *b_tree = NULL;
Russell Belfer committed
303
	git_diff *diff = NULL;
304
	git_diff_options opts = GIT_DIFF_OPTIONS_INIT;
Russell Belfer committed
305
	struct stash_update_rules data = {0};
306
	int error;
nulltoken committed
307

308 309
	opts.flags = GIT_DIFF_IGNORE_SUBMODULES;

310
	if ((error = git_commit_tree(&b_tree, b_commit)) < 0)
nulltoken committed
311 312
		goto cleanup;

Russell Belfer committed
313 314
	if ((error = git_diff_tree_to_workdir_with_index(
			&diff, repo, b_tree, &opts)) < 0)
nulltoken committed
315 316 317 318
		goto cleanup;

	data.include_changed = true;

Russell Belfer committed
319
	if ((error = stash_update_index_from_diff(index, diff, &data)) < 0)
nulltoken committed
320 321
		goto cleanup;

Russell Belfer committed
322
	error = build_tree_from_index(tree_out, index);
nulltoken committed
323 324

cleanup:
325
	git_diff_free(diff);
nulltoken committed
326
	git_tree_free(b_tree);
327

nulltoken committed
328 329 330 331 332 333
	return error;
}

static int commit_worktree(
	git_oid *w_commit_oid,
	git_index *index,
334
	const git_signature *stasher,
nulltoken committed
335 336 337 338 339
	const char *message,
	git_commit *i_commit,
	git_commit *b_commit,
	git_commit *u_commit)
{
340
	int error = 0;
nulltoken committed
341 342 343 344 345 346 347
	git_tree *w_tree = NULL, *i_tree = NULL;
	const git_commit *parents[] = {	NULL, NULL,	NULL };

	parents[0] = b_commit;
	parents[1] = i_commit;
	parents[2] = u_commit;

348 349
	if ((error = git_commit_tree(&i_tree, i_commit)) < 0)
		goto cleanup;
nulltoken committed
350

351
	if ((error = git_index_read_tree(index, i_tree)) < 0)
nulltoken committed
352 353
		goto cleanup;

354
	if ((error = build_workdir_tree(&w_tree, index, b_commit)) < 0)
nulltoken committed
355 356
		goto cleanup;

357
	error = git_commit_create(
nulltoken committed
358 359 360 361 362 363 364 365
		w_commit_oid,
		git_index_owner(index),
		NULL,
		stasher,
		stasher,
		NULL,
		message,
		w_tree,
366 367
		u_commit ? 3 : 2,
		parents);
nulltoken committed
368 369 370 371 372 373 374 375 376 377 378 379

cleanup:
	git_tree_free(i_tree);
	git_tree_free(w_tree);
	return error;
}

static int prepare_worktree_commit_message(
	git_buf* msg,
	const char *user_message)
{
	git_buf buf = GIT_BUF_INIT;
380 381
	int error;

382 383
	if ((error = git_buf_set(&buf, git_buf_cstr(msg), git_buf_len(msg))) < 0)
		return error;
nulltoken committed
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399

	git_buf_clear(msg);

	if (!user_message)
		git_buf_printf(msg, "WIP on %s", git_buf_cstr(&buf));
	else {
		const char *colon;

		if ((colon = strchr(git_buf_cstr(&buf), ':')) == NULL)
			goto cleanup;

		git_buf_puts(msg, "On ");
		git_buf_put(msg, git_buf_cstr(&buf), colon - buf.ptr);
		git_buf_printf(msg, ": %s\n", user_message);
	}

400
	error = (git_buf_oom(msg) || git_buf_oom(&buf)) ? -1 : 0;
nulltoken committed
401 402 403

cleanup:
	git_buf_free(&buf);
404

nulltoken committed
405 406 407 408 409 410
	return error;
}

static int update_reflog(
	git_oid *w_commit_oid,
	git_repository *repo,
411
	const git_signature *stasher,
nulltoken committed
412 413
	const char *message)
{
414
	git_reference *stash;
nulltoken committed
415 416
	int error;

417 418
	if ((error = git_reference_ensure_log(repo, GIT_REFS_STASH_FILE)) < 0)
		return error;
nulltoken committed
419

420
	error = git_reference_create(&stash, repo, GIT_REFS_STASH_FILE, w_commit_oid, 1, stasher, message);
nulltoken committed
421

422
	git_reference_free(stash);
nulltoken committed
423 424 425 426 427 428 429 430 431 432

	return error;
}

static int is_dirty_cb(const char *path, unsigned int status, void *payload)
{
	GIT_UNUSED(path);
	GIT_UNUSED(status);
	GIT_UNUSED(payload);

433
	return GIT_PASSTHROUGH;
nulltoken committed
434 435 436 437 438 439 440 441
}

static int ensure_there_are_changes_to_stash(
	git_repository *repo,
	bool include_untracked_files,
	bool include_ignored_files)
{
	int error;
442
	git_status_options opts = GIT_STATUS_OPTIONS_INIT;
nulltoken committed
443 444

	opts.show  = GIT_STATUS_SHOW_INDEX_AND_WORKDIR;
445 446
	opts.flags = GIT_STATUS_OPT_EXCLUDE_SUBMODULES;

nulltoken committed
447
	if (include_untracked_files)
448
		opts.flags |= GIT_STATUS_OPT_INCLUDE_UNTRACKED |
nulltoken committed
449 450 451
		GIT_STATUS_OPT_RECURSE_UNTRACKED_DIRS;

	if (include_ignored_files)
452
		opts.flags |= GIT_STATUS_OPT_INCLUDE_IGNORED;
nulltoken committed
453 454 455

	error = git_status_foreach_ext(repo, &opts, is_dirty_cb, NULL);

456
	if (error == GIT_PASSTHROUGH)
nulltoken committed
457 458 459 460 461 462 463 464 465 466 467 468 469
		return 0;

	if (!error)
		return create_error(GIT_ENOTFOUND, "There is nothing to stash.");

	return error;
}

static int reset_index_and_workdir(
	git_repository *repo,
	git_commit *commit,
	bool remove_untracked)
{
470
	git_checkout_opts opts = GIT_CHECKOUT_OPTS_INIT;
nulltoken committed
471

472
	opts.checkout_strategy = GIT_CHECKOUT_FORCE;
nulltoken committed
473 474 475 476 477 478 479 480 481 482

	if (remove_untracked)
		opts.checkout_strategy |= GIT_CHECKOUT_REMOVE_UNTRACKED;

	return git_checkout_tree(repo, (git_object *)commit, &opts);
}

int git_stash_save(
	git_oid *out,
	git_repository *repo,
483
	const git_signature *stasher,
nulltoken committed
484 485 486 487 488 489 490 491 492 493
	const char *message,
	uint32_t flags)
{
	git_index *index = NULL;
	git_commit *b_commit = NULL, *i_commit = NULL, *u_commit = NULL;
	git_buf msg = GIT_BUF_INIT;
	int error;

	assert(out && repo && stasher);

494
	if ((error = git_repository__ensure_not_bare(repo, "stash save")) < 0)
nulltoken committed
495 496 497 498 499 500 501
		return error;

	if ((error = retrieve_base_commit_and_message(&b_commit, &msg, repo)) < 0)
		goto cleanup;

	if ((error = ensure_there_are_changes_to_stash(
		repo,
502 503
		(flags & GIT_STASH_INCLUDE_UNTRACKED) != 0,
		(flags & GIT_STASH_INCLUDE_IGNORED) != 0)) < 0)
nulltoken committed
504 505
		goto cleanup;

506
	if ((error = git_repository_index(&index, repo)) < 0)
nulltoken committed
507 508
		goto cleanup;

509 510
	if ((error = commit_index(
			&i_commit, index, stasher, git_buf_cstr(&msg), b_commit)) < 0)
nulltoken committed
511 512
		goto cleanup;

513 514 515 516
	if ((flags & (GIT_STASH_INCLUDE_UNTRACKED | GIT_STASH_INCLUDE_IGNORED)) &&
		(error = commit_untracked(
			&u_commit, index, stasher, git_buf_cstr(&msg),
			i_commit, flags)) < 0)
nulltoken committed
517 518
		goto cleanup;

519
	if ((error = prepare_worktree_commit_message(&msg, message)) < 0)
nulltoken committed
520 521
		goto cleanup;

522 523 524
	if ((error = commit_worktree(
			out, index, stasher, git_buf_cstr(&msg),
			i_commit, b_commit, u_commit)) < 0)
nulltoken committed
525 526 527
		goto cleanup;

	git_buf_rtrim(&msg);
528 529

	if ((error = update_reflog(out, repo, stasher, git_buf_cstr(&msg))) < 0)
nulltoken committed
530 531
		goto cleanup;

532
	if ((error = reset_index_and_workdir(
nulltoken committed
533
		repo,
534 535
		((flags & GIT_STASH_KEEP_INDEX) != 0) ? i_commit : b_commit,
		(flags & GIT_STASH_INCLUDE_UNTRACKED) != 0)) < 0)
nulltoken committed
536 537 538
		goto cleanup;

cleanup:
539

nulltoken committed
540 541 542 543 544
	git_buf_free(&msg);
	git_commit_free(i_commit);
	git_commit_free(b_commit);
	git_commit_free(u_commit);
	git_index_free(index);
545

nulltoken committed
546 547
	return error;
}
548 549 550

int git_stash_foreach(
	git_repository *repo,
Ben Straub committed
551
	git_stash_cb callback,
552 553 554 555 556 557 558 559 560
	void *payload)
{
	git_reference *stash;
	git_reflog *reflog = NULL;
	int error;
	size_t i, max;
	const git_reflog_entry *entry;

	error = git_reference_lookup(&stash, repo, GIT_REFS_STASH_FILE);
561 562
	if (error == GIT_ENOTFOUND) {
		giterr_clear();
563
		return 0;
564
	}
565 566 567
	if (error < 0)
		goto cleanup;

568
	if ((error = git_reflog_read(&reflog, repo, GIT_REFS_STASH_FILE)) < 0)
569 570 571 572
		goto cleanup;

	max = git_reflog_entrycount(reflog);
	for (i = 0; i < max; i++) {
573
		entry = git_reflog_entry_byindex(reflog, i);
574

575 576 577 578 579 580
		error = callback(i,
			git_reflog_entry_message(entry),
			git_reflog_entry_id_new(entry),
			payload);

		if (error) {
581
			giterr_set_after_callback(error);
582
			break;
583
		}
584 585 586 587 588 589 590
	}

cleanup:
	git_reference_free(stash);
	git_reflog_free(reflog);
	return error;
}
nulltoken committed
591 592 593 594 595 596 597 598 599 600 601 602 603

int git_stash_drop(
	git_repository *repo,
	size_t index)
{
	git_reference *stash;
	git_reflog *reflog = NULL;
	size_t max;
	int error;

	if ((error = git_reference_lookup(&stash, repo, GIT_REFS_STASH_FILE)) < 0)
		return error;

604
	if ((error = git_reflog_read(&reflog, repo, GIT_REFS_STASH_FILE)) < 0)
nulltoken committed
605 606 607 608 609 610 611 612 613 614
		goto cleanup;

	max = git_reflog_entrycount(reflog);

	if (index > max - 1) {
		error = GIT_ENOTFOUND;
		giterr_set(GITERR_STASH, "No stashed state at position %" PRIuZ, index);
		goto cleanup;
	}

615
	if ((error = git_reflog_drop(reflog, index, true)) < 0)
nulltoken committed
616 617 618 619 620 621 622
		goto cleanup;

	if ((error = git_reflog_write(reflog)) < 0)
		goto cleanup;

	if (max == 1) {
		error = git_reference_delete(stash);
623
		git_reference_free(stash);
nulltoken committed
624
		stash = NULL;
625 626 627 628
	} else if (index == 0) {
		const git_reflog_entry *entry;

		entry = git_reflog_entry_byindex(reflog, 0);
629

630
		git_reference_free(stash);
631
		if ((error = git_reference_create(&stash, repo, GIT_REFS_STASH_FILE, &entry->oid_cur, 1, NULL, NULL) < 0))
632 633 634 635
			goto cleanup;

		/* We need to undo the writing that we just did */
		error = git_reflog_write(reflog);
nulltoken committed
636 637 638 639 640 641 642
	}

cleanup:
	git_reference_free(stash);
	git_reflog_free(reflog);
	return error;
}