/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: John Arbash Meinel
  • Date: 2009-06-19 19:26:32 UTC
  • mto: This revision was merged to the branch mainline in revision 4466.
  • Revision ID: john@arbash-meinel.com-20090619192632-1a4ntoq61fkhlp2x
Make a note of the 'worst case' for heads.

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
24
24
    bzrdir,
25
25
    check,
26
26
    chk_map,
27
 
    config,
28
27
    debug,
29
 
    fetch as _mod_fetch,
 
28
    errors,
30
29
    fifo_cache,
31
30
    generate_ids,
32
31
    gpg,
33
32
    graph,
34
33
    inventory,
35
 
    inventory_delta,
36
34
    lazy_regex,
37
35
    lockable_files,
38
36
    lockdir,
39
37
    lru_cache,
40
38
    osutils,
41
39
    revision as _mod_revision,
42
 
    static_tuple,
43
40
    symbol_versioning,
44
 
    trace,
45
41
    tsort,
46
42
    ui,
47
43
    versionedfile,
52
48
from bzrlib.testament import Testament
53
49
""")
54
50
 
55
 
from bzrlib import (
56
 
    errors,
57
 
    registry,
58
 
    )
59
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
51
from bzrlib.decorators import needs_read_lock, needs_write_lock
60
52
from bzrlib.inter import InterObject
61
53
from bzrlib.inventory import (
62
54
    Inventory,
64
56
    ROOT_ID,
65
57
    entry_factory,
66
58
    )
67
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
 
59
from bzrlib import registry
 
60
from bzrlib.symbol_versioning import (
 
61
        deprecated_method,
 
62
        )
68
63
from bzrlib.trace import (
69
64
    log_exception_quietly, note, mutter, mutter_callsite, warning)
70
65
 
73
68
_deprecation_warning_done = False
74
69
 
75
70
 
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
71
class CommitBuilder(object):
85
72
    """Provides an interface to build up a commit.
86
73
 
220
207
            # an inventory delta was accumulated without creating a new
221
208
            # inventory.
222
209
            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(
 
210
            self.inv_sha1 = self.repository.add_inventory_by_delta(
227
211
                basis_id, self._basis_delta, self._new_revision_id,
228
212
                self.parents)
229
213
        else:
483
467
            if content_summary[2] is None:
484
468
                raise ValueError("Files must not have executable = None")
485
469
            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:
 
470
                if (# if the file length changed we have to store:
 
471
                    parent_entry.text_size != content_summary[1] or
 
472
                    # if the exec bit has changed we have to store:
489
473
                    parent_entry.executable != content_summary[2]):
490
474
                    store = True
491
475
                elif parent_entry.text_sha1 == content_summary[3]:
510
494
            ie.executable = content_summary[2]
511
495
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
512
496
            try:
513
 
                text = file_obj.read()
 
497
                lines = file_obj.readlines()
514
498
            finally:
515
499
                file_obj.close()
516
500
            try:
517
501
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
518
 
                    ie.file_id, text, heads, nostore_sha)
 
502
                    ie.file_id, lines, heads, nostore_sha)
519
503
                # Let the caller know we generated a stat fingerprint.
520
504
                fingerprint = (ie.text_sha1, stat_value)
521
505
            except errors.ExistingContent:
533
517
                # carry over:
534
518
                ie.revision = parent_entry.revision
535
519
                return self._get_delta(ie, basis_inv, path), False, None
536
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
520
            lines = []
 
521
            self._add_text_to_weave(ie.file_id, lines, heads, None)
537
522
        elif kind == 'symlink':
538
523
            current_link_target = content_summary[3]
539
524
            if not store:
547
532
                ie.symlink_target = parent_entry.symlink_target
548
533
                return self._get_delta(ie, basis_inv, path), False, None
549
534
            ie.symlink_target = current_link_target
550
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
535
            lines = []
 
536
            self._add_text_to_weave(ie.file_id, lines, heads, None)
551
537
        elif kind == 'tree-reference':
552
538
            if not store:
553
539
                if content_summary[3] != parent_entry.reference_revision:
558
544
                ie.revision = parent_entry.revision
559
545
                return self._get_delta(ie, basis_inv, path), False, None
560
546
            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)
 
547
            lines = []
 
548
            self._add_text_to_weave(ie.file_id, lines, heads, None)
565
549
        else:
566
550
            raise NotImplementedError('unknown kind')
567
551
        ie.revision = self._new_revision_id
761
745
                        entry.executable = True
762
746
                    else:
763
747
                        entry.executable = False
764
 
                    if (carry_over_possible and
 
748
                    if (carry_over_possible and 
765
749
                        parent_entry.executable == entry.executable):
766
750
                            # Check the file length, content hash after reading
767
751
                            # the file.
770
754
                        nostore_sha = None
771
755
                    file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
772
756
                    try:
773
 
                        text = file_obj.read()
 
757
                        lines = file_obj.readlines()
774
758
                    finally:
775
759
                        file_obj.close()
776
760
                    try:
777
761
                        entry.text_sha1, entry.text_size = self._add_text_to_weave(
778
 
                            file_id, text, heads, nostore_sha)
 
762
                            file_id, lines, heads, nostore_sha)
779
763
                        yield file_id, change[1][1], (entry.text_sha1, stat_value)
780
764
                    except errors.ExistingContent:
781
765
                        # No content change against a carry_over parent
790
774
                        parent_entry.symlink_target == entry.symlink_target):
791
775
                        carried_over = True
792
776
                    else:
793
 
                        self._add_text_to_weave(change[0], '', heads, None)
 
777
                        self._add_text_to_weave(change[0], [], heads, None)
794
778
                elif kind == 'directory':
795
779
                    if carry_over_possible:
796
780
                        carried_over = True
798
782
                        # Nothing to set on the entry.
799
783
                        # XXX: split into the Root and nonRoot versions.
800
784
                        if change[1][1] != '' or self.repository.supports_rich_root():
801
 
                            self._add_text_to_weave(change[0], '', heads, None)
 
785
                            self._add_text_to_weave(change[0], [], heads, None)
802
786
                elif kind == 'tree-reference':
803
787
                    if not self.repository._format.supports_tree_reference:
804
788
                        # This isn't quite sane as an error, but we shouldn't
807
791
                        # references.
808
792
                        raise errors.UnsupportedOperation(tree.add_reference,
809
793
                            self.repository)
810
 
                    reference_revision = tree.get_reference_revision(change[0])
811
 
                    entry.reference_revision = reference_revision
 
794
                    entry.reference_revision = \
 
795
                        tree.get_reference_revision(change[0])
812
796
                    if (carry_over_possible and
813
797
                        parent_entry.reference_revision == reference_revision):
814
798
                        carried_over = True
815
799
                    else:
816
 
                        self._add_text_to_weave(change[0], '', heads, None)
 
800
                        self._add_text_to_weave(change[0], [], heads, None)
817
801
                else:
818
802
                    raise AssertionError('unknown kind %r' % kind)
819
803
                if not carried_over:
828
812
                seen_root = True
829
813
        self.new_inventory = None
830
814
        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
815
            self._any_changes = True
835
816
        if not seen_root:
836
817
            # housekeeping root entry changes do not affect no-change commits.
837
818
            self._require_root_change(tree)
838
819
        self.basis_delta_revision = basis_revision_id
839
820
 
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]
 
821
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
 
822
        # Note: as we read the content directly from the tree, we know its not
 
823
        # been turned into unicode or badly split - but a broken tree
 
824
        # implementation could give us bad output from readlines() so this is
 
825
        # not a guarantee of safety. What would be better is always checking
 
826
        # the content during test suite execution. RBC 20070912
 
827
        parent_keys = tuple((file_id, parent) for parent in parents)
 
828
        return self.repository.texts.add_lines(
 
829
            (file_id, self._new_revision_id), parent_keys, new_lines,
 
830
            nostore_sha=nostore_sha, random_id=self.random_revid,
 
831
            check_content=False)[0:2]
845
832
 
846
833
 
847
834
class RootCommitBuilder(CommitBuilder):
870
857
        # versioned roots do not change unless the tree found a change.
871
858
 
872
859
 
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
860
######################################################################
891
861
# Repositories
892
862
 
893
 
 
894
 
class Repository(_RelockDebugMixin, bzrdir.ControlComponent):
 
863
class Repository(object):
895
864
    """Repository holding history for one or more branches.
896
865
 
897
866
    The repository holds and retrieves historical information including
966
935
        """
967
936
        if self._write_group is not self.get_transaction():
968
937
            # 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
