~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Robert Collins
  • Date: 2009-05-23 21:01:51 UTC
  • mto: This revision was merged to the branch mainline in revision 4441.
  • Revision ID: robertc@robertcollins.net-20090523210151-69jmrka5l4eh0zf3
Get missing command support sorted out.

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
28
    errors,
30
 
    fetch as _mod_fetch,
31
29
    fifo_cache,
32
30
    generate_ids,
33
31
    gpg,
34
32
    graph,
35
33
    inventory,
36
 
    inventory_delta,
37
34
    lazy_regex,
38
35
    lockable_files,
39
36
    lockdir,
40
37
    lru_cache,
41
38
    osutils,
42
39
    revision as _mod_revision,
43
 
    static_tuple,
44
40
    symbol_versioning,
45
 
    trace,
46
41
    tsort,
47
42
    ui,
48
43
    versionedfile,
53
48
from bzrlib.testament import Testament
54
49
""")
55
50
 
56
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
51
from bzrlib.decorators import needs_read_lock, needs_write_lock
57
52
from bzrlib.inter import InterObject
58
53
from bzrlib.inventory import (
59
54
    Inventory,
61
56
    ROOT_ID,
62
57
    entry_factory,
63
58
    )
64
 
from bzrlib.lock import _RelockDebugMixin
65
59
from bzrlib import registry
 
60
from bzrlib.symbol_versioning import (
 
61
        deprecated_method,
 
62
        )
66
63
from bzrlib.trace import (
67
64
    log_exception_quietly, note, mutter, mutter_callsite, warning)
68
65
 
210
207
            # an inventory delta was accumulated without creating a new
211
208
            # inventory.
212
209
            basis_id = self.basis_delta_revision
213
 
            # We ignore the 'inventory' returned by add_inventory_by_delta
214
 
            # because self.new_inventory is used to hint to the rest of the
215
 
            # system what code path was taken
216
 
            self.inv_sha1, _ = self.repository.add_inventory_by_delta(
 
210
            self.inv_sha1 = self.repository.add_inventory_by_delta(
217
211
                basis_id, self._basis_delta, self._new_revision_id,
218
212
                self.parents)
219
213
        else:
473
467
            if content_summary[2] is None:
474
468
                raise ValueError("Files must not have executable = None")
475
469
            if not store:
476
 
                # We can't trust a check of the file length because of content
477
 
                # filtering...
478
 
                if (# if the exec bit has changed we have to store:
 
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:
479
473
                    parent_entry.executable != content_summary[2]):
480
474
                    store = True
481
475
                elif parent_entry.text_sha1 == content_summary[3]:
500
494
            ie.executable = content_summary[2]
501
495
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
502
496
            try:
503
 
                text = file_obj.read()
 
497
                lines = file_obj.readlines()
504
498
            finally:
505
499
                file_obj.close()
506
500
            try:
507
501
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
508
 
                    ie.file_id, text, heads, nostore_sha)
 
502
                    ie.file_id, lines, heads, nostore_sha)
509
503
                # Let the caller know we generated a stat fingerprint.
510
504
                fingerprint = (ie.text_sha1, stat_value)
511
505
            except errors.ExistingContent:
523
517
                # carry over:
524
518
                ie.revision = parent_entry.revision
525
519
                return self._get_delta(ie, basis_inv, path), False, None
526
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
520
            lines = []
 
521
            self._add_text_to_weave(ie.file_id, lines, heads, None)
527
522
        elif kind == 'symlink':
528
523
            current_link_target = content_summary[3]
529
524
            if not store:
537
532
                ie.symlink_target = parent_entry.symlink_target
538
533
                return self._get_delta(ie, basis_inv, path), False, None
539
534
            ie.symlink_target = current_link_target
540
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
535
            lines = []
 
536
            self._add_text_to_weave(ie.file_id, lines, heads, None)
541
537
        elif kind == 'tree-reference':
542
538
            if not store:
543
539
                if content_summary[3] != parent_entry.reference_revision:
548
544
                ie.revision = parent_entry.revision
549
545
                return self._get_delta(ie, basis_inv, path), False, None
550
546
            ie.reference_revision = content_summary[3]
551
 
            if ie.reference_revision is None:
552
 
                raise AssertionError("invalid content_summary for nested tree: %r"
553
 
                    % (content_summary,))
554
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
547
            lines = []
 
548
            self._add_text_to_weave(ie.file_id, lines, heads, None)
555
549
        else:
556
550
            raise NotImplementedError('unknown kind')
557
551
        ie.revision = self._new_revision_id
751
745
                        entry.executable = True
752
746
                    else:
753
747
                        entry.executable = False
754
 
                    if (carry_over_possible and
 
748
                    if (carry_over_possible and 
755
749
                        parent_entry.executable == entry.executable):
756
750
                            # Check the file length, content hash after reading
757
751
                            # the file.
760
754
                        nostore_sha = None
761
755
                    file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
762
756
                    try:
763
 
                        text = file_obj.read()
 
757
                        lines = file_obj.readlines()
764
758
                    finally:
765
759
                        file_obj.close()
766
760
                    try:
767
761
                        entry.text_sha1, entry.text_size = self._add_text_to_weave(
768
 
                            file_id, text, heads, nostore_sha)
 
762
                            file_id, lines, heads, nostore_sha)
769
763
                        yield file_id, change[1][1], (entry.text_sha1, stat_value)
770
764
                    except errors.ExistingContent:
771
765
                        # No content change against a carry_over parent
780
774
                        parent_entry.symlink_target == entry.symlink_target):
781
775
                        carried_over = True
782
776
                    else:
783
 
                        self._add_text_to_weave(change[0], '', heads, None)
 
777
                        self._add_text_to_weave(change[0], [], heads, None)
784
778
                elif kind == 'directory':
785
779
                    if carry_over_possible:
786
780
                        carried_over = True
788
782
                        # Nothing to set on the entry.
789
783
                        # XXX: split into the Root and nonRoot versions.
790
784
                        if change[1][1] != '' or self.repository.supports_rich_root():
791
 
                            self._add_text_to_weave(change[0], '', heads, None)
 
785
                            self._add_text_to_weave(change[0], [], heads, None)
792
786
                elif kind == 'tree-reference':
793
787
                    if not self.repository._format.supports_tree_reference:
794
788
                        # This isn't quite sane as an error, but we shouldn't
797
791
                        # references.
798
792
                        raise errors.UnsupportedOperation(tree.add_reference,
799
793
                            self.repository)
800
 
                    reference_revision = tree.get_reference_revision(change[0])
801
 
                    entry.reference_revision = reference_revision
 
794
                    entry.reference_revision = \
 
795
                        tree.get_reference_revision(change[0])
802
796
                    if (carry_over_possible and
803
797
                        parent_entry.reference_revision == reference_revision):
804
798
                        carried_over = True
805
799
                    else:
806
 
                        self._add_text_to_weave(change[0], '', heads, None)
 
800
                        self._add_text_to_weave(change[0], [], heads, None)
807
801
                else:
808
802
                    raise AssertionError('unknown kind %r' % kind)
809
803
                if not carried_over:
818
812
                seen_root = True
819
813
        self.new_inventory = None
820
814
        if len(inv_delta):
821
 
            # This should perhaps be guarded by a check that the basis we
822
 
            # commit against is the basis for the commit and if not do a delta
823
 
            # against the basis.
824
815
            self._any_changes = True
825
816
        if not seen_root:
826
817
            # housekeeping root entry changes do not affect no-change commits.
827
818
            self._require_root_change(tree)
828
819
        self.basis_delta_revision = basis_revision_id
829
820
 
830
 
    def _add_text_to_weave(self, file_id, new_text, parents, nostore_sha):
831
 
        parent_keys = tuple([(file_id, parent) for parent in parents])
832
 
        return self.repository.texts._add_text(
833
 
            (file_id, self._new_revision_id), parent_keys, new_text,
834
 
            nostore_sha=nostore_sha, random_id=self.random_revid)[0:2]
 
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]
835
832
 
836
833
 
837
834
class RootCommitBuilder(CommitBuilder):
860
857
        # versioned roots do not change unless the tree found a change.
861
858
 
862
859
 
863
 
class RepositoryWriteLockResult(object):
864
 
    """The result of write locking a repository.
865
 
 
866
 
    :ivar repository_token: The token obtained from the underlying lock, or
867
 
        None.
868
 
    :ivar unlock: A callable which will unlock the lock.
869
 
    """
870
 
 
871
 
    def __init__(self, unlock, repository_token):
872
 
        self.repository_token = repository_token
873
 
        self.unlock = unlock
874
 
 
875
 
    def __str__(self):
876
 
        return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
877
 
            self.unlock)
878
 
 
879
 
 
880
860
######################################################################
881
861
# Repositories
882
862
 
883
 
 
884
 
class Repository(_RelockDebugMixin, bzrdir.ControlComponent):
 
863
class Repository(object):
885
864
    """Repository holding history for one or more branches.
886
865
 
887
866
    The repository holds and retrieves historical information including
956
935
        """
957
936
        if self._write_group is not self.get_transaction():
958
937
            # has an unlock or relock occured ?
959
 
            if suppress_errors:
960
 
                mutter(
961
 
                '(suppressed) mismatched lock context and write group. %r, %r',
962
 
                self._write_group, self.get_transaction())
963
 
                return
964
938
            raise errors.BzrError(
965
939
                'mismatched lock context and write group. %r, %r' %
966
940
                (self._write_group, self.get_transaction()))
995
969
        """
996
970
        if not self._format.supports_external_lookups:
997
971
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
998
 
        if self.is_locked():
999
 
            # This repository will call fallback.unlock() when we transition to
1000
 
            # the unlocked state, so we make sure to increment the lock count
1001
 
            repository.lock_read()
1002
972
        self._check_fallback_repository(repository)
1003
973
        self._fallback_repositories.append(repository)
1004
974
        self.texts.add_fallback_versioned_files(repository.texts)
1045
1015
 
1046
1016
        :seealso: add_inventory, for the contract.
1047
1017
        """
1048
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
 
1018
        inv_lines = self._serialise_inventory_to_lines(inv)
1049
1019
        return self._inventory_add_lines(revision_id, parents,
1050
1020
            inv_lines, check_content=False)
1051
1021
 
1053
1023
                               parents, basis_inv=None, propagate_caches=False):
1054
1024
        """Add a new inventory expressed as a delta against another revision.
1055
1025
 
1056
 
        See the inventory developers documentation for the theory behind
1057
 
        inventory deltas.
1058
 
 
1059
1026
        :param basis_revision_id: The inventory id the delta was created
1060
1027
            against. (This does not have to be a direct parent.)
1061
1028
        :param delta: The inventory delta (see Inventory.apply_delta for
1100
1067
        check_content=True):
1101
1068
        """Store lines in inv_vf and return the sha1 of the inventory."""
1102
1069
        parents = [(parent,) for parent in parents]
1103
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
1070
        return self.inventories.add_lines((revision_id,), parents, lines,
1104
1071
            check_content=check_content)[0]
1105
 
        self.inventories._access.flush()
1106
 
        return result
1107
1072
 
1108
1073
    def add_revision(self, revision_id, rev, inv=None, config=None):
1109
1074
        """Add rev to the revision store as revision_id.
1185
1150
        # The old API returned a list, should this actually be a set?
1186
1151
        return parent_map.keys()
1187
1152
 
1188
 
    def _check_inventories(self, checker):
1189
 
        """Check the inventories found from the revision scan.
1190
 
        
1191
 
        This is responsible for verifying the sha1 of inventories and
1192
 
        creating a pending_keys set that covers data referenced by inventories.
