builtin/show-ref.c

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