git

1
#include "builtin.h"
2
#include "config.h"
3
#include "gettext.h"
4
#include "hex.h"
5
#include "refs/refs-internal.h"
6
#include "object-name.h"
7
#include "object-store-ll.h"
8
#include "object.h"
9
#include "string-list.h"
10
#include "parse-options.h"
11

12
static const char * const show_ref_usage[] = {
13
	N_("git show-ref [--head] [-d | --dereference]\n"
14
	   "             [-s | --hash[=<n>]] [--abbrev[=<n>]] [--branches] [--tags]\n"
15
	   "             [--] [<pattern>...]"),
16
	N_("git show-ref --verify [-q | --quiet] [-d | --dereference]\n"
17
	   "             [-s | --hash[=<n>]] [--abbrev[=<n>]]\n"
18
	   "             [--] [<ref>...]"),
19
	N_("git show-ref --exclude-existing[=<pattern>]"),
20
	N_("git show-ref --exists <ref>"),
21
	NULL
22
};
23

24
struct show_one_options {
25
	int quiet;
26
	int hash_only;
27
	int abbrev;
28
	int deref_tags;
29
};
30

31
static void show_one(const struct show_one_options *opts,
32
		     const char *refname, const struct object_id *oid)
33
{
34
	const char *hex;
35
	struct object_id peeled;
36

37
	if (!repo_has_object_file(the_repository, oid))
38
		die("git show-ref: bad ref %s (%s)", refname,
39
		    oid_to_hex(oid));
40

41
	if (opts->quiet)
42
		return;
43

44
	hex = repo_find_unique_abbrev(the_repository, oid, opts->abbrev);
45
	if (opts->hash_only)
46
		printf("%s\n", hex);
47
	else
48
		printf("%s %s\n", hex, refname);
49

50
	if (!opts->deref_tags)
51
		return;
52

53
	if (!peel_iterated_oid(the_repository, oid, &peeled)) {
54
		hex = repo_find_unique_abbrev(the_repository, &peeled, opts->abbrev);
55
		printf("%s %s^{}\n", hex, refname);
56
	}
57
}
58

59
struct show_ref_data {
60
	const struct show_one_options *show_one_opts;
61
	const char **patterns;
62
	int found_match;
63
	int show_head;
64
};
65

66
static int show_ref(const char *refname, const char *referent UNUSED, const struct object_id *oid,
67
		    int flag UNUSED, void *cbdata)
68
{
69
	struct show_ref_data *data = cbdata;
70

71
	if (data->show_head && !strcmp(refname, "HEAD"))
72
		goto match;
73

74
	if (data->patterns) {
75
		int reflen = strlen(refname);
76
		const char **p = data->patterns, *m;
77
		while ((m = *p++) != NULL) {
78
			int len = strlen(m);
79
			if (len > reflen)
80
				continue;
81
			if (memcmp(m, refname + reflen - len, len))
82
				continue;
83
			if (len == reflen)
84
				goto match;
85
			if (refname[reflen - len - 1] == '/')
86
				goto match;
87
		}
88
		return 0;
89
	}
90

91
match:
92
	data->found_match++;
93

94
	show_one(data->show_one_opts, refname, oid);
95

96
	return 0;
97
}
98

99
static int add_existing(const char *refname,
100
			const char *referent UNUSED,
101
			const struct object_id *oid UNUSED,
102
			int flag UNUSED, void *cbdata)
103
{
104
	struct string_list *list = (struct string_list *)cbdata;
105
	string_list_insert(list, refname);
106
	return 0;
107
}
108

109
struct exclude_existing_options {
110
	/*
111
	 * We need an explicit `enabled` field because it is perfectly valid
112
	 * for `pattern` to be `NULL` even if `--exclude-existing` was given.
113
	 */
114
	int enabled;
115
	const char *pattern;
116
};
117

118
/*
119
 * read "^(?:<anything>\s)?<refname>(?:\^\{\})?$" from the standard input,
120
 * and
121
 * (1) strip "^{}" at the end of line if any;
122
 * (2) ignore if match is provided and does not head-match refname;
123
 * (3) warn if refname is not a well-formed refname and skip;
124
 * (4) ignore if refname is a ref that exists in the local repository;
125
 * (5) otherwise output the line.
126
 */
