~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Martin
  • Date: 2010-05-16 15:18:43 UTC
  • mfrom: (5235 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5239.
  • Revision ID: gzlist@googlemail.com-20100516151843-lu53u7caehm3ie3i
Merge bzr.dev to resolve conflicts in NEWS and _chk_map_pyx

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
24
24
    bzrdir,
25
25
    check,
26
26
    chk_map,
 
27
    config,
27
28
    debug,
28
 
    errors,
 
29
    fetch as _mod_fetch,
29
30
    fifo_cache,
30
31
    generate_ids,
31
32
    gpg,
32
33
    graph,
33
34
    inventory,
 
35
    inventory_delta,
34
36
    lazy_regex,
35
37
    lockable_files,
36
38
    lockdir,
37
39
    lru_cache,
38
40
    osutils,
39
41
    revision as _mod_revision,
 
42
    static_tuple,
40
43
    symbol_versioning,
 
44
    trace,
41
45
    tsort,
42
46
    ui,
43
47
    versionedfile,
48
52
from bzrlib.testament import Testament
49
53
""")
50
54
 
51
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
55
from bzrlib import (
 
56
    errors,
 
57
    registry,
 
58
    )
 
59
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
52
60
from bzrlib.inter import InterObject
53
61
from bzrlib.inventory import (
54
62
    Inventory,
56
64
    ROOT_ID,
57
65
    entry_factory,
58
66
    )
59
 
from bzrlib import registry
60
 
from bzrlib.symbol_versioning import (
61
 
        deprecated_method,
62
 
        )
 
67
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
63
68
from bzrlib.trace import (
64
69
    log_exception_quietly, note, mutter, mutter_callsite, warning)
65
70
 
68
73
_deprecation_warning_done = False
69
74
 
70
75
 
 
76
class IsInWriteGroupError(errors.InternalBzrError):
 
77
 
 
78
    _fmt = "May not refresh_data of repo %(repo)s while in a write group."
 
79
 
 
80
    def __init__(self, repo):
 
81
        errors.InternalBzrError.__init__(self, repo=repo)
 
82
 
 
83
 
71
84
class CommitBuilder(object):
72
85
    """Provides an interface to build up a commit.
73
86
 
204
217
            repository.get_inventory.
205
218
        """
206
219
        if self.new_inventory is None:
207
 
            # XXX: Using these asserts causes test failures. However, at least
208
 
            #      "self._recording_deletes" seems like a useful check to do,
209
 
            #      as it ensure the delta is completely valid. Most likely this
210
 
            #      just exposes that the test suite isn't using CommitBuilder
211
 
            #      100% correctly.
212
 
            # if (not self.repository._format._commit_inv_deltas
213
 
            #     or not self._recording_deletes):
214
 
            #     raise AssertionError('new_inventory is None, but we did not'
215
 
            #         ' set the flag that the repository format supports'
216
 
            #         ' partial inventory generation.')
217
220
            # an inventory delta was accumulated without creating a new
218
221
            # inventory.
219
222
            basis_id = self.basis_delta_revision
220
 
            self.inv_sha1 = self.repository.add_inventory_by_delta(
 
223
            # We ignore the 'inventory' returned by add_inventory_by_delta
 
224
            # because self.new_inventory is used to hint to the rest of the
 
225
            # system what code path was taken
 
226
            self.inv_sha1, _ = self.repository.add_inventory_by_delta(
221
227
                basis_id, self._basis_delta, self._new_revision_id,
222
228
                self.parents)
223
229
        else:
282
288
 
283
289
        :param tree: The tree which is being committed.
284
290
        """
285
 
        # NB: if there are no parents then this method is not called, so no
286
 
        # need to guard on parents having length.
 
291
        if len(self.parents) == 0:
 
292
            raise errors.RootMissing()
287
293
        entry = entry_factory['directory'](tree.path2id(''), '',
288
294
            None)
289
295
        entry.revision = self._new_revision_id
336
342
            raise AssertionError("recording deletes not activated.")
337
343
        delta = (path, None, file_id, None)
338
344
        self._basis_delta.append(delta)
 
345
        self._any_changes = True
339
346
        return delta
340
347
 
341
348
    def will_record_deletes(self):
476
483
            if content_summary[2] is None:
477
484
                raise ValueError("Files must not have executable = None")
478
485
            if not store:
479
 
                if (# if the file length changed we have to store:
480
 
                    parent_entry.text_size != content_summary[1] or
481
 
                    # if the exec bit has changed we have to store:
 
486
                # We can't trust a check of the file length because of content
 
487
                # filtering...
 
488
                if (# if the exec bit has changed we have to store:
482
489
                    parent_entry.executable != content_summary[2]):
483
490
                    store = True
484
491
                elif parent_entry.text_sha1 == content_summary[3]:
503
510
            ie.executable = content_summary[2]
504
511
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
505
512
            try:
506
 
                lines = file_obj.readlines()
 
513
                text = file_obj.read()
507
514
            finally:
508
515
                file_obj.close()
509
516
            try:
510
517
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
511
 
                    ie.file_id, lines, heads, nostore_sha)
 
518
                    ie.file_id, text, heads, nostore_sha)
512
519
                # Let the caller know we generated a stat fingerprint.
513
520
                fingerprint = (ie.text_sha1, stat_value)
514
521
            except errors.ExistingContent:
526
533
                # carry over:
527
534
                ie.revision = parent_entry.revision
528
535
                return self._get_delta(ie, basis_inv, path), False, None
529
 
            lines = []
530
 
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
536
            self._add_text_to_weave(ie.file_id, '', heads, None)
531
537
        elif kind == 'symlink':
532
538
            current_link_target = content_summary[3]
533
539
            if not store:
541
547
                ie.symlink_target = parent_entry.symlink_target
542
548
                return self._get_delta(ie, basis_inv, path), False, None
543
549
            ie.symlink_target = current_link_target
544
 
            lines = []
545
 
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
550
            self._add_text_to_weave(ie.file_id, '', heads, None)
546
551
        elif kind == 'tree-reference':
547
552
            if not store:
548
553
                if content_summary[3] != parent_entry.reference_revision:
553
558
                ie.revision = parent_entry.revision
554
559
                return self._get_delta(ie, basis_inv, path), False, None
555
560
            ie.reference_revision = content_summary[3]
556
 
            lines = []
557
 
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
561
            if ie.reference_revision is None:
 
562
                raise AssertionError("invalid content_summary for nested tree: %r"
 
563
                    % (content_summary,))
 
564
            self._add_text_to_weave(ie.file_id, '', heads, None)
558
565
        else:
559
566
            raise NotImplementedError('unknown kind')
560
567
        ie.revision = self._new_revision_id
570
577
            has been generated against. Currently assumed to be the same
571
578
            as self.parents[0] - if it is not, errors may occur.
572
579
        :param iter_changes: An iter_changes iterator with the changes to apply
573
 
            to basis_revision_id.
 
580
            to basis_revision_id. The iterator must not include any items with
 
581
            a current kind of None - missing items must be either filtered out
 
582
            or errored-on beefore record_iter_changes sees the item.
574
583
        :param _entry_factory: Private method to bind entry_factory locally for
575
584
            performance.
576
 
        :return: None
 
585
        :return: A generator of (file_id, relpath, fs_hash) tuples for use with
 
586
            tree._observed_sha1.
577
587
        """
578
588
        # Create an inventory delta based on deltas between all the parents and
579
589
        # deltas between all the parent inventories. We use inventory delta's 
586
596
        # {file_id -> revision_id -> inventory entry, for entries in parent
587
597
        # trees that are not parents[0]
588
598
        parent_entries = {}
589
 
        revtrees = list(self.repository.revision_trees(self.parents))
 
599
        ghost_basis = False
 
600
        try:
 
601
            revtrees = list(self.repository.revision_trees(self.parents))
 
602
        except errors.NoSuchRevision:
 
603
            # one or more ghosts, slow path.
 
604
            revtrees = []
 
605
            for revision_id in self.parents:
 
606
                try:
 
607
                    revtrees.append(self.repository.revision_tree(revision_id))
 
608
                except errors.NoSuchRevision:
 
609
                    if not revtrees:
 
610
                        basis_revision_id = _mod_revision.NULL_REVISION
 
611
                        ghost_basis = True
 
612
                    revtrees.append(self.repository.revision_tree(
 
613
                        _mod_revision.NULL_REVISION))
590
614
        # The basis inventory from a repository 
591
615
        if revtrees:
592
616
            basis_inv = revtrees[0].inventory
594
618
            basis_inv = self.repository.revision_tree(
595
619
                _mod_revision.NULL_REVISION).inventory
596
620
        if len(self.parents) > 0:
597
 
            if basis_revision_id != self.parents[0]:
 
621
            if basis_revision_id != self.parents[0] and not ghost_basis:
598
622
                raise Exception(
599
623
                    "arbitrary basis parents not yet supported with merges")
600
624
            for revtree in revtrees[1:]:
604
628
                        continue
605
629
                    if change[2] not in merged_ids:
606
630
                        if change[0] is not None:
 
631
                            basis_entry = basis_inv[change[2]]
607
632
                            merged_ids[change[2]] = [
608
 
                                basis_inv[change[2]].revision,
 
633
                                # basis revid
 
634
                                basis_entry.revision,
 
635
                                # new tree revid
609
636
                                change[3].revision]
 
637
                            parent_entries[change[2]] = {
 
638
                                # basis parent
 
639
                                basis_entry.revision:basis_entry,
 
640
                                # this parent 
 
641
                                change[3].revision:change[3],
 
642
                                }
610
643
                        else:
611
644
                            merged_ids[change[2]] = [change[3].revision]
612
 
                        parent_entries[change[2]] = {change[3].revision:change[3]}
 
645
                            parent_entries[change[2]] = {change[3].revision:change[3]}
613
646
                    else:
614
647
                        merged_ids[change[2]].append(change[3].revision)
615
648
                        parent_entries[change[2]][change[3].revision] = change[3]
640
673
            # inv delta  change: (file_id, (path_in_source, path_in_target),
641
674
            #   changed_content, versioned, parent, name, kind,
642
675
            #   executable)
643
 
            basis_entry = basis_inv[file_id]
644
 
            change = (file_id,
645
 
                (basis_inv.id2path(file_id), tree.id2path(file_id)),
646
 
                False, (True, True),
647
 
                (basis_entry.parent_id, basis_entry.parent_id),
648
 
                (basis_entry.name, basis_entry.name),
649
 
                (basis_entry.kind, basis_entry.kind),
650
 
                (basis_entry.executable, basis_entry.executable))
651
 
            changes[file_id] = (change, merged_ids[file_id])
 
676
            try:
 
677
                basis_entry = basis_inv[file_id]
 
678
            except errors.NoSuchId:
 
679
                # a change from basis->some_parents but file_id isn't in basis
 
680
                # so was new in the merge, which means it must have changed
 
681
                # from basis -> current, and as it hasn't the add was reverted
 
682
                # by the user. So we discard this change.
 
683
                pass
 
684
            else:
 
685
                change = (file_id,
 
686
                    (basis_inv.id2path(file_id), tree.id2path(file_id)),
 
687
                    False, (True, True),
 
688
                    (basis_entry.parent_id, basis_entry.parent_id),
 
689
                    (basis_entry.name, basis_entry.name),
 
690
                    (basis_entry.kind, basis_entry.kind),
 
691
                    (basis_entry.executable, basis_entry.executable))
 
692
                changes[file_id] = (change, merged_ids[file_id])
652
693
        # changes contains tuples with the change and a set of inventory
653
694
        # candidates for the file.
654
695
        # inv delta is:
720
761
                        entry.executable = True
721
762
                    else:
722
763
                        entry.executable = False
723
 
                    if (carry_over_possible and 
 
764
                    if (carry_over_possible and
724
765
                        parent_entry.executable == entry.executable):
725
766
                            # Check the file length, content hash after reading
726
767
                            # the file.
729
770
                        nostore_sha = None
730
771
                    file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
731
772
                    try:
732
 
                        lines = file_obj.readlines()
 
773
                        text = file_obj.read()
733
774
                    finally:
734
775
                        file_obj.close()
735
776
                    try:
736
777
                        entry.text_sha1, entry.text_size = self._add_text_to_weave(
737
 
                            file_id, lines, heads, nostore_sha)
 
778
                            file_id, text, heads, nostore_sha)
 
779
                        yield file_id, change[1][1], (entry.text_sha1, stat_value)
738
780
                    except errors.ExistingContent:
739
781
                        # No content change against a carry_over parent
 
782
                        # Perhaps this should also yield a fs hash update?
740
783
                        carried_over = True
741
784
                        entry.text_size = parent_entry.text_size
742
785
                        entry.text_sha1 = parent_entry.text_sha1
745
788
                    entry.symlink_target = tree.get_symlink_target(file_id)
746
789
                    if (carry_over_possible and
747
790
                        parent_entry.symlink_target == entry.symlink_target):
748
 
                            carried_over = True
 
791
                        carried_over = True
749
792
                    else:
750
 
                        self._add_text_to_weave(change[0], [], heads, None)
 
793
                        self._add_text_to_weave(change[0], '', heads, None)
751
794
                elif kind == 'directory':
752
795
                    if carry_over_possible:
753
796
                        carried_over = True
755
798
                        # Nothing to set on the entry.
756
799
                        # XXX: split into the Root and nonRoot versions.
757
800
                        if change[1][1] != '' or self.repository.supports_rich_root():
758
 
                            self._add_text_to_weave(change[0], [], heads, None)
 
801
                            self._add_text_to_weave(change[0], '', heads, None)
759
802
                elif kind == 'tree-reference':
760
 
                    raise AssertionError('unknown kind %r' % kind)
 
803
                    if not self.repository._format.supports_tree_reference:
 
804
                        # This isn't quite sane as an error, but we shouldn't
 
805
                        # ever see this code path in practice: tree's don't
 
806
                        # permit references when the repo doesn't support tree
 
807
                        # references.
 
808
                        raise errors.UnsupportedOperation(tree.add_reference,
 
809
                            self.repository)
 
810
                    reference_revision = tree.get_reference_revision(change[0])
 
811
                    entry.reference_revision = reference_revision
 
812
                    if (carry_over_possible and
 
813
                        parent_entry.reference_revision == reference_revision):
 
814
                        carried_over = True
 
815
                    else:
 
816
                        self._add_text_to_weave(change[0], '', heads, None)
761
817
                else:
762
818
                    raise AssertionError('unknown kind %r' % kind)
763
819
                if not carried_over:
772
828
                seen_root = True
773
829
        self.new_inventory = None
774
830
        if len(inv_delta):
 
831
            # This should perhaps be guarded by a check that the basis we
 
832
            # commit against is the basis for the commit and if not do a delta
 
833
            # against the basis.
775
834
            self._any_changes = True
776
835
        if not seen_root:
777
836
            # housekeeping root entry changes do not affect no-change commits.
778
837
            self._require_root_change(tree)
779
838
        self.basis_delta_revision = basis_revision_id
780
839
 
781
 
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
782
 
        # Note: as we read the content directly from the tree, we know its not
783
 
        # been turned into unicode or badly split - but a broken tree
784
 
        # implementation could give us bad output from readlines() so this is
785
 
        # not a guarantee of safety. What would be better is always checking
786
 
        # the content during test suite execution. RBC 20070912
787
 
        parent_keys = tuple((file_id, parent) for parent in parents)
788
 
        return self.repository.texts.add_lines(
789
 
            (file_id, self._new_revision_id), parent_keys, new_lines,
790
 
            nostore_sha=nostore_sha, random_id=self.random_revid,
791
 
            check_content=False)[0:2]
 
840
    def _add_text_to_weave(self, file_id, new_text, parents, nostore_sha):
 
841
        parent_keys = tuple([(file_id, parent) for parent in parents])
 
842
        return self.repository.texts._add_text(
 
843
            (file_id, self._new_revision_id), parent_keys, new_text,
 
844
            nostore_sha=nostore_sha, random_id=self.random_revid)[0:2]
792
845
 
793
846
 
794
847
class RootCommitBuilder(CommitBuilder):
817
870
        # versioned roots do not change unless the tree found a change.
818
871
 
819
872
 
 
873
class RepositoryWriteLockResult(LogicalLockResult):
 
874
    """The result of write locking a repository.
 
