~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Andrew Bennetts
  • Date: 2009-04-02 05:53:12 UTC
  • mto: This revision was merged to the branch mainline in revision 4242.
  • Revision ID: andrew.bennetts@canonical.com-20090402055312-h7mvgumvm7e620mj
Fix nits in spelling and naming.

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
 
 
876
808
######################################################################
877
809
# Repositories
878
810
 
879
 
 
880
 
class Repository(_RelockDebugMixin, bzrdir.ControlComponent):
 
811
class Repository(object):
881
812
    """Repository holding history for one or more branches.
882
813
 
883
814
    The repository holds and retrieves historical information including
885
816
    which views a particular line of development through that history.
886
817
 
887
818
    The Repository builds on top of some byte storage facilies (the revisions,
888
 
    signatures, inventories, texts and chk_bytes attributes) and a Transport,
889
 
    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
890
821
    remote) disk.
891
822
 
892
823
    The byte storage facilities are addressed via tuples, which we refer to
893
824
    as 'keys' throughout the code base. Revision_keys, inventory_keys and
894
825
    signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
895
 
    (file_id, revision_id). chk_bytes uses CHK keys - a 1-tuple with a single
896
 
    byte string made up of a hash identifier and a hash value.
897
 
    We use this interface because it allows low friction with the underlying
898
 
    code that implements disk indices, network encoding and other parts of
899
 
    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.
900
829
 
901
830
    :ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
902
831
        the serialised revisions for the repository. This can be used to obtain
921
850
        The result of trying to insert data into the repository via this store
922
851
        is undefined: it should be considered read-only except for implementors
923
852
        of repositories.
924
 
    :ivar chk_bytes: A bzrlib.versionedfile.VersionedFiles instance containing
925
 
        any data the repository chooses to store or have indexed by its hash.
926
 
        The result of trying to insert data into the repository via this store
927
 
        is undefined: it should be considered read-only except for implementors
928
 
        of repositories.
929
853
    :ivar _transport: Transport for file access to repository, typically
930
854
        pointing to .bzr/repository.
931
855
    """
952
876
        """
953
877
        if self._write_group is not self.get_transaction():
954
878
            # has an unlock or relock occured ?
955
 
            if suppress_errors:
956
 
                mutter(
957
 
                '(suppressed) mismatched lock context and write group. %r, %r',
958
 
                self._write_group, self.get_transaction())
959
 
                return
960
 
            raise errors.BzrError(
961
 
                'mismatched lock context and write group. %r, %r' %
962
 
                (self._write_group, self.get_transaction()))
 
879
            raise errors.BzrError('mismatched lock context and write group.')
963
880
        try:
964
881
            self._abort_write_group()
965
882
        except Exception, exc:
991
908
        """
992
909
        if not self._format.supports_external_lookups:
993
910
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
994
 
        if self.is_locked():
995
 
            # This repository will call fallback.unlock() when we transition to
996
 
            # the unlocked state, so we make sure to increment the lock count
997
 
            repository.lock_read()
998
911
        self._check_fallback_repository(repository)
999
912
        self._fallback_repositories.append(repository)
1000
913
        self.texts.add_fallback_versioned_files(repository.texts)
1001
914
        self.inventories.add_fallback_versioned_files(repository.inventories)
1002
915
        self.revisions.add_fallback_versioned_files(repository.revisions)
1003
916
        self.signatures.add_fallback_versioned_files(repository.signatures)
1004
 
        if self.chk_bytes is not None:
1005
 
            self.chk_bytes.add_fallback_versioned_files(repository.chk_bytes)
1006
917
 
1007
918
    def _check_fallback_repository(self, repository):
1008
919
        """Check that this repository can fallback to repository safely.
1032
943
                % (inv.revision_id, revision_id))
1033
944
        if inv.root is None:
1034
945
            raise AssertionError()
1035
 
        return self._add_inventory_checked(revision_id, inv, parents)
1036
 
 
1037
 
    def _add_inventory_checked(self, revision_id, inv, parents):
1038
 
        """Add inv to the repository after checking the inputs.
1039
 
 
1040
 
        This function can be overridden to allow different inventory styles.
1041
 
 
1042
 
        :seealso: add_inventory, for the contract.
1043
 
        """
1044
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
 
946
        inv_lines = self._serialise_inventory_to_lines(inv)
1045
947
        return self._inventory_add_lines(revision_id, parents,
1046
948
            inv_lines, check_content=False)
1047
949
 
1048
950
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1049
 
                               parents, basis_inv=None, propagate_caches=False):
 
951
                               parents):
1050
952
        """Add a new inventory expressed as a delta against another revision.
1051
953
 
1052
 
        See the inventory developers documentation for the theory behind
1053
 
        inventory deltas.
1054
 
 
1055
954
        :param basis_revision_id: The inventory id the delta was created
1056
955
            against. (This does not have to be a direct parent.)
