/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-04-07 10:41:30 UTC
  • mfrom: (4230.1.2 bzr.dev)
  • Revision ID: pqm@pqm.ubuntu.com-20090407104130-ka3rxokxvi9yfbck
Include the msgeditor hooks in known_hooks.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
23
23
from bzrlib import (
24
24
    bzrdir,
25
25
    check,
26
 
    chk_map,
27
 
    config,
28
26
    debug,
29
 
    fetch as _mod_fetch,
 
27
    errors,
30
28
    fifo_cache,
31
29
    generate_ids,
32
30
    gpg,
33
31
    graph,
34
 
    inventory,
35
 
    inventory_delta,
36
32
    lazy_regex,
37
33
    lockable_files,
38
34
    lockdir,
39
35
    lru_cache,
40
36
    osutils,
41
37
    revision as _mod_revision,
42
 
    static_tuple,
43
38
    symbol_versioning,
44
 
    trace,
45
39
    tsort,
46
40
    ui,
47
41
    versionedfile,
52
46
from bzrlib.testament import Testament
53
47
""")
54
48
 
55
 
from bzrlib import (
56
 
    errors,
57
 
    registry,
58
 
    )
59
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
60
50
from bzrlib.inter import InterObject
61
51
from bzrlib.inventory import (
62
52
    Inventory,
64
54
    ROOT_ID,
65
55
    entry_factory,
66
56
    )
67
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
 
57
from bzrlib import registry
 
58
from bzrlib.symbol_versioning import (
 
59
        deprecated_method,
 
60
        )
68
61
from bzrlib.trace import (
69
62
    log_exception_quietly, note, mutter, mutter_callsite, warning)
70
63
 
73
66
_deprecation_warning_done = False
74
67
 
75
68
 
76
 
class IsInWriteGroupError(errors.InternalBzrError):
77
 
 
78
 
    _fmt = "May not refresh_data of repo %(repo)s while in a write group."
79
 
 
80
 
    def __init__(self, repo):
81
 
        errors.InternalBzrError.__init__(self, repo=repo)
82
 
 
83
 
 
84
69
class CommitBuilder(object):
85
70
    """Provides an interface to build up a commit.
86
71
 
212
197
 
213
198
    def finish_inventory(self):
214
199
        """Tell the builder that the inventory is finished.
215
 
 
 
200
        
216
201
        :return: The inventory id in the repository, which can be used with
217
202
            repository.get_inventory.
218
203
        """
220
205
            # an inventory delta was accumulated without creating a new
221
206
            # inventory.
222
207
            basis_id = self.basis_delta_revision
223
 
            # We ignore the 'inventory' returned by add_inventory_by_delta
224
 
            # because self.new_inventory is used to hint to the rest of the
225
 
            # system what code path was taken
226
 
            self.inv_sha1, _ = self.repository.add_inventory_by_delta(
 
208
            self.inv_sha1 = self.repository.add_inventory_by_delta(
227
209
                basis_id, self._basis_delta, self._new_revision_id,
228
210
                self.parents)
229
211
        else:
483
465
            if content_summary[2] is None:
484
466
                raise ValueError("Files must not have executable = None")
485
467
            if not store:
486
 
                # We can't trust a check of the file length because of content
487
 
                # filtering...
488
 
                if (# if the exec bit has changed we have to store:
 
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:
489
471
                    parent_entry.executable != content_summary[2]):
490
472
                    store = True
491
473
                elif parent_entry.text_sha1 == content_summary[3]:
510
492
            ie.executable = content_summary[2]
511
493
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
512
494
            try:
513
 
                text = file_obj.read()
 
495
                lines = file_obj.readlines()
514
496
            finally:
515
497
                file_obj.close()
516
498
            try:
517
499
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
518
 
                    ie.file_id, text, heads, nostore_sha)
 
500
                    ie.file_id, lines, heads, nostore_sha)
519
501
                # Let the caller know we generated a stat fingerprint.
520
502
                fingerprint = (ie.text_sha1, stat_value)
521
503
            except errors.ExistingContent:
533
515
                # carry over:
534
516
                ie.revision = parent_entry.revision
535
517
                return self._get_delta(ie, basis_inv, path), False, None
536
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
518
            lines = []
 
519
            self._add_text_to_weave(ie.file_id, lines, heads, None)
537
520
        elif kind == 'symlink':
538
521
            current_link_target = content_summary[3]
539
522
            if not store:
547
530
                ie.symlink_target = parent_entry.symlink_target
548
531
                return self._get_delta(ie, basis_inv, path), False, None
549
532
            ie.symlink_target = current_link_target
550
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
533
            lines = []
 
534
            self._add_text_to_weave(ie.file_id, lines, heads, None)
551
535
        elif kind == 'tree-reference':
552
536
            if not store:
553
537
                if content_summary[3] != parent_entry.reference_revision:
558
542
                ie.revision = parent_entry.revision
559
543
                return self._get_delta(ie, basis_inv, path), False, None
560
544
            ie.reference_revision = content_summary[3]
561
 
            if ie.reference_revision is None:
562
 
                raise AssertionError("invalid content_summary for nested tree: %r"
563
 
                    % (content_summary,))
564
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
545
            lines = []
 
546
            self._add_text_to_weave(ie.file_id, lines, heads, None)
565
547
        else:
566
548
            raise NotImplementedError('unknown kind')
567
549
        ie.revision = self._new_revision_id
761
743
                        entry.executable = True
762
744
                    else:
763
745
                        entry.executable = False
764
 
                    if (carry_over_possible and
 
746
                    if (carry_over_possible and 
765
747
                        parent_entry.executable == entry.executable):
766
748
                            # Check the file length, content hash after reading
767
749
                            # the file.
770
752
                        nostore_sha = None
771
753
                    file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
772
754
                    try:
773
 
                        text = file_obj.read()
 
755
                        lines = file_obj.readlines()
774
756
                    finally:
775
757
                        file_obj.close()
776
758
                    try:
777
759
                        entry.text_sha1, entry.text_size = self._add_text_to_weave(
778
 
                            file_id, text, heads, nostore_sha)
 
760
                            file_id, lines, heads, nostore_sha)
779
761
                        yield file_id, change[1][1], (entry.text_sha1, stat_value)
780
762
                    except errors.ExistingContent:
781
763
                        # No content change against a carry_over parent
790
772
                        parent_entry.symlink_target == entry.symlink_target):
791
773
                        carried_over = True
792
774
                    else:
793
 
                        self._add_text_to_weave(change[0], '', heads, None)
 
775
                        self._add_text_to_weave(change[0], [], heads, None)
794
776
                elif kind == 'directory':
795
777
                    if carry_over_possible:
796
778
                        carried_over = True
798
780
                        # Nothing to set on the entry.
799
781
                        # XXX: split into the Root and nonRoot versions.
800
782
                        if change[1][1] != '' or self.repository.supports_rich_root():
801
 
                            self._add_text_to_weave(change[0], '', heads, None)
 
783
                            self._add_text_to_weave(change[0], [], heads, None)
802
784
                elif kind == 'tree-reference':
803
785
                    if not self.repository._format.supports_tree_reference:
804
786
                        # This isn't quite sane as an error, but we shouldn't
807
789
                        # references.
808
790
                        raise errors.UnsupportedOperation(tree.add_reference,
809
791
                            self.repository)
810
 
                    reference_revision = tree.get_reference_revision(change[0])
811
 
                    entry.reference_revision = reference_revision
 
792
                    entry.reference_revision = \
 
793
                        tree.get_reference_revision(change[0])
812
794
                    if (carry_over_possible and
813
795
                        parent_entry.reference_revision == reference_revision):
814
796
                        carried_over = True
815
797
                    else:
816
 
                        self._add_text_to_weave(change[0], '', heads, None)
 
798
                        self._add_text_to_weave(change[0], [], heads, None)
817
799
                else:
818
800
                    raise AssertionError('unknown kind %r' % kind)
819
801
                if not carried_over:
828
810
                seen_root = True
829
811
        self.new_inventory = None
830
812
        if len(inv_delta):
831
 
            # This should perhaps be guarded by a check that the basis we
832
 
            # commit against is the basis for the commit and if not do a delta
833
 
            # against the basis.
834
813
            self._any_changes = True
835
814
        if not seen_root:
836
815
            # housekeeping root entry changes do not affect no-change commits.
837
816
            self._require_root_change(tree)
838
817
        self.basis_delta_revision = basis_revision_id
839
818
 
840
 
    def _add_text_to_weave(self, file_id, new_text, parents, nostore_sha):
841
 
        parent_keys = tuple([(file_id, parent) for parent in parents])
842
 
        return self.repository.texts._add_text(
843
 
            (file_id, self._new_revision_id), parent_keys, new_text,
844
 
            nostore_sha=nostore_sha, random_id=self.random_revid)[0:2]
 
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]
845
830
 
846
831
 
847
832
class RootCommitBuilder(CommitBuilder):
870
855
        # versioned roots do not change unless the tree found a change.
871
856
 
872
857
 
873
 
class RepositoryWriteLockResult(LogicalLockResult):
874
 
    """The result of write locking a repository.
875
 
 
876
 
    :ivar repository_token: The token obtained from the underlying lock, or
877
 
        None.
878
 
    :ivar unlock: A callable which will unlock the lock.
879
 
    """
880
 
 
881
 
    def __init__(self, unlock, repository_token):
882
 
        LogicalLockResult.__init__(self, unlock)
883
 
        self.repository_token = repository_token
884
 
 
885
 
    def __repr__(self):
886
 
        return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
887
 
            self.unlock)
888
 
 
889
 
 
890
858
######################################################################
891
859
# Repositories
892
860
 
893
 
 
894
 
class Repository(_RelockDebugMixin, bzrdir.ControlComponent):
 
861
class Repository(object):
895
862
    """Repository holding history for one or more branches.
896
863
 
897
864
    The repository holds and retrieves historical information including
899
866
    which views a particular line of development through that history.
900
867
 
901
868
    The Repository builds on top of some byte storage facilies (the revisions,
902
 
    signatures, inventories, texts and chk_bytes attributes) and a Transport,
903
 
    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
904
871
    remote) disk.
905
872
 
906
873
    The byte storage facilities are addressed via tuples, which we refer to
907
874
    as 'keys' throughout the code base. Revision_keys, inventory_keys and
908
875
    signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
909
 
    (file_id, revision_id). chk_bytes uses CHK keys - a 1-tuple with a single
910
 
    byte string made up of a hash identifier and a hash value.
911
 
    We use this interface because it allows low friction with the underlying
912
 
    code that implements disk indices, network encoding and other parts of
913
 
    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.
914
879
 
915
880
    :ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
916
881
        the serialised revisions for the repository. This can be used to obtain
935
900
        The result of trying to insert data into the repository via this store
936
901
        is undefined: it should be considered read-only except for implementors
937
902
        of repositories.
938
 
    :ivar chk_bytes: A bzrlib.versionedfile.VersionedFiles instance containing
939
 
        any data the repository chooses to store or have indexed by its hash.
940
 
        The result of trying to insert data into the repository via this store
941
 
        is undefined: it should be considered read-only except for implementors
942
 
        of repositories.
943
903
    :ivar _transport: Transport for file access to repository, typically
944
904
        pointing to .bzr/repository.
945
905
    """
966
926
        """
967
927
        if self._write_group is not self.get_transaction():
968
928
            # has an unlock or relock occured ?
969
 
            if suppress_errors:
970
 
                mutter(
971
 
                '(suppressed) mismatched lock context and write group. %r, %r',
972
 
                self._write_group, self.get_transaction())
973
 
                return
974
 
            raise errors.BzrError(
975
 
                'mismatched lock context and write group. %r, %r' %
976
 
                (self._write_group, self.get_transaction()))
 
929
            raise errors.BzrError('mismatched lock context and write group.')
977
930
        try:
978
931
            self._abort_write_group()
979
932
        except Exception, exc:
1005
958
        """
1006
959
        if not self._format.supports_external_lookups:
1007
960
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
1008
 
        if self.is_locked():
1009
 
            # This repository will call fallback.unlock() when we transition to
1010
 
            # the unlocked state, so we make sure to increment the lock count
1011
 
            repository.lock_read()
1012
961
        self._check_fallback_repository(repository)
1013
962
        self._fallback_repositories.append(repository)
1014
963
        self.texts.add_fallback_versioned_files(repository.texts)
1015
964
        self.inventories.add_fallback_versioned_files(repository.inventories)
1016
965
        self.revisions.add_fallback_versioned_files(repository.revisions)
