/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Robert Collins
  • Date: 2009-04-15 07:30:34 UTC
  • mto: This revision was merged to the branch mainline in revision 4292.
  • Revision ID: robertc@robertcollins.net-20090415073034-plcl46p8poz08kzb
Review feedback.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
24
24
    bzrdir,
25
25
    check,
26
26
    chk_map,
27
 
    config,
28
27
    debug,
29
 
    fetch as _mod_fetch,
 
28
    errors,
30
29
    fifo_cache,
31
30
    generate_ids,
32
31
    gpg,
33
32
    graph,
34
33
    inventory,
35
 
    inventory_delta,
36
34
    lazy_regex,
37
35
    lockable_files,
38
36
    lockdir,
39
37
    lru_cache,
40
38
    osutils,
41
39
    revision as _mod_revision,
42
 
    static_tuple,
43
40
    symbol_versioning,
44
 
    trace,
45
41
    tsort,
 
42
    ui,
46
43
    versionedfile,
47
44
    )
48
45
from bzrlib.bundle import serializer
51
48
from bzrlib.testament import Testament
52
49
""")
53
50
 
54
 
from bzrlib import (
55
 
    errors,
56
 
    registry,
57
 
    ui,
58
 
    )
59
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
51
from bzrlib.decorators import needs_read_lock, needs_write_lock
60
52
from bzrlib.inter import InterObject
61
53
from bzrlib.inventory import (
62
54
    Inventory,
64
56
    ROOT_ID,
65
57
    entry_factory,
66
58
    )
67
 
from bzrlib.recordcounter import RecordCounter
68
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
 
59
from bzrlib import registry
 
60
from bzrlib.symbol_versioning import (
 
61
        deprecated_method,
 
62
        )
69
63
from bzrlib.trace import (
70
64
    log_exception_quietly, note, mutter, mutter_callsite, warning)
71
65
 
74
68
_deprecation_warning_done = False
75
69
 
76
70
 
77
 
class IsInWriteGroupError(errors.InternalBzrError):
78
 
 
79
 
    _fmt = "May not refresh_data of repo %(repo)s while in a write group."
80
 
 
81
 
    def __init__(self, repo):
82
 
        errors.InternalBzrError.__init__(self, repo=repo)
83
 
 
84
 
 
85
71
class CommitBuilder(object):
86
72
    """Provides an interface to build up a commit.
87
73
 
221
207
            # an inventory delta was accumulated without creating a new
222
208
            # inventory.
223
209
            basis_id = self.basis_delta_revision
224
 
            # We ignore the 'inventory' returned by add_inventory_by_delta
225
 
            # because self.new_inventory is used to hint to the rest of the
226
 
            # system what code path was taken
227
 
            self.inv_sha1, _ = self.repository.add_inventory_by_delta(
 
210
            self.inv_sha1 = self.repository.add_inventory_by_delta(
228
211
                basis_id, self._basis_delta, self._new_revision_id,
229
212
                self.parents)
230
213
        else:
289
272
 
290
273
        :param tree: The tree which is being committed.
291
274
        """
292
 
        if len(self.parents) == 0:
293
 
            raise errors.RootMissing()
 
275
        # NB: if there are no parents then this method is not called, so no
 
276
        # need to guard on parents having length.
294
277
        entry = entry_factory['directory'](tree.path2id(''), '',
295
278
            None)
296
279
        entry.revision = self._new_revision_id
484
467
            if content_summary[2] is None:
485
468
                raise ValueError("Files must not have executable = None")
486
469
            if not store:
487
 
                # We can't trust a check of the file length because of content
488
 
                # filtering...
489
 
                if (# if the exec bit has changed we have to store:
 
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:
490
473
                    parent_entry.executable != content_summary[2]):
491
474
                    store = True
492
475
                elif parent_entry.text_sha1 == content_summary[3]:
511
494
            ie.executable = content_summary[2]
512
495
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
513
496
            try:
514
 
                text = file_obj.read()
 
497
                lines = file_obj.readlines()
515
498
            finally:
516
499
                file_obj.close()
517
500
            try:
518
501
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
519
 
                    ie.file_id, text, heads, nostore_sha)
 
502
                    ie.file_id, lines, heads, nostore_sha)
520
503
                # Let the caller know we generated a stat fingerprint.
521
504
                fingerprint = (ie.text_sha1, stat_value)
522
505
            except errors.ExistingContent:
534
517
                # carry over:
535
518
                ie.revision = parent_entry.revision
536
519
                return self._get_delta(ie, basis_inv, path), False, None
537
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
520
            lines = []
 
521
            self._add_text_to_weave(ie.file_id, lines, heads, None)
538
522
        elif kind == 'symlink':
539
523
            current_link_target = content_summary[3]
540
524
            if not store:
548
532
                ie.symlink_target = parent_entry.symlink_target
549
533
                return self._get_delta(ie, basis_inv, path), False, None
550
534
            ie.symlink_target = current_link_target
551
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
535
            lines = []
 
536
            self._add_text_to_weave(ie.file_id, lines, heads, None)
552
537
        elif kind == 'tree-reference':
553
538
            if not store:
554
539
                if content_summary[3] != parent_entry.reference_revision:
559
544
                ie.revision = parent_entry.revision
560
545
                return self._get_delta(ie, basis_inv, path), False, None
561
546
            ie.reference_revision = content_summary[3]
562
 
            if ie.reference_revision is None:
563
 
                raise AssertionError("invalid content_summary for nested tree: %r"
564
 
                    % (content_summary,))
565
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
547
            lines = []
 
548
            self._add_text_to_weave(ie.file_id, lines, heads, None)
566
549
        else:
567
550
            raise NotImplementedError('unknown kind')
568
551
        ie.revision = self._new_revision_id
762
745
                        entry.executable = True
763
746
                    else:
764
747
                        entry.executable = False
765
 
                    if (carry_over_possible and
 
748
                    if (carry_over_possible and 
766
749
                        parent_entry.executable == entry.executable):
767
750
                            # Check the file length, content hash after reading
768
751
                            # the file.
771
754
                        nostore_sha = None
772
755
                    file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
773
756
                    try:
774
 
                        text = file_obj.read()
 
757
                        lines = file_obj.readlines()
775
758
                    finally:
776
759
                        file_obj.close()
777
760
                    try:
778
761
                        entry.text_sha1, entry.text_size = self._add_text_to_weave(
779
 
                            file_id, text, heads, nostore_sha)
 
762
                            file_id, lines, heads, nostore_sha)
780
763
                        yield file_id, change[1][1], (entry.text_sha1, stat_value)
781
764
                    except errors.ExistingContent:
782
765
                        # No content change against a carry_over parent
791
774
                        parent_entry.symlink_target == entry.symlink_target):
792
775
                        carried_over = True
793
776
                    else:
794
 
                        self._add_text_to_weave(change[0], '', heads, None)
 
777
                        self._add_text_to_weave(change[0], [], heads, None)
795
778
                elif kind == 'directory':
796
779
                    if carry_over_possible:
797
780
                        carried_over = True
799
782
                        # Nothing to set on the entry.
800
783
                        # XXX: split into the Root and nonRoot versions.
801
784
                        if change[1][1] != '' or self.repository.supports_rich_root():
802
 
                            self._add_text_to_weave(change[0], '', heads, None)
 
785
                            self._add_text_to_weave(change[0], [], heads, None)
803
786
                elif kind == 'tree-reference':
804
787
                    if not self.repository._format.supports_tree_reference:
805
788
                        # This isn't quite sane as an error, but we shouldn't
808
791
                        # references.
809
792
                        raise errors.UnsupportedOperation(tree.add_reference,
810
793
                            self.repository)
811
 
                    reference_revision = tree.get_reference_revision(change[0])
812
 
                    entry.reference_revision = reference_revision
 
794
                    entry.reference_revision = \
 
795
                        tree.get_reference_revision(change[0])
813
796
                    if (carry_over_possible and
814
797
                        parent_entry.reference_revision == reference_revision):
815
798
                        carried_over = True
816
799
                    else:
817
 
                        self._add_text_to_weave(change[0], '', heads, None)
 
800
                        self._add_text_to_weave(change[0], [], heads, None)
818
801
                else:
819
802
                    raise AssertionError('unknown kind %r' % kind)
820
803
                if not carried_over:
829
812
                seen_root = True
830
813
        self.new_inventory = None
831
814
        if len(inv_delta):
832
 
            # This should perhaps be guarded by a check that the basis we
833
 
            # commit against is the basis for the commit and if not do a delta
834
 
            # against the basis.
835
815
            self._any_changes = True
836
816
        if not seen_root:
837
817
            # housekeeping root entry changes do not affect no-change commits.
838
818
            self._require_root_change(tree)
839
819
        self.basis_delta_revision = basis_revision_id
840
820
 
841
 
    def _add_text_to_weave(self, file_id, new_text, parents, nostore_sha):
842
 
        parent_keys = tuple([(file_id, parent) for parent in parents])
843
 
        return self.repository.texts._add_text(
844
 
            (file_id, self._new_revision_id), parent_keys, new_text,
845
 
            nostore_sha=nostore_sha, random_id=self.random_revid)[0:2]
 
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]
846
832
 
847
833
 
848
834
class RootCommitBuilder(CommitBuilder):
871
857
        # versioned roots do not change unless the tree found a change.
872
858
 
873
859
 
874
 
class RepositoryWriteLockResult(LogicalLockResult):
875
 
    """The result of write locking a repository.
876
 
 
877
 
    :ivar repository_token: The token obtained from the underlying lock, or
878
 
        None.
879
 
    :ivar unlock: A callable which will unlock the lock.
880
 
    """
881
 
 
882
 
    def __init__(self, unlock, repository_token):
883
 
        LogicalLockResult.__init__(self, unlock)
884
 
        self.repository_token = repository_token
885
 
 
886
 
    def __repr__(self):
887
 
        return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
888
 
            self.unlock)
889
 
 
890
 
 
891
860
######################################################################
892
861
# Repositories
893
862
 
894
 
 
895
 
class Repository(_RelockDebugMixin, bzrdir.ControlComponent):
 
863
class Repository(object):
896
864
    """Repository holding history for one or more branches.
897
865
 
898
866
    The repository holds and retrieves historical information including
967
935
        """
968
936
        if self._write_group is not self.get_transaction():
969
937
            # has an unlock or relock occured ?
970
 
            if suppress_errors:
971
 
                mutter(
972
 
                '(suppressed) mismatched lock context and write group. %r, %r',
973
 
                self._write_group, self.get_transaction())
974
 
                return
975
938
            raise errors.BzrError(
976
939
                'mismatched lock context and write group. %r, %r' %
977
940
                (self._write_group, self.get_transaction()))
1006
969
        """
1007
970
        if not self._format.supports_external_lookups:
1008
971
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
1009
 
        if self.is_locked():
1010
 
            # This repository will call fallback.unlock() when we transition to
1011
 
            # the unlocked state, so we make sure to increment the lock count
1012
 
            repository.lock_read()
1013
972
        self._check_fallback_repository(repository)
1014
973
        self._fallback_repositories.append(repository)
1015
974
        self.texts.add_fallback_versioned_files(repository.texts)
1046
1005
                " id and insertion revid (%r, %r)"
1047
1006
                % (inv.revision_id, revision_id))
1048
1007
        if inv.root is None:
1049
 
            raise errors.RootMissing()
 
1008
            raise AssertionError()
1050
1009
        return self._add_inventory_checked(revision_id, inv, parents)
1051
1010
 
1052
1011
    def _add_inventory_checked(self, revision_id, inv, parents):
1056
1015
 
1057
1016
        :seealso: add_inventory, for the contract.
1058
1017
        """
1059
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
 
1018
        inv_lines = self._serialise_inventory_to_lines(inv)
1060
1019
        return self._inventory_add_lines(revision_id, parents,
1061
1020
            inv_lines, check_content=False)
1062
1021
 
1064
1023
                               parents, basis_inv=None, propagate_caches=False):
1065
1024
        """Add a new inventory expressed as a delta against another revision.
1066
1025
 
1067
 
        See the inventory developers documentation for the theory behind
1068
 
        inventory deltas.
1069
 
 
1070
1026
        :param basis_revision_id: The inventory id the delta was created
1071
1027
            against. (This does not have to be a direct parent.)
1072
1028
        :param delta: The inventory delta (see Inventory.apply_delta for
1111
1067
        check_content=True):
1112
1068
        """Store lines in inv_vf and return the sha1 of the inventory."""
1113
1069
        parents = [(parent,) for parent in parents]
1114
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
1070
        return self.inventories.add_lines((revision_id,), parents, lines,
1115
1071
            check_content=check_content)[0]
1116
 
        self.inventories._access.flush()
1117
 
        return result
1118
1072
 
1119
1073
    def add_revision(self, revision_id, rev, inv=None, config=None):
1120
1074
        """Add rev to the revision store as revision_id.
1196
1150
        # The old API returned a list, should this actually be a set?
1197
1151
        return parent_map.keys()
1198
1152
 
1199
 
    def _check_inventories(self, checker):
1200
 
        """Check the inventories found from the revision scan.
1201
 
        
1202
 
        This is responsible for verifying the sha1 of inventories and
1203
 
        creating a pending_keys set that covers data referenced by inventories.
