← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/testament.py

[merge] much integrated work from robert and john

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 bzrlib.osutils import (
77
 
    contains_whitespace,
78
 
    contains_linebreaks,
79
 
    sha_strings,
80
 
    )
81
 
from bzrlib.tree import Tree
82
 
 
 
73
from cStringIO import StringIO
 
74
import string
 
75
from sha import sha
 
76
 
 
77
from bzrlib.osutils import contains_whitespace, contains_linebreaks
83
78
 
84
79
class Testament(object):
85
80
    """Reduced summary of a revision.
86
81
 
87
 
    Testaments can be
 
82
    Testaments can be 
88
83
 
89
84
      - produced from a revision
90
85
      - written to a stream
92
87
      - compared to a revision
93
88
    """
94
89
 
95
 
    long_header = 'bazaar-ng testament version 1\n'
96
 
    short_header = 'bazaar-ng testament short form 1\n'
97
 
    include_root = False
98
 
 
99
 
    @classmethod
100
 
    def from_revision(cls, repository, revision_id):
101
 
        """Produce a new testament from a historical revision."""
102
 
        rev = repository.get_revision(revision_id)
103
 
        tree = repository.revision_tree(revision_id)
104
 
        return cls(rev, tree)
105
 
 
106
 
    @classmethod
107
 
    def from_revision_tree(cls, tree):
108
 
        """Produce a new testament from a revision tree."""
109
 
        rev = tree._repository.get_revision(tree.get_revision_id())
110
 
        return cls(rev, tree)
111
 
 
112
 
    def __init__(self, rev, tree):
113
 
        """Create a new testament for rev using tree."""
114
 
        self.revision_id = rev.revision_id
 
90
    @classmethod
 
91
    def from_revision(cls, branch, revision_id):
 
92
        """Produce a new testament from a historical revision"""
 
93
        rev = branch.get_revision(revision_id)
 
94
        inventory = branch.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)
115
100
        self.committer = rev.committer
116
101
        self.timezone = rev.timezone or 0
117
102
        self.timestamp = rev.timestamp
118
103
        self.message = rev.message
119
104
        self.parent_ids = rev.parent_ids[:]
120
 
        if not isinstance(tree, Tree):
121
 
            raise TypeError("As of bzr 2.4 Testament.__init__() takes a "
122
 
                "Revision and a Tree.")
123
 
        self.tree = tree
 
105
        self.inventory = inventory
124
106
        self.revprops = copy(rev.properties)
125
 
        if contains_whitespace(self.revision_id):
126
 
            raise ValueError(self.revision_id)
127
 
        if contains_linebreaks(self.committer):
128
 
            raise ValueError(self.committer)
 
107
        assert not contains_whitespace(self.revision_id)
 
108
        assert not contains_linebreaks(self.committer)
129
109
 
130
110
    def as_text_lines(self):
131
111
        """Yield text form as a sequence of lines.
134
114
        hashed in that encoding.
135
115
        """
136
116
        r = []
137
 
        a = r.append
138
 
        a(self.long_header)
 
117
        def a(s):
 
118
            r.append(s)
 
119
        a('bazaar-ng testament version 1\n')
139
120
        a('revision-id: %s\n' % self.revision_id)
140
121
        a('committer: %s\n' % self.committer)
141
122
        a('timestamp: %d\n' % self.timestamp)
143
124
        # inventory length contains the root, which is not shown here
144
125
        a('parents:\n')
145
126
        for parent_id in sorted(self.parent_ids):
146
 
            if contains_whitespace(parent_id):
147
 
                raise ValueError(parent_id)
 
127
            assert not contains_whitespace(parent_id)
148
128
            a('  %s\n' % parent_id)
149
129
        a('message:\n')
150
130
        for l in self.message.splitlines():
151
131
            a('  %s\n' % l)
152
132
        a('inventory:\n')
153
 
        for path, ie in self._get_entries():
 
133
        for path, ie in self.inventory.iter_entries():
154
134
            a(self._entry_to_line(path, ie))
155
135
        r.extend(self._revprops_to_lines())
156
 
        return [line.encode('utf-8') for line in r]
157
 
 
158
 
    def _get_entries(self):
159
 
        return ((path, ie) for (path, versioned, kind, file_id, ie) in
160
 
                self.tree.list_files(include_root=self.include_root))
 
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
161
141
 
