[thirdparty/git.git] / archive.c

#include "cache.h"
#include "config.h"
#include "refs.h"
#include "object-store.h"
#include "commit.h"
#include "tree-walk.h"
#include "attr.h"
#include "archive.h"
#include "parse-options.h"
#include "unpack-trees.h"
#include "dir.h"

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

static const struct archiver **archivers;
static int nr_archivers;
static int alloc_archivers;
static int remote_allow_unreachable;

void register_archiver(struct archiver *ar)
{
	ALLOC_GROW(archivers, nr_archivers + 1, alloc_archivers);
	archivers[nr_archivers++] = ar;
}

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;
	struct pretty_print_context ctx = {0};
	ctx.date_mode.type = DATE_NORMAL;
	ctx.abbrev = DEFAULT_ABBREV;

	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, &ctx);
		len -= c + 1 - src;
		src  = c + 1;
	}
	strbuf_add(buf, src, len);
	strbuf_release(&fmt);
	free(to_free);
}

void *object_file_to_archive(const struct archiver_args *args,
			     const char *path, const struct object_id *oid,
			     unsigned int mode, enum object_type *type,
			     unsigned long *sizep)
{
	void *buffer;
	const struct commit *commit = args->convert ? args->commit : NULL;

	path += args->baselen;
	buffer = read_object_file(oid, 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(args->repo->index, 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;
}

struct directory {
	struct directory *up;
	struct object_id oid;
	int baselen, len;
	unsigned mode;
	int stage;
	char path[FLEX_ARRAY];
};

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

static const struct attr_check *get_archive_attrs(struct index_state *istate,
						  const char *path)
{
	static struct attr_check *check;
	if (!check)
		check = attr_check_initl("export-ignore", "export-subst", NULL);
	return git_check_attr(istate, path, check) ? NULL : check;
}

static int check_attr_export_ignore(const struct attr_check *check)
{
	return check && ATTR_TRUE(check->items[0].value);
}

static int check_attr_export_subst(const struct attr_check *check)
{
	return check && ATTR_TRUE(check->items[1].value);
}

static int write_archive_entry(const struct object_id *oid, 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;
	int err;
	const char *path_without_prefix;

	args->convert = 0;
	strbuf_reset(&path);
	strbuf_grow(&path, PATH_MAX);
	strbuf_add(&path, args->base, args->baselen);
	strbuf_add(&path, base, baselen);
	strbuf_addstr(&path, filename);
	if (S_ISDIR(mode) || S_ISGITLINK(mode))
		strbuf_addch(&path, '/');
	path_without_prefix = path.buf + args->baselen;

	if (!S_ISDIR(mode)) {
		const struct attr_check *check;
		check = get_archive_attrs(args->repo->index, path_without_prefix);
		if (check_attr_export_ignore(check))
			return 0;
		args->convert = check_attr_export_subst(check);
	}

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

	if (args->verbose)
		fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
	return write_entry(args, oid, path.buf, path.len, mode);
}

static void queue_directory(const unsigned char *sha1,
		struct strbuf *base, const char *filename,
		unsigned mode, int stage, struct archiver_context *c)
{
	struct directory *d;
	size_t len = st_add4(base->len, 1, strlen(filename), 1);
	d = xmalloc(st_add(sizeof(*d), len));
	d->up	   = c->bottom;
	d->baselen = base->len;
	d->mode	   = mode;
	d->stage   = stage;
	c->bottom  = d;
	d->len = xsnprintf(d->path, len, "%.*s%s/", (int)base->len, base->buf, filename);
	hashcpy(d->oid.hash, sha1);
}

static int write_directory(struct archiver_context *c)
{
	struct directory *d = c->bottom;
	int ret;

	if (!d)
		return 0;
	c->bottom = d->up;
	d->path[d->len - 1] = '\0'; /* no trailing slash */
	ret =
		write_directory(c) ||
		write_archive_entry(&d->oid, d->path, d->baselen,
				    d->path + d->baselen, d->mode,
				    d->stage, c) != READ_TREE_RECURSIVE;
	free(d);
	return ret ? -1 : 0;
}

static int queue_or_write_archive_entry(const struct object_id *oid,
		struct strbuf *base, const char *filename,
		unsigned mode, int stage, void *context)
{
	struct archiver_context *c = context;

	while (c->bottom &&
	       !(base->len >= c->bottom->len &&
		 !strncmp(base->buf, c->bottom->path, c->bottom->len))) {
		struct directory *next = c->bottom->up;
		free(c->bottom);
		c->bottom = next;
	}

	if (S_ISDIR(mode)) {
		size_t baselen = base->len;
		const struct attr_check *check;

		/* Borrow base, but restore its original value when done. */
		strbuf_addstr(base, filename);
		strbuf_addch(base, '/');
		check = get_archive_attrs(c->args->repo->index, base->buf);
		strbuf_setlen(base, baselen);

		if (check_attr_export_ignore(check))
			return 0;
		queue_directory(oid->hash, base, filename,
				mode, stage, c);
		return READ_TREE_RECURSIVE;
	}

	if (write_directory(c))
		return -1;
	return write_archive_entry(oid, base->buf, base->len, filename, mode,
				   stage, context);
}

int write_archive_entries(struct archiver_args *args,
		write_archive_entry_fn_t write_entry)
{
	struct archiver_context context;
	struct unpack_trees_options opts;
	struct tree_desc t;
	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.oid, args->base,
				  len, 040777);
		if (err)
			return err;
	}

	memset(&context, 0, sizeof(context));
	context.args = args;
	context.write_entry = write_entry;

	/*
	 * Setup index and instruct attr to read index only
	 */
	if (!args->worktree_attributes) {
		memset(&opts, 0, sizeof(opts));
		opts.index_only = 1;
		opts.head_idx = -1;
		opts.src_index = args->repo->index;
		opts.dst_index = args->repo->index;
		opts.fn = oneway_merge;
		init_tree_desc(&t, args->tree->buffer, args->tree->size);
		if (unpack_trees(1, &t, &opts))
			return -1;
		git_attr_set_direction(GIT_ATTR_INDEX);
	}

	err = read_tree_recursive(args->tree, "", 0, 0, &args->pathspec,
				  queue_or_write_archive_entry,
				  &context);
	if (err == READ_TREE_RECURSIVE)
		err = 0;
	while (context.bottom) {
		struct directory *next = context.bottom->up;
		free(context.bottom);
		context.bottom = next;
	}
	return err;
}

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

	if (!name)
		return NULL;

	for (i = 0; i < nr_archivers; i++) {
		if (!strcmp(name, archivers[i]->name))
			return archivers[i];
	}
	return NULL;
}