1057
956
        :param delta: The inventory delta (see Inventory.apply_delta for
1063
962
            for repositories that depend on the inventory graph for revision
1064
963
            graph access, as well as for those that pun ancestry with delta
1065
964
            compression.
1066
 
        :param basis_inv: The basis inventory if it is already known,
1067
 
            otherwise None.
1068
 
        :param propagate_caches: If True, the caches for this inventory are
1069
 
          copied to and updated for the result if possible.
1070
965
 
1071
966
        :returns: (validator, new_inv)
1072
967
            The validator(which is a sha1 digest, though what is sha'd is
1083
978
            # inventory implementations may support: A better idiom would be to
1084
979
            # return a new inventory, but as there is no revision tree cache in
1085
980
            # repository this is safe for now - RBC 20081013
1086
 
            if basis_inv is None:
1087
 
                basis_inv = basis_tree.inventory
 
981
            basis_inv = basis_tree.inventory
1088
982
            basis_inv.apply_delta(delta)
1089
983
            basis_inv.revision_id = new_revision_id
1090
984
            return (self.add_inventory(new_revision_id, basis_inv, parents),
1096
990
        check_content=True):
1097
991
        """Store lines in inv_vf and return the sha1 of the inventory."""
1098
992
        parents = [(parent,) for parent in parents]
1099
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
993
        return self.inventories.add_lines((revision_id,), parents, lines,
1100
994
            check_content=check_content)[0]
1101
 
        self.inventories._access.flush()
1102
 
        return result
1103
995
 
1104
996
    def add_revision(self, revision_id, rev, inv=None, config=None):
1105
997
        """Add rev to the revision store as revision_id.
1181
1073
        # The old API returned a list, should this actually be a set?
1182
1074
        return parent_map.keys()
1183
1075
 
1184
 
    def _check_inventories(self, checker):
1185
 
        """Check the inventories found from the revision scan.
1186
 
        
1187
 
        This is responsible for verifying the sha1 of inventories and
1188
 
        creating a pending_keys set that covers data referenced by inventories.
1189
 
        """
1190
 
        bar = ui.ui_factory.nested_progress_bar()
1191
 
        try:
1192
 
            self._do_check_inventories(checker, bar)
1193
 
        finally:
1194
 
            bar.finished()
1195
 
 
1196
 
    def _do_check_inventories(self, checker, bar):
1197
 
        """Helper for _check_inventories."""
1198
 
        revno = 0
1199
 
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
1200
 
        kinds = ['chk_bytes', 'texts']
1201
 
        count = len(checker.pending_keys)
1202
 
        bar.update("inventories", 0, 2)
1203
 
        current_keys = checker.pending_keys
1204
 
        checker.pending_keys = {}
1205
 
        # Accumulate current checks.
1206
 
        for key in current_keys:
1207
 
            if key[0] != 'inventories' and key[0] not in kinds:
1208
 
                checker._report_items.append('unknown key type %r' % (key,))
1209
 
            keys[key[0]].add(key[1:])
1210
 
        if keys['inventories']:
1211
 
            # NB: output order *should* be roughly sorted - topo or
1212
 
            # inverse topo depending on repository - either way decent
1213
 
            # to just delta against. However, pre-CHK formats didn't
1214
 
            # try to optimise inventory layout on disk. As such the
1215
 
            # pre-CHK code path does not use inventory deltas.
1216
 
            last_object = None
1217
 
            for record in self.inventories.check(keys=keys['inventories']):
1218
 
                if record.storage_kind == 'absent':
1219
 
                    checker._report_items.append(
1220
 
                        'Missing inventory {%s}' % (record.key,))
1221
 
                else:
1222
 
                    last_object = self._check_record('inventories', record,
1223
 
                        checker, last_object,
1224
 
                        current_keys[('inventories',) + record.key])
1225
 
            del keys['inventories']
1226
 
        else:
1227
 
            return
1228
 
        bar.update("texts", 1)
1229
 
        while (checker.pending_keys or keys['chk_bytes']
1230
 
            or keys['texts']):
1231
 
            # Something to check.
1232
 
            current_keys = checker.pending_keys
1233
 
            checker.pending_keys = {}
1234
 
            # Accumulate current checks.
1235
 
            for key in current_keys:
1236
 
                if key[0] not in kinds:
1237
 
                    checker._report_items.append('unknown key type %r' % (key,))
1238
 
                keys[key[0]].add(key[1:])
1239
 
            # Check the outermost kind only - inventories || chk_bytes || texts
1240
 
            for kind in kinds:
1241
 
                if keys[kind]:
1242
 
                    last_object = None
1243
 
                    for record in getattr(self, kind).check(keys=keys[kind]):
1244
 
                        if record.storage_kind == 'absent':
1245
 
                            checker._report_items.append(
1246
 
                                'Missing %s {%s}' % (kind, record.key,))
1247
 
                        else:
1248
 
                            last_object = self._check_record(kind, record,
1249
 
                                checker, last_object, current_keys[(kind,) + record.key])
1250
 
                    keys[kind] = set()
1251
 
                    break
1252
 
 
1253
 
    def _check_record(self, kind, record, checker, last_object, item_data):
1254
 
        """Check a single text from this repository."""
1255
 
        if kind == 'inventories':
1256
 
            rev_id = record.key[0]
1257
 
            inv = self._deserialise_inventory(rev_id,
1258
 
                record.get_bytes_as('fulltext'))
1259
 
            if last_object is not None:
1260
 
                delta = inv._make_delta(last_object)
1261
 
                for old_path, path, file_id, ie in delta:
1262
 
                    if ie is None:
1263
 
                        continue
1264
 
                    ie.check(checker, rev_id, inv)
1265
 
            else:
1266
 
                for path, ie in inv.iter_entries():
1267
 
                    ie.check(checker, rev_id, inv)
1268
 
            if self._format.fast_deltas:
1269
 
                return inv
1270
 
        elif kind == 'chk_bytes':
1271
 
            # No code written to check chk_bytes for this repo format.
1272
 
            checker._report_items.append(
1273
 
                'unsupported key type chk_bytes for %s' % (record.key,))
1274
 
        elif kind == 'texts':
1275
 
            self._check_text(record, checker, item_data)
1276
 
        else:
1277
 
            checker._report_items.append(
1278
 
                'unknown key type %s for %s' % (kind, record.key))
1279
 
 
1280
 
    def _check_text(self, record, checker, item_data):
1281
 
        """Check a single text."""
1282
 
        # Check it is extractable.
1283
 
        # TODO: check length.
1284
 
        if record.storage_kind == 'chunked':
1285
 
            chunks = record.get_bytes_as(record.storage_kind)
1286
 
            sha1 = osutils.sha_strings(chunks)
1287
 
            length = sum(map(len, chunks))
1288
 
        else:
1289
 
            content = record.get_bytes_as('fulltext')
1290
 
            sha1 = osutils.sha_string(content)
1291
 
            length = len(content)
1292
 
        if item_data and sha1 != item_data[1]:
1293
 
            checker._report_items.append(
1294
 
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
1295
 
                (record.key, sha1, item_data[1], item_data[2]))
1296
 
 
1297
1076
    @staticmethod
1298
1077
    def create(a_bzrdir):
1299
1078
        """Construct the current default format repository in a_bzrdir."""
1304
1083
 
1305
1084
        :param _format: The format of the repository on disk.
1306
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.
1307
1090
        """
1308
 
        # In the future we will have a single api for all stores for
1309
 
        # getting file texts, inventories and revisions, then
1310
 
        # this construct will accept instances of those things.
1311
1091
        super(Repository, self).__init__()
1312
1092
        self._format = _format
1313
1093
        # the following are part of the public API for Repository:
1319
1099
        self._reconcile_does_inventory_gc = True
1320
1100
        self._reconcile_fixes_text_parents = False
1321
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()
1322
1107
        self._write_group = None
1323
1108
        # Additional places to query for data.
1324
1109
        self._fallback_repositories = []
1325
1110
        # An InventoryEntry cache, used during deserialization
1326
1111
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
1327
 
        # Is it safe to return inventory entries directly from the entry cache,
1328
 
        # rather copying them?
1329
 
        self._safe_to_return_from_cache = False
1330
 
 
1331
 
    @property
1332
 
    def user_transport(self):
1333
 
        return self.bzrdir.user_transport
1334
 
 
1335
 
    @property
1336
 
    def control_transport(self):
1337
 
        return self._transport
1338
1112
 
1339
1113
    def __repr__(self):
1340
 
        if self._fallback_repositories:
1341
 
            return '%s(%r, fallback_repositories=%r)' % (
1342
 
                self.__class__.__name__,
1343
 
                self.base,
1344
 
                self._fallback_repositories)
1345
 
        else:
1346
 
            return '%s(%r)' % (self.__class__.__name__,
1347
 
                               self.base)
1348
 
 
1349
 
    def _has_same_fallbacks(self, other_repo):
1350
 
        """Returns true if the repositories have the same fallbacks."""
1351
 
        my_fb = self._fallback_repositories
1352
 
        other_fb = other_repo._fallback_repositories
1353
 
        if len(my_fb) != len(other_fb):
1354
 
            return False
1355
 
        for f, g in zip(my_fb, other_fb):
1356
 
            if not f.has_same_location(g):
1357
 
                return False
1358
 
        return True
 
1114
        return '%s(%r)' % (self.__class__.__name__,
 
1115
                           self.base)
1359
1116
 
1360
1117
    def has_same_location(self, other):
1361
1118
        """Returns a boolean indicating if this repository is at the same
1389
1146
        data during reads, and allows a 'write_group' to be obtained. Write
1390
1147
        groups must be used for actual data insertion.
1391
1148
 
1392
 
        A token should be passed in if you know that you have locked the object
1393
 
        some other way, and need to synchronise this object's state with that
1394
 
        fact.
1395
 
 
1396
 
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1397
 
 
1398
1149
        :param token: if this is already locked, then lock_write will fail
1399
1150
            unless the token matches the existing lock.
1400
1151
        :returns: a token if this instance supports tokens, otherwise None.
1403
1154
        :raises MismatchedToken: if the specified token doesn't match the token
1404
1155
            of the existing lock.
1405
1156
        :seealso: start_write_group.
1406
 
        :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
1407
1163
        """
1408
1164
        locked = self.is_locked()
1409
 
        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()
1410
1169
        if not locked:
1411
 
            self._warn_if_deprecated()
1412
 
            self._note_lock('w')
1413
 
            for repo in self._fallback_repositories:
1414
 
                # Writes don't affect fallback repos
1415
 
                repo.lock_read()
1416
1170
            self._refresh_data()
1417
 
        return RepositoryWriteLockResult(self.unlock, token)
 
1171
        return result
1418
1172
 
1419
1173
    def lock_read(self):
1420
 
        """Lock the repository for read operations.
1421
 
 
1422
 
        :return: An object with an unlock method which will release the lock
1423
 
            obtained.
1424
 
        """
1425
1174
        locked = self.is_locked()
1426
1175
        self.control_files.lock_read()
 
1176
        for repo in self._fallback_repositories:
 
1177
            repo.lock_read()
1427
1178
        if not locked:
1428
 
            self._warn_if_deprecated()
1429
 
            self._note_lock('r')
1430
 
            for repo in self._fallback_repositories:
1431
 
                repo.lock_read()
1432
1179
            self._refresh_data()
1433
 
        return self
1434
1180
 
1435
1181
    def get_physical_lock_status(self):
1436
1182
        return self.control_files.get_physical_lock_status()
1496
1242
 
1497
1243
        # now gather global repository information
1498
1244
        # XXX: This is available for many repos regardless of listability.
1499
 
        if self.user_transport.listable():
 
1245
        if self.bzrdir.root_transport.listable():
1500
1246
            # XXX: do we want to __define len__() ?
1501
1247
            # Maybe the versionedfiles object should provide a different
1502
1248
            # method to get the number of keys.
1512
1258
        :param using: If True, list only branches using this repository.
1513
1259
        """
1514
1260
        if using and not self.is_shared():
1515
 
            return self.bzrdir.list_branches()
 
1261
            try:
 
1262
                return [self.bzrdir.open_branch()]
 
1263
            except errors.NotBranchError:
 
1264
                return []
1516
1265
        class Evaluator(object):
1517
1266
 
1518
1267
            def __init__(self):
1527
1276
                    except errors.NoRepositoryPresent:
1528
1277
                        pass
1529
1278
                    else:
1530
 
                        return False, ([], repository)
 
1279
                        return False, (None, repository)
1531
1280
                self.first_call = False
1532
 
                value = (bzrdir.list_branches(), None)
 
1281
                try:
 
1282
                    value = (bzrdir.open_branch(), None)
 
1283
                except errors.NotBranchError:
 
1284
                    value = (None, None)
1533
1285
                return True, value
1534
1286
 
1535
 
        ret = []
1536
 
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
1537
 
                self.user_transport, evaluate=Evaluator()):
1538
 
            if branches is not None:
1539
 
                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)
1540
1292
            if not using and repository is not None:
1541
 
                ret.extend(repository.find_branches())
1542
 
        return ret
 
1293
                branches.extend(repository.find_branches())
 
1294
        return branches
1543
1295
 
1544
1296
    @needs_read_lock
1545
1297
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1574
1326
        """Commit the contents accrued within the current write group.
1575
1327
 
1576
1328
        :seealso: start_write_group.
1577
 
        
1578
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1579
1329
        """
1580
1330
        if self._write_group is not self.get_transaction():
1581
1331
            # has an unlock or relock occured ?
1582
1332
            raise errors.BzrError('mismatched lock context %r and '
1583
1333
                'write group %r.' %
1584
1334
                (self.get_transaction(), self._write_group))
1585
 
        result = self._commit_write_group()
 
1335
        self._commit_write_group()
1586
1336
        self._write_group = None
1587
 
        return result
1588
1337
 
1589
1338
    def _commit_write_group(self):
1590
1339
        """Template method for per-repository write group cleanup.
1598
1347
    def suspend_write_group(self):
1599
1348
        raise errors.UnsuspendableWriteGroup(self)
1600
1349
 
1601
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
1602
 
        """Return the keys of missing inventory parents for revisions added in
1603
 
        this write group.
1604
 
 
1605
 
        A revision is not complete if the inventory delta for that revision
1606
 
        cannot be calculated.  Therefore if the parent inventories of a
1607
 
        revision are not present, the revision is incomplete, and e.g. cannot
1608
 
        be streamed by a smart server.  This method finds missing inventory
1609
 
        parents for revisions added in this write group.
1610
 
        """
1611
 
        if not self._format.supports_external_lookups:
1612
 
            # This is only an issue for stacked repositories
1613
 
            return set()
1614
 
        if not self.is_in_write_group():
1615
 
            raise AssertionError('not in a write group')
1616
 
 
1617
 
        # XXX: We assume that every added revision already has its
1618
 
        # corresponding inventory, so we only check for parent inventories that
1619
 
        # might be missing, rather than all inventories.
1620
 
        parents = set(self.revisions._index.get_missing_parents())
1621
 
        parents.discard(_mod_revision.NULL_REVISION)
1622
 
        unstacked_inventories = self.inventories._index
1623
 
        present_inventories = unstacked_inventories.get_parent_map(
1624
 
            key[-1:] for key in parents)
1625
 
        parents.difference_update(present_inventories)
1626
 
        if len(parents) == 0:
1627
 
            # No missing parent inventories.
1628
 
            return set()
1629
 
        if not check_for_missing_texts:
1630
 
            return set(('inventories', rev_id) for (rev_id,) in parents)
1631
 
        # Ok, now we have a list of missing inventories.  But these only matter
1632
 
        # if the inventories that reference them are missing some texts they
1633
 
        # appear to introduce.
1634
 
        # XXX: Texts referenced by all added inventories need to be present,
1635
 
        # but at the moment we're only checking for texts referenced by
1636
 
        # inventories at the graph's edge.
1637
 
        key_deps = self.revisions._index._key_dependencies
1638
 
        key_deps.satisfy_refs_for_keys(present_inventories)
1639
 
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1640
 
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1641
 
        missing_texts = set()
1642
 
        for file_id, version_ids in file_ids.iteritems():
1643
 
            missing_texts.update(
1644
 
                (file_id, version_id) for version_id in version_ids)
1645
 
        present_texts = self.texts.get_parent_map(missing_texts)
1646
 
        missing_texts.difference_update(present_texts)
1647
 
        if not missing_texts:
1648
 
            # No texts are missing, so all revisions and their deltas are
1649
 
            # reconstructable.
1650
 
            return set()
1651
 
        # Alternatively the text versions could be returned as the missing
1652
 
        # keys, but this is likely to be less data.
1653
 
        missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
1654
 
        return missing_keys
1655
 
 
1656
1350
    def refresh_data(self):
1657
1351
        """Re-read any data needed to to synchronise with disk.
1658
1352
 
1707
1401
            raise errors.InternalBzrError(
1708
1402
                "May not fetch while in a write group.")
1709
1403
        # fast path same-url fetch operations
1710
 
        # TODO: lift out to somewhere common with RemoteRepository
1711
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401646>
1712
 
        if (self.has_same_location(source)
1713
 
            and fetch_spec is None
1714
 
            and self._has_same_fallbacks(source)):
 
1404
        if self.has_same_location(source) and fetch_spec is None:
1715
1405
            # check that last_revision is in 'from' and then return a
1716
1406
            # no-operation.
1717
1407
            if (revision_id is not None and
1742
1432
        :param revprops: Optional dictionary of revision properties.
1743
1433
        :param revision_id: Optional revision id.
1744
1434
        """
1745
 
        if self._fallback_repositories:
1746
 
            raise errors.BzrError("Cannot commit from a lightweight checkout "
1747
 
                "to a stacked branch. See "
1748
 
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1749
1435
        result = self._commit_builder_class(self, parents, config,
1750
1436
            timestamp, timezone, committer, revprops, revision_id)
1751
1437
        self.start_write_group()
1752
1438
        return result
1753
1439
 
1754
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1755
1440
    def unlock(self):
1756
1441
        if (self.control_files._lock_count == 1 and
1757
1442
            self.control_files._lock_mode == 'w'):
1763
1448
        self.control_files.unlock()
1764
1449
        if self.control_files._lock_count == 0:
1765
1450
            self._inventory_entry_cache.clear()
1766
 
            for repo in self._fallback_repositories:
1767
 
                repo.unlock()
 
1451
        for repo in self._fallback_repositories:
 
1452
            repo.unlock()
1768
1453
 
1769
1454
    @needs_read_lock
1770
1455
    def clone(self, a_bzrdir, revision_id=None):
1879
1564
 
1880
1565
    @needs_read_lock
1881
1566
    def get_revisions(self, revision_ids):
1882
 
        """Get many revisions at once.
1883
 
        
1884
 
        Repositories that need to check data on every revision read should 
1885
 
        subclass this method.
1886
 
        """
 
1567
        """Get many revisions at once."""
1887
1568
        return self._get_revisions(revision_ids)
1888
1569
 
1889
1570
    @needs_read_lock
1890
1571
    def _get_revisions(self, revision_ids):
1891
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)
1892
1578
        revs = {}
1893
 
        for revid, rev in self._iter_revisions(revision_ids):
1894
 
            if rev is None:
1895
 
                raise errors.NoSuchRevision(self, revid)
1896
 
            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
1897
1585
        return [revs[revid] for revid in revision_ids]
1898
1586
 
1899
 
    def _iter_revisions(self, revision_ids):
1900
 
        """Iterate over revision objects.
1901
 
 
1902
 
        :param revision_ids: An iterable of revisions to examine. None may be
1903
 
            passed to request all revisions known to the repository. Note that
1904
 
            not all repositories can find unreferenced revisions; for those
1905
 
            repositories only referenced ones will be returned.
1906
 
        :return: An iterator of (revid, revision) tuples. Absent revisions (
1907
 
            those asked for but not available) are returned as (revid, None).
1908
 
        """
1909
 
        if revision_ids is None:
1910
 
            revision_ids = self.all_revision_ids()
1911
 
        else:
1912
 
            for rev_id in revision_ids:
1913
 
                if not rev_id or not isinstance(rev_id, basestring):
1914
 
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1915
 
        keys = [(key,) for key in revision_ids]
1916
 
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1917
 
        for record in stream:
1918
 
            revid = record.key[0]
1919
 
            if record.storage_kind == 'absent':
1920
 
                yield (revid, None)
1921
 
            else:
1922
 
                text = record.get_bytes_as('fulltext')
1923
 
                rev = self._serializer.read_revision_from_string(text)
1924
 
                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()
1925
1598
 
1926
1599
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1927
1600
        """Produce a generator of revision deltas.
2105
1778
                    yield line, revid
2106
1779
 
2107
1780
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
2108
 
        revision_keys):
 
1781
        revision_ids):
2109
1782
        """Helper routine for fileids_altered_by_revision_ids.
2110
1783
 
2111
1784
        This performs the translation of xml lines to revision ids.
2112
1785
 
2113
1786
        :param line_iterator: An iterator of lines, origin_version_id
2114
 
        :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
2115
1788
            set or other type which supports efficient __contains__ lookups, as
2116
 
            the revision key from each parsed line will be looked up in the
2117
 
            revision_keys filter.
 
1789
            the revision id from each parsed line will be looked up in the
 
1790
            revision_ids filter.
2118
1791
        :return: a dictionary mapping altered file-ids to an iterable of
2119
1792
        revision_ids. Each altered file-ids has the exact revision_ids that
2120
1793
        altered it listed explicitly.
2121
1794
        """
2122
1795
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
2123
1796
                line_iterator).iterkeys())
2124
 
        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)
2125
1802
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
2126
 
            self._inventory_xml_lines_for_keys(parent_keys)))
 
1803
            self._inventory_xml_lines_for_keys(parents)))
2127
1804
        new_keys = seen - parent_seen
2128
1805
        result = {}
2129
1806
        setdefault = result.setdefault
2131
1808
            setdefault(key[0], set()).add(key[-1])
2132
1809
        return result
2133
1810
 
2134
 
    def _find_parent_ids_of_revisions(self, revision_ids):
2135
 
        """Find all parent ids that are mentioned in the revision graph.
2136
 
 
2137
 
        :return: set of revisions that are parents of revision_ids which are
2138
 
            not part of revision_ids themselves
2139
 
        """
2140
 
        parent_map = self.get_parent_map(revision_ids)
2141
 
        parent_ids = set()
2142
 
        map(parent_ids.update, parent_map.itervalues())
2143
 
        parent_ids.difference_update(revision_ids)
2144
 
        parent_ids.discard(_mod_revision.NULL_REVISION)
2145
 
        return parent_ids
2146
 
 
2147
 
    def _find_parent_keys_of_revisions(self, revision_keys):
2148
 
        """Similar to _find_parent_ids_of_revisions, but used with keys.
2149
 
 
2150
 
        :param revision_keys: An iterable of revision_keys.
2151
 
        :return: The parents of all revision_keys that are not already in
2152
 
            revision_keys
2153
 
        """
2154
 
        parent_map = self.revisions.get_parent_map(revision_keys)
2155
 
        parent_keys = set()
2156
 
        map(parent_keys.update, parent_map.itervalues())
2157
 
        parent_keys.difference_update(revision_keys)
2158
 
        parent_keys.discard(_mod_revision.NULL_REVISION)
2159
 
        return parent_keys
2160
 
 
2161
1811
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
2162
1812
        """Find the file ids and versions affected by revisions.
2163
1813
 
2170
1820
        """
2171
1821
        selected_keys = set((revid,) for revid in revision_ids)
2172
1822
        w = _inv_weave or self.inventories
2173
 
        return self._find_file_ids_from_xml_inventory_lines(
2174
 
            w.iter_lines_added_or_present_in_keys(
2175
 
                selected_keys, pb=None),
2176
 
            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()
2177
1831
 
2178
1832
    def iter_files_bytes(self, desired_files):
2179
1833
        """Iterate through file versions.
2261
1915
                batch_size]
2262
1916
            if not to_query:
2263
1917
                break
2264
 
            for revision_id in to_query:
 
1918
            for rev_tree in self.revision_trees(to_query):
 
1919
                revision_id = rev_tree.get_revision_id()
2265
1920
                parent_ids = ancestors[revision_id]
2266
1921
                for text_key in revision_keys[revision_id]:
2267
1922
                    pb.update("Calculating text parents", processed_texts)
2286
1941
                            except KeyError:
2287
1942
                                inv = self.revision_tree(parent_id).inventory
2288
1943
                                inventory_cache[parent_id] = inv
2289
 
                            try:
2290
 
                                parent_entry = inv[text_key[0]]
2291
 
                            except (KeyError, errors.NoSuchId):
2292
 
                                parent_entry = None
 
1944
                            parent_entry = inv._byid.get(text_key[0], None)
2293
1945
                            if parent_entry is not None:
2294
1946
                                parent_text_key = (
2295
1947
                                    text_key[0], parent_entry.revision)
2320
1972
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
2321
1973
            'revisions'.  file-id is None unless knit-kind is 'file'.
2322
1974
        """
2323
 
        for result in self._find_file_keys_to_fetch(revision_ids, _files_pb):
2324
 
            yield result
2325
 
        del _files_pb
2326
 
        for result in self._find_non_file_keys_to_fetch(revision_ids):
2327
 
            yield result
2328
 
 
2329
 
    def _find_file_keys_to_fetch(self, revision_ids, pb):
2330
1975
        # XXX: it's a bit weird to control the inventory weave caching in this
2331
1976
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
2332
1977
        # maybe this generator should explicitly have the contract that it
2339
1984
        count = 0
2340
1985
        num_file_ids = len(file_ids)
2341
1986
        for file_id, altered_versions in file_ids.iteritems():
2342
 
            if pb is not None:
2343
 
                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)
2344
1989
            count += 1
2345
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
2346
1994
 
2347
 
    def _find_non_file_keys_to_fetch(self, revision_ids):
2348
1995
        # inventory
2349
1996
        yield ("inventory", None, revision_ids)
2350
1997
 
2367
2014
        """Get Inventory object by revision id."""
2368
2015
        return self.iter_inventories([revision_id]).next()
2369
2016
 
2370
 
    def iter_inventories(self, revision_ids, ordering=None):
 
2017
    def iter_inventories(self, revision_ids):
2371
2018
        """Get many inventories by revision_ids.
2372
2019
 
2373
2020
        This will buffer some or all of the texts used in constructing the
2374
2021
        inventories in memory, but will only parse a single inventory at a
2375
2022
        time.
2376
2023
 
2377
 
        :param revision_ids: The expected revision ids of the inventories.
2378
 
        :param ordering: optional ordering, e.g. 'topological'.  If not
2379
 
            specified, the order of revision_ids will be preserved (by
2380
 
            buffering if necessary).
2381
2024
        :return: An iterator of inventories.
2382
2025
        """
2383
2026
        if ((None in revision_ids)
2384
2027
            or (_mod_revision.NULL_REVISION in revision_ids)):
2385
2028
            raise ValueError('cannot get null revision inventory')
2386
 
        return self._iter_inventories(revision_ids, ordering)
 
2029
        return self._iter_inventories(revision_ids)
2387
2030
 
2388
 
    def _iter_inventories(self, revision_ids, ordering):
 
2031
    def _iter_inventories(self, revision_ids):
2389
2032
        """single-document based inventory iteration."""
2390
 
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2391
 
        for text, revision_id in inv_xmls:
2392
 
            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)
2393
2035
 
2394
 
    def _iter_inventory_xmls(self, revision_ids, ordering):
2395
 
        if ordering is None:
2396
 
            order_as_requested = True
2397
 
            ordering = 'unordered'
2398
 
        else:
2399
 
            order_as_requested = False
 
2036
    def _iter_inventory_xmls(self, revision_ids):
2400
2037
        keys = [(revision_id,) for revision_id in revision_ids]
2401
 
        if not keys:
2402
 
            return
2403
 
        if order_as_requested:
2404
 
            key_iter = iter(keys)
2405
 
            next_key = key_iter.next()
2406
 
        stream = self.inventories.get_record_stream(keys, ordering, True)
 
2038
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2407
2039
        text_chunks = {}
2408
2040
        for record in stream:
2409
2041
            if record.storage_kind != 'absent':
2410
 
                chunks = record.get_bytes_as('chunked')
2411
 
                if order_as_requested:
2412
 
                    text_chunks[record.key] = chunks
2413
 
                else:
2414
 
                    yield ''.join(chunks), record.key[-1]
 
2042
                text_chunks[record.key] = record.get_bytes_as('chunked')
2415
2043
            else:
2416
2044
                raise errors.NoSuchRevision(self, record.key)
2417
 
            if order_as_requested:
2418
 
                # Yield as many results as we can while preserving order.
2419
 
                while next_key in text_chunks:
2420
 
                    chunks = text_chunks.pop(next_key)
2421
 
                    yield ''.join(chunks), next_key[-1]
2422
 
                    try:
2423
 
                        next_key = key_iter.next()
2424
 
                    except StopIteration:
2425
 
                        # We still want to fully consume the get_record_stream,
2426
 
                        # just in case it is not actually finished at this point
2427
 
                        next_key = None
2428
 
                        break
 
2045
        for key in keys:
 
2046
            chunks = text_chunks.pop(key)
 
2047
            yield ''.join(chunks), key[-1]
2429
2048
 
2430
 
    def _deserialise_inventory(self, revision_id, xml):
 
2049
    def deserialise_inventory(self, revision_id, xml):
2431
2050
        """Transform the xml into an inventory object.
2432
2051
 
2433
2052
        :param revision_id: The expected revision id of the inventory.
2434
2053
        :param xml: A serialised inventory.
2435
2054
        """
2436
2055
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2437
 
                    entry_cache=self._inventory_entry_cache,
2438
 
                    return_from_cache=self._safe_to_return_from_cache)
 
2056
                    entry_cache=self._inventory_entry_cache)
2439
2057
        if result.revision_id != revision_id:
2440
2058
            raise AssertionError('revision id mismatch %s != %s' % (
2441
2059
                result.revision_id, revision_id))
2442
2060
        return result
2443
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
 
2444
2068
    def get_serializer_format(self):
2445
2069
        return self._serializer.format_num
2446
2070
 
2447
2071
    @needs_read_lock
2448
 
    def _get_inventory_xml(self, revision_id):
2449
 
        """Get serialized inventory as a string."""
2450
 
        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])
2451
2075
        try:
2452
2076
            text, revision_id = texts.next()
2453
2077
        except StopIteration:
2454
2078
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2455
2079
        return text
2456
2080
 
2457
 
    def get_rev_id_for_revno(self, revno, known_pair):
2458
 
        """Return the revision id of a revno, given a later (revno, revid)
2459
 
        pair in the same history.
2460
 
 
2461
 
        :return: if found (True, revid).  If the available history ran out
2462
 
            before reaching the revno, then this returns
2463
 
            (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
2464
2084
        """
2465
 
        known_revno, known_revid = known_pair
2466
 
        partial_history = [known_revid]
2467
 
        distance_from_known = known_revno - revno
2468
 
        if distance_from_known < 0:
2469
 
            raise ValueError(
2470
 
                'requested revno (%d) is later than given known revno (%d)'
2471
 
                % (revno, known_revno))
2472
 
        try:
2473
 
            _iter_for_revno(
2474
 
                self, partial_history, stop_index=distance_from_known)
2475
 
        except errors.RevisionNotPresent, err:
2476
 
            if err.revision_id == known_revid:
2477
 
                # The start revision (known_revid) wasn't found.
2478
 
                raise
2479
 
            # This is a stacked repository with no fallbacks, or a there's a
2480
 
            # left-hand ghost.  Either way, even though the revision named in
2481
 
            # the error isn't in this repo, we know it's the next step in this
2482
 
            # left-hand history.
2483
 
            partial_history.append(err.revision_id)
2484
 
        if len(partial_history) <= distance_from_known:
2485
 
            # Didn't find enough history to get a revid for the revno.
2486
 
            earliest_revno = known_revno - len(partial_history) + 1
2487
 
            return (False, (earliest_revno, partial_history[-1]))
2488
 
        if len(partial_history) - 1 > distance_from_known:
2489
 
            raise AssertionError('_iter_for_revno returned too much history')
2490
 
        return (True, partial_history[-1])
 
2085
        return self.get_revision(revision_id).inventory_sha1
2491
2086
 
2492
2087
    def iter_reverse_revision_history(self, revision_id):
2493
2088
        """Iterate backwards through revision ids in the lefthand history
2500
2095
        while True:
2501
2096
            if next_id in (None, _mod_revision.NULL_REVISION):
2502
2097
                return
2503
 
            try:
2504
 
                parents = graph.get_parent_map([next_id])[next_id]
2505
 
            except KeyError:
2506
 
                raise errors.RevisionNotPresent(next_id, self)
2507
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]
2508
2105
            if len(parents) == 0:
2509
2106
                return
2510
2107
            else:
2511
2108
                next_id = parents[0]
2512
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
 
2513
2126
    def is_shared(self):
2514
2127
        """Return True if this repository is flagged as a shared repository."""
2515
2128
        raise NotImplementedError(self.is_shared)
2549
2162
            return RevisionTree(self, Inventory(root_id=None),
2550
2163
                                _mod_revision.NULL_REVISION)
2551
2164
        else:
2552
 
            inv = self.get_inventory(revision_id)
 
2165
            inv = self.get_revision_inventory(revision_id)
2553
2166
            return RevisionTree(self, inv, revision_id)
2554
2167
 
2555
2168
    def revision_trees(self, revision_ids):
2608
2221
            keys = tsort.topo_sort(parent_map)
2609
2222
        return [None] + list(keys)
2610
2223
 
2611
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
2224
    def pack(self):
2612
2225
        """Compress the data within the repository.
2613
2226
 
2614
2227
        This operation only makes sense for some repository types. For other
2617
2230
        This stub method does not require a lock, but subclasses should use
2618
2231
        @needs_write_lock as this is a long running call its reasonable to
2619
2232
        implicitly lock for the user.
2620
 
 
2621
 
        :param hint: If not supplied, the whole repository is packed.
2622
 
            If supplied, the repository may use the hint parameter as a
2623
 
            hint for the parts of the repository to pack. A hint can be
2624
 
            obtained from the result of commit_write_group(). Out of
2625
 
            date hints are simply ignored, because concurrent operations
2626
 
            can obsolete them rapidly.
2627
 
 
2628
 
        :param clean_obsolete_packs: Clean obsolete packs immediately after
2629
 
            the pack operation.
2630
2233
        """
2631
2234
 
2632
2235
    def get_transaction(self):
2633
2236
        return self.control_files.get_transaction()
2634
2237
 
2635
2238
    def get_parent_map(self, revision_ids):
2636
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
2239
        """See graph._StackedParentsProvider.get_parent_map"""
2637
2240
        # revisions index works in keys; this just works in revisions
2638
2241
        # therefore wrap and unwrap
2639
2242
        query_keys = []
2648
2251
        for ((revision_id,), parent_keys) in \
2649
2252
                self.revisions.get_parent_map(query_keys).iteritems():
2650
2253
            if parent_keys:
2651
 
                result[revision_id] = tuple([parent_revid
2652
 
                    for (parent_revid,) in parent_keys])
 
2254
                result[revision_id] = tuple(parent_revid
 
2255
                    for (parent_revid,) in parent_keys)
2653
2256
            else:
2654
2257
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2655
2258
        return result
2657
2260
    def _make_parents_provider(self):
2658
2261
        return self
2659
2262
 
2660
 
    @needs_read_lock
2661
 
    def get_known_graph_ancestry(self, revision_ids):
2662
 
        """Return the known graph for a set of revision ids and their ancestors.
2663
 
        """
2664
 
        st = static_tuple.StaticTuple
2665
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
2666
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
2667
 
        return graph.GraphThunkIdsToKeys(known_graph)
2668
 
 
2669
2263
    def get_graph(self, other_repository=None):
2670
2264
        """Return the graph walker for this repository format"""
2671
2265
        parents_provider = self._make_parents_provider()
2672
2266
        if (other_repository is not None and
2673
2267
            not self.has_same_location(other_repository)):
2674
 
            parents_provider = graph.StackedParentsProvider(
 
2268
            parents_provider = graph._StackedParentsProvider(
2675
2269
                [parents_provider, other_repository._make_parents_provider()])
2676
2270
        return graph.Graph(parents_provider)
2677
2271
 
2678
 
    def _get_versioned_file_checker(self, text_key_references=None,
2679
 
        ancestors=None):
 
2272
    def _get_versioned_file_checker(self, text_key_references=None):
2680
2273
        """Return an object suitable for checking versioned files.
2681
2274
        
2682
2275
        :param text_key_references: if non-None, an already built
2684
2277
            to whether they were referred to by the inventory of the
2685
2278
            revision_id that they contain. If None, this will be
2686
2279
            calculated.
2687
 
        :param ancestors: Optional result from
2688
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2689
 
            available.
2690
2280
        """
2691
2281
        return _VersionedFileChecker(self,
2692
 
            text_key_references=text_key_references, ancestors=ancestors)
 
2282
            text_key_references=text_key_references)
2693
2283
 
2694
2284
    def revision_ids_to_search_result(self, result_set):
2695
2285
        """Convert a set of revision ids to a graph SearchResult."""
2745
2335
        return record.get_bytes_as('fulltext')
2746
2336
 
2747
2337
    @needs_read_lock
2748
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
2338
    def check(self, revision_ids=None):
2749
2339
        """Check consistency of all history of given revision_ids.
2750
2340
 
2751
2341
        Different repository implementations should override _check().
2752
2342
 
2753
2343
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2754
2344
             will be checked.  Typically the last revision_id of a branch.
2755
 
        :param callback_refs: A dict of check-refs to resolve and callback
2756
 
            the check/_check method on the items listed as wanting the ref.
2757
 
            see bzrlib.check.
2758
 
        :param check_repo: If False do not check the repository contents, just 
2759
 
            calculate the data callback_refs requires and call them back.
2760
2345
        """
2761
 
        return self._check(revision_ids, callback_refs=callback_refs,
2762
 
            check_repo=check_repo)
 
2346
        return self._check(revision_ids)
2763
2347
 
2764
 
    def _check(self, revision_ids, callback_refs, check_repo):
2765
 
        result = check.Check(self, check_repo=check_repo)
2766
 
        result.check(callback_refs)
 
2348
    def _check(self, revision_ids):
 
2349
        result = check.Check(self)
 
2350
        result.check()
2767
2351
        return result
2768
2352
 
2769
 
    def _warn_if_deprecated(self, branch=None):
 
2353
    def _warn_if_deprecated(self):
2770
2354
        global _deprecation_warning_done
2771
2355
        if _deprecation_warning_done:
2772
2356
            return
2773
 
        try:
2774
 
            if branch is None:
2775
 
                conf = config.GlobalConfig()
2776
 
            else:
2777
 
                conf = branch.get_config()
2778
 
            if conf.suppress_warning('format_deprecation'):
2779
 
                return
2780
 
            warning("Format %s for %s is deprecated -"
2781
 
                    " please use 'bzr upgrade' to get better performance"
2782
 
                    % (self._format, self.bzrdir.transport.base))
2783
 
        finally:
2784
 
            _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))