1204
 
        """
1205
 
        bar = ui.ui_factory.nested_progress_bar()
1206
 
        try:
1207
 
            self._do_check_inventories(checker, bar)
1208
 
        finally:
1209
 
            bar.finished()
1210
 
 
1211
 
    def _do_check_inventories(self, checker, bar):
1212
 
        """Helper for _check_inventories."""
1213
 
        revno = 0
1214
 
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
1215
 
        kinds = ['chk_bytes', 'texts']
1216
 
        count = len(checker.pending_keys)
1217
 
        bar.update("inventories", 0, 2)
1218
 
        current_keys = checker.pending_keys
1219
 
        checker.pending_keys = {}
1220
 
        # Accumulate current checks.
1221
 
        for key in current_keys:
1222
 
            if key[0] != 'inventories' and key[0] not in kinds:
1223
 
                checker._report_items.append('unknown key type %r' % (key,))
1224
 
            keys[key[0]].add(key[1:])
1225
 
        if keys['inventories']:
1226
 
            # NB: output order *should* be roughly sorted - topo or
1227
 
            # inverse topo depending on repository - either way decent
1228
 
            # to just delta against. However, pre-CHK formats didn't
1229
 
            # try to optimise inventory layout on disk. As such the
1230
 
            # pre-CHK code path does not use inventory deltas.
1231
 
            last_object = None
1232
 
            for record in self.inventories.check(keys=keys['inventories']):
1233
 
                if record.storage_kind == 'absent':
1234
 
                    checker._report_items.append(
1235
 
                        'Missing inventory {%s}' % (record.key,))
1236
 
                else:
1237
 
                    last_object = self._check_record('inventories', record,
1238
 
                        checker, last_object,
1239
 
                        current_keys[('inventories',) + record.key])
1240
 
            del keys['inventories']
1241
 
        else:
1242
 
            return
1243
 
        bar.update("texts", 1)
1244
 
        while (checker.pending_keys or keys['chk_bytes']
1245
 
            or keys['texts']):
1246
 
            # Something to check.
1247
 
            current_keys = checker.pending_keys
1248
 
            checker.pending_keys = {}
1249
 
            # Accumulate current checks.
1250
 
            for key in current_keys:
1251
 
                if key[0] not in kinds:
1252
 
                    checker._report_items.append('unknown key type %r' % (key,))
1253
 
                keys[key[0]].add(key[1:])
1254
 
            # Check the outermost kind only - inventories || chk_bytes || texts
1255
 
            for kind in kinds:
1256
 
                if keys[kind]:
1257
 
                    last_object = None
1258
 
                    for record in getattr(self, kind).check(keys=keys[kind]):
1259
 
                        if record.storage_kind == 'absent':
1260
 
                            checker._report_items.append(
1261
 
                                'Missing %s {%s}' % (kind, record.key,))
1262
 
                        else:
1263
 
                            last_object = self._check_record(kind, record,
1264
 
                                checker, last_object, current_keys[(kind,) + record.key])
1265
 
                    keys[kind] = set()
1266
 
                    break
1267
 
 
1268
 
    def _check_record(self, kind, record, checker, last_object, item_data):
1269
 
        """Check a single text from this repository."""
1270
 
        if kind == 'inventories':
1271
 
            rev_id = record.key[0]
1272
 
            inv = self._deserialise_inventory(rev_id,
1273
 
                record.get_bytes_as('fulltext'))
1274
 
            if last_object is not None:
1275
 
                delta = inv._make_delta(last_object)
1276
 
                for old_path, path, file_id, ie in delta:
1277
 
                    if ie is None:
1278
 
                        continue
1279
 
                    ie.check(checker, rev_id, inv)
1280
 
            else:
1281
 
                for path, ie in inv.iter_entries():
1282
 
                    ie.check(checker, rev_id, inv)
1283
 
            if self._format.fast_deltas:
1284
 
                return inv
1285
 
        elif kind == 'chk_bytes':
1286
 
            # No code written to check chk_bytes for this repo format.
1287
 
            checker._report_items.append(
1288
 
                'unsupported key type chk_bytes for %s' % (record.key,))
1289
 
        elif kind == 'texts':
1290
 
            self._check_text(record, checker, item_data)
1291
 
        else:
1292
 
            checker._report_items.append(
1293
 
                'unknown key type %s for %s' % (kind, record.key))
1294
 
 
1295
 
    def _check_text(self, record, checker, item_data):
1296
 
        """Check a single text."""
1297
 
        # Check it is extractable.
1298
 
        # TODO: check length.
1299
 
        if record.storage_kind == 'chunked':
1300
 
            chunks = record.get_bytes_as(record.storage_kind)
1301
 
            sha1 = osutils.sha_strings(chunks)
1302
 
            length = sum(map(len, chunks))
1303
 
        else:
1304
 
            content = record.get_bytes_as('fulltext')
1305
 
            sha1 = osutils.sha_string(content)
1306
 
            length = len(content)
1307
 
        if item_data and sha1 != item_data[1]:
1308
 
            checker._report_items.append(
1309
 
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
1310
 
                (record.key, sha1, item_data[1], item_data[2]))
1311
 
 
1312
1153
    @staticmethod
1313
1154
    def create(a_bzrdir):
1314
1155
        """Construct the current default format repository in a_bzrdir."""
1319
1160
 
1320
1161
        :param _format: The format of the repository on disk.
1321
1162
        :param a_bzrdir: The BzrDir of the repository.
 
1163
 
 
1164
        In the future we will have a single api for all stores for
 
1165
        getting file texts, inventories and revisions, then
 
1166
        this construct will accept instances of those things.
1322
1167
        """
1323
 
        # In the future we will have a single api for all stores for
1324
 
        # getting file texts, inventories and revisions, then
1325
 
        # this construct will accept instances of those things.
1326
1168
        super(Repository, self).__init__()
1327
1169
        self._format = _format
1328
1170
        # the following are part of the public API for Repository:
1334
1176
        self._reconcile_does_inventory_gc = True
1335
1177
        self._reconcile_fixes_text_parents = False
1336
1178
        self._reconcile_backsup_inventory = True
 
1179
        # not right yet - should be more semantically clear ?
 
1180
        #
 
1181
        # TODO: make sure to construct the right store classes, etc, depending
 
1182
        # on whether escaping is required.
 
1183
        self._warn_if_deprecated()
1337
1184
        self._write_group = None
1338
1185
        # Additional places to query for data.
1339
1186
        self._fallback_repositories = []
1340
1187
        # An InventoryEntry cache, used during deserialization
1341
1188
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
1342
 
        # Is it safe to return inventory entries directly from the entry cache,
1343
 
        # rather copying them?
1344
 
        self._safe_to_return_from_cache = False
1345
 
 
1346
 
    @property
1347
 
    def user_transport(self):
1348
 
        return self.bzrdir.user_transport
1349
 
 
1350
 
    @property
1351
 
    def control_transport(self):
1352
 
        return self._transport
1353
1189
 
1354
1190
    def __repr__(self):
1355
 
        if self._fallback_repositories:
1356
 
            return '%s(%r, fallback_repositories=%r)' % (
1357
 
                self.__class__.__name__,
1358
 
                self.base,
1359
 
                self._fallback_repositories)
1360
 
        else:
1361
 
            return '%s(%r)' % (self.__class__.__name__,
1362
 
                               self.base)
1363
 
 
1364
 
    def _has_same_fallbacks(self, other_repo):
1365
 
        """Returns true if the repositories have the same fallbacks."""
1366
 
        my_fb = self._fallback_repositories
1367
 
        other_fb = other_repo._fallback_repositories
1368
 
        if len(my_fb) != len(other_fb):
1369
 
            return False
1370
 
        for f, g in zip(my_fb, other_fb):
1371
 
            if not f.has_same_location(g):
1372
 
                return False
1373
 
        return True
 
1191
        return '%s(%r)' % (self.__class__.__name__,
 
1192
                           self.base)
1374
1193
 
1375
1194
    def has_same_location(self, other):
1376
1195
        """Returns a boolean indicating if this repository is at the same
1404
1223
        data during reads, and allows a 'write_group' to be obtained. Write
1405
1224
        groups must be used for actual data insertion.
1406
1225
 
1407
 
        A token should be passed in if you know that you have locked the object
1408
 
        some other way, and need to synchronise this object's state with that
1409
 
        fact.
1410
 
 
1411
 
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1412
 
 
1413
1226
        :param token: if this is already locked, then lock_write will fail
1414
1227
            unless the token matches the existing lock.
1415
1228
        :returns: a token if this instance supports tokens, otherwise None.
1418
1231
        :raises MismatchedToken: if the specified token doesn't match the token
1419
1232
            of the existing lock.
1420
1233
        :seealso: start_write_group.
1421
 
        :return: A RepositoryWriteLockResult.
 
1234
 
 
1235
        A token should be passed in if you know that you have locked the object
 
1236
        some other way, and need to synchronise this object's state with that
 
1237
        fact.
 
1238
 
 
1239
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1422
1240
        """
1423
1241
        locked = self.is_locked()
1424
 
        token = self.control_files.lock_write(token=token)
 
1242
        result = self.control_files.lock_write(token=token)
 
1243
        for repo in self._fallback_repositories:
 
1244
            # Writes don't affect fallback repos
 
1245
            repo.lock_read()
1425
1246
        if not locked:
1426
 
            self._warn_if_deprecated()
1427
 
            self._note_lock('w')
1428
 
            for repo in self._fallback_repositories:
1429
 
                # Writes don't affect fallback repos
1430
 
                repo.lock_read()
1431
1247
            self._refresh_data()
1432
 
        return RepositoryWriteLockResult(self.unlock, token)
 
1248
        return result
1433
1249
 
1434
1250
    def lock_read(self):
1435
 
        """Lock the repository for read operations.
1436
 
 
1437
 
        :return: An object with an unlock method which will release the lock
1438
 
            obtained.
1439
 
        """
1440
1251
        locked = self.is_locked()
1441
1252
        self.control_files.lock_read()
 
1253
        for repo in self._fallback_repositories:
 
1254
            repo.lock_read()
1442
1255
        if not locked:
1443
 
            self._warn_if_deprecated()
1444
 
            self._note_lock('r')
1445
 
            for repo in self._fallback_repositories:
1446
 
                repo.lock_read()
1447
1256
            self._refresh_data()
1448
 
        return LogicalLockResult(self.unlock)
1449
1257
 
1450
1258
    def get_physical_lock_status(self):
1451
1259
        return self.control_files.get_physical_lock_status()
1511
1319
 
1512
1320
        # now gather global repository information
1513
1321
        # XXX: This is available for many repos regardless of listability.
1514
 
        if self.user_transport.listable():
 
1322
        if self.bzrdir.root_transport.listable():
1515
1323
            # XXX: do we want to __define len__() ?
1516
1324
            # Maybe the versionedfiles object should provide a different
1517
1325
            # method to get the number of keys.
1527
1335
        :param using: If True, list only branches using this repository.
1528
1336
        """
1529
1337
        if using and not self.is_shared():
1530
 
            return self.bzrdir.list_branches()
 
1338
            try:
 
1339
                return [self.bzrdir.open_branch()]
 
1340
            except errors.NotBranchError:
 
1341
                return []
1531
1342
        class Evaluator(object):
1532
1343
 
1533
1344
            def __init__(self):
1542
1353
                    except errors.NoRepositoryPresent:
1543
1354
                        pass
1544
1355
                    else:
1545
 
                        return False, ([], repository)
 
1356
                        return False, (None, repository)
1546
1357
                self.first_call = False
1547
 
                value = (bzrdir.list_branches(), None)
 
1358
                try:
 
1359
                    value = (bzrdir.open_branch(), None)
 
1360
                except errors.NotBranchError:
 
1361
                    value = (None, None)
1548
1362
                return True, value
1549
1363
 
1550
 
        ret = []
1551
 
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
1552
 
                self.user_transport, evaluate=Evaluator()):
1553
 
            if branches is not None:
1554
 
                ret.extend(branches)
 
1364
        branches = []
 
1365
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1366
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
1367
            if branch is not None:
 
1368
                branches.append(branch)
1555
1369
            if not using and repository is not None:
1556
 
                ret.extend(repository.find_branches())
1557
 
        return ret
 
1370
                branches.extend(repository.find_branches())
 
1371
        return branches
1558
1372
 
1559
1373
    @needs_read_lock
1560
1374
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1589
1403
        """Commit the contents accrued within the current write group.
1590
1404
 
1591
1405
        :seealso: start_write_group.
1592
 
        
1593
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1594
1406
        """
1595
1407
        if self._write_group is not self.get_transaction():
1596
1408
            # has an unlock or relock occured ?
1597
1409
            raise errors.BzrError('mismatched lock context %r and '
1598
1410
                'write group %r.' %
1599
1411
                (self.get_transaction(), self._write_group))
1600
 
        result = self._commit_write_group()
 
1412
        self._commit_write_group()
1601
1413
        self._write_group = None
1602
 
        return result
1603
1414
 
1604
1415
    def _commit_write_group(self):
1605
1416
        """Template method for per-repository write group cleanup.
1613
1424
    def suspend_write_group(self):
1614
1425
        raise errors.UnsuspendableWriteGroup(self)
1615
1426
 
1616
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
1617
 
        """Return the keys of missing inventory parents for revisions added in
1618
 
        this write group.
1619
 
 
1620
 
        A revision is not complete if the inventory delta for that revision
1621
 
        cannot be calculated.  Therefore if the parent inventories of a
1622
 
        revision are not present, the revision is incomplete, and e.g. cannot
1623
 
        be streamed by a smart server.  This method finds missing inventory
1624
 
        parents for revisions added in this write group.
1625
 
        """
1626
 
        if not self._format.supports_external_lookups:
1627
 
            # This is only an issue for stacked repositories
1628
 
            return set()
1629
 
        if not self.is_in_write_group():
1630
 
            raise AssertionError('not in a write group')
1631
 
 
1632
 
        # XXX: We assume that every added revision already has its
1633
 
        # corresponding inventory, so we only check for parent inventories that
1634
 
        # might be missing, rather than all inventories.
1635
 
        parents = set(self.revisions._index.get_missing_parents())
1636
 
        parents.discard(_mod_revision.NULL_REVISION)
1637
 
        unstacked_inventories = self.inventories._index
1638
 
        present_inventories = unstacked_inventories.get_parent_map(
1639
 
            key[-1:] for key in parents)
1640
 
        parents.difference_update(present_inventories)
1641
 
        if len(parents) == 0:
1642
 
            # No missing parent inventories.
1643
 
            return set()
1644
 
        if not check_for_missing_texts:
1645
 
            return set(('inventories', rev_id) for (rev_id,) in parents)
1646
 
        # Ok, now we have a list of missing inventories.  But these only matter
1647
 
        # if the inventories that reference them are missing some texts they
1648
 
        # appear to introduce.
1649
 
        # XXX: Texts referenced by all added inventories need to be present,
1650
 
        # but at the moment we're only checking for texts referenced by
1651
 
        # inventories at the graph's edge.
1652
 
        key_deps = self.revisions._index._key_dependencies
1653
 
        key_deps.satisfy_refs_for_keys(present_inventories)
1654
 
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1655
 
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1656
 
        missing_texts = set()
1657
 
        for file_id, version_ids in file_ids.iteritems():
1658
 
            missing_texts.update(
1659
 
                (file_id, version_id) for version_id in version_ids)
1660
 
        present_texts = self.texts.get_parent_map(missing_texts)