938
            raise errors.BzrError(
975
939
                'mismatched lock context and write group. %r, %r' %
976
940
                (self._write_group, self.get_transaction()))
1055
1019
 
1056
1020
        :seealso: add_inventory, for the contract.
1057
1021
        """
1058
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
 
1022
        inv_lines = self._serialise_inventory_to_lines(inv)
1059
1023
        return self._inventory_add_lines(revision_id, parents,
1060
1024
            inv_lines, check_content=False)
1061
1025
 
1063
1027
                               parents, basis_inv=None, propagate_caches=False):
1064
1028
        """Add a new inventory expressed as a delta against another revision.
1065
1029
 
1066
 
        See the inventory developers documentation for the theory behind
1067
 
        inventory deltas.
1068
 
 
1069
1030
        :param basis_revision_id: The inventory id the delta was created
1070
1031
            against. (This does not have to be a direct parent.)
1071
1032
        :param delta: The inventory delta (see Inventory.apply_delta for
1110
1071
        check_content=True):
1111
1072
        """Store lines in inv_vf and return the sha1 of the inventory."""
1112
1073
        parents = [(parent,) for parent in parents]
1113
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
1074
        return self.inventories.add_lines((revision_id,), parents, lines,
1114
1075
            check_content=check_content)[0]
1115
 
        self.inventories._access.flush()
1116
 
        return result
1117
1076
 
1118
1077
    def add_revision(self, revision_id, rev, inv=None, config=None):
1119
1078
        """Add rev to the revision store as revision_id.
1195
1154
        # The old API returned a list, should this actually be a set?
1196
1155
        return parent_map.keys()
1197
1156
 
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
1157
    @staticmethod
1312
1158
    def create(a_bzrdir):
1313
1159
        """Construct the current default format repository in a_bzrdir."""
1318
1164
 
1319
1165
        :param _format: The format of the repository on disk.
1320
1166
        :param a_bzrdir: The BzrDir of the repository.
 
1167
 
 
1168
        In the future we will have a single api for all stores for
 
1169
        getting file texts, inventories and revisions, then
 
1170
        this construct will accept instances of those things.
1321
1171
        """
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
1172
        super(Repository, self).__init__()
1326
1173
        self._format = _format
1327
1174
        # the following are part of the public API for Repository:
1333
1180
        self._reconcile_does_inventory_gc = True
1334
1181
        self._reconcile_fixes_text_parents = False
1335
1182
        self._reconcile_backsup_inventory = True
 
1183
        # not right yet - should be more semantically clear ?
 
1184
        #
 
1185
        # TODO: make sure to construct the right store classes, etc, depending
 
1186
        # on whether escaping is required.
 
1187
        self._warn_if_deprecated()
1336
1188
        self._write_group = None
1337
1189
        # Additional places to query for data.
1338
1190
        self._fallback_repositories = []
1339
1191
        # An InventoryEntry cache, used during deserialization
1340
1192
        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
1193
 
1353
1194
    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
 
1195
        return '%s(%r)' % (self.__class__.__name__,
 
1196
                           self.base)
1373
1197
 
1374
1198
    def has_same_location(self, other):
1375
1199
        """Returns a boolean indicating if this repository is at the same
1403
1227
        data during reads, and allows a 'write_group' to be obtained. Write
1404
1228
        groups must be used for actual data insertion.
1405
1229
 
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
1230
        :param token: if this is already locked, then lock_write will fail
1413
1231
            unless the token matches the existing lock.
1414
1232
        :returns: a token if this instance supports tokens, otherwise None.
1417
1235
        :raises MismatchedToken: if the specified token doesn't match the token
1418
1236
            of the existing lock.
1419
1237
        :seealso: start_write_group.
1420
 
        :return: A RepositoryWriteLockResult.
 
1238
 
 
1239
        A token should be passed in if you know that you have locked the object
 
1240
        some other way, and need to synchronise this object's state with that
 
1241
        fact.
 
1242
 
 
1243
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1421
1244
        """
1422
1245
        locked = self.is_locked()
1423
 
        token = self.control_files.lock_write(token=token)
 
1246
        result = self.control_files.lock_write(token=token)
1424
1247
        if not locked:
1425
 
            self._warn_if_deprecated()
1426
 
            self._note_lock('w')
1427
1248
            for repo in self._fallback_repositories:
1428
1249
                # Writes don't affect fallback repos
1429
1250
                repo.lock_read()
1430
1251
            self._refresh_data()
1431
 
        return RepositoryWriteLockResult(self.unlock, token)
 
1252
        return result
1432
1253
 
1433
1254
    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
1255
        locked = self.is_locked()
1440
1256
        self.control_files.lock_read()
1441
1257
        if not locked:
1442
 
            self._warn_if_deprecated()
1443
 
            self._note_lock('r')
1444
1258
            for repo in self._fallback_repositories:
1445
1259
                repo.lock_read()
1446
1260
            self._refresh_data()
1447
 
        return LogicalLockResult(self.unlock)
1448
1261
 
1449
1262
    def get_physical_lock_status(self):
1450
1263
        return self.control_files.get_physical_lock_status()
1510
1323
 
1511
1324
        # now gather global repository information
1512
1325
        # XXX: This is available for many repos regardless of listability.
1513
 
        if self.user_transport.listable():
 
1326
        if self.bzrdir.root_transport.listable():
1514
1327
            # XXX: do we want to __define len__() ?
1515
1328
            # Maybe the versionedfiles object should provide a different
1516
1329
            # method to get the number of keys.
1526
1339
        :param using: If True, list only branches using this repository.
1527
1340
        """
1528
1341
        if using and not self.is_shared():
1529
 
            return self.bzrdir.list_branches()
 
1342
            try:
 
1343
                return [self.bzrdir.open_branch()]
 
1344
            except errors.NotBranchError:
 
1345
                return []
1530
1346
        class Evaluator(object):
1531
1347
 
1532
1348
            def __init__(self):
1541
1357
                    except errors.NoRepositoryPresent:
1542
1358
                        pass
1543
1359
                    else:
1544
 
                        return False, ([], repository)
 
1360
                        return False, (None, repository)
1545
1361
                self.first_call = False
1546
 
                value = (bzrdir.list_branches(), None)
 
1362
                try:
 
1363
                    value = (bzrdir.open_branch(), None)
 
1364
                except errors.NotBranchError:
 
1365
                    value = (None, None)
1547
1366
                return True, value
1548
1367
 
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)
 
1368
        branches = []
 
1369
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1370
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
1371
            if branch is not None:
 
1372
                branches.append(branch)
1554
1373
            if not using and repository is not None:
1555
 
                ret.extend(repository.find_branches())
1556
 
        return ret
 
1374
                branches.extend(repository.find_branches())
 
1375
        return branches
1557
1376
 
1558
1377
    @needs_read_lock
1559
1378
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1588
1407
        """Commit the contents accrued within the current write group.
1589
1408
 
1590
1409
        :seealso: start_write_group.
1591
 
        
1592
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1593
1410
        """
1594
1411
        if self._write_group is not self.get_transaction():
1595
1412
            # has an unlock or relock occured ?
1596
1413
            raise errors.BzrError('mismatched lock context %r and '
1597
1414
                'write group %r.' %
1598
1415
                (self.get_transaction(), self._write_group))
1599
 
        result = self._commit_write_group()
 
1416
        self._commit_write_group()
1600
1417
        self._write_group = None
1601
 
        return result
1602
1418
 
1603
1419
    def _commit_write_group(self):
1604
1420
        """Template method for per-repository write group cleanup.
1649
1465
        # but at the moment we're only checking for texts referenced by
1650
1466
        # inventories at the graph's edge.
1651
1467
        key_deps = self.revisions._index._key_dependencies
1652
 
        key_deps.satisfy_refs_for_keys(present_inventories)
 
1468
        key_deps.add_keys(present_inventories)
1653
1469
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1654
1470
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1655
1471
        missing_texts = set()
1668
1484
        return missing_keys
1669
1485
 
1670
1486
    def refresh_data(self):
1671
 
        """Re-read any data needed to synchronise with disk.
 
1487
        """Re-read any data needed to to synchronise with disk.
1672
1488
 
1673
1489
        This method is intended to be called after another repository instance
