/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/testament.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

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 sha import sha
74
73
 
75
 
from bzrlib.osutils import contains_whitespace, contains_linebreaks
 
74
from bzrlib.osutils import (
 
75
    contains_whitespace,
 
76
    contains_linebreaks,
 
77
    sha,
 
78
    )
76
79
 
77
80
 
78
81
class Testament(object):
79
82
    """Reduced summary of a revision.
80
83
 
81
 
    Testaments can be 
 
84
    Testaments can be
82
85
 
83
86
      - produced from a revision
84
87
      - written to a stream
98
101
 
99
102
    def __init__(self, rev, inventory):
100
103
        """Create a new testament for rev using inventory."""
101
 
        self.revision_id = str(rev.revision_id)
 
104
        self.revision_id = rev.revision_id
102
105
        self.committer = rev.committer
103
106
        self.timezone = rev.timezone or 0
104
107
        self.timestamp = rev.timestamp
106
109
        self.parent_ids = rev.parent_ids[:]
107
110
        self.inventory = inventory
108
111
        self.revprops = copy(rev.properties)
109
 
        assert not contains_whitespace(self.revision_id)
110
 
        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)
111
116
 
112
117
    def as_text_lines(self):
113
118
        """Yield text form as a sequence of lines.
125
130
        # inventory length contains the root, which is not shown here
126
131
        a('parents:\n')
127
132
        for parent_id in sorted(self.parent_ids):
128
 
            assert not contains_whitespace(parent_id)
 
133
            if contains_whitespace(parent_id):
 
134
                raise ValueError(parent_id)
129
135
            a('  %s\n' % parent_id)
130
136
        a('message:\n')
131
137
        for l in self.message.splitlines():
132
138
            a('  %s\n' % l)
133
139
        a('inventory:\n')
134
 
        entries = self.inventory.iter_entries()
135
 
        entries.next()
136
 
        for path, ie in entries:
 
140
        for path, ie in self._get_entries():
137
141
            a(self._entry_to_line(path, ie))
138
142
        r.extend(self._revprops_to_lines())
139
 
        if __debug__:
140
 
            for l in r:
141
 
                assert isinstance(l, basestring), \
142
 
                    '%r of type %s is not a plain string' % (l, type(l))
143
143
        return [line.encode('utf-8') for line in r]
144
144
 
 
145
    def _get_entries(self):
 
146
        entries = self.inventory.iter_entries()
 
147
        entries.next()
 
148
        return entries
 
149
 
145
150
    def _escape_path(self, path):
146
 
        assert not contains_linebreaks(path)
 
151
        if contains_linebreaks(path):
 
152
            raise ValueError(path)
147
153
        return unicode(path.replace('\\', '/').replace(' ', '\ '))
148
154
 
149
155
    def _entry_to_line(self, path, ie):
150
156
        """Turn an inventory entry into a testament line"""
151
 
        assert not contains_whitespace(ie.file_id)
152
 
 
 
157
        if contains_whitespace(ie.file_id):
 
158
            raise ValueError(ie.file_id)
153
159
        content = ''
154
160
        content_spacer=''
155
161
        if ie.kind == 'file':
156
162
            # TODO: avoid switching on kind
157
 
            assert ie.text_sha1
 
163
            if not ie.text_sha1:
 
164
                raise AssertionError()
158
165
            content = ie.text_sha1
159
166
            content_spacer = ' '
160
167
        elif ie.kind == 'symlink':
161
 
            assert ie.symlink_target
 
168
            if not ie.symlink_target:
 
169
                raise AssertionError()
162
170
            content = self._escape_path(ie.symlink_target)
163
171
            content_spacer = ' '
164
172
 
165
173
        l = u'  %s %s %s%s%s\n' % (ie.kind, self._escape_path(path),
166
 
                                   unicode(ie.file_id),
 
174
                                   ie.file_id.decode('utf8'),
167
175
                                   content_spacer, content)
168
176
        return l
169
177
 
172
180
 
173
181
    def as_short_text(self):
174
182
        """Return short digest-based testament."""
175
 
        return (self.short_header + 
 
183
        return (self.short_header +
176
184
                'revision-id: %s\n'
177
185
                'sha1: %s\n'
178
186
                % (self.revision_id, self.as_sha1()))
183
191
            return []
184
192
        r = ['properties:\n']
185
193
        for name, value in sorted(self.revprops.items()):
186
 
            assert isinstance(name, str)
187
 
            assert not contains_whitespace(name)
 
194
            if contains_whitespace(name):
 
195
                raise ValueError(name)
188
196
            r.append('  %s:\n' % name)
189
197
            for line in value.splitlines():
190
198
                r.append(u'    %s\n' % line)
197
205
 
198
206
 
199
207
class StrictTestament(Testament):
200
 
    """This testament format is for use as a checksum in changesets"""
 
208
    """This testament format is for use as a checksum in bundle format 0.8"""
201
209
 
202
210
    long_header = 'bazaar-ng testament version 2.1\n'
203
211
    short_header = 'bazaar-ng testament short form 2.1\n'
206
214
        l += ' ' + ie.revision
207
215
        l += {True: ' yes\n', False: ' no\n'}[ie.executable]
208
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(' ', '\ '))