~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-03-24 23:19:12 UTC
  • mfrom: (4190.1.6 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20090324231912-rb0kgktzkvge8aea
(robertc) Negatively cache ghosts and misses during read-locks in
        RemoteRepository. (Robert Collins, Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
23
23
from bzrlib import (
24
24
    bzrdir,
25
25
    check,
26
 
    chk_map,
27
 
    config,
28
26
    debug,
29
27
    errors,
30
 
    fetch as _mod_fetch,
31
28
    fifo_cache,
32
29
    generate_ids,
33
30
    gpg,
34
31
    graph,
35
 
    inventory,
36
 
    inventory_delta,
37
32
    lazy_regex,
38
33
    lockable_files,
39
34
    lockdir,
40
35
    lru_cache,
41
36
    osutils,
42
37
    revision as _mod_revision,
43
 
    static_tuple,
44
38
    symbol_versioning,
45
 
    trace,
46
39
    tsort,
47
40
    ui,
48
41
    versionedfile,
53
46
from bzrlib.testament import Testament
54
47
""")
55
48
 
56
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
57
50
from bzrlib.inter import InterObject
58
51
from bzrlib.inventory import (
59
52
    Inventory,
61
54
    ROOT_ID,
62
55
    entry_factory,
63
56
    )
64
 
from bzrlib.lock import _RelockDebugMixin
65
57
from bzrlib import registry
 
58
from bzrlib.symbol_versioning import (
 
59
        deprecated_method,
 
60
        )
66
61
from bzrlib.trace import (
67
62
    log_exception_quietly, note, mutter, mutter_callsite, warning)
68
63
 
202
197
 
203
198
    def finish_inventory(self):
204
199
        """Tell the builder that the inventory is finished.
205
 
 
 
200
        
206
201
        :return: The inventory id in the repository, which can be used with
207
202
            repository.get_inventory.
208
203
        """
210
205
            # an inventory delta was accumulated without creating a new
211
206
            # inventory.
212
207
            basis_id = self.basis_delta_revision
213
 
            # We ignore the 'inventory' returned by add_inventory_by_delta
214
 
            # because self.new_inventory is used to hint to the rest of the
215
 
            # system what code path was taken
216
 
            self.inv_sha1, _ = self.repository.add_inventory_by_delta(
 
208
            self.inv_sha1 = self.repository.add_inventory_by_delta(
217
209
                basis_id, self._basis_delta, self._new_revision_id,
218
210
                self.parents)
219
211
        else:
332
324
            raise AssertionError("recording deletes not activated.")
333
325
        delta = (path, None, file_id, None)
334
326
        self._basis_delta.append(delta)
335
 
        self._any_changes = True
336
327
        return delta
337
328
 
338
329
    def will_record_deletes(self):
473
464
            if content_summary[2] is None:
474
465
                raise ValueError("Files must not have executable = None")
475
466
            if not store:
476
 
                # We can't trust a check of the file length because of content
477
 
                # filtering...
478
 
                if (# if the exec bit has changed we have to store:
 
467
                if (# if the file length changed we have to store:
 
468
                    parent_entry.text_size != content_summary[1] or
 
469
                    # if the exec bit has changed we have to store:
479
470
                    parent_entry.executable != content_summary[2]):
480
471
                    store = True
481
472
                elif parent_entry.text_sha1 == content_summary[3]:
500
491
            ie.executable = content_summary[2]
501
492
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
502
493
            try:
503
 
                text = file_obj.read()
 
494
                lines = file_obj.readlines()
504
495
            finally:
505
496
                file_obj.close()
506
497
            try:
507
498
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
508
 
                    ie.file_id, text, heads, nostore_sha)
 
499
                    ie.file_id, lines, heads, nostore_sha)
509
500
                # Let the caller know we generated a stat fingerprint.
510
501
                fingerprint = (ie.text_sha1, stat_value)
511
502
            except errors.ExistingContent:
523
514
                # carry over:
524
515
                ie.revision = parent_entry.revision
525
516
                return self._get_delta(ie, basis_inv, path), False, None
526
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
517
            lines = []
 
518
            self._add_text_to_weave(ie.file_id, lines, heads, None)
527
519
        elif kind == 'symlink':
528
520
            current_link_target = content_summary[3]
529
521
            if not store:
537
529
                ie.symlink_target = parent_entry.symlink_target
538
530
                return self._get_delta(ie, basis_inv, path), False, None
539
531
            ie.symlink_target = current_link_target
540
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
532
            lines = []
 
533
            self._add_text_to_weave(ie.file_id, lines, heads, None)
541
534
        elif kind == 'tree-reference':
542
535
            if not store:
543
536
                if content_summary[3] != parent_entry.reference_revision:
548
541
                ie.revision = parent_entry.revision
549
542
                return self._get_delta(ie, basis_inv, path), False, None
550
543
            ie.reference_revision = content_summary[3]
551
 
            if ie.reference_revision is None:
552
 
                raise AssertionError("invalid content_summary for nested tree: %r"
553
 
                    % (content_summary,))
554
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
544
            lines = []
 
545
            self._add_text_to_weave(ie.file_id, lines, heads, None)
555
546
        else:
556
547
            raise NotImplementedError('unknown kind')
557
548
        ie.revision = self._new_revision_id
567
558
            has been generated against. Currently assumed to be the same
568
559
            as self.parents[0] - if it is not, errors may occur.
569
560
        :param iter_changes: An iter_changes iterator with the changes to apply
570
 
            to basis_revision_id. The iterator must not include any items with
571
 
            a current kind of None - missing items must be either filtered out
572
 
            or errored-on beefore record_iter_changes sees the item.
 
561
            to basis_revision_id.
573
562
        :param _entry_factory: Private method to bind entry_factory locally for
574
563
            performance.
575
 
        :return: A generator of (file_id, relpath, fs_hash) tuples for use with
576
 
            tree._observed_sha1.
 
564
        :return: None
577
565
        """
578
566
        # Create an inventory delta based on deltas between all the parents and
579
567
        # deltas between all the parent inventories. We use inventory delta's 
586
574
        # {file_id -> revision_id -> inventory entry, for entries in parent
587
575
        # trees that are not parents[0]
588
576
        parent_entries = {}
589
 
        ghost_basis = False
590
 
        try:
591
 
            revtrees = list(self.repository.revision_trees(self.parents))
592
 
        except errors.NoSuchRevision:
593
 
            # one or more ghosts, slow path.
594
 
            revtrees = []
595
 
            for revision_id in self.parents:
596
 
                try:
597
 
                    revtrees.append(self.repository.revision_tree(revision_id))
598
 
                except errors.NoSuchRevision:
599
 
                    if not revtrees:
600
 
                        basis_revision_id = _mod_revision.NULL_REVISION
601
 
                        ghost_basis = True
602
 
                    revtrees.append(self.repository.revision_tree(
603
 
                        _mod_revision.NULL_REVISION))
 
577
        revtrees = list(self.repository.revision_trees(self.parents))
604
578
        # The basis inventory from a repository 
605
579
        if revtrees:
606
580
            basis_inv = revtrees[0].inventory
608
582
            basis_inv = self.repository.revision_tree(
609
583
                _mod_revision.NULL_REVISION).inventory
610
584
        if len(self.parents) > 0:
611
 
            if basis_revision_id != self.parents[0] and not ghost_basis:
 
585
            if basis_revision_id != self.parents[0]:
612
586
                raise Exception(
613
587
                    "arbitrary basis parents not yet supported with merges")
614
588
            for revtree in revtrees[1:]:
618
592
                        continue
619
593
                    if change[2] not in merged_ids:
620
594
                        if change[0] is not None:
621
 
                            basis_entry = basis_inv[change[2]]
622
595
                            merged_ids[change[2]] = [
623
 
                                # basis revid
624
 
                                basis_entry.revision,
625
 
                                # new tree revid
 
596
                                basis_inv[change[2]].revision,
626
597
                                change[3].revision]
627
 
                            parent_entries[change[2]] = {
628
 
                                # basis parent
629
 
                                basis_entry.revision:basis_entry,
630
 
                                # this parent 
631
 
                                change[3].revision:change[3],
632
 
                                }
633
598
                        else:
634
599
                            merged_ids[change[2]] = [change[3].revision]
635
 
                            parent_entries[change[2]] = {change[3].revision:change[3]}
 
600
                        parent_entries[change[2]] = {change[3].revision:change[3]}
636
601
                    else:
637
602
                        merged_ids[change[2]].append(change[3].revision)
638
603
                        parent_entries[change[2]][change[3].revision] = change[3]
663
628
            # inv delta  change: (file_id, (path_in_source, path_in_target),
664
629
            #   changed_content, versioned, parent, name, kind,
665
630
            #   executable)
666
 
            try:
667
 
                basis_entry = basis_inv[file_id]
668
 
            except errors.NoSuchId:
669
 
                # a change from basis->some_parents but file_id isn't in basis
670
 
                # so was new in the merge, which means it must have changed
671
 
                # from basis -> current, and as it hasn't the add was reverted
672
 
                # by the user. So we discard this change.
673
 
                pass
674
 
            else:
675
 
                change = (file_id,
676
 
                    (basis_inv.id2path(file_id), tree.id2path(file_id)),
677
 
                    False, (True, True),
678
 
                    (basis_entry.parent_id, basis_entry.parent_id),
679
 
                    (basis_entry.name, basis_entry.name),
680
 
                    (basis_entry.kind, basis_entry.kind),
681
 
                    (basis_entry.executable, basis_entry.executable))
682
 
                changes[file_id] = (change, merged_ids[file_id])
 
631
            basis_entry = basis_inv[file_id]
 
632
            change = (file_id,
 
633
                (basis_inv.id2path(file_id), tree.id2path(file_id)),
 
634
                False, (True, True),
 
635
                (basis_entry.parent_id, basis_entry.parent_id),
 
636
                (basis_entry.name, basis_entry.name),
 
637
                (basis_entry.kind, basis_entry.kind),
 
638
                (basis_entry.executable, basis_entry.executable))
 
639
            changes[file_id] = (change, merged_ids[file_id])
683
640
        # changes contains tuples with the change and a set of inventory
684
641
        # candidates for the file.
685
642
        # inv delta is:
751
708
                        entry.executable = True
752
709
                    else:
753
710
                        entry.executable = False
754
 
                    if (carry_over_possible and
 
711
                    if (carry_over_possible and 
755
712
                        parent_entry.executable == entry.executable):
756
713
                            # Check the file length, content hash after reading
757
714
                            # the file.
760
717
                        nostore_sha = None
761
718
                    file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
762
719
                    try:
763
 
                        text = file_obj.read()
 
720
                        lines = file_obj.readlines()
764
721
                    finally:
765
722
                        file_obj.close()
766
723
                    try:
767
724
                        entry.text_sha1, entry.text_size = self._add_text_to_weave(
768
 
                            file_id, text, heads, nostore_sha)
769
 
                        yield file_id, change[1][1], (entry.text_sha1, stat_value)
 
725
                            file_id, lines, heads, nostore_sha)
770
726
                    except errors.ExistingContent:
771
727
                        # No content change against a carry_over parent
772
 
                        # Perhaps this should also yield a fs hash update?
773
728
                        carried_over = True
774
729
                        entry.text_size = parent_entry.text_size
775
730
                        entry.text_sha1 = parent_entry.text_sha1
778
733
                    entry.symlink_target = tree.get_symlink_target(file_id)
779
734
                    if (carry_over_possible and
780
735
                        parent_entry.symlink_target == entry.symlink_target):
781
 
                        carried_over = True
 
736
                            carried_over = True
782
737
                    else:
783
 
                        self._add_text_to_weave(change[0], '', heads, None)
 
738
                        self._add_text_to_weave(change[0], [], heads, None)
784
739
                elif kind == 'directory':
785
740
                    if carry_over_possible:
786
741
                        carried_over = True
788
743
                        # Nothing to set on the entry.
789
744
                        # XXX: split into the Root and nonRoot versions.
790
745
                        if change[1][1] != '' or self.repository.supports_rich_root():
791
 
                            self._add_text_to_weave(change[0], '', heads, None)
 
746
                            self._add_text_to_weave(change[0], [], heads, None)
792
747
                elif kind == 'tree-reference':
793
 
                    if not self.repository._format.supports_tree_reference:
794
 
                        # This isn't quite sane as an error, but we shouldn't
795
 
                        # ever see this code path in practice: tree's don't
796
 
                        # permit references when the repo doesn't support tree
797
 
                        # references.
798
 
                        raise errors.UnsupportedOperation(tree.add_reference,
799
 
                            self.repository)
800
 
                    reference_revision = tree.get_reference_revision(change[0])
801
 
                    entry.reference_revision = reference_revision
802
 
                    if (carry_over_possible and
803
 
                        parent_entry.reference_revision == reference_revision):
804
 
                        carried_over = True
805
 
                    else:
806
 
                        self._add_text_to_weave(change[0], '', heads, None)
 
748
                    raise AssertionError('unknown kind %r' % kind)
807
749
                else:
808
750
                    raise AssertionError('unknown kind %r' % kind)
809
751
                if not carried_over:
818
760
                seen_root = True
819
761
        self.new_inventory = None
820
762
        if len(inv_delta):
821
 
            # This should perhaps be guarded by a check that the basis we
822
 
            # commit against is the basis for the commit and if not do a delta
823
 
            # against the basis.
824
763
            self._any_changes = True
825
764
        if not seen_root:
826
765
            # housekeeping root entry changes do not affect no-change commits.
827
766
            self._require_root_change(tree)
828
767
        self.basis_delta_revision = basis_revision_id
829
768
 
830
 
    def _add_text_to_weave(self, file_id, new_text, parents, nostore_sha):
831
 
        parent_keys = tuple([(file_id, parent) for parent in parents])
832
 
        return self.repository.texts._add_text(
833
 
            (file_id, self._new_revision_id), parent_keys, new_text,
834
 
            nostore_sha=nostore_sha, random_id=self.random_revid)[0:2]
 
769
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
 
770
        # Note: as we read the content directly from the tree, we know its not
 
771
        # been turned into unicode or badly split - but a broken tree
 
772
        # implementation could give us bad output from readlines() so this is
 
773
        # not a guarantee of safety. What would be better is always checking
 
774
        # the content during test suite execution. RBC 20070912
 
775
        parent_keys = tuple((file_id, parent) for parent in parents)
 
776
        return self.repository.texts.add_lines(
 
777
            (file_id, self._new_revision_id), parent_keys, new_lines,
 
778
            nostore_sha=nostore_sha, random_id=self.random_revid,
 
779
            check_content=False)[0:2]
835
780
 
836
781
 
837
782
class RootCommitBuilder(CommitBuilder):
860
805
        # versioned roots do not change unless the tree found a change.
861
806
 
862
807
 
863
 
class RepositoryWriteLockResult(object):
864
 
    """The result of write locking a repository.
865
 
 
866
 
    :ivar repository_token: The token obtained from the underlying lock, or
867
 
        None.
868
 
    :ivar unlock: A callable which will unlock the lock.
869
 
    """
870
 
 
871
 
    def __init__(self, unlock, repository_token):
872
 
        self.repository_token = repository_token
873
 
        self.unlock = unlock
874
 
 
875
 
    def __str__(self):
876
 
        return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
877
 
            self.unlock)
878
 
 
879
 
 
880
808
######################################################################
881
809
# Repositories
882
810
 
883
 
 
884
 
class Repository(_RelockDebugMixin, bzrdir.ControlComponent):
 
811
class Repository(object):
885
812
    """Repository holding history for one or more branches.
886
813
 
887
814
    The repository holds and retrieves historical information including
889
816
    which views a particular line of development through that history.
890
817
 
891
818
    The Repository builds on top of some byte storage facilies (the revisions,
892
 
    signatures, inventories, texts and chk_bytes attributes) and a Transport,
893
 
    which respectively provide byte storage and a means to access the (possibly
 
819
    signatures, inventories and texts attributes) and a Transport, which
 
820
    respectively provide byte storage and a means to access the (possibly
894
821
    remote) disk.
895
822
 
896
823
    The byte storage facilities are addressed via tuples, which we refer to
897
824
    as 'keys' throughout the code base. Revision_keys, inventory_keys and
898
825
    signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
899
 
    (file_id, revision_id). chk_bytes uses CHK keys - a 1-tuple with a single
900
 
    byte string made up of a hash identifier and a hash value.
901
 
    We use this interface because it allows low friction with the underlying
902
 
    code that implements disk indices, network encoding and other parts of
903
 
    bzrlib.
 
826
    (file_id, revision_id). We use this interface because it allows low
 
827
    friction with the underlying code that implements disk indices, network
 
828
    encoding and other parts of bzrlib.
904
829
 
905
830
    :ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
906
831
        the serialised revisions for the repository. This can be used to obtain
925
850
        The result of trying to insert data into the repository via this store
926
851
        is undefined: it should be considered read-only except for implementors
927
852
        of repositories.
928
 
    :ivar chk_bytes: A bzrlib.versionedfile.VersionedFiles instance containing
929
 
        any data the repository chooses to store or have indexed by its hash.
930
 
        The result of trying to insert data into the repository via this store
931
 
        is undefined: it should be considered read-only except for implementors
932
 
        of repositories.
933
853
    :ivar _transport: Transport for file access to repository, typically
934
854
        pointing to .bzr/repository.
935
855
    """
956
876
        """
957
877
        if self._write_group is not self.get_transaction():
958
878
            # has an unlock or relock occured ?
959
 
            if suppress_errors:
960
 
                mutter(
961
 
                '(suppressed) mismatched lock context and write group. %r, %r',
962
 
                self._write_group, self.get_transaction())
963
 
                return
964
 
            raise errors.BzrError(
965
 
                'mismatched lock context and write group. %r, %r' %
966
 
                (self._write_group, self.get_transaction()))
 
879
            raise errors.BzrError('mismatched lock context and write group.')
967
880
        try:
968
881
            self._abort_write_group()
969
882
        except Exception, exc:
995
908
        """
996
909
        if not self._format.supports_external_lookups:
997
910
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
998
 
        if self.is_locked():
999
 
            # This repository will call fallback.unlock() when we transition to
1000
 
            # the unlocked state, so we make sure to increment the lock count
1001
 
            repository.lock_read()
1002
911
        self._check_fallback_repository(repository)
1003
912
        self._fallback_repositories.append(repository)
1004
913
        self.texts.add_fallback_versioned_files(repository.texts)
1005
914
        self.inventories.add_fallback_versioned_files(repository.inventories)
1006
915
        self.revisions.add_fallback_versioned_files(repository.revisions)
1007
916
        self.signatures.add_fallback_versioned_files(repository.signatures)
1008
 
        if self.chk_bytes is not None:
1009
 
            self.chk_bytes.add_fallback_versioned_files(repository.chk_bytes)
1010
917
 
1011
918
    def _check_fallback_repository(self, repository):
1012
919
        """Check that this repository can fallback to repository safely.
1036
943
                % (inv.revision_id, revision_id))
1037
944
        if inv.root is None:
1038
945
            raise AssertionError()
1039
 
        return self._add_inventory_checked(revision_id, inv, parents)
1040
 
 
1041
 
    def _add_inventory_checked(self, revision_id, inv, parents):
1042
 
        """Add inv to the repository after checking the inputs.
1043
 
 
1044
 
        This function can be overridden to allow different inventory styles.
1045
 
 
1046
 
        :seealso: add_inventory, for the contract.
1047
 
        """
1048
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
 
946
        inv_lines = self._serialise_inventory_to_lines(inv)
1049
947
        return self._inventory_add_lines(revision_id, parents,
1050
948
            inv_lines, check_content=False)
1051
949
 
1052
950
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1053
 
                               parents, basis_inv=None, propagate_caches=False):
 
951
                               parents):
1054
952
        """Add a new inventory expressed as a delta against another revision.
1055
953
 
1056
 
        See the inventory developers documentation for the theory behind
1057
 
        inventory deltas.
1058
 
 
1059
954
        :param basis_revision_id: The inventory id the delta was created
1060
955
            against. (This does not have to be a direct parent.)
1061
956
        :param delta: The inventory delta (see Inventory.apply_delta for
1067
962
            for repositories that depend on the inventory graph for revision
1068
963
            graph access, as well as for those that pun ancestry with delta
1069
964
            compression.
1070
 
        :param basis_inv: The basis inventory if it is already known,
1071
 
            otherwise None.
1072
 
        :param propagate_caches: If True, the caches for this inventory are
1073
 
          copied to and updated for the result if possible.
1074
965
 
1075
966
        :returns: (validator, new_inv)
1076
967
            The validator(which is a sha1 digest, though what is sha'd is
1087
978
            # inventory implementations may support: A better idiom would be to
1088
979
            # return a new inventory, but as there is no revision tree cache in
1089
980
            # repository this is safe for now - RBC 20081013
1090
 
            if basis_inv is None:
1091
 
                basis_inv = basis_tree.inventory
 
981
            basis_inv = basis_tree.inventory
1092
982
            basis_inv.apply_delta(delta)
1093
983
            basis_inv.revision_id = new_revision_id
1094
984
            return (self.add_inventory(new_revision_id, basis_inv, parents),
1100
990
        check_content=True):
1101
991
        """Store lines in inv_vf and return the sha1 of the inventory."""
1102
992
        parents = [(parent,) for parent in parents]
1103
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
993
        return self.inventories.add_lines((revision_id,), parents, lines,
1104
994
            check_content=check_content)[0]
1105
 
        self.inventories._access.flush()
1106
 
        return result
1107
995
 
1108
996
    def add_revision(self, revision_id, rev, inv=None, config=None):
1109
997
        """Add rev to the revision store as revision_id.
1185
1073
        # The old API returned a list, should this actually be a set?
1186
1074
        return parent_map.keys()
1187
1075
 
1188
 
    def _check_inventories(self, checker):
1189
 
        """Check the inventories found from the revision scan.
1190
 
        
1191
 
        This is responsible for verifying the sha1 of inventories and
1192
 
        creating a pending_keys set that covers data referenced by inventories.
1193
 
        """
1194
 
        bar = ui.ui_factory.nested_progress_bar()
1195
 
        try:
1196
 
            self._do_check_inventories(checker, bar)
1197
 
        finally:
1198
 
            bar.finished()
1199
 
 
1200
 
    def _do_check_inventories(self, checker, bar):
1201
 
        """Helper for _check_inventories."""
1202
 
        revno = 0
1203
 
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
1204
 
        kinds = ['chk_bytes', 'texts']
1205
 
        count = len(checker.pending_keys)
1206
 
        bar.update("inventories", 0, 2)
1207
 
        current_keys = checker.pending_keys
1208
 
        checker.pending_keys = {}
1209
 
        # Accumulate current checks.
1210
 
        for key in current_keys:
1211
 
            if key[0] != 'inventories' and key[0] not in kinds:
1212
 
                checker._report_items.append('unknown key type %r' % (key,))
1213
 
            keys[key[0]].add(key[1:])
1214
 
        if keys['inventories']:
1215
 
            # NB: output order *should* be roughly sorted - topo or
1216
 
            # inverse topo depending on repository - either way decent
1217
 
            # to just delta against. However, pre-CHK formats didn't
1218
 
            # try to optimise inventory layout on disk. As such the
1219
 
            # pre-CHK code path does not use inventory deltas.
1220
 
            last_object = None
1221
 
            for record in self.inventories.check(keys=keys['inventories']):
1222
 
                if record.storage_kind == 'absent':
1223
 
                    checker._report_items.append(
1224
 
                        'Missing inventory {%s}' % (record.key,))
1225
 
                else:
1226
 
                    last_object = self._check_record('inventories', record,
1227
 
                        checker, last_object,
1228
 
                        current_keys[('inventories',) + record.key])
1229
 
            del keys['inventories']
1230
 
        else:
1231
 
            return
1232
 
        bar.update("texts", 1)
1233
 
        while (checker.pending_keys or keys['chk_bytes']
1234
 
            or keys['texts']):
1235
 
            # Something to check.
1236
 
            current_keys = checker.pending_keys
1237
 
            checker.pending_keys = {}
1238
 
            # Accumulate current checks.
1239
 
            for key in current_keys:
1240
 
                if key[0] not in kinds:
1241
 
                    checker._report_items.append('unknown key type %r' % (key,))
1242
 
                keys[key[0]].add(key[1:])
1243
 
            # Check the outermost kind only - inventories || chk_bytes || texts
1244
 
            for kind in kinds:
1245
 
                if keys[kind]:
1246
 
                    last_object = None
1247
 
                    for record in getattr(self, kind).check(keys=keys[kind]):
1248
 
                        if record.storage_kind == 'absent':
1249
 
                            checker._report_items.append(
1250
 
                                'Missing %s {%s}' % (kind, record.key,))
1251
 
                        else:
1252
 
                            last_object = self._check_record(kind, record,
1253
 
                                checker, last_object, current_keys[(kind,) + record.key])
1254
 
                    keys[kind] = set()
1255
 
                    break
1256
 
 
1257
 
    def _check_record(self, kind, record, checker, last_object, item_data):
1258
 
        """Check a single text from this repository."""
1259
 
        if kind == 'inventories':
1260
 
            rev_id = record.key[0]
1261
 
            inv = self._deserialise_inventory(rev_id,
1262
 
                record.get_bytes_as('fulltext'))
1263
 
            if last_object is not None:
1264
 
                delta = inv._make_delta(last_object)
1265
 
                for old_path, path, file_id, ie in delta:
1266
 
                    if ie is None:
1267
 
                        continue
1268
 
                    ie.check(checker, rev_id, inv)
1269
 
            else:
1270
 
                for path, ie in inv.iter_entries():
1271
 
                    ie.check(checker, rev_id, inv)
1272
 
            if self._format.fast_deltas:
1273
 
                return inv
1274
 
        elif kind == 'chk_bytes':
1275
 
            # No code written to check chk_bytes for this repo format.
1276
 
            checker._report_items.append(
1277
 
                'unsupported key type chk_bytes for %s' % (record.key,))
1278
 
        elif kind == 'texts':
1279
 
            self._check_text(record, checker, item_data)
1280
 
        else:
1281
 
            checker._report_items.append(
1282
 
                'unknown key type %s for %s' % (kind, record.key))
1283
 
 
1284
 
    def _check_text(self, record, checker, item_data):
1285
 
        """Check a single text."""
1286
 
        # Check it is extractable.
1287
 
        # TODO: check length.
1288
 
        if record.storage_kind == 'chunked':
1289
 
            chunks = record.get_bytes_as(record.storage_kind)
1290
 
            sha1 = osutils.sha_strings(chunks)
1291
 
            length = sum(map(len, chunks))
1292
 
        else:
1293
 
            content = record.get_bytes_as('fulltext')
1294
 
            sha1 = osutils.sha_string(content)
1295
 
            length = len(content)
1296
 
        if item_data and sha1 != item_data[1]:
1297
 
            checker._report_items.append(
1298
 
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
1299
 
                (record.key, sha1, item_data[1], item_data[2]))
1300
 
 
1301
1076
    @staticmethod
1302
1077
    def create(a_bzrdir):
1303
1078
        """Construct the current default format repository in a_bzrdir."""
1308
1083
 
1309
1084
        :param _format: The format of the repository on disk.
1310
1085
        :param a_bzrdir: The BzrDir of the repository.
 
1086
 
 
1087
        In the future we will have a single api for all stores for
 
1088
        getting file texts, inventories and revisions, then
 
1089
        this construct will accept instances of those things.
1311
1090
        """
1312
 
        # In the future we will have a single api for all stores for
1313
 
        # getting file texts, inventories and revisions, then
1314
 
        # this construct will accept instances of those things.
1315
1091
        super(Repository, self).__init__()
1316
1092
        self._format = _format
1317
1093
        # the following are part of the public API for Repository:
1323
1099
        self._reconcile_does_inventory_gc = True
1324
1100
        self._reconcile_fixes_text_parents = False
1325
1101
        self._reconcile_backsup_inventory = True
 
1102
        # not right yet - should be more semantically clear ?
 
1103
        #
 
1104
        # TODO: make sure to construct the right store classes, etc, depending
 
1105
        # on whether escaping is required.
 
1106
        self._warn_if_deprecated()
1326
1107
        self._write_group = None
1327
1108
        # Additional places to query for data.
1328
1109
        self._fallback_repositories = []
1329
1110
        # An InventoryEntry cache, used during deserialization
1330
1111
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
1331
 
        # Is it safe to return inventory entries directly from the entry cache,
1332
 
        # rather copying them?
1333
 
        self._safe_to_return_from_cache = False
1334
 
 
1335
 
    @property
1336
 
    def user_transport(self):
1337
 
        return self.bzrdir.user_transport
1338
 
 
1339
 
    @property
1340
 
    def control_transport(self):
1341
 
        return self._transport
1342
1112
 
1343
1113
    def __repr__(self):
1344
 
        if self._fallback_repositories:
1345
 
            return '%s(%r, fallback_repositories=%r)' % (
1346
 
                self.__class__.__name__,
1347
 
                self.base,
1348
 
                self._fallback_repositories)
1349
 
        else:
1350
 
            return '%s(%r)' % (self.__class__.__name__,
1351
 
                               self.base)
1352
 
 
1353
 
    def _has_same_fallbacks(self, other_repo):
1354
 
        """Returns true if the repositories have the same fallbacks."""
1355
 
        my_fb = self._fallback_repositories
1356
 
        other_fb = other_repo._fallback_repositories
1357
 
        if len(my_fb) != len(other_fb):
1358
 
            return False
1359
 
        for f, g in zip(my_fb, other_fb):
1360
 
            if not f.has_same_location(g):
1361
 
                return False
1362
 
        return True
 
1114
        return '%s(%r)' % (self.__class__.__name__,
 
1115
                           self.base)
1363
1116
 
1364
1117
    def has_same_location(self, other):
1365
1118
        """Returns a boolean indicating if this repository is at the same
1393
1146
        data during reads, and allows a 'write_group' to be obtained. Write
1394
1147
        groups must be used for actual data insertion.
1395
1148
 
1396
 
        A token should be passed in if you know that you have locked the object
1397
 
        some other way, and need to synchronise this object's state with that
1398
 
        fact.
1399
 
 
1400
 
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1401
 
 
1402
1149
        :param token: if this is already locked, then lock_write will fail
1403
1150
            unless the token matches the existing lock.
1404
1151
        :returns: a token if this instance supports tokens, otherwise None.
1407
1154
        :raises MismatchedToken: if the specified token doesn't match the token
1408
1155
            of the existing lock.
1409
1156
        :seealso: start_write_group.
1410
 
        :return: A RepositoryWriteLockResult.
 
1157
 
 
1158
        A token should be passed in if you know that you have locked the object
 
1159
        some other way, and need to synchronise this object's state with that
 
1160
        fact.
 
1161
 
 
1162
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1411
1163
        """
1412
1164
        locked = self.is_locked()
1413
 
        token = self.control_files.lock_write(token=token)
 
1165
        result = self.control_files.lock_write(token=token)
 
1166
        for repo in self._fallback_repositories:
 
1167
            # Writes don't affect fallback repos
 
1168
            repo.lock_read()
1414
1169
        if not locked:
1415
 
            self._warn_if_deprecated()
1416
 
            self._note_lock('w')
1417
 
            for repo in self._fallback_repositories:
1418
 
                # Writes don't affect fallback repos
1419
 
                repo.lock_read()
1420
1170
            self._refresh_data()
1421
 
        return RepositoryWriteLockResult(self.unlock, token)
 
1171
        return result
1422
1172
 
1423
1173
    def lock_read(self):
1424
 
        """Lock the repository for read operations.
1425
 
 
1426
 
        :return: An object with an unlock method which will release the lock
1427
 
            obtained.
1428
 
        """
1429
1174
        locked = self.is_locked()
1430
1175
        self.control_files.lock_read()
 
1176
        for repo in self._fallback_repositories:
 
1177
            repo.lock_read()
1431
1178
        if not locked:
1432
 
            self._warn_if_deprecated()
1433
 
            self._note_lock('r')
1434
 
            for repo in self._fallback_repositories:
1435
 
                repo.lock_read()
1436
1179
            self._refresh_data()
1437
 
        return self
1438
1180
 
1439
1181
    def get_physical_lock_status(self):
1440
1182
        return self.control_files.get_physical_lock_status()
1500
1242
 
1501
1243
        # now gather global repository information
1502
1244
        # XXX: This is available for many repos regardless of listability.
1503
 
        if self.user_transport.listable():
 
1245
        if self.bzrdir.root_transport.listable():
1504
1246
            # XXX: do we want to __define len__() ?
1505
1247
            # Maybe the versionedfiles object should provide a different
1506
1248
            # method to get the number of keys.
1516
1258
        :param using: If True, list only branches using this repository.
1517
1259
        """
1518
1260
        if using and not self.is_shared():
1519
 
            return self.bzrdir.list_branches()
 
1261
            try:
 
1262
                return [self.bzrdir.open_branch()]
 
1263
            except errors.NotBranchError:
 
1264
                return []
1520
1265
        class Evaluator(object):
1521
1266
 
1522
1267
            def __init__(self):
1531
1276
                    except errors.NoRepositoryPresent:
1532
1277
                        pass
1533
1278
                    else:
1534
 
                        return False, ([], repository)
 
1279
                        return False, (None, repository)
1535
1280
                self.first_call = False
1536
 
                value = (bzrdir.list_branches(), None)
 
1281
                try:
 
1282
                    value = (bzrdir.open_branch(), None)
 
1283
                except errors.NotBranchError:
 
1284
                    value = (None, None)
1537
1285
                return True, value
1538
1286
 
1539
 
        ret = []
1540
 
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
1541
 
                self.user_transport, evaluate=Evaluator()):
1542
 
            if branches is not None:
1543
 
                ret.extend(branches)
 
1287
        branches = []
 
1288
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1289
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
1290
            if branch is not None:
 
1291
                branches.append(branch)
1544
1292
            if not using and repository is not None:
1545
 
                ret.extend(repository.find_branches())
1546
 
        return ret
 
1293
                branches.extend(repository.find_branches())
 
1294
        return branches
1547
1295
 
1548
1296
    @needs_read_lock
1549
1297
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1578
1326
        """Commit the contents accrued within the current write group.
1579
1327
 
1580
1328
        :seealso: start_write_group.
1581
 
        
1582
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1583
1329
        """
1584
1330
        if self._write_group is not self.get_transaction():
1585
1331
            # has an unlock or relock occured ?
1586
1332
            raise errors.BzrError('mismatched lock context %r and '
1587
1333
                'write group %r.' %
1588
1334
                (self.get_transaction(), self._write_group))
1589
 
        result = self._commit_write_group()
 
1335
        self._commit_write_group()
1590
1336
        self._write_group = None
1591
 
        return result
1592
1337
 
1593
1338
    def _commit_write_group(self):
1594
1339
        """Template method for per-repository write group cleanup.
1602
1347
    def suspend_write_group(self):
1603
1348
        raise errors.UnsuspendableWriteGroup(self)
1604
1349
 
1605
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
1606
 
        """Return the keys of missing inventory parents for revisions added in
1607
 
        this write group.
1608
 
 
1609
 
        A revision is not complete if the inventory delta for that revision
1610
 
        cannot be calculated.  Therefore if the parent inventories of a
1611
 
        revision are not present, the revision is incomplete, and e.g. cannot
1612
 
        be streamed by a smart server.  This method finds missing inventory
1613
 
        parents for revisions added in this write group.
1614
 
        """
1615
 
        if not self._format.supports_external_lookups:
1616
 
            # This is only an issue for stacked repositories
1617
 
            return set()
1618
 
        if not self.is_in_write_group():
1619
 
            raise AssertionError('not in a write group')
1620
 
 
1621
 
        # XXX: We assume that every added revision already has its
1622
 
        # corresponding inventory, so we only check for parent inventories that
1623
 
        # might be missing, rather than all inventories.
1624
 
        parents = set(self.revisions._index.get_missing_parents())
1625
 
        parents.discard(_mod_revision.NULL_REVISION)
1626
 
        unstacked_inventories = self.inventories._index
1627
 
        present_inventories = unstacked_inventories.get_parent_map(
1628
 
            key[-1:] for key in parents)
1629
 
        parents.difference_update(present_inventories)
1630
 
        if len(parents) == 0:
1631
 
            # No missing parent inventories.
1632
 
            return set()
1633
 
        if not check_for_missing_texts:
1634
 
            return set(('inventories', rev_id) for (rev_id,) in parents)
1635
 
        # Ok, now we have a list of missing inventories.  But these only matter
1636
 
        # if the inventories that reference them are missing some texts they
1637
 
        # appear to introduce.
1638
 
        # XXX: Texts referenced by all added inventories need to be present,
1639
 
        # but at the moment we're only checking for texts referenced by
1640
 
        # inventories at the graph's edge.
1641
 
        key_deps = self.revisions._index._key_dependencies
1642
 
        key_deps.satisfy_refs_for_keys(present_inventories)
1643
 
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1644
 
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1645
 
        missing_texts = set()
1646
 
        for file_id, version_ids in file_ids.iteritems():
1647
 
            missing_texts.update(
1648
 
                (file_id, version_id) for version_id in version_ids)
1649
 
        present_texts = self.texts.get_parent_map(missing_texts)
1650
 
        missing_texts.difference_update(present_texts)
1651
 
        if not missing_texts:
1652
 
            # No texts are missing, so all revisions and their deltas are
1653
 
            # reconstructable.
1654
 
            return set()
1655
 
        # Alternatively the text versions could be returned as the missing
1656
 
        # keys, but this is likely to be less data.
1657
 
        missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
1658
 
        return missing_keys
1659
 
 
1660
1350
    def refresh_data(self):
1661
1351
        """Re-read any data needed to to synchronise with disk.
1662
1352
 
1711
1401
            raise errors.InternalBzrError(
1712
1402
                "May not fetch while in a write group.")
1713
1403
        # fast path same-url fetch operations
1714
 
        # TODO: lift out to somewhere common with RemoteRepository
1715
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401646>
1716
 
        if (self.has_same_location(source)
1717
 
            and fetch_spec is None
1718
 
            and self._has_same_fallbacks(source)):
 
1404
        if self.has_same_location(source) and fetch_spec is None:
1719
1405
            # check that last_revision is in 'from' and then return a
1720
1406
            # no-operation.
1721
1407
            if (revision_id is not None and
1746
1432
        :param revprops: Optional dictionary of revision properties.
1747
1433
        :param revision_id: Optional revision id.
1748
1434
        """
1749
 
        if self._fallback_repositories:
1750
 
            raise errors.BzrError("Cannot commit from a lightweight checkout "
1751
 
                "to a stacked branch. See "
1752
 
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1753
1435
        result = self._commit_builder_class(self, parents, config,
1754
1436
            timestamp, timezone, committer, revprops, revision_id)
1755
1437
        self.start_write_group()
1756
1438
        return result
1757
1439
 
1758
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1759
1440
    def unlock(self):
1760
1441
        if (self.control_files._lock_count == 1 and
1761
1442
            self.control_files._lock_mode == 'w'):
1767
1448
        self.control_files.unlock()
1768
1449
        if self.control_files._lock_count == 0:
1769
1450
            self._inventory_entry_cache.clear()
1770
 
            for repo in self._fallback_repositories:
1771
 
                repo.unlock()
 
1451
        for repo in self._fallback_repositories:
 
1452
            repo.unlock()
1772
1453
 
1773
1454
    @needs_read_lock
1774
1455
    def clone(self, a_bzrdir, revision_id=None):
1883
1564
 
1884
1565
    @needs_read_lock
1885
1566
    def get_revisions(self, revision_ids):
1886
 
        """Get many revisions at once.
1887
 
        
1888
 
        Repositories that need to check data on every revision read should 
1889
 
        subclass this method.
1890
 
        """
 
1567
        """Get many revisions at once."""
1891
1568
        return self._get_revisions(revision_ids)
1892
1569
 
1893
1570
    @needs_read_lock
1894
1571
    def _get_revisions(self, revision_ids):
1895
1572
        """Core work logic to get many revisions without sanity checks."""
 
1573
        for rev_id in revision_ids:
 
1574
            if not rev_id or not isinstance(rev_id, basestring):
 
1575
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1576
        keys = [(key,) for key in revision_ids]
 
1577
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1896
1578
        revs = {}
1897
 
        for revid, rev in self._iter_revisions(revision_ids):
1898
 
            if rev is None:
1899
 
                raise errors.NoSuchRevision(self, revid)
1900
 
            revs[revid] = rev
 
1579
        for record in stream:
 
1580
            if record.storage_kind == 'absent':
 
1581
                raise errors.NoSuchRevision(self, record.key[0])
 
1582
            text = record.get_bytes_as('fulltext')
 
1583
            rev = self._serializer.read_revision_from_string(text)
 
1584
            revs[record.key[0]] = rev
1901
1585
        return [revs[revid] for revid in revision_ids]
1902
1586
 
1903
 
    def _iter_revisions(self, revision_ids):
1904
 
        """Iterate over revision objects.
1905
 
 
1906
 
        :param revision_ids: An iterable of revisions to examine. None may be
1907
 
            passed to request all revisions known to the repository. Note that
1908
 
            not all repositories can find unreferenced revisions; for those
1909
 
            repositories only referenced ones will be returned.
1910
 
        :return: An iterator of (revid, revision) tuples. Absent revisions (
1911
 
            those asked for but not available) are returned as (revid, None).
1912
 
        """
1913
 
        if revision_ids is None:
1914
 
            revision_ids = self.all_revision_ids()
1915
 
        else:
1916
 
            for rev_id in revision_ids:
1917
 
                if not rev_id or not isinstance(rev_id, basestring):
1918
 
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1919
 
        keys = [(key,) for key in revision_ids]
1920
 
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1921
 
        for record in stream:
1922
 
            revid = record.key[0]
1923
 
            if record.storage_kind == 'absent':
1924
 
                yield (revid, None)
1925
 
            else:
1926
 
                text = record.get_bytes_as('fulltext')
1927
 
                rev = self._serializer.read_revision_from_string(text)
1928
 
                yield (revid, rev)
 
1587
    @needs_read_lock
 
1588
    def get_revision_xml(self, revision_id):
 
1589
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1590
        #       would have already do it.
 
1591
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1592
        rev = self.get_revision(revision_id)
 
1593
        rev_tmp = cStringIO.StringIO()
 
1594
        # the current serializer..
 
1595
        self._serializer.write_revision(rev, rev_tmp)
 
1596
        rev_tmp.seek(0)
 
1597
        return rev_tmp.getvalue()
1929
1598
 
1930
1599
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1931
1600
        """Produce a generator of revision deltas.
2109
1778
                    yield line, revid
2110
1779
 
2111
1780
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
2112
 
        revision_keys):
 
1781
        revision_ids):
2113
1782
        """Helper routine for fileids_altered_by_revision_ids.
2114
1783
 
2115
1784
        This performs the translation of xml lines to revision ids.
2116
1785
 
2117
1786
        :param line_iterator: An iterator of lines, origin_version_id
2118
 
        :param revision_keys: The revision ids to filter for. This should be a
 
1787
        :param revision_ids: The revision ids to filter for. This should be a
2119
1788
            set or other type which supports efficient __contains__ lookups, as
2120
 
            the revision key from each parsed line will be looked up in the
2121
 
            revision_keys filter.
 
1789
            the revision id from each parsed line will be looked up in the
 
1790
            revision_ids filter.
2122
1791
        :return: a dictionary mapping altered file-ids to an iterable of
2123
1792
        revision_ids. Each altered file-ids has the exact revision_ids that
2124
1793
        altered it listed explicitly.
2125
1794
        """
2126
1795
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
2127
1796
                line_iterator).iterkeys())
2128
 
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
 
1797
        # Note that revision_ids are revision keys.
 
1798
        parent_maps = self.revisions.get_parent_map(revision_ids)
 
1799
        parents = set()
 
1800
        map(parents.update, parent_maps.itervalues())
 
1801
        parents.difference_update(revision_ids)
2129
1802
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
2130
 
            self._inventory_xml_lines_for_keys(parent_keys)))
 
1803
            self._inventory_xml_lines_for_keys(parents)))
2131
1804
        new_keys = seen - parent_seen
2132
1805
        result = {}
2133
1806
        setdefault = result.setdefault
2135
1808
            setdefault(key[0], set()).add(key[-1])
2136
1809
        return result
2137
1810
 
2138
 
    def _find_parent_ids_of_revisions(self, revision_ids):
2139
 
        """Find all parent ids that are mentioned in the revision graph.
2140
 
 
2141
 
        :return: set of revisions that are parents of revision_ids which are
2142
 
            not part of revision_ids themselves
2143
 
        """
2144
 
        parent_map = self.get_parent_map(revision_ids)
2145
 
        parent_ids = set()
2146
 
        map(parent_ids.update, parent_map.itervalues())
2147
 
        parent_ids.difference_update(revision_ids)
2148
 
        parent_ids.discard(_mod_revision.NULL_REVISION)
2149
 
        return parent_ids
2150
 
 
2151
 
    def _find_parent_keys_of_revisions(self, revision_keys):
2152
 
        """Similar to _find_parent_ids_of_revisions, but used with keys.
2153
 
 
2154
 
        :param revision_keys: An iterable of revision_keys.
2155
 
        :return: The parents of all revision_keys that are not already in
2156
 
            revision_keys
2157
 
        """
2158
 
        parent_map = self.revisions.get_parent_map(revision_keys)
2159
 
        parent_keys = set()
2160
 
        map(parent_keys.update, parent_map.itervalues())
2161
 
        parent_keys.difference_update(revision_keys)
2162
 
        parent_keys.discard(_mod_revision.NULL_REVISION)
2163
 
        return parent_keys
2164
 
 
2165
1811
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
2166
1812
        """Find the file ids and versions affected by revisions.
2167
1813
 
2174
1820
        """
2175
1821
        selected_keys = set((revid,) for revid in revision_ids)
2176
1822
        w = _inv_weave or self.inventories
2177
 
        return self._find_file_ids_from_xml_inventory_lines(
2178
 
            w.iter_lines_added_or_present_in_keys(
2179
 
                selected_keys, pb=None),
2180
 
            selected_keys)
 
1823
        pb = ui.ui_factory.nested_progress_bar()
 
1824
        try:
 
1825
            return self._find_file_ids_from_xml_inventory_lines(
 
1826
                w.iter_lines_added_or_present_in_keys(
 
1827
                    selected_keys, pb=pb),
 
1828
                selected_keys)
 
1829
        finally:
 
1830
            pb.finished()
2181
1831
 
2182
1832
    def iter_files_bytes(self, desired_files):
2183
1833
        """Iterate through file versions.
2204
1854
        for record in self.texts.get_record_stream(text_keys, 'unordered', True):
2205
1855
            if record.storage_kind == 'absent':
2206
1856
                raise errors.RevisionNotPresent(record.key, self)
2207
 
            yield text_keys[record.key], record.get_bytes_as('chunked')
 
1857
            yield text_keys[record.key], record.get_bytes_as('fulltext')
2208
1858
 
2209
1859
    def _generate_text_key_index(self, text_key_references=None,
2210
1860
        ancestors=None):
2265
1915
                batch_size]
2266
1916
            if not to_query:
2267
1917
                break
2268
 
            for revision_id in to_query:
 
1918
            for rev_tree in self.revision_trees(to_query):
 
1919
                revision_id = rev_tree.get_revision_id()
2269
1920
                parent_ids = ancestors[revision_id]
2270
1921
                for text_key in revision_keys[revision_id]:
2271
1922
                    pb.update("Calculating text parents", processed_texts)
2290
1941
                            except KeyError:
2291
1942
                                inv = self.revision_tree(parent_id).inventory
2292
1943
                                inventory_cache[parent_id] = inv
2293
 
                            try:
2294
 
                                parent_entry = inv[text_key[0]]
2295
 
                            except (KeyError, errors.NoSuchId):
2296
 
                                parent_entry = None
 
1944
                            parent_entry = inv._byid.get(text_key[0], None)
2297
1945
                            if parent_entry is not None:
2298
1946
                                parent_text_key = (
2299
1947
                                    text_key[0], parent_entry.revision)
2324
1972
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
2325
1973
            'revisions'.  file-id is None unless knit-kind is 'file'.
2326
1974
        """
2327
 
        for result in self._find_file_keys_to_fetch(revision_ids, _files_pb):
2328
 
            yield result
2329
 
        del _files_pb
2330
 
        for result in self._find_non_file_keys_to_fetch(revision_ids):
2331
 
            yield result
2332
 
 
2333
 
    def _find_file_keys_to_fetch(self, revision_ids, pb):
2334
1975
        # XXX: it's a bit weird to control the inventory weave caching in this
2335
1976
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
2336
1977
        # maybe this generator should explicitly have the contract that it
2343
1984
        count = 0
2344
1985
        num_file_ids = len(file_ids)
2345
1986
        for file_id, altered_versions in file_ids.iteritems():
2346
 
            if pb is not None:
2347
 
                pb.update("Fetch texts", count, num_file_ids)
 
1987
            if _files_pb is not None:
 
1988
                _files_pb.update("fetch texts", count, num_file_ids)
2348
1989
            count += 1
2349
1990
            yield ("file", file_id, altered_versions)
 
1991
        # We're done with the files_pb.  Note that it finished by the caller,
 
1992
        # just as it was created by the caller.
 
1993
        del _files_pb
2350
1994
 
2351
 
    def _find_non_file_keys_to_fetch(self, revision_ids):
2352
1995
        # inventory
2353
1996
        yield ("inventory", None, revision_ids)
2354
1997
 
2371
2014
        """Get Inventory object by revision id."""
2372
2015
        return self.iter_inventories([revision_id]).next()
2373
2016
 
2374
 
    def iter_inventories(self, revision_ids, ordering=None):
 
2017
    def iter_inventories(self, revision_ids):
2375
2018
        """Get many inventories by revision_ids.
2376
2019
 
2377
2020
        This will buffer some or all of the texts used in constructing the
2378
2021
        inventories in memory, but will only parse a single inventory at a
2379
2022
        time.
2380
2023
 
2381
 
        :param revision_ids: The expected revision ids of the inventories.
2382
 
        :param ordering: optional ordering, e.g. 'topological'.  If not
2383
 
            specified, the order of revision_ids will be preserved (by
2384
 
            buffering if necessary).
2385
2024
        :return: An iterator of inventories.
2386
2025
        """
2387
2026
        if ((None in revision_ids)
2388
2027
            or (_mod_revision.NULL_REVISION in revision_ids)):
2389
2028
            raise ValueError('cannot get null revision inventory')
2390
 
        return self._iter_inventories(revision_ids, ordering)
 
2029
        return self._iter_inventories(revision_ids)
2391
2030
 
2392
 
    def _iter_inventories(self, revision_ids, ordering):
 
2031
    def _iter_inventories(self, revision_ids):
2393
2032
        """single-document based inventory iteration."""
2394
 
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2395
 
        for text, revision_id in inv_xmls:
2396
 
            yield self._deserialise_inventory(revision_id, text)
 
2033
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
 
2034
            yield self.deserialise_inventory(revision_id, text)
2397
2035
 
2398
 
    def _iter_inventory_xmls(self, revision_ids, ordering):
2399
 
        if ordering is None:
2400
 
            order_as_requested = True
2401
 
            ordering = 'unordered'
2402
 
        else:
2403
 
            order_as_requested = False
 
2036
    def _iter_inventory_xmls(self, revision_ids):
2404
2037
        keys = [(revision_id,) for revision_id in revision_ids]
2405
 
        if not keys:
2406
 
            return
2407
 
        if order_as_requested:
2408
 
            key_iter = iter(keys)
2409
 
            next_key = key_iter.next()
2410
 
        stream = self.inventories.get_record_stream(keys, ordering, True)
 
2038
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2411
2039
        text_chunks = {}
2412
2040
        for record in stream:
2413
2041
            if record.storage_kind != 'absent':
2414
 
                chunks = record.get_bytes_as('chunked')
2415
 
                if order_as_requested:
2416
 
                    text_chunks[record.key] = chunks
2417
 
                else:
2418
 
                    yield ''.join(chunks), record.key[-1]
 
2042
                text_chunks[record.key] = record.get_bytes_as('chunked')
2419
2043
            else:
2420
2044
                raise errors.NoSuchRevision(self, record.key)
2421
 
            if order_as_requested:
2422
 
                # Yield as many results as we can while preserving order.
2423
 
                while next_key in text_chunks:
2424
 
                    chunks = text_chunks.pop(next_key)
2425
 
                    yield ''.join(chunks), next_key[-1]
2426
 
                    try:
2427
 
                        next_key = key_iter.next()
2428
 
                    except StopIteration:
2429
 
                        # We still want to fully consume the get_record_stream,
2430
 
                        # just in case it is not actually finished at this point
2431
 
                        next_key = None
2432
 
                        break
 
2045
        for key in keys:
 
2046
            chunks = text_chunks.pop(key)
 
2047
            yield ''.join(chunks), key[-1]
2433
2048
 
2434
 
    def _deserialise_inventory(self, revision_id, xml):
 
2049
    def deserialise_inventory(self, revision_id, xml):
2435
2050
        """Transform the xml into an inventory object.
2436
2051
 
2437
2052
        :param revision_id: The expected revision id of the inventory.
2438
2053
        :param xml: A serialised inventory.
2439
2054
        """
2440
2055
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2441
 
                    entry_cache=self._inventory_entry_cache,
2442
 
                    return_from_cache=self._safe_to_return_from_cache)
 
2056
                    entry_cache=self._inventory_entry_cache)
2443
2057
        if result.revision_id != revision_id:
2444
2058
            raise AssertionError('revision id mismatch %s != %s' % (
2445
2059
                result.revision_id, revision_id))
2446
2060
        return result
2447
2061
 
 
2062
    def serialise_inventory(self, inv):
 
2063
        return self._serializer.write_inventory_to_string(inv)
 
2064
 
 
2065
    def _serialise_inventory_to_lines(self, inv):
 
2066
        return self._serializer.write_inventory_to_lines(inv)
 
2067
 
2448
2068
    def get_serializer_format(self):
2449
2069
        return self._serializer.format_num
2450
2070
 
2451
2071
    @needs_read_lock
2452
 
    def _get_inventory_xml(self, revision_id):
2453
 
        """Get serialized inventory as a string."""
2454
 
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
 
2072
    def get_inventory_xml(self, revision_id):
 
2073
        """Get inventory XML as a file object."""
 
2074
        texts = self._iter_inventory_xmls([revision_id])
2455
2075
        try:
2456
2076
            text, revision_id = texts.next()
2457
2077
        except StopIteration:
2458
2078
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2459
2079
        return text
2460
2080
 
2461
 
    def get_rev_id_for_revno(self, revno, known_pair):
2462
 
        """Return the revision id of a revno, given a later (revno, revid)
2463
 
        pair in the same history.
2464
 
 
2465
 
        :return: if found (True, revid).  If the available history ran out
2466
 
            before reaching the revno, then this returns
2467
 
            (False, (closest_revno, closest_revid)).
 
2081
    @needs_read_lock
 
2082
    def get_inventory_sha1(self, revision_id):
 
2083
        """Return the sha1 hash of the inventory entry
2468
2084
        """
2469
 
        known_revno, known_revid = known_pair
2470
 
        partial_history = [known_revid]
2471
 
        distance_from_known = known_revno - revno
2472
 
        if distance_from_known < 0:
2473
 
            raise ValueError(
2474
 
                'requested revno (%d) is later than given known revno (%d)'
2475
 
                % (revno, known_revno))
2476
 
        try:
2477
 
            _iter_for_revno(
2478
 
                self, partial_history, stop_index=distance_from_known)
2479
 
        except errors.RevisionNotPresent, err:
2480
 
            if err.revision_id == known_revid:
2481
 
                # The start revision (known_revid) wasn't found.
2482
 
                raise
2483
 
            # This is a stacked repository with no fallbacks, or a there's a
2484
 
            # left-hand ghost.  Either way, even though the revision named in
2485
 
            # the error isn't in this repo, we know it's the next step in this
2486
 
            # left-hand history.
2487
 
            partial_history.append(err.revision_id)
2488
 
        if len(partial_history) <= distance_from_known:
2489
 
            # Didn't find enough history to get a revid for the revno.
2490
 
            earliest_revno = known_revno - len(partial_history) + 1
2491
 
            return (False, (earliest_revno, partial_history[-1]))
2492
 
        if len(partial_history) - 1 > distance_from_known:
2493
 
            raise AssertionError('_iter_for_revno returned too much history')
2494
 
        return (True, partial_history[-1])
 
2085
        return self.get_revision(revision_id).inventory_sha1
2495
2086
 
2496
2087
    def iter_reverse_revision_history(self, revision_id):
2497
2088
        """Iterate backwards through revision ids in the lefthand history
2504
2095
        while True:
2505
2096
            if next_id in (None, _mod_revision.NULL_REVISION):
2506
2097
                return
2507
 
            try:
2508
 
                parents = graph.get_parent_map([next_id])[next_id]
2509
 
            except KeyError:
2510
 
                raise errors.RevisionNotPresent(next_id, self)
2511
2098
            yield next_id
 
2099
            # Note: The following line may raise KeyError in the event of
 
2100
            # truncated history. We decided not to have a try:except:raise
 
2101
            # RevisionNotPresent here until we see a use for it, because of the
 
2102
            # cost in an inner loop that is by its very nature O(history).
 
2103
            # Robert Collins 20080326
 
2104
            parents = graph.get_parent_map([next_id])[next_id]
2512
2105
            if len(parents) == 0:
2513
2106
                return
2514
2107
            else:
2515
2108
                next_id = parents[0]
2516
2109
 
 
2110
    @needs_read_lock
 
2111
    def get_revision_inventory(self, revision_id):
 
2112
        """Return inventory of a past revision."""
 
2113
        # TODO: Unify this with get_inventory()
 
2114
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
2115
        # must be the same as its revision, so this is trivial.
 
2116
        if revision_id is None:
 
2117
            # This does not make sense: if there is no revision,
 
2118
            # then it is the current tree inventory surely ?!
 
2119
            # and thus get_root_id() is something that looks at the last
 
2120
            # commit on the branch, and the get_root_id is an inventory check.
 
2121
            raise NotImplementedError
 
2122
            # return Inventory(self.get_root_id())
 
2123
        else:
 
2124
            return self.get_inventory(revision_id)
 
2125
 
2517
2126
    def is_shared(self):
2518
2127
        """Return True if this repository is flagged as a shared repository."""
2519
2128
        raise NotImplementedError(self.is_shared)
2553
2162
            return RevisionTree(self, Inventory(root_id=None),
2554
2163
                                _mod_revision.NULL_REVISION)
2555
2164
        else:
2556
 
            inv = self.get_inventory(revision_id)
 
2165
            inv = self.get_revision_inventory(revision_id)
2557
2166
            return RevisionTree(self, inv, revision_id)
2558
2167
 
2559
2168
    def revision_trees(self, revision_ids):
2612
2221
            keys = tsort.topo_sort(parent_map)
2613
2222
        return [None] + list(keys)
2614
2223
 
2615
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
2224
    def pack(self):
2616
2225
        """Compress the data within the repository.
2617
2226
 
2618
2227
        This operation only makes sense for some repository types. For other
2621
2230
        This stub method does not require a lock, but subclasses should use
2622
2231
        @needs_write_lock as this is a long running call its reasonable to
2623
2232
        implicitly lock for the user.
2624
 
 
2625
 
        :param hint: If not supplied, the whole repository is packed.
2626
 
            If supplied, the repository may use the hint parameter as a
2627
 
            hint for the parts of the repository to pack. A hint can be
2628
 
            obtained from the result of commit_write_group(). Out of
2629
 
            date hints are simply ignored, because concurrent operations
2630
 
            can obsolete them rapidly.
2631
 
 
2632
 
        :param clean_obsolete_packs: Clean obsolete packs immediately after
2633
 
            the pack operation.
2634
2233
        """
2635
2234
 
2636
2235
    def get_transaction(self):
2637
2236
        return self.control_files.get_transaction()
2638
2237
 
2639
2238
    def get_parent_map(self, revision_ids):
2640
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
2239
        """See graph._StackedParentsProvider.get_parent_map"""
2641
2240
        # revisions index works in keys; this just works in revisions
2642
2241
        # therefore wrap and unwrap
2643
2242
        query_keys = []
2652
2251
        for ((revision_id,), parent_keys) in \
2653
2252
                self.revisions.get_parent_map(query_keys).iteritems():
2654
2253
            if parent_keys:
2655
 
                result[revision_id] = tuple([parent_revid
2656
 
                    for (parent_revid,) in parent_keys])
 
2254
                result[revision_id] = tuple(parent_revid
 
2255
                    for (parent_revid,) in parent_keys)
2657
2256
            else:
2658
2257
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2659
2258
        return result
2661
2260
    def _make_parents_provider(self):
2662
2261
        return self
2663
2262
 
2664
 
    @needs_read_lock
2665
 
    def get_known_graph_ancestry(self, revision_ids):
2666
 
        """Return the known graph for a set of revision ids and their ancestors.
2667
 
        """
2668
 
        st = static_tuple.StaticTuple
2669
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
2670
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
2671
 
        return graph.GraphThunkIdsToKeys(known_graph)
2672
 
 
2673
2263
    def get_graph(self, other_repository=None):
2674
2264
        """Return the graph walker for this repository format"""
2675
2265
        parents_provider = self._make_parents_provider()
2676
2266
        if (other_repository is not None and
2677
2267
            not self.has_same_location(other_repository)):
2678
 
            parents_provider = graph.StackedParentsProvider(
 
2268
            parents_provider = graph._StackedParentsProvider(
2679
2269
                [parents_provider, other_repository._make_parents_provider()])
2680
2270
        return graph.Graph(parents_provider)
2681
2271
 
2682
 
    def _get_versioned_file_checker(self, text_key_references=None,
2683
 
        ancestors=None):
 
2272
    def _get_versioned_file_checker(self, text_key_references=None):
2684
2273
        """Return an object suitable for checking versioned files.
2685
2274
        
2686
2275
        :param text_key_references: if non-None, an already built
2688
2277
            to whether they were referred to by the inventory of the
2689
2278
            revision_id that they contain. If None, this will be
2690
2279
            calculated.
2691
 
        :param ancestors: Optional result from
2692
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2693
 
            available.
2694
2280
        """
2695
2281
        return _VersionedFileChecker(self,
2696
 
            text_key_references=text_key_references, ancestors=ancestors)
 
2282
            text_key_references=text_key_references)
2697
2283
 
2698
2284
    def revision_ids_to_search_result(self, result_set):
2699
2285
        """Convert a set of revision ids to a graph SearchResult."""
2749
2335
        return record.get_bytes_as('fulltext')
2750
2336
 
2751
2337
    @needs_read_lock
2752
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
2338
    def check(self, revision_ids=None):
2753
2339
        """Check consistency of all history of given revision_ids.
2754
2340
 
2755
2341
        Different repository implementations should override _check().
2756
2342
 
2757
2343
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2758
2344
             will be checked.  Typically the last revision_id of a branch.
2759
 
        :param callback_refs: A dict of check-refs to resolve and callback
2760
 
            the check/_check method on the items listed as wanting the ref.
2761
 
            see bzrlib.check.
2762
 
        :param check_repo: If False do not check the repository contents, just 
2763
 
            calculate the data callback_refs requires and call them back.
2764
2345
        """
2765
 
        return self._check(revision_ids, callback_refs=callback_refs,
2766
 
            check_repo=check_repo)
 
2346
        return self._check(revision_ids)
2767
2347
 
2768
 
    def _check(self, revision_ids, callback_refs, check_repo):
2769
 
        result = check.Check(self, check_repo=check_repo)
2770
 
        result.check(callback_refs)
 
2348
    def _check(self, revision_ids):
 
2349
        result = check.Check(self)
 
2350
        result.check()
2771
2351
        return result
2772
2352
 
2773
 
    def _warn_if_deprecated(self, branch=None):
 
2353
    def _warn_if_deprecated(self):
2774
2354
        global _deprecation_warning_done
2775
2355
        if _deprecation_warning_done:
2776
2356
            return
2777
 
        try:
2778
 
            if branch is None:
2779
 
                conf = config.GlobalConfig()
2780
 
            else:
2781
 
                conf = branch.get_config()
2782
 
            if conf.suppress_warning('format_deprecation'):
2783
 
                return
2784
 
            warning("Format %s for %s is deprecated -"
2785
 
                    " please use 'bzr upgrade' to get better performance"
2786
 
                    % (self._format, self.bzrdir.transport.base))
2787
 
        finally:
2788
 
            _deprecation_warning_done = True
 
2357
        _deprecation_warning_done = True
 
2358
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
2359
                % (self._format, self.bzrdir.transport.base))
2789
2360
 
2790
2361
    def supports_rich_root(self):
2791
2362
        return self._format.rich_root_data
2865
2436
    """
2866
2437
    repository.start_write_group()
2867
2438
    try:
2868
 
        inventory_cache = lru_cache.LRUCache(10)
2869
2439
        for n, (revision, revision_tree, signature) in enumerate(iterable):
2870
 
            _install_revision(repository, revision, revision_tree, signature,
2871
 
                inventory_cache)
 
2440
            _install_revision(repository, revision, revision_tree, signature)
2872
2441
            if pb is not None:
2873
2442
                pb.update('Transferring revisions', n + 1, num_revisions)
2874
2443
    except:
2878
2447
        repository.commit_write_group()
2879
2448
 
2880
2449
 
2881
 
def _install_revision(repository, rev, revision_tree, signature,
2882
 
    inventory_cache):
 
2450
def _install_revision(repository, rev, revision_tree, signature):
2883
2451
    """Install all revision data into a repository."""
2884
2452
    present_parents = []
2885
2453
    parent_trees = {}
2922
2490
        repository.texts.add_lines(text_key, text_parents, lines)
2923
2491
    try:
2924
2492
        # install the inventory
2925
 
        if repository._format._commit_inv_deltas and len(rev.parent_ids):
2926
 
            # Cache this inventory
2927
 
            inventory_cache[rev.revision_id] = inv
2928
 
            try:
2929
 
                basis_inv = inventory_cache[rev.parent_ids[0]]
2930
 
            except KeyError:
2931
 
                repository.add_inventory(rev.revision_id, inv, present_parents)
2932
 
            else:
2933
 
                delta = inv._make_delta(basis_inv)
2934
 
                repository.add_inventory_by_delta(rev.parent_ids[0], delta,
2935
 
                    rev.revision_id, present_parents)
2936
 
        else:
2937
 
            repository.add_inventory(rev.revision_id, inv, present_parents)
 
2493
        repository.add_inventory(rev.revision_id, inv, present_parents)
2938
2494
    except errors.RevisionAlreadyPresent:
2939
2495
        pass
2940
2496
    if signature is not None:
3031
2587
 
3032
2588
    Once a format is deprecated, just deprecate the initialize and open
3033
2589
    methods on the format class. Do not deprecate the object, as the
3034
 
    object may be created even when a repository instance hasn't been
 
2590
    object may be created even when a repository instnace hasn't been
3035
2591
    created.
3036
2592
 
3037
2593
    Common instance attributes:
3047
2603
    # Can this repository be given external locations to lookup additional
3048
2604
    # data. Set to True or False in derived classes.
3049
2605
    supports_external_lookups = None
3050
 
    # Does this format support CHK bytestring lookups. Set to True or False in
3051
 
    # derived classes.
3052
 
    supports_chks = None
3053
 
    # Should commit add an inventory, or an inventory delta to the repository.
3054
 
    _commit_inv_deltas = True
3055
2606
    # What order should fetch operations request streams in?
3056
2607
    # The default is unordered as that is the cheapest for an origin to
3057
2608
    # provide.
3067
2618
    # Does this format have < O(tree_size) delta generation. Used to hint what
3068
2619
    # code path for commit, amongst other things.
3069
2620
    fast_deltas = None
3070
 
    # Does doing a pack operation compress data? Useful for the pack UI command
3071
 
    # (so if there is one pack, the operation can still proceed because it may
3072
 
    # help), and for fetching when data won't have come from the same
3073
 
    # compressor.
3074
 
    pack_compresses = False
3075
 
    # Does the repository inventory storage understand references to trees?
3076
 
    supports_tree_reference = None
3077
 
    # Is the format experimental ?
3078
 
    experimental = False
3079
2621
 
3080
 
    def __repr__(self):
3081
 
        return "%s()" % self.__class__.__name__
 
2622
    def __str__(self):
 
2623
        return "<%s>" % self.__class__.__name__
3082
2624
 
3083
2625
    def __eq__(self, other):
3084
2626
        # format objects are generally stateless
3097
2639
        """
3098
2640
        try:
3099
2641
            transport = a_bzrdir.get_repository_transport(None)
3100
 
            format_string = transport.get_bytes("format")
 
2642
            format_string = transport.get("format").read()
3101
2643
            return format_registry.get(format_string)
3102
2644
        except errors.NoSuchFile:
3103
2645
            raise errors.NoRepositoryPresent(a_bzrdir)
3185
2727
        raise NotImplementedError(self.network_name)
3186
2728
 
3187
2729
    def check_conversion_target(self, target_format):
3188
 
        if self.rich_root_data and not target_format.rich_root_data:
3189
 
            raise errors.BadConversionTarget(
3190
 
                'Does not support rich root data.', target_format,
3191
 
                from_format=self)
3192
 
        if (self.supports_tree_reference and 
3193
 
            not getattr(target_format, 'supports_tree_reference', False)):
3194
 
            raise errors.BadConversionTarget(
3195
 
                'Does not support nested trees', target_format,
3196
 
                from_format=self)
 
2730
        raise NotImplementedError(self.check_conversion_target)
3197
2731
 
3198
2732
    def open(self, a_bzrdir, _found=False):
3199
2733
        """Return an instance of this format for the bzrdir a_bzrdir.
3202
2736
        """
3203
2737
        raise NotImplementedError(self.open)
3204
2738
 
3205
 
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
3206
 
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
3207
 
        hooks = BzrDir.hooks['post_repo_init']
3208
 
        if not hooks:
3209
 
            return
3210
 
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
3211
 
        for hook in hooks:
3212
 
            hook(params)
3213
 
 
3214
2739
 
3215
2740
class MetaDirRepositoryFormat(RepositoryFormat):
3216
2741
    """Common base class for the new repositories using the metadir layout."""
3264
2789
# Pre-0.8 formats that don't have a disk format string (because they are
3265
2790
# versioned by the matching control directory). We use the control directories
3266
2791
# disk format string as a key for the network_name because they meet the
3267
 
# constraints (simple string, unique, immutable).
 
2792
# constraints (simple string, unique, immmutable).
3268
2793
network_format_registry.register_lazy(
3269
2794
    "Bazaar-NG branch, format 5\n",
3270
2795
    'bzrlib.repofmt.weaverepo',
3351
2876
    )
3352
2877
 
3353
2878
# Development formats.
3354
 
# Obsolete but kept pending a CHK based subtree format.
 
2879
# 1.7->1.8 go below here
 
2880
format_registry.register_lazy(
 
2881
    "Bazaar development format 2 (needs bzr.dev from before 1.8)\n",
 
2882
    'bzrlib.repofmt.pack_repo',
 
2883
    'RepositoryFormatPackDevelopment2',
 
2884
    )
3355
2885
format_registry.register_lazy(
3356
2886
    ("Bazaar development format 2 with subtree support "
3357
2887
        "(needs bzr.dev from before 1.8)\n"),
3359
2889
    'RepositoryFormatPackDevelopment2Subtree',
3360
2890
    )
3361
2891
 
3362
 
# 1.14->1.16 go below here
3363
 
format_registry.register_lazy(
3364
 
    'Bazaar development format - group compression and chk inventory'
3365
 
        ' (needs bzr.dev from 1.14)\n',
3366
 
    'bzrlib.repofmt.groupcompress_repo',
3367
 
    'RepositoryFormatCHK1',
3368
 
    )
3369
 
 
3370
 
format_registry.register_lazy(
3371
 
    'Bazaar development format - chk repository with bencode revision '
3372
 
        'serialization (needs bzr.dev from 1.16)\n',
3373
 
    'bzrlib.repofmt.groupcompress_repo',
3374
 
    'RepositoryFormatCHK2',
3375
 
    )
3376
 
format_registry.register_lazy(
3377
 
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
3378
 
    'bzrlib.repofmt.groupcompress_repo',
3379
 
    'RepositoryFormat2a',
3380
 
    )
3381
 
 
3382
2892
 
3383
2893
class InterRepository(InterObject):
3384
2894
    """This class represents operations taking place between two repositories.
3421
2931
 
3422
2932
        :param revision_id: if None all content is copied, if NULL_REVISION no
3423
2933
                            content is copied.
3424
 
        :param pb: ignored.
 
2934
        :param pb: optional progress bar to use for progress reports. If not
 
2935
                   provided a default one will be created.
3425
2936
        :return: None.
3426
2937
        """
3427
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3428
2938
        from bzrlib.fetch import RepoFetcher
3429
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
3430
 
        if self.source._format.network_name() != self.target._format.network_name():
3431
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
3432
 
                from_format=self.source._format,
3433
 
                to_format=self.target._format)
3434
2939
        f = RepoFetcher(to_repository=self.target,
3435
2940
                               from_repository=self.source,
3436
2941
                               last_revision=revision_id,
3437
2942
                               fetch_spec=fetch_spec,
3438
 
                               find_ghosts=find_ghosts)
 
2943
                               pb=pb, find_ghosts=find_ghosts)
3439
2944
 
3440
2945
    def _walk_to_common_revisions(self, revision_ids):
3441
2946
        """Walk out from revision_ids in source to revisions target has.
3445
2950
        """
3446
2951
        target_graph = self.target.get_graph()
3447
2952
        revision_ids = frozenset(revision_ids)
 
2953
        # Fast path for the case where all the revisions are already in the
 
2954
        # target repo.
 
2955
        # (Although this does incur an extra round trip for the
 
2956
        # fairly common case where the target doesn't already have the revision
 
2957
        # we're pushing.)
 
2958
        if set(target_graph.get_parent_map(revision_ids)) == revision_ids:
 
2959
            return graph.SearchResult(revision_ids, set(), 0, set())
3448
2960
        missing_revs = set()
3449
2961
        source_graph = self.source.get_graph()
3450
2962
        # ensure we don't pay silly lookup costs.
3610
3122
                self.target.texts.insert_record_stream(
3611
3123
                    self.source.texts.get_record_stream(
3612
3124
                        self.source.texts.keys(), 'topological', False))
3613
 
                pb.update('Copying inventory', 0, 1)
 
3125
                pb.update('copying inventory', 0, 1)
3614
3126
                self.target.inventories.insert_record_stream(
3615
3127
                    self.source.inventories.get_record_stream(
3616
3128
                        self.source.inventories.keys(), 'topological', False))
3637
3149
        # so the first thing is to get a subset of the revisions to
3638
3150
        # satisfy revision_id in source, and then eliminate those that
3639
3151
        # we do already have.
3640
 
        # this is slow on high latency connection to self, but as this
 
3152
        # this is slow on high latency connection to self, but as as this
3641
3153
        # disk format scales terribly for push anyway due to rewriting
3642
3154
        # inventory.weave, this is considered acceptable.
3643
3155
        # - RBC 20060209
3730
3242
        return self.source.revision_ids_to_search_result(result_set)
3731
3243
 
3732
3244
 
3733
 
class InterDifferingSerializer(InterRepository):
 
3245
class InterPackRepo(InterSameDataRepository):
 
3246
    """Optimised code paths between Pack based repositories."""
 
3247
 
 
3248
    @classmethod
 
3249
    def _get_repo_format_to_test(self):
 
3250
        from bzrlib.repofmt import pack_repo
 
3251
        return pack_repo.RepositoryFormatKnitPack1()
 
3252
 
 
3253
    @staticmethod
 
3254
    def is_compatible(source, target):
 
3255
        """Be compatible with known Pack formats.
 
3256
 
 
3257
        We don't test for the stores being of specific types because that
 
3258
        could lead to confusing results, and there is no need to be
 
3259
        overly general.
 
3260
        """
 
3261
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
3262
        try:
 
3263
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
3264
                isinstance(target._format, RepositoryFormatPack))
 
3265
        except AttributeError:
 
3266
            return False
 
3267
        return are_packs and InterRepository._same_model(source, target)
 
3268
 
 
3269
    @needs_write_lock
 
3270
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
 
3271
            fetch_spec=None):
 
3272
        """See InterRepository.fetch()."""
 
3273
        if (len(self.source._fallback_repositories) > 0 or
 
3274
            len(self.target._fallback_repositories) > 0):
 
3275
            # The pack layer is not aware of fallback repositories, so when
 
3276
            # fetching from a stacked repository or into a stacked repository
 
3277
            # we use the generic fetch logic which uses the VersionedFiles
 
3278
            # attributes on repository.
 
3279
            from bzrlib.fetch import RepoFetcher
 
3280
            fetcher = RepoFetcher(self.target, self.source, revision_id,
 
3281
                    pb, find_ghosts, fetch_spec=fetch_spec)
 
3282
        if fetch_spec is not None:
 
3283
            if len(list(fetch_spec.heads)) != 1:
 
3284
                raise AssertionError(
 
3285
                    "InterPackRepo.fetch doesn't support "
 
3286
                    "fetching multiple heads yet.")
 
3287
            revision_id = list(fetch_spec.heads)[0]
 
3288
            fetch_spec = None
 
3289
        if revision_id is None:
 
3290
            # TODO:
 
3291
            # everything to do - use pack logic
 
3292
            # to fetch from all packs to one without
 
3293
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
3294
            # till then:
 
3295
            source_revision_ids = frozenset(self.source.all_revision_ids())
 
3296
            revision_ids = source_revision_ids - \
 
3297
                frozenset(self.target.get_parent_map(source_revision_ids))
 
3298
            revision_keys = [(revid,) for revid in revision_ids]
 
3299
            index = self.target._pack_collection.revision_index.combined_index
 
3300
            present_revision_ids = set(item[1][0] for item in
 
3301
                index.iter_entries(revision_keys))
 
3302
            revision_ids = set(revision_ids) - present_revision_ids
 
3303
            # implementing the TODO will involve:
 
3304
            # - detecting when all of a pack is selected
 
3305
            # - avoiding as much as possible pre-selection, so the
 
3306
            # more-core routines such as create_pack_from_packs can filter in
 
3307
            # a just-in-time fashion. (though having a HEADS list on a
 
3308
            # repository might make this a lot easier, because we could
 
3309
            # sensibly detect 'new revisions' without doing a full index scan.
 
3310
        elif _mod_revision.is_null(revision_id):
 
3311
            # nothing to do:
 
3312
            return (0, [])
 
3313
        else:
 
3314
            try:
 
3315
                revision_ids = self.search_missing_revision_ids(revision_id,
 
3316
                    find_ghosts=find_ghosts).get_keys()
 
3317
            except errors.NoSuchRevision:
 
3318
                raise errors.InstallFailed([revision_id])
 
3319
            if len(revision_ids) == 0:
 
3320
                return (0, [])
 
3321
        return self._pack(self.source, self.target, revision_ids)
 
3322
 
 
3323
    def _pack(self, source, target, revision_ids):
 
3324
        from bzrlib.repofmt.pack_repo import Packer
 
3325
        packs = source._pack_collection.all_packs()
 
3326
        pack = Packer(self.target._pack_collection, packs, '.fetch',
 
3327
            revision_ids).pack()
 
3328
        if pack is not None:
 
3329
            self.target._pack_collection._save_pack_names()
 
3330
            copied_revs = pack.get_revision_count()
 
3331
            # Trigger an autopack. This may duplicate effort as we've just done
 
3332
            # a pack creation, but for now it is simpler to think about as
 
3333
            # 'upload data, then repack if needed'.
 
3334
            self.target._pack_collection.autopack()
 
3335
            return (copied_revs, [])
 
3336
        else:
 
3337
            return (0, [])
 
3338
 
 
3339
    @needs_read_lock
 
3340
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
3341
        """See InterRepository.missing_revision_ids().
 
3342
 
 
3343
        :param find_ghosts: Find ghosts throughout the ancestry of
 
3344
            revision_id.
 
3345
        """
 
3346
        if not find_ghosts and revision_id is not None:
 
3347
            return self._walk_to_common_revisions([revision_id])
 
3348
        elif revision_id is not None:
 
3349
            # Find ghosts: search for revisions pointing from one repository to
 
3350
            # the other, and vice versa, anywhere in the history of revision_id.
 
3351
            graph = self.target.get_graph(other_repository=self.source)
 
3352
            searcher = graph._make_breadth_first_searcher([revision_id])
 
3353
            found_ids = set()
 
3354
            while True:
 
3355
                try:
 
3356
                    next_revs, ghosts = searcher.next_with_ghosts()
 
3357
                except StopIteration:
 
3358
                    break
 
3359
                if revision_id in ghosts:
 
3360
                    raise errors.NoSuchRevision(self.source, revision_id)
 
3361
                found_ids.update(next_revs)
 
3362
                found_ids.update(ghosts)
 
3363
            found_ids = frozenset(found_ids)
 
3364
            # Double query here: should be able to avoid this by changing the
 
3365
            # graph api further.
 
3366
            result_set = found_ids - frozenset(
 
3367
                self.target.get_parent_map(found_ids))
 
3368
        else:
 
3369
            source_ids = self.source.all_revision_ids()
 
3370
            # source_ids is the worst possible case we may need to pull.
 
3371
            # now we want to filter source_ids against what we actually
 
3372
            # have in target, but don't try to check for existence where we know
 
3373
            # we do not have a revision as that would be pointless.
 
3374
            target_ids = set(self.target.all_revision_ids())
 
3375
            result_set = set(source_ids).difference(target_ids)
 
3376
        return self.source.revision_ids_to_search_result(result_set)
 
3377
 
 
3378
 
 
3379
class InterDifferingSerializer(InterKnitRepo):
3734
3380
 
3735
3381
    @classmethod
3736
3382
    def _get_repo_format_to_test(self):
3739
3385
    @staticmethod
3740
3386
    def is_compatible(source, target):
3741
3387
        """Be compatible with Knit2 source and Knit3 target"""
3742
 
        # This is redundant with format.check_conversion_target(), however that
3743
 
        # raises an exception, and we just want to say "False" as in we won't
3744
 
        # support converting between these formats.
3745
 
        if 'IDS_never' in debug.debug_flags:
3746
 
            return False
3747
 
        if source.supports_rich_root() and not target.supports_rich_root():
3748
 
            return False
3749
 
        if (source._format.supports_tree_reference
3750
 
            and not target._format.supports_tree_reference):
3751
 
            return False
3752
 
        if target._fallback_repositories and target._format.supports_chks:
3753
 
            # IDS doesn't know how to copy CHKs for the parent inventories it
3754
 
            # adds to stacked repos.
3755
 
            return False
3756
 
        if 'IDS_always' in debug.debug_flags:
3757
 
            return True
3758
 
        # Only use this code path for local source and target.  IDS does far
3759
 
        # too much IO (both bandwidth and roundtrips) over a network.
3760
 
        if not source.bzrdir.transport.base.startswith('file:///'):
3761
 
            return False
3762
 
        if not target.bzrdir.transport.base.startswith('file:///'):
 
3388
        if source.supports_rich_root() != target.supports_rich_root():
 
3389
            return False
 
3390
        # Ideally, we'd support fetching if the source had no tree references
 
3391
        # even if it supported them...
 
3392
        if (getattr(source, '_format.supports_tree_reference', False) and
 
3393
            not getattr(target, '_format.supports_tree_reference', False)):
3763
3394
            return False
3764
3395
        return True
3765
3396
 
3766
 
    def _get_trees(self, revision_ids, cache):
3767
 
        possible_trees = []
3768
 
        for rev_id in revision_ids:
3769
 
            if rev_id in cache:
3770
 
                possible_trees.append((rev_id, cache[rev_id]))
3771
 
            else:
3772
 
                # Not cached, but inventory might be present anyway.
3773
 
                try:
3774
 
                    tree = self.source.revision_tree(rev_id)
3775
 
                except errors.NoSuchRevision:
3776
 
                    # Nope, parent is ghost.
3777
 
                    pass
3778
 
                else:
3779
 
                    cache[rev_id] = tree
3780
 
                    possible_trees.append((rev_id, tree))
3781
 
        return possible_trees
3782
 
 
3783
 
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
 
3397
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
3784
3398
        """Get the best delta and base for this revision.
3785
3399
 
3786
3400
        :return: (basis_id, delta)
3787
3401
        """
 
3402
        possible_trees = [(parent_id, cache[parent_id])
 
3403
                          for parent_id in parent_ids
 
3404
                           if parent_id in cache]
 
3405
        if len(possible_trees) == 0:
 
3406
            # There either aren't any parents, or the parents aren't in the
 
3407
            # cache, so just use the last converted tree
 
3408
            possible_trees.append((basis_id, cache[basis_id]))
3788
3409
        deltas = []
3789
 
        # Generate deltas against each tree, to find the shortest.
3790
 
        texts_possibly_new_in_tree = set()
3791
3410
        for basis_id, basis_tree in possible_trees:
3792
3411
            delta = tree.inventory._make_delta(basis_tree.inventory)
3793
 
            for old_path, new_path, file_id, new_entry in delta:
3794
 
                if new_path is None:
3795
 
                    # This file_id isn't present in the new rev, so we don't
3796
 
                    # care about it.
3797
 
                    continue
3798
 
                if not new_path:
3799
 
                    # Rich roots are handled elsewhere...
3800
 
                    continue
3801
 
                kind = new_entry.kind
3802
 
                if kind != 'directory' and kind != 'file':
3803
 
                    # No text record associated with this inventory entry.
3804
 
                    continue
3805
 
                # This is a directory or file that has changed somehow.
3806
 
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3807
3412
            deltas.append((len(delta), basis_id, delta))
3808
3413
        deltas.sort()
3809
3414
        return deltas[0][1:]
3810
3415
 
3811
 
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
3812
 
        """Find all parent revisions that are absent, but for which the
3813
 
        inventory is present, and copy those inventories.
3814
 
 
3815
 
        This is necessary to preserve correctness when the source is stacked
3816
 
        without fallbacks configured.  (Note that in cases like upgrade the
3817
 
        source may be not have _fallback_repositories even though it is
3818
 
        stacked.)
3819
 
        """
3820
 
        parent_revs = set()
3821
 
        for parents in parent_map.values():
3822
 
            parent_revs.update(parents)
3823
 
        present_parents = self.source.get_parent_map(parent_revs)
3824
 
        absent_parents = set(parent_revs).difference(present_parents)
3825
 
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
3826
 
            (rev_id,) for rev_id in absent_parents)
3827
 
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
3828
 
        for parent_tree in self.source.revision_trees(parent_inv_ids):
3829
 
            current_revision_id = parent_tree.get_revision_id()
3830
 
            parents_parents_keys = parent_invs_keys_for_stacking[
3831
 
                (current_revision_id,)]
3832
 
            parents_parents = [key[-1] for key in parents_parents_keys]
3833
 
            basis_id = _mod_revision.NULL_REVISION
3834
 
            basis_tree = self.source.revision_tree(basis_id)
3835
 
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
3836
 
            self.target.add_inventory_by_delta(
3837
 
                basis_id, delta, current_revision_id, parents_parents)
3838
 
            cache[current_revision_id] = parent_tree
3839
 
 
3840
 
    def _fetch_batch(self, revision_ids, basis_id, cache, a_graph=None):
 
3416
    def _fetch_batch(self, revision_ids, basis_id, cache):
3841
3417
        """Fetch across a few revisions.
3842
3418
 
3843
3419
        :param revision_ids: The revisions to copy
3844
3420
        :param basis_id: The revision_id of a tree that must be in cache, used
3845
3421
            as a basis for delta when no other base is available
3846
3422
        :param cache: A cache of RevisionTrees that we can use.
3847
 
        :param a_graph: A Graph object to determine the heads() of the
3848
 
            rich-root data stream.
3849
3423
        :return: The revision_id of the last converted tree. The RevisionTree
3850
3424
            for it will be in cache
3851
3425
        """
3852
3426
        # Walk though all revisions; get inventory deltas, copy referenced
3853
3427
        # texts that delta references, insert the delta, revision and
3854
3428
        # signature.
3855
 
        root_keys_to_create = set()
3856
3429
        text_keys = set()
3857
3430
        pending_deltas = []
3858
3431
        pending_revisions = []
3859
3432
        parent_map = self.source.get_parent_map(revision_ids)
3860
 
        self._fetch_parent_invs_for_stacking(parent_map, cache)
3861
 
        self.source._safe_to_return_from_cache = True
3862
3433
        for tree in self.source.revision_trees(revision_ids):
3863
 
            # Find a inventory delta for this revision.
3864
 
            # Find text entries that need to be copied, too.
3865
3434
            current_revision_id = tree.get_revision_id()
3866
3435
            parent_ids = parent_map.get(current_revision_id, ())
3867
 
            parent_trees = self._get_trees(parent_ids, cache)
3868
 
            possible_trees = list(parent_trees)
3869
 
            if len(possible_trees) == 0:
3870
 
                # There either aren't any parents, or the parents are ghosts,
3871
 
                # so just use the last converted tree.
3872
 
                possible_trees.append((basis_id, cache[basis_id]))
3873
3436
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3874
 
                                                           possible_trees)
 
3437
                                                           basis_id, cache)
 
3438
            # Find text entries that need to be copied
 
3439
            for old_path, new_path, file_id, entry in delta:
 
3440
                if new_path is not None:
 
3441
                    if not (new_path or self.target.supports_rich_root()):
 
3442
                        # We don't copy the text for the root node unless the
 
3443
                        # target supports_rich_root.
 
3444
                        continue
 
3445
                    text_keys.add((file_id, entry.revision))
3875
3446
            revision = self.source.get_revision(current_revision_id)
3876
3447
            pending_deltas.append((basis_id, delta,
3877
3448
                current_revision_id, revision.parent_ids))
3878
 
            if self._converting_to_rich_root:
3879
 
                self._revision_id_to_root_id[current_revision_id] = \
3880
 
                    tree.get_root_id()
3881
 
            # Determine which texts are in present in this revision but not in
3882
 
            # any of the available parents.
3883
 
            texts_possibly_new_in_tree = set()
3884
 
            for old_path, new_path, file_id, entry in delta:
3885
 
                if new_path is None:
3886
 
                    # This file_id isn't present in the new rev
3887
 
                    continue
3888
 
                if not new_path:
3889
 
                    # This is the root
3890
 
                    if not self.target.supports_rich_root():
3891
 
                        # The target doesn't support rich root, so we don't
3892
 
                        # copy
3893
 
                        continue
3894
 
                    if self._converting_to_rich_root:
3895
 
                        # This can't be copied normally, we have to insert
3896
 
                        # it specially
3897
 
                        root_keys_to_create.add((file_id, entry.revision))
3898
 
                        continue
3899
 
                kind = entry.kind
3900
 
                texts_possibly_new_in_tree.add((file_id, entry.revision))
3901
 
            for basis_id, basis_tree in possible_trees:
3902
 
                basis_inv = basis_tree.inventory
3903
 
                for file_key in list(texts_possibly_new_in_tree):
3904
 
                    file_id, file_revision = file_key
3905
 
                    try:
3906
 
                        entry = basis_inv[file_id]
3907
 
                    except errors.NoSuchId:
3908
 
                        continue
3909
 
                    if entry.revision == file_revision:
3910
 
                        texts_possibly_new_in_tree.remove(file_key)
3911
 
            text_keys.update(texts_possibly_new_in_tree)
3912
3449
            pending_revisions.append(revision)
3913
3450
            cache[current_revision_id] = tree
3914
3451
            basis_id = current_revision_id
3915
 
        self.source._safe_to_return_from_cache = False
3916
3452
        # Copy file texts
3917
3453
        from_texts = self.source.texts
3918
3454
        to_texts = self.target.texts
3919
 
        if root_keys_to_create:
3920
 
            root_stream = _mod_fetch._new_root_data_stream(
3921
 
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
3922
 
                self.source, graph=a_graph)
3923
 
            to_texts.insert_record_stream(root_stream)
3924
3455
        to_texts.insert_record_stream(from_texts.get_record_stream(
3925
3456
            text_keys, self.target._format._fetch_order,
3926
3457
            not self.target._format._fetch_uses_deltas))
3927
 
        # insert inventory deltas
 
3458
        # insert deltas
3928
3459
        for delta in pending_deltas:
3929
3460
            self.target.add_inventory_by_delta(*delta)
3930
 
        if self.target._fallback_repositories:
3931
 
            # Make sure this stacked repository has all the parent inventories
3932
 
            # for the new revisions that we are about to insert.  We do this
3933
 
            # before adding the revisions so that no revision is added until
3934
 
            # all the inventories it may depend on are added.
3935
 
            # Note that this is overzealous, as we may have fetched these in an
3936
 
            # earlier batch.
3937
 
            parent_ids = set()
3938
 
            revision_ids = set()
3939
 
            for revision in pending_revisions:
3940
 
                revision_ids.add(revision.revision_id)
3941
 
                parent_ids.update(revision.parent_ids)
3942
 
            parent_ids.difference_update(revision_ids)
3943
 
            parent_ids.discard(_mod_revision.NULL_REVISION)
3944
 
            parent_map = self.source.get_parent_map(parent_ids)
3945
 
            # we iterate over parent_map and not parent_ids because we don't
3946
 
            # want to try copying any revision which is a ghost
3947
 
            for parent_tree in self.source.revision_trees(parent_map):
3948
 
                current_revision_id = parent_tree.get_revision_id()
3949
 
                parents_parents = parent_map[current_revision_id]
3950
 
                possible_trees = self._get_trees(parents_parents, cache)
3951
 
                if len(possible_trees) == 0:
3952
 
                    # There either aren't any parents, or the parents are
3953
 
                    # ghosts, so just use the last converted tree.
3954
 
                    possible_trees.append((basis_id, cache[basis_id]))
3955
 
                basis_id, delta = self._get_delta_for_revision(parent_tree,
3956
 
                    parents_parents, possible_trees)
3957
 
                self.target.add_inventory_by_delta(
3958
 
                    basis_id, delta, current_revision_id, parents_parents)
3959
3461
        # insert signatures and revisions
3960
3462
        for revision in pending_revisions:
3961
3463
            try:
3973
3475
 
3974
3476
        :param revision_ids: The list of revisions to fetch. Must be in
3975
3477
            topological order.
3976
 
        :param pb: A ProgressTask
 
3478
        :param pb: A ProgressBar
3977
3479
        :return: None
3978
3480
        """
3979
3481
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3981
3483
        cache = lru_cache.LRUCache(100)
3982
3484
        cache[basis_id] = basis_tree
3983
3485
        del basis_tree # We don't want to hang on to it here
3984
 
        hints = []
3985
 
        if self._converting_to_rich_root and len(revision_ids) > 100:
3986
 
            a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
3987
 
                                                            revision_ids)
3988
 
        else:
3989
 
            a_graph = None
3990
 
 
3991
3486
        for offset in range(0, len(revision_ids), batch_size):
3992
3487
            self.target.start_write_group()
3993
3488
            try:
3994
3489
                pb.update('Transferring revisions', offset,
3995
3490
                          len(revision_ids))
3996
3491
                batch = revision_ids[offset:offset+batch_size]
3997
 
                basis_id = self._fetch_batch(batch, basis_id, cache,
3998
 
                                             a_graph=a_graph)
 
3492
                basis_id = self._fetch_batch(batch, basis_id, cache)
3999
3493
            except:
4000
 
                self.source._safe_to_return_from_cache = False
4001
3494
                self.target.abort_write_group()
4002
3495
                raise
4003
3496
            else:
4004
 
                hint = self.target.commit_write_group()
4005
 
                if hint:
4006
 
                    hints.extend(hint)
4007
 
        if hints and self.target._format.pack_compresses:
4008
 
            self.target.pack(hint=hints)
 
3497
                self.target.commit_write_group()
4009
3498
        pb.update('Transferring revisions', len(revision_ids),
4010
3499
                  len(revision_ids))
4011
3500
 
4015
3504
        """See InterRepository.fetch()."""
4016
3505
        if fetch_spec is not None:
4017
3506
            raise AssertionError("Not implemented yet...")
4018
 
        ui.ui_factory.warn_experimental_format_fetch(self)
4019
 
        if (not self.source.supports_rich_root()
4020
 
            and self.target.supports_rich_root()):
4021
 
            self._converting_to_rich_root = True
4022
 
            self._revision_id_to_root_id = {}
4023
 
        else:
4024
 
            self._converting_to_rich_root = False
4025
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
4026
 
        if self.source._format.network_name() != self.target._format.network_name():
4027
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
4028
 
                from_format=self.source._format,
4029
 
                to_format=self.target._format)
4030
3507
        revision_ids = self.target.search_missing_revision_ids(self.source,
4031
3508
            revision_id, find_ghosts=find_ghosts).get_keys()
4032
3509
        if not revision_ids:
4033
3510
            return 0, 0
4034
3511
        revision_ids = tsort.topo_sort(
4035
3512
            self.source.get_graph().get_parent_map(revision_ids))
4036
 
        if not revision_ids:
4037
 
            return 0, 0
4038
 
        # Walk though all revisions; get inventory deltas, copy referenced
4039
 
        # texts that delta references, insert the delta, revision and
4040
 
        # signature.
4041
3513
        if pb is None:
4042
3514
            my_pb = ui.ui_factory.nested_progress_bar()
4043
3515
            pb = my_pb
4080
3552
InterRepository.register_optimiser(InterSameDataRepository)
4081
3553
InterRepository.register_optimiser(InterWeaveRepo)
4082
3554
InterRepository.register_optimiser(InterKnitRepo)
 
3555
InterRepository.register_optimiser(InterPackRepo)
4083
3556
 
4084
3557
 
4085
3558
class CopyConverter(object):
4101
3574
        :param to_convert: The disk object to convert.
4102
3575
        :param pb: a progress bar to use for progress information.
4103
3576
        """
4104
 
        pb = ui.ui_factory.nested_progress_bar()
 
3577
        self.pb = pb
4105
3578
        self.count = 0
4106
3579
        self.total = 4
4107
3580
        # this is only useful with metadir layouts - separated repo content.
4108
3581
        # trigger an assertion if not such
4109
3582
        repo._format.get_format_string()
4110
3583
        self.repo_dir = repo.bzrdir
4111
 
        pb.update('Moving repository to repository.backup')
 
3584
        self.step('Moving repository to repository.backup')
4112
3585
        self.repo_dir.transport.move('repository', 'repository.backup')
4113
3586
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4114
3587
        repo._format.check_conversion_target(self.target_format)
4115
3588
        self.source_repo = repo._format.open(self.repo_dir,
4116
3589
            _found=True,
4117
3590
            _override_transport=backup_transport)
4118
 
        pb.update('Creating new repository')
 
3591
        self.step('Creating new repository')
4119
3592
        converted = self.target_format.initialize(self.repo_dir,
4120
3593
                                                  self.source_repo.is_shared())
4121
3594
        converted.lock_write()
4122
3595
        try:
4123
 
            pb.update('Copying content')
 
3596
            self.step('Copying content into repository.')
4124
3597
            self.source_repo.copy_content_into(converted)
4125
3598
        finally:
4126
3599
            converted.unlock()
4127
 
        pb.update('Deleting old repository content')
 
3600
        self.step('Deleting old repository content.')
4128
3601
        self.repo_dir.transport.delete_tree('repository.backup')
4129
 
        ui.ui_factory.note('repository converted')
4130
 
        pb.finished()
 
3602
        self.pb.note('repository converted')
 
3603
 
 
3604
    def step(self, message):
 
3605
        """Update the pb by a step."""
 
3606
        self.count +=1
 
3607
        self.pb.update(message, self.count, self.total)
4131
3608
 
4132
3609
 
4133
3610
_unescape_map = {
4162
3639
 
4163
3640
class _VersionedFileChecker(object):
4164
3641
 
4165
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
3642
    def __init__(self, repository, text_key_references=None):
4166
3643
        self.repository = repository
4167
3644
        self.text_index = self.repository._generate_text_key_index(
4168
 
            text_key_references=text_key_references, ancestors=ancestors)
 
3645
            text_key_references=text_key_references)
4169
3646
 
4170
3647
    def calculate_file_version_parents(self, text_key):
4171
3648
        """Calculate the correct parents for a file version according to
4189
3666
            revision_id) tuples for versions that are present in this versioned
4190
3667
            file, but not used by the corresponding inventory.
4191
3668
        """
4192
 
        local_progress = None
4193
 
        if progress_bar is None:
4194
 
            local_progress = ui.ui_factory.nested_progress_bar()
4195
 
            progress_bar = local_progress
4196
 
        try:
4197
 
            return self._check_file_version_parents(texts, progress_bar)
4198
 
        finally:
4199
 
            if local_progress:
4200
 
                local_progress.finished()
4201
 
 
4202
 
    def _check_file_version_parents(self, texts, progress_bar):
4203
 
        """See check_file_version_parents."""
4204
3669
        wrong_parents = {}
4205
3670
        self.file_ids = set([file_id for file_id, _ in
4206
3671
            self.text_index.iterkeys()])
4207
3672
        # text keys is now grouped by file_id
 
3673
        n_weaves = len(self.file_ids)
 
3674
        files_in_revisions = {}
 
3675
        revisions_of_files = {}
4208
3676
        n_versions = len(self.text_index)
4209
3677
        progress_bar.update('loading text store', 0, n_versions)
4210
3678
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4212
3680
        text_keys = self.repository.texts.keys()
4213
3681
        unused_keys = frozenset(text_keys) - set(self.text_index)
4214
3682
        for num, key in enumerate(self.text_index.iterkeys()):
4215
 
            progress_bar.update('checking text graph', num, n_versions)
 
3683
            if progress_bar is not None:
 
3684
                progress_bar.update('checking text graph', num, n_versions)
4216
3685
            correct_parents = self.calculate_file_version_parents(key)
4217
3686
            try:
4218
3687
                knit_parents = parent_map[key]
4267
3736
        try:
4268
3737
            if resume_tokens:
4269
3738
                self.target_repo.resume_write_group(resume_tokens)
4270
 
                is_resume = True
4271
3739
            else:
4272
3740
                self.target_repo.start_write_group()
4273
 
                is_resume = False
4274
3741
            try:
4275
3742
                # locked_insert_stream performs a commit|suspend.
4276
 
                return self._locked_insert_stream(stream, src_format, is_resume)
 
3743
                return self._locked_insert_stream(stream, src_format)
4277
3744
            except:
4278
3745
                self.target_repo.abort_write_group(suppress_errors=True)
4279
3746
                raise
4280
3747
        finally:
4281
3748
            self.target_repo.unlock()
4282
3749
 
4283
 
    def _locked_insert_stream(self, stream, src_format, is_resume):
 
3750
    def _locked_insert_stream(self, stream, src_format):
4284
3751
        to_serializer = self.target_repo._format._serializer
4285
3752
        src_serializer = src_format._serializer
4286
 
        new_pack = None
4287
 
        if to_serializer == src_serializer:
4288
 
            # If serializers match and the target is a pack repository, set the
4289
 
            # write cache size on the new pack.  This avoids poor performance
4290
 
            # on transports where append is unbuffered (such as
4291
 
            # RemoteTransport).  This is safe to do because nothing should read
4292
 
            # back from the target repository while a stream with matching
4293
 
            # serialization is being inserted.
4294
 
            # The exception is that a delta record from the source that should
4295
 
            # be a fulltext may need to be expanded by the target (see
4296
 
            # test_fetch_revisions_with_deltas_into_pack); but we take care to
4297
 
            # explicitly flush any buffered writes first in that rare case.
4298
 
            try:
4299
 
                new_pack = self.target_repo._pack_collection._new_pack
4300
 
            except AttributeError:
4301
 
                # Not a pack repository
4302
 
                pass
4303
 
            else:
4304
 
                new_pack.set_write_cache_size(1024*1024)
4305
3753
        for substream_type, substream in stream:
4306
 
            if 'stream' in debug.debug_flags:
4307
 
                mutter('inserting substream: %s', substream_type)
4308
3754
            if substream_type == 'texts':
4309
3755
                self.target_repo.texts.insert_record_stream(substream)
4310
3756
            elif substream_type == 'inventories':
4314
3760
                else:
4315
3761
                    self._extract_and_insert_inventories(
4316
3762
                        substream, src_serializer)
4317
 
            elif substream_type == 'inventory-deltas':
4318
 
                self._extract_and_insert_inventory_deltas(
4319
 
                    substream, src_serializer)
4320
 
            elif substream_type == 'chk_bytes':
4321
 
                # XXX: This doesn't support conversions, as it assumes the
4322
 
                #      conversion was done in the fetch code.
4323
 
                self.target_repo.chk_bytes.insert_record_stream(substream)
4324
3763
            elif substream_type == 'revisions':
4325
3764
                # This may fallback to extract-and-insert more often than
4326
3765
                # required if the serializers are different only in terms of
4335
3774
                self.target_repo.signatures.insert_record_stream(substream)
4336
3775
            else:
4337
3776
                raise AssertionError('kaboom! %s' % (substream_type,))
4338
 
        # Done inserting data, and the missing_keys calculations will try to
4339
 
        # read back from the inserted data, so flush the writes to the new pack
4340
 
        # (if this is pack format).
4341
 
        if new_pack is not None:
4342
 
            new_pack._write_data('', flush=True)
4343
 
        # Find all the new revisions (including ones from resume_tokens)
4344
 
        missing_keys = self.target_repo.get_missing_parent_inventories(
4345
 
            check_for_missing_texts=is_resume)
4346
3777
        try:
 
3778
            missing_keys = set()
4347
3779
            for prefix, versioned_file in (
4348
3780
                ('texts', self.target_repo.texts),
4349
3781
                ('inventories', self.target_repo.inventories),
4350
3782
                ('revisions', self.target_repo.revisions),
4351
3783
                ('signatures', self.target_repo.signatures),
4352
 
                ('chk_bytes', self.target_repo.chk_bytes),
4353
3784
                ):
4354
 
                if versioned_file is None:
4355
 
                    continue
4356
 
                # TODO: key is often going to be a StaticTuple object
4357
 
                #       I don't believe we can define a method by which
4358
 
                #       (prefix,) + StaticTuple will work, though we could
4359
 
                #       define a StaticTuple.sq_concat that would allow you to
4360
 
                #       pass in either a tuple or a StaticTuple as the second
4361
 
                #       object, so instead we could have:
4362
 
                #       StaticTuple(prefix) + key here...
4363
3785
                missing_keys.update((prefix,) + key for key in
4364
3786
                    versioned_file.get_missing_compression_parent_keys())
4365
3787
        except NotImplementedError:
4374
3796
                # missing keys can handle suspending a write group).
4375
3797
                write_group_tokens = self.target_repo.suspend_write_group()
4376
3798
                return write_group_tokens, missing_keys
4377
 
        hint = self.target_repo.commit_write_group()
4378
 
        if (to_serializer != src_serializer and
4379
 
            self.target_repo._format.pack_compresses):
4380
 
            self.target_repo.pack(hint=hint)
 
3799
        self.target_repo.commit_write_group()
4381
3800
        return [], set()
4382
3801
 
4383
 
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
4384
 
        target_rich_root = self.target_repo._format.rich_root_data
4385
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4386
 
        for record in substream:
4387
 
            # Insert the delta directly
4388
 
            inventory_delta_bytes = record.get_bytes_as('fulltext')
4389
 
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
4390
 
            try:
4391
 
                parse_result = deserialiser.parse_text_bytes(
4392
 
                    inventory_delta_bytes)
4393
 
            except inventory_delta.IncompatibleInventoryDelta, err:
4394
 
                trace.mutter("Incompatible delta: %s", err.msg)
4395
 
                raise errors.IncompatibleRevision(self.target_repo._format)
4396
 
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
4397
 
            revision_id = new_id
4398
 
            parents = [key[0] for key in record.parents]
4399
 
            self.target_repo.add_inventory_by_delta(
4400
 
                basis_id, inv_delta, revision_id, parents)
4401
 
 
4402
 
    def _extract_and_insert_inventories(self, substream, serializer,
4403
 
            parse_delta=None):
 
3802
    def _extract_and_insert_inventories(self, substream, serializer):
4404
3803
        """Generate a new inventory versionedfile in target, converting data.
4405
3804
 
4406
3805
        The inventory is retrieved from the source, (deserializing it), and
4407
3806
        stored in the target (reserializing it in a different format).
4408
3807
        """
4409
 
        target_rich_root = self.target_repo._format.rich_root_data
4410
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4411
3808
        for record in substream:
4412
 
            # It's not a delta, so it must be a fulltext in the source
4413
 
            # serializer's format.
4414
3809
            bytes = record.get_bytes_as('fulltext')
4415
3810
            revision_id = record.key[0]
4416
3811
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4417
3812
            parents = [key[0] for key in record.parents]
4418
3813
            self.target_repo.add_inventory(revision_id, inv, parents)
4419
 
            # No need to keep holding this full inv in memory when the rest of
4420
 
            # the substream is likely to be all deltas.
4421
 
            del inv
4422
3814
 
4423
3815
    def _extract_and_insert_revisions(self, substream, serializer):
4424
3816
        for record in substream:
4473
3865
        return [('signatures', signatures), ('revisions', revisions)]
4474
3866
 
4475
3867
    def _generate_root_texts(self, revs):
4476
 
        """This will be called by get_stream between fetching weave texts and
 
3868
        """This will be called by __fetch between fetching weave texts and
4477
3869
        fetching the inventory weave.
 
3870
 
 
3871
        Subclasses should override this if they need to generate root texts
 
3872
        after fetching weave texts.
4478
3873
        """
4479
3874
        if self._rich_root_upgrade():
4480
 
            return _mod_fetch.Inter1and2Helper(
 
3875
            import bzrlib.fetch
 
3876
            return bzrlib.fetch.Inter1and2Helper(
4481
3877
                self.from_repository).generate_root_texts(revs)
4482
3878
        else:
4483
3879
            return []
4486
3882
        phase = 'file'
4487
3883
        revs = search.get_keys()
4488
3884
        graph = self.from_repository.get_graph()
4489
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
 
3885
        revs = list(graph.iter_topo_order(revs))
4490
3886
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4491
3887
        text_keys = []
4492
3888
        for knit_kind, file_id, revisions in data_to_fetch:
4511
3907
                # will be valid.
4512
3908
                for _ in self._generate_root_texts(revs):
4513
3909
                    yield _
 
3910
                # NB: This currently reopens the inventory weave in source;
 
3911
                # using a single stream interface instead would avoid this.
 
3912
                from_weave = self.from_repository.inventories
4514
3913
                # we fetch only the referenced inventories because we do not
4515
3914
                # know for unselected inventories whether all their required
4516
3915
                # texts are present in the other repository - it could be
4517
3916
                # corrupt.
4518
 
                for info in self._get_inventory_stream(revs):
4519
 
                    yield info
 
3917
                yield ('inventories', from_weave.get_record_stream(
 
3918
                    [(rev_id,) for rev_id in revs],
 
3919
                    self.inventory_fetch_order(),
 
3920
                    not self.delta_on_metadata()))
4520
3921
            elif knit_kind == "signatures":
4521
3922
                # Nothing to do here; this will be taken care of when
4522
3923
                # _fetch_revision_texts happens.
4535
3936
        keys['texts'] = set()
4536
3937
        keys['revisions'] = set()
4537
3938
        keys['inventories'] = set()
4538
 
        keys['chk_bytes'] = set()
4539
3939
        keys['signatures'] = set()
4540
3940
        for key in missing_keys:
4541
3941
            keys[key[0]].add(key[1:])
4548
3948
                    keys['revisions'],))
