cat-file: add --batch-check=<format>
[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;
121
122 /*
123 * If mark_query is true, we do not expand anything, but rather
124 * just mark the object_info with items we wish to query.
125 */
126 int mark_query;
127
128 /*
129 * After a mark_query run, this object_info is set up to be
130 * passed to sha1_object_info_extended. It will point to the data
131 * elements above, so you can retrieve the response from there.
132 */
133 struct object_info info;
134};
135
136static int is_atom(const char *atom, const char *s, int slen)
137{
138 int alen = strlen(atom);
139 return alen == slen && !memcmp(atom, s, alen);
140}
141
142static void expand_atom(struct strbuf *sb, const char *atom, int len,
143 void *vdata)
144{
145 struct expand_data *data = vdata;
146
147 if (is_atom("objectname", atom, len)) {
148 if (!data->mark_query)
149 strbuf_addstr(sb, sha1_to_hex(data->sha1));
150 } else if (is_atom("objecttype", atom, len)) {
151 if (!data->mark_query)
152 strbuf_addstr(sb, typename(data->type));
153 } else if (is_atom("objectsize", atom, len)) {
154 if (data->mark_query)
155 data->info.sizep = &data->size;
156 else
157 strbuf_addf(sb, "%lu", data->size);
158 } else
159 die("unknown format element: %.*s", len, atom);
160}
161
162static size_t expand_format(struct strbuf *sb, const char *start, void *data)
163{
164 const char *end;
165
166 if (*start != '(')
167 return 0;
168 end = strchr(start + 1, ')');
169 if (!end)
170 die("format element '%s' does not end in ')'", start);
171
172 expand_atom(sb, start + 1, end - start - 1, data);
173
174 return end - start + 1;
175}
176
98e2092b
JK
177static void print_object_or_die(int fd, const unsigned char *sha1,
178 enum object_type type, unsigned long size)
179{
180 if (type == OBJ_BLOB) {
181 if (stream_blob_to_fd(fd, sha1, NULL, 0) < 0)
182 die("unable to stream %s to stdout", sha1_to_hex(sha1));
183 }
184 else {
185 enum object_type rtype;
186 unsigned long rsize;
187 void *contents;
188
189 contents = read_sha1_file(sha1, &rtype, &rsize);
190 if (!contents)
191 die("object %s disappeared", sha1_to_hex(sha1));
192 if (rtype != type)
193 die("object %s changed type!?", sha1_to_hex(sha1));
194 if (rsize != size)
195 die("object %s change size!?", sha1_to_hex(sha1));
196
197 write_or_die(fd, contents, size);
198 free(contents);
199 }
200}
201
b71bd480
JK
202struct batch_options {
203 int enabled;
204 int print_contents;
93d2a607 205 const char *format;
b71bd480
JK
206};
207
93d2a607
JK
208static int batch_one_object(const char *obj_name, struct batch_options *opt,
209 struct expand_data *data)
05d5667f 210{
93d2a607 211 struct strbuf buf = STRBUF_INIT;
05d5667f
AR
212
213 if (!obj_name)
214 return 1;
215
93d2a607 216 if (get_sha1(obj_name, data->sha1)) {
05d5667f 217 printf("%s missing\n", obj_name);
422b2063 218 fflush(stdout);
05d5667f
AR
219 return 0;
220 }
221
93d2a607
JK
222 data->type = sha1_object_info_extended(data->sha1, &data->info);
223 if (data->type <= 0) {
3c076dbe
LW
224 printf("%s missing\n", obj_name);
225 fflush(stdout);
226 return 0;
227 }
05d5667f 228
93d2a607
JK
229 strbuf_expand(&buf, opt->format, expand_format, data);
230 strbuf_addch(&buf, '\n');
231 write_or_die(1, buf.buf, buf.len);
232 strbuf_release(&buf);
a8128ed6 233
b71bd480 234 if (opt->print_contents) {
93d2a607 235 print_object_or_die(1, data->sha1, data->type, data->size);
98e2092b 236 write_or_die(1, "\n", 1);
a8128ed6 237 }
05d5667f
AR
238 return 0;
239}
240
b71bd480 241static int batch_objects(struct batch_options *opt)
05d5667f 242{
f285a2d7 243 struct strbuf buf = STRBUF_INIT;
93d2a607
JK
244 struct expand_data data;
245
246 if (!opt->format)
247 opt->format = "%(objectname) %(objecttype) %(objectsize)";
248
249 /*
250 * Expand once with our special mark_query flag, which will prime the
251 * object_info to be handed to sha1_object_info_extended for each
252 * object.
253 */
254 memset(&data, 0, sizeof(data));
255 data.mark_query = 1;
256 strbuf_expand(&buf, opt->format, expand_format, &data);
257 data.mark_query = 0;
05d5667f 258
05d5667f 259 while (strbuf_getline(&buf, stdin, '\n') != EOF) {
93d2a607 260 int error = batch_one_object(buf.buf, opt, &data);
05d5667f
AR
261 if (error)
262 return error;
263 }
264
265 return 0;
266}
267
15d8e565 268static const char * const cat_file_usage[] = {
d68faec7
NTND
269 N_("git cat-file (-t|-s|-e|-p|<type>|--textconv) <object>"),
270 N_("git cat-file (--batch|--batch-check) < <list_of_objects>"),
15d8e565
MB
271 NULL
272};
4814dbe8 273
e5fba602
CP
274static int git_cat_file_config(const char *var, const char *value, void *cb)
275{
6680a087 276 if (userdiff_config(var, value) < 0)
e5fba602 277 return -1;
e5fba602
CP
278
279 return git_default_config(var, value, cb);
280}
281
b71bd480
JK
282static int batch_option_callback(const struct option *opt,
283 const char *arg,
284 int unset)
285{
286 struct batch_options *bo = opt->value;
287
288 if (unset) {
289 memset(bo, 0, sizeof(*bo));
290 return 0;
291 }
292
293 bo->enabled = 1;
294 bo->print_contents = !strcmp(opt->long_name, "batch");
93d2a607 295 bo->format = arg;
b71bd480
JK
296
297 return 0;
298}
299
9cf71b17
AR
300int cmd_cat_file(int argc, const char **argv, const char *prefix)
301{
b71bd480 302 int opt = 0;
4814dbe8 303 const char *exp_type = NULL, *obj_name = NULL;
b71bd480 304 struct batch_options batch = {0};
9cf71b17 305
15d8e565 306 const struct option options[] = {
d68faec7
NTND
307 OPT_GROUP(N_("<type> can be one of: blob, tree, commit, tag")),
308 OPT_SET_INT('t', NULL, &opt, N_("show object type"), 't'),
309 OPT_SET_INT('s', NULL, &opt, N_("show object size"), 's'),
15d8e565 310 OPT_SET_INT('e', NULL, &opt,
d68faec7
NTND
311 N_("exit with zero when there's no error"), 'e'),
312 OPT_SET_INT('p', NULL, &opt, N_("pretty-print object's content"), 'p'),
e5fba602 313 OPT_SET_INT(0, "textconv", &opt,
d68faec7 314 N_("for blob objects, run textconv on object's content"), 'c'),
93d2a607 315 { OPTION_CALLBACK, 0, "batch", &batch, "format",
b71bd480 316 N_("show info and content of objects fed from the standard input"),
93d2a607
JK
317 PARSE_OPT_OPTARG, batch_option_callback },
318 { OPTION_CALLBACK, 0, "batch-check", &batch, "format",
b71bd480 319 N_("show info about objects fed from the standard input"),
93d2a607 320 PARSE_OPT_OPTARG, batch_option_callback },
15d8e565
MB
321 OPT_END()
322 };
a8128ed6 323
e5fba602 324 git_config(git_cat_file_config, NULL);
4814dbe8 325
15d8e565
MB
326 if (argc != 3 && argc != 2)
327 usage_with_options(cat_file_usage, options);
4814dbe8 328
37782920 329 argc = parse_options(argc, argv, prefix, options, cat_file_usage, 0);
05d5667f 330
15d8e565
MB
331 if (opt) {
332 if (argc == 1)
333 obj_name = argv[0];
334 else
335 usage_with_options(cat_file_usage, options);
336 }
b71bd480 337 if (!opt && !batch.enabled) {
15d8e565
MB
338 if (argc == 2) {
339 exp_type = argv[0];
340 obj_name = argv[1];
341 } else
342 usage_with_options(cat_file_usage, options);
343 }
b71bd480 344 if (batch.enabled && (opt || argc)) {
15d8e565 345 usage_with_options(cat_file_usage, options);
9cf71b17
AR
346 }
347
b71bd480
JK
348 if (batch.enabled)
349 return batch_objects(&batch);
05d5667f 350
9cf71b17
AR
351 return cat_one_file(opt, exp_type, obj_name);
352}