← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bundle/bundle_data.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-03-27 08:18:02 UTC
  • mfrom: (2378.1.1 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070327081802-271be0d343108f4f
(robertc) Merge bzrlib.strace module which adds support for stracing individual callables from within bzrlib.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/bundle/bundle_data.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2006 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
"""Read in a bundle stream, and process it into a BundleReader object."""
18
18
 
19
 
from __future__ import absolute_import
20
 
 
21
19
import base64
22
20
from cStringIO import StringIO
23
21
import os
25
23
 
26
24
from bzrlib import (
27
25
    osutils,
28
 
    timestamp,
29
 
    )
30
 
from bzrlib.bundle import apply_bundle
31
 
from bzrlib.errors import (
32
 
    TestamentMismatch,
33
 
    BzrError,
34
 
    )
35
 
from bzrlib.inventory import (
36
 
    Inventory,
37
 
    InventoryDirectory,
38
 
    InventoryFile,
39
 
    InventoryLink,
40
 
    )
41
 
from bzrlib.osutils import sha_string, pathjoin
 
26
    )
 
27
import bzrlib.errors
 
28
from bzrlib.errors import (TestamentMismatch, BzrError, 
 
29
                           MalformedHeader, MalformedPatches, NotABundle)
 
30
from bzrlib.inventory import (Inventory, InventoryEntry,
 
31
                              InventoryDirectory, InventoryFile,
 
32
                              InventoryLink)
 
33
from bzrlib.osutils import sha_file, sha_string, pathjoin
42
34
from bzrlib.revision import Revision, NULL_REVISION
43
35
from bzrlib.testament import StrictTestament
44
36
from bzrlib.trace import mutter, warning
 
37
import bzrlib.transport
45
38
from bzrlib.tree import Tree
 
39
import bzrlib.urlutils
46
40
from bzrlib.xml5 import serializer_v5
47
41
 
48
42
 
81
75
        if self.properties:
82
76
            for property in self.properties:
83
77
                key_end = property.find(': ')
84
 
                if key_end == -1:
85
 
                    if not property.endswith(':'):
86
 
                        raise ValueError(property)
87
 
                    key = str(property[:-1])
88
 
                    value = ''
89
 
                else:
90
 
                    key = str(property[:key_end])
91
 
                    value = property[key_end+2:]
 
78
                assert key_end is not None
 
79
                key = property[:key_end].encode('utf-8')
 
80
                value = property[key_end+2:].encode('utf-8')
92
81
                rev.properties[key] = value
93
82
 
94
83
        return rev
95
84
 
96
 
    @staticmethod
97
 
    def from_revision(revision):
98
 
        revision_info = RevisionInfo(revision.revision_id)
99
 
        date = timestamp.format_highres_date(revision.timestamp,
100
 
                                             revision.timezone)
101
 
        revision_info.date = date
102
 
        revision_info.timezone = revision.timezone
103
 
        revision_info.timestamp = revision.timestamp
104
 
        revision_info.message = revision.message.split('\n')
105
 
        revision_info.properties = [': '.join(p) for p in
106
 
                                    revision.properties.iteritems()]
107
 
        return revision_info
108
 
 
109
85
 
110
86
class BundleInfo(object):
111
87
    """This contains the meta information. Stuff that allows you to
112
88
    recreate the revision or inventory XML.
113
89
    """
114
 
    def __init__(self, bundle_format=None):
115
 
        self.bundle_format = None
 
90
    def __init__(self):
116
91
        self.committer = None
117
92
        self.date = None
118
93
        self.message = None
129
104
        self.timestamp = None
130
105
        self.timezone = None
131
106
 
132
 
        # Have we checked the repository yet?
133
 
        self._validated_revisions_against_repo = False
134
 
 
135
107
    def __str__(self):
136
108
        return pprint.pformat(self.__dict__)
137
109
 
163
135
    def get_base(self, revision):
164
136
        revision_info = self.get_revision_info(revision.revision_id)
165
137
        if revision_info.base_id is not None:
166
 
            return revision_info.base_id
 
138
            if revision_info.base_id == NULL_REVISION:
 
139
                return None
 
140
            else:
 
141
                return revision_info.base_id
167
142
        if len(revision.parent_ids) == 0:
168
143
            # There is no base listed, and
169
144
            # the lowest revision doesn't have a parent
170
145
            # so this is probably against the empty tree
171
 
            # and thus base truly is NULL_REVISION
172
 
            return NULL_REVISION
 
146
            # and thus base truly is None
 
147
            return None