875
 
 
876
    :ivar repository_token: The token obtained from the underlying lock, or
 
877
        None.
 
878
    :ivar unlock: A callable which will unlock the lock.
 
879
    """
 
880
 
 
881
    def __init__(self, unlock, repository_token):
 
882
        LogicalLockResult.__init__(self, unlock)
 
883
        self.repository_token = repository_token
 
884
 
 
885
    def __repr__(self):
 
886
        return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
 
887
            self.unlock)
 
888
 
 
889
 
820
890
######################################################################
821
891
# Repositories
822
892
 
823
 
class Repository(object):
 
893
 
 
894
class Repository(_RelockDebugMixin, bzrdir.ControlComponent):
824
895
    """Repository holding history for one or more branches.
825
896
 
826
897
    The repository holds and retrieves historical information including
864
935
        The result of trying to insert data into the repository via this store
865
936
        is undefined: it should be considered read-only except for implementors
866
937
        of repositories.
867
 
    :ivar chk_bytes: A bzrlib.versionedfile.VersioedFiles instance containing
 
938
    :ivar chk_bytes: A bzrlib.versionedfile.VersionedFiles instance containing
868
939
        any data the repository chooses to store or have indexed by its hash.
869
940
        The result of trying to insert data into the repository via this store
870
941
        is undefined: it should be considered read-only except for implementors
895
966
        """
896
967
        if self._write_group is not self.get_transaction():
897
968
            # has an unlock or relock occured ?
 
969
            if suppress_errors:
 
970
                mutter(
 
971
                '(suppressed) mismatched lock context and write group. %r, %r',
 
972
                self._write_group, self.get_transaction())
 
973
                return
898
974
            raise errors.BzrError(
899
975
                'mismatched lock context and write group. %r, %r' %
900
976
                (self._write_group, self.get_transaction()))
929
1005
        """
930
1006
        if not self._format.supports_external_lookups:
931
1007
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
 
1008
        if self.is_locked():
 
1009
            # This repository will call fallback.unlock() when we transition to
 
1010
            # the unlocked state, so we make sure to increment the lock count
 
1011
            repository.lock_read()
932
1012
        self._check_fallback_repository(repository)
933
1013
        self._fallback_repositories.append(repository)
934
1014
        self.texts.add_fallback_versioned_files(repository.texts)
937
1017
        self.signatures.add_fallback_versioned_files(repository.signatures)
938
1018
        if self.chk_bytes is not None:
939
1019
            self.chk_bytes.add_fallback_versioned_files(repository.chk_bytes)
940
 
        self._fetch_order = 'topological'
941
1020
 
942
1021
    def _check_fallback_repository(self, repository):
943
1022
        """Check that this repository can fallback to repository safely.
966
1045
                " id and insertion revid (%r, %r)"
967
1046
                % (inv.revision_id, revision_id))
968
1047
        if inv.root is None:
969
 
            raise AssertionError()
 
1048
            raise errors.RootMissing()
970
1049
        return self._add_inventory_checked(revision_id, inv, parents)
971
1050
 
972
1051
    def _add_inventory_checked(self, revision_id, inv, parents):
976
1055
 
977
1056
        :seealso: add_inventory, for the contract.
978
1057
        """
979
 
        inv_lines = self._serialise_inventory_to_lines(inv)
 
1058
        inv_lines = self._serializer.write_inventory_to_lines(inv)
980
1059
        return self._inventory_add_lines(revision_id, parents,
981
1060
            inv_lines, check_content=False)
982
1061
 
984
1063
                               parents, basis_inv=None, propagate_caches=False):
985
1064
        """Add a new inventory expressed as a delta against another revision.
986
1065
 
 
1066
        See the inventory developers documentation for the theory behind
 
1067
        inventory deltas.
 
1068
 
987
1069
        :param basis_revision_id: The inventory id the delta was created
988
1070
            against. (This does not have to be a direct parent.)
989
1071
        :param delta: The inventory delta (see Inventory.apply_delta for
1028
1110
        check_content=True):
1029
1111
        """Store lines in inv_vf and return the sha1 of the inventory."""
1030
1112
        parents = [(parent,) for parent in parents]
1031
 
        return self.inventories.add_lines((revision_id,), parents, lines,
 
1113
        result = self.inventories.add_lines((revision_id,), parents, lines,
1032
1114
            check_content=check_content)[0]
 
1115
        self.inventories._access.flush()
 
1116
        return result
1033
1117
 
1034
1118
    def add_revision(self, revision_id, rev, inv=None, config=None):
1035
1119
        """Add rev to the revision store as revision_id.
1111
1195
        # The old API returned a list, should this actually be a set?
1112
1196
        return parent_map.keys()
1113
1197
 
 
1198
    def _check_inventories(self, checker):
 
1199
        """Check the inventories found from the revision scan.
 
1200
        
 
1201
        This is responsible for verifying the sha1 of inventories and
 
1202
        creating a pending_keys set that covers data referenced by inventories.
 
1203
        """
 
1204
        bar = ui.ui_factory.nested_progress_bar()
 
1205
        try:
 
1206
            self._do_check_inventories(checker, bar)
 
1207
        finally:
 
1208
            bar.finished()
 
1209
 
 
1210
    def _do_check_inventories(self, checker, bar):
 
1211
        """Helper for _check_inventories."""
 
1212
        revno = 0
 
1213
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
 
1214
        kinds = ['chk_bytes', 'texts']
 
1215
        count = len(checker.pending_keys)
 
1216
        bar.update("inventories", 0, 2)
 
1217
        current_keys = checker.pending_keys
 
1218
        checker.pending_keys = {}
 
1219
        # Accumulate current checks.
 
1220
        for key in current_keys:
 
1221
            if key[0] != 'inventories' and key[0] not in kinds:
 
1222
                checker._report_items.append('unknown key type %r' % (key,))
 
1223
            keys[key[0]].add(key[1:])
 
1224
        if keys['inventories']:
 
1225
            # NB: output order *should* be roughly sorted - topo or
 
1226
            # inverse topo depending on repository - either way decent
 
1227
            # to just delta against. However, pre-CHK formats didn't
 
1228
            # try to optimise inventory layout on disk. As such the
 
1229
            # pre-CHK code path does not use inventory deltas.
 
1230
            last_object = None
 
1231
            for record in self.inventories.check(keys=keys['inventories']):
 
1232
                if record.storage_kind == 'absent':
 
1233
                    checker._report_items.append(
 
1234
                        'Missing inventory {%s}' % (record.key,))
 
1235
                else:
 
1236
                    last_object = self._check_record('inventories', record,
 
1237
                        checker, last_object,
 
1238
                        current_keys[('inventories',) + record.key])
 
1239
            del keys['inventories']
 
1240
        else:
 
1241
            return
 
1242
        bar.update("texts", 1)
 
1243
        while (checker.pending_keys or keys['chk_bytes']
 
1244
            or keys['texts']):
 
1245
            # Something to check.
 
1246
            current_keys = checker.pending_keys
 
1247
            checker.pending_keys = {}
 
1248
            # Accumulate current checks.
 
1249
            for key in current_keys:
 
1250
                if key[0] not in kinds:
 
1251
                    checker._report_items.append('unknown key type %r' % (key,))
 
1252
                keys[key[0]].add(key[1:])
 
1253
            # Check the outermost kind only - inventories || chk_bytes || texts
 
1254
            for kind in kinds:
 
1255
                if keys[kind]:
 
1256
                    last_object = None
 
1257
                    for record in getattr(self, kind).check(keys=keys[kind]):
 
1258
                        if record.storage_kind == 'absent':
 
1259
                            checker._report_items.append(
 
1260
                                'Missing %s {%s}' % (kind, record.key,))
 
1261
                        else:
 
1262
                            last_object = self._check_record(kind, record,
 
1263
                                checker, last_object, current_keys[(kind,) + record.key])
 
1264
                    keys[kind] = set()
 
1265
                    break
 
1266
 
 
1267
    def _check_record(self, kind, record, checker, last_object, item_data):
 
1268
        """Check a single text from this repository."""
 
1269
        if kind == 'inventories':
 
1270
            rev_id = record.key[0]
 
1271
            inv = self._deserialise_inventory(rev_id,
 
1272
                record.get_bytes_as('fulltext'))
 
1273
            if last_object is not None:
 
1274
                delta = inv._make_delta(last_object)
 
1275
                for old_path, path, file_id, ie in delta:
 
1276
                    if ie is None:
 
1277
                        continue
 
1278
                    ie.check(checker, rev_id, inv)
 
1279
            else:
 
1280
                for path, ie in inv.iter_entries():
 
1281
                    ie.check(checker, rev_id, inv)
 
1282
            if self._format.fast_deltas:
 
1283
                return inv
 
1284
        elif kind == 'chk_bytes':
 
1285
            # No code written to check chk_bytes for this repo format.
 
1286
            checker._report_items.append(
 
1287
                'unsupported key type chk_bytes for %s' % (record.key,))
 
1288
        elif kind == 'texts':
 
1289
            self._check_text(record, checker, item_data)
 
1290
        else:
 
1291
            checker._report_items.append(
 
1292
                'unknown key type %s for %s' % (kind, record.key))
 
1293
 
 
1294
    def _check_text(self, record, checker, item_data):
 
1295
        """Check a single text."""
 
1296
        # Check it is extractable.
 
1297
        # TODO: check length.
 
1298
        if record.storage_kind == 'chunked':
 
1299
            chunks = record.get_bytes_as(record.storage_kind)
 
1300
            sha1 = osutils.sha_strings(chunks)
 
1301
            length = sum(map(len, chunks))
 
1302
        else:
 
1303
            content = record.get_bytes_as('fulltext')
 
1304
            sha1 = osutils.sha_string(content)
 
1305
            length = len(content)
 
1306
        if item_data and sha1 != item_data[1]:
 
1307
            checker._report_items.append(
 
1308
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
 
1309
                (record.key, sha1, item_data[1], item_data[2]))
 
1310
 
1114
1311
    @staticmethod
1115
1312
    def create(a_bzrdir):
1116
1313
        """Construct the current default format repository in a_bzrdir."""
1121
1318
 
1122
1319
        :param _format: The format of the repository on disk.
1123
1320
        :param a_bzrdir: The BzrDir of the repository.
1124
 
 
1125
 
        In the future we will have a single api for all stores for
1126
 
        getting file texts, inventories and revisions, then
1127
 
        this construct will accept instances of those things.
1128
1321
        """
 
1322
        # In the future we will have a single api for all stores for
 
1323
        # getting file texts, inventories and revisions, then
 
1324
        # this construct will accept instances of those things.
1129
1325
        super(Repository, self).__init__()
1130
1326
        self._format = _format
1131
1327
        # the following are part of the public API for Repository:
1137
1333
        self._reconcile_does_inventory_gc = True
1138
1334
        self._reconcile_fixes_text_parents = False
1139
1335
        self._reconcile_backsup_inventory = True
1140
 
        # not right yet - should be more semantically clear ?
1141
 
        #
1142
 
        # TODO: make sure to construct the right store classes, etc, depending
1143
 
        # on whether escaping is required.
1144
 
        self._warn_if_deprecated()
1145
1336
        self._write_group = None
1146
1337
        # Additional places to query for data.
1147
1338
        self._fallback_repositories = []
1148
1339
        # An InventoryEntry cache, used during deserialization
1149
1340
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
 
1341
        # Is it safe to return inventory entries directly from the entry cache,
 
1342
        # rather copying them?
 
1343
        self._safe_to_return_from_cache = False
 
1344
 
 
1345
    @property
 
1346
    def user_transport(self):
 
1347
        return self.bzrdir.user_transport
 
1348
 
 
1349
    @property
 
1350
    def control_transport(self):
 
1351
        return self._transport
1150
1352
 
1151
1353
    def __repr__(self):
1152
 
        return '%s(%r)' % (self.__class__.__name__,
1153
 
                           self.base)
 
1354
        if self._fallback_repositories:
 
1355
            return '%s(%r, fallback_repositories=%r)' % (
 
1356
                self.__class__.__name__,
 
1357
                self.base,
 
1358
                self._fallback_repositories)
 
1359
        else:
 
1360
            return '%s(%r)' % (self.__class__.__name__,
 
1361
                               self.base)
 
1362
 
 
1363
    def _has_same_fallbacks(self, other_repo):
 
1364
        """Returns true if the repositories have the same fallbacks."""
 
1365
        my_fb = self._fallback_repositories
 
1366
        other_fb = other_repo._fallback_repositories
 
1367
        if len(my_fb) != len(other_fb):
 
1368
            return False
 
1369
        for f, g in zip(my_fb, other_fb):
 
1370
            if not f.has_same_location(g):
 
1371
                return False
 
1372
        return True
1154
1373
 
1155
1374
    def has_same_location(self, other):
1156
1375
        """Returns a boolean indicating if this repository is at the same
1184
1403
        data during reads, and allows a 'write_group' to be obtained. Write
1185
1404
        groups must be used for actual data insertion.
1186
1405
 
 
1406
        A token should be passed in if you know that you have locked the object
 
1407
        some other way, and need to synchronise this object's state with that
 
1408
        fact.
 
1409
 
 
1410
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
 
1411
 
1187
1412
        :param token: if this is already locked, then lock_write will fail
1188
1413
            unless the token matches the existing lock.
1189
1414
        :returns: a token if this instance supports tokens, otherwise None.
1192
1417
        :raises MismatchedToken: if the specified token doesn't match the token
1193
1418
            of the existing lock.
1194
1419
        :seealso: start_write_group.
1195
 
 
1196
 
        A token should be passed in if you know that you have locked the object
1197
 
        some other way, and need to synchronise this object's state with that
1198
 
        fact.
1199
 
 
1200
 
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
 
1420
        :return: A RepositoryWriteLockResult.
1201
1421
        """
1202
1422
        locked = self.is_locked()
1203
 
        result = self.control_files.lock_write(token=token)
1204
 
        for repo in self._fallback_repositories:
1205
 
            # Writes don't affect fallback repos
1206
 
            repo.lock_read()
 
1423
        token = self.control_files.lock_write(token=token)
1207
1424
        if not locked:
 
1425
            self._warn_if_deprecated()
 
1426
            self._note_lock('w')
 
1427
            for repo in self._fallback_repositories:
 
1428
                # Writes don't affect fallback repos
 
1429
                repo.lock_read()
1208
1430
            self._refresh_data()
1209
 
        return result
 
1431
        return RepositoryWriteLockResult(self.unlock, token)
1210
1432
 
1211
1433
    def lock_read(self):
 
1434
        """Lock the repository for read operations.
 
1435
 
 
1436
        :return: An object with an unlock method which will release the lock
 
1437
            obtained.
 
1438
        """
1212
1439
        locked = self.is_locked()
1213
1440
        self.control_files.lock_read()
1214
 
        for repo in self._fallback_repositories:
1215
 
            repo.lock_read()
1216
1441
        if not locked:
 
1442
            self._warn_if_deprecated()
 
1443
            self._note_lock('r')
 
1444
            for repo in self._fallback_repositories:
 
1445
                repo.lock_read()
1217
1446
            self._refresh_data()
 
1447
        return LogicalLockResult(self.unlock)
1218
1448
 
1219
1449
    def get_physical_lock_status(self):
1220
1450
        return self.control_files.get_physical_lock_status()
1280
1510
 
1281
1511
        # now gather global repository information
1282
1512
        # XXX: This is available for many repos regardless of listability.
1283
 
        if self.bzrdir.root_transport.listable():
 
1513
        if self.user_transport.listable():
1284
1514
            # XXX: do we want to __define len__() ?
1285
1515
            # Maybe the versionedfiles object should provide a different
1286
1516
            # method to get the number of keys.
1296
1526
        :param using: If True, list only branches using this repository.
1297
1527
        """
