← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/testament.py

  • Committer: John Arbash Meinel
  • Date: 2009-06-04 17:12:29 UTC
  • mto: This revision was merged to the branch mainline in revision 4410.
  • Revision ID: john@arbash-meinel.com-20090604171229-kbgfatt63y3u3uh1
Some small tweaks to decoding strings (avoid passing over the length 2x)

Down to 1.1s (from 1.4s) for decoding all of bzr.dev.
Also, favor decoding strings and then lists in _decode_object, since that is the
frequency we have those types inside Revisions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/testament.py
1
 
# Copyright (C) 2005 by Canonical Ltd
 
1
# Copyright (C) 2005 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Testament - a summary of a revision for signing.
18
18
 
19
 
A testament can be defined as "something that serves as tangible 
 
19
A testament can be defined as "something that serves as tangible
20
20
proof or evidence."  In bzr we use them to allow people to certify
21
 
particular revisions as authentic.  
 
21
particular revisions as authentic.
22
22
 
23
23
The goal is that if two revisions are semantically equal, then they will
24
24
have a byte-for-byte equal testament.  We can define different versions of
61
61
 
62
62
# XXX: At the moment, clients trust that the graph described in a weave
63
63
# is accurate, but that's not covered by the testament.  Perhaps the best
64
 
# fix is when verifying a revision to make sure that every file mentioned 
 
64
# fix is when verifying a revision to make sure that every file mentioned
65
65
# in the revision has compatible ancestry links.
66
66
 
67
67
# TODO: perhaps write timestamp in a more readable form
70
70
# revisions can be serialized.
71
71
 
72
72
from copy import copy
73
 
from cStringIO import StringIO
74
 
import string
75
 
from sha import sha
76
 
 
77
 
from bzrlib.osutils import contains_whitespace, contains_linebreaks
 
73
 
 
74
from bzrlib.osutils import (
 
75
    contains_whitespace,
 
76
    contains_linebreaks,
 
77
    sha,
 
78
    )
 
79
 
78
80
 
79
81
class Testament(object):
80
82
    """Reduced summary of a revision.
81
83
 
82
 
    Testaments can be 
 
84
    Testaments can be
83
85
 
84
86
      - produced from a revision
85
 
      - writen to a stream
 
87
      - written to a stream
86
88
      - loaded from a stream
87
89
      - compared to a revision
88
90
    """
89
91
 
 
92
    long_header = 'bazaar-ng testament version 1\n'
 
93
    short_header = 'bazaar-ng testament short form 1\n'
 
94
 
90
95
    @classmethod
91
 
    def from_revision(cls, branch, revision_id):
 
96
    def from_revision(cls, repository, revision_id):
92
97
        """Produce a new testament from a historical revision"""
93
 
        rev = branch.get_revision(revision_id)
94
 
        inventory = branch.get_inventory(revision_id)
 
98
        rev = repository.get_revision(revision_id)
 
99
        inventory = repository.get_inventory(revision_id)
95
100
        return cls(rev, inventory)
96
101
 
97
102
    def __init__(self, rev, inventory):
98
103
        """Create a new testament for rev using inventory."""
99
 
        self.revision_id = str(rev.revision_id)
 
104
        self.revision_id = rev.revision_id
100
105
        self.committer = rev.committer
101
106
        self.timezone = rev.timezone or 0
102
107
        self.timestamp = rev.timestamp
104
109
        self.parent_ids = rev.parent_ids[:]
105
110
        self.inventory = inventory
106
111
        self.revprops = copy(rev.properties)
107
 
        assert not contains_whitespace(self.revision_id)
108
 
        assert not contains_linebreaks(self.committer)
 
112
        if contains_whitespace(self.revision_id):
 
113
            raise ValueError(self.revision_id)
 
114
        if contains_linebreaks(self.committer):
 
115
            raise ValueError(self.committer)
109
116
 
110
117
    def as_text_lines(self):
111
118
        """Yield text form as a sequence of lines.
114
121
        hashed in that encoding.
115
122
        """
116
123
        r = []
117
 
        def a(s):
118
 
            r.append(s)
119
 
        a('bazaar-ng testament version 1\n')
 
124
        a = r.append
 
125
        a(self.long_header)
120
126
        a('revision-id: %s\n' % self.revision_id)
121
127
        a('committer: %s\n' % self.committer)
122
128
        a('timestamp: %d\n' % self.timestamp)
124
130
        # inventory length contains the root, which is not shown here
125
131
        a('parents:\n')
126
132
        for parent_id in sorted(self.parent_ids):
127
 
            assert not contains_whitespace(parent_id)
 
133
            if contains_whitespace(parent_id):
 
134
                raise ValueError(parent_id)
128
135
            a('  %s\n' % parent_id)
129
136
        a('message:\n')
130
137
        for l in self.message.splitlines():
131
138
            a('  %s\n' % l)
132
139
        a('inventory:\n')
133
 
        for path, ie in self.inventory.iter_entries():
 
140
        for path, ie in self._get_entries():
134
141
            a(self._entry_to_line(path, ie))
