~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Martin Pool
  • Date: 2009-06-23 06:58:46 UTC
  • mto: This revision was merged to the branch mainline in revision 4586.
  • Revision ID: mbp@sourcefrog.net-20090623065846-wvsuj9gip4e723i1
Update docstrings for recent progress changes

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()))
1045
1019
 
1046
1020
        :seealso: add_inventory, for the contract.
1047
1021
        """
1048
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
 
1022
        inv_lines = self._serialise_inventory_to_lines(inv)
1049
1023
        return self._inventory_add_lines(revision_id, parents,
1050
1024
            inv_lines, check_content=False)
1051
1025
 
1053
1027
                               parents, basis_inv=None, propagate_caches=False):
1054
1028
        """Add a new inventory expressed as a delta against another revision.
1055
1029
 
1056
 
        See the inventory developers documentation for the theory behind
1057
 
        inventory deltas.
1058
 
 
1059
1030
        :param basis_revision_id: The inventory id the delta was created
1060
1031
            against. (This does not have to be a direct parent.)
1061
1032
        :param delta: The inventory delta (see Inventory.apply_delta for
1100
1071
        check_content=True):
1101
1072
        """Store lines in inv_vf and return the sha1 of the inventory."""
1102
1073
        parents = [(parent,) for parent in parents]
1103
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
1074
        return self.inventories.add_lines((revision_id,), parents, lines,
1104
1075
            check_content=check_content)[0]
1105
 
        self.inventories._access.flush()
1106
 
        return result
1107
1076
 
1108
1077
    def add_revision(self, revision_id, rev, inv=None, config=None):
1109
1078
        """Add rev to the revision store as revision_id.
1185
1154
        # The old API returned a list, should this actually be a set?
1186
1155
        return parent_map.keys()
1187
1156
 
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
1157
    @staticmethod
1302
1158
    def create(a_bzrdir):
1303
1159
        """Construct the current default format repository in a_bzrdir."""
1308
1164
 
1309
1165
        :param _format: The format of the repository on disk.
1310
1166
        :param a_bzrdir: The BzrDir of the repository.
 
1167
 
 
1168
        In the future we will have a single api for all stores for
 
1169
        getting file texts, inventories and revisions, then
 
1170
        this construct will accept instances of those things.
1311
1171
        """
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
1172
        super(Repository, self).__init__()
1316
1173
        self._format = _format
1317
1174
        # the following are part of the public API for Repository:
1323
1180
        self._reconcile_does_inventory_gc = True
1324
1181
        self._reconcile_fixes_text_parents = False
1325
1182
        self._reconcile_backsup_inventory = True
 
1183
        # not right yet - should be more semantically clear ?
 
1184
        #
 
1185
        # TODO: make sure to construct the right store classes, etc, depending
 
1186
        # on whether escaping is required.
 
1187
        self._warn_if_deprecated()
1326
1188
        self._write_group = None
1327
1189
        # Additional places to query for data.
1328
1190
        self._fallback_repositories = []
1329
1191
        # An InventoryEntry cache, used during deserialization
1330
1192
        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
1193
 
1343
1194
    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
 
1195
        return '%s(%r)' % (self.__class__.__name__,
 
1196
                           self.base)
1363
1197
 
1364
1198
    def has_same_location(self, other):
1365
1199
        """Returns a boolean indicating if this repository is at the same
1393
1227
        data during reads, and allows a 'write_group' to be obtained. Write
1394
1228
        groups must be used for actual data insertion.
1395
1229
 
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
1230
        :param token: if this is already locked, then lock_write will fail
1403
1231
            unless the token matches the existing lock.
1404
1232
        :returns: a token if this instance supports tokens, otherwise None.
1407
1235
        :raises MismatchedToken: if the specified token doesn't match the token
1408
1236
            of the existing lock.
1409
1237
        :seealso: start_write_group.
1410
 
        :return: A RepositoryWriteLockResult.
 
1238
 
 
1239
        A token should be passed in if you know that you have locked the object
 
1240
        some other way, and need to synchronise this object's state with that
 
1241
        fact.
 
1242
 
 
1243
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1411
1244
        """
1412
1245
        locked = self.is_locked()
1413
 
        token = self.control_files.lock_write(token=token)
 
1246
        result = self.control_files.lock_write(token=token)
1414
1247
        if not locked:
1415
 
            self._warn_if_deprecated()
1416
 
            self._note_lock('w')
1417
1248
            for repo in self._fallback_repositories:
1418
1249
                # Writes don't affect fallback repos
1419
1250
                repo.lock_read()
1420
1251
            self._refresh_data()
1421
 
        return RepositoryWriteLockResult(self.unlock, token)
 
1252
        return result
1422
1253
 
1423
1254
    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
1255
        locked = self.is_locked()
1430
1256
        self.control_files.lock_read()
1431
1257
        if not locked:
1432
 
            self._warn_if_deprecated()
1433
 
            self._note_lock('r')
1434
1258
            for repo in self._fallback_repositories:
1435
1259
                repo.lock_read()
1436
1260
            self._refresh_data()
1437
 
        return self
1438
1261
 
1439
1262
    def get_physical_lock_status(self):
1440
1263
        return self.control_files.get_physical_lock_status()
1500
1323
 
1501
1324
        # now gather global repository information
1502
1325
        # XXX: This is available for many repos regardless of listability.
1503
 
        if self.user_transport.listable():
 
1326
        if self.bzrdir.root_transport.listable():
1504
1327
            # XXX: do we want to __define len__() ?
1505
1328
            # Maybe the versionedfiles object should provide a different
1506
1329
            # method to get the number of keys.
1516
1339
        :param using: If True, list only branches using this repository.