2785
2360
 
2786
2361
    def supports_rich_root(self):
2787
2362
        return self._format.rich_root_data
2861
2436
    """
2862
2437
    repository.start_write_group()
2863
2438
    try:
2864
 
        inventory_cache = lru_cache.LRUCache(10)
2865
2439
        for n, (revision, revision_tree, signature) in enumerate(iterable):
2866
 
            _install_revision(repository, revision, revision_tree, signature,
2867
 
                inventory_cache)
 
2440
            _install_revision(repository, revision, revision_tree, signature)
2868
2441
            if pb is not None:
2869
2442
                pb.update('Transferring revisions', n + 1, num_revisions)
2870
2443
    except:
2874
2447
        repository.commit_write_group()
2875
2448
 
2876
2449
 
2877
 
def _install_revision(repository, rev, revision_tree, signature,
2878
 
    inventory_cache):
 
2450
def _install_revision(repository, rev, revision_tree, signature):
2879
2451
    """Install all revision data into a repository."""
2880
2452
    present_parents = []
2881
2453
    parent_trees = {}
2918
2490
        repository.texts.add_lines(text_key, text_parents, lines)
2919
2491
    try:
2920
2492
        # install the inventory
2921
 
        if repository._format._commit_inv_deltas and len(rev.parent_ids):
2922
 
            # Cache this inventory
2923
 
            inventory_cache[rev.revision_id] = inv
2924
 
            try:
2925
 
                basis_inv = inventory_cache[rev.parent_ids[0]]
2926
 
            except KeyError:
2927
 
                repository.add_inventory(rev.revision_id, inv, present_parents)
2928
 
            else:
2929
 
                delta = inv._make_delta(basis_inv)
2930
 
                repository.add_inventory_by_delta(rev.parent_ids[0], delta,
2931
 
                    rev.revision_id, present_parents)
2932
 
        else:
2933
 
            repository.add_inventory(rev.revision_id, inv, present_parents)
 
2493
        repository.add_inventory(rev.revision_id, inv, present_parents)
2934
2494
    except errors.RevisionAlreadyPresent:
2935
2495
        pass
2936
2496
    if signature is not None:
3027
2587
 
3028
2588
    Once a format is deprecated, just deprecate the initialize and open
3029
2589
    methods on the format class. Do not deprecate the object, as the
3030
 
    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
3031
2591
    created.
3032
2592
 
3033
2593
    Common instance attributes:
3043
2603
    # Can this repository be given external locations to lookup additional
3044
2604
    # data. Set to True or False in derived classes.
3045
2605
    supports_external_lookups = None
3046
 
    # Does this format support CHK bytestring lookups. Set to True or False in
3047
 
    # derived classes.
3048
 
    supports_chks = None
3049
 
    # Should commit add an inventory, or an inventory delta to the repository.
3050
 
    _commit_inv_deltas = True
3051
2606
    # What order should fetch operations request streams in?
3052
2607
    # The default is unordered as that is the cheapest for an origin to
3053
2608
    # provide.
3063
2618
    # Does this format have < O(tree_size) delta generation. Used to hint what
3064
2619
    # code path for commit, amongst other things.
3065
2620
    fast_deltas = None
3066
 
    # Does doing a pack operation compress data? Useful for the pack UI command
3067
 
    # (so if there is one pack, the operation can still proceed because it may
3068
 
    # help), and for fetching when data won't have come from the same
3069
 
    # compressor.
3070
 
    pack_compresses = False
3071
 
    # Does the repository inventory storage understand references to trees?
3072
 
    supports_tree_reference = None
3073
 
    # Is the format experimental ?
3074
 
    experimental = False
3075
2621
 
3076
 
    def __repr__(self):
3077
 
        return "%s()" % self.__class__.__name__
 
2622
    def __str__(self):
 
2623
        return "<%s>" % self.__class__.__name__
3078
2624
 
3079
2625
    def __eq__(self, other):
3080
2626
        # format objects are generally stateless
3093
2639
        """