135
142
        r.extend(self._revprops_to_lines())
136
 
        if __debug__:
137
 
            for l in r:
138
 
                assert isinstance(l, basestring), \
139
 
                    '%r of type %s is not a plain string' % (l, type(l))
140
 
        return r
 
143
        return [line.encode('utf-8') for line in r]
 
144
 
 
145
    def _get_entries(self):
 
146
        entries = self.inventory.iter_entries()
 
147
        entries.next()
 
148
        return entries
141
149
 
142
150
    def _escape_path(self, path):
143
 
        assert not contains_linebreaks(path)
144
 
        return unicode(path.replace('\\', '/').replace(' ', '\ ')).encode('utf-8')
 
151
        if contains_linebreaks(path):
 
152
            raise ValueError(path)
 
153
        return unicode(path.replace('\\', '/').replace(' ', '\ '))
145
154
 
146
155
    def _entry_to_line(self, path, ie):
147
156
        """Turn an inventory entry into a testament line"""
148
 
        l = '  ' + str(ie.kind)
149
 
        l += ' ' + self._escape_path(path)
150
 
        assert not contains_whitespace(ie.file_id)
151
 
        l += ' ' + unicode(ie.file_id).encode('utf-8')
 
157
        if contains_whitespace(ie.file_id):
 
158
            raise ValueError(ie.file_id)
 
159
        content = ''
 
160
        content_spacer=''
152
161
        if ie.kind == 'file':
153
162
            # TODO: avoid switching on kind
154
 
            assert ie.text_sha1
155
 
            l += ' ' + ie.text_sha1
 
163
            if not ie.text_sha1:
 
164
                raise AssertionError()
 
165
            content = ie.text_sha1
 
166
            content_spacer = ' '
156
167
        elif ie.kind == 'symlink':
157
 
            assert ie.symlink_target
158
 
            l += ' ' + self._escape_path(ie.symlink_target)
159
 
        l += '\n'
 
168
            if not ie.symlink_target:
 
169
                raise AssertionError()
 
170
            content = self._escape_path(ie.symlink_target)
 
171
            content_spacer = ' '
 
172
 
 
173
        l = u'  %s %s %s%s%s\n' % (ie.kind, self._escape_path(path),
 
174
                                   ie.file_id.decode('utf8'),
 
175
                                   content_spacer, content)
160
176
        return l
161
177
 
162
178
    def as_text(self):
164
180
 
165
181
    def as_short_text(self):
166
182
        """Return short digest-based testament."""
167
 
        s = sha()
168
 
        map(s.update, self.as_text_lines())
169
 
        return ('bazaar-ng testament short form 1\n'
 
183
        return (self.short_header +
170
184
                'revision-id: %s\n'
171
185
                'sha1: %s\n'
172
 
                % (self.revision_id, s.hexdigest()))
 
186
                % (self.revision_id, self.as_sha1()))
173
187
 
174
188
    def _revprops_to_lines(self):
175
189
        """Pack up revision properties."""
177
191
            return []
178
192
        r = ['properties:\n']
179
193
        for name, value in sorted(self.revprops.items()):
180
 
            assert isinstance(name, str)
181
 
            assert not contains_whitespace(name)
 
194
            if contains_whitespace(name):
 
195
                raise ValueError(name)
182
196
            r.append('  %s:\n' % name)
183
197
            for line in value.splitlines():
184
 
                if not isinstance(line, str):
185
 
                    line = line.encode('utf-8')
186
 
                r.append('    %s\n' % line)
 
198
                r.append(u'    %s\n' % line)
187
199
        return r
 
200
 
 
201
    def as_sha1(self):
 
202
        s = sha()
 
203
        map(s.update, self.as_text_lines())
 
204
        return s.hexdigest()
 
205
 
 
206
 
 
207
class StrictTestament(Testament):
 
208
    """This testament format is for use as a checksum in bundle format 0.8"""
 
209
 
 
210
    long_header = 'bazaar-ng testament version 2.1\n'
 
211
    short_header = 'bazaar-ng testament short form 2.1\n'
 
212
    def _entry_to_line(self, path, ie):
 
213
        l = Testament._entry_to_line(self, path, ie)[:-1]
 
214
        l += ' ' + ie.revision
 
215
        l += {True: ' yes\n', False: ' no\n'}[ie.executable]
 
216
        return l
 
217
 
 
218
 
 
219
class StrictTestament3(StrictTestament):
 
220
    """This testament format is for use as a checksum in bundle format 0.9+
 
221
 
 
222
    It differs from StrictTestament by including data about the tree root.
 
223
    """
 
224
 
 
225
    long_header = 'bazaar testament version 3 strict\n'
 
226
    short_header = 'bazaar testament short form 3 strict\n'
 
227
    def _get_entries(self):
 
228
        return self.inventory.iter_entries()
 
229
 
 
230
    def _escape_path(self, path):
 
231
        if contains_linebreaks(path):
 
232
            raise ValueError(path)
 
233
        if path == '':
 
234
            path = '.'
 
235
        return unicode(path.replace('\\', '/').replace(' ', '\ '))