cat-file: make the options mutually exclusive
[git] / fsck.c
1 #include "cache.h"
2 #include "object.h"
3 #include "blob.h"
4 #include "tree.h"
5 #include "tree-walk.h"
6 #include "commit.h"
7 #include "tag.h"
8 #include "fsck.h"
9 #include "refs.h"
10 #include "utf8.h"
11
12 static int fsck_walk_tree(struct tree *tree, fsck_walk_func walk, void *data)
13 {
14         struct tree_desc desc;
15         struct name_entry entry;
16         int res = 0;
17
18         if (parse_tree(tree))
19                 return -1;
20
21         init_tree_desc(&desc, tree->buffer, tree->size);
22         while (tree_entry(&desc, &entry)) {
23                 int result;
24
25                 if (S_ISGITLINK(entry.mode))
26                         continue;
27                 if (S_ISDIR(entry.mode))
28                         result = walk(&lookup_tree(entry.sha1)->object, OBJ_TREE, data);
29                 else if (S_ISREG(entry.mode) || S_ISLNK(entry.mode))
30                         result = walk(&lookup_blob(entry.sha1)->object, OBJ_BLOB, data);
31                 else {
32                         result = error("in tree %s: entry %s has bad mode %.6o",
33                                         sha1_to_hex(tree->object.sha1), entry.path, entry.mode);
34                 }
35                 if (result < 0)
36                         return result;
37                 if (!res)
38                         res = result;
39         }
40         return res;
41 }
42
43 static int fsck_walk_commit(struct commit *commit, fsck_walk_func walk, void *data)
44 {
45         struct commit_list *parents;
46         int res;
47         int result;
48
49         if (parse_commit(commit))
50                 return -1;
51
52         result = walk((struct object *)commit->tree, OBJ_TREE, data);
53         if (result < 0)
54                 return result;
55         res = result;
56
57         parents = commit->parents;
58         while (parents) {
59                 result = walk((struct object *)parents->item, OBJ_COMMIT, data);
60                 if (result < 0)
61                         return result;
62                 if (!res)
63                         res = result;
64                 parents = parents->next;
65         }
66         return res;
67 }
68
69 static int fsck_walk_tag(struct tag *tag, fsck_walk_func walk, void *data)
70 {
71         if (parse_tag(tag))
72                 return -1;
73         return walk(tag->tagged, OBJ_ANY, data);
74 }
75
76 int fsck_walk(struct object *obj, fsck_walk_func walk, void *data)
77 {
78         if (!obj)
79                 return -1;
80         switch (obj->type) {
81         case OBJ_BLOB:
82                 return 0;
83         case OBJ_TREE:
84                 return fsck_walk_tree((struct tree *)obj, walk, data);
85         case OBJ_COMMIT:
86                 return fsck_walk_commit((struct commit *)obj, walk, data);
87         case OBJ_TAG:
88                 return fsck_walk_tag((struct tag *)obj, walk, data);
89         default:
90                 error("Unknown object type for %s", sha1_to_hex(obj->sha1));
91                 return -1;
92         }
93 }
94
95 /*
96  * The entries in a tree are ordered in the _path_ order,
97  * which means that a directory entry is ordered by adding
98  * a slash to the end of it.
99  *
100  * So a directory called "a" is ordered _after_ a file
101  * called "a.c", because "a/" sorts after "a.c".
102  */
103 #define TREE_UNORDERED (-1)
104 #define TREE_HAS_DUPS  (-2)
105
106 static int verify_ordered(unsigned mode1, const char *name1, unsigned mode2, const char *name2)
107 {
108         int len1 = strlen(name1);
109         int len2 = strlen(name2);
110         int len = len1 < len2 ? len1 : len2;
111         unsigned char c1, c2;
112         int cmp;
113
114         cmp = memcmp(name1, name2, len);
115         if (cmp < 0)
116                 return 0;
117         if (cmp > 0)
118                 return TREE_UNORDERED;
119
120         /*
121          * Ok, the first <len> characters are the same.
122          * Now we need to order the next one, but turn
123          * a '\0' into a '/' for a directory entry.
124          */
125         c1 = name1[len];
126         c2 = name2[len];
127         if (!c1 && !c2)
128                 /*
129                  * git-write-tree used to write out a nonsense tree that has
130                  * entries with the same name, one blob and one tree.  Make
131                  * sure we do not have duplicate entries.
132                  */
133                 return TREE_HAS_DUPS;
134         if (!c1 && S_ISDIR(mode1))
135                 c1 = '/';
136         if (!c2 && S_ISDIR(mode2))
137                 c2 = '/';
138         return c1 < c2 ? 0 : TREE_UNORDERED;
139 }
140
141 static int fsck_tree(struct tree *item, int strict, fsck_error error_func)
142 {
143         int retval;
144         int has_null_sha1 = 0;
145         int has_full_path = 0;
146         int has_empty_name = 0;
147         int has_dot = 0;
148         int has_dotdot = 0;
149         int has_dotgit = 0;
150         int has_zero_pad = 0;
151         int has_bad_modes = 0;
152         int has_dup_entries = 0;
153         int not_properly_sorted = 0;
154         struct tree_desc desc;
155         unsigned o_mode;
156         const char *o_name;
157
158         init_tree_desc(&desc, item->buffer, item->size);
159
160         o_mode = 0;
161         o_name = NULL;
162
163         while (desc.size) {
164                 unsigned mode;
165                 const char *name;
166                 const unsigned char *sha1;
167
168                 sha1 = tree_entry_extract(&desc, &name, &mode);
169
170                 has_null_sha1 |= is_null_sha1(sha1);
171                 has_full_path |= !!strchr(name, '/');
172                 has_empty_name |= !*name;
173                 has_dot |= !strcmp(name, ".");
174                 has_dotdot |= !strcmp(name, "..");
175                 has_dotgit |= (!strcmp(name, ".git") ||
176                                is_hfs_dotgit(name) ||
177                                is_ntfs_dotgit(name));
178                 has_zero_pad |= *(char *)desc.buffer == '0';
179                 update_tree_entry(&desc);
180
181                 switch (mode) {
182                 /*
183                  * Standard modes..
184                  */
185                 case S_IFREG | 0755:
186                 case S_IFREG | 0644:
187                 case S_IFLNK:
188                 case S_IFDIR:
189                 case S_IFGITLINK:
190                         break;
191                 /*
192                  * This is nonstandard, but we had a few of these
193                  * early on when we honored the full set of mode
194                  * bits..
195                  */
196                 case S_IFREG | 0664:
197                         if (!strict)
198                                 break;
199                 default:
200                         has_bad_modes = 1;
201                 }
202
203                 if (o_name) {
204                         switch (verify_ordered(o_mode, o_name, mode, name)) {
205                         case TREE_UNORDERED:
206                                 not_properly_sorted = 1;
207                                 break;
208                         case TREE_HAS_DUPS:
209                                 has_dup_entries = 1;
210                                 break;
211                         default:
212                                 break;
213                         }
214                 }
215
216                 o_mode = mode;
217                 o_name = name;
218         }
219
220         retval = 0;
221         if (has_null_sha1)
222                 retval += error_func(&item->object, FSCK_WARN, "contains entries pointing to null sha1");
223         if (has_full_path)
224                 retval += error_func(&item->object, FSCK_WARN, "contains full pathnames");
225         if (has_empty_name)
226                 retval += error_func(&item->object, FSCK_WARN, "contains empty pathname");
227         if (has_dot)
228                 retval += error_func(&item->object, FSCK_WARN, "contains '.'");
229         if (has_dotdot)
230                 retval += error_func(&item->object, FSCK_WARN, "contains '..'");
231         if (has_dotgit)
232                 retval += error_func(&item->object, FSCK_WARN, "contains '.git'");
233         if (has_zero_pad)
234                 retval += error_func(&item->object, FSCK_WARN, "contains zero-padded file modes");
235         if (has_bad_modes)
236                 retval += error_func(&item->object, FSCK_WARN, "contains bad file modes");
237         if (has_dup_entries)
238                 retval += error_func(&item->object, FSCK_ERROR, "contains duplicate file entries");
239         if (not_properly_sorted)
240                 retval += error_func(&item->object, FSCK_ERROR, "not properly sorted");
241         return retval;
242 }
243
244 static int require_end_of_header(const void *data, unsigned long size,
245         struct object *obj, fsck_error error_func)
246 {
247         const char *buffer = (const char *)data;
248         unsigned long i;
249
250         for (i = 0; i < size; i++) {
251                 switch (buffer[i]) {
252                 case '\0':
253                         return error_func(obj, FSCK_ERROR,
254                                 "unterminated header: NUL at offset %d", i);
255                 case '\n':
256                         if (i + 1 < size && buffer[i + 1] == '\n')
257                                 return 0;
258                 }
259         }
260
261         return error_func(obj, FSCK_ERROR, "unterminated header");
262 }
263
264 static int fsck_ident(const char **ident, struct object *obj, fsck_error error_func)
265 {
266         char *end;
267
268         if (**ident == '<')
269                 return error_func(obj, FSCK_ERROR, "invalid author/committer line - missing space before email");
270         *ident += strcspn(*ident, "<>\n");
271         if (**ident == '>')
272                 return error_func(obj, FSCK_ERROR, "invalid author/committer line - bad name");
273         if (**ident != '<')
274                 return error_func(obj, FSCK_ERROR, "invalid author/committer line - missing email");
275         if ((*ident)[-1] != ' ')
276                 return error_func(obj, FSCK_ERROR, "invalid author/committer line - missing space before email");
277         (*ident)++;
278         *ident += strcspn(*ident, "<>\n");
279         if (**ident != '>')
280                 return error_func(obj, FSCK_ERROR, "invalid author/committer line - bad email");
281         (*ident)++;
282         if (**ident != ' ')
283                 return error_func(obj, FSCK_ERROR, "invalid author/committer line - missing space before date");
284         (*ident)++;
285         if (**ident == '0' && (*ident)[1] != ' ')
286                 return error_func(obj, FSCK_ERROR, "invalid author/committer line - zero-padded date");
287         if (date_overflows(strtoul(*ident, &end, 10)))
288                 return error_func(obj, FSCK_ERROR, "invalid author/committer line - date causes integer overflow");
289         if (end == *ident || *end != ' ')
290                 return error_func(obj, FSCK_ERROR, "invalid author/committer line - bad date");
291         *ident = end + 1;
292         if ((**ident != '+' && **ident != '-') ||
293             !isdigit((*ident)[1]) ||
294             !isdigit((*ident)[2]) ||
295             !isdigit((*ident)[3]) ||
296             !isdigit((*ident)[4]) ||
297             ((*ident)[5] != '\n'))
298                 return error_func(obj, FSCK_ERROR, "invalid author/committer line - bad time zone");
299         (*ident) += 6;
300         return 0;
301 }
302
303 static int fsck_commit_buffer(struct commit *commit, const char *buffer,
304         unsigned long size, fsck_error error_func)
305 {
306         unsigned char tree_sha1[20], sha1[20];
307         struct commit_graft *graft;
308         unsigned parent_count, parent_line_count = 0;
309         int err;
310
311         if (require_end_of_header(buffer, size, &commit->object, error_func))
312                 return -1;
313
314         if (!skip_prefix(buffer, "tree ", &buffer))
315                 return error_func(&commit->object, FSCK_ERROR, "invalid format - expected 'tree' line");
316         if (get_sha1_hex(buffer, tree_sha1) || buffer[40] != '\n')
317                 return error_func(&commit->object, FSCK_ERROR, "invalid 'tree' line format - bad sha1");
318         buffer += 41;
319         while (skip_prefix(buffer, "parent ", &buffer)) {
320                 if (get_sha1_hex(buffer, sha1) || buffer[40] != '\n')
321                         return error_func(&commit->object, FSCK_ERROR, "invalid 'parent' line format - bad sha1");
322                 buffer += 41;
323                 parent_line_count++;
324         }
325         graft = lookup_commit_graft(commit->object.sha1);
326         parent_count = commit_list_count(commit->parents);
327         if (graft) {
328                 if (graft->nr_parent == -1 && !parent_count)
329                         ; /* shallow commit */
330                 else if (graft->nr_parent != parent_count)
331                         return error_func(&commit->object, FSCK_ERROR, "graft objects missing");
332         } else {
333                 if (parent_count != parent_line_count)
334                         return error_func(&commit->object, FSCK_ERROR, "parent objects missing");
335         }
336         if (!skip_prefix(buffer, "author ", &buffer))
337                 return error_func(&commit->object, FSCK_ERROR, "invalid format - expected 'author' line");
338         err = fsck_ident(&buffer, &commit->object, error_func);
339         if (err)
340                 return err;
341         if (!skip_prefix(buffer, "committer ", &buffer))
342                 return error_func(&commit->object, FSCK_ERROR, "invalid format - expected 'committer' line");
343         err = fsck_ident(&buffer, &commit->object, error_func);
344         if (err)
345                 return err;
346         if (!commit->tree)
347                 return error_func(&commit->object, FSCK_ERROR, "could not load commit's tree %s", sha1_to_hex(tree_sha1));
348
349         return 0;
350 }
351
352 static int fsck_commit(struct commit *commit, const char *data,
353         unsigned long size, fsck_error error_func)
354 {
355         const char *buffer = data ?  data : get_commit_buffer(commit, &size);
356         int ret = fsck_commit_buffer(commit, buffer, size, error_func);
357         if (!data)
358                 unuse_commit_buffer(commit, buffer);
359         return ret;
360 }
361
362 static int fsck_tag_buffer(struct tag *tag, const char *data,
363         unsigned long size, fsck_error error_func)
364 {
365         unsigned char sha1[20];
366         int ret = 0;
367         const char *buffer;
368         char *to_free = NULL, *eol;
369         struct strbuf sb = STRBUF_INIT;
370
371         if (data)
372                 buffer = data;
373         else {
374                 enum object_type type;
375
376                 buffer = to_free =
377                         read_sha1_file(tag->object.sha1, &type, &size);
378                 if (!buffer)
379                         return error_func(&tag->object, FSCK_ERROR,
380                                 "cannot read tag object");
381
382                 if (type != OBJ_TAG) {
383                         ret = error_func(&tag->object, FSCK_ERROR,
384                                 "expected tag got %s",
385                             typename(type));
386                         goto done;
387                 }
388         }
389
390         if (require_end_of_header(buffer, size, &tag->object, error_func))
391                 goto done;
392
393         if (!skip_prefix(buffer, "object ", &buffer)) {
394                 ret = error_func(&tag->object, FSCK_ERROR, "invalid format - expected 'object' line");
395                 goto done;
396         }
397         if (get_sha1_hex(buffer, sha1) || buffer[40] != '\n') {
398                 ret = error_func(&tag->object, FSCK_ERROR, "invalid 'object' line format - bad sha1");
399                 goto done;
400         }
401         buffer += 41;
402
403         if (!skip_prefix(buffer, "type ", &buffer)) {
404                 ret = error_func(&tag->object, FSCK_ERROR, "invalid format - expected 'type' line");
405                 goto done;
406         }
407         eol = strchr(buffer, '\n');
408         if (!eol) {
409                 ret = error_func(&tag->object, FSCK_ERROR, "invalid format - unexpected end after 'type' line");
410                 goto done;
411         }
412         if (type_from_string_gently(buffer, eol - buffer, 1) < 0)
413                 ret = error_func(&tag->object, FSCK_ERROR, "invalid 'type' value");
414         if (ret)
415                 goto done;
416         buffer = eol + 1;
417
418         if (!skip_prefix(buffer, "tag ", &buffer)) {
419                 ret = error_func(&tag->object, FSCK_ERROR, "invalid format - expected 'tag' line");
420                 goto done;
421         }
422         eol = strchr(buffer, '\n');
423         if (!eol) {
424                 ret = error_func(&tag->object, FSCK_ERROR, "invalid format - unexpected end after 'type' line");
425                 goto done;
426         }
427         strbuf_addf(&sb, "refs/tags/%.*s", (int)(eol - buffer), buffer);
428         if (check_refname_format(sb.buf, 0))
429                 error_func(&tag->object, FSCK_WARN, "invalid 'tag' name: %.*s",
430                            (int)(eol - buffer), buffer);
431         buffer = eol + 1;
432
433         if (!skip_prefix(buffer, "tagger ", &buffer))
434                 /* early tags do not contain 'tagger' lines; warn only */
435                 error_func(&tag->object, FSCK_WARN, "invalid format - expected 'tagger' line");
436         else
437                 ret = fsck_ident(&buffer, &tag->object, error_func);
438
439 done:
440         strbuf_release(&sb);
441         free(to_free);
442         return ret;
443 }
444
445 static int fsck_tag(struct tag *tag, const char *data,
446         unsigned long size, fsck_error error_func)
447 {
448         struct object *tagged = tag->tagged;
449
450         if (!tagged)
451                 return error_func(&tag->object, FSCK_ERROR, "could not load tagged object");
452
453         return fsck_tag_buffer(tag, data, size, error_func);
454 }
455
456 int fsck_object(struct object *obj, void *data, unsigned long size,
457         int strict, fsck_error error_func)
458 {
459         if (!obj)
460                 return error_func(obj, FSCK_ERROR, "no valid object to fsck");
461
462         if (obj->type == OBJ_BLOB)
463                 return 0;
464         if (obj->type == OBJ_TREE)
465                 return fsck_tree((struct tree *) obj, strict, error_func);
466         if (obj->type == OBJ_COMMIT)
467                 return fsck_commit((struct commit *) obj, (const char *) data,
468                         size, error_func);
469         if (obj->type == OBJ_TAG)
470                 return fsck_tag((struct tag *) obj, (const char *) data,
471                         size, error_func);
472
473         return error_func(obj, FSCK_ERROR, "unknown type '%d' (internal fsck error)",
474                           obj->type);
475 }
476
477 int fsck_error_function(struct object *obj, int type, const char *fmt, ...)
478 {
479         va_list ap;
480         struct strbuf sb = STRBUF_INIT;
481
482         strbuf_addf(&sb, "object %s:", sha1_to_hex(obj->sha1));
483
484         va_start(ap, fmt);
485         strbuf_vaddf(&sb, fmt, ap);
486         va_end(ap);
487
488         error("%s", sb.buf);
489         strbuf_release(&sb);
490         return 1;
491 }