[thirdparty/git.git] / checkout-cache.c

/*
 * Check-out files from the "current cache directory"
 *
 * Copyright (C) 2005 Linus Torvalds
 *
 * Careful: order of argument flags does matter. For example,
 *
 *	git-checkout-cache -a -f file.c
 *
 * Will first check out all files listed in the cache (but not
 * overwrite any old ones), and then force-checkout "file.c" a
 * second time (ie that one _will_ overwrite any old contents
 * with the same filename).
 *
 * Also, just doing "git-checkout-cache" does nothing. You probably
 * meant "git-checkout-cache -a". And if you want to force it, you
 * want "git-checkout-cache -f -a".
 *
 * Intuitiveness is not the goal here. Repeatability is. The
 * reason for the "no arguments means no work" thing is that
 * from scripts you are supposed to be able to do things like
 *
 *	find . -name '*.h' -print0 | xargs -0 git-checkout-cache -f --
 *
 * which will force all existing *.h files to be replaced with
 * their cached copies. If an empty command line implied "all",
 * then this would force-refresh everything in the cache, which
 * was not the point.
 *
 * Oh, and the "--" is just a good idea when you know the rest
 * will be filenames. Just so that you wouldn't have a filename
 * of "-a" causing problems (not possible in the above example,
 * but get used to it in scripting!).
 */
#include <sys/types.h>
#include <dirent.h>
#include "cache.h"

static int force = 0, quiet = 0, not_new = 0, refresh_cache = 0;
static const char *base_dir = "";
static int base_dir_len = 0;

static void create_directories(const char *path)
{
	int len = strlen(path);
	char *buf = xmalloc(len + 1);
	const char *slash = path;

	while ((slash = strchr(slash+1, '/')) != NULL) {
		len = slash - path;
		memcpy(buf, path, len);
		buf[len] = 0;
		if (mkdir(buf, 0755)) {
			if (errno == EEXIST) {
				struct stat st;
				if (len > base_dir_len && force && !unlink(buf) && !mkdir(buf, 0755))
					continue;
				if (!stat(buf, &st) && S_ISDIR(st.st_mode))
					continue; /* ok */
			}
			die("cannot create directory at %s", buf);
		}
	}
	free(buf);
}

static void remove_subtree(const char *path)
{
	DIR *dir = opendir(path);
	struct dirent *de;
	char pathbuf[PATH_MAX];
	char *name;
	
	if (!dir)
		die("cannot opendir %s", path);
	strcpy(pathbuf, path);
	name = pathbuf + strlen(path);
	*name++ = '/';
	while ((de = readdir(dir)) != NULL) {
		struct stat st;
		if ((de->d_name[0] == '.') &&
		    ((de->d_name[1] == 0) ||
		     ((de->d_name[1] == '.') && de->d_name[2] == 0)))
			continue;
		strcpy(name, de->d_name);
		if (lstat(pathbuf, &st))
			die("cannot lstat %s", pathbuf);
		if (S_ISDIR(st.st_mode))
			remove_subtree(pathbuf);
		else if (unlink(pathbuf))
			die("cannot unlink %s", pathbuf);
	}
	closedir(dir);
	if (rmdir(path))
		die("cannot rmdir %s", path);
}

static int create_file(const char *path, unsigned int mode)
{
	int fd;

	mode = (mode & 0100) ? 0777 : 0666;
	create_directories(path);
	fd = open(path, O_WRONLY | O_TRUNC | O_CREAT, mode);
	if (fd < 0) {
		if (errno == EISDIR && force) {
			remove_subtree(path);
			fd = open(path, O_WRONLY | O_TRUNC | O_CREAT, mode);
		}
	}
	return fd;
}

