[thirdparty/git.git] / builtin / mv.c

/*
 * "git mv" builtin command
 *
 * Copyright (C) 2006 Johannes Schindelin
 */
#define USE_THE_INDEX_COMPATIBILITY_MACROS
#include "builtin.h"
#include "config.h"
#include "pathspec.h"
#include "lockfile.h"
#include "dir.h"
#include "cache-tree.h"
#include "string-list.h"
#include "parse-options.h"
#include "submodule.h"
#include "entry.h"

static const char * const builtin_mv_usage[] = {
	N_("git mv [<options>] <source>... <destination>"),
	NULL
};

enum update_mode {
	WORKING_DIRECTORY = (1 << 1),
	INDEX = (1 << 2),
	SPARSE = (1 << 3),
	SKIP_WORKTREE_DIR = (1 << 4),
};

#define DUP_BASENAME 1
#define KEEP_TRAILING_SLASH 2

static const char **internal_prefix_pathspec(const char *prefix,
					     const char **pathspec,
					     int count, unsigned flags)
{
	int i;
	const char **result;
	int prefixlen = prefix ? strlen(prefix) : 0;
	ALLOC_ARRAY(result, count + 1);

	/* Create an intermediate copy of the pathspec based on the flags */
	for (i = 0; i < count; i++) {
		int length = strlen(pathspec[i]);
		int to_copy = length;
		char *it;
		while (!(flags & KEEP_TRAILING_SLASH) &&
		       to_copy > 0 && is_dir_sep(pathspec[i][to_copy - 1]))
			to_copy--;

		it = xmemdupz(pathspec[i], to_copy);
		if (flags & DUP_BASENAME) {
			result[i] = xstrdup(basename(it));
			free(it);
		} else {
			result[i] = it;
		}
	}
	result[count] = NULL;

	/* Prefix the pathspec and free the old intermediate strings */
	for (i = 0; i < count; i++) {
		const char *match = prefix_path(prefix, prefixlen, result[i]);
		free((char *) result[i]);
		result[i] = match;
	}

	return result;
}

static const char *add_slash(const char *path)
{
	size_t len = strlen(path);
	if (path[len - 1] != '/') {
		char *with_slash = xmalloc(st_add(len, 2));
		memcpy(with_slash, path, len);
		with_slash[len++] = '/';
		with_slash[len] = 0;
		return with_slash;
	}
	return path;
}

#define SUBMODULE_WITH_GITDIR ((const char *)1)

static void prepare_move_submodule(const char *src, int first,
				   const char **submodule_gitfile)
{
	struct strbuf submodule_dotgit = STRBUF_INIT;
	if (!S_ISGITLINK(active_cache[first]->ce_mode))
		die(_("Directory %s is in index and no submodule?"), src);
	if (!is_staging_gitmodules_ok(&the_index))
		die(_("Please stage your changes to .gitmodules or stash them to proceed"));
	strbuf_addf(&submodule_dotgit, "%s/.git", src);
	*submodule_gitfile = read_gitfile(submodule_dotgit.buf);
	if (*submodule_gitfile)
		*submodule_gitfile = xstrdup(*submodule_gitfile);
	else
		*submodule_gitfile = SUBMODULE_WITH_GITDIR;
	strbuf_release(&submodule_dotgit);
}

static int index_range_of_same_dir(const char *src, int length,
				   int *first_p, int *last_p)
{
	const char *src_w_slash = add_slash(src);
	int first, last, len_w_slash = length + 1;

	first = cache_name_pos(src_w_slash, len_w_slash);
	if (first >= 0)
		die(_("%.*s is in index"), len_w_slash, src_w_slash);

	first = -1 - first;
	for (last = first; last < active_nr; last++) {
		const char *path = active_cache[last]->name;
		if (strncmp(path, src_w_slash, len_w_slash))
			break;
	}
	if (src_w_slash != src)
		free((char *)src_w_slash);
	*first_p = first;
	*last_p = last;
	return last - first;
}

/*
 * Given the path of a directory that does not exist on-disk, check whether the
 * directory contains any entries in the index with the SKIP_WORKTREE flag
 * enabled.
 * Return 1 if such index entries exist.
 * Return 0 otherwise.
 */
static int empty_dir_has_sparse_contents(const char *name)
{
	int ret = 0;
	const char *with_slash = add_slash(name);
	int length = strlen(with_slash);

	int pos = cache_name_pos(with_slash, length);
	const struct cache_entry *ce;

	if (pos < 0) {
		pos = -pos - 1;
		if (pos >= the_index.cache_nr)
			goto free_return;
		ce = active_cache[pos];
		if (strncmp(with_slash, ce->name, length))
			goto free_return;
		if (ce_skip_worktree(ce))
			ret = 1;
	}

free_return:
	if (with_slash != name)
		free((char *)with_slash);
	return ret;
}