4549
3949
        for substream_kind, keys in keys.iteritems():
4550
3950
            vf = getattr(self.from_repository, substream_kind)
4551
 
            if vf is None and keys:
4552
 
                    raise AssertionError(
4553
 
                        "cannot fill in keys for a versioned file we don't"
4554
 
                        " have: %s needs %s" % (substream_kind, keys))
4555
 
            if not keys:
4556
 
                # No need to stream something we don't have
4557
 
                continue
4558
 
            if substream_kind == 'inventories':
4559
 
                # Some missing keys are genuinely ghosts, filter those out.
4560
 
                present = self.from_repository.inventories.get_parent_map(keys)
4561
 
                revs = [key[0] for key in present]
4562
 
                # Get the inventory stream more-or-less as we do for the
4563
 
                # original stream; there's no reason to assume that records
4564
 
                # direct from the source will be suitable for the sink.  (Think
4565
 
                # e.g. 2a -> 1.9-rich-root).
4566
 
                for info in self._get_inventory_stream(revs, missing=True):
4567
 
                    yield info
4568
 
                continue
4569
 
 
4570
3951
            # Ask for full texts always so that we don't need more round trips
4571
3952
            # after this stream.
4572
 
            # Some of the missing keys are genuinely ghosts, so filter absent
4573
 
            # records. The Sink is responsible for doing another check to