1017
966
        self.signatures.add_fallback_versioned_files(repository.signatures)
1018
 
        if self.chk_bytes is not None:
1019
 
            self.chk_bytes.add_fallback_versioned_files(repository.chk_bytes)
1020
967
 
1021
968
    def _check_fallback_repository(self, repository):
1022
969
        """Check that this repository can fallback to repository safely.
1046
993
                % (inv.revision_id, revision_id))
1047
994
        if inv.root is None:
1048
995
            raise AssertionError()
1049
 
        return self._add_inventory_checked(revision_id, inv, parents)
1050
 
 
1051
 
    def _add_inventory_checked(self, revision_id, inv, parents):
1052
 
        """Add inv to the repository after checking the inputs.
1053
 
 
1054
 
        This function can be overridden to allow different inventory styles.
1055
 
 
1056
 
        :seealso: add_inventory, for the contract.
1057
 
        """
1058
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
 
996
        inv_lines = self._serialise_inventory_to_lines(inv)
1059
997
        return self._inventory_add_lines(revision_id, parents,
1060
998
            inv_lines, check_content=False)
1061
999
 
1062
1000
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1063
 
                               parents, basis_inv=None, propagate_caches=False):
 
1001
                               parents):
1064
1002
        """Add a new inventory expressed as a delta against another revision.
1065
1003
 
1066
 
        See the inventory developers documentation for the theory behind
1067
 
        inventory deltas.
1068
 
 
1069
1004
        :param basis_revision_id: The inventory id the delta was created
1070
1005
            against. (This does not have to be a direct parent.)
