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