1674
1490
        (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.
 
1491
        repository. It may not be called during a write group, but may be
 
1492
        called at any other time.
1680
1493
        """
 
1494
        if self.is_in_write_group():
 
1495
            raise errors.InternalBzrError(
 
1496
                "May not refresh_data while in a write group.")
1681
1497
        self._refresh_data()
1682
1498
 
1683
1499
    def resume_write_group(self, tokens):
1721
1537
            raise errors.InternalBzrError(
1722
1538
                "May not fetch while in a write group.")
1723
1539
        # 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)):
 
1540
        if self.has_same_location(source) and fetch_spec is None:
1729
1541
            # check that last_revision is in 'from' and then return a
1730
1542
            # no-operation.
1731
1543
            if (revision_id is not None and
1756
1568
        :param revprops: Optional dictionary of revision properties.
1757
1569
        :param revision_id: Optional revision id.
1758
1570
        """
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
1571
        result = self._commit_builder_class(self, parents, config,
1764
1572
            timestamp, timezone, committer, revprops, revision_id)
1765
1573
        self.start_write_group()
1766
1574
        return result
1767
1575
 
1768
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1769
1576
    def unlock(self):
1770
1577
        if (self.control_files._lock_count == 1 and
1771
1578
            self.control_files._lock_mode == 'w'):
1893
1700
 
1894
1701
    @needs_read_lock
1895
1702
    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
 
        """
 
1703
        """Get many revisions at once."""
1901
1704
        return self._get_revisions(revision_ids)
1902
1705
 
1903
1706
    @needs_read_lock
1904
1707
    def _get_revisions(self, revision_ids):
1905
1708
        """Core work logic to get many revisions without sanity checks."""
 
1709
        for rev_id in revision_ids:
 
1710
            if not rev_id or not isinstance(rev_id, basestring):
 
1711
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1712
        keys = [(key,) for key in revision_ids]
 
1713
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1906
1714
        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
 
1715
        for record in stream:
 
1716
            if record.storage_kind == 'absent':
 
1717
                raise errors.NoSuchRevision(self, record.key[0])
 
1718
            text = record.get_bytes_as('fulltext')
 
1719
            rev = self._serializer.read_revision_from_string(text)
 
1720
            revs[record.key[0]] = rev
1911
1721
        return [revs[revid] for revid in revision_ids]
1912
1722
 
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)
 
1723
    @needs_read_lock
 
1724
    def get_revision_xml(self, revision_id):
 
1725
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1726
        #       would have already do it.
 
1727
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1728
        # TODO: this can't just be replaced by:
 
1729
        # return self._serializer.write_revision_to_string(
 
1730
        #     self.get_revision(revision_id))
 
1731
        # as cStringIO preservers the encoding unlike write_revision_to_string
 
1732
        # or some other call down the path.
 
1733
        rev = self.get_revision(revision_id)
 
1734
        rev_tmp = cStringIO.StringIO()
 
1735
        # the current serializer..
 
1736
        self._serializer.write_revision(rev, rev_tmp)
 
1737
        rev_tmp.seek(0)
 
1738
        return rev_tmp.getvalue()
1939
1739
 
1940
1740
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1941
1741
        """Produce a generator of revision deltas.
2119
1919
                    yield line, revid
2120
1920
 
2121
1921
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
2122
 
        revision_keys):
 
1922
        revision_ids):
2123
1923
        """Helper routine for fileids_altered_by_revision_ids.
2124
1924
 
2125
1925
        This performs the translation of xml lines to revision ids.
2126
1926
 
2127
1927
        :param line_iterator: An iterator of lines, origin_version_id
2128
 
        :param revision_keys: The revision ids to filter for. This should be a
 
1928
        :param revision_ids: The revision ids to filter for. This should be a
2129
1929
            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.
 
1930
            the revision id from each parsed line will be looked up in the
 
1931
            revision_ids filter.
2132
1932
        :return: a dictionary mapping altered file-ids to an iterable of
2133
1933
        revision_ids. Each altered file-ids has the exact revision_ids that
2134
1934
        altered it listed explicitly.
2135
1935
        """
2136
1936
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
2137
1937
                line_iterator).iterkeys())
2138
 
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
 
1938
        # Note that revision_ids are revision keys.
 
1939
        parent_maps = self.revisions.get_parent_map(revision_ids)
 
1940
        parents = set()
 
1941
        map(parents.update, parent_maps.itervalues())
 
1942
        parents.difference_update(revision_ids)
2139
1943
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
2140
 
            self._inventory_xml_lines_for_keys(parent_keys)))
 
1944
            self._inventory_xml_lines_for_keys(parents)))
2141
1945
        new_keys = seen - parent_seen
2142
1946
        result = {}
2143
1947
        setdefault = result.setdefault
2145
1949
            setdefault(key[0], set()).add(key[-1])
2146
1950
        return result
2147
1951
 
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
1952
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
2176
1953
        """Find the file ids and versions affected by revisions.
2177
1954
 
2184
1961
        """
2185
1962
        selected_keys = set((revid,) for revid in revision_ids)
2186
1963
        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)
 
1964
        pb = ui.ui_factory.nested_progress_bar()
 
1965
        try:
 
1966
            return self._find_file_ids_from_xml_inventory_lines(
 
1967
                w.iter_lines_added_or_present_in_keys(
 
1968
                    selected_keys, pb=pb),
 
1969
                selected_keys)
 
1970
        finally:
 
1971
            pb.finished()
2191
1972
 
2192
1973
    def iter_files_bytes(self, desired_files):
2193
1974
        """Iterate through file versions.
2275
2056
                batch_size]
2276
2057
            if not to_query:
2277
2058
                break
2278
 
            for revision_id in to_query:
 
2059
            for rev_tree in self.revision_trees(to_query):
 
2060
                revision_id = rev_tree.get_revision_id()
2279
2061
                parent_ids = ancestors[revision_id]
2280
2062
                for text_key in revision_keys[revision_id]:
2281
2063
                    pb.update("Calculating text parents", processed_texts)
2354
2136
        num_file_ids = len(file_ids)
2355
2137
        for file_id, altered_versions in file_ids.iteritems():
2356
2138
            if pb is not None:
2357
 
                pb.update("Fetch texts", count, num_file_ids)
 
2139
                pb.update("fetch texts", count, num_file_ids)
2358
2140
            count += 1
2359
2141
            yield ("file", file_id, altered_versions)
2360
2142
 
2381
2163
        """Get Inventory object by revision id."""
2382
2164
        return self.iter_inventories([revision_id]).next()
2383
2165
 
2384
 
    def iter_inventories(self, revision_ids, ordering=None):
 
2166
    def iter_inventories(self, revision_ids):
2385
2167
        """Get many inventories by revision_ids.
2386
2168
 
2387
2169
        This will buffer some or all of the texts used in constructing the
2389
2171
        time.
2390
2172
 
2391
2173
        :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
2174
        :return: An iterator of inventories.
2396
2175
        """
2397
2176
        if ((None in revision_ids)
2398
2177
            or (_mod_revision.NULL_REVISION in revision_ids)):
2399
2178
            raise ValueError('cannot get null revision inventory')
2400
 
        return self._iter_inventories(revision_ids, ordering)
 
2179
        return self._iter_inventories(revision_ids)
2401
2180
 
2402
 
    def _iter_inventories(self, revision_ids, ordering):
 
2181
    def _iter_inventories(self, revision_ids):
2403
2182
        """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)
 
2183
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
 
2184
            yield self.deserialise_inventory(revision_id, text)
2407
2185
 
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
 
2186
    def _iter_inventory_xmls(self, revision_ids):
2414
2187
        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)
 
2188
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2421
2189
        text_chunks = {}
2422
2190
        for record in stream:
2423
2191
            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]
 
2192
                text_chunks[record.key] = record.get_bytes_as('chunked')
2429
2193
            else:
2430
2194
                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
 
2195
        for key in keys:
 
2196
            chunks = text_chunks.pop(key)
 
2197
            yield ''.join(chunks), key[-1]
2443
2198
 
2444
 
    def _deserialise_inventory(self, revision_id, xml):
 
2199
    def deserialise_inventory(self, revision_id, xml):
2445
2200
        """Transform the xml into an inventory object.
2446
2201
 
2447
2202
        :param revision_id: The expected revision id of the inventory.
2448
2203
        :param xml: A serialised inventory.
2449
2204
        """
2450
2205
        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)
 
2206
                    entry_cache=self._inventory_entry_cache)
2453
2207
        if result.revision_id != revision_id:
2454
2208
            raise AssertionError('revision id mismatch %s != %s' % (
2455
2209
                result.revision_id, revision_id))
2456
2210
        return result
2457
2211
 
 
2212
    def serialise_inventory(self, inv):
 
2213
        return self._serializer.write_inventory_to_string(inv)
 
2214
 
 
2215
    def _serialise_inventory_to_lines(self, inv):
 
2216
        return self._serializer.write_inventory_to_lines(inv)
 
2217
 