1661
 
        missing_texts.difference_update(present_texts)
1662
 
        if not missing_texts:
1663
 
            # No texts are missing, so all revisions and their deltas are
1664
 
            # reconstructable.
1665
 
            return set()
1666
 
        # Alternatively the text versions could be returned as the missing
1667
 
        # keys, but this is likely to be less data.
1668
 
        missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
1669
 
        return missing_keys
1670
 
 
1671
1427
    def refresh_data(self):
1672
 
        """Re-read any data needed to synchronise with disk.
 
1428
        """Re-read any data needed to to synchronise with disk.
1673
1429
 
1674
1430
        This method is intended to be called after another repository instance
1675
1431
        (such as one used by a smart server) has inserted data into the
1676
 
        repository. On all repositories this will work outside of write groups.
1677
 
        Some repository formats (pack and newer for bzrlib native formats)
1678
 
        support refresh_data inside write groups. If called inside a write
1679
 
        group on a repository that does not support refreshing in a write group
1680
 
        IsInWriteGroupError will be raised.
 
1432
        repository. It may not be called during a write group, but may be
 
1433
        called at any other time.
1681
1434
        """
 
1435
        if self.is_in_write_group():
 
1436
            raise errors.InternalBzrError(
 
1437
                "May not refresh_data while in a write group.")
1682
1438
        self._refresh_data()
1683
1439
 
1684
1440
    def resume_write_group(self, tokens):
1722
1478
            raise errors.InternalBzrError(
1723
1479
                "May not fetch while in a write group.")
1724
1480
        # fast path same-url fetch operations
1725
 
        # TODO: lift out to somewhere common with RemoteRepository
1726
 
        # <https://bugs.launchpad.net/bzr/+bug/401646>
1727
 
        if (self.has_same_location(source)
1728
 
            and fetch_spec is None
1729
 
            and self._has_same_fallbacks(source)):
 
1481
        if self.has_same_location(source) and fetch_spec is None:
1730
1482
            # check that last_revision is in 'from' and then return a
1731
1483
            # no-operation.
1732
1484
            if (revision_id is not None and
1757
1509
        :param revprops: Optional dictionary of revision properties.
1758
1510
        :param revision_id: Optional revision id.
1759
1511
        """
1760
 
        if self._fallback_repositories:
1761
 
            raise errors.BzrError("Cannot commit from a lightweight checkout "
1762
 
                "to a stacked branch. See "
1763
 
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1764
1512
        result = self._commit_builder_class(self, parents, config,
1765
1513
            timestamp, timezone, committer, revprops, revision_id)
1766
1514
        self.start_write_group()
1767
1515
        return result
1768
1516
 
1769
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1770
1517
    def unlock(self):
1771
1518
        if (self.control_files._lock_count == 1 and
1772
1519
            self.control_files._lock_mode == 'w'):
1778
1525
        self.control_files.unlock()
1779
1526
        if self.control_files._lock_count == 0:
1780
1527
            self._inventory_entry_cache.clear()
1781
 
            for repo in self._fallback_repositories:
1782
 
                repo.unlock()
 
1528
        for repo in self._fallback_repositories:
 
1529
            repo.unlock()
1783
1530
 
1784
1531
    @needs_read_lock
1785
1532
    def clone(self, a_bzrdir, revision_id=None):
1894
1641
 
1895
1642
    @needs_read_lock
1896
1643
    def get_revisions(self, revision_ids):
1897
 
        """Get many revisions at once.
1898
 
        
1899
 
        Repositories that need to check data on every revision read should 
1900
 
        subclass this method.
1901
 
        """
 
1644
        """Get many revisions at once."""
1902
1645
        return self._get_revisions(revision_ids)
1903
1646
 
1904
1647
    @needs_read_lock
1905
1648
    def _get_revisions(self, revision_ids):
1906
1649
        """Core work logic to get many revisions without sanity checks."""
 
1650
        for rev_id in revision_ids:
 
1651
            if not rev_id or not isinstance(rev_id, basestring):
 
1652
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1653
        keys = [(key,) for key in revision_ids]
 
1654
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1907
1655
        revs = {}
1908
 
        for revid, rev in self._iter_revisions(revision_ids):
1909
 
            if rev is None:
1910
 
                raise errors.NoSuchRevision(self, revid)
1911
 
            revs[revid] = rev
 
1656
        for record in stream:
 
1657
            if record.storage_kind == 'absent':
 
1658
                raise errors.NoSuchRevision(self, record.key[0])
 
1659
            text = record.get_bytes_as('fulltext')
 
1660
            rev = self._serializer.read_revision_from_string(text)
 
1661
            revs[record.key[0]] = rev
1912
1662
        return [revs[revid] for revid in revision_ids]
1913
1663
 
1914
 
    def _iter_revisions(self, revision_ids):
1915
 
        """Iterate over revision objects.
1916
 
 
1917
 
        :param revision_ids: An iterable of revisions to examine. None may be
1918
 
            passed to request all revisions known to the repository. Note that
1919
 
            not all repositories can find unreferenced revisions; for those
1920
 
            repositories only referenced ones will be returned.
1921
 
        :return: An iterator of (revid, revision) tuples. Absent revisions (
1922
 
            those asked for but not available) are returned as (revid, None).
1923
 
        """
1924
 
        if revision_ids is None:
1925
 
            revision_ids = self.all_revision_ids()
1926
 
        else:
1927
 
            for rev_id in revision_ids:
1928
 
                if not rev_id or not isinstance(rev_id, basestring):
1929
 
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1930
 
        keys = [(key,) for key in revision_ids]
1931
 
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1932
 
        for record in stream:
1933
 
            revid = record.key[0]
1934
 
            if record.storage_kind == 'absent':
1935
 
                yield (revid, None)
1936
 
            else:
1937
 
                text = record.get_bytes_as('fulltext')
1938
 
                rev = self._serializer.read_revision_from_string(text)
1939
 
                yield (revid, rev)
 
1664
    @needs_read_lock
 
1665
    def get_revision_xml(self, revision_id):
 
1666
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1667
        #       would have already do it.
 
1668
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1669
        # TODO: this can't just be replaced by:
 
1670
        # return self._serializer.write_revision_to_string(
 
1671
        #     self.get_revision(revision_id))
 
1672
        # as cStringIO preservers the encoding unlike write_revision_to_string
 
1673
        # or some other call down the path.
 
1674
        rev = self.get_revision(revision_id)
 
1675
        rev_tmp = cStringIO.StringIO()
 
1676
        # the current serializer..
 
1677
        self._serializer.write_revision(rev, rev_tmp)
 
1678
        rev_tmp.seek(0)
 
1679
        return rev_tmp.getvalue()
1940
1680
 
1941
1681
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1942
1682
        """Produce a generator of revision deltas.
2120
1860
                    yield line, revid
2121
1861
 
2122
1862
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
2123
 
        revision_keys):
 
1863
        revision_ids):
2124
1864
        """Helper routine for fileids_altered_by_revision_ids.
2125
1865
 
2126
1866
        This performs the translation of xml lines to revision ids.
2127
1867
 
2128
1868
        :param line_iterator: An iterator of lines, origin_version_id
2129
 
        :param revision_keys: The revision ids to filter for. This should be a
 
1869
        :param revision_ids: The revision ids to filter for. This should be a
2130
1870
            set or other type which supports efficient __contains__ lookups, as
2131
 
            the revision key from each parsed line will be looked up in the
2132
 
            revision_keys filter.
 
1871
            the revision id from each parsed line will be looked up in the
 
1872
            revision_ids filter.
2133
1873
        :return: a dictionary mapping altered file-ids to an iterable of
2134
1874
        revision_ids. Each altered file-ids has the exact revision_ids that
2135
1875
        altered it listed explicitly.
2136
1876
        """
2137
1877
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
2138
1878
                line_iterator).iterkeys())
2139
 
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
 
1879
        # Note that revision_ids are revision keys.
 
1880
        parent_maps = self.revisions.get_parent_map(revision_ids)
 
1881
        parents = set()
 
1882
        map(parents.update, parent_maps.itervalues())
 
1883
        parents.difference_update(revision_ids)
2140
1884
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
2141
 
            self._inventory_xml_lines_for_keys(parent_keys)))
 
1885
            self._inventory_xml_lines_for_keys(parents)))
2142
1886
        new_keys = seen - parent_seen
2143
1887
        result = {}
2144
1888
        setdefault = result.setdefault
2146
1890
            setdefault(key[0], set()).add(key[-1])
2147
1891
        return result
2148
1892
 
2149
 
    def _find_parent_ids_of_revisions(self, revision_ids):
2150
 
        """Find all parent ids that are mentioned in the revision graph.
2151
 
 
2152
 
        :return: set of revisions that are parents of revision_ids which are
2153
 
            not part of revision_ids themselves
2154
 
        """
2155
 
        parent_map = self.get_parent_map(revision_ids)
2156
 
        parent_ids = set()
2157
 
        map(parent_ids.update, parent_map.itervalues())
2158
 
        parent_ids.difference_update(revision_ids)
2159
 
        parent_ids.discard(_mod_revision.NULL_REVISION)
2160
 
        return parent_ids
2161
 
 
2162
 
    def _find_parent_keys_of_revisions(self, revision_keys):
2163
 
        """Similar to _find_parent_ids_of_revisions, but used with keys.
2164
 
 
2165
 
        :param revision_keys: An iterable of revision_keys.
2166
 
        :return: The parents of all revision_keys that are not already in
2167
 
            revision_keys
2168
 
        """
2169
 
        parent_map = self.revisions.get_parent_map(revision_keys)
2170
 
        parent_keys = set()
2171
 
        map(parent_keys.update, parent_map.itervalues())
2172
 
        parent_keys.difference_update(revision_keys)
2173
 
        parent_keys.discard(_mod_revision.NULL_REVISION)
2174
 
        return parent_keys
2175
 
 
2176
1893
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
2177
1894
        """Find the file ids and versions affected by revisions.
2178
1895
 
2185
1902
        """
2186
1903
        selected_keys = set((revid,) for revid in revision_ids)
2187
1904
        w = _inv_weave or self.inventories
2188
 
        return self._find_file_ids_from_xml_inventory_lines(
2189
 
            w.iter_lines_added_or_present_in_keys(
2190
 
                selected_keys, pb=None),
2191
 
            selected_keys)
 
1905
        pb = ui.ui_factory.nested_progress_bar()
 
1906
        try:
 
1907
            return self._find_file_ids_from_xml_inventory_lines(
 
1908
                w.iter_lines_added_or_present_in_keys(
 
1909
                    selected_keys, pb=pb),
 
1910
                selected_keys)
 
1911
        finally:
 
1912
            pb.finished()
2192
1913
 
2193
1914
    def iter_files_bytes(self, desired_files):
2194
1915
        """Iterate through file versions.
2276
1997
                batch_size]
2277
1998
            if not to_query:
2278
1999
                break
2279
 
            for revision_id in to_query:
 
2000
            for rev_tree in self.revision_trees(to_query):
 
2001
                revision_id = rev_tree.get_revision_id()
2280
2002
                parent_ids = ancestors[revision_id]
2281
2003
                for text_key in revision_keys[revision_id]:
2282
2004
                    pb.update("Calculating text parents", processed_texts)
2355
2077
        num_file_ids = len(file_ids)
2356
2078
        for file_id, altered_versions in file_ids.iteritems():
2357
2079
            if pb is not None:
2358
 
                pb.update("Fetch texts", count, num_file_ids)
 
2080
                pb.update("fetch texts", count, num_file_ids)
2359
2081
            count += 1
2360
2082
            yield ("file", file_id, altered_versions)
2361
2083
 
2382
2104
        """Get Inventory object by revision id."""
2383
2105
        return self.iter_inventories([revision_id]).next()
2384
2106
 
2385
 
    def iter_inventories(self, revision_ids, ordering=None):
 
2107
    def iter_inventories(self, revision_ids):
2386
2108
        """Get many inventories by revision_ids.
2387
2109
 
2388
2110
        This will buffer some or all of the texts used in constructing the
2390
2112
        time.
2391
2113
 
2392
2114
        :param revision_ids: The expected revision ids of the inventories.
2393
 
        :param ordering: optional ordering, e.g. 'topological'.  If not
2394
 
            specified, the order of revision_ids will be preserved (by
2395
 
            buffering if necessary).
2396
2115
        :return: An iterator of inventories.
2397
2116
        """
2398
2117
        if ((None in revision_ids)
2399
2118
            or (_mod_revision.NULL_REVISION in revision_ids)):
2400
2119
            raise ValueError('cannot get null revision inventory')
2401
 
        return self._iter_inventories(revision_ids, ordering)
 
2120
        return self._iter_inventories(revision_ids)
2402
2121
 
2403
 
    def _iter_inventories(self, revision_ids, ordering):
 
2122
    def _iter_inventories(self, revision_ids):
2404
2123
        """single-document based inventory iteration."""
2405
 
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2406
 
        for text, revision_id in inv_xmls:
2407
 
            yield self._deserialise_inventory(revision_id, text)
 
2124
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
 
2125
            yield self.deserialise_inventory(revision_id, text)
2408
2126
 
2409
 
    def _iter_inventory_xmls(self, revision_ids, ordering):
2410
 
        if ordering is None:
2411
 
            order_as_requested = True
2412
 
            ordering = 'unordered'
2413
 
        else:
2414
 
            order_as_requested = False
 
2127
    def _iter_inventory_xmls(self, revision_ids):
2415
2128
        keys = [(revision_id,) for revision_id in revision_ids]
2416
 
        if not keys:
2417
 
            return
2418
 
        if order_as_requested:
2419
 
            key_iter = iter(keys)
2420
 
            next_key = key_iter.next()
2421
 
        stream = self.inventories.get_record_stream(keys, ordering, True)
 
2129
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2422
2130
        text_chunks = {}
2423
2131
        for record in stream:
2424
2132
            if record.storage_kind != 'absent':
2425
 
                chunks = record.get_bytes_as('chunked')
2426
 
                if order_as_requested:
2427
 
                    text_chunks[record.key] = chunks
2428
 
                else:
2429
 
                    yield ''.join(chunks), record.key[-1]
 
2133
                text_chunks[record.key] = record.get_bytes_as('chunked')
2430
2134
            else:
2431
2135
                raise errors.NoSuchRevision(self, record.key)
2432
 
            if order_as_requested:
2433
 
                # Yield as many results as we can while preserving order.
2434
 
                while next_key in text_chunks:
2435
 
                    chunks = text_chunks.pop(next_key)
2436
 
                    yield ''.join(chunks), next_key[-1]
2437
 
                    try:
2438
 
                        next_key = key_iter.next()
2439
 
                    except StopIteration:
2440
 
                        # We still want to fully consume the get_record_stream,
2441
 
                        # just in case it is not actually finished at this point
2442
 
                        next_key = None
2443
 
                        break
 
2136
        for key in keys:
 
2137
            chunks = text_chunks.pop(key)
 
2138
            yield ''.join(chunks), key[-1]
2444
2139
 
2445
 
    def _deserialise_inventory(self, revision_id, xml):
 
2140
    def deserialise_inventory(self, revision_id, xml):
2446
2141
        """Transform the xml into an inventory object.
2447
2142
 
2448
2143
        :param revision_id: The expected revision id of the inventory.
2449
2144
        :param xml: A serialised inventory.
2450
2145
        """
2451
2146
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2452
 
                    entry_cache=self._inventory_entry_cache,
2453
 
                    return_from_cache=self._safe_to_return_from_cache)
 
2147
                    entry_cache=self._inventory_entry_cache)
2454
2148
        if result.revision_id != revision_id:
2455
2149
            raise AssertionError('revision id mismatch %s != %s' % (
2456
2150
                result.revision_id, revision_id))
2457
2151
        return result
2458
2152
 
 
2153
    def serialise_inventory(self, inv):
 
2154
        return self._serializer.write_inventory_to_string(inv)
 
2155
 
 
2156
    def _serialise_inventory_to_lines(self, inv):
 
2157
        return self._serializer.write_inventory_to_lines(inv)
 
2158
 
2459
2159
    def get_serializer_format(self):
2460
2160
        return self._serializer.format_num
2461
2161
 
2462
2162
    @needs_read_lock
2463
 
    def _get_inventory_xml(self, revision_id):
2464
 
        """Get serialized inventory as a string."""
2465
 
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
 
2163
    def get_inventory_xml(self, revision_id):
 
2164
        """Get inventory XML as a file object."""
 
2165
        texts = self._iter_inventory_xmls([revision_id])
2466
2166
        try:
2467
2167
            text, revision_id = texts.next()
2468
2168
        except StopIteration:
2469
2169
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2470
2170
        return text
2471
2171
 
2472
 
    def get_rev_id_for_revno(self, revno, known_pair):
2473
 
        """Return the revision id of a revno, given a later (revno, revid)
2474
 
        pair in the same history.
2475
 
 
2476
 
        :return: if found (True, revid).  If the available history ran out
2477
 
            before reaching the revno, then this returns
2478
 
            (False, (closest_revno, closest_revid)).
 
2172
    @needs_read_lock
 
2173
    def get_inventory_sha1(self, revision_id):
 
2174
        """Return the sha1 hash of the inventory entry
2479
2175
        """
2480
 
        known_revno, known_revid = known_pair
2481
 
        partial_history = [known_revid]
2482
 
        distance_from_known = known_revno - revno
2483
 
        if distance_from_known < 0:
2484
 
            raise ValueError(
2485
 
                'requested revno (%d) is later than given known revno (%d)'
2486
 
                % (revno, known_revno))
2487
 
        try:
2488
 
            _iter_for_revno(
2489
 
                self, partial_history, stop_index=distance_from_known)
2490
 
        except errors.RevisionNotPresent, err:
2491
 
            if err.revision_id == known_revid:
2492
 
                # The start revision (known_revid) wasn't found.
2493
 
                raise
2494
 
            # This is a stacked repository with no fallbacks, or a there's a
2495
 
            # left-hand ghost.  Either way, even though the revision named in
2496
 
            # the error isn't in this repo, we know it's the next step in this
2497
 
            # left-hand history.
2498
 
            partial_history.append(err.revision_id)
2499
 
        if len(partial_history) <= distance_from_known:
2500
 
            # Didn't find enough history to get a revid for the revno.
2501
 
            earliest_revno = known_revno - len(partial_history) + 1
2502
 
            return (False, (earliest_revno, partial_history[-1]))
2503
 
        if len(partial_history) - 1 > distance_from_known:
2504
 
            raise AssertionError('_iter_for_revno returned too much history')
2505
 
        return (True, partial_history[-1])
 
2176
        return self.get_revision(revision_id).inventory_sha1
2506
2177
 
2507
2178
    def iter_reverse_revision_history(self, revision_id):
2508
2179
        """Iterate backwards through revision ids in the lefthand history
2515
2186
        while True:
2516
2187
            if next_id in (None, _mod_revision.NULL_REVISION):
2517
2188
                return
2518
 
            try:
2519
 
                parents = graph.get_parent_map([next_id])[next_id]
2520
 
            except KeyError:
2521
 
                raise errors.RevisionNotPresent(next_id, self)
2522
2189
            yield next_id
 
2190
            # Note: The following line may raise KeyError in the event of
 
2191
            # truncated history. We decided not to have a try:except:raise
 
2192
            # RevisionNotPresent here until we see a use for it, because of the
 
2193
            # cost in an inner loop that is by its very nature O(history).
 
2194
            # Robert Collins 20080326
 
2195
            parents = graph.get_parent_map([next_id])[next_id]
2523
2196
            if len(parents) == 0:
2524
2197
                return
2525
2198
            else:
2526
2199
                next_id = parents[0]
2527
2200
 
 
2201
    @needs_read_lock
 
2202
    def get_revision_inventory(self, revision_id):
 
2203
        """Return inventory of a past revision."""
 
2204
        # TODO: Unify this with get_inventory()
 
2205
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
2206
        # must be the same as its revision, so this is trivial.
 
2207
        if revision_id is None:
 
2208
            # This does not make sense: if there is no revision,
 
2209
            # then it is the current tree inventory surely ?!
 
2210
            # and thus get_root_id() is something that looks at the last
 
2211
            # commit on the branch, and the get_root_id is an inventory check.
 
2212
            raise NotImplementedError
 
2213
            # return Inventory(self.get_root_id())
 
2214
        else:
 
2215
            return self.get_inventory(revision_id)
 
2216
 
2528
2217
    def is_shared(self):
2529
2218
        """Return True if this repository is flagged as a shared repository."""
2530
2219
        raise NotImplementedError(self.is_shared)
2564
2253
            return RevisionTree(self, Inventory(root_id=None),
2565
2254
                                _mod_revision.NULL_REVISION)
2566
2255
        else:
2567
 
            inv = self.get_inventory(revision_id)
 
2256
            inv = self.get_revision_inventory(revision_id)
2568
2257
            return RevisionTree(self, inv, revision_id)
2569
2258
 
2570
2259
    def revision_trees(self, revision_ids):
2623
2312
            keys = tsort.topo_sort(parent_map)
2624
2313
        return [None] + list(keys)
2625
2314
 
2626
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
2315
    def pack(self):
2627
2316
        """Compress the data within the repository.
2628
2317
 
2629
2318
        This operation only makes sense for some repository types. For other
2632
2321
        This stub method does not require a lock, but subclasses should use
2633
2322
        @needs_write_lock as this is a long running call its reasonable to
2634
2323
        implicitly lock for the user.
2635
 
 
2636
 
        :param hint: If not supplied, the whole repository is packed.
2637
 
            If supplied, the repository may use the hint parameter as a
2638
 
            hint for the parts of the repository to pack. A hint can be
2639
 
            obtained from the result of commit_write_group(). Out of
2640
 
            date hints are simply ignored, because concurrent operations
2641
 
            can obsolete them rapidly.
2642
 
 
2643
 
        :param clean_obsolete_packs: Clean obsolete packs immediately after
2644
 
            the pack operation.
2645
2324
        """
2646
2325
 
2647
2326
    def get_transaction(self):
2648
2327
        return self.control_files.get_transaction()
2649
2328
 
2650
2329
    def get_parent_map(self, revision_ids):
2651
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
2330
        """See graph._StackedParentsProvider.get_parent_map"""
2652
2331
        # revisions index works in keys; this just works in revisions
2653
2332
        # therefore wrap and unwrap
2654
2333
        query_keys = []
2663
2342
        for ((revision_id,), parent_keys) in \
2664
2343
                self.revisions.get_parent_map(query_keys).iteritems():
2665
2344
            if parent_keys:
2666
 
                result[revision_id] = tuple([parent_revid
2667
 
                    for (parent_revid,) in parent_keys])
 
2345
                result[revision_id] = tuple(parent_revid
 
2346
                    for (parent_revid,) in parent_keys)
2668
2347
            else:
2669
2348
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2670
2349
        return result
2672
2351
    def _make_parents_provider(self):
2673
2352
        return self
2674
2353
 
2675
 
    @needs_read_lock
2676
 
    def get_known_graph_ancestry(self, revision_ids):
2677
 
        """Return the known graph for a set of revision ids and their ancestors.
2678
 
        """
2679
 
        st = static_tuple.StaticTuple
2680
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
2681
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
2682
 
        return graph.GraphThunkIdsToKeys(known_graph)
2683
 
 
2684
2354
    def get_graph(self, other_repository=None):
2685
2355
        """Return the graph walker for this repository format"""
2686
2356
        parents_provider = self._make_parents_provider()
2687
2357
        if (other_repository is not None and
2688
2358
            not self.has_same_location(other_repository)):
2689
 
            parents_provider = graph.StackedParentsProvider(
 
2359
            parents_provider = graph._StackedParentsProvider(
2690
2360
                [parents_provider, other_repository._make_parents_provider()])
2691
2361
        return graph.Graph(parents_provider)
2692
2362
 
2693
 
    def _get_versioned_file_checker(self, text_key_references=None,
2694
 
        ancestors=None):
 
2363
    def _get_versioned_file_checker(self, text_key_references=None):
2695
2364
        """Return an object suitable for checking versioned files.
2696
2365
        
2697
2366
        :param text_key_references: if non-None, an already built
2699
2368
            to whether they were referred to by the inventory of the
2700
2369
            revision_id that they contain. If None, this will be
2701
2370
            calculated.
2702
 
        :param ancestors: Optional result from
2703
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2704
 
            available.
2705
2371
        """
2706
2372
        return _VersionedFileChecker(self,
2707
 
            text_key_references=text_key_references, ancestors=ancestors)
 
2373
            text_key_references=text_key_references)
2708
2374
 
2709
2375
    def revision_ids_to_search_result(self, result_set):
2710
2376
        """Convert a set of revision ids to a graph SearchResult."""
2760
2426
        return record.get_bytes_as('fulltext')
2761
2427
 
2762
2428
    @needs_read_lock
2763
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
2429
    def check(self, revision_ids=None):
2764
2430
        """Check consistency of all history of given revision_ids.
2765
2431
 
2766
2432
        Different repository implementations should override _check().
2767
2433
 
2768
2434
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2769
2435
             will be checked.  Typically the last revision_id of a branch.
2770
 
        :param callback_refs: A dict of check-refs to resolve and callback
2771
 
            the check/_check method on the items listed as wanting the ref.
2772
 
            see bzrlib.check.
2773
 
        :param check_repo: If False do not check the repository contents, just 
2774
 
            calculate the data callback_refs requires and call them back.
2775
2436
        """
2776
 
        return self._check(revision_ids, callback_refs=callback_refs,
2777
 
            check_repo=check_repo)
 
2437
        return self._check(revision_ids)
2778
2438
 
2779
 
    def _check(self, revision_ids, callback_refs, check_repo):
2780
 
        result = check.Check(self, check_repo=check_repo)
2781
 
        result.check(callback_refs)
 
2439
    def _check(self, revision_ids):
 
2440
        result = check.Check(self)
 
2441
        result.check()
2782
2442
        return result
2783
2443
 
2784
 
    def _warn_if_deprecated(self, branch=None):
 
2444
    def _warn_if_deprecated(self):
2785
2445
        global _deprecation_warning_done
2786
2446
        if _deprecation_warning_done:
2787
2447
            return
2788
 
        try:
2789
 
            if branch is None:
2790
 
                conf = config.GlobalConfig()
2791
 
            else:
2792
 
                conf = branch.get_config()
2793
 
            if conf.suppress_warning('format_deprecation'):
2794
 
                return
2795
 
            warning("Format %s for %s is deprecated -"
2796
 
                    " please use 'bzr upgrade' to get better performance"
2797
 
                    % (self._format, self.bzrdir.transport.base))
2798
 
        finally:
2799
 
            _deprecation_warning_done = True
 
2448
        _deprecation_warning_done = True
 
2449
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
2450
                % (self._format, self.bzrdir.transport.base))
2800
2451
 
2801
2452
    def supports_rich_root(self):
2802
2453
        return self._format.rich_root_data
3078
2729
    # Does this format have < O(tree_size) delta generation. Used to hint what
3079
2730
    # code path for commit, amongst other things.
3080
2731
    fast_deltas = None
3081
 
    # Does doing a pack operation compress data? Useful for the pack UI command
3082
 
    # (so if there is one pack, the operation can still proceed because it may
3083
 
    # help), and for fetching when data won't have come from the same
3084
 
    # compressor.
3085
 
    pack_compresses = False
3086
 
    # Does the repository inventory storage understand references to trees?
3087
 
    supports_tree_reference = None
3088
 
    # Is the format experimental ?
3089
 
    experimental = False
3090
2732
 
3091
 
    def __repr__(self):
3092
 
        return "%s()" % self.__class__.__name__
 
2733
    def __str__(self):
 
2734
        return "<%s>" % self.__class__.__name__
3093
2735
 
3094
2736
    def __eq__(self, other):
3095
2737
        # format objects are generally stateless
3108
2750
        """
3109
2751
        try:
3110
2752
            transport = a_bzrdir.get_repository_transport(None)
3111
 
            format_string = transport.get_bytes("format")
 
2753
            format_string = transport.get("format").read()
3112
2754
            return format_registry.get(format_string)
3113
2755
        except errors.NoSuchFile:
3114
2756
            raise errors.NoRepositoryPresent(a_bzrdir)
3196
2838
        raise NotImplementedError(self.network_name)
3197
2839
 
3198
2840
    def check_conversion_target(self, target_format):
3199
 
        if self.rich_root_data and not target_format.rich_root_data:
3200
 
            raise errors.BadConversionTarget(
3201
 
                'Does not support rich root data.', target_format,
3202
 
                from_format=self)
3203
 
        if (self.supports_tree_reference and 
3204
 
            not getattr(target_format, 'supports_tree_reference', False)):
3205
 
            raise errors.BadConversionTarget(
3206
 
                'Does not support nested trees', target_format,
3207
 
                from_format=self)
 
2841
        raise NotImplementedError(self.check_conversion_target)
3208
2842
 
3209
2843
    def open(self, a_bzrdir, _found=False):
3210
2844
        """Return an instance of this format for the bzrdir a_bzrdir.