1517
1340
        """
1518
1341
        if using and not self.is_shared():
1519
 
            return self.bzrdir.list_branches()
 
1342
            try:
 
1343
                return [self.bzrdir.open_branch()]
 
1344
            except errors.NotBranchError:
 
1345
                return []
1520
1346
        class Evaluator(object):
1521
1347
 
1522
1348
            def __init__(self):
1531
1357
                    except errors.NoRepositoryPresent:
1532
1358
                        pass
1533
1359
                    else:
1534
 
                        return False, ([], repository)
 
1360
                        return False, (None, repository)
1535
1361
                self.first_call = False
1536
 
                value = (bzrdir.list_branches(), None)
 
1362
                try:
 
1363
                    value = (bzrdir.open_branch(), None)
 
1364
                except errors.NotBranchError:
 
1365
                    value = (None, None)
1537
1366
                return True, value
1538
1367
 
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)
 
1368
        branches = []
 
1369
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1370
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
1371
            if branch is not None:
 
1372
                branches.append(branch)
1544
1373
            if not using and repository is not None:
1545
 
                ret.extend(repository.find_branches())
1546
 
        return ret
 
1374
                branches.extend(repository.find_branches())
 
1375
        return branches
1547
1376
 
1548
1377
    @needs_read_lock
1549
1378
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1578
1407
        """Commit the contents accrued within the current write group.
1579
1408
 
1580
1409
        :seealso: start_write_group.
1581
 
        
1582
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1583
1410
        """
1584
1411
        if self._write_group is not self.get_transaction():
1585
1412
            # has an unlock or relock occured ?
1586
1413
            raise errors.BzrError('mismatched lock context %r and '
1587
1414
                'write group %r.' %
1588
1415
                (self.get_transaction(), self._write_group))
1589
 
        result = self._commit_write_group()
 
1416
        self._commit_write_group()
1590
1417
        self._write_group = None
1591
 
        return result
1592
1418
 
1593
1419
    def _commit_write_group(self):
1594
1420
        """Template method for per-repository write group cleanup.
1639
1465
        # but at the moment we're only checking for texts referenced by
1640
1466
        # inventories at the graph's edge.
1641
1467
        key_deps = self.revisions._index._key_dependencies
1642
 
        key_deps.satisfy_refs_for_keys(present_inventories)
 
1468
        key_deps.add_keys(present_inventories)
1643
1469
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1644
1470
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1645
1471
        missing_texts = set()
1711
1537
            raise errors.InternalBzrError(
1712
1538
                "May not fetch while in a write group.")
1713
1539
        # 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)):
 
1540
        if self.has_same_location(source) and fetch_spec is None:
1719
1541
            # check that last_revision is in 'from' and then return a
1720
1542
            # no-operation.
1721
1543
            if (revision_id is not None and
1746
1568
        :param revprops: Optional dictionary of revision properties.
1747
1569
        :param revision_id: Optional revision id.
1748
1570
        """
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
1571
        result = self._commit_builder_class(self, parents, config,
1754
1572
            timestamp, timezone, committer, revprops, revision_id)
1755
1573
        self.start_write_group()
1756
1574
        return result
1757
1575
 
1758
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1759
1576
    def unlock(self):
1760
1577
        if (self.control_files._lock_count == 1 and
1761
1578
            self.control_files._lock_mode == 'w'):
1883
1700
 
1884
1701
    @needs_read_lock
1885
1702
    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
 
        """
 
1703
        """Get many revisions at once."""
1891
1704
        return self._get_revisions(revision_ids)
1892
1705
 
1893
1706
    @needs_read_lock
1894
1707
    def _get_revisions(self, revision_ids):
1895
1708
        """Core work logic to get many revisions without sanity checks."""
 
1709
        for rev_id in revision_ids:
 
1710
            if not rev_id or not isinstance(rev_id, basestring):
 
1711
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1712
        keys = [(key,) for key in revision_ids]
 
1713
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1896
1714
        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
 
1715
        for record in stream:
 
1716
            if record.storage_kind == 'absent':
 
1717
                raise errors.NoSuchRevision(self, record.key[0])
 
1718
            text = record.get_bytes_as('fulltext')
 
1719
            rev = self._serializer.read_revision_from_string(text)
 
1720
            revs[record.key[0]] = rev
1901
1721
        return [revs[revid] for revid in revision_ids]
1902
1722
 
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)
 
1723
    @needs_read_lock
 
1724
    def get_revision_xml(self, revision_id):
 
1725
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1726
        #       would have already do it.
 
1727
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1728
        # TODO: this can't just be replaced by:
 
1729
        # return self._serializer.write_revision_to_string(
 
1730
        #     self.get_revision(revision_id))
 
1731
        # as cStringIO preservers the encoding unlike write_revision_to_string
 
1732
        # or some other call down the path.
 
1733
        rev = self.get_revision(revision_id)
 
1734
        rev_tmp = cStringIO.StringIO()
 
1735
        # the current serializer..
 
1736
        self._serializer.write_revision(rev, rev_tmp)
 
1737
        rev_tmp.seek(0)
 
1738
        return rev_tmp.getvalue()
1929
1739
 
1930
1740
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1931
1741
        """Produce a generator of revision deltas.
2174
1984
        """
2175
1985
        selected_keys = set((revid,) for revid in revision_ids)
2176
1986
        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)
 
1987
        pb = ui.ui_factory.nested_progress_bar()
 
1988
        try:
 
1989
            return self._find_file_ids_from_xml_inventory_lines(
 
1990
                w.iter_lines_added_or_present_in_keys(
 
1991
                    selected_keys, pb=pb),
 
1992
                selected_keys)
 
1993
        finally:
 
1994
            pb.finished()
2181
1995
 
2182
1996
    def iter_files_bytes(self, desired_files):
2183
1997
        """Iterate through file versions.
2265
2079
                batch_size]
2266
2080
            if not to_query:
2267
2081
                break
2268
 
            for revision_id in to_query:
 
2082
            for rev_tree in self.revision_trees(to_query):
 
2083
                revision_id = rev_tree.get_revision_id()
2269
2084
                parent_ids = ancestors[revision_id]
2270
2085
                for text_key in revision_keys[revision_id]:
2271
2086
                    pb.update("Calculating text parents", processed_texts)
2344
2159
        num_file_ids = len(file_ids)
2345
2160
        for file_id, altered_versions in file_ids.iteritems():
2346
2161
            if pb is not None:
2347
 
                pb.update("Fetch texts", count, num_file_ids)
 
2162
                pb.update("fetch texts", count, num_file_ids)
2348
2163
            count += 1
2349
2164
            yield ("file", file_id, altered_versions)
2350
2165
 
2371
2186
        """Get Inventory object by revision id."""
2372
2187
        return self.iter_inventories([revision_id]).next()
2373
2188
 
2374
 
    def iter_inventories(self, revision_ids, ordering=None):
 
2189
    def iter_inventories(self, revision_ids):
2375
2190
        """Get many inventories by revision_ids.
