← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/testament.py

  • Committer: Robert Collins
  • Date: 2007-11-18 19:56:39 UTC
  • mfrom: (3006 +trunk)
  • mto: This revision was merged to the branch mainline in revision 3038.
  • Revision ID: robertc@robertcollins.net-20071118195639-m6zf3d5ljjw88kkn
Merge bzr.dev.

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 bzrlib.osutils import (
77
 
    contains_whitespace,
78
 
    contains_linebreaks,
79
 
    sha_strings,
80
 
    )
81
 
from bzrlib.tree import Tree
 
75
from bzrlib.osutils import contains_whitespace, contains_linebreaks
82
76
 
83
77
 
84
78
class Testament(object):
85
79
    """Reduced summary of a revision.
86
80
 
87
 
    Testaments can be
 
81
    Testaments can be 
88
82
 
89
83
      - produced from a revision
90
84
      - written to a stream
94
88
 
95
89
    long_header = 'bazaar-ng testament version 1\n'
96
90
    short_header = 'bazaar-ng testament short form 1\n'
97
 
    include_root = False
98
91
 
99
92
    @classmethod
100
93
    def from_revision(cls, repository, revision_id):
101
 
        """Produce a new testament from a historical revision."""
 
94
        """Produce a new testament from a historical revision"""
102
95
        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."""
 
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."""
114
101
        self.revision_id = rev.revision_id
115
102
        self.committer = rev.committer
116
103
        self.timezone = rev.timezone or 0
117
104
        self.timestamp = rev.timestamp
118
105
        self.message = rev.message
119
106
        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
 
107
        self.inventory = inventory
124
108
        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)
 
109
        assert not contains_whitespace(self.revision_id)
 
110
        assert not contains_linebreaks(self.committer)
129
111
 
130
112
    def as_text_lines(self):
131
113
        """Yield text form as a sequence of lines.
143
125
        # inventory length contains the root, which is not shown here
144
126
        a('parents:\n')
145
127
        for parent_id in sorted(self.parent_ids):
146
 
            if contains_whitespace(parent_id):
147
 
                raise ValueError(parent_id)
 
128
            assert not contains_whitespace(parent_id)
148
129
            a('  %s\n' % parent_id)
149
130
        a('message:\n')
150
131
        for l in self.message.splitlines():
153
134
        for path, ie in self._get_entries():
154
135
            a(self._entry_to_line(path, ie))
155
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))
156
141
        return [line.encode('utf-8') for line in r]
157
142
 
158
143
    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))
 
144
        entries = self.inventory.iter_entries()
 
145
        entries.next()
 
146
        return entries
161
147
 
162
148
    def _escape_path(self, path):
163
 
        if contains_linebreaks(path):
164
 
            raise ValueError(path)
 
149
        assert not contains_linebreaks(path)
165
150
        return unicode(path.replace('\\', '/').replace(' ', '\ '))
166
151
 
167
152
    def _entry_to_line(self, path, ie):
168
153
        """Turn an inventory entry into a testament line"""
169
 
        if contains_whitespace(ie.file_id):
170
 
            raise ValueError(ie.file_id)
 
154
        assert not contains_whitespace(ie.file_id)
 
155
 
171
156
        content = ''
172
157
        content_spacer=''
173
158
        if ie.kind == 'file':
174
159
            # TODO: avoid switching on kind
175
 
            if not ie.text_sha1:
176
 
                raise AssertionError()
 
160
            assert ie.text_sha1
177
161
            content = ie.text_sha1
178
162
            content_spacer = ' '
179
163
        elif ie.kind == 'symlink':
180
 
            if not ie.symlink_target:
181
 
                raise AssertionError()
 
164
            assert ie.symlink_target
182
165
            content = self._escape_path(ie.symlink_target)
183
166
            content_spacer = ' '
184
167
 
192
175
 
193
176
    def as_short_text(self):
194
177
        """Return short digest-based testament."""
195
 
        return (self.short_header +
 
178
        return (self.short_header + 
196
179
                'revision-id: %s\n'
197
180
                'sha1: %s\n'
198
181
                % (self.revision_id, self.as_sha1()))
203
186
            return []
204
187
        r = ['properties:\n']
205
188
        for name, value in sorted(self.revprops.items()):
206
 
            if contains_whitespace(name):
207
 
                raise ValueError(name)
 
189
            assert isinstance(name, str)
 
190
            assert not contains_whitespace(name)
208
191
            r.append('  %s:\n' % name)
209
192
            for line in value.splitlines():
210
193
                r.append(u'    %s\n' % line)
211
194
        return r
212
195
 
213
196
    def as_sha1(self):
214
 
        return sha_strings(self.as_text_lines())
 
197
        s = sha()
 
198
        map(s.update, self.as_text_lines())
 
199
        return s.hexdigest()
215
200
 
216
201
 
217
202
class StrictTestament(Testament):
219
204
 
220
205
    long_header = 'bazaar-ng testament version 2.1\n'
221
206
    short_header = 'bazaar-ng testament short form 2.1\n'
222
 
    include_root = False
223
207
    def _entry_to_line(self, path, ie):
224
208
        l = Testament._entry_to_line(self, path, ie)[:-1]
225
209
        l += ' ' + ie.revision
229
213
 
230
214
class StrictTestament3(StrictTestament):
231
215
    """This testament format is for use as a checksum in bundle format 0.9+
232
 
 
 
216
    
233
217
    It differs from StrictTestament by including data about the tree root.
234
218
    """
235
219
 
236
220
    long_header = 'bazaar testament version 3 strict\n'
237
221
    short_header = 'bazaar testament short form 3 strict\n'
238
 
    include_root = True
 
222
    def _get_entries(self):
 
223
        return self.inventory.iter_entries()
239
224
 
240
225
    def _escape_path(self, path):
241
 
        if contains_linebreaks(path):
242
 
            raise ValueError(path)
 
226
        assert not contains_linebreaks(path)
243
227
        if path == '':
244
228
            path = '.'
245
229
        return unicode(path.replace('\\', '/').replace(' ', '\ '))