1298
1528
        if using and not self.is_shared():
1299
 
            try:
1300
 
                return [self.bzrdir.open_branch()]
1301
 
            except errors.NotBranchError:
1302
 
                return []
 
1529
            return self.bzrdir.list_branches()
1303
1530
        class Evaluator(object):
1304
1531
 
1305
1532
            def __init__(self):
1314
1541
                    except errors.NoRepositoryPresent:
1315
1542
                        pass
1316
1543
                    else:
1317
 
                        return False, (None, repository)
 
1544
                        return False, ([], repository)
1318
1545
                self.first_call = False
1319
 
                try:
1320
 
                    value = (bzrdir.open_branch(), None)
1321
 
                except errors.NotBranchError:
1322
 
                    value = (None, None)
 
1546
                value = (bzrdir.list_branches(), None)
1323
1547
                return True, value
1324
1548
 
1325
 
        branches = []
1326
 
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
1327
 
                self.bzrdir.root_transport, evaluate=Evaluator()):
1328
 
            if branch is not None:
1329
 
                branches.append(branch)
 
1549
        ret = []
 
1550
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
 
1551
                self.user_transport, evaluate=Evaluator()):
 
1552
            if branches is not None:
 
1553
                ret.extend(branches)
1330
1554
            if not using and repository is not None:
1331
 
                branches.extend(repository.find_branches())
1332
 
        return branches
 
1555
                ret.extend(repository.find_branches())
 
1556
        return ret
1333
1557
 
1334
1558
    @needs_read_lock
1335
1559
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1364
1588
        """Commit the contents accrued within the current write group.
1365
1589
 
1366
1590
        :seealso: start_write_group.
 
1591
        
 
1592
        :return: it may return an opaque hint that can be passed to 'pack'.
1367
1593
        """
1368
1594
        if self._write_group is not self.get_transaction():
1369
1595
            # has an unlock or relock occured ?
1370
1596
            raise errors.BzrError('mismatched lock context %r and '
1371
1597
                'write group %r.' %
1372
1598
                (self.get_transaction(), self._write_group))
1373
 
        self._commit_write_group()
 
1599
        result = self._commit_write_group()
1374
1600
        self._write_group = None
 
1601
        return result
1375
1602
 
1376
1603
    def _commit_write_group(self):
1377
1604
        """Template method for per-repository write group cleanup.
1385
1612
    def suspend_write_group(self):
1386
1613
        raise errors.UnsuspendableWriteGroup(self)
1387
1614
 
 
1615
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
 
1616
        """Return the keys of missing inventory parents for revisions added in
 
1617
        this write group.
 
1618
 
 
1619
        A revision is not complete if the inventory delta for that revision
 
1620
        cannot be calculated.  Therefore if the parent inventories of a
 
1621
        revision are not present, the revision is incomplete, and e.g. cannot
 
1622
        be streamed by a smart server.  This method finds missing inventory
 
1623
        parents for revisions added in this write group.
 
1624
        """
 
1625
        if not self._format.supports_external_lookups:
 
1626
            # This is only an issue for stacked repositories
 
1627
            return set()
 
1628
        if not self.is_in_write_group():
 
1629
            raise AssertionError('not in a write group')
 
1630
 
 
1631
        # XXX: We assume that every added revision already has its
 
1632
        # corresponding inventory, so we only check for parent inventories that
 
1633
        # might be missing, rather than all inventories.
 
1634
        parents = set(self.revisions._index.get_missing_parents())
 
1635
        parents.discard(_mod_revision.NULL_REVISION)
 
1636
        unstacked_inventories = self.inventories._index
 
1637
        present_inventories = unstacked_inventories.get_parent_map(
 
1638
            key[-1:] for key in parents)
 
1639
        parents.difference_update(present_inventories)
 
1640
        if len(parents) == 0:
 
1641
            # No missing parent inventories.
 
1642
            return set()
 
1643
        if not check_for_missing_texts:
 
1644
            return set(('inventories', rev_id) for (rev_id,) in parents)
 
1645
        # Ok, now we have a list of missing inventories.  But these only matter
 
1646
        # if the inventories that reference them are missing some texts they
 
1647
        # appear to introduce.
 
1648
        # XXX: Texts referenced by all added inventories need to be present,
 
1649
        # but at the moment we're only checking for texts referenced by
 
1650
        # inventories at the graph's edge.
 
1651
        key_deps = self.revisions._index._key_dependencies
 
1652
        key_deps.satisfy_refs_for_keys(present_inventories)
 
1653
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
 
1654
        file_ids = self.fileids_altered_by_revision_ids(referrers)
 
1655
        missing_texts = set()
 
1656
        for file_id, version_ids in file_ids.iteritems():
 
1657
            missing_texts.update(
 
1658
                (file_id, version_id) for version_id in version_ids)
 
1659
        present_texts = self.texts.get_parent_map(missing_texts)
 
1660
        missing_texts.difference_update(present_texts)
 
1661
        if not missing_texts:
 
1662
            # No texts are missing, so all revisions and their deltas are
 
1663
            # reconstructable.
 
1664
            return set()
 
1665
        # Alternatively the text versions could be returned as the missing
 
1666
        # keys, but this is likely to be less data.
 
1667
        missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
 
1668
        return missing_keys
 
1669
 
1388
1670
    def refresh_data(self):
1389
 
        """Re-read any data needed to to synchronise with disk.
 
1671
        """Re-read any data needed to synchronise with disk.
1390
1672
 
1391
1673
        This method is intended to be called after another repository instance
1392
1674
        (such as one used by a smart server) has inserted data into the
1393
 
        repository. It may not be called during a write group, but may be
1394
 
        called at any other time.
 
1675
        repository. On all repositories this will work outside of write groups.
 
1676
        Some repository formats (pack and newer for bzrlib native formats)
 
1677
        support refresh_data inside write groups. If called inside a write
 
1678
        group on a repository that does not support refreshing in a write group
 
1679
        IsInWriteGroupError will be raised.
1395
1680
        """
1396
 
        if self.is_in_write_group():
1397
 
            raise errors.InternalBzrError(
1398
 
                "May not refresh_data while in a write group.")
1399
1681
        self._refresh_data()
1400
1682
 
1401
1683
    def resume_write_group(self, tokens):
1439
1721
            raise errors.InternalBzrError(
1440
1722
                "May not fetch while in a write group.")
1441
1723
        # fast path same-url fetch operations
1442
 
        if self.has_same_location(source) and fetch_spec is None:
 
1724
        # TODO: lift out to somewhere common with RemoteRepository
 
1725
        # <https://bugs.edge.launchpad.net/bzr/+bug/401646>
 
1726
        if (self.has_same_location(source)
 
1727
            and fetch_spec is None
 
1728
            and self._has_same_fallbacks(source)):
1443
1729
            # check that last_revision is in 'from' and then return a
1444
1730
            # no-operation.
1445
1731
            if (revision_id is not None and
1470
1756
        :param revprops: Optional dictionary of revision properties.
1471
1757
        :param revision_id: Optional revision id.
1472
1758
        """
 
1759
        if self._fallback_repositories:
 
1760
            raise errors.BzrError("Cannot commit from a lightweight checkout "
 
1761
                "to a stacked branch. See "
 
1762
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1473
1763
        result = self._commit_builder_class(self, parents, config,
1474
1764
            timestamp, timezone, committer, revprops, revision_id)
1475
1765
        self.start_write_group()
1476
1766
        return result
1477
1767
 
 
1768
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1478
1769
    def unlock(self):
1479
1770
        if (self.control_files._lock_count == 1 and
1480
1771
            self.control_files._lock_mode == 'w'):
1486
1777
        self.control_files.unlock()
1487
1778
        if self.control_files._lock_count == 0:
1488
1779
            self._inventory_entry_cache.clear()
1489
 
        for repo in self._fallback_repositories:
1490
 
            repo.unlock()
 
1780
            for repo in self._fallback_repositories:
 
1781
                repo.unlock()
1491
1782
 
1492
1783
    @needs_read_lock
1493
1784
    def clone(self, a_bzrdir, revision_id=None):
1602
1893
 
1603
1894
    @needs_read_lock
1604
1895
    def get_revisions(self, revision_ids):
1605
 
        """Get many revisions at once."""
 
1896
        """Get many revisions at once.
 
1897
        
 
1898
        Repositories that need to check data on every revision read should 
 
1899
        subclass this method.
 
1900
        """
1606
1901
        return self._get_revisions(revision_ids)
1607
1902
 
1608
1903
    @needs_read_lock
1609
1904
    def _get_revisions(self, revision_ids):
1610
1905
        """Core work logic to get many revisions without sanity checks."""
1611
 
        for rev_id in revision_ids:
1612
 
            if not rev_id or not isinstance(rev_id, basestring):
1613
 
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1906
        revs = {}
 
1907
        for revid, rev in self._iter_revisions(revision_ids):
 
1908
            if rev is None:
 
1909
                raise errors.NoSuchRevision(self, revid)
 
1910
            revs[revid] = rev
 
1911
        return [revs[revid] for revid in revision_ids]
 
1912
 
 
1913
    def _iter_revisions(self, revision_ids):
 
1914
        """Iterate over revision objects.
 
1915
 
 
1916
        :param revision_ids: An iterable of revisions to examine. None may be
 
1917
            passed to request all revisions known to the repository. Note that
 
1918
            not all repositories can find unreferenced revisions; for those
 
1919
            repositories only referenced ones will be returned.
 
1920
        :return: An iterator of (revid, revision) tuples. Absent revisions (
 
1921
            those asked for but not available) are returned as (revid, None).
 
1922
        """
 
1923
        if revision_ids is None:
 
1924
            revision_ids = self.all_revision_ids()
 
1925
        else:
 
1926
            for rev_id in revision_ids:
 
1927
                if not rev_id or not isinstance(rev_id, basestring):
 
1928
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1614
1929
        keys = [(key,) for key in revision_ids]
1615
1930
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1616
 
        revs = {}
1617
1931
        for record in stream:
 
1932
            revid = record.key[0]
1618
1933
            if record.storage_kind == 'absent':
1619
 
                raise errors.NoSuchRevision(self, record.key[0])
1620
 
            text = record.get_bytes_as('fulltext')
1621
 
            rev = self._serializer.read_revision_from_string(text)
1622
 
            revs[record.key[0]] = rev
1623
 
        return [revs[revid] for revid in revision_ids]
1624
 
 
1625
 
    @needs_read_lock
1626
 
    def get_revision_xml(self, revision_id):
1627
 
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
1628
 
        #       would have already do it.
1629
 
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
1630
 
        rev = self.get_revision(revision_id)
1631
 
        rev_tmp = cStringIO.StringIO()
1632
 
        # the current serializer..
1633
 
        self._serializer.write_revision(rev, rev_tmp)
1634
 
        rev_tmp.seek(0)
1635
 
        return rev_tmp.getvalue()
 
1934
                yield (revid, None)
 
1935
            else:
 
1936
                text = record.get_bytes_as('fulltext')
 
1937
                rev = self._serializer.read_revision_from_string(text)
 
1938
                yield (revid, rev)
1636
1939
 
1637
1940
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1638
1941
        """Produce a generator of revision deltas.
1816
2119
                    yield line, revid
1817
2120
 
1818
2121
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
1819
 
        revision_ids):
 
2122
        revision_keys):
1820
2123
        """Helper routine for fileids_altered_by_revision_ids.
1821
2124
 
1822
2125
        This performs the translation of xml lines to revision ids.
1823
2126
 
1824
2127
        :param line_iterator: An iterator of lines, origin_version_id
1825
 
        :param revision_ids: The revision ids to filter for. This should be a
 
2128
        :param revision_keys: The revision ids to filter for. This should be a
1826
2129
            set or other type which supports efficient __contains__ lookups, as
1827
 
            the revision id from each parsed line will be looked up in the
1828
 
            revision_ids filter.
 
2130
            the revision key from each parsed line will be looked up in the
 
2131
            revision_keys filter.
1829
2132
        :return: a dictionary mapping altered file-ids to an iterable of
1830
2133
        revision_ids. Each altered file-ids has the exact revision_ids that
1831
2134
        altered it listed explicitly.
1832
2135
        """
1833
2136
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
1834
2137
                line_iterator).iterkeys())
1835
 
        # Note that revision_ids are revision keys.
1836
 
        parent_maps = self.revisions.get_parent_map(revision_ids)
1837
 
        parents = set()
1838
 
        map(parents.update, parent_maps.itervalues())
1839
 
        parents.difference_update(revision_ids)
 
2138
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
1840
2139
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
1841
 
            self._inventory_xml_lines_for_keys(parents)))
 
2140
            self._inventory_xml_lines_for_keys(parent_keys)))
1842
2141
        new_keys = seen - parent_seen
1843
2142
        result = {}
1844
2143
        setdefault = result.setdefault
1846
2145
            setdefault(key[0], set()).add(key[-1])
1847
2146
        return result
1848
2147
 
 
2148
    def _find_parent_ids_of_revisions(self, revision_ids):
 
2149
        """Find all parent ids that are mentioned in the revision graph.
 
2150
 
 
2151
        :return: set of revisions that are parents of revision_ids which are
 
2152
            not part of revision_ids themselves
 
2153
        """
 
2154
        parent_map = self.get_parent_map(revision_ids)
 
2155
        parent_ids = set()
 
2156
        map(parent_ids.update, parent_map.itervalues())
 
2157
        parent_ids.difference_update(revision_ids)
 
2158
        parent_ids.discard(_mod_revision.NULL_REVISION)
 
2159
        return parent_ids
 
2160
 
 
2161
    def _find_parent_keys_of_revisions(self, revision_keys):
 
2162
        """Similar to _find_parent_ids_of_revisions, but used with keys.
 
2163
 
 
2164
        :param revision_keys: An iterable of revision_keys.
 
2165
        :return: The parents of all revision_keys that are not already in
 
2166
            revision_keys
 
2167
        """
 
2168
        parent_map = self.revisions.get_parent_map(revision_keys)
 
2169
        parent_keys = set()
 
2170
        map(parent_keys.update, parent_map.itervalues())
 
2171
        parent_keys.difference_update(revision_keys)
 
2172
        parent_keys.discard(_mod_revision.NULL_REVISION)
 
2173
        return parent_keys
 
2174
 
1849
2175
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
1850
2176
        """Find the file ids and versions affected by revisions.
1851
2177
 
1858
2184
        """
1859
2185
        selected_keys = set((revid,) for revid in revision_ids)
1860
2186
        w = _inv_weave or self.inventories
1861
 
        pb = ui.ui_factory.nested_progress_bar()
1862
 
        try:
1863
 
            return self._find_file_ids_from_xml_inventory_lines(
1864
 
                w.iter_lines_added_or_present_in_keys(
1865
 
                    selected_keys, pb=pb),
1866
 
                selected_keys)
1867
 
        finally:
1868
 
            pb.finished()
 
2187
        return self._find_file_ids_from_xml_inventory_lines(
 
2188
            w.iter_lines_added_or_present_in_keys(
 
2189
                selected_keys, pb=None),
 
2190
            selected_keys)
1869
2191
 
1870
2192
    def iter_files_bytes(self, desired_files):
1871
2193
        """Iterate through file versions.
1953
2275
                batch_size]
1954
2276
            if not to_query:
1955
2277
                break
1956
 
            for rev_tree in self.revision_trees(to_query):
1957
 
                revision_id = rev_tree.get_revision_id()
 
2278
            for revision_id in to_query:
1958
2279
                parent_ids = ancestors[revision_id]
1959
2280
                for text_key in revision_keys[revision_id]:
1960
2281
                    pb.update("Calculating text parents", processed_texts)
2033
2354
        num_file_ids = len(file_ids)
2034
2355
        for file_id, altered_versions in file_ids.iteritems():
2035
2356
            if pb is not None:
2036
 
                pb.update("fetch texts", count, num_file_ids)
 
2357
                pb.update("Fetch texts", count, num_file_ids)
2037
2358
            count += 1
2038
2359
            yield ("file", file_id, altered_versions)
2039
2360
 
2060
2381
        """Get Inventory object by revision id."""
2061
2382
        return self.iter_inventories([revision_id]).next()
2062
2383
 
2063
 
    def iter_inventories(self, revision_ids):
 
2384
    def iter_inventories(self, revision_ids, ordering=None):
2064
2385
        """Get many inventories by revision_ids.