4574
 
            # ensure that ghosts don't introduce missing data for future
4575
 
            # fetches.
4576
 
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
4577
 
                self.to_format._fetch_order, True))
 
3953
            stream = vf.get_record_stream(keys,
 
3954
                self.to_format._fetch_order, True)
4578
3955
            yield substream_kind, stream
4579
3956
 
4580
3957
    def inventory_fetch_order(self):
4587
3964
        return (not self.from_repository._format.rich_root_data and
4588
3965
            self.to_format.rich_root_data)
4589
3966
 
4590
 
    def _get_inventory_stream(self, revision_ids, missing=False):
4591
 
        from_format = self.from_repository._format
4592
 
        if (from_format.supports_chks and self.to_format.supports_chks and
4593
 
            from_format.network_name() == self.to_format.network_name()):
4594
 
            raise AssertionError(
4595
 
                "this case should be handled by GroupCHKStreamSource")
4596
 
        elif 'forceinvdeltas' in debug.debug_flags:
4597
 
            return self._get_convertable_inventory_stream(revision_ids,
4598
 
                    delta_versus_null=missing)
4599
 
        elif from_format.network_name() == self.to_format.network_name():
4600
 
            # Same format.
4601
 
            return self._get_simple_inventory_stream(revision_ids,
4602
 
                    missing=missing)