1193
 
        """
1194
 
        bar = ui.ui_factory.nested_progress_bar()
1195
 
        try:
1196
 
            self._do_check_inventories(checker, bar)
1197
 
        finally:
1198
 
            bar.finished()
1199
 
 
1200
 
    def _do_check_inventories(self, checker, bar):
1201
 
        """Helper for _check_inventories."""
1202
 
        revno = 0
1203
 
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
1204
 
        kinds = ['chk_bytes', 'texts']
1205
 
        count = len(checker.pending_keys)
1206
 
        bar.update("inventories", 0, 2)
1207
 
        current_keys = checker.pending_keys
1208
 
        checker.pending_keys = {}
1209
 
        # Accumulate current checks.
1210
 
        for key in current_keys:
1211
 
            if key[0] != 'inventories' and key[0] not in kinds:
1212
 
                checker._report_items.append('unknown key type %r' % (key,))
1213
 
            keys[key[0]].add(key[1:])
1214
 
        if keys['inventories']:
1215
 
            # NB: output order *should* be roughly sorted - topo or
1216
 
            # inverse topo depending on repository - either way decent
1217
 
            # to just delta against. However, pre-CHK formats didn't
1218
 
            # try to optimise inventory layout on disk. As such the
1219
 
            # pre-CHK code path does not use inventory deltas.
1220
 
            last_object = None
1221
 
            for record in self.inventories.check(keys=keys['inventories']):
1222
 
                if record.storage_kind == 'absent':
1223
 
                    checker._report_items.append(
1224
 
                        'Missing inventory {%s}' % (record.key,))
1225
 
                else:
1226
 
                    last_object = self._check_record('inventories', record,
1227
 
                        checker, last_object,
1228
 
                        current_keys[('inventories',) + record.key])
1229
 
            del keys['inventories']
1230
 
        else:
1231
 
            return
1232
 
        bar.update("texts", 1)
1233
 
        while (checker.pending_keys or keys['chk_bytes']
1234
 
            or keys['texts']):
1235
 
            # Something to check.
1236
 
            current_keys = checker.pending_keys
1237
 
            checker.pending_keys = {}
1238
 
            # Accumulate current checks.
1239
 
            for key in current_keys:
1240
 
                if key[0] not in kinds:
1241
 
                    checker._report_items.append('unknown key type %r' % (key,))
1242
 
                keys[key[0]].add(key[1:])
1243
 
            # Check the outermost kind only - inventories || chk_bytes || texts
1244
 
            for kind in kinds:
1245
 
                if keys[kind]:
1246
 
                    last_object = None
1247
 
                    for record in getattr(self, kind).check(keys=keys[kind]):
1248
 
                        if record.storage_kind == 'absent':
1249
 
                            checker._report_items.append(
1250
 
                                'Missing %s {%s}' % (kind, record.key,))
1251
 
                        else:
1252
 
                            last_object = self._check_record(kind, record,
1253
 
                                checker, last_object, current_keys[(kind,) + record.key])
1254
 
                    keys[kind] = set()
1255
 
                    break
1256
 
 
1257
 
    def _check_record(self, kind, record, checker, last_object, item_data):
1258
 
        """Check a single text from this repository."""
1259
 
        if kind == 'inventories':
1260
 
            rev_id = record.key[0]
1261
 
            inv = self._deserialise_inventory(rev_id,
1262
 
                record.get_bytes_as('fulltext'))
1263
 
            if last_object is not None:
1264
 
                delta = inv._make_delta(last_object)
1265
 
                for old_path, path, file_id, ie in delta:
1266
 
                    if ie is None:
1267
 
                        continue
1268
 
                    ie.check(checker, rev_id, inv)
1269
 
            else:
1270
 
                for path, ie in inv.iter_entries():
1271
 
                    ie.check(checker, rev_id, inv)
1272
 
            if self._format.fast_deltas:
1273
 
                return inv
1274
 
        elif kind == 'chk_bytes':
1275
 
            # No code written to check chk_bytes for this repo format.
1276
 
            checker._report_items.append(
1277
 
                'unsupported key type chk_bytes for %s' % (record.key,))
1278
 
        elif kind == 'texts':
1279
 
            self._check_text(record, checker, item_data)
1280
 
        else:
1281
 
            checker._report_items.append(
1282
 
                'unknown key type %s for %s' % (kind, record.key))
1283
 
 
1284
 
    def _check_text(self, record, checker, item_data):
1285
 
        """Check a single text."""
1286
 
        # Check it is extractable.
1287
 
        # TODO: check length.
1288
 
        if record.storage_kind == 'chunked':
1289
 
            chunks = record.get_bytes_as(record.storage_kind)
1290
 
            sha1 = osutils.sha_strings(chunks)
1291
 
            length = sum(map(len, chunks))
1292
 
        else:
1293
 
            content = record.get_bytes_as('fulltext')
1294
 
            sha1 = osutils.sha_string(content)
1295
 
            length = len(content)
1296
 
        if item_data and sha1 != item_data[1]:
1297
 
            checker._report_items.append(
1298
 
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
1299
 
                (record.key, sha1, item_data[1], item_data[2]))
1300
 
 
1301
1153
    @staticmethod
1302
1154
    def create(a_bzrdir):
1303
1155
        """Construct the current default format repository in a_bzrdir."""
1308
1160
 
1309
1161
        :param _format: The format of the repository on disk.
1310
1162
        :param a_bzrdir: The BzrDir of the repository.
 
1163
 
 
1164
        In the future we will have a single api for all stores for
 
1165
        getting file texts, inventories and revisions, then
 
1166
        this construct will accept instances of those things.
1311
1167
        """
1312
 
        # In the future we will have a single api for all stores for
1313
 
        # getting file texts, inventories and revisions, then
1314
 
        # this construct will accept instances of those things.
1315
1168
        super(Repository, self).__init__()
1316
1169
        self._format = _format
1317
1170
        # the following are part of the public API for Repository:
1323
1176
        self._reconcile_does_inventory_gc = True
1324
1177
        self._reconcile_fixes_text_parents = False
1325
1178
        self._reconcile_backsup_inventory = True
 
1179
        # not right yet - should be more semantically clear ?
 
1180
        #
 
1181
        # TODO: make sure to construct the right store classes, etc, depending
 
1182
        # on whether escaping is required.
 
1183
        self._warn_if_deprecated()
1326
1184
        self._write_group = None
1327
1185
        # Additional places to query for data.
1328
1186
        self._fallback_repositories = []
1329
1187
        # An InventoryEntry cache, used during deserialization
1330
1188
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
1331
 
        # Is it safe to return inventory entries directly from the entry cache,
1332
 
        # rather copying them?
1333
 
        self._safe_to_return_from_cache = False
1334
 
 
1335
 
    @property
1336
 
    def user_transport(self):
1337
 
        return self.bzrdir.user_transport
1338
 
 
1339
 
    @property
1340
 
    def control_transport(self):
1341
 
        return self._transport
1342
1189
 
1343
1190
    def __repr__(self):
1344
 
        if self._fallback_repositories:
1345
 
            return '%s(%r, fallback_repositories=%r)' % (
1346
 
                self.__class__.__name__,
1347
 
                self.base,
1348
 
                self._fallback_repositories)
1349
 
        else:
1350
 
            return '%s(%r)' % (self.__class__.__name__,
1351
 
                               self.base)
1352
 
 
1353
 
    def _has_same_fallbacks(self, other_repo):
1354
 
        """Returns true if the repositories have the same fallbacks."""
1355
 
        my_fb = self._fallback_repositories
1356
 
        other_fb = other_repo._fallback_repositories
1357
 
        if len(my_fb) != len(other_fb):
1358
 
            return False
1359
 
        for f, g in zip(my_fb, other_fb):
1360
 
            if not f.has_same_location(g):
1361
 
                return False
1362
 
        return True
 
1191
        return '%s(%r)' % (self.__class__.__name__,
 
1192
                           self.base)
1363
1193
 
1364
1194
    def has_same_location(self, other):
1365
1195
        """Returns a boolean indicating if this repository is at the same
1393
1223
        data during reads, and allows a 'write_group' to be obtained. Write
1394
1224
        groups must be used for actual data insertion.
1395
1225
 
1396
 
        A token should be passed in if you know that you have locked the object
1397
 
        some other way, and need to synchronise this object's state with that
1398
 
        fact.
1399
 
 
1400
 
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1401
 
 
1402
1226
        :param token: if this is already locked, then lock_write will fail
1403
1227
            unless the token matches the existing lock.
1404
1228
        :returns: a token if this instance supports tokens, otherwise None.
1407
1231
        :raises MismatchedToken: if the specified token doesn't match the token
1408
1232
            of the existing lock.
1409
1233
        :seealso: start_write_group.
1410
 
        :return: A RepositoryWriteLockResult.
 
1234
 
 
1235
        A token should be passed in if you know that you have locked the object
 
1236
        some other way, and need to synchronise this object's state with that
 
1237
        fact.
 
1238
 
 
1239
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1411
1240
        """
1412
1241
        locked = self.is_locked()
1413
 
        token = self.control_files.lock_write(token=token)
 
1242
        result = self.control_files.lock_write(token=token)
 
1243
        for repo in self._fallback_repositories:
 
1244
            # Writes don't affect fallback repos
 
1245
            repo.lock_read()
1414
1246
        if not locked:
1415
 
            self._warn_if_deprecated()
1416
 
            self._note_lock('w')
1417
 
            for repo in self._fallback_repositories:
1418
 
                # Writes don't affect fallback repos
1419
 
                repo.lock_read()
1420
1247
            self._refresh_data()
1421
 
        return RepositoryWriteLockResult(self.unlock, token)
 
1248
        return result
1422
1249
 
1423
1250
    def lock_read(self):
1424
 
        """Lock the repository for read operations.
1425
 
 
1426
 
        :return: An object with an unlock method which will release the lock
1427
 
            obtained.
1428
 
        """
1429
1251
        locked = self.is_locked()
1430
1252
        self.control_files.lock_read()
 
1253
        for repo in self._fallback_repositories:
 
1254
            repo.lock_read()
1431
1255
        if not locked:
1432
 
            self._warn_if_deprecated()
1433
 
            self._note_lock('r')
1434
 
            for repo in self._fallback_repositories:
1435
 
                repo.lock_read()
1436
1256
            self._refresh_data()
1437
 
        return self
1438
1257
 
1439
1258
    def get_physical_lock_status(self):
1440
1259
        return self.control_files.get_physical_lock_status()
1500
1319
 
1501
1320
        # now gather global repository information
1502
1321
        # XXX: This is available for many repos regardless of listability.
1503
 
        if self.user_transport.listable():
 
1322
        if self.bzrdir.root_transport.listable():
1504
1323
            # XXX: do we want to __define len__() ?
1505
1324
            # Maybe the versionedfiles object should provide a different
1506
1325
            # method to get the number of keys.
1516
1335
        :param using: If True, list only branches using this repository.
1517
1336
        """
1518
1337
        if using and not self.is_shared():
1519
 
            return self.bzrdir.list_branches()
 
1338
            try:
 
1339
                return [self.bzrdir.open_branch()]
 
1340
            except errors.NotBranchError:
 
1341
                return []
1520
1342
        class Evaluator(object):
1521
1343
 
1522
1344
            def __init__(self):
1531
1353
                    except errors.NoRepositoryPresent:
1532
1354
                        pass
1533
1355
                    else:
1534
 
                        return False, ([], repository)
 
1356
                        return False, (None, repository)
1535
1357
                self.first_call = False
1536
 
                value = (bzrdir.list_branches(), None)
 
1358
                try:
 
1359
                    value = (bzrdir.open_branch(), None)
 
1360
                except errors.NotBranchError:
 
1361
                    value = (None, None)
1537
1362
                return True, value
1538
1363
 
1539
 
        ret = []
1540
 
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
1541
 
                self.user_transport, evaluate=Evaluator()):
1542
 
            if branches is not None:
1543
 
                ret.extend(branches)
 
1364
        branches = []
 
1365
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1366
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
1367
            if branch is not None:
 
1368
                branches.append(branch)
1544
1369
            if not using and repository is not None:
1545
 
                ret.extend(repository.find_branches())
1546
 
        return ret
 
1370
                branches.extend(repository.find_branches())
 
1371
        return branches
1547
1372
 
1548
1373
    @needs_read_lock
1549
1374
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1578
1403
        """Commit the contents accrued within the current write group.
1579
1404
 
1580
1405
        :seealso: start_write_group.
1581
 
        
1582
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1583
1406
        """
1584
1407
        if self._write_group is not self.get_transaction():
1585
1408
            # has an unlock or relock occured ?
1586
1409
            raise errors.BzrError('mismatched lock context %r and '
1587
1410
                'write group %r.' %
1588
1411
                (self.get_transaction(), self._write_group))
1589
 
        result = self._commit_write_group()
 
1412
        self._commit_write_group()
1590
1413
        self._write_group = None
1591
 
        return result
1592
1414
 
1593
1415
    def _commit_write_group(self):
1594
1416
        """Template method for per-repository write group cleanup.
1602
1424
    def suspend_write_group(self):
1603
1425
        raise errors.UnsuspendableWriteGroup(self)
1604
1426
 
1605
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
 
1427
    def get_missing_parent_inventories(self):
1606
1428
        """Return the keys of missing inventory parents for revisions added in
1607
1429
        this write group.
1608
1430
 
1617
1439
            return set()
1618
1440
        if not self.is_in_write_group():
1619
1441
            raise AssertionError('not in a write group')
1620
 
 
 
1442
                
1621
1443
        # XXX: We assume that every added revision already has its
1622
1444
        # corresponding inventory, so we only check for parent inventories that
1623
1445
        # might be missing, rather than all inventories.
1626
1448
        unstacked_inventories = self.inventories._index
1627
1449
        present_inventories = unstacked_inventories.get_parent_map(
1628
1450
            key[-1:] for key in parents)
1629
 
        parents.difference_update(present_inventories)
1630
 
        if len(parents) == 0:
 
1451
        if len(parents.difference(present_inventories)) == 0:
1631
1452
            # No missing parent inventories.
1632
1453
            return set()
1633
 
        if not check_for_missing_texts:
1634
 
            return set(('inventories', rev_id) for (rev_id,) in parents)
1635
1454
        # Ok, now we have a list of missing inventories.  But these only matter
1636
1455
        # if the inventories that reference them are missing some texts they
1637
1456
        # appear to introduce.
1639
1458
        # but at the moment we're only checking for texts referenced by
1640
1459
        # inventories at the graph's edge.
1641
1460
        key_deps = self.revisions._index._key_dependencies
1642
 
        key_deps.satisfy_refs_for_keys(present_inventories)
 
1461
        key_deps.add_keys(present_inventories)
1643
1462
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1644
1463
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1645
1464
        missing_texts = set()
1711
1530
            raise errors.InternalBzrError(
1712
1531
                "May not fetch while in a write group.")
1713
1532
        # fast path same-url fetch operations
1714
 
        # TODO: lift out to somewhere common with RemoteRepository
1715
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401646>
1716
 
        if (self.has_same_location(source)
1717
 
            and fetch_spec is None
1718
 
            and self._has_same_fallbacks(source)):
 
1533
        if self.has_same_location(source) and fetch_spec is None:
1719
1534
            # check that last_revision is in 'from' and then return a
1720
1535
            # no-operation.
1721
1536
            if (revision_id is not None and
1746
1561
        :param revprops: Optional dictionary of revision properties.
1747
1562
        :param revision_id: Optional revision id.
1748
1563
        """
1749
 
        if self._fallback_repositories:
1750
 
            raise errors.BzrError("Cannot commit from a lightweight checkout "
1751
 
                "to a stacked branch. See "
1752
 
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1753
1564
        result = self._commit_builder_class(self, parents, config,
1754
1565
            timestamp, timezone, committer, revprops, revision_id)
1755
1566
        self.start_write_group()
1756
1567
        return result
1757
1568
 
1758
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1759
1569
    def unlock(self):
1760
1570
        if (self.control_files._lock_count == 1 and
1761
1571
            self.control_files._lock_mode == 'w'):
1767
1577
        self.control_files.unlock()
1768
1578
        if self.control_files._lock_count == 0:
1769
1579
            self._inventory_entry_cache.clear()
1770
 
            for repo in self._fallback_repositories:
1771
 
                repo.unlock()
 
1580
        for repo in self._fallback_repositories:
 
1581
            repo.unlock()
1772
1582
 
1773
1583
    @needs_read_lock
1774
1584
    def clone(self, a_bzrdir, revision_id=None):
1883
1693
 
1884
1694
    @needs_read_lock
1885
1695
    def get_revisions(self, revision_ids):
1886
 
        """Get many revisions at once.
1887
 
        
1888
 
        Repositories that need to check data on every revision read should 
1889
 
        subclass this method.
1890
 
        """
 
1696
        """Get many revisions at once."""
1891
1697
        return self._get_revisions(revision_ids)
1892
1698
 
1893
1699
    @needs_read_lock
1894
1700
    def _get_revisions(self, revision_ids):
1895
1701
        """Core work logic to get many revisions without sanity checks."""
 
1702
        for rev_id in revision_ids:
 
1703
            if not rev_id or not isinstance(rev_id, basestring):
 
1704
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1705
        keys = [(key,) for key in revision_ids]
 
1706
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1896
1707
        revs = {}
1897
 
        for revid, rev in self._iter_revisions(revision_ids):
1898
 
            if rev is None:
1899
 
                raise errors.NoSuchRevision(self, revid)
1900
 
            revs[revid] = rev
 
1708
        for record in stream:
 
1709
            if record.storage_kind == 'absent':
 
1710
                raise errors.NoSuchRevision(self, record.key[0])
 
1711
            text = record.get_bytes_as('fulltext')
 
1712
            rev = self._serializer.read_revision_from_string(text)
 
1713
            revs[record.key[0]] = rev
1901
1714
        return [revs[revid] for revid in revision_ids]
1902
1715
 
1903
 
    def _iter_revisions(self, revision_ids):
1904
 
        """Iterate over revision objects.
1905
 
 
1906
 
        :param revision_ids: An iterable of revisions to examine. None may be
1907
 
            passed to request all revisions known to the repository. Note that
1908
 
            not all repositories can find unreferenced revisions; for those
1909
 
            repositories only referenced ones will be returned.
1910
 
        :return: An iterator of (revid, revision) tuples. Absent revisions (
1911
 
            those asked for but not available) are returned as (revid, None).
1912
 
        """
1913
 
        if revision_ids is None:
1914
 
            revision_ids = self.all_revision_ids()
1915
 
        else:
1916
 
            for rev_id in revision_ids:
1917
 
                if not rev_id or not isinstance(rev_id, basestring):
1918
 
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1919
 
        keys = [(key,) for key in revision_ids]
1920
 
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1921
 
        for record in stream:
1922
 
            revid = record.key[0]
1923
 
            if record.storage_kind == 'absent':
1924
 
                yield (revid, None)
1925
 
            else:
1926
 
                text = record.get_bytes_as('fulltext')
1927
 
                rev = self._serializer.read_revision_from_string(text)
1928
 
                yield (revid, rev)
 
1716
    @needs_read_lock
 
1717
    def get_revision_xml(self, revision_id):
 
1718
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1719
        #       would have already do it.
 
1720
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1721
        # TODO: this can't just be replaced by:
 
1722
        # return self._serializer.write_revision_to_string(
 
1723
        #     self.get_revision(revision_id))
 
1724
        # as cStringIO preservers the encoding unlike write_revision_to_string
 
1725
        # or some other call down the path.
 
1726
        rev = self.get_revision(revision_id)
 
1727
        rev_tmp = cStringIO.StringIO()
 
1728
        # the current serializer..
 
1729
        self._serializer.write_revision(rev, rev_tmp)
 
1730
        rev_tmp.seek(0)
 
1731
        return rev_tmp.getvalue()
1929
1732
 
1930
1733
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1931
1734
        """Produce a generator of revision deltas.
2109
1912
                    yield line, revid
2110
1913
 
2111
1914
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
2112
 
        revision_keys):
 
1915
        revision_ids):
2113
1916
        """Helper routine for fileids_altered_by_revision_ids.
2114
1917
 
2115
1918
        This performs the translation of xml lines to revision ids.
2116
1919
 
2117
1920
        :param line_iterator: An iterator of lines, origin_version_id
2118
 
        :param revision_keys: The revision ids to filter for. This should be a
 
1921
        :param revision_ids: The revision ids to filter for. This should be a
2119
1922
            set or other type which supports efficient __contains__ lookups, as
2120
 
            the revision key from each parsed line will be looked up in the
2121
 
            revision_keys filter.
 
1923
            the revision id from each parsed line will be looked up in the
 
1924
            revision_ids filter.
2122
1925
        :return: a dictionary mapping altered file-ids to an iterable of
2123
1926
        revision_ids. Each altered file-ids has the exact revision_ids that
2124
1927
        altered it listed explicitly.
2125
1928
        """
2126
1929
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
2127
1930
                line_iterator).iterkeys())
2128
 
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
 
1931
        # Note that revision_ids are revision keys.
 
1932
        parent_maps = self.revisions.get_parent_map(revision_ids)
 
1933
        parents = set()
 
1934
        map(parents.update, parent_maps.itervalues())
 
1935
        parents.difference_update(revision_ids)
2129
1936
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
2130
 
            self._inventory_xml_lines_for_keys(parent_keys)))
 
1937
            self._inventory_xml_lines_for_keys(parents)))
2131
1938
        new_keys = seen - parent_seen
2132
1939
        result = {}
2133
1940
        setdefault = result.setdefault
2135
1942
            setdefault(key[0], set()).add(key[-1])
2136
1943
        return result
2137
1944
 
2138
 
    def _find_parent_ids_of_revisions(self, revision_ids):
2139
 
        """Find all parent ids that are mentioned in the revision graph.
2140
 
 
2141
 
        :return: set of revisions that are parents of revision_ids which are
2142
 
            not part of revision_ids themselves
2143
 
        """
2144
 
        parent_map = self.get_parent_map(revision_ids)
2145
 
        parent_ids = set()
2146
 
        map(parent_ids.update, parent_map.itervalues())
2147
 
        parent_ids.difference_update(revision_ids)
2148
 
        parent_ids.discard(_mod_revision.NULL_REVISION)
2149
 
        return parent_ids
2150
 
 
2151
 
    def _find_parent_keys_of_revisions(self, revision_keys):
2152
 
        """Similar to _find_parent_ids_of_revisions, but used with keys.
2153
 
 
2154
 
        :param revision_keys: An iterable of revision_keys.
2155
 
        :return: The parents of all revision_keys that are not already in
2156
 
            revision_keys
2157
 
        """
2158
 
        parent_map = self.revisions.get_parent_map(revision_keys)
2159
 
        parent_keys = set()
2160
 
        map(parent_keys.update, parent_map.itervalues())
2161
 
        parent_keys.difference_update(revision_keys)
2162
 
        parent_keys.discard(_mod_revision.NULL_REVISION)
2163
 
        return parent_keys
2164
 
 
2165
1945
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
2166
1946
        """Find the file ids and versions affected by revisions.
2167
1947
 
2174
1954
        """
2175
1955
        selected_keys = set((revid,) for revid in revision_ids)
2176
1956
        w = _inv_weave or self.inventories
2177
 
        return self._find_file_ids_from_xml_inventory_lines(
2178
 
            w.iter_lines_added_or_present_in_keys(
2179
 
                selected_keys, pb=None),
2180
 
            selected_keys)
 
1957
        pb = ui.ui_factory.nested_progress_bar()
 
1958
        try:
 
1959
            return self._find_file_ids_from_xml_inventory_lines(
 
1960
                w.iter_lines_added_or_present_in_keys(
 
1961
                    selected_keys, pb=pb),
 
1962
                selected_keys)
 
1963
        finally:
 
1964
            pb.finished()
2181
1965
 
2182
1966
    def iter_files_bytes(self, desired_files):
2183
1967
        """Iterate through file versions.
2265
2049
                batch_size]
2266
2050
            if not to_query:
2267
2051
                break
2268
 
            for revision_id in to_query:
 
2052
            for rev_tree in self.revision_trees(to_query):
 
2053
                revision_id = rev_tree.get_revision_id()
2269
2054
                parent_ids = ancestors[revision_id]
2270
2055
                for text_key in revision_keys[revision_id]:
2271
2056
                    pb.update("Calculating text parents", processed_texts)
2344
2129
        num_file_ids = len(file_ids)
2345
2130
        for file_id, altered_versions in file_ids.iteritems():
2346
2131
            if pb is not None:
2347
 
                pb.update("Fetch texts", count, num_file_ids)
 
2132
                pb.update("fetch texts", count, num_file_ids)
2348
2133
            count += 1
2349
2134
            yield ("file", file_id, altered_versions)
2350
2135
 
2371
2156
        """Get Inventory object by revision id."""
2372
2157
        return self.iter_inventories([revision_id]).next()
2373
2158
 
2374
 
    def iter_inventories(self, revision_ids, ordering=None):
 
2159
    def iter_inventories(self, revision_ids):
2375
2160
        """Get many inventories by revision_ids.
2376
2161
 
2377
2162
        This will buffer some or all of the texts used in constructing the
2379
2164
        time.
2380
2165
 
2381
2166
        :param revision_ids: The expected revision ids of the inventories.
2382
 
        :param ordering: optional ordering, e.g. 'topological'.  If not
2383
 
            specified, the order of revision_ids will be preserved (by
2384
 
            buffering if necessary).
2385
2167
        :return: An iterator of inventories.
2386
2168
        """
2387
2169
        if ((None in revision_ids)
2388
2170
            or (_mod_revision.NULL_REVISION in revision_ids)):
2389
2171
            raise ValueError('cannot get null revision inventory')
2390
 
        return self._iter_inventories(revision_ids, ordering)
 
2172
        return self._iter_inventories(revision_ids)
2391
2173
 
2392
 
    def _iter_inventories(self, revision_ids, ordering):
 
2174
    def _iter_inventories(self, revision_ids):
2393
2175
        """single-document based inventory iteration."""
2394
 
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2395
 
        for text, revision_id in inv_xmls:
2396
 
            yield self._deserialise_inventory(revision_id, text)
 
2176
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
 
2177
            yield self.deserialise_inventory(revision_id, text)
2397
2178
 
2398
 
    def _iter_inventory_xmls(self, revision_ids, ordering):
2399
 
        if ordering is None:
2400
 
            order_as_requested = True
2401
 
            ordering = 'unordered'
2402
 
        else:
2403
 
            order_as_requested = False
 
2179
    def _iter_inventory_xmls(self, revision_ids):
2404
2180
        keys = [(revision_id,) for revision_id in revision_ids]
2405
 
        if not keys:
2406
 
            return
2407
 
        if order_as_requested:
2408
 
            key_iter = iter(keys)
2409
 
            next_key = key_iter.next()
2410
 
        stream = self.inventories.get_record_stream(keys, ordering, True)
 
2181
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2411
2182
        text_chunks = {}
2412
2183
        for record in stream:
2413
2184
            if record.storage_kind != 'absent':
2414
 
                chunks = record.get_bytes_as('chunked')
2415
 
                if order_as_requested:
2416
 
                    text_chunks[record.key] = chunks
2417
 
                else:
2418
 
                    yield ''.join(chunks), record.key[-1]
 
2185
                text_chunks[record.key] = record.get_bytes_as('chunked')
2419
2186
            else:
2420
2187
                raise errors.NoSuchRevision(self, record.key)
2421
 
            if order_as_requested:
2422
 
                # Yield as many results as we can while preserving order.
2423
 
                while next_key in text_chunks:
2424
 
                    chunks = text_chunks.pop(next_key)
2425
 
                    yield ''.join(chunks), next_key[-1]
2426
 
                    try:
2427
 
                        next_key = key_iter.next()
2428
 
                    except StopIteration:
2429
 
                        # We still want to fully consume the get_record_stream,
2430
 
                        # just in case it is not actually finished at this point
2431
 
                        next_key = None
2432
 
                        break
 
2188
        for key in keys:
 
2189
            chunks = text_chunks.pop(key)
 
2190
            yield ''.join(chunks), key[-1]
2433
2191
 
2434
 
    def _deserialise_inventory(self, revision_id, xml):
 
2192
    def deserialise_inventory(self, revision_id, xml):
2435
2193
        """Transform the xml into an inventory object.
2436
2194
 
2437
2195
        :param revision_id: The expected revision id of the inventory.
2438
2196
        :param xml: A serialised inventory.
2439
2197
        """
2440
2198
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2441
 
                    entry_cache=self._inventory_entry_cache,
2442
 
                    return_from_cache=self._safe_to_return_from_cache)
 
2199
                    entry_cache=self._inventory_entry_cache)
2443
2200
        if result.revision_id != revision_id:
2444
2201
            raise AssertionError('revision id mismatch %s != %s' % (
2445
2202
                result.revision_id, revision_id))
2446
2203
        return result
2447
2204
 
 
2205
    def serialise_inventory(self, inv):
 
2206
        return self._serializer.write_inventory_to_string(inv)
 
2207
 
 
2208
    def _serialise_inventory_to_lines(self, inv):
 
2209
        return self._serializer.write_inventory_to_lines(inv)
 
2210
 
2448
2211
    def get_serializer_format(self):
2449
2212
        return self._serializer.format_num
2450
2213
 
2451
2214
    @needs_read_lock
2452
 
    def _get_inventory_xml(self, revision_id):