1071
1006
        :param delta: The inventory delta (see Inventory.apply_delta for
1077
1012
            for repositories that depend on the inventory graph for revision
1078
1013
            graph access, as well as for those that pun ancestry with delta
1079
1014
            compression.
1080
 
        :param basis_inv: The basis inventory if it is already known,
1081
 
            otherwise None.
1082
 
        :param propagate_caches: If True, the caches for this inventory are
1083
 
          copied to and updated for the result if possible.
1084
1015
 
1085
1016
        :returns: (validator, new_inv)
1086
1017
            The validator(which is a sha1 digest, though what is sha'd is
1097
1028
            # inventory implementations may support: A better idiom would be to
1098
1029
            # return a new inventory, but as there is no revision tree cache in
1099
1030
            # repository this is safe for now - RBC 20081013
1100
 
            if basis_inv is None:
1101
 
                basis_inv = basis_tree.inventory
 
1031
            basis_inv = basis_tree.inventory
1102
1032
            basis_inv.apply_delta(delta)
1103
1033
            basis_inv.revision_id = new_revision_id
1104
1034
            return (self.add_inventory(new_revision_id, basis_inv, parents),
1110
1040
        check_content=True):
1111
1041
        """Store lines in inv_vf and return the sha1 of the inventory."""
1112
1042
        parents = [(parent,) for parent in parents]
1113
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
1043
        return self.inventories.add_lines((revision_id,), parents, lines,
1114
1044
            check_content=check_content)[0]
1115
 
        self.inventories._access.flush()
1116
 
        return result
1117
1045
 
1118
1046
    def add_revision(self, revision_id, rev, inv=None, config=None):
1119
1047
        """Add rev to the revision store as revision_id.
1195
1123
        # The old API returned a list, should this actually be a set?
1196
1124
        return parent_map.keys()
1197
1125
 
1198
 
    def _check_inventories(self, checker):
1199
 
        """Check the inventories found from the revision scan.
1200
 
        
1201
 
        This is responsible for verifying the sha1 of inventories and
1202
 
        creating a pending_keys set that covers data referenced by inventories.
1203
 
        """
1204
 
        bar = ui.ui_factory.nested_progress_bar()
1205
 
        try:
1206
 
            self._do_check_inventories(checker, bar)
1207
 
        finally:
1208
 
            bar.finished()
1209
 
 
1210
 
    def _do_check_inventories(self, checker, bar):
1211
 
        """Helper for _check_inventories."""
1212
 
        revno = 0
1213
 
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
1214
 
        kinds = ['chk_bytes', 'texts']
1215
 
        count = len(checker.pending_keys)
1216
 
        bar.update("inventories", 0, 2)
1217
 
        current_keys = checker.pending_keys
1218
 
        checker.pending_keys = {}
1219
 
        # Accumulate current checks.
1220
 
        for key in current_keys:
1221
 
            if key[0] != 'inventories' and key[0] not in kinds:
1222
 
                checker._report_items.append('unknown key type %r' % (key,))
1223
 
            keys[key[0]].add(key[1:])
1224
 
        if keys['inventories']:
1225
 
            # NB: output order *should* be roughly sorted - topo or
1226
 
            # inverse topo depending on repository - either way decent
1227
 
            # to just delta against. However, pre-CHK formats didn't
1228
 
            # try to optimise inventory layout on disk. As such the
1229
 
            # pre-CHK code path does not use inventory deltas.
1230
 
            last_object = None
1231
 
            for record in self.inventories.check(keys=keys['inventories']):
1232
 
                if record.storage_kind == 'absent':
1233
 
                    checker._report_items.append(
1234
 
                        'Missing inventory {%s}' % (record.key,))
1235
 
                else:
1236
 
                    last_object = self._check_record('inventories', record,
1237
 
                        checker, last_object,
1238
 
                        current_keys[('inventories',) + record.key])
1239
 
            del keys['inventories']
1240
 
        else:
1241
 
            return
1242
 
        bar.update("texts", 1)
1243
 
        while (checker.pending_keys or keys['chk_bytes']
1244
 
            or keys['texts']):
1245
 
            # Something to check.
1246
 
            current_keys = checker.pending_keys
1247
 
            checker.pending_keys = {}
1248
 
            # Accumulate current checks.
1249
 
            for key in current_keys:
1250
 
                if key[0] not in kinds:
1251
 
                    checker._report_items.append('unknown key type %r' % (key,))
1252
 
                keys[key[0]].add(key[1:])
1253
 
            # Check the outermost kind only - inventories || chk_bytes || texts
1254
 
            for kind in kinds:
1255
 
                if keys[kind]:
1256
 
                    last_object = None
1257
 
                    for record in getattr(self, kind).check(keys=keys[kind]):
1258
 
                        if record.storage_kind == 'absent':
1259
 
                            checker._report_items.append(
1260
 
                                'Missing %s {%s}' % (kind, record.key,))
1261
 
                        else:
1262
 
                            last_object = self._check_record(kind, record,
1263
 
                                checker, last_object, current_keys[(kind,) + record.key])
1264
 
                    keys[kind] = set()
1265
 
                    break
1266
 
 
1267
 
    def _check_record(self, kind, record, checker, last_object, item_data):
1268
 
        """Check a single text from this repository."""
1269
 
        if kind == 'inventories':
1270
 
            rev_id = record.key[0]
1271
 
            inv = self._deserialise_inventory(rev_id,
1272
 
                record.get_bytes_as('fulltext'))
1273
 
            if last_object is not None:
1274
 
                delta = inv._make_delta(last_object)
1275
 
                for old_path, path, file_id, ie in delta:
1276
 
                    if ie is None:
1277
 
                        continue
1278
 
                    ie.check(checker, rev_id, inv)
1279
 
            else:
1280
 
                for path, ie in inv.iter_entries():
1281
 
                    ie.check(checker, rev_id, inv)
1282
 
            if self._format.fast_deltas:
1283
 
                return inv
1284
 
        elif kind == 'chk_bytes':
1285
 
            # No code written to check chk_bytes for this repo format.
1286
 
            checker._report_items.append(
1287
 
                'unsupported key type chk_bytes for %s' % (record.key,))
1288
 
        elif kind == 'texts':
1289
 
            self._check_text(record, checker, item_data)
1290
 
        else:
1291
 
            checker._report_items.append(
1292
 
                'unknown key type %s for %s' % (kind, record.key))
1293
 
 
1294
 
    def _check_text(self, record, checker, item_data):
1295
 
        """Check a single text."""
1296
 
        # Check it is extractable.
1297
 
        # TODO: check length.
1298
 
        if record.storage_kind == 'chunked':
1299
 
            chunks = record.get_bytes_as(record.storage_kind)
1300
 
            sha1 = osutils.sha_strings(chunks)
1301
 
            length = sum(map(len, chunks))
1302
 
        else:
1303
 
            content = record.get_bytes_as('fulltext')
1304
 
            sha1 = osutils.sha_string(content)
1305
 
            length = len(content)
1306
 
        if item_data and sha1 != item_data[1]:
1307
 
            checker._report_items.append(
1308
 
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
1309
 
                (record.key, sha1, item_data[1], item_data[2]))
1310
 
 
1311
1126
    @staticmethod
1312
1127
    def create(a_bzrdir):
1313
1128
        """Construct the current default format repository in a_bzrdir."""
1318
1133
 
1319
1134
        :param _format: The format of the repository on disk.
1320
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.
1321
1140
        """
1322
 
        # In the future we will have a single api for all stores for
1323
 
        # getting file texts, inventories and revisions, then
1324
 
        # this construct will accept instances of those things.
1325
1141
        super(Repository, self).__init__()
1326
1142
        self._format = _format
1327
1143
        # the following are part of the public API for Repository:
1333
1149
        self._reconcile_does_inventory_gc = True
1334
1150
        self._reconcile_fixes_text_parents = False
1335
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()
1336
1157
        self._write_group = None
1337
1158
        # Additional places to query for data.
1338
1159
        self._fallback_repositories = []
1339
1160
        # An InventoryEntry cache, used during deserialization
1340
1161
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
1341
 
        # Is it safe to return inventory entries directly from the entry cache,
1342
 
        # rather copying them?
1343
 
        self._safe_to_return_from_cache = False
1344
 
 
1345
 
    @property
1346
 
    def user_transport(self):
1347
 
        return self.bzrdir.user_transport
1348
 
 
1349
 
    @property
1350
 
    def control_transport(self):
1351
 
        return self._transport
1352
1162
 
1353
1163
    def __repr__(self):
1354
 
        if self._fallback_repositories:
1355
 
            return '%s(%r, fallback_repositories=%r)' % (
1356
 
                self.__class__.__name__,
1357
 
                self.base,
1358
 
                self._fallback_repositories)
1359
 
        else:
1360
 
            return '%s(%r)' % (self.__class__.__name__,
1361
 
                               self.base)
1362
 
 
1363
 
    def _has_same_fallbacks(self, other_repo):
1364
 
        """Returns true if the repositories have the same fallbacks."""
1365
 
        my_fb = self._fallback_repositories
1366
 
        other_fb = other_repo._fallback_repositories
1367
 
        if len(my_fb) != len(other_fb):
1368
 
            return False
1369
 
        for f, g in zip(my_fb, other_fb):
1370
 
            if not f.has_same_location(g):
1371
 
                return False
1372
 
        return True
 
1164
        return '%s(%r)' % (self.__class__.__name__,
 
1165
                           self.base)
1373
1166
 
1374
1167
    def has_same_location(self, other):
1375
1168
        """Returns a boolean indicating if this repository is at the same
1403
1196
        data during reads, and allows a 'write_group' to be obtained. Write
1404
1197
        groups must be used for actual data insertion.
1405
1198
 
1406
 
        A token should be passed in if you know that you have locked the object
1407
 
        some other way, and need to synchronise this object's state with that
1408
 
        fact.
1409
 
 
1410
 
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1411
 
 
1412
1199
        :param token: if this is already locked, then lock_write will fail
1413
1200
            unless the token matches the existing lock.
1414
1201
        :returns: a token if this instance supports tokens, otherwise None.
1417
1204
        :raises MismatchedToken: if the specified token doesn't match the token
1418
1205
            of the existing lock.
1419
1206
        :seealso: start_write_group.
1420
 
        :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
1421
1213
        """
1422
1214
        locked = self.is_locked()
1423
 
        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()
1424
1219
        if not locked:
1425
 
            self._warn_if_deprecated()
1426
 
            self._note_lock('w')
1427
 
            for repo in self._fallback_repositories:
1428
 
                # Writes don't affect fallback repos
1429
 
                repo.lock_read()
1430
1220
            self._refresh_data()
1431
 
        return RepositoryWriteLockResult(self.unlock, token)
 
1221
        return result
1432
1222
 
1433
1223
    def lock_read(self):
1434
 
        """Lock the repository for read operations.
1435
 
 
1436
 
        :return: An object with an unlock method which will release the lock
1437
 
            obtained.
1438
 
        """
1439
1224
        locked = self.is_locked()
1440
1225
        self.control_files.lock_read()
 
1226
        for repo in self._fallback_repositories:
 
1227
            repo.lock_read()
1441
1228
        if not locked:
1442
 
            self._warn_if_deprecated()
1443
 
            self._note_lock('r')
1444
 
            for repo in self._fallback_repositories:
1445
 
                repo.lock_read()
1446
1229
            self._refresh_data()
1447
 
        return LogicalLockResult(self.unlock)
1448
1230
 
1449
1231
    def get_physical_lock_status(self):
1450
1232
        return self.control_files.get_physical_lock_status()
1510
1292
 
1511
1293
        # now gather global repository information
1512
1294
        # XXX: This is available for many repos regardless of listability.
1513
 
        if self.user_transport.listable():
 
1295
        if self.bzrdir.root_transport.listable():
1514
1296
            # XXX: do we want to __define len__() ?
1515
1297
            # Maybe the versionedfiles object should provide a different
1516
1298
            # method to get the number of keys.
1526
1308
        :param using: If True, list only branches using this repository.
1527
1309
        """
1528
1310
        if using and not self.is_shared():
1529
 
            return self.bzrdir.list_branches()
 
1311
            try:
 
1312
                return [self.bzrdir.open_branch()]
 
1313
            except errors.NotBranchError:
 
1314
                return []
1530
1315
        class Evaluator(object):
1531
1316
 
1532
1317
            def __init__(self):
1541
1326
                    except errors.NoRepositoryPresent:
1542
1327
                        pass
1543
1328
                    else:
1544
 
                        return False, ([], repository)
 
1329
                        return False, (None, repository)
1545
1330
                self.first_call = False
1546
 
                value = (bzrdir.list_branches(), None)
 
1331
                try:
 
1332
                    value = (bzrdir.open_branch(), None)
 
1333
                except errors.NotBranchError:
 
1334
                    value = (None, None)
1547
1335
                return True, value
1548
1336
 
1549
 
        ret = []
1550
 
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
1551
 
                self.user_transport, evaluate=Evaluator()):
1552
 
            if branches is not None:
1553
 
                ret.extend(branches)
 
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)
1554
1342
            if not using and repository is not None:
1555
 
                ret.extend(repository.find_branches())
1556
 
        return ret
 
1343
                branches.extend(repository.find_branches())
 
1344
        return branches
1557
1345
 
1558
1346
    @needs_read_lock
1559
1347
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1588
1376
        """Commit the contents accrued within the current write group.
1589
1377
 
1590
1378
        :seealso: start_write_group.
1591
 
        
1592
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1593
1379
        """
1594
1380
        if self._write_group is not self.get_transaction():
1595
1381
            # has an unlock or relock occured ?
1596
1382
            raise errors.BzrError('mismatched lock context %r and '
1597
1383
                'write group %r.' %
1598
1384
                (self.get_transaction(), self._write_group))
1599
 
        result = self._commit_write_group()
 
1385
        self._commit_write_group()
1600
1386
        self._write_group = None
1601
 
        return result
1602
1387
 
1603
1388
    def _commit_write_group(self):
1604
1389
        """Template method for per-repository write group cleanup.
1612
1397
    def suspend_write_group(self):
1613
1398
        raise errors.UnsuspendableWriteGroup(self)
1614
1399
 
1615
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
1616
 
        """Return the keys of missing inventory parents for revisions added in
1617
 
        this write group.
1618
 
 
1619
 
        A revision is not complete if the inventory delta for that revision
1620
 
        cannot be calculated.  Therefore if the parent inventories of a
1621
 
        revision are not present, the revision is incomplete, and e.g. cannot
1622
 
        be streamed by a smart server.  This method finds missing inventory
1623
 
        parents for revisions added in this write group.
1624
 
        """
1625
 
        if not self._format.supports_external_lookups:
1626
 
            # This is only an issue for stacked repositories
1627
 
            return set()
1628
 
        if not self.is_in_write_group():
1629
 
            raise AssertionError('not in a write group')
1630
 
 
1631
 
        # XXX: We assume that every added revision already has its
1632
 
        # corresponding inventory, so we only check for parent inventories that
1633
 
        # might be missing, rather than all inventories.
1634
 
        parents = set(self.revisions._index.get_missing_parents())
1635
 
        parents.discard(_mod_revision.NULL_REVISION)
1636
 
        unstacked_inventories = self.inventories._index
1637
 
        present_inventories = unstacked_inventories.get_parent_map(
1638
 
            key[-1:] for key in parents)
1639
 
        parents.difference_update(present_inventories)
1640
 
        if len(parents) == 0:
1641
 
            # No missing parent inventories.
1642
 
            return set()
1643
 
        if not check_for_missing_texts:
1644
 
            return set(('inventories', rev_id) for (rev_id,) in parents)
1645
 
        # Ok, now we have a list of missing inventories.  But these only matter
1646
 
        # if the inventories that reference them are missing some texts they
1647
 
        # appear to introduce.
1648
 
        # XXX: Texts referenced by all added inventories need to be present,
1649
 
        # but at the moment we're only checking for texts referenced by
1650
 
        # inventories at the graph's edge.
1651
 
        key_deps = self.revisions._index._key_dependencies
1652
 
        key_deps.satisfy_refs_for_keys(present_inventories)
1653
 
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1654
 
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1655
 
        missing_texts = set()
1656
 
        for file_id, version_ids in file_ids.iteritems():
1657
 
            missing_texts.update(
1658
 
                (file_id, version_id) for version_id in version_ids)
1659
 
        present_texts = self.texts.get_parent_map(missing_texts)
1660
 
        missing_texts.difference_update(present_texts)
1661
 
        if not missing_texts:
1662
 
            # No texts are missing, so all revisions and their deltas are
1663
 
            # reconstructable.
1664
 
            return set()
1665
 
        # Alternatively the text versions could be returned as the missing
1666
 
        # keys, but this is likely to be less data.
1667
 
        missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
1668
 
        return missing_keys
1669
 
 
1670
1400
    def refresh_data(self):
1671
 
        """Re-read any data needed to synchronise with disk.
 
1401
        """Re-read any data needed to to synchronise with disk.
1672
1402
 
1673
1403
        This method is intended to be called after another repository instance
1674
1404
        (such as one used by a smart server) has inserted data into the
1675
 
        repository. On all repositories this will work outside of write groups.
1676
 
        Some repository formats (pack and newer for bzrlib native formats)
1677
 
        support refresh_data inside write groups. If called inside a write
1678
 
        group on a repository that does not support refreshing in a write group
1679
 
        IsInWriteGroupError will be raised.
 
1405
        repository. It may not be called during a write group, but may be
 
1406
        called at any other time.
1680
1407
        """
 
1408
        if self.is_in_write_group():
 
1409
            raise errors.InternalBzrError(
 
1410
                "May not refresh_data while in a write group.")
1681
1411
        self._refresh_data()
1682
1412
 
1683
1413
    def resume_write_group(self, tokens):
1721
1451
            raise errors.InternalBzrError(
1722
1452
                "May not fetch while in a write group.")
1723
1453
        # fast path same-url fetch operations
1724
 
        # TODO: lift out to somewhere common with RemoteRepository
1725
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401646>
1726
 
        if (self.has_same_location(source)
1727
 
            and fetch_spec is None
1728
 
            and self._has_same_fallbacks(source)):
 
1454
        if self.has_same_location(source) and fetch_spec is None:
1729
1455
            # check that last_revision is in 'from' and then return a
1730
1456
            # no-operation.
1731
1457
            if (revision_id is not None and
1756
1482
        :param revprops: Optional dictionary of revision properties.
1757
1483
        :param revision_id: Optional revision id.
1758
1484
        """
1759
 
        if self._fallback_repositories:
1760
 
            raise errors.BzrError("Cannot commit from a lightweight checkout "
1761
 
                "to a stacked branch. See "
1762
 
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1763
1485
        result = self._commit_builder_class(self, parents, config,
1764
1486
            timestamp, timezone, committer, revprops, revision_id)
1765
1487
        self.start_write_group()
1766
1488
        return result
1767
1489
 
1768
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1769
1490
    def unlock(self):
1770
1491
        if (self.control_files._lock_count == 1 and
1771
1492
            self.control_files._lock_mode == 'w'):
1777
1498
        self.control_files.unlock()
1778
1499
        if self.control_files._lock_count == 0:
1779
1500
            self._inventory_entry_cache.clear()
1780
 
            for repo in self._fallback_repositories:
1781
 
                repo.unlock()
 
1501
        for repo in self._fallback_repositories:
 
1502
            repo.unlock()
1782
1503
 
1783
1504
    @needs_read_lock
1784
1505
    def clone(self, a_bzrdir, revision_id=None):
1893
1614
 
1894
1615
    @needs_read_lock
1895
1616
    def get_revisions(self, revision_ids):
1896
 
        """Get many revisions at once.
1897
 
        
1898
 
        Repositories that need to check data on every revision read should 
1899
 
        subclass this method.
1900
 
        """
 
1617
        """Get many revisions at once."""
1901
1618
        return self._get_revisions(revision_ids)
1902
1619
 
1903
1620
    @needs_read_lock
1904
1621
    def _get_revisions(self, revision_ids):
1905
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)
1906
1628
        revs = {}
1907
 
        for revid, rev in self._iter_revisions(revision_ids):
1908
 
            if rev is None:
1909
 
                raise errors.NoSuchRevision(self, revid)
1910
 
            revs[revid] = rev
 
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
1911
1635
        return [revs[revid] for revid in revision_ids]
1912
1636
 
1913
 
    def _iter_revisions(self, revision_ids):
1914
 
        """Iterate over revision objects.
1915
 
 
1916
 
        :param revision_ids: An iterable of revisions to examine. None may be
1917
 
            passed to request all revisions known to the repository. Note that
1918
 
            not all repositories can find unreferenced revisions; for those
1919
 
            repositories only referenced ones will be returned.
1920
 
        :return: An iterator of (revid, revision) tuples. Absent revisions (
1921
 
            those asked for but not available) are returned as (revid, None).
1922
 
        """
1923
 
        if revision_ids is None:
1924
 
            revision_ids = self.all_revision_ids()
1925
 
        else:
1926
 
            for rev_id in revision_ids:
1927
 
                if not rev_id or not isinstance(rev_id, basestring):
1928
 
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1929
 
        keys = [(key,) for key in revision_ids]
1930
 
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1931
 
        for record in stream:
1932
 
            revid = record.key[0]
1933
 
            if record.storage_kind == 'absent':
1934
 
                yield (revid, None)
1935
 
            else:
1936
 
                text = record.get_bytes_as('fulltext')
1937
 
                rev = self._serializer.read_revision_from_string(text)
1938
 
                yield (revid, rev)
 
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()
1939
1653
 
1940
1654
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1941
1655
        """Produce a generator of revision deltas.
2119
1833
                    yield line, revid
2120
1834
 
2121
1835
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
2122
 
        revision_keys):
 
1836
        revision_ids):
2123
1837
        """Helper routine for fileids_altered_by_revision_ids.
2124
1838
 
2125
1839
        This performs the translation of xml lines to revision ids.
2126
1840
 
2127
1841
        :param line_iterator: An iterator of lines, origin_version_id
2128
 
        :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
2129
1843
            set or other type which supports efficient __contains__ lookups, as
2130
 
            the revision key from each parsed line will be looked up in the
2131
 
            revision_keys filter.
 
1844
            the revision id from each parsed line will be looked up in the
 
1845
            revision_ids filter.
2132
1846
        :return: a dictionary mapping altered file-ids to an iterable of
2133
1847
        revision_ids. Each altered file-ids has the exact revision_ids that
2134
1848
        altered it listed explicitly.
2135
1849
        """
2136
1850
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
2137
1851
                line_iterator).iterkeys())
2138
 
        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)
2139
1857
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
2140
 
            self._inventory_xml_lines_for_keys(parent_keys)))
 
1858
            self._inventory_xml_lines_for_keys(parents)))
2141
1859
        new_keys = seen - parent_seen
2142
1860
        result = {}
2143
1861
        setdefault = result.setdefault
2145
1863
            setdefault(key[0], set()).add(key[-1])
2146
1864
        return result
2147
1865
 
2148
 
    def _find_parent_ids_of_revisions(self, revision_ids):
2149
 
        """Find all parent ids that are mentioned in the revision graph.
2150
 
 
2151
 
        :return: set of revisions that are parents of revision_ids which are
2152
 
            not part of revision_ids themselves
2153
 
        """
2154
 
        parent_map = self.get_parent_map(revision_ids)
2155
 
        parent_ids = set()
2156
 
        map(parent_ids.update, parent_map.itervalues())
2157
 
        parent_ids.difference_update(revision_ids)
2158
 
        parent_ids.discard(_mod_revision.NULL_REVISION)
2159
 
        return parent_ids
2160
 
 
2161
 
    def _find_parent_keys_of_revisions(self, revision_keys):
2162
 
        """Similar to _find_parent_ids_of_revisions, but used with keys.
2163
 
 
2164
 
        :param revision_keys: An iterable of revision_keys.
2165
 
        :return: The parents of all revision_keys that are not already in
2166
 
            revision_keys
2167
 
        """
2168
 
        parent_map = self.revisions.get_parent_map(revision_keys)
2169
 
        parent_keys = set()
2170
 
        map(parent_keys.update, parent_map.itervalues())
2171
 
        parent_keys.difference_update(revision_keys)
2172
 
        parent_keys.discard(_mod_revision.NULL_REVISION)
2173
 
        return parent_keys
2174
 
 
2175
1866
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
2176
1867
        """Find the file ids and versions affected by revisions.
2177
1868
 
2184
1875
        """
2185
1876
        selected_keys = set((revid,) for revid in revision_ids)
2186
1877
        w = _inv_weave or self.inventories
2187
 
        return self._find_file_ids_from_xml_inventory_lines(
2188
 
            w.iter_lines_added_or_present_in_keys(
2189
 
                selected_keys, pb=None),
2190
 
            selected_keys)
 
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()
2191
1886
 
2192
1887
    def iter_files_bytes(self, desired_files):
2193
1888
        """Iterate through file versions.
2275
1970
                batch_size]
2276
1971
            if not to_query:
2277
1972
                break
2278
 
            for revision_id in to_query:
 
1973
            for rev_tree in self.revision_trees(to_query):
 
1974
                revision_id = rev_tree.get_revision_id()
2279
1975
                parent_ids = ancestors[revision_id]
2280
1976
                for text_key in revision_keys[revision_id]:
2281
1977
                    pb.update("Calculating text parents", processed_texts)
2300
1996
                            except KeyError:
2301
1997
                                inv = self.revision_tree(parent_id).inventory
2302
1998
                                inventory_cache[parent_id] = inv
2303
 
                            try:
2304
 
                                parent_entry = inv[text_key[0]]
2305
 
                            except (KeyError, errors.NoSuchId):
2306
 
                                parent_entry = None
 
1999
                            parent_entry = inv._byid.get(text_key[0], None)
2307
2000
                            if parent_entry is not None:
2308
2001
                                parent_text_key = (
2309
2002
                                    text_key[0], parent_entry.revision)
2334
2027
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
2335
2028
            'revisions'.  file-id is None unless knit-kind is 'file'.
2336
2029
        """
2337
 
        for result in self._find_file_keys_to_fetch(revision_ids, _files_pb):
2338
 
            yield result
2339
 
        del _files_pb
2340
 
        for result in self._find_non_file_keys_to_fetch(revision_ids):
2341
 
            yield result
2342
 
 
2343
 
    def _find_file_keys_to_fetch(self, revision_ids, pb):
2344
2030
        # XXX: it's a bit weird to control the inventory weave caching in this
2345
2031
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
2346
2032
        # maybe this generator should explicitly have the contract that it
2353
2039
        count = 0
2354
2040
        num_file_ids = len(file_ids)
2355
2041
        for file_id, altered_versions in file_ids.iteritems():
2356
 
            if pb is not None:
2357
 
                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)
2358
2044
            count += 1
2359
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
2360
2049
 
2361
 
    def _find_non_file_keys_to_fetch(self, revision_ids):
2362
2050
        # inventory
2363
2051
        yield ("inventory", None, revision_ids)
2364
2052
 
2381
2069
        """Get Inventory object by revision id."""
2382
2070
        return self.iter_inventories([revision_id]).next()
2383
2071
 
2384
 
    def iter_inventories(self, revision_ids, ordering=None):
 
2072
    def iter_inventories(self, revision_ids):
2385
2073
        """Get many inventories by revision_ids.
2386
2074
 
2387
2075
        This will buffer some or all of the texts used in constructing the
2389
2077
        time.
2390
2078
 
2391
2079
        :param revision_ids: The expected revision ids of the inventories.
2392
 
        :param ordering: optional ordering, e.g. 'topological'.  If not
2393
 
            specified, the order of revision_ids will be preserved (by
2394
 
            buffering if necessary).
2395
2080
        :return: An iterator of inventories.
2396
2081
        """
2397
2082
        if ((None in revision_ids)
2398
2083
            or (_mod_revision.NULL_REVISION in revision_ids)):
2399
2084
            raise ValueError('cannot get null revision inventory')
2400
 
        return self._iter_inventories(revision_ids, ordering)
 
2085
        return self._iter_inventories(revision_ids)
2401
2086
 
2402
 
    def _iter_inventories(self, revision_ids, ordering):
 
2087
    def _iter_inventories(self, revision_ids):
2403
2088
        """single-document based inventory iteration."""
2404
 
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2405
 
        for text, revision_id in inv_xmls:
2406
 
            yield self._deserialise_inventory(revision_id, text)
 
2089
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
 
2090
            yield self.deserialise_inventory(revision_id, text)
2407
2091
 
2408
 
    def _iter_inventory_xmls(self, revision_ids, ordering):
2409
 
        if ordering is None:
2410
 
            order_as_requested = True
2411
 
            ordering = 'unordered'
2412
 
        else:
2413
 
            order_as_requested = False
 
2092
    def _iter_inventory_xmls(self, revision_ids):
2414
2093
        keys = [(revision_id,) for revision_id in revision_ids]
2415
 
        if not keys:
2416
 
            return
2417
 
        if order_as_requested:
2418
 
            key_iter = iter(keys)
2419
 
            next_key = key_iter.next()
2420
 
        stream = self.inventories.get_record_stream(keys, ordering, True)
 
2094
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2421
2095
        text_chunks = {}
2422
2096
        for record in stream:
2423
2097
            if record.storage_kind != 'absent':
2424
 
                chunks = record.get_bytes_as('chunked')
2425
 
                if order_as_requested:
2426
 
                    text_chunks[record.key] = chunks
2427
 
                else:
2428
 
                    yield ''.join(chunks), record.key[-1]
 
2098
                text_chunks[record.key] = record.get_bytes_as('chunked')
2429
2099
            else:
2430
2100
                raise errors.NoSuchRevision(self, record.key)
2431
 
            if order_as_requested:
2432
 
                # Yield as many results as we can while preserving order.
2433
 
                while next_key in text_chunks:
2434
 
                    chunks = text_chunks.pop(next_key)
2435
 
                    yield ''.join(chunks), next_key[-1]
2436
 
                    try:
2437
 
                        next_key = key_iter.next()
2438
 
                    except StopIteration:
2439
 
                        # We still want to fully consume the get_record_stream,
2440
 
                        # just in case it is not actually finished at this point
2441
 
                        next_key = None
2442
 
                        break
 
2101
        for key in keys:
 
2102
            chunks = text_chunks.pop(key)
 
2103
            yield ''.join(chunks), key[-1]
2443
2104
 
2444
 
    def _deserialise_inventory(self, revision_id, xml):
 
2105
    def deserialise_inventory(self, revision_id, xml):
2445
2106
        """Transform the xml into an inventory object.
2446
2107
 
2447
2108
        :param revision_id: The expected revision id of the inventory.
2448
2109
        :param xml: A serialised inventory.
2449
2110
        """
2450
2111
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2451
 
                    entry_cache=self._inventory_entry_cache,
2452
 
                    return_from_cache=self._safe_to_return_from_cache)
 
2112
                    entry_cache=self._inventory_entry_cache)
2453
2113
        if result.revision_id != revision_id:
2454
2114
            raise AssertionError('revision id mismatch %s != %s' % (
2455
2115
                result.revision_id, revision_id))
2456
2116
        return result
2457
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
 
2458
2124
    def get_serializer_format(self):
2459
2125
        return self._serializer.format_num
2460
2126
 
2461
2127
    @needs_read_lock
2462
 
    def _get_inventory_xml(self, revision_id):
2463
 
        """Get serialized inventory as a string."""
2464
 
        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])
2465
2131
        try:
2466
2132
            text, revision_id = texts.next()
2467
2133
        except StopIteration:
2468
2134
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2469
2135
        return text
2470
2136
 
2471
 
    def get_rev_id_for_revno(self, revno, known_pair):
2472
 
        """Return the revision id of a revno, given a later (revno, revid)
2473
 
        pair in the same history.
2474
 
 
2475
 
        :return: if found (True, revid).  If the available history ran out
2476
 
            before reaching the revno, then this returns
2477
 
            (False, (closest_revno, closest_revid)).
 
2137
    @needs_read_lock
 
2138
    def get_inventory_sha1(self, revision_id):
 
2139
        """Return the sha1 hash of the inventory entry
2478
2140
        """
2479
 
        known_revno, known_revid = known_pair
2480
 
        partial_history = [known_revid]
2481
 
        distance_from_known = known_revno - revno
2482
 
        if distance_from_known < 0:
2483
 
            raise ValueError(
2484
 
                'requested revno (%d) is later than given known revno (%d)'
2485
 
                % (revno, known_revno))
2486
 
        try:
2487
 
            _iter_for_revno(
2488
 
                self, partial_history, stop_index=distance_from_known)
2489
 
        except errors.RevisionNotPresent, err:
2490
 
            if err.revision_id == known_revid:
2491
 
                # The start revision (known_revid) wasn't found.
2492
 
                raise
2493
 
            # This is a stacked repository with no fallbacks, or a there's a
2494
 
            # left-hand ghost.  Either way, even though the revision named in
2495
 
            # the error isn't in this repo, we know it's the next step in this
2496
 
            # left-hand history.
2497
 
            partial_history.append(err.revision_id)
2498
 
        if len(partial_history) <= distance_from_known:
2499
 
            # Didn't find enough history to get a revid for the revno.
2500
 
            earliest_revno = known_revno - len(partial_history) + 1
2501
 
            return (False, (earliest_revno, partial_history[-1]))
2502
 
        if len(partial_history) - 1 > distance_from_known:
2503
 
            raise AssertionError('_iter_for_revno returned too much history')
2504
 
        return (True, partial_history[-1])
 
2141
        return self.get_revision(revision_id).inventory_sha1
2505
2142
 
2506
2143
    def iter_reverse_revision_history(self, revision_id):
2507
2144
        """Iterate backwards through revision ids in the lefthand history
2514
2151
        while True:
2515
2152
            if next_id in (None, _mod_revision.NULL_REVISION):
2516
2153
                return
2517
 
            try:
2518
 
                parents = graph.get_parent_map([next_id])[next_id]
2519
 
            except KeyError:
2520
 
                raise errors.RevisionNotPresent(next_id, self)
2521
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]
2522
2161
            if len(parents) == 0:
2523
2162
                return
2524
2163
            else:
2525
2164
                next_id = parents[0]
2526
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)
 
2181
 
2527
2182
    def is_shared(self):
2528
2183
        """Return True if this repository is flagged as a shared repository."""
2529
2184
        raise NotImplementedError(self.is_shared)
2563
2218
            return RevisionTree(self, Inventory(root_id=None),
2564
2219
                                _mod_revision.NULL_REVISION)
2565
2220
        else:
2566
 
            inv = self.get_inventory(revision_id)
 
2221
            inv = self.get_revision_inventory(revision_id)
2567
2222
            return RevisionTree(self, inv, revision_id)
2568
2223
 
2569
2224
    def revision_trees(self, revision_ids):
2622
2277
            keys = tsort.topo_sort(parent_map)
2623
2278
        return [None] + list(keys)
2624
2279
 
2625
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
2280
    def pack(self):
2626
2281
        """Compress the data within the repository.
2627
2282
 
2628
2283
        This operation only makes sense for some repository types. For other
2631
2286
        This stub method does not require a lock, but subclasses should use
2632
2287
        @needs_write_lock as this is a long running call its reasonable to
2633
2288
        implicitly lock for the user.
2634
 
 
2635
 
        :param hint: If not supplied, the whole repository is packed.
2636
 
            If supplied, the repository may use the hint parameter as a
2637
 
            hint for the parts of the repository to pack. A hint can be
2638
 
            obtained from the result of commit_write_group(). Out of
2639
 
            date hints are simply ignored, because concurrent operations
2640
 
            can obsolete them rapidly.
2641
 
 
2642
 
        :param clean_obsolete_packs: Clean obsolete packs immediately after
2643
 
            the pack operation.
2644
2289
        """
2645
2290
 
2646
2291
    def get_transaction(self):
2647
2292
        return self.control_files.get_transaction()
2648
2293
 
2649
2294
    def get_parent_map(self, revision_ids):
2650
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
2295
        """See graph._StackedParentsProvider.get_parent_map"""
2651
2296
        # revisions index works in keys; this just works in revisions
2652
2297
        # therefore wrap and unwrap
2653
2298
        query_keys = []
2662
2307
        for ((revision_id,), parent_keys) in \
2663
2308
                self.revisions.get_parent_map(query_keys).iteritems():
2664
2309
            if parent_keys:
2665
 
                result[revision_id] = tuple([parent_revid
2666
 
                    for (parent_revid,) in parent_keys])
 
2310
                result[revision_id] = tuple(parent_revid
 
2311
                    for (parent_revid,) in parent_keys)
2667
2312
            else:
2668
2313
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2669
2314
        return result
2671
2316
    def _make_parents_provider(self):
2672
2317
        return self
2673
2318
 
2674
 
    @needs_read_lock
2675
 
    def get_known_graph_ancestry(self, revision_ids):
2676
 
        """Return the known graph for a set of revision ids and their ancestors.
2677
 
        """
2678
 
        st = static_tuple.StaticTuple
2679
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
2680
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
2681
 
        return graph.GraphThunkIdsToKeys(known_graph)
2682
 
 
2683
2319
    def get_graph(self, other_repository=None):
2684
2320
        """Return the graph walker for this repository format"""
2685
2321
        parents_provider = self._make_parents_provider()
2686
2322
        if (other_repository is not None and
2687
2323
            not self.has_same_location(other_repository)):
2688
 
            parents_provider = graph.StackedParentsProvider(
 
2324
            parents_provider = graph._StackedParentsProvider(
2689
2325
                [parents_provider, other_repository._make_parents_provider()])
2690
2326
        return graph.Graph(parents_provider)
2691
2327
 
2692
 
    def _get_versioned_file_checker(self, text_key_references=None,
2693
 
        ancestors=None):
 
2328
    def _get_versioned_file_checker(self, text_key_references=None):
2694
2329
        """Return an object suitable for checking versioned files.
2695
2330
        
2696
2331
        :param text_key_references: if non-None, an already built
2698
2333
            to whether they were referred to by the inventory of the
2699
2334
            revision_id that they contain. If None, this will be
2700
2335
            calculated.
2701
 
        :param ancestors: Optional result from
2702
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2703
 
            available.
2704
2336
        """
2705
2337
        return _VersionedFileChecker(self,
2706
 
            text_key_references=text_key_references, ancestors=ancestors)
 
2338
            text_key_references=text_key_references)
2707
2339
 
2708
2340
    def revision_ids_to_search_result(self, result_set):
2709
2341
        """Convert a set of revision ids to a graph SearchResult."""
2759
2391
        return record.get_bytes_as('fulltext')
2760
2392
 
2761
2393
    @needs_read_lock
2762
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
2394
    def check(self, revision_ids=None):
2763
2395
        """Check consistency of all history of given revision_ids.
2764
2396
 
2765
2397
        Different repository implementations should override _check().
2766
2398
 
2767
2399
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2768
2400
             will be checked.  Typically the last revision_id of a branch.
2769
 
        :param callback_refs: A dict of check-refs to resolve and callback
2770
 
            the check/_check method on the items listed as wanting the ref.
2771
 
            see bzrlib.check.
2772
 
        :param check_repo: If False do not check the repository contents, just 
2773
 
            calculate the data callback_refs requires and call them back.
2774
2401
        """
2775
 
        return self._check(revision_ids, callback_refs=callback_refs,
2776
 
            check_repo=check_repo)
 
2402
        return self._check(revision_ids)
2777
2403
 
2778
 
    def _check(self, revision_ids, callback_refs, check_repo):
2779
 
        result = check.Check(self, check_repo=check_repo)
2780
 
        result.check(callback_refs)
 
2404
    def _check(self, revision_ids):
 
2405
        result = check.Check(self)
 
2406
        result.check()
2781
2407
        return result
2782
2408
 
2783
 
    def _warn_if_deprecated(self, branch=None):
 
2409
    def _warn_if_deprecated(self):
2784
2410
        global _deprecation_warning_done
2785
2411
        if _deprecation_warning_done:
2786
2412
            return
2787
 
        try:
2788
 
            if branch is None:
2789
 
                conf = config.GlobalConfig()
2790
 
            else:
2791
 
                conf = branch.get_config()
2792
 
            if conf.suppress_warning('format_deprecation'):
2793
 
                return
2794
 
            warning("Format %s for %s is deprecated -"
2795
 
                    " please use 'bzr upgrade' to get better performance"
2796
 
                    % (self._format, self.bzrdir.transport.base))
2797
 
        finally:
2798
 
            _deprecation_warning_done = True
 
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))
2799
2416
 
2800
2417
    def supports_rich_root(self):
2801
2418
        return self._format.rich_root_data
2875
2492
    """
2876
2493
    repository.start_write_group()
2877
2494
    try:
2878
 
        inventory_cache = lru_cache.LRUCache(10)
2879
2495
        for n, (revision, revision_tree, signature) in enumerate(iterable):
2880
 
            _install_revision(repository, revision, revision_tree, signature,
2881
 
                inventory_cache)
 
2496
            _install_revision(repository, revision, revision_tree, signature)
2882
2497
            if pb is not None:
2883
2498
                pb.update('Transferring revisions', n + 1, num_revisions)
2884
2499
    except:
2888
2503
        repository.commit_write_group()
2889
2504
 
2890
2505
 
2891
 
def _install_revision(repository, rev, revision_tree, signature,
2892
 
    inventory_cache):
 
2506
def _install_revision(repository, rev, revision_tree, signature):
2893
2507
    """Install all revision data into a repository."""
2894
2508
    present_parents = []
2895
2509
    parent_trees = {}
2932
2546
        repository.texts.add_lines(text_key, text_parents, lines)
2933
2547
    try:
2934
2548
        # install the inventory
2935
 
        if repository._format._commit_inv_deltas and len(rev.parent_ids):
2936
 
            # Cache this inventory
2937
 
            inventory_cache[rev.revision_id] = inv
2938
 
            try:
2939
 
                basis_inv = inventory_cache[rev.parent_ids[0]]
2940
 
            except KeyError:
2941
 
                repository.add_inventory(rev.revision_id, inv, present_parents)
2942
 
            else:
2943
 
                delta = inv._make_delta(basis_inv)
2944
 
                repository.add_inventory_by_delta(rev.parent_ids[0], delta,
2945
 
                    rev.revision_id, present_parents)
2946
 
        else:
2947
 
            repository.add_inventory(rev.revision_id, inv, present_parents)
 
2549
        repository.add_inventory(rev.revision_id, inv, present_parents)
2948
2550
    except errors.RevisionAlreadyPresent:
2949
2551
        pass
2950
2552
    if signature is not None:
3057
2659
    # Can this repository be given external locations to lookup additional
3058
2660
    # data. Set to True or False in derived classes.
3059
2661
    supports_external_lookups = None
3060
 
    # Does this format support CHK bytestring lookups. Set to True or False in
3061
 
    # derived classes.
3062
 
    supports_chks = None
3063
 
    # Should commit add an inventory, or an inventory delta to the repository.
3064
 
    _commit_inv_deltas = True
3065
2662
    # What order should fetch operations request streams in?
3066
2663
    # The default is unordered as that is the cheapest for an origin to
3067
2664
    # provide.
3077
2674
    # Does this format have < O(tree_size) delta generation. Used to hint what
3078
2675
    # code path for commit, amongst other things.
3079
2676
    fast_deltas = None
3080
 
    # Does doing a pack operation compress data? Useful for the pack UI command
3081
 
    # (so if there is one pack, the operation can still proceed because it may
3082
 
    # help), and for fetching when data won't have come from the same
3083
 
    # compressor.
3084
 
    pack_compresses = False
3085
 
    # Does the repository inventory storage understand references to trees?
3086
 
    supports_tree_reference = None
3087
 
    # Is the format experimental ?
3088
 
    experimental = False
3089
2677
 
3090
 
    def __repr__(self):
3091
 
        return "%s()" % self.__class__.__name__
 
2678
    def __str__(self):
 
2679
        return "<%s>" % self.__class__.__name__
3092
2680
 
3093
2681
    def __eq__(self, other):
3094
2682
        # format objects are generally stateless
3107
2695
        """
3108
2696
        try:
3109
2697
            transport = a_bzrdir.get_repository_transport(None)
3110
 
            format_string = transport.get_bytes("format")
 
2698
            format_string = transport.get("format").read()
3111
2699
            return format_registry.get(format_string)
3112
2700
        except errors.NoSuchFile:
3113
2701
            raise errors.NoRepositoryPresent(a_bzrdir)
3195
2783
        raise NotImplementedError(self.network_name)
3196
2784
 
3197
2785
    def check_conversion_target(self, target_format):
3198
 
        if self.rich_root_data and not target_format.rich_root_data:
3199
 
            raise errors.BadConversionTarget(
3200
 
                'Does not support rich root data.', target_format,
3201
 
                from_format=self)
3202
 
        if (self.supports_tree_reference and 
3203
 
            not getattr(target_format, 'supports_tree_reference', False)):
3204
 
            raise errors.BadConversionTarget(
3205
 
                'Does not support nested trees', target_format,
3206
 
                from_format=self)
 
2786
        raise NotImplementedError(self.check_conversion_target)
3207
2787
 
3208
2788
    def open(self, a_bzrdir, _found=False):
3209
2789
        """Return an instance of this format for the bzrdir a_bzrdir.
3212
2792
        """
3213
2793
        raise NotImplementedError(self.open)
3214
2794
 
3215
 
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
3216
 
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
3217
 
        hooks = BzrDir.hooks['post_repo_init']
3218
 
        if not hooks:
3219
 
            return
3220
 
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
3221
 
        for hook in hooks:
3222
 
            hook(params)
3223
 
 
3224
2795
 
3225
2796
class MetaDirRepositoryFormat(RepositoryFormat):
3226
2797
    """Common base class for the new repositories using the metadir layout."""
3361
2932
    )
3362
2933
 
3363
2934
# Development formats.
3364
 
# 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
    )
3365
2941
format_registry.register_lazy(
3366
2942
    ("Bazaar development format 2 with subtree support "
3367
2943
        "(needs bzr.dev from before 1.8)\n"),
3369
2945
    'RepositoryFormatPackDevelopment2Subtree',
3370
2946
    )
3371
2947
 
3372
 
# 1.14->1.16 go below here
3373
 
format_registry.register_lazy(
3374
 
    'Bazaar development format - group compression and chk inventory'
3375
 
        ' (needs bzr.dev from 1.14)\n',
3376
 
    'bzrlib.repofmt.groupcompress_repo',
3377
 
    'RepositoryFormatCHK1',
3378
 
    )
3379
 
 
3380
 
format_registry.register_lazy(
3381
 
    'Bazaar development format - chk repository with bencode revision '
3382
 
        'serialization (needs bzr.dev from 1.16)\n',
3383
 
    'bzrlib.repofmt.groupcompress_repo',
3384
 
    'RepositoryFormatCHK2',
3385
 
    )
3386
 
format_registry.register_lazy(
3387
 
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
3388
 
    'bzrlib.repofmt.groupcompress_repo',
3389
 
    'RepositoryFormat2a',
3390
 
    )
3391
 
 
3392
2948
 
3393
2949
class InterRepository(InterObject):
3394
2950
    """This class represents operations taking place between two repositories.
3431
2987
 
3432
2988
        :param revision_id: if None all content is copied, if NULL_REVISION no
3433
2989
                            content is copied.
3434
 
        :param pb: ignored.
 
2990
        :param pb: optional progress bar to use for progress reports. If not
 
2991
                   provided a default one will be created.
3435
2992
        :return: None.
3436
2993
        """
3437
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3438
2994
        from bzrlib.fetch import RepoFetcher
3439
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
3440
 
        if self.source._format.network_name() != self.target._format.network_name():
3441
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
3442
 
                from_format=self.source._format,
3443
 
                to_format=self.target._format)
3444
2995
        f = RepoFetcher(to_repository=self.target,
3445
2996
                               from_repository=self.source,
3446
2997
                               last_revision=revision_id,
3447
2998
                               fetch_spec=fetch_spec,
3448
 
                               find_ghosts=find_ghosts)
 
2999
                               pb=pb, find_ghosts=find_ghosts)
3449
3000
 
3450
3001
    def _walk_to_common_revisions(self, revision_ids):
3451
3002
        """Walk out from revision_ids in source to revisions target has.
3455
3006
        """
3456
3007
        target_graph = self.target.get_graph()
3457
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())
3458
3016
        missing_revs = set()
3459
3017
        source_graph = self.source.get_graph()
3460
3018
        # ensure we don't pay silly lookup costs.
3620
3178
                self.target.texts.insert_record_stream(
3621
3179
                    self.source.texts.get_record_stream(
3622
3180
                        self.source.texts.keys(), 'topological', False))
3623
 
                pb.update('Copying inventory', 0, 1)
 
3181
                pb.update('copying inventory', 0, 1)
3624
3182
                self.target.inventories.insert_record_stream(
3625
3183
                    self.source.inventories.get_record_stream(
3626
3184
                        self.source.inventories.keys(), 'topological', False))
3740
3298
        return self.source.revision_ids_to_search_result(result_set)
3741
3299
 
3742
3300
 
3743
 
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):
3744
3436
 
3745
3437
    @classmethod
3746
3438
    def _get_repo_format_to_test(self):
3749
3441
    @staticmethod
3750
3442
    def is_compatible(source, target):
3751
3443
        """Be compatible with Knit2 source and Knit3 target"""
3752
 
        # This is redundant with format.check_conversion_target(), however that
3753
 
        # raises an exception, and we just want to say "False" as in we won't
3754
 
        # support converting between these formats.
3755
 
        if 'IDS_never' in debug.debug_flags:
3756
 
            return False
3757
 
        if source.supports_rich_root() and not target.supports_rich_root():
3758
 
            return False
3759
 
        if (source._format.supports_tree_reference
3760
 
            and not target._format.supports_tree_reference):
3761
 
            return False
3762
 
        if target._fallback_repositories and target._format.supports_chks:
3763
 
            # IDS doesn't know how to copy CHKs for the parent inventories it
3764
 
            # adds to stacked repos.
3765
 
            return False
3766
 
        if 'IDS_always' in debug.debug_flags:
3767
 
            return True
3768
 
        # Only use this code path for local source and target.  IDS does far
3769
 
        # too much IO (both bandwidth and roundtrips) over a network.
3770
 
        if not source.bzrdir.transport.base.startswith('file:///'):
3771
 
            return False
3772
 
        if not target.bzrdir.transport.base.startswith('file:///'):
 
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)):
3773
3450
            return False
3774
3451
        return True
3775
3452
 
3776
 
    def _get_trees(self, revision_ids, cache):
3777
 
        possible_trees = []
3778
 
        for rev_id in revision_ids:
3779
 
            if rev_id in cache:
3780
 
                possible_trees.append((rev_id, cache[rev_id]))
3781
 
            else:
3782
 
                # Not cached, but inventory might be present anyway.
3783
 
                try:
3784
 
                    tree = self.source.revision_tree(rev_id)
3785
 
                except errors.NoSuchRevision:
3786
 
                    # Nope, parent is ghost.
3787
 
                    pass
3788
 
                else:
3789
 
                    cache[rev_id] = tree
3790
 
                    possible_trees.append((rev_id, tree))
3791
 
        return possible_trees
3792
 
 
3793
 
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
 
3453
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
3794
3454
        """Get the best delta and base for this revision.
3795
3455
 
3796
3456
        :return: (basis_id, delta)
3797
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]))
3798
3465
        deltas = []