3213
2847
        """
3214
2848
        raise NotImplementedError(self.open)
3215
2849
 
3216
 
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
3217
 
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
3218
 
        hooks = BzrDir.hooks['post_repo_init']
3219
 
        if not hooks:
3220
 
            return
3221
 
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
3222
 
        for hook in hooks:
3223
 
            hook(params)
3224
 
 
3225
2850
 
3226
2851
class MetaDirRepositoryFormat(RepositoryFormat):
3227
2852
    """Common base class for the new repositories using the metadir layout."""
3378
3003
    'RepositoryFormatCHK1',
3379
3004
    )
3380
3005
 
3381
 
format_registry.register_lazy(
3382
 
    'Bazaar development format - chk repository with bencode revision '
3383
 
        'serialization (needs bzr.dev from 1.16)\n',
3384
 
    'bzrlib.repofmt.groupcompress_repo',
3385
 
    'RepositoryFormatCHK2',
3386
 
    )
3387
 
format_registry.register_lazy(
3388
 
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
3389
 
    'bzrlib.repofmt.groupcompress_repo',
3390
 
    'RepositoryFormat2a',
3391
 
    )
3392
 
 
3393
3006
 
3394
3007
class InterRepository(InterObject):
3395
3008
    """This class represents operations taking place between two repositories.
3432
3045
 
3433
3046
        :param revision_id: if None all content is copied, if NULL_REVISION no
3434
3047
                            content is copied.
3435
 
        :param pb: ignored.
 
3048
        :param pb: optional progress bar to use for progress reports. If not
 
3049
                   provided a default one will be created.
3436
3050
        :return: None.
3437
3051
        """
3438
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3439
3052
        from bzrlib.fetch import RepoFetcher
3440
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
3441
 
        if self.source._format.network_name() != self.target._format.network_name():
3442
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
3443
 
                from_format=self.source._format,
3444
 
                to_format=self.target._format)
3445
3053
        f = RepoFetcher(to_repository=self.target,
3446
3054
                               from_repository=self.source,
3447
3055
                               last_revision=revision_id,
3448
3056
                               fetch_spec=fetch_spec,
3449
 
                               find_ghosts=find_ghosts)
 
3057
                               pb=pb, find_ghosts=find_ghosts)
3450
3058
 
3451
3059
    def _walk_to_common_revisions(self, revision_ids):
3452
3060
        """Walk out from revision_ids in source to revisions target has.
3456
3064
        """
3457
3065
        target_graph = self.target.get_graph()
3458
3066
        revision_ids = frozenset(revision_ids)
 
3067
        # Fast path for the case where all the revisions are already in the
 
3068
        # target repo.
 
3069
        # (Although this does incur an extra round trip for the
 
3070
        # fairly common case where the target doesn't already have the revision
 
3071
        # we're pushing.)
 
3072
        if set(target_graph.get_parent_map(revision_ids)) == revision_ids:
 
3073
            return graph.SearchResult(revision_ids, set(), 0, set())
3459
3074
        missing_revs = set()
3460
3075
        source_graph = self.source.get_graph()
3461
3076
        # ensure we don't pay silly lookup costs.
3621
3236
                self.target.texts.insert_record_stream(
3622
3237
                    self.source.texts.get_record_stream(
3623
3238
                        self.source.texts.keys(), 'topological', False))
3624
 
                pb.update('Copying inventory', 0, 1)
 
3239
                pb.update('copying inventory', 0, 1)
3625
3240
                self.target.inventories.insert_record_stream(
3626
3241
                    self.source.inventories.get_record_stream(
3627
3242
                        self.source.inventories.keys(), 'topological', False))
3741
3356
        return self.source.revision_ids_to_search_result(result_set)
3742
3357
 
3743
3358
 
 
3359
class InterPackRepo(InterSameDataRepository):
 
3360
    """Optimised code paths between Pack based repositories."""
 
3361
 
 
3362
    @classmethod
 
3363
    def _get_repo_format_to_test(self):
 
3364
        from bzrlib.repofmt import pack_repo
 
3365
        return pack_repo.RepositoryFormatKnitPack6RichRoot()
 
3366
 
 
3367
    @staticmethod
 
3368
    def is_compatible(source, target):
 
3369
        """Be compatible with known Pack formats.
 
3370
 
 
3371
        We don't test for the stores being of specific types because that
 
3372
        could lead to confusing results, and there is no need to be
 
3373
        overly general.
 
3374
 
 
3375
        InterPackRepo does not support CHK based repositories.
 
3376
        """
 
3377
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
3378
        from bzrlib.repofmt.groupcompress_repo import RepositoryFormatCHK1
 
3379
        try:
 
3380
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
3381
                isinstance(target._format, RepositoryFormatPack))
 
3382
            not_packs = (isinstance(source._format, RepositoryFormatCHK1) or
 
3383
                isinstance(target._format, RepositoryFormatCHK1))
 
3384
        except AttributeError:
 
3385
            return False
 
3386
        if not_packs or not are_packs:
 
3387
            return False
 
3388
        return InterRepository._same_model(source, target)
 
3389
 
 
3390
    @needs_write_lock
 
3391
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
 
3392
            fetch_spec=None):
 
3393
        """See InterRepository.fetch()."""
 
3394
        if (len(self.source._fallback_repositories) > 0 or
 
3395
            len(self.target._fallback_repositories) > 0):
 
3396
            # The pack layer is not aware of fallback repositories, so when
 
3397
            # fetching from a stacked repository or into a stacked repository
 
3398
            # we use the generic fetch logic which uses the VersionedFiles
 
3399
            # attributes on repository.
 
3400
            from bzrlib.fetch import RepoFetcher
 
3401
            fetcher = RepoFetcher(self.target, self.source, revision_id,
 
3402
                    pb, find_ghosts, fetch_spec=fetch_spec)
 
3403
        if fetch_spec is not None:
 
3404
            if len(list(fetch_spec.heads)) != 1:
 
3405
                raise AssertionError(
 
3406
                    "InterPackRepo.fetch doesn't support "
 
3407
                    "fetching multiple heads yet.")
 
3408
            revision_id = list(fetch_spec.heads)[0]
 
3409
            fetch_spec = None
 
3410
        if revision_id is None:
 
3411
            # TODO:
 
3412
            # everything to do - use pack logic
 
3413
            # to fetch from all packs to one without
 
3414
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
3415
            # till then:
 
3416
            source_revision_ids = frozenset(self.source.all_revision_ids())
 
3417
            revision_ids = source_revision_ids - \
 
3418
                frozenset(self.target.get_parent_map(source_revision_ids))
 
3419
            revision_keys = [(revid,) for revid in revision_ids]
 
3420
            index = self.target._pack_collection.revision_index.combined_index
 
3421
            present_revision_ids = set(item[1][0] for item in
 
3422
                index.iter_entries(revision_keys))
 
3423
            revision_ids = set(revision_ids) - present_revision_ids
 
3424
            # implementing the TODO will involve:
 
3425
            # - detecting when all of a pack is selected
 
3426
            # - avoiding as much as possible pre-selection, so the
 
3427
            # more-core routines such as create_pack_from_packs can filter in
 
3428
            # a just-in-time fashion. (though having a HEADS list on a
 
3429
            # repository might make this a lot easier, because we could
 
3430
            # sensibly detect 'new revisions' without doing a full index scan.
 
3431
        elif _mod_revision.is_null(revision_id):
 
3432
            # nothing to do:
 
3433
            return (0, [])
 
3434
        else:
 
3435
            try:
 
3436
                revision_ids = self.search_missing_revision_ids(revision_id,
 
3437
                    find_ghosts=find_ghosts).get_keys()
 
3438
            except errors.NoSuchRevision:
 
3439
                raise errors.InstallFailed([revision_id])
 
3440
            if len(revision_ids) == 0:
 
3441
                return (0, [])
 
3442
        return self._pack(self.source, self.target, revision_ids)
 
3443
 
 
3444
    def _pack(self, source, target, revision_ids):
 
3445
        from bzrlib.repofmt.pack_repo import Packer
 
3446
        packs = source._pack_collection.all_packs()
 
3447
        pack = Packer(self.target._pack_collection, packs, '.fetch',
 
3448
            revision_ids).pack()
 
3449
        if pack is not None:
 
3450
            self.target._pack_collection._save_pack_names()
 
3451
            copied_revs = pack.get_revision_count()
 
3452
            # Trigger an autopack. This may duplicate effort as we've just done
 
3453
            # a pack creation, but for now it is simpler to think about as
 
3454
            # 'upload data, then repack if needed'.
 
3455
            self.target._pack_collection.autopack()
 
3456
            return (copied_revs, [])
 
3457
        else:
 
3458
            return (0, [])
 
3459
 
 
3460
    @needs_read_lock
 
3461
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
3462
        """See InterRepository.missing_revision_ids().
 
3463
 
 
3464
        :param find_ghosts: Find ghosts throughout the ancestry of
 
3465
            revision_id.
 
3466
        """
 
3467
        if not find_ghosts and revision_id is not None:
 
3468
            return self._walk_to_common_revisions([revision_id])
 
3469
        elif revision_id is not None:
 
3470
            # Find ghosts: search for revisions pointing from one repository to
 
3471
            # the other, and vice versa, anywhere in the history of revision_id.
 
3472
            graph = self.target.get_graph(other_repository=self.source)
 
3473
            searcher = graph._make_breadth_first_searcher([revision_id])
 
3474
            found_ids = set()
 
3475
            while True:
 
3476
                try:
 
3477
                    next_revs, ghosts = searcher.next_with_ghosts()
 
3478
                except StopIteration:
 
3479
                    break
 
3480
                if revision_id in ghosts:
 
3481
                    raise errors.NoSuchRevision(self.source, revision_id)
 
3482
                found_ids.update(next_revs)
 
3483
                found_ids.update(ghosts)
 
3484
            found_ids = frozenset(found_ids)
 
3485
            # Double query here: should be able to avoid this by changing the
 
3486
            # graph api further.
 
3487
            result_set = found_ids - frozenset(
 
3488
                self.target.get_parent_map(found_ids))
 
3489
        else:
 
3490
            source_ids = self.source.all_revision_ids()
 
3491
            # source_ids is the worst possible case we may need to pull.
 
3492
            # now we want to filter source_ids against what we actually
 
3493
            # have in target, but don't try to check for existence where we know
 
3494
            # we do not have a revision as that would be pointless.
 
3495
            target_ids = set(self.target.all_revision_ids())
 
3496
            result_set = set(source_ids).difference(target_ids)
 
3497
        return self.source.revision_ids_to_search_result(result_set)
 
3498
 
 
3499
 
3744
3500
class InterDifferingSerializer(InterRepository):
3745
3501
 
3746
3502
    @classmethod
3753
3509
        # This is redundant with format.check_conversion_target(), however that
3754
3510
        # raises an exception, and we just want to say "False" as in we won't
3755
3511
        # support converting between these formats.
3756
 
        if 'IDS_never' in debug.debug_flags:
3757
 
            return False
3758
3512
        if source.supports_rich_root() and not target.supports_rich_root():
3759
3513
            return False
3760
3514
        if (source._format.supports_tree_reference
3761
3515
            and not target._format.supports_tree_reference):
3762
3516
            return False
3763
 
        if target._fallback_repositories and target._format.supports_chks:
3764
 
            # IDS doesn't know how to copy CHKs for the parent inventories it
3765
 
            # adds to stacked repos.
3766
 
            return False
3767
 
        if 'IDS_always' in debug.debug_flags:
3768
 
            return True
3769
 
        # Only use this code path for local source and target.  IDS does far
3770
 
        # too much IO (both bandwidth and roundtrips) over a network.
3771
 
        if not source.bzrdir.transport.base.startswith('file:///'):
3772
 
            return False
3773
 
        if not target.bzrdir.transport.base.startswith('file:///'):
3774
 
            return False
3775
3517
        return True
3776
3518
 
3777
 
    def _get_trees(self, revision_ids, cache):
3778
 
        possible_trees = []
3779
 
        for rev_id in revision_ids:
3780
 
            if rev_id in cache:
3781
 
                possible_trees.append((rev_id, cache[rev_id]))
3782
 
            else:
3783
 
                # Not cached, but inventory might be present anyway.
3784
 
                try:
3785
 
                    tree = self.source.revision_tree(rev_id)
3786
 
                except errors.NoSuchRevision:
3787
 
                    # Nope, parent is ghost.
3788
 
                    pass
3789
 
                else:
3790
 
                    cache[rev_id] = tree
3791
 
                    possible_trees.append((rev_id, tree))
3792
 
        return possible_trees
3793
 
 
3794
 
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
 
3519
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
3795
3520
        """Get the best delta and base for this revision.
3796
3521
 
3797
3522
        :return: (basis_id, delta)
3798
3523
        """
 
3524
        possible_trees = [(parent_id, cache[parent_id])
 
3525
                          for parent_id in parent_ids
 
3526
                           if parent_id in cache]
 
3527
        if len(possible_trees) == 0:
 
3528
            # There either aren't any parents, or the parents aren't in the
 
3529
            # cache, so just use the last converted tree
 
3530
            possible_trees.append((basis_id, cache[basis_id]))
3799
3531
        deltas = []
3800
 
        # Generate deltas against each tree, to find the shortest.
3801
 
        texts_possibly_new_in_tree = set()
3802
3532
        for basis_id, basis_tree in possible_trees:
3803
3533
            delta = tree.inventory._make_delta(basis_tree.inventory)
3804
 
            for old_path, new_path, file_id, new_entry in delta:
3805
 
                if new_path is None:
3806
 
                    # This file_id isn't present in the new rev, so we don't
3807
 
                    # care about it.
3808
 
                    continue
3809
 
                if not new_path:
3810
 
                    # Rich roots are handled elsewhere...
3811
 
                    continue
3812
 
                kind = new_entry.kind
3813
 
                if kind != 'directory' and kind != 'file':
3814
 
                    # No text record associated with this inventory entry.
3815
 
                    continue
3816
 
                # This is a directory or file that has changed somehow.
3817
 
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3818
3534
            deltas.append((len(delta), basis_id, delta))
3819
3535
        deltas.sort()
3820
3536
        return deltas[0][1:]
3821
3537
 
3822
 
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
3823
 
        """Find all parent revisions that are absent, but for which the
