~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Jelmer Vernooij
  • Date: 2009-04-06 02:54:14 UTC
  • mfrom: (4253 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4255.
  • Revision ID: jelmer@samba.org-20090406025414-65tpjwcmjp5wa5oj
Merge bzr.dev.

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
 
    controldir,
29
26
    debug,
30
 
    fetch as _mod_fetch,
 
27
    errors,
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,
 
40
    ui,
47
41
    versionedfile,
48
42
    )
49
43
from bzrlib.bundle import serializer
52
46
from bzrlib.testament import Testament
53
47
""")
54
48
 
55
 
from bzrlib import (
56
 
    errors,
57
 
    registry,
58
 
    ui,
59
 
    )
60
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
61
50
from bzrlib.inter import InterObject
62
51
from bzrlib.inventory import (
63
52
    Inventory,
65
54
    ROOT_ID,
66
55
    entry_factory,
67
56
    )
68
 
from bzrlib.recordcounter import RecordCounter
69
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
 
57
from bzrlib import registry
 
58
from bzrlib.symbol_versioning import (
 
59
        deprecated_method,
 
60
        )
70
61
from bzrlib.trace import (
71
62
    log_exception_quietly, note, mutter, mutter_callsite, warning)
72
63
 
75
66
_deprecation_warning_done = False
76
67
 
77
68
 
78
 
class IsInWriteGroupError(errors.InternalBzrError):
79
 
 
80
 
    _fmt = "May not refresh_data of repo %(repo)s while in a write group."
81
 
 
82
 
    def __init__(self, repo):
83
 
        errors.InternalBzrError.__init__(self, repo=repo)
84
 
 
85
 
 
86
69
class CommitBuilder(object):
87
70
    """Provides an interface to build up a commit.
88
71
 
214
197
 
215
198
    def finish_inventory(self):
216
199
        """Tell the builder that the inventory is finished.
217
 
 
 
200
        
218
201
        :return: The inventory id in the repository, which can be used with
219
202
            repository.get_inventory.
220
203
        """
222
205
            # an inventory delta was accumulated without creating a new
223
206
            # inventory.
224
207
            basis_id = self.basis_delta_revision
225
 
            # We ignore the 'inventory' returned by add_inventory_by_delta
226
 
            # because self.new_inventory is used to hint to the rest of the
227
 
            # system what code path was taken
228
 
            self.inv_sha1, _ = self.repository.add_inventory_by_delta(
 
208
            self.inv_sha1 = self.repository.add_inventory_by_delta(
229
209
                basis_id, self._basis_delta, self._new_revision_id,
230
210
                self.parents)
231
211
        else:
243
223
 
244
224
    def _gen_revision_id(self):
245
225
        """Return new revision-id."""
246
 
        return generate_ids.gen_revision_id(self._committer, self._timestamp)
 
226
        return generate_ids.gen_revision_id(self._config.username(),
 
227
                                            self._timestamp)
247
228
 
248
229
    def _generate_revision_if_needed(self):
249
230
        """Create a revision id if None was supplied.
289
270
 
290
271
        :param tree: The tree which is being committed.
291
272
        """
292
 
        if len(self.parents) == 0:
293
 
            raise errors.RootMissing()
 
273
        # NB: if there are no parents then this method is not called, so no
 
274
        # need to guard on parents having length.
294
275
        entry = entry_factory['directory'](tree.path2id(''), '',
295
276
            None)
296
277
        entry.revision = self._new_revision_id
434
415
            else:
435
416
                # we don't need to commit this, because the caller already
436
417
                # determined that an existing revision of this file is
437
 
                # appropriate. If it's not being considered for committing then
 
418
                # appropriate. If its not being considered for committing then
438
419
                # it and all its parents to the root must be unaltered so
439
420
                # no-change against the basis.
440
421
                if ie.revision == self._new_revision_id:
484
465
            if content_summary[2] is None:
485
466
                raise ValueError("Files must not have executable = None")
486
467
            if not store:
487
 
                # We can't trust a check of the file length because of content
488
 
                # filtering...
489
 
                if (# if the exec bit has changed we have to store:
 
468
                if (# if the file length changed we have to store:
 
469
                    parent_entry.text_size != content_summary[1] or
 
470
                    # if the exec bit has changed we have to store:
490
471
                    parent_entry.executable != content_summary[2]):
491
472
                    store = True
492
473
                elif parent_entry.text_sha1 == content_summary[3]:
511
492
            ie.executable = content_summary[2]
512
493
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
513
494
            try:
514
 
                text = file_obj.read()
 
495
                lines = file_obj.readlines()
515
496
            finally:
516
497
                file_obj.close()
517
498
            try:
518
499
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
519
 
                    ie.file_id, text, heads, nostore_sha)
 
500
                    ie.file_id, lines, heads, nostore_sha)
520
501
                # Let the caller know we generated a stat fingerprint.
521
502
                fingerprint = (ie.text_sha1, stat_value)
522
503
            except errors.ExistingContent:
534
515
                # carry over:
535
516
                ie.revision = parent_entry.revision
536
517
                return self._get_delta(ie, basis_inv, path), False, None
537
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
518
            lines = []
 
519
            self._add_text_to_weave(ie.file_id, lines, heads, None)
538
520
        elif kind == 'symlink':
539
521
            current_link_target = content_summary[3]
540
522
            if not store:
548
530
                ie.symlink_target = parent_entry.symlink_target
549
531
                return self._get_delta(ie, basis_inv, path), False, None
550
532
            ie.symlink_target = current_link_target
551
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
533
            lines = []
 
534
            self._add_text_to_weave(ie.file_id, lines, heads, None)
552
535
        elif kind == 'tree-reference':
553
536
            if not store:
554
537
                if content_summary[3] != parent_entry.reference_revision:
559
542
                ie.revision = parent_entry.revision
560
543
                return self._get_delta(ie, basis_inv, path), False, None
561
544
            ie.reference_revision = content_summary[3]
562
 
            if ie.reference_revision is None:
563
 
                raise AssertionError("invalid content_summary for nested tree: %r"
564
 
                    % (content_summary,))
565
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
545
            lines = []
 
546
            self._add_text_to_weave(ie.file_id, lines, heads, None)
566
547
        else:
567
548
            raise NotImplementedError('unknown kind')
568
549
        ie.revision = self._new_revision_id
756
737
                    # after iter_changes examines and decides it has changed,
757
738
                    # we will unconditionally record a new version even if some
758
739
                    # other process reverts it while commit is running (with
759
 
                    # the revert happening after iter_changes did its
 
740
                    # the revert happening after iter_changes did it's
760
741
                    # examination).
761
742
                    if change[7][1]:
762
743
                        entry.executable = True
763
744
                    else:
764
745
                        entry.executable = False
765
 
                    if (carry_over_possible and
 
746
                    if (carry_over_possible and 
766
747
                        parent_entry.executable == entry.executable):
767
748
                            # Check the file length, content hash after reading
768
749
                            # the file.
771
752
                        nostore_sha = None
772
753
                    file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
773
754
                    try:
774
 
                        text = file_obj.read()
 
755
                        lines = file_obj.readlines()
775
756
                    finally:
776
757
                        file_obj.close()
777
758
                    try:
778
759
                        entry.text_sha1, entry.text_size = self._add_text_to_weave(
779
 
                            file_id, text, heads, nostore_sha)
 
760
                            file_id, lines, heads, nostore_sha)
780
761
                        yield file_id, change[1][1], (entry.text_sha1, stat_value)
781
762
                    except errors.ExistingContent:
782
763
                        # No content change against a carry_over parent
791
772
                        parent_entry.symlink_target == entry.symlink_target):
792
773
                        carried_over = True
793
774
                    else:
794
 
                        self._add_text_to_weave(change[0], '', heads, None)
 
775
                        self._add_text_to_weave(change[0], [], heads, None)
795
776
                elif kind == 'directory':
796
777
                    if carry_over_possible:
797
778
                        carried_over = True
799
780
                        # Nothing to set on the entry.
800
781
                        # XXX: split into the Root and nonRoot versions.
801
782
                        if change[1][1] != '' or self.repository.supports_rich_root():
802
 
                            self._add_text_to_weave(change[0], '', heads, None)
 
783
                            self._add_text_to_weave(change[0], [], heads, None)
803
784
                elif kind == 'tree-reference':
804
785
                    if not self.repository._format.supports_tree_reference:
805
786
                        # This isn't quite sane as an error, but we shouldn't
808
789
                        # references.
809
790
                        raise errors.UnsupportedOperation(tree.add_reference,
810
791
                            self.repository)
811
 
                    reference_revision = tree.get_reference_revision(change[0])
812
 
                    entry.reference_revision = reference_revision
 
792
                    entry.reference_revision = \
 
793
                        tree.get_reference_revision(change[0])
813
794
                    if (carry_over_possible and
814
795
                        parent_entry.reference_revision == reference_revision):
815
796
                        carried_over = True
816
797
                    else:
817
 
                        self._add_text_to_weave(change[0], '', heads, None)
 
798
                        self._add_text_to_weave(change[0], [], heads, None)
818
799
                else:
819
800
                    raise AssertionError('unknown kind %r' % kind)
820
801
                if not carried_over:
829
810
                seen_root = True
830
811
        self.new_inventory = None
831
812
        if len(inv_delta):
832
 
            # This should perhaps be guarded by a check that the basis we
833
 
            # commit against is the basis for the commit and if not do a delta
834
 
            # against the basis.
835
813
            self._any_changes = True
836
814
        if not seen_root:
837
815
            # housekeeping root entry changes do not affect no-change commits.
838
816
            self._require_root_change(tree)
839
817
        self.basis_delta_revision = basis_revision_id
840
818
 
841
 
    def _add_text_to_weave(self, file_id, new_text, parents, nostore_sha):
842
 
        parent_keys = tuple([(file_id, parent) for parent in parents])
843
 
        return self.repository.texts._add_text(
844
 
            (file_id, self._new_revision_id), parent_keys, new_text,
845
 
            nostore_sha=nostore_sha, random_id=self.random_revid)[0:2]
 
819
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
 
820
        # Note: as we read the content directly from the tree, we know its not
 
821
        # been turned into unicode or badly split - but a broken tree
 
822
        # implementation could give us bad output from readlines() so this is
 
823
        # not a guarantee of safety. What would be better is always checking
 
824
        # the content during test suite execution. RBC 20070912
 
825
        parent_keys = tuple((file_id, parent) for parent in parents)
 
826
        return self.repository.texts.add_lines(
 
827
            (file_id, self._new_revision_id), parent_keys, new_lines,
 
828
            nostore_sha=nostore_sha, random_id=self.random_revid,
 
829
            check_content=False)[0:2]
846
830
 
847
831
 
848
832
class RootCommitBuilder(CommitBuilder):
871
855
        # versioned roots do not change unless the tree found a change.
872
856
 
873
857
 
874
 
class RepositoryWriteLockResult(LogicalLockResult):
875
 
    """The result of write locking a repository.
876
 
 
877
 
    :ivar repository_token: The token obtained from the underlying lock, or
878
 
        None.
879
 
    :ivar unlock: A callable which will unlock the lock.
880
 
    """
881
 
 
882
 
    def __init__(self, unlock, repository_token):
883
 
        LogicalLockResult.__init__(self, unlock)
884
 
        self.repository_token = repository_token
885
 
 
886
 
    def __repr__(self):
887
 
        return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
888
 
            self.unlock)
889
 
 
890
 
 
891
858
######################################################################
892
859
# Repositories
893
860
 
894
 
 
895
 
class Repository(_RelockDebugMixin, controldir.ControlComponent):
 
861
class Repository(object):
896
862
    """Repository holding history for one or more branches.
897
863
 
898
864
    The repository holds and retrieves historical information including
900
866
    which views a particular line of development through that history.
901
867
 
902
868
    The Repository builds on top of some byte storage facilies (the revisions,
903
 
    signatures, inventories, texts and chk_bytes attributes) and a Transport,
904
 
    which respectively provide byte storage and a means to access the (possibly
 
869
    signatures, inventories and texts attributes) and a Transport, which
 
870
    respectively provide byte storage and a means to access the (possibly
905
871
    remote) disk.
906
872
 
907
873
    The byte storage facilities are addressed via tuples, which we refer to
908
874
    as 'keys' throughout the code base. Revision_keys, inventory_keys and
909
875
    signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
910
 
    (file_id, revision_id). chk_bytes uses CHK keys - a 1-tuple with a single
911
 
    byte string made up of a hash identifier and a hash value.
912
 
    We use this interface because it allows low friction with the underlying
913
 
    code that implements disk indices, network encoding and other parts of
914
 
    bzrlib.
 
876
    (file_id, revision_id). We use this interface because it allows low
 
877
    friction with the underlying code that implements disk indices, network
 
878
    encoding and other parts of bzrlib.
915
879
 
916
880
    :ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
917
881
        the serialised revisions for the repository. This can be used to obtain
936
900
        The result of trying to insert data into the repository via this store
937
901
        is undefined: it should be considered read-only except for implementors
938
902
        of repositories.
939
 
    :ivar chk_bytes: A bzrlib.versionedfile.VersionedFiles instance containing
940
 
        any data the repository chooses to store or have indexed by its hash.
941
 
        The result of trying to insert data into the repository via this store
942
 
        is undefined: it should be considered read-only except for implementors
943
 
        of repositories.
944
903
    :ivar _transport: Transport for file access to repository, typically
945
904
        pointing to .bzr/repository.
946
905
    """
947
906
 
948
 
    # What class to use for a CommitBuilder. Often it's simpler to change this
 
907
    # What class to use for a CommitBuilder. Often its simpler to change this
949
908
    # in a Repository class subclass rather than to override
950
909
    # get_commit_builder.
951
910
    _commit_builder_class = CommitBuilder
967
926
        """
968
927
        if self._write_group is not self.get_transaction():
969
928
            # has an unlock or relock occured ?
970
 
            if suppress_errors:
971
 
                mutter(
972
 
                '(suppressed) mismatched lock context and write group. %r, %r',
973
 
                self._write_group, self.get_transaction())
974
 
                return
975
 
            raise errors.BzrError(
976
 
                'mismatched lock context and write group. %r, %r' %
977
 
                (self._write_group, self.get_transaction()))
 
929
            raise errors.BzrError('mismatched lock context and write group.')
978
930
        try:
979
931
            self._abort_write_group()
980
932
        except Exception, exc:
1006
958
        """
1007
959
        if not self._format.supports_external_lookups:
1008
960
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
1009
 
        if self.is_locked():
1010
 
            # This repository will call fallback.unlock() when we transition to
1011
 
            # the unlocked state, so we make sure to increment the lock count
1012
 
            repository.lock_read()
1013
961
        self._check_fallback_repository(repository)
1014
962
        self._fallback_repositories.append(repository)
1015
963
        self.texts.add_fallback_versioned_files(repository.texts)
1016
964
        self.inventories.add_fallback_versioned_files(repository.inventories)