2065
2386
 
2066
2387
        This will buffer some or all of the texts used in constructing the
2068
2389
        time.
2069
2390
 
2070
2391
        :param revision_ids: The expected revision ids of the inventories.
 
2392
        :param ordering: optional ordering, e.g. 'topological'.  If not
 
2393
            specified, the order of revision_ids will be preserved (by
 
2394
            buffering if necessary).
2071
2395
        :return: An iterator of inventories.
2072
2396
        """
2073
2397
        if ((None in revision_ids)
2074
2398
            or (_mod_revision.NULL_REVISION in revision_ids)):
2075
2399
            raise ValueError('cannot get null revision inventory')
2076
 
        return self._iter_inventories(revision_ids)
 
2400
        return self._iter_inventories(revision_ids, ordering)
2077
2401
 
2078
 
    def _iter_inventories(self, revision_ids):
 
2402
    def _iter_inventories(self, revision_ids, ordering):
2079
2403
        """single-document based inventory iteration."""
2080
 
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
2081
 
            yield self.deserialise_inventory(revision_id, text)
 
2404
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
 
2405
        for text, revision_id in inv_xmls:
 
2406
            yield self._deserialise_inventory(revision_id, text)
2082
2407
 
2083
 
    def _iter_inventory_xmls(self, revision_ids):
 
2408
    def _iter_inventory_xmls(self, revision_ids, ordering):
 
2409
        if ordering is None:
 
2410
            order_as_requested = True
 
2411
            ordering = 'unordered'
 
2412
        else:
 
2413
            order_as_requested = False
2084
2414
        keys = [(revision_id,) for revision_id in revision_ids]
2085
 
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
 
2415
        if not keys:
 
2416
            return
 
2417
        if order_as_requested:
 
2418
            key_iter = iter(keys)
 
2419
            next_key = key_iter.next()
 
2420
        stream = self.inventories.get_record_stream(keys, ordering, True)
2086
2421
        text_chunks = {}
2087
2422
        for record in stream:
2088
2423
            if record.storage_kind != 'absent':
2089
 
                text_chunks[record.key] = record.get_bytes_as('chunked')
 
2424
                chunks = record.get_bytes_as('chunked')
 
2425
                if order_as_requested:
 
2426
                    text_chunks[record.key] = chunks
 
2427
                else:
 
2428
                    yield ''.join(chunks), record.key[-1]
2090
2429
            else:
2091
2430
                raise errors.NoSuchRevision(self, record.key)
2092
 
        for key in keys:
2093
 
            chunks = text_chunks.pop(key)
2094
 
            yield ''.join(chunks), key[-1]
 
2431
            if order_as_requested:
 
2432
                # Yield as many results as we can while preserving order.
 
2433
                while next_key in text_chunks:
 
2434
                    chunks = text_chunks.pop(next_key)
 
2435
                    yield ''.join(chunks), next_key[-1]
 
2436
                    try:
 
2437
                        next_key = key_iter.next()
 
2438
                    except StopIteration:
 
2439
                        # We still want to fully consume the get_record_stream,
 
2440
                        # just in case it is not actually finished at this point
 
2441
                        next_key = None
 
2442
                        break
2095
2443
 
2096
 
    def deserialise_inventory(self, revision_id, xml):
 
2444
    def _deserialise_inventory(self, revision_id, xml):
2097
2445
        """Transform the xml into an inventory object.
2098
2446
 
2099
2447
        :param revision_id: The expected revision id of the inventory.
2100
2448
        :param xml: A serialised inventory.
2101
2449
        """
2102
2450
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2103
 
                    entry_cache=self._inventory_entry_cache)
 
2451
                    entry_cache=self._inventory_entry_cache,
 
2452
                    return_from_cache=self._safe_to_return_from_cache)
2104
2453
        if result.revision_id != revision_id:
2105
2454
            raise AssertionError('revision id mismatch %s != %s' % (
2106
2455
                result.revision_id, revision_id))
2107
2456
        return result
2108
2457
 
2109
 
    def serialise_inventory(self, inv):
2110
 
        return self._serializer.write_inventory_to_string(inv)
2111
 
 
2112
 
    def _serialise_inventory_to_lines(self, inv):
2113
 
        return self._serializer.write_inventory_to_lines(inv)
2114
 
 
2115
2458
    def get_serializer_format(self):
2116
2459
        return self._serializer.format_num
2117
2460
 
2118
2461
    @needs_read_lock
2119
 
    def get_inventory_xml(self, revision_id):
2120
 
        """Get inventory XML as a file object."""
2121
 
        texts = self._iter_inventory_xmls([revision_id])
 
2462
    def _get_inventory_xml(self, revision_id):
 
2463
        """Get serialized inventory as a string."""
 
2464
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
2122
2465
        try:
2123
2466
            text, revision_id = texts.next()
2124
2467
        except StopIteration:
2125
2468
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2126
2469
        return text
2127
2470
 
2128
 
    @needs_read_lock
2129
 
    def get_inventory_sha1(self, revision_id):
2130
 
        """Return the sha1 hash of the inventory entry
 
2471
    def get_rev_id_for_revno(self, revno, known_pair):
 
2472
        """Return the revision id of a revno, given a later (revno, revid)
 
2473
        pair in the same history.
 
2474
 
 
2475
        :return: if found (True, revid).  If the available history ran out
 
2476
            before reaching the revno, then this returns
 
2477
            (False, (closest_revno, closest_revid)).
2131
2478
        """
2132
 
        return self.get_revision(revision_id).inventory_sha1
 
2479
        known_revno, known_revid = known_pair
 
2480
        partial_history = [known_revid]
 
2481
        distance_from_known = known_revno - revno
 
2482
        if distance_from_known < 0:
 
2483
            raise ValueError(
 
2484
                'requested revno (%d) is later than given known revno (%d)'
 
2485
                % (revno, known_revno))
 
2486
        try:
 
2487
            _iter_for_revno(
 
2488
                self, partial_history, stop_index=distance_from_known)
 
2489
        except errors.RevisionNotPresent, err:
 
2490
            if err.revision_id == known_revid:
 
2491
                # The start revision (known_revid) wasn't found.
 
2492
                raise
 
2493
            # This is a stacked repository with no fallbacks, or a there's a
 
2494
            # left-hand ghost.  Either way, even though the revision named in
 
2495
            # the error isn't in this repo, we know it's the next step in this
 
2496
            # left-hand history.
 
2497
            partial_history.append(err.revision_id)
 
2498
        if len(partial_history) <= distance_from_known:
 
2499
            # Didn't find enough history to get a revid for the revno.
 
2500
            earliest_revno = known_revno - len(partial_history) + 1
 
2501
            return (False, (earliest_revno, partial_history[-1]))
 
2502
        if len(partial_history) - 1 > distance_from_known:
 
2503
            raise AssertionError('_iter_for_revno returned too much history')
 
2504
        return (True, partial_history[-1])
2133
2505
 
2134
2506
    def iter_reverse_revision_history(self, revision_id):
2135
2507
        """Iterate backwards through revision ids in the lefthand history
2142
2514
        while True:
2143
2515
            if next_id in (None, _mod_revision.NULL_REVISION):
2144
2516
                return
 
2517
            try:
 
2518
                parents = graph.get_parent_map([next_id])[next_id]
 
2519
            except KeyError:
 
2520
                raise errors.RevisionNotPresent(next_id, self)
2145
2521
            yield next_id
2146
 
            # Note: The following line may raise KeyError in the event of
2147
 
            # truncated history. We decided not to have a try:except:raise
2148
 
            # RevisionNotPresent here until we see a use for it, because of the
2149
 
            # cost in an inner loop that is by its very nature O(history).
2150
 
            # Robert Collins 20080326
2151
 
            parents = graph.get_parent_map([next_id])[next_id]
2152
2522
            if len(parents) == 0:
2153
2523
                return
2154
2524
            else:
2155
2525
                next_id = parents[0]
2156
2526
 
2157
 
    @needs_read_lock
2158
 
    def get_revision_inventory(self, revision_id):
2159
 
        """Return inventory of a past revision."""
2160
 
        # TODO: Unify this with get_inventory()
2161
 
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
2162
 
        # must be the same as its revision, so this is trivial.
2163
 
        if revision_id is None:
2164
 
            # This does not make sense: if there is no revision,
2165
 
            # then it is the current tree inventory surely ?!
2166
 
            # and thus get_root_id() is something that looks at the last
2167
 
            # commit on the branch, and the get_root_id is an inventory check.
2168
 
            raise NotImplementedError
2169
 
            # return Inventory(self.get_root_id())
2170
 
        else:
2171
 
            return self.get_inventory(revision_id)
2172
 
 
2173
2527
    def is_shared(self):
2174
2528
        """Return True if this repository is flagged as a shared repository."""
2175
2529
        raise NotImplementedError(self.is_shared)
2209
2563
            return RevisionTree(self, Inventory(root_id=None),
2210
2564
                                _mod_revision.NULL_REVISION)
2211
2565
        else:
2212
 
            inv = self.get_revision_inventory(revision_id)
 
2566
            inv = self.get_inventory(revision_id)
2213
2567
            return RevisionTree(self, inv, revision_id)
2214
2568
 
2215
2569
    def revision_trees(self, revision_ids):
2268
2622
            keys = tsort.topo_sort(parent_map)
2269
2623
        return [None] + list(keys)
2270
2624
 
2271
 
    def pack(self):
 
2625
    def pack(self, hint=None, clean_obsolete_packs=False):
2272
2626
        """Compress the data within the repository.
2273
2627
 
2274
2628
        This operation only makes sense for some repository types. For other
2277
2631
        This stub method does not require a lock, but subclasses should use
2278
2632
        @needs_write_lock as this is a long running call its reasonable to
2279
2633
        implicitly lock for the user.
 
2634
 
 
2635
        :param hint: If not supplied, the whole repository is packed.
 
2636
            If supplied, the repository may use the hint parameter as a
 
2637
            hint for the parts of the repository to pack. A hint can be
 
2638
            obtained from the result of commit_write_group(). Out of
 
2639
            date hints are simply ignored, because concurrent operations
 
2640
            can obsolete them rapidly.
 
2641
 
 
2642
        :param clean_obsolete_packs: Clean obsolete packs immediately after
 
2643
            the pack operation.
2280
2644
        """
2281
2645
 
2282
2646
    def get_transaction(self):
2283
2647
        return self.control_files.get_transaction()
2284
2648
 
2285
2649
    def get_parent_map(self, revision_ids):
2286
 
        """See graph._StackedParentsProvider.get_parent_map"""
 
2650
        """See graph.StackedParentsProvider.get_parent_map"""
2287
2651
        # revisions index works in keys; this just works in revisions
2288
2652
        # therefore wrap and unwrap
2289
2653
        query_keys = []
2298
2662
        for ((revision_id,), parent_keys) in \
2299
2663
                self.revisions.get_parent_map(query_keys).iteritems():
2300
2664
            if parent_keys:
2301
 
                result[revision_id] = tuple(parent_revid
2302
 
                    for (parent_revid,) in parent_keys)
 
2665
                result[revision_id] = tuple([parent_revid
 
2666
                    for (parent_revid,) in parent_keys])
2303
2667
            else:
2304
2668
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2305
2669
        return result
2307
2671
    def _make_parents_provider(self):
2308
2672
        return self
2309
2673
 
 
2674
    @needs_read_lock
 
2675
    def get_known_graph_ancestry(self, revision_ids):
 
2676
        """Return the known graph for a set of revision ids and their ancestors.
 
2677
        """
 
2678
        st = static_tuple.StaticTuple
 
2679
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
 
2680
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
 
2681
        return graph.GraphThunkIdsToKeys(known_graph)
 
2682
 
2310
2683
    def get_graph(self, other_repository=None):
2311
2684
        """Return the graph walker for this repository format"""
2312
2685
        parents_provider = self._make_parents_provider()
2313
2686
        if (other_repository is not None and
2314
2687
            not self.has_same_location(other_repository)):
2315
 
            parents_provider = graph._StackedParentsProvider(
 
2688
            parents_provider = graph.StackedParentsProvider(
2316
2689
                [parents_provider, other_repository._make_parents_provider()])
2317
2690
        return graph.Graph(parents_provider)
2318
2691
 
2319
 
    def _get_versioned_file_checker(self, text_key_references=None):
 
2692
    def _get_versioned_file_checker(self, text_key_references=None,
 
2693
        ancestors=None):
2320
2694
        """Return an object suitable for checking versioned files.
2321
2695
        
2322
2696
        :param text_key_references: if non-None, an already built
2324
2698
            to whether they were referred to by the inventory of the
2325
2699
            revision_id that they contain. If None, this will be
2326
2700
            calculated.
 
2701
        :param ancestors: Optional result from
 
2702
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
 
2703
            available.
2327
2704
        """
2328
2705
        return _VersionedFileChecker(self,
2329
 
            text_key_references=text_key_references)
 
2706
            text_key_references=text_key_references, ancestors=ancestors)
2330
2707
 
2331
2708
    def revision_ids_to_search_result(self, result_set):
2332
2709
        """Convert a set of revision ids to a graph SearchResult."""
2382
2759
        return record.get_bytes_as('fulltext')
2383
2760
 
2384
2761
    @needs_read_lock
2385
 
    def check(self, revision_ids=None):
 
2762
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
2386
2763
        """Check consistency of all history of given revision_ids.
2387
2764
 
2388
2765
        Different repository implementations should override _check().
2389
2766
 
2390
2767
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2391
2768
             will be checked.  Typically the last revision_id of a branch.
 
2769
        :param callback_refs: A dict of check-refs to resolve and callback
 
2770
            the check/_check method on the items listed as wanting the ref.
 
2771
            see bzrlib.check.
 
2772
        :param check_repo: If False do not check the repository contents, just 
 
2773
            calculate the data callback_refs requires and call them back.
2392
2774
        """
2393
 
        return self._check(revision_ids)
 
2775
        return self._check(revision_ids, callback_refs=callback_refs,
 
2776
            check_repo=check_repo)
2394
2777
 
2395
 
    def _check(self, revision_ids):
2396
 
        result = check.Check(self)
2397
 
        result.check()
 
2778
    def _check(self, revision_ids, callback_refs, check_repo):
 
2779
        result = check.Check(self, check_repo=check_repo)
 
2780
        result.check(callback_refs)
2398
2781
        return result
2399
2782
 
2400
 
    def _warn_if_deprecated(self):
 
2783
    def _warn_if_deprecated(self, branch=None):
2401
2784
        global _deprecation_warning_done
2402
2785
        if _deprecation_warning_done:
2403
2786
            return
2404
 
        _deprecation_warning_done = True
2405
 
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
2406
 
                % (self._format, self.bzrdir.transport.base))
 
2787
        try:
 
2788
            if branch is None:
 
2789
                conf = config.GlobalConfig()
 
2790
            else:
 
2791
                conf = branch.get_config()
 
2792
            if conf.suppress_warning('format_deprecation'):
 
2793
                return
 
2794
            warning("Format %s for %s is deprecated -"
 
2795
                    " please use 'bzr upgrade' to get better performance"
 
2796
                    % (self._format, self.bzrdir.transport.base))
 
2797
        finally:
 
2798
            _deprecation_warning_done = True
2407
2799
 
2408
2800
    def supports_rich_root(self):
2409
2801
        return self._format.rich_root_data
2649
3041
 
2650
3042
    Once a format is deprecated, just deprecate the initialize and open
2651
3043
    methods on the format class. Do not deprecate the object, as the
2652
 
    object may be created even when a repository instnace hasn't been
 
3044
    object may be created even when a repository instance hasn't been
2653
3045
    created.
2654
3046
 
2655
3047
    Common instance attributes:
2685
3077
    # Does this format have < O(tree_size) delta generation. Used to hint what
2686
3078
    # code path for commit, amongst other things.
2687
3079
    fast_deltas = None
 
3080
    # Does doing a pack operation compress data? Useful for the pack UI command
 
3081
    # (so if there is one pack, the operation can still proceed because it may
 
3082
    # help), and for fetching when data won't have come from the same
 
3083
    # compressor.
 
3084
    pack_compresses = False
 
3085
    # Does the repository inventory storage understand references to trees?
 
3086
    supports_tree_reference = None
 
3087
    # Is the format experimental ?
 
3088
    experimental = False
2688
3089
 
2689
 
    def __str__(self):
2690
 
        return "<%s>" % self.__class__.__name__
 
3090
    def __repr__(self):
 
3091
        return "%s()" % self.__class__.__name__
2691
3092
 
2692
3093
    def __eq__(self, other):
2693
3094
        # format objects are generally stateless
2706
3107
        """