3094
2640
        try:
3095
2641
            transport = a_bzrdir.get_repository_transport(None)
3096
 
            format_string = transport.get_bytes("format")
 
2642
            format_string = transport.get("format").read()
3097
2643
            return format_registry.get(format_string)
3098
2644
        except errors.NoSuchFile:
3099
2645
            raise errors.NoRepositoryPresent(a_bzrdir)
3181
2727
        raise NotImplementedError(self.network_name)
3182
2728
 
3183
2729
    def check_conversion_target(self, target_format):
3184
 
        if self.rich_root_data and not target_format.rich_root_data:
3185
 
            raise errors.BadConversionTarget(
3186
 
                'Does not support rich root data.', target_format,
3187
 
                from_format=self)
3188
 
        if (self.supports_tree_reference and 
3189
 
            not getattr(target_format, 'supports_tree_reference', False)):
3190
 
            raise errors.BadConversionTarget(
3191
 
                'Does not support nested trees', target_format,
3192
 
                from_format=self)
 
2730
        raise NotImplementedError(self.check_conversion_target)
3193
2731
 
3194
2732
    def open(self, a_bzrdir, _found=False):
3195
2733
        """Return an instance of this format for the bzrdir a_bzrdir.
3198
2736
        """
3199
2737
        raise NotImplementedError(self.open)