1017
965
        self.revisions.add_fallback_versioned_files(repository.revisions)
1018
966
        self.signatures.add_fallback_versioned_files(repository.signatures)
1019
 
        if self.chk_bytes is not None:
1020
 
            self.chk_bytes.add_fallback_versioned_files(repository.chk_bytes)
1021
967
 
1022
968
    def _check_fallback_repository(self, repository):
1023
969
        """Check that this repository can fallback to repository safely.
1046
992
                " id and insertion revid (%r, %r)"
1047
993
                % (inv.revision_id, revision_id))
1048
994
        if inv.root is None:
1049
 
            raise errors.RootMissing()
1050
 
        return self._add_inventory_checked(revision_id, inv, parents)
1051
 
 
1052
 
    def _add_inventory_checked(self, revision_id, inv, parents):
1053
 
        """Add inv to the repository after checking the inputs.
1054
 
 
1055
 
        This function can be overridden to allow different inventory styles.
1056
 
 
1057
 
        :seealso: add_inventory, for the contract.
1058
 
        """
1059
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
 
995
            raise AssertionError()
 
996
        inv_lines = self._serialise_inventory_to_lines(inv)
1060
997
        return self._inventory_add_lines(revision_id, parents,
1061
998
            inv_lines, check_content=False)
1062
999
 
1063
1000
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1064
 
                               parents, basis_inv=None, propagate_caches=False):
 
1001
                               parents):
1065
1002
        """Add a new inventory expressed as a delta against another revision.
1066
1003
 
1067
 
        See the inventory developers documentation for the theory behind
1068
 
        inventory deltas.
1069
 
 
1070
1004
        :param basis_revision_id: The inventory id the delta was created
1071
1005
            against. (This does not have to be a direct parent.)
