← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/testament.py

  • Committer: Patch Queue Manager
  • Date: 2011-09-22 14:12:18 UTC
  • mfrom: (6155.3.1 jam)
  • Revision ID: pqm@pqm.ubuntu.com-20110922141218-86s4uu6nqvourw4f
(jameinel) Cleanup comments bzrlib/smart/__init__.py (John A Meinel)

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