stash.c 14.1 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"
18
#include "git2/transaction.h"
Ben Straub committed
19
#include "signature.h"
nulltoken committed
20 21 22 23 24 25 26 27 28 29 30

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

31
	if (error == GIT_EUNBORNBRANCH)
nulltoken committed
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
		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;
53
	size_t pos = 0, len;
nulltoken committed
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 85

	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)
86
		error = git_buf_puts(stash_message, "(no branch): ");
nulltoken committed
87
	else
88
		error = git_buf_printf(
nulltoken committed
89 90 91
			stash_message,
			"%s: ",
			git_reference_name(head) + strlen(GIT_REFS_HEADS_DIR));
92
	if (error < 0)
nulltoken committed
93 94
		goto cleanup;

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

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

cleanup:
	git_reference_free(head);
	return error;
}

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

112
	if ((error = git_index_write_tree(&i_tree_oid, index)) < 0)
nulltoken committed
113 114 115 116 117 118 119 120
		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,
121
	const git_signature *stasher,
nulltoken committed
122 123 124 125 126 127
	const char *message,
	const git_commit *parent)
{
	git_tree *i_tree = NULL;
	git_oid i_commit_oid;
	git_buf msg = GIT_BUF_INIT;
128
	int error;
nulltoken committed
129

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

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

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

	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
157
struct stash_update_rules {
nulltoken committed
158 159 160 161 162
	bool include_changed;
	bool include_untracked;
	bool include_ignored;
};

Russell Belfer committed
163 164 165 166
static int stash_update_index_from_diff(
	git_index *index,
	const git_diff *diff,
	struct stash_update_rules *data)
nulltoken committed
167
{
Russell Belfer committed
168 169 170 171 172 173 174 175 176 177 178 179 180 181
	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:
182 183
			if (data->include_untracked &&
				delta->new_file.mode != GIT_FILEMODE_TREE)
Russell Belfer committed
184
				add_path = delta->new_file.path;
nulltoken committed
185 186
			break;

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

Russell Belfer committed
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
		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
213 214 215 216 217 218 219 220 221
}

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

	git_index_clear(index);

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

	if (flags & GIT_STASH_INCLUDE_IGNORED) {
236 237
		opts.flags |= GIT_DIFF_INCLUDE_IGNORED |
			GIT_DIFF_RECURSE_IGNORED_DIRS;
nulltoken committed
238 239 240
		data.include_ignored = true;
	}

241
	if ((error = git_commit_tree(&i_tree, i_commit)) < 0)
nulltoken committed
242 243
		goto cleanup;

244 245
	if ((error = git_diff_tree_to_workdir(
			&diff, git_index_owner(index), i_tree, &opts)) < 0)
nulltoken committed
246 247
		goto cleanup;

Russell Belfer committed
248
	if ((error = stash_update_index_from_diff(index, diff, &data)) < 0)
nulltoken committed
249 250
		goto cleanup;

251
	error = build_tree_from_index(tree_out, index);
nulltoken committed
252 253

cleanup:
254
	git_diff_free(diff);
nulltoken committed
255 256 257 258 259 260 261
	git_tree_free(i_tree);
	return error;
}

static int commit_untracked(
	git_commit **u_commit,
	git_index *index,
262
	const git_signature *stasher,
nulltoken committed
263 264 265 266 267 268 269
	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;
270
	int error;
nulltoken committed
271

272
	if ((error = build_untracked_tree(&u_tree, index, i_commit, flags)) < 0)
nulltoken committed
273 274
		goto cleanup;

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

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

	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)
{
304
	git_repository *repo = git_index_owner(index);
nulltoken committed
305
	git_tree *b_tree = NULL;
Russell Belfer committed
306
	git_diff *diff = NULL;
307
	git_diff_options opts = GIT_DIFF_OPTIONS_INIT;
Russell Belfer committed
308
	struct stash_update_rules data = {0};
309
	int error;
nulltoken committed
310

311 312
	opts.flags = GIT_DIFF_IGNORE_SUBMODULES;

313
	if ((error = git_commit_tree(&b_tree, b_commit)) < 0)
nulltoken committed
314 315
		goto cleanup;

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

	data.include_changed = true;

Russell Belfer committed
322
	if ((error = stash_update_index_from_diff(index, diff, &data)) < 0)
nulltoken committed
323 324
		goto cleanup;

Russell Belfer committed
325
	error = build_tree_from_index(tree_out, index);
nulltoken committed
326 327

cleanup:
328
	git_diff_free(diff);
nulltoken committed
329
	git_tree_free(b_tree);
330

nulltoken committed
331 332 333 334 335 336
	return error;
}