2707
3108
        try:
2708
3109
            transport = a_bzrdir.get_repository_transport(None)
2709
 
            format_string = transport.get("format").read()
 
3110
            format_string = transport.get_bytes("format")
2710
3111
            return format_registry.get(format_string)
2711
3112
        except errors.NoSuchFile:
2712
3113
            raise errors.NoRepositoryPresent(a_bzrdir)
2794
3195
        raise NotImplementedError(self.network_name)
2795
3196
 
2796
3197
    def check_conversion_target(self, target_format):
2797
 
        raise NotImplementedError(self.check_conversion_target)
 
3198
        if self.rich_root_data and not target_format.rich_root_data:
 
3199
            raise errors.BadConversionTarget(
 
3200
                'Does not support rich root data.', target_format,
 
3201
                from_format=self)
 
3202
        if (self.supports_tree_reference and 
 
3203
            not getattr(target_format, 'supports_tree_reference', False)):
 
3204
            raise errors.BadConversionTarget(
 
3205
                'Does not support nested trees', target_format,
 
3206
                from_format=self)
2798
3207
 
2799
3208
    def open(self, a_bzrdir, _found=False):
2800
3209
        """Return an instance of this format for the bzrdir a_bzrdir.
2803
3212
        """
2804
3213
        raise NotImplementedError(self.open)
2805
3214
 
 
3215
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
 
3216
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
 
3217
        hooks = BzrDir.hooks['post_repo_init']
 
3218
        if not hooks:
 
3219
            return
 
3220
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
 
3221
        for hook in hooks:
 
3222
            hook(params)
 
3223
 
2806
3224
 
2807
3225
class MetaDirRepositoryFormat(RepositoryFormat):
2808
3226
    """Common base class for the new repositories using the metadir layout."""
2856
3274
# Pre-0.8 formats that don't have a disk format string (because they are
2857
3275
# versioned by the matching control directory). We use the control directories
2858
3276
# disk format string as a key for the network_name because they meet the
2859
 
# constraints (simple string, unique, immmutable).
 
3277
# constraints (simple string, unique, immutable).
2860
3278
network_format_registry.register_lazy(
2861
3279
    "Bazaar-NG branch, format 5\n",
2862
3280
    'bzrlib.repofmt.weaverepo',
2943
3361
    )
2944
3362
 
2945
3363
# Development formats.
2946
 
# 1.7->1.8 go below here
2947
 
format_registry.register_lazy(
2948
 
    "Bazaar development format 2 (needs bzr.dev from before 1.8)\n",
2949
 
    'bzrlib.repofmt.pack_repo',
2950
 
    'RepositoryFormatPackDevelopment2',
2951
 
    )
 
3364
# Obsolete but kept pending a CHK based subtree format.
2952
3365
format_registry.register_lazy(
2953
3366
    ("Bazaar development format 2 with subtree support "
2954
3367
        "(needs bzr.dev from before 1.8)\n"),
2955
3368
    'bzrlib.repofmt.pack_repo',
2956
3369
    'RepositoryFormatPackDevelopment2Subtree',
2957
3370
    )
2958
 
# 1.9->1.110 go below here
2959
 
format_registry.register_lazy(
2960
 
    # merge-bbc-dev4-to-bzr.dev
2961
 
    "Bazaar development format 5 (needs bzr.dev from before 1.13)\n",
2962
 
    'bzrlib.repofmt.pack_repo',
2963
 
    'RepositoryFormatPackDevelopment5',
2964
 
    )
2965
 
format_registry.register_lazy(
2966
 
    # merge-bbc-dev4-to-bzr.dev
2967
 
    ("Bazaar development format 5 with subtree support"
2968
 
     " (needs bzr.dev from before 1.13)\n"),
2969
 
    'bzrlib.repofmt.pack_repo',
2970
 
    'RepositoryFormatPackDevelopment5Subtree',
2971
 
    )
2972
 
format_registry.register_lazy(
2973
 
    # merge-bbc-dev4-to-bzr.dev
2974
 
    ('Bazaar development format 5 hash 16'
2975
 
     ' (needs bzr.dev from before 1.13)\n'),
2976
 
    'bzrlib.repofmt.pack_repo',
2977
 
    'RepositoryFormatPackDevelopment5Hash16',
2978
 
    )
2979
 
format_registry.register_lazy(
2980
 
    # merge-bbc-dev4-to-bzr.dev
2981
 
    ('Bazaar development format 5 hash 255'
2982
 
     ' (needs bzr.dev from before 1.13)\n'),
2983
 
    'bzrlib.repofmt.pack_repo',
2984
 
    'RepositoryFormatPackDevelopment5Hash255',
2985
 
    )
2986
 
format_registry.register_lazy(
2987
 
    'Bazaar development format - hash16chk+gc rich-root (needs bzr.dev from 1.14)\n',
2988
 
    'bzrlib.repofmt.groupcompress_repo',
2989
 
    'RepositoryFormatPackGCCHK16',
2990
 
    )
2991
 
format_registry.register_lazy(
2992
 
    'Bazaar development format - hash255chk+gc rich-root (needs bzr.dev from 1.14)\n',
2993
 
    'bzrlib.repofmt.groupcompress_repo',
2994
 
    'RepositoryFormatPackGCCHK255',
2995
 
    )
2996
 