2376
2191
 
2377
2192
        This will buffer some or all of the texts used in constructing the
2379
2194
        time.
2380
2195
 
2381
2196
        :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
2197
        :return: An iterator of inventories.
2386
2198
        """
2387
2199
        if ((None in revision_ids)
2388
2200
            or (_mod_revision.NULL_REVISION in revision_ids)):
2389
2201
            raise ValueError('cannot get null revision inventory')
2390
 
        return self._iter_inventories(revision_ids, ordering)
 
2202
        return self._iter_inventories(revision_ids)
2391
2203
 
2392
 
    def _iter_inventories(self, revision_ids, ordering):
 
2204
    def _iter_inventories(self, revision_ids):
2393
2205
        """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)
 
2206
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
 
2207
            yield self.deserialise_inventory(revision_id, text)
2397
2208
 
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
 
2209
    def _iter_inventory_xmls(self, revision_ids):
2404
2210
        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)
 
2211
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2411
2212
        text_chunks = {}
2412
2213
        for record in stream:
2413
2214
            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]
 
2215
                text_chunks[record.key] = record.get_bytes_as('chunked')
2419
2216
            else:
2420
2217
                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
 
2218
        for key in keys:
 
2219
            chunks = text_chunks.pop(key)
 
2220
            yield ''.join(chunks), key[-1]
2433
2221
 
2434
 
    def _deserialise_inventory(self, revision_id, xml):
 
2222
    def deserialise_inventory(self, revision_id, xml):
2435
2223
        """Transform the xml into an inventory object.
2436
2224
 
2437
2225
        :param revision_id: The expected revision id of the inventory.
2438
2226
        :param xml: A serialised inventory.
2439
2227
        """
2440
2228
        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)
 
2229
                    entry_cache=self._inventory_entry_cache)
2443
2230
        if result.revision_id != revision_id:
2444
2231
            raise AssertionError('revision id mismatch %s != %s' % (
2445
2232
                result.revision_id, revision_id))
2446
2233
        return result
2447
2234
 
 
2235
    def serialise_inventory(self, inv):
 
2236
        return self._serializer.write_inventory_to_string(inv)
 
2237
 
 
2238
    def _serialise_inventory_to_lines(self, inv):
 
2239
        return self._serializer.write_inventory_to_lines(inv)
 
2240
 
2448
2241
    def get_serializer_format(self):
2449
2242
        return self._serializer.format_num
2450
2243
 
2451
2244
    @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')
 
2245
    def get_inventory_xml(self, revision_id):
 
2246
        """Get inventory XML as a file object."""
 
2247
        texts = self._iter_inventory_xmls([revision_id])
2455
2248
        try:
2456
2249
            text, revision_id = texts.next()
2457
2250
        except StopIteration:
2458
2251
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2459
2252
        return text
2460
2253
 
 
2254
    @needs_read_lock
 
2255
    def get_inventory_sha1(self, revision_id):
 
2256
        """Return the sha1 hash of the inventory entry
 
2257
        """
 
2258
        return self.get_revision(revision_id).inventory_sha1
 
2259
 
2461
2260
    def get_rev_id_for_revno(self, revno, known_pair):
2462
2261
        """Return the revision id of a revno, given a later (revno, revid)
2463
2262
        pair in the same history.
2514
2313
            else:
2515
2314
                next_id = parents[0]
2516
2315
 
 
2316
    @needs_read_lock
 
2317
    def get_revision_inventory(self, revision_id):
 
2318
        """Return inventory of a past revision."""
 
2319
        # TODO: Unify this with get_inventory()
 
2320
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
2321
        # must be the same as its revision, so this is trivial.
 
2322
        if revision_id is None:
 
2323
            # This does not make sense: if there is no revision,
 
2324
            # then it is the current tree inventory surely ?!
 
2325
            # and thus get_root_id() is something that looks at the last
 
2326
            # commit on the branch, and the get_root_id is an inventory check.
 
2327
            raise NotImplementedError
 
2328
            # return Inventory(self.get_root_id())
 
2329
        else:
 
2330
            return self.get_inventory(revision_id)
 
2331
 
2517
2332
    def is_shared(self):
2518
2333
        """Return True if this repository is flagged as a shared repository."""
2519
2334
        raise NotImplementedError(self.is_shared)
2553
2368
            return RevisionTree(self, Inventory(root_id=None),
2554
2369
                                _mod_revision.NULL_REVISION)
2555
2370
        else:
2556
 
            inv = self.get_inventory(revision_id)
 
2371
            inv = self.get_revision_inventory(revision_id)
2557
2372
            return RevisionTree(self, inv, revision_id)
2558
2373
 
2559
2374
    def revision_trees(self, revision_ids):
2612
2427
            keys = tsort.topo_sort(parent_map)
2613
2428
        return [None] + list(keys)
2614
2429
 
2615
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
2430
    def pack(self):
2616
2431
        """Compress the data within the repository.
2617
2432
 
2618
2433
        This operation only makes sense for some repository types. For other
2621
2436
        This stub method does not require a lock, but subclasses should use
2622
2437
        @needs_write_lock as this is a long running call its reasonable to
2623
2438
        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
2439
        """
2635
2440
 
2636
2441
    def get_transaction(self):
2652
2457
        for ((revision_id,), parent_keys) in \
2653
2458
                self.revisions.get_parent_map(query_keys).iteritems():
2654
2459
            if parent_keys:
2655
 
                result[revision_id] = tuple([parent_revid
2656
 
                    for (parent_revid,) in parent_keys])
 
2460
                result[revision_id] = tuple(parent_revid
 
2461
                    for (parent_revid,) in parent_keys)
2657
2462
            else:
2658
2463
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2659
2464
        return result
2661
2466
    def _make_parents_provider(self):
2662
2467
        return self
2663
2468
 
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
2469
    def get_graph(self, other_repository=None):
2674
2470
        """Return the graph walker for this repository format"""
2675
2471
        parents_provider = self._make_parents_provider()
2679
2475
                [parents_provider, other_repository._make_parents_provider()])
2680
2476
        return graph.Graph(parents_provider)
2681
2477
 
2682
 
    def _get_versioned_file_checker(self, text_key_references=None,
2683
 
        ancestors=None):
 
2478
    def _get_versioned_file_checker(self, text_key_references=None):
2684
2479
        """Return an object suitable for checking versioned files.
