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