builtin/show-ref.c

   1 #define USE_THE_REPOSITORY_VARIABLE
   2 #include "builtin.h"
   3 #include "config.h"
   4 #include "gettext.h"
   5 #include "hex.h"
   6 #include "refs/refs-internal.h"
   7 #include "object-name.h"
   8 #include "object-store.h"
   9 #include "object.h"
  10 #include "string-list.h"
  11 #include "parse-options.h"
  12
  13 static const char * const show_ref_usage[] = {
  14         N_("git show-ref [--head] [-d | --dereference]\n"
  15            "             [-s | --hash[=<n>]] [--abbrev[=<n>]] [--branches] [--tags]\n"
  16            "             [--] [<pattern>...]"),
  17         N_("git show-ref --verify [-q | --quiet] [-d | --dereference]\n"
  18            "             [-s | --hash[=<n>]] [--abbrev[=<n>]]\n"
  19            "             [--] [<ref>...]"),
  20         N_("git show-ref --exclude-existing[=<pattern>]"),
  21         N_("git show-ref --exists <ref>"),
  22         NULL
  23 };
  24
  25 struct show_one_options {
  26         int quiet;
  27         int hash_only;
  28         int abbrev;
  29         int deref_tags;
  30 };
  31
  32 static void show_one(const struct show_one_options *opts,
  33                      const char *refname, const struct object_id *oid)
  34 {
  35         const char *hex;
  36         struct object_id peeled;
  37
  38         if (!has_object(the_repository, oid,
  39                         HAS_OBJECT_RECHECK_PACKED | HAS_OBJECT_FETCH_PROMISOR))
  40                 die("git show-ref: bad ref %s (%s)", refname,
  41                     oid_to_hex(oid));
  42
  43         if (opts->quiet)
  44                 return;
  45
  46         hex = repo_find_unique_abbrev(the_repository, oid, opts->abbrev);
  47         if (opts->hash_only)
  48                 printf("%s\n", hex);
  49         else
  50                 printf("%s %s\n", hex, refname);
  51
  52         if (!opts->deref_tags)
  53                 return;
  54
  55         if (!peel_iterated_oid(the_repository, oid, &peeled)) {
  56                 hex = repo_find_unique_abbrev(the_repository, &peeled, opts->abbrev);
  57                 printf("%s %s^{}\n", hex, refname);
  58         }
  59 }
  60
  61 struct show_ref_data {
  62         const struct show_one_options *show_one_opts;
  63         const char **patterns;
  64         int found_match;
  65         int show_head;
  66 };
  67
  68 static int show_ref(const char *refname, const char *referent UNUSED, const struct object_id *oid,
  69                     int flag UNUSED, void *cbdata)
  70 {
  71         struct show_ref_data *data = cbdata;
  72
  73         if (data->show_head && !strcmp(refname, "HEAD"))
  74                 goto match;
  75
  76         if (data->patterns) {
  77                 int reflen = strlen(refname);
  78                 const char **p = data->patterns, *m;
  79                 while ((m = *p++) != NULL) {
  80                         int len = strlen(m);
  81                         if (len > reflen)
  82                                 continue;
  83                         if (memcmp(m, refname + reflen - len, len))
  84                                 continue;
  85                         if (len == reflen)
  86                                 goto match;
  87                         if (refname[reflen - len - 1] == '/')
  88                                 goto match;
  89                 }
  90                 return 0;
  91         }
  92
  93 match:
  94         data->found_match++;
  95
  96         show_one(data->show_one_opts, refname, oid);
  97
  98         return 0;
  99 }
 100
 101 static int add_existing(const char *refname,
 102                         const char *referent UNUSED,
 103                         const struct object_id *oid UNUSED,
 104                         int flag UNUSED, void *cbdata)
 105 {
 106         struct string_list *list = (struct string_list *)cbdata;
 107         string_list_insert(list, refname);
 108         return 0;
 109 }
 110
 111 struct exclude_existing_options {
 112         /*
 113          * We need an explicit `enabled` field because it is perfectly valid
 114          * for `pattern` to be `NULL` even if `--exclude-existing` was given.
 115          */
 116         int enabled;
 117         const char *pattern;
 118 };
 119
 120 /*
 121  * read "^(?:<anything>\s)?<refname>(?:\^\{\})?$" from the standard input,
 122  * and
 123  * (1) strip "^{}" at the end of line if any;
 124  * (2) ignore if match is provided and does not head-match refname;
 125  * (3) warn if refname is not a well-formed refname and skip;
 126  * (4) ignore if refname is a ref that exists in the local repository;
 127  * (5) otherwise output the line.
 128  */
 129 static int cmd_show_ref__exclude_existing(const struct exclude_existing_options *opts)
 130 {
 131         struct string_list existing_refs = STRING_LIST_INIT_DUP;
 132         char buf[1024];
 133         int patternlen = opts->pattern ? strlen(opts->pattern) : 0;
 134
 135         refs_for_each_ref(get_main_ref_store(the_repository), add_existing,
 136                           &existing_refs);
 137         while (fgets(buf, sizeof(buf), stdin)) {
 138                 char *ref;
 139                 int len = strlen(buf);
 140
 141                 if (len > 0 && buf[len - 1] == '\n')
 142                         buf[--len] = '\0';
 143                 if (3 <= len && !strcmp(buf + len - 3, "^{}")) {
 144                         len -= 3;
 145                         buf[len] = '\0';
 146                 }
 147                 for (ref = buf + len; buf < ref; ref--)
 148                         if (isspace(ref[-1]))
 149                                 break;
 150                 if (opts->pattern) {
 151                         int reflen = buf + len - ref;
 152                         if (reflen < patternlen)
 153                                 continue;
 154                         if (strncmp(ref, opts->pattern, patternlen))
 155                                 continue;
 156                 }
 157                 if (check_refname_format(ref, 0)) {
 158                         warning("ref '%s' ignored", ref);
 159                         continue;
 160                 }
 161                 if (!string_list_has_string(&existing_refs, ref)) {
 162                         printf("%s\n", buf);
 163                 }
 164         }
 165
 166         string_list_clear(&existing_refs, 0);
 167         return 0;
 168 }
 169
 170 static int cmd_show_ref__verify(const struct show_one_options *show_one_opts,
 171                                 const char **refs)
 172 {
 173         if (!refs || !*refs)
 174                 die("--verify requires a reference");
 175
 176         while (*refs) {
 177                 struct object_id oid;
 178
 179                 if ((starts_with(*refs, "refs/") || refname_is_safe(*refs)) &&
 180                     !refs_read_ref(get_main_ref_store(the_repository), *refs, &oid)) {
 181                         show_one(show_one_opts, *refs, &oid);
 182                 }
 183                 else if (!show_one_opts->quiet)
 184                         die("'%s' - not a valid ref", *refs);
 185                 else
 186                         return 1;
 187                 refs++;
 188         }
 189
 190         return 0;
 191 }
 192
 193 struct patterns_options {
 194         int show_head;
 195         int branches_only;
 196         int tags_only;
 197 };
 198
 199 static int cmd_show_ref__patterns(const struct patterns_options *opts,
 200                                   const struct show_one_options *show_one_opts,
 201                                   const char **patterns)
 202 {
 203         struct show_ref_data show_ref_data = {
 204                 .show_one_opts = show_one_opts,
 205                 .show_head = opts->show_head,
 206         };
 207
 208         if (patterns && *patterns)
 209                 show_ref_data.patterns = patterns;
 210
 211         if (opts->show_head)
 212                 refs_head_ref(get_main_ref_store(the_repository), show_ref,
 213                               &show_ref_data);
 214         if (opts->branches_only || opts->tags_only) {
 215                 if (opts->branches_only)
 216                         refs_for_each_fullref_in(get_main_ref_store(the_repository),
 217                                                  "refs/heads/", NULL,
 218                                                  show_ref, &show_ref_data);
 219                 if (opts->tags_only)
 220                         refs_for_each_fullref_in(get_main_ref_store(the_repository),
 221                                                  "refs/tags/", NULL, show_ref,
 222                                                  &show_ref_data);
 223         } else {
 224                 refs_for_each_ref(get_main_ref_store(the_repository),
 225                                   show_ref, &show_ref_data);
 226         }
 227         if (!show_ref_data.found_match)
 228                 return 1;
 229
 230         return 0;
 231 }
 232
 233 static int cmd_show_ref__exists(const char **refs)
 234 {
 235         struct strbuf unused_referent = STRBUF_INIT;
 236         struct object_id unused_oid;
 237         unsigned int unused_type;
 238         int failure_errno = 0;
 239         const char *ref;
 240         int ret = 0;
 241
 242         if (!refs || !*refs)
 243                 die("--exists requires a reference");
 244         ref = *refs++;
 245         if (*refs)
 246                 die("--exists requires exactly one reference");
 247
 248         if (refs_read_raw_ref(get_main_ref_store(the_repository), ref,
 249                               &unused_oid, &unused_referent, &unused_type,
 250                               &failure_errno)) {
 251                 if (failure_errno == ENOENT || failure_errno == EISDIR) {
 252                         error(_("reference does not exist"));
 253                         ret = 2;
 254                 } else {
 255                         errno = failure_errno;
 256                         error_errno(_("failed to look up reference"));
 257                         ret = 1;
 258                 }
 259
 260                 goto out;
 261         }
 262
 263 out:
 264         strbuf_release(&unused_referent);
 265         return ret;
 266 }
 267
 268 static int hash_callback(const struct option *opt, const char *arg, int unset)
 269 {
 270         struct show_one_options *opts = opt->value;
 271         struct option abbrev_opt = *opt;
 272
 273         opts->hash_only = 1;
 274         /* Use full length SHA1 if no argument */
 275         if (!arg)
 276                 return 0;
 277
 278         abbrev_opt.value = &opts->abbrev;
 279         return parse_opt_abbrev_cb(&abbrev_opt, arg, unset);
 280 }
 281
 282 static int exclude_existing_callback(const struct option *opt, const char *arg,
 283                                      int unset)
 284 {
 285         struct exclude_existing_options *opts = opt->value;
 286         BUG_ON_OPT_NEG(unset);
 287         opts->enabled = 1;
 288         opts->pattern = arg;
 289         return 0;
 290 }
 291
 292 int cmd_show_ref(int argc,
 293 const char **argv,
 294 const char *prefix,
 295 struct repository *repo UNUSED)
 296 {
 297         struct exclude_existing_options exclude_existing_opts = {0};
 298         struct patterns_options patterns_opts = {0};
 299         struct show_one_options show_one_opts = {0};
 300         int verify = 0, exists = 0;
 301         const struct option show_ref_options[] = {
 302                 OPT_BOOL(0, "tags", &patterns_opts.tags_only, N_("only show tags (can be combined with --branches)")),
 303                 OPT_BOOL(0, "branches", &patterns_opts.branches_only, N_("only show branches (can be combined with --tags)")),
 304                 OPT_HIDDEN_BOOL(0, "heads", &patterns_opts.branches_only,
 305                                 N_("deprecated synonym for --branches")),
 306                 OPT_BOOL(0, "exists", &exists, N_("check for reference existence without resolving")),
 307                 OPT_BOOL(0, "verify", &verify, N_("stricter reference checking, "
 308                             "requires exact ref path")),
 309                 OPT_HIDDEN_BOOL('h', NULL, &patterns_opts.show_head,
 310                                 N_("show the HEAD reference, even if it would be filtered out")),
 311                 OPT_BOOL(0, "head", &patterns_opts.show_head,
 312                   N_("show the HEAD reference, even if it would be filtered out")),
 313                 OPT_BOOL('d', "dereference", &show_one_opts.deref_tags,
 314                             N_("dereference tags into object IDs")),
 315                 OPT_CALLBACK_F('s', "hash", &show_one_opts, N_("n"),
 316                                N_("only show SHA1 hash using <n> digits"),
 317                                PARSE_OPT_OPTARG, &hash_callback),
 318                 OPT__ABBREV(&show_one_opts.abbrev),
 319                 OPT__QUIET(&show_one_opts.quiet,
 320                            N_("do not print results to stdout (useful with --verify)")),
 321                 OPT_CALLBACK_F(0, "exclude-existing", &exclude_existing_opts,
 322                                N_("pattern"), N_("show refs from stdin that aren't in local repository"),
 323                                PARSE_OPT_OPTARG | PARSE_OPT_NONEG, exclude_existing_callback),
 324                 OPT_END()
 325         };
 326
 327         git_config(git_default_config, NULL);
 328
 329         argc = parse_options(argc, argv, prefix, show_ref_options,
 330                              show_ref_usage, 0);
 331
 332         die_for_incompatible_opt3(exclude_existing_opts.enabled, "--exclude-existing",
 333                                   verify, "--verify",
 334                                   exists, "--exists");
 335
 336         if (exclude_existing_opts.enabled)
 337                 return cmd_show_ref__exclude_existing(&exclude_existing_opts);
 338         else if (verify)
 339                 return cmd_show_ref__verify(&show_one_opts, argv);
 340         else if (exists)
 341                 return cmd_show_ref__exists(argv);
 342         else
 343                 return cmd_show_ref__patterns(&patterns_opts, &show_one_opts, argv);
 344 }