1072
1006
        :param delta: The inventory delta (see Inventory.apply_delta for
1078
1012
            for repositories that depend on the inventory graph for revision
1079
1013
            graph access, as well as for those that pun ancestry with delta
1080
1014
            compression.
1081
 
        :param basis_inv: The basis inventory if it is already known,
1082
 
            otherwise None.
1083
 
        :param propagate_caches: If True, the caches for this inventory are
1084
 
          copied to and updated for the result if possible.
1085
1015
 
1086
1016
        :returns: (validator, new_inv)
1087
1017
            The validator(which is a sha1 digest, though what is sha'd is
1098
1028
            # inventory implementations may support: A better idiom would be to
1099
1029
            # return a new inventory, but as there is no revision tree cache in
1100
1030
            # repository this is safe for now - RBC 20081013
1101
 
            if basis_inv is None:
1102
 
                basis_inv = basis_tree.inventory
 
1031
            basis_inv = basis_tree.inventory
1103
1032
            basis_inv.apply_delta(delta)
1104
1033
            basis_inv.revision_id = new_revision_id
1105
1034
            return (self.add_inventory(new_revision_id, basis_inv, parents),
1111
1040
        check_content=True):
1112
1041
        """Store lines in inv_vf and return the sha1 of the inventory."""
1113
1042
        parents = [(parent,) for parent in parents]
1114
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
1043
        return self.inventories.add_lines((revision_id,), parents, lines,
1115
1044
            check_content=check_content)[0]
1116
 
        self.inventories._access.flush()
1117
 
        return result
1118
1045
 
1119
1046
    def add_revision(self, revision_id, rev, inv=None, config=None):
1120
1047
        """Add rev to the revision store as revision_id.
1196
1123
        # The old API returned a list, should this actually be a set?
1197
1124
        return parent_map.keys()
1198
1125
 
1199
 
    def _check_inventories(self, checker):
1200
 
        """Check the inventories found from the revision scan.
1201
 
        
1202
 
        This is responsible for verifying the sha1 of inventories and
1203
 
        creating a pending_keys set that covers data referenced by inventories.
1204
 
        """
1205
 
        bar = ui.ui_factory.nested_progress_bar()
1206
 
        try:
1207
 
            self._do_check_inventories(checker, bar)
1208
 
        finally:
1209
 
            bar.finished()
1210
 
 
1211
 
    def _do_check_inventories(self, checker, bar):
1212
 
        """Helper for _check_inventories."""
1213
 
        revno = 0
1214
 
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
1215
 
        kinds = ['chk_bytes', 'texts']
1216
 
        count = len(checker.pending_keys)
1217
 
        bar.update("inventories", 0, 2)
1218
 
        current_keys = checker.pending_keys
1219
 
        checker.pending_keys = {}
1220
 
        # Accumulate current checks.
1221
 
        for key in current_keys:
1222
 
            if key[0] != 'inventories' and key[0] not in kinds:
1223
 
                checker._report_items.append('unknown key type %r' % (key,))
1224
 
            keys[key[0]].add(key[1:])
1225
 
        if keys['inventories']:
1226
 
            # NB: output order *should* be roughly sorted - topo or
1227
 
            # inverse topo depending on repository - either way decent
1228
 
            # to just delta against. However, pre-CHK formats didn't
1229
 
            # try to optimise inventory layout on disk. As such the
1230
 
            # pre-CHK code path does not use inventory deltas.
1231
 
            last_object = None
1232
 
            for record in self.inventories.check(keys=keys['inventories']):
1233
 
                if record.storage_kind == 'absent':
1234
 
                    checker._report_items.append(
1235
 
                        'Missing inventory {%s}' % (record.key,))
1236
 
                else:
1237
 
                    last_object = self._check_record('inventories', record,
1238
 
                        checker, last_object,
1239
 
                        current_keys[('inventories',) + record.key])
1240
 
            del keys['inventories']
1241
 
        else:
1242
 
            return
1243
 
        bar.update("texts", 1)
1244
 
        while (checker.pending_keys or keys['chk_bytes']
1245
 
            or keys['texts']):
1246
 
            # Something to check.
1247
 
            current_keys = checker.pending_keys
1248
 
            checker.pending_keys = {}
1249
 
            # Accumulate current checks.
1250
 
            for key in current_keys:
1251
 
                if key[0] not in kinds:
1252
 
                    checker._report_items.append('unknown key type %r' % (key,))
1253
 
                keys[key[0]].add(key[1:])
1254
 
            # Check the outermost kind only - inventories || chk_bytes || texts
1255
 
            for kind in kinds:
1256
 
                if keys[kind]:
1257
 
                    last_object = None
1258
 
                    for record in getattr(self, kind).check(keys=keys[kind]):
1259
 
                        if record.storage_kind == 'absent':
1260
 
                            checker._report_items.append(
1261
 
                                'Missing %s {%s}' % (kind, record.key,))
1262
 
                        else:
1263
 
                            last_object = self._check_record(kind, record,
1264
 
                                checker, last_object, current_keys[(kind,) + record.key])
1265
 
                    keys[kind] = set()
1266
 
                    break
1267
 
 
1268
 
    def _check_record(self, kind, record, checker, last_object, item_data):
1269
 
        """Check a single text from this repository."""
1270
 
        if kind == 'inventories':
1271
 
            rev_id = record.key[0]
1272
 
            inv = self._deserialise_inventory(rev_id,
1273
 
                record.get_bytes_as('fulltext'))
1274
 
            if last_object is not None:
1275
 
                delta = inv._make_delta(last_object)
1276
 
                for old_path, path, file_id, ie in delta:
1277
 
                    if ie is None:
1278
 
                        continue
1279
 
                    ie.check(checker, rev_id, inv)
1280
 
            else:
1281
 
                for path, ie in inv.iter_entries():
1282
 
                    ie.check(checker, rev_id, inv)
1283
 
            if self._format.fast_deltas:
1284
 
                return inv
1285
 
        elif kind == 'chk_bytes':
1286
 
            # No code written to check chk_bytes for this repo format.
1287
 
            checker._report_items.append(
1288
 
                'unsupported key type chk_bytes for %s' % (record.key,))
1289
 
        elif kind == 'texts':
1290
 
            self._check_text(record, checker, item_data)
1291
 
        else:
1292
 
            checker._report_items.append(
1293
 
                'unknown key type %s for %s' % (kind, record.key))
1294
 
 
1295
 
    def _check_text(self, record, checker, item_data):
1296
 
        """Check a single text."""
1297
 
        # Check it is extractable.
1298
 
        # TODO: check length.
1299
 
        if record.storage_kind == 'chunked':
1300
 
            chunks = record.get_bytes_as(record.storage_kind)
1301
 
            sha1 = osutils.sha_strings(chunks)
1302
 
            length = sum(map(len, chunks))
1303
 
        else:
1304
 
            content = record.get_bytes_as('fulltext')
1305
 
            sha1 = osutils.sha_string(content)
1306
 
            length = len(content)
1307
 
        if item_data and sha1 != item_data[1]:
1308
 
            checker._report_items.append(
1309
 
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
1310
 
                (record.key, sha1, item_data[1], item_data[2]))
1311
 
 
1312
1126
    @staticmethod
1313
1127
    def create(a_bzrdir):
1314
1128
        """Construct the current default format repository in a_bzrdir."""
1319
1133
 
1320
1134
        :param _format: The format of the repository on disk.
1321
1135
        :param a_bzrdir: The BzrDir of the repository.
 
1136
 
 
1137
        In the future we will have a single api for all stores for
 
1138
        getting file texts, inventories and revisions, then
 
1139
        this construct will accept instances of those things.
1322
1140
        """
1323
 
        # In the future we will have a single api for all stores for
1324
 
        # getting file texts, inventories and revisions, then
1325
 
        # this construct will accept instances of those things.
1326
1141
        super(Repository, self).__init__()
1327
1142
        self._format = _format
1328
1143
        # the following are part of the public API for Repository:
1334
1149
        self._reconcile_does_inventory_gc = True
1335
1150
        self._reconcile_fixes_text_parents = False
1336
1151
        self._reconcile_backsup_inventory = True
 
1152
        # not right yet - should be more semantically clear ?
 
1153
        #
 
1154
        # TODO: make sure to construct the right store classes, etc, depending
 
1155
        # on whether escaping is required.
 
1156
        self._warn_if_deprecated()
1337
1157
        self._write_group = None
1338
1158
        # Additional places to query for data.
1339
1159
        self._fallback_repositories = []
1340
1160
        # An InventoryEntry cache, used during deserialization
1341
1161
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
1342
 
        # Is it safe to return inventory entries directly from the entry cache,
1343
 
        # rather copying them?
1344
 
        self._safe_to_return_from_cache = False
1345
 
 
1346
 
    @property
1347
 
    def user_transport(self):
1348
 
        return self.bzrdir.user_transport
1349
 
 
1350
 
    @property
1351
 
    def control_transport(self):
1352
 
        return self._transport
1353
1162
 
1354
1163
    def __repr__(self):
1355
 
        if self._fallback_repositories:
1356
 
            return '%s(%r, fallback_repositories=%r)' % (
1357
 
                self.__class__.__name__,
1358
 
                self.base,
1359
 
                self._fallback_repositories)
1360
 
        else:
1361
 
            return '%s(%r)' % (self.__class__.__name__,
1362
 
                               self.base)
1363
 
 
1364
 
    def _has_same_fallbacks(self, other_repo):
1365
 
        """Returns true if the repositories have the same fallbacks."""
1366
 
        my_fb = self._fallback_repositories
1367
 
        other_fb = other_repo._fallback_repositories
1368
 
        if len(my_fb) != len(other_fb):
1369
 
            return False
1370
 
        for f, g in zip(my_fb, other_fb):
1371
 
            if not f.has_same_location(g):
1372
 
                return False
1373
 
        return True
 
1164
        return '%s(%r)' % (self.__class__.__name__,
 
1165
                           self.base)
1374
1166
 
1375
1167
    def has_same_location(self, other):
1376
1168
        """Returns a boolean indicating if this repository is at the same
1404
1196
        data during reads, and allows a 'write_group' to be obtained. Write
1405
1197
        groups must be used for actual data insertion.
1406
1198
 
1407
 
        A token should be passed in if you know that you have locked the object
1408
 
        some other way, and need to synchronise this object's state with that
1409
 
        fact.
1410
 
 
1411
 
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1412
 
 
1413
1199
        :param token: if this is already locked, then lock_write will fail
1414
1200
            unless the token matches the existing lock.
1415
1201
        :returns: a token if this instance supports tokens, otherwise None.
1418
1204
        :raises MismatchedToken: if the specified token doesn't match the token
1419
1205
            of the existing lock.
1420
1206
        :seealso: start_write_group.
1421
 
        :return: A RepositoryWriteLockResult.
 
1207
 
 
1208
        A token should be passed in if you know that you have locked the object
 
1209
        some other way, and need to synchronise this object's state with that
 
1210
        fact.
 
1211
 
 
1212
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1422
1213
        """
1423
1214
        locked = self.is_locked()
1424
 
        token = self.control_files.lock_write(token=token)
 
1215
        result = self.control_files.lock_write(token=token)
 
1216
        for repo in self._fallback_repositories:
 
1217
            # Writes don't affect fallback repos
 
1218
            repo.lock_read()
1425
1219
        if not locked:
1426
 
            self._warn_if_deprecated()
1427
 
            self._note_lock('w')
1428
 
            for repo in self._fallback_repositories:
1429
 
                # Writes don't affect fallback repos
1430
 
                repo.lock_read()
1431
1220
            self._refresh_data()
1432
 
        return RepositoryWriteLockResult(self.unlock, token)
 
1221
        return result
1433
1222
 
1434
1223
    def lock_read(self):
1435
 
        """Lock the repository for read operations.
1436
 
 
1437
 
        :return: An object with an unlock method which will release the lock
1438
 
            obtained.
1439
 
        """
1440
1224
        locked = self.is_locked()
1441
1225
        self.control_files.lock_read()
 
1226
        for repo in self._fallback_repositories:
 
1227
            repo.lock_read()
1442
1228
        if not locked:
1443
 
            self._warn_if_deprecated()
1444
 
            self._note_lock('r')
1445
 
            for repo in self._fallback_repositories:
1446
 
                repo.lock_read()
1447
1229
            self._refresh_data()
1448
 
        return LogicalLockResult(self.unlock)
1449
1230
 
1450
1231
    def get_physical_lock_status(self):
1451
1232
        return self.control_files.get_physical_lock_status()
1511
1292
 
1512
1293
        # now gather global repository information
1513
1294
        # XXX: This is available for many repos regardless of listability.
1514
 
        if self.user_transport.listable():
 
1295
        if self.bzrdir.root_transport.listable():
1515
1296
            # XXX: do we want to __define len__() ?
1516
1297
            # Maybe the versionedfiles object should provide a different
1517
1298
            # method to get the number of keys.
1527
1308
        :param using: If True, list only branches using this repository.
1528
1309
        """
1529
1310
        if using and not self.is_shared():
1530
 
            return self.bzrdir.list_branches()
 
1311
            try:
 
1312
                return [self.bzrdir.open_branch()]
 
1313
            except errors.NotBranchError:
 
1314
                return []
1531
1315
        class Evaluator(object):
1532
1316
 
1533
1317
            def __init__(self):
1542
1326
                    except errors.NoRepositoryPresent:
1543
1327
                        pass
1544
1328
                    else:
1545
 
                        return False, ([], repository)
 
1329
                        return False, (None, repository)
1546
1330
                self.first_call = False
1547
 
                value = (bzrdir.list_branches(), None)
 
1331
                try:
 
1332
                    value = (bzrdir.open_branch(), None)
 
1333
                except errors.NotBranchError:
 
1334
                    value = (None, None)
1548
1335
                return True, value
1549
1336
 
1550
 
        ret = []
1551
 
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
1552
 
                self.user_transport, evaluate=Evaluator()):
1553
 
            if branches is not None:
1554
 
                ret.extend(branches)
 
1337
        branches = []
 
1338
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1339
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
1340
            if branch is not None:
 
1341
                branches.append(branch)
1555
1342
            if not using and repository is not None:
1556
 
                ret.extend(repository.find_branches())
1557
 
        return ret
 
1343
                branches.extend(repository.find_branches())
 
1344
        return branches
1558
1345
 
1559
1346
    @needs_read_lock
1560
1347
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1589
1376
        """Commit the contents accrued within the current write group.
1590
1377
 
1591
1378
        :seealso: start_write_group.
1592
 
        
1593
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1594
1379
        """
1595
1380
        if self._write_group is not self.get_transaction():
1596
1381
            # has an unlock or relock occured ?
1597
1382
            raise errors.BzrError('mismatched lock context %r and '
1598
1383
                'write group %r.' %
1599
1384
                (self.get_transaction(), self._write_group))
1600
 
        result = self._commit_write_group()
 
1385
        self._commit_write_group()
1601
1386
        self._write_group = None
1602
 
        return result
1603
1387
 
1604
1388
    def _commit_write_group(self):
1605
1389
        """Template method for per-repository write group cleanup.
1613
1397
    def suspend_write_group(self):
1614
1398
        raise errors.UnsuspendableWriteGroup(self)
1615
1399
 
1616
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
1617
 
        """Return the keys of missing inventory parents for revisions added in
1618
 
        this write group.
1619
 
 
1620
 
        A revision is not complete if the inventory delta for that revision
1621
 
        cannot be calculated.  Therefore if the parent inventories of a
1622
 
        revision are not present, the revision is incomplete, and e.g. cannot
1623
 
        be streamed by a smart server.  This method finds missing inventory
1624
 
        parents for revisions added in this write group.
1625
 
        """
1626
 
        if not self._format.supports_external_lookups:
1627
 
            # This is only an issue for stacked repositories
1628
 
            return set()
1629
 
        if not self.is_in_write_group():
1630
 
            raise AssertionError('not in a write group')
1631
 
 
1632
 
        # XXX: We assume that every added revision already has its
1633
 
        # corresponding inventory, so we only check for parent inventories that
1634
 
        # might be missing, rather than all inventories.
1635
 
        parents = set(self.revisions._index.get_missing_parents())
1636
 
        parents.discard(_mod_revision.NULL_REVISION)
1637
 
        unstacked_inventories = self.inventories._index
1638
 
        present_inventories = unstacked_inventories.get_parent_map(
1639
 
            key[-1:] for key in parents)
1640
 
        parents.difference_update(present_inventories)
1641
 
        if len(parents) == 0:
1642
 
            # No missing parent inventories.
1643
 
            return set()
1644
 
        if not check_for_missing_texts:
1645
 
            return set(('inventories', rev_id) for (rev_id,) in parents)
1646
 
        # Ok, now we have a list of missing inventories.  But these only matter
1647
 
        # if the inventories that reference them are missing some texts they
1648
 
        # appear to introduce.
1649
 
        # XXX: Texts referenced by all added inventories need to be present,
1650
 
        # but at the moment we're only checking for texts referenced by
1651
 
        # inventories at the graph's edge.
1652
 
        key_deps = self.revisions._index._key_dependencies
1653
 
        key_deps.satisfy_refs_for_keys(present_inventories)
1654
 
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1655
 
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1656
 
        missing_texts = set()
1657
 
        for file_id, version_ids in file_ids.iteritems():
1658
 
            missing_texts.update(
1659
 
                (file_id, version_id) for version_id in version_ids)
1660
 
        present_texts = self.texts.get_parent_map(missing_texts)
1661
 
        missing_texts.difference_update(present_texts)
1662
 
        if not missing_texts:
1663
 
            # No texts are missing, so all revisions and their deltas are
1664
 
            # reconstructable.
1665
 
            return set()
1666
 
        # Alternatively the text versions could be returned as the missing
1667
 
        # keys, but this is likely to be less data.
1668
 
        missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
1669
 
        return missing_keys
1670
 
 
1671
1400
    def refresh_data(self):
1672
 
        """Re-read any data needed to synchronise with disk.
 
1401
        """Re-read any data needed to to synchronise with disk.
1673
1402
 
1674
1403
        This method is intended to be called after another repository instance
1675
1404
        (such as one used by a smart server) has inserted data into the
1676
 
        repository. On all repositories this will work outside of write groups.
1677
 
        Some repository formats (pack and newer for bzrlib native formats)
1678
 
        support refresh_data inside write groups. If called inside a write
1679
 
        group on a repository that does not support refreshing in a write group
1680
 
        IsInWriteGroupError will be raised.
 
1405
        repository. It may not be called during a write group, but may be
 
1406
        called at any other time.
1681
1407
        """
 
1408
        if self.is_in_write_group():
 
1409
            raise errors.InternalBzrError(
 
1410
                "May not refresh_data while in a write group.")
1682
1411
        self._refresh_data()
1683
1412
 
1684
1413
    def resume_write_group(self, tokens):
1722
1451
            raise errors.InternalBzrError(
1723
1452
                "May not fetch while in a write group.")
1724
1453
        # fast path same-url fetch operations
1725
 
        # TODO: lift out to somewhere common with RemoteRepository
1726
 
        # <https://bugs.launchpad.net/bzr/+bug/401646>
1727
 
        if (self.has_same_location(source)
1728
 
            and fetch_spec is None
1729
 
            and self._has_same_fallbacks(source)):
 
1454
        if self.has_same_location(source) and fetch_spec is None:
1730
1455
            # check that last_revision is in 'from' and then return a
1731
1456
            # no-operation.
1732
1457
            if (revision_id is not None and
1757
1482
        :param revprops: Optional dictionary of revision properties.
1758
1483
        :param revision_id: Optional revision id.
1759
1484
        """
1760
 
        if self._fallback_repositories:
1761
 
            raise errors.BzrError("Cannot commit from a lightweight checkout "
1762
 
                "to a stacked branch. See "
1763
 
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1764
1485
        result = self._commit_builder_class(self, parents, config,
1765
1486
            timestamp, timezone, committer, revprops, revision_id)
1766
1487
        self.start_write_group()
1767
1488
        return result
1768
1489
 
1769
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1770
1490
    def unlock(self):
1771
1491
        if (self.control_files._lock_count == 1 and
1772
1492
            self.control_files._lock_mode == 'w'):
1778
1498
        self.control_files.unlock()
1779
1499
        if self.control_files._lock_count == 0:
1780
1500
            self._inventory_entry_cache.clear()
1781
 
            for repo in self._fallback_repositories:
1782
 
                repo.unlock()
 
1501
        for repo in self._fallback_repositories:
 
1502
            repo.unlock()
1783
1503
 
1784
1504
    @needs_read_lock
1785
1505
    def clone(self, a_bzrdir, revision_id=None):
1894
1614
 
1895
1615
    @needs_read_lock
1896
1616
    def get_revisions(self, revision_ids):
1897
 
        """Get many revisions at once.
1898
 
        
1899
 
        Repositories that need to check data on every revision read should 
1900
 
        subclass this method.
1901
 
        """
 
1617
        """Get many revisions at once."""
1902
1618
        return self._get_revisions(revision_ids)
1903
1619
 
1904
1620
    @needs_read_lock
1905
1621
    def _get_revisions(self, revision_ids):
1906
1622
        """Core work logic to get many revisions without sanity checks."""
 
1623
        for rev_id in revision_ids:
 
1624
            if not rev_id or not isinstance(rev_id, basestring):
 
1625
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1626
        keys = [(key,) for key in revision_ids]
 
1627
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1907
1628
        revs = {}
1908
 
        for revid, rev in self._iter_revisions(revision_ids):
1909
 
            if rev is None:
1910
 
                raise errors.NoSuchRevision(self, revid)
1911
 
            revs[revid] = rev
 
1629
        for record in stream:
 
1630
            if record.storage_kind == 'absent':
 
1631
                raise errors.NoSuchRevision(self, record.key[0])
 
1632
            text = record.get_bytes_as('fulltext')
 
1633
            rev = self._serializer.read_revision_from_string(text)
 
1634
            revs[record.key[0]] = rev
1912
1635
        return [revs[revid] for revid in revision_ids]
1913
1636
 
1914
 
    def _iter_revisions(self, revision_ids):
1915
 
        """Iterate over revision objects.
1916
 
 
1917
 
        :param revision_ids: An iterable of revisions to examine. None may be
1918
 
            passed to request all revisions known to the repository. Note that
1919
 
            not all repositories can find unreferenced revisions; for those
1920
 
            repositories only referenced ones will be returned.
1921
 
        :return: An iterator of (revid, revision) tuples. Absent revisions (
1922
 
            those asked for but not available) are returned as (revid, None).
1923
 
        """
1924
 
        if revision_ids is None:
1925
 
            revision_ids = self.all_revision_ids()
1926
 
        else:
1927
 
            for rev_id in revision_ids:
1928
 
                if not rev_id or not isinstance(rev_id, basestring):
1929
 
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1930
 
        keys = [(key,) for key in revision_ids]
1931
 
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1932
 
        for record in stream:
1933
 
            revid = record.key[0]
1934
 
            if record.storage_kind == 'absent':
1935
 
                yield (revid, None)
1936
 
            else:
1937
 
                text = record.get_bytes_as('fulltext')
1938
 
                rev = self._serializer.read_revision_from_string(text)
1939
 
                yield (revid, rev)
 
1637
    @needs_read_lock
 
1638
    def get_revision_xml(self, revision_id):
 
1639
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1640
        #       would have already do it.
 
1641
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1642
        # TODO: this can't just be replaced by:
 
1643
        # return self._serializer.write_revision_to_string(
 
1644
        #     self.get_revision(revision_id))
 
1645
        # as cStringIO preservers the encoding unlike write_revision_to_string
 
1646
        # or some other call down the path.
 
1647
        rev = self.get_revision(revision_id)
 
1648
        rev_tmp = cStringIO.StringIO()
 
1649
        # the current serializer..
 
1650
        self._serializer.write_revision(rev, rev_tmp)
 
1651
        rev_tmp.seek(0)
 
1652
        return rev_tmp.getvalue()
1940
1653
 
1941
1654
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1942
1655
        """Produce a generator of revision deltas.
2120
1833
                    yield line, revid
2121
1834
 
2122
1835
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
2123
 
        revision_keys):
 
1836
        revision_ids):
2124
1837
        """Helper routine for fileids_altered_by_revision_ids.
2125
1838
 
2126
1839
        This performs the translation of xml lines to revision ids.
2127
1840
 
2128
1841
        :param line_iterator: An iterator of lines, origin_version_id
2129
 
        :param revision_keys: The revision ids to filter for. This should be a
 
1842
        :param revision_ids: The revision ids to filter for. This should be a
2130
1843
            set or other type which supports efficient __contains__ lookups, as
2131
 
            the revision key from each parsed line will be looked up in the
2132
 
            revision_keys filter.
 
1844
            the revision id from each parsed line will be looked up in the
 
1845
            revision_ids filter.
2133
1846
        :return: a dictionary mapping altered file-ids to an iterable of
2134
1847
        revision_ids. Each altered file-ids has the exact revision_ids that
2135
1848
        altered it listed explicitly.
2136
1849
        """
2137
1850
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
2138
1851
                line_iterator).iterkeys())
2139
 
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
 
1852
        # Note that revision_ids are revision keys.
 
1853
        parent_maps = self.revisions.get_parent_map(revision_ids)
 
1854
        parents = set()
 
1855
        map(parents.update, parent_maps.itervalues())
 
1856
        parents.difference_update(revision_ids)
2140
1857
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
2141
 
            self._inventory_xml_lines_for_keys(parent_keys)))
 
1858
            self._inventory_xml_lines_for_keys(parents)))
2142
1859
        new_keys = seen - parent_seen
2143
1860
        result = {}
2144
1861
        setdefault = result.setdefault
2146
1863
            setdefault(key[0], set()).add(key[-1])
2147
1864
        return result
2148
1865
 
2149
 
    def _find_parent_ids_of_revisions(self, revision_ids):
2150
 
        """Find all parent ids that are mentioned in the revision graph.
2151
 
 
2152
 
        :return: set of revisions that are parents of revision_ids which are
2153
 
            not part of revision_ids themselves
2154
 
        """
2155
 
        parent_map = self.get_parent_map(revision_ids)
2156
 
        parent_ids = set()
2157
 
        map(parent_ids.update, parent_map.itervalues())
2158
 
        parent_ids.difference_update(revision_ids)
2159
 
        parent_ids.discard(_mod_revision.NULL_REVISION)
2160
 
        return parent_ids
2161
 
 
2162
 
    def _find_parent_keys_of_revisions(self, revision_keys):
2163
 
        """Similar to _find_parent_ids_of_revisions, but used with keys.
2164
 
 
2165
 
        :param revision_keys: An iterable of revision_keys.
2166
 
        :return: The parents of all revision_keys that are not already in
2167
 
            revision_keys
2168
 
        """
2169
 
        parent_map = self.revisions.get_parent_map(revision_keys)
2170
 
        parent_keys = set()
2171
 
        map(parent_keys.update, parent_map.itervalues())
2172
 
        parent_keys.difference_update(revision_keys)
2173
 
        parent_keys.discard(_mod_revision.NULL_REVISION)
2174
 
        return parent_keys
2175
 
 
2176
1866
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
2177
1867
        """Find the file ids and versions affected by revisions.
2178
1868
 
2185
1875
        """
2186
1876
        selected_keys = set((revid,) for revid in revision_ids)
2187
1877
        w = _inv_weave or self.inventories
2188
 
        return self._find_file_ids_from_xml_inventory_lines(
2189
 
            w.iter_lines_added_or_present_in_keys(
2190
 
                selected_keys, pb=None),
2191
 
            selected_keys)
 
1878
        pb = ui.ui_factory.nested_progress_bar()
 
1879
        try:
 
1880
            return self._find_file_ids_from_xml_inventory_lines(
 
1881
                w.iter_lines_added_or_present_in_keys(
 
1882
                    selected_keys, pb=pb),
 
1883
                selected_keys)
 
1884
        finally:
 
1885
            pb.finished()
2192
1886
 
2193
1887
    def iter_files_bytes(self, desired_files):
2194
1888
        """Iterate through file versions.
2276
1970
                batch_size]
2277
1971
            if not to_query:
2278
1972
                break
2279
 
            for revision_id in to_query:
 
1973
            for rev_tree in self.revision_trees(to_query):
 
1974
                revision_id = rev_tree.get_revision_id()
2280
1975
                parent_ids = ancestors[revision_id]
2281
1976
                for text_key in revision_keys[revision_id]:
2282
1977
                    pb.update("Calculating text parents", processed_texts)
2301
1996
                            except KeyError:
2302
1997
                                inv = self.revision_tree(parent_id).inventory
2303
1998
                                inventory_cache[parent_id] = inv
2304
 
                            try:
2305
 
                                parent_entry = inv[text_key[0]]
2306
 
                            except (KeyError, errors.NoSuchId):
2307
 
                                parent_entry = None
 
1999
                            parent_entry = inv._byid.get(text_key[0], None)
2308
2000
                            if parent_entry is not None:
2309
2001
                                parent_text_key = (
2310
2002
                                    text_key[0], parent_entry.revision)
2335
2027
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
2336
2028
            'revisions'.  file-id is None unless knit-kind is 'file'.
2337
2029
        """
2338
 
        for result in self._find_file_keys_to_fetch(revision_ids, _files_pb):
2339
 
            yield result
2340
 
        del _files_pb
2341
 
        for result in self._find_non_file_keys_to_fetch(revision_ids):
2342
 
            yield result
2343
 
 
2344
 
    def _find_file_keys_to_fetch(self, revision_ids, pb):
2345
2030
        # XXX: it's a bit weird to control the inventory weave caching in this
2346
2031
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
2347
2032
        # maybe this generator should explicitly have the contract that it
2354
2039
        count = 0
2355
2040
        num_file_ids = len(file_ids)
2356
2041
        for file_id, altered_versions in file_ids.iteritems():
2357
 
            if pb is not None:
2358
 
                pb.update("Fetch texts", count, num_file_ids)
 
2042
            if _files_pb is not None:
 
2043
                _files_pb.update("fetch texts", count, num_file_ids)
2359
2044
            count += 1
2360
2045
            yield ("file", file_id, altered_versions)
 
2046
        # We're done with the files_pb.  Note that it finished by the caller,
 
2047
        # just as it was created by the caller.
 
2048
        del _files_pb
2361
2049
 
2362
 
    def _find_non_file_keys_to_fetch(self, revision_ids):
2363
2050
        # inventory
2364
2051
        yield ("inventory", None, revision_ids)
2365
2052
 
2382
2069
        """Get Inventory object by revision id."""
2383
2070
        return self.iter_inventories([revision_id]).next()
2384
2071
 
2385
 
    def iter_inventories(self, revision_ids, ordering=None):
 
2072
    def iter_inventories(self, revision_ids):
2386
2073
        """Get many inventories by revision_ids.
2387
2074
 
2388
2075
        This will buffer some or all of the texts used in constructing the
2390
2077
        time.
2391
2078
 
2392
2079
        :param revision_ids: The expected revision ids of the inventories.
2393
 
        :param ordering: optional ordering, e.g. 'topological'.  If not
2394
 
            specified, the order of revision_ids will be preserved (by
2395
 
            buffering if necessary).
2396
2080
        :return: An iterator of inventories.
2397
2081
        """
2398
2082
        if ((None in revision_ids)
2399
2083
            or (_mod_revision.NULL_REVISION in revision_ids)):
2400
2084
            raise ValueError('cannot get null revision inventory')
2401
 
        return self._iter_inventories(revision_ids, ordering)
 
2085
        return self._iter_inventories(revision_ids)
2402
2086
 
2403
 
    def _iter_inventories(self, revision_ids, ordering):
 
2087
    def _iter_inventories(self, revision_ids):
2404
2088
        """single-document based inventory iteration."""
2405
 
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2406
 
        for text, revision_id in inv_xmls:
2407
 
            yield self._deserialise_inventory(revision_id, text)
 
2089
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
 
2090
            yield self.deserialise_inventory(revision_id, text)
2408
2091
 
2409
 
    def _iter_inventory_xmls(self, revision_ids, ordering):
2410
 
        if ordering is None:
2411
 
            order_as_requested = True
2412
 
            ordering = 'unordered'
2413
 
        else:
2414
 
            order_as_requested = False
 
2092
    def _iter_inventory_xmls(self, revision_ids):
2415
2093
        keys = [(revision_id,) for revision_id in revision_ids]
2416
 
        if not keys:
2417
 
            return
2418
 
        if order_as_requested:
2419
 
            key_iter = iter(keys)
2420
 
            next_key = key_iter.next()
2421
 
        stream = self.inventories.get_record_stream(keys, ordering, True)
 
2094
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2422
2095
        text_chunks = {}
2423
2096
        for record in stream:
2424
2097
            if record.storage_kind != 'absent':
2425
 
                chunks = record.get_bytes_as('chunked')
2426
 
                if order_as_requested:
2427
 
                    text_chunks[record.key] = chunks
2428
 
                else:
2429
 
                    yield ''.join(chunks), record.key[-1]
 
2098
                text_chunks[record.key] = record.get_bytes_as('chunked')
2430
2099
            else:
2431
2100
                raise errors.NoSuchRevision(self, record.key)
2432
 
            if order_as_requested:
2433
 
                # Yield as many results as we can while preserving order.
2434
 
                while next_key in text_chunks:
2435
 
                    chunks = text_chunks.pop(next_key)
2436
 
                    yield ''.join(chunks), next_key[-1]
2437
 
                    try:
2438
 
                        next_key = key_iter.next()
2439
 
                    except StopIteration:
2440
 
                        # We still want to fully consume the get_record_stream,
2441
 
                        # just in case it is not actually finished at this point
2442
 
                        next_key = None
2443
 
                        break
 
2101
        for key in keys:
 
2102
            chunks = text_chunks.pop(key)
 
2103
            yield ''.join(chunks), key[-1]
2444
2104
 
2445
 
    def _deserialise_inventory(self, revision_id, xml):
 
2105
    def deserialise_inventory(self, revision_id, xml):
2446
2106
        """Transform the xml into an inventory object.
2447
2107
 
2448
2108
        :param revision_id: The expected revision id of the inventory.
2449
2109
        :param xml: A serialised inventory.
2450
2110
        """
2451
2111
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2452
 
                    entry_cache=self._inventory_entry_cache,
2453
 
                    return_from_cache=self._safe_to_return_from_cache)
 
2112
                    entry_cache=self._inventory_entry_cache)
2454
2113
        if result.revision_id != revision_id:
2455
2114
            raise AssertionError('revision id mismatch %s != %s' % (
2456
2115
                result.revision_id, revision_id))
2457
2116
        return result
2458
2117
 
 
2118
    def serialise_inventory(self, inv):
 
2119
        return self._serializer.write_inventory_to_string(inv)
 
2120
 
 
2121
    def _serialise_inventory_to_lines(self, inv):
 
2122
        return self._serializer.write_inventory_to_lines(inv)
 
2123
 
2459
2124
    def get_serializer_format(self):
2460
2125
        return self._serializer.format_num
2461
2126
 
2462
2127
    @needs_read_lock
2463
 
    def _get_inventory_xml(self, revision_id):
2464
 
        """Get serialized inventory as a string."""
2465
 
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
 
2128
    def get_inventory_xml(self, revision_id):
 
2129
        """Get inventory XML as a file object."""
 
2130
        texts = self._iter_inventory_xmls([revision_id])
2466
2131
        try:
2467
2132
            text, revision_id = texts.next()
2468
2133
        except StopIteration:
2469
2134
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2470
2135
        return text
2471
2136
 
2472
 
    def get_rev_id_for_revno(self, revno, known_pair):
2473
 
        """Return the revision id of a revno, given a later (revno, revid)
2474
 
        pair in the same history.
2475
 
 
2476
 
        :return: if found (True, revid).  If the available history ran out
2477
 
            before reaching the revno, then this returns
2478
 
            (False, (closest_revno, closest_revid)).
 
2137
    @needs_read_lock
 
2138
    def get_inventory_sha1(self, revision_id):
 
2139
        """Return the sha1 hash of the inventory entry
2479
2140
        """
2480
 
        known_revno, known_revid = known_pair
2481
 
        partial_history = [known_revid]
2482
 
        distance_from_known = known_revno - revno
2483
 
        if distance_from_known < 0:
2484
 
            raise ValueError(
2485
 
                'requested revno (%d) is later than given known revno (%d)'
2486
 
                % (revno, known_revno))
2487
 
        try:
2488
 
            _iter_for_revno(
2489
 
                self, partial_history, stop_index=distance_from_known)
2490
 
        except errors.RevisionNotPresent, err:
2491
 
            if err.revision_id == known_revid:
2492
 
                # The start revision (known_revid) wasn't found.
2493
 
                raise
2494
 
            # This is a stacked repository with no fallbacks, or a there's a
2495
 
            # left-hand ghost.  Either way, even though the revision named in
2496
 
            # the error isn't in this repo, we know it's the next step in this
2497
 
            # left-hand history.
2498
 
            partial_history.append(err.revision_id)
2499
 
        if len(partial_history) <= distance_from_known:
2500
 
            # Didn't find enough history to get a revid for the revno.
2501
 
            earliest_revno = known_revno - len(partial_history) + 1
2502
 
            return (False, (earliest_revno, partial_history[-1]))
2503
 
        if len(partial_history) - 1 > distance_from_known:
2504
 
            raise AssertionError('_iter_for_revno returned too much history')
2505
 
        return (True, partial_history[-1])
 
2141
        return self.get_revision(revision_id).inventory_sha1
2506
2142
 
2507
2143
    def iter_reverse_revision_history(self, revision_id):
2508
2144
        """Iterate backwards through revision ids in the lefthand history
2511
2147
            ancestors will be traversed.
2512
2148
        """
2513
2149
        graph = self.get_graph()
2514
 
        stop_revisions = (None, _mod_revision.NULL_REVISION)
2515
 
        return graph.iter_lefthand_ancestry(revision_id, stop_revisions)
 
2150
        next_id = revision_id
 
2151
        while True:
 
2152
            if next_id in (None, _mod_revision.NULL_REVISION):
 
2153
                return
 
2154
            yield next_id
 
2155
            # Note: The following line may raise KeyError in the event of
 
2156
            # truncated history. We decided not to have a try:except:raise
 
2157
            # RevisionNotPresent here until we see a use for it, because of the
 
2158
            # cost in an inner loop that is by its very nature O(history).
 
2159
            # Robert Collins 20080326
 
2160
            parents = graph.get_parent_map([next_id])[next_id]
 
2161
            if len(parents) == 0:
 
2162
                return
 
2163
            else:
 
2164
                next_id = parents[0]
 
2165
 
 
2166
    @needs_read_lock
 
2167
    def get_revision_inventory(self, revision_id):
 
2168
        """Return inventory of a past revision."""
 
2169
        # TODO: Unify this with get_inventory()
 
2170
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
2171
        # must be the same as its revision, so this is trivial.
 
2172
        if revision_id is None:
 
2173
            # This does not make sense: if there is no revision,
 
2174
            # then it is the current tree inventory surely ?!
 
2175
            # and thus get_root_id() is something that looks at the last
 
2176
            # commit on the branch, and the get_root_id is an inventory check.
 
2177
            raise NotImplementedError
 
2178
            # return Inventory(self.get_root_id())
 
2179
        else:
 
2180
            return self.get_inventory(revision_id)
2516
2181
 
2517
2182
    def is_shared(self):
2518
2183
        """Return True if this repository is flagged as a shared repository."""
2553
2218
            return RevisionTree(self, Inventory(root_id=None),
2554
2219
                                _mod_revision.NULL_REVISION)
2555
2220
        else:
2556
 
            inv = self.get_inventory(revision_id)
 
2221
            inv = self.get_revision_inventory(revision_id)
2557
2222
            return RevisionTree(self, inv, revision_id)
2558
2223
 
2559
2224
    def revision_trees(self, revision_ids):
2612
2277
            keys = tsort.topo_sort(parent_map)
2613
2278
        return [None] + list(keys)
2614
2279
 
2615
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
2280
    def pack(self):
2616
2281
        """Compress the data within the repository.
2617
2282
 
2618
2283
        This operation only makes sense for some repository types. For other
2619
2284
        types it should be a no-op that just returns.
2620
2285
 
2621
2286
        This stub method does not require a lock, but subclasses should use
2622
 
        @needs_write_lock as this is a long running call it's reasonable to
 
2287
        @needs_write_lock as this is a long running call its reasonable to
2623
2288
        implicitly lock for the user.
2624
 
 
2625
 
        :param hint: If not supplied, the whole repository is packed.
2626
 
            If supplied, the repository may use the hint parameter as a
2627
 
            hint for the parts of the repository to pack. A hint can be
2628
 
            obtained from the result of commit_write_group(). Out of
2629
 
            date hints are simply ignored, because concurrent operations
2630
 
            can obsolete them rapidly.
2631
 
 
2632
 
        :param clean_obsolete_packs: Clean obsolete packs immediately after
2633
 
            the pack operation.
2634
2289
        """
2635
2290
 
2636
2291
    def get_transaction(self):
2637
2292
        return self.control_files.get_transaction()
2638
2293
 
2639
2294
    def get_parent_map(self, revision_ids):
2640
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
2295
        """See graph._StackedParentsProvider.get_parent_map"""
2641
2296
        # revisions index works in keys; this just works in revisions
2642
2297
        # therefore wrap and unwrap
2643
2298
        query_keys = []
2652
2307
        for ((revision_id,), parent_keys) in \
2653
2308
                self.revisions.get_parent_map(query_keys).iteritems():
2654
2309
            if parent_keys:
2655
 
                result[revision_id] = tuple([parent_revid
2656
 
                    for (parent_revid,) in parent_keys])
 
2310
                result[revision_id] = tuple(parent_revid
 
2311
                    for (parent_revid,) in parent_keys)
2657
2312
            else:
2658
2313
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2659
2314
        return result
2661
2316
    def _make_parents_provider(self):
2662
2317
        return self
2663
2318
 
2664
 
    @needs_read_lock
2665
 
    def get_known_graph_ancestry(self, revision_ids):
2666
 
        """Return the known graph for a set of revision ids and their ancestors.
2667
 
        """
2668
 
        st = static_tuple.StaticTuple
2669
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
2670
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
2671
 
        return graph.GraphThunkIdsToKeys(known_graph)
2672
 
 
2673
2319
    def get_graph(self, other_repository=None):
2674
2320
        """Return the graph walker for this repository format"""
2675
2321
        parents_provider = self._make_parents_provider()
2676
2322
        if (other_repository is not None and
2677
2323
            not self.has_same_location(other_repository)):
2678
 
            parents_provider = graph.StackedParentsProvider(
 
2324
            parents_provider = graph._StackedParentsProvider(
2679
2325
                [parents_provider, other_repository._make_parents_provider()])
2680
2326
        return graph.Graph(parents_provider)
2681
2327
 
2682
 
    def _get_versioned_file_checker(self, text_key_references=None,
2683
 
        ancestors=None):
 
2328
    def _get_versioned_file_checker(self, text_key_references=None):
2684
2329
        """Return an object suitable for checking versioned files.
2685
2330
        
2686
2331
        :param text_key_references: if non-None, an already built
2688
2333
            to whether they were referred to by the inventory of the
2689
2334
            revision_id that they contain. If None, this will be
2690
2335
            calculated.
2691
 
        :param ancestors: Optional result from
2692
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2693
 
            available.
2694
2336
        """
2695
2337
        return _VersionedFileChecker(self,
2696
 
            text_key_references=text_key_references, ancestors=ancestors)
 
2338
            text_key_references=text_key_references)
2697
2339
 
2698
2340
    def revision_ids_to_search_result(self, result_set):
2699
2341
        """Convert a set of revision ids to a graph SearchResult."""
2749
2391
        return record.get_bytes_as('fulltext')
2750
2392
 
2751
2393
    @needs_read_lock
2752
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
2394
    def check(self, revision_ids=None):
2753
2395
        """Check consistency of all history of given revision_ids.
2754
2396
 
2755
2397
        Different repository implementations should override _check().
2756
2398
 
2757
2399
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2758
2400
             will be checked.  Typically the last revision_id of a branch.
2759
 
        :param callback_refs: A dict of check-refs to resolve and callback
2760
 
            the check/_check method on the items listed as wanting the ref.
2761
 
            see bzrlib.check.
2762
 
        :param check_repo: If False do not check the repository contents, just 
2763
 
            calculate the data callback_refs requires and call them back.
2764
2401
        """
2765
 
        return self._check(revision_ids, callback_refs=callback_refs,
2766
 
            check_repo=check_repo)
 
2402
        return self._check(revision_ids)
2767
2403
 
2768
 
    def _check(self, revision_ids, callback_refs, check_repo):
2769
 
        result = check.Check(self, check_repo=check_repo)
2770
 
        result.check(callback_refs)
 
2404
    def _check(self, revision_ids):
 
2405
        result = check.Check(self)
 
2406
        result.check()
2771
2407
        return result
2772
2408
 
2773
 
    def _warn_if_deprecated(self, branch=None):
 
2409
    def _warn_if_deprecated(self):
2774
2410
        global _deprecation_warning_done
2775
2411
        if _deprecation_warning_done:
2776
2412
            return
2777
 
        try:
2778
 
            if branch is None:
2779
 
                conf = config.GlobalConfig()
2780
 
            else:
2781
 
                conf = branch.get_config()
2782
 
            if conf.suppress_warning('format_deprecation'):
2783
 
                return
2784
 
            warning("Format %s for %s is deprecated -"
2785
 
                    " please use 'bzr upgrade' to get better performance"
2786
 
                    % (self._format, self.bzrdir.transport.base))
2787
 
        finally:
2788
 
            _deprecation_warning_done = True
 
2413
        _deprecation_warning_done = True
 
2414
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
2415
                % (self._format, self.bzrdir.transport.base))
2789
2416
 
2790
2417
    def supports_rich_root(self):
2791
2418
        return self._format.rich_root_data
2865
2492
    """
2866
2493
    repository.start_write_group()
2867
2494
    try:
2868
 
        inventory_cache = lru_cache.LRUCache(10)
2869
2495
        for n, (revision, revision_tree, signature) in enumerate(iterable):
2870
 
            _install_revision(repository, revision, revision_tree, signature,
2871
 
                inventory_cache)
 
2496
            _install_revision(repository, revision, revision_tree, signature)
2872
2497
            if pb is not None:
2873
2498
                pb.update('Transferring revisions', n + 1, num_revisions)
2874
2499
    except:
2878
2503
        repository.commit_write_group()
2879
2504
 
2880
2505
 
2881
 
def _install_revision(repository, rev, revision_tree, signature,
2882
 
    inventory_cache):
 
2506
def _install_revision(repository, rev, revision_tree, signature):
2883
2507
    """Install all revision data into a repository."""
2884
2508
    present_parents = []
2885
2509
    parent_trees = {}
2922
2546
        repository.texts.add_lines(text_key, text_parents, lines)
2923
2547
    try:
2924
2548
        # install the inventory
2925
 
        if repository._format._commit_inv_deltas and len(rev.parent_ids):
2926
 
            # Cache this inventory
2927
 
            inventory_cache[rev.revision_id] = inv
2928
 
            try:
2929
 
                basis_inv = inventory_cache[rev.parent_ids[0]]
2930
 
            except KeyError:
2931
 
                repository.add_inventory(rev.revision_id, inv, present_parents)
2932
 
            else:
2933
 
                delta = inv._make_delta(basis_inv)
2934
 
                repository.add_inventory_by_delta(rev.parent_ids[0], delta,
2935
 
                    rev.revision_id, present_parents)
2936
 
        else:
2937
 
            repository.add_inventory(rev.revision_id, inv, present_parents)
 
2549
        repository.add_inventory(rev.revision_id, inv, present_parents)
2938
2550
    except errors.RevisionAlreadyPresent:
2939
2551
        pass
2940
2552
    if signature is not None:
3031
2643
 
3032
2644
    Once a format is deprecated, just deprecate the initialize and open
3033
2645
    methods on the format class. Do not deprecate the object, as the
3034
 
    object may be created even when a repository instance hasn't been
 
2646
    object may be created even when a repository instnace hasn't been
3035
2647
    created.
3036
2648
 
3037
2649
    Common instance attributes:
3047
2659
    # Can this repository be given external locations to lookup additional
3048
2660
    # data. Set to True or False in derived classes.
3049
2661
    supports_external_lookups = None
3050
 
    # Does this format support CHK bytestring lookups. Set to True or False in
3051
 
    # derived classes.
3052
 
    supports_chks = None
3053
 
    # Should commit add an inventory, or an inventory delta to the repository.
3054
 
    _commit_inv_deltas = True
3055
2662
    # What order should fetch operations request streams in?
3056
2663
    # The default is unordered as that is the cheapest for an origin to
3057
2664
    # provide.
3067
2674
    # Does this format have < O(tree_size) delta generation. Used to hint what
3068
2675
    # code path for commit, amongst other things.
3069
2676
    fast_deltas = None
3070
 
    # Does doing a pack operation compress data? Useful for the pack UI command
3071
 
    # (so if there is one pack, the operation can still proceed because it may
3072
 
    # help), and for fetching when data won't have come from the same
3073
 
    # compressor.
3074
 
    pack_compresses = False
3075
 
    # Does the repository inventory storage understand references to trees?
3076
 
    supports_tree_reference = None
3077
 
    # Is the format experimental ?
3078
 
    experimental = False
3079
2677
 
3080
 
    def __repr__(self):
3081
 
        return "%s()" % self.__class__.__name__
 
2678
    def __str__(self):
 
2679
        return "<%s>" % self.__class__.__name__
3082
2680
 
3083
2681
    def __eq__(self, other):
3084
2682
        # format objects are generally stateless
3097
2695
        """
3098
2696
        try:
3099
2697
            transport = a_bzrdir.get_repository_transport(None)
3100
 
            format_string = transport.get_bytes("format")
 
2698
            format_string = transport.get("format").read()
3101
2699
            return format_registry.get(format_string)
3102
2700
        except errors.NoSuchFile:
3103
2701
            raise errors.NoRepositoryPresent(a_bzrdir)
3185
2783
        raise NotImplementedError(self.network_name)
3186
2784
 
3187
2785
    def check_conversion_target(self, target_format):
3188
 
        if self.rich_root_data and not target_format.rich_root_data:
3189
 
            raise errors.BadConversionTarget(
3190
 
                'Does not support rich root data.', target_format,
3191
 
                from_format=self)
3192
 
        if (self.supports_tree_reference and 
3193
 
            not getattr(target_format, 'supports_tree_reference', False)):
3194
 
            raise errors.BadConversionTarget(
3195
 
                'Does not support nested trees', target_format,
3196
 
                from_format=self)
 
2786
        raise NotImplementedError(self.check_conversion_target)
3197
2787
 
3198
2788
    def open(self, a_bzrdir, _found=False):
3199
2789
        """Return an instance of this format for the bzrdir a_bzrdir.
3202
2792
        """
3203
2793
        raise NotImplementedError(self.open)
3204
2794
 
3205
 
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
3206
 
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
3207
 
        hooks = BzrDir.hooks['post_repo_init']
3208
 
        if not hooks:
3209
 
            return
3210
 
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
3211
 
        for hook in hooks:
3212
 
            hook(params)
3213
 
 
3214
2795
 
3215
2796
class MetaDirRepositoryFormat(RepositoryFormat):
3216
2797
    """Common base class for the new repositories using the metadir layout."""
3264
2845
# Pre-0.8 formats that don't have a disk format string (because they are
3265
2846
# versioned by the matching control directory). We use the control directories
3266
2847
# disk format string as a key for the network_name because they meet the
3267
 
# constraints (simple string, unique, immutable).
 
2848
# constraints (simple string, unique, immmutable).
3268
2849
network_format_registry.register_lazy(
3269
2850
    "Bazaar-NG branch, format 5\n",
3270
2851
    'bzrlib.repofmt.weaverepo',
3351
2932
    )
3352
2933
 
3353
2934
# Development formats.
3354
 
# Obsolete but kept pending a CHK based subtree format.
 
2935
# 1.7->1.8 go below here
 
2936
format_registry.register_lazy(
 
2937
    "Bazaar development format 2 (needs bzr.dev from before 1.8)\n",
 
2938
    'bzrlib.repofmt.pack_repo',
 
2939
    'RepositoryFormatPackDevelopment2',
 
2940
    )
3355
2941
format_registry.register_lazy(
3356
2942
    ("Bazaar development format 2 with subtree support "
3357
2943
        "(needs bzr.dev from before 1.8)\n"),
3359
2945
    'RepositoryFormatPackDevelopment2Subtree',
3360
2946
    )
3361
2947
 
3362
 
# 1.14->1.16 go below here
3363
 
format_registry.register_lazy(
3364
 
    'Bazaar development format - group compression and chk inventory'
3365
 
        ' (needs bzr.dev from 1.14)\n',
3366
 
    'bzrlib.repofmt.groupcompress_repo',
3367
 
    'RepositoryFormatCHK1',
3368
 
    )
3369
 
 
3370
 
format_registry.register_lazy(
3371
 
    'Bazaar development format - chk repository with bencode revision '
3372
 
        'serialization (needs bzr.dev from 1.16)\n',
3373
 
    'bzrlib.repofmt.groupcompress_repo',
3374
 
    'RepositoryFormatCHK2',
3375
 
    )
3376
 
format_registry.register_lazy(
3377
 
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
3378
 
    'bzrlib.repofmt.groupcompress_repo',
3379
 
    'RepositoryFormat2a',
3380
 
    )
3381
 
format_registry.register_lazy(
3382
 
    'Bazaar development format 8\n',
3383
 
    'bzrlib.repofmt.groupcompress_repo',
3384
 
    'RepositoryFormat2aSubtree',
3385
 
    )
3386
 
 
3387
2948
 
3388
2949
class InterRepository(InterObject):
3389
2950
    """This class represents operations taking place between two repositories.
3426
2987
 
3427
2988
        :param revision_id: if None all content is copied, if NULL_REVISION no
3428
2989
                            content is copied.
3429
 
        :param pb: ignored.
 
2990
        :param pb: optional progress bar to use for progress reports. If not
 
2991
                   provided a default one will be created.
3430
2992
        :return: None.
3431
2993
        """
3432
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3433
2994
        from bzrlib.fetch import RepoFetcher
3434
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
3435
 
        if self.source._format.network_name() != self.target._format.network_name():
3436
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
3437
 
                from_format=self.source._format,
3438
 
                to_format=self.target._format)
