[thirdparty/git.git] / archive.c

#include "cache.h"
#include "commit.h"
#include "tree-walk.h"
#include "attr.h"
#include "archive.h"
#include "parse-options.h"

static char const * const archive_usage[] = {
	"git archive [options] <tree-ish> [path...]",
	"git archive --list",
	"git archive --remote <repo> [--exec <cmd>] [options] <tree-ish> [path...]",
	"git archive --remote <repo> [--exec <cmd>] --list",
	NULL
};

#define USES_ZLIB_COMPRESSION 1

static const struct archiver {
	const char *name;
	write_archive_fn_t write_archive;
	unsigned int flags;
} archivers[] = {
	{ "tar", write_tar_archive },
	{ "zip", write_zip_archive, USES_ZLIB_COMPRESSION },
};

static void format_subst(const struct commit *commit,
                         const char *src, size_t len,
                         struct strbuf *buf)
{
	char *to_free = NULL;
	struct strbuf fmt = STRBUF_INIT;

	if (src == buf->buf)
		to_free = strbuf_detach(buf, NULL);
	for (;;) {
		const char *b, *c;

		b = memmem(src, len, "$Format:", 8);
		if (!b)
			break;
		c = memchr(b + 8, '$', (src + len) - b - 8);
		if (!c)
			break;

		strbuf_reset(&fmt);
		strbuf_add(&fmt, b + 8, c - b - 8);

		strbuf_add(buf, src, b - src);
		format_commit_message(commit, fmt.buf, buf, DATE_NORMAL);
		len -= c + 1 - src;
		src  = c + 1;
	}
	strbuf_add(buf, src, len);
	strbuf_release(&fmt);
	free(to_free);
}

static void *sha1_file_to_archive(const char *path, const unsigned char *sha1,
		unsigned int mode, enum object_type *type,
		unsigned long *sizep, const struct commit *commit)
{
	void *buffer;

	buffer = read_sha1_file(sha1, type, sizep);
	if (buffer && S_ISREG(mode)) {
		struct strbuf buf = STRBUF_INIT;
		size_t size = 0;

		strbuf_attach(&buf, buffer, *sizep, *sizep + 1);
		convert_to_working_tree(path, buf.buf, buf.len, &buf);
		if (commit)
			format_subst(commit, buf.buf, buf.len, &buf);
		buffer = strbuf_detach(&buf, &size);
		*sizep = size;
	}

	return buffer;
}

static void setup_archive_check(struct git_attr_check *check)
{
	static struct git_attr *attr_export_ignore;
	static struct git_attr *attr_export_subst;

	if (!attr_export_ignore) {
		attr_export_ignore = git_attr("export-ignore", 13);
		attr_export_subst = git_attr("export-subst", 12);
	}
	check[0].attr = attr_export_ignore;
	check[1].attr = attr_export_subst;
}

struct archiver_context {
	struct archiver_args *args;
	write_archive_entry_fn_t write_entry;
};

static int write_archive_entry(const unsigned char *sha1, const char *base,
		int baselen, const char *filename, unsigned mode, int stage,
		void *context)
{
	static struct strbuf path = STRBUF_INIT;
	struct archiver_context *c = context;
	struct archiver_args *args = c->args;
	write_archive_entry_fn_t write_entry = c->write_entry;
	struct git_attr_check check[2];
	const char *path_without_prefix;
	int convert = 0;
	int err;
	enum object_type type;
	unsigned long size;
	void *buffer;

	strbuf_reset(&path);
	strbuf_grow(&path, PATH_MAX);
	strbuf_add(&path, base, baselen);
	strbuf_addstr(&path, filename);
	path_without_prefix = path.buf + args->baselen;

	setup_archive_check(check);
	if (!git_checkattr(path_without_prefix, ARRAY_SIZE(check), check)) {
		if (ATTR_TRUE(check[0].value))
			return 0;
		convert = ATTR_TRUE(check[1].value);
	}

	if (S_ISDIR(mode) || S_ISGITLINK(mode)) {
		strbuf_addch(&path, '/');
		if (args->verbose)
			fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
		err = write_entry(args, sha1, path.buf, path.len, mode, NULL, 0);
		if (err)
			return err;
		return (S_ISDIR(mode) ? READ_TREE_RECURSIVE : 0);
	}

	buffer = sha1_file_to_archive(path_without_prefix, sha1, mode,
			&type, &size, convert ? args->commit : NULL);
	if (!buffer)
		return error("cannot read %s", sha1_to_hex(sha1));
	if (args->verbose)
		fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
	err = write_entry(args, sha1, path.buf, path.len, mode, buffer, size);
	free(buffer);
	return err;
}

