← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/testament.py

  • Committer: John Arbash Meinel
  • Date: 2006-09-20 14:51:03 UTC
  • mfrom: (0.8.23 version_info)
  • mto: This revision was merged to the branch mainline in revision 2028.
  • Revision ID: john@arbash-meinel.com-20060920145103-02725c6d6c886040
[merge] version-info plugin, and cleanup for layout in bzr

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