2458
2218
    def get_serializer_format(self):
2459
2219
        return self._serializer.format_num
2460
2220
 
2461
2221
    @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')
 
2222
    def get_inventory_xml(self, revision_id):
 
2223
        """Get inventory XML as a file object."""
 
2224
        texts = self._iter_inventory_xmls([revision_id])
2465
2225
        try:
2466
2226
            text, revision_id = texts.next()
2467
2227
        except StopIteration:
2468
2228
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2469
2229
        return text
2470
2230
 
 
2231
    @needs_read_lock
 
2232
    def get_inventory_sha1(self, revision_id):
 
2233
        """Return the sha1 hash of the inventory entry
 
2234
        """
 
2235
        return self.get_revision(revision_id).inventory_sha1
 
2236
 
2471
2237
    def get_rev_id_for_revno(self, revno, known_pair):
2472
2238
        """Return the revision id of a revno, given a later (revno, revid)
2473
2239
        pair in the same history.
2524
2290
            else:
2525
2291
                next_id = parents[0]
2526
2292
 
 
2293
    @needs_read_lock
 
2294
    def get_revision_inventory(self, revision_id):
 
2295
        """Return inventory of a past revision."""
 
2296
        # TODO: Unify this with get_inventory()
 
2297
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
2298
        # must be the same as its revision, so this is trivial.
 
2299
        if revision_id is None:
 
2300
            # This does not make sense: if there is no revision,
 
2301
            # then it is the current tree inventory surely ?!
 
2302
            # and thus get_root_id() is something that looks at the last
 
2303
            # commit on the branch, and the get_root_id is an inventory check.
 
2304
            raise NotImplementedError
 
2305
            # return Inventory(self.get_root_id())
 
2306
        else:
 
2307
            return self.get_inventory(revision_id)
 
2308
 
2527
2309
    def is_shared(self):
2528
2310
        """Return True if this repository is flagged as a shared repository."""
2529
2311
        raise NotImplementedError(self.is_shared)
2563
2345
            return RevisionTree(self, Inventory(root_id=None),
2564
2346
                                _mod_revision.NULL_REVISION)
2565
2347
        else:
2566
 
            inv = self.get_inventory(revision_id)
 
2348
            inv = self.get_revision_inventory(revision_id)
2567
2349
            return RevisionTree(self, inv, revision_id)
2568
2350
 
2569
2351
    def revision_trees(self, revision_ids):
2622
2404
            keys = tsort.topo_sort(parent_map)
2623
2405
        return [None] + list(keys)
2624
2406
 
2625
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
2407
    def pack(self):
2626
2408
        """Compress the data within the repository.
2627
2409
 
2628
2410
        This operation only makes sense for some repository types. For other
2631
2413
        This stub method does not require a lock, but subclasses should use
2632
2414
        @needs_write_lock as this is a long running call its reasonable to
2633
2415
        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
2416
        """
2645
2417
 
2646
2418
    def get_transaction(self):
2662
2434
        for ((revision_id,), parent_keys) in \
2663
2435
                self.revisions.get_parent_map(query_keys).iteritems():
2664
2436
            if parent_keys:
2665
 
                result[revision_id] = tuple([parent_revid
2666
 
                    for (parent_revid,) in parent_keys])
 
2437
                result[revision_id] = tuple(parent_revid
 
2438
                    for (parent_revid,) in parent_keys)
2667
2439
            else:
2668
2440
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2669
2441
        return result
2671
2443
    def _make_parents_provider(self):
2672
2444
        return self
2673
2445
 
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
2446
    def get_graph(self, other_repository=None):
2684
2447
        """Return the graph walker for this repository format"""
2685
2448
        parents_provider = self._make_parents_provider()
2689
2452
                [parents_provider, other_repository._make_parents_provider()])
2690
2453
        return graph.Graph(parents_provider)
2691
2454
 
2692
 
    def _get_versioned_file_checker(self, text_key_references=None,
2693
 
        ancestors=None):
 
2455
    def _get_versioned_file_checker(self, text_key_references=None):
2694
2456
        """Return an object suitable for checking versioned files.
2695
2457
        
2696
2458
        :param text_key_references: if non-None, an already built
2698
2460
            to whether they were referred to by the inventory of the
2699
2461
            revision_id that they contain. If None, this will be
2700
2462
            calculated.
2701
 
        :param ancestors: Optional result from
2702
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2703
 
            available.
2704
2463
        """
2705
2464
        return _VersionedFileChecker(self,
2706
 
            text_key_references=text_key_references, ancestors=ancestors)
 
2465
            text_key_references=text_key_references)
2707
2466
 
2708
2467
    def revision_ids_to_search_result(self, result_set):
2709
2468
        """Convert a set of revision ids to a graph SearchResult."""
2759
2518
        return record.get_bytes_as('fulltext')
2760
2519
 
2761
2520
    @needs_read_lock
2762
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
2521
    def check(self, revision_ids=None):
2763
2522
        """Check consistency of all history of given revision_ids.
2764
2523
 
2765
2524
        Different repository implementations should override _check().
2766
2525
 
2767
2526
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2768
2527
             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
2528
        """
2775
 
        return self._check(revision_ids, callback_refs=callback_refs,
2776
 
            check_repo=check_repo)
 
2529
        return self._check(revision_ids)
2777
2530
 
2778
 
    def _check(self, revision_ids, callback_refs, check_repo):
2779
 
        result = check.Check(self, check_repo=check_repo)
2780
 
        result.check(callback_refs)
 
2531
    def _check(self, revision_ids):
 
2532
        result = check.Check(self)
 
2533
        result.check()
2781
2534
        return result
2782
2535
 
2783
 
    def _warn_if_deprecated(self, branch=None):
 
2536
    def _warn_if_deprecated(self):
2784
2537
        global _deprecation_warning_done
2785
2538
        if _deprecation_warning_done:
2786
2539
            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
 
2540
        _deprecation_warning_done = True
 
2541
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
2542
                % (self._format, self.bzrdir.transport.base))
2799
2543
 
2800
2544
    def supports_rich_root(self):
2801
2545
        return self._format.rich_root_data
3077
2821
    # Does this format have < O(tree_size) delta generation. Used to hint what
3078
2822
    # code path for commit, amongst other things.
3079
2823
    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
2824
 
3090
 
    def __repr__(self):
3091
 
        return "%s()" % self.__class__.__name__
 
2825
    def __str__(self):
 
2826
        return "<%s>" % self.__class__.__name__
3092
2827
 
3093
2828
    def __eq__(self, other):
3094
2829
        # format objects are generally stateless
3107
2842
        """
3108
2843
        try:
3109
2844
            transport = a_bzrdir.get_repository_transport(None)
3110
 
            format_string = transport.get_bytes("format")
 
2845
            format_string = transport.get("format").read()
3111
2846
            return format_registry.get(format_string)
3112
2847
        except errors.NoSuchFile:
3113
2848
            raise errors.NoRepositoryPresent(a_bzrdir)
3195
2930
        raise NotImplementedError(self.network_name)
3196
2931
 
3197
2932
    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)
 
2933
        raise NotImplementedError(self.check_conversion_target)
3207
2934
 
3208
2935
    def open(self, a_bzrdir, _found=False):
3209
2936
        """Return an instance of this format for the bzrdir a_bzrdir.
3212
2939
        """
3213
2940
        raise NotImplementedError(self.open)
3214
2941
 
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
2942
 
3225
2943
class MetaDirRepositoryFormat(RepositoryFormat):
3226
2944
    """Common base class for the new repositories using the metadir layout."""
3431
3149
 
3432
3150
        :param revision_id: if None all content is copied, if NULL_REVISION no
3433
3151
                            content is copied.
3434
 
        :param pb: ignored.
 
3152
        :param pb: optional progress bar to use for progress reports. If not
 
3153
                   provided a default one will be created.
3435
3154
        :return: None.
3436
3155
        """
3437
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3438
3156
        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
3157
        f = RepoFetcher(to_repository=self.target,
3445
3158
                               from_repository=self.source,
3446
3159
                               last_revision=revision_id,
3447
3160
                               fetch_spec=fetch_spec,
3448
 
                               find_ghosts=find_ghosts)
 
3161
                               pb=pb, find_ghosts=find_ghosts)
3449
3162
 
3450
3163
    def _walk_to_common_revisions(self, revision_ids):
3451
3164
        """Walk out from revision_ids in source to revisions target has.
3620
3333
                self.target.texts.insert_record_stream(
3621
3334
                    self.source.texts.get_record_stream(
3622
3335
                        self.source.texts.keys(), 'topological', False))