4603
 
        elif (not from_format.supports_chks and not self.to_format.supports_chks
4604
 
                and from_format._serializer == self.to_format._serializer):
4605
 
            # Essentially the same format.
4606
 
            return self._get_simple_inventory_stream(revision_ids,
4607
 
                    missing=missing)
4608
 
        else:
4609
 
            # Any time we switch serializations, we want to use an
4610
 
            # inventory-delta based approach.
4611
 
            return self._get_convertable_inventory_stream(revision_ids,
4612
 
                    delta_versus_null=missing)
4613
 
 
4614
 
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
4615
 
        # NB: This currently reopens the inventory weave in source;
4616
 
        # using a single stream interface instead would avoid this.
4617
 
        from_weave = self.from_repository.inventories
4618
 
        if missing:
4619
 
            delta_closure = True
4620
 
        else:
4621
 
            delta_closure = not self.delta_on_metadata()
4622
 
        yield ('inventories', from_weave.get_record_stream(
4623
 
            [(rev_id,) for rev_id in revision_ids],
4624
 
            self.inventory_fetch_order(), delta_closure))
4625
 
 
4626
 
    def _get_convertable_inventory_stream(self, revision_ids,
4627
 
                                          delta_versus_null=False):
4628
 
        # The two formats are sufficiently different that there is no fast