format_registry.register_lazy(
2997
 
    'Bazaar development format - hash255chk+gc rich-root bigpage (needs bzr.dev from 1.14)\n',
2998
 
    'bzrlib.repofmt.groupcompress_repo',
2999
 
    'RepositoryFormatPackGCCHK255Big',
 
3371
 
 
3372
# 1.14->1.16 go below here
 
3373
format_registry.register_lazy(
 
3374
    'Bazaar development format - group compression and chk inventory'
 
3375
        ' (needs bzr.dev from 1.14)\n',
 
3376
    'bzrlib.repofmt.groupcompress_repo',
 
3377
    'RepositoryFormatCHK1',
 
3378
    )
 
3379
 
 
3380
format_registry.register_lazy(
 
3381
    'Bazaar development format - chk repository with bencode revision '
 
3382
        'serialization (needs bzr.dev from 1.16)\n',
 
3383
    'bzrlib.repofmt.groupcompress_repo',
 
3384
    'RepositoryFormatCHK2',
 
3385
    )
 
3386
format_registry.register_lazy(
 
3387
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
 
3388
    'bzrlib.repofmt.groupcompress_repo',
 
3389
    'RepositoryFormat2a',
3000
3390
    )
3001
3391
 
3002
3392
 
3041
3431
 
3042
3432
        :param revision_id: if None all content is copied, if NULL_REVISION no
3043
3433
                            content is copied.
3044
 
        :param pb: optional progress bar to use for progress reports. If not
3045
 
                   provided a default one will be created.
 
3434
        :param pb: ignored.
3046
3435
        :return: None.
3047
3436
        """
 
3437
        ui.ui_factory.warn_experimental_format_fetch(self)
3048
3438
        from bzrlib.fetch import RepoFetcher
 
3439
        # See <https://launchpad.net/bugs/456077> asking for a warning here
 
3440
        if self.source._format.network_name() != self.target._format.network_name():
 
3441
            ui.ui_factory.show_user_warning('cross_format_fetch',
 
3442
                from_format=self.source._format,
 
3443
                to_format=self.target._format)
3049
3444
        f = RepoFetcher(to_repository=self.target,
3050
3445
                               from_repository=self.source,
3051
3446
                               last_revision=revision_id,
3052
3447
                               fetch_spec=fetch_spec,
3053
 
                               pb=pb, find_ghosts=find_ghosts)
 
3448
                               find_ghosts=find_ghosts)
3054
3449
 
3055
3450
    def _walk_to_common_revisions(self, revision_ids):
3056
3451
        """Walk out from revision_ids in source to revisions target has.
3060
3455
        """
3061
3456
        target_graph = self.target.get_graph()
3062
3457
        revision_ids = frozenset(revision_ids)
3063
 
        # Fast path for the case where all the revisions are already in the
3064
 
        # target repo.
3065
 
        # (Although this does incur an extra round trip for the
3066
 
        # fairly common case where the target doesn't already have the revision
3067
 
        # we're pushing.)
3068
 
        if set(target_graph.get_parent_map(revision_ids)) == revision_ids:
3069
 
            return graph.SearchResult(revision_ids, set(), 0, set())
3070
3458
        missing_revs = set()
3071
3459
        source_graph = self.source.get_graph()
3072
3460
        # ensure we don't pay silly lookup costs.
3232
3620
                self.target.texts.insert_record_stream(
3233
3621
                    self.source.texts.get_record_stream(
3234
3622
                        self.source.texts.keys(), 'topological', False))
3235
 
                pb.update('copying inventory', 0, 1)
 
3623
                pb.update('Copying inventory', 0, 1)
3236
3624
                self.target.inventories.insert_record_stream(
3237
3625
                    self.source.inventories.get_record_stream(
3238
3626
                        self.source.inventories.keys(), 'topological', False))
3259
3647
        # so the first thing is to get a subset of the revisions to
3260
3648
        # satisfy revision_id in source, and then eliminate those that
3261
3649
        # we do already have.
3262
 
        # this is slow on high latency connection to self, but as as this
 
3650
        # this is slow on high latency connection to self, but as this
3263
3651
        # disk format scales terribly for push anyway due to rewriting
3264
3652
        # inventory.weave, this is considered acceptable.
3265
3653
        # - RBC 20060209
3352
3740
        return self.source.revision_ids_to_search_result(result_set)
3353
3741
 
3354
3742
 
3355
 
class InterPackRepo(InterSameDataRepository):
3356
 
    """Optimised code paths between Pack based repositories."""
3357
 
 
3358
 
    @classmethod
3359
 
    def _get_repo_format_to_test(self):
3360
 
        from bzrlib.repofmt import pack_repo
3361
 
        return pack_repo.RepositoryFormatKnitPack1()
3362
 
 
3363
 
    @staticmethod
3364
 
    def is_compatible(source, target):
3365
 
        """Be compatible with known Pack formats.
3366
 
 
3367
 
        We don't test for the stores being of specific types because that
3368
 
        could lead to confusing results, and there is no need to be
3369
 
        overly general.
3370
 
 
3371
 
        Do not support CHK based repositories at this point.
3372
 
        """
3373
 
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
3374
 
        # XXX: This format is scheduled for termination
3375
 
        # from bzrlib.repofmt.groupcompress_repo import (
3376
 
        #     RepositoryFormatPackGCPlain,
3377
 
        #     )
3378
 
        try:
3379
 
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
3380
 
                isinstance(target._format, RepositoryFormatPack))
3381
 
        except AttributeError:
3382
 
            return False
3383
 
        if not are_packs:
3384
 
            return False
3385
 
        # if (isinstance(source._format, RepositoryFormatPackGCPlain)
3386
 
        #     or isinstance(target._format, RepositoryFormatPackGCPlain)):
3387
 
        #     return False
3388
 
        return (InterRepository._same_model(source, target) and
3389
 
            not source._format.supports_chks)
3390
 
 
3391
 
    @needs_write_lock
3392
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
3393
 
            fetch_spec=None):
3394
 
        """See InterRepository.fetch()."""
3395
 
        if (len(self.source._fallback_repositories) > 0 or
3396
 
            len(self.target._fallback_repositories) > 0):
3397
 
            # The pack layer is not aware of fallback repositories, so when
3398
 
            # fetching from a stacked repository or into a stacked repository
3399
 
            # we use the generic fetch logic which uses the VersionedFiles
3400
 
            # attributes on repository.
3401
 
            from bzrlib.fetch import RepoFetcher
3402
 
            fetcher = RepoFetcher(self.target, self.source, revision_id,
3403
 
                    pb, find_ghosts, fetch_spec=fetch_spec)
3404
 
        if fetch_spec is not None:
3405
 
            if len(list(fetch_spec.heads)) != 1:
3406
 
                raise AssertionError(
3407
 
                    "InterPackRepo.fetch doesn't support "
3408
 
                    "fetching multiple heads yet.")
3409
 
            revision_id = list(fetch_spec.heads)[0]
3410
 
            fetch_spec = None
3411
 
        if revision_id is None:
3412
 
            # TODO:
3413
 
            # everything to do - use pack logic
3414
 
            # to fetch from all packs to one without
3415
 
            # inventory parsing etc, IFF nothing to be copied is in the target.
3416
 
            # till then:
3417
 
            source_revision_ids = frozenset(self.source.all_revision_ids())
3418
 
            revision_ids = source_revision_ids - \
3419
 
                frozenset(self.target.get_parent_map(source_revision_ids))
3420
 
            revision_keys = [(revid,) for revid in revision_ids]
3421
 
            index = self.target._pack_collection.revision_index.combined_index
3422
 
            present_revision_ids = set(item[1][0] for item in
3423
 
                index.iter_entries(revision_keys))
3424
 
            revision_ids = set(revision_ids) - present_revision_ids
3425
 
            # implementing the TODO will involve:
3426
 
            # - detecting when all of a pack is selected
3427
 
            # - avoiding as much as possible pre-selection, so the
3428
 
            # more-core routines such as create_pack_from_packs can filter in
3429
 
            # a just-in-time fashion. (though having a HEADS list on a
3430
 
            # repository might make this a lot easier, because we could
3431
 
            # sensibly detect 'new revisions' without doing a full index scan.
3432
 
        elif _mod_revision.is_null(revision_id):
3433
 
            # nothing to do:
3434
 
            return (0, [])
3435
 
        else:
3436
 
            try:
3437
 
                revision_ids = self.search_missing_revision_ids(revision_id,
3438
 
                    find_ghosts=find_ghosts).get_keys()
3439
 
            except errors.NoSuchRevision:
3440
 
                raise errors.InstallFailed([revision_id])
3441
 
            if len(revision_ids) == 0:
3442
 
                return (0, [])
3443
 
        return self._pack(self.source, self.target, revision_ids)
3444
 
 
3445
 
    def _pack(self, source, target, revision_ids):
3446
 
        from bzrlib.repofmt.pack_repo import Packer
3447
 
        packs = source._pack_collection.all_packs()
3448
 
        pack = Packer(self.target._pack_collection, packs, '.fetch',
3449
 
            revision_ids).pack()
3450
 
        if pack is not None:
3451
 
            self.target._pack_collection._save_pack_names()
3452
 
            copied_revs = pack.get_revision_count()
3453
 
            # Trigger an autopack. This may duplicate effort as we've just done
3454
 
            # a pack creation, but for now it is simpler to think about as
3455
 
            # 'upload data, then repack if needed'.
3456
 
            self.target._pack_collection.autopack()
3457
 
            return (copied_revs, [])
3458
 
        else:
3459
 
            return (0, [])
3460
 
 
3461
 
    @needs_read_lock
3462
 
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3463
 
        """See InterRepository.missing_revision_ids().
3464
 
 
3465
 
        :param find_ghosts: Find ghosts throughout the ancestry of
3466
 
            revision_id.
3467
 
        """
3468
 
        if not find_ghosts and revision_id is not None:
3469
 
            return self._walk_to_common_revisions([revision_id])
3470
 
        elif revision_id is not None:
3471
 
            # Find ghosts: search for revisions pointing from one repository to
3472
 
            # the other, and vice versa, anywhere in the history of revision_id.
3473
 
            graph = self.target.get_graph(other_repository=self.source)
3474
 
            searcher = graph._make_breadth_first_searcher([revision_id])
3475
 
            found_ids = set()
3476
 
            while True:
3477
 
                try:
3478
 
                    next_revs, ghosts = searcher.next_with_ghosts()
3479
 
                except StopIteration:
3480
 
                    break
3481
 
                if revision_id in ghosts:
3482
 
                    raise errors.NoSuchRevision(self.source, revision_id)
3483
 
                found_ids.update(next_revs)
3484
 
                found_ids.update(ghosts)
3485
 
            found_ids = frozenset(found_ids)
3486
 
            # Double query here: should be able to avoid this by changing the
3487
 
            # graph api further.
3488
 
            result_set = found_ids - frozenset(
3489
 
                self.target.get_parent_map(found_ids))
3490
 
        else:
3491
 
            source_ids = self.source.all_revision_ids()
3492
 
            # source_ids is the worst possible case we may need to pull.
3493
 
            # now we want to filter source_ids against what we actually
3494
 
            # have in target, but don't try to check for existence where we know
3495
 
            # we do not have a revision as that would be pointless.
3496
 
            target_ids = set(self.target.all_revision_ids())
3497
 
            result_set = set(source_ids).difference(target_ids)
3498
 
        return self.source.revision_ids_to_search_result(result_set)
3499
 
 
3500
 
 
3501
 
class InterDifferingSerializer(InterKnitRepo):
 
3743
class InterDifferingSerializer(InterRepository):
3502
3744
 
3503
3745
    @classmethod
3504
3746
    def _get_repo_format_to_test(self):
3507
3749
    @staticmethod
3508
3750
    def is_compatible(source, target):
3509
3751
        """Be compatible with Knit2 source and Knit3 target"""
3510
 
        # XXX: What do we need to do to support fetching them?
3511
 
        # if source.supports_rich_root() != target.supports_rich_root():
3512
 
        #     return False
3513
 
        # Ideally, we'd support fetching if the source had no tree references
3514
 
        # even if it supported them...
3515
 
        # XXX: What do we need to do to support fetching them?
3516
 
        # if (getattr(source._format, 'supports_tree_reference', False) and
3517
 
        #     not getattr(target._format, 'supports_tree_reference', False)):
3518
 
        #    return False
 
3752
        # This is redundant with format.check_conversion_target(), however that
 
3753
        # raises an exception, and we just want to say "False" as in we won't
 
3754
        # support converting between these formats.
 
3755
        if 'IDS_never' in debug.debug_flags:
 
3756
            return False
 
3757
        if source.supports_rich_root() and not target.supports_rich_root():
 
3758
            return False
 
3759
        if (source._format.supports_tree_reference
 
3760
            and not target._format.supports_tree_reference):
 
3761
            return False
 
3762
        if target._fallback_repositories and target._format.supports_chks:
 
3763
            # IDS doesn't know how to copy CHKs for the parent inventories it
 
3764
            # adds to stacked repos.
 
3765
            return False
 
3766
        if 'IDS_always' in debug.debug_flags:
 
3767
            return True
 
3768
        # Only use this code path for local source and target.  IDS does far
 
3769
        # too much IO (both bandwidth and roundtrips) over a network.
 
3770
        if not source.bzrdir.transport.base.startswith('file:///'):
 
3771
            return False
 
3772
        if not target.bzrdir.transport.base.startswith('file:///'):
 
3773
            return False
3519
3774
        return True
3520
3775
 
3521
 
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
 
3776
    def _get_trees(self, revision_ids, cache):
 
3777
        possible_trees = []
 
3778
        for rev_id in revision_ids:
 
3779
            if rev_id in cache:
 
3780
                possible_trees.append((rev_id, cache[rev_id]))
 
3781
            else:
 
3782
                # Not cached, but inventory might be present anyway.
 
3783
                try:
 
3784
                    tree = self.source.revision_tree(rev_id)
 
3785
                except errors.NoSuchRevision:
 
3786
                    # Nope, parent is ghost.
 
3787
                    pass
 
3788
                else:
 
3789
                    cache[rev_id] = tree
 
3790
                    possible_trees.append((rev_id, tree))
 
3791
        return possible_trees
 
3792
 
 
3793
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
3522
3794
        """Get the best delta and base for this revision.
3523
3795
 
3524
3796
        :return: (basis_id, delta)
3525
3797
        """
3526
 
        possible_trees = [(parent_id, cache[parent_id])
3527
 
                          for parent_id in parent_ids
3528
 
                           if parent_id in cache]
3529
 
        if len(possible_trees) == 0:
3530
 
            # There either aren't any parents, or the parents aren't in the
3531
 
            # cache, so just use the last converted tree
3532
 
            possible_trees.append((basis_id, cache[basis_id]))
3533
3798
        deltas = []
 
3799
        # Generate deltas against each tree, to find the shortest.
 
3800
        texts_possibly_new_in_tree = set()
3534
3801
        for basis_id, basis_tree in possible_trees:
3535
3802
            delta = tree.inventory._make_delta(basis_tree.inventory)
 
3803
            for old_path, new_path, file_id, new_entry in delta:
 
3804
                if new_path is None:
 
3805
                    # This file_id isn't present in the new rev, so we don't
 
3806
                    # care about it.
 
3807
                    continue
 
3808
                if not new_path:
 
3809
                    # Rich roots are handled elsewhere...
 
3810
                    continue
 
3811
                kind = new_entry.kind
 
3812
                if kind != 'directory' and kind != 'file':
 
3813
                    # No text record associated with this inventory entry.
 
3814
                    continue
 
3815
                # This is a directory or file that has changed somehow.
 
3816
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3536
3817
            deltas.append((len(delta), basis_id, delta))
3537
3818
        deltas.sort()
3538
3819
        return deltas[0][1:]
3539
3820
 
3540
 
    def _fetch_batch(self, revision_ids, basis_id, cache):
 
3821
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
 
3822
        """Find all parent revisions that are absent, but for which the
 
3823
        inventory is present, and copy those inventories.
 
3824
 
 
3825
        This is necessary to preserve correctness when the source is stacked
 
3826
        without fallbacks configured.  (Note that in cases like upgrade the
 
3827
        source may be not have _fallback_repositories even though it is
 
3828
        stacked.)
 
3829
        """
 
3830
        parent_revs = set()
 
3831
        for parents in parent_map.values():
 
3832
            parent_revs.update(parents)
 
3833
        present_parents = self.source.get_parent_map(parent_revs)
 
3834
        absent_parents = set(parent_revs).difference(present_parents)
 
3835
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
 
3836
            (rev_id,) for rev_id in absent_parents)
 
3837
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
 
3838
        for parent_tree in self.source.revision_trees(parent_inv_ids):
 
3839
            current_revision_id = parent_tree.get_revision_id()
 
3840
            parents_parents_keys = parent_invs_keys_for_stacking[
 
3841
                (current_revision_id,)]
 
3842
            parents_parents = [key[-1] for key in parents_parents_keys]
 
3843
            basis_id = _mod_revision.NULL_REVISION
 
3844
            basis_tree = self.source.revision_tree(basis_id)
 
3845
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
 
3846
            self.target.add_inventory_by_delta(
 
3847
                basis_id, delta, current_revision_id, parents_parents)
 
3848
            cache[current_revision_id] = parent_tree
 
3849
 
 
3850
    def _fetch_batch(self, revision_ids, basis_id, cache, a_graph=None):
3541
3851
        """Fetch across a few revisions.
3542
3852
 
3543
3853
        :param revision_ids: The revisions to copy
3544
3854
        :param basis_id: The revision_id of a tree that must be in cache, used
3545
3855
            as a basis for delta when no other base is available
3546
3856
        :param cache: A cache of RevisionTrees that we can use.
 
3857
        :param a_graph: A Graph object to determine the heads() of the
 
3858
            rich-root data stream.
3547
3859
        :return: The revision_id of the last converted tree. The RevisionTree
3548
3860
            for it will be in cache
3549
3861
        """
3555
3867
        pending_deltas = []
3556
3868
        pending_revisions = []
3557
3869
        parent_map = self.source.get_parent_map(revision_ids)
3558
 
        # NB: This fails with dubious inventory data (when inv A has rev OLD
3559
 
        # for file F, and in B, after A, has rev A for file F) when A and B are
3560
 
        # in different groups.
 
3870
        self._fetch_parent_invs_for_stacking(parent_map, cache)
 
3871
        self.source._safe_to_return_from_cache = True
3561
3872
        for tree in self.source.revision_trees(revision_ids):
 
3873
            # Find a inventory delta for this revision.
 
3874
            # Find text entries that need to be copied, too.
3562
3875
            current_revision_id = tree.get_revision_id()
3563
3876
            parent_ids = parent_map.get(current_revision_id, ())
 
3877
            parent_trees = self._get_trees(parent_ids, cache)
 
3878
            possible_trees = list(parent_trees)
 
3879
            if len(possible_trees) == 0:
 
3880
                # There either aren't any parents, or the parents are ghosts,
 
3881
                # so just use the last converted tree.
 
3882
                possible_trees.append((basis_id, cache[basis_id]))
3564
3883
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3565
 
                                                           basis_id, cache)
 
3884
                                                           possible_trees)
 
3885
            revision = self.source.get_revision(current_revision_id)
 
3886
            pending_deltas.append((basis_id, delta,
 
3887
                current_revision_id, revision.parent_ids))
3566
3888
            if self._converting_to_rich_root:
3567
3889
                self._revision_id_to_root_id[current_revision_id] = \
3568
3890
                    tree.get_root_id()
3569
 
            # Find text entries that need to be copied
 
3891
            # Determine which texts are in present in this revision but not in
 
3892
            # any of the available parents.
 
3893
            texts_possibly_new_in_tree = set()
3570
3894
            for old_path, new_path, file_id, entry in delta:
3571
 
                if new_path is not None:
3572
 
                    if not new_path:
3573
 
                        # This is the root
3574
 
                        if not self.target.supports_rich_root():
3575
 
                            # The target doesn't support rich root, so we don't
3576
 
                            # copy
3577
 
                            continue
3578
 
                        if self._converting_to_rich_root:
3579
 
                            # This can't be copied normally, we have to insert
3580
 
                            # it specially
3581
 
                            root_keys_to_create.add((file_id, entry.revision))
3582
 
                            continue
3583
 
                    text_keys.add((file_id, entry.revision))
3584
 
            revision = self.source.get_revision(current_revision_id)
3585
 
            pending_deltas.append((basis_id, delta,
3586
 
                current_revision_id, revision.parent_ids))
 
3895
                if new_path is None:
 
3896
                    # This file_id isn't present in the new rev
 
3897
                    continue
 
3898
                if not new_path:
 
3899
                    # This is the root
 
3900
                    if not self.target.supports_rich_root():
 
3901
                        # The target doesn't support rich root, so we don't
 
3902
                        # copy
 
3903
                        continue
 
3904
                    if self._converting_to_rich_root:
 
3905
                        # This can't be copied normally, we have to insert
 
3906
                        # it specially
 
3907
                        root_keys_to_create.add((file_id, entry.revision))
 
3908
                        continue
 
3909
                kind = entry.kind
 
3910
                texts_possibly_new_in_tree.add((file_id, entry.revision))
 
3911
            for basis_id, basis_tree in possible_trees:
 
3912
                basis_inv = basis_tree.inventory
 
3913
                for file_key in list(texts_possibly_new_in_tree):
 
3914
                    file_id, file_revision = file_key
 
3915
                    try:
 
3916
                        entry = basis_inv[file_id]
 
3917
                    except errors.NoSuchId:
 
3918
                        continue
 
3919
                    if entry.revision == file_revision:
 
3920
                        texts_possibly_new_in_tree.remove(file_key)
 
3921
            text_keys.update(texts_possibly_new_in_tree)
3587
3922
            pending_revisions.append(revision)
3588
3923
            cache[current_revision_id] = tree
3589
3924
            basis_id = current_revision_id
 
3925
        self.source._safe_to_return_from_cache = False
3590
3926
        # Copy file texts
3591
3927
        from_texts = self.source.texts
3592
3928
        to_texts = self.target.texts
3593
3929
        if root_keys_to_create:
3594
 
            NULL_REVISION = _mod_revision.NULL_REVISION
3595
 
            def _get_parent_keys(root_key):
3596
 
                root_id, rev_id = root_key
3597
 
                # Include direct parents of the revision, but only if they used
3598
 
                # the same root_id.
3599
 
                parent_keys = tuple([(root_id, parent_id)
3600
 
                    for parent_id in parent_map[rev_id]
3601
 
                    if parent_id != NULL_REVISION and
3602
 
                        self._revision_id_to_root_id.get(parent_id, root_id) == root_id])
3603
 
                return parent_keys
3604
 
            def new_root_data_stream():
3605
 
                for root_key in root_keys_to_create:
3606
 
                    parent_keys = _get_parent_keys(root_key)
3607
 
                    yield versionedfile.FulltextContentFactory(root_key,
3608
 
                        parent_keys, None, '')
3609
 
            to_texts.insert_record_stream(new_root_data_stream())
 
3930
            root_stream = _mod_fetch._new_root_data_stream(
 
3931
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
 
3932
                self.source, graph=a_graph)
 
3933
            to_texts.insert_record_stream(root_stream)
3610
3934
        to_texts.insert_record_stream(from_texts.get_record_stream(
3611
3935
            text_keys, self.target._format._fetch_order,
3612
3936
            not self.target._format._fetch_uses_deltas))
3613
 
        # insert deltas
 
3937
        # insert inventory deltas
3614
3938
        for delta in pending_deltas:
3615
3939
            self.target.add_inventory_by_delta(*delta)
 
3940
        if self.target._fallback_repositories:
 
3941
            # Make sure this stacked repository has all the parent inventories
 
3942
            # for the new revisions that we are about to insert.  We do this
 
3943
            # before adding the revisions so that no revision is added until
 
3944
            # all the inventories it may depend on are added.
 
3945
            # Note that this is overzealous, as we may have fetched these in an
 
3946
            # earlier batch.
 
3947
            parent_ids = set()
 
3948
            revision_ids = set()
 
3949
            for revision in pending_revisions:
 
3950
                revision_ids.add(revision.revision_id)
 
3951
                parent_ids.update(revision.parent_ids)
 
3952
            parent_ids.difference_update(revision_ids)
 
3953
            parent_ids.discard(_mod_revision.NULL_REVISION)
 
3954
            parent_map = self.source.get_parent_map(parent_ids)
 
3955
            # we iterate over parent_map and not parent_ids because we don't
 
3956
            # want to try copying any revision which is a ghost
 
3957
            for parent_tree in self.source.revision_trees(parent_map):
 
3958
                current_revision_id = parent_tree.get_revision_id()
 
3959
                parents_parents = parent_map[current_revision_id]
 
3960
                possible_trees = self._get_trees(parents_parents, cache)
 
3961
                if len(possible_trees) == 0:
 
3962
                    # There either aren't any parents, or the parents are
 
3963
                    # ghosts, so just use the last converted tree.
 
3964
                    possible_trees.append((basis_id, cache[basis_id]))
 
3965
                basis_id, delta = self._get_delta_for_revision(parent_tree,
 
3966
                    parents_parents, possible_trees)
 
3967
                self.target.add_inventory_by_delta(
 
3968
                    basis_id, delta, current_revision_id, parents_parents)
3616
3969
        # insert signatures and revisions
3617
3970
        for revision in pending_revisions:
3618
3971
            try:
3630
3983
 
3631
3984
        :param revision_ids: The list of revisions to fetch. Must be in
3632
3985
            topological order.
3633
 
        :param pb: A ProgressBar
 
3986
        :param pb: A ProgressTask
3634
3987
        :return: None
3635
3988
        """
3636
3989
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3638
3991
        cache = lru_cache.LRUCache(100)
3639
3992
        cache[basis_id] = basis_tree
3640
3993
        del basis_tree # We don't want to hang on to it here
 
3994
        hints = []
 
3995
        if self._converting_to_rich_root and len(revision_ids) > 100:
 
3996
            a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
 
3997
                                                            revision_ids)
 
