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