user-manual: mention 'git remote add' for remote branch config
[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
10 static int fsck_walk_tree(struct tree *tree, fsck_walk_func walk, void *data)
11 {
12         struct tree_desc desc;
13         struct name_entry entry;
14         int res = 0;
15
16         if (parse_tree(tree))
17                 return -1;
18
19         init_tree_desc(&desc, tree->buffer, tree->size);
20         while (tree_entry(&desc, &entry)) {
21                 int result;
22
23                 if (S_ISGITLINK(entry.mode))
24                         continue;
25                 if (S_ISDIR(entry.mode))
26                         result = walk(&lookup_tree(entry.sha1)->object, OBJ_TREE, data);
27                 else if (S_ISREG(entry.mode) || S_ISLNK(entry.mode))
28                         result = walk(&lookup_blob(entry.sha1)->object, OBJ_BLOB, data);
29                 else {
30                         result = error("in tree %s: entry %s has bad mode %.6o",
31                                         sha1_to_hex(tree->object.sha1), entry.path, entry.mode);
32                 }
33                 if (result < 0)
34                         return result;
35                 if (!res)
36                         res = result;
37         }
38         return res;
39 }
40
41 static int fsck_walk_commit(struct commit *commit, fsck_walk_func walk, void *data)
42 {
43         struct commit_list *parents;
44         int res;
45         int result;
46
47         if (parse_commit(commit))
48                 return -1;
49
50         result = walk((struct object *)commit->tree, OBJ_TREE, data);
51         if (result < 0)
52                 return result;
53         res = result;
54
55         parents = commit->parents;
56         while (parents) {
57                 result = walk((struct object *)parents->item, OBJ_COMMIT, data);
58                 if (result < 0)
59                         return result;
60                 if (!res)
61                         res = result;
62                 parents = parents->next;
63         }
64         return res;
65 }
66
67 static int fsck_walk_tag(struct tag *tag, fsck_walk_func walk, void *data)
68 {
69         if (parse_tag(tag))
70                 return -1;
71         return walk(tag->tagged, OBJ_ANY, data);
72 }
73
74 int fsck_walk(struct object *obj, fsck_walk_func walk, void *data)
75 {
76         if (!obj)
77                 return -1;
78         switch (obj->type) {
79         case OBJ_BLOB:
80                 return 0;
81         case OBJ_TREE:
82                 return fsck_walk_tree((struct tree *)obj, walk, data);
83         case OBJ_COMMIT:
84                 return fsck_walk_commit((struct commit *)obj, walk, data);
85         case OBJ_TAG:
86                 return fsck_walk_tag((struct tag *)obj, walk, data);
87         default:
88                 error("Unknown object type for %s", sha1_to_hex(obj->sha1));
89                 return -1;
90         }
91 }
92
93 /*
94  * The entries in a tree are ordered in the _path_ order,
95  * which means that a directory entry is ordered by adding
96  * a slash to the end of it.
97  *
98  * So a directory called "a" is ordered _after_ a file
99  * called "a.c", because "a/" sorts after "a.c".
100  */
101 #define TREE_UNORDERED (-1)
102 #define TREE_HAS_DUPS  (-2)
103
104 static int verify_ordered(unsigned mode1, const char *name1, unsigned mode2, const char *name2)
105 {
106         int len1 = strlen(name1);
107         int len2 = strlen(name2);
108         int len = len1 < len2 ? len1 : len2;
109         unsigned char c1, c2;
110         int cmp;
111
112         cmp = memcmp(name1, name2, len);
113         if (cmp < 0)
114                 return 0;
115         if (cmp > 0)
116                 return TREE_UNORDERED;
117
118         /*
119          * Ok, the first <len> characters are the same.
120          * Now we need to order the next one, but turn
121          * a '\0' into a '/' for a directory entry.
122          */
123         c1 = name1[len];
124         c2 = name2[len];
125         if (!c1 && !c2)
126                 /*
127                  * git-write-tree used to write out a nonsense tree that has
128                  * entries with the same name, one blob and one tree.  Make
129                  * sure we do not have duplicate entries.
130                  */
131                 return TREE_HAS_DUPS;
132         if (!c1 && S_ISDIR(mode1))
133                 c1 = '/';
134         if (!c2 && S_ISDIR(mode2))
135                 c2 = '/';
136         return c1 < c2 ? 0 : TREE_UNORDERED;
137 }
138
139 static int fsck_tree(struct tree *item, int strict, fsck_error error_func)
140 {
141         int retval;
142         int has_null_sha1 = 0;
143         int has_full_path = 0;
144         int has_empty_name = 0;
145         int has_zero_pad = 0;
146         int has_bad_modes = 0;
147         int has_dup_entries = 0;
148         int not_properly_sorted = 0;
149         struct tree_desc desc;
150         unsigned o_mode;
151         const char *o_name;
152
153         init_tree_desc(&desc, item->buffer, item->size);
154
155         o_mode = 0;
156         o_name = NULL;
157
158         while (desc.size) {
159                 unsigned mode;
160                 const char *name;
161                 const unsigned char *sha1;
162
163                 sha1 = tree_entry_extract(&desc, &name, &mode);
164
165                 if (is_null_sha1(sha1))
166                         has_null_sha1 = 1;
167                 if (strchr(name, '/'))
168                         has_full_path = 1;
169                 if (!*name)
170                         has_empty_name = 1;
171                 has_zero_pad |= *(char *)desc.buffer == '0';
172                 update_tree_entry(&desc);
173
174                 switch (mode) {
175                 /*
176                  * Standard modes..
177                  */
178                 case S_IFREG | 0755:
179                 case S_IFREG | 0644:
180                 case S_IFLNK:
181                 case S_IFDIR:
182                 case S_IFGITLINK:
183                         break;
184                 /*
185                  * This is nonstandard, but we had a few of these
186                  * early on when we honored the full set of mode
187                  * bits..
188                  */
189                 case S_IFREG | 0664:
190                         if (!strict)
191                                 break;
192                 default:
193                         has_bad_modes = 1;
194                 }
195
196                 if (o_name) {
197                         switch (verify_ordered(o_mode, o_name, mode, name)) {
198                         case TREE_UNORDERED:
199                                 not_properly_sorted = 1;
200                                 break;
201                         case TREE_HAS_DUPS:
202                                 has_dup_entries = 1;
203                                 break;
204                         default:
205                                 break;
206                         }
207                 }
208
209                 o_mode = mode;
210                 o_name = name;
211         }
212
213         retval = 0;
214         if (has_null_sha1)
215                 retval += error_func(&item->object, FSCK_WARN, "contains entries pointing to null sha1");
216         if (has_full_path)
217                 retval += error_func(&item->object, FSCK_WARN, "contains full pathnames");
218         if (has_empty_name)
219                 retval += error_func(&item->object, FSCK_WARN, "contains empty pathname");
220         if (has_zero_pad)
221                 retval += error_func(&item->object, FSCK_WARN, "contains zero-padded file modes");
222         if (has_bad_modes)
223                 retval += error_func(&item->object, FSCK_WARN, "contains bad file modes");
224         if (has_dup_entries)
225                 retval += error_func(&item->object, FSCK_ERROR, "contains duplicate file entries");
226         if (not_properly_sorted)
227                 retval += error_func(&item->object, FSCK_ERROR, "not properly sorted");
228         return retval;
229 }
230
231 static int fsck_ident(char **ident, struct object *obj, fsck_error error_func)
232 {
233         if (**ident == '<')
234                 return error_func(obj, FSCK_ERROR, "invalid author/committer line - missing space before email");
235         *ident += strcspn(*ident, "<>\n");
236         if (**ident == '>')
237                 return error_func(obj, FSCK_ERROR, "invalid author/committer line - bad name");
238         if (**ident != '<')
239                 return error_func(obj, FSCK_ERROR, "invalid author/committer line - missing email");
240         if ((*ident)[-1] != ' ')
241                 return error_func(obj, FSCK_ERROR, "invalid author/committer line - missing space before email");
242         (*ident)++;
243         *ident += strcspn(*ident, "<>\n");
244         if (**ident != '>')
245                 return error_func(obj, FSCK_ERROR, "invalid author/committer line - bad email");
246         (*ident)++;
247         if (**ident != ' ')
248                 return error_func(obj, FSCK_ERROR, "invalid author/committer line - missing space before date");
249         (*ident)++;
250         if (**ident == '0' && (*ident)[1] != ' ')
251                 return error_func(obj, FSCK_ERROR, "invalid author/committer line - zero-padded date");
252         *ident += strspn(*ident, "0123456789");
253         if (**ident != ' ')
254                 return error_func(obj, FSCK_ERROR, "invalid author/committer line - bad date");
255         (*ident)++;
256         if ((**ident != '+' && **ident != '-') ||
257             !isdigit((*ident)[1]) ||
258             !isdigit((*ident)[2]) ||
259             !isdigit((*ident)[3]) ||
260             !isdigit((*ident)[4]) ||
261             ((*ident)[5] != '\n'))
262                 return error_func(obj, FSCK_ERROR, "invalid author/committer line - bad time zone");
263         (*ident) += 6;
264         return 0;
265 }
266
267 static int fsck_commit(struct commit *commit, fsck_error error_func)
268 {
269         char *buffer = commit->buffer;
270         unsigned char tree_sha1[20], sha1[20];
271         struct commit_graft *graft;
272         int parents = 0;
273         int err;
274
275         if (commit->date == ULONG_MAX)
276                 return error_func(&commit->object, FSCK_ERROR, "invalid author/committer line");
277
278         if (memcmp(buffer, "tree ", 5))
279                 return error_func(&commit->object, FSCK_ERROR, "invalid format - expected 'tree' line");
280         if (get_sha1_hex(buffer+5, tree_sha1) || buffer[45] != '\n')
281                 return error_func(&commit->object, FSCK_ERROR, "invalid 'tree' line format - bad sha1");
282         buffer += 46;
283         while (!memcmp(buffer, "parent ", 7)) {
284                 if (get_sha1_hex(buffer+7, sha1) || buffer[47] != '\n')
285                         return error_func(&commit->object, FSCK_ERROR, "invalid 'parent' line format - bad sha1");
286                 buffer += 48;
287                 parents++;
288         }
289         graft = lookup_commit_graft(commit->object.sha1);
290         if (graft) {
291                 struct commit_list *p = commit->parents;
292                 parents = 0;
293                 while (p) {
294                         p = p->next;
295                         parents++;
296                 }
297                 if (graft->nr_parent == -1 && !parents)
298                         ; /* shallow commit */
299                 else if (graft->nr_parent != parents)
300                         return error_func(&commit->object, FSCK_ERROR, "graft objects missing");
301         } else {
302                 struct commit_list *p = commit->parents;
303                 while (p && parents) {
304                         p = p->next;
305                         parents--;
306                 }
307                 if (p || parents)
308                         return error_func(&commit->object, FSCK_ERROR, "parent objects missing");
309         }
310         if (memcmp(buffer, "author ", 7))
311                 return error_func(&commit->object, FSCK_ERROR, "invalid format - expected 'author' line");
312         buffer += 7;
313         err = fsck_ident(&buffer, &commit->object, error_func);
314         if (err)
315                 return err;
316         if (memcmp(buffer, "committer ", strlen("committer ")))
317                 return error_func(&commit->object, FSCK_ERROR, "invalid format - expected 'committer' line");
318         buffer += strlen("committer ");
319         err = fsck_ident(&buffer, &commit->object, error_func);
320         if (err)
321                 return err;
322         if (!commit->tree)
323                 return error_func(&commit->object, FSCK_ERROR, "could not load commit's tree %s", sha1_to_hex(tree_sha1));
324
325         return 0;
326 }
327
328 static int fsck_tag(struct tag *tag, fsck_error error_func)
329 {
330         struct object *tagged = tag->tagged;
331
332         if (!tagged)
333                 return error_func(&tag->object, FSCK_ERROR, "could not load tagged object");
334         return 0;
335 }
336
337 int fsck_object(struct object *obj, int strict, fsck_error error_func)
338 {
339         if (!obj)
340                 return error_func(obj, FSCK_ERROR, "no valid object to fsck");
341
342         if (obj->type == OBJ_BLOB)
343                 return 0;
344         if (obj->type == OBJ_TREE)
345                 return fsck_tree((struct tree *) obj, strict, error_func);
346         if (obj->type == OBJ_COMMIT)
347                 return fsck_commit((struct commit *) obj, error_func);
348         if (obj->type == OBJ_TAG)
349                 return fsck_tag((struct tag *) obj, error_func);
350
351         return error_func(obj, FSCK_ERROR, "unknown type '%d' (internal fsck error)",
352                           obj->type);
353 }
354
355 int fsck_error_function(struct object *obj, int type, const char *fmt, ...)
356 {
357         va_list ap;
358         struct strbuf sb = STRBUF_INIT;
359
360         strbuf_addf(&sb, "object %s:", sha1_to_hex(obj->sha1));
361
362         va_start(ap, fmt);
363         strbuf_vaddf(&sb, fmt, ap);
364         va_end(ap);
365
366         error("%s", sb.buf);
367         strbuf_release(&sb);
368         return 1;
369 }