3200
2738
 
3201
 
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
3202
 
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
3203
 
        hooks = BzrDir.hooks['post_repo_init']
3204
 
        if not hooks:
3205
 
            return
3206
 
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
3207
 
        for hook in hooks:
3208
 
            hook(params)
3209
 
 
3210
2739
 
3211
2740
class MetaDirRepositoryFormat(RepositoryFormat):
3212
2741
    """Common base class for the new repositories using the metadir layout."""
3260
2789
# Pre-0.8 formats that don't have a disk format string (because they are
3261
2790
# versioned by the matching control directory). We use the control directories
3262
2791
# disk format string as a key for the network_name because they meet the
3263
 
# constraints (simple string, unique, immutable).
 
2792
# constraints (simple string, unique, immmutable).
3264
2793
network_format_registry.register_lazy(
3265
2794
    "Bazaar-NG branch, format 5\n",
3266
2795
    'bzrlib.repofmt.weaverepo',
3347
2876
    )
3348
2877
 
3349
2878
# Development formats.
3350
 
# 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
    )
3351
2885
format_registry.register_lazy(
3352
2886
    ("Bazaar development format 2 with subtree support "
3353
2887
        "(needs bzr.dev from before 1.8)\n"),
3355
2889
    'RepositoryFormatPackDevelopment2Subtree',
3356
2890
    )
3357
2891
 
3358
 
# 1.14->1.16 go below here
3359
 
format_registry.register_lazy(
3360
 
    'Bazaar development format - group compression and chk inventory'
3361
 
        ' (needs bzr.dev from 1.14)\n',
3362
 
    'bzrlib.repofmt.groupcompress_repo',
3363
 
    'RepositoryFormatCHK1',
3364
 
    )
3365
 
 
3366
 
format_registry.register_lazy(
3367
 
    'Bazaar development format - chk repository with bencode revision '
3368
 
        'serialization (needs bzr.dev from 1.16)\n',
3369
 
    'bzrlib.repofmt.groupcompress_repo',
3370
 
    'RepositoryFormatCHK2',
3371
 
    )
3372
 
format_registry.register_lazy(
3373
 
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
3374
 
    'bzrlib.repofmt.groupcompress_repo',
3375
 
    'RepositoryFormat2a',
3376
 
    )
3377
 
 
3378
2892
 
3379
2893
class InterRepository(InterObject):
3380
2894
    """This class represents operations taking place between two repositories.
3417
2931
 
3418
2932
        :param revision_id: if None all content is copied, if NULL_REVISION no
3419
2933
                            content is copied.
3420
 
        :param pb: ignored.
 
2934
        :param pb: optional progress bar to use for progress reports. If not
 
2935
                   provided a default one will be created.
3421
2936
        :return: None.
3422
2937
        """
3423
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3424
2938
        from bzrlib.fetch import RepoFetcher
3425
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
3426
 
        if self.source._format.network_name() != self.target._format.network_name():
3427
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
3428
 
                from_format=self.source._format,
3429
 
                to_format=self.target._format)
3430
2939
        f = RepoFetcher(to_repository=self.target,
3431
2940
                               from_repository=self.source,
3432
2941
                               last_revision=revision_id,
3433
2942
                               fetch_spec=fetch_spec,
3434
 
                               find_ghosts=find_ghosts)
 
2943
                               pb=pb, find_ghosts=find_ghosts)
3435
2944
 
3436
2945
    def _walk_to_common_revisions(self, revision_ids):
3437
2946
        """Walk out from revision_ids in source to revisions target has.
3441
2950
        """
3442
2951
        target_graph = self.target.get_graph()
3443
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())
3444
2960
        missing_revs = set()
3445
2961
        source_graph = self.source.get_graph()
3446
2962
        # ensure we don't pay silly lookup costs.
3606
3122
                self.target.texts.insert_record_stream(
3607
3123
                    self.source.texts.get_record_stream(
3608
3124
                        self.source.texts.keys(), 'topological', False))
3609
 
                pb.update('Copying inventory', 0, 1)
 
3125
                pb.update('copying inventory', 0, 1)
3610
3126
                self.target.inventories.insert_record_stream(
3611
3127
                    self.source.inventories.get_record_stream(
3612
3128
                        self.source.inventories.keys(), 'topological', False))
3633
3149
        # so the first thing is to get a subset of the revisions to
3634
3150
        # satisfy revision_id in source, and then eliminate those that
3635
3151
        # we do already have.
3636
 
        # 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
3637
3153
        # disk format scales terribly for push anyway due to rewriting
3638
3154
        # inventory.weave, this is considered acceptable.
3639
3155
        # - RBC 20060209
3726
3242
        return self.source.revision_ids_to_search_result(result_set)
3727
3243
 
3728
3244
 
3729
 
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):
3730
3380
 
3731
3381
    @classmethod
3732
3382
    def _get_repo_format_to_test(self):
3735
3385
    @staticmethod
3736
3386
    def is_compatible(source, target):
3737
3387
        """Be compatible with Knit2 source and Knit3 target"""
3738
 
        # This is redundant with format.check_conversion_target(), however that
3739
 
        # raises an exception, and we just want to say "False" as in we won't
3740
 
        # support converting between these formats.
3741
 
        if 'IDS_never' in debug.debug_flags:
3742
 
            return False
3743
 
        if source.supports_rich_root() and not target.supports_rich_root():
3744
 
            return False
3745
 
        if (source._format.supports_tree_reference
3746
 
            and not target._format.supports_tree_reference):
3747
 
            return False
3748
 
        if target._fallback_repositories and target._format.supports_chks:
3749
 
            # IDS doesn't know how to copy CHKs for the parent inventories it
3750
 
            # adds to stacked repos.
3751
 
            return False
3752
 
        if 'IDS_always' in debug.debug_flags:
3753
 
            return True
3754
 
        # Only use this code path for local source and target.  IDS does far
3755
 
        # too much IO (both bandwidth and roundtrips) over a network.
3756
 
        if not source.bzrdir.transport.base.startswith('file:///'):
3757
 
            return False
3758
 
        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)):
3759
3394
            return False
3760
3395
        return True
3761
3396
 
3762
 
    def _get_trees(self, revision_ids, cache):
3763
 
        possible_trees = []
3764
 
        for rev_id in revision_ids:
3765
 
            if rev_id in cache:
3766
 
                possible_trees.append((rev_id, cache[rev_id]))
3767
 
            else:
3768
 
                # Not cached, but inventory might be present anyway.
3769
 
                try:
3770
 
                    tree = self.source.revision_tree(rev_id)
3771
 
                except errors.NoSuchRevision:
3772
 
                    # Nope, parent is ghost.
3773
 
                    pass
3774
 
                else:
3775
 
                    cache[rev_id] = tree
3776
 
                    possible_trees.append((rev_id, tree))
3777
 
        return possible_trees
3778
 
 
3779
 
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
 