3439
2995
        f = RepoFetcher(to_repository=self.target,
3440
2996
                               from_repository=self.source,
3441
2997
                               last_revision=revision_id,
3442
2998
                               fetch_spec=fetch_spec,
3443
 
                               find_ghosts=find_ghosts)
 
2999
                               pb=pb, find_ghosts=find_ghosts)
3444
3000
 
3445
3001
    def _walk_to_common_revisions(self, revision_ids):
3446
3002
        """Walk out from revision_ids in source to revisions target has.
3450
3006
        """
3451
3007
        target_graph = self.target.get_graph()
3452
3008
        revision_ids = frozenset(revision_ids)
 
3009
        # Fast path for the case where all the revisions are already in the
 
3010
        # target repo.
 
3011
        # (Although this does incur an extra round trip for the
 
3012
        # fairly common case where the target doesn't already have the revision
 
3013
        # we're pushing.)
 
3014
        if set(target_graph.get_parent_map(revision_ids)) == revision_ids:
 
3015
            return graph.SearchResult(revision_ids, set(), 0, set())
3453
3016
        missing_revs = set()
3454
3017
        source_graph = self.source.get_graph()
3455
3018
        # ensure we don't pay silly lookup costs.
3615
3178
                self.target.texts.insert_record_stream(
3616
3179
                    self.source.texts.get_record_stream(
3617
3180
                        self.source.texts.keys(), 'topological', False))