2685
2480
        
2686
2481
        :param text_key_references: if non-None, an already built
2688
2483
            to whether they were referred to by the inventory of the
2689
2484
            revision_id that they contain. If None, this will be
2690
2485
            calculated.
2691
 
        :param ancestors: Optional result from
2692
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2693
 
            available.
2694
2486
        """
2695
2487
        return _VersionedFileChecker(self,
2696
 
            text_key_references=text_key_references, ancestors=ancestors)
 
2488
            text_key_references=text_key_references)
2697
2489
 
2698
2490
    def revision_ids_to_search_result(self, result_set):
2699
2491
        """Convert a set of revision ids to a graph SearchResult."""
2749
2541
        return record.get_bytes_as('fulltext')
2750
2542
 
2751
2543
    @needs_read_lock
2752
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
2544
    def check(self, revision_ids=None):
2753
2545
        """Check consistency of all history of given revision_ids.
2754
2546
 
2755
2547
        Different repository implementations should override _check().
2756
2548
 
2757
2549
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2758
2550
             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
2551
        """
2765
 
        return self._check(revision_ids, callback_refs=callback_refs,
2766
 
            check_repo=check_repo)
 
2552
        return self._check(revision_ids)
2767
2553
 
2768
 
    def _check(self, revision_ids, callback_refs, check_repo):
2769
 
        result = check.Check(self, check_repo=check_repo)
2770
 
        result.check(callback_refs)
 
2554
    def _check(self, revision_ids):
 
2555
        result = check.Check(self)
 
2556
        result.check()
2771
2557
        return result
2772
2558
 
2773
 
    def _warn_if_deprecated(self, branch=None):
 
2559
    def _warn_if_deprecated(self):
2774
2560
        global _deprecation_warning_done
2775
2561
        if _deprecation_warning_done:
2776
2562
            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
 
2563
        _deprecation_warning_done = True
 
2564
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
2565
                % (self._format, self.bzrdir.transport.base))
2789
2566
 
2790
2567
    def supports_rich_root(self):
2791
2568
        return self._format.rich_root_data
3067
2844
    # Does this format have < O(tree_size) delta generation. Used to hint what
3068
2845
    # code path for commit, amongst other things.
3069
2846
    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
2847
 
3080
 
    def __repr__(self):
3081
 
        return "%s()" % self.__class__.__name__
 
2848
    def __str__(self):
 
2849
        return "<%s>" % self.__class__.__name__
3082
2850
 
3083
2851
    def __eq__(self, other):
3084
2852
        # format objects are generally stateless
3097
2865
        """
3098
2866
        try:
3099
2867
            transport = a_bzrdir.get_repository_transport(None)
3100
 
            format_string = transport.get_bytes("format")
 
2868
            format_string = transport.get("format").read()
3101
2869
            return format_registry.get(format_string)
3102
2870
        except errors.NoSuchFile:
3103
2871
            raise errors.NoRepositoryPresent(a_bzrdir)
3185
2953
        raise NotImplementedError(self.network_name)
3186
2954
 
3187
2955
    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)
 
2956
        raise NotImplementedError(self.check_conversion_target)
3197
2957
 
3198
2958
    def open(self, a_bzrdir, _found=False):
3199
2959
        """Return an instance of this format for the bzrdir a_bzrdir.
3202
2962
        """
3203
2963
        raise NotImplementedError(self.open)
3204
2964
 
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
2965
 
3215
2966
class MetaDirRepositoryFormat(RepositoryFormat):
3216
2967
    """Common base class for the new repositories using the metadir layout."""
3421
3172
 
3422
3173
        :param revision_id: if None all content is copied, if NULL_REVISION no
3423
3174
                            content is copied.
3424
 
        :param pb: ignored.
 
3175
        :param pb: optional progress bar to use for progress reports. If not
 
3176
                   provided a default one will be created.
3425
3177
        :return: None.
3426
3178
        """
3427
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3428
3179
        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
3180
        f = RepoFetcher(to_repository=self.target,
3435
3181
                               from_repository=self.source,
3436
3182
                               last_revision=revision_id,
3437
3183
                               fetch_spec=fetch_spec,
3438
 
                               find_ghosts=find_ghosts)
 
3184
                               pb=pb, find_ghosts=find_ghosts)
3439
3185
 
3440
3186
    def _walk_to_common_revisions(self, revision_ids):
3441
3187
        """Walk out from revision_ids in source to revisions target has.
3610
3356
                self.target.texts.insert_record_stream(
3611
3357
                    self.source.texts.get_record_stream(
3612
3358
                        self.source.texts.keys(), 'topological', False))
3613
 
                pb.update('Copying inventory', 0, 1)
 
3359
                pb.update('copying inventory', 0, 1)
3614
3360
                self.target.inventories.insert_record_stream(
3615
3361
                    self.source.inventories.get_record_stream(
3616
3362
                        self.source.inventories.keys(), 'topological', False))
3742
3488
        # This is redundant with format.check_conversion_target(), however that
3743
3489
        # raises an exception, and we just want to say "False" as in we won't
3744
3490
        # support converting between these formats.
3745
 
        if 'IDS_never' in debug.debug_flags:
3746
 
            return False
3747
3491
        if source.supports_rich_root() and not target.supports_rich_root():
3748
3492
            return False
3749
3493
        if (source._format.supports_tree_reference
3750
3494
            and not target._format.supports_tree_reference):
3751
3495
            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
3496
        return True
3765
3497
 
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):
 
3498
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
3784
3499
        """Get the best delta and base for this revision.
3785
3500
 
3786
3501
        :return: (basis_id, delta)
3787
3502
        """
 
3503
        possible_trees = [(parent_id, cache[parent_id])
 
3504
                          for parent_id in parent_ids
 
3505
                           if parent_id in cache]
 
