~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/check.py

  • Committer: Martin Pool
  • Date: 2005-06-11 01:55:29 UTC
  • Revision ID: mbp@sourcefrog.net-20050611015529-26a9c988699de34f
- help formatting fix from ndim

Show diffs side-by-side

added added

removed removed

Lines of Context:
17
17
 
18
18
 
19
19
 
20
 
######################################################################
21
 
# consistency checks
22
 
 
23
 
import sys
24
 
from sets import Set
25
 
 
26
 
from trace import mutter
27
 
from errors import bailout
28
 
import osutils
29
 
 
30
 
def check(branch, progress=True):
 
20
 
 
21
def check(branch, update=False):
 
22
    """Run consistency checks on a branch.
 
23
 
 
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.
 
27
    """
 
28
    import sys
 
29
 
 
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
 
34
    
31
35
    out = sys.stdout
32
36
 
33
 
    # TODO: factor out
34
 
    if not (hasattr(out, 'isatty') and out.isatty()):
35
 
        progress=False
36
 
 
37
 
    if progress:
38
 
        def p(m):
39
 
            mutter('checking ' + m)
40
 
            out.write('\rchecking: %-50.50s' % m)
41
 
            out.flush()
42
 
    else:
43
 
        def p(m):
44
 
            mutter('checking ' + m)
45
 
 
46
 
    p('history of %r' % branch.base)
 
37
    pb = ProgressBar(show_spinner=True)
47
38
    last_ptr = None
48
 
    checked_revs = Set()
 
39
    checked_revs = {}
 
40
 
 
41
    missing_inventory_sha_cnt = 0
49
42
    
50
43
    history = branch.revision_history()
51
44
    revno = 0
52
45
    revcount = len(history)
53
46
 
54
47
    checked_texts = {}
 
48
 
 
49
    updated_revisions = []
 
50
 
 
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
55
54
    
56
55
    for rid in history:
57
56
        revno += 1
58
 
        p('revision %d/%d' % (revno, revcount))
 
57
        pb.update('checking revision', revno, revcount)
59
58
        mutter('    revision {%s}' % rid)
60
59
        rev = branch.get_revision(rid)
61
60
        if rev.revision_id != rid:
62
 
            bailout('wrong internal revision id in revision {%s}' % rid)
 
61
            raise BzrCheckError('wrong internal revision id in revision {%s}' % rid)
63
62
        if rev.precursor != last_ptr:
64
 
            bailout('mismatched precursor in revision {%s}' % rid)
 
63
            raise BzrCheckError('mismatched precursor in revision {%s}' % rid)
65
64
        last_ptr = rid
66
65
        if rid in checked_revs:
67
 
            bailout('repeated revision {%s}' % rid)
68
 
        checked_revs.add(rid)
 
66
            raise BzrCheckError('repeated revision {%s}' % rid)
 
67
        checked_revs[rid] = True
69
68
 
70
69
        ## TODO: Check all the required fields are present on the revision.
71
70
 
 
71
        updated = False
 
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)
 
78
        elif update:
 
79
            inv_sha1 = branch.get_inventory_sha1(rev.inventory_id)
 
80
            rev.inventory_sha1 = inv_sha1
 
81
            updated = True
 
82
        else:
 
83
            missing_inventory_sha_cnt += 1
 
84
            mutter("no inventory_sha1 on revision {%s}" % rid)
 
85
 
 
86
        if rev.precursor:
 
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
 
93
                    updated = True
 
94
                else:
 
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)
 
99
            elif update:
 
100
                precursor_sha1 = branch.get_revision_sha1(rev.precursor)
 
101
                rev.precursor_sha1 = precursor_sha1
 
102
                updated = True
 
103
 
 
104
        if updated:
 
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)
 
115
            rev_tmp.seek(0)
 
116
 
 
117
            tmpfd, tmp_path = tempfile.mkstemp(prefix=rid, suffix='.gz',
 
118
                dir=branch.controlfilename('revision-store'))
 
119
            os.close(tmpfd)
 
120
            def special_rename(p1, p2):
 
121
                if sys.platform == 'win32':
 
122
                    try:
 
123
                        os.remove(p2)
 
124
                    except OSError, e:
 