3618
 
                pb.update('Copying inventory', 0, 1)
 
3181
                pb.update('copying inventory', 0, 1)
3619
3182
                self.target.inventories.insert_record_stream(
3620
3183
                    self.source.inventories.get_record_stream(
3621
3184
                        self.source.inventories.keys(), 'topological', False))
3642
3205
        # so the first thing is to get a subset of the revisions to
3643
3206
        # satisfy revision_id in source, and then eliminate those that
3644
3207
        # we do already have.
3645
 
        # this is slow on high latency connection to self, but as this
 
3208
        # this is slow on high latency connection to self, but as as this
3646
3209
        # disk format scales terribly for push anyway due to rewriting
3647
3210
        # inventory.weave, this is considered acceptable.
3648
3211
        # - RBC 20060209
3735
3298
        return self.source.revision_ids_to_search_result(result_set)
3736
3299
 
3737
3300
 
3738
 
class InterDifferingSerializer(InterRepository):
 
3301
class InterPackRepo(InterSameDataRepository):
 
3302
    """Optimised code paths between Pack based repositories."""
 
3303
 
 
3304
    @classmethod
 
3305
    def _get_repo_format_to_test(self):
 
3306
        from bzrlib.repofmt import pack_repo
 
3307
        return pack_repo.RepositoryFormatKnitPack1()
 
3308
 
 
3309
    @staticmethod
 
3310
    def is_compatible(source, target):
 
3311
        """Be compatible with known Pack formats.
 
3312
 
 
3313
        We don't test for the stores being of specific types because that
 
3314
        could lead to confusing results, and there is no need to be
 
3315
        overly general.
 
3316
        """
 