3799
 
        # Generate deltas against each tree, to find the shortest.
3800
 
        texts_possibly_new_in_tree = set()
3801
3466
        for basis_id, basis_tree in possible_trees:
3802
3467
            delta = tree.inventory._make_delta(basis_tree.inventory)
3803
 
            for old_path, new_path, file_id, new_entry in delta:
3804
 
                if new_path is None:
3805
 
                    # This file_id isn't present in the new rev, so we don't
3806
 
                    # care about it.
3807
 
                    continue
3808
 
                if not new_path:
3809
 
                    # Rich roots are handled elsewhere...
3810
 
                    continue
3811
 
                kind = new_entry.kind
3812
 
                if kind != 'directory' and kind != 'file':
3813
 
                    # No text record associated with this inventory entry.
3814
 
                    continue
3815
 
                # This is a directory or file that has changed somehow.
3816
 
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3817
3468
            deltas.append((len(delta), basis_id, delta))
3818
3469
        deltas.sort()
3819
3470
        return deltas[0][1:]
3820
3471
 
3821
 
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
3822
 
        """Find all parent revisions that are absent, but for which the
3823
 
        inventory is present, and copy those inventories.
3824
 
 
3825
 
        This is necessary to preserve correctness when the source is stacked
3826
 
        without fallbacks configured.  (Note that in cases like upgrade the
3827
 
        source may be not have _fallback_repositories even though it is
3828
 
        stacked.)
3829
 
        """