int write_archive_entries(struct archiver_args *args,
		write_archive_entry_fn_t write_entry)
{
	struct archiver_context context;
	int err;

	if (args->baselen > 0 && args->base[args->baselen - 1] == '/') {
		size_t len = args->baselen;

		while (len > 1 && args->base[len - 2] == '/')
			len--;
		if (args->verbose)
			fprintf(stderr, "%.*s\n", (int)len, args->base);
		err = write_entry(args, args->tree->object.sha1, args->base,
				len, 040777, NULL, 0);
		if (err)
			return err;
	}

	context.args = args;
	context.write_entry = write_entry;

	err =  read_tree_recursive(args->tree, args->base, args->baselen, 0,
			args->pathspec, write_archive_entry, &context);
	if (err == READ_TREE_RECURSIVE)
		err = 0;
	return err;
}

static const struct archiver *lookup_archiver(const char *name)
{
	int i;

	if (!name)
		return NULL;

	for (i = 0; i < ARRAY_SIZE(archivers); i++) {
		if (!strcmp(name, archivers[i].name))
			return &archivers[i];
	}
	return NULL;
}

static void parse_pathspec_arg(const char **pathspec,
		struct archiver_args *ar_args)
{
	ar_args->pathspec = get_pathspec(ar_args->base, pathspec);
}

static void parse_treeish_arg(const char **argv,
		struct archiver_args *ar_args, const char *prefix)
{
	const char *name = argv[0];
	const unsigned char *commit_sha1;
	time_t archive_time;
	struct tree *tree;
	const struct commit *commit;
	unsigned char sha1[20];

	if (get_sha1(name, sha1))
		die("Not a valid object name");

	commit = lookup_commit_reference_gently(sha1, 1);
	if (commit) {
		commit_sha1 = commit->object.sha1;
		archive_time = commit->date;
	} else {
		commit_sha1 = NULL;
		archive_time = time(NULL);
	}

	tree = parse_tree_indirect(sha1);
	if (tree == NULL)
		die("not a tree object");

	if (prefix) {
		unsigned char tree_sha1[20];
		unsigned int mode;
		int err;

		err = get_tree_entry(tree->object.sha1, prefix,
				     tree_sha1, &mode);
		if (err || !S_ISDIR(mode))
			die("current working directory is untracked");

		tree = parse_tree_indirect(tree_sha1);
	}
	ar_args->tree = tree;
	ar_args->commit_sha1 = commit_sha1;
	ar_args->commit = commit;
	ar_args->time = archive_time;
}

#define OPT__COMPR(s, v, h, p) \
	{ OPTION_SET_INT, (s), NULL, (v), NULL, (h), \
	  PARSE_OPT_NOARG | PARSE_OPT_NONEG, NULL, (p) }
#define OPT__COMPR_HIDDEN(s, v, p) \
	{ OPTION_SET_INT, (s), NULL, (v), NULL, "", \
	  PARSE_OPT_NOARG | PARSE_OPT_NONEG | PARSE_OPT_HIDDEN, NULL, (p) }