3998
        else:
 
3999
            a_graph = None
 
4000
 
3641
4001
        for offset in range(0, len(revision_ids), batch_size):
3642
4002
            self.target.start_write_group()
3643
4003
            try:
3644
4004
                pb.update('Transferring revisions', offset,
3645
4005
                          len(revision_ids))
3646
4006
                batch = revision_ids[offset:offset+batch_size]
3647
 
                basis_id = self._fetch_batch(batch, basis_id, cache)
 
4007
                basis_id = self._fetch_batch(batch, basis_id, cache,
 
4008
                                             a_graph=a_graph)
3648
4009
            except:
 
4010
                self.source._safe_to_return_from_cache = False
3649
4011
                self.target.abort_write_group()
3650
4012
                raise
3651
4013
            else:
3652
 
                self.target.commit_write_group()
 
4014
                hint = self.target.commit_write_group()
 
4015
                if hint:
 
4016
                    hints.extend(hint)
 
4017
        if hints and self.target._format.pack_compresses:
 
4018
            self.target.pack(hint=hints)
3653
4019
        pb.update('Transferring revisions', len(revision_ids),
3654
4020
                  len(revision_ids))
3655
4021
 
3659
4025
        """See InterRepository.fetch()."""
3660
4026
        if fetch_spec is not None:
3661
4027
            raise AssertionError("Not implemented yet...")
 
4028
        ui.ui_factory.warn_experimental_format_fetch(self)
3662
4029
        if (not self.source.supports_rich_root()
3663
4030
            and self.target.supports_rich_root()):
3664
4031
            self._converting_to_rich_root = True
3665
4032
            self._revision_id_to_root_id = {}
3666
4033
        else:
3667
4034
            self._converting_to_rich_root = False
 
4035
        # See <https://launchpad.net/bugs/456077> asking for a warning here
 
4036
        if self.source._format.network_name() != self.target._format.network_name():
 
4037
            ui.ui_factory.show_user_warning('cross_format_fetch',
 
4038
                from_format=self.source._format,
 
4039
                to_format=self.target._format)
3668
4040
        revision_ids = self.target.search_missing_revision_ids(self.source,
3669
4041
            revision_id, find_ghosts=find_ghosts).get_keys()
3670
4042
        if not revision_ids:
3676
4048
        # Walk though all revisions; get inventory deltas, copy referenced
3677
4049
        # texts that delta references, insert the delta, revision and
3678
4050
        # signature.
3679
 
        first_rev = self.source.get_revision(revision_ids[0])
3680
4051
        if pb is None:
3681
4052
            my_pb = ui.ui_factory.nested_progress_bar()
3682
4053
            pb = my_pb
3719
4090
InterRepository.register_optimiser(InterSameDataRepository)
3720
4091
InterRepository.register_optimiser(InterWeaveRepo)
3721
4092
InterRepository.register_optimiser(InterKnitRepo)
3722
 
InterRepository.register_optimiser(InterPackRepo)
3723
4093
 
3724
4094
 
3725
4095
class CopyConverter(object):
3741
4111
        :param to_convert: The disk object to convert.
3742
4112
        :param pb: a progress bar to use for progress information.
3743
4113
        """
3744
 
        self.pb = pb
 
4114
        pb = ui.ui_factory.nested_progress_bar()
3745
4115
        self.count = 0
3746
4116
        self.total = 4
3747
4117
        # this is only useful with metadir layouts - separated repo content.
3748
4118
        # trigger an assertion if not such
3749
4119
        repo._format.get_format_string()
3750
4120
        self.repo_dir = repo.bzrdir
3751
 
        self.step('Moving repository to repository.backup')
 
4121
        pb.update('Moving repository to repository.backup')
3752
4122
        self.repo_dir.transport.move('repository', 'repository.backup')
3753
4123
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
3754
4124
        repo._format.check_conversion_target(self.target_format)
3755
4125
        self.source_repo = repo._format.open(self.repo_dir,
3756
4126
            _found=True,
3757
4127
            _override_transport=backup_transport)
3758
 
        self.step('Creating new repository')
 
4128
        pb.update('Creating new repository')
3759
4129
        converted = self.target_format.initialize(self.repo_dir,
3760
4130
                                                  self.source_repo.is_shared())
3761
4131
        converted.lock_write()
3762
4132
        try:
3763
 
            self.step('Copying content into repository.')
 
4133
            pb.update('Copying content')
3764
4134
            self.source_repo.copy_content_into(converted)
3765
4135
        finally:
3766
4136
            converted.unlock()
3767
 
        self.step('Deleting old repository content.')
 
4137
        pb.update('Deleting old repository content')
3768
4138
        self.repo_dir.transport.delete_tree('repository.backup')
3769
 
        self.pb.note('repository converted')
3770
 
 
3771
 
    def step(self, message):
3772
 
        """Update the pb by a step."""
3773
 
        self.count +=1
3774
 
        self.pb.update(message, self.count, self.total)
 
4139
        ui.ui_factory.note('repository converted')
 
4140
        pb.finished()
3775
4141
 
3776
4142
 
3777
4143
_unescape_map = {
3806
4172
 
3807
4173
class _VersionedFileChecker(object):
3808
4174
 
3809
 
    def __init__(self, repository, text_key_references=None):
 
4175
    def __init__(self, repository, text_key_references=None, ancestors=None):
3810
4176
        self.repository = repository
3811
4177
        self.text_index = self.repository._generate_text_key_index(
3812
 
            text_key_references=text_key_references)
 
4178
            text_key_references=text_key_references, ancestors=ancestors)
3813
4179
 
3814
4180
    def calculate_file_version_parents(self, text_key):
3815
4181
        """Calculate the correct parents for a file version according to
3833
4199
            revision_id) tuples for versions that are present in this versioned
3834
4200
            file, but not used by the corresponding inventory.
3835
4201
        """
 
4202
        local_progress = None
 
4203
        if progress_bar is None:
 
4204
            local_progress = ui.ui_factory.nested_progress_bar()
 
4205
            progress_bar = local_progress
 
4206
        try:
 
4207
            return self._check_file_version_parents(texts, progress_bar)
 
4208
        finally:
 
4209
            if local_progress:
 
4210
                local_progress.finished()
 
4211
 
 
4212
    def _check_file_version_parents(self, texts, progress_bar):
 
4213
        """See check_file_version_parents."""
3836
4214
        wrong_parents = {}
3837
4215
        self.file_ids = set([file_id for file_id, _ in
3838
4216
            self.text_index.iterkeys()])
3839
4217
        # text keys is now grouped by file_id
3840
 
        n_weaves = len(self.file_ids)
3841
 
        files_in_revisions = {}
3842
 
        revisions_of_files = {}
3843
4218
        n_versions = len(self.text_index)
3844
4219
        progress_bar.update('loading text store', 0, n_versions)
3845
4220
        parent_map = self.repository.texts.get_parent_map(self.text_index)
3847
4222
        text_keys = self.repository.texts.keys()
3848
4223
        unused_keys = frozenset(text_keys) - set(self.text_index)
3849
4224
        for num, key in enumerate(self.text_index.iterkeys()):
3850
 
            if progress_bar is not None:
3851
 
                progress_bar.update('checking text graph', num, n_versions)
 
4225
            progress_bar.update('checking text graph', num, n_versions)
3852
4226
            correct_parents = self.calculate_file_version_parents(key)
3853
4227
            try:
3854
4228
                knit_parents = parent_map[key]
3903
4277
        try:
3904
4278
            if resume_tokens:
3905
4279
                self.target_repo.resume_write_group(resume_tokens)
 
4280
                is_resume = True
3906
4281
            else:
3907
4282
                self.target_repo.start_write_group()
 
4283
                is_resume = False
3908
4284
            try:
3909
4285
                # locked_insert_stream performs a commit|suspend.
3910
 
                return self._locked_insert_stream(stream, src_format)
 
4286
                return self._locked_insert_stream(stream, src_format, is_resume)
3911
4287
            except:
3912
4288
                self.target_repo.abort_write_group(suppress_errors=True)
3913
4289
                raise
3914
4290
        finally:
3915
4291
            self.target_repo.unlock()
3916
4292
 
3917
 
    def _locked_insert_stream(self, stream, src_format):
 
4293
    def _locked_insert_stream(self, stream, src_format, is_resume):
3918
4294
        to_serializer = self.target_repo._format._serializer
3919
4295
        src_serializer = src_format._serializer
 
4296
        new_pack = None
3920
4297
        if to_serializer == src_serializer:
3921
4298
            # If serializers match and the target is a pack repository, set the
3922
4299
            # write cache size on the new pack.  This avoids poor performance
3936
4313
            else:
3937
4314
                new_pack.set_write_cache_size(1024*1024)
3938
4315
        for substream_type, substream in stream:
 
4316
            if 'stream' in debug.debug_flags:
 
4317
                mutter('inserting substream: %s', substream_type)
3939
4318
            if substream_type == 'texts':
3940
4319
                self.target_repo.texts.insert_record_stream(substream)
3941
4320
            elif substream_type == 'inventories':
3945
4324
                else:
3946
4325
                    self._extract_and_insert_inventories(
3947
4326
                        substream, src_serializer)
 
4327
            elif substream_type == 'inventory-deltas':
 
4328
                self._extract_and_insert_inventory_deltas(
 
4329
                    substream, src_serializer)
3948
4330
            elif substream_type == 'chk_bytes':
3949
4331
                # XXX: This doesn't support conversions, as it assumes the
3950
4332
                #      conversion was done in the fetch code.
3963
4345
                self.target_repo.signatures.insert_record_stream(substream)
3964
4346
            else:
3965
4347
                raise AssertionError('kaboom! %s' % (substream_type,))
 
4348
        # Done inserting data, and the missing_keys calculations will try to
 
4349
        # read back from the inserted data, so flush the writes to the new pack
 
4350
        # (if this is pack format).
 
4351
        if new_pack is not None:
 
4352
            new_pack._write_data('', flush=True)
 
4353
        # Find all the new revisions (including ones from resume_tokens)
 
4354
        missing_keys = self.target_repo.get_missing_parent_inventories(
 
4355
            check_for_missing_texts=is_resume)
3966
4356
        try:
3967
 
            missing_keys = set()
3968
4357
            for prefix, versioned_file in (
3969
4358
                ('texts', self.target_repo.texts),
3970
4359
                ('inventories', self.target_repo.inventories),
3971
4360
                ('revisions', self.target_repo.revisions),
3972
4361
                ('signatures', self.target_repo.signatures),
 
4362
                ('chk_bytes', self.target_repo.chk_bytes),
3973
4363
                ):
 
4364
                if versioned_file is None:
 
4365
                    continue
 
4366
                # TODO: key is often going to be a StaticTuple object
 
4367
                #       I don't believe we can define a method by which
 
4368
                #       (prefix,) + StaticTuple will work, though we could
 
4369
                #       define a StaticTuple.sq_concat that would allow you to
 
4370
                #       pass in either a tuple or a StaticTuple as the second
 
4371
                #       object, so instead we could have:
 
4372
                #       StaticTuple(prefix) + key here...
3974
4373
                missing_keys.update((prefix,) + key for key in
3975
4374
                    versioned_file.get_missing_compression_parent_keys())
3976
4375
        except NotImplementedError:
3985
4384
                # missing keys can handle suspending a write group).
3986
4385
                write_group_tokens = self.target_repo.suspend_write_group()
3987
4386
                return write_group_tokens, missing_keys
3988
 
        self.target_repo.commit_write_group()
 
4387
        hint = self.target_repo.commit_write_group()
 
4388
        if (to_serializer != src_serializer and
 
4389
            self.target_repo._format.pack_compresses):
 
4390
            self.target_repo.pack(hint=hint)
3989
4391
        return [], set()
3990
4392
 
3991
 
    def _extract_and_insert_inventories(self, substream, serializer):
 
4393
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
 
4394
        target_rich_root = self.target_repo._format.rich_root_data
 
4395
        target_tree_refs = self.target_repo._format.supports_tree_reference
 
4396
        for record in substream:
 
4397
            # Insert the delta directly
 
4398
            inventory_delta_bytes = record.get_bytes_as('fulltext')
 
4399
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
 
4400
            try:
 
4401
                parse_result = deserialiser.parse_text_bytes(
 
4402
                    inventory_delta_bytes)
 
4403
            except inventory_delta.IncompatibleInventoryDelta, err:
 
4404
                trace.mutter("Incompatible delta: %s", err.msg)
 
4405
                raise errors.IncompatibleRevision(self.target_repo._format)
 
4406
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
 
4407
            revision_id = new_id
 
4408
            parents = [key[0] for key in record.parents]
 
4409
            self.target_repo.add_inventory_by_delta(
 
4410
                basis_id, inv_delta, revision_id, parents)
 
4411
 
 
4412
    def _extract_and_insert_inventories(self, substream, serializer,
 
4413
            parse_delta=None):
3992
4414
        """Generate a new inventory versionedfile in target, converting data.
3993
4415
 
3994
4416
        The inventory is retrieved from the source, (deserializing it), and
3995
4417
        stored in the target (reserializing it in a different format).
3996
4418
        """
 
4419
        target_rich_root = self.target_repo._format.rich_root_data
 
4420
        target_tree_refs = self.target_repo._format.supports_tree_reference
3997
4421
        for record in substream:
 
4422
            # It's not a delta, so it must be a fulltext in the source
 
4423
            # serializer's format.
3998
4424
            bytes = record.get_bytes_as('fulltext')
3999
4425
            revision_id = record.key[0]
4000
4426
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4001
4427
            parents = [key[0] for key in record.parents]
4002
4428
            self.target_repo.add_inventory(revision_id, inv, parents)
 
4429
            # No need to keep holding this full inv in memory when the rest of
 
4430
            # the substream is likely to be all deltas.
 
4431
            del inv
4003
4432
 
4004
4433
    def _extract_and_insert_revisions(self, substream, serializer):
4005
4434
        for record in substream:
4054
4483
        return [('signatures', signatures), ('revisions', revisions)]
4055
4484
 
4056
4485
    def _generate_root_texts(self, revs):
4057
 
        """This will be called by __fetch between fetching weave texts and
 
4486
        """This will be called by get_stream between fetching weave texts and
4058
4487
        fetching the inventory weave.
4059
 
 
4060
 
        Subclasses should override this if they need to generate root texts
4061
 
        after fetching weave texts.
4062
4488
        """
4063
4489
        if self._rich_root_upgrade():
4064
 
            import bzrlib.fetch
4065
 
            return bzrlib.fetch.Inter1and2Helper(
 
4490
            return _mod_fetch.Inter1and2Helper(
4066
4491
                self.from_repository).generate_root_texts(revs)
4067
4492
        else:
4068
4493
            return []
4071
4496
        phase = 'file'
4072
4497
        revs = search.get_keys()
4073
4498
        graph = self.from_repository.get_graph()
4074
 
        revs = list(graph.iter_topo_order(revs))
 
4499
        revs = tsort.topo_sort(graph.get_parent_map(revs))
4075
4500
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4076
4501
        text_keys = []
4077
4502
        for knit_kind, file_id, revisions in data_to_fetch:
4096
4521
                # will be valid.
4097
4522
                for _ in self._generate_root_texts(revs):
4098
4523
                    yield _
4099
 
                # NB: This currently reopens the inventory weave in source;
4100
 
                # using a single stream interface instead would avoid this.
4101
 
                from_weave = self.from_repository.inventories
4102
4524
                # we fetch only the referenced inventories because we do not
4103
4525
                # know for unselected inventories whether all their required
4104
4526
                # texts are present in the other repository - it could be
4123
4545
        keys['texts'] = set()
4124
4546
        keys['revisions'] = set()
4125
4547
        keys['inventories'] = set()
 
4548
        keys['chk_bytes'] = set()
4126
4549
        keys['signatures'] = set()
4127
4550
        for key in missing_keys:
4128
4551
            keys[key[0]].add(key[1:])
4135
4558
                    keys['revisions'],))
