refs.c: ref_transaction_commit: distinguish name conflicts from other errors
[git.git] / builtin / cat-file.c
blobf8d81291b9913a769f79405720210aa4eaf6daee
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 */
6 #include "cache.h"
7 #include "exec_cmd.h"
8 #include "tag.h"
9 #include "tree.h"
10 #include "builtin.h"
11 #include "parse-options.h"
12 #include "diff.h"
13 #include "userdiff.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;
20 char *buf;
21 unsigned long size;
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);
27 buf = NULL;
28 switch (opt) {
29 case 't':
30 type = sha1_object_info(sha1, NULL);
31 if (type > 0) {
32 printf("%s\n", typename(type));
33 return 0;
35 break;
37 case 's':
38 type = sha1_object_info(sha1, &size);
39 if (type > 0) {
40 printf("%lu\n", size);
41 return 0;
43 break;
45 case 'e':
46 return !has_sha1_file(sha1);
48 case 'c':
49 if (!obj_context.path[0])
50 die("git cat-file --textconv %s: <object> must be <sha1:path>",
51 obj_name);
53 if (textconv_object(obj_context.path, obj_context.mode, sha1, 1, &buf, &size))
54 break;
56 case 'p':
57 type = sha1_object_info(sha1, NULL);
58 if (type < 0)
59 die("Not a valid object name %s", obj_name);
61 /* custom pretty-print here */
62 if (type == OBJ_TREE) {
63 const char *ls_args[3] = { NULL };
64 ls_args[0] = "ls-tree";
65 ls_args[1] = obj_name;
66 return cmd_ls_tree(2, ls_args, NULL);
69 if (type == OBJ_BLOB)
70 return stream_blob_to_fd(1, sha1, NULL, 0);
71 buf = read_sha1_file(sha1, &type, &size);
72 if (!buf)
73 die("Cannot read object %s", obj_name);
75 /* otherwise just spit out the data */
76 break;
78 case 0:
79 if (type_from_string(exp_type) == OBJ_BLOB) {
80 unsigned char blob_sha1[20];
81 if (sha1_object_info(sha1, NULL) == OBJ_TAG) {
82 enum object_type type;
83 unsigned long size;
84 char *buffer = read_sha1_file(sha1, &type, &size);
85 const char *target;
86 if (!skip_prefix(buffer, "object ", &target) ||
87 get_sha1_hex(target, blob_sha1))
88 die("%s not a valid tag", sha1_to_hex(sha1));
89 free(buffer);
90 } else
91 hashcpy(blob_sha1, sha1);
93 if (sha1_object_info(blob_sha1, NULL) == OBJ_BLOB)
94 return stream_blob_to_fd(1, blob_sha1, NULL, 0);
96 * we attempted to dereference a tag to a blob
97 * and failed; there may be new dereference
98 * mechanisms this code is not aware of.
99 * fall-back to the usual case.
102 buf = read_object_with_reference(sha1, exp_type, &size, NULL);
103 break;
105 default:
106 die("git cat-file: unknown option: %s", exp_type);
109 if (!buf)
110 die("git cat-file %s: bad file", obj_name);
112 write_or_die(1, buf, size);
113 return 0;
116 struct expand_data {
117 unsigned char sha1[20];
118 enum object_type type;
119 unsigned long size;
120 unsigned long disk_size;
121 const char *rest;
122 unsigned char delta_base_sha1[20];
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.
128 int mark_query;
131 * Whether to split the input on whitespace before feeding it to
132 * get_sha1; this is decided during the mark_query phase based on
133 * whether we have a %(rest) token in our format.
135 int split_on_whitespace;
138 * After a mark_query run, this object_info is set up to be
139 * passed to sha1_object_info_extended. It will point to the data
140 * elements above, so you can retrieve the response from there.
142 struct object_info info;
145 static int is_atom(const char *atom, const char *s, int slen)
147 int alen = strlen(atom);
148 return alen == slen && !memcmp(atom, s, alen);
151 static void expand_atom(struct strbuf *sb, const char *atom, int len,
152 void *vdata)
154 struct expand_data *data = vdata;
156 if (is_atom("objectname", atom, len)) {
157 if (!data->mark_query)
158 strbuf_addstr(sb, sha1_to_hex(data->sha1));
159 } else if (is_atom("objecttype", atom, len)) {
160 if (data->mark_query)
161 data->info.typep = &data->type;
162 else
163 strbuf_addstr(sb, typename(data->type));
164 } else if (is_atom("objectsize", atom, len)) {
165 if (data->mark_query)
166 data->info.sizep = &data->size;
167 else
168 strbuf_addf(sb, "%lu", data->size);
169 } else if (is_atom("objectsize:disk", atom, len)) {
170 if (data->mark_query)
171 data->info.disk_sizep = &data->disk_size;
172 else
173 strbuf_addf(sb, "%lu", data->disk_size);
174 } else if (is_atom("rest", atom, len)) {
175 if (data->mark_query)
176 data->split_on_whitespace = 1;
177 else if (data->rest)
178 strbuf_addstr(sb, data->rest);
179 } else if (is_atom("deltabase", atom, len)) {
180 if (data->mark_query)
181 data->info.delta_base_sha1 = data->delta_base_sha1;
182 else
183 strbuf_addstr(sb, sha1_to_hex(data->delta_base_sha1));
184 } else
185 die("unknown format element: %.*s", len, atom);
188 static size_t expand_format(struct strbuf *sb, const char *start, void *data)
190 const char *end;
192 if (*start != '(')
193 return 0;
194 end = strchr(start + 1, ')');
195 if (!end)
196 die("format element '%s' does not end in ')'", start);
198 expand_atom(sb, start + 1, end - start - 1, data);
200 return end - start + 1;
203 static void print_object_or_die(int fd, struct expand_data *data)
205 const unsigned char *sha1 = data->sha1;
207 assert(data->info.typep);
209 if (data->type == OBJ_BLOB) {
210 if (stream_blob_to_fd(fd, sha1, NULL, 0) < 0)
211 die("unable to stream %s to stdout", sha1_to_hex(sha1));
213 else {
214 enum object_type type;
215 unsigned long size;
216 void *contents;
218 contents = read_sha1_file(sha1, &type, &size);
219 if (!contents)
220 die("object %s disappeared", sha1_to_hex(sha1));
221 if (type != data->type)
222 die("object %s changed type!?", sha1_to_hex(sha1));
223 if (data->info.sizep && size != data->size)
224 die("object %s changed size!?", sha1_to_hex(sha1));
226 write_or_die(fd, contents, size);
227 free(contents);
231 struct batch_options {
232 int enabled;
233 int print_contents;
234 const char *format;
237 static int batch_one_object(const char *obj_name, struct batch_options *opt,
238 struct expand_data *data)
240 struct strbuf buf = STRBUF_INIT;
242 if (!obj_name)
243 return 1;
245 if (get_sha1(obj_name, data->sha1)) {
246 printf("%s missing\n", obj_name);
247 fflush(stdout);
248 return 0;
251 if (sha1_object_info_extended(data->sha1, &data->info, LOOKUP_REPLACE_OBJECT) < 0) {
252 printf("%s missing\n", obj_name);
253 fflush(stdout);
254 return 0;
257 strbuf_expand(&buf, opt->format, expand_format, data);
258 strbuf_addch(&buf, '\n');
259 write_or_die(1, buf.buf, buf.len);
260 strbuf_release(&buf);
262 if (opt->print_contents) {
263 print_object_or_die(1, data);
264 write_or_die(1, "\n", 1);
266 return 0;
269 static int batch_objects(struct batch_options *opt)
271 struct strbuf buf = STRBUF_INIT;
272 struct expand_data data;
273 int save_warning;
274 int retval = 0;
276 if (!opt->format)
277 opt->format = "%(objectname) %(objecttype) %(objectsize)";
280 * Expand once with our special mark_query flag, which will prime the
281 * object_info to be handed to sha1_object_info_extended for each
282 * object.
284 memset(&data, 0, sizeof(data));
285 data.mark_query = 1;
286 strbuf_expand(&buf, opt->format, expand_format, &data);
287 data.mark_query = 0;
290 * If we are printing out the object, then always fill in the type,
291 * since we will want to decide whether or not to stream.
293 if (opt->print_contents)
294 data.info.typep = &data.type;
297 * We are going to call get_sha1 on a potentially very large number of
298 * objects. In most large cases, these will be actual object sha1s. The
299 * cost to double-check that each one is not also a ref (just so we can
300 * warn) ends up dwarfing the actual cost of the object lookups
301 * themselves. We can work around it by just turning off the warning.
303 save_warning = warn_on_object_refname_ambiguity;
304 warn_on_object_refname_ambiguity = 0;
306 while (strbuf_getline(&buf, stdin, '\n') != EOF) {
307 if (data.split_on_whitespace) {
309 * Split at first whitespace, tying off the beginning
310 * of the string and saving the remainder (or NULL) in
311 * data.rest.
313 char *p = strpbrk(buf.buf, " \t");
314 if (p) {
315 while (*p && strchr(" \t", *p))
316 *p++ = '\0';
318 data.rest = p;
321 retval = batch_one_object(buf.buf, opt, &data);
322 if (retval)
323 break;
326 strbuf_release(&buf);
327 warn_on_object_refname_ambiguity = save_warning;
328 return retval;
331 static const char * const cat_file_usage[] = {
332 N_("git cat-file (-t|-s|-e|-p|<type>|--textconv) <object>"),
333 N_("git cat-file (--batch|--batch-check) < <list_of_objects>"),
334 NULL
337 static int git_cat_file_config(const char *var, const char *value, void *cb)
339 if (userdiff_config(var, value) < 0)
340 return -1;
342 return git_default_config(var, value, cb);
345 static int batch_option_callback(const struct option *opt,
346 const char *arg,
347 int unset)
349 struct batch_options *bo = opt->value;
351 if (unset) {
352 memset(bo, 0, sizeof(*bo));
353 return 0;
356 bo->enabled = 1;
357 bo->print_contents = !strcmp(opt->long_name, "batch");
358 bo->format = arg;
360 return 0;
363 int cmd_cat_file(int argc, const char **argv, const char *prefix)
365 int opt = 0;
366 const char *exp_type = NULL, *obj_name = NULL;
367 struct batch_options batch = {0};
369 const struct option options[] = {
370 OPT_GROUP(N_("<type> can be one of: blob, tree, commit, tag")),
371 OPT_SET_INT('t', NULL, &opt, N_("show object type"), 't'),
372 OPT_SET_INT('s', NULL, &opt, N_("show object size"), 's'),
373 OPT_SET_INT('e', NULL, &opt,
374 N_("exit with zero when there's no error"), 'e'),
375 OPT_SET_INT('p', NULL, &opt, N_("pretty-print object's content"), 'p'),
376 OPT_SET_INT(0, "textconv", &opt,
377 N_("for blob objects, run textconv on object's content"), 'c'),
378 { OPTION_CALLBACK, 0, "batch", &batch, "format",
379 N_("show info and content of objects fed from the standard input"),
380 PARSE_OPT_OPTARG, batch_option_callback },
381 { OPTION_CALLBACK, 0, "batch-check", &batch, "format",
382 N_("show info about objects fed from the standard input"),
383 PARSE_OPT_OPTARG, batch_option_callback },
384 OPT_END()
387 git_config(git_cat_file_config, NULL);
389 if (argc != 3 && argc != 2)
390 usage_with_options(cat_file_usage, options);
392 argc = parse_options(argc, argv, prefix, options, cat_file_usage, 0);
394 if (opt) {
395 if (argc == 1)
396 obj_name = argv[0];
397 else
398 usage_with_options(cat_file_usage, options);
400 if (!opt && !batch.enabled) {
401 if (argc == 2) {
402 exp_type = argv[0];
403 obj_name = argv[1];
404 } else
405 usage_with_options(cat_file_usage, options);
407 if (batch.enabled && (opt || argc)) {
408 usage_with_options(cat_file_usage, options);
411 if (batch.enabled)
412 return batch_objects(&batch);
414 return cat_one_file(opt, exp_type, obj_name);