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
;
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.
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.
134 struct object_info info
;
137 static int is_atom(const char *atom
, const char *s
, int slen
)
139 int alen
= strlen(atom
);
140 return alen
== slen
&& !memcmp(atom
, s
, alen
);
143 static void expand_atom(struct strbuf
*sb
, const char *atom
, int len
,
146 struct expand_data
*data
= vdata
;
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
)) {
152 if (!data
->mark_query
)
153 strbuf_addstr(sb
, typename(data
->type
));
154 } else if (is_atom("objectsize", atom
, len
)) {
155 if (data
->mark_query
)
156 data
->info
.sizep
= &data
->size
;
158 strbuf_addf(sb
, "%lu", data
->size
);
159 } else if (is_atom("objectsize:disk", atom
, len
)) {
160 if (data
->mark_query
)
161 data
->info
.disk_sizep
= &data
->disk_size
;
163 strbuf_addf(sb
, "%lu", data
->disk_size
);
165 die("unknown format element: %.*s", len
, atom
);
168 static size_t expand_format(struct strbuf
*sb
, const char *start
, void *data
)
174 end
= strchr(start
+ 1, ')');
176 die("format element '%s' does not end in ')'", start
);
178 expand_atom(sb
, start
+ 1, end
- start
- 1, data
);
180 return end
- start
+ 1;
183 static void print_object_or_die(int fd
, const unsigned char *sha1
,
184 enum object_type type
, unsigned long size
)
186 if (type
== OBJ_BLOB
) {
187 if (stream_blob_to_fd(fd
, sha1
, NULL
, 0) < 0)
188 die("unable to stream %s to stdout", sha1_to_hex(sha1
));
191 enum object_type rtype
;
195 contents
= read_sha1_file(sha1
, &rtype
, &rsize
);
197 die("object %s disappeared", sha1_to_hex(sha1
));
199 die("object %s changed type!?", sha1_to_hex(sha1
));
201 die("object %s change size!?", sha1_to_hex(sha1
));
203 write_or_die(fd
, contents
, size
);
208 struct batch_options
{
214 static int batch_one_object(const char *obj_name
, struct batch_options
*opt
,
215 struct expand_data
*data
)
217 struct strbuf buf
= STRBUF_INIT
;
222 if (get_sha1(obj_name
, data
->sha1
)) {
223 printf("%s missing\n", obj_name
);
228 data
->type
= sha1_object_info_extended(data
->sha1
, &data
->info
);
229 if (data
->type
<= 0) {
230 printf("%s missing\n", obj_name
);
235 strbuf_expand(&buf
, opt
->format
, expand_format
, data
);
236 strbuf_addch(&buf
, '\n');
237 write_or_die(1, buf
.buf
, buf
.len
);
238 strbuf_release(&buf
);
240 if (opt
->print_contents
) {
241 print_object_or_die(1, data
->sha1
, data
->type
, data
->size
);
242 write_or_die(1, "\n", 1);
247 static int batch_objects(struct batch_options
*opt
)
249 struct strbuf buf
= STRBUF_INIT
;
250 struct expand_data data
;
253 opt
->format
= "%(objectname) %(objecttype) %(objectsize)";
256 * Expand once with our special mark_query flag, which will prime the
257 * object_info to be handed to sha1_object_info_extended for each
260 memset(&data
, 0, sizeof(data
));
262 strbuf_expand(&buf
, opt
->format
, expand_format
, &data
);
265 while (strbuf_getline(&buf
, stdin
, '\n') != EOF
) {
266 int error
= batch_one_object(buf
.buf
, opt
, &data
);
274 static const char * const cat_file_usage
[] = {
275 N_("git cat-file (-t|-s|-e|-p|<type>|--textconv) <object>"),
276 N_("git cat-file (--batch|--batch-check) < <list_of_objects>"),
280 static int git_cat_file_config(const char *var
, const char *value
, void *cb
)
282 if (userdiff_config(var
, value
) < 0)
285 return git_default_config(var
, value
, cb
);
288 static int batch_option_callback(const struct option
*opt
,
292 struct batch_options
*bo
= opt
->value
;
295 memset(bo
, 0, sizeof(*bo
));
300 bo
->print_contents
= !strcmp(opt
->long_name
, "batch");
306 int cmd_cat_file(int argc
, const char **argv
, const char *prefix
)
309 const char *exp_type
= NULL
, *obj_name
= NULL
;
310 struct batch_options batch
= {0};
312 const struct option options
[] = {
313 OPT_GROUP(N_("<type> can be one of: blob, tree, commit, tag")),
314 OPT_SET_INT('t', NULL
, &opt
, N_("show object type"), 't'),
315 OPT_SET_INT('s', NULL
, &opt
, N_("show object size"), 's'),
316 OPT_SET_INT('e', NULL
, &opt
,
317 N_("exit with zero when there's no error"), 'e'),
318 OPT_SET_INT('p', NULL
, &opt
, N_("pretty-print object's content"), 'p'),
319 OPT_SET_INT(0, "textconv", &opt
,
320 N_("for blob objects, run textconv on object's content"), 'c'),
321 { OPTION_CALLBACK
, 0, "batch", &batch
, "format",
322 N_("show info and content of objects fed from the standard input"),
323 PARSE_OPT_OPTARG
, batch_option_callback
},
324 { OPTION_CALLBACK
, 0, "batch-check", &batch
, "format",
325 N_("show info about objects fed from the standard input"),
326 PARSE_OPT_OPTARG
, batch_option_callback
},
330 git_config(git_cat_file_config
, NULL
);
332 if (argc
!= 3 && argc
!= 2)
333 usage_with_options(cat_file_usage
, options
);
335 argc
= parse_options(argc
, argv
, prefix
, options
, cat_file_usage
, 0);
341 usage_with_options(cat_file_usage
, options
);
343 if (!opt
&& !batch
.enabled
) {
348 usage_with_options(cat_file_usage
, options
);
350 if (batch
.enabled
&& (opt
|| argc
)) {
351 usage_with_options(cat_file_usage
, options
);
355 return batch_objects(&batch
);
357 return cat_one_file(opt
, exp_type
, obj_name
);