[thirdparty/git.git] / archive.c

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

static const char archive_usage[] = \
"git archive --format=<fmt> [--prefix=<prefix>/] [--verbose] [<extra>] <tree-ish> [path...]";

#define USES_ZLIB_COMPRESSION 1

const struct archiver 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;

	if (src == buf->buf)
		to_free = strbuf_detach(buf, NULL);
	strbuf_init(&fmt, 0);
	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);
		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;
		size_t size = 0;

		strbuf_init(&buf, 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 READ_TREE_RECURSIVE;
	}

	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;

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

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 = "";
	int compression_level = -1;
	int verbose = 0;
	int i;

	for (i = 1; i < argc; i++) {
		const char *arg = argv[i];

		if (!strcmp(arg, "--list") || !strcmp(arg, "-l")) {
			for (i = 0; i < ARRAY_SIZE(archivers); i++)
				printf("%s\n", archivers[i].name);
			exit(0);
		}
		if (!strcmp(arg, "--verbose") || !strcmp(arg, "-v")) {
			verbose = 1;
			continue;
		}
		if (!prefixcmp(arg, "--format=")) {
			format = arg + 9;
			continue;
		}
		if (!prefixcmp(arg, "--prefix=")) {
			base = arg + 9;
			continue;
		}
		if (!strcmp(arg, "--")) {
			i++;
			break;
		}
		if (arg[0] == '-' && isdigit(arg[1]) && arg[2] == '\0') {
			compression_level = arg[1] - '0';
			continue;
		}
		if (arg[0] == '-')
			die("Unknown argument: %s", arg);
		break;
	}

	/* We need at least one parameter -- tree-ish */
	if (argc - 1 < i)
		usage(archive_usage);
	*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 i;
}

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

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

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

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