3506
        if len(possible_trees) == 0:
 
3507
            # There either aren't any parents, or the parents aren't in the
 
3508
            # cache, so just use the last converted tree
 
3509
            possible_trees.append((basis_id, cache[basis_id]))
3788
3510
        deltas = []
3789
 
        # Generate deltas against each tree, to find the shortest.
3790
 
        texts_possibly_new_in_tree = set()
3791
3511
        for basis_id, basis_tree in possible_trees:
3792
3512
            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
3513
            deltas.append((len(delta), basis_id, delta))
3808
3514
        deltas.sort()
3809
3515
        return deltas[0][1:]
3810
3516
 
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):
 
3517
    def _get_parent_keys(self, root_key, parent_map):
 
3518
        """Get the parent keys for a given root id."""
 
3519
        root_id, rev_id = root_key
 
3520
        # Include direct parents of the revision, but only if they used
 
3521
        # the same root_id and are heads.
 
3522
        parent_keys = []
 
3523
        for parent_id in parent_map[rev_id]:
 
3524
            if parent_id == _mod_revision.NULL_REVISION:
 
3525
                continue
 
3526
            if parent_id not in self._revision_id_to_root_id:
 
3527
                # We probably didn't read this revision, go spend the
 
3528
                # extra effort to actually check
 
3529
                try:
 
3530
                    tree = self.source.revision_tree(parent_id)
 
3531
                except errors.NoSuchRevision:
 
3532
                    # Ghost, fill out _revision_id_to_root_id in case we
 
3533
                    # encounter this again.
 
3534
                    # But set parent_root_id to None since we don't really know
 
3535
                    parent_root_id = None
 
3536
                else:
 
3537
                    parent_root_id = tree.get_root_id()
 
3538
                self._revision_id_to_root_id[parent_id] = None
 
3539
            else:
 
3540
                parent_root_id = self._revision_id_to_root_id[parent_id]
 
3541
            if root_id == parent_root_id:
 
3542
                # With stacking we _might_ want to refer to a non-local
 
3543
                # revision, but this code path only applies when we have the
 
3544
                # full content available, so ghosts really are ghosts, not just
 
3545
                # the edge of local data.
 
3546
                parent_keys.append((parent_id,))
 
3547
            else:
 
3548
                # root_id may be in the parent anyway.
 
3549
                try:
 
3550
                    tree = self.source.revision_tree(parent_id)
 
3551
                except errors.NoSuchRevision:
 
3552
                    # ghost, can't refer to it.
 
3553
                    pass
 
3554
                else:
 
3555
                    try:
 
3556
                        parent_keys.append((tree.inventory[root_id].revision,))
 
3557
                    except errors.NoSuchId:
 
3558
                        # not in the tree
 
3559
                        pass
 
3560
        g = graph.Graph(self.source.revisions)
 
3561
        heads = g.heads(parent_keys)
 
3562
        selected_keys = []
 
3563
        for key in parent_keys:
 
3564
            if key in heads and key not in selected_keys:
 
3565
                selected_keys.append(key)
 
3566
        return tuple([(root_id,)+ key for key in selected_keys])
 
3567
 
 
3568
    def _new_root_data_stream(self, root_keys_to_create, parent_map):
 
3569
        for root_key in root_keys_to_create:
 
3570
            parent_keys = self._get_parent_keys(root_key, parent_map)
 
3571
            yield versionedfile.FulltextContentFactory(root_key,
 
3572
                parent_keys, None, '')
 
3573
 
 
3574
    def _fetch_batch(self, revision_ids, basis_id, cache):
3841
3575
        """Fetch across a few revisions.
3842
3576
 
3843
3577
        :param revision_ids: The revisions to copy
3844
3578
        :param basis_id: The revision_id of a tree that must be in cache, used
3845
3579
            as a basis for delta when no other base is available
3846
3580
        :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
3581
        :return: The revision_id of the last converted tree. The RevisionTree
3850
3582
            for it will be in cache
3851
3583
        """
3857
3589
        pending_deltas = []
3858
3590
        pending_revisions = []
3859
3591
        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
3592
        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
3593
            current_revision_id = tree.get_revision_id()
3866
3594
            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
3595
            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))
 
3596
                                                           basis_id, cache)
3878
3597
            if self._converting_to_rich_root:
3879
3598
                self._revision_id_to_root_id[current_revision_id] = \
3880
3599
                    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()
 
3600
            # Find text entries that need to be copied
3884
3601
            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)
 
3602
                if new_path is not None:
 
3603
                    if not new_path:
 
3604
                        # This is the root
 
3605
                        if not self.target.supports_rich_root():
 
3606
                            # The target doesn't support rich root, so we don't
 
3607
                            # copy
 
3608
                            continue
 
3609
                        if self._converting_to_rich_root:
 
3610
                            # This can't be copied normally, we have to insert
 
3611
                            # it specially
 
3612
                            root_keys_to_create.add((file_id, entry.revision))
 
3613
                            continue
 
3614
                    text_keys.add((file_id, entry.revision))
 
3615
            revision = self.source.get_revision(current_revision_id)
 
3616
            pending_deltas.append((basis_id, delta,
 
3617
                current_revision_id, revision.parent_ids))
3912
3618
            pending_revisions.append(revision)
3913
3619
            cache[current_revision_id] = tree
3914
3620
            basis_id = current_revision_id
3915
 
        self.source._safe_to_return_from_cache = False
3916
3621
        # Copy file texts
3917
3622
        from_texts = self.source.texts
3918
3623
        to_texts = self.target.texts
3919
3624
        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)
 
3625
            root_stream = self._new_root_data_stream(root_keys_to_create,
 
3626
                                                     parent_map)
3923
3627
            to_texts.insert_record_stream(root_stream)