3397
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
3780
3398
        """Get the best delta and base for this revision.
3781
3399
 
3782
3400
        :return: (basis_id, delta)
3783
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]))
3784
3409
        deltas = []
3785
 
        # Generate deltas against each tree, to find the shortest.
3786
 
        texts_possibly_new_in_tree = set()
3787
3410
        for basis_id, basis_tree in possible_trees:
3788
3411
            delta = tree.inventory._make_delta(basis_tree.inventory)
3789
 
            for old_path, new_path, file_id, new_entry in delta:
3790
 
                if new_path is None:
3791
 
                    # This file_id isn't present in the new rev, so we don't
3792
 
                    # care about it.
3793
 
                    continue
3794
 
                if not new_path:
3795
 
                    # Rich roots are handled elsewhere...
3796
 
                    continue
3797
 
                kind = new_entry.kind
3798
 
                if kind != 'directory' and kind != 'file':
3799
 
                    # No text record associated with this inventory entry.
3800
 
                    continue
3801
 
                # This is a directory or file that has changed somehow.
3802
 
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3803
3412
            deltas.append((len(delta), basis_id, delta))
3804
3413
        deltas.sort()
3805
3414
        return deltas[0][1:]
3806
3415
 
3807
 
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
3808
 
        """Find all parent revisions that are absent, but for which the
3809
 
        inventory is present, and copy those inventories.
3810
 
 
3811
 
        This is necessary to preserve correctness when the source is stacked
3812
 
        without fallbacks configured.  (Note that in cases like upgrade the
3813
 
        source may be not have _fallback_repositories even though it is
3814
 
        stacked.)
3815
 
        """
3816
 
        parent_revs = set()
3817
 
        for parents in parent_map.values():
3818
 
            parent_revs.update(parents)
3819
 
        present_parents = self.source.get_parent_map(parent_revs)
3820
 
        absent_parents = set(parent_revs).difference(present_parents)
3821
 
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
3822
 
            (rev_id,) for rev_id in absent_parents)
3823
 
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
3824
 
        for parent_tree in self.source.revision_trees(parent_inv_ids):
3825
 
            current_revision_id = parent_tree.get_revision_id()
3826
 
            parents_parents_keys = parent_invs_keys_for_stacking[
3827
 
                (current_revision_id,)]
3828
 
            parents_parents = [key[-1] for key in parents_parents_keys]
3829
 
            basis_id = _mod_revision.NULL_REVISION
3830
 
            basis_tree = self.source.revision_tree(basis_id)
3831
 
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
3832
 
            self.target.add_inventory_by_delta(
3833
 
                basis_id, delta, current_revision_id, parents_parents)
3834
 
            cache[current_revision_id] = parent_tree
3835
 
 
3836
 
    def _fetch_batch(self, revision_ids, basis_id, cache, a_graph=None):
 
3416
    def _fetch_batch(self, revision_ids, basis_id, cache):
3837
3417
        """Fetch across a few revisions.
3838
3418
 
3839
3419
        :param revision_ids: The revisions to copy
3840
3420
        :param basis_id: The revision_id of a tree that must be in cache, used
3841
3421
            as a basis for delta when no other base is available
3842
3422
        :param cache: A cache of RevisionTrees that we can use.
3843
 
        :param a_graph: A Graph object to determine the heads() of the
3844
 
            rich-root data stream.
3845
3423
        :return: The revision_id of the last converted tree. The RevisionTree
3846
3424
            for it will be in cache
3847
3425
        """
3848
3426
        # Walk though all revisions; get inventory deltas, copy referenced
3849
3427
        # texts that delta references, insert the delta, revision and
3850
3428
        # signature.
3851
 
        root_keys_to_create = set()
3852
3429
        text_keys = set()
3853
3430
        pending_deltas = []
3854
3431
        pending_revisions = []
3855
3432
        parent_map = self.source.get_parent_map(revision_ids)
3856
 
        self._fetch_parent_invs_for_stacking(parent_map, cache)
3857
 
        self.source._safe_to_return_from_cache = True
3858
3433
        for tree in self.source.revision_trees(revision_ids):
3859
 
            # Find a inventory delta for this revision.
3860
 
            # Find text entries that need to be copied, too.
3861
3434
            current_revision_id = tree.get_revision_id()
3862
3435
            parent_ids = parent_map.get(current_revision_id, ())
3863
 
            parent_trees = self._get_trees(parent_ids, cache)
3864
 
            possible_trees = list(parent_trees)
3865
 
            if len(possible_trees) == 0:
3866
 
                # There either aren't any parents, or the parents are ghosts,
3867
 
                # so just use the last converted tree.
3868
 
                possible_trees.append((basis_id, cache[basis_id]))
3869
3436
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3870
 
                                                           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))
3871
3446
            revision = self.source.get_revision(current_revision_id)
3872
3447
            pending_deltas.append((basis_id, delta,
3873
3448
                current_revision_id, revision.parent_ids))
3874
 
            if self._converting_to_rich_root:
3875
 
                self._revision_id_to_root_id[current_revision_id] = \
3876
 
                    tree.get_root_id()
3877
 
            # Determine which texts are in present in this revision but not in
3878
 
            # any of the available parents.
3879
 
            texts_possibly_new_in_tree = set()
3880
 
            for old_path, new_path, file_id, entry in delta:
3881
 
                if new_path is None:
3882
 
                    # This file_id isn't present in the new rev
3883
 
                    continue
3884
 
                if not new_path:
3885
 
                    # This is the root
3886
 
                    if not self.target.supports_rich_root():
3887
 
                        # The target doesn't support rich root, so we don't
3888
 
                        # copy
3889
 
                        continue
3890
 
                    if self._converting_to_rich_root:
3891
 
                        # This can't be copied normally, we have to insert
3892
 
                        # it specially
3893
 
                        root_keys_to_create.add((file_id, entry.revision))
3894
 
                        continue
3895
 
                kind = entry.kind
3896
 
                texts_possibly_new_in_tree.add((file_id, entry.revision))
3897
 
            for basis_id, basis_tree in possible_trees:
3898
 
                basis_inv = basis_tree.inventory
3899
 
                for file_key in list(texts_possibly_new_in_tree):
3900
 
                    file_id, file_revision = file_key
3901
 
                    try:
3902
 
                        entry = basis_inv[file_id]
3903
 
                    except errors.NoSuchId:
3904
 
                        continue
3905
 
                    if entry.revision == file_revision:
3906
 
                        texts_possibly_new_in_tree.remove(file_key)
3907
 
            text_keys.update(texts_possibly_new_in_tree)
3908
3449
            pending_revisions.append(revision)
3909
3450
            cache[current_revision_id] = tree
3910
3451
            basis_id = current_revision_id
3911
 
        self.source._safe_to_return_from_cache = False
3912
3452
        # Copy file texts
3913
3453
        from_texts = self.source.texts
3914
3454
        to_texts = self.target.texts
3915
 
        if root_keys_to_create:
3916
 
            root_stream = _mod_fetch._new_root_data_stream(
3917
 
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
3918
 
                self.source, graph=a_graph)
3919
 
            to_texts.insert_record_stream(root_stream)
3920
3455
        to_texts.insert_record_stream(from_texts.get_record_stream(
3921
3456
            text_keys, self.target._format._fetch_order,
3922
3457
            not self.target._format._fetch_uses_deltas))
3923
 
        # insert inventory deltas
 
3458
        # insert deltas
3924
3459
        for delta in pending_deltas:
3925
3460
            self.target.add_inventory_by_delta(*delta)
3926
 
        if self.target._fallback_repositories:
3927
 
            # Make sure this stacked repository has all the parent inventories
3928
 
            # for the new revisions that we are about to insert.  We do this
3929
 
            # before adding the revisions so that no revision is added until
3930
 
            # all the inventories it may depend on are added.
3931
 
            # Note that this is overzealous, as we may have fetched these in an
3932
 
            # earlier batch.
3933
 
            parent_ids = set()
3934
 
            revision_ids = set()
3935
 
            for revision in pending_revisions:
3936
 
                revision_ids.add(revision.revision_id)
3937
 
                parent_ids.update(revision.parent_ids)
3938
 
            parent_ids.difference_update(revision_ids)
3939
 
            parent_ids.discard(_mod_revision.NULL_REVISION)
3940
 
            parent_map = self.source.get_parent_map(parent_ids)
3941
 
            # we iterate over parent_map and not parent_ids because we don't
3942
 
            # want to try copying any revision which is a ghost
3943
 
            for parent_tree in self.source.revision_trees(parent_map):
3944
 
                current_revision_id = parent_tree.get_revision_id()
3945
 
                parents_parents = parent_map[current_revision_id]
3946
 
                possible_trees = self._get_trees(parents_parents, cache)
3947
 
                if len(possible_trees) == 0:
3948
 
                    # There either aren't any parents, or the parents are
3949
 
                    # ghosts, so just use the last converted tree.
3950
 
                    possible_trees.append((basis_id, cache[basis_id]))
3951
 
                basis_id, delta = self._get_delta_for_revision(parent_tree,
3952
 
                    parents_parents, possible_trees)
3953
 
                self.target.add_inventory_by_delta(
3954
 
                    basis_id, delta, current_revision_id, parents_parents)
3955
3461
        # insert signatures and revisions
3956
3462
        for revision in pending_revisions:
3957
3463
            try:
3969
3475
 
3970
3476
        :param revision_ids: The list of revisions to fetch. Must be in
3971
3477
            topological order.
3972
 
        :param pb: A ProgressTask
 
3478
        :param pb: A ProgressBar
3973
3479
        :return: None
3974
3480
        """
3975
3481
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3977
3483
        cache = lru_cache.LRUCache(100)
3978
3484
        cache[basis_id] = basis_tree
3979
3485
        del basis_tree # We don't want to hang on to it here
3980
 
        hints = []
3981
 
        if self._converting_to_rich_root and len(revision_ids) > 100:
3982
 
            a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
3983
 
                                                            revision_ids)
3984
 
        else:
3985
 
            a_graph = None
3986
 
 
3987
3486
        for offset in range(0, len(revision_ids), batch_size):
3988
3487
            self.target.start_write_group()
3989
3488
            try:
3990
3489
                pb.update('Transferring revisions', offset,
3991
3490
                          len(revision_ids))
3992
3491
                batch = revision_ids[offset:offset+batch_size]
3993
 
                basis_id = self._fetch_batch(batch, basis_id, cache,
3994
 
                                             a_graph=a_graph)
 
3492
                basis_id = self._fetch_batch(batch, basis_id, cache)
3995
3493
            except:
3996
 
                self.source._safe_to_return_from_cache = False
3997
3494
                self.target.abort_write_group()
3998
3495
                raise
3999
3496
            else:
4000
 
                hint = self.target.commit_write_group()
4001
 
                if hint:
4002
 
                    hints.extend(hint)
4003
 
        if hints and self.target._format.pack_compresses:
4004
 
            self.target.pack(hint=hints)
 
3497
                self.target.commit_write_group()
4005
3498
        pb.update('Transferring revisions', len(revision_ids),
4006
3499
                  len(revision_ids))
4007
3500
 
4011
3504
        """See InterRepository.fetch()."""
4012
3505
        if fetch_spec is not None:
4013
3506
            raise AssertionError("Not implemented yet...")
4014
 
        ui.ui_factory.warn_experimental_format_fetch(self)
4015
 
        if (not self.source.supports_rich_root()
4016
 
            and self.target.supports_rich_root()):
4017
 
            self._converting_to_rich_root = True
4018
 
            self._revision_id_to_root_id = {}
4019
 
        else:
4020
 
            self._converting_to_rich_root = False
4021
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
4022
 
        if self.source._format.network_name() != self.target._format.network_name():
4023
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
4024
 
                from_format=self.source._format,
4025
 
                to_format=self.target._format)
4026
3507
        revision_ids = self.target.search_missing_revision_ids(self.source,
4027
3508
            revision_id, find_ghosts=find_ghosts).get_keys()
4028
3509
        if not revision_ids:
4029
3510
            return 0, 0
