builtin/cat-file.c

   1 /*
   2  * GIT - The information manager from hell
   3  *
   4  * Copyright (C) Linus Torvalds, 2005
   5  */
   6 #include "cache.h"
   7 #include "builtin.h"
   8 #include "parse-options.h"
   9 #include "userdiff.h"
  10 #include "streaming.h"
  11 #include "tree-walk.h"
  12
  13 struct batch_options {
  14         int enabled;
  15         int follow_symlinks;
  16         int print_contents;
  17         int buffer_output;
  18         const char *format;
  19 };
  20
  21 static int cat_one_file(int opt, const char *exp_type, const char *obj_name,
  22                         int unknown_type)
  23 {
  24         unsigned char sha1[20];
  25         enum object_type type;
  26         char *buf;
  27         unsigned long size;
  28         struct object_context obj_context;
  29         struct object_info oi = {NULL};
  30         struct strbuf sb = STRBUF_INIT;
  31         unsigned flags = LOOKUP_REPLACE_OBJECT;
  32
  33         if (unknown_type)
  34                 flags |= LOOKUP_UNKNOWN_OBJECT;
  35
  36         if (get_sha1_with_context(obj_name, 0, sha1, &obj_context))
  37                 die("Not a valid object name %s", obj_name);
  38
  39         buf = NULL;
  40         switch (opt) {
  41         case 't':
  42                 oi.typename = &sb;
  43                 if (sha1_object_info_extended(sha1, &oi, flags) < 0)
  44                         die("git cat-file: could not get object info");
  45                 if (sb.len) {
  46                         printf("%s\n", sb.buf);
  47                         strbuf_release(&sb);
  48                         return 0;
  49                 }
  50                 break;
  51
  52         case 's':
  53                 oi.sizep = &size;
  54                 if (sha1_object_info_extended(sha1, &oi, flags) < 0)
  55                         die("git cat-file: could not get object info");
  56                 printf("%lu\n", size);
  57                 return 0;
  58
  59         case 'e':
  60                 return !has_sha1_file(sha1);
  61
  62         case 'c':
  63                 if (!obj_context.path[0])
  64                         die("git cat-file --textconv %s: <object> must be <sha1:path>",
  65                             obj_name);
  66
  67                 if (textconv_object(obj_context.path, obj_context.mode, sha1, 1, &buf, &size))
  68                         break;
  69
  70         case 'p':
  71                 type = sha1_object_info(sha1, NULL);
  72                 if (type < 0)
  73                         die("Not a valid object name %s", obj_name);
  74
  75                 /* custom pretty-print here */
  76                 if (type == OBJ_TREE) {
  77                         const char *ls_args[3] = { NULL };
  78                         ls_args[0] =  "ls-tree";
  79                         ls_args[1] =  obj_name;
  80                         return cmd_ls_tree(2, ls_args, NULL);
  81                 }
  82
  83                 if (type == OBJ_BLOB)
  84                         return stream_blob_to_fd(1, sha1, NULL, 0);
  85                 buf = read_sha1_file(sha1, &type, &size);
  86                 if (!buf)
  87                         die("Cannot read object %s", obj_name);
  88
  89                 /* otherwise just spit out the data */
  90                 break;
  91
  92         case 0:
  93                 if (type_from_string(exp_type) == OBJ_BLOB) {
  94                         unsigned char blob_sha1[20];
  95                         if (sha1_object_info(sha1, NULL) == OBJ_TAG) {
  96                                 char *buffer = read_sha1_file(sha1, &type, &size);
  97                                 const char *target;
  98                                 if (!skip_prefix(buffer, "object ", &target) ||
  99                                     get_sha1_hex(target, blob_sha1))
 100                                         die("%s not a valid tag", sha1_to_hex(sha1));
 101                                 free(buffer);
 102                         } else
 103                                 hashcpy(blob_sha1, sha1);
 104
 105                         if (sha1_object_info(blob_sha1, NULL) == OBJ_BLOB)
 106                                 return stream_blob_to_fd(1, blob_sha1, NULL, 0);
 107                         /*
 108                          * we attempted to dereference a tag to a blob
 109                          * and failed; there may be new dereference
 110                          * mechanisms this code is not aware of.
 111                          * fall-back to the usual case.
 112                          */
 113                 }
 114                 buf = read_object_with_reference(sha1, exp_type, &size, NULL);
 115                 break;
 116
 117         default:
 118                 die("git cat-file: unknown option: %s", exp_type);
 119         }
 120
 121         if (!buf)
 122                 die("git cat-file %s: bad file", obj_name);
 123
 124         write_or_die(1, buf, size);
 125         return 0;
 126 }
 127
 128 struct expand_data {
 129         unsigned char sha1[20];
 130         enum object_type type;
 131         unsigned long size;
 132         unsigned long disk_size;
 133         const char *rest;
 134         unsigned char delta_base_sha1[20];
 135
 136         /*
 137          * If mark_query is true, we do not expand anything, but rather
 138          * just mark the object_info with items we wish to query.
 139          */
 140         int mark_query;
 141
 142         /*
 143          * Whether to split the input on whitespace before feeding it to
 144          * get_sha1; this is decided during the mark_query phase based on
 145          * whether we have a %(rest) token in our format.
 146          */
 147         int split_on_whitespace;
 148
 149         /*
 150          * After a mark_query run, this object_info is set up to be
 151          * passed to sha1_object_info_extended. It will point to the data
 152          * elements above, so you can retrieve the response from there.
 153          */
 154         struct object_info info;
 155 };
 156
 157 static int is_atom(const char *atom, const char *s, int slen)
 158 {
 159         int alen = strlen(atom);
 160         return alen == slen && !memcmp(atom, s, alen);
 161 }
 162
 163 static void expand_atom(struct strbuf *sb, const char *atom, int len,
 164                         void *vdata)
 165 {
 166         struct expand_data *data = vdata;
 167
 168         if (is_atom("objectname", atom, len)) {
 169                 if (!data->mark_query)
 170                         strbuf_addstr(sb, sha1_to_hex(data->sha1));
 171         } else if (is_atom("objecttype", atom, len)) {
 172                 if (data->mark_query)
 173                         data->info.typep = &data->type;
 174                 else
 175                         strbuf_addstr(sb, typename(data->type));
 176         } else if (is_atom("objectsize", atom, len)) {
 177                 if (data->mark_query)
 178                         data->info.sizep = &data->size;
 179                 else
 180                         strbuf_addf(sb, "%lu", data->size);
 181         } else if (is_atom("objectsize:disk", atom, len)) {
 182                 if (data->mark_query)
 183                         data->info.disk_sizep = &data->disk_size;
 184                 else
 185                         strbuf_addf(sb, "%lu", data->disk_size);
 186         } else if (is_atom("rest", atom, len)) {
 187                 if (data->mark_query)
 188                         data->split_on_whitespace = 1;
 189                 else if (data->rest)
 190                         strbuf_addstr(sb, data->rest);
 191         } else if (is_atom("deltabase", atom, len)) {
 192                 if (data->mark_query)
 193                         data->info.delta_base_sha1 = data->delta_base_sha1;
 194                 else
 195                         strbuf_addstr(sb, sha1_to_hex(data->delta_base_sha1));
 196         } else
 197                 die("unknown format element: %.*s", len, atom);
 198 }
 199
 200 static size_t expand_format(struct strbuf *sb, const char *start, void *data)
 201 {
 202         const char *end;
 203
 204         if (*start != '(')
 205                 return 0;
 206         end = strchr(start + 1, ')');
 207         if (!end)
 208                 die("format element '%s' does not end in ')'", start);
 209
 210         expand_atom(sb, start + 1, end - start - 1, data);
 211
 212         return end - start + 1;
 213 }
 214
 215 static void batch_write(struct batch_options *opt, const void *data, int len)
 216 {
 217         if (opt->buffer_output) {
 218                 if (fwrite(data, 1, len, stdout) != len)
 219                         die_errno("unable to write to stdout");
 220         } else
 221                 write_or_die(1, data, len);
 222 }
 223
 224 static void print_object_or_die(struct batch_options *opt, struct expand_data *data)
 225 {
 226         const unsigned char *sha1 = data->sha1;
 227
 228         assert(data->info.typep);
 229
 230         if (data->type == OBJ_BLOB) {
 231                 if (opt->buffer_output)
 232                         fflush(stdout);
 233                 if (stream_blob_to_fd(1, sha1, NULL, 0) < 0)
 234                         die("unable to stream %s to stdout", sha1_to_hex(sha1));
 235         }
 236         else {
 237                 enum object_type type;
 238                 unsigned long size;
 239                 void *contents;
 240
 241                 contents = read_sha1_file(sha1, &type, &size);
 242                 if (!contents)
 243                         die("object %s disappeared", sha1_to_hex(sha1));
 244                 if (type != data->type)
 245                         die("object %s changed type!?", sha1_to_hex(sha1));
 246                 if (data->info.sizep && size != data->size)
 247                         die("object %s changed size!?", sha1_to_hex(sha1));
 248
 249                 batch_write(opt, contents, size);
 250                 free(contents);
 251         }
 252 }
 253
 254 static void batch_one_object(const char *obj_name, struct batch_options *opt,
 255                              struct expand_data *data)
 256 {
 257         struct strbuf buf = STRBUF_INIT;
 258         struct object_context ctx;
 259         int flags = opt->follow_symlinks ? GET_SHA1_FOLLOW_SYMLINKS : 0;
 260         enum follow_symlinks_result result;
 261
 262         result = get_sha1_with_context(obj_name, flags, data->sha1, &ctx);
 263         if (result != FOUND) {
 264                 switch (result) {
 265                 case MISSING_OBJECT:
 266                         printf("%s missing\n", obj_name);
 267                         break;
 268                 case DANGLING_SYMLINK:
 269                         printf("dangling %"PRIuMAX"\n%s\n",
 270                                (uintmax_t)strlen(obj_name), obj_name);
 271                         break;
 272                 case SYMLINK_LOOP:
 273                         printf("loop %"PRIuMAX"\n%s\n",
 274                                (uintmax_t)strlen(obj_name), obj_name);
 275                         break;
 276                 case NOT_DIR:
 277                         printf("notdir %"PRIuMAX"\n%s\n",
 278                                (uintmax_t)strlen(obj_name), obj_name);
 279                         break;
 280                 default:
 281                         die("BUG: unknown get_sha1_with_context result %d\n",
 282                                result);
 283                         break;
 284                 }
 285                 fflush(stdout);
 286                 return;
 287         }
 288
 289         if (ctx.mode == 0) {
 290                 printf("symlink %"PRIuMAX"\n%s\n",
 291                        (uintmax_t)ctx.symlink_path.len,
 292                        ctx.symlink_path.buf);
 293                 fflush(stdout);
 294                 return;
 295         }
 296
 297         if (sha1_object_info_extended(data->sha1, &data->info, LOOKUP_REPLACE_OBJECT) < 0) {
 298                 printf("%s missing\n", obj_name);
 299                 fflush(stdout);
 300                 return;
 301         }
 302
 303         strbuf_expand(&buf, opt->format, expand_format, data);
 304         strbuf_addch(&buf, '\n');
 305         batch_write(opt, buf.buf, buf.len);
 306         strbuf_release(&buf);
 307
 308         if (opt->print_contents) {
 309                 print_object_or_die(opt, data);
 310                 batch_write(opt, "\n", 1);
 311         }
 312 }
 313
 314 static int batch_objects(struct batch_options *opt)
 315 {
 316         struct strbuf buf = STRBUF_INIT;
 317         struct expand_data data;
 318         int save_warning;
 319         int retval = 0;
 320
 321         if (!opt->format)
 322                 opt->format = "%(objectname) %(objecttype) %(objectsize)";
 323
 324         /*
 325          * Expand once with our special mark_query flag, which will prime the
 326          * object_info to be handed to sha1_object_info_extended for each
 327          * object.
 328          */
 329         memset(&data, 0, sizeof(data));
 330         data.mark_query = 1;
 331         strbuf_expand(&buf, opt->format, expand_format, &data);
 332         data.mark_query = 0;
 333
 334         /*
 335          * If we are printing out the object, then always fill in the type,
 336          * since we will want to decide whether or not to stream.
 337          */
 338         if (opt->print_contents)
 339                 data.info.typep = &data.type;
 340
 341         /*
 342          * We are going to call get_sha1 on a potentially very large number of
 343          * objects. In most large cases, these will be actual object sha1s. The
 344          * cost to double-check that each one is not also a ref (just so we can
 345          * warn) ends up dwarfing the actual cost of the object lookups
 346          * themselves. We can work around it by just turning off the warning.
 347          */
 348         save_warning = warn_on_object_refname_ambiguity;
 349         warn_on_object_refname_ambiguity = 0;
 350
 351         while (strbuf_getline(&buf, stdin, '\n') != EOF) {
 352                 if (data.split_on_whitespace) {
 353                         /*
 354                          * Split at first whitespace, tying off the beginning
 355                          * of the string and saving the remainder (or NULL) in
 356                          * data.rest.
 357                          */
 358                         char *p = strpbrk(buf.buf, " \t");
 359                         if (p) {
 360                                 while (*p && strchr(" \t", *p))
 361                                         *p++ = '\0';
 362                         }
 363                         data.rest = p;
 364                 }
 365
 366                 batch_one_object(buf.buf, opt, &data);
 367         }
 368
 369         strbuf_release(&buf);
 370         warn_on_object_refname_ambiguity = save_warning;
 371         return retval;
 372 }
 373
 374 static const char * const cat_file_usage[] = {
 375         N_("git cat-file (-t [--allow-unknown-type]|-s [--allow-unknown-type]|-e|-p|<type>|--textconv) <object>"),
 376         N_("git cat-file (--batch | --batch-check) [--follow-symlinks] < <list-of-objects>"),
 377         NULL
 378 };
 379
 380 static int git_cat_file_config(const char *var, const char *value, void *cb)
 381 {
 382         if (userdiff_config(var, value) < 0)
 383                 return -1;
 384
 385         return git_default_config(var, value, cb);
 386 }
 387
 388 static int batch_option_callback(const struct option *opt,
 389                                  const char *arg,
 390                                  int unset)
 391 {
 392         struct batch_options *bo = opt->value;
 393
 394         if (bo->enabled) {
 395                 return 1;
 396         }
 397
 398         bo->enabled = 1;
 399         bo->print_contents = !strcmp(opt->long_name, "batch");
 400         bo->format = arg;
 401
 402         return 0;
 403 }
 404
 405 int cmd_cat_file(int argc, const char **argv, const char *prefix)
 406 {
 407         int opt = 0;
 408         const char *exp_type = NULL, *obj_name = NULL;
 409         struct batch_options batch = {0};
 410         int unknown_type = 0;
 411
 412         const struct option options[] = {
 413                 OPT_GROUP(N_("<type> can be one of: blob, tree, commit, tag")),
 414                 OPT_CMDMODE('t', NULL, &opt, N_("show object type"), 't'),
 415                 OPT_CMDMODE('s', NULL, &opt, N_("show object size"), 's'),
 416                 OPT_CMDMODE('e', NULL, &opt,
 417                             N_("exit with zero when there's no error"), 'e'),
 418                 OPT_CMDMODE('p', NULL, &opt, N_("pretty-print object's content"), 'p'),
 419                 OPT_CMDMODE(0, "textconv", &opt,
 420                             N_("for blob objects, run textconv on object's content"), 'c'),
 421                 OPT_BOOL(0, "allow-unknown-type", &unknown_type,
 422                           N_("allow -s and -t to work with broken/corrupt objects")),
 423                 OPT_BOOL(0, "buffer", &batch.buffer_output, N_("buffer --batch output")),
 424                 { OPTION_CALLBACK, 0, "batch", &batch, "format",
 425                         N_("show info and content of objects fed from the standard input"),
 426                         PARSE_OPT_OPTARG, batch_option_callback },
 427                 { OPTION_CALLBACK, 0, "batch-check", &batch, "format",
 428                         N_("show info about objects fed from the standard input"),
 429                         PARSE_OPT_OPTARG, batch_option_callback },
 430                 OPT_BOOL(0, "follow-symlinks", &batch.follow_symlinks,
 431                          N_("follow in-tree symlinks (used with --batch or --batch-check)")),
 432                 OPT_END()
 433         };
 434
 435         git_config(git_cat_file_config, NULL);
 436
 437         argc = parse_options(argc, argv, prefix, options, cat_file_usage, 0);
 438
 439         if (opt) {
 440                 if (argc == 1)
 441                         obj_name = argv[0];
 442                 else
 443                         usage_with_options(cat_file_usage, options);
 444         }
 445         if (!opt && !batch.enabled) {
 446                 if (argc == 2) {
 447                         exp_type = argv[0];
 448                         obj_name = argv[1];
 449                 } else
 450                         usage_with_options(cat_file_usage, options);
 451         }
 452         if (batch.enabled && (opt || argc)) {
 453                 usage_with_options(cat_file_usage, options);
 454         }
 455
 456         if (batch.follow_symlinks && !batch.enabled) {
 457                 usage_with_options(cat_file_usage, options);
 458         }
 459
 460         if (batch.enabled)
 461                 return batch_objects(&batch);
 462
 463         if (unknown_type && opt != 't' && opt != 's')
 464                 die("git cat-file --allow-unknown-type: use with -s or -t");
 465         return cat_one_file(opt, exp_type, obj_name, unknown_type);
 466 }