3830
 
        parent_revs = set()
3831
 
        for parents in parent_map.values():
3832
 
            parent_revs.update(parents)
3833
 
        present_parents = self.source.get_parent_map(parent_revs)
3834
 
        absent_parents = set(parent_revs).difference(present_parents)
3835
 
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
3836
 
            (rev_id,) for rev_id in absent_parents)
3837
 
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
3838
 
        for parent_tree in self.source.revision_trees(parent_inv_ids):
3839
 
            current_revision_id = parent_tree.get_revision_id()
3840
 
            parents_parents_keys = parent_invs_keys_for_stacking[
3841
 
                (current_revision_id,)]
3842
 
            parents_parents = [key[-1] for key in parents_parents_keys]
3843
 
            basis_id = _mod_revision.NULL_REVISION
3844
 
            basis_tree = self.source.revision_tree(basis_id)
3845
 
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
3846
 
            self.target.add_inventory_by_delta(
3847
 
                basis_id, delta, current_revision_id, parents_parents)
3848
 
            cache[current_revision_id] = parent_tree
3849
 
 
3850
 
    def _fetch_batch(self, revision_ids, basis_id, cache, a_graph=None):
 
3472
    def _fetch_batch(self, revision_ids, basis_id, cache):
3851
3473
        """Fetch across a few revisions.
3852
3474
 
3853
3475
        :param revision_ids: The revisions to copy
3854
3476
        :param basis_id: The revision_id of a tree that must be in cache, used
3855
3477
            as a basis for delta when no other base is available
3856
3478
        :param cache: A cache of RevisionTrees that we can use.
3857
 
        :param a_graph: A Graph object to determine the heads() of the
3858
 
            rich-root data stream.
3859
3479
        :return: The revision_id of the last converted tree. The RevisionTree
3860
3480
            for it will be in cache
3861
3481
        """