int cmd_mv(int argc, const char **argv, const char *prefix)
{
	int i, flags, gitmodules_modified = 0;
	int verbose = 0, show_only = 0, force = 0, ignore_errors = 0, ignore_sparse = 0;
	struct option builtin_mv_options[] = {
		OPT__VERBOSE(&verbose, N_("be verbose")),
		OPT__DRY_RUN(&show_only, N_("dry run")),
		OPT__FORCE(&force, N_("force move/rename even if target exists"),
			   PARSE_OPT_NOCOMPLETE),
		OPT_BOOL('k', NULL, &ignore_errors, N_("skip move/rename errors")),
		OPT_BOOL(0, "sparse", &ignore_sparse, N_("allow updating entries outside of the sparse-checkout cone")),
		OPT_END(),
	};
	const char **source, **destination, **dest_path, **submodule_gitfile;
	const char *dst_w_slash;
	const char **src_dir = NULL;
	int src_dir_nr = 0, src_dir_alloc = 0;
	struct strbuf a_src_dir = STRBUF_INIT;
	enum update_mode *modes, dst_mode = 0;
	struct stat st;
	struct string_list src_for_dst = STRING_LIST_INIT_NODUP;
	struct lock_file lock_file = LOCK_INIT;
	struct cache_entry *ce;
	struct string_list only_match_skip_worktree = STRING_LIST_INIT_NODUP;
	struct string_list dirty_paths = STRING_LIST_INIT_NODUP;

	git_config(git_default_config, NULL);

	argc = parse_options(argc, argv, prefix, builtin_mv_options,
			     builtin_mv_usage, 0);
	if (--argc < 1)
		usage_with_options(builtin_mv_usage, builtin_mv_options);

	hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
	if (read_cache() < 0)
		die(_("index file corrupt"));

	source = internal_prefix_pathspec(prefix, argv, argc, 0);
	modes = xcalloc(argc, sizeof(enum update_mode));
	/*
	 * Keep trailing slash, needed to let
	 * "git mv file no-such-dir/" error out, except in the case
	 * "git mv directory no-such-dir/".
	 */
	flags = KEEP_TRAILING_SLASH;
	if (argc == 1 && is_directory(argv[0]) && !is_directory(argv[1]))
		flags = 0;
	dest_path = internal_prefix_pathspec(prefix, argv + argc, 1, flags);
	dst_w_slash = add_slash(dest_path[0]);
	submodule_gitfile = xcalloc(argc, sizeof(char *));

	if (dest_path[0][0] == '\0')
		/* special case: "." was normalized to "" */
		destination = internal_prefix_pathspec(dest_path[0], argv, argc, DUP_BASENAME);
	else if (!lstat(dest_path[0], &st) &&
			S_ISDIR(st.st_mode)) {
		destination = internal_prefix_pathspec(dst_w_slash, argv, argc, DUP_BASENAME);
	} else {
		if (!path_in_sparse_checkout(dst_w_slash, &the_index) &&
		    empty_dir_has_sparse_contents(dst_w_slash)) {
			destination = internal_prefix_pathspec(dst_w_slash, argv, argc, DUP_BASENAME);
			dst_mode = SKIP_WORKTREE_DIR;
		} else if (argc != 1) {
			die(_("destination '%s' is not a directory"), dest_path[0]);
		} else {
			destination = dest_path;
			/*
			 * <destination> is a file outside of sparse-checkout
			 * cone. Insist on cone mode here for backward
			 * compatibility. We don't want dst_mode to be assigned
			 * for a file when the repo is using no-cone mode (which
			 * is deprecated at this point) sparse-checkout. As
			 * SPARSE here is only considering cone-mode situation.
			 */
			if (!path_in_cone_mode_sparse_checkout(destination[0], &the_index))
				dst_mode = SPARSE;
		}
	}
	if (dst_w_slash != dest_path[0]) {
		free((char *)dst_w_slash);
		dst_w_slash = NULL;
	}

	/* Checking */
	for (i = 0; i < argc; i++) {
		const char *src = source[i], *dst = destination[i];
		int length;
		const char *bad = NULL;
		int skip_sparse = 0;

		if (show_only)
			printf(_("Checking rename of '%s' to '%s'\n"), src, dst);

		length = strlen(src);
		if (lstat(src, &st) < 0) {
			int pos;
			const struct cache_entry *ce;

			pos = cache_name_pos(src, length);
			if (pos < 0) {
				const char *src_w_slash = add_slash(src);
				if (!path_in_sparse_checkout(src_w_slash, &the_index) &&
				    empty_dir_has_sparse_contents(src)) {
					modes[i] |= SKIP_WORKTREE_DIR;
					goto dir_check;
				}
				/* only error if existence is expected. */
				if (!(modes[i] & SPARSE))
					bad = _("bad source");
				goto act_on_entry;
			}
			ce = active_cache[pos];
			if (!ce_skip_worktree(ce)) {
				bad = _("bad source");
				goto act_on_entry;
			}
			if (!ignore_sparse) {
				string_list_append(&only_match_skip_worktree, src);
				goto act_on_entry;
			}
			/* Check if dst exists in index */
			if (cache_name_pos(dst, strlen(dst)) < 0) {
				modes[i] |= SPARSE;
				goto act_on_entry;
			}
			if (!force) {
				bad = _("destination exists");
				goto act_on_entry;
			}
			modes[i] |= SPARSE;
			goto act_on_entry;
		}
		if (!strncmp(src, dst, length) &&
		    (dst[length] == 0 || dst[length] == '/')) {
			bad = _("can not move directory into itself");
			goto act_on_entry;
		}
		if (S_ISDIR(st.st_mode)
		    && lstat(dst, &st) == 0) {
			bad = _("cannot move directory over file");
			goto act_on_entry;
		}

dir_check:
		if (S_ISDIR(st.st_mode)) {
			int j, dst_len, n;
			int first = cache_name_pos(src, length), last;

			if (first >= 0) {
				prepare_move_submodule(src, first,
						       submodule_gitfile + i);
				goto act_on_entry;
			} else if (index_range_of_same_dir(src, length,
							   &first, &last) < 1) {
				bad = _("source directory is empty");
				goto act_on_entry;
			}

			/* last - first >= 1 */
			modes[i] |= WORKING_DIRECTORY;

			ALLOC_GROW(src_dir, src_dir_nr + 1, src_dir_alloc);
			src_dir[src_dir_nr++] = src;

			n = argc + last - first;
			REALLOC_ARRAY(source, n);
			REALLOC_ARRAY(destination, n);
			REALLOC_ARRAY(modes, n);
			REALLOC_ARRAY(submodule_gitfile, n);

			dst = add_slash(dst);
			dst_len = strlen(dst);

			for (j = 0; j < last - first; j++) {
				const struct cache_entry *ce = active_cache[first + j];
				const char *path = ce->name;
				source[argc + j] = path;
				destination[argc + j] =
					prefix_path(dst, dst_len, path + length + 1);
				memset(modes + argc + j, 0, sizeof(enum update_mode));
				modes[argc + j] |= ce_skip_worktree(ce) ? SPARSE : INDEX;
				submodule_gitfile[argc + j] = NULL;
			}
			argc += last - first;
			goto act_on_entry;
		}
		if (!(ce = cache_file_exists(src, length, 0))) {
			bad = _("not under version control");
			goto act_on_entry;
		}
		if (ce_stage(ce)) {
			bad = _("conflicted");
			goto act_on_entry;
		}
		if (lstat(dst, &st) == 0 &&
		    (!ignore_case || strcasecmp(src, dst))) {
			bad = _("destination exists");
			if (force) {
				/*
				 * only files can overwrite each other:
				 * check both source and destination
				 */
				if (S_ISREG(st.st_mode) || S_ISLNK(st.st_mode)) {
					if (verbose)
						warning(_("overwriting '%s'"), dst);
					bad = NULL;
				} else
					bad = _("Cannot overwrite");
			}
			goto act_on_entry;
		}
		if (string_list_has_string(&src_for_dst, dst)) {
			bad = _("multiple sources for the same target");
			goto act_on_entry;
		}
		if (is_dir_sep(dst[strlen(dst) - 1])) {
			bad = _("destination directory does not exist");
			goto act_on_entry;
		}

		/*
		 * We check if the paths are in the sparse-checkout
		 * definition as a very final check, since that
		 * allows us to point the user to the --sparse
		 * option as a way to have a successful run.
		 */
		if (!ignore_sparse &&
		    !path_in_sparse_checkout(src, &the_index)) {
			string_list_append(&only_match_skip_worktree, src);
			skip_sparse = 1;
		}
		if (!ignore_sparse &&
		    !path_in_sparse_checkout(dst, &the_index)) {
			string_list_append(&only_match_skip_worktree, dst);
			skip_sparse = 1;
		}

		if (skip_sparse)
			goto remove_entry;

		string_list_insert(&src_for_dst, dst);

act_on_entry:
		if (!bad)
			continue;
		if (!ignore_errors)
			die(_("%s, source=%s, destination=%s"),
			     bad, src, dst);
remove_entry:
		if (--argc > 0) {
			int n = argc - i;
			memmove(source + i, source + i + 1,
				n * sizeof(char *));
			memmove(destination + i, destination + i + 1,
				n * sizeof(char *));
			memmove(modes + i, modes + i + 1,
				n * sizeof(enum update_mode));
			memmove(submodule_gitfile + i, submodule_gitfile + i + 1,
				n * sizeof(char *));
			i--;
		}
	}

	if (only_match_skip_worktree.nr) {
		advise_on_updating_sparse_paths(&only_match_skip_worktree);
		if (!ignore_errors)
			return 1;
	}

	for (i = 0; i < argc; i++) {
		const char *src = source[i], *dst = destination[i];
		enum update_mode mode = modes[i];
		int pos;
		int sparse_and_dirty = 0;
		struct checkout state = CHECKOUT_INIT;
		state.istate = &the_index;

		if (force)
			state.force = 1;
		if (show_only || verbose)
			printf(_("Renaming %s to %s\n"), src, dst);
		if (show_only)
			continue;
		if (!(mode & (INDEX | SPARSE | SKIP_WORKTREE_DIR)) &&
		    !(dst_mode & (SKIP_WORKTREE_DIR | SPARSE)) &&
		    rename(src, dst) < 0) {
			if (ignore_errors)
				continue;
			die_errno(_("renaming '%s' failed"), src);
		}
		if (submodule_gitfile[i]) {
			if (!update_path_in_gitmodules(src, dst))
				gitmodules_modified = 1;
			if (submodule_gitfile[i] != SUBMODULE_WITH_GITDIR)
				connect_work_tree_and_git_dir(dst,
							      submodule_gitfile[i],
							      1);
		}

		if (mode & (WORKING_DIRECTORY | SKIP_WORKTREE_DIR))
			continue;

		pos = cache_name_pos(src, strlen(src));
		assert(pos >= 0);
		if (!(mode & SPARSE) && !lstat(src, &st))
			sparse_and_dirty = ce_modified(active_cache[pos], &st, 0);
		rename_cache_entry_at(pos, dst);

		if (ignore_sparse &&
		    core_apply_sparse_checkout &&
		    core_sparse_checkout_cone) {
			/*
			 * NEEDSWORK: we are *not* paying attention to
			 * "out-to-out" move (<source> is out-of-cone and
			 * <destination> is out-of-cone) at this point. It
			 * should be added in a future patch.
			 */
			if ((mode & SPARSE) &&
			    path_in_sparse_checkout(dst, &the_index)) {
				/* from out-of-cone to in-cone */
				int dst_pos = cache_name_pos(dst, strlen(dst));
				struct cache_entry *dst_ce = active_cache[dst_pos];

				dst_ce->ce_flags &= ~CE_SKIP_WORKTREE;

				if (checkout_entry(dst_ce, &state, NULL, NULL))
					die(_("cannot checkout %s"), dst_ce->name);
			} else if ((dst_mode & (SKIP_WORKTREE_DIR | SPARSE)) &&
				   !(mode & SPARSE) &&
				   !path_in_sparse_checkout(dst, &the_index)) {
				/* from in-cone to out-of-cone */
				int dst_pos = cache_name_pos(dst, strlen(dst));
				struct cache_entry *dst_ce = active_cache[dst_pos];

				/*
				 * if src is clean, it will suffice to remove it
				 */
				if (!sparse_and_dirty) {
					dst_ce->ce_flags |= CE_SKIP_WORKTREE;
					unlink_or_warn(src);
				} else {
					/*
					 * if src is dirty, move it to the
					 * destination and create leading
					 * dirs if necessary
					 */
					char *dst_dup = xstrdup(dst);
					string_list_append(&dirty_paths, dst);
					safe_create_leading_directories(dst_dup);
					FREE_AND_NULL(dst_dup);
					rename(src, dst);
				}
			}
		}
	}

	/*
	 * cleanup the empty src_dirs
	 */
	for (i = 0; i < src_dir_nr; i++) {
		int dummy;
		strbuf_addstr(&a_src_dir, src_dir[i]);
		/*
		 * if entries under a_src_dir are all moved away,
		 * recursively remove a_src_dir to cleanup
		 */
		if (index_range_of_same_dir(a_src_dir.buf, a_src_dir.len,
					    &dummy, &dummy) < 1) {
			remove_dir_recursively(&a_src_dir, 0);
		}
		strbuf_reset(&a_src_dir);
	}

	strbuf_release(&a_src_dir);
	free(src_dir);

	if (gitmodules_modified)
		stage_updated_gitmodules(&the_index);

	if (write_locked_index(&the_index, &lock_file,
			       COMMIT_LOCK | SKIP_IF_UNCHANGED))
		die(_("Unable to write new index file"));

	string_list_clear(&src_for_dst, 0);
	string_list_clear(&dirty_paths, 0);
	UNLEAK(source);
	UNLEAK(dest_path);
	free(submodule_gitfile);
	free(modes);
	return 0;
}
Commit	Line	Data
11be42a4 JS	1	/*
	2	* "git mv" builtin command
	3	*
	4	* Copyright (C) 2006 Johannes Schindelin
	5	*/