3623
 
                pb.update('Copying inventory', 0, 1)
 
3336
                pb.update('copying inventory', 0, 1)
3624
3337
                self.target.inventories.insert_record_stream(
3625
3338
                    self.source.inventories.get_record_stream(
3626
3339
                        self.source.inventories.keys(), 'topological', False))
3740
3453
        return self.source.revision_ids_to_search_result(result_set)
3741
3454
 
3742
3455
 
 
3456
class InterPackRepo(InterSameDataRepository):
 
3457
    """Optimised code paths between Pack based repositories."""
 
3458
 
 
3459
    @classmethod
 
3460
    def _get_repo_format_to_test(self):
 
3461
        from bzrlib.repofmt import pack_repo
 
3462
        return pack_repo.RepositoryFormatKnitPack6RichRoot()
 
3463
 
 
3464
    @staticmethod
 
3465
    def is_compatible(source, target):
 
3466
        """Be compatible with known Pack formats.
 
3467
 
 
3468
        We don't test for the stores being of specific types because that
 
3469
        could lead to confusing results, and there is no need to be
 
3470
        overly general.
 
3471
 
 
3472
        InterPackRepo does not support CHK based repositories.
 
3473
        """
 
3474
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
3475
        from bzrlib.repofmt.groupcompress_repo import RepositoryFormatCHK1
 
3476
        try:
 
3477
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
3478
                isinstance(target._format, RepositoryFormatPack))
 
3479
            not_packs = (isinstance(source._format, RepositoryFormatCHK1) or
 
3480
                isinstance(target._format, RepositoryFormatCHK1))
 
3481
        except AttributeError:
 
3482
            return False
 
3483
        if not_packs or not are_packs:
 
3484
            return False
 
3485
        return InterRepository._same_model(source, target)
 
3486
 
 
3487
    @needs_write_lock
 
3488
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
 
3489
            fetch_spec=None):
 
3490
        """See InterRepository.fetch()."""
 
3491
        if (len(self.source._fallback_repositories) > 0 or
 
3492
            len(self.target._fallback_repositories) > 0):
 
3493
            # The pack layer is not aware of fallback repositories, so when
 
3494
            # fetching from a stacked repository or into a stacked repository
 
3495
            # we use the generic fetch logic which uses the VersionedFiles
 
3496
            # attributes on repository.
 
3497
            from bzrlib.fetch import RepoFetcher
 
3498
            fetcher = RepoFetcher(self.target, self.source, revision_id,
 
3499
                    pb, find_ghosts, fetch_spec=fetch_spec)
 
3500
        if fetch_spec is not None:
 
3501
            if len(list(fetch_spec.heads)) != 1:
 
3502
                raise AssertionError(
 
3503
                    "InterPackRepo.fetch doesn't support "
 
3504
                    "fetching multiple heads yet.")
 
3505
            revision_id = list(fetch_spec.heads)[0]
 
3506
            fetch_spec = None
 
3507
        if revision_id is None:
 
3508
            # TODO:
 
3509
            # everything to do - use pack logic
 
3510
            # to fetch from all packs to one without
 
3511
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
3512
            # till then:
 
3513
            source_revision_ids = frozenset(self.source.all_revision_ids())
 
3514
            revision_ids = source_revision_ids - \
 
3515
                frozenset(self.target.get_parent_map(source_revision_ids))
 
3516
            revision_keys = [(revid,) for revid in revision_ids]
 
3517
            index = self.target._pack_collection.revision_index.combined_index
 
3518
            present_revision_ids = set(item[1][0] for item in
 
3519
                index.iter_entries(revision_keys))
 
3520
            revision_ids = set(revision_ids) - present_revision_ids
 
3521
            # implementing the TODO will involve:
 
3522
            # - detecting when all of a pack is selected
 
3523
            # - avoiding as much as possible pre-selection, so the
 
3524
            # more-core routines such as create_pack_from_packs can filter in
 
3525
            # a just-in-time fashion. (though having a HEADS list on a
 
3526
            # repository might make this a lot easier, because we could
 
3527
            # sensibly detect 'new revisions' without doing a full index scan.
 
3528
        elif _mod_revision.is_null(revision_id):
 
3529
            # nothing to do:
 
3530
            return (0, [])
 
3531
        else:
 
3532
            revision_ids = self.search_missing_revision_ids(revision_id,
 
3533
                find_ghosts=find_ghosts).get_keys()
 
3534
            if len(revision_ids) == 0:
 
3535
                return (0, [])
 
3536
        return self._pack(self.source, self.target, revision_ids)
 
3537
 
 
3538
    def _pack(self, source, target, revision_ids):
 
3539
        from bzrlib.repofmt.pack_repo import Packer
 
3540
        packs = source._pack_collection.all_packs()
 
3541
        pack = Packer(self.target._pack_collection, packs, '.fetch',
 
3542
            revision_ids).pack()
 
3543
        if pack is not None:
 
3544
            self.target._pack_collection._save_pack_names()
 
3545
            copied_revs = pack.get_revision_count()
 
3546
            # Trigger an autopack. This may duplicate effort as we've just done
 
3547
            # a pack creation, but for now it is simpler to think about as
 
3548
            # 'upload data, then repack if needed'.
 
3549
            self.target._pack_collection.autopack()
 
3550
            return (copied_revs, [])
 
3551
        else:
 
3552
            return (0, [])
 
3553
 
 
3554
    @needs_read_lock
 
3555
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
3556
        """See InterRepository.missing_revision_ids().
 
3557
 
 
3558
        :param find_ghosts: Find ghosts throughout the ancestry of
 
3559
            revision_id.
 
3560
        """
 
3561
        if not find_ghosts and revision_id is not None:
 
3562
            return self._walk_to_common_revisions([revision_id])
 
3563
        elif revision_id is not None:
 
3564
            # Find ghosts: search for revisions pointing from one repository to
 
3565
            # the other, and vice versa, anywhere in the history of revision_id.
 
3566
            graph = self.target.get_graph(other_repository=self.source)
 
3567
            searcher = graph._make_breadth_first_searcher([revision_id])
 
3568
            found_ids = set()
 
3569
            while True:
 
3570
                try:
 
3571
                    next_revs, ghosts = searcher.next_with_ghosts()
 
3572
                except StopIteration:
 
3573
                    break
 
3574
                if revision_id in ghosts:
 
3575
                    raise errors.NoSuchRevision(self.source, revision_id)
 
3576
                found_ids.update(next_revs)
 
3577
                found_ids.update(ghosts)
 
3578
            found_ids = frozenset(found_ids)
 
3579
            # Double query here: should be able to avoid this by changing the
 
3580
            # graph api further.
 
3581
            result_set = found_ids - frozenset(
 
3582
                self.target.get_parent_map(found_ids))
 
3583
        else:
 
3584
            source_ids = self.source.all_revision_ids()
 
3585
            # source_ids is the worst possible case we may need to pull.
 
3586
            # now we want to filter source_ids against what we actually
 
3587
            # have in target, but don't try to check for existence where we know
 
3588
            # we do not have a revision as that would be pointless.
 
3589
            target_ids = set(self.target.all_revision_ids())
 
3590
            result_set = set(source_ids).difference(target_ids)
 
3591
        return self.source.revision_ids_to_search_result(result_set)
 
3592
 
 
3593
 
3743
3594
class InterDifferingSerializer(InterRepository):
3744
3595
 
3745
3596
    @classmethod
3752
3603
        # This is redundant with format.check_conversion_target(), however that
3753
3604
        # raises an exception, and we just want to say "False" as in we won't
3754
3605
        # support converting between these formats.
3755
 
        if 'IDS_never' in debug.debug_flags:
3756
 
            return False
3757
3606
        if source.supports_rich_root() and not target.supports_rich_root():
3758
3607
            return False
3759
3608
        if (source._format.supports_tree_reference
3760
3609
            and not target._format.supports_tree_reference):
3761
3610
            return False
3762
 
        if target._fallback_repositories and target._format.supports_chks:
3763
 
            # IDS doesn't know how to copy CHKs for the parent inventories it
3764
 
            # adds to stacked repos.
3765
 
            return False
3766
 
        if 'IDS_always' in debug.debug_flags:
3767
 
            return True
3768
 
        # Only use this code path for local source and target.  IDS does far
3769
 
        # too much IO (both bandwidth and roundtrips) over a network.
3770
 
        if not source.bzrdir.transport.base.startswith('file:///'):
3771
 
            return False
3772
 
        if not target.bzrdir.transport.base.startswith('file:///'):
3773
 
            return False
3774
3611
        return True
3775
3612
 
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):
 