3824
 
        inventory is present, and copy those inventories.
3825
 
 
3826
 
        This is necessary to preserve correctness when the source is stacked
3827
 
        without fallbacks configured.  (Note that in cases like upgrade the
3828
 
        source may be not have _fallback_repositories even though it is
3829
 
        stacked.)
3830
 
        """
3831
 
        parent_revs = set()
3832
 
        for parents in parent_map.values():
3833
 
            parent_revs.update(parents)
3834
 
        present_parents = self.source.get_parent_map(parent_revs)
3835
 
        absent_parents = set(parent_revs).difference(present_parents)
3836
 
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
3837
 
            (rev_id,) for rev_id in absent_parents)
3838
 
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
3839
 
        for parent_tree in self.source.revision_trees(parent_inv_ids):
3840
 
            current_revision_id = parent_tree.get_revision_id()
3841
 
            parents_parents_keys = parent_invs_keys_for_stacking[
3842
 
                (current_revision_id,)]
3843
 
            parents_parents = [key[-1] for key in parents_parents_keys]
3844
 
            basis_id = _mod_revision.NULL_REVISION
3845
 
            basis_tree = self.source.revision_tree(basis_id)
3846
 
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
3847
 
            self.target.add_inventory_by_delta(
3848
 
                basis_id, delta, current_revision_id, parents_parents)
3849
 
            cache[current_revision_id] = parent_tree
3850
 
 
3851
 
    def _fetch_batch(self, revision_ids, basis_id, cache, a_graph=None):
 
3538
    def _get_parent_keys(self, root_key, parent_map):
 
3539
        """Get the parent keys for a given root id."""
 
3540
        root_id, rev_id = root_key
 
3541
        # Include direct parents of the revision, but only if they used
 
3542
        # the same root_id.
 
3543
        parent_keys = []
 
3544
        for parent_id in parent_map[rev_id]:
 
3545
            if parent_id == _mod_revision.NULL_REVISION:
 
3546
                continue
 
3547
            if parent_id not in self._revision_id_to_root_id:
 
3548
                # We probably didn't read this revision, go spend the
 
3549
                # extra effort to actually check
 
3550
                try:
 
3551
                    tree = self.source.revision_tree(parent_id)
 
3552
                except errors.NoSuchRevision:
 
3553
                    # Ghost, fill out _revision_id_to_root_id in case we
 
3554
                    # encounter this again.
 
3555
                    # But set parent_root_id to None since we don't really know
 
3556
                    parent_root_id = None
 
3557
                else:
 
3558
                    parent_root_id = tree.get_root_id()
 
3559
                self._revision_id_to_root_id[parent_id] = None
 
3560
            else:
 
3561
                parent_root_id = self._revision_id_to_root_id[parent_id]
 
3562
            if root_id == parent_root_id or parent_root_id is None:
 
3563
                parent_keys.append((root_id, parent_id))
 
3564
        return tuple(parent_keys)
 
3565
 
 
3566
    def _new_root_data_stream(self, root_keys_to_create, parent_map):
 
3567
        for root_key in root_keys_to_create:
 
3568
            parent_keys = self._get_parent_keys(root_key, parent_map)
 
3569
            yield versionedfile.FulltextContentFactory(root_key,
 
3570
                parent_keys, None, '')
 
3571
 
 
3572
    def _fetch_batch(self, revision_ids, basis_id, cache):
3852
3573
        """Fetch across a few revisions.
3853
3574
 
3854
3575
        :param revision_ids: The revisions to copy
3855
3576
        :param basis_id: The revision_id of a tree that must be in cache, used
3856
3577
            as a basis for delta when no other base is available
3857
3578
        :param cache: A cache of RevisionTrees that we can use.
3858
 
        :param a_graph: A Graph object to determine the heads() of the
3859
 
            rich-root data stream.
3860
3579
        :return: The revision_id of the last converted tree. The RevisionTree
3861
3580
            for it will be in cache
3862
3581
        """
3868
3587
        pending_deltas = []
3869
3588
        pending_revisions = []
3870
3589
        parent_map = self.source.get_parent_map(revision_ids)
3871
 
        self._fetch_parent_invs_for_stacking(parent_map, cache)
3872
 
        self.source._safe_to_return_from_cache = True
3873
3590
        for tree in self.source.revision_trees(revision_ids):
3874
 
            # Find a inventory delta for this revision.
3875
 
            # Find text entries that need to be copied, too.
3876
3591
            current_revision_id = tree.get_revision_id()
3877
3592
            parent_ids = parent_map.get(current_revision_id, ())
3878
 
            parent_trees = self._get_trees(parent_ids, cache)
3879
 
            possible_trees = list(parent_trees)
3880
 
            if len(possible_trees) == 0:
3881
 
                # There either aren't any parents, or the parents are ghosts,
3882
 
                # so just use the last converted tree.
3883
 
                possible_trees.append((basis_id, cache[basis_id]))
3884
3593
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3885
 
                                                           possible_trees)
3886
 
            revision = self.source.get_revision(current_revision_id)
3887
 
            pending_deltas.append((basis_id, delta,
3888
 
                current_revision_id, revision.parent_ids))
 
3594
                                                           basis_id, cache)
3889
3595
            if self._converting_to_rich_root:
3890
3596
                self._revision_id_to_root_id[current_revision_id] = \
3891
3597
                    tree.get_root_id()
3892
 
            # Determine which texts are in present in this revision but not in
3893
 
            # any of the available parents.
3894
 
            texts_possibly_new_in_tree = set()
 
3598
            # Find text entries that need to be copied
3895
3599
            for old_path, new_path, file_id, entry in delta:
3896
 
                if new_path is None:
3897
 
                    # This file_id isn't present in the new rev
3898
 
                    continue
3899
 
                if not new_path:
3900
 
                    # This is the root
3901
 
                    if not self.target.supports_rich_root():
3902
 
                        # The target doesn't support rich root, so we don't
3903
 
                        # copy
3904
 
                        continue
3905
 
                    if self._converting_to_rich_root:
3906
 
                        # This can't be copied normally, we have to insert
3907
 
                        # it specially
3908
 
                        root_keys_to_create.add((file_id, entry.revision))
3909
 
                        continue
3910
 
                kind = entry.kind
3911
 
                texts_possibly_new_in_tree.add((file_id, entry.revision))
3912
 
            for basis_id, basis_tree in possible_trees:
3913
 
                basis_inv = basis_tree.inventory
3914
 
                for file_key in list(texts_possibly_new_in_tree):
3915
 
                    file_id, file_revision = file_key
3916
 
                    try:
3917
 
                        entry = basis_inv[file_id]
3918
 
                    except errors.NoSuchId:
3919
 
                        continue
3920
 
                    if entry.revision == file_revision:
3921
 
                        texts_possibly_new_in_tree.remove(file_key)
3922
 
            text_keys.update(texts_possibly_new_in_tree)
 
3600
                if new_path is not None:
 
3601
                    if not new_path:
 
3602
                        # This is the root
 
3603
                        if not self.target.supports_rich_root():
 
3604
                            # The target doesn't support rich root, so we don't
 
3605
                            # copy
 
3606
                            continue
 
3607
                        if self._converting_to_rich_root:
 
3608
                            # This can't be copied normally, we have to insert
 
3609
                            # it specially
 
3610
                            root_keys_to_create.add((file_id, entry.revision))
 
3611
                            continue
 
3612
                    text_keys.add((file_id, entry.revision))
 
3613
            revision = self.source.get_revision(current_revision_id)
 
3614
            pending_deltas.append((basis_id, delta,
 
3615
                current_revision_id, revision.parent_ids))
3923
3616
            pending_revisions.append(revision)
3924
3617
            cache[current_revision_id] = tree
3925
3618
            basis_id = current_revision_id
3926
 
        self.source._safe_to_return_from_cache = False
3927
3619
        # Copy file texts
3928
3620
        from_texts = self.source.texts
3929
3621
        to_texts = self.target.texts
3930
3622
        if root_keys_to_create:
3931
 
            root_stream = _mod_fetch._new_root_data_stream(
3932
 
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
3933
 
                self.source, graph=a_graph)
 
3623
            root_stream = self._new_root_data_stream(root_keys_to_create,
 
3624
                                                     parent_map)
3934
3625
            to_texts.insert_record_stream(root_stream)
3935
3626
        to_texts.insert_record_stream(from_texts.get_record_stream(
3936
3627
            text_keys, self.target._format._fetch_order,
3943
3634
            # for the new revisions that we are about to insert.  We do this
3944
3635
            # before adding the revisions so that no revision is added until
3945
3636
            # all the inventories it may depend on are added.
3946
 
            # Note that this is overzealous, as we may have fetched these in an
3947
 
            # earlier batch.
3948
3637
            parent_ids = set()
3949
3638
            revision_ids = set()
3950
3639
            for revision in pending_revisions:
3953
3642
            parent_ids.difference_update(revision_ids)
3954
3643
            parent_ids.discard(_mod_revision.NULL_REVISION)
3955
3644
            parent_map = self.source.get_parent_map(parent_ids)
3956
 
            # we iterate over parent_map and not parent_ids because we don't
3957
 
            # want to try copying any revision which is a ghost
3958
 
            for parent_tree in self.source.revision_trees(parent_map):
 
3645
            for parent_tree in self.source.revision_trees(parent_ids):
 
3646
                basis_id, delta = self._get_delta_for_revision(tree, parent_ids, basis_id, cache)
3959
3647
                current_revision_id = parent_tree.get_revision_id()
3960
3648
                parents_parents = parent_map[current_revision_id]
3961
 
                possible_trees = self._get_trees(parents_parents, cache)
3962
 
                if len(possible_trees) == 0:
3963
 
                    # There either aren't any parents, or the parents are
3964
 
                    # ghosts, so just use the last converted tree.
3965
 
                    possible_trees.append((basis_id, cache[basis_id]))
3966
 
                basis_id, delta = self._get_delta_for_revision(parent_tree,
3967
 
                    parents_parents, possible_trees)
3968
3649
                self.target.add_inventory_by_delta(
3969
3650
                    basis_id, delta, current_revision_id, parents_parents)
3970
3651
        # insert signatures and revisions
3984
3665
 
3985
3666
        :param revision_ids: The list of revisions to fetch. Must be in
3986
3667
            topological order.
3987
 
        :param pb: A ProgressTask
 
3668
        :param pb: A ProgressBar
3988
3669
        :return: None
3989
3670
        """
3990
3671
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3992
3673
        cache = lru_cache.LRUCache(100)
3993
3674
        cache[basis_id] = basis_tree
3994
3675
        del basis_tree # We don't want to hang on to it here
3995
 
        hints = []
3996
 
        if self._converting_to_rich_root and len(revision_ids) > 100:
3997
 
            a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
3998
 
                                                            revision_ids)
3999
 
        else:
4000
 
            a_graph = None
4001
 
 
4002
3676
        for offset in range(0, len(revision_ids), batch_size):
4003
3677
            self.target.start_write_group()
4004
3678
            try:
4005
3679
                pb.update('Transferring revisions', offset,
4006
3680
                          len(revision_ids))
4007
3681
                batch = revision_ids[offset:offset+batch_size]
4008
 
                basis_id = self._fetch_batch(batch, basis_id, cache,
4009
 
                                             a_graph=a_graph)
 
3682
                basis_id = self._fetch_batch(batch, basis_id, cache)
4010
3683
            except:
4011
 
                self.source._safe_to_return_from_cache = False
4012
3684
                self.target.abort_write_group()
4013
3685
                raise
4014
3686
            else:
4015
 
                hint = self.target.commit_write_group()
4016
 
                if hint:
4017
 
                    hints.extend(hint)
4018
 
        if hints and self.target._format.pack_compresses:
4019
 
            self.target.pack(hint=hints)
 
3687
                self.target.commit_write_group()
4020
3688
        pb.update('Transferring revisions', len(revision_ids),
4021
3689
                  len(revision_ids))
4022
3690
 
4026
3694
        """See InterRepository.fetch()."""
4027
3695
        if fetch_spec is not None:
4028
3696
            raise AssertionError("Not implemented yet...")
4029
 
        ui.ui_factory.warn_experimental_format_fetch(self)
4030
3697
        if (not self.source.supports_rich_root()
4031
3698
            and self.target.supports_rich_root()):
4032
3699
            self._converting_to_rich_root = True
4033
3700
            self._revision_id_to_root_id = {}
4034
3701
        else:
4035
3702
            self._converting_to_rich_root = False
4036
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
4037
 
        if self.source._format.network_name() != self.target._format.network_name():
4038
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
4039
 
                from_format=self.source._format,
4040
 
                to_format=self.target._format)
4041
3703
        revision_ids = self.target.search_missing_revision_ids(self.source,
4042
3704
            revision_id, find_ghosts=find_ghosts).get_keys()
4043
3705
        if not revision_ids:
4049
3711
        # Walk though all revisions; get inventory deltas, copy referenced
4050
3712
        # texts that delta references, insert the delta, revision and
4051
3713
        # signature.
 
3714
        first_rev = self.source.get_revision(revision_ids[0])
4052
3715
        if pb is None:
4053
3716
            my_pb = ui.ui_factory.nested_progress_bar()
4054
3717
            pb = my_pb
4091
3754
InterRepository.register_optimiser(InterSameDataRepository)
4092
3755
InterRepository.register_optimiser(InterWeaveRepo)
4093
3756
InterRepository.register_optimiser(InterKnitRepo)
 
3757
InterRepository.register_optimiser(InterPackRepo)
4094
3758
 
4095
3759
 
4096
3760
class CopyConverter(object):
4112
3776
        :param to_convert: The disk object to convert.
4113
3777
        :param pb: a progress bar to use for progress information.