f8adbec9	6	#define USE_THE_INDEX_COMPATIBILITY_MACROS
11be42a4	7	#include "builtin.h"
b2141fc1	8	#include "config.h"
2ec87741	9	#include "pathspec.h"
697cc8ef	10	#include "lockfile.h"
11be42a4 JS	11	#include "dir.h"
11be42a4 JS	12	#include "cache-tree.h"
c455c87c	13	#include "string-list.h"
c7a20c11	14	#include "parse-options.h"
a88c915d	15	#include "submodule.h"
707fa2f7	16	#include "entry.h"
11be42a4	17
c7a20c11	18	static const char * const builtin_mv_usage[] = {
9c9b4f2f	19	N_("git mv [<options>] <source>... <destination>"),
c7a20c11 PH	20	NULL
c7a20c11 PH	21	};
11be42a4	22
24ea81d9	23	enum update_mode {
24ea81d9 SY	24	WORKING_DIRECTORY = (1 << 1),
	25	INDEX = (1 << 2),
	26	SPARSE = (1 << 3),
b91a2b65	27	SKIP_WORKTREE_DIR = (1 << 4),
24ea81d9 SY	28	};
24ea81d9 SY	29
c57f6281 MM	30	#define DUP_BASENAME 1
	31	#define KEEP_TRAILING_SLASH 2
	32
