1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005 by Canonical Ltd
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
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
17
17
"""Testament - a summary of a revision for signing.
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.
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
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.
67
67
# TODO: perhaps write timestamp in a more readable form
70
70
# revisions can be serialized.
72
72
from copy import copy
74
from bzrlib.osutils import (
75
from bzrlib.osutils import contains_whitespace, contains_linebreaks
81
78
class Testament(object):
82
79
"""Reduced summary of a revision.
86
83
- produced from a revision
87
84
- written to a stream
102
99
def __init__(self, rev, inventory):
103
100
"""Create a new testament for rev using inventory."""
104
self.revision_id = rev.revision_id
101
self.revision_id = str(rev.revision_id)
105
102
self.committer = rev.committer
106
103
self.timezone = rev.timezone or 0
107
104
self.timestamp = rev.timestamp
109
106
self.parent_ids = rev.parent_ids[:]
110
107
self.inventory = inventory
111
108
self.revprops = copy(rev.properties)
112
if contains_whitespace(self.revision_id):
113
raise ValueError(self.revision_id)
114
if contains_linebreaks(self.committer):
115
raise ValueError(self.committer)
109
assert not contains_whitespace(self.revision_id)
110
assert not contains_linebreaks(self.committer)
117
112
def as_text_lines(self):
118
113
"""Yield text form as a sequence of lines.
130
125
# inventory length contains the root, which is not shown here
132
127
for parent_id in sorted(self.parent_ids):
133
if contains_whitespace(parent_id):
134
raise ValueError(parent_id)
128
assert not contains_whitespace(parent_id)
135
129
a(' %s\n' % parent_id)
137
131
for l in self.message.splitlines():
139
133
a('inventory:\n')
140
for path, ie in self._get_entries():
134
entries = self.inventory.iter_entries()
136
for path, ie in entries:
141
137
a(self._entry_to_line(path, ie))
142
138
r.extend(self._revprops_to_lines())
141
assert isinstance(l, basestring), \
142
'%r of type %s is not a plain string' % (l, type(l))
143
143
return [line.encode('utf-8') for line in r]
145
def _get_entries(self):
146
entries = self.inventory.iter_entries()
150
145
def _escape_path(self, path):
151
if contains_linebreaks(path):
152
raise ValueError(path)
146
assert not contains_linebreaks(path)
153
147
return unicode(path.replace('\\', '/').replace(' ', '\ '))
155
149
def _entry_to_line(self, path, ie):
156
150
"""Turn an inventory entry into a testament line"""
157
if contains_whitespace(ie.file_id):
158
raise ValueError(ie.file_id)
151
assert not contains_whitespace(ie.file_id)
160
154
content_spacer=''
161
155
if ie.kind == 'file':
162
156
# TODO: avoid switching on kind
164
raise AssertionError()
165
158
content = ie.text_sha1
166
159
content_spacer = ' '
167
160
elif ie.kind == 'symlink':
168
if not ie.symlink_target:
169
raise AssertionError()
161
assert ie.symlink_target
170
162
content = self._escape_path(ie.symlink_target)
171
163
content_spacer = ' '
173
165
l = u' %s %s %s%s%s\n' % (ie.kind, self._escape_path(path),
174
ie.file_id.decode('utf8'),
175
167
content_spacer, content)
181
173
def as_short_text(self):
182
174
"""Return short digest-based testament."""
183
return (self.short_header +
175
return (self.short_header +
184
176
'revision-id: %s\n'
186
178
% (self.revision_id, self.as_sha1()))
192
184
r = ['properties:\n']
193
185
for name, value in sorted(self.revprops.items()):
194
if contains_whitespace(name):
195
raise ValueError(name)
186
assert isinstance(name, str)
187
assert not contains_whitespace(name)
196
188
r.append(' %s:\n' % name)
197
189
for line in value.splitlines():
198
190
r.append(u' %s\n' % line)
207
199
class StrictTestament(Testament):
208
"""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"""
210
202
long_header = 'bazaar-ng testament version 2.1\n'
211
203
short_header = 'bazaar-ng testament short form 2.1\n'
214
206
l += ' ' + ie.revision
215
207
l += {True: ' yes\n', False: ' no\n'}[ie.executable]
219
class StrictTestament3(StrictTestament):
220
"""This testament format is for use as a checksum in bundle format 0.9+
222
It differs from StrictTestament by including data about the tree root.
225
long_header = 'bazaar testament version 3 strict\n'
226
short_header = 'bazaar testament short form 3 strict\n'
227
def _get_entries(self):
228
return self.inventory.iter_entries()
230
def _escape_path(self, path):
231
if contains_linebreaks(path):
232
raise ValueError(path)
235
return unicode(path.replace('\\', '/').replace(' ', '\ '))
added
removed
bzrlib/testament.py