127
static int cmd_show_ref__exclude_existing(const struct exclude_existing_options *opts)
128
{
129
	struct string_list existing_refs = STRING_LIST_INIT_DUP;
130
	char buf[1024];
131
	int patternlen = opts->pattern ? strlen(opts->pattern) : 0;
132

133
	refs_for_each_ref(get_main_ref_store(the_repository), add_existing,
134
			  &existing_refs);
135
	while (fgets(buf, sizeof(buf), stdin)) {
136
		char *ref;
137
		int len = strlen(buf);
138

139
		if (len > 0 && buf[len - 1] == '\n')
140
			buf[--len] = '\0';
141
		if (3 <= len && !strcmp(buf + len - 3, "^{}")) {
142
			len -= 3;
143
			buf[len] = '\0';
144
		}
145
		for (ref = buf + len; buf < ref; ref--)
146
			if (isspace(ref[-1]))
147
				break;
148
		if (opts->pattern) {
149
			int reflen = buf + len - ref;
150
			if (reflen < patternlen)
151
				continue;
152
			if (strncmp(ref, opts->pattern, patternlen))
153
				continue;
154
		}
155
		if (check_refname_format(ref, 0)) {
156
			warning("ref '%s' ignored", ref);
157
			continue;
158
		}
159
		if (!string_list_has_string(&existing_refs, ref)) {
160
			printf("%s\n", buf);
161
		}
162
	}
163

164
	string_list_clear(&existing_refs, 0);
165
	return 0;
166
}
167

168
static int cmd_show_ref__verify(const struct show_one_options *show_one_opts,
169
				const char **refs)
170
{
171
	if (!refs || !*refs)
172
		die("--verify requires a reference");
173

174
	while (*refs) {
175
		struct object_id oid;
176

177
		if ((starts_with(*refs, "refs/") || refname_is_safe(*refs)) &&
178
		    !refs_read_ref(get_main_ref_store(the_repository), *refs, &oid)) {
179
			show_one(show_one_opts, *refs, &oid);
180
		}
181
		else if (!show_one_opts->quiet)
182
			die("'%s' - not a valid ref", *refs);
183
		else
184
			return 1;
185
		refs++;
186
	}
187

188
	return 0;
189
}
190

191
struct patterns_options {
192
	int show_head;
193
	int branches_only;
194
	int tags_only;
195
};
196

197
static int cmd_show_ref__patterns(const struct patterns_options *opts,
198
				  const struct show_one_options *show_one_opts,
199
				  const char **patterns)
200
{
201
	struct show_ref_data show_ref_data = {
202
		.show_one_opts = show_one_opts,
203
		.show_head = opts->show_head,
204
	};
205

206
	if (patterns && *patterns)
207
		show_ref_data.patterns = patterns;
208

209
	if (opts->show_head)
210
		refs_head_ref(get_main_ref_store(the_repository), show_ref,
211
			      &show_ref_data);
212
	if (opts->branches_only || opts->tags_only) {
213
		if (opts->branches_only)
214
			refs_for_each_fullref_in(get_main_ref_store(the_repository),
215
						 "refs/heads/", NULL,
216
						 show_ref, &show_ref_data);
217
		if (opts->tags_only)
218
			refs_for_each_fullref_in(get_main_ref_store(the_repository),
219
						 "refs/tags/", NULL, show_ref,
220
						 &show_ref_data);
221
	} else {
222
		refs_for_each_ref(get_main_ref_store(the_repository),
223
				  show_ref, &show_ref_data);
224
	}
225
	if (!show_ref_data.found_match)
226
		return 1;
227

228
	return 0;
229
}
230

231
static int cmd_show_ref__exists(const char **refs)
232
{
233
	struct strbuf unused_referent = STRBUF_INIT;
234
	struct object_id unused_oid;
235
	unsigned int unused_type;
236
	int failure_errno = 0;
237
	const char *ref;
238
	int ret = 0;
239

240
	if (!refs || !*refs)
241
		die("--exists requires a reference");
242
	ref = *refs++;
243
	if (*refs)
244
		die("--exists requires exactly one reference");
245

246
	if (refs_read_raw_ref(get_main_ref_store(the_repository), ref,
247
			      &unused_oid, &unused_referent, &unused_type,
248
			      &failure_errno)) {
249
		if (failure_errno == ENOENT || failure_errno == EISDIR) {
250
			error(_("reference does not exist"));
251
			ret = 2;
252
		} else {
253
			errno = failure_errno;
254
			error_errno(_("failed to look up reference"));
255
			ret = 1;
256
		}
257

258
		goto out;
259
	}
260

261
out:
262
	strbuf_release(&unused_referent);
263
	return ret;
264
}
265