static int parse_archive_args(int argc, const char **argv,
		const struct archiver **ar, struct archiver_args *args)
{
	const char *format = "tar";
	const char *base = NULL;
	const char *remote = NULL;
	const char *exec = NULL;
	int compression_level = -1;
	int verbose = 0;
	int i;
	int list = 0;
	struct option opts[] = {
		OPT_GROUP(""),
		OPT_STRING(0, "format", &format, "fmt", "archive format"),
		OPT_STRING(0, "prefix", &base, "prefix",
			"prepend prefix to each pathname in the archive"),
		OPT__VERBOSE(&verbose),
		OPT__COMPR('0', &compression_level, "store only", 0),
		OPT__COMPR('1', &compression_level, "compress faster", 1),
		OPT__COMPR_HIDDEN('2', &compression_level, 2),
		OPT__COMPR_HIDDEN('3', &compression_level, 3),
		OPT__COMPR_HIDDEN('4', &compression_level, 4),
		OPT__COMPR_HIDDEN('5', &compression_level, 5),
		OPT__COMPR_HIDDEN('6', &compression_level, 6),
		OPT__COMPR_HIDDEN('7', &compression_level, 7),
		OPT__COMPR_HIDDEN('8', &compression_level, 8),
		OPT__COMPR('9', &compression_level, "compress better", 9),
		OPT_GROUP(""),
		OPT_BOOLEAN('l', "list", &list,
			"list supported archive formats"),
		OPT_GROUP(""),
		OPT_STRING(0, "remote", &remote, "repo",
			"retrieve the archive from remote repository <repo>"),
		OPT_STRING(0, "exec", &exec, "cmd",
			"path to the remote git-upload-archive command"),
		OPT_END()
	};

	argc = parse_options(argc, argv, opts, archive_usage, 0);

	if (remote)
		die("Unexpected option --remote");
	if (exec)
		die("Option --exec can only be used together with --remote");

	if (!base)
		base = "";

	if (list) {
		for (i = 0; i < ARRAY_SIZE(archivers); i++)
			printf("%s\n", archivers[i].name);
		exit(0);
	}

	/* We need at least one parameter -- tree-ish */
	if (argc < 1)
		usage_with_options(archive_usage, opts);
	*ar = lookup_archiver(format);
	if (!*ar)
		die("Unknown archive format '%s'", format);

	args->compression_level = Z_DEFAULT_COMPRESSION;
	if (compression_level != -1) {
		if ((*ar)->flags & USES_ZLIB_COMPRESSION)
			args->compression_level = compression_level;
		else {
			die("Argument not supported for format '%s': -%d",
					format, compression_level);
		}
	}
	args->verbose = verbose;
	args->base = base;
	args->baselen = strlen(base);

	return argc;
}

int write_archive(int argc, const char **argv, const char *prefix,
		int setup_prefix)
{
	const struct archiver *ar = NULL;
	struct archiver_args args;

	argc = parse_archive_args(argc, argv, &ar, &args);
	if (setup_prefix && prefix == NULL)
		prefix = setup_git_directory();

	parse_treeish_arg(argv, &args, prefix);
	parse_pathspec_arg(argv + 1, &args);

	git_config(git_default_config, NULL);

	return ar->write_archive(&args);
}
Commit	Line	Data
18125644 LH	1	#include "cache.h"
18125644 LH	2	#include "commit.h"
c0885435	3	#include "tree-walk.h"
18125644	4	#include "attr.h"
562e25ab	5	#include "archive.h"
4fac1d3a RS	6	#include "parse-options.h"
	7
	8	static char const * const archive_usage[] = {
	9	"git archive [options] <tree-ish> [path...]",
	10	"git archive --list",
	11	"git archive --remote <repo> [--exec <cmd>] [options] <tree-ish> [path...]",
	12	"git archive --remote <repo> [--exec <cmd>] --list",
	13	NULL
	14	};
c0885435 RS	15
	16	#define USES_ZLIB_COMPRESSION 1
	17
120a385a	18	static const struct archiver {
f15f736d RS	19	const char *name;
	20	write_archive_fn_t write_archive;
	21	unsigned int flags;
	22	} archivers[] = {
c0885435 RS	23	{ "tar", write_tar_archive },
	24	{ "zip", write_zip_archive, USES_ZLIB_COMPRESSION },
	25	};
	26
