[thirdparty/git.git] / builtin-show-ref.c

#include "builtin.h"
#include "cache.h"
#include "refs.h"
#include "object.h"
#include "tag.h"
#include "string-list.h"
#include "parse-options.h"

static const char * const show_ref_usage[] = {
	"git show-ref [-q|--quiet] [--verify] [--head] [-d|--dereference] [-s|--hash[=<n>]] [--abbrev[=<n>]] [--tags] [--heads] [--] [pattern*] ",
	"git show-ref --exclude-existing[=pattern] < ref-list",
	NULL
};

static int deref_tags, show_head, tags_only, heads_only, found_match, verify,
	   quiet, hash_only, abbrev, exclude_arg;
static const char **pattern;
static const char *exclude_existing_arg;

static void show_one(const char *refname, const unsigned char *sha1)
{
	const char *hex = find_unique_abbrev(sha1, abbrev);
	if (hash_only)
		printf("%s\n", hex);
	else
		printf("%s %s\n", hex, refname);
}

static int show_ref(const char *refname, const unsigned char *sha1, int flag, void *cbdata)
{
	struct object *obj;
	const char *hex;
	unsigned char peeled[20];

	if (tags_only || heads_only) {
		int match;

		match = heads_only && !prefixcmp(refname, "refs/heads/");
		match |= tags_only && !prefixcmp(refname, "refs/tags/");
		if (!match)
			return 0;
	}
	if (pattern) {
		int reflen = strlen(refname);
		const char **p = pattern, *m;
		while ((m = *p++) != NULL) {
			int len = strlen(m);
			if (len > reflen)
				continue;
			if (memcmp(m, refname + reflen - len, len))
				continue;
			if (len == reflen)
				goto match;
			/* "--verify" requires an exact match */
			if (verify)
				continue;
			if (refname[reflen - len - 1] == '/')
				goto match;
		}
		return 0;
	}

match:
	found_match++;

	/* This changes the semantics slightly that even under quiet we
	 * detect and return error if the repository is corrupt and
	 * ref points at a nonexistent object.
	 */
	if (!has_sha1_file(sha1))
		die("git show-ref: bad ref %s (%s)", refname,
		    sha1_to_hex(sha1));

	if (quiet)
		return 0;

	show_one(refname, sha1);

	if (!deref_tags)
		return 0;

	if ((flag & REF_ISPACKED) && !peel_ref(refname, peeled)) {
		if (!is_null_sha1(peeled)) {
			hex = find_unique_abbrev(peeled, abbrev);
			printf("%s %s^{}\n", hex, refname);
		}
	}
	else {
		obj = parse_object(sha1);
		if (!obj)
			die("git show-ref: bad ref %s (%s)", refname,
			    sha1_to_hex(sha1));
		if (obj->type == OBJ_TAG) {
			obj = deref_tag(obj, refname, 0);
			if (!obj)
				die("git show-ref: bad tag at ref %s (%s)", refname,
				    sha1_to_hex(sha1));
			hex = find_unique_abbrev(obj->sha1, abbrev);
			printf("%s %s^{}\n", hex, refname);
		}
	}
	return 0;
}

static int add_existing(const char *refname, const unsigned char *sha1, int flag, void *cbdata)
{
	struct string_list *list = (struct string_list *)cbdata;
	string_list_insert(refname, list);
	return 0;
}

/*
 * read "^(?:<anything>\s)?<refname>(?:\^\{\})?$" from the standard input,
 * and
 * (1) strip "^{}" at the end of line if any;
 * (2) ignore if match is provided and does not head-match refname;
 * (3) warn if refname is not a well-formed refname and skip;
 * (4) ignore if refname is a ref that exists in the local repository;
 * (5) otherwise output the line.
 */
static int exclude_existing(const char *match)
{
	static struct string_list existing_refs = { NULL, 0, 0, 0 };
	char buf[1024];
	int matchlen = match ? strlen(match) : 0;

	for_each_ref(add_existing, &existing_refs);
	while (fgets(buf, sizeof(buf), stdin)) {
		char *ref;
		int len = strlen(buf);

		if (len > 0 && buf[len - 1] == '\n')
			buf[--len] = '\0';
		if (3 <= len && !strcmp(buf + len - 3, "^{}")) {
			len -= 3;
			buf[len] = '\0';
		}
		for (ref = buf + len; buf < ref; ref--)
			if (isspace(ref[-1]))
				break;
		if (match) {
			int reflen = buf + len - ref;
			if (reflen < matchlen)
				continue;
			if (strncmp(ref, match, matchlen))
				continue;
		}
		if (check_ref_format(ref)) {
			warning("ref '%s' ignored", ref);
			continue;
		}
		if (!string_list_has_string(&existing_refs, ref)) {
			printf("%s\n", buf);
		}
	}
	return 0;
}