3317
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
3318
        try:
 
3319
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
3320
                isinstance(target._format, RepositoryFormatPack))
 
3321
        except AttributeError:
 
3322
            return False
 
3323
        return are_packs and InterRepository._same_model(source, target)
 
3324
 
 
3325
    @needs_write_lock
 
3326
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
 
3327
            fetch_spec=None):
 
3328
        """See InterRepository.fetch()."""
 
3329
        if (len(self.source._fallback_repositories) > 0 or
 
3330
            len(self.target._fallback_repositories) > 0):
 
3331
            # The pack layer is not aware of fallback repositories, so when
 
3332
            # fetching from a stacked repository or into a stacked repository
 
3333
            # we use the generic fetch logic which uses the VersionedFiles
 
3334
            # attributes on repository.
 
3335
            from bzrlib.fetch import RepoFetcher
 
3336
            fetcher = RepoFetcher(self.target, self.source, revision_id,
 
3337
                    pb, find_ghosts, fetch_spec=fetch_spec)
 
3338
        if fetch_spec is not None:
 
3339
            if len(list(fetch_spec.heads)) != 1:
 
3340
                raise AssertionError(
 
3341
                    "InterPackRepo.fetch doesn't support "
 
3342
                    "fetching multiple heads yet.")
 
3343
            revision_id = list(fetch_spec.heads)[0]
 
3344
            fetch_spec = None
 
3345
        if revision_id is None:
 
3346
            # TODO:
 
3347
            # everything to do - use pack logic
 
3348
            # to fetch from all packs to one without
 
3349
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
3350
            # till then:
 
3351
            source_revision_ids = frozenset(self.source.all_revision_ids())
 
3352
            revision_ids = source_revision_ids - \
 
3353
                frozenset(self.target.get_parent_map(source_revision_ids))
 
3354
            revision_keys = [(revid,) for revid in revision_ids]
 
3355
            index = self.target._pack_collection.revision_index.combined_index
 
3356
            present_revision_ids = set(item[1][0] for item in
 
3357
                index.iter_entries(revision_keys))
 
3358
            revision_ids = set(revision_ids) - present_revision_ids
 
3359
            # implementing the TODO will involve:
 
3360
            # - detecting when all of a pack is selected
 
3361
            # - avoiding as much as possible pre-selection, so the
 
3362
            # more-core routines such as create_pack_from_packs can filter in
 
3363
            # a just-in-time fashion. (though having a HEADS list on a
 
3364
            # repository might make this a lot easier, because we could
 
3365
            # sensibly detect 'new revisions' without doing a full index scan.
 
3366
        elif _mod_revision.is_null(revision_id):
 
3367
            # nothing to do:
 
3368
            return (0, [])
 
3369
        else:
 
3370
            try:
 
3371
                revision_ids = self.search_missing_revision_ids(revision_id,
 
3372
                    find_ghosts=find_ghosts).get_keys()
 
3373
            except errors.NoSuchRevision:
 
3374
                raise errors.InstallFailed([revision_id])
 
3375
            if len(revision_ids) == 0:
 
3376
                return (0, [])
 
3377
        return self._pack(self.source, self.target, revision_ids)
 
3378
 
 
3379
    def _pack(self, source, target, revision_ids):
 
3380
        from bzrlib.repofmt.pack_repo import Packer
 
3381
        packs = source._pack_collection.all_packs()
 
3382
        pack = Packer(self.target._pack_collection, packs, '.fetch',
 
3383
            revision_ids).pack()
 
3384
        if pack is not None:
 
3385
            self.target._pack_collection._save_pack_names()
 
3386
            copied_revs = pack.get_revision_count()
 
3387
            # Trigger an autopack. This may duplicate effort as we've just done
 
3388
            # a pack creation, but for now it is simpler to think about as
 
3389
            # 'upload data, then repack if needed'.
 
3390
            self.target._pack_collection.autopack()
 
3391
            return (copied_revs, [])
 
3392
        else:
 
3393
            return (0, [])
 
3394
 
 
3395
    @needs_read_lock
 
3396
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
3397
        """See InterRepository.missing_revision_ids().
 
3398
 
 
3399
        :param find_ghosts: Find ghosts throughout the ancestry of
 
3400
            revision_id.
 
3401
        """
 
3402
        if not find_ghosts and revision_id is not None:
 
3403
            return self._walk_to_common_revisions([revision_id])
 
3404
        elif revision_id is not None:
 
3405
            # Find ghosts: search for revisions pointing from one repository to
 
3406
            # the other, and vice versa, anywhere in the history of revision_id.
 
3407
            graph = self.target.get_graph(other_repository=self.source)
 
3408
            searcher = graph._make_breadth_first_searcher([revision_id])
 
3409
            found_ids = set()
 
3410
            while True:
 
3411
                try:
 
3412
                    next_revs, ghosts = searcher.next_with_ghosts()
 
3413
                except StopIteration:
 
3414
                    break
 
3415
                if revision_id in ghosts:
 
3416
                    raise errors.NoSuchRevision(self.source, revision_id)
 
3417
                found_ids.update(next_revs)
 
3418
                found_ids.update(ghosts)
 
3419
            found_ids = frozenset(found_ids)
 
3420
            # Double query here: should be able to avoid this by changing the
 
3421
            # graph api further.
 
3422
            result_set = found_ids - frozenset(
 
3423
                self.target.get_parent_map(found_ids))
 
3424
        else:
 
3425
            source_ids = self.source.all_revision_ids()
 
3426
            # source_ids is the worst possible case we may need to pull.
 
3427
            # now we want to filter source_ids against what we actually
 
3428
            # have in target, but don't try to check for existence where we know
 
3429
            # we do not have a revision as that would be pointless.
 
3430
            target_ids = set(self.target.all_revision_ids())
 
3431
            result_set = set(source_ids).difference(target_ids)
 
3432
        return self.source.revision_ids_to_search_result(result_set)
 
3433
 
 
3434
 
 
3435
class InterDifferingSerializer(InterKnitRepo):
3739
3436
 
3740
3437
    @classmethod
3741
3438
    def _get_repo_format_to_test(self):
3744
3441
    @staticmethod
3745
3442
    def is_compatible(source, target):
3746
3443
        """Be compatible with Knit2 source and Knit3 target"""
3747
 
        # This is redundant with format.check_conversion_target(), however that
3748
 
        # raises an exception, and we just want to say "False" as in we won't
3749
 
        # support converting between these formats.
3750
 
        if 'IDS_never' in debug.debug_flags:
3751
 
            return False
3752
 
        if source.supports_rich_root() and not target.supports_rich_root():
3753
 
            return False
3754
 
        if (source._format.supports_tree_reference
3755
 
            and not target._format.supports_tree_reference):
3756
 
            return False
3757
 
        if target._fallback_repositories and target._format.supports_chks:
3758
 
            # IDS doesn't know how to copy CHKs for the parent inventories it
3759
 
            # adds to stacked repos.
3760
 
            return False
3761
 
        if 'IDS_always' in debug.debug_flags:
3762
 
            return True
3763
 
        # Only use this code path for local source and target.  IDS does far
3764
 
        # too much IO (both bandwidth and roundtrips) over a network.
3765
 
        if not source.bzrdir.transport.base.startswith('file:///'):
3766
 
            return False
3767
 
        if not target.bzrdir.transport.base.startswith('file:///'):
 
3444
        if source.supports_rich_root() != target.supports_rich_root():
 
3445
            return False
 
3446
        # Ideally, we'd support fetching if the source had no tree references
 
3447
        # even if it supported them...
 
3448
        if (getattr(source, '_format.supports_tree_reference', False) and
 
3449
            not getattr(target, '_format.supports_tree_reference', False)):
3768
3450
            return False
3769
3451
        return True
3770
3452
 
3771
 
    def _get_trees(self, revision_ids, cache):
3772
 
        possible_trees = []
3773
 
        for rev_id in revision_ids:
3774
 
            if rev_id in cache:
3775
 
                possible_trees.append((rev_id, cache[rev_id]))
3776
 
            else:
3777
 
                # Not cached, but inventory might be present anyway.
3778
 
                try:
3779
 
                    tree = self.source.revision_tree(rev_id)
3780
 
                except errors.NoSuchRevision:
3781
 
                    # Nope, parent is ghost.
3782
 
                    pass
3783
 
                else:
3784
 
                    cache[rev_id] = tree
3785
 
                    possible_trees.append((rev_id, tree))
3786
 
        return possible_trees
3787
 
 
3788
 
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
 
3453
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
3789
3454
        """Get the best delta and base for this revision.
3790
3455
 
3791
3456
        :return: (basis_id, delta)
3792
3457
        """
 
3458
        possible_trees = [(parent_id, cache[parent_id])
 
3459
                          for parent_id in parent_ids
 
3460
                           if parent_id in cache]
 
3461
        if len(possible_trees) == 0:
 
3462
            # There either aren't any parents, or the parents aren't in the
 
3463
            # cache, so just use the last converted tree
 
3464
            possible_trees.append((basis_id, cache[basis_id]))
3793
3465
        deltas = []
3794
 
        # Generate deltas against each tree, to find the shortest.
3795
 
        texts_possibly_new_in_tree = set()
3796
3466
        for basis_id, basis_tree in possible_trees:
3797
3467
            delta = tree.inventory._make_delta(basis_tree.inventory)
3798
 
            for old_path, new_path, file_id, new_entry in delta:
3799
 
                if new_path is None:
3800
 
                    # This file_id isn't present in the new rev, so we don't
3801
 
                    # care about it.
3802
 
                    continue
3803
 
                if not new_path:
3804
 
                    # Rich roots are handled elsewhere...
3805
 
                    continue
3806
 
                kind = new_entry.kind
3807
 
                if kind != 'directory' and kind != 'file':
3808
 
                    # No text record associated with this inventory entry.
3809
 
                    continue
3810
 
                # This is a directory or file that has changed somehow.
3811
 
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3812
3468
            deltas.append((len(delta), basis_id, delta))
3813
3469
        deltas.sort()
3814
3470
        return deltas[0][1:]
3815
3471
 
3816
 
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
3817
 
        """Find all parent revisions that are absent, but for which the
3818
 
        inventory is present, and copy those inventories.
3819
 
 
3820
 
        This is necessary to preserve correctness when the source is stacked
3821
 
        without fallbacks configured.  (Note that in cases like upgrade the
3822
 
        source may be not have _fallback_repositories even though it is
3823
 
        stacked.)
3824
 
        """
3825
 
        parent_revs = set()
3826
 
        for parents in parent_map.values():
3827
 
            parent_revs.update(parents)
3828
 
        present_parents = self.source.get_parent_map(parent_revs)
3829
 
        absent_parents = set(parent_revs).difference(present_parents)
3830
 
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
3831
 
            (rev_id,) for rev_id in absent_parents)
3832
 
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
3833
 
        for parent_tree in self.source.revision_trees(parent_inv_ids):
3834
 
            current_revision_id = parent_tree.get_revision_id()
3835
 
            parents_parents_keys = parent_invs_keys_for_stacking[
3836
 
                (current_revision_id,)]
3837
 
            parents_parents = [key[-1] for key in parents_parents_keys]
3838
 
            basis_id = _mod_revision.NULL_REVISION
3839
 
            basis_tree = self.source.revision_tree(basis_id)
3840
 
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
3841
 
            self.target.add_inventory_by_delta(
3842
 
                basis_id, delta, current_revision_id, parents_parents)
3843
 
            cache[current_revision_id] = parent_tree
3844
 
 
3845
3472
    def _fetch_batch(self, revision_ids, basis_id, cache):