4114
3778
        """
4115
 
        pb = ui.ui_factory.nested_progress_bar()
 
3779
        self.pb = pb
4116
3780
        self.count = 0
4117
3781
        self.total = 4
4118
3782
        # this is only useful with metadir layouts - separated repo content.
4119
3783
        # trigger an assertion if not such
4120
3784
        repo._format.get_format_string()
4121
3785
        self.repo_dir = repo.bzrdir
4122
 
        pb.update('Moving repository to repository.backup')
 
3786
        self.step('Moving repository to repository.backup')
4123
3787
        self.repo_dir.transport.move('repository', 'repository.backup')
4124
3788
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4125
3789
        repo._format.check_conversion_target(self.target_format)
4126
3790
        self.source_repo = repo._format.open(self.repo_dir,
4127
3791
            _found=True,
4128
3792
            _override_transport=backup_transport)
4129
 
        pb.update('Creating new repository')
 
3793
        self.step('Creating new repository')
4130
3794
        converted = self.target_format.initialize(self.repo_dir,
4131
3795
                                                  self.source_repo.is_shared())
4132
3796
        converted.lock_write()
4133
3797
        try:
4134
 
            pb.update('Copying content')
 
3798
            self.step('Copying content into repository.')
4135
3799
            self.source_repo.copy_content_into(converted)
4136
3800
        finally:
4137
3801
            converted.unlock()
4138
 
        pb.update('Deleting old repository content')
 
3802
        self.step('Deleting old repository content.')
4139
3803
        self.repo_dir.transport.delete_tree('repository.backup')
4140
 
        ui.ui_factory.note('repository converted')
4141
 
        pb.finished()
 
3804
        self.pb.note('repository converted')
 
3805
 
 
3806
    def step(self, message):
 
3807
        """Update the pb by a step."""
 
3808
        self.count +=1
 
3809
        self.pb.update(message, self.count, self.total)
4142
3810
 
4143
3811
 
4144
3812
_unescape_map = {
4173
3841
 
4174
3842
class _VersionedFileChecker(object):
4175
3843
 
4176
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
3844
    def __init__(self, repository, text_key_references=None):
4177
3845
        self.repository = repository
4178
3846
        self.text_index = self.repository._generate_text_key_index(
4179
 
            text_key_references=text_key_references, ancestors=ancestors)
 
3847
            text_key_references=text_key_references)
4180
3848
 
4181
3849
    def calculate_file_version_parents(self, text_key):
4182
3850
        """Calculate the correct parents for a file version according to
4200
3868
            revision_id) tuples for versions that are present in this versioned
4201
3869
            file, but not used by the corresponding inventory.
4202
3870
        """
4203
 
        local_progress = None
4204
 
        if progress_bar is None:
4205
 
            local_progress = ui.ui_factory.nested_progress_bar()
4206
 
            progress_bar = local_progress
4207
 
        try:
4208
 
            return self._check_file_version_parents(texts, progress_bar)
4209
 
        finally:
4210
 
            if local_progress:
4211
 
                local_progress.finished()
4212
 
 
4213
 
    def _check_file_version_parents(self, texts, progress_bar):
4214
 
        """See check_file_version_parents."""
4215
3871
        wrong_parents = {}
4216
3872
        self.file_ids = set([file_id for file_id, _ in
4217
3873
            self.text_index.iterkeys()])
4218
3874
        # text keys is now grouped by file_id
 
3875
        n_weaves = len(self.file_ids)
 
3876
        files_in_revisions = {}
 
3877
        revisions_of_files = {}
4219
3878
        n_versions = len(self.text_index)
4220
3879
        progress_bar.update('loading text store', 0, n_versions)
4221
3880
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4223
3882
        text_keys = self.repository.texts.keys()
4224
3883
        unused_keys = frozenset(text_keys) - set(self.text_index)
4225
3884
        for num, key in enumerate(self.text_index.iterkeys()):
4226
 
            progress_bar.update('checking text graph', num, n_versions)
 
3885
            if progress_bar is not None:
 
3886
                progress_bar.update('checking text graph', num, n_versions)
4227
3887
            correct_parents = self.calculate_file_version_parents(key)
4228
3888
            try:
4229
3889
                knit_parents = parent_map[key]
4278
3938
        try:
4279
3939
            if resume_tokens:
4280
3940
                self.target_repo.resume_write_group(resume_tokens)
4281
 
                is_resume = True
4282
3941
            else:
4283
3942
                self.target_repo.start_write_group()
4284
 
                is_resume = False
4285
3943
            try:
4286
3944
                # locked_insert_stream performs a commit|suspend.
4287
 
                return self._locked_insert_stream(stream, src_format,
4288
 
                    is_resume)
 
3945
                return self._locked_insert_stream(stream, src_format)
4289
3946
            except:
4290
3947
                self.target_repo.abort_write_group(suppress_errors=True)
4291
3948
                raise
4292
3949
        finally:
4293
3950
            self.target_repo.unlock()
4294
3951
 
4295
 
    def _locked_insert_stream(self, stream, src_format, is_resume):
 
3952
    def _locked_insert_stream(self, stream, src_format):
4296
3953
        to_serializer = self.target_repo._format._serializer
4297
3954
        src_serializer = src_format._serializer
4298
 
        new_pack = None
4299
3955
        if to_serializer == src_serializer:
4300
3956
            # If serializers match and the target is a pack repository, set the
4301
3957
            # write cache size on the new pack.  This avoids poor performance
4315
3971
            else:
4316
3972
                new_pack.set_write_cache_size(1024*1024)
4317
3973
        for substream_type, substream in stream:
4318
 
            if 'stream' in debug.debug_flags:
4319
 
                mutter('inserting substream: %s', substream_type)
4320
3974
            if substream_type == 'texts':
4321
3975
                self.target_repo.texts.insert_record_stream(substream)
4322
3976
            elif substream_type == 'inventories':
4326
3980
                else:
4327
3981
                    self._extract_and_insert_inventories(
4328
3982
                        substream, src_serializer)
4329
 
            elif substream_type == 'inventory-deltas':
4330
 
                self._extract_and_insert_inventory_deltas(
4331
 
                    substream, src_serializer)
4332
3983
            elif substream_type == 'chk_bytes':
4333
3984
                # XXX: This doesn't support conversions, as it assumes the
4334
3985
                #      conversion was done in the fetch code.
4338
3989
                # required if the serializers are different only in terms of
4339
3990
                # the inventory.
4340
3991
                if src_serializer == to_serializer:
4341
 
                    self.target_repo.revisions.insert_record_stream(substream)
 
3992
                    self.target_repo.revisions.insert_record_stream(
 
3993
                        substream)
4342
3994
                else:
4343
3995
                    self._extract_and_insert_revisions(substream,
4344
3996
                        src_serializer)
4346
3998
                self.target_repo.signatures.insert_record_stream(substream)
4347
3999
            else:
4348
4000
                raise AssertionError('kaboom! %s' % (substream_type,))
4349
 
        # Done inserting data, and the missing_keys calculations will try to
4350
 
        # read back from the inserted data, so flush the writes to the new pack
4351
 
        # (if this is pack format).
4352
 
        if new_pack is not None:
4353
 
            new_pack._write_data('', flush=True)
4354
 
        # Find all the new revisions (including ones from resume_tokens)
4355
 
        missing_keys = self.target_repo.get_missing_parent_inventories(
4356
 
            check_for_missing_texts=is_resume)
4357
4001
        try:
 
4002
            missing_keys = set()
4358
4003
            for prefix, versioned_file in (
4359
4004
                ('texts', self.target_repo.texts),
4360
4005
                ('inventories', self.target_repo.inventories),
4361
4006
                ('revisions', self.target_repo.revisions),
4362
4007
                ('signatures', self.target_repo.signatures),
4363
 
                ('chk_bytes', self.target_repo.chk_bytes),
4364
4008
                ):
4365
 
                if versioned_file is None:
4366
 
                    continue
4367
 
                # TODO: key is often going to be a StaticTuple object
4368
 
                #       I don't believe we can define a method by which
4369
 
                #       (prefix,) + StaticTuple will work, though we could
4370
 
                #       define a StaticTuple.sq_concat that would allow you to
4371
 
                #       pass in either a tuple or a StaticTuple as the second
4372
 
                #       object, so instead we could have:
4373
 
                #       StaticTuple(prefix) + key here...
4374
4009
                missing_keys.update((prefix,) + key for key in
4375
4010
                    versioned_file.get_missing_compression_parent_keys())
4376
4011
        except NotImplementedError:
4385
4020
                # missing keys can handle suspending a write group).
4386
4021
                write_group_tokens = self.target_repo.suspend_write_group()
4387
4022
                return write_group_tokens, missing_keys
4388
 
        hint = self.target_repo.commit_write_group()
4389
 
        if (to_serializer != src_serializer and
4390
 
            self.target_repo._format.pack_compresses):
4391
 
            self.target_repo.pack(hint=hint)
 
4023
        self.target_repo.commit_write_group()
4392
4024
        return [], set()
4393
4025
 
4394
 
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
4395
 
        target_rich_root = self.target_repo._format.rich_root_data
4396
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4397
 
        for record in substream:
4398
 
            # Insert the delta directly
4399
 
            inventory_delta_bytes = record.get_bytes_as('fulltext')
4400
 
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
4401
 
            try:
4402
 
                parse_result = deserialiser.parse_text_bytes(
4403
 
                    inventory_delta_bytes)
4404
 
            except inventory_delta.IncompatibleInventoryDelta, err:
4405
 
                trace.mutter("Incompatible delta: %s", err.msg)
4406
 
                raise errors.IncompatibleRevision(self.target_repo._format)
4407
 
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
4408
 
            revision_id = new_id
4409
 
            parents = [key[0] for key in record.parents]
4410
 
            self.target_repo.add_inventory_by_delta(
4411
 
                basis_id, inv_delta, revision_id, parents)
4412
 
 
4413
 
    def _extract_and_insert_inventories(self, substream, serializer,
4414
 
            parse_delta=None):
 
4026
    def _extract_and_insert_inventories(self, substream, serializer):
4415
4027
        """Generate a new inventory versionedfile in target, converting data.
4416
4028
 
4417
4029
        The inventory is retrieved from the source, (deserializing it), and
4418
4030
        stored in the target (reserializing it in a different format).
4419
4031
        """
4420
 
        target_rich_root = self.target_repo._format.rich_root_data
4421
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4422
4032
        for record in substream:
4423
 
            # It's not a delta, so it must be a fulltext in the source
4424
 
            # serializer's format.
4425
4033
            bytes = record.get_bytes_as('fulltext')
4426
4034
            revision_id = record.key[0]
4427
4035
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4428
4036
            parents = [key[0] for key in record.parents]
4429
4037
            self.target_repo.add_inventory(revision_id, inv, parents)
4430
 
            # No need to keep holding this full inv in memory when the rest of
4431
 
            # the substream is likely to be all deltas.
4432
 
            del inv
4433
4038
 
4434
4039
    def _extract_and_insert_revisions(self, substream, serializer):
4435
4040
        for record in substream:
4452
4057
        """Create a StreamSource streaming from from_repository."""
4453
4058
        self.from_repository = from_repository
4454
4059
        self.to_format = to_format
4455
 
        self._record_counter = RecordCounter()
4456
4060
 
4457
4061
    def delta_on_metadata(self):
4458
4062
        """Return True if delta's are permitted on metadata streams.
4485
4089
        return [('signatures', signatures), ('revisions', revisions)]
4486
4090
 
4487
4091
    def _generate_root_texts(self, revs):
4488
 
        """This will be called by get_stream between fetching weave texts and
 
4092
        """This will be called by __fetch between fetching weave texts and
4489
4093
        fetching the inventory weave.
 
4094
 
 
4095
        Subclasses should override this if they need to generate root texts
 
4096
        after fetching weave texts.
