/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

Merge from bzr.dev, resolving conflicts.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/testament.py
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
59
59
* the testament uses unix line-endings (\n)
60
60
"""
61
61
 
62
 
from __future__ import absolute_import
63
 
 
64
62
# XXX: At the moment, clients trust that the graph described in a weave
65
63
# 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
 
64
# fix is when verifying a revision to make sure that every file mentioned 
67
65
# in the revision has compatible ancestry links.
68
66
 
69
67
# TODO: perhaps write timestamp in a more readable form
72
70
# revisions can be serialized.
73
71
 
74
72
from copy import copy
 
73
from sha import sha
75
74
 
76
 
from .osutils import (
77
 
    contains_whitespace,
78
 
    contains_linebreaks,
79
 
    sha_strings,
80
 
    )
81
 
from .sixish import text_type
82
 
from .tree import Tree
 
75
from bzrlib.osutils import contains_whitespace, contains_linebreaks
83
76
 
84
77
 
85
78
class Testament(object):
86
79
    """Reduced summary of a revision.
87
80
 
88
 
    Testaments can be
 
81
    Testaments can be 
89
82
 
90
83
      - produced from a revision
91
84
      - written to a stream
94
87
    """
95
88
 
96
89
    long_header = 'bazaar-ng testament version 1\n'
97
 
    short_header = b'bazaar-ng testament short form 1\n'
98
 
    include_root = False
 
90
    short_header = 'bazaar-ng testament short form 1\n'
99
91
 
100
92
    @classmethod
101
93
    def from_revision(cls, repository, revision_id):
102
 
        """Produce a new testament from a historical revision."""
 
94
        """Produce a new testament from a historical revision"""
103
95
        rev = repository.get_revision(revision_id)
104
 
        tree = repository.revision_tree(revision_id)
105
 
        return cls(rev, tree)
106
 
 
107
 
    @classmethod
108
 
    def from_revision_tree(cls, tree):
109
 
        """Produce a new testament from a revision tree."""
110
 
        rev = tree._repository.get_revision(tree.get_revision_id())
111
 
        return cls(rev, tree)
112
 
 
113
 
    def __init__(self, rev, tree):
114
 
        """Create a new testament for rev using tree."""
 
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."""
115
101
        self.revision_id = rev.revision_id
116
102
        self.committer = rev.committer
117
103
        self.timezone = rev.timezone or 0
118
104
        self.timestamp = rev.timestamp
119
105
        self.message = rev.message
120
106
        self.parent_ids = rev.parent_ids[:]
121
 
        if not isinstance(tree, Tree):
122
 
            raise TypeError("As of bzr 2.4 Testament.__init__() takes a "
123
 
                "Revision and a Tree.")
124
 
        self.tree = tree
 
107
        self.inventory = inventory
125
108
        self.revprops = copy(rev.properties)
126
 
        if contains_whitespace(self.revision_id):
127
 
            raise ValueError(self.revision_id)
128
 
        if contains_linebreaks(self.committer):
129
 
            raise ValueError(self.committer)
 
109
        assert not contains_whitespace(self.revision_id)
 
110
        assert not contains_linebreaks(self.committer)
130
111
 
131
112
    def as_text_lines(self):