2ec87741 BW	33	static const char *internal_prefix_pathspec(const char prefix,
	34	const char **pathspec,
	35	int count, unsigned flags)
11be42a4	36	{
d78b0f3d	37	int i;
b32fa95f	38	const char **result;
2ec87741	39	int prefixlen = prefix ? strlen(prefix) : 0;
b32fa95f	40	ALLOC_ARRAY(result, count + 1);
2ec87741 BW	41
2ec87741 BW	42	/* Create an intermediate copy of the pathspec based on the flags */
d78b0f3d	43	for (i = 0; i < count; i++) {
2ec87741	44	int length = strlen(pathspec[i]);
af82559b	45	int to_copy = length;
2ec87741	46	char *it;
c57f6281	47	while (!(flags & KEEP_TRAILING_SLASH) &&
2ec87741	48	to_copy > 0 && is_dir_sep(pathspec[i][to_copy - 1]))
af82559b	49	to_copy--;
2ec87741 BW	50
	51	it = xmemdupz(pathspec[i], to_copy);
	52	if (flags & DUP_BASENAME) {
	53	result[i] = xstrdup(basename(it));
	54	free(it);
	55	} else {
	56	result[i] = it;
af82559b	57	}
11be42a4	58	}
2ec87741 BW	59	result[count] = NULL;
	60
	61	/* Prefix the pathspec and free the old intermediate strings */
	62	for (i = 0; i < count; i++) {
	63	const char *match = prefix_path(prefix, prefixlen, result[i]);
	64	free((char *) result[i]);
	65	result[i] = match;
	66	}
	67
	68	return result;
11be42a4 JS	69	}
11be42a4 JS	70
ac64a722 JS	71	static const char add_slash(const char path)
ac64a722 JS	72	{
50a6c8ef	73	size_t len = strlen(path);
ac64a722	74	if (path[len - 1] != '/') {
50a6c8ef	75	char *with_slash = xmalloc(st_add(len, 2));
ac64a722	76	memcpy(with_slash, path, len);
329a3047 JH	77	with_slash[len++] = '/';
329a3047 JH	78	with_slash[len] = 0;
ac64a722 JS	79	return with_slash;
	80	}
	81	return path;
	82	}
	83
