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