1
# Copyright (C) 2004, 2005 by Martin Pool
2
# Copyright (C) 2005 by Canonical Ltd
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21
def check(branch, update=False):
22
"""Run consistency checks on a branch.
24
If update is True, for revisions missing certain information
25
(right now this is inventory_sha1 and revision_sha1),
26
update them to include the appropriate values.
30
from bzrlib.trace import mutter
31
from bzrlib.errors import BzrCheckError
32
from bzrlib.osutils import fingerprint_file
33
from bzrlib.progress import ProgressBar
37
pb = ProgressBar(show_spinner=True)
41
missing_inventory_sha_cnt = 0
43
history = branch.revision_history()
45
revcount = len(history)
49
updated_revisions = []
51
# Set to True in the case that the previous revision entry
52
# was updated, since this will affect future revision entries
53
updated_previous_revision = False
57
pb.update('checking revision', revno, revcount)
58
mutter(' revision {%s}' % rid)
59
rev = branch.get_revision(rid)
60
if rev.revision_id != rid:
61
raise BzrCheckError('wrong internal revision id in revision {%s}' % rid)
62
if rev.precursor != last_ptr:
63
raise BzrCheckError('mismatched precursor in revision {%s}' % rid)
65
if rid in checked_revs:
66
raise BzrCheckError('repeated revision {%s}' % rid)
67
checked_revs[rid] = True
69
## TODO: Check all the required fields are present on the revision.
72
if rev.inventory_sha1:
73
#mutter(' checking inventory hash {%s}' % rev.inventory_sha1)
74
inv_sha1 = branch.get_inventory_sha1(rev.inventory_id)
75
if inv_sha1 != rev.inventory_sha1:
76
raise BzrCheckError('Inventory sha1 hash doesn\'t match'
77
' value in revision {%s}' % rid)
79
inv_sha1 = branch.get_inventory_sha1(rev.inventory_id)
80
rev.inventory_sha1 = inv_sha1
83
missing_inventory_sha_cnt += 1
84
mutter("no inventory_sha1 on revision {%s}" % rid)
87
if rev.precursor_sha1:
88
precursor_sha1 = branch.get_revision_sha1(rev.precursor)
89
if updated_previous_revision:
90
# we don't expect the hashes to match, because
91
# we had to modify the previous revision_history entry.
92
rev.precursor_sha1 = precursor_sha1
95
#mutter(' checking precursor hash {%s}' % rev.precursor_sha1)
96
if rev.precursor_sha1 != precursor_sha1:
97
raise BzrCheckError('Precursor sha1 hash doesn\'t match'
98
' value in revision {%s}' % rid)
100
precursor_sha1 = branch.get_revision_sha1(rev.precursor)
101
rev.precursor_sha1 = precursor_sha1
105
updated_previous_revision = True
106
# We had to update this revision entries hashes
107
# Now we need to write out a new value
108
# This is a little bit invasive, since we are *rewriting* a
109
# revision entry. I'm not supremely happy about it, but
110
# there should be *some* way of making old entries have
111
# the full meta information.
112
import tempfile, os, errno
113
rev_tmp = tempfile.TemporaryFile()
114
rev.write_xml(rev_tmp)
117
tmpfd, tmp_path = tempfile.mkstemp(prefix=rid, suffix='.gz',
118
dir=branch.controlfilename('revision-store'))
120
def special_rename(p1, p2):
121
if sys.platform == 'win32':
125
if e.errno != e.ENOENT:
130
# TODO: We may need to handle the case where the old revision
131
# entry was not compressed (and thus did not end with .gz)
133
# Remove the old revision entry out of the way
134
rev_path = branch.controlfilename(['revision-store', rid+'.gz'])
135
special_rename(rev_path, tmp_path)
136
branch.revision_store.add(rev_tmp, rid) # Add the new one
137
os.remove(tmp_path) # Remove the old name
138
mutter(' Updated revision entry {%s}' % rid)
140
# On any exception, restore the old entry
141
special_rename(tmp_path, rev_path)
144
updated_revisions.append(rid)
146
updated_previous_revision = False
148
inv = branch.get_inventory(rev.inventory_id)
152
## p('revision %d/%d file ids' % (revno, revcount))
154
if file_id in seen_ids:
155
raise BzrCheckError('duplicated file_id {%s} '
156
'in inventory for revision {%s}'
158
seen_ids[file_id] = True
169
if ie.parent_id != None:
170
if ie.parent_id not in seen_ids:
171
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
172
% (ie.parent_id, rid))
174
if ie.kind == 'file':
175
if ie.text_id in checked_texts:
176
fp = checked_texts[ie.text_id]
178
if not ie.text_id in branch.text_store:
179
raise BzrCheckError('text {%s} not in text_store' % ie.text_id)
181
tf = branch.text_store[ie.text_id]
182
fp = fingerprint_file(tf)
183
checked_texts[ie.text_id] = fp
185
if ie.text_size != fp['size']:
186
raise BzrCheckError('text {%s} wrong size' % ie.text_id)
187
if ie.text_sha1 != fp['sha1']:
188
raise BzrCheckError('text {%s} wrong sha1' % ie.text_id)
189
elif ie.kind == 'directory':
190
if ie.text_sha1 != None or ie.text_size != None or ie.text_id != None:
191
raise BzrCheckError('directory {%s} has text in revision {%s}'
195
for path, ie in inv.iter_entries():
196
if path in seen_names:
197
raise BzrCheckError('duplicated path %r '
198
'in inventory for revision {%s}'
200
seen_names[path] = True
205
print 'checked %d revisions, %d file texts' % (revcount, len(checked_texts))
206
if updated_revisions:
207
print '%d revisions updated to current format' % len(updated_revisions)
208
if missing_inventory_sha_cnt:
209
print '%d revisions are missing inventory_sha1' % missing_inventory_sha_cnt
210
print ' (use bzr check --update to fix them)'
added
removed
bzrlib/check.py