3924
3628
        to_texts.insert_record_stream(from_texts.get_record_stream(
3925
3629
            text_keys, self.target._format._fetch_order,
3932
3636
            # for the new revisions that we are about to insert.  We do this
3933
3637
            # before adding the revisions so that no revision is added until
3934
3638
            # 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
3639
            parent_ids = set()
3938
3640
            revision_ids = set()
3939
3641
            for revision in pending_revisions:
3942
3644
            parent_ids.difference_update(revision_ids)
3943
3645
            parent_ids.discard(_mod_revision.NULL_REVISION)
3944
3646
            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):
 
3647
            for parent_tree in self.source.revision_trees(parent_ids):
 
3648
                basis_id, delta = self._get_delta_for_revision(tree, parent_ids, basis_id, cache)
3948
3649
                current_revision_id = parent_tree.get_revision_id()
3949
3650
                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
3651
                self.target.add_inventory_by_delta(
3958
3652
                    basis_id, delta, current_revision_id, parents_parents)
3959
3653
        # insert signatures and revisions
3981
3675
        cache = lru_cache.LRUCache(100)
3982
3676
        cache[basis_id] = basis_tree
3983
3677
        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
3678
        for offset in range(0, len(revision_ids), batch_size):
3992
3679
            self.target.start_write_group()
3993
3680
            try:
3994
3681
                pb.update('Transferring revisions', offset,
3995
3682
                          len(revision_ids))
3996
3683
                batch = revision_ids[offset:offset+batch_size]
3997
 
                basis_id = self._fetch_batch(batch, basis_id, cache,
3998
 
                                             a_graph=a_graph)
 
3684
                basis_id = self._fetch_batch(batch, basis_id, cache)
3999
3685
            except:
4000
 
                self.source._safe_to_return_from_cache = False
4001
3686
                self.target.abort_write_group()
4002
3687
                raise
4003
3688
            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)
 
3689
                self.target.commit_write_group()
4009
3690
        pb.update('Transferring revisions', len(revision_ids),
4010
3691
                  len(revision_ids))
4011
3692
 
4015
3696
        """See InterRepository.fetch()."""
4016
3697
        if fetch_spec is not None:
4017
3698
            raise AssertionError("Not implemented yet...")
4018
 
        ui.ui_factory.warn_experimental_format_fetch(self)
4019
3699
        if (not self.source.supports_rich_root()
4020
3700
            and self.target.supports_rich_root()):
4021
3701
            self._converting_to_rich_root = True
4022
3702
            self._revision_id_to_root_id = {}
4023
3703
        else:
4024
3704
            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
3705
        revision_ids = self.target.search_missing_revision_ids(self.source,
4031
3706
            revision_id, find_ghosts=find_ghosts).get_keys()
4032
3707
        if not revision_ids:
4038
3713
        # Walk though all revisions; get inventory deltas, copy referenced
4039
3714
        # texts that delta references, insert the delta, revision and
4040
3715
        # signature.
 
3716
        first_rev = self.source.get_revision(revision_ids[0])
4041
3717
        if pb is None:
4042
3718
            my_pb = ui.ui_factory.nested_progress_bar()
4043
3719
            pb = my_pb
4101
3777
        :param to_convert: The disk object to convert.
4102
3778
        :param pb: a progress bar to use for progress information.
4103
3779
        """
4104
 
        pb = ui.ui_factory.nested_progress_bar()
 
3780
        self.pb = pb
4105
3781
        self.count = 0
4106
3782
        self.total = 4
4107
3783
        # this is only useful with metadir layouts - separated repo content.
4108
3784
        # trigger an assertion if not such
4109
3785
        repo._format.get_format_string()
4110
3786
        self.repo_dir = repo.bzrdir
4111
 
        pb.update('Moving repository to repository.backup')
 
3787
        self.step('Moving repository to repository.backup')
4112
3788
        self.repo_dir.transport.move('repository', 'repository.backup')
4113
3789
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4114
3790
        repo._format.check_conversion_target(self.target_format)
4115
3791
        self.source_repo = repo._format.open(self.repo_dir,
4116
3792
            _found=True,
4117
3793
            _override_transport=backup_transport)
4118
 
        pb.update('Creating new repository')
 
3794
        self.step('Creating new repository')
4119
3795
        converted = self.target_format.initialize(self.repo_dir,
4120
3796
                                                  self.source_repo.is_shared())
4121
3797
        converted.lock_write()
4122
3798
        try:
4123
 
            pb.update('Copying content')
 
3799
            self.step('Copying content into repository.')
4124
3800
            self.source_repo.copy_content_into(converted)
4125
3801
        finally:
4126
3802
            converted.unlock()
4127
 
        pb.update('Deleting old repository content')
 
3803
        self.step('Deleting old repository content.')
4128
3804
        self.repo_dir.transport.delete_tree('repository.backup')
4129
 
        ui.ui_factory.note('repository converted')
4130
 
        pb.finished()
 
3805
        self.pb.note('repository converted')
 
3806
 
 
3807
    def step(self, message):
 
3808
        """Update the pb by a step."""
 
3809
        self.count +=1
 
3810
        self.pb.update(message, self.count, self.total)
4131
3811
 
4132
3812
 
4133
3813
_unescape_map = {
4162
3842
 
4163
3843
class _VersionedFileChecker(object):
4164
3844
 
4165
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
3845
    def __init__(self, repository, text_key_references=None):
4166
3846
        self.repository = repository
4167
3847
        self.text_index = self.repository._generate_text_key_index(
4168
 
            text_key_references=text_key_references, ancestors=ancestors)
 
3848
            text_key_references=text_key_references)
4169
3849
 
4170
3850
    def calculate_file_version_parents(self, text_key):
4171
3851
        """Calculate the correct parents for a file version according to
4189
3869
            revision_id) tuples for versions that are present in this versioned
4190
3870
            file, but not used by the corresponding inventory.