struct path_exists_context {
	struct pathspec pathspec;
	struct archiver_args *args;
};

static int reject_entry(const struct object_id *oid, struct strbuf *base,
			const char *filename, unsigned mode,
			int stage, void *context)
{
	int ret = -1;
	struct path_exists_context *ctx = context;

	if (S_ISDIR(mode)) {
		struct strbuf sb = STRBUF_INIT;
		strbuf_addbuf(&sb, base);
		strbuf_addstr(&sb, filename);
		if (!match_pathspec(ctx->args->repo->index,
				    &ctx->pathspec,
				    sb.buf, sb.len, 0, NULL, 1))
			ret = READ_TREE_RECURSIVE;
		strbuf_release(&sb);
	}
	return ret;
}

static int path_exists(struct archiver_args *args, const char *path)
{
	const char *paths[] = { path, NULL };
	struct path_exists_context ctx;
	int ret;

	ctx.args = args;
	parse_pathspec(&ctx.pathspec, 0, 0, "", paths);
	ctx.pathspec.recursive = 1;
	ret = read_tree_recursive(args->tree, "", 0, 0, &ctx.pathspec,
				  reject_entry, &ctx);
	clear_pathspec(&ctx.pathspec);
	return ret != 0;
}

static void parse_pathspec_arg(const char **pathspec,
		struct archiver_args *ar_args)
{
	/*
	 * must be consistent with parse_pathspec in path_exists()
	 * Also if pathspec patterns are dependent, we're in big
	 * trouble as we test each one separately
	 */
	parse_pathspec(&ar_args->pathspec, 0,
		       PATHSPEC_PREFER_FULL,
		       "", pathspec);
	ar_args->pathspec.recursive = 1;
	if (pathspec) {
		while (*pathspec) {
			if (**pathspec && !path_exists(ar_args, *pathspec))
				die(_("pathspec '%s' did not match any files"), *pathspec);
			pathspec++;
		}
	}
}

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

	/* Remotes are only allowed to fetch actual refs */
	if (remote && !remote_allow_unreachable) {
		char *ref = NULL;
		const char *colon = strchrnul(name, ':');
		int refnamelen = colon - name;

		if (!dwim_ref(name, refnamelen, &oid, &ref))
			die("no such ref: %.*s", refnamelen, name);
		free(ref);
	}

	if (get_oid(name, &oid))
		die("Not a valid object name");

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

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

	if (prefix) {
		struct object_id tree_oid;
		unsigned int mode;
		int err;

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

		tree = parse_tree_indirect(&tree_oid);
	}
	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) \
	OPT_SET_INT_F(s, NULL, v, h, p, PARSE_OPT_NONEG)
#define OPT__COMPR_HIDDEN(s, v, p) \
	OPT_SET_INT_F(s, NULL, v, "", p, PARSE_OPT_NONEG | PARSE_OPT_HIDDEN)

