Revert "cat-file: split --batch input lines on whitespace"
[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"
a0f15fa5 7#include "exec_cmd.h"
8e440259
PE
8#include "tag.h"
9#include "tree.h"
f81daefe 10#include "builtin.h"
15d8e565 11#include "parse-options.h"
e5fba602
CP
12#include "diff.h"
13#include "userdiff.h"
00c8fd49 14#include "streaming.h"
15d8e565 15
9cf71b17 16static int cat_one_file(int opt, const char *exp_type, const char *obj_name)
e83c5163
LT
17{
18 unsigned char sha1[20];
21666f1a 19 enum object_type type;
e5fba602 20 char *buf;
e83c5163 21 unsigned long size;
e5fba602 22 struct object_context obj_context;
2b6854c8 23
33bd598c 24 if (get_sha1_with_context(obj_name, 0, sha1, &obj_context))
2b6854c8 25 die("Not a valid object name %s", obj_name);
7950571a 26
7950571a
PA
27 buf = NULL;
28 switch (opt) {
29 case 't':
21666f1a
NP
30 type = sha1_object_info(sha1, NULL);
31 if (type > 0) {
32 printf("%s\n", typename(type));
f2a06330 33 return 0;
11e7d5c5 34 }
7950571a
PA
35 break;
36
37 case 's':
21666f1a
NP
38 type = sha1_object_info(sha1, &size);
39 if (type > 0) {
7950571a
PA
40 printf("%lu\n", size);
41 return 0;
42 }
43 break;
44
45 case 'e':
46 return !has_sha1_file(sha1);
47
a0f15fa5 48 case 'p':
21666f1a
NP
49 type = sha1_object_info(sha1, NULL);
50 if (type < 0)
2b6854c8 51 die("Not a valid object name %s", obj_name);
a0f15fa5
JH
52
53 /* custom pretty-print here */
2b6854c8 54 if (type == OBJ_TREE) {
66dbfd55
GV
55 const char *ls_args[3] = { NULL };
56 ls_args[0] = "ls-tree";
57 ls_args[1] = obj_name;
2b6854c8
SP
58 return cmd_ls_tree(2, ls_args, NULL);
59 }
a0f15fa5 60
00c8fd49
NTND
61 if (type == OBJ_BLOB)
62 return stream_blob_to_fd(1, sha1, NULL, 0);
21666f1a 63 buf = read_sha1_file(sha1, &type, &size);
a0f15fa5 64 if (!buf)
2b6854c8 65 die("Cannot read object %s", obj_name);
a0f15fa5
JH
66
67 /* otherwise just spit out the data */
68 break;
e5fba602
CP
69
70 case 'c':
71 if (!obj_context.path[0])
72 die("git cat-file --textconv %s: <object> must be <sha1:path>",
73 obj_name);
74
e5450100 75 if (!textconv_object(obj_context.path, obj_context.mode, sha1, 1, &buf, &size))
e5fba602
CP
76 die("git cat-file --textconv: unable to run textconv on %s",
77 obj_name);
78 break;
79
7950571a 80 case 0:
00c8fd49
NTND
81 if (type_from_string(exp_type) == OBJ_BLOB) {
82 unsigned char blob_sha1[20];
83 if (sha1_object_info(sha1, NULL) == OBJ_TAG) {
84 enum object_type type;
85 unsigned long size;
86 char *buffer = read_sha1_file(sha1, &type, &size);
87 if (memcmp(buffer, "object ", 7) ||
88 get_sha1_hex(buffer + 7, blob_sha1))
89 die("%s not a valid tag", sha1_to_hex(sha1));
90 free(buffer);
91 } else
92 hashcpy(blob_sha1, sha1);
93
94 if (sha1_object_info(blob_sha1, NULL) == OBJ_BLOB)
95 return stream_blob_to_fd(1, blob_sha1, NULL, 0);
96 /*
97 * we attempted to dereference a tag to a blob
98 * and failed; there may be new dereference
99 * mechanisms this code is not aware of.
100 * fall-back to the usual case.
101 */
102 }
2b6854c8 103 buf = read_object_with_reference(sha1, exp_type, &size, NULL);
7950571a
PA
104 break;
105
106 default:
d7530708 107 die("git cat-file: unknown option: %s", exp_type);
bf0c6e83
LT
108 }
109
11e7d5c5 110 if (!buf)
34baebce 111 die("git cat-file %s: bad file", obj_name);
11e7d5c5 112
7230e6d0 113 write_or_die(1, buf, size);
bf0c6e83 114 return 0;
e83c5163 115}
9cf71b17 116
93d2a607
JK
117struct expand_data {
118 unsigned char sha1[20];
119 enum object_type type;
120 unsigned long size;
a4ac1061 121 unsigned long disk_size;
93d2a607
JK
122
123 /*
124 * If mark_query is true, we do not expand anything, but rather
125 * just mark the object_info with items we wish to query.
126 */
127 int mark_query;
128
129 /*
130 * After a mark_query run, this object_info is set up to be
131 * passed to sha1_object_info_extended. It will point to the data
132 * elements above, so you can retrieve the response from there.
133 */
134 struct object_info info;
135};
136
137static int is_atom(const char *atom, const char *s, int slen)
138{
139 int alen = strlen(atom);
140 return alen == slen && !memcmp(atom, s, alen);
141}
142
143static void expand_atom(struct strbuf *sb, const char *atom, int len,
144 void *vdata)
145{
146 struct expand_data *data = vdata;
147
148 if (is_atom("objectname", atom, len)) {
149 if (!data->mark_query)
150 strbuf_addstr(sb, sha1_to_hex(data->sha1));
151 } else if (is_atom("objecttype", atom, len)) {
5b086407
JK
152 if (data->mark_query)
153 data->info.typep = &data->type;
154 else
93d2a607
JK
155 strbuf_addstr(sb, typename(data->type));
156 } else if (is_atom("objectsize", atom, len)) {
157 if (data->mark_query)
158 data->info.sizep = &data->size;
159 else
160 strbuf_addf(sb, "%lu", data->size);
a4ac1061
JK
161 } else if (is_atom("objectsize:disk", atom, len)) {
162 if (data->mark_query)
163 data->info.disk_sizep = &data->disk_size;
164 else
165 strbuf_addf(sb, "%lu", data->disk_size);
93d2a607
JK
166 } else
167 die("unknown format element: %.*s", len, atom);
168}
169
170static size_t expand_format(struct strbuf *sb, const char *start, void *data)
171{
172 const char *end;
173
174 if (*start != '(')
175 return 0;
176 end = strchr(start + 1, ')');
177 if (!end)
178 die("format element '%s' does not end in ')'", start);
179
180 expand_atom(sb, start + 1, end - start - 1, data);
181
182 return end - start + 1;
183}
184
98e2092b
JK
185static void print_object_or_die(int fd, const unsigned char *sha1,
186 enum object_type type, unsigned long size)
187{
188 if (type == OBJ_BLOB) {
189 if (stream_blob_to_fd(fd, sha1, NULL, 0) < 0)
190 die("unable to stream %s to stdout", sha1_to_hex(sha1));
191 }
192 else {
193 enum object_type rtype;
194 unsigned long rsize;
195 void *contents;
196
197 contents = read_sha1_file(sha1, &rtype, &rsize);
198 if (!contents)
199 die("object %s disappeared", sha1_to_hex(sha1));
200 if (rtype != type)
201 die("object %s changed type!?", sha1_to_hex(sha1));
202 if (rsize != size)
203 die("object %s change size!?", sha1_to_hex(sha1));
204
205 write_or_die(fd, contents, size);
206 free(contents);
207 }
208}
209
b71bd480
JK
210struct batch_options {
211 int enabled;
212 int print_contents;
93d2a607 213 const char *format;
b71bd480
JK
214};
215
93d2a607
JK
216static int batch_one_object(const char *obj_name, struct batch_options *opt,
217 struct expand_data *data)
05d5667f 218{
93d2a607 219 struct strbuf buf = STRBUF_INIT;
05d5667f
AR
220
221 if (!obj_name)
222 return 1;
223
93d2a607 224 if (get_sha1(obj_name, data->sha1)) {
05d5667f 225 printf("%s missing\n", obj_name);
422b2063 226 fflush(stdout);
05d5667f
AR
227 return 0;
228 }
229
5b086407 230 if (sha1_object_info_extended(data->sha1, &data->info) < 0) {
3c076dbe
LW
231 printf("%s missing\n", obj_name);
232 fflush(stdout);
233 return 0;
234 }
05d5667f 235
93d2a607
JK
236 strbuf_expand(&buf, opt->format, expand_format, data);
237 strbuf_addch(&buf, '\n');
238 write_or_die(1, buf.buf, buf.len);
239 strbuf_release(&buf);
a8128ed6 240
b71bd480 241 if (opt->print_contents) {
93d2a607 242 print_object_or_die(1, data->sha1, data->type, data->size);
98e2092b 243 write_or_die(1, "\n", 1);
a8128ed6 244 }
05d5667f
AR
245 return 0;
246}
247
b71bd480 248static int batch_objects(struct batch_options *opt)
05d5667f 249{
f285a2d7 250 struct strbuf buf = STRBUF_INIT;
93d2a607
JK
251 struct expand_data data;
252
253 if (!opt->format)
254 opt->format = "%(objectname) %(objecttype) %(objectsize)";
255
256 /*
257 * Expand once with our special mark_query flag, which will prime the
258 * object_info to be handed to sha1_object_info_extended for each
259 * object.
260 */
261 memset(&data, 0, sizeof(data));
262 data.mark_query = 1;
263 strbuf_expand(&buf, opt->format, expand_format, &data);
264 data.mark_query = 0;
05d5667f 265
25fba78d
JK
266 /*
267 * We are going to call get_sha1 on a potentially very large number of
268 * objects. In most large cases, these will be actual object sha1s. The
269 * cost to double-check that each one is not also a ref (just so we can
270 * warn) ends up dwarfing the actual cost of the object lookups
271 * themselves. We can work around it by just turning off the warning.
272 */
273 warn_on_object_refname_ambiguity = 0;
274
05d5667f 275 while (strbuf_getline(&buf, stdin, '\n') != EOF) {
062aeee8 276 int error = batch_one_object(buf.buf, opt, &data);
05d5667f
AR
277 if (error)
278 return error;
279 }
280
281 return 0;
282}
283
15d8e565 284static const char * const cat_file_usage[] = {
d68faec7
NTND
285 N_("git cat-file (-t|-s|-e|-p|<type>|--textconv) <object>"),
286 N_("git cat-file (--batch|--batch-check) < <list_of_objects>"),
15d8e565
MB
287 NULL
288};
4814dbe8 289
e5fba602
CP
290static int git_cat_file_config(const char *var, const char *value, void *cb)
291{
6680a087 292 if (userdiff_config(var, value) < 0)
e5fba602 293 return -1;
e5fba602
CP
294
295 return git_default_config(var, value, cb);
296}
297
b71bd480
JK
298static int batch_option_callback(const struct option *opt,
299 const char *arg,
300 int unset)
301{
302 struct batch_options *bo = opt->value;
303
304 if (unset) {
305 memset(bo, 0, sizeof(*bo));
306 return 0;
307 }
308
309 bo->enabled = 1;
310 bo->print_contents = !strcmp(opt->long_name, "batch");
93d2a607 311 bo->format = arg;
b71bd480
JK
312
313 return 0;
314}
315
9cf71b17
AR
316int cmd_cat_file(int argc, const char **argv, const char *prefix)
317{
b71bd480 318 int opt = 0;
4814dbe8 319 const char *exp_type = NULL, *obj_name = NULL;
b71bd480 320 struct batch_options batch = {0};
9cf71b17 321
15d8e565 322 const struct option options[] = {
d68faec7
NTND
323 OPT_GROUP(N_("<type> can be one of: blob, tree, commit, tag")),
324 OPT_SET_INT('t', NULL, &opt, N_("show object type"), 't'),
325 OPT_SET_INT('s', NULL, &opt, N_("show object size"), 's'),
15d8e565 326 OPT_SET_INT('e', NULL, &opt,
d68faec7
NTND
327 N_("exit with zero when there's no error"), 'e'),
328 OPT_SET_INT('p', NULL, &opt, N_("pretty-print object's content"), 'p'),
e5fba602 329 OPT_SET_INT(0, "textconv", &opt,
d68faec7 330 N_("for blob objects, run textconv on object's content"), 'c'),
93d2a607 331 { OPTION_CALLBACK, 0, "batch", &batch, "format",
b71bd480 332 N_("show info and content of objects fed from the standard input"),
93d2a607
JK
333 PARSE_OPT_OPTARG, batch_option_callback },
334 { OPTION_CALLBACK, 0, "batch-check", &batch, "format",
b71bd480 335 N_("show info about objects fed from the standard input"),
93d2a607 336 PARSE_OPT_OPTARG, batch_option_callback },
15d8e565
MB
337 OPT_END()
338 };
a8128ed6 339
e5fba602 340 git_config(git_cat_file_config, NULL);
4814dbe8 341
15d8e565
MB
342 if (argc != 3 && argc != 2)
343 usage_with_options(cat_file_usage, options);
4814dbe8 344
37782920 345 argc = parse_options(argc, argv, prefix, options, cat_file_usage, 0);
05d5667f 346
15d8e565
MB
347 if (opt) {
348 if (argc == 1)
349 obj_name = argv[0];
350 else
351 usage_with_options(cat_file_usage, options);
352 }
b71bd480 353 if (!opt && !batch.enabled) {
15d8e565
MB
354 if (argc == 2) {
355 exp_type = argv[0];
356 obj_name = argv[1];
357 } else
358 usage_with_options(cat_file_usage, options);
359 }
b71bd480 360 if (batch.enabled && (opt || argc)) {
15d8e565 361 usage_with_options(cat_file_usage, options);
9cf71b17
AR
362 }
363
b71bd480
JK
364 if (batch.enabled)
365 return batch_objects(&batch);
05d5667f 366
9cf71b17
AR
367 return cat_one_file(opt, exp_type, obj_name);
368}