static int commit_worktree(
	git_oid *w_commit_oid,
	git_index *index,
337
	const git_signature *stasher,
nulltoken committed
338 339 340 341 342
	const char *message,
	git_commit *i_commit,
	git_commit *b_commit,
	git_commit *u_commit)
{
343
	int error = 0;
nulltoken committed
344 345 346 347 348 349 350
	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;

351 352
	if ((error = git_commit_tree(&i_tree, i_commit)) < 0)
		goto cleanup;
nulltoken committed
353

354
	if ((error = git_index_read_tree(index, i_tree)) < 0)
nulltoken committed
355 356
		goto cleanup;

357
	if ((error = build_workdir_tree(&w_tree, index, b_commit)) < 0)
nulltoken committed
358 359
		goto cleanup;

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

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;
383 384
	int error;

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

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

403
	error = (git_buf_oom(msg) || git_buf_oom(&buf)) ? -1 : 0;
nulltoken committed
404 405 406

cleanup:
	git_buf_free(&buf);
407

nulltoken committed
408 409 410 411 412 413
	return error;
}

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

420 421
	if ((error = git_reference_ensure_log(repo, GIT_REFS_STASH_FILE)) < 0)
		return error;
nulltoken committed
422

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

425
	git_reference_free(stash);
nulltoken committed
426 427 428 429 430 431 432 433 434 435

	return error;
}

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

436
	return GIT_PASSTHROUGH;
nulltoken committed
437 438 439 440 441 442 443 444
}

static int ensure_there_are_changes_to_stash(
	git_repository *repo,
	bool include_untracked_files,
	bool include_ignored_files)
{
	int error;
445
	git_status_options opts = GIT_STATUS_OPTIONS_INIT;
nulltoken committed
446 447

	opts.show  = GIT_STATUS_SHOW_INDEX_AND_WORKDIR;
448 449
	opts.flags = GIT_STATUS_OPT_EXCLUDE_SUBMODULES;

nulltoken committed
450
	if (include_untracked_files)
451
		opts.flags |= GIT_STATUS_OPT_INCLUDE_UNTRACKED |
452
			GIT_STATUS_OPT_RECURSE_UNTRACKED_DIRS;
nulltoken committed
453 454

	if (include_ignored_files)
455 456
		opts.flags |= GIT_STATUS_OPT_INCLUDE_IGNORED |
			GIT_STATUS_OPT_RECURSE_IGNORED_DIRS;
nulltoken committed
457 458 459

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

460
	if (error == GIT_PASSTHROUGH)
nulltoken committed
461 462 463 464 465 466 467 468 469 470 471
		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,
472 473
	bool remove_untracked,
	bool remove_ignored)
nulltoken committed
474
{
475
	git_checkout_options opts = GIT_CHECKOUT_OPTIONS_INIT;
nulltoken committed
476

477
	opts.checkout_strategy = GIT_CHECKOUT_FORCE;
nulltoken committed
478 479 480 481

	if (remove_untracked)
		opts.checkout_strategy |= GIT_CHECKOUT_REMOVE_UNTRACKED;

482 483 484
	if (remove_ignored)
		opts.checkout_strategy |= GIT_CHECKOUT_REMOVE_IGNORED;

nulltoken committed
485 486 487 488 489 490
	return git_checkout_tree(repo, (git_object *)commit, &opts);
}

int git_stash_save(
	git_oid *out,
	git_repository *repo,
491
	const git_signature *stasher,
nulltoken committed
492 493 494 495 496 497 498 499 500 501
	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);

502
	if ((error = git_repository__ensure_not_bare(repo, "stash save")) < 0)
nulltoken committed
503 504 505 506 507 508 509
		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,
510 511
		(flags & GIT_STASH_INCLUDE_UNTRACKED) != 0,
		(flags & GIT_STASH_INCLUDE_IGNORED) != 0)) < 0)
nulltoken committed
512 513
		goto cleanup;