static int write_entry(struct cache_entry *ce, const char *path)
{
	int fd;
	void *new;
	unsigned long size;
	long wrote;
	char type[20];
	char target[1024];

	new = read_sha1_file(ce->sha1, type, &size);
	if (!new || strcmp(type, "blob")) {
		if (new)
			free(new);
		return error("git-checkout-cache: unable to read sha1 file of %s (%s)",
			path, sha1_to_hex(ce->sha1));
	}
	switch (ntohl(ce->ce_mode) & S_IFMT) {
	case S_IFREG:
		fd = create_file(path, ntohl(ce->ce_mode));
		if (fd < 0) {
			free(new);
			return error("git-checkout-cache: unable to create file %s (%s)",
				path, strerror(errno));
		}
		wrote = write(fd, new, size);
		close(fd);
		free(new);
		if (wrote != size)
			return error("git-checkout-cache: unable to write file %s", path);
		break;
	case S_IFLNK:
		memcpy(target, new, size);
		target[size] = '\0';
		create_directories(path);
		if (symlink(target, path)) {
			free(new);
			return error("git-checkout-cache: unable to create symlink %s (%s)",
				path, strerror(errno));
		}
		free(new);
		break;
	default:
		free(new);
		return error("git-checkout-cache: unknown file mode for %s", path);
	}

	if (refresh_cache) {
		struct stat st;
		lstat(ce->name, &st);
		fill_stat_cache_info(ce, &st);
	}
	return 0;
}

static int checkout_entry(struct cache_entry *ce)
{
	struct stat st;
	static char path[MAXPATHLEN+1];
	int len = base_dir_len;

	memcpy(path, base_dir, len);
	strcpy(path + len, ce->name);

	if (!lstat(path, &st)) {
		unsigned changed = ce_match_stat(ce, &st);
		if (!changed)
			return 0;
		if (!force) {
			if (!quiet)
				fprintf(stderr, "git-checkout-cache: %s already exists\n", path);
			return 0;
		}

		/*
		 * We unlink the old file, to get the new one with the
		 * right permissions (including umask, which is nasty
		 * to emulate by hand - much easier to let the system
		 * just do the right thing)
		 */
		unlink(path);
	} else if (not_new) 
		return 0;
	return write_entry(ce, path);
}

static int checkout_file(const char *name)
{
	int pos = cache_name_pos(name, strlen(name));
	if (pos < 0) {
		if (!quiet) {
			pos = -pos - 1;
			fprintf(stderr,
				"git-checkout-cache: %s is %s.\n",
				name,
				(pos < active_nr &&
				 !strcmp(active_cache[pos]->name, name)) ?
				"unmerged" : "not in the cache");
		}
		return -1;
	}
	return checkout_entry(active_cache[pos]);
}

static int checkout_all(void)
{
	int i;

	for (i = 0; i < active_nr ; i++) {
		struct cache_entry *ce = active_cache[i];
		if (ce_stage(ce))
			continue;
		if (checkout_entry(ce) < 0)
			return -1;
	}
	return 0;
}