2453
 
        """Get serialized inventory as a string."""
2454
 
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
 
2215
    def get_inventory_xml(self, revision_id):
 
2216
        """Get inventory XML as a file object."""
 
2217
        texts = self._iter_inventory_xmls([revision_id])
2455
2218
        try:
2456
2219
            text, revision_id = texts.next()
2457
2220
        except StopIteration:
2458
2221
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2459
2222
        return text
2460
2223
 
2461
 
    def get_rev_id_for_revno(self, revno, known_pair):
2462
 
        """Return the revision id of a revno, given a later (revno, revid)
2463
 
        pair in the same history.
2464
 
 
2465
 
        :return: if found (True, revid).  If the available history ran out
2466
 
            before reaching the revno, then this returns
2467
 
            (False, (closest_revno, closest_revid)).
 
2224
    @needs_read_lock
 
2225
    def get_inventory_sha1(self, revision_id):
 
2226
        """Return the sha1 hash of the inventory entry
2468
2227
        """
2469
 
        known_revno, known_revid = known_pair
2470
 
        partial_history = [known_revid]
2471
 
        distance_from_known = known_revno - revno
2472
 
        if distance_from_known < 0:
2473
 
            raise ValueError(
2474
 
                'requested revno (%d) is later than given known revno (%d)'
2475
 
                % (revno, known_revno))
2476
 
        try:
2477
 
            _iter_for_revno(
2478
 
                self, partial_history, stop_index=distance_from_known)
2479
 
        except errors.RevisionNotPresent, err:
2480
 
            if err.revision_id == known_revid:
2481
 
                # The start revision (known_revid) wasn't found.
2482
 
                raise
2483
 
            # This is a stacked repository with no fallbacks, or a there's a
2484
 
            # left-hand ghost.  Either way, even though the revision named in
2485
 
            # the error isn't in this repo, we know it's the next step in this
2486
 
            # left-hand history.
2487
 
            partial_history.append(err.revision_id)
2488
 
        if len(partial_history) <= distance_from_known:
2489
 
            # Didn't find enough history to get a revid for the revno.
2490
 
            earliest_revno = known_revno - len(partial_history) + 1
2491
 
            return (False, (earliest_revno, partial_history[-1]))
2492
 
        if len(partial_history) - 1 > distance_from_known:
2493
 
            raise AssertionError('_iter_for_revno returned too much history')
2494
 
        return (True, partial_history[-1])
 
2228
        return self.get_revision(revision_id).inventory_sha1
2495
2229
 
2496
2230
    def iter_reverse_revision_history(self, revision_id):
2497
2231
        """Iterate backwards through revision ids in the lefthand history
2504
2238
        while True:
2505
2239
            if next_id in (None, _mod_revision.NULL_REVISION):
2506
2240
                return
2507
 
            try:
2508
 
                parents = graph.get_parent_map([next_id])[next_id]
2509
 
            except KeyError:
2510
 
                raise errors.RevisionNotPresent(next_id, self)
2511
2241
            yield next_id
 
2242
            # Note: The following line may raise KeyError in the event of
 
2243
            # truncated history. We decided not to have a try:except:raise
 
2244
            # RevisionNotPresent here until we see a use for it, because of the
 
2245
            # cost in an inner loop that is by its very nature O(history).
 
2246
            # Robert Collins 20080326
 
2247
            parents = graph.get_parent_map([next_id])[next_id]
2512
2248
            if len(parents) == 0:
2513
2249
                return
2514
2250
            else:
2515
2251
                next_id = parents[0]
2516
2252
 
 
2253
    @needs_read_lock
 
2254
    def get_revision_inventory(self, revision_id):
 
2255
        """Return inventory of a past revision."""
 
2256
        # TODO: Unify this with get_inventory()
 
2257
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
2258
        # must be the same as its revision, so this is trivial.
 
2259
        if revision_id is None:
 
2260
            # This does not make sense: if there is no revision,
 
2261
            # then it is the current tree inventory surely ?!
 
2262
            # and thus get_root_id() is something that looks at the last
 
2263
            # commit on the branch, and the get_root_id is an inventory check.
 
2264
            raise NotImplementedError
 
2265
            # return Inventory(self.get_root_id())
 
2266
        else:
 
2267
            return self.get_inventory(revision_id)
 
2268
 
2517
2269
    def is_shared(self):
2518
2270
        """Return True if this repository is flagged as a shared repository."""
2519
2271
        raise NotImplementedError(self.is_shared)
2553
2305
            return RevisionTree(self, Inventory(root_id=None),
2554
2306
                                _mod_revision.NULL_REVISION)
2555
2307
        else:
2556
 
            inv = self.get_inventory(revision_id)
 
2308
            inv = self.get_revision_inventory(revision_id)
2557
2309
            return RevisionTree(self, inv, revision_id)
2558
2310
 
2559
2311
    def revision_trees(self, revision_ids):
2612
2364
            keys = tsort.topo_sort(parent_map)
2613
2365
        return [None] + list(keys)
2614
2366
 
2615
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
2367
    def pack(self):
2616
2368
        """Compress the data within the repository.
2617
2369
 
2618
2370
        This operation only makes sense for some repository types. For other
2621
2373
        This stub method does not require a lock, but subclasses should use
2622
2374
        @needs_write_lock as this is a long running call its reasonable to
2623
2375
        implicitly lock for the user.
2624
 
 
2625
 
        :param hint: If not supplied, the whole repository is packed.
2626
 
            If supplied, the repository may use the hint parameter as a
2627
 
            hint for the parts of the repository to pack. A hint can be
2628
 
            obtained from the result of commit_write_group(). Out of
2629
 
            date hints are simply ignored, because concurrent operations
2630
 
            can obsolete them rapidly.
2631
 
 
2632
 
        :param clean_obsolete_packs: Clean obsolete packs immediately after
2633
 
            the pack operation.
2634
2376
        """
2635
2377
 
2636
2378
    def get_transaction(self):
2637
2379
        return self.control_files.get_transaction()
2638
2380
 
2639
2381
    def get_parent_map(self, revision_ids):
2640
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
2382
        """See graph._StackedParentsProvider.get_parent_map"""
2641
2383
        # revisions index works in keys; this just works in revisions
2642
2384
        # therefore wrap and unwrap
2643
2385
        query_keys = []
2652
2394
        for ((revision_id,), parent_keys) in \
2653
2395
                self.revisions.get_parent_map(query_keys).iteritems():
2654
2396
            if parent_keys:
2655
 
                result[revision_id] = tuple([parent_revid
2656
 
                    for (parent_revid,) in parent_keys])
 
2397
                result[revision_id] = tuple(parent_revid
 
2398
                    for (parent_revid,) in parent_keys)
2657
2399
            else:
2658
2400
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2659
2401
        return result
2661
2403
    def _make_parents_provider(self):
2662
2404
        return self
2663
2405
 
2664
 
    @needs_read_lock
2665
 
    def get_known_graph_ancestry(self, revision_ids):
2666
 
        """Return the known graph for a set of revision ids and their ancestors.
2667
 
        """
2668
 
        st = static_tuple.StaticTuple
2669
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
2670
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
2671
 
        return graph.GraphThunkIdsToKeys(known_graph)
2672
 
 
2673
2406
    def get_graph(self, other_repository=None):
2674
2407
        """Return the graph walker for this repository format"""
2675
2408
        parents_provider = self._make_parents_provider()
2676
2409
        if (other_repository is not None and
2677
2410
            not self.has_same_location(other_repository)):
2678
 
            parents_provider = graph.StackedParentsProvider(
 
2411
            parents_provider = graph._StackedParentsProvider(
2679
2412
                [parents_provider, other_repository._make_parents_provider()])
2680
2413
        return graph.Graph(parents_provider)
2681
2414
 
2682
 
    def _get_versioned_file_checker(self, text_key_references=None,
2683
 
        ancestors=None):
 
2415
    def _get_versioned_file_checker(self, text_key_references=None):
2684
2416
        """Return an object suitable for checking versioned files.
2685
2417
        
2686
2418
        :param text_key_references: if non-None, an already built
2688
2420
            to whether they were referred to by the inventory of the
2689
2421
            revision_id that they contain. If None, this will be
2690
2422
            calculated.
2691
 
        :param ancestors: Optional result from
2692
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2693
 
            available.
2694
2423
        """
2695
2424
        return _VersionedFileChecker(self,
2696
 
            text_key_references=text_key_references, ancestors=ancestors)
 
2425
            text_key_references=text_key_references)
2697
2426
 
2698
2427
    def revision_ids_to_search_result(self, result_set):
2699
2428
        """Convert a set of revision ids to a graph SearchResult."""
2749
2478
        return record.get_bytes_as('fulltext')
2750
2479
 
2751
2480
    @needs_read_lock
2752
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
2481
    def check(self, revision_ids=None):
2753
2482
        """Check consistency of all history of given revision_ids.
2754
2483
 
2755
2484
        Different repository implementations should override _check().
2756
2485
 
2757
2486
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2758
2487
             will be checked.  Typically the last revision_id of a branch.
2759
 
        :param callback_refs: A dict of check-refs to resolve and callback
2760
 
            the check/_check method on the items listed as wanting the ref.
2761
 
            see bzrlib.check.
2762
 
        :param check_repo: If False do not check the repository contents, just 
2763
 
            calculate the data callback_refs requires and call them back.
2764
2488
        """
2765
 
        return self._check(revision_ids, callback_refs=callback_refs,
2766
 
            check_repo=check_repo)
 
2489
        return self._check(revision_ids)
2767
2490
 
2768
 
    def _check(self, revision_ids, callback_refs, check_repo):
2769
 
        result = check.Check(self, check_repo=check_repo)
2770
 
        result.check(callback_refs)
 
2491
    def _check(self, revision_ids):
 
2492
        result = check.Check(self)
 
2493
        result.check()
2771
2494
        return result
2772
2495
 
2773
 
    def _warn_if_deprecated(self, branch=None):
 
2496
    def _warn_if_deprecated(self):
2774
2497
        global _deprecation_warning_done
2775
2498
        if _deprecation_warning_done:
2776
2499
            return
2777
 
        try:
2778
 
            if branch is None:
2779
 
                conf = config.GlobalConfig()
2780
 
            else:
2781
 
                conf = branch.get_config()
2782
 
            if conf.suppress_warning('format_deprecation'):
2783
 
                return
2784
 
            warning("Format %s for %s is deprecated -"
2785
 
                    " please use 'bzr upgrade' to get better performance"
2786
 
                    % (self._format, self.bzrdir.transport.base))
2787
 
        finally:
2788
 
            _deprecation_warning_done = True
 
2500
        _deprecation_warning_done = True
 
2501
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
2502
                % (self._format, self.bzrdir.transport.base))
2789
2503
 
2790
2504
    def supports_rich_root(self):
2791
2505
        return self._format.rich_root_data
3067
2781
    # Does this format have < O(tree_size) delta generation. Used to hint what
3068
2782
    # code path for commit, amongst other things.
3069
2783
    fast_deltas = None
3070
 
    # Does doing a pack operation compress data? Useful for the pack UI command
3071
 
    # (so if there is one pack, the operation can still proceed because it may
3072
 
    # help), and for fetching when data won't have come from the same
3073
 
    # compressor.
3074
 
    pack_compresses = False
3075
 
    # Does the repository inventory storage understand references to trees?
3076
 
    supports_tree_reference = None
3077
 
    # Is the format experimental ?
3078
 
    experimental = False
3079
2784
 
3080
 
    def __repr__(self):
3081
 
        return "%s()" % self.__class__.__name__
 
2785
    def __str__(self):
 
2786
        return "<%s>" % self.__class__.__name__
3082
2787
 
3083
2788
    def __eq__(self, other):
3084
2789
        # format objects are generally stateless
3097
2802
        """
3098
2803
        try:
3099
2804
            transport = a_bzrdir.get_repository_transport(None)
3100
 
            format_string = transport.get_bytes("format")
 
2805
            format_string = transport.get("format").read()
3101
2806
            return format_registry.get(format_string)
3102
2807
        except errors.NoSuchFile:
3103
2808
            raise errors.NoRepositoryPresent(a_bzrdir)
3185
2890
        raise NotImplementedError(self.network_name)
3186
2891
 
3187
2892
    def check_conversion_target(self, target_format):
3188
 
        if self.rich_root_data and not target_format.rich_root_data:
3189
 
            raise errors.BadConversionTarget(
3190
 
                'Does not support rich root data.', target_format,
3191
 
                from_format=self)
3192
 
        if (self.supports_tree_reference and 
3193
 
            not getattr(target_format, 'supports_tree_reference', False)):
3194
 
            raise errors.BadConversionTarget(
3195
 
                'Does not support nested trees', target_format,
3196
 
                from_format=self)
 
2893
        raise NotImplementedError(self.check_conversion_target)
3197
2894
 
3198
2895
    def open(self, a_bzrdir, _found=False):
3199
2896
        """Return an instance of this format for the bzrdir a_bzrdir.
3202
2899
        """
3203
2900
        raise NotImplementedError(self.open)
3204
2901
 
3205
 
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
3206
 
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
3207
 
        hooks = BzrDir.hooks['post_repo_init']
3208
 
        if not hooks:
3209
 
            return
3210
 
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
3211
 
        for hook in hooks:
3212
 
            hook(params)
3213
 
 
3214
2902
 
3215
2903
class MetaDirRepositoryFormat(RepositoryFormat):
3216
2904
    """Common base class for the new repositories using the metadir layout."""
3367
3055
    'RepositoryFormatCHK1',
3368
3056
    )
3369
3057
 
3370
 
format_registry.register_lazy(
3371
 
    'Bazaar development format - chk repository with bencode revision '
3372
 
        'serialization (needs bzr.dev from 1.16)\n',
3373
 
    'bzrlib.repofmt.groupcompress_repo',
3374
 
    'RepositoryFormatCHK2',
3375
 
    )
3376
 
format_registry.register_lazy(
3377
 
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
3378
 
    'bzrlib.repofmt.groupcompress_repo',
3379
 
    'RepositoryFormat2a',
3380
 
    )
3381
 
 
3382
3058
 
3383
3059
class InterRepository(InterObject):
3384
3060
    """This class represents operations taking place between two repositories.