18125644 LH	27	static void format_subst(const struct commit *commit,
	28	const char *src, size_t len,
	29	struct strbuf *buf)
	30	{
	31	char *to_free = NULL;
f285a2d7	32	struct strbuf fmt = STRBUF_INIT;
18125644 LH	33
	34	if (src == buf->buf)
	35	to_free = strbuf_detach(buf, NULL);
18125644 LH	36	for (;;) {
	37	const char b, c;
	38
	39	b = memmem(src, len, "$Format:", 8);
75b7dfbd	40	if (!b)
18125644	41	break;
75b7dfbd	42	c = memchr(b + 8, '$', (src + len) - b - 8);
18125644 LH	43	if (!c)
	44	break;
	45
	46	strbuf_reset(&fmt);
	47	strbuf_add(&fmt, b + 8, c - b - 8);
	48
	49	strbuf_add(buf, src, b - src);
d36f8679	50	format_commit_message(commit, fmt.buf, buf, DATE_NORMAL);
18125644 LH	51	len -= c + 1 - src;
	52	src = c + 1;
	53	}
	54	strbuf_add(buf, src, len);
	55	strbuf_release(&fmt);
	56	free(to_free);
	57	}
	58
1d11d5bb RS	59	static void sha1_file_to_archive(const char path, const unsigned char *sha1,
	60	unsigned int mode, enum object_type *type,
	61	unsigned long sizep, const struct commit commit)
18125644 LH	62	{
	63	void *buffer;
	64
	65	buffer = read_sha1_file(sha1, type, sizep);
	66	if (buffer && S_ISREG(mode)) {
f285a2d7	67	struct strbuf buf = STRBUF_INIT;
18125644 LH	68	size_t size = 0;
18125644 LH	69
18125644 LH	70	strbuf_attach(&buf, buffer, sizep, sizep + 1);
18125644 LH	71	convert_to_working_tree(path, buf.buf, buf.len, &buf);
1d11d5bb RS	72	if (commit)
1d11d5bb RS	73	format_subst(commit, buf.buf, buf.len, &buf);
18125644 LH	74	buffer = strbuf_detach(&buf, &size);
	75	*sizep = size;
	76	}
	77
	78	return buffer;
	79	}
	80
1d11d5bb	81	static void setup_archive_check(struct git_attr_check *check)
008d896d RS	82	{
008d896d RS	83	static struct git_attr *attr_export_ignore;
1d11d5bb	84	static struct git_attr *attr_export_subst;
008d896d	85
1d11d5bb	86	if (!attr_export_ignore) {
008d896d	87	attr_export_ignore = git_attr("export-ignore", 13);
1d11d5bb RS	88	attr_export_subst = git_attr("export-subst", 12);
1d11d5bb RS	89	}
008d896d	90	check[0].attr = attr_export_ignore;
1d11d5bb	91	check[1].attr = attr_export_subst;
008d896d	92	}
562e25ab RS	93
	94	struct archiver_context {
	95	struct archiver_args *args;
	96	write_archive_entry_fn_t write_entry;
	97	};
	98
	99	static int write_archive_entry(const unsigned char sha1, const char base,
	100	int baselen, const char *filename, unsigned mode, int stage,
	101	void *context)
	102	{
	103	static struct strbuf path = STRBUF_INIT;
	104	struct archiver_context *c = context;
	105	struct archiver_args *args = c->args;
	106	write_archive_entry_fn_t write_entry = c->write_entry;
1d11d5bb RS	107	struct git_attr_check check[2];
	108	const char *path_without_prefix;
	109	int convert = 0;
562e25ab RS	110	int err;
	111	enum object_type type;
	112	unsigned long size;
	113	void *buffer;
	114
	115	strbuf_reset(&path);
	116	strbuf_grow(&path, PATH_MAX);
	117	strbuf_add(&path, base, baselen);
	118	strbuf_addstr(&path, filename);
1d11d5bb	119	path_without_prefix = path.buf + args->baselen;
562e25ab	120
1d11d5bb RS	121	setup_archive_check(check);
	122	if (!git_checkattr(path_without_prefix, ARRAY_SIZE(check), check)) {
	123	if (ATTR_TRUE(check[0].value))
	124	return 0;
	125	convert = ATTR_TRUE(check[1].value);
	126	}
562e25ab RS	127
	128	if (S_ISDIR(mode) \|\| S_ISGITLINK(mode)) {
	129	strbuf_addch(&path, '/');
	130	if (args->verbose)
	131	fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
	132	err = write_entry(args, sha1, path.buf, path.len, mode, NULL, 0);
	133	if (err)
	134	return err;
d3bee161	135	return (S_ISDIR(mode) ? READ_TREE_RECURSIVE : 0);
562e25ab RS	136	}
562e25ab RS	137
1d11d5bb RS	138	buffer = sha1_file_to_archive(path_without_prefix, sha1, mode,
1d11d5bb RS	139	&type, &size, convert ? args->commit : NULL);
562e25ab RS	140	if (!buffer)
	141	return error("cannot read %s", sha1_to_hex(sha1));
	142	if (args->verbose)
	143	fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
	144	err = write_entry(args, sha1, path.buf, path.len, mode, buffer, size);
	145	free(buffer);
	146	return err;
	147	}
	148
	149	int write_archive_entries(struct archiver_args *args,
	150	write_archive_entry_fn_t write_entry)
	151	{
	152	struct archiver_context context;
	153	int err;
	154
	155	if (args->baselen > 0 && args->base[args->baselen - 1] == '/') {
	156	size_t len = args->baselen;
	157
	158	while (len > 1 && args->base[len - 2] == '/')
	159	len--;
	160	if (args->verbose)
	161	fprintf(stderr, "%.*s\n", (int)len, args->base);
	162	err = write_entry(args, args->tree->object.sha1, args->base,
	163	len, 040777, NULL, 0);
	164	if (err)
	165	return err;
	166	}
	167
	168	context.args = args;
	169	context.write_entry = write_entry;
	170
	171	err = read_tree_recursive(args->tree, args->base, args->baselen, 0,
	172	args->pathspec, write_archive_entry, &context);
	173	if (err == READ_TREE_RECURSIVE)
	174	err = 0;
	175	return err;
	176	}