static int hash_callback(const struct option *opt, const char *arg, int unset)
{
	hash_only = 1;
	/* Use full length SHA1 if no argument */
	if (!arg)
		return 0;
	return parse_opt_abbrev_cb(opt, arg, unset);
}

static int exclude_existing_callback(const struct option *opt, const char *arg,
				     int unset)
{
	exclude_arg = 1;
	*(const char **)opt->value = arg;
	return 0;
}

static int help_callback(const struct option *opt, const char *arg, int unset)
{
	return -1;
}

static const struct option show_ref_options[] = {
	OPT_BOOLEAN(0, "tags", &tags_only, "only show tags (can be combined with heads)"),
	OPT_BOOLEAN(0, "heads", &heads_only, "only show heads (can be combined with tags)"),
	OPT_BOOLEAN(0, "verify", &verify, "stricter reference checking, "
		    "requires exact ref path"),
	{ OPTION_BOOLEAN, 'h', NULL, &show_head, NULL,
	  "show the HEAD reference",
	  PARSE_OPT_NOARG | PARSE_OPT_HIDDEN },
	OPT_BOOLEAN(0, "head", &show_head, "show the HEAD reference"),
	OPT_BOOLEAN('d', "dereference", &deref_tags,
		    "dereference tags into object IDs"),
	{ OPTION_CALLBACK, 's', "hash", &abbrev, "n",
	  "only show SHA1 hash using <n> digits",
	  PARSE_OPT_OPTARG, &hash_callback },
	OPT__ABBREV(&abbrev),
	OPT__QUIET(&quiet),
	{ OPTION_CALLBACK, 0, "exclude-existing", &exclude_existing_arg,
	  "pattern", "show refs from stdin that aren't in local repository",
	  PARSE_OPT_OPTARG | PARSE_OPT_NONEG, exclude_existing_callback },
	{ OPTION_CALLBACK, 0, "help-all", NULL, NULL, "show usage",
	  PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, help_callback },
	OPT_END()
};

int cmd_show_ref(int argc, const char **argv, const char *prefix)
{
	if (argc == 2 && !strcmp(argv[1], "-h"))
		usage_with_options(show_ref_usage, show_ref_options);

	argc = parse_options(argc, argv, prefix, show_ref_options,
			     show_ref_usage, PARSE_OPT_NO_INTERNAL_HELP);

	if (exclude_arg)
		return exclude_existing(exclude_existing_arg);

	pattern = argv;
	if (!*pattern)
		pattern = NULL;

	if (verify) {
		if (!pattern)
			die("--verify requires a reference");
		while (*pattern) {
			unsigned char sha1[20];

			if (!prefixcmp(*pattern, "refs/") &&
			    resolve_ref(*pattern, sha1, 1, NULL)) {
				if (!quiet)
					show_one(*pattern, sha1);
			}
			else if (!quiet)
				die("'%s' - not a valid ref", *pattern);
			else
				return 1;
			pattern++;
		}
		return 0;
	}

	if (show_head)
		head_ref(show_ref, NULL);
	for_each_ref(show_ref, NULL);
	if (!found_match) {
		if (verify && !quiet)
			die("No match");
		return 1;
	}
	return 0;
}
Commit	Line	Data
baffc0e7	1	#include "builtin.h"
358ddb62 LT	2	#include "cache.h"
	3	#include "refs.h"
	4	#include "object.h"
	5	#include "tag.h"
c455c87c	6	#include "string-list.h"
69932bc6	7	#include "parse-options.h"
358ddb62	8
69932bc6	9	static const char * const show_ref_usage[] = {
e62b3935	10	"git show-ref [-q\|--quiet] [--verify] [--head] [-d\|--dereference] [-s\|--hash[=<n>]] [--abbrev[=<n>]] [--tags] [--heads] [--] [pattern*] ",
69932bc6 SB	11	"git show-ref --exclude-existing[=pattern] < ref-list",
	12	NULL
	13	};
358ddb62	14
69932bc6 SB	15	static int deref_tags, show_head, tags_only, heads_only, found_match, verify,
69932bc6 SB	16	quiet, hash_only, abbrev, exclude_arg;
358ddb62	17	static const char **pattern;
69932bc6	18	static const char *exclude_existing_arg;
358ddb62	19
64fe031a JH	20	static void show_one(const char refname, const unsigned char sha1)
	21	{
	22	const char *hex = find_unique_abbrev(sha1, abbrev);
	23	if (hash_only)
	24	printf("%s\n", hex);
	25	else
	26	printf("%s %s\n", hex, refname);
	27	}
	28