125
                        if e.errno != e.ENOENT:
 
126
                            raise
 
127
                os.rename(p1, p2)
 
128
 
 
129
            try:
 
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)
 
132
 
 
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)
 
139
            except:
 
140
                # On any exception, restore the old entry
 
141
                special_rename(tmp_path, rev_path)
 
142
                raise
 
143
            rev_tmp.close()
 
144
            updated_revisions.append(rid)
 
145
        else:
 
146
            updated_previous_revision = False
 
147
            
72
148
        inv = branch.get_inventory(rev.inventory_id)
73
 
        seen_ids = Set()
74
 
        seen_names = Set()
 
149
        seen_ids = {}
 
150
        seen_names = {}
75
151
 
76
 
        p('revision %d/%d file ids' % (revno, revcount))
 
152
        ## p('revision %d/%d file ids' % (revno, revcount))
77
153
        for file_id in inv:
78
154
            if file_id in seen_ids:
79
 
                bailout('duplicated file_id {%s} in inventory for revision {%s}'
80
 
                        % (file_id, rid))
81
 
            seen_ids.add(file_id)
 
155
                raise BzrCheckError('duplicated file_id {%s} '
 
156
                                    'in inventory for revision {%s}'
 
157
                                    % (file_id, rid))
 
158
            seen_ids[file_id] = True
82
159
 
83
160
        i = 0
84
161
        len_inv = len(inv)
85
162
        for file_id in inv:
86
163
            i += 1
87
 
            if (i % 100) == 0:
88
 
                p('revision %d/%d file text %d/%d' % (revno, revcount, i, len_inv))
 
164
            if i & 31 == 0:
 
165
                pb.tick()
89
166
 
90
167
            ie = inv[file_id]
91
168
 
92
169
            if ie.parent_id != None:
93
170
                if ie.parent_id not in seen_ids:
94
 
                    bailout('missing parent {%s} in inventory for revision {%s}'
 
171
                    raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
95
172
                            % (ie.parent_id, rid))
96
173
 
97
174
            if ie.kind == 'file':
99
176
                    fp = checked_texts[ie.text_id]
100
177
                else:
101
178
                    if not ie.text_id in branch.text_store:
102
 
                        bailout('text {%s} not in text_store' % ie.text_id)
 
179
                        raise BzrCheckError('text {%s} not in text_store' % ie.text_id)
103
180
 
104
181
                    tf = branch.text_store[ie.text_id]
105
 
                    fp = osutils.fingerprint_file(tf)
 
182
                    fp = fingerprint_file(tf)
106
183
                    checked_texts[ie.text_id] = fp
107
184
 
108
185
                if ie.text_size != fp['size']:
109
 
                    bailout('text {%s} wrong size' % ie.text_id)
 
186
                    raise BzrCheckError('text {%s} wrong size' % ie.text_id)
110
187
                if ie.text_sha1 != fp['sha1']:
111
 
                    bailout('text {%s} wrong sha1' % ie.text_id)
 
188
                    raise BzrCheckError('text {%s} wrong sha1' % ie.text_id)
112
189
            elif ie.kind == 'directory':
113
190
                if ie.text_sha1 != None or ie.text_size != None or ie.text_id != None:
114
 
                    bailout('directory {%s} has text in revision {%s}'
 
191
                    raise BzrCheckError('directory {%s} has text in revision {%s}'
115
192
                            % (file_id, rid))
116
193
 
117
 
        p('revision %d/%d file paths' % (revno, revcount))
 
194
        pb.tick()
118
195
        for path, ie in inv.iter_entries():
119
196
            if path in seen_names:
120
 
                bailout('duplicated path %r in inventory for revision {%s}' % (path, revid))
121
 
            seen_names.add(path)
122
 
 
123
 
 
124
 
    p('done')
125
 
    if progress:
126
 
        print 
 
197
                raise BzrCheckError('duplicated path %r '
 
198
                                    'in inventory for revision {%s}'
 
199
                                    % (path, revid))
 
200
            seen_names[path] = True
 
201
 
 
202
 
 
203
    pb.clear()
 
204
 
127
205
    print 'checked %d revisions, %d file texts' % (revcount, len(checked_texts))
128
 
 
 
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)'