3846
3473
        """Fetch across a few revisions.
3847
3474
 
3855
3482
        # Walk though all revisions; get inventory deltas, copy referenced
3856
3483
        # texts that delta references, insert the delta, revision and
3857
3484
        # signature.
3858
 
        root_keys_to_create = set()
3859
3485
        text_keys = set()
3860
3486
        pending_deltas = []
3861
3487
        pending_revisions = []
3862
3488
        parent_map = self.source.get_parent_map(revision_ids)
3863
 
        self._fetch_parent_invs_for_stacking(parent_map, cache)
3864
 
        self.source._safe_to_return_from_cache = True
3865
3489
        for tree in self.source.revision_trees(revision_ids):
3866
 
            # Find a inventory delta for this revision.
3867
 
            # Find text entries that need to be copied, too.
3868
3490
            current_revision_id = tree.get_revision_id()
3869
3491
            parent_ids = parent_map.get(current_revision_id, ())
3870
 
            parent_trees = self._get_trees(parent_ids, cache)
3871
 
            possible_trees = list(parent_trees)
3872
 
            if len(possible_trees) == 0:
3873
 
                # There either aren't any parents, or the parents are ghosts,
3874
 
                # so just use the last converted tree.
3875
 
                possible_trees.append((basis_id, cache[basis_id]))
3876
3492
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3877
 
                                                           possible_trees)
 
3493
                                                           basis_id, cache)
 
3494
            # Find text entries that need to be copied
 
3495
            for old_path, new_path, file_id, entry in delta:
 
3496
                if new_path is not None:
 
3497
                    if not (new_path or self.target.supports_rich_root()):
 
3498
                        # We don't copy the text for the root node unless the
 
3499
                        # target supports_rich_root.
 
3500
                        continue
 
3501
                    text_keys.add((file_id, entry.revision))
3878
3502
            revision = self.source.get_revision(current_revision_id)
3879
3503
            pending_deltas.append((basis_id, delta,
3880
3504
                current_revision_id, revision.parent_ids))
3881
 
            if self._converting_to_rich_root:
3882
 
                self._revision_id_to_root_id[current_revision_id] = \
3883
 
                    tree.get_root_id()
3884
 
            # Determine which texts are in present in this revision but not in
3885
 
            # any of the available parents.
3886
 
            texts_possibly_new_in_tree = set()
3887
 
            for old_path, new_path, file_id, entry in delta:
3888
 
                if new_path is None:
3889
 
                    # This file_id isn't present in the new rev
3890
 
                    continue
3891
 
                if not new_path:
3892
 
                    # This is the root
3893
 
                    if not self.target.supports_rich_root():
3894
 
                        # The target doesn't support rich root, so we don't
3895
 
                        # copy
3896
 
                        continue
3897
 
                    if self._converting_to_rich_root:
3898
 
                        # This can't be copied normally, we have to insert
3899
 
                        # it specially
3900
 
                        root_keys_to_create.add((file_id, entry.revision))
3901
 
                        continue
3902
 
                kind = entry.kind
3903
 
                texts_possibly_new_in_tree.add((file_id, entry.revision))
3904
 
            for basis_id, basis_tree in possible_trees:
3905
 
                basis_inv = basis_tree.inventory
3906
 
                for file_key in list(texts_possibly_new_in_tree):
3907
 
                    file_id, file_revision = file_key
3908
 
                    try:
3909
 
                        entry = basis_inv[file_id]
3910
 
                    except errors.NoSuchId:
3911
 
                        continue
3912
 
                    if entry.revision == file_revision:
3913
 
                        texts_possibly_new_in_tree.remove(file_key)
3914
 
            text_keys.update(texts_possibly_new_in_tree)
3915
3505
            pending_revisions.append(revision)
3916
3506
            cache[current_revision_id] = tree
3917
3507
            basis_id = current_revision_id
3918
 
        self.source._safe_to_return_from_cache = False
3919
3508
        # Copy file texts
3920
3509
        from_texts = self.source.texts
3921
3510
        to_texts = self.target.texts
3922
 
        if root_keys_to_create:
3923
 
            root_stream = _mod_fetch._new_root_data_stream(
3924
 
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
3925
 
                self.source)
3926
 
            to_texts.insert_record_stream(root_stream)
3927
3511
        to_texts.insert_record_stream(from_texts.get_record_stream(
3928
3512
            text_keys, self.target._format._fetch_order,
3929
3513
            not self.target._format._fetch_uses_deltas))
3930
 
        # insert inventory deltas
 
3514
        # insert deltas
3931
3515
        for delta in pending_deltas:
3932
3516
            self.target.add_inventory_by_delta(*delta)
3933
 
        if self.target._fallback_repositories:
3934
 
            # Make sure this stacked repository has all the parent inventories
3935
 
            # for the new revisions that we are about to insert.  We do this
3936
 
            # before adding the revisions so that no revision is added until
3937
 
            # all the inventories it may depend on are added.
3938
 
            # Note that this is overzealous, as we may have fetched these in an
3939
 
            # earlier batch.
3940
 
            parent_ids = set()
3941
 
            revision_ids = set()
3942
 
            for revision in pending_revisions:
3943
 
                revision_ids.add(revision.revision_id)
3944
 
                parent_ids.update(revision.parent_ids)
3945
 
            parent_ids.difference_update(revision_ids)
3946
 
            parent_ids.discard(_mod_revision.NULL_REVISION)
3947
 
            parent_map = self.source.get_parent_map(parent_ids)
3948
 
            # we iterate over parent_map and not parent_ids because we don't
3949
 
            # want to try copying any revision which is a ghost
3950
 
            for parent_tree in self.source.revision_trees(parent_map):
3951
 
                current_revision_id = parent_tree.get_revision_id()
3952
 
                parents_parents = parent_map[current_revision_id]
3953
 
                possible_trees = self._get_trees(parents_parents, cache)
3954
 
                if len(possible_trees) == 0:
3955
 
                    # There either aren't any parents, or the parents are
3956
 
                    # ghosts, so just use the last converted tree.
3957
 
                    possible_trees.append((basis_id, cache[basis_id]))
3958
 
                basis_id, delta = self._get_delta_for_revision(parent_tree,
3959
 
                    parents_parents, possible_trees)
3960
 
                self.target.add_inventory_by_delta(
3961
 
                    basis_id, delta, current_revision_id, parents_parents)
3962
3517
        # insert signatures and revisions
3963
3518
        for revision in pending_revisions:
3964
3519
            try:
3976
3531
 
3977
3532
        :param revision_ids: The list of revisions to fetch. Must be in
3978
3533
            topological order.
3979
 
        :param pb: A ProgressTask
 
3534
        :param pb: A ProgressBar
3980
3535
        :return: None
3981
3536
        """
3982
3537
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3984
3539
        cache = lru_cache.LRUCache(100)
3985
3540
        cache[basis_id] = basis_tree
3986
3541
        del basis_tree # We don't want to hang on to it here
3987
 
        hints = []
3988
 
        a_graph = None
3989
 
 
3990
3542
        for offset in range(0, len(revision_ids), batch_size):
3991
3543
            self.target.start_write_group()
3992
3544
            try:
3995
3547
                batch = revision_ids[offset:offset+batch_size]
3996
3548
                basis_id = self._fetch_batch(batch, basis_id, cache)
3997
3549
            except:
3998
 
                self.source._safe_to_return_from_cache = False
3999
3550
                self.target.abort_write_group()
4000
3551
                raise
4001
3552
            else:
4002
 
                hint = self.target.commit_write_group()
4003
 
                if hint:
4004
 
                    hints.extend(hint)
4005
 
        if hints and self.target._format.pack_compresses:
4006
 
            self.target.pack(hint=hints)
 
3553
                self.target.commit_write_group()
4007
3554
        pb.update('Transferring revisions', len(revision_ids),
4008
3555
                  len(revision_ids))
4009
3556
 
4013
3560
        """See InterRepository.fetch()."""
4014
3561
        if fetch_spec is not None:
4015
3562
            raise AssertionError("Not implemented yet...")
4016
 
        ui.ui_factory.warn_experimental_format_fetch(self)
4017
 
        if (not self.source.supports_rich_root()
4018
 
            and self.target.supports_rich_root()):
4019
 
            self._converting_to_rich_root = True
4020
 
            self._revision_id_to_root_id = {}
4021
 
        else:
4022
 
            self._converting_to_rich_root = False
4023
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
4024
 
        if self.source._format.network_name() != self.target._format.network_name():
4025
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
4026
 
                from_format=self.source._format,
4027
 
                to_format=self.target._format)
4028
3563
        revision_ids = self.target.search_missing_revision_ids(self.source,
4029
3564
            revision_id, find_ghosts=find_ghosts).get_keys()
4030
3565
        if not revision_ids:
4031
3566
            return 0, 0
4032
3567
        revision_ids = tsort.topo_sort(
4033
3568
            self.source.get_graph().get_parent_map(revision_ids))
4034
 
        if not revision_ids:
4035
 
            return 0, 0
4036
 
        # Walk though all revisions; get inventory deltas, copy referenced
4037
 
        # texts that delta references, insert the delta, revision and
4038
 
        # signature.
4039
3569
        if pb is None:
4040
3570
            my_pb = ui.ui_factory.nested_progress_bar()
4041
3571
            pb = my_pb
4065
3595
            basis_id = first_rev.parent_ids[0]
4066
3596
            # only valid as a basis if the target has it
4067
3597
            self.target.get_revision(basis_id)
4068
 
            # Try to get a basis tree - if it's a ghost it will hit the
 
3598
            # Try to get a basis tree - if its a ghost it will hit the
4069
3599
            # NoSuchRevision case.
4070
3600
            basis_tree = self.source.revision_tree(basis_id)
4071
3601
        except (IndexError, errors.NoSuchRevision):
4078
3608
InterRepository.register_optimiser(InterSameDataRepository)
4079
3609
InterRepository.register_optimiser(InterWeaveRepo)
4080
3610
InterRepository.register_optimiser(InterKnitRepo)
 
3611
InterRepository.register_optimiser(InterPackRepo)
4081
3612
 
4082
3613
 
4083
3614
class CopyConverter(object):
4099
3630
        :param to_convert: The disk object to convert.
4100
3631
        :param pb: a progress bar to use for progress information.
4101
3632
        """
4102
 
        pb = ui.ui_factory.nested_progress_bar()
 
3633
        self.pb = pb
4103
3634
        self.count = 0
4104
3635
        self.total = 4
4105
3636
        # this is only useful with metadir layouts - separated repo content.
4106
3637
        # trigger an assertion if not such
4107
3638
        repo._format.get_format_string()
4108
3639
        self.repo_dir = repo.bzrdir
4109
 
        pb.update('Moving repository to repository.backup')
 
3640
        self.step('Moving repository to repository.backup')
4110
3641
        self.repo_dir.transport.move('repository', 'repository.backup')
4111
3642
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4112
3643
        repo._format.check_conversion_target(self.target_format)
4113
3644
        self.source_repo = repo._format.open(self.repo_dir,
4114
3645
            _found=True,
4115
3646
            _override_transport=backup_transport)
4116
 
        pb.update('Creating new repository')
 
3647
        self.step('Creating new repository')
4117
3648
        converted = self.target_format.initialize(self.repo_dir,
4118
3649
                                                  self.source_repo.is_shared())
4119
3650
        converted.lock_write()
4120
3651
        try:
4121
 
            pb.update('Copying content')
 
3652
            self.step('Copying content into repository.')
4122
3653
            self.source_repo.copy_content_into(converted)
4123
3654
        finally:
4124
3655
            converted.unlock()
4125
 
        pb.update('Deleting old repository content')
 
3656
        self.step('Deleting old repository content.')
4126
3657
        self.repo_dir.transport.delete_tree('repository.backup')
4127
 
        ui.ui_factory.note('repository converted')
4128
 
        pb.finished()
 
3658
        self.pb.note('repository converted')
 
3659
 
 
3660
    def step(self, message):
 
3661
        """Update the pb by a step."""
 
3662
        self.count +=1
 
3663
        self.pb.update(message, self.count, self.total)
4129
3664
 
4130
3665
 
4131
3666
_unescape_map = {
4160
3695
 
4161
3696
class _VersionedFileChecker(object):
4162
3697
 
4163
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
3698
    def __init__(self, repository, text_key_references=None):
4164
3699
        self.repository = repository
4165
3700
        self.text_index = self.repository._generate_text_key_index(
4166
 
            text_key_references=text_key_references, ancestors=ancestors)
 
3701
            text_key_references=text_key_references)
4167
3702
 
4168
3703
    def calculate_file_version_parents(self, text_key):
4169
3704
        """Calculate the correct parents for a file version according to
4187
3722
            revision_id) tuples for versions that are present in this versioned
4188
3723
            file, but not used by the corresponding inventory.
4189
3724
        """
4190
 
        local_progress = None
4191
 
        if progress_bar is None:
4192
 
            local_progress = ui.ui_factory.nested_progress_bar()
4193
 
            progress_bar = local_progress
4194
 
        try:
4195
 
            return self._check_file_version_parents(texts, progress_bar)
4196
 
        finally:
4197
 
            if local_progress:
4198
 
                local_progress.finished()
4199
 
 
4200
 
    def _check_file_version_parents(self, texts, progress_bar):
4201
 
        """See check_file_version_parents."""
4202
3725
        wrong_parents = {}
4203
3726
        self.file_ids = set([file_id for file_id, _ in
4204
3727
            self.text_index.iterkeys()])
4205
3728
        # text keys is now grouped by file_id
 
3729
        n_weaves = len(self.file_ids)
 
3730
        files_in_revisions = {}
 
3731
        revisions_of_files = {}
4206
3732
        n_versions = len(self.text_index)
4207
3733
        progress_bar.update('loading text store', 0, n_versions)
4208
3734
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4210
3736
        text_keys = self.repository.texts.keys()
4211
3737
        unused_keys = frozenset(text_keys) - set(self.text_index)
4212
3738
        for num, key in enumerate(self.text_index.iterkeys()):
4213
 
            progress_bar.update('checking text graph', num, n_versions)
 
3739
            if progress_bar is not None:
 
3740
                progress_bar.update('checking text graph', num, n_versions)
4214
3741
            correct_parents = self.calculate_file_version_parents(key)
4215
3742
            try:
4216
3743
                knit_parents = parent_map[key]
4265
3792
        try:
4266
3793
            if resume_tokens:
4267
3794
                self.target_repo.resume_write_group(resume_tokens)
4268
 
                is_resume = True
4269
3795
            else:
4270
3796
                self.target_repo.start_write_group()
4271
 
                is_resume = False
4272
3797
            try:
4273
3798
                # locked_insert_stream performs a commit|suspend.
4274
 
                return self._locked_insert_stream(stream, src_format,
4275
 
                    is_resume)
 
3799
                return self._locked_insert_stream(stream, src_format)
4276
3800
            except:
4277
3801
                self.target_repo.abort_write_group(suppress_errors=True)
4278
3802
                raise
4279
3803
        finally:
4280
3804
            self.target_repo.unlock()
4281
3805
 
4282
 
    def _locked_insert_stream(self, stream, src_format, is_resume):
 
3806
    def _locked_insert_stream(self, stream, src_format):
4283
3807
        to_serializer = self.target_repo._format._serializer
4284
3808
        src_serializer = src_format._serializer
4285
 
        new_pack = None
4286
3809
        if to_serializer == src_serializer:
4287
3810
            # If serializers match and the target is a pack repository, set the
4288
3811
            # write cache size on the new pack.  This avoids poor performance
4302
3825
            else:
4303
3826
                new_pack.set_write_cache_size(1024*1024)
4304
3827
        for substream_type, substream in stream:
4305
 
            if 'stream' in debug.debug_flags:
4306
 
                mutter('inserting substream: %s', substream_type)
4307
3828
            if substream_type == 'texts':
4308
3829
                self.target_repo.texts.insert_record_stream(substream)
4309
3830
            elif substream_type == 'inventories':
4313
3834
                else:
4314
3835
                    self._extract_and_insert_inventories(
4315
3836
                        substream, src_serializer)
4316
 
            elif substream_type == 'inventory-deltas':
4317
 
                self._extract_and_insert_inventory_deltas(
4318
 
                    substream, src_serializer)
4319
 
            elif substream_type == 'chk_bytes':
4320
 
                # XXX: This doesn't support conversions, as it assumes the
4321
 
                #      conversion was done in the fetch code.
4322
 
                self.target_repo.chk_bytes.insert_record_stream(substream)
4323
3837
            elif substream_type == 'revisions':
4324
3838
                # This may fallback to extract-and-insert more often than
4325
3839
                # required if the serializers are different only in terms of
4326
3840
                # the inventory.
4327
3841
                if src_serializer == to_serializer:
4328
 
                    self.target_repo.revisions.insert_record_stream(substream)
 
3842
                    self.target_repo.revisions.insert_record_stream(
 
3843
                        substream)
4329
3844
                else:
4330
3845
                    self._extract_and_insert_revisions(substream,
4331
3846
                        src_serializer)
4333
3848
                self.target_repo.signatures.insert_record_stream(substream)
4334
3849
            else:
4335
3850
                raise AssertionError('kaboom! %s' % (substream_type,))
4336
 
        # Done inserting data, and the missing_keys calculations will try to
4337
 
        # read back from the inserted data, so flush the writes to the new pack
4338
 
        # (if this is pack format).
4339
 
        if new_pack is not None:
4340
 
            new_pack._write_data('', flush=True)
4341
 
        # Find all the new revisions (including ones from resume_tokens)
4342
 
        missing_keys = self.target_repo.get_missing_parent_inventories(
4343
 
            check_for_missing_texts=is_resume)
4344
3851
        try:
 
3852
            missing_keys = set()
4345
3853
            for prefix, versioned_file in (
4346
3854
                ('texts', self.target_repo.texts),
4347
3855
                ('inventories', self.target_repo.inventories),
4348
3856
                ('revisions', self.target_repo.revisions),
4349
3857
                ('signatures', self.target_repo.signatures),
4350
 
                ('chk_bytes', self.target_repo.chk_bytes),
4351
3858
                ):
4352
 
                if versioned_file is None:
4353
 
                    continue
4354
 
                # TODO: key is often going to be a StaticTuple object
4355
 
                #       I don't believe we can define a method by which
4356
 
                #       (prefix,) + StaticTuple will work, though we could
4357
 
                #       define a StaticTuple.sq_concat that would allow you to
4358
 
                #       pass in either a tuple or a StaticTuple as the second
4359
 
                #       object, so instead we could have:
4360
 
                #       StaticTuple(prefix) + key here...
4361
3859
                missing_keys.update((prefix,) + key for key in
4362
3860
                    versioned_file.get_missing_compression_parent_keys())
4363
3861
        except NotImplementedError:
4372
3870
                # missing keys can handle suspending a write group).
4373
3871
                write_group_tokens = self.target_repo.suspend_write_group()
4374
3872
                return write_group_tokens, missing_keys
4375
 
        hint = self.target_repo.commit_write_group()
4376
 
        if (to_serializer != src_serializer and
4377
 
            self.target_repo._format.pack_compresses):
4378
 
            self.target_repo.pack(hint=hint)
 
3873
        self.target_repo.commit_write_group()
4379
3874
        return [], set()
4380
3875
 
4381
 
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
4382
 
        target_rich_root = self.target_repo._format.rich_root_data
4383
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4384
 
        for record in substream:
4385
 
            # Insert the delta directly
4386
 
            inventory_delta_bytes = record.get_bytes_as('fulltext')
4387
 
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
4388
 
            try:
4389
 
                parse_result = deserialiser.parse_text_bytes(
4390
 
                    inventory_delta_bytes)
4391
 
            except inventory_delta.IncompatibleInventoryDelta, err:
4392
 
                trace.mutter("Incompatible delta: %s", err.msg)
4393
 
                raise errors.IncompatibleRevision(self.target_repo._format)
4394
 
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
4395
 
            revision_id = new_id
4396
 
            parents = [key[0] for key in record.parents]
4397
 
            self.target_repo.add_inventory_by_delta(
4398
 
                basis_id, inv_delta, revision_id, parents)
4399
 
 
4400
 
    def _extract_and_insert_inventories(self, substream, serializer,
4401
 
            parse_delta=None):
 
3876
    def _extract_and_insert_inventories(self, substream, serializer):
4402
3877
        """Generate a new inventory versionedfile in target, converting data.