6e94e683	177
c0885435 RS	178	static const struct archiver lookup_archiver(const char name)
	179	{
	180	int i;
	181
4fac1d3a RS	182	if (!name)
	183	return NULL;
	184
c0885435 RS	185	for (i = 0; i < ARRAY_SIZE(archivers); i++) {
	186	if (!strcmp(name, archivers[i].name))
	187	return &archivers[i];
	188	}
	189	return NULL;
	190	}
	191
	192	static void parse_pathspec_arg(const char **pathspec,
	193	struct archiver_args *ar_args)
	194	{
	195	ar_args->pathspec = get_pathspec(ar_args->base, pathspec);
	196	}
	197
	198	static void parse_treeish_arg(const char **argv,
	199	struct archiver_args ar_args, const char prefix)
	200	{
	201	const char *name = argv[0];
	202	const unsigned char *commit_sha1;
	203	time_t archive_time;
	204	struct tree *tree;
	205	const struct commit *commit;
	206	unsigned char sha1[20];
	207
	208	if (get_sha1(name, sha1))
	209	die("Not a valid object name");
	210
	211	commit = lookup_commit_reference_gently(sha1, 1);
	212	if (commit) {
	213	commit_sha1 = commit->object.sha1;
	214	archive_time = commit->date;
	215	} else {
	216	commit_sha1 = NULL;
	217	archive_time = time(NULL);
	218	}
	219
	220	tree = parse_tree_indirect(sha1);
	221	if (tree == NULL)
	222	die("not a tree object");
	223
	224	if (prefix) {
	225	unsigned char tree_sha1[20];
	226	unsigned int mode;
	227	int err;
	228
	229	err = get_tree_entry(tree->object.sha1, prefix,
	230	tree_sha1, &mode);
	231	if (err \|\| !S_ISDIR(mode))
	232	die("current working directory is untracked");
	233
	234	tree = parse_tree_indirect(tree_sha1);
	235	}
	236	ar_args->tree = tree;
	237	ar_args->commit_sha1 = commit_sha1;
	238	ar_args->commit = commit;
	239	ar_args->time = archive_time;
	240	}
	241
4fac1d3a RS	242	#define OPT__COMPR(s, v, h, p) \
	243	{ OPTION_SET_INT, (s), NULL, (v), NULL, (h), \
	244	PARSE_OPT_NOARG \| PARSE_OPT_NONEG, NULL, (p) }
	245	#define OPT__COMPR_HIDDEN(s, v, p) \
	246	{ OPTION_SET_INT, (s), NULL, (v), NULL, "", \
	247	PARSE_OPT_NOARG \| PARSE_OPT_NONEG \| PARSE_OPT_HIDDEN, NULL, (p) }
	248