3613
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
3794
3614
        """Get the best delta and base for this revision.
3795
3615
 
3796
3616
        :return: (basis_id, delta)
3797
3617
        """
 
3618
        possible_trees = [(parent_id, cache[parent_id])
 
3619
                          for parent_id in parent_ids
 
3620
                           if parent_id in cache]
 
3621
        if len(possible_trees) == 0:
 
3622
            # There either aren't any parents, or the parents aren't in the
 
3623
            # cache, so just use the last converted tree
 
3624
            possible_trees.append((basis_id, cache[basis_id]))
3798
3625
        deltas = []
3799
 
        # Generate deltas against each tree, to find the shortest.
3800
 
        texts_possibly_new_in_tree = set()
3801
3626
        for basis_id, basis_tree in possible_trees:
3802
3627
            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
3628
            deltas.append((len(delta), basis_id, delta))
3818
3629
        deltas.sort()
3819
3630
        return deltas[0][1:]
3820
3631
 
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):
 
3632
    def _get_parent_keys(self, root_key, parent_map):
 
3633
        """Get the parent keys for a given root id."""
 
3634
        root_id, rev_id = root_key
 
3635
        # Include direct parents of the revision, but only if they used
 
3636
        # the same root_id and are heads.
 
3637
        parent_keys = []
 
3638
        for parent_id in parent_map[rev_id]:
 
3639
            if parent_id == _mod_revision.NULL_REVISION:
 
3640
                continue
 
3641
            if parent_id not in self._revision_id_to_root_id:
 
3642
                # We probably didn't read this revision, go spend the
 
3643
                # extra effort to actually check
 
3644
                try:
 
3645
                    tree = self.source.revision_tree(parent_id)
 
3646
                except errors.NoSuchRevision:
 
3647
                    # Ghost, fill out _revision_id_to_root_id in case we
 
3648
                    # encounter this again.
 
3649
                    # But set parent_root_id to None since we don't really know
 
3650
                    parent_root_id = None
 
3651
                else:
 
3652
                    parent_root_id = tree.get_root_id()
 
3653
                self._revision_id_to_root_id[parent_id] = None
 
3654
            else:
 
3655
                parent_root_id = self._revision_id_to_root_id[parent_id]
 
3656
            if root_id == parent_root_id:
 
3657
                # With stacking we _might_ want to refer to a non-local
 
3658
                # revision, but this code path only applies when we have the
 
3659
                # full content available, so ghosts really are ghosts, not just
 
3660
                # the edge of local data.
 
3661
                parent_keys.append((parent_id,))
 
3662
            else:
 
3663
                # root_id may be in the parent anyway.
 
3664
                try:
 
3665
                    tree = self.source.revision_tree(parent_id)
 
3666
                except errors.NoSuchRevision:
 
3667
                    # ghost, can't refer to it.
 
3668
                    pass
 
3669
                else:
 
3670
                    try:
 
3671
                        parent_keys.append((tree.inventory[root_id].revision,))
 
3672
                    except errors.NoSuchId:
 
3673
                        # not in the tree
 
3674
                        pass
 
3675
        g = graph.Graph(self.source.revisions)
 
3676
        heads = g.heads(parent_keys)
 
3677
        selected_keys = []
 
3678
        for key in parent_keys:
 
3679
            if key in heads and key not in selected_keys:
 
3680
                selected_keys.append(key)
 
3681
        return tuple([(root_id,)+ key for key in selected_keys])
 
3682
 
 
3683
    def _new_root_data_stream(self, root_keys_to_create, parent_map):
 
3684
        for root_key in root_keys_to_create:
 
3685
            parent_keys = self._get_parent_keys(root_key, parent_map)
 
3686
            yield versionedfile.FulltextContentFactory(root_key,
 
3687
                parent_keys, None, '')
 
3688
 
 
3689
    def _fetch_batch(self, revision_ids, basis_id, cache):
3851
3690
        """Fetch across a few revisions.
3852
3691
 
3853
3692
        :param revision_ids: The revisions to copy
3854
3693
        :param basis_id: The revision_id of a tree that must be in cache, used
3855
3694
            as a basis for delta when no other base is available
3856
3695
        :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
3696
        :return: The revision_id of the last converted tree. The RevisionTree
3860
3697
            for it will be in cache
3861
3698
        """
3867
3704
        pending_deltas = []
3868
3705
        pending_revisions = []
3869
3706
        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
3707
        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
3708
            current_revision_id = tree.get_revision_id()
3876
3709
            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
3710
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3884
 
                                                           possible_trees)
3885
 
            revision = self.source.get_revision(current_revision_id)
3886
 
            pending_deltas.append((basis_id, delta,
3887
 
                current_revision_id, revision.parent_ids))
 
3711
                                                           basis_id, cache)
3888
3712
            if self._converting_to_rich_root:
3889
3713
                self._revision_id_to_root_id[current_revision_id] = \
3890
3714
                    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()
 
3715
            # Find text entries that need to be copied
3894
3716
            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)
 
3717
                if new_path is not None:
 
3718
                    if not new_path:
 
3719
                        # This is the root
 
3720
                        if not self.target.supports_rich_root():
 
3721
                            # The target doesn't support rich root, so we don't
 
3722
                            # copy
 
3723
                            continue
 
3724
                        if self._converting_to_rich_root:
 
3725
                            # This can't be copied normally, we have to insert
 
3726
                            # it specially
 
3727
                            root_keys_to_create.add((file_id, entry.revision))
 
3728
                            continue
 
3729
                    text_keys.add((file_id, entry.revision))
 
3730
            revision = self.source.get_revision(current_revision_id)
 
3731
            pending_deltas.append((basis_id, delta,
 
3732
                current_revision_id, revision.parent_ids))
3922
3733
            pending_revisions.append(revision)
3923
3734
            cache[current_revision_id] = tree
3924
3735
            basis_id = current_revision_id
3925
 
        self.source._safe_to_return_from_cache = False
3926
3736
        # Copy file texts
3927
3737
        from_texts = self.source.texts
3928
3738
        to_texts = self.target.texts
3929
3739
        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)
 
3740
            root_stream = self._new_root_data_stream(root_keys_to_create,
 
3741
                                                     parent_map)
3933
3742
            to_texts.insert_record_stream(root_stream)