266
static int hash_callback(const struct option *opt, const char *arg, int unset)
267
{
268
	struct show_one_options *opts = opt->value;
269
	struct option abbrev_opt = *opt;
270

271
	opts->hash_only = 1;
272
	/* Use full length SHA1 if no argument */
273
	if (!arg)
274
		return 0;
275

276
	abbrev_opt.value = &opts->abbrev;
277
	return parse_opt_abbrev_cb(&abbrev_opt, arg, unset);
278
}
279

280
static int exclude_existing_callback(const struct option *opt, const char *arg,
281
				     int unset)
282
{
283
	struct exclude_existing_options *opts = opt->value;
284
	BUG_ON_OPT_NEG(unset);
285
	opts->enabled = 1;
286
	opts->pattern = arg;
287
	return 0;
288
}
289

290
int cmd_show_ref(int argc, const char **argv, const char *prefix)
291
{
292
	struct exclude_existing_options exclude_existing_opts = {0};
293
	struct patterns_options patterns_opts = {0};
294
	struct show_one_options show_one_opts = {0};
295
	int verify = 0, exists = 0;
296
	const struct option show_ref_options[] = {
297
		OPT_BOOL(0, "tags", &patterns_opts.tags_only, N_("only show tags (can be combined with --branches)")),
298
		OPT_BOOL(0, "branches", &patterns_opts.branches_only, N_("only show branches (can be combined with --tags)")),
299
		OPT_HIDDEN_BOOL(0, "heads", &patterns_opts.branches_only,
300
				N_("deprecated synonym for --branches")),
301
		OPT_BOOL(0, "exists", &exists, N_("check for reference existence without resolving")),
302
		OPT_BOOL(0, "verify", &verify, N_("stricter reference checking, "
303
			    "requires exact ref path")),
304
		OPT_HIDDEN_BOOL('h', NULL, &patterns_opts.show_head,
305
				N_("show the HEAD reference, even if it would be filtered out")),
306
		OPT_BOOL(0, "head", &patterns_opts.show_head,
307
		  N_("show the HEAD reference, even if it would be filtered out")),
308
		OPT_BOOL('d', "dereference", &show_one_opts.deref_tags,
309
			    N_("dereference tags into object IDs")),
310
		OPT_CALLBACK_F('s', "hash", &show_one_opts, N_("n"),
311
			       N_("only show SHA1 hash using <n> digits"),
312
			       PARSE_OPT_OPTARG, &hash_callback),
313
		OPT__ABBREV(&show_one_opts.abbrev),
314
		OPT__QUIET(&show_one_opts.quiet,
315
			   N_("do not print results to stdout (useful with --verify)")),
316
		OPT_CALLBACK_F(0, "exclude-existing", &exclude_existing_opts,
317
			       N_("pattern"), N_("show refs from stdin that aren't in local repository"),
318
			       PARSE_OPT_OPTARG | PARSE_OPT_NONEG, exclude_existing_callback),
319
		OPT_END()
320
	};
321

322
	git_config(git_default_config, NULL);
323

324
	argc = parse_options(argc, argv, prefix, show_ref_options,
325
			     show_ref_usage, 0);
326

327
	die_for_incompatible_opt3(exclude_existing_opts.enabled, "--exclude-existing",
328
				  verify, "--verify",
329
				  exists, "--exists");
330

331
	if (exclude_existing_opts.enabled)
332
		return cmd_show_ref__exclude_existing(&exclude_existing_opts);
333
	else if (verify)
334
		return cmd_show_ref__verify(&show_one_opts, argv);
335
	else if (exists)
336
		return cmd_show_ref__exists(argv);
337
	else
338
		return cmd_show_ref__patterns(&patterns_opts, &show_one_opts, argv);
339
}
340