514
	if ((error = git_repository_index(&index, repo)) < 0)
nulltoken committed
515 516
		goto cleanup;

517 518
	if ((error = commit_index(
			&i_commit, index, stasher, git_buf_cstr(&msg), b_commit)) < 0)
nulltoken committed
519 520
		goto cleanup;

521 522 523 524
	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
525 526
		goto cleanup;

527
	if ((error = prepare_worktree_commit_message(&msg, message)) < 0)
nulltoken committed
528 529
		goto cleanup;

530 531 532
	if ((error = commit_worktree(
			out, index, stasher, git_buf_cstr(&msg),
			i_commit, b_commit, u_commit)) < 0)
nulltoken committed
533 534 535
		goto cleanup;

	git_buf_rtrim(&msg);
536 537

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

540
	if ((error = reset_index_and_workdir(
nulltoken committed
541
		repo,
542
		((flags & GIT_STASH_KEEP_INDEX) != 0) ? i_commit : b_commit,
543 544
		(flags & GIT_STASH_INCLUDE_UNTRACKED) != 0,
		(flags & GIT_STASH_INCLUDE_IGNORED) != 0)) < 0)
nulltoken committed
545 546 547
		goto cleanup;

cleanup:
548

nulltoken committed
549 550 551 552 553
	git_buf_free(&msg);
	git_commit_free(i_commit);
	git_commit_free(b_commit);
	git_commit_free(u_commit);
	git_index_free(index);
554

nulltoken committed
555 556
	return error;
}
557 558 559

int git_stash_foreach(
	git_repository *repo,
Ben Straub committed
560
	git_stash_cb callback,
561 562 563 564 565 566 567 568 569
	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);
570 571
	if (error == GIT_ENOTFOUND) {
		giterr_clear();
572
		return 0;
573
	}
574 575 576
	if (error < 0)
		goto cleanup;

577
	if ((error = git_reflog_read(&reflog, repo, GIT_REFS_STASH_FILE)) < 0)
578 579 580 581
		goto cleanup;

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

584 585 586 587 588 589
		error = callback(i,
			git_reflog_entry_message(entry),
			git_reflog_entry_id_new(entry),
			payload);

		if (error) {
590
			giterr_set_after_callback(error);
591
			break;
592
		}
593 594 595 596 597 598 599
	}

cleanup:
	git_reference_free(stash);
	git_reflog_free(reflog);
	return error;
}
nulltoken committed
600 601 602 603 604

int git_stash_drop(
	git_repository *repo,
	size_t index)
{
605 606
	git_transaction *tx;
	git_reference *stash = NULL;
nulltoken committed
607 608 609 610
	git_reflog *reflog = NULL;
	size_t max;
	int error;

611
	if ((error = git_transaction_new(&tx, repo)) < 0)
nulltoken committed
612 613
		return error;

614
	if ((error = git_transaction_lock_ref(tx, GIT_REFS_STASH_FILE)) < 0)
615 616 617 618 619
		goto cleanup;

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

620
	if ((error = git_reflog_read(&reflog, repo, GIT_REFS_STASH_FILE)) < 0)
nulltoken committed
621 622 623 624 625 626 627 628 629 630
		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;
	}

631
	if ((error = git_reflog_drop(reflog, index, true)) < 0)
nulltoken committed
632 633
		goto cleanup;

634
	if ((error = git_transaction_set_reflog(tx, GIT_REFS_STASH_FILE, reflog)) < 0)
nulltoken committed
635 636 637
		goto cleanup;

	if (max == 1) {
638 639
		if ((error = git_transaction_remove(tx, GIT_REFS_STASH_FILE)) < 0)
			goto cleanup;
640 641 642 643
	} else if (index == 0) {
		const git_reflog_entry *entry;

		entry = git_reflog_entry_byindex(reflog, 0);
644
		if ((error = git_transaction_set_target(tx, GIT_REFS_STASH_FILE, &entry->oid_cur, NULL, NULL)) < 0)
645
			goto cleanup;
nulltoken committed
646 647
	}

648 649
	error = git_transaction_commit(tx);

nulltoken committed
650 651
cleanup:
	git_reference_free(stash);
652
	git_transaction_free(tx);
nulltoken committed
653 654 655
	git_reflog_free(reflog);
	return error;
}