← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bundle/serializer/v08.py

  • Committer: Alexander Belchenko
  • Date: 2006-07-30 16:43:12 UTC
  • mto: (1711.2.111 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1906.
  • Revision ID: bialix@ukr.net-20060730164312-b025fd3ff0cee59e
rename  gpl.txt => COPYING.txt

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/bundle/serializer/v08.py
1
 
# Copyright (C) 2005, 2006, 2009 Canonical Ltd
 
1
# (C) 2005 Canonical Development 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
"""Serializer factory for reading and writing bundles.
18
18
"""
19
19
 
20
20
import os
21
21
 
22
 
from bzrlib import (
23
 
    errors,
24
 
    ui,
25
 
    )
 
22
from bzrlib import errors
26
23
from bzrlib.bundle.serializer import (BundleSerializer,
27
 
                                      _get_bundle_header,
 
24
                                      BUNDLE_HEADER,
 
25
                                      format_highres_date,
 
26
                                      unpack_highres_date,
28
27
                                     )
29
28
from bzrlib.bundle.serializer import binary_diff
30
29
from bzrlib.bundle.bundle_data import (RevisionInfo, BundleInfo, BundleTree)
31
30
from bzrlib.diff import internal_diff
32
31
from bzrlib.osutils import pathjoin
 
32
from bzrlib.progress import DummyProgress
33
33
from bzrlib.revision import NULL_REVISION
 
34
from bzrlib.rio import RioWriter, read_stanzas
 
35
import bzrlib.ui
34
36
from bzrlib.testament import StrictTestament
35
 
from bzrlib.timestamp import (
36
 
    format_highres_date,
37
 
    unpack_highres_date,
38
 
)
39
37
from bzrlib.textfile import text_file
40
38
from bzrlib.trace import mutter
41
39
 
56
54
        else:
57
55
            self.properties = properties
58
56
 
59
 
    def add_utf8_property(self, name, value):
60
 
        """Add a property whose value is currently utf8 to the action."""
61
 
        self.properties.append((name, value.decode('utf8')))
62
 
 
63
57
    def add_property(self, name, value):
64
58
        """Add a property to the action"""
65
59
        self.properties.append((name, value))
100
94
        """
101
95
        return BundleReader(f).info
102
96
 
103
 
    def check_compatible(self):
104
 
        if self.source.supports_rich_root():
105
 
            raise errors.IncompatibleBundleFormat('0.8', repr(self.source))
106
 
 
107
97
    def write(self, source, revision_ids, forced_bases, f):
108
98
        """Write the bundless to the supplied files.
109
99
 
116
106
        self.revision_ids = revision_ids
117
107
        self.forced_bases = forced_bases
118
108
        self.to_file = f
119
 
        self.check_compatible()
120
109
        source.lock_read()
121
110
        try:
122
111
            self._write_main_header()
123
 
            pb = ui.ui_factory.nested_progress_bar()
 
112
            pb = DummyProgress()
124
113
            try:
125
114
                self._write_revisions(pb)
126
115
            finally:
127
 
                pb.finished()
 
116
                pass
 
117
                #pb.finished()
128
118
        finally:
129
119
            source.unlock()
130
120
 
131
 
    def write_bundle(self, repository, target, base, fileobj):
132
 
        return self._write_bundle(repository, target, base, fileobj)
133
 
 
134
121
    def _write_main_header(self):
135
122
        """Write the header for the changes"""
136
123
        f = self.to_file
137
 
        f.write(_get_bundle_header('0.8'))
 
124
        f.write(BUNDLE_HEADER)
 
125
        f.write('0.8\n')
138
126
        f.write('#\n')
139
127
 
140
 
    def _write(self, key, value, indent=1, trailing_space_when_empty=False):
141
 
        """Write out meta information, with proper indenting, etc.
142
 
 
143
 
        :param trailing_space_when_empty: To work around a bug in earlier
144
 
            bundle readers, when writing an empty property, we use "prop: \n"
145
 
            rather than writing "prop:\n".
146
 
            If this parameter is True, and value is the empty string, we will
147
 
            write an extra space.
148
 
        """
149
 
        if indent < 1:
150
 
            raise ValueError('indentation must be greater than 0')
 
128
    def _write(self, key, value, indent=1):
 
129
        """Write out meta information, with proper indenting, etc"""
 
130
        assert indent > 0, 'indentation must be greater than 0'
151
131
        f = self.to_file
152
132
        f.write('#' + (' ' * indent))
153
133
        f.write(key.encode('utf-8'))
154
134
        if not value:
155
 
            if trailing_space_when_empty and value == '':
156
 
                f.write(': \n')
157
 
            else:
158
 
                f.write(':\n')
159
 
        elif isinstance(value, str):
160
 
            f.write(': ')
161
 
            f.write(value)
162
 
            f.write('\n')
163
 
        elif isinstance(value, unicode):
 
135
            f.write(':\n')
 
136
        elif isinstance(value, basestring):
164
137
            f.write(': ')
165
138
            f.write(value.encode('utf-8'))
166
139
            f.write('\n')
168
141
            f.write(':\n')
169
142
            for entry in value:
170
143
                f.write('#' + (' ' * (indent+2)))
171
 
                if isinstance(entry, str):
172
 
                    f.write(entry)
173
 
                else:
174
 
                    f.write(entry.encode('utf-8'))
 
144
                f.write(entry.encode('utf-8'))
175
145
                f.write('\n')
176
146
 
177
147
    def _write_revisions(self, pb):
181
151
        last_rev_id = None
182
152
        last_rev_tree = None
183
153
 
184
 
        i_max = len(self.revision_ids)
 
154
        i_max = len(self.revision_ids) 
185
155
        for i, rev_id in enumerate(self.revision_ids):
186
 
            pb.update("Generating revision data", i, i_max)
 
156
            pb.update("Generating revsion data", i, i_max)
187
157
            rev = self.source.get_revision(rev_id)
188
158
            if rev_id == last_rev_id:
189
159
                rev_tree = last_rev_tree
190
160
            else:
191
 
                rev_tree = self.source.revision_tree(rev_id)
 
161
                base_tree = self.source.revision_tree(rev_id)
 
162
            rev_tree = self.source.revision_tree(rev_id)
192
163
            if rev_id in self.forced_bases:
193
164
                explicit_base = True
194
165
                base_id = self.forced_bases[rev_id]
206
177
            else:
207
178
                base_tree = self.source.revision_tree(base_id)
208
179
            force_binary = (i != 0)
209
 
            self._write_revision(rev, rev_tree, base_id, base_tree,
 
180
            self._write_revision(rev, rev_tree, base_id, base_tree, 
210
181
                                 explicit_base, force_binary)
211
182
 
212
183
            last_rev_id = base_id
213
184
            last_rev_tree = base_tree
214
185
 
215
 
    def _testament_sha1(self, revision_id):
216
 
        return StrictTestament.from_revision(self.source,
217
 
                                             revision_id).as_sha1()
218
 
 
219
 
    def _write_revision(self, rev, rev_tree, base_rev, base_tree,
 
186
    def _write_revision(self, rev, rev_tree, base_rev, base_tree, 
220
187
                        explicit_base, force_binary):
221
188
        """Write out the information for a revision."""
222
189
        def w(key, value):
230
197
        self._write_delta(rev_tree, base_tree, rev.revision_id, force_binary)
231
198
 
232
199
        w('revision id', rev.revision_id)
233
 
        w('sha1', self._testament_sha1(rev.revision_id))
 
200
        w('sha1', StrictTestament.from_revision(self.source, 
 
201
                                                rev.revision_id).as_sha1())
234
202
        w('inventory sha1', rev.inventory_sha1)
235
203
        if rev.parent_ids:
236
204
            w('parent ids', rev.parent_ids)
238
206
            w('base id', base_rev)
239
207
        if rev.properties:
240
208
            self._write('properties', None, indent=1)
241
 
            for name, value in sorted(rev.properties.items()):
242
 
                self._write(name, value, indent=3,
243
 
                            trailing_space_when_empty=True)
244
 
 
 
209
            for name, value in rev.properties.items():
 
210
                self._write(name, value, indent=3)
 
211
        
245
212
        # Add an extra blank space at the end
246
213
        self.to_file.write('\n')
247
214
 
254
221
        self.to_file.write(' // '.join(p_texts).encode('utf-8'))
255
222
        self.to_file.write('\n')
256
223
 
257
 
    def _write_delta(self, new_tree, old_tree, default_revision_id,
 
224
    def _write_delta(self, new_tree, old_tree, default_revision_id, 
258
225
                     force_binary):
259
226
        """Write out the changes between the trees."""
260
227
        DEVNULL = '/dev/null'
277
244
                old_lines = tree_lines(old_tree, require_text=True)
278
245
                new_lines = tree_lines(new_tree, require_text=True)
279
246
                action.write(self.to_file)
280
 
                internal_diff(old_path, old_lines, new_path, new_lines,
 
247
                internal_diff(old_path, old_lines, new_path, new_lines, 
281
248
                              self.to_file)
282
249
            except errors.BinaryFile:
283
250
                old_lines = tree_lines(old_tree, require_text=False)
284
251
                new_lines = tree_lines(new_tree, require_text=False)
285
252
                action.add_property('encoding', 'base64')
286
253
                action.write(self.to_file)
287
 
                binary_diff(old_path, old_lines, new_path, new_lines,
 
254
                binary_diff(old_path, old_lines, new_path, new_lines, 
288
255
                            self.to_file)
289
256
 
290
257
        def finish_action(action, file_id, kind, meta_modified, text_modified,
291
258
                          old_path, new_path):
292
259
            entry = new_tree.inventory[file_id]
293
260
            if entry.revision != default_revision_id:
294
 
                action.add_utf8_property('last-changed', entry.revision)
 
261
                action.add_property('last-changed', entry.revision)
295
262
            if meta_modified:
296
263
                action.add_bool_property('executable', entry.executable)
297
264
            if text_modified and kind == "symlink":
301
268
            else:
302
269
                action.write(self.to_file)
303
270
 
304
 
        delta = new_tree.changes_from(old_tree, want_unchanged=True,
305
 
                                      include_root=True)
 
271
        delta = new_tree.changes_from(old_tree, want_unchanged=True)
306
272
        for path, file_id, kind in delta.removed:
307
273
            action = Action('removed', [kind, path]).write(self.to_file)
308
274
 
309
275
        for path, file_id, kind in delta.added:
310
276
            action = Action('added', [kind, path], [('file-id', file_id)])
311
 
            meta_modified = (kind=='file' and
 
277
            meta_modified = (kind=='file' and 
312
278
                             new_tree.is_executable(file_id))
313
279
            finish_action(action, file_id, kind, meta_modified, True,
314
280
                          DEVNULL, path)
332
298
                continue
333
299
            old_rev = getattr(old_tree.inventory[ie.file_id], 'revision', None)
334
300
            if new_rev != old_rev:
335
 
                action = Action('modified', [ie.kind,
 
301
                action = Action('modified', [ie.kind, 
336
302
                                             new_tree.id2path(ie.file_id)])
337
 
                action.add_utf8_property('last-changed', ie.revision)
 
303
                action.add_property('last-changed', ie.revision)
338
304
                action.write(self.to_file)
339
305
 
340
306
 
350
316
        object.__init__(self)
351
317
        self.from_file = iter(from_file)
352
318
        self._next_line = None
353
 
 
354
 
        self.info = self._get_info()
 
319
        
 
320
        self.info = BundleInfo()
355
321
        # We put the actual inventory ids in the footer, so that the patch
356
322
        # is easier to read for humans.
357
323
        # Unfortunately, that means we need to read everything before we
359
325
        self._read()
360
326
        self._validate()
361
327
 
362
 
    def _get_info(self):
363
 
        return BundleInfo08()
364
 
 
365
328
    def _read(self):
366
329
        self._next().next()
367
330
        while self._next_line is not None:
449
412
            return
450
413
 
451
414
        revision_info = self.info.revisions[-1]
452
 
        if key in revision_info.__dict__:
 
415
        if hasattr(revision_info, key):
453
416
            if getattr(revision_info, key) is None:
454
 
                if key in ('file_id', 'revision_id', 'base_id'):
455
 
                    value = value.encode('utf8')
456
 
                elif key in ('parent_ids'):
457
 
                    value = [v.encode('utf8') for v in value]
458
417
                setattr(revision_info, key, value)
459
418
            else:
460
419
                raise errors.MalformedHeader('Duplicated Key: %s' % key)
461
420
        else:
462
421
            # What do we do with a key we don't recognize
463
422
            raise errors.MalformedHeader('Unknown Key: "%s"' % key)
464
 
 
 
423
    
465
424
    def _read_many(self, indent):
466
425
        """If a line ends with no entry, that means that it should be
467
426
        followed with multiple lines of values.
504
463
            elif line.startswith('... '):
505
464
                action += line[len('... '):-1].decode('utf-8')
506
465
 
507
 
            if (self._next_line is not None and
 
466
            if (self._next_line is not None and 
508
467
                self._next_line.startswith('===')):
509
468
                return action, lines, True
510
469
            elif self._next_line is None or self._next_line.startswith('#'):
516
475
                lines.append(line)
517
476
 
518
477
        return action, lines, False
519
 
 
 
478
            
520
479
    def _read_patches(self):
521
480
        do_continue = True
522
481
        revision_actions = []
524
483
            action, lines, do_continue = self._read_one_patch()
525
484
            if action is not None:
526
485
                revision_actions.append((action, lines))
527
 
        if self.info.revisions[-1].tree_actions is not None:
528
 
            raise AssertionError()
 
486
        assert self.info.revisions[-1].tree_actions is None
529
487
        self.info.revisions[-1].tree_actions = revision_actions
530
488
 
531
489
    def _read_footer(self):
542
500
                # Consume the trailing \n and stop processing
543
501
                self._next().next()
544
502
                break
545
 
 
546
 
class BundleInfo08(BundleInfo):
547
 
 
548
 
    def _update_tree(self, bundle_tree, revision_id):
549
 
        bundle_tree.note_last_changed('', revision_id)
550
 
        BundleInfo._update_tree(self, bundle_tree, revision_id)
551
 
 
552
 
    def _testament_sha1_from_revision(self, repository, revision_id):
553
 
        testament = StrictTestament.from_revision(repository, revision_id)
554
 
        return testament.as_sha1()
555
 
 
556
 
    def _testament_sha1(self, revision, inventory):
557
 
        return StrictTestament(revision, inventory).as_sha1()