eaf12a8c	29	static int show_ref(const char refname, const unsigned char sha1, int flag, void *cbdata)
358ddb62 LT	30	{
358ddb62 LT	31	struct object *obj;
2eaf2224	32	const char *hex;
cf0adba7	33	unsigned char peeled[20];
358ddb62 LT	34
	35	if (tags_only \|\| heads_only) {
	36	int match;
	37
cc44c765 JH	38	match = heads_only && !prefixcmp(refname, "refs/heads/");
cc44c765 JH	39	match \|= tags_only && !prefixcmp(refname, "refs/tags/");
358ddb62 LT	40	if (!match)
	41	return 0;
	42	}
	43	if (pattern) {
	44	int reflen = strlen(refname);
	45	const char *p = pattern, m;
	46	while ((m = *p++) != NULL) {
	47	int len = strlen(m);
	48	if (len > reflen)
	49	continue;
	50	if (memcmp(m, refname + reflen - len, len))
	51	continue;
	52	if (len == reflen)
	53	goto match;
	54	/* "--verify" requires an exact match */
	55	if (verify)
	56	continue;
	57	if (refname[reflen - len - 1] == '/')
	58	goto match;
	59	}
	60	return 0;
	61	}
	62
	63	match:
	64	found_match++;
cf0adba7 JH	65
	66	/* This changes the semantics slightly that even under quiet we
	67	* detect and return error if the repository is corrupt and
	68	* ref points at a nonexistent object.
	69	*/
	70	if (!has_sha1_file(sha1))
7e44c935	71	die("git show-ref: bad ref %s (%s)", refname,
cf0adba7 JH	72	sha1_to_hex(sha1));
cf0adba7 JH	73
358ddb62 LT	74	if (quiet)
358ddb62 LT	75	return 0;
2eaf2224	76
64fe031a	77	show_one(refname, sha1);
cf0adba7 JH	78
	79	if (!deref_tags)
	80	return 0;
	81
	82	if ((flag & REF_ISPACKED) && !peel_ref(refname, peeled)) {
f4204ab9 JH	83	if (!is_null_sha1(peeled)) {
	84	hex = find_unique_abbrev(peeled, abbrev);
	85	printf("%s %s^{}\n", hex, refname);
	86	}
358ddb62	87	}
cf0adba7 JH	88	else {
	89	obj = parse_object(sha1);
	90	if (!obj)
7e44c935	91	die("git show-ref: bad ref %s (%s)", refname,
cf0adba7 JH	92	sha1_to_hex(sha1));
	93	if (obj->type == OBJ_TAG) {
	94	obj = deref_tag(obj, refname, 0);
affeef12	95	if (!obj)
7e44c935	96	die("git show-ref: bad tag at ref %s (%s)", refname,
affeef12	97	sha1_to_hex(sha1));
cf0adba7 JH	98	hex = find_unique_abbrev(obj->sha1, abbrev);
	99	printf("%s %s^{}\n", hex, refname);
	100	}
	101	}
358ddb62 LT	102	return 0;
	103	}
	104
ed9f7c95 JH	105	static int add_existing(const char refname, const unsigned char sha1, int flag, void *cbdata)
ed9f7c95 JH	106	{
c455c87c JS	107	struct string_list list = (struct string_list )cbdata;
c455c87c JS	108	string_list_insert(refname, list);
ed9f7c95 JH	109	return 0;
	110	}
	111
	112	/*
	113	* read "^(?:<anything>\s)?<refname>(?:\^\{\})?$" from the standard input,
	114	* and
	115	* (1) strip "^{}" at the end of line if any;
	116	* (2) ignore if match is provided and does not head-match refname;
	117	* (3) warn if refname is not a well-formed refname and skip;
	118	* (4) ignore if refname is a ref that exists in the local repository;
	119	* (5) otherwise output the line.
	120	*/
	121	static int exclude_existing(const char *match)
	122	{
c455c87c	123	static struct string_list existing_refs = { NULL, 0, 0, 0 };
ed9f7c95 JH	124	char buf[1024];
	125	int matchlen = match ? strlen(match) : 0;
	126
	127	for_each_ref(add_existing, &existing_refs);
	128	while (fgets(buf, sizeof(buf), stdin)) {
ed9f7c95	129	char *ref;
d8285af4 JH	130	int len = strlen(buf);
d8285af4 JH	131
ed9f7c95 JH	132	if (len > 0 && buf[len - 1] == '\n')
ed9f7c95 JH	133	buf[--len] = '\0';
d8285af4	134	if (3 <= len && !strcmp(buf + len - 3, "^{}")) {
ed9f7c95 JH	135	len -= 3;
	136	buf[len] = '\0';
	137	}
	138	for (ref = buf + len; buf < ref; ref--)
	139	if (isspace(ref[-1]))
	140	break;
	141	if (match) {
	142	int reflen = buf + len - ref;
	143	if (reflen < matchlen)
	144	continue;
	145	if (strncmp(ref, match, matchlen))
	146	continue;
	147	}
	148	if (check_ref_format(ref)) {
5620e77e	149	warning("ref '%s' ignored", ref);
ed9f7c95 JH	150	continue;
ed9f7c95 JH	151	}
c455c87c	152	if (!string_list_has_string(&existing_refs, ref)) {
ed9f7c95 JH	153	printf("%s\n", buf);
	154	}
	155	}
	156	return 0;
	157	}
	158