c0885435 RS	249	static int parse_archive_args(int argc, const char **argv,
	250	const struct archiver *ar, struct archiver_args args)
	251	{
	252	const char *format = "tar";
4fac1d3a RS	253	const char *base = NULL;
	254	const char *remote = NULL;
	255	const char *exec = NULL;
c0885435 RS	256	int compression_level = -1;
	257	int verbose = 0;
	258	int i;
4fac1d3a RS	259	int list = 0;
	260	struct option opts[] = {
	261	OPT_GROUP(""),
	262	OPT_STRING(0, "format", &format, "fmt", "archive format"),
	263	OPT_STRING(0, "prefix", &base, "prefix",
	264	"prepend prefix to each pathname in the archive"),
	265	OPT__VERBOSE(&verbose),
	266	OPT__COMPR('0', &compression_level, "store only", 0),
	267	OPT__COMPR('1', &compression_level, "compress faster", 1),
	268	OPT__COMPR_HIDDEN('2', &compression_level, 2),
	269	OPT__COMPR_HIDDEN('3', &compression_level, 3),
	270	OPT__COMPR_HIDDEN('4', &compression_level, 4),
	271	OPT__COMPR_HIDDEN('5', &compression_level, 5),
	272	OPT__COMPR_HIDDEN('6', &compression_level, 6),
	273	OPT__COMPR_HIDDEN('7', &compression_level, 7),
	274	OPT__COMPR_HIDDEN('8', &compression_level, 8),
	275	OPT__COMPR('9', &compression_level, "compress better", 9),
	276	OPT_GROUP(""),
	277	OPT_BOOLEAN('l', "list", &list,
	278	"list supported archive formats"),
	279	OPT_GROUP(""),
	280	OPT_STRING(0, "remote", &remote, "repo",
	281	"retrieve the archive from remote repository <repo>"),
	282	OPT_STRING(0, "exec", &exec, "cmd",
	283	"path to the remote git-upload-archive command"),
	284	OPT_END()
	285	};
	286
	287	argc = parse_options(argc, argv, opts, archive_usage, 0);
	288
	289	if (remote)
	290	die("Unexpected option --remote");
	291	if (exec)
	292	die("Option --exec can only be used together with --remote");
	293
	294	if (!base)
	295	base = "";
	296
	297	if (list) {
	298	for (i = 0; i < ARRAY_SIZE(archivers); i++)
	299	printf("%s\n", archivers[i].name);
	300	exit(0);
c0885435 RS	301	}
	302
	303	/* We need at least one parameter -- tree-ish */
4fac1d3a RS	304	if (argc < 1)
4fac1d3a RS	305	usage_with_options(archive_usage, opts);
c0885435 RS	306	*ar = lookup_archiver(format);
	307	if (!*ar)
	308	die("Unknown archive format '%s'", format);
	309
	310	args->compression_level = Z_DEFAULT_COMPRESSION;
	311	if (compression_level != -1) {
	312	if ((*ar)->flags & USES_ZLIB_COMPRESSION)
	313	args->compression_level = compression_level;
	314	else {
	315	die("Argument not supported for format '%s': -%d",
	316	format, compression_level);
	317	}
	318	}
	319	args->verbose = verbose;
	320	args->base = base;
	321	args->baselen = strlen(base);
	322
4fac1d3a	323	return argc;
c0885435 RS	324	}
c0885435 RS	325
6e94e683 RS	326	int write_archive(int argc, const char *argv, const char prefix,
	327	int setup_prefix)
	328	{
	329	const struct archiver *ar = NULL;
	330	struct archiver_args args;
6e94e683	331
4fac1d3a	332	argc = parse_archive_args(argc, argv, &ar, &args);
6e94e683 RS	333	if (setup_prefix && prefix == NULL)
	334	prefix = setup_git_directory();
	335
6e94e683 RS	336	parse_treeish_arg(argv, &args, prefix);
	337	parse_pathspec_arg(argv + 1, &args);
	338
ddff8563 CB	339	git_config(git_default_config, NULL);
ddff8563 CB	340
6e94e683 RS	341	return ar->write_archive(&args);
6e94e683 RS	342	}