3421
3097
 
3422
3098
        :param revision_id: if None all content is copied, if NULL_REVISION no
3423
3099
                            content is copied.
3424
 
        :param pb: ignored.
 
3100
        :param pb: optional progress bar to use for progress reports. If not
 
3101
                   provided a default one will be created.
3425
3102
        :return: None.
3426
3103
        """
3427
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3428
3104
        from bzrlib.fetch import RepoFetcher
3429
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
3430
 
        if self.source._format.network_name() != self.target._format.network_name():
3431
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
3432
 
                from_format=self.source._format,
3433
 
                to_format=self.target._format)
3434
3105
        f = RepoFetcher(to_repository=self.target,
3435
3106
                               from_repository=self.source,
3436
3107
                               last_revision=revision_id,
3437
3108
                               fetch_spec=fetch_spec,
3438
 
                               find_ghosts=find_ghosts)
 
3109
                               pb=pb, find_ghosts=find_ghosts)
3439
3110
 
3440
3111
    def _walk_to_common_revisions(self, revision_ids):
3441
3112
        """Walk out from revision_ids in source to revisions target has.
3610
3281
                self.target.texts.insert_record_stream(
3611
3282
                    self.source.texts.get_record_stream(
3612
3283
                        self.source.texts.keys(), 'topological', False))
3613
 
                pb.update('Copying inventory', 0, 1)
 
3284
                pb.update('copying inventory', 0, 1)
3614
3285
                self.target.inventories.insert_record_stream(
3615
3286
                    self.source.inventories.get_record_stream(
3616
3287
                        self.source.inventories.keys(), 'topological', False))
3730
3401
        return self.source.revision_ids_to_search_result(result_set)
3731
3402
 
3732
3403
 
 
3404
class InterPackRepo(InterSameDataRepository):
 
3405
    """Optimised code paths between Pack based repositories."""
 
3406
 
 
3407
    @classmethod
 
3408
    def _get_repo_format_to_test(self):
 
3409
        from bzrlib.repofmt import pack_repo
 
3410
        return pack_repo.RepositoryFormatKnitPack6RichRoot()
 
3411
 
 
3412
    @staticmethod
 
3413
    def is_compatible(source, target):
 
3414
        """Be compatible with known Pack formats.
 
3415
 
 
3416
        We don't test for the stores being of specific types because that
 
3417
        could lead to confusing results, and there is no need to be
 
3418
        overly general.
 
3419
 
 
3420
        InterPackRepo does not support CHK based repositories.
 
3421
        """
 
3422
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
3423
        from bzrlib.repofmt.groupcompress_repo import RepositoryFormatCHK1
 
3424
        try:
 
3425
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
3426
                isinstance(target._format, RepositoryFormatPack))
 
3427
            not_packs = (isinstance(source._format, RepositoryFormatCHK1) or
 
3428
                isinstance(target._format, RepositoryFormatCHK1))
 
3429
        except AttributeError:
 
3430
            return False
 
3431
        if not_packs or not are_packs:
 
3432
            return False
 
3433
        return InterRepository._same_model(source, target)
 
3434
 
 
3435
    @needs_write_lock
 
3436
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
 
3437
            fetch_spec=None):
 
3438
        """See InterRepository.fetch()."""
 
3439
        if (len(self.source._fallback_repositories) > 0 or
 
3440
            len(self.target._fallback_repositories) > 0):
 
3441
            # The pack layer is not aware of fallback repositories, so when
 
3442
            # fetching from a stacked repository or into a stacked repository
 
3443
            # we use the generic fetch logic which uses the VersionedFiles
 
3444
            # attributes on repository.
 
3445
            from bzrlib.fetch import RepoFetcher
 
3446
            fetcher = RepoFetcher(self.target, self.source, revision_id,
 
3447
                    pb, find_ghosts, fetch_spec=fetch_spec)
 
3448
        if fetch_spec is not None:
 
3449
            if len(list(fetch_spec.heads)) != 1:
 
3450
                raise AssertionError(
 
3451
                    "InterPackRepo.fetch doesn't support "
 
3452
                    "fetching multiple heads yet.")
 
3453
            revision_id = list(fetch_spec.heads)[0]
 
3454
            fetch_spec = None
 
3455
        if revision_id is None:
 
3456
            # TODO:
 
3457
            # everything to do - use pack logic
 
3458
            # to fetch from all packs to one without
 
3459
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
3460
            # till then:
 
3461
            source_revision_ids = frozenset(self.source.all_revision_ids())
 
3462
            revision_ids = source_revision_ids - \
 
3463
                frozenset(self.target.get_parent_map(source_revision_ids))
 
3464
            revision_keys = [(revid,) for revid in revision_ids]
 
3465
            index = self.target._pack_collection.revision_index.combined_index
 
3466
            present_revision_ids = set(item[1][0] for item in
 
3467
                index.iter_entries(revision_keys))
 
3468
            revision_ids = set(revision_ids) - present_revision_ids
 
3469
            # implementing the TODO will involve:
 
3470
            # - detecting when all of a pack is selected
 
3471
            # - avoiding as much as possible pre-selection, so the
 
3472
            # more-core routines such as create_pack_from_packs can filter in
 
3473
            # a just-in-time fashion. (though having a HEADS list on a
 
3474
            # repository might make this a lot easier, because we could
 
3475
            # sensibly detect 'new revisions' without doing a full index scan.
 
3476
        elif _mod_revision.is_null(revision_id):
 
3477
            # nothing to do:
 
3478
            return (0, [])
 
3479
        else:
 
3480
            revision_ids = self.search_missing_revision_ids(revision_id,
 
3481
                find_ghosts=find_ghosts).get_keys()
 
3482
            if len(revision_ids) == 0:
 
3483
                return (0, [])
 
3484
        return self._pack(self.source, self.target, revision_ids)
 
3485
 
 
3486
    def _pack(self, source, target, revision_ids):
 
3487
        from bzrlib.repofmt.pack_repo import Packer
 
3488
        packs = source._pack_collection.all_packs()
 
3489
        pack = Packer(self.target._pack_collection, packs, '.fetch',
 
3490
            revision_ids).pack()
 
3491
        if pack is not None:
 
3492
            self.target._pack_collection._save_pack_names()
 
3493
            copied_revs = pack.get_revision_count()
 
3494
            # Trigger an autopack. This may duplicate effort as we've just done
 
3495
            # a pack creation, but for now it is simpler to think about as
 
3496
            # 'upload data, then repack if needed'.
 
3497
            self.target._pack_collection.autopack()
 
3498
            return (copied_revs, [])
 
3499
        else:
 
3500
            return (0, [])
 
3501
 
 
3502
    @needs_read_lock
 
3503
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
3504
        """See InterRepository.missing_revision_ids().
 
3505
 
 
3506
        :param find_ghosts: Find ghosts throughout the ancestry of
 
3507
            revision_id.
 
3508
        """
 
3509
        if not find_ghosts and revision_id is not None:
 
3510
            return self._walk_to_common_revisions([revision_id])
 
3511
        elif revision_id is not None:
 
3512
            # Find ghosts: search for revisions pointing from one repository to
 
3513
            # the other, and vice versa, anywhere in the history of revision_id.
 
3514
            graph = self.target.get_graph(other_repository=self.source)
 
3515
            searcher = graph._make_breadth_first_searcher([revision_id])
 
3516
            found_ids = set()
 
3517
            while True:
 
3518
                try:
 
3519
                    next_revs, ghosts = searcher.next_with_ghosts()
 
3520
                except StopIteration:
 
3521
                    break
 
3522
                if revision_id in ghosts:
 
3523
                    raise errors.NoSuchRevision(self.source, revision_id)
 
3524
                found_ids.update(next_revs)
 
3525
                found_ids.update(ghosts)
 
3526
            found_ids = frozenset(found_ids)
 
3527
            # Double query here: should be able to avoid this by changing the
 
3528
            # graph api further.
 
3529
            result_set = found_ids - frozenset(
 
3530
                self.target.get_parent_map(found_ids))
 
3531
        else:
 
3532
            source_ids = self.source.all_revision_ids()
 
3533
            # source_ids is the worst possible case we may need to pull.
 
3534
            # now we want to filter source_ids against what we actually
 
3535
            # have in target, but don't try to check for existence where we know
 
3536
            # we do not have a revision as that would be pointless.
 
3537
            target_ids = set(self.target.all_revision_ids())
 
3538
            result_set = set(source_ids).difference(target_ids)
 
3539
        return self.source.revision_ids_to_search_result(result_set)
 
3540
 
 
3541
 
3733
3542
class InterDifferingSerializer(InterRepository):
3734
3543
 
3735
3544
    @classmethod
3742
3551
        # This is redundant with format.check_conversion_target(), however that
3743
3552
        # raises an exception, and we just want to say "False" as in we won't
3744
3553
        # support converting between these formats.
3745
 
        if 'IDS_never' in debug.debug_flags:
3746
 
            return False
3747
3554
        if source.supports_rich_root() and not target.supports_rich_root():
3748
3555
            return False
3749
3556
        if (source._format.supports_tree_reference
3750
3557
            and not target._format.supports_tree_reference):
3751
3558
            return False
3752
 
        if target._fallback_repositories and target._format.supports_chks:
3753
 
            # IDS doesn't know how to copy CHKs for the parent inventories it
3754
 
            # adds to stacked repos.
3755
 
            return False
3756
 
        if 'IDS_always' in debug.debug_flags:
3757
 
            return True
3758
 
        # Only use this code path for local source and target.  IDS does far
3759
 
        # too much IO (both bandwidth and roundtrips) over a network.
3760
 
        if not source.bzrdir.transport.base.startswith('file:///'):
3761
 
            return False
3762
 
        if not target.bzrdir.transport.base.startswith('file:///'):
3763
 
            return False
3764
3559
        return True
3765
3560
 
3766
 
    def _get_trees(self, revision_ids, cache):
3767
 
        possible_trees = []
3768
 
        for rev_id in revision_ids:
3769
 
            if rev_id in cache:
3770
 
                possible_trees.append((rev_id, cache[rev_id]))
3771
 
            else:
3772
 
                # Not cached, but inventory might be present anyway.
3773
 
                try:
3774
 
                    tree = self.source.revision_tree(rev_id)
3775
 
                except errors.NoSuchRevision:
3776
 
                    # Nope, parent is ghost.
3777
 
                    pass
3778
 
                else:
3779
 
                    cache[rev_id] = tree
3780
 
                    possible_trees.append((rev_id, tree))
3781
 
        return possible_trees
3782
 
 
3783
 
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
 
3561
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
3784
3562
        """Get the best delta and base for this revision.
3785
3563
 
3786
3564
        :return: (basis_id, delta)
3787
3565
        """
 
3566
        possible_trees = [(parent_id, cache[parent_id])
 
3567
                          for parent_id in parent_ids
 
3568
                           if parent_id in cache]
 
3569
        if len(possible_trees) == 0:
 
3570
            # There either aren't any parents, or the parents aren't in the
 
3571
            # cache, so just use the last converted tree
 
3572
            possible_trees.append((basis_id, cache[basis_id]))
3788
3573
        deltas = []
3789
 
        # Generate deltas against each tree, to find the shortest.
3790
 
        texts_possibly_new_in_tree = set()
3791
3574
        for basis_id, basis_tree in possible_trees:
3792
3575
            delta = tree.inventory._make_delta(basis_tree.inventory)
3793
 
            for old_path, new_path, file_id, new_entry in delta:
3794
 
                if new_path is None:
3795
 
                    # This file_id isn't present in the new rev, so we don't
3796
 
                    # care about it.
3797
 
                    continue
3798
 
                if not new_path:
3799
 
                    # Rich roots are handled elsewhere...
3800
 
                    continue
3801
 
                kind = new_entry.kind
3802
 
                if kind != 'directory' and kind != 'file':
3803
 
                    # No text record associated with this inventory entry.
3804
 
                    continue
3805
 
                # This is a directory or file that has changed somehow.
3806
 
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3807
3576
            deltas.append((len(delta), basis_id, delta))
3808
3577
        deltas.sort()
3809
3578
        return deltas[0][1:]
3810
3579
 
3811
 
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
3812
 
        """Find all parent revisions that are absent, but for which the
3813
 
        inventory is present, and copy those inventories.
3814
 
 
3815
 
        This is necessary to preserve correctness when the source is stacked
3816
 
        without fallbacks configured.  (Note that in cases like upgrade the
3817
 
        source may be not have _fallback_repositories even though it is
3818
 
        stacked.)
3819
 
        """
3820
 
        parent_revs = set()
3821
 
        for parents in parent_map.values():
3822
 
            parent_revs.update(parents)
3823
 
        present_parents = self.source.get_parent_map(parent_revs)
3824
 
        absent_parents = set(parent_revs).difference(present_parents)
3825
 
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
3826
 
            (rev_id,) for rev_id in absent_parents)
3827
 
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
3828
 
        for parent_tree in self.source.revision_trees(parent_inv_ids):
3829
 
            current_revision_id = parent_tree.get_revision_id()
3830
 
            parents_parents_keys = parent_invs_keys_for_stacking[
3831
 
                (current_revision_id,)]
3832
 
            parents_parents = [key[-1] for key in parents_parents_keys]
3833
 
            basis_id = _mod_revision.NULL_REVISION