69932bc6 SB	159	static int hash_callback(const struct option opt, const char arg, int unset)
	160	{
	161	hash_only = 1;
	162	/* Use full length SHA1 if no argument */
	163	if (!arg)
	164	return 0;
	165	return parse_opt_abbrev_cb(opt, arg, unset);
	166	}
	167
	168	static int exclude_existing_callback(const struct option opt, const char arg,
	169	int unset)
	170	{
	171	exclude_arg = 1;
	172	(const char *)opt->value = arg;
	173	return 0;
	174	}
	175
	176	static int help_callback(const struct option opt, const char arg, int unset)
	177	{
	178	return -1;
	179	}
	180
	181	static const struct option show_ref_options[] = {
	182	OPT_BOOLEAN(0, "tags", &tags_only, "only show tags (can be combined with heads)"),
	183	OPT_BOOLEAN(0, "heads", &heads_only, "only show heads (can be combined with tags)"),
	184	OPT_BOOLEAN(0, "verify", &verify, "stricter reference checking, "
	185	"requires exact ref path"),
e62b3935 JN	186	{ OPTION_BOOLEAN, 'h', NULL, &show_head, NULL,
	187	"show the HEAD reference",
	188	PARSE_OPT_NOARG \| PARSE_OPT_HIDDEN },
	189	OPT_BOOLEAN(0, "head", &show_head, "show the HEAD reference"),
69932bc6 SB	190	OPT_BOOLEAN('d', "dereference", &deref_tags,
	191	"dereference tags into object IDs"),
	192	{ OPTION_CALLBACK, 's', "hash", &abbrev, "n",
	193	"only show SHA1 hash using <n> digits",
	194	PARSE_OPT_OPTARG, &hash_callback },
	195	OPT__ABBREV(&abbrev),
	196	OPT__QUIET(&quiet),
	197	{ OPTION_CALLBACK, 0, "exclude-existing", &exclude_existing_arg,
	198	"pattern", "show refs from stdin that aren't in local repository",
	199	PARSE_OPT_OPTARG \| PARSE_OPT_NONEG, exclude_existing_callback },
	200	{ OPTION_CALLBACK, 0, "help-all", NULL, NULL, "show usage",
	201	PARSE_OPT_HIDDEN \| PARSE_OPT_NOARG, help_callback },
	202	OPT_END()
	203	};
	204
358ddb62 LT	205	int cmd_show_ref(int argc, const char *argv, const char prefix)
358ddb62 LT	206	{
e62b3935 JN	207	if (argc == 2 && !strcmp(argv[1], "-h"))
	208	usage_with_options(show_ref_usage, show_ref_options);
	209
69932bc6 SB	210	argc = parse_options(argc, argv, prefix, show_ref_options,
69932bc6 SB	211	show_ref_usage, PARSE_OPT_NO_INTERNAL_HELP);
358ddb62	212
69932bc6 SB	213	if (exclude_arg)
	214	return exclude_existing(exclude_existing_arg);
	215
	216	pattern = argv;
	217	if (!*pattern)
	218	pattern = NULL;
26cdd1e7 JH	219
26cdd1e7 JH	220	if (verify) {
8ab40a20 DL	221	if (!pattern)
8ab40a20 DL	222	die("--verify requires a reference");
26cdd1e7	223	while (*pattern) {
8ab40a20 DL	224	unsigned char sha1[20];
8ab40a20 DL	225
cc44c765	226	if (!prefixcmp(*pattern, "refs/") &&
64fe031a	227	resolve_ref(*pattern, sha1, 1, NULL)) {
dd914299	228	if (!quiet)
64fe031a	229	show_one(*pattern, sha1);
dd914299	230	}
26cdd1e7 JH	231	else if (!quiet)
	232	die("'%s' - not a valid ref", *pattern);
	233	else
	234	return 1;
	235	pattern++;
	236	}
	237	return 0;
	238	}
	239
358ddb62	240	if (show_head)
eaf12a8c JH	241	head_ref(show_ref, NULL);
eaf12a8c JH	242	for_each_ref(show_ref, NULL);
358ddb62 LT	243	if (!found_match) {
	244	if (verify && !quiet)
	245	die("No match");
	246	return 1;
	247	}
	248	return 0;
	249	}