4191
3871
        """
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
3872
        wrong_parents = {}
4205
3873
        self.file_ids = set([file_id for file_id, _ in
4206
3874
            self.text_index.iterkeys()])
4207
3875
        # text keys is now grouped by file_id
 
3876
        n_weaves = len(self.file_ids)
 
3877
        files_in_revisions = {}
 
3878
        revisions_of_files = {}
4208
3879
        n_versions = len(self.text_index)
4209
3880
        progress_bar.update('loading text store', 0, n_versions)
4210
3881
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4212
3883
        text_keys = self.repository.texts.keys()
4213
3884
        unused_keys = frozenset(text_keys) - set(self.text_index)
4214
3885
        for num, key in enumerate(self.text_index.iterkeys()):
4215
 
            progress_bar.update('checking text graph', num, n_versions)
 
3886
            if progress_bar is not None:
 
3887
                progress_bar.update('checking text graph', num, n_versions)
4216
3888
            correct_parents = self.calculate_file_version_parents(key)
4217
3889
            try:
4218
3890
                knit_parents = parent_map[key]
4303
3975
            else:
4304
3976
                new_pack.set_write_cache_size(1024*1024)
4305
3977
        for substream_type, substream in stream:
4306
 
            if 'stream' in debug.debug_flags:
4307
 
                mutter('inserting substream: %s', substream_type)
4308
3978
            if substream_type == 'texts':
4309
3979
                self.target_repo.texts.insert_record_stream(substream)
4310
3980
            elif substream_type == 'inventories':
4314
3984
                else:
4315
3985
                    self._extract_and_insert_inventories(
4316
3986
                        substream, src_serializer)
4317
 
            elif substream_type == 'inventory-deltas':
4318
 
                self._extract_and_insert_inventory_deltas(
4319
 
                    substream, src_serializer)
4320
3987
            elif substream_type == 'chk_bytes':
4321
3988
                # XXX: This doesn't support conversions, as it assumes the
4322
3989
                #      conversion was done in the fetch code.
4353
4020
                ):
4354
4021
                if versioned_file is None:
4355
4022
                    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
4023
                missing_keys.update((prefix,) + key for key in
4364
4024
                    versioned_file.get_missing_compression_parent_keys())
4365
4025
        except NotImplementedError:
4374
4034
                # missing keys can handle suspending a write group).
4375
4035
                write_group_tokens = self.target_repo.suspend_write_group()
4376
4036
                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)
 
4037
        self.target_repo.commit_write_group()
4381
4038
        return [], set()
4382
4039
 
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):
 
4040
    def _extract_and_insert_inventories(self, substream, serializer):
4404
4041
        """Generate a new inventory versionedfile in target, converting data.
4405
4042
 
4406
4043
        The inventory is retrieved from the source, (deserializing it), and
4407
4044
        stored in the target (reserializing it in a different format).
4408
4045
        """
4409
 
        target_rich_root = self.target_repo._format.rich_root_data
4410
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4411
4046
        for record in substream:
4412
 
            # It's not a delta, so it must be a fulltext in the source
4413
 
            # serializer's format.
4414
4047
            bytes = record.get_bytes_as('fulltext')
4415
4048
            revision_id = record.key[0]
4416
4049
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4417
4050
            parents = [key[0] for key in record.parents]
4418
4051
            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
4052
 
4423
4053
    def _extract_and_insert_revisions(self, substream, serializer):
4424
4054
        for record in substream:
4473
4103
        return [('signatures', signatures), ('revisions', revisions)]
4474
4104
 
4475
4105
    def _generate_root_texts(self, revs):
4476
 
        """This will be called by get_stream between fetching weave texts and
 
4106
        """This will be called by __fetch between fetching weave texts and
4477
4107
        fetching the inventory weave.
 
4108
 
 
4109
        Subclasses should override this if they need to generate root texts
 
4110
        after fetching weave texts.
4478
4111
        """
4479
4112
        if self._rich_root_upgrade():
4480
 
            return _mod_fetch.Inter1and2Helper(
 
4113
            import bzrlib.fetch
 
4114
            return bzrlib.fetch.Inter1and2Helper(
4481
4115
                self.from_repository).generate_root_texts(revs)
4482
4116
        else:
4483
4117
            return []
4486
4120
        phase = 'file'
4487
4121
        revs = search.get_keys()
4488
4122
        graph = self.from_repository.get_graph()
4489
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
 
4123
        revs = list(graph.iter_topo_order(revs))
4490
4124
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4491
4125
        text_keys = []
4492
4126
        for knit_kind, file_id, revisions in data_to_fetch:
4511
4145
                # will be valid.
4512
4146
                for _ in self._generate_root_texts(revs):
4513
4147
                    yield _
 
4148
                # NB: This currently reopens the inventory weave in source;
 
4149
                # using a single stream interface instead would avoid this.
 
4150
                from_weave = self.from_repository.inventories
4514
4151
                # we fetch only the referenced inventories because we do not
4515
4152
                # know for unselected inventories whether all their required
4516
4153
                # texts are present in the other repository - it could be
4555
4192
            if not keys:
4556
4193
                # No need to stream something we don't have
4557
4194
                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
4195
            # Ask for full texts always so that we don't need more round trips
4571
4196
            # after this stream.
4572
4197
            # Some of the missing keys are genuinely ghosts, so filter absent
4587
4212
        return (not self.from_repository._format.rich_root_data and
4588
4213
            self.to_format.rich_root_data)
4589
4214
 
4590
 
    def _get_inventory_stream(self, revision_ids, missing=False):
 
4215
    def _get_inventory_stream(self, revision_ids):
4591
4216
        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)
 
4217
        if (from_format.supports_chks and self.to_format.supports_chks
 
4218
            and (from_format._serializer == self.to_format._serializer)):
 
4219
            # Both sides support chks, and they use the same serializer, so it
 
4220
            # is safe to transmit the chk pages and inventory pages across
 
4221
            # as-is.
 
4222
            return self._get_chk_inventory_stream(revision_ids)
 
4223
        elif (not from_format.supports_chks):
 
4224
            # Source repository doesn't support chks. So we can transmit the
 
4225
            # inventories 'as-is' and either they are just accepted on the
 
4226
            # target, or the Sink will properly convert it.
 
4227
            return self._get_simple_inventory_stream(revision_ids)
4608
4228
        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)
 
4229
            # XXX: Hack to make not-chk->chk fetch: copy the inventories as
 
4230
            #      inventories. Note that this should probably be done somehow
 
4231
            #      as part of bzrlib.repository.StreamSink. Except JAM couldn't
 
4232
            #      figure out how a non-chk repository could possibly handle
 
4233
            #      deserializing an inventory stream from a chk repo, as it
 
4234
            #      doesn't have a way to understand individual pages.
 
4235
            return self._get_convertable_inventory_stream(revision_ids)
4613
4236
 
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.
 