04c1ee57	84	#define SUBMODULE_WITH_GITDIR ((const char *)1)
11be42a4	85
3af05a6d NTND	86	static void prepare_move_submodule(const char *src, int first,
	87	const char **submodule_gitfile)
	88	{
	89	struct strbuf submodule_dotgit = STRBUF_INIT;
	90	if (!S_ISGITLINK(active_cache[first]->ce_mode))
	91	die(_("Directory %s is in index and no submodule?"), src);
91b83480	92	if (!is_staging_gitmodules_ok(&the_index))
3af05a6d NTND	93	die(_("Please stage your changes to .gitmodules or stash them to proceed"));
	94	strbuf_addf(&submodule_dotgit, "%s/.git", src);
	95	*submodule_gitfile = read_gitfile(submodule_dotgit.buf);
	96	if (*submodule_gitfile)
	97	submodule_gitfile = xstrdup(submodule_gitfile);
	98	else
	99	*submodule_gitfile = SUBMODULE_WITH_GITDIR;
	100	strbuf_release(&submodule_dotgit);
	101	}
	102
e2b6cfa0 NTND	103	static int index_range_of_same_dir(const char *src, int length,
	104	int first_p, int last_p)
	105	{
	106	const char *src_w_slash = add_slash(src);
	107	int first, last, len_w_slash = length + 1;
	108
	109	first = cache_name_pos(src_w_slash, len_w_slash);
	110	if (first >= 0)
	111	die(_("%.*s is in index"), len_w_slash, src_w_slash);
	112
	113	first = -1 - first;
	114	for (last = first; last < active_nr; last++) {
	115	const char *path = active_cache[last]->name;
	116	if (strncmp(path, src_w_slash, len_w_slash))
	117	break;
	118	}
	119	if (src_w_slash != src)
	120	free((char *)src_w_slash);
	121	*first_p = first;
	122	*last_p = last;
	123	return last - first;
	124	}
	125