3862
3482
        # Walk though all revisions; get inventory deltas, copy referenced
3863
3483
        # texts that delta references, insert the delta, revision and
3864
3484
        # signature.
3865
 
        root_keys_to_create = set()
3866
3485
        text_keys = set()
3867
3486
        pending_deltas = []
3868
3487
        pending_revisions = []
3869
3488
        parent_map = self.source.get_parent_map(revision_ids)
3870
 
        self._fetch_parent_invs_for_stacking(parent_map, cache)
3871
 
        self.source._safe_to_return_from_cache = True
3872
3489
        for tree in self.source.revision_trees(revision_ids):
3873
 
            # Find a inventory delta for this revision.
3874
 
            # Find text entries that need to be copied, too.
3875
3490
            current_revision_id = tree.get_revision_id()
3876
3491
            parent_ids = parent_map.get(current_revision_id, ())
3877
 
            parent_trees = self._get_trees(parent_ids, cache)
3878
 
            possible_trees = list(parent_trees)
3879
 
            if len(possible_trees) == 0:
3880
 
                # There either aren't any parents, or the parents are ghosts,
3881
 
                # so just use the last converted tree.
3882
 
                possible_trees.append((basis_id, cache[basis_id]))
3883
3492
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3884
 
                                                           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))
3885
3502
            revision = self.source.get_revision(current_revision_id)
3886
3503
            pending_deltas.append((basis_id, delta,
3887
3504
                current_revision_id, revision.parent_ids))
3888
 
            if self._converting_to_rich_root:
3889
 
                self._revision_id_to_root_id[current_revision_id] = \
3890
 
                    tree.get_root_id()
3891
 
            # Determine which texts are in present in this revision but not in
3892
 
            # any of the available parents.
3893
 
            texts_possibly_new_in_tree = set()
3894
 
            for old_path, new_path, file_id, entry in delta:
3895
 
                if new_path is None:
3896
 
                    # This file_id isn't present in the new rev
3897
 
                    continue
3898
 
                if not new_path:
3899
 
                    # This is the root
3900
 
                    if not self.target.supports_rich_root():
3901
 
                        # The target doesn't support rich root, so we don't
3902
 
                        # copy
3903
 
                        continue
3904
 
                    if self._converting_to_rich_root:
3905
 
                        # This can't be copied normally, we have to insert
3906
 
                        # it specially
3907
 
                        root_keys_to_create.add((file_id, entry.revision))
3908
 
                        continue
3909
 
                kind = entry.kind
3910
 
                texts_possibly_new_in_tree.add((file_id, entry.revision))
3911
 
            for basis_id, basis_tree in possible_trees:
3912
 
                basis_inv = basis_tree.inventory
3913
 
                for file_key in list(texts_possibly_new_in_tree):
3914
 
                    file_id, file_revision = file_key
3915
 
                    try:
3916
 
                        entry = basis_inv[file_id]
3917
 
                    except errors.NoSuchId:
3918
 
                        continue
3919
 
                    if entry.revision == file_revision:
3920
 
                        texts_possibly_new_in_tree.remove(file_key)
3921
 
            text_keys.update(texts_possibly_new_in_tree)
3922
3505
            pending_revisions.append(revision)
3923
3506
            cache[current_revision_id] = tree
3924
3507
            basis_id = current_revision_id
3925
 
        self.source._safe_to_return_from_cache = False
3926
3508
        # Copy file texts
3927
3509
        from_texts = self.source.texts
3928
3510
        to_texts = self.target.texts
3929
 
        if root_keys_to_create:
3930
 
            root_stream = _mod_fetch._new_root_data_stream(
3931
 
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
3932
 
                self.source, graph=a_graph)
3933
 
            to_texts.insert_record_stream(root_stream)
3934
3511
        to_texts.insert_record_stream(from_texts.get_record_stream(
3935
3512
            text_keys, self.target._format._fetch_order,
3936
3513
            not self.target._format._fetch_uses_deltas))
3937
 
        # insert inventory deltas
 
3514
        # insert deltas
3938
3515
        for delta in pending_deltas:
3939
3516
            self.target.add_inventory_by_delta(*delta)
3940
 
        if self.target._fallback_repositories:
3941
 
            # Make sure this stacked repository has all the parent inventories
3942
 
            # for the new revisions that we are about to insert.  We do this
3943
 
            # before adding the revisions so that no revision is added until
3944
 
            # all the inventories it may depend on are added.
3945
 
            # Note that this is overzealous, as we may have fetched these in an
3946
 
            # earlier batch.
3947
 
            parent_ids = set()
3948
 
            revision_ids = set()
3949
 
            for revision in pending_revisions:
3950
 
                revision_ids.add(revision.revision_id)
3951
 
                parent_ids.update(revision.parent_ids)
3952
 
            parent_ids.difference_update(revision_ids)
3953
 
            parent_ids.discard(_mod_revision.NULL_REVISION)
3954
 
            parent_map = self.source.get_parent_map(parent_ids)
3955
 
            # we iterate over parent_map and not parent_ids because we don't
3956
 
            # want to try copying any revision which is a ghost
3957
 
            for parent_tree in self.source.revision_trees(parent_map):
3958
 
                current_revision_id = parent_tree.get_revision_id()
3959
 
                parents_parents = parent_map[current_revision_id]
3960
 
                possible_trees = self._get_trees(parents_parents, cache)
3961
 
                if len(possible_trees) == 0:
3962
 
                    # There either aren't any parents, or the parents are
3963
 
                    # ghosts, so just use the last converted tree.
3964
 
                    possible_trees.append((basis_id, cache[basis_id]))
3965
 
                basis_id, delta = self._get_delta_for_revision(parent_tree,
3966
 
                    parents_parents, possible_trees)
3967
 
                self.target.add_inventory_by_delta(
3968
 
                    basis_id, delta, current_revision_id, parents_parents)
3969
3517
        # insert signatures and revisions
3970
3518
        for revision in pending_revisions:
3971
3519
            try:
3983
3531
 