4237
    def _get_simple_inventory_stream(self, revision_ids):
4617
4238
        from_weave = self.from_repository.inventories
4618
 
        if missing:
4619
 
            delta_closure = True
4620
 
        else:
4621
 
            delta_closure = not self.delta_on_metadata()
4622
4239
        yield ('inventories', from_weave.get_record_stream(
4623
4240
            [(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
 
        """
 
4241
            self.inventory_fetch_order(),
 
4242
            not self.delta_on_metadata()))
 
4243
 
 
4244
    def _get_chk_inventory_stream(self, revision_ids):
 
4245
        """Fetch the inventory texts, along with the associated chk maps."""
 
4246
        # We want an inventory outside of the search set, so that we can filter
 
4247
        # out uninteresting chk pages. For now we use
 
4248
        # _find_revision_outside_set, but if we had a Search with cut_revs, we
 
4249
        # could use that instead.
 
4250
        start_rev_id = self.from_repository._find_revision_outside_set(
 
4251
                            revision_ids)
 
4252
        start_rev_key = (start_rev_id,)
 
4253
        inv_keys_to_fetch = [(rev_id,) for rev_id in revision_ids]
 
4254
        if start_rev_id != _mod_revision.NULL_REVISION:
 
4255
            inv_keys_to_fetch.append((start_rev_id,))
 
4256
        # Any repo that supports chk_bytes must also support out-of-order
 
4257
        # insertion. At least, that is how we expect it to work
 
4258
        # We use get_record_stream instead of iter_inventories because we want
 
4259
        # to be able to insert the stream as well. We could instead fetch
 
4260
        # allowing deltas, and then iter_inventories, but we don't know whether
 
4261
        # source or target is more 'local' anway.
 
4262
        inv_stream = self.from_repository.inventories.get_record_stream(
 
4263
            inv_keys_to_fetch, 'unordered',
 
4264
            True) # We need them as full-texts so we can find their references
 
4265
        uninteresting_chk_roots = set()
 
4266
        interesting_chk_roots = set()
 
4267
        def filter_inv_stream(inv_stream):
 
4268
            for idx, record in enumerate(inv_stream):
 
4269
                ### child_pb.update('fetch inv', idx, len(inv_keys_to_fetch))
 
4270
                bytes = record.get_bytes_as('fulltext')
 
4271
                chk_inv = inventory.CHKInventory.deserialise(
 
4272
                    self.from_repository.chk_bytes, bytes, record.key)
 
4273
                if record.key == start_rev_key:
 
4274
                    uninteresting_chk_roots.add(chk_inv.id_to_entry.key())
 
4275
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4276
                    if p_id_map is not None:
 
4277
                        uninteresting_chk_roots.add(p_id_map.key())
 
4278
                else:
 
4279
                    yield record
 
4280
                    interesting_chk_roots.add(chk_inv.id_to_entry.key())
 
4281
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4282
                    if p_id_map is not None:
 
4283
                        interesting_chk_roots.add(p_id_map.key())
 
4284
        ### pb.update('fetch inventory', 0, 2)
 
4285
        yield ('inventories', filter_inv_stream(inv_stream))
 
4286
        # Now that we have worked out all of the interesting root nodes, grab
 
4287
        # all of the interesting pages and insert them
 
4288
        ### pb.update('fetch inventory', 1, 2)
 
4289
        interesting = chk_map.iter_interesting_nodes(
 
4290
            self.from_repository.chk_bytes, interesting_chk_roots,
 
4291
            uninteresting_chk_roots)
 
4292
        def to_stream_adapter():
 
4293
            """Adapt the iter_interesting_nodes result to a single stream.
 
4294
 
 
4295
            iter_interesting_nodes returns records as it processes them, along
 
4296
            with keys. However, we only want to return the records themselves.
 
4297
            """
 
4298
            for record, items in interesting:
 
4299
                if record is not None:
 
4300
                    yield record
 
4301
        # XXX: We could instead call get_record_stream(records.keys())
 
4302
        #      ATM, this will always insert the records as fulltexts, and
 
4303
        #      requires that you can hang on to records once you have gone
 
4304
        #      on to the next one. Further, it causes the target to
 
4305
        #      recompress the data. Testing shows it to be faster than
 
4306
        #      requesting the records again, though.
 
4307
        yield ('chk_bytes', to_stream_adapter())
 
4308
        ### pb.update('fetch inventory', 2, 2)
 
4309
 
 
4310
    def _get_convertable_inventory_stream(self, revision_ids):
 
4311
        # XXX: One of source or target is using chks, and they don't have
 
4312
        #      compatible serializations. The StreamSink code expects to be
 
4313
        #      able to convert on the target, so we need to put
 
4314
        #      bytes-on-the-wire that can be converted
 
4315
        yield ('inventories', self._stream_invs_as_fulltexts(revision_ids))
 
4316
 
 
4317
    def _stream_invs_as_fulltexts(self, revision_ids):
4648
4318
        from_repo = self.from_repository
 
4319
        from_serializer = from_repo._format._serializer
4649
4320
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4650
4321
        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:
 
4322
        for inv in self.from_repository.iter_inventories(revision_ids):
 
4323
            # XXX: This is a bit hackish, but it works. Basically,
 
4324
            #      CHKSerializer 'accidentally' supports
 
4325
            #      read/write_inventory_to_string, even though that is never
 
4326
            #      the format that is stored on disk. It *does* give us a
 
4327
            #      single string representation for an inventory, so live with
 
4328
            #      it for now.
 
4329
            #      This would be far better if we had a 'serialized inventory
 
4330
            #      delta' form. Then we could use 'inventory._make_delta', and
 
4331
            #      transmit that. This would both be faster to generate, and
 
4332
            #      result in fewer bytes-on-the-wire.
 
4333
            as_bytes = from_serializer.write_inventory_to_string(inv)
4667
4334
            key = (inv.revision_id,)
4668
4335
            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
4336
            yield versionedfile.FulltextContentFactory(
4701
 
                key, parent_keys, None, delta_serialized)
 
4337
                key, parent_keys, None, as_bytes)
4702
4338
 
4703
4339
 
4704
4340
def _iter_for_revno(repo, partial_history_cache, stop_index=None,