3834
 
            basis_tree = self.source.revision_tree(basis_id)
3835
 
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
3836
 
            self.target.add_inventory_by_delta(
3837
 
                basis_id, delta, current_revision_id, parents_parents)
3838
 
            cache[current_revision_id] = parent_tree
3839
 
 
3840
 
    def _fetch_batch(self, revision_ids, basis_id, cache, a_graph=None):
 
3580
    def _get_parent_keys(self, root_key, parent_map):
 
3581
        """Get the parent keys for a given root id."""
 
3582
        root_id, rev_id = root_key
 
3583
        # Include direct parents of the revision, but only if they used
 
3584
        # the same root_id and are heads.
 
3585
        parent_keys = []
 
3586
        for parent_id in parent_map[rev_id]:
 
3587
            if parent_id == _mod_revision.NULL_REVISION:
 
3588
                continue
 
3589
            if parent_id not in self._revision_id_to_root_id:
 
3590
                # We probably didn't read this revision, go spend the
 
3591
                # extra effort to actually check
 
3592
                try:
 
3593
                    tree = self.source.revision_tree(parent_id)
 
3594
                except errors.NoSuchRevision:
 
3595
                    # Ghost, fill out _revision_id_to_root_id in case we
 
3596
                    # encounter this again.
 
3597
                    # But set parent_root_id to None since we don't really know
 
3598
                    parent_root_id = None
 
3599
                else:
 
3600
                    parent_root_id = tree.get_root_id()
 
3601
                self._revision_id_to_root_id[parent_id] = None
 
3602
            else:
 
3603
                parent_root_id = self._revision_id_to_root_id[parent_id]
 
3604
            if root_id == parent_root_id:
 
3605
                # With stacking we _might_ want to refer to a non-local
 
3606
                # revision, but this code path only applies when we have the
 
3607
                # full content available, so ghosts really are ghosts, not just
 
3608
                # the edge of local data.
 
3609
                parent_keys.append((parent_id,))
 
3610
            else:
 
3611
                # root_id may be in the parent anyway.
 
3612
                try:
 
3613
                    tree = self.source.revision_tree(parent_id)
 
3614
                except errors.NoSuchRevision:
 
3615
                    # ghost, can't refer to it.
 
3616
                    pass
 
3617
                else:
 
3618
                    try:
 
3619
                        parent_keys.append((tree.inventory[root_id].revision,))
 
3620
                    except errors.NoSuchId:
 
3621
                        # not in the tree
 
3622
                        pass
 
3623
        g = graph.Graph(self.source.revisions)
 
3624
        heads = g.heads(parent_keys)
 
3625
        selected_keys = []
 
3626
        for key in parent_keys:
 
3627
            if key in heads and key not in selected_keys:
 
3628
                selected_keys.append(key)
 
3629
        return tuple([(root_id,)+ key for key in selected_keys])
 
3630
 
 
3631
    def _new_root_data_stream(self, root_keys_to_create, parent_map):
 
3632
        for root_key in root_keys_to_create:
 
3633
            parent_keys = self._get_parent_keys(root_key, parent_map)
 
3634
            yield versionedfile.FulltextContentFactory(root_key,
 
3635
                parent_keys, None, '')
 
3636
 
 
3637
    def _fetch_batch(self, revision_ids, basis_id, cache):
3841
3638
        """Fetch across a few revisions.
3842
3639
 
3843
3640
        :param revision_ids: The revisions to copy
3844
3641
        :param basis_id: The revision_id of a tree that must be in cache, used
3845
3642
            as a basis for delta when no other base is available
3846
3643
        :param cache: A cache of RevisionTrees that we can use.
3847
 
        :param a_graph: A Graph object to determine the heads() of the
3848
 
            rich-root data stream.
3849
3644
        :return: The revision_id of the last converted tree. The RevisionTree
3850
3645
            for it will be in cache
3851
3646
        """
3857
3652
        pending_deltas = []
3858
3653
        pending_revisions = []
3859
3654
        parent_map = self.source.get_parent_map(revision_ids)
3860
 
        self._fetch_parent_invs_for_stacking(parent_map, cache)
3861
 
        self.source._safe_to_return_from_cache = True
3862
3655
        for tree in self.source.revision_trees(revision_ids):
3863
 
            # Find a inventory delta for this revision.
3864
 
            # Find text entries that need to be copied, too.
3865
3656
            current_revision_id = tree.get_revision_id()
3866
3657
            parent_ids = parent_map.get(current_revision_id, ())
3867
 
            parent_trees = self._get_trees(parent_ids, cache)
3868
 
            possible_trees = list(parent_trees)
3869
 
            if len(possible_trees) == 0:
3870
 
                # There either aren't any parents, or the parents are ghosts,
3871
 
                # so just use the last converted tree.
3872
 
                possible_trees.append((basis_id, cache[basis_id]))
3873
3658
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3874
 
                                                           possible_trees)
3875
 
            revision = self.source.get_revision(current_revision_id)
3876
 
            pending_deltas.append((basis_id, delta,
3877
 
                current_revision_id, revision.parent_ids))
 
3659
                                                           basis_id, cache)
3878
3660
            if self._converting_to_rich_root:
3879
3661
                self._revision_id_to_root_id[current_revision_id] = \
3880
3662
                    tree.get_root_id()
3881
 
            # Determine which texts are in present in this revision but not in
3882
 
            # any of the available parents.
3883
 
            texts_possibly_new_in_tree = set()
 
3663
            # Find text entries that need to be copied
3884
3664
            for old_path, new_path, file_id, entry in delta:
3885
 
                if new_path is None:
3886
 
                    # This file_id isn't present in the new rev
3887
 
                    continue
3888
 
                if not new_path:
3889
 
                    # This is the root
3890
 
                    if not self.target.supports_rich_root():
3891
 
                        # The target doesn't support rich root, so we don't
3892
 
                        # copy
3893
 
                        continue
3894
 
                    if self._converting_to_rich_root:
3895
 
                        # This can't be copied normally, we have to insert
3896
 
                        # it specially
3897
 
                        root_keys_to_create.add((file_id, entry.revision))
3898
 
                        continue
3899
 
                kind = entry.kind
3900
 
                texts_possibly_new_in_tree.add((file_id, entry.revision))
3901
 
            for basis_id, basis_tree in possible_trees:
3902
 
                basis_inv = basis_tree.inventory
3903
 
                for file_key in list(texts_possibly_new_in_tree):
3904
 
                    file_id, file_revision = file_key
3905
 
                    try:
3906
 
                        entry = basis_inv[file_id]
3907
 
                    except errors.NoSuchId:
3908
 
                        continue
3909
 
                    if entry.revision == file_revision:
3910
 
                        texts_possibly_new_in_tree.remove(file_key)
3911
 
            text_keys.update(texts_possibly_new_in_tree)
 
3665
                if new_path is not None:
 
3666
                    if not new_path:
 
3667
                        # This is the root
 
3668
                        if not self.target.supports_rich_root():
 
3669
                            # The target doesn't support rich root, so we don't
 
3670
                            # copy
 
3671
                            continue
 
3672
                        if self._converting_to_rich_root:
 
3673
                            # This can't be copied normally, we have to insert
 
3674
                            # it specially
 
3675
                            root_keys_to_create.add((file_id, entry.revision))
 
3676
                            continue
 
3677
                    text_keys.add((file_id, entry.revision))
 
3678
            revision = self.source.get_revision(current_revision_id)
 
3679
            pending_deltas.append((basis_id, delta,
 
3680
                current_revision_id, revision.parent_ids))
3912
3681
            pending_revisions.append(revision)
3913
3682
            cache[current_revision_id] = tree
3914
3683
            basis_id = current_revision_id
3915
 
        self.source._safe_to_return_from_cache = False
3916
3684
        # Copy file texts
3917
3685
        from_texts = self.source.texts
3918
3686
        to_texts = self.target.texts
3919
3687
        if root_keys_to_create:
3920
 
            root_stream = _mod_fetch._new_root_data_stream(
3921
 
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
3922
 
                self.source, graph=a_graph)
 
3688
            root_stream = self._new_root_data_stream(root_keys_to_create,
 
3689
                                                     parent_map)
3923
3690
            to_texts.insert_record_stream(root_stream)