4030
3511
        revision_ids = tsort.topo_sort(
4031
3512
            self.source.get_graph().get_parent_map(revision_ids))
4032
 
        if not revision_ids:
4033
 
            return 0, 0
4034
 
        # Walk though all revisions; get inventory deltas, copy referenced
4035
 
        # texts that delta references, insert the delta, revision and
4036
 
        # signature.
4037
3513
        if pb is None:
4038
3514
            my_pb = ui.ui_factory.nested_progress_bar()
4039
3515
            pb = my_pb
4076
3552
InterRepository.register_optimiser(InterSameDataRepository)
4077
3553
InterRepository.register_optimiser(InterWeaveRepo)
4078
3554
InterRepository.register_optimiser(InterKnitRepo)
 
3555
InterRepository.register_optimiser(InterPackRepo)
4079
3556
 
4080
3557
 
4081
3558
class CopyConverter(object):
4097
3574
        :param to_convert: The disk object to convert.
4098
3575
        :param pb: a progress bar to use for progress information.
4099
3576
        """
4100
 
        pb = ui.ui_factory.nested_progress_bar()
 
3577
        self.pb = pb
4101
3578
        self.count = 0
4102
3579
        self.total = 4
4103
3580
        # this is only useful with metadir layouts - separated repo content.
4104
3581
        # trigger an assertion if not such
4105
3582
        repo._format.get_format_string()
4106
3583
        self.repo_dir = repo.bzrdir
4107
 
        pb.update('Moving repository to repository.backup')
 
3584
        self.step('Moving repository to repository.backup')
4108
3585
        self.repo_dir.transport.move('repository', 'repository.backup')
4109
3586
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4110
3587
        repo._format.check_conversion_target(self.target_format)
4111
3588
        self.source_repo = repo._format.open(self.repo_dir,
4112
3589
            _found=True,
4113
3590
            _override_transport=backup_transport)
4114
 
        pb.update('Creating new repository')
 
3591
        self.step('Creating new repository')
4115
3592
        converted = self.target_format.initialize(self.repo_dir,
4116
3593
                                                  self.source_repo.is_shared())
4117
3594
        converted.lock_write()
4118
3595
        try:
4119
 
            pb.update('Copying content')
 
3596
            self.step('Copying content into repository.')
4120
3597
            self.source_repo.copy_content_into(converted)
4121
3598
        finally:
4122
3599
            converted.unlock()
4123
 
        pb.update('Deleting old repository content')
 
3600
        self.step('Deleting old repository content.')
4124
3601
        self.repo_dir.transport.delete_tree('repository.backup')
4125
 
        ui.ui_factory.note('repository converted')
4126
 
        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)
4127
3608
 
4128
3609
 
4129
3610
_unescape_map = {
4158
3639
 
4159
3640
class _VersionedFileChecker(object):
4160
3641
 
4161
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
3642
    def __init__(self, repository, text_key_references=None):
4162
3643
        self.repository = repository
4163
3644
        self.text_index = self.repository._generate_text_key_index(
4164
 
            text_key_references=text_key_references, ancestors=ancestors)
 
3645
            text_key_references=text_key_references)
4165
3646
 
4166
3647
    def calculate_file_version_parents(self, text_key):
4167
3648
        """Calculate the correct parents for a file version according to
4185
3666
            revision_id) tuples for versions that are present in this versioned
4186
3667
            file, but not used by the corresponding inventory.
4187
3668
        """
4188
 
        local_progress = None
4189
 
        if progress_bar is None:
4190
 
            local_progress = ui.ui_factory.nested_progress_bar()
4191
 
            progress_bar = local_progress
4192
 
        try:
4193
 
            return self._check_file_version_parents(texts, progress_bar)
4194
 
        finally:
4195
 
            if local_progress:
4196
 
                local_progress.finished()
4197
 
 
4198
 
    def _check_file_version_parents(self, texts, progress_bar):
4199
 
        """See check_file_version_parents."""
4200
3669
        wrong_parents = {}
4201
3670
        self.file_ids = set([file_id for file_id, _ in
4202
3671
            self.text_index.iterkeys()])
4203
3672
        # text keys is now grouped by file_id
 
3673
        n_weaves = len(self.file_ids)
 
3674
        files_in_revisions = {}
 
3675
        revisions_of_files = {}
4204
3676
        n_versions = len(self.text_index)
4205
3677
        progress_bar.update('loading text store', 0, n_versions)
4206
3678
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4208
3680
        text_keys = self.repository.texts.keys()
4209
3681
        unused_keys = frozenset(text_keys) - set(self.text_index)
4210
3682
        for num, key in enumerate(self.text_index.iterkeys()):
4211
 
            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)
4212
3685
            correct_parents = self.calculate_file_version_parents(key)
4213
3686
            try:
4214
3687
                knit_parents = parent_map[key]
4263
3736
        try:
4264
3737
            if resume_tokens:
4265
3738
                self.target_repo.resume_write_group(resume_tokens)
4266
 
                is_resume = True
4267
3739
            else:
4268
3740
                self.target_repo.start_write_group()
4269
 
                is_resume = False
4270
3741
            try:
4271
3742
                # locked_insert_stream performs a commit|suspend.
4272
 
                return self._locked_insert_stream(stream, src_format, is_resume)
 
3743
                return self._locked_insert_stream(stream, src_format)
4273
3744
            except:
4274
3745
                self.target_repo.abort_write_group(suppress_errors=True)
4275
3746
                raise
4276
3747
        finally:
4277
3748
            self.target_repo.unlock()
4278
3749
 
4279
 
    def _locked_insert_stream(self, stream, src_format, is_resume):
 
3750
    def _locked_insert_stream(self, stream, src_format):
4280
3751
        to_serializer = self.target_repo._format._serializer
4281
3752
        src_serializer = src_format._serializer
4282
 
        new_pack = None
4283
3753
        if to_serializer == src_serializer:
4284
3754
            # If serializers match and the target is a pack repository, set the
4285
3755
            # write cache size on the new pack.  This avoids poor performance
4299
3769
            else:
4300
3770
                new_pack.set_write_cache_size(1024*1024)
4301
3771
        for substream_type, substream in stream:
4302
 
            if 'stream' in debug.debug_flags:
4303
 
                mutter('inserting substream: %s', substream_type)
4304
3772
            if substream_type == 'texts':
4305
3773
                self.target_repo.texts.insert_record_stream(substream)
4306
3774
            elif substream_type == 'inventories':
4310
3778
                else:
4311
3779
                    self._extract_and_insert_inventories(
4312
3780
                        substream, src_serializer)
4313
 
            elif substream_type == 'inventory-deltas':
4314
 
                self._extract_and_insert_inventory_deltas(
4315
 
                    substream, src_serializer)
4316
 
            elif substream_type == 'chk_bytes':
4317
 
                # XXX: This doesn't support conversions, as it assumes the
4318
 
                #      conversion was done in the fetch code.
4319
 
                self.target_repo.chk_bytes.insert_record_stream(substream)
4320
3781
            elif substream_type == 'revisions':
4321
3782
                # This may fallback to extract-and-insert more often than
4322
3783
                # required if the serializers are different only in terms of
4331
3792
                self.target_repo.signatures.insert_record_stream(substream)
4332
3793
            else:
4333
3794
                raise AssertionError('kaboom! %s' % (substream_type,))
4334
 
        # Done inserting data, and the missing_keys calculations will try to
4335
 
        # read back from the inserted data, so flush the writes to the new pack
4336
 
        # (if this is pack format).
4337
 
        if new_pack is not None:
4338
 
            new_pack._write_data('', flush=True)
4339
 
        # Find all the new revisions (including ones from resume_tokens)
4340
 
        missing_keys = self.target_repo.get_missing_parent_inventories(
4341
 
            check_for_missing_texts=is_resume)
4342
3795
        try:
 
3796
            missing_keys = set()
4343
3797
            for prefix, versioned_file in (
4344
3798
                ('texts', self.target_repo.texts),
4345
3799
                ('inventories', self.target_repo.inventories),
4346
3800
                ('revisions', self.target_repo.revisions),
4347
3801
                ('signatures', self.target_repo.signatures),
4348
 
                ('chk_bytes', self.target_repo.chk_bytes),
4349
3802
                ):
4350
 
                if versioned_file is None:
4351
 
                    continue
4352
 
                # TODO: key is often going to be a StaticTuple object
4353
 
                #       I don't believe we can define a method by which
4354
 
                #       (prefix,) + StaticTuple will work, though we could
4355
 
                #       define a StaticTuple.sq_concat that would allow you to
4356
 
                #       pass in either a tuple or a StaticTuple as the second
4357
 
                #       object, so instead we could have:
4358
 
                #       StaticTuple(prefix) + key here...
4359
3803
                missing_keys.update((prefix,) + key for key in
4360
3804
                    versioned_file.get_missing_compression_parent_keys())
4361
3805
        except NotImplementedError:
4370
3814
                # missing keys can handle suspending a write group).
4371
3815
                write_group_tokens = self.target_repo.suspend_write_group()
4372
3816
                return write_group_tokens, missing_keys
4373
 
        hint = self.target_repo.commit_write_group()
4374
 
        if (to_serializer != src_serializer and
4375
 
            self.target_repo._format.pack_compresses):
4376
 
            self.target_repo.pack(hint=hint)
 
3817
        self.target_repo.commit_write_group()
4377
3818
        return [], set()
4378
3819
 
4379
 
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
4380
 
        target_rich_root = self.target_repo._format.rich_root_data
4381
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4382
 
        for record in substream:
4383
 
            # Insert the delta directly
4384
 
            inventory_delta_bytes = record.get_bytes_as('fulltext')
4385
 
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
4386
 
            try:
4387
 
                parse_result = deserialiser.parse_text_bytes(
4388
 
                    inventory_delta_bytes)
4389
 
            except inventory_delta.IncompatibleInventoryDelta, err:
4390
 
                trace.mutter("Incompatible delta: %s", err.msg)
4391
 
                raise errors.IncompatibleRevision(self.target_repo._format)
4392
 
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
4393
 
            revision_id = new_id
4394
 
            parents = [key[0] for key in record.parents]
4395
 
            self.target_repo.add_inventory_by_delta(
4396
 
                basis_id, inv_delta, revision_id, parents)
4397
 
 
4398
 
    def _extract_and_insert_inventories(self, substream, serializer,
4399
 
            parse_delta=None):
 
3820
    def _extract_and_insert_inventories(self, substream, serializer):
4400
3821
        """Generate a new inventory versionedfile in target, converting data.
4401
3822
 
4402
3823
        The inventory is retrieved from the source, (deserializing it), and
4403
3824
        stored in the target (reserializing it in a different format).
4404
3825
        """
4405
 
        target_rich_root = self.target_repo._format.rich_root_data
4406
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4407
3826
        for record in substream:
4408
 
            # It's not a delta, so it must be a fulltext in the source
4409
 
            # serializer's format.
4410
3827
            bytes = record.get_bytes_as('fulltext')
4411
3828
            revision_id = record.key[0]
4412
3829
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4413
3830
            parents = [key[0] for key in record.parents]
4414
3831
            self.target_repo.add_inventory(revision_id, inv, parents)
4415
 
            # No need to keep holding this full inv in memory when the rest of
4416
 
            # the substream is likely to be all deltas.
4417
 
            del inv
4418
3832
 
4419
3833
    def _extract_and_insert_revisions(self, substream, serializer):
4420
3834
        for record in substream:
4469
3883
        return [('signatures', signatures), ('revisions', revisions)]
4470
3884
 
4471
3885
    def _generate_root_texts(self, revs):
4472
 
        """This will be called by get_stream between fetching weave texts and
 
