cat-file --textconv/--filters: allow specifying the path separately
[git/git.git] / builtin / cat-file.c
CommitLineData
8bc9a0c7
LT
1/*
2 * GIT - The information manager from hell
3 *
4 * Copyright (C) Linus Torvalds, 2005
5 */
e83c5163 6#include "cache.h"
f81daefe 7#include "builtin.h"
15d8e565 8#include "parse-options.h"
e5fba602 9#include "userdiff.h"
00c8fd49 10#include "streaming.h"
122d5346 11#include "tree-walk.h"
3115ee45 12#include "sha1-array.h"
15d8e565 13
bfd15594
JK
14struct batch_options {
15 int enabled;
16 int follow_symlinks;
17 int print_contents;
fc4937c3 18 int buffer_output;
6a951937 19 int all_objects;
bfd15594
JK
20 const char *format;
21};
22
7bcf3414
JS
23static const char *force_path;
24
b9e62f60
JS
25static int filter_object(const char *path, unsigned mode,
26 const unsigned char *sha1,
27 char **buf, unsigned long *size)
28{
29 enum object_type type;
30
31 *buf = read_sha1_file(sha1, &type, size);
32 if (!*buf)
33 return error(_("cannot read object %s '%s'"),
34 sha1_to_hex(sha1), path);
35 if ((type == OBJ_BLOB) && S_ISREG(mode)) {
36 struct strbuf strbuf = STRBUF_INIT;
37 if (convert_to_working_tree(path, *buf, *size, &strbuf)) {
38 free(*buf);
39 *size = strbuf.len;
40 *buf = strbuf_detach(&strbuf, NULL);
41 }
42 }
43
44 return 0;
45}
46
39e4ae38
KN
47static int cat_one_file(int opt, const char *exp_type, const char *obj_name,
48 int unknown_type)
e83c5163
LT
49{
50 unsigned char sha1[20];
21666f1a 51 enum object_type type;
e5fba602 52 char *buf;
e83c5163 53 unsigned long size;
e5fba602 54 struct object_context obj_context;
39e4ae38
KN
55 struct object_info oi = {NULL};
56 struct strbuf sb = STRBUF_INIT;
57 unsigned flags = LOOKUP_REPLACE_OBJECT;
7bcf3414 58 const char *path = force_path;
39e4ae38
KN
59
60 if (unknown_type)
61 flags |= LOOKUP_UNKNOWN_OBJECT;
2b6854c8 62
33bd598c 63 if (get_sha1_with_context(obj_name, 0, sha1, &obj_context))
2b6854c8 64 die("Not a valid object name %s", obj_name);
7950571a 65
7bcf3414
JS
66 if (!path)
67 path = obj_context.path;
68 if (obj_context.mode == S_IFINVALID)
69 obj_context.mode = 0100644;
70
7950571a
PA
71 buf = NULL;
72 switch (opt) {
73 case 't':
39e4ae38
KN
74 oi.typename = &sb;
75 if (sha1_object_info_extended(sha1, &oi, flags) < 0)
76 die("git cat-file: could not get object info");
77 if (sb.len) {
78 printf("%s\n", sb.buf);
79 strbuf_release(&sb);
f2a06330 80 return 0;
11e7d5c5 81 }
7950571a
PA
82 break;
83
84 case 's':
39e4ae38
KN
85 oi.sizep = &size;
86 if (sha1_object_info_extended(sha1, &oi, flags) < 0)
87 die("git cat-file: could not get object info");
88 printf("%lu\n", size);
89 return 0;
7950571a
PA
90
91 case 'e':
92 return !has_sha1_file(sha1);
93
b9e62f60 94 case 'w':
7bcf3414 95 if (!path[0])
b9e62f60
JS
96 die("git cat-file --filters %s: <object> must be "
97 "<sha1:path>", obj_name);
98
7bcf3414 99 if (filter_object(path, obj_context.mode,
b9e62f60
JS
100 sha1, &buf, &size))
101 return -1;
102 break;
103
3ac21617 104 case 'c':
7bcf3414 105 if (!path[0])
3ac21617
MG
106 die("git cat-file --textconv %s: <object> must be <sha1:path>",
107 obj_name);
108
7bcf3414
JS
109 if (textconv_object(path, obj_context.mode,
110 sha1, 1, &buf, &size))
3ac21617
MG
111 break;
112
a0f15fa5 113 case 'p':
21666f1a
NP
114 type = sha1_object_info(sha1, NULL);
115 if (type < 0)
2b6854c8 116 die("Not a valid object name %s", obj_name);
a0f15fa5
JH
117
118 /* custom pretty-print here */
2b6854c8 119 if (type == OBJ_TREE) {
66dbfd55
GV
120 const char *ls_args[3] = { NULL };
121 ls_args[0] = "ls-tree";
122 ls_args[1] = obj_name;
2b6854c8
SP
123 return cmd_ls_tree(2, ls_args, NULL);
124 }
a0f15fa5 125
00c8fd49
NTND
126 if (type == OBJ_BLOB)
127 return stream_blob_to_fd(1, sha1, NULL, 0);
21666f1a 128 buf = read_sha1_file(sha1, &type, &size);
a0f15fa5 129 if (!buf)
2b6854c8 130 die("Cannot read object %s", obj_name);
a0f15fa5
JH
131
132 /* otherwise just spit out the data */
133 break;
e5fba602 134
7950571a 135 case 0:
00c8fd49
NTND
136 if (type_from_string(exp_type) == OBJ_BLOB) {
137 unsigned char blob_sha1[20];
138 if (sha1_object_info(sha1, NULL) == OBJ_TAG) {
00c8fd49 139 char *buffer = read_sha1_file(sha1, &type, &size);
e3f1da98
RS
140 const char *target;
141 if (!skip_prefix(buffer, "object ", &target) ||
142 get_sha1_hex(target, blob_sha1))
00c8fd49
NTND
143 die("%s not a valid tag", sha1_to_hex(sha1));
144 free(buffer);
145 } else
146 hashcpy(blob_sha1, sha1);
147
148 if (sha1_object_info(blob_sha1, NULL) == OBJ_BLOB)
149 return stream_blob_to_fd(1, blob_sha1, NULL, 0);
150 /*
151 * we attempted to dereference a tag to a blob
152 * and failed; there may be new dereference
153 * mechanisms this code is not aware of.
154 * fall-back to the usual case.
155 */
156 }
2b6854c8 157 buf = read_object_with_reference(sha1, exp_type, &size, NULL);
7950571a
PA
158 break;
159
160 default:
d7530708 161 die("git cat-file: unknown option: %s", exp_type);
bf0c6e83
LT
162 }
163
11e7d5c5 164 if (!buf)
34baebce 165 die("git cat-file %s: bad file", obj_name);
11e7d5c5 166
7230e6d0 167 write_or_die(1, buf, size);
bf0c6e83 168 return 0;
e83c5163 169}
9cf71b17 170
93d2a607
JK
171struct expand_data {
172 unsigned char sha1[20];
173 enum object_type type;
174 unsigned long size;
166df26f 175 off_t disk_size;
97be0407 176 const char *rest;
65ea9c3c 177 unsigned char delta_base_sha1[20];
93d2a607
JK
178
179 /*
180 * If mark_query is true, we do not expand anything, but rather
181 * just mark the object_info with items we wish to query.
182 */
183 int mark_query;
184
97be0407
JK
185 /*
186 * Whether to split the input on whitespace before feeding it to
187 * get_sha1; this is decided during the mark_query phase based on
188 * whether we have a %(rest) token in our format.
189 */
190 int split_on_whitespace;
191
93d2a607
JK
192 /*
193 * After a mark_query run, this object_info is set up to be
194 * passed to sha1_object_info_extended. It will point to the data
195 * elements above, so you can retrieve the response from there.
196 */
197 struct object_info info;
845de33a
JK
198
199 /*
200 * This flag will be true if the requested batch format and options
201 * don't require us to call sha1_object_info, which can then be
202 * optimized out.
203 */
204 unsigned skip_object_info : 1;
93d2a607
JK
205};
206
207static int is_atom(const char *atom, const char *s, int slen)
208{
209 int alen = strlen(atom);
210 return alen == slen && !memcmp(atom, s, alen);
211}
212
213static void expand_atom(struct strbuf *sb, const char *atom, int len,
214 void *vdata)
215{
216 struct expand_data *data = vdata;
217
218 if (is_atom("objectname", atom, len)) {
219 if (!data->mark_query)
220 strbuf_addstr(sb, sha1_to_hex(data->sha1));
221 } else if (is_atom("objecttype", atom, len)) {
5b086407
JK
222 if (data->mark_query)
223 data->info.typep = &data->type;
224 else
93d2a607
JK
225 strbuf_addstr(sb, typename(data->type));
226 } else if (is_atom("objectsize", atom, len)) {
227 if (data->mark_query)
228 data->info.sizep = &data->size;
229 else
230 strbuf_addf(sb, "%lu", data->size);
a4ac1061
JK
231 } else if (is_atom("objectsize:disk", atom, len)) {
232 if (data->mark_query)
233 data->info.disk_sizep = &data->disk_size;
234 else
166df26f 235 strbuf_addf(sb, "%"PRIuMAX, (uintmax_t)data->disk_size);
97be0407
JK
236 } else if (is_atom("rest", atom, len)) {
237 if (data->mark_query)
238 data->split_on_whitespace = 1;
239 else if (data->rest)
240 strbuf_addstr(sb, data->rest);
65ea9c3c
JK
241 } else if (is_atom("deltabase", atom, len)) {
242 if (data->mark_query)
243 data->info.delta_base_sha1 = data->delta_base_sha1;
244 else
245 strbuf_addstr(sb, sha1_to_hex(data->delta_base_sha1));
93d2a607
JK
246 } else
247 die("unknown format element: %.*s", len, atom);
248}
249
250static size_t expand_format(struct strbuf *sb, const char *start, void *data)
251{
252 const char *end;
253
254 if (*start != '(')
255 return 0;
256 end = strchr(start + 1, ')');
257 if (!end)
258 die("format element '%s' does not end in ')'", start);
259
260 expand_atom(sb, start + 1, end - start - 1, data);
261
262 return end - start + 1;
263}
264
fc4937c3
JK
265static void batch_write(struct batch_options *opt, const void *data, int len)
266{
267 if (opt->buffer_output) {
268 if (fwrite(data, 1, len, stdout) != len)
269 die_errno("unable to write to stdout");
270 } else
271 write_or_die(1, data, len);
272}
273
274static void print_object_or_die(struct batch_options *opt, struct expand_data *data)
98e2092b 275{
370c9268
JK
276 const unsigned char *sha1 = data->sha1;
277
6554dfa9
JK
278 assert(data->info.typep);
279
370c9268 280 if (data->type == OBJ_BLOB) {
fc4937c3
JK
281 if (opt->buffer_output)
282 fflush(stdout);
283 if (stream_blob_to_fd(1, sha1, NULL, 0) < 0)
98e2092b
JK
284 die("unable to stream %s to stdout", sha1_to_hex(sha1));
285 }
286 else {
370c9268
JK
287 enum object_type type;
288 unsigned long size;
98e2092b
JK
289 void *contents;
290
370c9268 291 contents = read_sha1_file(sha1, &type, &size);
98e2092b
JK
292 if (!contents)
293 die("object %s disappeared", sha1_to_hex(sha1));
370c9268 294 if (type != data->type)
98e2092b 295 die("object %s changed type!?", sha1_to_hex(sha1));
6554dfa9 296 if (data->info.sizep && size != data->size)
370c9268 297 die("object %s changed size!?", sha1_to_hex(sha1));
98e2092b 298
fc4937c3 299 batch_write(opt, contents, size);
98e2092b
JK
300 free(contents);
301 }
302}
303
44b877e9
JK
304static void batch_object_write(const char *obj_name, struct batch_options *opt,
305 struct expand_data *data)
306{
307 struct strbuf buf = STRBUF_INIT;
308
845de33a
JK
309 if (!data->skip_object_info &&
310 sha1_object_info_extended(data->sha1, &data->info, LOOKUP_REPLACE_OBJECT) < 0) {
6a951937 311 printf("%s missing\n", obj_name ? obj_name : sha1_to_hex(data->sha1));
44b877e9
JK
312 fflush(stdout);
313 return;
314 }
315
316 strbuf_expand(&buf, opt->format, expand_format, data);
317 strbuf_addch(&buf, '\n');
318 batch_write(opt, buf.buf, buf.len);
319 strbuf_release(&buf);
320
321 if (opt->print_contents) {
322 print_object_or_die(opt, data);
323 batch_write(opt, "\n", 1);
324 }
325}
326
82330950
JK
327static void batch_one_object(const char *obj_name, struct batch_options *opt,
328 struct expand_data *data)
05d5667f 329{
122d5346
DT
330 struct object_context ctx;
331 int flags = opt->follow_symlinks ? GET_SHA1_FOLLOW_SYMLINKS : 0;
332 enum follow_symlinks_result result;
05d5667f 333
122d5346
DT
334 result = get_sha1_with_context(obj_name, flags, data->sha1, &ctx);
335 if (result != FOUND) {
336 switch (result) {
337 case MISSING_OBJECT:
338 printf("%s missing\n", obj_name);
339 break;
340 case DANGLING_SYMLINK:
341 printf("dangling %"PRIuMAX"\n%s\n",
342 (uintmax_t)strlen(obj_name), obj_name);
343 break;
344 case SYMLINK_LOOP:
345 printf("loop %"PRIuMAX"\n%s\n",
346 (uintmax_t)strlen(obj_name), obj_name);
347 break;
348 case NOT_DIR:
349 printf("notdir %"PRIuMAX"\n%s\n",
350 (uintmax_t)strlen(obj_name), obj_name);
351 break;
352 default:
353 die("BUG: unknown get_sha1_with_context result %d\n",
354 result);
355 break;
356 }
357 fflush(stdout);
82330950 358 return;
122d5346
DT
359 }
360
361 if (ctx.mode == 0) {
362 printf("symlink %"PRIuMAX"\n%s\n",
363 (uintmax_t)ctx.symlink_path.len,
364 ctx.symlink_path.buf);
422b2063 365 fflush(stdout);
82330950 366 return;
05d5667f
AR
367 }
368
44b877e9 369 batch_object_write(obj_name, opt, data);
05d5667f
AR
370}
371
6a951937
JK
372struct object_cb_data {
373 struct batch_options *opt;
374 struct expand_data *expand;
375};
376
3115ee45 377static void batch_object_cb(const unsigned char sha1[20], void *vdata)
6a951937 378{
3115ee45 379 struct object_cb_data *data = vdata;
6a951937
JK
380 hashcpy(data->expand->sha1, sha1);
381 batch_object_write(NULL, data->opt, data->expand);
6a951937
JK
382}
383
384static int batch_loose_object(const unsigned char *sha1,
385 const char *path,
386 void *data)
387{
3115ee45
JK
388 sha1_array_append(data, sha1);
389 return 0;
6a951937
JK
390}
391
392static int batch_packed_object(const unsigned char *sha1,
393 struct packed_git *pack,
394 uint32_t pos,
395 void *data)
396{
3115ee45
JK
397 sha1_array_append(data, sha1);
398 return 0;
6a951937
JK
399}
400
b71bd480 401static int batch_objects(struct batch_options *opt)
05d5667f 402{
f285a2d7 403 struct strbuf buf = STRBUF_INIT;
93d2a607 404 struct expand_data data;
a42fcd15 405 int save_warning;
07e23839 406 int retval = 0;
93d2a607
JK
407
408 if (!opt->format)
409 opt->format = "%(objectname) %(objecttype) %(objectsize)";
410
411 /*
412 * Expand once with our special mark_query flag, which will prime the
413 * object_info to be handed to sha1_object_info_extended for each
414 * object.
415 */
416 memset(&data, 0, sizeof(data));
417 data.mark_query = 1;
418 strbuf_expand(&buf, opt->format, expand_format, &data);
419 data.mark_query = 0;
05d5667f 420
845de33a
JK
421 if (opt->all_objects) {
422 struct object_info empty;
423 memset(&empty, 0, sizeof(empty));
424 if (!memcmp(&data.info, &empty, sizeof(empty)))
425 data.skip_object_info = 1;
426 }
427
6554dfa9
JK
428 /*
429 * If we are printing out the object, then always fill in the type,
430 * since we will want to decide whether or not to stream.
431 */
432 if (opt->print_contents)
433 data.info.typep = &data.type;
434
6a951937 435 if (opt->all_objects) {
3115ee45 436 struct sha1_array sa = SHA1_ARRAY_INIT;
6a951937 437 struct object_cb_data cb;
3115ee45
JK
438
439 for_each_loose_object(batch_loose_object, &sa, 0);
440 for_each_packed_object(batch_packed_object, &sa, 0);
441
6a951937
JK
442 cb.opt = opt;
443 cb.expand = &data;
3115ee45
JK
444 sha1_array_for_each_unique(&sa, batch_object_cb, &cb);
445
446 sha1_array_clear(&sa);
6a951937
JK
447 return 0;
448 }
449
25fba78d
JK
450 /*
451 * We are going to call get_sha1 on a potentially very large number of
452 * objects. In most large cases, these will be actual object sha1s. The
453 * cost to double-check that each one is not also a ref (just so we can
454 * warn) ends up dwarfing the actual cost of the object lookups
455 * themselves. We can work around it by just turning off the warning.
456 */
a42fcd15 457 save_warning = warn_on_object_refname_ambiguity;
25fba78d
JK
458 warn_on_object_refname_ambiguity = 0;
459
b42ca3dd 460 while (strbuf_getline(&buf, stdin) != EOF) {
97be0407
JK
461 if (data.split_on_whitespace) {
462 /*
463 * Split at first whitespace, tying off the beginning
464 * of the string and saving the remainder (or NULL) in
465 * data.rest.
466 */
467 char *p = strpbrk(buf.buf, " \t");
468 if (p) {
469 while (*p && strchr(" \t", *p))
470 *p++ = '\0';
471 }
472 data.rest = p;
473 }
474
82330950 475 batch_one_object(buf.buf, opt, &data);
05d5667f
AR
476 }
477
648027c4 478 strbuf_release(&buf);
a42fcd15 479 warn_on_object_refname_ambiguity = save_warning;
07e23839 480 return retval;
05d5667f
AR
481}
482
15d8e565 483static const char * const cat_file_usage[] = {
7bcf3414 484 N_("git cat-file (-t [--allow-unknown-type]|-s [--allow-unknown-type]|-e|-p|<type>|--textconv|--filters) [--path=<path>] <object>"),
33e8fc87 485 N_("git cat-file (--batch | --batch-check) [--follow-symlinks]"),
15d8e565
MB
486 NULL
487};
4814dbe8 488
e5fba602
CP
489static int git_cat_file_config(const char *var, const char *value, void *cb)
490{
6680a087 491 if (userdiff_config(var, value) < 0)
e5fba602 492 return -1;
e5fba602
CP
493
494 return git_default_config(var, value, cb);
495}
496
b71bd480
JK
497static int batch_option_callback(const struct option *opt,
498 const char *arg,
499 int unset)
500{
501 struct batch_options *bo = opt->value;
502
122d5346
DT
503 if (bo->enabled) {
504 return 1;
b71bd480
JK
505 }
506
507 bo->enabled = 1;
508 bo->print_contents = !strcmp(opt->long_name, "batch");
93d2a607 509 bo->format = arg;
b71bd480
JK
510
511 return 0;
512}
513
9cf71b17
AR
514int cmd_cat_file(int argc, const char **argv, const char *prefix)
515{
b71bd480 516 int opt = 0;
4814dbe8 517 const char *exp_type = NULL, *obj_name = NULL;
b71bd480 518 struct batch_options batch = {0};
39e4ae38 519 int unknown_type = 0;
9cf71b17 520
15d8e565 521 const struct option options[] = {
d68faec7 522 OPT_GROUP(N_("<type> can be one of: blob, tree, commit, tag")),
b48158ac
KN
523 OPT_CMDMODE('t', NULL, &opt, N_("show object type"), 't'),
524 OPT_CMDMODE('s', NULL, &opt, N_("show object size"), 's'),
525 OPT_CMDMODE('e', NULL, &opt,
d68faec7 526 N_("exit with zero when there's no error"), 'e'),
b48158ac
KN
527 OPT_CMDMODE('p', NULL, &opt, N_("pretty-print object's content"), 'p'),
528 OPT_CMDMODE(0, "textconv", &opt,
d68faec7 529 N_("for blob objects, run textconv on object's content"), 'c'),
b9e62f60
JS
530 OPT_CMDMODE(0, "filters", &opt,
531 N_("for blob objects, run filters on object's content"), 'w'),
7bcf3414
JS
532 OPT_STRING(0, "path", &force_path, N_("blob"),
533 N_("use a specific path for --textconv/--filters")),
ad42f28d 534 OPT_BOOL(0, "allow-unknown-type", &unknown_type,
39e4ae38 535 N_("allow -s and -t to work with broken/corrupt objects")),
fc4937c3 536 OPT_BOOL(0, "buffer", &batch.buffer_output, N_("buffer --batch output")),
93d2a607 537 { OPTION_CALLBACK, 0, "batch", &batch, "format",
b71bd480 538 N_("show info and content of objects fed from the standard input"),
93d2a607
JK
539 PARSE_OPT_OPTARG, batch_option_callback },
540 { OPTION_CALLBACK, 0, "batch-check", &batch, "format",
b71bd480 541 N_("show info about objects fed from the standard input"),
93d2a607 542 PARSE_OPT_OPTARG, batch_option_callback },
122d5346
DT
543 OPT_BOOL(0, "follow-symlinks", &batch.follow_symlinks,
544 N_("follow in-tree symlinks (used with --batch or --batch-check)")),
6a951937
JK
545 OPT_BOOL(0, "batch-all-objects", &batch.all_objects,
546 N_("show all objects with --batch or --batch-check")),
15d8e565
MB
547 OPT_END()
548 };
a8128ed6 549
e5fba602 550 git_config(git_cat_file_config, NULL);
4814dbe8 551
6a36e1e7 552 batch.buffer_output = -1;
37782920 553 argc = parse_options(argc, argv, prefix, options, cat_file_usage, 0);
05d5667f 554
15d8e565
MB
555 if (opt) {
556 if (argc == 1)
557 obj_name = argv[0];
558 else
559 usage_with_options(cat_file_usage, options);
560 }
b71bd480 561 if (!opt && !batch.enabled) {
15d8e565
MB
562 if (argc == 2) {
563 exp_type = argv[0];
564 obj_name = argv[1];
565 } else
566 usage_with_options(cat_file_usage, options);
567 }
b71bd480 568 if (batch.enabled && (opt || argc)) {
15d8e565 569 usage_with_options(cat_file_usage, options);
9cf71b17
AR
570 }
571
6a951937 572 if ((batch.follow_symlinks || batch.all_objects) && !batch.enabled) {
122d5346
DT
573 usage_with_options(cat_file_usage, options);
574 }
575
7bcf3414
JS
576 if (force_path && opt != 'c' && opt != 'w') {
577 error("--path=<path> needs --textconv or --filters");
578 usage_with_options(cat_file_usage, options);
579 }
580
6a36e1e7
JK
581 if (batch.buffer_output < 0)
582 batch.buffer_output = batch.all_objects;
583
b71bd480
JK
584 if (batch.enabled)
585 return batch_objects(&batch);
05d5667f 586
39e4ae38
KN
587 if (unknown_type && opt != 't' && opt != 's')
588 die("git cat-file --allow-unknown-type: use with -s or -t");
589 return cat_one_file(opt, exp_type, obj_name, unknown_type);
9cf71b17 590}