3924
3691
        to_texts.insert_record_stream(from_texts.get_record_stream(
3925
3692
            text_keys, self.target._format._fetch_order,
3932
3699
            # for the new revisions that we are about to insert.  We do this
3933
3700
            # before adding the revisions so that no revision is added until
3934
3701
            # all the inventories it may depend on are added.
3935
 
            # Note that this is overzealous, as we may have fetched these in an
3936
 
            # earlier batch.
3937
3702
            parent_ids = set()
3938
3703
            revision_ids = set()
3939
3704
            for revision in pending_revisions:
3942
3707
            parent_ids.difference_update(revision_ids)
3943
3708
            parent_ids.discard(_mod_revision.NULL_REVISION)
3944
3709
            parent_map = self.source.get_parent_map(parent_ids)
3945
 
            # we iterate over parent_map and not parent_ids because we don't
3946
 
            # want to try copying any revision which is a ghost
3947
 
            for parent_tree in self.source.revision_trees(parent_map):
 
3710
            for parent_tree in self.source.revision_trees(parent_ids):
 
3711
                basis_id, delta = self._get_delta_for_revision(tree, parent_ids, basis_id, cache)
3948
3712
                current_revision_id = parent_tree.get_revision_id()
3949
3713
                parents_parents = parent_map[current_revision_id]
3950
 
                possible_trees = self._get_trees(parents_parents, cache)
3951
 
                if len(possible_trees) == 0:
3952
 
                    # There either aren't any parents, or the parents are
3953
 
                    # ghosts, so just use the last converted tree.
3954
 
                    possible_trees.append((basis_id, cache[basis_id]))
3955
 
                basis_id, delta = self._get_delta_for_revision(parent_tree,
3956
 
                    parents_parents, possible_trees)
3957
3714
                self.target.add_inventory_by_delta(
3958
3715
                    basis_id, delta, current_revision_id, parents_parents)
3959
3716
        # insert signatures and revisions
3973
3730
 
3974
3731
        :param revision_ids: The list of revisions to fetch. Must be in
3975
3732
            topological order.
3976
 
        :param pb: A ProgressTask
 
3733
        :param pb: A ProgressBar
3977
3734
        :return: None
3978
3735
        """
3979
3736
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3981
3738
        cache = lru_cache.LRUCache(100)
3982
3739
        cache[basis_id] = basis_tree
3983
3740
        del basis_tree # We don't want to hang on to it here
3984
 
        hints = []
3985
 
        if self._converting_to_rich_root and len(revision_ids) > 100:
3986
 
            a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
3987
 
                                                            revision_ids)
3988
 
        else:
3989
 
            a_graph = None
3990
 
 
3991
3741
        for offset in range(0, len(revision_ids), batch_size):
3992
3742
            self.target.start_write_group()
3993
3743
            try:
3994
3744
                pb.update('Transferring revisions', offset,
3995
3745
                          len(revision_ids))
3996
3746
                batch = revision_ids[offset:offset+batch_size]
3997
 
                basis_id = self._fetch_batch(batch, basis_id, cache,
3998
 
                                             a_graph=a_graph)
 
3747
                basis_id = self._fetch_batch(batch, basis_id, cache)
3999
3748
            except:
4000
 
                self.source._safe_to_return_from_cache = False
4001
3749
                self.target.abort_write_group()
4002
3750
                raise
4003
3751
            else:
4004
 
                hint = self.target.commit_write_group()
4005
 
                if hint:
4006
 
                    hints.extend(hint)
4007
 
        if hints and self.target._format.pack_compresses:
4008
 
            self.target.pack(hint=hints)
 
3752
                self.target.commit_write_group()
4009
3753
        pb.update('Transferring revisions', len(revision_ids),
4010
3754
                  len(revision_ids))
4011
3755
 
4015
3759
        """See InterRepository.fetch()."""
4016
3760
        if fetch_spec is not None:
4017
3761
            raise AssertionError("Not implemented yet...")
4018
 
        ui.ui_factory.warn_experimental_format_fetch(self)
4019
3762
        if (not self.source.supports_rich_root()
4020
3763
            and self.target.supports_rich_root()):
4021
3764
            self._converting_to_rich_root = True
4022
3765
            self._revision_id_to_root_id = {}
4023
3766
        else:
4024
3767
            self._converting_to_rich_root = False
4025
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
4026
 
        if self.source._format.network_name() != self.target._format.network_name():
4027
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
4028
 
                from_format=self.source._format,
4029
 
                to_format=self.target._format)
4030
3768
        revision_ids = self.target.search_missing_revision_ids(self.source,
4031
3769
            revision_id, find_ghosts=find_ghosts).get_keys()
4032
3770
        if not revision_ids:
4038
3776
        # Walk though all revisions; get inventory deltas, copy referenced
4039
3777
        # texts that delta references, insert the delta, revision and
4040
3778
        # signature.
 
3779
        first_rev = self.source.get_revision(revision_ids[0])
4041
3780
        if pb is None:
4042
3781
            my_pb = ui.ui_factory.nested_progress_bar()
4043
3782
            pb = my_pb
4080
3819
InterRepository.register_optimiser(InterSameDataRepository)
4081
3820
InterRepository.register_optimiser(InterWeaveRepo)
4082
3821
InterRepository.register_optimiser(InterKnitRepo)
 
3822
InterRepository.register_optimiser(InterPackRepo)
4083
3823
 
4084
3824
 
4085
3825
class CopyConverter(object):
4101
3841
        :param to_convert: The disk object to convert.
4102
3842
        :param pb: a progress bar to use for progress information.
4103
3843
        """
4104
 
        pb = ui.ui_factory.nested_progress_bar()
 
3844
        self.pb = pb
4105
3845
        self.count = 0
4106
3846
        self.total = 4
4107
3847
        # this is only useful with metadir layouts - separated repo content.
4108
3848
        # trigger an assertion if not such
4109
3849
        repo._format.get_format_string()
4110
3850
        self.repo_dir = repo.bzrdir
4111
 
        pb.update('Moving repository to repository.backup')
 
3851
        self.step('Moving repository to repository.backup')
4112
3852
        self.repo_dir.transport.move('repository', 'repository.backup')
4113
3853
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4114
3854
        repo._format.check_conversion_target(self.target_format)
4115
3855
        self.source_repo = repo._format.open(self.repo_dir,
4116
3856
            _found=True,
4117
3857
            _override_transport=backup_transport)
4118
 
        pb.update('Creating new repository')
 
3858
        self.step('Creating new repository')
4119
3859
        converted = self.target_format.initialize(self.repo_dir,
4120
3860
                                                  self.source_repo.is_shared())
4121
3861
        converted.lock_write()
4122
3862
        try:
4123
 
            pb.update('Copying content')
 
3863
            self.step('Copying content into repository.')
4124
3864
            self.source_repo.copy_content_into(converted)
4125
3865
        finally:
4126
3866
            converted.unlock()
4127
 
        pb.update('Deleting old repository content')
 
3867
        self.step('Deleting old repository content.')
4128
3868
        self.repo_dir.transport.delete_tree('repository.backup')
4129
 
        ui.ui_factory.note('repository converted')
4130
 
        pb.finished()
 
3869
        self.pb.note('repository converted')
 
3870
 
 
3871
    def step(self, message):
 
3872
        """Update the pb by a step."""
 
3873
        self.count +=1
 
3874
        self.pb.update(message, self.count, self.total)
4131
3875
 
4132
3876
 
4133
3877
_unescape_map = {
4162
3906
 
4163
3907
class _VersionedFileChecker(object):
4164
3908
 
4165
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
3909
    def __init__(self, repository, text_key_references=None):
4166
3910
        self.repository = repository
4167
3911
        self.text_index = self.repository._generate_text_key_index(
4168
 
            text_key_references=text_key_references, ancestors=ancestors)
 
3912
            text_key_references=text_key_references)
4169
3913
 
4170
3914
    def calculate_file_version_parents(self, text_key):
4171
3915
        """Calculate the correct parents for a file version according to
4189
3933
            revision_id) tuples for versions that are present in this versioned
4190
3934
            file, but not used by the corresponding inventory.
4191
3935
        """
4192
 
        local_progress = None
4193
 
        if progress_bar is None:
4194
 
            local_progress = ui.ui_factory.nested_progress_bar()
4195
 
            progress_bar = local_progress
4196
 
        try:
4197
 
            return self._check_file_version_parents(texts, progress_bar)
4198
 
        finally:
4199
 
            if local_progress:
4200
 
                local_progress.finished()
4201
 
 
4202
 
    def _check_file_version_parents(self, texts, progress_bar):
4203
 
        """See check_file_version_parents."""
4204
3936
        wrong_parents = {}
4205
3937
        self.file_ids = set([file_id for file_id, _ in
4206
3938
            self.text_index.iterkeys()])
4207
3939
        # text keys is now grouped by file_id
 
3940
        n_weaves = len(self.file_ids)
 
3941
        files_in_revisions = {}
 
3942
        revisions_of_files = {}
4208
3943
        n_versions = len(self.text_index)
4209
3944
        progress_bar.update('loading text store', 0, n_versions)
4210
3945
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4212
3947
        text_keys = self.repository.texts.keys()
4213
3948
        unused_keys = frozenset(text_keys) - set(self.text_index)
4214
3949
        for num, key in enumerate(self.text_index.iterkeys()):
4215
 
            progress_bar.update('checking text graph', num, n_versions)
 
3950
            if progress_bar is not None:
 
3951
                progress_bar.update('checking text graph', num, n_versions)
4216
3952
            correct_parents = self.calculate_file_version_parents(key)
4217
3953
            try:
4218
3954
                knit_parents = parent_map[key]
4267
4003
        try:
4268
4004
            if resume_tokens:
4269
4005
                self.target_repo.resume_write_group(resume_tokens)
4270
 
                is_resume = True
4271
4006
            else:
4272
4007
                self.target_repo.start_write_group()
4273
 
                is_resume = False
4274
4008
            try:
4275
4009
                # locked_insert_stream performs a commit|suspend.
4276
 
                return self._locked_insert_stream(stream, src_format, is_resume)
 
4010
                return self._locked_insert_stream(stream, src_format)
4277
4011
            except:
4278
4012
                self.target_repo.abort_write_group(suppress_errors=True)
4279
4013
                raise
4280
4014
        finally:
4281
4015
            self.target_repo.unlock()
4282
4016
 
4283
 
    def _locked_insert_stream(self, stream, src_format, is_resume):
 
4017
    def _locked_insert_stream(self, stream, src_format):
4284
4018
        to_serializer = self.target_repo._format._serializer
4285
4019
        src_serializer = src_format._serializer
4286
4020
        new_pack = None
4303
4037
            else:
4304
4038
                new_pack.set_write_cache_size(1024*1024)
4305
4039
        for substream_type, substream in stream:
4306
 
            if 'stream' in debug.debug_flags:
4307
 
                mutter('inserting substream: %s', substream_type)
4308
4040
            if substream_type == 'texts':
4309
4041
                self.target_repo.texts.insert_record_stream(substream)
4310
4042
            elif substream_type == 'inventories':
4314
4046
                else:
4315
4047
                    self._extract_and_insert_inventories(
4316
4048
                        substream, src_serializer)
4317
 
            elif substream_type == 'inventory-deltas':
4318
 
                self._extract_and_insert_inventory_deltas(
4319
 
                    substream, src_serializer)
4320
4049
            elif substream_type == 'chk_bytes':
4321
4050
                # XXX: This doesn't support conversions, as it assumes the
4322
4051
                #      conversion was done in the fetch code.
4341
4070
        if new_pack is not None:
4342
4071
            new_pack._write_data('', flush=True)
4343
4072
        # Find all the new revisions (including ones from resume_tokens)
4344
 
        missing_keys = self.target_repo.get_missing_parent_inventories(
4345
 
            check_for_missing_texts=is_resume)
 
4073
        missing_keys = self.target_repo.get_missing_parent_inventories()
4346
4074
        try:
4347
4075
            for prefix, versioned_file in (
4348
4076
                ('texts', self.target_repo.texts),
4349
4077
                ('inventories', self.target_repo.inventories),
4350
4078
                ('revisions', self.target_repo.revisions),
4351
4079
                ('signatures', self.target_repo.signatures),
4352
 
                ('chk_bytes', self.target_repo.chk_bytes),
4353
4080
                ):
4354
 
                if versioned_file is None:
4355
 
                    continue
4356
 
                # TODO: key is often going to be a StaticTuple object
4357
 
                #       I don't believe we can define a method by which
4358
 
                #       (prefix,) + StaticTuple will work, though we could
4359
 
                #       define a StaticTuple.sq_concat that would allow you to
4360
 
                #       pass in either a tuple or a StaticTuple as the second
4361
 
                #       object, so instead we could have:
4362
 
                #       StaticTuple(prefix) + key here...
4363
4081
                missing_keys.update((prefix,) + key for key in
4364
4082
                    versioned_file.get_missing_compression_parent_keys())
4365
4083
        except NotImplementedError:
4374
4092
                # missing keys can handle suspending a write group).
4375
4093
                write_group_tokens = self.target_repo.suspend_write_group()
4376
4094
                return write_group_tokens, missing_keys
4377
 
        hint = self.target_repo.commit_write_group()
4378
 
        if (to_serializer != src_serializer and
4379
 
            self.target_repo._format.pack_compresses):
4380
 
            self.target_repo.pack(hint=hint)
 
4095
        self.target_repo.commit_write_group()
4381
4096
        return [], set()
4382
4097
 
4383
 
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
4384
 
        target_rich_root = self.target_repo._format.rich_root_data
4385
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4386
 
        for record in substream:
4387
 
            # Insert the delta directly
4388
 
            inventory_delta_bytes = record.get_bytes_as('fulltext')
4389
 
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
4390
 
            try:
4391
 
                parse_result = deserialiser.parse_text_bytes(
4392
 
                    inventory_delta_bytes)
4393
 
            except inventory_delta.IncompatibleInventoryDelta, err:
4394
 
                trace.mutter("Incompatible delta: %s", err.msg)
4395
 
                raise errors.IncompatibleRevision(self.target_repo._format)
4396
 
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
4397
 
            revision_id = new_id
4398
 
            parents = [key[0] for key in record.parents]
4399
 
            self.target_repo.add_inventory_by_delta(
4400
 
                basis_id, inv_delta, revision_id, parents)
4401
 
 
4402
 
    def _extract_and_insert_inventories(self, substream, serializer,
4403
 
            parse_delta=None):
 
4098
    def _extract_and_insert_inventories(self, substream, serializer):
4404
4099
        """Generate a new inventory versionedfile in target, converting data.
4405
4100
 
4406
4101
        The inventory is retrieved from the source, (deserializing it), and
4407
4102
        stored in the target (reserializing it in a different format).
4408
4103
        """
4409
 
        target_rich_root = self.target_repo._format.rich_root_data
4410
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4411
4104
        for record in substream:
4412
 
            # It's not a delta, so it must be a fulltext in the source
4413
 
            # serializer's format.
4414
4105
            bytes = record.get_bytes_as('fulltext')
4415
4106
            revision_id = record.key[0]
4416
4107
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4417
4108
            parents = [key[0] for key in record.parents]
4418
4109
            self.target_repo.add_inventory(revision_id, inv, parents)
4419
 
            # No need to keep holding this full inv in memory when the rest of
4420
 
            # the substream is likely to be all deltas.
4421
 
            del inv
4422
4110
 
4423
4111
    def _extract_and_insert_revisions(self, substream, serializer):
4424
4112
        for record in substream:
4473
4161
        return [('signatures', signatures), ('revisions', revisions)]
4474
4162
 
4475
4163
    def _generate_root_texts(self, revs):
4476
 
        """This will be called by get_stream between fetching weave texts and
 
4164
        """This will be called by __fetch between fetching weave texts and
4477
4165
        fetching the inventory weave.
 
4166
 
 
4167
        Subclasses should override this if they need to generate root texts
 
4168
        after fetching weave texts.
4478
4169
        """
4479
4170
        if self._rich_root_upgrade():
4480
 
            return _mod_fetch.Inter1and2Helper(
 
4171
            import bzrlib.fetch
 
4172
            return bzrlib.fetch.Inter1and2Helper(
4481
4173
                self.from_repository).generate_root_texts(revs)
4482
4174
        else:
4483
4175
            return []
4486
4178
        phase = 'file'
4487
4179
        revs = search.get_keys()
4488
4180
        graph = self.from_repository.get_graph()
4489
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
 
4181
        revs = list(graph.iter_topo_order(revs))
4490
4182
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4491
4183
        text_keys = []
4492
4184
        for knit_kind, file_id, revisions in data_to_fetch:
4511
4203
                # will be valid.
4512
4204
                for _ in self._generate_root_texts(revs):
4513
4205
                    yield _
 
4206
                # NB: This currently reopens the inventory weave in source;
 
4207
                # using a single stream interface instead would avoid this.
 
4208
                from_weave = self.from_repository.inventories
4514
4209
                # we fetch only the referenced inventories because we do not
4515
4210
                # know for unselected inventories whether all their required
4516
4211
                # texts are present in the other repository - it could be
4535
4230
        keys['texts'] = set()
4536
4231
        keys['revisions'] = set()
4537
4232
        keys['inventories'] = set()
4538
 
        keys['chk_bytes'] = set()
4539
4233
        keys['signatures'] = set()
4540
4234
        for key in missing_keys:
4541
4235
            keys[key[0]].add(key[1:])
4548
4242
                    keys['revisions'],))
4549
4243
        for substream_kind, keys in keys.iteritems():
4550
4244
            vf = getattr(self.from_repository, substream_kind)
4551
 
            if vf is None and keys:
4552
 
                    raise AssertionError(
4553
 
                        "cannot fill in keys for a versioned file we don't"
4554
 
                        " have: %s needs %s" % (substream_kind, keys))
4555
 
            if not keys:
4556
 
                # No need to stream something we don't have
4557
 
                continue
4558
 
            if substream_kind == 'inventories':
4559
 
                # Some missing keys are genuinely ghosts, filter those out.
4560
 
                present = self.from_repository.inventories.get_parent_map(keys)
4561
 
                revs = [key[0] for key in present]
4562
 
                # Get the inventory stream more-or-less as we do for the
4563
 
                # original stream; there's no reason to assume that records
4564
 
                # direct from the source will be suitable for the sink.  (Think
4565
 
                # e.g. 2a -> 1.9-rich-root).
4566
 
                for info in self._get_inventory_stream(revs, missing=True):
4567
 
                    yield info
4568
 
                continue
4569
 
 
4570
4245
            # Ask for full texts always so that we don't need more round trips
4571
4246
            # after this stream.
4572
 
            # Some of the missing keys are genuinely ghosts, so filter absent
4573
 
            # records. The Sink is responsible for doing another check to
4574
 
            # ensure that ghosts don't introduce missing data for future
4575
 
            # fetches.
4576
 
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
4577
 
                self.to_format._fetch_order, True))
 
4247
            stream = vf.get_record_stream(keys,
 
4248
                self.to_format._fetch_order, True)
4578
4249
            yield substream_kind, stream
4579
4250
 
4580
4251
    def inventory_fetch_order(self):
4587
4258
        return (not self.from_repository._format.rich_root_data and
4588
4259
            self.to_format.rich_root_data)
4589
4260
 
4590
 
    def _get_inventory_stream(self, revision_ids, missing=False):
 
4261
    def _get_inventory_stream(self, revision_ids):
4591
4262
        from_format = self.from_repository._format
4592
 
        if (from_format.supports_chks and self.to_format.supports_chks and
4593
 
            from_format.network_name() == self.to_format.network_name()):
4594
 
            raise AssertionError(
4595
 
                "this case should be handled by GroupCHKStreamSource")
4596
 
        elif 'forceinvdeltas' in debug.debug_flags:
4597
 
            return self._get_convertable_inventory_stream(revision_ids,
4598
 
                    delta_versus_null=missing)
4599
 
        elif from_format.network_name() == self.to_format.network_name():
4600
 
            # Same format.
4601
 
            return self._get_simple_inventory_stream(revision_ids,
4602
 
                    missing=missing)
4603
 
        elif (not from_format.supports_chks and not self.to_format.supports_chks
4604
 
                and from_format._serializer == self.to_format._serializer):
4605
 
            # Essentially the same format.
4606
 
            return self._get_simple_inventory_stream(revision_ids,
4607
 
                    missing=missing)
 
4263
        if (from_format.supports_chks and self.to_format.supports_chks
 
4264
            and (from_format._serializer == self.to_format._serializer)):
 
4265
            # Both sides support chks, and they use the same serializer, so it
 
4266
            # is safe to transmit the chk pages and inventory pages across
 
4267
            # as-is.
 
4268
            return self._get_chk_inventory_stream(revision_ids)
 
4269
        elif (not from_format.supports_chks):
 
4270
            # Source repository doesn't support chks. So we can transmit the
 
4271
            # inventories 'as-is' and either they are just accepted on the
 
4272
            # target, or the Sink will properly convert it.
 
4273
            return self._get_simple_inventory_stream(revision_ids)
4608
4274
        else:
4609
 
            # Any time we switch serializations, we want to use an
4610
 
            # inventory-delta based approach.
4611
 
            return self._get_convertable_inventory_stream(revision_ids,
4612
 
                    delta_versus_null=missing)
 
4275
            # XXX: Hack to make not-chk->chk fetch: copy the inventories as
 
4276
            #      inventories. Note that this should probably be done somehow
 
4277
            #      as part of bzrlib.repository.StreamSink. Except JAM couldn't
 
4278
            #      figure out how a non-chk repository could possibly handle
 
4279
            #      deserializing an inventory stream from a chk repo, as it
 
4280
            #      doesn't have a way to understand individual pages.
 
4281
            return self._get_convertable_inventory_stream(revision_ids)
4613
4282
 
4614
 
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
4615
 
        # NB: This currently reopens the inventory weave in source;
4616
 
        # using a single stream interface instead would avoid this.
 
4283
    def _get_simple_inventory_stream(self, revision_ids):
4617
4284
        from_weave = self.from_repository.inventories
4618
 
        if missing:
4619
 
            delta_closure = True
4620
 
        else:
4621
 
            delta_closure = not self.delta_on_metadata()
4622
4285
        yield ('inventories', from_weave.get_record_stream(
4623
4286
            [(rev_id,) for rev_id in revision_ids],
4624
 
            self.inventory_fetch_order(), delta_closure))
4625
 
 
4626
 
    def _get_convertable_inventory_stream(self, revision_ids,
4627
 
                                          delta_versus_null=False):
4628
 
        # The two formats are sufficiently different that there is no fast
4629
 
        # path, so we need to send just inventorydeltas, which any
4630
 
        # sufficiently modern client can insert into any repository.
4631
 
        # The StreamSink code expects to be able to
4632
 
        # convert on the target, so we need to put bytes-on-the-wire that can
4633
 
        # be converted.  That means inventory deltas (if the remote is <1.19,
4634
 
        # RemoteStreamSink will fallback to VFS to insert the deltas).
4635
 
        yield ('inventory-deltas',
4636
 
           self._stream_invs_as_deltas(revision_ids,
4637
 
                                       delta_versus_null=delta_versus_null))
4638
 
 
4639
 
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
4640
 
        """Return a stream of inventory-deltas for the given rev ids.
4641
 
 
4642
 
        :param revision_ids: The list of inventories to transmit
4643
 
        :param delta_versus_null: Don't try to find a minimal delta for this
4644
 
            entry, instead compute the delta versus the NULL_REVISION. This
4645
 
            effectively streams a complete inventory. Used for stuff like
4646
 
            filling in missing parents, etc.
4647
 
        """
 
4287
            self.inventory_fetch_order(),
 
4288
            not self.delta_on_metadata()))
 
4289
 
 
4290
    def _get_chk_inventory_stream(self, revision_ids):
 
4291
        """Fetch the inventory texts, along with the associated chk maps."""
 
4292
        # We want an inventory outside of the search set, so that we can filter
 
4293
        # out uninteresting chk pages. For now we use
 
4294
        # _find_revision_outside_set, but if we had a Search with cut_revs, we
 
4295
        # could use that instead.
 
4296
        start_rev_id = self.from_repository._find_revision_outside_set(
 
4297
                            revision_ids)
 
4298
        start_rev_key = (start_rev_id,)
 
4299
        inv_keys_to_fetch = [(rev_id,) for rev_id in revision_ids]
 
4300
        if start_rev_id != _mod_revision.NULL_REVISION:
 
4301
            inv_keys_to_fetch.append((start_rev_id,))
 
4302
        # Any repo that supports chk_bytes must also support out-of-order
 
4303
        # insertion. At least, that is how we expect it to work
 
4304
        # We use get_record_stream instead of iter_inventories because we want
 
4305
        # to be able to insert the stream as well. We could instead fetch
 
4306
        # allowing deltas, and then iter_inventories, but we don't know whether
 
4307
        # source or target is more 'local' anway.
 
4308
        inv_stream = self.from_repository.inventories.get_record_stream(
 
4309
            inv_keys_to_fetch, 'unordered',
 
4310
            True) # We need them as full-texts so we can find their references
 
4311
        uninteresting_chk_roots = set()
 
4312
        interesting_chk_roots = set()
 
4313
        def filter_inv_stream(inv_stream):
 
4314
            for idx, record in enumerate(inv_stream):
 
4315
                ### child_pb.update('fetch inv', idx, len(inv_keys_to_fetch))
 
4316
                bytes = record.get_bytes_as('fulltext')
 
4317
                chk_inv = inventory.CHKInventory.deserialise(
 
4318
                    self.from_repository.chk_bytes, bytes, record.key)
 
4319
                if record.key == start_rev_key:
 
4320
                    uninteresting_chk_roots.add(chk_inv.id_to_entry.key())
 
4321
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4322
                    if p_id_map is not None:
 
4323
                        uninteresting_chk_roots.add(p_id_map.key())
 
4324
                else:
 
4325
                    yield record
 
4326
                    interesting_chk_roots.add(chk_inv.id_to_entry.key())
 
4327
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4328
                    if p_id_map is not None:
 
4329
                        interesting_chk_roots.add(p_id_map.key())
 
4330
        ### pb.update('fetch inventory', 0, 2)
 
4331
        yield ('inventories', filter_inv_stream(inv_stream))
 
4332
        # Now that we have worked out all of the interesting root nodes, grab
 
4333
        # all of the interesting pages and insert them
 
4334
        ### pb.update('fetch inventory', 1, 2)
 
4335
        interesting = chk_map.iter_interesting_nodes(
 
4336
            self.from_repository.chk_bytes, interesting_chk_roots,
 
4337
            uninteresting_chk_roots)
 
4338
        def to_stream_adapter():
 
4339
            """Adapt the iter_interesting_nodes result to a single stream.
 
4340
 
 
4341
            iter_interesting_nodes returns records as it processes them, along
 
4342
            with keys. However, we only want to return the records themselves.
 
4343
            """
 
4344
            for record, items in interesting:
 
4345
                if record is not None:
 
4346
                    yield record
 
4347
        # XXX: We could instead call get_record_stream(records.keys())
 
4348
        #      ATM, this will always insert the records as fulltexts, and
 
4349
        #      requires that you can hang on to records once you have gone
 
4350
        #      on to the next one. Further, it causes the target to
 
4351
        #      recompress the data. Testing shows it to be faster than
 
4352
        #      requesting the records again, though.
 
4353
        yield ('chk_bytes', to_stream_adapter())
 
4354
        ### pb.update('fetch inventory', 2, 2)
 
4355
 
 
4356
    def _get_convertable_inventory_stream(self, revision_ids):
 
4357
        # XXX: One of source or target is using chks, and they don't have
 
4358
        #      compatible serializations. The StreamSink code expects to be
 
4359
        #      able to convert on the target, so we need to put
 
4360
        #      bytes-on-the-wire that can be converted
 
4361
        yield ('inventories', self._stream_invs_as_fulltexts(revision_ids))
 
4362
 
 
4363
    def _stream_invs_as_fulltexts(self, revision_ids):
4648
4364
        from_repo = self.from_repository
 
4365
        from_serializer = from_repo._format._serializer
4649
4366
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4650
4367
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
4651
 
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
4652
 
        # method...
4653
 
        inventories = self.from_repository.iter_inventories(
4654
 
            revision_ids, 'topological')
4655
 
        format = from_repo._format
4656
 
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
4657
 
        inventory_cache = lru_cache.LRUCache(50)
4658
 
        null_inventory = from_repo.revision_tree(
4659
 
            _mod_revision.NULL_REVISION).inventory
4660
 
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
4661
 
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
4662
 
        # repo back into a non-rich-root repo ought to be allowed)
4663
 
        serializer = inventory_delta.InventoryDeltaSerializer(
4664
 
            versioned_root=format.rich_root_data,
4665
 
            tree_references=format.supports_tree_reference)
4666
 
        for inv in inventories:
 
4368
        for inv in self.from_repository.iter_inventories(revision_ids):
 
4369
            # XXX: This is a bit hackish, but it works. Basically,
 
4370
            #      CHKSerializer 'accidentally' supports
 
4371
            #      read/write_inventory_to_string, even though that is never
 
4372
            #      the format that is stored on disk. It *does* give us a
 
4373
            #      single string representation for an inventory, so live with
 
4374
            #      it for now.
 
4375
            #      This would be far better if we had a 'serialized inventory
 
4376
            #      delta' form. Then we could use 'inventory._make_delta', and
 
4377
            #      transmit that. This would both be faster to generate, and
 
4378
            #      result in fewer bytes-on-the-wire.
 
4379
            as_bytes = from_serializer.write_inventory_to_string(inv)
4667
4380
            key = (inv.revision_id,)
4668
4381
            parent_keys = parent_map.get(key, ())
4669
 
            delta = None
4670
 
            if not delta_versus_null and parent_keys:
4671
 
                # The caller did not ask for complete inventories and we have
4672
 
                # some parents that we can delta against.  Make a delta against
4673
 
                # each parent so that we can find the smallest.
4674
 
                parent_ids = [parent_key[0] for parent_key in parent_keys]
4675
 
                for parent_id in parent_ids:
4676
 
                    if parent_id not in invs_sent_so_far:
4677
 
                        # We don't know that the remote side has this basis, so
4678
 
                        # we can't use it.
4679
 
                        continue
4680
 
                    if parent_id == _mod_revision.NULL_REVISION:
4681
 
                        parent_inv = null_inventory
4682
 
                    else:
4683
 
                        parent_inv = inventory_cache.get(parent_id, None)
4684
 
                        if parent_inv is None:
4685
 
                            parent_inv = from_repo.get_inventory(parent_id)
4686
 
                    candidate_delta = inv._make_delta(parent_inv)
4687
 
                    if (delta is None or
4688
 
                        len(delta) > len(candidate_delta)):
4689
 
                        delta = candidate_delta
4690
 
                        basis_id = parent_id
4691
 
            if delta is None:
4692
 
                # Either none of the parents ended up being suitable, or we
4693
 
                # were asked to delta against NULL
4694
 
                basis_id = _mod_revision.NULL_REVISION
4695
 
                delta = inv._make_delta(null_inventory)
4696
 
            invs_sent_so_far.add(inv.revision_id)
4697
 
            inventory_cache[inv.revision_id] = inv
4698
 
            delta_serialized = ''.join(
4699
 
                serializer.delta_to_lines(basis_id, key[-1], delta))
4700
4382
            yield versionedfile.FulltextContentFactory(
4701
 
                key, parent_keys, None, delta_serialized)
4702
 
 
4703
 
 
4704
 
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
4705
 
                    stop_revision=None):
4706
 
    """Extend the partial history to include a given index
4707
 
 
4708
 
    If a stop_index is supplied, stop when that index has been reached.
4709
 
    If a stop_revision is supplied, stop when that revision is
4710
 
    encountered.  Otherwise, stop when the beginning of history is
4711
 
    reached.
4712
 
 
4713
 
    :param stop_index: The index which should be present.  When it is
4714
 
        present, history extension will stop.
4715
 
    :param stop_revision: The revision id which should be present.  When
4716
 
        it is encountered, history extension will stop.
4717
 
    """
4718
 
    start_revision = partial_history_cache[-1]
4719
 
    iterator = repo.iter_reverse_revision_history(start_revision)
4720
 
    try:
4721
 
        #skip the last revision in the list
4722
 
        iterator.next()
4723
 
        while True:
4724
 
            if (stop_index is not None and
4725
 
                len(partial_history_cache) > stop_index):
4726
 
                break
4727
 
            if partial_history_cache[-1] == stop_revision:
4728
 
                break
4729
 
            revision_id = iterator.next()
4730
 
            partial_history_cache.append(revision_id)
4731
 
    except StopIteration:
4732
 
        # No more history
4733
 
        return
 
4383
                key, parent_keys, None, as_bytes)
4734
4384