4629
 
        # path, so we need to send just inventorydeltas, which any
4630
 
        # sufficiently modern client can insert into any repository.
4631
 
        # The StreamSink code expects to be able to
4632
 
        # convert on the target, so we need to put bytes-on-the-wire that can
4633
 
        # be converted.  That means inventory deltas (if the remote is <1.19,
4634
 
        # RemoteStreamSink will fallback to VFS to insert the deltas).
4635
 
        yield ('inventory-deltas',
4636
 
           self._stream_invs_as_deltas(revision_ids,
4637
 
                                       delta_versus_null=delta_versus_null))
4638
 
 
4639
 
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
4640
 
        """Return a stream of inventory-deltas for the given rev ids.
4641
 
 
4642
 
        :param revision_ids: The list of inventories to transmit
4643
 
        :param delta_versus_null: Don't try to find a minimal delta for this
4644
 
            entry, instead compute the delta versus the NULL_REVISION. This
4645
 
            effectively streams a complete inventory. Used for stuff like
4646
 
            filling in missing parents, etc.
4647
 
        """
4648
 
        from_repo = self.from_repository
4649
 
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4650
 
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
4651
 
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
4652
 
        # method...
4653
 
        inventories = self.from_repository.iter_inventories(
4654
 
            revision_ids, 'topological')