b91a2b65	126	/*
72e59ba1 SY	127	* Given the path of a directory that does not exist on-disk, check whether the
	128	* directory contains any entries in the index with the SKIP_WORKTREE flag
	129	* enabled.
	130	* Return 1 if such index entries exist.
	131	* Return 0 otherwise.
b91a2b65	132	*/
72e59ba1	133	static int empty_dir_has_sparse_contents(const char *name)
b91a2b65	134	{
d57690a9	135	int ret = 0;
b91a2b65 SY	136	const char *with_slash = add_slash(name);
	137	int length = strlen(with_slash);
	138
	139	int pos = cache_name_pos(with_slash, length);
	140	const struct cache_entry *ce;
	141
	142	if (pos < 0) {
	143	pos = -pos - 1;
	144	if (pos >= the_index.cache_nr)
d57690a9	145	goto free_return;
b91a2b65 SY	146	ce = active_cache[pos];
b91a2b65 SY	147	if (strncmp(with_slash, ce->name, length))
d57690a9	148	goto free_return;
72e59ba1	149	if (ce_skip_worktree(ce))
d57690a9	150	ret = 1;
b91a2b65	151	}
d57690a9 SY	152
	153	free_return:
	154	if (with_slash != name)
	155	free((char *)with_slash);
	156	return ret;
b91a2b65 SY	157	}
b91a2b65 SY	158
7061cf0f	159	int cmd_mv(int argc, const char *argv, const char prefix)
11be42a4	160	{
189d035e	161	int i, flags, gitmodules_modified = 0;
93d2c160	162	int verbose = 0, show_only = 0, force = 0, ignore_errors = 0, ignore_sparse = 0;
c7a20c11	163	struct option builtin_mv_options[] = {
6c54dc46 NTND	164	OPT__VERBOSE(&verbose, N_("be verbose")),
6c54dc46 NTND	165	OPT__DRY_RUN(&show_only, N_("dry run")),
61d15cd6 NTND	166	OPT__FORCE(&force, N_("force move/rename even if target exists"),
61d15cd6 NTND	167	PARSE_OPT_NOCOMPLETE),
d5d09d47	168	OPT_BOOL('k', NULL, &ignore_errors, N_("skip move/rename errors")),
93d2c160	169	OPT_BOOL(0, "sparse", &ignore_sparse, N_("allow updating entries outside of the sparse-checkout cone")),
c7a20c11 PH	170	OPT_END(),
c7a20c11 PH	171	};
a88c915d	172	const char source, destination, dest_path, submodule_gitfile;
c08830de	173	const char *dst_w_slash;
b6f51e3d SY	174	const char **src_dir = NULL;
	175	int src_dir_nr = 0, src_dir_alloc = 0;
	176	struct strbuf a_src_dir = STRBUF_INIT;
5784db1b	177	enum update_mode *modes, dst_mode = 0;
11be42a4	178	struct stat st;
183113a5	179	struct string_list src_for_dst = STRING_LIST_INIT_NODUP;
0fa5a2ed	180	struct lock_file lock_file = LOCK_INIT;
9b906af6	181	struct cache_entry *ce;
93d2c160	182	struct string_list only_match_skip_worktree = STRING_LIST_INIT_NODUP;
5784db1b	183	struct string_list dirty_paths = STRING_LIST_INIT_NODUP;
11be42a4	184
ef90d6d4	185	git_config(git_default_config, NULL);
11be42a4	186
37782920 SB	187	argc = parse_options(argc, argv, prefix, builtin_mv_options,
37782920 SB	188	builtin_mv_usage, 0);
c7a20c11 PH	189	if (--argc < 1)
c7a20c11 PH	190	usage_with_options(builtin_mv_usage, builtin_mv_options);
11be42a4	191
b3e83cc7	192	hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
99caeed0	193	if (read_cache() < 0)
431b049e	194	die(_("index file corrupt"));
99caeed0	195
2ec87741	196	source = internal_prefix_pathspec(prefix, argv, argc, 0);
c7a20c11	197	modes = xcalloc(argc, sizeof(enum update_mode));
c57f6281 MM	198	/*
c57f6281 MM	199	* Keep trailing slash, needed to let
189d035e JS	200	* "git mv file no-such-dir/" error out, except in the case
189d035e JS	201	* "git mv directory no-such-dir/".
c57f6281	202	*/
189d035e JS	203	flags = KEEP_TRAILING_SLASH;
	204	if (argc == 1 && is_directory(argv[0]) && !is_directory(argv[1]))
	205	flags = 0;
2ec87741	206	dest_path = internal_prefix_pathspec(prefix, argv + argc, 1, flags);
c08830de	207	dst_w_slash = add_slash(dest_path[0]);
a88c915d	208	submodule_gitfile = xcalloc(argc, sizeof(char *));
11be42a4	209
c5203bdf JS	210	if (dest_path[0][0] == '\0')
c5203bdf JS	211	/* special case: "." was normalized to "" */
2ec87741	212	destination = internal_prefix_pathspec(dest_path[0], argv, argc, DUP_BASENAME);
c5203bdf	213	else if (!lstat(dest_path[0], &st) &&
ac64a722	214	S_ISDIR(st.st_mode)) {
c08830de	215	destination = internal_prefix_pathspec(dst_w_slash, argv, argc, DUP_BASENAME);
ac64a722	216	} else {
c08830de SY	217	if (!path_in_sparse_checkout(dst_w_slash, &the_index) &&
	218	empty_dir_has_sparse_contents(dst_w_slash)) {
	219	destination = internal_prefix_pathspec(dst_w_slash, argv, argc, DUP_BASENAME);
5784db1b	220	dst_mode = SKIP_WORKTREE_DIR;
c08830de	221	} else if (argc != 1) {
eac0ccc2	222	die(_("destination '%s' is not a directory"), dest_path[0]);
c08830de SY	223	} else {
c08830de SY	224	destination = dest_path;
5784db1b SY	225	/*
	226	* <destination> is a file outside of sparse-checkout
	227	* cone. Insist on cone mode here for backward
	228	* compatibility. We don't want dst_mode to be assigned
	229	* for a file when the repo is using no-cone mode (which
	230	* is deprecated at this point) sparse-checkout. As
	231	* SPARSE here is only considering cone-mode situation.
	232	*/
	233	if (!path_in_cone_mode_sparse_checkout(destination[0], &the_index))
	234	dst_mode = SPARSE;
c08830de SY	235	}
	236	}
	237	if (dst_w_slash != dest_path[0]) {
	238	free((char *)dst_w_slash);
	239	dst_w_slash = NULL;
11be42a4 JS	240	}
	241
	242	/* Checking */
c7a20c11	243	for (i = 0; i < argc; i++) {
60a6bf5f	244	const char src = source[i], dst = destination[i];
b91a2b65	245	int length;
11be42a4	246	const char *bad = NULL;
93d2c160	247	int skip_sparse = 0;
11be42a4 JS	248
11be42a4 JS	249	if (show_only)
431b049e	250	printf(_("Checking rename of '%s' to '%s'\n"), src, dst);
11be42a4	251
60a6bf5f	252	length = strlen(src);
93d2c160	253	if (lstat(src, &st) < 0) {
6645b03c SY	254	int pos;
	255	const struct cache_entry *ce;
	256
	257	pos = cache_name_pos(src, length);
	258	if (pos < 0) {
b91a2b65 SY	259	const char *src_w_slash = add_slash(src);
b91a2b65 SY	260	if (!path_in_sparse_checkout(src_w_slash, &the_index) &&
72e59ba1	261	empty_dir_has_sparse_contents(src)) {
b91a2b65 SY	262	modes[i] \|= SKIP_WORKTREE_DIR;
	263	goto dir_check;
	264	}
6645b03c	265	/* only error if existence is expected. */
24ea81d9	266	if (!(modes[i] & SPARSE))
6645b03c SY	267	bad = _("bad source");
	268	goto act_on_entry;
	269	}
6645b03c SY	270	ce = active_cache[pos];
6645b03c SY	271	if (!ce_skip_worktree(ce)) {
93d2c160	272	bad = _("bad source");
7889755b SY	273	goto act_on_entry;
7889755b SY	274	}
8a26a391	275	if (!ignore_sparse) {
6645b03c	276	string_list_append(&only_match_skip_worktree, src);
8a26a391 SY	277	goto act_on_entry;
	278	}
	279	/* Check if dst exists in index */
	280	if (cache_name_pos(dst, strlen(dst)) < 0) {
24ea81d9	281	modes[i] \|= SPARSE;
8a26a391 SY	282	goto act_on_entry;
	283	}
	284	if (!force) {
	285	bad = _("destination exists");
	286	goto act_on_entry;
	287	}
24ea81d9	288	modes[i] \|= SPARSE;
6645b03c	289	goto act_on_entry;
7889755b SY	290	}
	291	if (!strncmp(src, dst, length) &&
	292	(dst[length] == 0 \|\| dst[length] == '/')) {
a7d5629f	293	bad = _("can not move directory into itself");
7889755b SY	294	goto act_on_entry;
7889755b SY	295	}
b91a2b65	296	if (S_ISDIR(st.st_mode)
7889755b	297	&& lstat(dst, &st) == 0) {
a7d5629f	298	bad = _("cannot move directory over file");
7889755b SY	299	goto act_on_entry;
7889755b SY	300	}
b91a2b65 SY	301
	302	dir_check:
	303	if (S_ISDIR(st.st_mode)) {
7889755b	304	int j, dst_len, n;
b46b15de	305	int first = cache_name_pos(src, length), last;
3af05a6d	306
7889755b	307	if (first >= 0) {
3af05a6d NTND	308	prepare_move_submodule(src, first,
3af05a6d NTND	309	submodule_gitfile + i);
7889755b SY	310	goto act_on_entry;
	311	} else if (index_range_of_same_dir(src, length,
	312	&first, &last) < 1) {
b46b15de	313	bad = _("source directory is empty");
7889755b SY	314	goto act_on_entry;
7889755b SY	315	}
11502468	316
7889755b	317	/* last - first >= 1 */
24ea81d9	318	modes[i] \|= WORKING_DIRECTORY;
b6f51e3d SY	319
	320	ALLOC_GROW(src_dir, src_dir_nr + 1, src_dir_alloc);
	321	src_dir[src_dir_nr++] = src;
	322
7889755b SY	323	n = argc + last - first;
	324	REALLOC_ARRAY(source, n);
	325	REALLOC_ARRAY(destination, n);
	326	REALLOC_ARRAY(modes, n);
	327	REALLOC_ARRAY(submodule_gitfile, n);
b46b15de	328
7889755b SY	329	dst = add_slash(dst);
7889755b SY	330	dst_len = strlen(dst);
b46b15de	331
7889755b SY	332	for (j = 0; j < last - first; j++) {
	333	const struct cache_entry *ce = active_cache[first + j];
	334	const char *path = ce->name;
	335	source[argc + j] = path;
	336	destination[argc + j] =
	337	prefix_path(dst, dst_len, path + length + 1);
24ea81d9 SY	338	memset(modes + argc + j, 0, sizeof(enum update_mode));
24ea81d9 SY	339	modes[argc + j] \|= ce_skip_worktree(ce) ? SPARSE : INDEX;
7889755b	340	submodule_gitfile[argc + j] = NULL;
ac64a722	341	}
7889755b SY	342	argc += last - first;
	343	goto act_on_entry;
	344	}
	345	if (!(ce = cache_file_exists(src, length, 0))) {
a7d5629f	346	bad = _("not under version control");
7889755b SY	347	goto act_on_entry;
	348	}
	349	if (ce_stage(ce)) {
9b906af6	350	bad = _("conflicted");
7889755b SY	351	goto act_on_entry;
	352	}
	353	if (lstat(dst, &st) == 0 &&
	354	(!ignore_case \|\| strcasecmp(src, dst))) {
a7d5629f	355	bad = _("destination exists");
11be42a4 JS	356	if (force) {
	357	/*
	358	* only files can overwrite each other:
	359	* check both source and destination
	360	*/
81dc2307	361	if (S_ISREG(st.st_mode) \|\| S_ISLNK(st.st_mode)) {
534376ca JK	362	if (verbose)
534376ca JK	363	warning(_("overwriting '%s'"), dst);
11be42a4	364	bad = NULL;
11be42a4	365	} else
a7d5629f	366	bad = _("Cannot overwrite");
11be42a4	367	}
7889755b SY	368	goto act_on_entry;
	369	}
	370	if (string_list_has_string(&src_for_dst, dst)) {
a7d5629f	371	bad = _("multiple sources for the same target");
7889755b SY	372	goto act_on_entry;
	373	}
	374	if (is_dir_sep(dst[strlen(dst) - 1])) {
a8933469	375	bad = _("destination directory does not exist");
7889755b SY	376	goto act_on_entry;
7889755b SY	377	}
93d2c160	378
7889755b SY	379	/*
	380	* We check if the paths are in the sparse-checkout
	381	* definition as a very final check, since that
	382	* allows us to point the user to the --sparse
	383	* option as a way to have a successful run.
	384	*/
	385	if (!ignore_sparse &&
	386	!path_in_sparse_checkout(src, &the_index)) {
	387	string_list_append(&only_match_skip_worktree, src);
	388	skip_sparse = 1;
	389	}
	390	if (!ignore_sparse &&
	391	!path_in_sparse_checkout(dst, &the_index)) {
	392	string_list_append(&only_match_skip_worktree, dst);
	393	skip_sparse = 1;
93d2c160	394	}
11be42a4	395
7889755b SY	396	if (skip_sparse)
	397	goto remove_entry;
	398
	399	string_list_insert(&src_for_dst, dst);
	400
	401	act_on_entry:
ad1a19d0 NTND	402	if (!bad)
	403	continue;
	404	if (!ignore_errors)
4f1bbd23	405	die(_("%s, source=%s, destination=%s"),
ad1a19d0	406	bad, src, dst);
93d2c160	407	remove_entry:
ad1a19d0 NTND	408	if (--argc > 0) {
	409	int n = argc - i;
	410	memmove(source + i, source + i + 1,
	411	n * sizeof(char *));
	412	memmove(destination + i, destination + i + 1,
	413	n * sizeof(char *));
	414	memmove(modes + i, modes + i + 1,
	415	n * sizeof(enum update_mode));
	416	memmove(submodule_gitfile + i, submodule_gitfile + i + 1,
	417	n * sizeof(char *));
	418	i--;
11be42a4 JS	419	}
	420	}
	421
93d2c160 DS	422	if (only_match_skip_worktree.nr) {
	423	advise_on_updating_sparse_paths(&only_match_skip_worktree);
	424	if (!ignore_errors)
	425	return 1;
	426	}
	427
c7a20c11	428	for (i = 0; i < argc; i++) {
60a6bf5f JS	429	const char src = source[i], dst = destination[i];
60a6bf5f JS	430	enum update_mode mode = modes[i];
81dc2307	431	int pos;
5784db1b	432	int sparse_and_dirty = 0;
707fa2f7 SY	433	struct checkout state = CHECKOUT_INIT;
	434	state.istate = &the_index;
	435
	436	if (force)
	437	state.force = 1;
11be42a4	438	if (show_only \|\| verbose)
431b049e	439	printf(_("Renaming %s to %s\n"), src, dst);
a127331c SB	440	if (show_only)
a127331c SB	441	continue;
b91a2b65	442	if (!(mode & (INDEX \| SPARSE \| SKIP_WORKTREE_DIR)) &&
5784db1b	443	!(dst_mode & (SKIP_WORKTREE_DIR \| SPARSE)) &&
24ea81d9	444	rename(src, dst) < 0) {
a127331c SB	445	if (ignore_errors)
	446	continue;
	447	die_errno(_("renaming '%s' failed"), src);
	448	}
	449	if (submodule_gitfile[i]) {
a127331c SB	450	if (!update_path_in_gitmodules(src, dst))
a127331c SB	451	gitmodules_modified = 1;
da62f786 SB	452	if (submodule_gitfile[i] != SUBMODULE_WITH_GITDIR)
	453	connect_work_tree_and_git_dir(dst,
	454	submodule_gitfile[i],
	455	1);
a88c915d	456	}
60a6bf5f	457
b91a2b65	458	if (mode & (WORKING_DIRECTORY \| SKIP_WORKTREE_DIR))
ac64a722 JS	459	continue;
ac64a722 JS	460
81dc2307 PB	461	pos = cache_name_pos(src, strlen(src));
81dc2307 PB	462	assert(pos >= 0);
5784db1b SY	463	if (!(mode & SPARSE) && !lstat(src, &st))
5784db1b SY	464	sparse_and_dirty = ce_modified(active_cache[pos], &st, 0);
4cbe92fd	465	rename_cache_entry_at(pos, dst);
707fa2f7	466
5784db1b SY	467	if (ignore_sparse &&
	468	core_apply_sparse_checkout &&
	469	core_sparse_checkout_cone) {
	470	/*
	471	* NEEDSWORK: we are not paying attention to
	472	* "out-to-out" move (<source> is out-of-cone and
	473	* <destination> is out-of-cone) at this point. It
	474	* should be added in a future patch.
	475	*/
	476	if ((mode & SPARSE) &&
	477	path_in_sparse_checkout(dst, &the_index)) {
	478	/* from out-of-cone to in-cone */
	479	int dst_pos = cache_name_pos(dst, strlen(dst));
	480	struct cache_entry *dst_ce = active_cache[dst_pos];
	481
	482	dst_ce->ce_flags &= ~CE_SKIP_WORKTREE;
	483
	484	if (checkout_entry(dst_ce, &state, NULL, NULL))
	485	die(_("cannot checkout %s"), dst_ce->name);
	486	} else if ((dst_mode & (SKIP_WORKTREE_DIR \| SPARSE)) &&
	487	!(mode & SPARSE) &&
	488	!path_in_sparse_checkout(dst, &the_index)) {
	489	/* from in-cone to out-of-cone */
	490	int dst_pos = cache_name_pos(dst, strlen(dst));
	491	struct cache_entry *dst_ce = active_cache[dst_pos];
707fa2f7	492
5784db1b SY	493	/*
	494	* if src is clean, it will suffice to remove it
	495	*/
	496	if (!sparse_and_dirty) {
	497	dst_ce->ce_flags \|= CE_SKIP_WORKTREE;
	498	unlink_or_warn(src);
	499	} else {
	500	/*
	501	* if src is dirty, move it to the
	502	* destination and create leading
	503	* dirs if necessary
	504	*/
	505	char *dst_dup = xstrdup(dst);
	506	string_list_append(&dirty_paths, dst);
	507	safe_create_leading_directories(dst_dup);
	508	FREE_AND_NULL(dst_dup);
	509	rename(src, dst);
	510	}
	511	}
707fa2f7	512	}
11be42a4 JS	513	}
11be42a4 JS	514
b6f51e3d SY	515	/*
	516	* cleanup the empty src_dirs
	517	*/
	518	for (i = 0; i < src_dir_nr; i++) {
	519	int dummy;
	520	strbuf_addstr(&a_src_dir, src_dir[i]);
	521	/*
	522	* if entries under a_src_dir are all moved away,
	523	* recursively remove a_src_dir to cleanup
	524	*/
	525	if (index_range_of_same_dir(a_src_dir.buf, a_src_dir.len,
	526	&dummy, &dummy) < 1) {
	527	remove_dir_recursively(&a_src_dir, 0);
	528	}
	529	strbuf_reset(&a_src_dir);
	530	}
	531
	532	strbuf_release(&a_src_dir);
	533	free(src_dir);
	534
0656781f	535	if (gitmodules_modified)
3b8317a9	536	stage_updated_gitmodules(&the_index);
0656781f	537
61000814 MÅ	538	if (write_locked_index(&the_index, &lock_file,
61000814 MÅ	539	COMMIT_LOCK \| SKIP_IF_UNCHANGED))
dcadc8b8	540	die(_("Unable to write new index file"));
11be42a4	541
ed3c566d	542	string_list_clear(&src_for_dst, 0);
5784db1b	543	string_list_clear(&dirty_paths, 0);
ed3c566d AH	544	UNLEAK(source);
	545	UNLEAK(dest_path);
	546	free(submodule_gitfile);
	547	free(modes);
11be42a4 JS	548	return 0;
11be42a4 JS	549	}