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
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
59
59
* the testament uses unix line-endings (\n)
62
from __future__ import absolute_import
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.
67
69
# TODO: perhaps write timestamp in a more readable form
70
72
# revisions can be serialized.
72
74
from copy import copy
73
from cStringIO import StringIO
77
from bzrlib.osutils import contains_whitespace, contains_linebreaks
76
from bzrlib.osutils import (
81
from bzrlib.tree import Tree
79
84
class Testament(object):
80
85
"""Reduced summary of a revision.
84
89
- produced from a revision
86
91
- loaded from a stream
87
92
- compared to a revision
91
def from_revision(cls, branch, revision_id):
92
"""Produce a new testament from a historical revision"""
93
rev = branch.get_revision(revision_id)
94
inventory = branch.get_inventory(revision_id)
95
return cls(rev, inventory)
97
def __init__(self, rev, inventory):
98
"""Create a new testament for rev using inventory."""
99
self.revision_id = str(rev.revision_id)
95
long_header = 'bazaar-ng testament version 1\n'
96
short_header = 'bazaar-ng testament short form 1\n'
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)
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)
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.")
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)
110
130
def as_text_lines(self):
111
131
"""Yield text form as a sequence of lines.
124
143
# inventory length contains the root, which is not shown here
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)
130
150
for l in self.message.splitlines():
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())
138
assert isinstance(l, basestring), \
139
'%r of type %s is not a plain string' % (l, type(l))
156
return [line.encode('utf-8') for line in r]
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))
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(' ', '\ '))
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)
152
173
if ie.kind == 'file':
153
174
# TODO: avoid switching on kind
155
l += ' ' + ie.text_sha1
176
raise AssertionError()
177
content = ie.text_sha1
156
179
elif ie.kind == 'symlink':
157
assert ie.symlink_target
158
l += ' ' + self._escape_path(ie.symlink_target)
180
if not ie.symlink_target:
181
raise AssertionError()
182
content = self._escape_path(ie.symlink_target)
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)
162
190
def as_text(self):
165
193
def as_short_text(self):
166
194
"""Return short digest-based testament."""
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'
172
% (self.revision_id, s.hexdigest()))
198
% (self.revision_id, self.as_sha1()))
174
200
def _revprops_to_lines(self):
175
201
"""Pack up revision properties."""
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)
214
return sha_strings(self.as_text_lines())
217
class StrictTestament(Testament):
218
"""This testament format is for use as a checksum in bundle format 0.8"""
220
long_header = 'bazaar-ng testament version 2.1\n'
221
short_header = 'bazaar-ng testament short form 2.1\n'
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]
230
class StrictTestament3(StrictTestament):
231
"""This testament format is for use as a checksum in bundle format 0.9+
233
It differs from StrictTestament by including data about the tree root.
236
long_header = 'bazaar testament version 3 strict\n'
237
short_header = 'bazaar testament short form 3 strict\n'
240
def _escape_path(self, path):
241
if contains_linebreaks(path):
242
raise ValueError(path)
245
return unicode(path.replace('\\', '/').replace(' ', '\ '))