173
148
        else:
174
149
            return revision.parent_ids[-1]
175
150
 
196
171
        raise KeyError(revision_id)
197
172
 
198
173
    def revision_tree(self, repository, revision_id, base=None):
 
174
        revision_id = osutils.safe_revision_id(revision_id)
199
175
        revision = self.get_revision(revision_id)
200
176
        base = self.get_base(revision)
201
 
        if base == revision_id:
202
 
            raise AssertionError()
203
 
        if not self._validated_revisions_against_repo:
204
 
            self._validate_references_from_repository(repository)
 
177
        assert base != revision_id
 
178
        self._validate_references_from_repository(repository)
205
179
        revision_info = self.get_revision_info(revision_id)
206
180
        inventory_revision_id = revision_id
207
 
        bundle_tree = BundleTree(repository.revision_tree(base),
 
181
        bundle_tree = BundleTree(repository.revision_tree(base), 
208
182
                                  inventory_revision_id)
209
183
        self._update_tree(bundle_tree, revision_id)
210
184
 
211
185
        inv = bundle_tree.inventory
212
186
        self._validate_inventory(inv, revision_id)
213
 
        self._validate_revision(bundle_tree, revision_id)
 
187
        self._validate_revision(inv, revision_id)
214
188
 
215
189
        return bundle_tree
216
190
 
243
217
        for rev_info in self.revisions:
244
218
            checked[rev_info.revision_id] = True
245
219
            add_sha(rev_to_sha, rev_info.revision_id, rev_info.sha1)
246
 
 
 
220
                
247
221
        for (rev, rev_info) in zip(self.real_revisions, self.revisions):
248
222
            add_sha(inv_to_sha, rev_info.revision_id, rev_info.inventory_sha1)
249
223
 
251
225
        missing = {}
252
226
        for revision_id, sha1 in rev_to_sha.iteritems():
253
227
            if repository.has_revision(revision_id):
254
 
                testament = StrictTestament.from_revision(repository,
 
228
                testament = StrictTestament.from_revision(repository, 
255
229
                                                          revision_id)
256
230
                local_sha1 = self._testament_sha1_from_revision(repository,
257
231
                                                                revision_id)
258
232
                if sha1 != local_sha1:
259
 
                    raise BzrError('sha1 mismatch. For revision id {%s}'
 
233
                    raise BzrError('sha1 mismatch. For revision id {%s}' 
260
234
                            'local: %s, bundle: %s' % (revision_id, local_sha1, sha1))
261
235
                else:
262
236
                    count += 1
263
237
            elif revision_id not in checked:
264
238
                missing[revision_id] = sha1
265
239
 
 
240
        for inv_id, sha1 in inv_to_sha.iteritems():
 
241
            if repository.has_revision(inv_id):
 
242
                # Note: branch.get_inventory_sha1() just returns the value that
 
243
                # is stored in the revision text, and that value may be out
 
244
                # of date. This is bogus, because that means we aren't
 
245
                # validating the actual text, just that we wrote and read the
 
246
                # string. But for now, what the hell.
 
247
                local_sha1 = repository.get_inventory_sha1(inv_id)
 
248
                if sha1 != local_sha1:
 
249
                    raise BzrError('sha1 mismatch. For inventory id {%s}' 
 
250
                                   'local: %s, bundle: %s' % 
 
251
                                   (inv_id, local_sha1, sha1))
 
252
                else:
 
253
                    count += 1
 
254
 
266
255
        if len(missing) > 0:
267
256
            # I don't know if this is an error yet
268
257
            warning('Not all revision hashes could be validated.'
269
258
                    ' Unable validate %d hashes' % len(missing))
270
259
        mutter('Verified %d sha hashes for the bundle.' % count)
271
 
        self._validated_revisions_against_repo = True
272
260
 
273
261
    def _validate_inventory(self, inv, revision_id):
274
262
        """At this point we should have generated the BundleTree,
275
263
        so build up an inventory, and make sure the hashes match.
276
264
        """
 
265
 
 
266
        assert inv is not None
 
267
 
277
268
        # Now we should have a complete inventory entry.
278
269
        s = serializer_v5.write_inventory_to_string(inv)
279
270
        sha1 = sha_string(s)
280
271
        # Target revision is the last entry in the real_revisions list
281
272
        rev = self.get_revision(revision_id)
282
 
        if rev.revision_id != revision_id:
283
 
            raise AssertionError()
 
273
        assert rev.revision_id == revision_id
284
274
        if sha1 != rev.inventory_sha1:
285
 
            f = open(',,bogus-inv', 'wb')
286
 
            try:
287
 
                f.write(s)
288
 
            finally:
289
 
                f.close()
 
275
            open(',,bogus-inv', 'wb').write(s)
290
276
            warning('Inventory sha hash mismatch for revision %s. %s'
291
277
                    ' != %s' % (revision_id, sha1, rev.inventory_sha1))
292
278
 
293
 
    def _validate_revision(self, tree, revision_id):
 
279
    def _validate_revision(self, inventory, revision_id):
294
280
        """Make sure all revision entries match their checksum."""
295
281
 
296
 
        # This is a mapping from each revision id to its sha hash
 
282
        # This is a mapping from each revision id to it's sha hash
297
283
        rev_to_sha1 = {}
298
 
 
 
284
        
299
285
        rev = self.get_revision(revision_id)
300
286
        rev_info = self.get_revision_info(revision_id)
301
 
        if not (rev.revision_id == rev_info.revision_id):
302
 
            raise AssertionError()
303
 
        if not (rev.revision_id == revision_id):
304
 
            raise AssertionError()
305
 
        sha1 = self._testament_sha1(rev, tree)
 
287
        assert rev.revision_id == rev_info.revision_id
 
288
        assert rev.revision_id == revision_id
 
289
        sha1 = self._testament_sha1(rev, inventory)
306
290
        if sha1 != rev_info.sha1:
307
291
            raise TestamentMismatch(rev.revision_id, rev_info.sha1, sha1)
308
292
        if rev.revision_id in rev_to_sha1:
335
319
                try:
336
320
                    name, value = info_item.split(':', 1)
337
321
                except ValueError:
338
 
                    raise ValueError('Value %r has no colon' % info_item)
 
322
                    raise 'Value %r has no colon' % info_item
339
323
                if name == 'last-changed':
340
324
                    last_changed = value
341
325
                elif name == 'executable':
 
326
                    assert value in ('yes', 'no'), value
342
327
                    val = (value == 'yes')
343
328
                    bundle_tree.note_executable(new_path, val)
344
329
                elif name == 'target':
348
333
            return last_changed, encoding
349
334
 
350
335
        def do_patch(path, lines, encoding):
351
 
            if encoding == 'base64':
 
336
            if encoding is not None:
 
337
                assert encoding == 'base64'
352
338
                patch = base64.decodestring(''.join(lines))
353
 
            elif encoding is None:
 
339
            else:
354
340
                patch =  ''.join(lines)
355
 
            else:
356
 
                raise ValueError(encoding)
357
341
            bundle_tree.note_patch(path, patch)
358
342
 
359
343
        def renamed(kind, extra, lines):
419
403
            revision = get_rev_id(last_modified, path, kind)
420
404
            if lines:
421
405
                do_patch(path, lines, encoding)
422
 
 
 
406
            
423
407
        valid_actions = {
424
408
            'renamed':renamed,
425
409
            'removed':removed,
448
432
                        ' (unrecognized action): %r' % action_line)
449
433
            valid_actions[action](kind, extra, lines)
450
434
 
451
 
    def install_revisions(self, target_repo, stream_input=True):
452
 
        """Install revisions and return the target revision
453
 
 
454
 
        :param target_repo: The repository to install into
455
 
        :param stream_input: Ignored by this implementation.
456
 
        """
457
 
        apply_bundle.install_bundle(target_repo, self)
458
 
        return self.target
459
 
 
460
 
    def get_merge_request(self, target_repo):
461
 
        """Provide data for performing a merge
462
 
 
463
 
        Returns suggested base, suggested target, and patch verification status
464
 
        """
465
 
        return None, self.target, 'inapplicable'
466
 
 
467
435
 
468
436
class BundleTree(Tree):
469
 
 
470
437
    def __init__(self, base_tree, revision_id):
471
438
        self.base_tree = base_tree
472
439
        self._renamed = {} # Mapping from old_path => new_path
488
455
 
489
456
    def note_rename(self, old_path, new_path):
490
457
        """A file/directory has been renamed from old_path => new_path"""
491
 
        if new_path in self._renamed:
492
 
            raise AssertionError(new_path)
493
 
        if old_path in self._renamed_r:
494
 
            raise AssertionError(old_path)
 
458
        assert new_path not in self._renamed
 
459
        assert old_path not in self._renamed_r
495
460
        self._renamed[new_path] = old_path
496
461
        self._renamed_r[old_path] = new_path
497
462
 
527
492
 
528
493
    def old_path(self, new_path):
529
494
        """Get the old_path (path in the base_tree) for the file at new_path"""
530
 
        if new_path[:1] in ('\\', '/'):
531
 
            raise ValueError(new_path)
 
495
        assert new_path[:1] not in ('\\', '/')
532
496
        old_path = self._renamed.get(new_path)
533
497
        if old_path is not None:
534
498
            return old_path
548
512
        #renamed_r
549
513
        if old_path in self._renamed_r:
550
514
            return None
551
 
        return old_path
 
515
        return old_path 
552
516
 
553
517
    def new_path(self, old_path):
554
518
        """Get the new_path (path in the target_tree) for the file at old_path
555
519
        in the base tree.
556
520
        """
557
 
        if old_path[:1] in ('\\', '/'):
558
 
            raise ValueError(old_path)
 
521
        assert old_path[:1] not in ('\\', '/')
559
522
        new_path = self._renamed_r.get(old_path)
560
523
        if new_path is not None:
561
524
            return new_path
574
537
        #renamed_r
575
538
        if new_path in self._renamed:
576
539
            return None
577
 
        return new_path
578
 
 
579
 
    def get_root_id(self):
580
 
        return self.path2id('')
 
540
        return new_path 
581
541
 
582
542
    def path2id(self, path):
583
543
        """Return the id of the file present at path in the target tree."""
589
549
            return None
590
550
        if old_path in self.deleted:
591
551
            return None
592
 
        return self.base_tree.path2id(old_path)
 
552
        if getattr(self.base_tree, 'path2id', None) is not None:
 
553
            return self.base_tree.path2id(old_path)
 
554
        else:
 
555
            return self.base_tree.inventory.path2id(old_path)
593
556
 
594
557
    def id2path(self, file_id):
595
558
        """Return the new path in the target tree of the file with id file_id"""
614
577
                return None
615
578
        new_path = self.id2path(file_id)
616
579
        return self.base_tree.path2id(new_path)
617
 
 
 
580
        
618
581
    def get_file(self, file_id):
619
582
        """Return a file-like object containing the new contents of the
620
583
        file given by file_id.
625
588
        """
626
589
        base_id = self.old_contents_id(file_id)
627
590
        if (base_id is not None and
628
 
            base_id != self.base_tree.get_root_id()):
 
591
            base_id != self.base_tree.inventory.root.file_id):
629
592
            patch_original = self.base_tree.get_file(base_id)
630
593
        else:
631
594
            patch_original = None
632
595
        file_patch = self.patches.get(self.id2path(file_id))
633
596
        if file_patch is None:
634
 
            if (patch_original is None and
635
 
                self.kind(file_id) == 'directory'):
 
597
            if (patch_original is None and 
 
598
                self.get_kind(file_id) == 'directory'):
636
599
                return StringIO()
637
 
            if patch_original is None:
638
 
                raise AssertionError("None: %s" % file_id)
 
600
            assert patch_original is not None, "None: %s" % file_id
639
601
            return patch_original
640
602
 
641
 
        if file_patch.startswith('\\'):
642
 
            raise ValueError(
643
 
                'Malformed patch for %s, %r' % (file_id, file_patch))
 
603
        assert not file_patch.startswith('\\'), \
 
604
            'Malformed patch for %s, %r' % (file_id, file_patch)
644
605
        return patched_file(file_patch, patch_original)
645
606
 
646
 
    def get_symlink_target(self, file_id, path=None):
647
 
        if path is None:
648
 
            path = self.id2path(file_id)
 
607
    def get_symlink_target(self, file_id):
 
608
        new_path = self.id2path(file_id)
649
609
        try:
650
 
            return self._targets[path]
 
610
            return self._targets[new_path]
651
611
        except KeyError:
652
612
            return self.base_tree.get_symlink_target(file_id)
653
613
 
654
 
    def kind(self, file_id):
 
614
    def get_kind(self, file_id):
655
615
        if file_id in self._kinds:
656
616
            return self._kinds[file_id]
657
 
        return self.base_tree.kind(file_id)
658
 
 
659
 
    def get_file_revision(self, file_id):
660
 
        path = self.id2path(file_id)
661
 
        if path in self._last_changed:
662
 
            return self._last_changed[path]
663
 
        else:
664
 
            return self.base_tree.get_file_revision(file_id)
 
617
        return self.base_tree.inventory[file_id].kind
665
618
 
666
619
    def is_executable(self, file_id):
667
620
        path = self.id2path(file_id)
668
621
        if path in self._executable:
669
622
            return self._executable[path]
670
623
        else:
671
 
            return self.base_tree.is_executable(file_id)
 
624
            return self.base_tree.inventory[file_id].executable
672
625
 
673
626
    def get_last_changed(self, file_id):
674
627
        path = self.id2path(file_id)
675
628
        if path in self._last_changed:
676
629
            return self._last_changed[path]
677
 
        return self.base_tree.get_file_revision(file_id)
 
630
        return self.base_tree.inventory[file_id].revision
678
631
 
679
632
    def get_size_and_sha1(self, file_id):
680
633
        """Return the size and sha1 hash of the given file id.
687
640
        if new_path not in self.patches:
688
641
            # If the entry does not have a patch, then the
689
642
            # contents must be the same as in the base_tree
690
 
            text_size = self.base_tree.get_file_size(file_id)
691
 
            text_sha1 = self.base_tree.get_file_sha1(file_id)
692
 
            return text_size, text_sha1
 
643
            ie = self.base_tree.inventory[file_id]
 
644
            if ie.text_size is None:
 
645
                return ie.text_size, ie.text_sha1
 
646
            return int(ie.text_size), ie.text_sha1
693
647
        fileobj = self.get_file(file_id)
694
648
        content = fileobj.read()
695
649
        return len(content), sha_string(content)
700
654
        This need to be called before ever accessing self.inventory
701
655
        """
702
656
        from os.path import dirname, basename
 
657
 
 
658
        assert self.base_tree is not None
 
659
        base_inv = self.base_tree.inventory
703
660
        inv = Inventory(None, self.revision_id)
704
661
 
705
662
        def add_entry(file_id):
712
669
                parent_path = dirname(path)
713
670
                parent_id = self.path2id(parent_path)
714
671
 
715
 
            kind = self.kind(file_id)
 
672
            kind = self.get_kind(file_id)
716
673
            revision_id = self.get_last_changed(file_id)
717
674
 
718
675
            name = basename(path)
723
680
                ie.executable = self.is_executable(file_id)
724
681
            elif kind == 'symlink':
725
682
                ie = InventoryLink(file_id, name, parent_id)
726
 
                ie.symlink_target = self.get_symlink_target(file_id, path)
 
683
                ie.symlink_target = self.get_symlink_target(file_id)
727
684
            ie.revision = revision_id
728
685
 
729
 
            if kind == 'file':
 
686
            if kind in ('directory', 'symlink'):
 
687
                ie.text_size, ie.text_sha1 = None, None
 
688
            else:
730
689
                ie.text_size, ie.text_sha1 = self.get_size_and_sha1(file_id)
731
 
                if ie.text_size is None:
732
 
                    raise BzrError(
733
 
                        'Got a text_size of None for file_id %r' % file_id)
 
690
            if (ie.text_size is None) and (kind == 'file'):
 
691
                raise BzrError('Got a text_size of None for file_id %r' % file_id)
734
692
            inv.add(ie)
735
693
 
736
694
        sorted_entries = self.sorted_path_id()
746
704
    # at that instant
747
705
    inventory = property(_get_inventory)
748
706
 
749
 
    root_inventory = property(_get_inventory)
750
 
 
751
 
    def all_file_ids(self):
752
 
        return set(
753
 
            [entry.file_id for path, entry in self.inventory.iter_entries()])
754
 
 
755
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
756
 
        # The only files returned by this are those from the version
757
 
        inv = self.inventory
758
 
        if from_dir is None:
759
 
            from_dir_id = None
760
 
        else:
761
 
            from_dir_id = inv.path2id(from_dir)
762
 
            if from_dir_id is None:
763
 
                # Directory not versioned
764
 
                return
765
 
        entries = inv.iter_entries(from_dir=from_dir_id, recursive=recursive)
766
 
        if inv.root is not None and not include_root and from_dir is None:
767
 
            # skip the root for compatability with the current apis.
768
 
            entries.next()
769
 
        for path, entry in entries:
770
 
            yield path, 'V', entry.kind, entry.file_id, entry
 
707
    def __iter__(self):
 
708
        for path, entry in self.inventory.iter_entries():
 
709
            yield entry.file_id
771
710
 
772
711
    def sorted_path_id(self):
773
712
        paths = []
774
713
        for result in self._new_id.iteritems():
775
714
            paths.append(result)
776
 
        for id in self.base_tree.all_file_ids():
 
715
        for id in self.base_tree:
777
716
            path = self.id2path(id)
778
717
            if path is None:
779
718
                continue