3934
3743
        to_texts.insert_record_stream(from_texts.get_record_stream(
3935
3744
            text_keys, self.target._format._fetch_order,
3942
3751
            # for the new revisions that we are about to insert.  We do this
3943
3752
            # before adding the revisions so that no revision is added until
3944
3753
            # 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
3754
            parent_ids = set()
3948
3755
            revision_ids = set()
3949
3756
            for revision in pending_revisions:
3952
3759
            parent_ids.difference_update(revision_ids)
3953
3760
            parent_ids.discard(_mod_revision.NULL_REVISION)
3954
3761
            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):
 
3762
            for parent_tree in self.source.revision_trees(parent_ids):
 
3763
                basis_id, delta = self._get_delta_for_revision(tree, parent_ids, basis_id, cache)
3958
3764
                current_revision_id = parent_tree.get_revision_id()
3959
3765
                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
3766
                self.target.add_inventory_by_delta(
3968
3767
                    basis_id, delta, current_revision_id, parents_parents)
3969
3768
        # insert signatures and revisions
3983
3782
 
3984
3783
        :param revision_ids: The list of revisions to fetch. Must be in
3985
3784
            topological order.
3986
 
        :param pb: A ProgressTask
 
3785
        :param pb: A ProgressBar
3987
3786
        :return: None
3988
3787
        """
3989
3788
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3991
3790
        cache = lru_cache.LRUCache(100)
3992
3791
        cache[basis_id] = basis_tree
3993
3792
        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
3793
        for offset in range(0, len(revision_ids), batch_size):
4002
3794
            self.target.start_write_group()
4003
3795
            try:
4004
3796
                pb.update('Transferring revisions', offset,
4005
3797
                          len(revision_ids))
4006
3798
                batch = revision_ids[offset:offset+batch_size]
4007
 
                basis_id = self._fetch_batch(batch, basis_id, cache,
4008
 
                                             a_graph=a_graph)
 
3799
                basis_id = self._fetch_batch(batch, basis_id, cache)
4009
3800
            except:
4010
 
                self.source._safe_to_return_from_cache = False
4011
3801
                self.target.abort_write_group()
4012
3802
                raise
4013
3803
            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)
 
3804
                self.target.commit_write_group()
4019
3805
        pb.update('Transferring revisions', len(revision_ids),
4020
3806
                  len(revision_ids))
4021
3807
 
4025
3811
        """See InterRepository.fetch()."""
4026
3812
        if fetch_spec is not None:
4027
3813
            raise AssertionError("Not implemented yet...")
4028
 
        ui.ui_factory.warn_experimental_format_fetch(self)
4029
3814
        if (not self.source.supports_rich_root()
4030
3815
            and self.target.supports_rich_root()):
4031
3816
            self._converting_to_rich_root = True
4032
3817
            self._revision_id_to_root_id = {}
4033
3818
        else:
4034
3819
            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
3820
        revision_ids = self.target.search_missing_revision_ids(self.source,
4041
3821
            revision_id, find_ghosts=find_ghosts).get_keys()
4042
3822
        if not revision_ids:
4048
3828
        # Walk though all revisions; get inventory deltas, copy referenced
4049
3829
        # texts that delta references, insert the delta, revision and
4050
3830
        # signature.
 
3831
        first_rev = self.source.get_revision(revision_ids[0])
4051
3832
        if pb is None:
4052
3833
            my_pb = ui.ui_factory.nested_progress_bar()
4053
3834
            pb = my_pb
4090
3871
InterRepository.register_optimiser(InterSameDataRepository)
4091
3872
InterRepository.register_optimiser(InterWeaveRepo)
4092
3873
InterRepository.register_optimiser(InterKnitRepo)
 
3874
InterRepository.register_optimiser(InterPackRepo)
4093
3875
 
4094
3876
 
4095
3877
class CopyConverter(object):
4111
3893
        :param to_convert: The disk object to convert.
4112
3894
        :param pb: a progress bar to use for progress information.
4113
3895
        """
4114
 
        pb = ui.ui_factory.nested_progress_bar()
 
3896
        self.pb = pb
4115
3897
        self.count = 0
4116
3898
        self.total = 4
4117
3899
        # this is only useful with metadir layouts - separated repo content.
4118
3900
        # trigger an assertion if not such
4119
3901
        repo._format.get_format_string()
4120
3902
        self.repo_dir = repo.bzrdir
4121
 
        pb.update('Moving repository to repository.backup')
 
3903
        self.step('Moving repository to repository.backup')
4122
3904
        self.repo_dir.transport.move('repository', 'repository.backup')
4123
3905
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4124
3906
        repo._format.check_conversion_target(self.target_format)
4125
3907
        self.source_repo = repo._format.open(self.repo_dir,
4126
3908
            _found=True,
4127
3909
            _override_transport=backup_transport)
4128
 
        pb.update('Creating new repository')
 
3910
        self.step('Creating new repository')
4129
3911
        converted = self.target_format.initialize(self.repo_dir,
4130
3912
                                                  self.source_repo.is_shared())
4131
3913
        converted.lock_write()
4132
3914
        try:
4133
 
            pb.update('Copying content')
 
3915
            self.step('Copying content into repository.')
4134
3916
            self.source_repo.copy_content_into(converted)
4135
3917
        finally:
4136
3918
            converted.unlock()
4137
 
        pb.update('Deleting old repository content')
 
3919
        self.step('Deleting old repository content.')
4138
3920
        self.repo_dir.transport.delete_tree('repository.backup')
4139
 
        ui.ui_factory.note('repository converted')
4140
 
        pb.finished()
 
3921
        self.pb.note('repository converted')
 
3922
 
 
3923
    def step(self, message):
 
3924
        """Update the pb by a step."""
 
3925
        self.count +=1
 
3926
        self.pb.update(message, self.count, self.total)
4141
3927
 
4142
3928
 
4143
3929
_unescape_map = {
4172
3958
 
4173
3959
class _VersionedFileChecker(object):
4174
3960
 
4175
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
3961
    def __init__(self, repository, text_key_references=None):
4176
3962
        self.repository = repository
4177
3963
        self.text_index = self.repository._generate_text_key_index(
4178
 
            text_key_references=text_key_references, ancestors=ancestors)
 
3964
            text_key_references=text_key_references)
4179
3965
 
4180
3966
    def calculate_file_version_parents(self, text_key):
4181
3967
        """Calculate the correct parents for a file version according to
4199
3985
            revision_id) tuples for versions that are present in this versioned
4200
3986
            file, but not used by the corresponding inventory.
4201
3987
        """
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
3988
        wrong_parents = {}
4215
3989
        self.file_ids = set([file_id for file_id, _ in
4216
3990
            self.text_index.iterkeys()])
4217
3991
        # text keys is now grouped by file_id
 
3992
        n_weaves = len(self.file_ids)
 
3993
        files_in_revisions = {}
 
3994
        revisions_of_files = {}
4218
3995
        n_versions = len(self.text_index)
4219
3996
        progress_bar.update('loading text store', 0, n_versions)
4220
3997
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4222
3999
        text_keys = self.repository.texts.keys()
4223
4000
        unused_keys = frozenset(text_keys) - set(self.text_index)
4224
4001
        for num, key in enumerate(self.text_index.iterkeys()):
4225
 
            progress_bar.update('checking text graph', num, n_versions)
 
4002
            if progress_bar is not None:
 
4003
                progress_bar.update('checking text graph', num, n_versions)
4226
4004
            correct_parents = self.calculate_file_version_parents(key)
4227
4005
            try:
4228
4006
                knit_parents = parent_map[key]
4313
4091
            else:
4314
4092
                new_pack.set_write_cache_size(1024*1024)
4315
4093
        for substream_type, substream in stream:
4316
 
            if 'stream' in debug.debug_flags:
4317
 
                mutter('inserting substream: %s', substream_type)
4318
4094
            if substream_type == 'texts':
4319
4095
                self.target_repo.texts.insert_record_stream(substream)
4320
4096
            elif substream_type == 'inventories':
4324
4100
                else:
4325
4101
                    self._extract_and_insert_inventories(
4326
4102
                        substream, src_serializer)
4327
 
            elif substream_type == 'inventory-deltas':
4328
 
                self._extract_and_insert_inventory_deltas(
4329
 
                    substream, src_serializer)
4330
4103
            elif substream_type == 'chk_bytes':
4331
4104
                # XXX: This doesn't support conversions, as it assumes the
4332
4105
                #      conversion was done in the fetch code.
4363
4136
                ):
4364
4137
                if versioned_file is None:
4365
4138
                    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
4139
                missing_keys.update((prefix,) + key for key in
4374
4140
                    versioned_file.get_missing_compression_parent_keys())
4375
4141
        except NotImplementedError:
4384
4150
                # missing keys can handle suspending a write group).
4385
4151
                write_group_tokens = self.target_repo.suspend_write_group()
4386
4152
                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)
 
4153
        self.target_repo.commit_write_group()
4391
4154
        return [], set()
4392
4155
 
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):
 
4156
    def _extract_and_insert_inventories(self, substream, serializer):
4414
4157
        """Generate a new inventory versionedfile in target, converting data.
4415
4158
 
4416
4159
        The inventory is retrieved from the source, (deserializing it), and
4417
4160
        stored in the target (reserializing it in a different format).
4418
4161
        """
4419
 
        target_rich_root = self.target_repo._format.rich_root_data
4420
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4421
4162
        for record in substream:
4422
 
            # It's not a delta, so it must be a fulltext in the source
4423
 
            # serializer's format.
4424
4163
            bytes = record.get_bytes_as('fulltext')
4425
4164
            revision_id = record.key[0]
4426
4165
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4427
4166
            parents = [key[0] for key in record.parents]
4428
4167
            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
4168
 
4433
4169
    def _extract_and_insert_revisions(self, substream, serializer):
4434
4170
        for record in substream:
4483
4219
        return [('signatures', signatures), ('revisions', revisions)]
4484
4220
 
4485
4221
    def _generate_root_texts(self, revs):
4486
 
        """This will be called by get_stream between fetching weave texts and
 
4222
        """This will be called by __fetch between fetching weave texts and
4487
4223
        fetching the inventory weave.
 
4224
 
 
4225
        Subclasses should override this if they need to generate root texts
 
4226
        after fetching weave texts.
