blob: 87806ad5b088f5c905757a4fab3c3499ec20a308 [file] [log] [blame]
Peter Hagervallbaffc0e2007-07-15 01:14:45 +02001#include "builtin.h"
Linus Torvalds358ddb62006-09-15 11:19:32 -07002#include "cache.h"
3#include "refs.h"
4#include "object.h"
5#include "tag.h"
Johannes Schindelinc455c872008-07-21 19:03:49 +01006#include "string-list.h"
Stephen Boyd69932bc2009-06-20 21:40:46 -07007#include "parse-options.h"
Linus Torvalds358ddb62006-09-15 11:19:32 -07008
Stephen Boyd69932bc2009-06-20 21:40:46 -07009static const char * const show_ref_usage[] = {
Nguyễn Thái Ngọc Duyc9120b12012-08-20 19:32:45 +070010 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] < ref-list"),
Stephen Boyd69932bc2009-06-20 21:40:46 -070012 NULL
13};
Linus Torvalds358ddb62006-09-15 11:19:32 -070014
Stephen Boyd69932bc2009-06-20 21:40:46 -070015static int deref_tags, show_head, tags_only, heads_only, found_match, verify,
16 quiet, hash_only, abbrev, exclude_arg;
Linus Torvalds358ddb62006-09-15 11:19:32 -070017static const char **pattern;
Stephen Boyd69932bc2009-06-20 21:40:46 -070018static const char *exclude_existing_arg;
Linus Torvalds358ddb62006-09-15 11:19:32 -070019
Junio C Hamano64fe0312006-12-17 19:27:49 -080020static 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
Junio C Hamanoeaf12a82006-09-21 00:40:28 -070029static int show_ref(const char *refname, const unsigned char *sha1, int flag, void *cbdata)
Linus Torvalds358ddb62006-09-15 11:19:32 -070030{
Junio C Hamano2eaf2222006-10-01 00:27:27 -070031 const char *hex;
Junio C Hamanocf0adba2006-11-19 13:22:44 -080032 unsigned char peeled[20];
Linus Torvalds358ddb62006-09-15 11:19:32 -070033
Doug Bell3f3d0ce2013-07-16 19:05:14 -050034 if (show_head && !strcmp(refname, "HEAD"))
35 goto match;
36
Linus Torvalds358ddb62006-09-15 11:19:32 -070037 if (tags_only || heads_only) {
38 int match;
39
Junio C Hamanocc44c762007-02-20 01:53:29 -080040 match = heads_only && !prefixcmp(refname, "refs/heads/");
41 match |= tags_only && !prefixcmp(refname, "refs/tags/");
Linus Torvalds358ddb62006-09-15 11:19:32 -070042 if (!match)
43 return 0;
44 }
45 if (pattern) {
46 int reflen = strlen(refname);
47 const char **p = pattern, *m;
48 while ((m = *p++) != NULL) {
49 int len = strlen(m);
50 if (len > reflen)
51 continue;
52 if (memcmp(m, refname + reflen - len, len))
53 continue;
54 if (len == reflen)
55 goto match;
56 /* "--verify" requires an exact match */
57 if (verify)
58 continue;
59 if (refname[reflen - len - 1] == '/')
60 goto match;
61 }
62 return 0;
63 }
64
65match:
66 found_match++;
Junio C Hamanocf0adba2006-11-19 13:22:44 -080067
68 /* This changes the semantics slightly that even under quiet we
69 * detect and return error if the repository is corrupt and
70 * ref points at a nonexistent object.
71 */
72 if (!has_sha1_file(sha1))
Junio C Hamano7e44c932008-08-31 09:39:19 -070073 die("git show-ref: bad ref %s (%s)", refname,
Junio C Hamanocf0adba2006-11-19 13:22:44 -080074 sha1_to_hex(sha1));
75
Linus Torvalds358ddb62006-09-15 11:19:32 -070076 if (quiet)
77 return 0;
Junio C Hamano2eaf2222006-10-01 00:27:27 -070078
Junio C Hamano64fe0312006-12-17 19:27:49 -080079 show_one(refname, sha1);
Junio C Hamanocf0adba2006-11-19 13:22:44 -080080
81 if (!deref_tags)
82 return 0;
83
Jeff Kinge6dbffa2012-10-04 04:00:19 -040084 if (!peel_ref(refname, peeled)) {
85 hex = find_unique_abbrev(peeled, abbrev);
86 printf("%s %s^{}\n", hex, refname);
Junio C Hamanocf0adba2006-11-19 13:22:44 -080087 }
Linus Torvalds358ddb62006-09-15 11:19:32 -070088 return 0;
89}
90
Junio C Hamanoed9f7c92006-12-17 17:57:19 -080091static int add_existing(const char *refname, const unsigned char *sha1, int flag, void *cbdata)
92{
Johannes Schindelinc455c872008-07-21 19:03:49 +010093 struct string_list *list = (struct string_list *)cbdata;
Julian Phillips78a395d2010-06-26 00:41:35 +010094 string_list_insert(list, refname);
Junio C Hamanoed9f7c92006-12-17 17:57:19 -080095 return 0;
96}
97
98/*
99 * read "^(?:<anything>\s)?<refname>(?:\^\{\})?$" from the standard input,
100 * and
101 * (1) strip "^{}" at the end of line if any;
102 * (2) ignore if match is provided and does not head-match refname;
103 * (3) warn if refname is not a well-formed refname and skip;
104 * (4) ignore if refname is a ref that exists in the local repository;
105 * (5) otherwise output the line.
106 */
107static int exclude_existing(const char *match)
108{
Michael Haggerty66ce0362013-05-25 11:08:22 +0200109 static struct string_list existing_refs = STRING_LIST_INIT_DUP;
Junio C Hamanoed9f7c92006-12-17 17:57:19 -0800110 char buf[1024];
111 int matchlen = match ? strlen(match) : 0;
112
113 for_each_ref(add_existing, &existing_refs);
114 while (fgets(buf, sizeof(buf), stdin)) {
Junio C Hamanoed9f7c92006-12-17 17:57:19 -0800115 char *ref;
Junio C Hamanod8285af2006-12-18 13:33:47 -0800116 int len = strlen(buf);
117
Junio C Hamanoed9f7c92006-12-17 17:57:19 -0800118 if (len > 0 && buf[len - 1] == '\n')
119 buf[--len] = '\0';
Junio C Hamanod8285af2006-12-18 13:33:47 -0800120 if (3 <= len && !strcmp(buf + len - 3, "^{}")) {
Junio C Hamanoed9f7c92006-12-17 17:57:19 -0800121 len -= 3;
122 buf[len] = '\0';
123 }
124 for (ref = buf + len; buf < ref; ref--)
125 if (isspace(ref[-1]))
126 break;
127 if (match) {
128 int reflen = buf + len - ref;
129 if (reflen < matchlen)
130 continue;
131 if (strncmp(ref, match, matchlen))
132 continue;
133 }
Michael Haggerty8d9c5012011-09-15 23:10:25 +0200134 if (check_refname_format(ref, 0)) {
Miklos Vajna5620e772009-03-24 02:09:16 +0100135 warning("ref '%s' ignored", ref);
Junio C Hamanoed9f7c92006-12-17 17:57:19 -0800136 continue;
137 }
Johannes Schindelinc455c872008-07-21 19:03:49 +0100138 if (!string_list_has_string(&existing_refs, ref)) {
Junio C Hamanoed9f7c92006-12-17 17:57:19 -0800139 printf("%s\n", buf);
140 }
141 }
142 return 0;
143}
144
Stephen Boyd69932bc2009-06-20 21:40:46 -0700145static int hash_callback(const struct option *opt, const char *arg, int unset)
146{
147 hash_only = 1;
148 /* Use full length SHA1 if no argument */
149 if (!arg)
150 return 0;
151 return parse_opt_abbrev_cb(opt, arg, unset);
152}
153
154static int exclude_existing_callback(const struct option *opt, const char *arg,
155 int unset)
156{
157 exclude_arg = 1;
158 *(const char **)opt->value = arg;
159 return 0;
160}
161
162static int help_callback(const struct option *opt, const char *arg, int unset)
163{
164 return -1;
165}
166
167static const struct option show_ref_options[] = {
Nguyễn Thái Ngọc Duyc9120b12012-08-20 19:32:45 +0700168 OPT_BOOLEAN(0, "tags", &tags_only, N_("only show tags (can be combined with heads)")),
169 OPT_BOOLEAN(0, "heads", &heads_only, N_("only show heads (can be combined with tags)")),
170 OPT_BOOLEAN(0, "verify", &verify, N_("stricter reference checking, "
171 "requires exact ref path")),
Jonathan Niedere62b3932009-11-09 09:04:46 -0600172 { OPTION_BOOLEAN, 'h', NULL, &show_head, NULL,
Doug Bell3f3d0ce2013-07-16 19:05:14 -0500173 N_("show the HEAD reference, even if it would be filtered out"),
Jonathan Niedere62b3932009-11-09 09:04:46 -0600174 PARSE_OPT_NOARG | PARSE_OPT_HIDDEN },
Doug Bell3f3d0ce2013-07-16 19:05:14 -0500175 OPT_BOOLEAN(0, "head", &show_head,
176 N_("show the HEAD reference, even if it would be filtered out")),
Stephen Boyd69932bc2009-06-20 21:40:46 -0700177 OPT_BOOLEAN('d', "dereference", &deref_tags,
Nguyễn Thái Ngọc Duyc9120b12012-08-20 19:32:45 +0700178 N_("dereference tags into object IDs")),
179 { OPTION_CALLBACK, 's', "hash", &abbrev, N_("n"),
180 N_("only show SHA1 hash using <n> digits"),
Stephen Boyd69932bc2009-06-20 21:40:46 -0700181 PARSE_OPT_OPTARG, &hash_callback },
182 OPT__ABBREV(&abbrev),
Jonathan Nieder8c839682010-11-08 13:54:48 -0600183 OPT__QUIET(&quiet,
Nguyễn Thái Ngọc Duyc9120b12012-08-20 19:32:45 +0700184 N_("do not print results to stdout (useful with --verify)")),
Stephen Boyd69932bc2009-06-20 21:40:46 -0700185 { OPTION_CALLBACK, 0, "exclude-existing", &exclude_existing_arg,
Nguyễn Thái Ngọc Duyc9120b12012-08-20 19:32:45 +0700186 N_("pattern"), N_("show refs from stdin that aren't in local repository"),
Stephen Boyd69932bc2009-06-20 21:40:46 -0700187 PARSE_OPT_OPTARG | PARSE_OPT_NONEG, exclude_existing_callback },
Nguyễn Thái Ngọc Duyc9120b12012-08-20 19:32:45 +0700188 { OPTION_CALLBACK, 0, "help-all", NULL, NULL, N_("show usage"),
Stephen Boyd69932bc2009-06-20 21:40:46 -0700189 PARSE_OPT_HIDDEN | PARSE_OPT_NOARG, help_callback },
190 OPT_END()
191};
192
Linus Torvalds358ddb62006-09-15 11:19:32 -0700193int cmd_show_ref(int argc, const char **argv, const char *prefix)
194{
Jonathan Niedere62b3932009-11-09 09:04:46 -0600195 if (argc == 2 && !strcmp(argv[1], "-h"))
196 usage_with_options(show_ref_usage, show_ref_options);
197
Stephen Boyd69932bc2009-06-20 21:40:46 -0700198 argc = parse_options(argc, argv, prefix, show_ref_options,
199 show_ref_usage, PARSE_OPT_NO_INTERNAL_HELP);
Linus Torvalds358ddb62006-09-15 11:19:32 -0700200
Stephen Boyd69932bc2009-06-20 21:40:46 -0700201 if (exclude_arg)
202 return exclude_existing(exclude_existing_arg);
203
204 pattern = argv;
205 if (!*pattern)
206 pattern = NULL;
Junio C Hamano26cdd1e2006-12-17 18:08:52 -0800207
208 if (verify) {
Dmitry V. Levin8ab40a22007-02-23 20:12:33 +0300209 if (!pattern)
210 die("--verify requires a reference");
Junio C Hamano26cdd1e2006-12-17 18:08:52 -0800211 while (*pattern) {
Dmitry V. Levin8ab40a22007-02-23 20:12:33 +0300212 unsigned char sha1[20];
213
Junio C Hamanocc44c762007-02-20 01:53:29 -0800214 if (!prefixcmp(*pattern, "refs/") &&
Nguyễn Thái Ngọc Duyc6893322011-11-13 17:22:14 +0700215 !read_ref(*pattern, sha1)) {
Junio C Hamanodd914292006-12-17 18:53:24 -0800216 if (!quiet)
Junio C Hamano64fe0312006-12-17 19:27:49 -0800217 show_one(*pattern, sha1);
Junio C Hamanodd914292006-12-17 18:53:24 -0800218 }
Junio C Hamano26cdd1e2006-12-17 18:08:52 -0800219 else if (!quiet)
220 die("'%s' - not a valid ref", *pattern);
221 else
222 return 1;
223 pattern++;
224 }
225 return 0;
226 }
227
Linus Torvalds358ddb62006-09-15 11:19:32 -0700228 if (show_head)
Junio C Hamanoeaf12a82006-09-21 00:40:28 -0700229 head_ref(show_ref, NULL);
230 for_each_ref(show_ref, NULL);
Linus Torvalds358ddb62006-09-15 11:19:32 -0700231 if (!found_match) {
232 if (verify && !quiet)
233 die("No match");
234 return 1;
235 }
236 return 0;
237}