3984
3532
        :param revision_ids: The list of revisions to fetch. Must be in
3985
3533
            topological order.
3986
 
        :param pb: A ProgressTask
 
3534
        :param pb: A ProgressBar
3987
3535
        :return: None
3988
3536
        """
3989
3537
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3991
3539
        cache = lru_cache.LRUCache(100)
3992
3540
        cache[basis_id] = basis_tree
3993
3541
        del basis_tree # We don't want to hang on to it here
3994
 
        hints = []
3995
 
        if self._converting_to_rich_root and len(revision_ids) > 100:
3996
 
            a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
3997
 
                                                            revision_ids)
3998
 
        else:
3999
 
            a_graph = None
4000
 
 
4001
3542
        for offset in range(0, len(revision_ids), batch_size):
4002
3543
            self.target.start_write_group()
4003
3544
            try:
4004
3545
                pb.update('Transferring revisions', offset,
4005
3546
                          len(revision_ids))
4006
3547
                batch = revision_ids[offset:offset+batch_size]
4007
 
                basis_id = self._fetch_batch(batch, basis_id, cache,
4008
 
                                             a_graph=a_graph)
 
3548
                basis_id = self._fetch_batch(batch, basis_id, cache)
4009
3549
            except:
4010
 
                self.source._safe_to_return_from_cache = False
4011
3550
                self.target.abort_write_group()
4012
3551
                raise
4013
3552
            else:
4014
 
                hint = self.target.commit_write_group()
4015
 
                if hint:
4016
 
                    hints.extend(hint)
4017
 
        if hints and self.target._format.pack_compresses:
4018
 
            self.target.pack(hint=hints)
 
3553
                self.target.commit_write_group()
4019
3554
        pb.update('Transferring revisions', len(revision_ids),
4020
3555
                  len(revision_ids))
4021
3556
 
4025
3560
        """See InterRepository.fetch()."""
4026
3561
        if fetch_spec is not None:
4027
3562
            raise AssertionError("Not implemented yet...")
4028
 
        ui.ui_factory.warn_experimental_format_fetch(self)
4029
 
        if (not self.source.supports_rich_root()
4030
 
            and self.target.supports_rich_root()):
4031
 
            self._converting_to_rich_root = True
4032
 
            self._revision_id_to_root_id = {}
4033
 
        else:
4034
 
            self._converting_to_rich_root = False
4035
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
4036
 
        if self.source._format.network_name() != self.target._format.network_name():
4037
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
4038
 
                from_format=self.source._format,
4039
 
                to_format=self.target._format)
4040
3563
        revision_ids = self.target.search_missing_revision_ids(self.source,
4041
3564
            revision_id, find_ghosts=find_ghosts).get_keys()
4042
3565
        if not revision_ids:
4043
3566
            return 0, 0
4044
3567
        revision_ids = tsort.topo_sort(
4045
3568
            self.source.get_graph().get_parent_map(revision_ids))
4046
 
        if not revision_ids:
4047
 
            return 0, 0
4048
 
        # Walk though all revisions; get inventory deltas, copy referenced
4049
 
        # texts that delta references, insert the delta, revision and
4050
 
        # signature.
4051
3569
        if pb is None:
4052
3570
            my_pb = ui.ui_factory.nested_progress_bar()
4053
3571
            pb = my_pb
4090
3608
InterRepository.register_optimiser(InterSameDataRepository)
4091
3609
InterRepository.register_optimiser(InterWeaveRepo)
4092
3610
InterRepository.register_optimiser(InterKnitRepo)
 
3611
InterRepository.register_optimiser(InterPackRepo)
4093
3612
 
4094
3613
 
4095
3614
class CopyConverter(object):
4111
3630
        :param to_convert: The disk object to convert.
4112
3631
        :param pb: a progress bar to use for progress information.
4113
3632
        """
4114
 
        pb = ui.ui_factory.nested_progress_bar()
 
3633
        self.pb = pb
4115
3634
        self.count = 0
4116
3635
        self.total = 4
4117
3636
        # this is only useful with metadir layouts - separated repo content.
4118
3637
        # trigger an assertion if not such
4119
3638
        repo._format.get_format_string()
4120
3639
        self.repo_dir = repo.bzrdir
4121
 
        pb.update('Moving repository to repository.backup')
 
3640
        self.step('Moving repository to repository.backup')
4122
3641
        self.repo_dir.transport.move('repository', 'repository.backup')
4123
3642
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4124
3643
        repo._format.check_conversion_target(self.target_format)
4125
3644
        self.source_repo = repo._format.open(self.repo_dir,
4126
3645
            _found=True,
4127
3646
            _override_transport=backup_transport)
4128
 
        pb.update('Creating new repository')
 
3647
        self.step('Creating new repository')
4129
3648
        converted = self.target_format.initialize(self.repo_dir,
4130
3649
                                                  self.source_repo.is_shared())
4131
3650
        converted.lock_write()
4132
3651
        try:
4133
 
            pb.update('Copying content')
 
3652
            self.step('Copying content into repository.')
4134
3653
            self.source_repo.copy_content_into(converted)
4135
3654
        finally:
4136
3655
            converted.unlock()
4137
 
        pb.update('Deleting old repository content')
 
3656
        self.step('Deleting old repository content.')
4138
3657
        self.repo_dir.transport.delete_tree('repository.backup')
4139
 
        ui.ui_factory.note('repository converted')
4140
 
        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)
4141
3664
 
4142
3665
 
4143
3666
_unescape_map = {
4172
3695
 
4173
3696
class _VersionedFileChecker(object):
4174
3697
 
4175
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
3698
    def __init__(self, repository, text_key_references=None):
4176
3699
        self.repository = repository
4177
3700
        self.text_index = self.repository._generate_text_key_index(
4178
 
            text_key_references=text_key_references, ancestors=ancestors)
 
3701
            text_key_references=text_key_references)
4179
3702
 
4180
3703
    def calculate_file_version_parents(self, text_key):
4181
3704
        """Calculate the correct parents for a file version according to
4199
3722
            revision_id) tuples for versions that are present in this versioned
4200
3723
            file, but not used by the corresponding inventory.
4201
3724
        """
4202
 
        local_progress = None
4203
 
        if progress_bar is None:
4204
 
            local_progress = ui.ui_factory.nested_progress_bar()
4205
 
            progress_bar = local_progress
4206
 
        try:
4207
 
            return self._check_file_version_parents(texts, progress_bar)
4208
 
        finally:
4209
 
            if local_progress:
4210
 
                local_progress.finished()
4211
 
 
4212
 
    def _check_file_version_parents(self, texts, progress_bar):
4213
 
        """See check_file_version_parents."""
4214
3725
        wrong_parents = {}
4215
3726
        self.file_ids = set([file_id for file_id, _ in
4216
3727
            self.text_index.iterkeys()])
4217
3728
        # text keys is now grouped by file_id
 
3729
        n_weaves = len(self.file_ids)
 
3730
        files_in_revisions = {}
 
3731
        revisions_of_files = {}
4218
3732
        n_versions = len(self.text_index)
4219
3733
        progress_bar.update('loading text store', 0, n_versions)
4220
3734
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4222
3736
        text_keys = self.repository.texts.keys()
4223
3737
        unused_keys = frozenset(text_keys) - set(self.text_index)
4224
3738
        for num, key in enumerate(self.text_index.iterkeys()):
4225
 
            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)
4226
3741
            correct_parents = self.calculate_file_version_parents(key)
4227
3742
            try:
4228
3743
                knit_parents = parent_map[key]
4277
3792
        try:
4278
3793
            if resume_tokens:
4279
3794
                self.target_repo.resume_write_group(resume_tokens)
4280
 
                is_resume = True
4281
3795
            else:
4282
3796
                self.target_repo.start_write_group()
4283
 
                is_resume = False
4284
3797
            try:
4285
3798
                # locked_insert_stream performs a commit|suspend.
4286
 
                return self._locked_insert_stream(stream, src_format, is_resume)
 
3799
                return self._locked_insert_stream(stream, src_format)
4287
3800
            except:
4288
3801
                self.target_repo.abort_write_group(suppress_errors=True)
4289
3802
                raise
4290
3803
        finally:
4291
3804
            self.target_repo.unlock()
4292
3805
 
4293
 
    def _locked_insert_stream(self, stream, src_format, is_resume):
 
3806
    def _locked_insert_stream(self, stream, src_format):
4294
3807
        to_serializer = self.target_repo._format._serializer
4295
3808
        src_serializer = src_format._serializer
4296
 
        new_pack = None
4297
3809
        if to_serializer == src_serializer:
4298
3810
            # If serializers match and the target is a pack repository, set the
4299
3811
            # write cache size on the new pack.  This avoids poor performance
4313
3825
            else:
4314
3826
                new_pack.set_write_cache_size(1024*1024)
4315
3827
        for substream_type, substream in stream:
4316
 
            if 'stream' in debug.debug_flags:
4317
 
                mutter('inserting substream: %s', substream_type)
4318
3828
            if substream_type == 'texts':
4319
3829
                self.target_repo.texts.insert_record_stream(substream)
4320
3830
            elif substream_type == 'inventories':
4324
3834
                else:
4325
3835
                    self._extract_and_insert_inventories(
4326
3836
                        substream, src_serializer)
4327
 
            elif substream_type == 'inventory-deltas':
4328
 
                self._extract_and_insert_inventory_deltas(
4329
 
                    substream, src_serializer)
4330
 
            elif substream_type == 'chk_bytes':
4331
 
                # XXX: This doesn't support conversions, as it assumes the
4332
 
                #      conversion was done in the fetch code.
4333
 
                self.target_repo.chk_bytes.insert_record_stream(substream)
4334
3837
            elif substream_type == 'revisions':
4335
3838
                # This may fallback to extract-and-insert more often than
4336
3839
                # required if the serializers are different only in terms of
4345
3848
                self.target_repo.signatures.insert_record_stream(substream)
4346
3849
            else:
4347
3850
                raise AssertionError('kaboom! %s' % (substream_type,))
4348
 
        # Done inserting data, and the missing_keys calculations will try to
4349
 
        # read back from the inserted data, so flush the writes to the new pack
4350
 
        # (if this is pack format).
4351
 
        if new_pack is not None:
4352
 
            new_pack._write_data('', flush=True)
4353
 
        # Find all the new revisions (including ones from resume_tokens)
4354
 
        missing_keys = self.target_repo.get_missing_parent_inventories(
4355
 
            check_for_missing_texts=is_resume)
4356
3851
        try:
 
3852
            missing_keys = set()
4357
3853
            for prefix, versioned_file in (
4358
3854
                ('texts', self.target_repo.texts),
4359
3855
                ('inventories', self.target_repo.inventories),
4360
3856
                ('revisions', self.target_repo.revisions),
4361
3857
                ('signatures', self.target_repo.signatures),
4362
 
                ('chk_bytes', self.target_repo.chk_bytes),
4363
3858
                ):
4364
 
                if versioned_file is None:
4365
 
                    continue
4366
 
                # TODO: key is often going to be a StaticTuple object
4367
 
                #       I don't believe we can define a method by which
4368
 
                #       (prefix,) + StaticTuple will work, though we could
4369
 
                #       define a StaticTuple.sq_concat that would allow you to
4370
 
                #       pass in either a tuple or a StaticTuple as the second
4371
 
                #       object, so instead we could have:
4372
 
                #       StaticTuple(prefix) + key here...
4373
3859
                missing_keys.update((prefix,) + key for key in
4374
3860
                    versioned_file.get_missing_compression_parent_keys())
4375
3861
        except NotImplementedError:
4384
3870
                # missing keys can handle suspending a write group).
4385
3871
                write_group_tokens = self.target_repo.suspend_write_group()
4386
3872
                return write_group_tokens, missing_keys
4387
 
        hint = self.target_repo.commit_write_group()
4388
 
        if (to_serializer != src_serializer and
4389
 
            self.target_repo._format.pack_compresses):
4390
 
            self.target_repo.pack(hint=hint)
 
3873
        self.target_repo.commit_write_group()
4391
3874
        return [], set()
4392
3875
 
4393
 
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
4394
 
        target_rich_root = self.target_repo._format.rich_root_data
4395
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4396
 
        for record in substream:
4397
 
            # Insert the delta directly
4398
 
            inventory_delta_bytes = record.get_bytes_as('fulltext')
4399
 
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
4400
 
            try:
4401
 
                parse_result = deserialiser.parse_text_bytes(
4402
 
                    inventory_delta_bytes)
4403
 
            except inventory_delta.IncompatibleInventoryDelta, err:
