/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: Canonical.com Patch Queue Manager
  • Date: 2006-04-24 10:31:28 UTC
  • mfrom: (1684.1.2 bzr.mbp.integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060424103128-a637f56a7c529bad
(mbp) tutorial improvements

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/testament.py
1
 
# Copyright (C) 2005 Canonical Ltd
 
1
# Copyright (C) 2005 by 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
59
59
* the testament uses unix line-endings (\n)
60
60
"""
61
61
 
62
 
from __future__ import absolute_import
63
 
 
64
62
# XXX: At the moment, clients trust that the graph described in a weave
65
63
# is accurate, but that's not covered by the testament.  Perhaps the best
66
 
# 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 
67
65
# in the revision has compatible ancestry links.
68
66
 
69
67
# TODO: perhaps write timestamp in a more readable form
72
70
# revisions can be serialized.
73
71
 
74
72
from copy import copy
75
 
 
76
 
from ..osutils import (
77
 
    contains_whitespace,
78
 
    contains_linebreaks,
79
 
    sha_strings,
80
 
    )
81
 
from ..sixish import text_type
82
 
from ..tree import Tree
83
 
 
 
73
from cStringIO import StringIO
 
74
import string
 
75
from sha import sha
 
76
 
 
77
from bzrlib.osutils import contains_whitespace, contains_linebreaks
84
78
 
85
79
class Testament(object):
86
80
    """Reduced summary of a revision.
87
81
 
88
 
    Testaments can be
 
82
    Testaments can be 
89
83
 
90
84
      - produced from a revision
91
85
      - written to a stream
93
87
      - compared to a revision
94
88
    """
95
89
 
96
 
    long_header = 'bazaar-ng testament version 1\n'
97
 
    short_header = 'bazaar-ng testament short form 1\n'
98
 
    include_root = False
99
 
 
100
90
    @classmethod
101
91
    def from_revision(cls, repository, revision_id):
102
 
        """Produce a new testament from a historical revision."""
 
92
        """Produce a new testament from a historical revision"""
103
93
        rev = repository.get_revision(revision_id)
104
 
        tree = repository.revision_tree(revision_id)
105
 
        return cls(rev, tree)
106
 
 
107
 
    @classmethod
108
 
    def from_revision_tree(cls, tree):
109
 
        """Produce a new testament from a revision tree."""
110
 
        rev = tree._repository.get_revision(tree.get_revision_id())
111
 
        return cls(rev, tree)
112
 
 
113
 
    def __init__(self, rev, tree):
114
 
        """Create a new testament for rev using tree."""
115
 
        self.revision_id = rev.revision_id
 
94
        inventory = repository.get_inventory(revision_id)
 
95
        return cls(rev, inventory)
 
96
 
 
97
    def __init__(self, rev, inventory):
 
98
        """Create a new testament for rev using inventory."""
 
99
        self.revision_id = str(rev.revision_id)
116
100
        self.committer = rev.committer
117
101
        self.timezone = rev.timezone or 0
118
102
        self.timestamp = rev.timestamp
119
103
        self.message = rev.message
120
104
        self.parent_ids = rev.parent_ids[:]
121
 
        if not isinstance(tree, Tree):
122
 
            raise TypeError("As of bzr 2.4 Testament.__init__() takes a "
123
 
                            "Revision and a Tree.")
124
 
        self.tree = tree
 
105
        self.inventory = inventory
125
106
        self.revprops = copy(rev.properties)
126
 
        if contains_whitespace(self.revision_id):
127
 
            raise ValueError(self.revision_id)
128
 
        if contains_linebreaks(self.committer):
129
 
            raise ValueError(self.committer)
 
107
        assert not contains_whitespace(self.revision_id)
 
108
        assert not contains_linebreaks(self.committer)
130
109
 
131
110
    def as_text_lines(self):
132
111
        """Yield text form as a sequence of lines.
136
115
        """
137
116
        r = []
138
117
        a = r.append
139
 
        a(self.long_header)
140
 
        a('revision-id: %s\n' % self.revision_id.decode('utf-8'))
 
118
        a('bazaar-ng testament version 1\n')
 
119
        a('revision-id: %s\n' % self.revision_id)
141
120
        a('committer: %s\n' % self.committer)
142
121
        a('timestamp: %d\n' % self.timestamp)
143
122
        a('timezone: %d\n' % self.timezone)
144
123
        # inventory length contains the root, which is not shown here
145
124
        a('parents:\n')
146
125
        for parent_id in sorted(self.parent_ids):
147
 
            if contains_whitespace(parent_id):
148
 
                raise ValueError(parent_id)
149
 
            a('  %s\n' % parent_id.decode('utf-8'))
 
126
            assert not contains_whitespace(parent_id)
 
127
            a('  %s\n' % parent_id)
150
128
        a('message:\n')
151
129
        for l in self.message.splitlines():
152
130
            a('  %s\n' % l)
153
131
        a('inventory:\n')
154
 
        for path, ie in self._get_entries():
 
132
        for path, ie in self.inventory.iter_entries():
155
133
            a(self._entry_to_line(path, ie))
156
134
        r.extend(self._revprops_to_lines())
 
135
        if __debug__:
 
136
            for l in r:
 
137
                assert isinstance(l, basestring), \
 
138
                    '%r of type %s is not a plain string' % (l, type(l))
157
139
        return [line.encode('utf-8') for line in r]
158
140
 
159
 
    def _get_entries(self):
160
 
        return ((path, ie) for (path, file_class, kind, ie) in
161
 
                self.tree.list_files(include_root=self.include_root))
162
 
 
163
141
    def _escape_path(self, path):
164
 
        if contains_linebreaks(path):
165
 
            raise ValueError(path)
166
 
        if not isinstance(path, text_type):
167
 
            # TODO(jelmer): Clean this up for pad.lv/1696545
168
 
            path = path.decode('ascii')
169
 
        return path.replace(u'\\', u'/').replace(u' ', u'\\ ')
 
142
        assert not contains_linebreaks(path)
 
143
        return unicode(path.replace('\\', '/').replace(' ', '\ ')).encode('utf-8')
170
144
 
171
145
    def _entry_to_line(self, path, ie):
172
146
        """Turn an inventory entry into a testament line"""
173
 
        if contains_whitespace(ie.file_id):
174
 
            raise ValueError(ie.file_id)
175
 
        content = ''
176
 
        content_spacer = ''
 
147
        l = '  ' + str(ie.kind)
 
148
        l += ' ' + self._escape_path(path)
 
149
        assert not contains_whitespace(ie.file_id)
 
150
        l += ' ' + unicode(ie.file_id).encode('utf-8')
177
151
        if ie.kind == 'file':
178
152
            # TODO: avoid switching on kind
179
 
            if not ie.text_sha1:
180
 
                raise AssertionError()
181
 
            content = ie.text_sha1.decode('ascii')
182
 
            content_spacer = ' '
 
153
            assert ie.text_sha1
 
154
            l += ' ' + ie.text_sha1
183
155
        elif ie.kind == 'symlink':
184
 
            if not ie.symlink_target:
185
 
                raise AssertionError()
186
 
            content = self._escape_path(ie.symlink_target)
187
 
            content_spacer = ' '
188
 
 
189
 
        l = u'  %s %s %s%s%s\n' % (ie.kind, self._escape_path(path),
190
 
                                   ie.file_id.decode('utf8'),
191
 
                                   content_spacer, content)
 
156
            assert ie.symlink_target
 
157
            l += ' ' + self._escape_path(ie.symlink_target)
 
158
        l += '\n'
192
159
        return l
193
160
 
194
161
    def as_text(self):
195
 
        return b''.join(self.as_text_lines())
 
162
        return ''.join(self.as_text_lines())
196
163
 
197
164
    def as_short_text(self):
198
165
        """Return short digest-based testament."""
199
 
        return (self.short_header.encode('ascii') +
200
 
                b'revision-id: %s\n'
201
 
                b'sha1: %s\n'
202
 
                % (self.revision_id, self.as_sha1()))
 
166
        s = sha()
 
167
        map(s.update, self.as_text_lines())
 
168
        return ('bazaar-ng testament short form 1\n'
 
169
                'revision-id: %s\n'
 
170
                'sha1: %s\n'
 
171
                % (self.revision_id, s.hexdigest()))
203
172
 
204
173
    def _revprops_to_lines(self):
205
174
        """Pack up revision properties."""
207
176
            return []
208
177
        r = ['properties:\n']
209
178
        for name, value in sorted(self.revprops.items()):
210
 
            if contains_whitespace(name):
211
 
                raise ValueError(name)
 
179
            assert isinstance(name, str)
 
180
            assert not contains_whitespace(name)
212
181
            r.append('  %s:\n' % name)
213
182
            for line in value.splitlines():
214
 
                r.append(u'    %s\n' % line)
 
183
                if not isinstance(line, str):
 
184
                    line = line.encode('utf-8')
 
185
                r.append('    %s\n' % line)
215
186
        return r
216
 
 
217
 
    def as_sha1(self):
218
 
        return sha_strings(self.as_text_lines())
219
 
 
220
 
 
221
 
class StrictTestament(Testament):
222
 
    """This testament format is for use as a checksum in bundle format 0.8"""
223
 
 
224
 
    long_header = 'bazaar-ng testament version 2.1\n'
225
 
    short_header = 'bazaar-ng testament short form 2.1\n'
226
 
    include_root = False
227
 
 
228
 
    def _entry_to_line(self, path, ie):
229
 
        l = Testament._entry_to_line(self, path, ie)[:-1]
230
 
        l += ' ' + ie.revision.decode('utf-8')
231
 
        l += {True: ' yes\n', False: ' no\n'}[ie.executable]
232
 
        return l
233
 
 
234
 
 
235
 
class StrictTestament3(StrictTestament):
236
 
    """This testament format is for use as a checksum in bundle format 0.9+
237
 
 
238
 
    It differs from StrictTestament by including data about the tree root.
239
 
    """
240
 
 
241
 
    long_header = 'bazaar testament version 3 strict\n'
242
 
    short_header = 'bazaar testament short form 3 strict\n'
243
 
    include_root = True
244
 
 
245
 
    def _escape_path(self, path):
246
 
        if contains_linebreaks(path):
247
 
            raise ValueError(path)
248
 
        if not isinstance(path, text_type):
249
 
            # TODO(jelmer): Clean this up for pad.lv/1696545
250
 
            path = path.decode('ascii')
251
 
        if path == u'':
252
 
            path = u'.'
253
 
        return path.replace(u'\\', u'/').replace(u' ', u'\\ ')