← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/testament.py

  • Committer: Martin Pool
  • Date: 2009-08-20 04:53:23 UTC
  • mto: This revision was merged to the branch mainline in revision 4632.
  • Revision ID: mbp@sourcefrog.net-20090820045323-4hsicfa87pdq3l29
Correction to xdg_cache_dir and add a simple test

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