static int parse_archive_args(int argc, const char **argv,
		const struct archiver **ar, struct archiver_args *args,
		const char *name_hint, int is_remote)
{
	const char *format = NULL;
	const char *base = NULL;
	const char *remote = NULL;
	const char *exec = NULL;
	const char *output = NULL;
	int compression_level = -1;
	int verbose = 0;
	int i;
	int list = 0;
	int worktree_attributes = 0;
	struct option opts[] = {
		OPT_GROUP(""),
		OPT_STRING(0, "format", &format, N_("fmt"), N_("archive format")),
		OPT_STRING(0, "prefix", &base, N_("prefix"),
			N_("prepend prefix to each pathname in the archive")),
		OPT_STRING('o', "output", &output, N_("file"),
			N_("write the archive to this file")),
		OPT_BOOL(0, "worktree-attributes", &worktree_attributes,
			N_("read .gitattributes in working directory")),
		OPT__VERBOSE(&verbose, N_("report archived files on stderr")),
		OPT__COMPR('0', &compression_level, N_("store only"), 0),
		OPT__COMPR('1', &compression_level, N_("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, N_("compress better"), 9),
		OPT_GROUP(""),
		OPT_BOOL('l', "list", &list,
			N_("list supported archive formats")),
		OPT_GROUP(""),
		OPT_STRING(0, "remote", &remote, N_("repo"),
			N_("retrieve the archive from remote repository <repo>")),
		OPT_STRING(0, "exec", &exec, N_("command"),
			N_("path to the remote git-upload-archive command")),
		OPT_END()
	};

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

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

	if (!base)
		base = "";

	if (list) {
		for (i = 0; i < nr_archivers; i++)
			if (!is_remote || archivers[i]->flags & ARCHIVER_REMOTE)
				printf("%s\n", archivers[i]->name);
		exit(0);
	}

	if (!format && name_hint)
		format = archive_format_from_filename(name_hint);
	if (!format)
		format = "tar";

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

	args->compression_level = Z_DEFAULT_COMPRESSION;
	if (compression_level != -1) {
		if ((*ar)->flags & ARCHIVER_WANT_COMPRESSION_LEVELS)
			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);
	args->worktree_attributes = worktree_attributes;

	return argc;
}

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

	git_config_get_bool("uploadarchive.allowunreachable", &remote_allow_unreachable);
	git_config(git_default_config, NULL);

	init_tar_archiver();
	init_zip_archiver();

	args.repo = repo;
	argc = parse_archive_args(argc, argv, &ar, &args, name_hint, remote);
	if (!startup_info->have_repository) {
		/*
		 * We know this will die() with an error, so we could just
		 * die ourselves; but its error message will be more specific
		 * than what we could write here.
		 */
		setup_git_directory();
	}

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

	return ar->write_archive(ar, &args);
}

static int match_extension(const char *filename, const char *ext)
{
	int prefixlen = strlen(filename) - strlen(ext);

	/*
	 * We need 1 character for the '.', and 1 character to ensure that the
	 * prefix is non-empty (k.e., we don't match .tar.gz with no actual
	 * filename).
	 */
	if (prefixlen < 2 || filename[prefixlen - 1] != '.')
		return 0;
	return !strcmp(filename + prefixlen, ext);
}

const char *archive_format_from_filename(const char *filename)
{
	int i;

	for (i = 0; i < nr_archivers; i++)
		if (match_extension(filename, archivers[i]->name))
			return archivers[i]->name;
	return NULL;
}
Commit	Line	Data
18125644	1	#include "cache.h"
b2141fc1	2	#include "config.h"
fb58c8d5	3	#include "refs.h"
cbd53a21	4	#include "object-store.h"
18125644	5	#include "commit.h"
c0885435	6	#include "tree-walk.h"
18125644	7	#include "attr.h"
562e25ab	8	#include "archive.h"
4fac1d3a	9	#include "parse-options.h"
ba053ea9	10	#include "unpack-trees.h"
ed22b417	11	#include "dir.h"
4fac1d3a RS	12
4fac1d3a RS	13	static char const * const archive_usage[] = {
9c9b4f2f	14	N_("git archive [<options>] <tree-ish> [<path>...]"),
0012a387	15	N_("git archive --list"),
9c9b4f2f	16	N_("git archive --remote <repo> [--exec <cmd>] [<options>] <tree-ish> [<path>...]"),
0012a387	17	N_("git archive --remote <repo> [--exec <cmd>] --list"),
4fac1d3a RS	18	NULL
4fac1d3a RS	19	};
c0885435	20
13e0f88d JK	21	static const struct archiver **archivers;
	22	static int nr_archivers;
	23	static int alloc_archivers;
7671b632	24	static int remote_allow_unreachable;
13e0f88d JK	25
	26	void register_archiver(struct archiver *ar)
	27	{
	28	ALLOC_GROW(archivers, nr_archivers + 1, alloc_archivers);
	29	archivers[nr_archivers++] = ar;
	30	}
c0885435	31
18125644 LH	32	static void format_subst(const struct commit *commit,
	33	const char *src, size_t len,
	34	struct strbuf *buf)
	35	{
	36	char *to_free = NULL;
f285a2d7	37	struct strbuf fmt = STRBUF_INIT;
dd2e794a	38	struct pretty_print_context ctx = {0};
a5481a6c	39	ctx.date_mode.type = DATE_NORMAL;
35039ced	40	ctx.abbrev = DEFAULT_ABBREV;
18125644 LH	41
	42	if (src == buf->buf)
	43	to_free = strbuf_detach(buf, NULL);
18125644 LH	44	for (;;) {
	45	const char b, c;
	46
	47	b = memmem(src, len, "$Format:", 8);
75b7dfbd	48	if (!b)
18125644	49	break;
75b7dfbd	50	c = memchr(b + 8, '$', (src + len) - b - 8);
18125644 LH	51	if (!c)
	52	break;
	53
	54	strbuf_reset(&fmt);
	55	strbuf_add(&fmt, b + 8, c - b - 8);
	56
	57	strbuf_add(buf, src, b - src);
dd2e794a	58	format_commit_message(commit, fmt.buf, buf, &ctx);
18125644 LH	59	len -= c + 1 - src;
	60	src = c + 1;
	61	}
	62	strbuf_add(buf, src, len);
	63	strbuf_release(&fmt);
	64	free(to_free);
	65	}
	66
e5ec981a	67	void object_file_to_archive(const struct archiver_args args,
	68	const char path, const struct object_id oid,
	69	unsigned int mode, enum object_type *type,
	70	unsigned long *sizep)
18125644 LH	71	{
18125644 LH	72	void *buffer;
9cb513b7	73	const struct commit *commit = args->convert ? args->commit : NULL;
18125644	74
9cb513b7	75	path += args->baselen;
b4f5aca4	76	buffer = read_object_file(oid, type, sizep);
18125644	77	if (buffer && S_ISREG(mode)) {
f285a2d7	78	struct strbuf buf = STRBUF_INIT;
18125644 LH	79	size_t size = 0;
18125644 LH	80
18125644	81	strbuf_attach(&buf, buffer, sizep, sizep + 1);
b612ee20	82	convert_to_working_tree(args->repo->index, path, buf.buf, buf.len, &buf);
1d11d5bb RS	83	if (commit)
1d11d5bb RS	84	format_subst(commit, buf.buf, buf.len, &buf);
18125644 LH	85	buffer = strbuf_detach(&buf, &size);
	86	*sizep = size;
	87	}
	88
	89	return buffer;
	90	}
	91
ed22b417 NTND	92	struct directory {
ed22b417 NTND	93	struct directory *up;
13609673	94	struct object_id oid;
ed22b417 NTND	95	int baselen, len;
	96	unsigned mode;
	97	int stage;
	98	char path[FLEX_ARRAY];
	99	};
	100
562e25ab RS	101	struct archiver_context {
	102	struct archiver_args *args;
	103	write_archive_entry_fn_t write_entry;
ed22b417	104	struct directory *bottom;
562e25ab RS	105	};
562e25ab RS	106
b612ee20 NTND	107	static const struct attr_check get_archive_attrs(struct index_state istate,
b612ee20 NTND	108	const char *path)
c6c08f7e RS	109	{
	110	static struct attr_check *check;
	111	if (!check)
	112	check = attr_check_initl("export-ignore", "export-subst", NULL);
b612ee20	113	return git_check_attr(istate, path, check) ? NULL : check;
c6c08f7e RS	114	}
	115
	116	static int check_attr_export_ignore(const struct attr_check *check)
	117	{
	118	return check && ATTR_TRUE(check->items[0].value);
	119	}
	120
	121	static int check_attr_export_subst(const struct attr_check *check)
	122	{
	123	return check && ATTR_TRUE(check->items[1].value);
	124	}
	125
015ff4f8	126	static int write_archive_entry(const struct object_id oid, const char base,
562e25ab RS	127	int baselen, const char *filename, unsigned mode, int stage,
	128	void *context)
	129	{
	130	static struct strbuf path = STRBUF_INIT;
	131	struct archiver_context *c = context;
	132	struct archiver_args *args = c->args;
	133	write_archive_entry_fn_t write_entry = c->write_entry;
	134	int err;
5ff247ac	135	const char *path_without_prefix;
562e25ab	136
9cb513b7	137	args->convert = 0;
562e25ab RS	138	strbuf_reset(&path);
562e25ab RS	139	strbuf_grow(&path, PATH_MAX);
ebfbdb34	140	strbuf_add(&path, args->base, args->baselen);
562e25ab RS	141	strbuf_add(&path, base, baselen);
562e25ab RS	142	strbuf_addstr(&path, filename);
94bc671a JNA	143	if (S_ISDIR(mode) \|\| S_ISGITLINK(mode))
94bc671a JNA	144	strbuf_addch(&path, '/');
1d11d5bb	145	path_without_prefix = path.buf + args->baselen;
562e25ab	146
43180940	147	if (!S_ISDIR(mode)) {
5ff247ac	148	const struct attr_check *check;
b612ee20	149	check = get_archive_attrs(args->repo->index, path_without_prefix);
5ff247ac	150	if (check_attr_export_ignore(check))
1d11d5bb	151	return 0;
5ff247ac	152	args->convert = check_attr_export_subst(check);
1d11d5bb	153	}
562e25ab RS	154
562e25ab RS	155	if (S_ISDIR(mode) \|\| S_ISGITLINK(mode)) {
562e25ab RS	156	if (args->verbose)
562e25ab RS	157	fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
015ff4f8	158	err = write_entry(args, oid, path.buf, path.len, mode);
562e25ab RS	159	if (err)
562e25ab RS	160	return err;
d3bee161	161	return (S_ISDIR(mode) ? READ_TREE_RECURSIVE : 0);
562e25ab RS	162	}
562e25ab RS	163
562e25ab RS	164	if (args->verbose)
562e25ab RS	165	fprintf(stderr, "%.*s\n", (int)path.len, path.buf);
015ff4f8	166	return write_entry(args, oid, path.buf, path.len, mode);
562e25ab RS	167	}
562e25ab RS	168
ed22b417	169	static void queue_directory(const unsigned char *sha1,
6a0b0b6d	170	struct strbuf base, const char filename,
ed22b417 NTND	171	unsigned mode, int stage, struct archiver_context *c)
	172	{
	173	struct directory *d;
50a6c8ef JK	174	size_t len = st_add4(base->len, 1, strlen(filename), 1);
50a6c8ef JK	175	d = xmalloc(st_add(sizeof(*d), len));
ed22b417	176	d->up = c->bottom;
6a0b0b6d	177	d->baselen = base->len;
ed22b417 NTND	178	d->mode = mode;
	179	d->stage = stage;
	180	c->bottom = d;
c7ab0ba3	181	d->len = xsnprintf(d->path, len, "%.*s%s/", (int)base->len, base->buf, filename);
13609673	182	hashcpy(d->oid.hash, sha1);
ed22b417 NTND	183	}
	184
	185	static int write_directory(struct archiver_context *c)
	186	{
	187	struct directory *d = c->bottom;
	188	int ret;
	189
	190	if (!d)
	191	return 0;
	192	c->bottom = d->up;
	193	d->path[d->len - 1] = '\0'; /* no trailing slash */
	194	ret =
	195	write_directory(c) \|\|
015ff4f8	196	write_archive_entry(&d->oid, d->path, d->baselen,
ed22b417 NTND	197	d->path + d->baselen, d->mode,
	198	d->stage, c) != READ_TREE_RECURSIVE;
	199	free(d);
	200	return ret ? -1 : 0;
	201	}
	202
df46d77e	203	static int queue_or_write_archive_entry(const struct object_id *oid,
6a0b0b6d	204	struct strbuf base, const char filename,
ed22b417 NTND	205	unsigned mode, int stage, void *context)
	206	{
	207	struct archiver_context *c = context;
	208
	209	while (c->bottom &&
6a0b0b6d NTND	210	!(base->len >= c->bottom->len &&
6a0b0b6d NTND	211	!strncmp(base->buf, c->bottom->path, c->bottom->len))) {
ed22b417 NTND	212	struct directory *next = c->bottom->up;
	213	free(c->bottom);
	214	c->bottom = next;
	215	}
	216
	217	if (S_ISDIR(mode)) {
5ff247ac RS	218	size_t baselen = base->len;
	219	const struct attr_check *check;
	220
	221	/* Borrow base, but restore its original value when done. */
	222	strbuf_addstr(base, filename);
	223	strbuf_addch(base, '/');
b612ee20	224	check = get_archive_attrs(c->args->repo->index, base->buf);
5ff247ac RS	225	strbuf_setlen(base, baselen);
	226
	227	if (check_attr_export_ignore(check))
	228	return 0;
df46d77e	229	queue_directory(oid->hash, base, filename,
ed22b417 NTND	230	mode, stage, c);
	231	return READ_TREE_RECURSIVE;
	232	}
	233
	234	if (write_directory(c))
	235	return -1;
015ff4f8	236	return write_archive_entry(oid, base->buf, base->len, filename, mode,
ed22b417 NTND	237	stage, context);
	238	}
	239
562e25ab RS	240	int write_archive_entries(struct archiver_args *args,
	241	write_archive_entry_fn_t write_entry)
	242	{
	243	struct archiver_context context;
ba053ea9 NTND	244	struct unpack_trees_options opts;
ba053ea9 NTND	245	struct tree_desc t;
562e25ab RS	246	int err;
	247
	248	if (args->baselen > 0 && args->base[args->baselen - 1] == '/') {
	249	size_t len = args->baselen;
	250
	251	while (len > 1 && args->base[len - 2] == '/')
	252	len--;
	253	if (args->verbose)
	254	fprintf(stderr, "%.*s\n", (int)len, args->base);
015ff4f8	255	err = write_entry(args, &args->tree->object.oid, args->base,
9cb513b7	256	len, 040777);
562e25ab RS	257	if (err)
	258	return err;
	259	}
	260
ed22b417	261	memset(&context, 0, sizeof(context));
562e25ab RS	262	context.args = args;
	263	context.write_entry = write_entry;
	264
ba053ea9 NTND	265	/*
	266	* Setup index and instruct attr to read index only
	267	*/
	268	if (!args->worktree_attributes) {
	269	memset(&opts, 0, sizeof(opts));
	270	opts.index_only = 1;
	271	opts.head_idx = -1;
b612ee20 NTND	272	opts.src_index = args->repo->index;
b612ee20 NTND	273	opts.dst_index = args->repo->index;
ba053ea9 NTND	274	opts.fn = oneway_merge;
	275	init_tree_desc(&t, args->tree->buffer, args->tree->size);
	276	if (unpack_trees(1, &t, &opts))
	277	return -1;
c4500e25	278	git_attr_set_direction(GIT_ATTR_INDEX);
ba053ea9 NTND	279	}
ba053ea9 NTND	280
f3e743a0	281	err = read_tree_recursive(args->tree, "", 0, 0, &args->pathspec,
43180940	282	queue_or_write_archive_entry,
ed22b417	283	&context);
562e25ab RS	284	if (err == READ_TREE_RECURSIVE)
562e25ab RS	285	err = 0;
ed22b417 NTND	286	while (context.bottom) {
	287	struct directory *next = context.bottom->up;
	288	free(context.bottom);
	289	context.bottom = next;
	290	}
562e25ab RS	291	return err;
562e25ab RS	292	}
6e94e683	293
c0885435 RS	294	static const struct archiver lookup_archiver(const char name)
	295	{
	296	int i;
	297
4fac1d3a RS	298	if (!name)
	299	return NULL;
	300
13e0f88d JK	301	for (i = 0; i < nr_archivers; i++) {
	302	if (!strcmp(name, archivers[i]->name))
	303	return archivers[i];
c0885435 RS	304	}
	305	return NULL;
	306	}
	307
b612ee20 NTND	308	struct path_exists_context {
	309	struct pathspec pathspec;
	310	struct archiver_args *args;
	311	};
	312
df46d77e	313	static int reject_entry(const struct object_id oid, struct strbuf base,
6a0b0b6d	314	const char *filename, unsigned mode,
d5f53d6d RS	315	int stage, void *context)
d5f53d6d RS	316	{
ed22b417	317	int ret = -1;
b612ee20 NTND	318	struct path_exists_context *ctx = context;
b612ee20 NTND	319
ed22b417 NTND	320	if (S_ISDIR(mode)) {
ed22b417 NTND	321	struct strbuf sb = STRBUF_INIT;
6a0b0b6d	322	strbuf_addbuf(&sb, base);
ed22b417	323	strbuf_addstr(&sb, filename);
b612ee20 NTND	324	if (!match_pathspec(ctx->args->repo->index,
	325	&ctx->pathspec,
	326	sb.buf, sb.len, 0, NULL, 1))
ed22b417 NTND	327	ret = READ_TREE_RECURSIVE;
	328	strbuf_release(&sb);
	329	}
	330	return ret;
d5f53d6d RS	331	}
d5f53d6d RS	332
b612ee20	333	static int path_exists(struct archiver_args args, const char path)
d5f53d6d	334	{
f0096c06	335	const char *paths[] = { path, NULL };
b612ee20	336	struct path_exists_context ctx;
f0096c06 NTND	337	int ret;
f0096c06 NTND	338
b612ee20 NTND	339	ctx.args = args;
	340	parse_pathspec(&ctx.pathspec, 0, 0, "", paths);
	341	ctx.pathspec.recursive = 1;
	342	ret = read_tree_recursive(args->tree, "", 0, 0, &ctx.pathspec,
	343	reject_entry, &ctx);
	344	clear_pathspec(&ctx.pathspec);
f0096c06	345	return ret != 0;
d5f53d6d RS	346	}
d5f53d6d RS	347
c0885435 RS	348	static void parse_pathspec_arg(const char **pathspec,
	349	struct archiver_args *ar_args)
	350	{
f3e743a0 NTND	351	/*
	352	* must be consistent with parse_pathspec in path_exists()
	353	* Also if pathspec patterns are dependent, we're in big
	354	* trouble as we test each one separately
	355	*/
	356	parse_pathspec(&ar_args->pathspec, 0,
	357	PATHSPEC_PREFER_FULL,
	358	"", pathspec);
ed22b417	359	ar_args->pathspec.recursive = 1;
d5f53d6d RS	360	if (pathspec) {
d5f53d6d RS	361	while (*pathspec) {
b612ee20	362	if (*pathspec && !path_exists(ar_args, pathspec))
f3e743a0	363	die(_("pathspec '%s' did not match any files"), *pathspec);
d5f53d6d RS	364	pathspec++;
	365	}
	366	}
c0885435 RS	367	}
	368
	369	static void parse_treeish_arg(const char **argv,
ee27ca4a JK	370	struct archiver_args ar_args, const char prefix,
ee27ca4a JK	371	int remote)
c0885435 RS	372	{
	373	const char *name = argv[0];
	374	const unsigned char *commit_sha1;
	375	time_t archive_time;
	376	struct tree *tree;
	377	const struct commit *commit;
13609673	378	struct object_id oid;
c0885435	379
ee27ca4a	380	/* Remotes are only allowed to fetch actual refs */
7671b632	381	if (remote && !remote_allow_unreachable) {
ee27ca4a	382	char *ref = NULL;
2c5495f7 RM	383	const char *colon = strchrnul(name, ':');
2c5495f7 RM	384	int refnamelen = colon - name;
c51a351a	385
cca5fa64	386	if (!dwim_ref(name, refnamelen, &oid, &ref))
c51a351a	387	die("no such ref: %.*s", refnamelen, name);
ee27ca4a JK	388	free(ref);
ee27ca4a JK	389	}
0f544ee8	390
e82caf38	391	if (get_oid(name, &oid))
0f544ee8	392	die("Not a valid object name");
c0885435	393
21e1ee8f	394	commit = lookup_commit_reference_gently(the_repository, &oid, 1);
c0885435	395	if (commit) {
ed1c9977	396	commit_sha1 = commit->object.oid.hash;
c0885435 RS	397	archive_time = commit->date;
	398	} else {
	399	commit_sha1 = NULL;
	400	archive_time = time(NULL);
	401	}
	402
a9dbc179	403	tree = parse_tree_indirect(&oid);
c0885435 RS	404	if (tree == NULL)
	405	die("not a tree object");
	406
	407	if (prefix) {
13609673	408	struct object_id tree_oid;
c0885435 RS	409	unsigned int mode;
	410	int err;
	411
916bc35b	412	err = get_tree_entry(&tree->object.oid, prefix, &tree_oid,
916bc35b	413	&mode);
c0885435 RS	414	if (err \|\| !S_ISDIR(mode))
	415	die("current working directory is untracked");
	416
a9dbc179	417	tree = parse_tree_indirect(&tree_oid);
c0885435 RS	418	}
	419	ar_args->tree = tree;
	420	ar_args->commit_sha1 = commit_sha1;
	421	ar_args->commit = commit;
	422	ar_args->time = archive_time;
	423	}
	424
4fac1d3a	425	#define OPT__COMPR(s, v, h, p) \
3e4a67b4	426	OPT_SET_INT_F(s, NULL, v, h, p, PARSE_OPT_NONEG)
4fac1d3a	427	#define OPT__COMPR_HIDDEN(s, v, p) \
3e4a67b4	428	OPT_SET_INT_F(s, NULL, v, "", p, PARSE_OPT_NONEG \| PARSE_OPT_HIDDEN)
4fac1d3a	429
c0885435	430	static int parse_archive_args(int argc, const char **argv,
56baa61d	431	const struct archiver *ar, struct archiver_args args,
7b97730b	432	const char *name_hint, int is_remote)
c0885435	433	{
56baa61d	434	const char *format = NULL;
4fac1d3a RS	435	const char *base = NULL;
	436	const char *remote = NULL;
	437	const char *exec = NULL;
aec0c1bb	438	const char *output = NULL;
c0885435 RS	439	int compression_level = -1;
	440	int verbose = 0;
	441	int i;
4fac1d3a	442	int list = 0;
ba053ea9	443	int worktree_attributes = 0;
4fac1d3a RS	444	struct option opts[] = {
4fac1d3a RS	445	OPT_GROUP(""),
0012a387 NTND	446	OPT_STRING(0, "format", &format, N_("fmt"), N_("archive format")),
	447	OPT_STRING(0, "prefix", &base, N_("prefix"),
	448	N_("prepend prefix to each pathname in the archive")),
	449	OPT_STRING('o', "output", &output, N_("file"),
	450	N_("write the archive to this file")),
f858c646	451	OPT_BOOL(0, "worktree-attributes", &worktree_attributes,
0012a387 NTND	452	N_("read .gitattributes in working directory")),
	453	OPT__VERBOSE(&verbose, N_("report archived files on stderr")),
	454	OPT__COMPR('0', &compression_level, N_("store only"), 0),
	455	OPT__COMPR('1', &compression_level, N_("compress faster"), 1),
4fac1d3a RS	456	OPT__COMPR_HIDDEN('2', &compression_level, 2),
	457	OPT__COMPR_HIDDEN('3', &compression_level, 3),
	458	OPT__COMPR_HIDDEN('4', &compression_level, 4),
	459	OPT__COMPR_HIDDEN('5', &compression_level, 5),
	460	OPT__COMPR_HIDDEN('6', &compression_level, 6),
	461	OPT__COMPR_HIDDEN('7', &compression_level, 7),
	462	OPT__COMPR_HIDDEN('8', &compression_level, 8),
0012a387	463	OPT__COMPR('9', &compression_level, N_("compress better"), 9),
4fac1d3a	464	OPT_GROUP(""),
f858c646	465	OPT_BOOL('l', "list", &list,
0012a387	466	N_("list supported archive formats")),
4fac1d3a	467	OPT_GROUP(""),
0012a387 NTND	468	OPT_STRING(0, "remote", &remote, N_("repo"),
0012a387 NTND	469	N_("retrieve the archive from remote repository <repo>")),
b0ff9654	470	OPT_STRING(0, "exec", &exec, N_("command"),
0012a387	471	N_("path to the remote git-upload-archive command")),
4fac1d3a RS	472	OPT_END()
	473	};
	474
37782920	475	argc = parse_options(argc, argv, NULL, opts, archive_usage, 0);
4fac1d3a RS	476
4fac1d3a RS	477	if (remote)
5a36d00c	478	die(_("Unexpected option --remote"));
4fac1d3a	479	if (exec)
5a36d00c	480	die(_("Option --exec can only be used together with --remote"));
52e77876	481	if (output)
5a36d00c	482	die(_("Unexpected option --output"));
4fac1d3a RS	483
	484	if (!base)
	485	base = "";
	486
	487	if (list) {
13e0f88d	488	for (i = 0; i < nr_archivers; i++)
7b97730b JK	489	if (!is_remote \|\| archivers[i]->flags & ARCHIVER_REMOTE)
7b97730b JK	490	printf("%s\n", archivers[i]->name);
4fac1d3a	491	exit(0);
c0885435 RS	492	}
c0885435 RS	493
56baa61d JK	494	if (!format && name_hint)
	495	format = archive_format_from_filename(name_hint);
	496	if (!format)
	497	format = "tar";
	498
c0885435	499	/* We need at least one parameter -- tree-ish */
4fac1d3a RS	500	if (argc < 1)
4fac1d3a RS	501	usage_with_options(archive_usage, opts);
c0885435	502	*ar = lookup_archiver(format);
7b97730b	503	if (!ar \|\| (is_remote && !((ar)->flags & ARCHIVER_REMOTE)))
5a36d00c	504	die(_("Unknown archive format '%s'"), format);
c0885435 RS	505
	506	args->compression_level = Z_DEFAULT_COMPRESSION;
	507	if (compression_level != -1) {
13e0f88d	508	if ((*ar)->flags & ARCHIVER_WANT_COMPRESSION_LEVELS)
c0885435 RS	509	args->compression_level = compression_level;
c0885435 RS	510	else {
5a36d00c	511	die(_("Argument not supported for format '%s': -%d"),
c0885435 RS	512	format, compression_level);
	513	}
	514	}
	515	args->verbose = verbose;
	516	args->base = base;
	517	args->baselen = strlen(base);
ba053ea9	518	args->worktree_attributes = worktree_attributes;
c0885435	519
4fac1d3a	520	return argc;
c0885435 RS	521	}
c0885435 RS	522
6e94e683	523	int write_archive(int argc, const char *argv, const char prefix,
b612ee20	524	struct repository *repo,
eb0224c6	525	const char *name_hint, int remote)
6e94e683 RS	526	{
	527	const struct archiver *ar = NULL;
	528	struct archiver_args args;
6e94e683	529
95790ff6 TA	530	git_config_get_bool("uploadarchive.allowunreachable", &remote_allow_unreachable);
	531	git_config(git_default_config, NULL);
	532
13e0f88d JK	533	init_tar_archiver();
13e0f88d JK	534	init_zip_archiver();
23212862	535
b612ee20	536	args.repo = repo;
7b97730b	537	argc = parse_archive_args(argc, argv, &ar, &args, name_hint, remote);
eb0224c6	538	if (!startup_info->have_repository) {
23212862 JK	539	/*
	540	* We know this will die() with an error, so we could just
	541	* die ourselves; but its error message will be more specific
	542	* than what we could write here.
	543	*/
	544	setup_git_directory();
	545	}
6e94e683	546
ee27ca4a	547	parse_treeish_arg(argv, &args, prefix, remote);
6e94e683 RS	548	parse_pathspec_arg(argv + 1, &args);
6e94e683 RS	549
4d7c9898	550	return ar->write_archive(ar, &args);
6e94e683	551	}
56baa61d	552
08716b3c JK	553	static int match_extension(const char filename, const char ext)
	554	{
	555	int prefixlen = strlen(filename) - strlen(ext);
	556
	557	/*
	558	* We need 1 character for the '.', and 1 character to ensure that the
	559	* prefix is non-empty (k.e., we don't match .tar.gz with no actual
	560	* filename).
	561	*/
b1cdfb54	562	if (prefixlen < 2 \|\| filename[prefixlen - 1] != '.')
08716b3c JK	563	return 0;
	564	return !strcmp(filename + prefixlen, ext);
	565	}
	566
56baa61d JK	567	const char archive_format_from_filename(const char filename)
56baa61d JK	568	{
08716b3c JK	569	int i;
	570
	571	for (i = 0; i < nr_archivers; i++)
	572	if (match_extension(filename, archivers[i]->name))
	573	return archivers[i]->name;
56baa61d JK	574	return NULL;
56baa61d JK	575	}