4404
 
                trace.mutter("Incompatible delta: %s", err.msg)
4405
 
                raise errors.IncompatibleRevision(self.target_repo._format)
4406
 
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
4407
 
            revision_id = new_id
4408
 
            parents = [key[0] for key in record.parents]
4409
 
            self.target_repo.add_inventory_by_delta(
4410
 
                basis_id, inv_delta, revision_id, parents)
4411
 
 
4412
 
    def _extract_and_insert_inventories(self, substream, serializer,
4413
 
            parse_delta=None):
 
3876
    def _extract_and_insert_inventories(self, substream, serializer):
4414
3877
        """Generate a new inventory versionedfile in target, converting data.
4415
3878
 
4416
3879
        The inventory is retrieved from the source, (deserializing it), and
4417
3880
        stored in the target (reserializing it in a different format).
4418
3881
        """
4419
 
        target_rich_root = self.target_repo._format.rich_root_data
4420
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4421
3882
        for record in substream:
4422
 
            # It's not a delta, so it must be a fulltext in the source
4423
 
            # serializer's format.
4424
3883
            bytes = record.get_bytes_as('fulltext')
4425
3884
            revision_id = record.key[0]
4426
3885
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4427
3886
            parents = [key[0] for key in record.parents]
4428
3887
            self.target_repo.add_inventory(revision_id, inv, parents)
4429
 
            # No need to keep holding this full inv in memory when the rest of
4430
 
            # the substream is likely to be all deltas.
4431
 
            del inv
4432
3888
 
4433
3889
    def _extract_and_insert_revisions(self, substream, serializer):
4434
3890
        for record in substream:
4483
3939
        return [('signatures', signatures), ('revisions', revisions)]
4484
3940
 
4485
3941
    def _generate_root_texts(self, revs):
4486
 
        """This will be called by get_stream between fetching weave texts and
 
3942
        """This will be called by __fetch between fetching weave texts and
4487
3943
        fetching the inventory weave.
 
3944
 
 
3945
        Subclasses should override this if they need to generate root texts
 
3946
        after fetching weave texts.
4488
3947
        """
4489
3948
        if self._rich_root_upgrade():
4490
 
            return _mod_fetch.Inter1and2Helper(
 
3949
            import bzrlib.fetch
 
3950
            return bzrlib.fetch.Inter1and2Helper(
4491
3951
                self.from_repository).generate_root_texts(revs)
4492
3952
        else:
4493
3953
            return []
4496
3956
        phase = 'file'
4497
3957
        revs = search.get_keys()
4498
3958
        graph = self.from_repository.get_graph()
4499
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
 
3959
        revs = list(graph.iter_topo_order(revs))
4500
3960
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4501
3961
        text_keys = []
4502
3962
        for knit_kind, file_id, revisions in data_to_fetch:
4521
3981
                # will be valid.
4522
3982
                for _ in self._generate_root_texts(revs):
4523
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
4524
3987
                # we fetch only the referenced inventories because we do not
4525
3988
                # know for unselected inventories whether all their required
4526
3989
                # texts are present in the other repository - it could be
4527
3990
                # corrupt.
4528
 
                for info in self._get_inventory_stream(revs):
4529
 
                    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()))
4530
3995
            elif knit_kind == "signatures":
4531
3996
                # Nothing to do here; this will be taken care of when
4532
3997
                # _fetch_revision_texts happens.
4545
4010
        keys['texts'] = set()
4546
4011
        keys['revisions'] = set()
4547
4012
        keys['inventories'] = set()
4548
 
        keys['chk_bytes'] = set()
4549
4013
        keys['signatures'] = set()
4550
4014
        for key in missing_keys:
4551
4015
            keys[key[0]].add(key[1:])
4558
4022
                    keys['revisions'],))
4559
4023
        for substream_kind, keys in keys.iteritems():
4560
4024
            vf = getattr(self.from_repository, substream_kind)
4561
 
            if vf is None and keys:
4562
 
                    raise AssertionError(
4563
 
                        "cannot fill in keys for a versioned file we don't"
4564
 
                        " have: %s needs %s" % (substream_kind, keys))
4565
 
            if not keys:
4566
 
                # No need to stream something we don't have
4567
 
                continue
4568
 
            if substream_kind == 'inventories':
4569
 
                # Some missing keys are genuinely ghosts, filter those out.
4570
 
                present = self.from_repository.inventories.get_parent_map(keys)
4571
 
                revs = [key[0] for key in present]
4572
 
                # Get the inventory stream more-or-less as we do for the
4573
 
                # original stream; there's no reason to assume that records
4574
 
                # direct from the source will be suitable for the sink.  (Think
4575
 
                # e.g. 2a -> 1.9-rich-root).
4576
 
                for info in self._get_inventory_stream(revs, missing=True):
4577
 
                    yield info
4578
 
                continue
4579
 
 
4580
4025
            # Ask for full texts always so that we don't need more round trips
4581
4026
            # after this stream.
4582
 
            # Some of the missing keys are genuinely ghosts, so filter absent
4583
 
            # records. The Sink is responsible for doing another check to
4584
 
            # ensure that ghosts don't introduce missing data for future
4585
 
            # fetches.
4586
 
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
4587
 
                self.to_format._fetch_order, True))
 
4027
            stream = vf.get_record_stream(keys,
 
4028
                self.to_format._fetch_order, True)
4588
4029
            yield substream_kind, stream
4589
4030
 
4590
4031
    def inventory_fetch_order(self):
4597
4038
        return (not self.from_repository._format.rich_root_data and
4598
4039
            self.to_format.rich_root_data)
4599
4040
 
4600
 
    def _get_inventory_stream(self, revision_ids, missing=False):
4601
 
        from_format = self.from_repository._format
4602
 
        if (from_format.supports_chks and self.to_format.supports_chks and
4603
 
            from_format.network_name() == self.to_format.network_name()):
4604
 
            raise AssertionError(
4605
 
                "this case should be handled by GroupCHKStreamSource")
4606
 
        elif 'forceinvdeltas' in debug.debug_flags:
4607
 
            return self._get_convertable_inventory_stream(revision_ids,
4608
 
                    delta_versus_null=missing)
4609
 
        elif from_format.network_name() == self.to_format.network_name():
4610
 
            # Same format.
4611
 
            return self._get_simple_inventory_stream(revision_ids,
4612
 
                    missing=missing)
4613
 
        elif (not from_format.supports_chks and not self.to_format.supports_chks
4614
 
                and from_format._serializer == self.to_format._serializer):
4615
 
            # Essentially the same format.
4616
 
            return self._get_simple_inventory_stream(revision_ids,
4617
 
                    missing=missing)
4618
 
        else:
4619
 
            # Any time we switch serializations, we want to use an
4620
 
            # inventory-delta based approach.
4621
 
            return self._get_convertable_inventory_stream(revision_ids,
4622
 
                    delta_versus_null=missing)
4623
 
 
4624
 
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
4625
 
        # NB: This currently reopens the inventory weave in source;
4626
 
        # using a single stream interface instead would avoid this.
4627
 
        from_weave = self.from_repository.inventories
4628
 
        if missing:
4629
 
            delta_closure = True
4630
 
        else:
4631
 
            delta_closure = not self.delta_on_metadata()
4632
 
        yield ('inventories', from_weave.get_record_stream(
4633
 
            [(rev_id,) for rev_id in revision_ids],
4634
 
            self.inventory_fetch_order(), delta_closure))
4635
 
 
4636
 
    def _get_convertable_inventory_stream(self, revision_ids,
4637
 
                                          delta_versus_null=False):
4638
 
        # The two formats are sufficiently different that there is no fast
4639
 
        # path, so we need to send just inventorydeltas, which any
4640
 
        # sufficiently modern client can insert into any repository.
4641
 
        # The StreamSink code expects to be able to
4642
 
        # convert on the target, so we need to put bytes-on-the-wire that can
4643
 
        # be converted.  That means inventory deltas (if the remote is <1.19,
4644
 
        # RemoteStreamSink will fallback to VFS to insert the deltas).
4645
 
        yield ('inventory-deltas',
4646
 
           self._stream_invs_as_deltas(revision_ids,
4647
 
                                       delta_versus_null=delta_versus_null))
4648
 
 
4649
 
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
4650
 
        """Return a stream of inventory-deltas for the given rev ids.
4651
 
 
4652
 
        :param revision_ids: The list of inventories to transmit
4653
 
        :param delta_versus_null: Don't try to find a minimal delta for this
4654
 
            entry, instead compute the delta versus the NULL_REVISION. This
4655
 
            effectively streams a complete inventory. Used for stuff like
4656
 
            filling in missing parents, etc.
4657
 
        """
4658
 
        from_repo = self.from_repository
4659
 
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4660
 
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
4661
 
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
4662
 
        # method...
4663
 
        inventories = self.from_repository.iter_inventories(
4664
 
            revision_ids, 'topological')
4665
 
        format = from_repo._format
4666
 
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
4667
 
        inventory_cache = lru_cache.LRUCache(50)
4668
 
        null_inventory = from_repo.revision_tree(
4669
 
            _mod_revision.NULL_REVISION).inventory
4670
 
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
4671
 
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
4672
 
        # repo back into a non-rich-root repo ought to be allowed)
4673
 
        serializer = inventory_delta.InventoryDeltaSerializer(
4674
 
            versioned_root=format.rich_root_data,
4675
 
            tree_references=format.supports_tree_reference)
4676
 
        for inv in inventories:
4677
 
            key = (inv.revision_id,)
4678
 
            parent_keys = parent_map.get(key, ())
4679
 
            delta = None
4680
 
            if not delta_versus_null and parent_keys:
4681
 
                # The caller did not ask for complete inventories and we have
4682
 
                # some parents that we can delta against.  Make a delta against
4683
 
                # each parent so that we can find the smallest.
4684
 
                parent_ids = [parent_key[0] for parent_key in parent_keys]
4685
 
                for parent_id in parent_ids:
4686
 
                    if parent_id not in invs_sent_so_far:
4687
 
                        # We don't know that the remote side has this basis, so
4688
 
                        # we can't use it.
4689
 
                        continue
4690
 
                    if parent_id == _mod_revision.NULL_REVISION:
4691
 
                        parent_inv = null_inventory
4692
 
                    else:
4693
 
                        parent_inv = inventory_cache.get(parent_id, None)
4694
 
                        if parent_inv is None:
4695
 
                            parent_inv = from_repo.get_inventory(parent_id)
4696
 
                    candidate_delta = inv._make_delta(parent_inv)
4697
 
                    if (delta is None or
4698
 
                        len(delta) > len(candidate_delta)):
4699
 
                        delta = candidate_delta
4700
 
                        basis_id = parent_id
4701
 
            if delta is None:
4702
 
                # Either none of the parents ended up being suitable, or we
4703
 
                # were asked to delta against NULL
4704
 
                basis_id = _mod_revision.NULL_REVISION
4705
 
                delta = inv._make_delta(null_inventory)
4706
 
            invs_sent_so_far.add(inv.revision_id)
4707
 
            inventory_cache[inv.revision_id] = inv
4708
 
            delta_serialized = ''.join(
4709
 
                serializer.delta_to_lines(basis_id, key[-1], delta))
4710
 
            yield versionedfile.FulltextContentFactory(
4711
 
                key, parent_keys, None, delta_serialized)
4712
 
 
4713
 
 
4714
 
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
4715
 
                    stop_revision=None):
4716
 
    """Extend the partial history to include a given index
4717
 
 
4718
 
    If a stop_index is supplied, stop when that index has been reached.
4719
 
    If a stop_revision is supplied, stop when that revision is
4720
 
    encountered.  Otherwise, stop when the beginning of history is
4721
 
    reached.
4722
 
 
4723
 
    :param stop_index: The index which should be present.  When it is
4724
 
        present, history extension will stop.
4725
 
    :param stop_revision: The revision id which should be present.  When
4726
 
        it is encountered, history extension will stop.
4727
 
    """
4728
 
    start_revision = partial_history_cache[-1]
4729
 
    iterator = repo.iter_reverse_revision_history(start_revision)
4730
 
    try:
4731
 
        #skip the last revision in the list
4732
 
        iterator.next()
4733
 
        while True:
4734
 
            if (stop_index is not None and
4735
 
                len(partial_history_cache) > stop_index):
4736
 
                break
4737
 
            if partial_history_cache[-1] == stop_revision:
4738
 
                break
4739
 
            revision_id = iterator.next()
4740
 
            partial_history_cache.append(revision_id)
4741
 
    except StopIteration:
4742
 
        # No more history
4743
 
        return
4744