builtin/show-ref.c

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