int main(int argc, char **argv)
{
	int i, force_filename = 0;
	struct cache_file cache_file;
	int newfd = -1;

	if (read_cache() < 0) {
		die("invalid cache");
	}

	for (i = 1; i < argc; i++) {
		const char *arg = argv[i];
		if (!force_filename) {
			if (!strcmp(arg, "-a")) {
				checkout_all();
				continue;
			}
			if (!strcmp(arg, "--")) {
				force_filename = 1;
				continue;
			}
			if (!strcmp(arg, "-f")) {
				force = 1;
				continue;
			}
			if (!strcmp(arg, "-q")) {
				quiet = 1;
				continue;
			}
			if (!strcmp(arg, "-n")) {
				not_new = 1;
				continue;
			}
			if (!strcmp(arg, "-u")) {
				refresh_cache = 1;
				if (newfd < 0)
					newfd = hold_index_file_for_update
						(&cache_file,
						 get_index_file());
				if (newfd < 0)
					die("cannot open index.lock file.");
				continue;
			}
			if (!memcmp(arg, "--prefix=", 9)) {
				base_dir = arg+9;
				base_dir_len = strlen(base_dir);
				continue;
			}
		}
		if (base_dir_len) {
			/* when --prefix is specified we do not
			 * want to update cache.
			 */
			if (refresh_cache) {
				close(newfd); newfd = -1;
				rollback_index_file(&cache_file);
			}
			refresh_cache = 0;
		}
		checkout_file(arg);
	}

	if (0 <= newfd &&
	    (write_cache(newfd, active_cache, active_nr) ||
	     commit_index_file(&cache_file)))
		die("Unable to write new cachefile");
	return 0;
}
Commit	Line	Data
33db5f4d LT	1	/*
	2	* Check-out files from the "current cache directory"
	3	*
	4	* Copyright (C) 2005 Linus Torvalds
	5	*
	6	* Careful: order of argument flags does matter. For example,
	7	*
667bb59b	8	* git-checkout-cache -a -f file.c
33db5f4d LT	9	*
	10	* Will first check out all files listed in the cache (but not
	11	* overwrite any old ones), and then force-checkout "file.c" a
	12	* second time (ie that one _will_ overwrite any old contents
	13	* with the same filename).
	14	*
667bb59b AN	15	* Also, just doing "git-checkout-cache" does nothing. You probably
	16	* meant "git-checkout-cache -a". And if you want to force it, you
	17	* want "git-checkout-cache -f -a".
33db5f4d LT	18	*
	19	* Intuitiveness is not the goal here. Repeatability is. The
	20	* reason for the "no arguments means no work" thing is that
	21	* from scripts you are supposed to be able to do things like
	22	*
667bb59b	23	* find . -name '*.h' -print0 \| xargs -0 git-checkout-cache -f --
33db5f4d LT	24	*
	25	* which will force all existing *.h files to be replaced with
	26	* their cached copies. If an empty command line implied "all",
	27	* then this would force-refresh everything in the cache, which
	28	* was not the point.
	29	*
	30	* Oh, and the "--" is just a good idea when you know the rest
	31	* will be filenames. Just so that you wouldn't have a filename
	32	* of "-a" causing problems (not possible in the above example,
	33	* but get used to it in scripting!).
	34	*/
1126b419 JH	35	#include <sys/types.h>
1126b419 JH	36	#include <dirent.h>
33db5f4d LT	37	#include "cache.h"
33db5f4d LT	38
415e96c8	39	static int force = 0, quiet = 0, not_new = 0, refresh_cache = 0;
d7f6ea3d JH	40	static const char *base_dir = "";
d7f6ea3d JH	41	static int base_dir_len = 0;
33db5f4d	42
83adac3c LT	43	static void create_directories(const char *path)
	44	{
	45	int len = strlen(path);
812666c8	46	char *buf = xmalloc(len + 1);
83adac3c LT	47	const char *slash = path;
	48
	49	while ((slash = strchr(slash+1, '/')) != NULL) {
	50	len = slash - path;
	51	memcpy(buf, path, len);
	52	buf[len] = 0;
1126b419 JH	53	if (mkdir(buf, 0755)) {
	54	if (errno == EEXIST) {
	55	struct stat st;
d7f6ea3d	56	if (len > base_dir_len && force && !unlink(buf) && !mkdir(buf, 0755))
1126b419	57	continue;
d7f6ea3d JH	58	if (!stat(buf, &st) && S_ISDIR(st.st_mode))
d7f6ea3d JH	59	continue; /* ok */
1126b419 JH	60	}
	61	die("cannot create directory at %s", buf);
	62	}
83adac3c	63	}
36997b45	64	free(buf);
83adac3c LT	65	}
83adac3c LT	66
1126b419 JH	67	static void remove_subtree(const char *path)
	68	{
	69	DIR *dir = opendir(path);
	70	struct dirent *de;
	71	char pathbuf[PATH_MAX];
	72	char *name;
	73
	74	if (!dir)
	75	die("cannot opendir %s", path);
	76	strcpy(pathbuf, path);
	77	name = pathbuf + strlen(path);
	78	*name++ = '/';
	79	while ((de = readdir(dir)) != NULL) {
	80	struct stat st;
	81	if ((de->d_name[0] == '.') &&
	82	((de->d_name[1] == 0) \|\|
	83	((de->d_name[1] == '.') && de->d_name[2] == 0)))
	84	continue;
	85	strcpy(name, de->d_name);
	86	if (lstat(pathbuf, &st))
	87	die("cannot lstat %s", pathbuf);
	88	if (S_ISDIR(st.st_mode))
	89	remove_subtree(pathbuf);
	90	else if (unlink(pathbuf))
	91	die("cannot unlink %s", pathbuf);
	92	}
	93	closedir(dir);
	94	if (rmdir(path))
	95	die("cannot rmdir %s", path);
	96	}
	97