3886
        """This will be called by __fetch between fetching weave texts and
4473
3887
        fetching the inventory weave.
 
3888
 
 
3889
        Subclasses should override this if they need to generate root texts
 
3890
        after fetching weave texts.
4474
3891
        """
4475
3892
        if self._rich_root_upgrade():
4476
 
            return _mod_fetch.Inter1and2Helper(
 
3893
            import bzrlib.fetch
 
3894
            return bzrlib.fetch.Inter1and2Helper(
4477
3895
                self.from_repository).generate_root_texts(revs)
4478
3896
        else:
4479
3897
            return []
4482
3900
        phase = 'file'
4483
3901
        revs = search.get_keys()
4484
3902
        graph = self.from_repository.get_graph()
4485
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
 
3903
        revs = list(graph.iter_topo_order(revs))
4486
3904
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4487
3905
        text_keys = []
4488
3906
        for knit_kind, file_id, revisions in data_to_fetch:
4507
3925
                # will be valid.
4508
3926
                for _ in self._generate_root_texts(revs):
4509
3927
                    yield _
 
3928
                # NB: This currently reopens the inventory weave in source;
 
3929
                # using a single stream interface instead would avoid this.
 
3930
                from_weave = self.from_repository.inventories
4510
3931
                # we fetch only the referenced inventories because we do not
4511
3932
                # know for unselected inventories whether all their required
4512
3933
                # texts are present in the other repository - it could be
4513
3934
                # corrupt.
4514
 
                for info in self._get_inventory_stream(revs):
4515
 
                    yield info
 
3935
                yield ('inventories', from_weave.get_record_stream(
 
3936
                    [(rev_id,) for rev_id in revs],
 
3937
                    self.inventory_fetch_order(),
 
3938
                    not self.delta_on_metadata()))
4516
3939
            elif knit_kind == "signatures":
4517
3940
                # Nothing to do here; this will be taken care of when
4518
3941
                # _fetch_revision_texts happens.
4531
3954
        keys['texts'] = set()
4532
3955
        keys['revisions'] = set()
4533
3956
        keys['inventories'] = set()
4534
 
        keys['chk_bytes'] = set()
4535
3957
        keys['signatures'] = set()
4536
3958
        for key in missing_keys:
4537
3959
            keys[key[0]].add(key[1:])
4544
3966
                    keys['revisions'],))
4545
3967
        for substream_kind, keys in keys.iteritems():
4546
3968
            vf = getattr(self.from_repository, substream_kind)
4547
 
            if vf is None and keys:
4548
 
                    raise AssertionError(
4549
 
                        "cannot fill in keys for a versioned file we don't"
4550
 
                        " have: %s needs %s" % (substream_kind, keys))
4551
 
            if not keys:
4552
 
                # No need to stream something we don't have
4553
 
                continue
4554
 
            if substream_kind == 'inventories':
4555
 
                # Some missing keys are genuinely ghosts, filter those out.
4556
 
                present = self.from_repository.inventories.get_parent_map(keys)
4557
 
                revs = [key[0] for key in present]
4558
 
                # Get the inventory stream more-or-less as we do for the
4559
 
                # original stream; there's no reason to assume that records
4560
 
                # direct from the source will be suitable for the sink.  (Think
4561
 
                # e.g. 2a -> 1.9-rich-root).
4562
 
                for info in self._get_inventory_stream(revs, missing=True):
4563
 
                    yield info
4564
 
                continue
4565
 
 
4566
3969
            # Ask for full texts always so that we don't need more round trips
4567
3970
            # after this stream.
4568
 
            # Some of the missing keys are genuinely ghosts, so filter absent
4569
 
            # records. The Sink is responsible for doing another check to
4570
 
            # ensure that ghosts don't introduce missing data for future
4571
 
            # fetches.
4572
 
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
4573
 
                self.to_format._fetch_order, True))
 
3971
            stream = vf.get_record_stream(keys,
 
3972
                self.to_format._fetch_order, True)
4574
3973
            yield substream_kind, stream
4575
3974
 
4576
3975
    def inventory_fetch_order(self):
4583
3982
        return (not self.from_repository._format.rich_root_data and
4584
3983
            self.to_format.rich_root_data)
4585
3984
 
4586
 
    def _get_inventory_stream(self, revision_ids, missing=False):
4587
 
        from_format = self.from_repository._format
4588
 
        if (from_format.supports_chks and self.to_format.supports_chks and
4589
 
            from_format.network_name() == self.to_format.network_name()):
4590
 
            raise AssertionError(
4591
 
                "this case should be handled by GroupCHKStreamSource")
4592
 
        elif 'forceinvdeltas' in debug.debug_flags:
4593
 
            return self._get_convertable_inventory_stream(revision_ids,
4594
 
                    delta_versus_null=missing)
4595
 
        elif from_format.network_name() == self.to_format.network_name():
4596
 
            # Same format.
4597
 
            return self._get_simple_inventory_stream(revision_ids,
4598
 
                    missing=missing)
4599
 
        elif (not from_format.supports_chks and not self.to_format.supports_chks
4600
 
                and from_format._serializer == self.to_format._serializer):
4601
 
            # Essentially the same format.
4602
 
            return self._get_simple_inventory_stream(revision_ids,
4603
 
                    missing=missing)
4604
 
        else:
4605
 
            # Any time we switch serializations, we want to use an
4606
 
            # inventory-delta based approach.
4607
 
            return self._get_convertable_inventory_stream(revision_ids,
4608
 
                    delta_versus_null=missing)
4609
 
 
4610
 
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
4611
 
        # NB: This currently reopens the inventory weave in source;
4612
 
        # using a single stream interface instead would avoid this.
4613
 
        from_weave = self.from_repository.inventories
4614
 
        if missing:
4615
 
            delta_closure = True
4616
 
        else:
4617
 
            delta_closure = not self.delta_on_metadata()
4618
 
        yield ('inventories', from_weave.get_record_stream(
4619
 
            [(rev_id,) for rev_id in revision_ids],
4620
 
            self.inventory_fetch_order(), delta_closure))
4621
 
 
4622
 
    def _get_convertable_inventory_stream(self, revision_ids,
4623
 
                                          delta_versus_null=False):
4624
 
        # The two formats are sufficiently different that there is no fast
4625
 
        # path, so we need to send just inventorydeltas, which any
4626
 
        # sufficiently modern client can insert into any repository.
4627
 
        # The StreamSink code expects to be able to
4628
 
        # convert on the target, so we need to put bytes-on-the-wire that can
4629
 
        # be converted.  That means inventory deltas (if the remote is <1.19,
4630
 
        # RemoteStreamSink will fallback to VFS to insert the deltas).
4631
 
        yield ('inventory-deltas',
4632
 
           self._stream_invs_as_deltas(revision_ids,
4633
 
                                       delta_versus_null=delta_versus_null))
4634
 
 
4635
 
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
4636
 
        """Return a stream of inventory-deltas for the given rev ids.
4637
 
 
4638
 
        :param revision_ids: The list of inventories to transmit
4639
 
        :param delta_versus_null: Don't try to find a minimal delta for this
4640
 
            entry, instead compute the delta versus the NULL_REVISION. This
4641
 
            effectively streams a complete inventory. Used for stuff like
4642
 
            filling in missing parents, etc.
4643
 
        """
4644
 
        from_repo = self.from_repository
4645
 
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4646
 
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
4647
 
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
4648
 
        # method...
4649
 
        inventories = self.from_repository.iter_inventories(
4650
 
            revision_ids, 'topological')
4651
 
        format = from_repo._format
4652
 
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
4653
 
        inventory_cache = lru_cache.LRUCache(50)
4654
 
        null_inventory = from_repo.revision_tree(
4655
 
            _mod_revision.NULL_REVISION).inventory
4656
 
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
4657
 
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
4658
 
        # repo back into a non-rich-root repo ought to be allowed)
4659
 
        serializer = inventory_delta.InventoryDeltaSerializer(
4660
 
            versioned_root=format.rich_root_data,
4661
 
            tree_references=format.supports_tree_reference)
4662
 
        for inv in inventories:
4663
 
            key = (inv.revision_id,)
4664
 
            parent_keys = parent_map.get(key, ())
4665
 
            delta = None
4666
 
            if not delta_versus_null and parent_keys:
4667
 
                # The caller did not ask for complete inventories and we have
4668
 
                # some parents that we can delta against.  Make a delta against
4669
 
                # each parent so that we can find the smallest.
4670
 
                parent_ids = [parent_key[0] for parent_key in parent_keys]
4671
 
                for parent_id in parent_ids:
4672
 
                    if parent_id not in invs_sent_so_far:
4673
 
                        # We don't know that the remote side has this basis, so
4674
 
                        # we can't use it.
4675
 
                        continue
4676
 
                    if parent_id == _mod_revision.NULL_REVISION:
4677
 
                        parent_inv = null_inventory
4678
 
                    else:
4679
 
                        parent_inv = inventory_cache.get(parent_id, None)
4680
 
                        if parent_inv is None:
4681
 
                            parent_inv = from_repo.get_inventory(parent_id)
4682
 
                    candidate_delta = inv._make_delta(parent_inv)
4683
 
                    if (delta is None or
4684
 
                        len(delta) > len(candidate_delta)):
4685
 
                        delta = candidate_delta
4686
 
                        basis_id = parent_id
4687
 
            if delta is None:
4688
 
                # Either none of the parents ended up being suitable, or we
4689
 
                # were asked to delta against NULL
4690
 
                basis_id = _mod_revision.NULL_REVISION
4691
 
                delta = inv._make_delta(null_inventory)
4692
 
            invs_sent_so_far.add(inv.revision_id)
4693
 
            inventory_cache[inv.revision_id] = inv
4694
 
            delta_serialized = ''.join(
4695
 
                serializer.delta_to_lines(basis_id, key[-1], delta))
4696
 
            yield versionedfile.FulltextContentFactory(
4697
 
                key, parent_keys, None, delta_serialized)
4698
 
 
4699
 
 
4700
 
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
4701
 
                    stop_revision=None):
4702
 
    """Extend the partial history to include a given index
4703
 
 
4704
 
    If a stop_index is supplied, stop when that index has been reached.
4705
 
    If a stop_revision is supplied, stop when that revision is
4706
 
    encountered.  Otherwise, stop when the beginning of history is
4707
 
    reached.
4708
 
 
4709
 
    :param stop_index: The index which should be present.  When it is
4710
 
        present, history extension will stop.
4711
 
    :param stop_revision: The revision id which should be present.  When
4712
 
        it is encountered, history extension will stop.
4713
 
    """
4714
 
    start_revision = partial_history_cache[-1]
4715
 
    iterator = repo.iter_reverse_revision_history(start_revision)
4716
 
    try:
4717
 
        #skip the last revision in the list
4718
 
        iterator.next()
4719
 
        while True:
4720
 
            if (stop_index is not None and
4721
 
                len(partial_history_cache) > stop_index):
4722
 
                break
4723
 
            if partial_history_cache[-1] == stop_revision:
4724
 
                break
4725
 
            revision_id = iterator.next()
4726
 
            partial_history_cache.append(revision_id)
4727
 
    except StopIteration:
4728
 
        # No more history
4729
 
        return
4730