← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/testament.py

  • Committer: Vincent Ladeuil
  • Date: 2013-08-09 15:09:23 UTC
  • mto: This revision was merged to the branch mainline in revision 6587.
  • Revision ID: v.ladeuil+lp@free.fr-20130809150923-y71dusyorep0hbkt
Fix various typos in docstrings. Rename 'buffer' to 'buf' since it's now a python builtin function.

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
59
59
* the testament uses unix line-endings (\n)
60
60
"""
61
61
 
 
62
from __future__ import absolute_import
 
63
 
62
64
# XXX: At the moment, clients trust that the graph described in a weave
63
65
# 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 
 
66
# fix is when verifying a revision to make sure that every file mentioned
65
67
# in the revision has compatible ancestry links.
66
68
 
67
69
# TODO: perhaps write timestamp in a more readable form
70
72
# revisions can be serialized.
71
73
 
72
74
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
 
75
 
 
76
from bzrlib.osutils import (
 
77
    contains_whitespace,
 
78
    contains_linebreaks,
 
79
    sha_strings,
 
80
    )
 
81
from bzrlib.tree import Tree
 
82
 
78
83
 
79
84
class Testament(object):
80
85
    """Reduced summary of a revision.
81
86
 
82
 
    Testaments can be 
 
87
    Testaments can be
83
88
 
84
89
      - produced from a revision
85
90
      - written to a stream
87
92
      - compared to a revision
88
93
    """
89
94
 
 
95
    long_header = 'bazaar-ng testament version 1\n'
 
96
    short_header = 'bazaar-ng testament short form 1\n'
 
97
    include_root = False
 
98
 
90
99
    @classmethod
91
100
    def from_revision(cls, repository, revision_id):
92
 
        """Produce a new testament from a historical revision"""
 
101
        """Produce a new testament from a historical revision."""
93
102
        rev = repository.get_revision(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)
 
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
100
115
        self.committer = rev.committer
101
116
        self.timezone = rev.timezone or 0
102
117
        self.timestamp = rev.timestamp
103
118
        self.message = rev.message
104
119
        self.parent_ids = rev.parent_ids[:]
105
 
        self.inventory = inventory
 
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
106
124
        self.revprops = copy(rev.properties)
107
 
        assert not contains_whitespace(self.revision_id)
108
 
        assert not contains_linebreaks(self.committer)
 
125
        if contains_whitespace(self.revision_id):
 
126
            raise ValueError(self.revision_id)
 
127
        if contains_linebreaks(self.committer):
 
128
            raise ValueError(self.committer)
109
129
 
110
130
    def as_text_lines(self):
111
131
        """Yield text form as a sequence of lines.
114
134
        hashed in that encoding.
115
135
        """
116
136
        r = []
117
 
        def a(s):
118
 
            r.append(s)
119
 
        a('bazaar-ng testament version 1\n')
 
137
        a = r.append
 
138
        a(self.long_header)
120
139
        a('revision-id: %s\n' % self.revision_id)
121
140
        a('committer: %s\n' % self.committer)
122
141
        a('timestamp: %d\n' % self.timestamp)
124
143
        # inventory length contains the root, which is not shown here
125
144
        a('parents:\n')
126
145
        for parent_id in sorted(self.parent_ids):
127
 
            assert not contains_whitespace(parent_id)
 
146
            if contains_whitespace(parent_id):
 
147
                raise ValueError(parent_id)
128
148
            a('  %s\n' % parent_id)
129
149
        a('message:\n')
130
150
        for l in self.message.splitlines():
131
151
            a('  %s\n' % l)
132
152
        a('inventory:\n')
133
 
        for path, ie in self.inventory.iter_entries():
 
153
        for path, ie in self._get_entries():
134
154
            a(self._entry_to_line(path, ie))
135
155
        r.extend(self._revprops_to_lines())
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
 
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))
141
161
 
142
162
    def _escape_path(self, path):
143
 
        assert not contains_linebreaks(path)
144
 
        return unicode(path.replace('\\', '/').replace(' ', '\ ')).encode('utf-8')
 
163
        if contains_linebreaks(path):
 
164
            raise ValueError(path)
 
165
        return unicode(path.replace('\\', '/').replace(' ', '\ '))
145
166
 
146
167
    def _entry_to_line(self, path, ie):
147
168
        """Turn an inventory entry into a testament line"""
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')
 
169
        if contains_whitespace(ie.file_id):
 
170
            raise ValueError(ie.file_id)
 
171
        content = ''
 
172
        content_spacer=''
152
173
        if ie.kind == 'file':
153
174
            # TODO: avoid switching on kind
154
 
            assert ie.text_sha1
155
 
            l += ' ' + ie.text_sha1
 
175
            if not ie.text_sha1:
 
176
                raise AssertionError()
 
177
            content = ie.text_sha1
 
178
            content_spacer = ' '
156
179
        elif ie.kind == 'symlink':
157
 
            assert ie.symlink_target
158
 
            l += ' ' + self._escape_path(ie.symlink_target)
159
 
        l += '\n'
 
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)
160
188
        return l
161
189
 
162
190
    def as_text(self):
164
192
 
165
193
    def as_short_text(self):
166
194
        """Return short digest-based testament."""
167
 
        s = sha()
168
 
        map(s.update, self.as_text_lines())
169
 
        return ('bazaar-ng testament short form 1\n'
 
195
        return (self.short_header +
170
196
                'revision-id: %s\n'
171
197
                'sha1: %s\n'
172
 
                % (self.revision_id, s.hexdigest()))
 
198
                % (self.revision_id, self.as_sha1()))
173
199
 
174
200
    def _revprops_to_lines(self):
175
201
        """Pack up revision properties."""
177
203
            return []
178
204
        r = ['properties:\n']
179
205
        for name, value in sorted(self.revprops.items()):
180
 
            assert isinstance(name, str)
181
 
            assert not contains_whitespace(name)
 
206
            if contains_whitespace(name):
 
207
                raise ValueError(name)
182
208
            r.append('  %s:\n' % name)
183
209
            for line in value.splitlines():
184
 
                if not isinstance(line, str):
185
 
                    line = line.encode('utf-8')
186
 
                r.append('    %s\n' % line)
 
210
                r.append(u'    %s\n' % line)
187
211
        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(' ', '\ '))