4488
4227
        """
4489
4228
        if self._rich_root_upgrade():
4490
 
            return _mod_fetch.Inter1and2Helper(
 
4229
            import bzrlib.fetch
 
4230
            return bzrlib.fetch.Inter1and2Helper(
4491
4231
                self.from_repository).generate_root_texts(revs)
4492
4232
        else:
4493
4233
            return []
4496
4236
        phase = 'file'
4497
4237
        revs = search.get_keys()
4498
4238
        graph = self.from_repository.get_graph()
4499
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
 
4239
        revs = list(graph.iter_topo_order(revs))
4500
4240
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4501
4241
        text_keys = []
4502
4242
        for knit_kind, file_id, revisions in data_to_fetch:
4521
4261
                # will be valid.
4522
4262
                for _ in self._generate_root_texts(revs):
4523
4263
                    yield _
 
4264
                # NB: This currently reopens the inventory weave in source;
 
4265
                # using a single stream interface instead would avoid this.
 
4266
                from_weave = self.from_repository.inventories
4524
4267
                # we fetch only the referenced inventories because we do not
4525
4268
                # know for unselected inventories whether all their required
4526
4269
                # texts are present in the other repository - it could be
4565
4308
            if not keys:
4566
4309
                # No need to stream something we don't have
4567
4310
                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
4311
            # Ask for full texts always so that we don't need more round trips
4581
4312
            # after this stream.
4582
4313
            # Some of the missing keys are genuinely ghosts, so filter absent
4597
4328
        return (not self.from_repository._format.rich_root_data and
4598
4329
            self.to_format.rich_root_data)
4599
4330
 
4600
 
    def _get_inventory_stream(self, revision_ids, missing=False):
 
4331
    def _get_inventory_stream(self, revision_ids):
4601
4332
        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)
 
4333
        if (from_format.supports_chks and self.to_format.supports_chks
 
4334
            and (from_format._serializer == self.to_format._serializer)):
 
4335
            # Both sides support chks, and they use the same serializer, so it
 
4336
            # is safe to transmit the chk pages and inventory pages across
 
4337
            # as-is.
 
4338
            return self._get_chk_inventory_stream(revision_ids)
 
4339
        elif (not from_format.supports_chks):
 
4340
            # Source repository doesn't support chks. So we can transmit the
 
4341
            # inventories 'as-is' and either they are just accepted on the
 
4342
            # target, or the Sink will properly convert it.
 
4343
            return self._get_simple_inventory_stream(revision_ids)
4618
4344
        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)
 
4345
            # XXX: Hack to make not-chk->chk fetch: copy the inventories as
 
4346
            #      inventories. Note that this should probably be done somehow
 
4347
            #      as part of bzrlib.repository.StreamSink. Except JAM couldn't
 
4348
            #      figure out how a non-chk repository could possibly handle
 
4349
            #      deserializing an inventory stream from a chk repo, as it
 
4350
            #      doesn't have a way to understand individual pages.
 
4351
            return self._get_convertable_inventory_stream(revision_ids)
4623
4352
 
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.
 
4353
    def _get_simple_inventory_stream(self, revision_ids):
4627
4354
        from_weave = self.from_repository.inventories
4628
 
        if missing:
4629
 
            delta_closure = True
4630
 
        else:
4631
 
            delta_closure = not self.delta_on_metadata()
4632
4355
        yield ('inventories', from_weave.get_record_stream(
4633
4356
            [(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
 
        """
 
4357
            self.inventory_fetch_order(),
 
4358
            not self.delta_on_metadata()))
 
4359
 
 
4360
    def _get_chk_inventory_stream(self, revision_ids):
 
4361
        """Fetch the inventory texts, along with the associated chk maps."""
 
4362
        # We want an inventory outside of the search set, so that we can filter
 
4363
        # out uninteresting chk pages. For now we use
 
4364
        # _find_revision_outside_set, but if we had a Search with cut_revs, we
 
4365
        # could use that instead.
 
4366
        start_rev_id = self.from_repository._find_revision_outside_set(
 
4367
                            revision_ids)
 
4368
        start_rev_key = (start_rev_id,)
 
4369
        inv_keys_to_fetch = [(rev_id,) for rev_id in revision_ids]
 
4370
        if start_rev_id != _mod_revision.NULL_REVISION:
 
4371
            inv_keys_to_fetch.append((start_rev_id,))
 
4372
        # Any repo that supports chk_bytes must also support out-of-order
 
4373
        # insertion. At least, that is how we expect it to work
 
4374
        # We use get_record_stream instead of iter_inventories because we want
 
4375
        # to be able to insert the stream as well. We could instead fetch
 
4376
        # allowing deltas, and then iter_inventories, but we don't know whether
 
4377
        # source or target is more 'local' anway.
 
4378
        inv_stream = self.from_repository.inventories.get_record_stream(
 
4379
            inv_keys_to_fetch, 'unordered',
 
4380
            True) # We need them as full-texts so we can find their references
 
4381
        uninteresting_chk_roots = set()
 
4382
        interesting_chk_roots = set()
 
4383
        def filter_inv_stream(inv_stream):
 
4384
            for idx, record in enumerate(inv_stream):
 
4385
                ### child_pb.update('fetch inv', idx, len(inv_keys_to_fetch))
 
4386
                bytes = record.get_bytes_as('fulltext')
 
4387
                chk_inv = inventory.CHKInventory.deserialise(
 
4388
                    self.from_repository.chk_bytes, bytes, record.key)
 
4389
                if record.key == start_rev_key:
 
4390
                    uninteresting_chk_roots.add(chk_inv.id_to_entry.key())
 
4391
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4392
                    if p_id_map is not None:
 
4393
                        uninteresting_chk_roots.add(p_id_map.key())
 
4394
                else:
 
4395
                    yield record
 
4396
                    interesting_chk_roots.add(chk_inv.id_to_entry.key())
 
4397
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4398
                    if p_id_map is not None:
 
4399
                        interesting_chk_roots.add(p_id_map.key())
 
4400
        ### pb.update('fetch inventory', 0, 2)
 
4401
        yield ('inventories', filter_inv_stream(inv_stream))
 
4402
        # Now that we have worked out all of the interesting root nodes, grab
 
4403
        # all of the interesting pages and insert them
 
4404
        ### pb.update('fetch inventory', 1, 2)
 
4405
        interesting = chk_map.iter_interesting_nodes(
 
4406
            self.from_repository.chk_bytes, interesting_chk_roots,
 
4407
            uninteresting_chk_roots)
 
4408
        def to_stream_adapter():
 
4409
            """Adapt the iter_interesting_nodes result to a single stream.
 
4410
 
 
4411
            iter_interesting_nodes returns records as it processes them, along
 
4412
            with keys. However, we only want to return the records themselves.
 
4413
            """
 
4414
            for record, items in interesting:
 
4415
                if record is not None:
 
4416
                    yield record
 
4417
        # XXX: We could instead call get_record_stream(records.keys())
 
4418
        #      ATM, this will always insert the records as fulltexts, and
 
4419
        #      requires that you can hang on to records once you have gone
 
4420
        #      on to the next one. Further, it causes the target to
 
4421
        #      recompress the data. Testing shows it to be faster than
 
4422
        #      requesting the records again, though.
 
4423
        yield ('chk_bytes', to_stream_adapter())
 
4424
        ### pb.update('fetch inventory', 2, 2)
 
4425
 
 
4426
    def _get_convertable_inventory_stream(self, revision_ids):
 
4427
        # XXX: One of source or target is using chks, and they don't have
 
4428
        #      compatible serializations. The StreamSink code expects to be
 
4429
        #      able to convert on the target, so we need to put
 
4430
        #      bytes-on-the-wire that can be converted
 
4431
        yield ('inventories', self._stream_invs_as_fulltexts(revision_ids))
 
4432
 
 
4433
    def _stream_invs_as_fulltexts(self, revision_ids):
4658
4434
        from_repo = self.from_repository
 
4435
        from_serializer = from_repo._format._serializer
4659
4436
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4660
4437
        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:
 
4438
        for inv in self.from_repository.iter_inventories(revision_ids):
 
4439
            # XXX: This is a bit hackish, but it works. Basically,
 
4440
            #      CHKSerializer 'accidentally' supports
 
4441
            #      read/write_inventory_to_string, even though that is never
 
4442
            #      the format that is stored on disk. It *does* give us a
 
4443
            #      single string representation for an inventory, so live with
 
4444
            #      it for now.
 
4445
            #      This would be far better if we had a 'serialized inventory
 
4446
            #      delta' form. Then we could use 'inventory._make_delta', and
 
4447
            #      transmit that. This would both be faster to generate, and
 
4448
            #      result in fewer bytes-on-the-wire.
 
4449
            as_bytes = from_serializer.write_inventory_to_string(inv)
4677
4450
            key = (inv.revision_id,)
4678
4451
            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
4452
            yield versionedfile.FulltextContentFactory(
4711
 
                key, parent_keys, None, delta_serialized)
 
4453
                key, parent_keys, None, as_bytes)
4712
4454
 
4713
4455
 
4714
4456
def _iter_for_revno(repo, partial_history_cache, stop_index=None,