4136
4559
        for substream_kind, keys in keys.iteritems():
4137
4560
            vf = getattr(self.from_repository, substream_kind)
 
4561
            if vf is None and keys:
 
4562
                    raise AssertionError(
 
4563
                        "cannot fill in keys for a versioned file we don't"
 
4564
                        " have: %s needs %s" % (substream_kind, keys))
 
4565
            if not keys:
 
4566
                # No need to stream something we don't have
 
4567
                continue
 
4568
            if substream_kind == 'inventories':
 
4569
                # Some missing keys are genuinely ghosts, filter those out.
 
4570
                present = self.from_repository.inventories.get_parent_map(keys)
 
4571
                revs = [key[0] for key in present]
 
4572
                # Get the inventory stream more-or-less as we do for the
 
4573
                # original stream; there's no reason to assume that records
 
4574
                # direct from the source will be suitable for the sink.  (Think
 
4575
                # e.g. 2a -> 1.9-rich-root).
 
4576
                for info in self._get_inventory_stream(revs, missing=True):
 
4577
                    yield info
 
4578
                continue
 
4579
 
4138
4580
            # Ask for full texts always so that we don't need more round trips
4139
4581
            # after this stream.
4140
 
            stream = vf.get_record_stream(keys,
4141
 
                self.to_format._fetch_order, True)
 
4582
            # Some of the missing keys are genuinely ghosts, so filter absent
 
4583
            # records. The Sink is responsible for doing another check to
 
4584
            # ensure that ghosts don't introduce missing data for future
 
4585
            # fetches.
 
4586
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
 
4587
                self.to_format._fetch_order, True))
4142
4588
            yield substream_kind, stream
4143
4589
 
4144
4590
    def inventory_fetch_order(self):
4151
4597
        return (not self.from_repository._format.rich_root_data and
4152
4598
            self.to_format.rich_root_data)
4153
4599
 
4154
 
    def _get_inventory_stream(self, revision_ids):
 
4600
    def _get_inventory_stream(self, revision_ids, missing=False):
4155
4601
        from_format = self.from_repository._format
4156
 
        if (from_format.supports_chks and self.to_format.supports_chks
4157
 
            and (from_format._serializer == self.to_format._serializer)):
4158
 
            # Both sides support chks, and they use the same serializer, so it
4159
 
            # is safe to transmit the chk pages and inventory pages across
4160
 
            # as-is.
4161
 
            return self._get_chk_inventory_stream(revision_ids)
4162
 
        elif (not from_format.supports_chks):
4163
 
            # Source repository doesn't support chks. So we can transmit the
4164
 
            # inventories 'as-is' and either they are just accepted on the
4165
 
            # target, or the Sink will properly convert it.
4166
 
            return self._get_simple_inventory_stream(revision_ids)
 
4602
        if (from_format.supports_chks and self.to_format.supports_chks and
 
4603
            from_format.network_name() == self.to_format.network_name()):
 
4604
            raise AssertionError(
 
4605
                "this case should be handled by GroupCHKStreamSource")
 
4606
        elif 'forceinvdeltas' in debug.debug_flags:
 
4607
            return self._get_convertable_inventory_stream(revision_ids,
 
4608
                    delta_versus_null=missing)
 
4609
        elif from_format.network_name() == self.to_format.network_name():
 
4610
            # Same format.
 
4611
            return self._get_simple_inventory_stream(revision_ids,
 
4612
                    missing=missing)
 
4613
        elif (not from_format.supports_chks and not self.to_format.supports_chks
 
4614
                and from_format._serializer == self.to_format._serializer):
 
4615
            # Essentially the same format.
 
4616
            return self._get_simple_inventory_stream(revision_ids,
 
4617
                    missing=missing)
4167
4618
        else:
4168
 
            # XXX: Hack to make not-chk->chk fetch: copy the inventories as
4169
 
            #      inventories. Note that this should probably be done somehow
4170
 
            #      as part of bzrlib.repository.StreamSink. Except JAM couldn't
4171
 
            #      figure out how a non-chk repository could possibly handle
4172
 
            #      deserializing an inventory stream from a chk repo, as it
4173
 
            #      doesn't have a way to understand individual pages.
4174
 
            return self._get_convertable_inventory_stream(revision_ids)
 
4619
            # Any time we switch serializations, we want to use an
 
4620
            # inventory-delta based approach.
 
4621
            return self._get_convertable_inventory_stream(revision_ids,
 
4622
                    delta_versus_null=missing)
4175
4623
 
4176
 
    def _get_simple_inventory_stream(self, revision_ids):
 
4624
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
 
4625
        # NB: This currently reopens the inventory weave in source;
 
4626
        # using a single stream interface instead would avoid this.
4177
4627
        from_weave = self.from_repository.inventories
 
4628
        if missing:
 
4629
            delta_closure = True
 
4630
        else:
 
4631
            delta_closure = not self.delta_on_metadata()
4178
4632
        yield ('inventories', from_weave.get_record_stream(
4179
4633
            [(rev_id,) for rev_id in revision_ids],
4180
 
            self.inventory_fetch_order(),
4181
 
            not self.delta_on_metadata()))
4182
 
 
4183
 
    def _get_chk_inventory_stream(self, revision_ids):
4184
 
        """Fetch the inventory texts, along with the associated chk maps."""
4185
 
        # We want an inventory outside of the search set, so that we can filter
4186
 
        # out uninteresting chk pages. For now we use
4187
 
        # _find_revision_outside_set, but if we had a Search with cut_revs, we
4188
 
        # could use that instead.
4189
 
        start_rev_id = self.from_repository._find_revision_outside_set(
4190
 
                            revision_ids)
4191
 
        start_rev_key = (start_rev_id,)
4192
 
        inv_keys_to_fetch = [(rev_id,) for rev_id in revision_ids]
4193
 
        if start_rev_id != _mod_revision.NULL_REVISION:
4194
 
            inv_keys_to_fetch.append((start_rev_id,))
4195
 
        # Any repo that supports chk_bytes must also support out-of-order
4196
 
        # insertion. At least, that is how we expect it to work
4197
 
        # We use get_record_stream instead of iter_inventories because we want
4198
 
        # to be able to insert the stream as well. We could instead fetch
4199
 
        # allowing deltas, and then iter_inventories, but we don't know whether
4200
 
        # source or target is more 'local' anway.
4201
 
        inv_stream = self.from_repository.inventories.get_record_stream(
4202
 
            inv_keys_to_fetch, 'unordered',
4203
 
            True) # We need them as full-texts so we can find their references
4204
 
        uninteresting_chk_roots = set()
4205
 
        interesting_chk_roots = set()
4206
 
        def filter_inv_stream(inv_stream):
4207
 
            for idx, record in enumerate(inv_stream):
4208
 
                ### child_pb.update('fetch inv', idx, len(inv_keys_to_fetch))
4209
 
                bytes = record.get_bytes_as('fulltext')
4210
 
                chk_inv = inventory.CHKInventory.deserialise(
4211
 
                    self.from_repository.chk_bytes, bytes, record.key)
4212
 
                if record.key == start_rev_key:
4213
 
                    uninteresting_chk_roots.add(chk_inv.id_to_entry.key())
4214
 
                    p_id_map = chk_inv.parent_id_basename_to_file_id
4215
 
                    if p_id_map is not None:
4216
 
                        uninteresting_chk_roots.add(p_id_map.key())
4217
 
                else:
4218
 
                    yield record
4219
 
                    interesting_chk_roots.add(chk_inv.id_to_entry.key())
4220
 
                    p_id_map = chk_inv.parent_id_basename_to_file_id
4221
 
                    if p_id_map is not None:
4222
 
                        interesting_chk_roots.add(p_id_map.key())
4223
 
        ### pb.update('fetch inventory', 0, 2)
4224
 
        yield ('inventories', filter_inv_stream(inv_stream))
4225
 
        # Now that we have worked out all of the interesting root nodes, grab
4226
 
        # all of the interesting pages and insert them
4227
 
        ### pb.update('fetch inventory', 1, 2)
4228
 
        interesting = chk_map.iter_interesting_nodes(
4229
 
            self.from_repository.chk_bytes, interesting_chk_roots,
4230
 
            uninteresting_chk_roots)
4231
 
        def to_stream_adapter():
4232
 
            """Adapt the iter_interesting_nodes result to a single stream.
4233
 
 
4234
 
            iter_interesting_nodes returns records as it processes them, which
4235
 
            can be in batches. But we only want a single stream to be inserted.
4236
 
            """
4237
 
            for record, items in interesting:
4238
 
                for value in record.itervalues():
4239
 
                    yield value
4240
 
        # XXX: We could instead call get_record_stream(records.keys())
4241
 
        #      ATM, this will always insert the records as fulltexts, and
4242
 
        #      requires that you can hang on to records once you have gone
4243
 
        #      on to the next one. Further, it causes the target to
4244
 
        #      recompress the data. Testing shows it to be faster than
4245
 
        #      requesting the records again, though.
4246
 
        yield ('chk_bytes', to_stream_adapter())
4247
 
        ### pb.update('fetch inventory', 2, 2)
4248
 
 
4249
 
    def _get_convertable_inventory_stream(self, revision_ids):
4250
 
        # XXX: One of source or target is using chks, and they don't have
4251
 
        #      compatible serializations. The StreamSink code expects to be
4252
 
        #      able to convert on the target, so we need to put
4253
 
        #      bytes-on-the-wire that can be converted
4254
 
        yield ('inventories', self._stream_invs_as_fulltexts(revision_ids))
4255
 
 
4256
 
    def _stream_invs_as_fulltexts(self, revision_ids):
 
4634
            self.inventory_fetch_order(), delta_closure))
 
4635
 
 
4636
    def _get_convertable_inventory_stream(self, revision_ids,
 
4637
                                          delta_versus_null=False):
 
4638
        # The two formats are sufficiently different that there is no fast
 
4639
        # path, so we need to send just inventorydeltas, which any
 
4640
        # sufficiently modern client can insert into any repository.
 
4641
        # The StreamSink code expects to be able to
 
4642
        # convert on the target, so we need to put bytes-on-the-wire that can
 
4643
        # be converted.  That means inventory deltas (if the remote is <1.19,
 
4644
        # RemoteStreamSink will fallback to VFS to insert the deltas).
 
4645
        yield ('inventory-deltas',
 
4646
           self._stream_invs_as_deltas(revision_ids,
 
4647
                                       delta_versus_null=delta_versus_null))
 
4648
 
 
4649
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
 
4650
        """Return a stream of inventory-deltas for the given rev ids.
 
4651
 
 
4652
        :param revision_ids: The list of inventories to transmit
 
4653
        :param delta_versus_null: Don't try to find a minimal delta for this
 
4654
            entry, instead compute the delta versus the NULL_REVISION. This
 
4655
            effectively streams a complete inventory. Used for stuff like
 
4656
            filling in missing parents, etc.
 
4657
        """
4257
4658
        from_repo = self.from_repository
4258
 
        from_serializer = from_repo._format._serializer
4259
4659
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4260
4660
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
4261
 
        for inv in self.from_repository.iter_inventories(revision_ids):
4262
 
            # XXX: This is a bit hackish, but it works. Basically,
4263
 
            #      CHKSerializer 'accidentally' supports
4264
 
            #      read/write_inventory_to_string, even though that is never
4265
 
            #      the format that is stored on disk. It *does* give us a
4266
 
            #      single string representation for an inventory, so live with
4267
 
            #      it for now.
4268
 
            #      This would be far better if we had a 'serialized inventory
4269
 
            #      delta' form. Then we could use 'inventory._make_delta', and
4270
 
            #      transmit that. This would both be faster to generate, and
4271
 
            #      result in fewer bytes-on-the-wire.
4272
 
            as_bytes = from_serializer.write_inventory_to_string(inv)
 
4661
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
 
4662
        # method...
 
4663
        inventories = self.from_repository.iter_inventories(
 
4664
            revision_ids, 'topological')
 
4665
        format = from_repo._format
 
4666
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
 
4667
        inventory_cache = lru_cache.LRUCache(50)
 
4668
        null_inventory = from_repo.revision_tree(
 
4669
            _mod_revision.NULL_REVISION).inventory
 
4670
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
 
4671
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
 
4672
        # repo back into a non-rich-root repo ought to be allowed)
 
4673
        serializer = inventory_delta.InventoryDeltaSerializer(
 
4674
            versioned_root=format.rich_root_data,
 
4675
            tree_references=format.supports_tree_reference)
 
4676
        for inv in inventories:
4273
4677
            key = (inv.revision_id,)
4274
4678
            parent_keys = parent_map.get(key, ())
 
4679
            delta = None
 
4680
            if not delta_versus_null and parent_keys:
 
4681
                # The caller did not ask for complete inventories and we have
 
4682
                # some parents that we can delta against.  Make a delta against
 
4683
                # each parent so that we can find the smallest.
 
4684
                parent_ids = [parent_key[0] for parent_key in parent_keys]
 
4685
                for parent_id in parent_ids:
 
4686
                    if parent_id not in invs_sent_so_far:
 
4687
                        # We don't know that the remote side has this basis, so
 
4688
                        # we can't use it.
 
4689
                        continue
 
4690
                    if parent_id == _mod_revision.NULL_REVISION:
 
4691
                        parent_inv = null_inventory
 
4692
                    else:
 
4693
                        parent_inv = inventory_cache.get(parent_id, None)
 
4694
                        if parent_inv is None:
 
4695
                            parent_inv = from_repo.get_inventory(parent_id)
 
4696
                    candidate_delta = inv._make_delta(parent_inv)
 
4697
                    if (delta is None or
 
4698
                        len(delta) > len(candidate_delta)):
 
4699
                        delta = candidate_delta
 
4700
                        basis_id = parent_id
 
4701
            if delta is None:
 
4702
                # Either none of the parents ended up being suitable, or we
 
4703
                # were asked to delta against NULL
 
4704
                basis_id = _mod_revision.NULL_REVISION
 
4705
                delta = inv._make_delta(null_inventory)
 
4706
            invs_sent_so_far.add(inv.revision_id)
 
4707
            inventory_cache[inv.revision_id] = inv
 
4708
            delta_serialized = ''.join(
 
4709
                serializer.delta_to_lines(basis_id, key[-1], delta))
4275
4710
            yield versionedfile.FulltextContentFactory(
4276
 
                key, parent_keys, None, as_bytes)
 
4711
                key, parent_keys, None, delta_serialized)
 
4712
 
 
4713
 
 
4714
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
 
4715
                    stop_revision=None):
 
4716
    """Extend the partial history to include a given index
 
4717
 
 
4718
    If a stop_index is supplied, stop when that index has been reached.
 
4719
    If a stop_revision is supplied, stop when that revision is
 
4720
    encountered.  Otherwise, stop when the beginning of history is
 
4721
    reached.
 
4722
 
 
4723
    :param stop_index: The index which should be present.  When it is
 
4724
        present, history extension will stop.
 
4725
    :param stop_revision: The revision id which should be present.  When
 
4726
        it is encountered, history extension will stop.
 
4727
    """
 
4728
    start_revision = partial_history_cache[-1]
 
4729
    iterator = repo.iter_reverse_revision_history(start_revision)
 
4730
    try:
 
4731
        #skip the last revision in the list
 
4732
        iterator.next()
 
4733
        while True:
 
4734
            if (stop_index is not None and
 
4735
                len(partial_history_cache) > stop_index):
 
4736
                break
 
4737
            if partial_history_cache[-1] == stop_revision:
 
4738
                break
 
4739
            revision_id = iterator.next()
 
4740
            partial_history_cache.append(revision_id)
 
4741
    except StopIteration:
 
4742
        # No more history
 
4743
        return
4277
4744