132
113
        """Yield text form as a sequence of lines.
144
125
        # inventory length contains the root, which is not shown here
145
126
        a('parents:\n')
146
127
        for parent_id in sorted(self.parent_ids):
147
 
            if contains_whitespace(parent_id):
148
 
                raise ValueError(parent_id)
 
128
            assert not contains_whitespace(parent_id)
149
129
            a('  %s\n' % parent_id)
150
130
        a('message:\n')
151
131
        for l in self.message.splitlines():
154
134
        for path, ie in self._get_entries():
155
135
            a(self._entry_to_line(path, ie))
156
136
        r.extend(self._revprops_to_lines())
 
137
        if __debug__:
 
138
            for l in r:
 
139
                assert isinstance(l, basestring), \
 
140
                    '%r of type %s is not a plain string' % (l, type(l))
157
141
        return [line.encode('utf-8') for line in r]
158
142
 
159
143
    def _get_entries(self):
160
 
        return ((path, ie) for (path, versioned, kind, file_id, ie) in
161
 
                self.tree.list_files(include_root=self.include_root))
 
144
        entries = self.inventory.iter_entries()
 
145
        entries.next()
 
146
        return entries
162
147
 
163
148
    def _escape_path(self, path):
164
 
        if contains_linebreaks(path):
165
 
            raise ValueError(path)
166
 
        if not isinstance(path, text_type):
167
 
            # TODO(jelmer): Clean this up for pad.lv/1696545
168
 
            path = path.decode('ascii')
169
 
        return path.replace(u'\\', u'/').replace(u' ', u'\\ ')
 
149
        assert not contains_linebreaks(path)
 
150
        return unicode(path.replace('\\', '/').replace(' ', '\ '))
170
151
 
171
152
    def _entry_to_line(self, path, ie):
172
153
        """Turn an inventory entry into a testament line"""
173
 
        if contains_whitespace(ie.file_id):
174
 
            raise ValueError(ie.file_id)
 
154
        assert not contains_whitespace(ie.file_id)
 
155
 
175
156
        content = ''
176
157
        content_spacer=''
177
158
        if ie.kind == 'file':
178
159
            # TODO: avoid switching on kind
179
 
            if not ie.text_sha1:
180
 
                raise AssertionError()
 
160
            assert ie.text_sha1
181
161
            content = ie.text_sha1
182
162
            content_spacer = ' '
183
163
        elif ie.kind == 'symlink':
184
 
            if not ie.symlink_target:
185
 
                raise AssertionError()
 
164
            assert ie.symlink_target
186
165
            content = self._escape_path(ie.symlink_target)
187
166
            content_spacer = ' '
188
167
 
192
171
        return l
193
172
 
194
173
    def as_text(self):
195
 
        return b''.join(self.as_text_lines())
 
174
        return ''.join(self.as_text_lines())
196
175
 
197
176
    def as_short_text(self):
198
177
        """Return short digest-based testament."""
199
 
        return (self.short_header +
200
 
                b'revision-id: %s\n'
201
 
                b'sha1: %s\n'
 
178
        return (self.short_header + 
 
179
                'revision-id: %s\n'
 
180
                'sha1: %s\n'
202
181
                % (self.revision_id, self.as_sha1()))
203
182
 
204
183
    def _revprops_to_lines(self):
207
186
            return []
208
187
        r = ['properties:\n']
209
188
        for name, value in sorted(self.revprops.items()):
210
 
            if contains_whitespace(name):
211
 
                raise ValueError(name)
 
189
            assert isinstance(name, str)
 
190
            assert not contains_whitespace(name)
212
191
            r.append('  %s:\n' % name)
213
192
            for line in value.splitlines():
214
193
                r.append(u'    %s\n' % line)
215
194
        return r
216
195
 
217
196
    def as_sha1(self):
218
 
        return sha_strings(self.as_text_lines())
 
197
        s = sha()
 
198
        map(s.update, self.as_text_lines())
 
199
        return s.hexdigest()
219
200
 
220
201
 
221
202
class StrictTestament(Testament):
223
204
 
224
205
    long_header = 'bazaar-ng testament version 2.1\n'
225
206
    short_header = 'bazaar-ng testament short form 2.1\n'
226
 
    include_root = False
227
207
    def _entry_to_line(self, path, ie):
228
208
        l = Testament._entry_to_line(self, path, ie)[:-1]
229
 
        l += ' ' + ie.revision.decode('ascii')
 
209
        l += ' ' + ie.revision
230
210
        l += {True: ' yes\n', False: ' no\n'}[ie.executable]
231
211
        return l
232
212
 
233
213
 
234
214
class StrictTestament3(StrictTestament):
235
215
    """This testament format is for use as a checksum in bundle format 0.9+
236
 
 
 
216
    
237
217
    It differs from StrictTestament by including data about the tree root.
238
218
    """
239
219
 
240
220
    long_header = 'bazaar testament version 3 strict\n'
241
221
    short_header = 'bazaar testament short form 3 strict\n'
242
 
    include_root = True
 
222
    def _get_entries(self):
 
223
        return self.inventory.iter_entries()
243
224
 
244
225
    def _escape_path(self, path):
245
 
        if contains_linebreaks(path):
246
 
            raise ValueError(path)
247
 
        if not isinstance(path, text_type):
248
 
            # TODO(jelmer): Clean this up for pad.lv/1696545
249
 
            path = path.decode('ascii')
250
 
        if path == u'':
251
 
            path = u'.'
252
 
        return path.replace(u'\\', u'/').replace(u' ', u'\\ ')
 
226
        assert not contains_linebreaks(path)
 
227
        if path == '':
 
228
            path = '.'
 
229
        return unicode(path.replace('\\', '/').replace(' ', '\ '))