83adac3c LT	98	static int create_file(const char *path, unsigned int mode)
83adac3c LT	99	{
e4479470 LT	100	int fd;
e4479470 LT	101
fa06d442	102	mode = (mode & 0100) ? 0777 : 0666;
1126b419	103	create_directories(path);
e4479470	104	fd = open(path, O_WRONLY \| O_TRUNC \| O_CREAT, mode);
83adac3c	105	if (fd < 0) {
1126b419 JH	106	if (errno == EISDIR && force) {
1126b419 JH	107	remove_subtree(path);
e4479470	108	fd = open(path, O_WRONLY \| O_TRUNC \| O_CREAT, mode);
83adac3c LT	109	}
83adac3c LT	110	}
83adac3c LT	111	return fd;
	112	}
	113
65bb4914	114	static int write_entry(struct cache_entry ce, const char path)
33db5f4d LT	115	{
	116	int fd;
	117	void *new;
	118	unsigned long size;
	119	long wrote;
8d3af1d5	120	char type[20];
8ae0a8c5	121	char target[1024];
33db5f4d	122
8d3af1d5 LT	123	new = read_sha1_file(ce->sha1, type, &size);
8d3af1d5 LT	124	if (!new \|\| strcmp(type, "blob")) {
aceedfe3 IM	125	if (new)
aceedfe3 IM	126	free(new);
667bb59b	127	return error("git-checkout-cache: unable to read sha1 file of %s (%s)",
65bb4914	128	path, sha1_to_hex(ce->sha1));
33db5f4d	129	}
8ae0a8c5 KS	130	switch (ntohl(ce->ce_mode) & S_IFMT) {
	131	case S_IFREG:
	132	fd = create_file(path, ntohl(ce->ce_mode));
	133	if (fd < 0) {
	134	free(new);
667bb59b	135	return error("git-checkout-cache: unable to create file %s (%s)",
8ae0a8c5 KS	136	path, strerror(errno));
	137	}
	138	wrote = write(fd, new, size);
	139	close(fd);
	140	free(new);
	141	if (wrote != size)
667bb59b	142	return error("git-checkout-cache: unable to write file %s", path);
8ae0a8c5 KS	143	break;
	144	case S_IFLNK:
	145	memcpy(target, new, size);
	146	target[size] = '\0';
d5f415e6	147	create_directories(path);
8ae0a8c5 KS	148	if (symlink(target, path)) {
8ae0a8c5 KS	149	free(new);
667bb59b	150	return error("git-checkout-cache: unable to create symlink %s (%s)",
8ae0a8c5 KS	151	path, strerror(errno));
	152	}
	153	free(new);
	154	break;
	155	default:
33db5f4d	156	free(new);
667bb59b	157	return error("git-checkout-cache: unknown file mode for %s", path);
33db5f4d	158	}
415e96c8 JH	159
	160	if (refresh_cache) {
	161	struct stat st;
	162	lstat(ce->name, &st);
	163	fill_stat_cache_info(ce, &st);
	164	}
2de381f9	165	return 0;
33db5f4d LT	166	}
33db5f4d LT	167
d7f6ea3d	168	static int checkout_entry(struct cache_entry *ce)
33db5f4d	169	{
29d76d4b	170	struct stat st;
65bb4914	171	static char path[MAXPATHLEN+1];
d7f6ea3d	172	int len = base_dir_len;
65bb4914 LT	173
	174	memcpy(path, base_dir, len);
	175	strcpy(path + len, ce->name);
33db5f4d	176
8ae0a8c5	177	if (!lstat(path, &st)) {
5d728c84	178	unsigned changed = ce_match_stat(ce, &st);
29d76d4b LT	179	if (!changed)
	180	return 0;
	181	if (!force) {
	182	if (!quiet)
667bb59b	183	fprintf(stderr, "git-checkout-cache: %s already exists\n", path);
f7391ce3	184	return 0;
33db5f4d	185	}
e4479470 LT	186
	187	/*
	188	* We unlink the old file, to get the new one with the
	189	* right permissions (including umask, which is nasty
	190	* to emulate by hand - much easier to let the system
	191	* just do the right thing)
	192	*/
65bb4914	193	unlink(path);
32718b6c JB	194	} else if (not_new)
32718b6c JB	195	return 0;
65bb4914	196	return write_entry(ce, path);
33db5f4d LT	197	}
33db5f4d LT	198
d7f6ea3d	199	static int checkout_file(const char *name)
33db5f4d LT	200	{
	201	int pos = cache_name_pos(name, strlen(name));
	202	if (pos < 0) {
a38800fd JH	203	if (!quiet) {
	204	pos = -pos - 1;
	205	fprintf(stderr,
667bb59b	206	"git-checkout-cache: %s is %s.\n",
a38800fd JH	207	name,
	208	(pos < active_nr &&
	209	!strcmp(active_cache[pos]->name, name)) ?
	210	"unmerged" : "not in the cache");
	211	}
33db5f4d LT	212	return -1;
33db5f4d LT	213	}
d7f6ea3d	214	return checkout_entry(active_cache[pos]);
33db5f4d LT	215	}
33db5f4d LT	216
d7f6ea3d	217	static int checkout_all(void)
33db5f4d LT	218	{
	219	int i;
	220
	221	for (i = 0; i < active_nr ; i++) {
	222	struct cache_entry *ce = active_cache[i];
d9f98eeb LT	223	if (ce_stage(ce))
d9f98eeb LT	224	continue;
d7f6ea3d	225	if (checkout_entry(ce) < 0)
33db5f4d LT	226	return -1;
	227	}
	228	return 0;
	229	}
	230
	231	int main(int argc, char **argv)
	232	{
	233	int i, force_filename = 0;
415e96c8 JH	234	struct cache_file cache_file;
415e96c8 JH	235	int newfd = -1;
33db5f4d LT	236
33db5f4d LT	237	if (read_cache() < 0) {
2de381f9	238	die("invalid cache");
33db5f4d LT	239	}
	240
	241	for (i = 1; i < argc; i++) {
	242	const char *arg = argv[i];
	243	if (!force_filename) {
	244	if (!strcmp(arg, "-a")) {
d7f6ea3d	245	checkout_all();
33db5f4d LT	246	continue;
	247	}
	248	if (!strcmp(arg, "--")) {
	249	force_filename = 1;
	250	continue;
	251	}
	252	if (!strcmp(arg, "-f")) {
	253	force = 1;
	254	continue;
	255	}
	256	if (!strcmp(arg, "-q")) {
	257	quiet = 1;
	258	continue;
	259	}
32718b6c JB	260	if (!strcmp(arg, "-n")) {
	261	not_new = 1;
	262	continue;
	263	}
415e96c8 JH	264	if (!strcmp(arg, "-u")) {
	265	refresh_cache = 1;
	266	if (newfd < 0)
	267	newfd = hold_index_file_for_update
	268	(&cache_file,
	269	get_index_file());
	270	if (newfd < 0)
	271	die("cannot open index.lock file.");
	272	continue;
	273	}
65bb4914 LT	274	if (!memcmp(arg, "--prefix=", 9)) {
65bb4914 LT	275	base_dir = arg+9;
d7f6ea3d	276	base_dir_len = strlen(base_dir);
65bb4914 LT	277	continue;
65bb4914 LT	278	}
33db5f4d	279	}
d7f6ea3d	280	if (base_dir_len) {
415e96c8 JH	281	/* when --prefix is specified we do not
	282	* want to update cache.
	283	*/
	284	if (refresh_cache) {
	285	close(newfd); newfd = -1;
	286	rollback_index_file(&cache_file);
	287	}
	288	refresh_cache = 0;
	289	}
d7f6ea3d	290	checkout_file(arg);
33db5f4d	291	}
415e96c8 JH	292
	293	if (0 <= newfd &&
	294	(write_cache(newfd, active_cache, active_nr) \|\|
	295	commit_index_file(&cache_file)))
	296	die("Unable to write new cachefile");
33db5f4d LT	297	return 0;
33db5f4d LT	298	}