4490
4097
        """
4491
4098
        if self._rich_root_upgrade():
4492
 
            return _mod_fetch.Inter1and2Helper(
 
4099
            import bzrlib.fetch
 
4100
            return bzrlib.fetch.Inter1and2Helper(
4493
4101
                self.from_repository).generate_root_texts(revs)
4494
4102
        else:
4495
4103
            return []
4498
4106
        phase = 'file'
4499
4107
        revs = search.get_keys()
4500
4108
        graph = self.from_repository.get_graph()
4501
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
 
4109
        revs = list(graph.iter_topo_order(revs))
4502
4110
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4503
4111
        text_keys = []
4504
4112
        for knit_kind, file_id, revisions in data_to_fetch:
4523
4131
                # will be valid.
4524
4132
                for _ in self._generate_root_texts(revs):
4525
4133
                    yield _
 
4134
                # NB: This currently reopens the inventory weave in source;
 
4135
                # using a single stream interface instead would avoid this.
 
4136
                from_weave = self.from_repository.inventories
4526
4137
                # we fetch only the referenced inventories because we do not
4527
4138
                # know for unselected inventories whether all their required
4528
4139
                # texts are present in the other repository - it could be
4547
4158
        keys['texts'] = set()
4548
4159
        keys['revisions'] = set()
4549
4160
        keys['inventories'] = set()
4550
 
        keys['chk_bytes'] = set()
4551
4161
        keys['signatures'] = set()
4552
4162
        for key in missing_keys:
4553
4163
            keys[key[0]].add(key[1:])
4560
4170
                    keys['revisions'],))
4561
4171
        for substream_kind, keys in keys.iteritems():
4562
4172
            vf = getattr(self.from_repository, substream_kind)
4563
 
            if vf is None and keys:
4564
 
                    raise AssertionError(
4565
 
                        "cannot fill in keys for a versioned file we don't"
4566
 
                        " have: %s needs %s" % (substream_kind, keys))
4567
 
            if not keys:
4568
 
                # No need to stream something we don't have
4569
 
                continue
4570
 
            if substream_kind == 'inventories':
4571
 
                # Some missing keys are genuinely ghosts, filter those out.
4572
 
                present = self.from_repository.inventories.get_parent_map(keys)
4573
 
                revs = [key[0] for key in present]
4574
 
                # Get the inventory stream more-or-less as we do for the
4575
 
                # original stream; there's no reason to assume that records
4576
 
                # direct from the source will be suitable for the sink.  (Think
4577
 
                # e.g. 2a -> 1.9-rich-root).
4578
 
                for info in self._get_inventory_stream(revs, missing=True):
4579
 
                    yield info
4580
 
                continue
4581
 
 
4582
4173
            # Ask for full texts always so that we don't need more round trips
4583
4174
            # after this stream.
4584
 
            # Some of the missing keys are genuinely ghosts, so filter absent
4585
 
            # records. The Sink is responsible for doing another check to
4586
 
            # ensure that ghosts don't introduce missing data for future
4587
 
            # fetches.
4588
 
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
4589
 
                self.to_format._fetch_order, True))
 
4175
            stream = vf.get_record_stream(keys,
 
4176
                self.to_format._fetch_order, True)
4590
4177
            yield substream_kind, stream
4591
4178
 
4592
4179
    def inventory_fetch_order(self):
4599
4186
        return (not self.from_repository._format.rich_root_data and
4600
4187
            self.to_format.rich_root_data)
4601
4188
 
4602
 
    def _get_inventory_stream(self, revision_ids, missing=False):
 
4189
    def _get_inventory_stream(self, revision_ids):
4603
4190
        from_format = self.from_repository._format
4604
 
        if (from_format.supports_chks and self.to_format.supports_chks and
4605
 
            from_format.network_name() == self.to_format.network_name()):
4606
 
            raise AssertionError(
4607
 
                "this case should be handled by GroupCHKStreamSource")
4608
 
        elif 'forceinvdeltas' in debug.debug_flags:
4609
 
            return self._get_convertable_inventory_stream(revision_ids,
4610
 
                    delta_versus_null=missing)
4611
 
        elif from_format.network_name() == self.to_format.network_name():
4612
 
            # Same format.
4613
 
            return self._get_simple_inventory_stream(revision_ids,
4614
 
                    missing=missing)
4615
 
        elif (not from_format.supports_chks and not self.to_format.supports_chks
4616
 
                and from_format._serializer == self.to_format._serializer):
4617
 
            # Essentially the same format.
4618
 
            return self._get_simple_inventory_stream(revision_ids,
4619
 
                    missing=missing)
 
4191
        if (from_format.supports_chks and self.to_format.supports_chks
 
4192
            and (from_format._serializer == self.to_format._serializer)):
 
4193
            # Both sides support chks, and they use the same serializer, so it
 
4194
            # is safe to transmit the chk pages and inventory pages across
 
4195
            # as-is.
 
4196
            return self._get_chk_inventory_stream(revision_ids)
 
4197
        elif (not from_format.supports_chks):
 
4198
            # Source repository doesn't support chks. So we can transmit the
 
4199
            # inventories 'as-is' and either they are just accepted on the
 
4200
            # target, or the Sink will properly convert it.
 
4201
            return self._get_simple_inventory_stream(revision_ids)
4620
4202
        else:
4621
 
            # Any time we switch serializations, we want to use an
4622
 
            # inventory-delta based approach.
4623
 
            return self._get_convertable_inventory_stream(revision_ids,
4624
 
                    delta_versus_null=missing)
 
4203
            # XXX: Hack to make not-chk->chk fetch: copy the inventories as
 
4204
            #      inventories. Note that this should probably be done somehow
 
4205
            #      as part of bzrlib.repository.StreamSink. Except JAM couldn't
 
4206
            #      figure out how a non-chk repository could possibly handle
 
4207
            #      deserializing an inventory stream from a chk repo, as it
 
4208
            #      doesn't have a way to understand individual pages.
 
4209
            return self._get_convertable_inventory_stream(revision_ids)
4625
4210
 
4626
 
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
4627
 
        # NB: This currently reopens the inventory weave in source;
4628
 
        # using a single stream interface instead would avoid this.
 
4211
    def _get_simple_inventory_stream(self, revision_ids):
4629
4212
        from_weave = self.from_repository.inventories
4630
 
        if missing:
4631
 
            delta_closure = True
4632
 
        else:
4633
 
            delta_closure = not self.delta_on_metadata()
4634
4213
        yield ('inventories', from_weave.get_record_stream(
4635
4214
            [(rev_id,) for rev_id in revision_ids],
4636
 
            self.inventory_fetch_order(), delta_closure))
4637
 
 
4638
 
    def _get_convertable_inventory_stream(self, revision_ids,
4639
 
                                          delta_versus_null=False):
4640
 
        # The two formats are sufficiently different that there is no fast
4641
 
        # path, so we need to send just inventorydeltas, which any
4642
 
        # sufficiently modern client can insert into any repository.
4643
 
        # The StreamSink code expects to be able to
4644
 
        # convert on the target, so we need to put bytes-on-the-wire that can
4645
 
        # be converted.  That means inventory deltas (if the remote is <1.19,
4646
 
        # RemoteStreamSink will fallback to VFS to insert the deltas).
4647
 
        yield ('inventory-deltas',
4648
 
           self._stream_invs_as_deltas(revision_ids,
4649
 
                                       delta_versus_null=delta_versus_null))
4650
 
 
4651
 
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
4652
 
        """Return a stream of inventory-deltas for the given rev ids.
4653
 
 
4654
 
        :param revision_ids: The list of inventories to transmit
4655
 
        :param delta_versus_null: Don't try to find a minimal delta for this
4656
 
            entry, instead compute the delta versus the NULL_REVISION. This
4657
 
            effectively streams a complete inventory. Used for stuff like
4658
 
            filling in missing parents, etc.
4659
 
        """
 
4215
            self.inventory_fetch_order(),
 
4216
            not self.delta_on_metadata()))
 
4217
 
 
4218
    def _get_chk_inventory_stream(self, revision_ids):
 
4219
        """Fetch the inventory texts, along with the associated chk maps."""
 
4220
        # We want an inventory outside of the search set, so that we can filter
 
4221
        # out uninteresting chk pages. For now we use
 
4222
        # _find_revision_outside_set, but if we had a Search with cut_revs, we
 
4223
        # could use that instead.
 
4224
        start_rev_id = self.from_repository._find_revision_outside_set(
 
4225
                            revision_ids)
 
4226
        start_rev_key = (start_rev_id,)
 
4227
        inv_keys_to_fetch = [(rev_id,) for rev_id in revision_ids]
 
4228
        if start_rev_id != _mod_revision.NULL_REVISION:
 
4229
            inv_keys_to_fetch.append((start_rev_id,))
 
4230
        # Any repo that supports chk_bytes must also support out-of-order
 
4231
        # insertion. At least, that is how we expect it to work
 
4232
        # We use get_record_stream instead of iter_inventories because we want
 
4233
        # to be able to insert the stream as well. We could instead fetch
 
4234
        # allowing deltas, and then iter_inventories, but we don't know whether
 
4235
        # source or target is more 'local' anway.
 
4236
        inv_stream = self.from_repository.inventories.get_record_stream(
 
4237
            inv_keys_to_fetch, 'unordered',
 
4238
            True) # We need them as full-texts so we can find their references
 
4239
        uninteresting_chk_roots = set()
 
4240
        interesting_chk_roots = set()
 
4241
        def filter_inv_stream(inv_stream):
 
4242
            for idx, record in enumerate(inv_stream):
 
4243
                ### child_pb.update('fetch inv', idx, len(inv_keys_to_fetch))
 
4244
                bytes = record.get_bytes_as('fulltext')
 
4245
                chk_inv = inventory.CHKInventory.deserialise(
 
4246
                    self.from_repository.chk_bytes, bytes, record.key)
 
4247
                if record.key == start_rev_key:
 
4248
                    uninteresting_chk_roots.add(chk_inv.id_to_entry.key())
 
4249
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4250
                    if p_id_map is not None:
 
4251
                        uninteresting_chk_roots.add(p_id_map.key())
 
4252
                else:
 
4253
                    yield record
 
4254
                    interesting_chk_roots.add(chk_inv.id_to_entry.key())
 
4255
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4256
                    if p_id_map is not None:
 
4257
                        interesting_chk_roots.add(p_id_map.key())
 
4258
        ### pb.update('fetch inventory', 0, 2)
 
4259
        yield ('inventories', filter_inv_stream(inv_stream))
 
4260
        # Now that we have worked out all of the interesting root nodes, grab
 
4261
        # all of the interesting pages and insert them
 
4262
        ### pb.update('fetch inventory', 1, 2)
 
4263
        interesting = chk_map.iter_interesting_nodes(
 
4264
            self.from_repository.chk_bytes, interesting_chk_roots,
 
4265
            uninteresting_chk_roots)
 
4266
        def to_stream_adapter():
 
4267
            """Adapt the iter_interesting_nodes result to a single stream.
 
4268
 
 
4269
            iter_interesting_nodes returns records as it processes them, along
 
4270
            with keys. However, we only want to return the records themselves.
 
4271
            """
 
4272
            for record, items in interesting:
 
4273
                if record is not None:
 
4274
                    yield record
 
4275
        # XXX: We could instead call get_record_stream(records.keys())
 
4276
        #      ATM, this will always insert the records as fulltexts, and
 
4277
        #      requires that you can hang on to records once you have gone
 
4278
        #      on to the next one. Further, it causes the target to
 
4279
        #      recompress the data. Testing shows it to be faster than
 
4280
        #      requesting the records again, though.
 
4281
        yield ('chk_bytes', to_stream_adapter())
 
4282
        ### pb.update('fetch inventory', 2, 2)
 
4283
 
 
4284
    def _get_convertable_inventory_stream(self, revision_ids):
 
4285
        # XXX: One of source or target is using chks, and they don't have
 
4286
        #      compatible serializations. The StreamSink code expects to be
 
4287
        #      able to convert on the target, so we need to put
 
4288
        #      bytes-on-the-wire that can be converted
 
4289
        yield ('inventories', self._stream_invs_as_fulltexts(revision_ids))
 
4290
 
 
4291
    def _stream_invs_as_fulltexts(self, revision_ids):
4660
4292
        from_repo = self.from_repository
 
4293
        from_serializer = from_repo._format._serializer
4661
4294
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4662
4295
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
4663
 
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
4664
 
        # method...
4665
 
        inventories = self.from_repository.iter_inventories(
4666
 
            revision_ids, 'topological')
4667
 
        format = from_repo._format
4668
 
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
4669
 
        inventory_cache = lru_cache.LRUCache(50)
4670
 
        null_inventory = from_repo.revision_tree(
4671
 
            _mod_revision.NULL_REVISION).inventory
4672
 
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
4673
 
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
4674
 
        # repo back into a non-rich-root repo ought to be allowed)
4675
 
        serializer = inventory_delta.InventoryDeltaSerializer(
4676
 
            versioned_root=format.rich_root_data,
4677
 
            tree_references=format.supports_tree_reference)
4678
 
        for inv in inventories:
 
4296
        for inv in self.from_repository.iter_inventories(revision_ids):
 
4297
            # XXX: This is a bit hackish, but it works. Basically,
 
4298
            #      CHKSerializer 'accidentally' supports
 
4299
            #      read/write_inventory_to_string, even though that is never
 
4300
            #      the format that is stored on disk. It *does* give us a
 
4301
            #      single string representation for an inventory, so live with
 
4302
            #      it for now.
 
4303
            #      This would be far better if we had a 'serialized inventory
 
4304
            #      delta' form. Then we could use 'inventory._make_delta', and
 
4305
            #      transmit that. This would both be faster to generate, and
 
4306
            #      result in fewer bytes-on-the-wire.
 
4307
            as_bytes = from_serializer.write_inventory_to_string(inv)
4679
4308
            key = (inv.revision_id,)
4680
4309
            parent_keys = parent_map.get(key, ())
4681
 
            delta = None
4682
 
            if not delta_versus_null and parent_keys:
4683
 
                # The caller did not ask for complete inventories and we have
4684
 
                # some parents that we can delta against.  Make a delta against
4685
 
                # each parent so that we can find the smallest.
4686
 
                parent_ids = [parent_key[0] for parent_key in parent_keys]
4687
 
                for parent_id in parent_ids:
4688
 
                    if parent_id not in invs_sent_so_far:
4689
 
                        # We don't know that the remote side has this basis, so
4690
 
                        # we can't use it.
4691
 
                        continue
4692
 
                    if parent_id == _mod_revision.NULL_REVISION:
4693
 
                        parent_inv = null_inventory
4694
 
                    else:
4695
 
                        parent_inv = inventory_cache.get(parent_id, None)
4696
 
                        if parent_inv is None:
4697
 
                            parent_inv = from_repo.get_inventory(parent_id)
4698
 
                    candidate_delta = inv._make_delta(parent_inv)
4699
 
                    if (delta is None or
4700
 
                        len(delta) > len(candidate_delta)):
4701
 
                        delta = candidate_delta
4702
 
                        basis_id = parent_id
4703
 
            if delta is None:
4704
 
                # Either none of the parents ended up being suitable, or we
4705
 
                # were asked to delta against NULL
4706
 
                basis_id = _mod_revision.NULL_REVISION
4707
 
                delta = inv._make_delta(null_inventory)
4708
 
            invs_sent_so_far.add(inv.revision_id)
4709
 
            inventory_cache[inv.revision_id] = inv
4710
 
            delta_serialized = ''.join(
4711
 
                serializer.delta_to_lines(basis_id, key[-1], delta))
4712
4310
            yield versionedfile.FulltextContentFactory(
4713
 
                key, parent_keys, None, delta_serialized)
4714
 
 
4715
 
 
4716
 
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
4717
 
                    stop_revision=None):
4718
 
    """Extend the partial history to include a given index
4719
 
 
4720
 
    If a stop_index is supplied, stop when that index has been reached.
4721
 
    If a stop_revision is supplied, stop when that revision is
4722
 
    encountered.  Otherwise, stop when the beginning of history is
4723
 
    reached.
4724
 
 
4725
 
    :param stop_index: The index which should be present.  When it is
4726
 
        present, history extension will stop.
4727
 
    :param stop_revision: The revision id which should be present.  When
4728
 
        it is encountered, history extension will stop.
4729
 
    """
4730
 
    start_revision = partial_history_cache[-1]
4731
 
    iterator = repo.iter_reverse_revision_history(start_revision)
4732
 
    try:
4733
 
        #skip the last revision in the list
4734
 
        iterator.next()
4735
 
        while True:
4736
 
            if (stop_index is not None and
4737
 
                len(partial_history_cache) > stop_index):
4738
 
                break
4739
 
            if partial_history_cache[-1] == stop_revision:
4740
 
                break
4741
 
            revision_id = iterator.next()
4742
 
            partial_history_cache.append(revision_id)
4743
 
    except StopIteration:
4744
 
        # No more history
4745
 
        return
 
4311
                key, parent_keys, None, as_bytes)
4746
4312