/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/testament.py

  • Committer: Robert Collins
  • Date: 2005-10-16 22:04:54 UTC
  • mto: This revision was merged to the branch mainline in revision 1458.
  • Revision ID: robertc@lifelesslap.robertcollins.net-20051016220454-0418f1911d37b342
move branch._relpath into osutils as relpath

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