4403
3878
 
4404
3879
        The inventory is retrieved from the source, (deserializing it), and
4405
3880
        stored in the target (reserializing it in a different format).
4406
3881
        """
4407
 
        target_rich_root = self.target_repo._format.rich_root_data
4408
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4409
3882
        for record in substream:
4410
 
            # It's not a delta, so it must be a fulltext in the source
4411
 
            # serializer's format.
4412
3883
            bytes = record.get_bytes_as('fulltext')
4413
3884
            revision_id = record.key[0]
4414
3885
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4415
3886
            parents = [key[0] for key in record.parents]
4416
3887
            self.target_repo.add_inventory(revision_id, inv, parents)
4417
 
            # No need to keep holding this full inv in memory when the rest of
4418
 
            # the substream is likely to be all deltas.
4419
 
            del inv
4420
3888
 
4421
3889
    def _extract_and_insert_revisions(self, substream, serializer):
4422
3890
        for record in substream:
4439
3907
        """Create a StreamSource streaming from from_repository."""
4440
3908
        self.from_repository = from_repository
4441
3909
        self.to_format = to_format
4442
 
        self._record_counter = RecordCounter()
4443
3910
 
4444
3911
    def delta_on_metadata(self):
4445
3912
        """Return True if delta's are permitted on metadata streams.
4472
3939
        return [('signatures', signatures), ('revisions', revisions)]
4473
3940
 
4474
3941
    def _generate_root_texts(self, revs):
4475
 
        """This will be called by get_stream between fetching weave texts and
 
3942
        """This will be called by __fetch between fetching weave texts and
4476
3943
        fetching the inventory weave.
 
3944
 
 
3945
        Subclasses should override this if they need to generate root texts
 
3946
        after fetching weave texts.
4477
3947
        """
4478
3948
        if self._rich_root_upgrade():
4479
 
            return _mod_fetch.Inter1and2Helper(
 
3949
            import bzrlib.fetch
 
3950
            return bzrlib.fetch.Inter1and2Helper(
4480
3951
                self.from_repository).generate_root_texts(revs)
4481
3952
        else:
4482
3953
            return []
4485
3956
        phase = 'file'
4486
3957
        revs = search.get_keys()
4487
3958
        graph = self.from_repository.get_graph()
4488
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
 
3959
        revs = list(graph.iter_topo_order(revs))
4489
3960
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4490
3961
        text_keys = []
4491
3962
        for knit_kind, file_id, revisions in data_to_fetch:
4510
3981
                # will be valid.
4511
3982
                for _ in self._generate_root_texts(revs):
4512
3983
                    yield _
 
3984
                # NB: This currently reopens the inventory weave in source;
 
3985
                # using a single stream interface instead would avoid this.
 
3986
                from_weave = self.from_repository.inventories
4513
3987
                # we fetch only the referenced inventories because we do not
4514
3988
                # know for unselected inventories whether all their required
4515
3989
                # texts are present in the other repository - it could be
4516
3990
                # corrupt.
4517
 
                for info in self._get_inventory_stream(revs):
4518
 
                    yield info
 
3991
                yield ('inventories', from_weave.get_record_stream(
 
3992
                    [(rev_id,) for rev_id in revs],
 
3993
                    self.inventory_fetch_order(),
 
3994
                    not self.delta_on_metadata()))
4519
3995
            elif knit_kind == "signatures":
4520
3996
                # Nothing to do here; this will be taken care of when
4521
3997
                # _fetch_revision_texts happens.
4534
4010
        keys['texts'] = set()
4535
4011
        keys['revisions'] = set()
4536
4012
        keys['inventories'] = set()
4537
 
        keys['chk_bytes'] = set()
4538
4013
        keys['signatures'] = set()
4539
4014
        for key in missing_keys:
4540
4015
            keys[key[0]].add(key[1:])
4547
4022
                    keys['revisions'],))
4548
4023
        for substream_kind, keys in keys.iteritems():
4549
4024
            vf = getattr(self.from_repository, substream_kind)
4550
 
            if vf is None and keys:
4551
 
                    raise AssertionError(
4552
 
                        "cannot fill in keys for a versioned file we don't"
4553
 
                        " have: %s needs %s" % (substream_kind, keys))
4554
 
            if not keys:
4555
 
                # No need to stream something we don't have
4556
 
                continue
4557
 
            if substream_kind == 'inventories':
4558
 
                # Some missing keys are genuinely ghosts, filter those out.
4559
 
                present = self.from_repository.inventories.get_parent_map(keys)
4560
 
                revs = [key[0] for key in present]
4561
 
                # Get the inventory stream more-or-less as we do for the
4562
 
                # original stream; there's no reason to assume that records
4563
 
                # direct from the source will be suitable for the sink.  (Think
4564
 
                # e.g. 2a -> 1.9-rich-root).
4565
 
                for info in self._get_inventory_stream(revs, missing=True):
4566
 
                    yield info
4567
 
                continue
4568
 
 
4569
4025
            # Ask for full texts always so that we don't need more round trips
4570
4026
            # after this stream.
4571
 
            # Some of the missing keys are genuinely ghosts, so filter absent
4572
 
            # records. The Sink is responsible for doing another check to
4573
 
            # ensure that ghosts don't introduce missing data for future
4574
 
            # fetches.
4575
 
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
4576
 
                self.to_format._fetch_order, True))
 
4027
            stream = vf.get_record_stream(keys,
 
4028
                self.to_format._fetch_order, True)
4577
4029
            yield substream_kind, stream
4578
4030
 
4579
4031
    def inventory_fetch_order(self):
4586
4038
        return (not self.from_repository._format.rich_root_data and
4587
4039
            self.to_format.rich_root_data)
4588
4040
 
4589
 
    def _get_inventory_stream(self, revision_ids, missing=False):
4590
 
        from_format = self.from_repository._format
4591
 
        if (from_format.supports_chks and self.to_format.supports_chks and
4592
 
            from_format.network_name() == self.to_format.network_name()):
4593
 
            raise AssertionError(
4594
 
                "this case should be handled by GroupCHKStreamSource")
4595
 
        elif 'forceinvdeltas' in debug.debug_flags:
4596
 
            return self._get_convertable_inventory_stream(revision_ids,
4597
 
                    delta_versus_null=missing)
4598
 
        elif from_format.network_name() == self.to_format.network_name():
4599
 
            # Same format.
4600
 
            return self._get_simple_inventory_stream(revision_ids,
4601
 
                    missing=missing)
4602
 
        elif (not from_format.supports_chks and not self.to_format.supports_chks
4603
 
                and from_format._serializer == self.to_format._serializer):
4604
 
            # Essentially the same format.
4605
 
            return self._get_simple_inventory_stream(revision_ids,
4606
 
                    missing=missing)
4607
 
        else:
4608
 
            # Any time we switch serializations, we want to use an
4609
 
            # inventory-delta based approach.
4610
 
            return self._get_convertable_inventory_stream(revision_ids,
4611
 
                    delta_versus_null=missing)
4612
 
 
4613
 
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
4614
 
        # NB: This currently reopens the inventory weave in source;
4615
 
        # using a single stream interface instead would avoid this.
4616
 
        from_weave = self.from_repository.inventories
4617
 
        if missing:
4618
 
            delta_closure = True
4619
 
        else:
4620
 
            delta_closure = not self.delta_on_metadata()
4621
 
        yield ('inventories', from_weave.get_record_stream(
4622
 
            [(rev_id,) for rev_id in revision_ids],
4623
 
            self.inventory_fetch_order(), delta_closure))
4624
 
 
4625
 
    def _get_convertable_inventory_stream(self, revision_ids,
4626
 
                                          delta_versus_null=False):
4627
 
        # The two formats are sufficiently different that there is no fast
4628
 
        # path, so we need to send just inventorydeltas, which any
4629
 
        # sufficiently modern client can insert into any repository.
4630
 
        # The StreamSink code expects to be able to
4631
 
        # convert on the target, so we need to put bytes-on-the-wire that can
4632
 
        # be converted.  That means inventory deltas (if the remote is <1.19,
4633
 
        # RemoteStreamSink will fallback to VFS to insert the deltas).
4634
 
        yield ('inventory-deltas',
4635
 
           self._stream_invs_as_deltas(revision_ids,
4636
 
                                       delta_versus_null=delta_versus_null))
4637
 
 
4638
 
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
4639
 
        """Return a stream of inventory-deltas for the given rev ids.
4640
 
 
4641
 
        :param revision_ids: The list of inventories to transmit
4642
 
        :param delta_versus_null: Don't try to find a minimal delta for this
4643
 
            entry, instead compute the delta versus the NULL_REVISION. This
4644
 
            effectively streams a complete inventory. Used for stuff like
4645
 
            filling in missing parents, etc.
4646
 
        """
4647
 
        from_repo = self.from_repository
4648
 
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4649
 
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
4650
 
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
4651
 
        # method...
4652
 
        inventories = self.from_repository.iter_inventories(
4653
 
            revision_ids, 'topological')
4654
 
        format = from_repo._format
4655
 
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
4656
 
        inventory_cache = lru_cache.LRUCache(50)
4657
 
        null_inventory = from_repo.revision_tree(
4658
 
            _mod_revision.NULL_REVISION).inventory
4659
 
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
4660
 
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
4661
 
        # repo back into a non-rich-root repo ought to be allowed)
4662
 
        serializer = inventory_delta.InventoryDeltaSerializer(
4663
 
            versioned_root=format.rich_root_data,
4664
 
            tree_references=format.supports_tree_reference)
4665
 
        for inv in inventories:
4666
 
            key = (inv.revision_id,)
4667
 
            parent_keys = parent_map.get(key, ())
4668
 
            delta = None
4669
 
            if not delta_versus_null and parent_keys:
4670
 
                # The caller did not ask for complete inventories and we have
4671
 
                # some parents that we can delta against.  Make a delta against
4672
 
                # each parent so that we can find the smallest.
4673
 
                parent_ids = [parent_key[0] for parent_key in parent_keys]
4674
 
                for parent_id in parent_ids:
4675
 
                    if parent_id not in invs_sent_so_far:
4676
 
                        # We don't know that the remote side has this basis, so
4677
 
                        # we can't use it.
4678
 
                        continue
4679
 
                    if parent_id == _mod_revision.NULL_REVISION:
4680
 
                        parent_inv = null_inventory
4681
 
                    else:
4682
 
                        parent_inv = inventory_cache.get(parent_id, None)
4683
 
                        if parent_inv is None:
4684
 
                            parent_inv = from_repo.get_inventory(parent_id)
4685
 
                    candidate_delta = inv._make_delta(parent_inv)
4686
 
                    if (delta is None or
4687
 
                        len(delta) > len(candidate_delta)):
4688
 
                        delta = candidate_delta
4689
 
                        basis_id = parent_id
4690
 
            if delta is None:
4691
 
                # Either none of the parents ended up being suitable, or we
4692
 
                # were asked to delta against NULL
4693
 
                basis_id = _mod_revision.NULL_REVISION
4694
 
                delta = inv._make_delta(null_inventory)
4695
 
            invs_sent_so_far.add(inv.revision_id)
4696
 
            inventory_cache[inv.revision_id] = inv
4697
 
            delta_serialized = ''.join(
4698
 
                serializer.delta_to_lines(basis_id, key[-1], delta))
4699
 
            yield versionedfile.FulltextContentFactory(
4700
 
                key, parent_keys, None, delta_serialized)
4701
 
 
4702
 
 
4703
 
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
4704
 
                    stop_revision=None):
4705
 
    """Extend the partial history to include a given index
4706
 
 
4707
 
    If a stop_index is supplied, stop when that index has been reached.
4708
 
    If a stop_revision is supplied, stop when that revision is
4709
 
    encountered.  Otherwise, stop when the beginning of history is
4710
 
    reached.
4711
 
 
4712
 
    :param stop_index: The index which should be present.  When it is
4713
 
        present, history extension will stop.
4714
 
    :param stop_revision: The revision id which should be present.  When
4715
 
        it is encountered, history extension will stop.
4716
 
    """
4717
 
    start_revision = partial_history_cache[-1]
4718
 
    iterator = repo.iter_reverse_revision_history(start_revision)
4719
 
    try:
4720
 
        #skip the last revision in the list
4721
 
        iterator.next()
4722
 
        while True:
4723
 
            if (stop_index is not None and
4724
 
                len(partial_history_cache) > stop_index):
4725
 
                break
4726
 
            if partial_history_cache[-1] == stop_revision:
4727
 
                break
4728
 
            revision_id = iterator.next()
4729
 
            partial_history_cache.append(revision_id)
4730
 
    except StopIteration:
4731
 
        # No more history
4732
 
        return
4733