builtin/for-each-ref.c

   1 #include "builtin.h"
   2 #include "cache.h"
   3 #include "refs.h"
   4 #include "object.h"
   5 #include "tag.h"
   6 #include "commit.h"
   7 #include "tree.h"
   8 #include "blob.h"
   9 #include "quote.h"
  10 #include "parse-options.h"
  11 #include "remote.h"
  12
  13 /* Quoting styles */
  14 #define QUOTE_NONE 0
  15 #define QUOTE_SHELL 1
  16 #define QUOTE_PERL 2
  17 #define QUOTE_PYTHON 4
  18 #define QUOTE_TCL 8
  19
  20 typedef enum { FIELD_STR, FIELD_ULONG, FIELD_TIME } cmp_type;
  21
  22 struct atom_value {
  23         const char *s;
  24         unsigned long ul; /* used for sorting when not FIELD_STR */
  25 };
  26
  27 struct ref_sort {
  28         struct ref_sort *next;
  29         int atom; /* index into used_atom array */
  30         unsigned reverse : 1;
  31 };
  32
  33 struct refinfo {
  34         char *refname;
  35         unsigned char objectname[20];
  36         int flag;
  37         const char *symref;
  38         struct atom_value *value;
  39 };
  40
  41 static struct {
  42         const char *name;
  43         cmp_type cmp_type;
  44 } valid_atom[] = {
  45         { "refname" },
  46         { "objecttype" },
  47         { "objectsize", FIELD_ULONG },
  48         { "objectname" },
  49         { "tree" },
  50         { "parent" },
  51         { "numparent", FIELD_ULONG },
  52         { "object" },
  53         { "type" },
  54         { "tag" },
  55         { "author" },
  56         { "authorname" },
  57         { "authoremail" },
  58         { "authordate", FIELD_TIME },
  59         { "committer" },
  60         { "committername" },
  61         { "committeremail" },
  62         { "committerdate", FIELD_TIME },
  63         { "tagger" },
  64         { "taggername" },
  65         { "taggeremail" },
  66         { "taggerdate", FIELD_TIME },
  67         { "creator" },
  68         { "creatordate", FIELD_TIME },
  69         { "subject" },
  70         { "body" },
  71         { "contents" },
  72         { "upstream" },
  73         { "symref" },
  74         { "flag" },
  75 };
  76
  77 /*
  78  * An atom is a valid field atom listed above, possibly prefixed with
  79  * a "*" to denote deref_tag().
  80  *
  81  * We parse given format string and sort specifiers, and make a list
  82  * of properties that we need to extract out of objects.  refinfo
  83  * structure will hold an array of values extracted that can be
  84  * indexed with the "atom number", which is an index into this
  85  * array.
  86  */
  87 static const char **used_atom;
  88 static cmp_type *used_atom_type;
  89 static int used_atom_cnt, sort_atom_limit, need_tagged, need_symref;
  90
  91 /*
  92  * Used to parse format string and sort specifiers
  93  */
  94 static int parse_atom(const char *atom, const char *ep)
  95 {
  96         const char *sp;
  97         int i, at;
  98
  99         sp = atom;
 100         if (*sp == '*' && sp < ep)
 101                 sp++; /* deref */
 102         if (ep <= sp)
 103                 die("malformed field name: %.*s", (int)(ep-atom), atom);
 104
 105         /* Do we have the atom already used elsewhere? */
 106         for (i = 0; i < used_atom_cnt; i++) {
 107                 int len = strlen(used_atom[i]);
 108                 if (len == ep - atom && !memcmp(used_atom[i], atom, len))
 109                         return i;
 110         }
 111
 112         /* Is the atom a valid one? */
 113         for (i = 0; i < ARRAY_SIZE(valid_atom); i++) {
 114                 int len = strlen(valid_atom[i].name);
 115                 /*
 116                  * If the atom name has a colon, strip it and everything after
 117                  * it off - it specifies the format for this entry, and
 118                  * shouldn't be used for checking against the valid_atom
 119                  * table.
 120                  */
 121                 const char *formatp = strchr(sp, ':');
 122                 if (!formatp || ep < formatp)
 123                         formatp = ep;
 124                 if (len == formatp - sp && !memcmp(valid_atom[i].name, sp, len))
 125                         break;
 126         }
 127
 128         if (ARRAY_SIZE(valid_atom) <= i)
 129                 die("unknown field name: %.*s", (int)(ep-atom), atom);
 130
 131         /* Add it in, including the deref prefix */
 132         at = used_atom_cnt;
 133         used_atom_cnt++;
 134         used_atom = xrealloc(used_atom,
 135                              (sizeof *used_atom) * used_atom_cnt);
 136         used_atom_type = xrealloc(used_atom_type,
 137                                   (sizeof(*used_atom_type) * used_atom_cnt));
 138         used_atom[at] = xmemdupz(atom, ep - atom);
 139         used_atom_type[at] = valid_atom[i].cmp_type;
 140         if (*atom == '*')
 141                 need_tagged = 1;
 142         if (!strcmp(used_atom[at], "symref"))
 143                 need_symref = 1;
 144         return at;
 145 }
 146
 147 /*
 148  * In a format string, find the next occurrence of %(atom).
 149  */
 150 static const char *find_next(const char *cp)
 151 {
 152         while (*cp) {
 153                 if (*cp == '%') {
 154                         /*
 155                          * %( is the start of an atom;
 156                          * %% is a quoted per-cent.
 157                          */
 158                         if (cp[1] == '(')
 159                                 return cp;
 160                         else if (cp[1] == '%')
 161                                 cp++; /* skip over two % */
 162                         /* otherwise this is a singleton, literal % */
 163                 }
 164                 cp++;
 165         }
 166         return NULL;
 167 }
 168
 169 /*
 170  * Make sure the format string is well formed, and parse out
 171  * the used atoms.
 172  */
 173 static int verify_format(const char *format)
 174 {
 175         const char *cp, *sp;
 176         for (cp = format; *cp && (sp = find_next(cp)); ) {
 177                 const char *ep = strchr(sp, ')');
 178                 if (!ep)
 179                         return error("malformed format string %s", sp);
 180                 /* sp points at "%(" and ep points at the closing ")" */
 181                 parse_atom(sp + 2, ep);
 182                 cp = ep + 1;
 183         }
 184         return 0;
 185 }
 186
 187 /*
 188  * Given an object name, read the object data and size, and return a
 189  * "struct object".  If the object data we are returning is also borrowed
 190  * by the "struct object" representation, set *eaten as well---it is a
 191  * signal from parse_object_buffer to us not to free the buffer.
 192  */
 193 static void *get_obj(const unsigned char *sha1, struct object **obj, unsigned long *sz, int *eaten)
 194 {
 195         enum object_type type;
 196         void *buf = read_sha1_file(sha1, &type, sz);
 197
 198         if (buf)
 199                 *obj = parse_object_buffer(sha1, type, *sz, buf, eaten);
 200         else
 201                 *obj = NULL;
 202         return buf;
 203 }
 204
 205 /* See grab_values */
 206 static void grab_common_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
 207 {
 208         int i;
 209
 210         for (i = 0; i < used_atom_cnt; i++) {
 211                 const char *name = used_atom[i];
 212                 struct atom_value *v = &val[i];
 213                 if (!!deref != (*name == '*'))
 214                         continue;
 215                 if (deref)
 216                         name++;
 217                 if (!strcmp(name, "objecttype"))
 218                         v->s = typename(obj->type);
 219                 else if (!strcmp(name, "objectsize")) {
 220                         char *s = xmalloc(40);
 221                         sprintf(s, "%lu", sz);
 222                         v->ul = sz;
 223                         v->s = s;
 224                 }
 225                 else if (!strcmp(name, "objectname")) {
 226                         char *s = xmalloc(41);
 227                         strcpy(s, sha1_to_hex(obj->sha1));
 228                         v->s = s;
 229                 }
 230                 else if (!strcmp(name, "objectname:short")) {
 231                         v->s = xstrdup(find_unique_abbrev(obj->sha1,
 232                                                           DEFAULT_ABBREV));
 233                 }
 234         }
 235 }
 236
 237 /* See grab_values */
 238 static void grab_tag_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
 239 {
 240         int i;
 241         struct tag *tag = (struct tag *) obj;
 242
 243         for (i = 0; i < used_atom_cnt; i++) {
 244                 const char *name = used_atom[i];
 245                 struct atom_value *v = &val[i];
 246                 if (!!deref != (*name == '*'))
 247                         continue;
 248                 if (deref)
 249                         name++;
 250                 if (!strcmp(name, "tag"))
 251                         v->s = tag->tag;
 252                 else if (!strcmp(name, "type") && tag->tagged)
 253                         v->s = typename(tag->tagged->type);
 254                 else if (!strcmp(name, "object") && tag->tagged) {
 255                         char *s = xmalloc(41);
 256                         strcpy(s, sha1_to_hex(tag->tagged->sha1));
 257                         v->s = s;
 258                 }
 259         }
 260 }
 261
 262 static int num_parents(struct commit *commit)
 263 {
 264         struct commit_list *parents;
 265         int i;
 266
 267         for (i = 0, parents = commit->parents;
 268              parents;
 269              parents = parents->next)
 270                 i++;
 271         return i;
 272 }
 273
 274 /* See grab_values */
 275 static void grab_commit_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
 276 {
 277         int i;
 278         struct commit *commit = (struct commit *) obj;
 279
 280         for (i = 0; i < used_atom_cnt; i++) {
 281                 const char *name = used_atom[i];
 282                 struct atom_value *v = &val[i];
 283                 if (!!deref != (*name == '*'))
 284                         continue;
 285                 if (deref)
 286                         name++;
 287                 if (!strcmp(name, "tree")) {
 288                         char *s = xmalloc(41);
 289                         strcpy(s, sha1_to_hex(commit->tree->object.sha1));
 290                         v->s = s;
 291                 }
 292                 if (!strcmp(name, "numparent")) {
 293                         char *s = xmalloc(40);
 294                         v->ul = num_parents(commit);
 295                         sprintf(s, "%lu", v->ul);
 296                         v->s = s;
 297                 }
 298                 else if (!strcmp(name, "parent")) {
 299                         int num = num_parents(commit);
 300                         int i;
 301                         struct commit_list *parents;
 302                         char *s = xmalloc(41 * num + 1);
 303                         v->s = s;
 304                         for (i = 0, parents = commit->parents;
 305                              parents;
 306                              parents = parents->next, i = i + 41) {
 307                                 struct commit *parent = parents->item;
 308                                 strcpy(s+i, sha1_to_hex(parent->object.sha1));
 309                                 if (parents->next)
 310                                         s[i+40] = ' ';
 311                         }
 312                         if (!i)
 313                                 *s = '\0';
 314                 }
 315         }
 316 }
 317
 318 static const char *find_wholine(const char *who, int wholen, const char *buf, unsigned long sz)
 319 {
 320         const char *eol;
 321         while (*buf) {
 322                 if (!strncmp(buf, who, wholen) &&
 323                     buf[wholen] == ' ')
 324                         return buf + wholen + 1;
 325                 eol = strchr(buf, '\n');
 326                 if (!eol)
 327                         return "";
 328                 eol++;
 329                 if (*eol == '\n')
 330                         return ""; /* end of header */
 331                 buf = eol;
 332         }
 333         return "";
 334 }
 335
 336 static const char *copy_line(const char *buf)
 337 {
 338         const char *eol = strchrnul(buf, '\n');
 339         return xmemdupz(buf, eol - buf);
 340 }
 341
 342 static const char *copy_name(const char *buf)
 343 {
 344         const char *cp;
 345         for (cp = buf; *cp && *cp != '\n'; cp++) {
 346                 if (!strncmp(cp, " <", 2))
 347                         return xmemdupz(buf, cp - buf);
 348         }
 349         return "";
 350 }
 351
 352 static const char *copy_email(const char *buf)
 353 {
 354         const char *email = strchr(buf, '<');
 355         const char *eoemail;
 356         if (!email)
 357                 return "";
 358         eoemail = strchr(email, '>');
 359         if (!eoemail)
 360                 return "";
 361         return xmemdupz(email, eoemail + 1 - email);
 362 }
 363
 364 static char *copy_subject(const char *buf, unsigned long len)
 365 {
 366         char *r = xmemdupz(buf, len);
 367         int i;
 368
 369         for (i = 0; i < len; i++)
 370                 if (r[i] == '\n')
 371                         r[i] = ' ';
 372
 373         return r;
 374 }
 375
 376 static void grab_date(const char *buf, struct atom_value *v, const char *atomname)
 377 {
 378         const char *eoemail = strstr(buf, "> ");
 379         char *zone;
 380         unsigned long timestamp;
 381         long tz;
 382         enum date_mode date_mode = DATE_NORMAL;
 383         const char *formatp;
 384
 385         /*
 386          * We got here because atomname ends in "date" or "date<something>";
 387          * it's not possible that <something> is not ":<format>" because
 388          * parse_atom() wouldn't have allowed it, so we can assume that no
 389          * ":" means no format is specified, and use the default.
 390          */
 391         formatp = strchr(atomname, ':');
 392         if (formatp != NULL) {
 393                 formatp++;
 394                 date_mode = parse_date_format(formatp);
 395         }
 396
 397         if (!eoemail)
 398                 goto bad;
 399         timestamp = strtoul(eoemail + 2, &zone, 10);
 400         if (timestamp == ULONG_MAX)
 401                 goto bad;
 402         tz = strtol(zone, NULL, 10);
 403         if ((tz == LONG_MIN || tz == LONG_MAX) && errno == ERANGE)
 404                 goto bad;
 405         v->s = xstrdup(show_date(timestamp, tz, date_mode));
 406         v->ul = timestamp;
 407         return;
 408  bad:
 409         v->s = "";
 410         v->ul = 0;
 411 }
 412
 413 /* See grab_values */
 414 static void grab_person(const char *who, struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
 415 {
 416         int i;
 417         int wholen = strlen(who);
 418         const char *wholine = NULL;
 419
 420         for (i = 0; i < used_atom_cnt; i++) {
 421                 const char *name = used_atom[i];
 422                 struct atom_value *v = &val[i];
 423                 if (!!deref != (*name == '*'))
 424                         continue;
 425                 if (deref)
 426                         name++;
 427                 if (strncmp(who, name, wholen))
 428                         continue;
 429                 if (name[wholen] != 0 &&
 430                     strcmp(name + wholen, "name") &&
 431                     strcmp(name + wholen, "email") &&
 432                     prefixcmp(name + wholen, "date"))
 433                         continue;
 434                 if (!wholine)
 435                         wholine = find_wholine(who, wholen, buf, sz);
 436                 if (!wholine)
 437                         return; /* no point looking for it */
 438                 if (name[wholen] == 0)
 439                         v->s = copy_line(wholine);
 440                 else if (!strcmp(name + wholen, "name"))
 441                         v->s = copy_name(wholine);
 442                 else if (!strcmp(name + wholen, "email"))
 443                         v->s = copy_email(wholine);
 444                 else if (!prefixcmp(name + wholen, "date"))
 445                         grab_date(wholine, v, name);
 446         }
 447
 448         /*
 449          * For a tag or a commit object, if "creator" or "creatordate" is
 450          * requested, do something special.
 451          */
 452         if (strcmp(who, "tagger") && strcmp(who, "committer"))
 453                 return; /* "author" for commit object is not wanted */
 454         if (!wholine)
 455                 wholine = find_wholine(who, wholen, buf, sz);
 456         if (!wholine)
 457                 return;
 458         for (i = 0; i < used_atom_cnt; i++) {
 459                 const char *name = used_atom[i];
 460                 struct atom_value *v = &val[i];
 461                 if (!!deref != (*name == '*'))
 462                         continue;
 463                 if (deref)
 464                         name++;
 465
 466                 if (!prefixcmp(name, "creatordate"))
 467                         grab_date(wholine, v, name);
 468                 else if (!strcmp(name, "creator"))
 469                         v->s = copy_line(wholine);
 470         }
 471 }
 472
 473 static void find_subpos(const char *buf, unsigned long sz,
 474                         const char **sub, unsigned long *sublen,
 475                         const char **body, unsigned long *bodylen)
 476 {
 477         const char *eol;
 478         /* skip past header until we hit empty line */
 479         while (*buf && *buf != '\n') {
 480                 eol = strchrnul(buf, '\n');
 481                 if (*eol)
 482                         eol++;
 483                 buf = eol;
 484         }
 485         /* skip any empty lines */
 486         while (*buf == '\n')
 487                 buf++;
 488
 489         /* subject is first non-empty line */
 490         *sub = buf;
 491         /* subject goes to first empty line */
 492         while (*buf && *buf != '\n') {
 493                 eol = strchrnul(buf, '\n');
 494                 if (*eol)
 495                         eol++;
 496                 buf = eol;
 497         }
 498         *sublen = buf - *sub;
 499         /* drop trailing newline, if present */
 500         if (*sublen && (*sub)[*sublen - 1] == '\n')
 501                 *sublen -= 1;
 502
 503         /* skip any empty lines */
 504         while (*buf == '\n')
 505                 buf++;
 506         *body = buf;
 507         *bodylen = strlen(buf);
 508 }
 509
 510 /* See grab_values */
 511 static void grab_sub_body_contents(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
 512 {
 513         int i;
 514         const char *subpos = NULL, *bodypos;
 515         unsigned long sublen, bodylen;
 516
 517         for (i = 0; i < used_atom_cnt; i++) {
 518                 const char *name = used_atom[i];
 519                 struct atom_value *v = &val[i];
 520                 if (!!deref != (*name == '*'))
 521                         continue;
 522                 if (deref)
 523                         name++;
 524                 if (strcmp(name, "subject") &&
 525                     strcmp(name, "body") &&
 526                     strcmp(name, "contents"))
 527                         continue;
 528                 if (!subpos)
 529                         find_subpos(buf, sz,
 530                                     &subpos, &sublen,
 531                                     &bodypos, &bodylen);
 532
 533                 if (!strcmp(name, "subject"))
 534                         v->s = copy_subject(subpos, sublen);
 535                 else if (!strcmp(name, "body"))
 536                         v->s = xmemdupz(bodypos, bodylen);
 537                 else if (!strcmp(name, "contents"))
 538                         v->s = xstrdup(subpos);
 539         }
 540 }
 541
 542 /*
 543  * We want to have empty print-string for field requests
 544  * that do not apply (e.g. "authordate" for a tag object)
 545  */
 546 static void fill_missing_values(struct atom_value *val)
 547 {
 548         int i;
 549         for (i = 0; i < used_atom_cnt; i++) {
 550                 struct atom_value *v = &val[i];
 551                 if (v->s == NULL)
 552                         v->s = "";
 553         }
 554 }
 555
 556 /*
 557  * val is a list of atom_value to hold returned values.  Extract
 558  * the values for atoms in used_atom array out of (obj, buf, sz).
 559  * when deref is false, (obj, buf, sz) is the object that is
 560  * pointed at by the ref itself; otherwise it is the object the
 561  * ref (which is a tag) refers to.
 562  */
 563 static void grab_values(struct atom_value *val, int deref, struct object *obj, void *buf, unsigned long sz)
 564 {
 565         grab_common_values(val, deref, obj, buf, sz);
 566         switch (obj->type) {
 567         case OBJ_TAG:
 568                 grab_tag_values(val, deref, obj, buf, sz);
 569                 grab_sub_body_contents(val, deref, obj, buf, sz);
 570                 grab_person("tagger", val, deref, obj, buf, sz);
 571                 break;
 572         case OBJ_COMMIT:
 573                 grab_commit_values(val, deref, obj, buf, sz);
 574                 grab_sub_body_contents(val, deref, obj, buf, sz);
 575                 grab_person("author", val, deref, obj, buf, sz);
 576                 grab_person("committer", val, deref, obj, buf, sz);
 577                 break;
 578         case OBJ_TREE:
 579                 /* grab_tree_values(val, deref, obj, buf, sz); */
 580                 break;
 581         case OBJ_BLOB:
 582                 /* grab_blob_values(val, deref, obj, buf, sz); */
 583                 break;
 584         default:
 585                 die("Eh?  Object of type %d?", obj->type);
 586         }
 587 }
 588
 589 static inline char *copy_advance(char *dst, const char *src)
 590 {
 591         while (*src)
 592                 *dst++ = *src++;
 593         return dst;
 594 }
 595
 596 /*
 597  * Parse the object referred by ref, and grab needed value.
 598  */
 599 static void populate_value(struct refinfo *ref)
 600 {
 601         void *buf;
 602         struct object *obj;
 603         int eaten, i;
 604         unsigned long size;
 605         const unsigned char *tagged;
 606
 607         ref->value = xcalloc(sizeof(struct atom_value), used_atom_cnt);
 608
 609         if (need_symref && (ref->flag & REF_ISSYMREF) && !ref->symref) {
 610                 unsigned char unused1[20];
 611                 const char *symref;
 612                 symref = resolve_ref(ref->refname, unused1, 1, NULL);
 613                 if (symref)
 614                         ref->symref = xstrdup(symref);
 615                 else
 616                         ref->symref = "";
 617         }
 618
 619         /* Fill in specials first */
 620         for (i = 0; i < used_atom_cnt; i++) {
 621                 const char *name = used_atom[i];
 622                 struct atom_value *v = &ref->value[i];
 623                 int deref = 0;
 624                 const char *refname;
 625                 const char *formatp;
 626
 627                 if (*name == '*') {
 628                         deref = 1;
 629                         name++;
 630                 }
 631
 632                 if (!prefixcmp(name, "refname"))
 633                         refname = ref->refname;
 634                 else if (!prefixcmp(name, "symref"))
 635                         refname = ref->symref ? ref->symref : "";
 636                 else if (!prefixcmp(name, "upstream")) {
 637                         struct branch *branch;
 638                         /* only local branches may have an upstream */
 639                         if (prefixcmp(ref->refname, "refs/heads/"))
 640                                 continue;
 641                         branch = branch_get(ref->refname + 11);
 642
 643                         if (!branch || !branch->merge || !branch->merge[0] ||
 644                             !branch->merge[0]->dst)
 645                                 continue;
 646                         refname = branch->merge[0]->dst;
 647                 }
 648                 else if (!strcmp(name, "flag")) {
 649                         char buf[256], *cp = buf;
 650                         if (ref->flag & REF_ISSYMREF)
 651                                 cp = copy_advance(cp, ",symref");
 652                         if (ref->flag & REF_ISPACKED)
 653                                 cp = copy_advance(cp, ",packed");
 654                         if (cp == buf)
 655                                 v->s = "";
 656                         else {
 657                                 *cp = '\0';
 658                                 v->s = xstrdup(buf + 1);
 659                         }
 660                         continue;
 661                 }
 662                 else
 663                         continue;
 664
 665                 formatp = strchr(name, ':');
 666                 /* look for "short" refname format */
 667                 if (formatp) {
 668                         formatp++;
 669                         if (!strcmp(formatp, "short"))
 670                                 refname = shorten_unambiguous_ref(refname,
 671                                                       warn_ambiguous_refs);
 672                         else
 673                                 die("unknown %.*s format %s",
 674                                     (int)(formatp - name), name, formatp);
 675                 }
 676
 677                 if (!deref)
 678                         v->s = refname;
 679                 else {
 680                         int len = strlen(refname);
 681                         char *s = xmalloc(len + 4);
 682                         sprintf(s, "%s^{}", refname);
 683                         v->s = s;
 684                 }
 685         }
 686
 687         for (i = 0; i < used_atom_cnt; i++) {
 688                 struct atom_value *v = &ref->value[i];
 689                 if (v->s == NULL)
 690                         goto need_obj;
 691         }
 692         return;
 693
 694  need_obj:
 695         buf = get_obj(ref->objectname, &obj, &size, &eaten);
 696         if (!buf)
 697                 die("missing object %s for %s",
 698                     sha1_to_hex(ref->objectname), ref->refname);
 699         if (!obj)
 700                 die("parse_object_buffer failed on %s for %s",
 701                     sha1_to_hex(ref->objectname), ref->refname);
 702
 703         grab_values(ref->value, 0, obj, buf, size);
 704         if (!eaten)
 705                 free(buf);
 706
 707         /*
 708          * If there is no atom that wants to know about tagged
 709          * object, we are done.
 710          */
 711         if (!need_tagged || (obj->type != OBJ_TAG))
 712                 return;
 713
 714         /*
 715          * If it is a tag object, see if we use a value that derefs
 716          * the object, and if we do grab the object it refers to.
 717          */
 718         tagged = ((struct tag *)obj)->tagged->sha1;
 719
 720         /*
 721          * NEEDSWORK: This derefs tag only once, which
 722          * is good to deal with chains of trust, but
 723          * is not consistent with what deref_tag() does
 724          * which peels the onion to the core.
 725          */
 726         buf = get_obj(tagged, &obj, &size, &eaten);
 727         if (!buf)
 728                 die("missing object %s for %s",
 729                     sha1_to_hex(tagged), ref->refname);
 730         if (!obj)
 731                 die("parse_object_buffer failed on %s for %s",
 732                     sha1_to_hex(tagged), ref->refname);
 733         grab_values(ref->value, 1, obj, buf, size);
 734         if (!eaten)
 735                 free(buf);
 736 }
 737
 738 /*
 739  * Given a ref, return the value for the atom.  This lazily gets value
 740  * out of the object by calling populate value.
 741  */
 742 static void get_value(struct refinfo *ref, int atom, struct atom_value **v)
 743 {
 744         if (!ref->value) {
 745                 populate_value(ref);
 746                 fill_missing_values(ref->value);
 747         }
 748         *v = &ref->value[atom];
 749 }
 750
 751 struct grab_ref_cbdata {
 752         struct refinfo **grab_array;
 753         const char **grab_pattern;
 754         int grab_cnt;
 755 };
 756
 757 /*
 758  * A call-back given to for_each_ref().  Filter refs and keep them for
 759  * later object processing.
 760  */
 761 static int grab_single_ref(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
 762 {
 763         struct grab_ref_cbdata *cb = cb_data;
 764         struct refinfo *ref;
 765         int cnt;
 766
 767         if (*cb->grab_pattern) {
 768                 const char **pattern;
 769                 int namelen = strlen(refname);
 770                 for (pattern = cb->grab_pattern; *pattern; pattern++) {
 771                         const char *p = *pattern;
 772                         int plen = strlen(p);
 773
 774                         if ((plen <= namelen) &&
 775                             !strncmp(refname, p, plen) &&
 776                             (refname[plen] == '\0' ||
 777                              refname[plen] == '/' ||
 778                              p[plen-1] == '/'))
 779                                 break;
 780                         if (!fnmatch(p, refname, FNM_PATHNAME))
 781                                 break;
 782                 }
 783                 if (!*pattern)
 784                         return 0;
 785         }
 786
 787         /*
 788          * We do not open the object yet; sort may only need refname
 789          * to do its job and the resulting list may yet to be pruned
 790          * by maxcount logic.
 791          */
 792         ref = xcalloc(1, sizeof(*ref));
 793         ref->refname = xstrdup(refname);
 794         hashcpy(ref->objectname, sha1);
 795         ref->flag = flag;
 796
 797         cnt = cb->grab_cnt;
 798         cb->grab_array = xrealloc(cb->grab_array,
 799                                   sizeof(*cb->grab_array) * (cnt + 1));
 800         cb->grab_array[cnt++] = ref;
 801         cb->grab_cnt = cnt;
 802         return 0;
 803 }
 804
 805 static int cmp_ref_sort(struct ref_sort *s, struct refinfo *a, struct refinfo *b)
 806 {
 807         struct atom_value *va, *vb;
 808         int cmp;
 809         cmp_type cmp_type = used_atom_type[s->atom];
 810
 811         get_value(a, s->atom, &va);
 812         get_value(b, s->atom, &vb);
 813         switch (cmp_type) {
 814         case FIELD_STR:
 815                 cmp = strcmp(va->s, vb->s);
 816                 break;
 817         default:
 818                 if (va->ul < vb->ul)
 819                         cmp = -1;
 820                 else if (va->ul == vb->ul)
 821                         cmp = 0;
 822                 else
 823                         cmp = 1;
 824                 break;
 825         }
 826         return (s->reverse) ? -cmp : cmp;
 827 }
 828
 829 static struct ref_sort *ref_sort;
 830 static int compare_refs(const void *a_, const void *b_)
 831 {
 832         struct refinfo *a = *((struct refinfo **)a_);
 833         struct refinfo *b = *((struct refinfo **)b_);
 834         struct ref_sort *s;
 835
 836         for (s = ref_sort; s; s = s->next) {
 837                 int cmp = cmp_ref_sort(s, a, b);
 838                 if (cmp)
 839                         return cmp;
 840         }
 841         return 0;
 842 }
 843
 844 static void sort_refs(struct ref_sort *sort, struct refinfo **refs, int num_refs)
 845 {
 846         ref_sort = sort;
 847         qsort(refs, num_refs, sizeof(struct refinfo *), compare_refs);
 848 }
 849
 850 static void print_value(struct refinfo *ref, int atom, int quote_style)
 851 {
 852         struct atom_value *v;
 853         get_value(ref, atom, &v);
 854         switch (quote_style) {
 855         case QUOTE_NONE:
 856                 fputs(v->s, stdout);
 857                 break;
 858         case QUOTE_SHELL:
 859                 sq_quote_print(stdout, v->s);
 860                 break;
 861         case QUOTE_PERL:
 862                 perl_quote_print(stdout, v->s);
 863                 break;
 864         case QUOTE_PYTHON:
 865                 python_quote_print(stdout, v->s);
 866                 break;
 867         case QUOTE_TCL:
 868                 tcl_quote_print(stdout, v->s);
 869                 break;
 870         }
 871 }
 872
 873 static int hex1(char ch)
 874 {
 875         if ('0' <= ch && ch <= '9')
 876                 return ch - '0';
 877         else if ('a' <= ch && ch <= 'f')
 878                 return ch - 'a' + 10;
 879         else if ('A' <= ch && ch <= 'F')
 880                 return ch - 'A' + 10;
 881         return -1;
 882 }
 883 static int hex2(const char *cp)
 884 {
 885         if (cp[0] && cp[1])
 886                 return (hex1(cp[0]) << 4) | hex1(cp[1]);
 887         else
 888                 return -1;
 889 }
 890
 891 static void emit(const char *cp, const char *ep)
 892 {
 893         while (*cp && (!ep || cp < ep)) {
 894                 if (*cp == '%') {
 895                         if (cp[1] == '%')
 896                                 cp++;
 897                         else {
 898                                 int ch = hex2(cp + 1);
 899                                 if (0 <= ch) {
 900                                         putchar(ch);
 901                                         cp += 3;
 902                                         continue;
 903                                 }
 904                         }
 905                 }
 906                 putchar(*cp);
 907                 cp++;
 908         }
 909 }
 910
 911 static void show_ref(struct refinfo *info, const char *format, int quote_style)
 912 {
 913         const char *cp, *sp, *ep;
 914
 915         for (cp = format; *cp && (sp = find_next(cp)); cp = ep + 1) {
 916                 ep = strchr(sp, ')');
 917                 if (cp < sp)
 918                         emit(cp, sp);
 919                 print_value(info, parse_atom(sp + 2, ep), quote_style);
 920         }
 921         if (*cp) {
 922                 sp = cp + strlen(cp);
 923                 emit(cp, sp);
 924         }
 925         putchar('\n');
 926 }
 927
 928 static struct ref_sort *default_sort(void)
 929 {
 930         static const char cstr_name[] = "refname";
 931
 932         struct ref_sort *sort = xcalloc(1, sizeof(*sort));
 933
 934         sort->next = NULL;
 935         sort->atom = parse_atom(cstr_name, cstr_name + strlen(cstr_name));
 936         return sort;
 937 }
 938
 939 static int opt_parse_sort(const struct option *opt, const char *arg, int unset)
 940 {
 941         struct ref_sort **sort_tail = opt->value;
 942         struct ref_sort *s;
 943         int len;
 944
 945         if (!arg) /* should --no-sort void the list ? */
 946                 return -1;
 947
 948         *sort_tail = s = xcalloc(1, sizeof(*s));
 949
 950         if (*arg == '-') {
 951                 s->reverse = 1;
 952                 arg++;
 953         }
 954         len = strlen(arg);
 955         s->atom = parse_atom(arg, arg+len);
 956         return 0;
 957 }
 958
 959 static char const * const for_each_ref_usage[] = {
 960         "git for-each-ref [options] [<pattern>]",
 961         NULL
 962 };
 963
 964 int cmd_for_each_ref(int argc, const char **argv, const char *prefix)
 965 {
 966         int i, num_refs;
 967         const char *format = "%(objectname) %(objecttype)\t%(refname)";
 968         struct ref_sort *sort = NULL, **sort_tail = &sort;
 969         int maxcount = 0, quote_style = 0;
 970         struct refinfo **refs;
 971         struct grab_ref_cbdata cbdata;
 972
 973         struct option opts[] = {
 974                 OPT_BIT('s', "shell", &quote_style,
 975                         "quote placeholders suitably for shells", QUOTE_SHELL),
 976                 OPT_BIT('p', "perl",  &quote_style,
 977                         "quote placeholders suitably for perl", QUOTE_PERL),
 978                 OPT_BIT(0 , "python", &quote_style,
 979                         "quote placeholders suitably for python", QUOTE_PYTHON),
 980                 OPT_BIT(0 , "tcl",  &quote_style,
 981                         "quote placeholders suitably for tcl", QUOTE_TCL),
 982
 983                 OPT_GROUP(""),
 984                 OPT_INTEGER( 0 , "count", &maxcount, "show only <n> matched refs"),
 985                 OPT_STRING(  0 , "format", &format, "format", "format to use for the output"),
 986                 OPT_CALLBACK(0 , "sort", sort_tail, "key",
 987                             "field name to sort on", &opt_parse_sort),
 988                 OPT_END(),
 989         };
 990
 991         parse_options(argc, argv, prefix, opts, for_each_ref_usage, 0);
 992         if (maxcount < 0) {
 993                 error("invalid --count argument: `%d'", maxcount);
 994                 usage_with_options(for_each_ref_usage, opts);
 995         }
 996         if (HAS_MULTI_BITS(quote_style)) {
 997                 error("more than one quoting style?");
 998                 usage_with_options(for_each_ref_usage, opts);
 999         }
1000         if (verify_format(format))
1001                 usage_with_options(for_each_ref_usage, opts);
1002
1003         if (!sort)
1004                 sort = default_sort();
1005         sort_atom_limit = used_atom_cnt;
1006
1007         /* for warn_ambiguous_refs */
1008         git_config(git_default_config, NULL);
1009
1010         memset(&cbdata, 0, sizeof(cbdata));
1011         cbdata.grab_pattern = argv;
1012         for_each_rawref(grab_single_ref, &cbdata);
1013         refs = cbdata.grab_array;
1014         num_refs = cbdata.grab_cnt;
1015
1016         sort_refs(sort, refs, num_refs);
1017
1018         if (!maxcount || num_refs < maxcount)
1019                 maxcount = num_refs;
1020         for (i = 0; i < maxcount; i++)
1021                 show_ref(refs[i], format, quote_style);
1022         return 0;
1023 }