Merge branch 'jt/http-redact-cookies' into maint
[git.git] / builtin / show-ref.c
blob41e5e71cad660d26ddc90ffeaa383fd7bf10f79f
1 #include "builtin.h"
2 #include "cache.h"
3 #include "refs.h"
4 #include "object.h"
5 #include "tag.h"
6 #include "string-list.h"
7 #include "parse-options.h"
9 static const char * const show_ref_usage[] = {
10 N_("git show-ref [-q | --quiet] [--verify] [--head] [-d | --dereference] [-s | --hash[=<n>]] [--abbrev[=<n>]] [--tags] [--heads] [--] [<pattern>...]"),
11 N_("git show-ref --exclude-existing[=<pattern>]"),
12 NULL
15 static int deref_tags, show_head, tags_only, heads_only, found_match, verify,
16 quiet, hash_only, abbrev, exclude_arg;
17 static const char **pattern;
18 static const char *exclude_existing_arg;
20 static void show_one(const char *refname, const struct object_id *oid)
22 const char *hex;
23 struct object_id peeled;
25 if (!has_sha1_file(oid->hash))
26 die("git show-ref: bad ref %s (%s)", refname,
27 oid_to_hex(oid));
29 if (quiet)
30 return;
32 hex = find_unique_abbrev(oid->hash, abbrev);
33 if (hash_only)
34 printf("%s\n", hex);
35 else
36 printf("%s %s\n", hex, refname);
38 if (!deref_tags)
39 return;
41 if (!peel_ref(refname, &peeled)) {
42 hex = find_unique_abbrev(peeled.hash, abbrev);
43 printf("%s %s^{}\n", hex, refname);
47 static int show_ref(const char *refname, const struct object_id *oid,
48 int flag, void *cbdata)
50 if (show_head && !strcmp(refname, "HEAD"))
51 goto match;
53 if (tags_only || heads_only) {
54 int match;
56 match = heads_only && starts_with(refname, "refs/heads/");
57 match |= tags_only && starts_with(refname, "refs/tags/");
58 if (!match)
59 return 0;
61 if (pattern) {
62 int reflen = strlen(refname);
63 const char **p = pattern, *m;
64 while ((m = *p++) != NULL) {
65 int len = strlen(m);
66 if (len > reflen)
67 continue;
68 if (memcmp(m, refname + reflen - len, len))
69 continue;
70 if (len == reflen)
71 goto match;
72 if (refname[reflen - len - 1] == '/')
73 goto match;
75 return 0;
78 match:
79 found_match++;
81 show_one(refname, oid);
83 return 0;
86 static int add_existing(const char *refname, const struct object_id *oid,
87 int flag, void *cbdata)
89 struct string_list *list = (struct string_list *)cbdata;
90 string_list_insert(list, refname);
91 return 0;
95 * read "^(?:<anything>\s)?<refname>(?:\^\{\})?$" from the standard input,
96 * and
97 * (1) strip "^{}" at the end of line if any;
98 * (2) ignore if match is provided and does not head-match refname;
99 * (3) warn if refname is not a well-formed refname and skip;
100 * (4) ignore if refname is a ref that exists in the local repository;
101 * (5) otherwise output the line.
103 static int exclude_existing(const char *match)
105 static struct string_list existing_refs = STRING_LIST_INIT_DUP;
106 char buf[1024];
107 int matchlen = match ? strlen(match) : 0;
109 for_each_ref(add_existing, &existing_refs);
110 while (fgets(buf, sizeof(buf), stdin)) {
111 char *ref;
112 int len = strlen(buf);
114 if (len > 0 && buf[len - 1] == '\n')
115 buf[--len] = '\0';
116 if (3 <= len && !strcmp(buf + len - 3, "^{}")) {
117 len -= 3;
118 buf[len] = '\0';
120 for (ref = buf + len; buf < ref; ref--)
121 if (isspace(ref[-1]))
122 break;
123 if (match) {
124 int reflen = buf + len - ref;
125 if (reflen < matchlen)
126 continue;
127 if (strncmp(ref, match, matchlen))
128 continue;
130 if (check_refname_format(ref, 0)) {
131 warning("ref '%s' ignored", ref);
132 continue;
134 if (!string_list_has_string(&existing_refs, ref)) {
135 printf("%s\n", buf);
138 return 0;
141 static int hash_callback(const struct option *opt, const char *arg, int unset)
143 hash_only = 1;
144 /* Use full length SHA1 if no argument */
145 if (!arg)
146 return 0;
147 return parse_opt_abbrev_cb(opt, arg, unset);
150 static int exclude_existing_callback(const struct option *opt, const char *arg,
151 int unset)
153 exclude_arg = 1;
154 *(const char **)opt->value = arg;
155 return 0;
158 static const struct option show_ref_options[] = {
159 OPT_BOOL(0, "tags", &tags_only, N_("only show tags (can be combined with heads)")),
160 OPT_BOOL(0, "heads", &heads_only, N_("only show heads (can be combined with tags)")),
161 OPT_BOOL(0, "verify", &verify, N_("stricter reference checking, "
162 "requires exact ref path")),
163 OPT_HIDDEN_BOOL('h', NULL, &show_head,
164 N_("show the HEAD reference, even if it would be filtered out")),
165 OPT_BOOL(0, "head", &show_head,
166 N_("show the HEAD reference, even if it would be filtered out")),
167 OPT_BOOL('d', "dereference", &deref_tags,
168 N_("dereference tags into object IDs")),
169 { OPTION_CALLBACK, 's', "hash", &abbrev, N_("n"),
170 N_("only show SHA1 hash using <n> digits"),
171 PARSE_OPT_OPTARG, &hash_callback },
172 OPT__ABBREV(&abbrev),
173 OPT__QUIET(&quiet,
174 N_("do not print results to stdout (useful with --verify)")),
175 { OPTION_CALLBACK, 0, "exclude-existing", &exclude_existing_arg,
176 N_("pattern"), N_("show refs from stdin that aren't in local repository"),
177 PARSE_OPT_OPTARG | PARSE_OPT_NONEG, exclude_existing_callback },
178 OPT_END()
181 int cmd_show_ref(int argc, const char **argv, const char *prefix)
183 argc = parse_options(argc, argv, prefix, show_ref_options,
184 show_ref_usage, 0);
186 if (exclude_arg)
187 return exclude_existing(exclude_existing_arg);
189 pattern = argv;
190 if (!*pattern)
191 pattern = NULL;
193 if (verify) {
194 if (!pattern)
195 die("--verify requires a reference");
196 while (*pattern) {
197 struct object_id oid;
199 if ((starts_with(*pattern, "refs/") || !strcmp(*pattern, "HEAD")) &&
200 !read_ref(*pattern, &oid)) {
201 show_one(*pattern, &oid);
203 else if (!quiet)
204 die("'%s' - not a valid ref", *pattern);
205 else
206 return 1;
207 pattern++;
209 return 0;
212 if (show_head)
213 head_ref(show_ref, NULL);
214 for_each_ref(show_ref, NULL);
215 if (!found_match) {
216 if (verify && !quiet)
217 die("No match");
218 return 1;
220 return 0;