4655
 
        format = from_repo._format
4656
 
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
4657
 
        inventory_cache = lru_cache.LRUCache(50)
4658
 
        null_inventory = from_repo.revision_tree(
4659
 
            _mod_revision.NULL_REVISION).inventory
4660
 
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
4661
 
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
4662
 
        # repo back into a non-rich-root repo ought to be allowed)
4663
 
        serializer = inventory_delta.InventoryDeltaSerializer(
4664
 
            versioned_root=format.rich_root_data,
4665
 
            tree_references=format.supports_tree_reference)
4666
 
        for inv in inventories:
4667
 
            key = (inv.revision_id,)
4668
 
            parent_keys = parent_map.get(key, ())
4669
 
            delta = None
4670
 
            if not delta_versus_null and parent_keys:
4671
 
                # The caller did not ask for complete inventories and we have
4672
 
                # some parents that we can delta against.  Make a delta against
4673
 
                # each parent so that we can find the smallest.
4674
 
                parent_ids = [parent_key[0] for parent_key in parent_keys]
4675
 
                for parent_id in parent_ids:
4676
 
                    if parent_id not in invs_sent_so_far:
4677
 
                        # We don't know that the remote side has this basis, so
4678
 
                        # we can't use it.
4679
 
                        continue
4680
 
                    if parent_id == _mod_revision.NULL_REVISION:
4681
 
                        parent_inv = null_inventory
4682
 
                    else:
4683
 
                        parent_inv = inventory_cache.get(parent_id, None)
4684
 
                        if parent_inv is None:
4685
 
                            parent_inv = from_repo.get_inventory(parent_id)
4686
 
                    candidate_delta = inv._make_delta(parent_inv)
4687
 
                    if (delta is None or
4688
 
                        len(delta) > len(candidate_delta)):
4689
 
                        delta = candidate_delta
4690
 
                        basis_id = parent_id
4691
 
            if delta is None:
4692
 
                # Either none of the parents ended up being suitable, or we
4693
 
                # were asked to delta against NULL
4694
 
                basis_id = _mod_revision.NULL_REVISION
4695
 
                delta = inv._make_delta(null_inventory)
4696
 
            invs_sent_so_far.add(inv.revision_id)
4697
 
            inventory_cache[inv.revision_id] = inv
4698
 
            delta_serialized = ''.join(
4699
 
                serializer.delta_to_lines(basis_id, key[-1], delta))
4700
 
            yield versionedfile.FulltextContentFactory(
4701
 
                key, parent_keys, None, delta_serialized)
4702
 
 
4703
 
 
4704
 
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
4705
 
                    stop_revision=None):
4706
 
    """Extend the partial history to include a given index
4707
 
 
4708
 
    If a stop_index is supplied, stop when that index has been reached.
4709
 
    If a stop_revision is supplied, stop when that revision is
4710
 
    encountered.  Otherwise, stop when the beginning of history is
4711
 
    reached.
4712
 
 
4713
 
    :param stop_index: The index which should be present.  When it is
4714
 
        present, history extension will stop.
4715
 
    :param stop_revision: The revision id which should be present.  When
4716
 
        it is encountered, history extension will stop.
4717
 
    """
4718
 
    start_revision = partial_history_cache[-1]
4719
 
    iterator = repo.iter_reverse_revision_history(start_revision)
4720
 
    try:
4721
 
        #skip the last revision in the list
4722
 
        iterator.next()
4723
 
        while True:
4724
 
            if (stop_index is not None and
4725
 
                len(partial_history_cache) > stop_index):
4726
 
                break
4727
 
            if partial_history_cache[-1] == stop_revision:
4728
 
                break
4729
 
            revision_id = iterator.next()
4730
 
            partial_history_cache.append(revision_id)
4731
 
    except StopIteration:
4732
 
        # No more history
4733
 
        return
4734