← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/testament.py

  • Committer: Aaron Bentley
  • Date: 2005-07-26 14:06:11 UTC
  • mto: (1092.1.41) (1185.3.4) (974.1.47)
  • mto: This revision was merged to the branch mainline in revision 982.
  • Revision ID: abentley@panoramicfeedback.com-20050726140611-403e366f3c79c1f1
Fixed python invocation

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/testament.py
1
 
# Copyright (C) 2005 Canonical Ltd
2
 
#
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
#
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
#
13
 
# You should have received a copy of the GNU General Public License
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
16
 
 
17
 
"""Testament - a summary of a revision for signing.
18
 
 
19
 
A testament can be defined as "something that serves as tangible
20
 
proof or evidence."  In bzr we use them to allow people to certify
21
 
particular revisions as authentic.
22
 
 
23
 
The goal is that if two revisions are semantically equal, then they will
24
 
have a byte-for-byte equal testament.  We can define different versions of
25
 
"semantically equal" by using different testament classes; e.g. one that
26
 
includes or ignores file-ids.
27
 
 
28
 
We sign a testament rather than the revision XML itself for several reasons.
29
 
The most important is that the form in which the revision is stored
30
 
internally is designed for that purpose, and contains information which need
31
 
not be attested to by the signer.  For example the inventory contains the
32
 
last-changed revision for a file, but this is not necessarily something the
33
 
user cares to sign.
34
 
 
35
 
Having unnecessary fields signed makes the signatures brittle when the same
36
 
revision is stored in different branches or when the format is upgraded.
37
 
 
38
 
Handling upgrades is another motivation for using testaments separate from
39
 
the stored revision.  We would like to be able to compare a signature
40
 
generated from an old-format tree to newer tree, or vice versa.  This could
41
 
be done by comparing the revisions but that makes it unclear about exactly
42
 
what is being compared or not.
43
 
 
44
 
Different signing keys might indicate different levels of trust; we can in
45
 
the future extend this to allow signatures indicating not just that a
46
 
particular version is authentic but that it has other properties.
47
 
 
48
 
The signature can be applied to either the full testament or to just a
49
 
hash of it.
50
 
 
51
 
Testament format 1
52
 
~~~~~~~~~~~~~~~~~~
53
 
 
54
 
* timestamps are given as integers to avoid rounding errors
55
 
* parents given in lexicographical order
56
 
* indented-text form similar to log; intended to be human readable
57
 
* paths are given with forward slashes
58
 
* files are named using paths for ease of comparison/debugging
59
 
* the testament uses unix line-endings (\n)
60
 
"""
61
 
 
62
 
from __future__ import absolute_import
63
 
 
64
 
# XXX: At the moment, clients trust that the graph described in a weave
65
 
# 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
67
 
# in the revision has compatible ancestry links.
68
 
 
69
 
# TODO: perhaps write timestamp in a more readable form
70
 
 
71
 
# TODO: Perhaps these should just be different formats in which inventories/
72
 
# revisions can be serialized.
73
 
 
74
 
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
 
 
83
 
 
84
 
class Testament(object):
85
 
    """Reduced summary of a revision.
86
 
 
87
 
    Testaments can be
88
 
 
89
 
      - produced from a revision
90
 
      - written to a stream
91
 
      - loaded from a stream
92
 
      - compared to a revision
93
 
    """
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
 
 
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
115
 
        self.committer = rev.committer
116
 
        self.timezone = rev.timezone or 0
117
 
        self.timestamp = rev.timestamp
118
 
        self.message = rev.message
119
 
        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
124
 
        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)
129
 
 
130
 
    def as_text_lines(self):
131
 
        """Yield text form as a sequence of lines.
132
 
 
133
 
        The result is returned in utf-8, because it should be signed or
134
 
        hashed in that encoding.
135
 
        """
136
 
        r = []
137
 
        a = r.append
138
 
        a(self.long_header)
139
 
        a('revision-id: %s\n' % self.revision_id)
140
 
        a('committer: %s\n' % self.committer)
141
 
        a('timestamp: %d\n' % self.timestamp)
142
 
        a('timezone: %d\n' % self.timezone)
143
 
        # inventory length contains the root, which is not shown here
144
 
        a('parents:\n')
145
 
        for parent_id in sorted(self.parent_ids):
146
 
            if contains_whitespace(parent_id):
147
 
                raise ValueError(parent_id)
148
 
            a('  %s\n' % parent_id)
149
 
        a('message:\n')
150
 
        for l in self.message.splitlines():
151
 
            a('  %s\n' % l)
152
 
        a('inventory:\n')
153
 
        for path, ie in self._get_entries():
154
 
            a(self._entry_to_line(path, ie))
155
 
        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))
161
 
 
162
 
    def _escape_path(self, path):
163
 
        if contains_linebreaks(path):
164
 
            raise ValueError(path)
165
 
        return unicode(path.replace('\\', '/').replace(' ', '\ '))
166
 
 
167
 
    def _entry_to_line(self, path, ie):
168
 
        """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=''
173
 
        if ie.kind == 'file':
174
 
            # TODO: avoid switching on kind
175
 
            if not ie.text_sha1:
176
 
                raise AssertionError()
177
 
            content = ie.text_sha1
178
 
            content_spacer = ' '
179
 
        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)
188
 
        return l
189
 
 
190
 
    def as_text(self):
191
 
        return ''.join(self.as_text_lines())
192
 
 
193
 
    def as_short_text(self):
194
 
        """Return short digest-based testament."""
195
 
        return (self.short_header +
196
 
                'revision-id: %s\n'
197
 
                'sha1: %s\n'
198
 
                % (self.revision_id, self.as_sha1()))
199
 
 
200
 
    def _revprops_to_lines(self):
201
 
        """Pack up revision properties."""
202
 
        if not self.revprops:
203
 
            return []
204
 
        r = ['properties:\n']
205
 
        for name, value in sorted(self.revprops.items()):
206
 
            if contains_whitespace(name):
207
 
                raise ValueError(name)
208
 
            r.append('  %s:\n' % name)
209
 
            for line in value.splitlines():
210
 
                r.append(u'    %s\n' % line)
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(' ', '\ '))