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