Update draft release notes to 1.8.3.4
[git/git.git] / builtin / cat-file.c
1 /*
2 * GIT - The information manager from hell
3 *
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"
15
16 #define BATCH 1
17 #define BATCH_CHECK 2
18
19 static int cat_one_file(int opt, const char *exp_type, const char *obj_name)
20 {
21 unsigned char sha1[20];
22 enum object_type type;
23 char *buf;
24 unsigned long size;
25 struct object_context obj_context;
26
27 if (get_sha1_with_context(obj_name, 0, sha1, &obj_context))
28 die("Not a valid object name %s", obj_name);
29
30 buf = NULL;
31 switch (opt) {
32 case 't':
33 type = sha1_object_info(sha1, NULL);
34 if (type > 0) {
35 printf("%s\n", typename(type));
36 return 0;
37 }
38 break;
39
40 case 's':
41 type = sha1_object_info(sha1, &size);
42 if (type > 0) {
43 printf("%lu\n", size);
44 return 0;
45 }
46 break;
47
48 case 'e':
49 return !has_sha1_file(sha1);
50
51 case 'p':
52 type = sha1_object_info(sha1, NULL);
53 if (type < 0)
54 die("Not a valid object name %s", obj_name);
55
56 /* custom pretty-print here */
57 if (type == OBJ_TREE) {
58 const char *ls_args[3] = { NULL };
59 ls_args[0] = "ls-tree";
60 ls_args[1] = obj_name;
61 return cmd_ls_tree(2, ls_args, NULL);
62 }
63
64 if (type == OBJ_BLOB)
65 return stream_blob_to_fd(1, sha1, NULL, 0);
66 buf = read_sha1_file(sha1, &type, &size);
67 if (!buf)
68 die("Cannot read object %s", obj_name);
69
70 /* otherwise just spit out the data */
71 break;
72
73 case 'c':
74 if (!obj_context.path[0])
75 die("git cat-file --textconv %s: <object> must be <sha1:path>",
76 obj_name);
77
78 if (!textconv_object(obj_context.path, obj_context.mode, sha1, 1, &buf, &size))
79 die("git cat-file --textconv: unable to run textconv on %s",
80 obj_name);
81 break;
82
83 case 0:
84 if (type_from_string(exp_type) == OBJ_BLOB) {
85 unsigned char blob_sha1[20];
86 if (sha1_object_info(sha1, NULL) == OBJ_TAG) {
87 enum object_type type;
88 unsigned long size;
89 char *buffer = read_sha1_file(sha1, &type, &size);
90 if (memcmp(buffer, "object ", 7) ||
91 get_sha1_hex(buffer + 7, blob_sha1))
92 die("%s not a valid tag", sha1_to_hex(sha1));
93 free(buffer);
94 } else
95 hashcpy(blob_sha1, sha1);
96
97 if (sha1_object_info(blob_sha1, NULL) == OBJ_BLOB)
98 return stream_blob_to_fd(1, blob_sha1, NULL, 0);
99 /*
100 * we attempted to dereference a tag to a blob
101 * and failed; there may be new dereference
102 * mechanisms this code is not aware of.
103 * fall-back to the usual case.
104 */
105 }
106 buf = read_object_with_reference(sha1, exp_type, &size, NULL);
107 break;
108
109 default:
110 die("git cat-file: unknown option: %s", exp_type);
111 }
112
113 if (!buf)
114 die("git cat-file %s: bad file", obj_name);
115
116 write_or_die(1, buf, size);
117 return 0;
118 }
119
120 static int batch_one_object(const char *obj_name, int print_contents)
121 {
122 unsigned char sha1[20];
123 enum object_type type = 0;
124 unsigned long size;
125 void *contents = NULL;
126
127 if (!obj_name)
128 return 1;
129
130 if (get_sha1(obj_name, sha1)) {
131 printf("%s missing\n", obj_name);
132 fflush(stdout);
133 return 0;
134 }
135
136 if (print_contents == BATCH)
137 contents = read_sha1_file(sha1, &type, &size);
138 else
139 type = sha1_object_info(sha1, &size);
140
141 if (type <= 0) {
142 printf("%s missing\n", obj_name);
143 fflush(stdout);
144 if (print_contents == BATCH)
145 free(contents);
146 return 0;
147 }
148
149 printf("%s %s %lu\n", sha1_to_hex(sha1), typename(type), size);
150 fflush(stdout);
151
152 if (print_contents == BATCH) {
153 write_or_die(1, contents, size);
154 printf("\n");
155 fflush(stdout);
156 free(contents);
157 }
158
159 return 0;
160 }
161
162 static int batch_objects(int print_contents)
163 {
164 struct strbuf buf = STRBUF_INIT;
165
166 while (strbuf_getline(&buf, stdin, '\n') != EOF) {
167 int error = batch_one_object(buf.buf, print_contents);
168 if (error)
169 return error;
170 }
171
172 return 0;
173 }
174
175 static const char * const cat_file_usage[] = {
176 N_("git cat-file (-t|-s|-e|-p|<type>|--textconv) <object>"),
177 N_("git cat-file (--batch|--batch-check) < <list_of_objects>"),
178 NULL
179 };
180
181 static int git_cat_file_config(const char *var, const char *value, void *cb)
182 {
183 if (userdiff_config(var, value) < 0)
184 return -1;
185
186 return git_default_config(var, value, cb);
187 }
188
189 int cmd_cat_file(int argc, const char **argv, const char *prefix)
190 {
191 int opt = 0, batch = 0;
192 const char *exp_type = NULL, *obj_name = NULL;
193
194 const struct option options[] = {
195 OPT_GROUP(N_("<type> can be one of: blob, tree, commit, tag")),
196 OPT_SET_INT('t', NULL, &opt, N_("show object type"), 't'),
197 OPT_SET_INT('s', NULL, &opt, N_("show object size"), 's'),
198 OPT_SET_INT('e', NULL, &opt,
199 N_("exit with zero when there's no error"), 'e'),
200 OPT_SET_INT('p', NULL, &opt, N_("pretty-print object's content"), 'p'),
201 OPT_SET_INT(0, "textconv", &opt,
202 N_("for blob objects, run textconv on object's content"), 'c'),
203 OPT_SET_INT(0, "batch", &batch,
204 N_("show info and content of objects fed from the standard input"),
205 BATCH),
206 OPT_SET_INT(0, "batch-check", &batch,
207 N_("show info about objects fed from the standard input"),
208 BATCH_CHECK),
209 OPT_END()
210 };
211
212 git_config(git_cat_file_config, NULL);
213
214 if (argc != 3 && argc != 2)
215 usage_with_options(cat_file_usage, options);
216
217 argc = parse_options(argc, argv, prefix, options, cat_file_usage, 0);
218
219 if (opt) {
220 if (argc == 1)
221 obj_name = argv[0];
222 else
223 usage_with_options(cat_file_usage, options);
224 }
225 if (!opt && !batch) {
226 if (argc == 2) {
227 exp_type = argv[0];
228 obj_name = argv[1];
229 } else
230 usage_with_options(cat_file_usage, options);
231 }
232 if (batch && (opt || argc)) {
233 usage_with_options(cat_file_usage, options);
234 }
235
236 if (batch)
237 return batch_objects(batch);
238
239 return cat_one_file(opt, exp_type, obj_name);
240 }