builtin/show-ref.c

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