2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
11 #include "parse-options.h"
14 #include "streaming.h"
16 static int cat_one_file(int opt, const char *exp_type, const char *obj_name)
18 unsigned char sha1[20];
19 enum object_type type;
22 struct object_context obj_context;
24 if (get_sha1_with_context(obj_name, 0, sha1, &obj_context))
25 die("Not a valid object name %s", obj_name);
30 type = sha1_object_info(sha1, NULL);
32 printf("%s\n", typename(type));
38 type = sha1_object_info(sha1, &size);
40 printf("%lu\n", size);
46 return !has_sha1_file(sha1);
49 type = sha1_object_info(sha1, NULL);
51 die("Not a valid object name %s", obj_name);
53 /* custom pretty-print here */
54 if (type == OBJ_TREE) {
55 const char *ls_args[3] = { NULL };
56 ls_args[0] = "ls-tree";
57 ls_args[1] = obj_name;
58 return cmd_ls_tree(2, ls_args, NULL);
62 return stream_blob_to_fd(1, sha1, NULL, 0);
63 buf = read_sha1_file(sha1, &type, &size);
65 die("Cannot read object %s", obj_name);
67 /* otherwise just spit out the data */
71 if (!obj_context.path[0])
72 die("git cat-file --textconv %s: <object> must be <sha1:path>",
75 if (!textconv_object(obj_context.path, obj_context.mode, sha1, 1, &buf, &size))
76 die("git cat-file --textconv: unable to run textconv on %s",
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;
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));
92 hashcpy(blob_sha1, sha1);
94 if (sha1_object_info(blob_sha1, NULL) == OBJ_BLOB)
95 return stream_blob_to_fd(1, blob_sha1, NULL, 0);
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.
103 buf = read_object_with_reference(sha1, exp_type, &size, NULL);
107 die("git cat-file: unknown option: %s", exp_type);
111 die("git cat-file %s: bad file", obj_name);
113 write_or_die(1, buf, size);
118 unsigned char sha1[20];
119 enum object_type type;
121 unsigned long disk_size;
125 * If mark_query is true, we do not expand anything, but rather
126 * just mark the object_info with items we wish to query.
131 * After a mark_query run, this object_info is set up to be
132 * passed to sha1_object_info_extended. It will point to the data
133 * elements above, so you can retrieve the response from there.
135 struct object_info info;
138 static int is_atom(const char *atom, const char *s, int slen)
140 int alen = strlen(atom);
141 return alen == slen && !memcmp(atom, s, alen);
144 static void expand_atom(struct strbuf *sb, const char *atom, int len,
147 struct expand_data *data = vdata;
149 if (is_atom("objectname", atom, len)) {
150 if (!data->mark_query)
151 strbuf_addstr(sb, sha1_to_hex(data->sha1));
152 } else if (is_atom("objecttype", atom, len)) {
153 if (!data->mark_query)
154 strbuf_addstr(sb, typename(data->type));
155 } else if (is_atom("objectsize", atom, len)) {
156 if (data->mark_query)
157 data->info.sizep = &data->size;
159 strbuf_addf(sb, "%lu", data->size);
160 } else if (is_atom("objectsize:disk", atom, len)) {
161 if (data->mark_query)
162 data->info.disk_sizep = &data->disk_size;
164 strbuf_addf(sb, "%lu", data->disk_size);
165 } else if (is_atom("rest", atom, len)) {
166 if (!data->mark_query && data->rest)
167 strbuf_addstr(sb, data->rest);
169 die("unknown format element: %.*s", len, atom);
172 static size_t expand_format(struct strbuf *sb, const char *start, void *data)
178 end = strchr(start + 1, ')');
180 die("format element '%s' does not end in ')'", start);
182 expand_atom(sb, start + 1, end - start - 1, data);
184 return end - start + 1;
187 static void print_object_or_die(int fd, const unsigned char *sha1,
188 enum object_type type, unsigned long size)
190 if (type == OBJ_BLOB) {
191 if (stream_blob_to_fd(fd, sha1, NULL, 0) < 0)
192 die("unable to stream %s to stdout", sha1_to_hex(sha1));
195 enum object_type rtype;
199 contents = read_sha1_file(sha1, &rtype, &rsize);
201 die("object %s disappeared", sha1_to_hex(sha1));
203 die("object %s changed type!?", sha1_to_hex(sha1));
205 die("object %s change size!?", sha1_to_hex(sha1));
207 write_or_die(fd, contents, size);
212 struct batch_options {
218 static int batch_one_object(const char *obj_name, struct batch_options *opt,
219 struct expand_data *data)
221 struct strbuf buf = STRBUF_INIT;
226 if (get_sha1(obj_name, data->sha1)) {
227 printf("%s missing\n", obj_name);
232 data->type = sha1_object_info_extended(data->sha1, &data->info);
233 if (data->type <= 0) {
234 printf("%s missing\n", obj_name);
239 strbuf_expand(&buf, opt->format, expand_format, data);
240 strbuf_addch(&buf, '\n');
241 write_or_die(1, buf.buf, buf.len);
242 strbuf_release(&buf);
244 if (opt->print_contents) {
245 print_object_or_die(1, data->sha1, data->type, data->size);
246 write_or_die(1, "\n", 1);
251 static int batch_objects(struct batch_options *opt)
253 struct strbuf buf = STRBUF_INIT;
254 struct expand_data data;
257 opt->format = "%(objectname) %(objecttype) %(objectsize)";
260 * Expand once with our special mark_query flag, which will prime the
261 * object_info to be handed to sha1_object_info_extended for each
264 memset(&data, 0, sizeof(data));
266 strbuf_expand(&buf, opt->format, expand_format, &data);
269 while (strbuf_getline(&buf, stdin, '\n') != EOF) {
274 * Split at first whitespace, tying off the beginning of the
275 * string and saving the remainder (or NULL) in data.rest.
277 p = strpbrk(buf.buf, " \t");
279 while (*p && strchr(" \t", *p))
284 error = batch_one_object(buf.buf, opt, &data);
292 static const char * const cat_file_usage[] = {
293 N_("git cat-file (-t|-s|-e|-p|<type>|--textconv) <object>"),
294 N_("git cat-file (--batch|--batch-check) < <list_of_objects>"),
298 static int git_cat_file_config(const char *var, const char *value, void *cb)
300 if (userdiff_config(var, value) < 0)
303 return git_default_config(var, value, cb);
306 static int batch_option_callback(const struct option *opt,
310 struct batch_options *bo = opt->value;
313 memset(bo, 0, sizeof(*bo));
318 bo->print_contents = !strcmp(opt->long_name, "batch");
324 int cmd_cat_file(int argc, const char **argv, const char *prefix)
327 const char *exp_type = NULL, *obj_name = NULL;
328 struct batch_options batch = {0};
330 const struct option options[] = {
331 OPT_GROUP(N_("<type> can be one of: blob, tree, commit, tag")),
332 OPT_SET_INT('t', NULL, &opt, N_("show object type"), 't'),
333 OPT_SET_INT('s', NULL, &opt, N_("show object size"), 's'),
334 OPT_SET_INT('e', NULL, &opt,
335 N_("exit with zero when there's no error"), 'e'),
336 OPT_SET_INT('p', NULL, &opt, N_("pretty-print object's content"), 'p'),
337 OPT_SET_INT(0, "textconv", &opt,
338 N_("for blob objects, run textconv on object's content"), 'c'),
339 { OPTION_CALLBACK, 0, "batch", &batch, "format",
340 N_("show info and content of objects fed from the standard input"),
341 PARSE_OPT_OPTARG, batch_option_callback },
342 { OPTION_CALLBACK, 0, "batch-check", &batch, "format",
343 N_("show info about objects fed from the standard input"),
344 PARSE_OPT_OPTARG, batch_option_callback },
348 git_config(git_cat_file_config, NULL);
350 if (argc != 3 && argc != 2)
351 usage_with_options(cat_file_usage, options);
353 argc = parse_options(argc, argv, prefix, options, cat_file_usage, 0);
359 usage_with_options(cat_file_usage, options);
361 if (!opt && !batch.enabled) {
366 usage_with_options(cat_file_usage, options);
368 if (batch.enabled && (opt || argc)) {
369 usage_with_options(cat_file_usage, options);
373 return batch_objects(&batch);
375 return cat_one_file(opt, exp_type, obj_name);