162
142
    def _escape_path(self, path):
163
 
        if contains_linebreaks(path):
164
 
            raise ValueError(path)
165
 
        return unicode(path.replace('\\', '/').replace(' ', '\ '))
 
143
        assert not contains_linebreaks(path)
 
144
        return unicode(path.replace('\\', '/').replace(' ', '\ ')).encode('utf-8')
166
145
 
167
146
    def _entry_to_line(self, path, ie):
168
147
        """Turn an inventory entry into a testament line"""
169
 
        if contains_whitespace(ie.file_id):
170
 
            raise ValueError(ie.file_id)
171
 
        content = ''
172
 
        content_spacer=''
 
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')
173
152
        if ie.kind == 'file':
174
153
            # TODO: avoid switching on kind
175
 
            if not ie.text_sha1:
176
 
                raise AssertionError()
177
 
            content = ie.text_sha1
178
 
            content_spacer = ' '
 
154
            assert ie.text_sha1
 
155
            l += ' ' + ie.text_sha1
179
156
        elif ie.kind == 'symlink':
180
 
            if not ie.symlink_target:
181
 
                raise AssertionError()
182
 
            content = self._escape_path(ie.symlink_target)
183
 
            content_spacer = ' '
184
 
 
185
 
        l = u'  %s %s %s%s%s\n' % (ie.kind, self._escape_path(path),
186
 
                                   ie.file_id.decode('utf8'),
187
 
                                   content_spacer, content)
 
157
            assert ie.symlink_target
 
158
            l += ' ' + self._escape_path(ie.symlink_target)
 
159
        l += '\n'
188
160
        return l
189
161
 
190
162
    def as_text(self):
192
164
 
193
165
    def as_short_text(self):
194
166
        """Return short digest-based testament."""
195
 
        return (self.short_header +
 
167
        s = sha()
 
168
        map(s.update, self.as_text_lines())
 
169
        return ('bazaar-ng testament short form 1\n'
196
170
                'revision-id: %s\n'
197
171
                'sha1: %s\n'
198
 
                % (self.revision_id, self.as_sha1()))
 
172
                % (self.revision_id, s.hexdigest()))
199
173
 
200
174
    def _revprops_to_lines(self):
201
175
        """Pack up revision properties."""
203
177
            return []
204
178
        r = ['properties:\n']
205
179
        for name, value in sorted(self.revprops.items()):
206
 
            if contains_whitespace(name):
207
 
                raise ValueError(name)
 
180
            assert isinstance(name, str)
 
181
            assert not contains_whitespace(name)
208
182
            r.append('  %s:\n' % name)
209
183
            for line in value.splitlines():
210
 
                r.append(u'    %s\n' % line)
 
184
                if not isinstance(line, str):
 
185
                    line = line.encode('utf-8')
 
186
                r.append('    %s\n' % line)
211
187
        return r
212
 
 
213
 
    def as_sha1(self):
214
 
        return sha_strings(self.as_text_lines())
215
 
 
216
 
 
217
 
class StrictTestament(Testament):
218
 
    """This testament format is for use as a checksum in bundle format 0.8"""
219
 
 
220
 
    long_header = 'bazaar-ng testament version 2.1\n'
221
 
    short_header = 'bazaar-ng testament short form 2.1\n'
222
 
    include_root = False
223
 
    def _entry_to_line(self, path, ie):
224
 
        l = Testament._entry_to_line(self, path, ie)[:-1]
225
 
        l += ' ' + ie.revision
226
 
        l += {True: ' yes\n', False: ' no\n'}[ie.executable]
227
 
        return l
228
 
 
229
 
 
230
 
class StrictTestament3(StrictTestament):
231
 
    """This testament format is for use as a checksum in bundle format 0.9+
232
 
 
233
 
    It differs from StrictTestament by including data about the tree root.
234
 
    """
235
 
 
236
 
    long_header = 'bazaar testament version 3 strict\n'
237
 
    short_header = 'bazaar testament short form 3 strict\n'
238
 
    include_root = True
239
 
 
240
 
    def _escape_path(self, path):
241
 
        if contains_linebreaks(path):
242
 
            raise ValueError(path)
243
 
        if path == '':
244
 
            path = '.'
245
 
        return unicode(path.replace('\\', '/').replace(' ', '\ '))