~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: John Arbash Meinel
  • Date: 2009-06-19 17:40:59 UTC
  • mto: This revision was merged to the branch mainline in revision 4466.
  • Revision ID: john@arbash-meinel.com-20090619174059-jzowjv0d86vzjg4m
Update the python code to do the same checking around known_parent_gdfos being present.

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
 
    controldir,
29
27
    debug,
30
 
    fetch as _mod_fetch,
 
28
    errors,
31
29
    fifo_cache,
32
30
    generate_ids,
33
31
    gpg,
34
32
    graph,
35
33
    inventory,
36
 
    inventory_delta,
37
34
    lazy_regex,
38
35
    lockable_files,
39
36
    lockdir,
40
37
    lru_cache,
41
38
    osutils,
42
39
    revision as _mod_revision,
43
 
    static_tuple,
44
40
    symbol_versioning,
45
 
    trace,
46
41
    tsort,
 
42
    ui,
47
43
    versionedfile,
48
44
    )
49
45
from bzrlib.bundle import serializer
52
48
from bzrlib.testament import Testament
53
49
""")
54
50
 
55
 
from bzrlib import (
56
 
    errors,
57
 
    registry,
58
 
    ui,
59
 
    )
60
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
51
from bzrlib.decorators import needs_read_lock, needs_write_lock
61
52
from bzrlib.inter import InterObject
62
53
from bzrlib.inventory import (
63
54
    Inventory,
65
56
    ROOT_ID,
66
57
    entry_factory,
67
58
    )
68
 
from bzrlib.recordcounter import RecordCounter
69
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
 
59
from bzrlib import registry
 
60
from bzrlib.symbol_versioning import (
 
61
        deprecated_method,
 
62
        )
70
63
from bzrlib.trace import (
71
64
    log_exception_quietly, note, mutter, mutter_callsite, warning)
72
65
 
75
68
_deprecation_warning_done = False
76
69
 
77
70
 
78
 
class IsInWriteGroupError(errors.InternalBzrError):
79
 
 
80
 
    _fmt = "May not refresh_data of repo %(repo)s while in a write group."
81
 
 
82
 
    def __init__(self, repo):
83
 
        errors.InternalBzrError.__init__(self, repo=repo)
84
 
 
85
 
 
86
71
class CommitBuilder(object):
87
72
    """Provides an interface to build up a commit.
88
73
 
222
207
            # an inventory delta was accumulated without creating a new
223
208
            # inventory.
224
209
            basis_id = self.basis_delta_revision
225
 
            # We ignore the 'inventory' returned by add_inventory_by_delta
226
 
            # because self.new_inventory is used to hint to the rest of the
227
 
            # system what code path was taken
228
 
            self.inv_sha1, _ = self.repository.add_inventory_by_delta(
 
210
            self.inv_sha1 = self.repository.add_inventory_by_delta(
229
211
                basis_id, self._basis_delta, self._new_revision_id,
230
212
                self.parents)
231
213
        else:
243
225
 
244
226
    def _gen_revision_id(self):
245
227
        """Return new revision-id."""
246
 
        return generate_ids.gen_revision_id(self._committer, self._timestamp)
 
228
        return generate_ids.gen_revision_id(self._config.username(),
 
229
                                            self._timestamp)
247
230
 
248
231
    def _generate_revision_if_needed(self):
249
232
        """Create a revision id if None was supplied.
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
434
417
            else:
435
418
                # we don't need to commit this, because the caller already
436
419
                # determined that an existing revision of this file is
437
 
                # appropriate. If it's not being considered for committing then
 
420
                # appropriate. If its not being considered for committing then
438
421
                # it and all its parents to the root must be unaltered so
439
422
                # no-change against the basis.
440
423
                if ie.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
756
739
                    # after iter_changes examines and decides it has changed,
757
740
                    # we will unconditionally record a new version even if some
758
741
                    # other process reverts it while commit is running (with
759
 
                    # the revert happening after iter_changes did its
 
742
                    # the revert happening after iter_changes did it's
760
743
                    # examination).
761
744
                    if change[7][1]:
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, controldir.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
945
913
        pointing to .bzr/repository.
946
914
    """
947
915
 
948
 
    # What class to use for a CommitBuilder. Often it's simpler to change this
 
916
    # What class to use for a CommitBuilder. Often its simpler to change this
949
917
    # in a Repository class subclass rather than to override
950
918
    # get_commit_builder.
951
919
    _commit_builder_class = CommitBuilder
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()))
1046
1009
                " id and insertion revid (%r, %r)"
1047
1010
                % (inv.revision_id, revision_id))
1048
1011
        if inv.root is None:
1049
 
            raise errors.RootMissing()
 
1012
            raise AssertionError()
1050
1013
        return self._add_inventory_checked(revision_id, inv, parents)
1051
1014
 
1052
1015
    def _add_inventory_checked(self, revision_id, inv, parents):
1056
1019
 
1057
1020
        :seealso: add_inventory, for the contract.
1058
1021
        """
1059
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
 
1022
        inv_lines = self._serialise_inventory_to_lines(inv)
1060
1023
        return self._inventory_add_lines(revision_id, parents,
1061
1024
            inv_lines, check_content=False)
1062
1025
 
1064
1027
                               parents, basis_inv=None, propagate_caches=False):
1065
1028
        """Add a new inventory expressed as a delta against another revision.
1066
1029
 
1067
 
        See the inventory developers documentation for the theory behind
1068
 
        inventory deltas.
1069
 
 
1070
1030
        :param basis_revision_id: The inventory id the delta was created
1071
1031
            against. (This does not have to be a direct parent.)
1072
1032
        :param delta: The inventory delta (see Inventory.apply_delta for
1111
1071
        check_content=True):
1112
1072
        """Store lines in inv_vf and return the sha1 of the inventory."""
1113
1073
        parents = [(parent,) for parent in parents]
1114
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
1074
        return self.inventories.add_lines((revision_id,), parents, lines,
1115
1075
            check_content=check_content)[0]
1116
 
        self.inventories._access.flush()
1117
 
        return result
1118
1076
 
1119
1077
    def add_revision(self, revision_id, rev, inv=None, config=None):
1120
1078
        """Add rev to the revision store as revision_id.
1196
1154
        # The old API returned a list, should this actually be a set?
1197
1155
        return parent_map.keys()
1198
1156
 
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
1157
    @staticmethod
1313
1158
    def create(a_bzrdir):
1314
1159
        """Construct the current default format repository in a_bzrdir."""
1319
1164
 
1320
1165
        :param _format: The format of the repository on disk.
1321
1166
        :param a_bzrdir: The BzrDir of the repository.
 
1167
 
 
1168
        In the future we will have a single api for all stores for
 
1169
        getting file texts, inventories and revisions, then
 
1170
        this construct will accept instances of those things.
1322
1171
        """
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
1172
        super(Repository, self).__init__()
1327
1173
        self._format = _format
1328
1174
        # the following are part of the public API for Repository:
1334
1180
        self._reconcile_does_inventory_gc = True
1335
1181
        self._reconcile_fixes_text_parents = False
1336
1182
        self._reconcile_backsup_inventory = True
 
1183
        # not right yet - should be more semantically clear ?
 
1184
        #
 
1185
        # TODO: make sure to construct the right store classes, etc, depending
 
1186
        # on whether escaping is required.
 
1187
        self._warn_if_deprecated()
1337
1188
        self._write_group = None
1338
1189
        # Additional places to query for data.
1339
1190
        self._fallback_repositories = []
1340
1191
        # An InventoryEntry cache, used during deserialization
1341
1192
        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
1193
 
1354
1194
    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
 
1195
        return '%s(%r)' % (self.__class__.__name__,
 
1196
                           self.base)
1374
1197
 
1375
1198
    def has_same_location(self, other):
1376
1199
        """Returns a boolean indicating if this repository is at the same
1404
1227
        data during reads, and allows a 'write_group' to be obtained. Write
1405
1228
        groups must be used for actual data insertion.
1406
1229
 
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
1230
        :param token: if this is already locked, then lock_write will fail
1414
1231
            unless the token matches the existing lock.
1415
1232
        :returns: a token if this instance supports tokens, otherwise None.
1418
1235
        :raises MismatchedToken: if the specified token doesn't match the token
1419
1236
            of the existing lock.
1420
1237
        :seealso: start_write_group.
1421
 
        :return: A RepositoryWriteLockResult.
 
1238
 
 
1239
        A token should be passed in if you know that you have locked the object
 
1240
        some other way, and need to synchronise this object's state with that
 
1241
        fact.
 
1242
 
 
1243
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1422
1244
        """
1423
1245
        locked = self.is_locked()
1424
 
        token = self.control_files.lock_write(token=token)
 
1246
        result = self.control_files.lock_write(token=token)
1425
1247
        if not locked:
1426
 
            self._warn_if_deprecated()
1427
 
            self._note_lock('w')
1428
1248
            for repo in self._fallback_repositories:
1429
1249
                # Writes don't affect fallback repos
1430
1250
                repo.lock_read()
1431
1251
            self._refresh_data()
1432
 
        return RepositoryWriteLockResult(self.unlock, token)
 
1252
        return result
1433
1253
 
1434
1254
    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
1255
        locked = self.is_locked()
1441
1256
        self.control_files.lock_read()
1442
1257
        if not locked:
1443
 
            self._warn_if_deprecated()
1444
 
            self._note_lock('r')
1445
1258
            for repo in self._fallback_repositories:
1446
1259
                repo.lock_read()
1447
1260
            self._refresh_data()
1448
 
        return LogicalLockResult(self.unlock)
1449
1261
 
1450
1262
    def get_physical_lock_status(self):
1451
1263
        return self.control_files.get_physical_lock_status()
1511
1323
 
1512
1324
        # now gather global repository information
1513
1325
        # XXX: This is available for many repos regardless of listability.
1514
 
        if self.user_transport.listable():
 
1326
        if self.bzrdir.root_transport.listable():
1515
1327
            # XXX: do we want to __define len__() ?
1516
1328
            # Maybe the versionedfiles object should provide a different
1517
1329
            # method to get the number of keys.
1527
1339
        :param using: If True, list only branches using this repository.
1528
1340
        """
1529
1341
        if using and not self.is_shared():
1530
 
            return self.bzrdir.list_branches()
 
1342
            try:
 
1343
                return [self.bzrdir.open_branch()]
 
1344
            except errors.NotBranchError:
 
1345
                return []
1531
1346
        class Evaluator(object):
1532
1347
 
1533
1348
            def __init__(self):
1542
1357
                    except errors.NoRepositoryPresent:
1543
1358
                        pass
1544
1359
                    else:
1545
 
                        return False, ([], repository)
 
1360
                        return False, (None, repository)
1546
1361
                self.first_call = False
1547
 
                value = (bzrdir.list_branches(), None)
 
1362
                try:
 
1363
                    value = (bzrdir.open_branch(), None)
 
1364
                except errors.NotBranchError:
 
1365
                    value = (None, None)
1548
1366
                return True, value
1549
1367
 
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)
 
1368
        branches = []
 
1369
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1370
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
1371
            if branch is not None:
 
1372
                branches.append(branch)
1555
1373
            if not using and repository is not None:
1556
 
                ret.extend(repository.find_branches())
1557
 
        return ret
 
1374
                branches.extend(repository.find_branches())
 
1375
        return branches
1558
1376
 
1559
1377
    @needs_read_lock
1560
1378
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1589
1407
        """Commit the contents accrued within the current write group.
1590
1408
 
1591
1409
        :seealso: start_write_group.
1592
 
        
1593
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1594
1410
        """
1595
1411
        if self._write_group is not self.get_transaction():
1596
1412
            # has an unlock or relock occured ?
1597
1413
            raise errors.BzrError('mismatched lock context %r and '
1598
1414
                'write group %r.' %
1599
1415
                (self.get_transaction(), self._write_group))
1600
 
        result = self._commit_write_group()
 
1416
        self._commit_write_group()
1601
1417
        self._write_group = None
1602
 
        return result
1603
1418
 
1604
1419
    def _commit_write_group(self):
1605
1420
        """Template method for per-repository write group cleanup.
1650
1465
        # but at the moment we're only checking for texts referenced by
1651
1466
        # inventories at the graph's edge.
1652
1467
        key_deps = self.revisions._index._key_dependencies
1653
 
        key_deps.satisfy_refs_for_keys(present_inventories)
 
1468
        key_deps.add_keys(present_inventories)
1654
1469
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1655
1470
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1656
1471
        missing_texts = set()
1669
1484
        return missing_keys
1670
1485
 
1671
1486
    def refresh_data(self):
1672
 
        """Re-read any data needed to synchronise with disk.
 
1487
        """Re-read any data needed to to synchronise with disk.
1673
1488
 
1674
1489
        This method is intended to be called after another repository instance
1675
1490
        (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.
 
1491
        repository. It may not be called during a write group, but may be
 
1492
        called at any other time.
1681
1493
        """
 
1494
        if self.is_in_write_group():
 
1495
            raise errors.InternalBzrError(
 
1496
                "May not refresh_data while in a write group.")
1682
1497
        self._refresh_data()
1683
1498
 
1684
1499
    def resume_write_group(self, tokens):
1722
1537
            raise errors.InternalBzrError(
1723
1538
                "May not fetch while in a write group.")
1724
1539
        # 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)):
 
1540
        if self.has_same_location(source) and fetch_spec is None:
1730
1541
            # check that last_revision is in 'from' and then return a
1731
1542
            # no-operation.
1732
1543
            if (revision_id is not None and
1757
1568
        :param revprops: Optional dictionary of revision properties.
1758
1569
        :param revision_id: Optional revision id.
1759
1570
        """
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
1571
        result = self._commit_builder_class(self, parents, config,
1765
1572
            timestamp, timezone, committer, revprops, revision_id)
1766
1573
        self.start_write_group()
1767
1574
        return result
1768
1575
 
1769
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1770
1576
    def unlock(self):
1771
1577
        if (self.control_files._lock_count == 1 and
1772
1578
            self.control_files._lock_mode == 'w'):
1894
1700
 
1895
1701
    @needs_read_lock
1896
1702
    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
 
        """
 
1703
        """Get many revisions at once."""
1902
1704
        return self._get_revisions(revision_ids)
1903
1705
 
1904
1706
    @needs_read_lock
1905
1707
    def _get_revisions(self, revision_ids):
1906
1708
        """Core work logic to get many revisions without sanity checks."""
 
1709
        for rev_id in revision_ids:
 
1710
            if not rev_id or not isinstance(rev_id, basestring):
 
1711
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1712
        keys = [(key,) for key in revision_ids]
 
1713
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1907
1714
        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
 
1715
        for record in stream:
 
1716
            if record.storage_kind == 'absent':
 
1717
                raise errors.NoSuchRevision(self, record.key[0])
 
1718
            text = record.get_bytes_as('fulltext')
 
1719
            rev = self._serializer.read_revision_from_string(text)
 
1720
            revs[record.key[0]] = rev
1912
1721
        return [revs[revid] for revid in revision_ids]
1913
1722
 
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)
 
1723
    @needs_read_lock
 
1724
    def get_revision_xml(self, revision_id):
 
1725
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1726
        #       would have already do it.
 
1727
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1728
        # TODO: this can't just be replaced by:
 
1729
        # return self._serializer.write_revision_to_string(
 
1730
        #     self.get_revision(revision_id))
 
1731
        # as cStringIO preservers the encoding unlike write_revision_to_string
 
1732
        # or some other call down the path.
 
1733
        rev = self.get_revision(revision_id)
 
1734
        rev_tmp = cStringIO.StringIO()
 
1735
        # the current serializer..
 
1736
        self._serializer.write_revision(rev, rev_tmp)
 
1737
        rev_tmp.seek(0)
 
1738
        return rev_tmp.getvalue()
1940
1739
 
1941
1740
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1942
1741
        """Produce a generator of revision deltas.
2120
1919
                    yield line, revid
2121
1920
 
2122
1921
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
2123
 
        revision_keys):
 
1922
        revision_ids):
2124
1923
        """Helper routine for fileids_altered_by_revision_ids.
2125
1924
 
2126
1925
        This performs the translation of xml lines to revision ids.
2127
1926
 
2128
1927
        :param line_iterator: An iterator of lines, origin_version_id
2129
 
        :param revision_keys: The revision ids to filter for. This should be a
 
1928
        :param revision_ids: The revision ids to filter for. This should be a
2130
1929
            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.
 
1930
            the revision id from each parsed line will be looked up in the
 
1931
            revision_ids filter.
2133
1932
        :return: a dictionary mapping altered file-ids to an iterable of
2134
1933
        revision_ids. Each altered file-ids has the exact revision_ids that
2135
1934
        altered it listed explicitly.
2136
1935
        """
2137
1936
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
2138
1937
                line_iterator).iterkeys())
2139
 
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
 
1938
        # Note that revision_ids are revision keys.
 
1939
        parent_maps = self.revisions.get_parent_map(revision_ids)
 
1940
        parents = set()
 
1941
        map(parents.update, parent_maps.itervalues())
 
1942
        parents.difference_update(revision_ids)
2140
1943
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
2141
 
            self._inventory_xml_lines_for_keys(parent_keys)))
 
1944
            self._inventory_xml_lines_for_keys(parents)))
2142
1945
        new_keys = seen - parent_seen
2143
1946
        result = {}
2144
1947
        setdefault = result.setdefault
2146
1949
            setdefault(key[0], set()).add(key[-1])
2147
1950
        return result
2148
1951
 
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
1952
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
2177
1953
        """Find the file ids and versions affected by revisions.
2178
1954
 
2185
1961
        """
2186
1962
        selected_keys = set((revid,) for revid in revision_ids)
2187
1963
        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)
 
1964
        pb = ui.ui_factory.nested_progress_bar()
 
1965
        try:
 
1966
            return self._find_file_ids_from_xml_inventory_lines(
 
1967
                w.iter_lines_added_or_present_in_keys(
 
1968
                    selected_keys, pb=pb),
 
1969
                selected_keys)
 
1970
        finally:
 
1971
            pb.finished()
2192
1972
 
2193
1973
    def iter_files_bytes(self, desired_files):
2194
1974
        """Iterate through file versions.
2276
2056
                batch_size]
2277
2057
            if not to_query:
2278
2058
                break
2279
 
            for revision_id in to_query:
 
2059
            for rev_tree in self.revision_trees(to_query):
 
2060
                revision_id = rev_tree.get_revision_id()
2280
2061
                parent_ids = ancestors[revision_id]
2281
2062
                for text_key in revision_keys[revision_id]:
2282
2063
                    pb.update("Calculating text parents", processed_texts)
2355
2136
        num_file_ids = len(file_ids)
2356
2137
        for file_id, altered_versions in file_ids.iteritems():
2357
2138
            if pb is not None:
2358
 
                pb.update("Fetch texts", count, num_file_ids)
 
2139
                pb.update("fetch texts", count, num_file_ids)
2359
2140
            count += 1
2360
2141
            yield ("file", file_id, altered_versions)
2361
2142
 
2382
2163
        """Get Inventory object by revision id."""
2383
2164
        return self.iter_inventories([revision_id]).next()
2384
2165
 
2385
 
    def iter_inventories(self, revision_ids, ordering=None):
 
2166
    def iter_inventories(self, revision_ids):
2386
2167
        """Get many inventories by revision_ids.
2387
2168
 
2388
2169
        This will buffer some or all of the texts used in constructing the
2390
2171
        time.
2391
2172
 
2392
2173
        :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
2174
        :return: An iterator of inventories.
2397
2175
        """
2398
2176
        if ((None in revision_ids)
2399
2177
            or (_mod_revision.NULL_REVISION in revision_ids)):
2400
2178
            raise ValueError('cannot get null revision inventory')
2401
 
        return self._iter_inventories(revision_ids, ordering)
 
2179
        return self._iter_inventories(revision_ids)
2402
2180
 
2403
 
    def _iter_inventories(self, revision_ids, ordering):
 
2181
    def _iter_inventories(self, revision_ids):
2404
2182
        """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)
 
2183
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
 
2184
            yield self.deserialise_inventory(revision_id, text)
2408
2185
 
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
 
2186
    def _iter_inventory_xmls(self, revision_ids):
2415
2187
        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)
 
2188
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2422
2189
        text_chunks = {}
2423
2190
        for record in stream:
2424
2191
            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]
 
2192
                text_chunks[record.key] = record.get_bytes_as('chunked')
2430
2193
            else:
2431
2194
                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
 
2195
        for key in keys:
 
2196
            chunks = text_chunks.pop(key)
 
2197
            yield ''.join(chunks), key[-1]
2444
2198
 
2445
 
    def _deserialise_inventory(self, revision_id, xml):
 
2199
    def deserialise_inventory(self, revision_id, xml):
2446
2200
        """Transform the xml into an inventory object.
2447
2201
 
2448
2202
        :param revision_id: The expected revision id of the inventory.
2449
2203
        :param xml: A serialised inventory.
2450
2204
        """
2451
2205
        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)
 
2206
                    entry_cache=self._inventory_entry_cache)
2454
2207
        if result.revision_id != revision_id:
2455
2208
            raise AssertionError('revision id mismatch %s != %s' % (
2456
2209
                result.revision_id, revision_id))
2457
2210
        return result
2458
2211
 
 
2212
    def serialise_inventory(self, inv):
 
2213
        return self._serializer.write_inventory_to_string(inv)
 
2214
 
 
2215
    def _serialise_inventory_to_lines(self, inv):
 
2216
        return self._serializer.write_inventory_to_lines(inv)
 
2217
 
2459
2218
    def get_serializer_format(self):
2460
2219
        return self._serializer.format_num
2461
2220
 
2462
2221
    @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')
 
2222
    def get_inventory_xml(self, revision_id):
 
2223
        """Get inventory XML as a file object."""
 
2224
        texts = self._iter_inventory_xmls([revision_id])
2466
2225
        try:
2467
2226
            text, revision_id = texts.next()
2468
2227
        except StopIteration:
2469
2228
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2470
2229
        return text
2471
2230
 
 
2231
    @needs_read_lock
 
2232
    def get_inventory_sha1(self, revision_id):
 
2233
        """Return the sha1 hash of the inventory entry
 
2234
        """
 
2235
        return self.get_revision(revision_id).inventory_sha1
 
2236
 
2472
2237
    def get_rev_id_for_revno(self, revno, known_pair):
2473
2238
        """Return the revision id of a revno, given a later (revno, revid)
2474
2239
        pair in the same history.
2511
2276
            ancestors will be traversed.
2512
2277
        """
2513
2278
        graph = self.get_graph()
2514
 
        stop_revisions = (None, _mod_revision.NULL_REVISION)
2515
 
        return graph.iter_lefthand_ancestry(revision_id, stop_revisions)
 
2279
        next_id = revision_id
 
2280
        while True:
 
2281
            if next_id in (None, _mod_revision.NULL_REVISION):
 
2282
                return
 
2283
            try:
 
2284
                parents = graph.get_parent_map([next_id])[next_id]
 
2285
            except KeyError:
 
2286
                raise errors.RevisionNotPresent(next_id, self)
 
2287
            yield next_id
 
2288
            if len(parents) == 0:
 
2289
                return
 
2290
            else:
 
2291
                next_id = parents[0]
 
2292
 
 
2293
    @needs_read_lock
 
2294
    def get_revision_inventory(self, revision_id):
 
2295
        """Return inventory of a past revision."""
 
2296
        # TODO: Unify this with get_inventory()
 
2297
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
2298
        # must be the same as its revision, so this is trivial.
 
2299
        if revision_id is None:
 
2300
            # This does not make sense: if there is no revision,
 
2301
            # then it is the current tree inventory surely ?!
 
2302
            # and thus get_root_id() is something that looks at the last
 
2303
            # commit on the branch, and the get_root_id is an inventory check.
 
2304
            raise NotImplementedError
 
2305
            # return Inventory(self.get_root_id())
 
2306
        else:
 
2307
            return self.get_inventory(revision_id)
2516
2308
 
2517
2309
    def is_shared(self):
2518
2310
        """Return True if this repository is flagged as a shared repository."""
2553
2345
            return RevisionTree(self, Inventory(root_id=None),
2554
2346
                                _mod_revision.NULL_REVISION)
2555
2347
        else:
2556
 
            inv = self.get_inventory(revision_id)
 
2348
            inv = self.get_revision_inventory(revision_id)
2557
2349
            return RevisionTree(self, inv, revision_id)
2558
2350
 
2559
2351
    def revision_trees(self, revision_ids):
2612
2404
            keys = tsort.topo_sort(parent_map)
2613
2405
        return [None] + list(keys)
2614
2406
 
2615
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
2407
    def pack(self):
2616
2408
        """Compress the data within the repository.
2617
2409
 
2618
2410
        This operation only makes sense for some repository types. For other
2619
2411
        types it should be a no-op that just returns.
2620
2412
 
2621
2413
        This stub method does not require a lock, but subclasses should use
2622
 
        @needs_write_lock as this is a long running call it's reasonable to
 
2414
        @needs_write_lock as this is a long running call its reasonable to
2623
2415
        implicitly lock for the user.
2624
 
 
2625
 
        :param hint: If not supplied, the whole repository is packed.
2626
 
            If supplied, the repository may use the hint parameter as a
2627
 
            hint for the parts of the repository to pack. A hint can be
2628
 
            obtained from the result of commit_write_group(). Out of
2629
 
            date hints are simply ignored, because concurrent operations
2630
 
            can obsolete them rapidly.
2631
 
 
2632
 
        :param clean_obsolete_packs: Clean obsolete packs immediately after
2633
 
            the pack operation.
2634
2416
        """
2635
2417
 
2636
2418
    def get_transaction(self):
2652
2434
        for ((revision_id,), parent_keys) in \
2653
2435
                self.revisions.get_parent_map(query_keys).iteritems():
2654
2436
            if parent_keys:
2655
 
                result[revision_id] = tuple([parent_revid
2656
 
                    for (parent_revid,) in parent_keys])
 
2437
                result[revision_id] = tuple(parent_revid
 
2438
                    for (parent_revid,) in parent_keys)
2657
2439
            else:
2658
2440
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2659
2441
        return result
2661
2443
    def _make_parents_provider(self):
2662
2444
        return self
2663
2445
 
2664
 
    @needs_read_lock
2665
 
    def get_known_graph_ancestry(self, revision_ids):
2666
 
        """Return the known graph for a set of revision ids and their ancestors.
2667
 
        """
2668
 
        st = static_tuple.StaticTuple
2669
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
2670
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
2671
 
        return graph.GraphThunkIdsToKeys(known_graph)
2672
 
 
2673
2446
    def get_graph(self, other_repository=None):
2674
2447
        """Return the graph walker for this repository format"""
2675
2448
        parents_provider = self._make_parents_provider()
2679
2452
                [parents_provider, other_repository._make_parents_provider()])
2680
2453
        return graph.Graph(parents_provider)
2681
2454
 
2682
 
    def _get_versioned_file_checker(self, text_key_references=None,
2683
 
        ancestors=None):
 
2455
    def _get_versioned_file_checker(self, text_key_references=None):
2684
2456
        """Return an object suitable for checking versioned files.
2685
2457
        
2686
2458
        :param text_key_references: if non-None, an already built
2688
2460
            to whether they were referred to by the inventory of the
2689
2461
            revision_id that they contain. If None, this will be
2690
2462
            calculated.
2691
 
        :param ancestors: Optional result from
2692
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2693
 
            available.
2694
2463
        """
2695
2464
        return _VersionedFileChecker(self,
2696
 
            text_key_references=text_key_references, ancestors=ancestors)
 
2465
            text_key_references=text_key_references)
2697
2466
 
2698
2467
    def revision_ids_to_search_result(self, result_set):
2699
2468
        """Convert a set of revision ids to a graph SearchResult."""
2749
2518
        return record.get_bytes_as('fulltext')
2750
2519
 
2751
2520
    @needs_read_lock
2752
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
2521
    def check(self, revision_ids=None):
2753
2522
        """Check consistency of all history of given revision_ids.
2754
2523
 
2755
2524
        Different repository implementations should override _check().
2756
2525
 
2757
2526
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2758
2527
             will be checked.  Typically the last revision_id of a branch.
2759
 
        :param callback_refs: A dict of check-refs to resolve and callback
2760
 
            the check/_check method on the items listed as wanting the ref.
2761
 
            see bzrlib.check.
2762
 
        :param check_repo: If False do not check the repository contents, just 
2763
 
            calculate the data callback_refs requires and call them back.
2764
2528
        """
2765
 
        return self._check(revision_ids, callback_refs=callback_refs,
2766
 
            check_repo=check_repo)
 
2529
        return self._check(revision_ids)
2767
2530
 
2768
 
    def _check(self, revision_ids, callback_refs, check_repo):
2769
 
        result = check.Check(self, check_repo=check_repo)
2770
 
        result.check(callback_refs)
 
2531
    def _check(self, revision_ids):
 
2532
        result = check.Check(self)
 
2533
        result.check()
2771
2534
        return result
2772
2535
 
2773
 
    def _warn_if_deprecated(self, branch=None):
 
2536
    def _warn_if_deprecated(self):
2774
2537
        global _deprecation_warning_done
2775
2538
        if _deprecation_warning_done:
2776
2539
            return
2777
 
        try:
2778
 
            if branch is None:
2779
 
                conf = config.GlobalConfig()
2780
 
            else:
2781
 
                conf = branch.get_config()
2782
 
            if conf.suppress_warning('format_deprecation'):
2783
 
                return
2784
 
            warning("Format %s for %s is deprecated -"
2785
 
                    " please use 'bzr upgrade' to get better performance"
2786
 
                    % (self._format, self.bzrdir.transport.base))
2787
 
        finally:
2788
 
            _deprecation_warning_done = True
 
2540
        _deprecation_warning_done = True
 
2541
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
2542
                % (self._format, self.bzrdir.transport.base))
2789
2543
 
2790
2544
    def supports_rich_root(self):
2791
2545
        return self._format.rich_root_data
3067
2821
    # Does this format have < O(tree_size) delta generation. Used to hint what
3068
2822
    # code path for commit, amongst other things.
3069
2823
    fast_deltas = None
3070
 
    # Does doing a pack operation compress data? Useful for the pack UI command
3071
 
    # (so if there is one pack, the operation can still proceed because it may
3072
 
    # help), and for fetching when data won't have come from the same
3073
 
    # compressor.
3074
 
    pack_compresses = False
3075
 
    # Does the repository inventory storage understand references to trees?
3076
 
    supports_tree_reference = None
3077
 
    # Is the format experimental ?
3078
 
    experimental = False
3079
2824
 
3080
 
    def __repr__(self):
3081
 
        return "%s()" % self.__class__.__name__
 
2825
    def __str__(self):
 
2826
        return "<%s>" % self.__class__.__name__
3082
2827
 
3083
2828
    def __eq__(self, other):
3084
2829
        # format objects are generally stateless
3097
2842
        """
3098
2843
        try:
3099
2844
            transport = a_bzrdir.get_repository_transport(None)
3100
 
            format_string = transport.get_bytes("format")
 
2845
            format_string = transport.get("format").read()
3101
2846
            return format_registry.get(format_string)
3102
2847
        except errors.NoSuchFile:
3103
2848
            raise errors.NoRepositoryPresent(a_bzrdir)
3185
2930
        raise NotImplementedError(self.network_name)
3186
2931
 
3187
2932
    def check_conversion_target(self, target_format):
3188
 
        if self.rich_root_data and not target_format.rich_root_data:
3189
 
            raise errors.BadConversionTarget(
3190
 
                'Does not support rich root data.', target_format,
3191
 
                from_format=self)
3192
 
        if (self.supports_tree_reference and 
3193
 
            not getattr(target_format, 'supports_tree_reference', False)):
3194
 
            raise errors.BadConversionTarget(
3195
 
                'Does not support nested trees', target_format,
3196
 
                from_format=self)
 
2933
        raise NotImplementedError(self.check_conversion_target)
3197
2934
 
3198
2935
    def open(self, a_bzrdir, _found=False):
3199
2936
        """Return an instance of this format for the bzrdir a_bzrdir.
3202
2939
        """
3203
2940
        raise NotImplementedError(self.open)
3204
2941
 
3205
 
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
3206
 
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
3207
 
        hooks = BzrDir.hooks['post_repo_init']
3208
 
        if not hooks:
3209
 
            return
3210
 
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
3211
 
        for hook in hooks:
3212
 
            hook(params)
3213
 
 
3214
2942
 
3215
2943
class MetaDirRepositoryFormat(RepositoryFormat):
3216
2944
    """Common base class for the new repositories using the metadir layout."""
3378
3106
    'bzrlib.repofmt.groupcompress_repo',
3379
3107
    'RepositoryFormat2a',
3380
3108
    )
3381
 
format_registry.register_lazy(
3382
 
    'Bazaar development format 8\n',
3383
 
    'bzrlib.repofmt.groupcompress_repo',
3384
 
    'RepositoryFormat2aSubtree',
3385
 
    )
3386
3109
 
3387
3110
 
3388
3111
class InterRepository(InterObject):
3426
3149
 
3427
3150
        :param revision_id: if None all content is copied, if NULL_REVISION no
3428
3151
                            content is copied.
3429
 
        :param pb: ignored.
 
3152
        :param pb: optional progress bar to use for progress reports. If not
 
3153
                   provided a default one will be created.
3430
3154
        :return: None.
3431
3155
        """
3432
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3433
3156
        from bzrlib.fetch import RepoFetcher
3434
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
3435
 
        if self.source._format.network_name() != self.target._format.network_name():
3436
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
3437
 
                from_format=self.source._format,
3438
 
                to_format=self.target._format)
3439
3157
        f = RepoFetcher(to_repository=self.target,
3440
3158
                               from_repository=self.source,
3441
3159
                               last_revision=revision_id,
3442
3160
                               fetch_spec=fetch_spec,
3443
 
                               find_ghosts=find_ghosts)
 
3161
                               pb=pb, find_ghosts=find_ghosts)
3444
3162
 
3445
3163
    def _walk_to_common_revisions(self, revision_ids):
3446
3164
        """Walk out from revision_ids in source to revisions target has.
3615
3333
                self.target.texts.insert_record_stream(
3616
3334
                    self.source.texts.get_record_stream(
3617
3335
                        self.source.texts.keys(), 'topological', False))
3618
 
                pb.update('Copying inventory', 0, 1)
 
3336
                pb.update('copying inventory', 0, 1)
3619
3337
                self.target.inventories.insert_record_stream(
3620
3338
                    self.source.inventories.get_record_stream(
3621
3339
                        self.source.inventories.keys(), 'topological', False))
3735
3453
        return self.source.revision_ids_to_search_result(result_set)
3736
3454
 
3737
3455
 
 
3456
class InterPackRepo(InterSameDataRepository):
 
3457
    """Optimised code paths between Pack based repositories."""
 
3458
 
 
3459
    @classmethod
 
3460
    def _get_repo_format_to_test(self):
 
3461
        from bzrlib.repofmt import pack_repo
 
3462
        return pack_repo.RepositoryFormatKnitPack6RichRoot()
 
3463
 
 
3464
    @staticmethod
 
3465
    def is_compatible(source, target):
 
3466
        """Be compatible with known Pack formats.
 
3467
 
 
3468
        We don't test for the stores being of specific types because that
 
3469
        could lead to confusing results, and there is no need to be
 
3470
        overly general.
 
3471
 
 
3472
        InterPackRepo does not support CHK based repositories.
 
3473
        """
 
3474
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
3475
        from bzrlib.repofmt.groupcompress_repo import RepositoryFormatCHK1
 
3476
        try:
 
3477
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
3478
                isinstance(target._format, RepositoryFormatPack))
 
3479
            not_packs = (isinstance(source._format, RepositoryFormatCHK1) or
 
3480
                isinstance(target._format, RepositoryFormatCHK1))
 
3481
        except AttributeError:
 
3482
            return False
 
3483
        if not_packs or not are_packs:
 
3484
            return False
 
3485
        return InterRepository._same_model(source, target)
 
3486
 
 
3487
    @needs_write_lock
 
3488
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
 
3489
            fetch_spec=None):
 
3490
        """See InterRepository.fetch()."""
 
3491
        if (len(self.source._fallback_repositories) > 0 or
 
3492
            len(self.target._fallback_repositories) > 0):
 
3493
            # The pack layer is not aware of fallback repositories, so when
 
3494
            # fetching from a stacked repository or into a stacked repository
 
3495
            # we use the generic fetch logic which uses the VersionedFiles
 
3496
            # attributes on repository.
 
3497
            from bzrlib.fetch import RepoFetcher
 
3498
            fetcher = RepoFetcher(self.target, self.source, revision_id,
 
3499
                    pb, find_ghosts, fetch_spec=fetch_spec)
 
3500
        if fetch_spec is not None:
 
3501
            if len(list(fetch_spec.heads)) != 1:
 
3502
                raise AssertionError(
 
3503
                    "InterPackRepo.fetch doesn't support "
 
3504
                    "fetching multiple heads yet.")
 
3505
            revision_id = list(fetch_spec.heads)[0]
 
3506
            fetch_spec = None
 
3507
        if revision_id is None:
 
3508
            # TODO:
 
3509
            # everything to do - use pack logic
 
3510
            # to fetch from all packs to one without
 
3511
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
3512
            # till then:
 
3513
            source_revision_ids = frozenset(self.source.all_revision_ids())
 
3514
            revision_ids = source_revision_ids - \
 
3515
                frozenset(self.target.get_parent_map(source_revision_ids))
 
3516
            revision_keys = [(revid,) for revid in revision_ids]
 
3517
            index = self.target._pack_collection.revision_index.combined_index
 
3518
            present_revision_ids = set(item[1][0] for item in
 
3519
                index.iter_entries(revision_keys))
 
3520
            revision_ids = set(revision_ids) - present_revision_ids
 
3521
            # implementing the TODO will involve:
 
3522
            # - detecting when all of a pack is selected
 
3523
            # - avoiding as much as possible pre-selection, so the
 
3524
            # more-core routines such as create_pack_from_packs can filter in
 
3525
            # a just-in-time fashion. (though having a HEADS list on a
 
3526
            # repository might make this a lot easier, because we could
 
3527
            # sensibly detect 'new revisions' without doing a full index scan.
 
3528
        elif _mod_revision.is_null(revision_id):
 
3529
            # nothing to do:
 
3530
            return (0, [])
 
3531
        else:
 
3532
            revision_ids = self.search_missing_revision_ids(revision_id,
 
3533
                find_ghosts=find_ghosts).get_keys()
 
3534
            if len(revision_ids) == 0:
 
3535
                return (0, [])
 
3536
        return self._pack(self.source, self.target, revision_ids)
 
3537
 
 
3538
    def _pack(self, source, target, revision_ids):
 
3539
        from bzrlib.repofmt.pack_repo import Packer
 
3540
        packs = source._pack_collection.all_packs()
 
3541
        pack = Packer(self.target._pack_collection, packs, '.fetch',
 
3542
            revision_ids).pack()
 
3543
        if pack is not None:
 
3544
            self.target._pack_collection._save_pack_names()
 
3545
            copied_revs = pack.get_revision_count()
 
3546
            # Trigger an autopack. This may duplicate effort as we've just done
 
3547
            # a pack creation, but for now it is simpler to think about as
 
3548
            # 'upload data, then repack if needed'.
 
3549
            self.target._pack_collection.autopack()
 
3550
            return (copied_revs, [])
 
3551
        else:
 
3552
            return (0, [])
 
3553
 
 
3554
    @needs_read_lock
 
3555
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
3556
        """See InterRepository.missing_revision_ids().
 
3557
 
 
3558
        :param find_ghosts: Find ghosts throughout the ancestry of
 
3559
            revision_id.
 
3560
        """
 
3561
        if not find_ghosts and revision_id is not None:
 
3562
            return self._walk_to_common_revisions([revision_id])
 
3563
        elif revision_id is not None:
 
3564
            # Find ghosts: search for revisions pointing from one repository to
 
3565
            # the other, and vice versa, anywhere in the history of revision_id.
 
3566
            graph = self.target.get_graph(other_repository=self.source)
 
3567
            searcher = graph._make_breadth_first_searcher([revision_id])
 
3568
            found_ids = set()
 
3569
            while True:
 
3570
                try:
 
3571
                    next_revs, ghosts = searcher.next_with_ghosts()
 
3572
                except StopIteration:
 
3573
                    break
 
3574
                if revision_id in ghosts:
 
3575
                    raise errors.NoSuchRevision(self.source, revision_id)
 
3576
                found_ids.update(next_revs)
 
3577
                found_ids.update(ghosts)
 
3578
            found_ids = frozenset(found_ids)
 
3579
            # Double query here: should be able to avoid this by changing the
 
3580
            # graph api further.
 
3581
            result_set = found_ids - frozenset(
 
3582
                self.target.get_parent_map(found_ids))
 
3583
        else:
 
3584
            source_ids = self.source.all_revision_ids()
 
3585
            # source_ids is the worst possible case we may need to pull.
 
3586
            # now we want to filter source_ids against what we actually
 
3587
            # have in target, but don't try to check for existence where we know
 
3588
            # we do not have a revision as that would be pointless.
 
3589
            target_ids = set(self.target.all_revision_ids())
 
3590
            result_set = set(source_ids).difference(target_ids)
 
3591
        return self.source.revision_ids_to_search_result(result_set)
 
3592
 
 
3593
 
3738
3594
class InterDifferingSerializer(InterRepository):
3739
3595
 
3740
3596
    @classmethod
3747
3603
        # This is redundant with format.check_conversion_target(), however that
3748
3604
        # raises an exception, and we just want to say "False" as in we won't
3749
3605
        # support converting between these formats.
3750
 
        if 'IDS_never' in debug.debug_flags:
3751
 
            return False
3752
3606
        if source.supports_rich_root() and not target.supports_rich_root():
3753
3607
            return False
3754
3608
        if (source._format.supports_tree_reference
3755
3609
            and not target._format.supports_tree_reference):
3756
3610
            return False
3757
 
        if target._fallback_repositories and target._format.supports_chks:
3758
 
            # IDS doesn't know how to copy CHKs for the parent inventories it
3759
 
            # adds to stacked repos.
3760
 
            return False
3761
 
        if 'IDS_always' in debug.debug_flags:
3762
 
            return True
3763
 
        # Only use this code path for local source and target.  IDS does far
3764
 
        # too much IO (both bandwidth and roundtrips) over a network.
3765
 
        if not source.bzrdir.transport.base.startswith('file:///'):
3766
 
            return False
3767
 
        if not target.bzrdir.transport.base.startswith('file:///'):
3768
 
            return False
3769
3611
        return True
3770
3612
 
3771
 
    def _get_trees(self, revision_ids, cache):
3772
 
        possible_trees = []
3773
 
        for rev_id in revision_ids:
3774
 
            if rev_id in cache:
3775
 
                possible_trees.append((rev_id, cache[rev_id]))
3776
 
            else:
3777
 
                # Not cached, but inventory might be present anyway.
3778
 
                try:
3779
 
                    tree = self.source.revision_tree(rev_id)
3780
 
                except errors.NoSuchRevision:
3781
 
                    # Nope, parent is ghost.
3782
 
                    pass
3783
 
                else:
3784
 
                    cache[rev_id] = tree
3785
 
                    possible_trees.append((rev_id, tree))
3786
 
        return possible_trees
3787
 
 
3788
 
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
 
3613
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
3789
3614
        """Get the best delta and base for this revision.
3790
3615
 
3791
3616
        :return: (basis_id, delta)
3792
3617
        """
 
3618
        possible_trees = [(parent_id, cache[parent_id])
 
3619
                          for parent_id in parent_ids
 
3620
                           if parent_id in cache]
 
3621
        if len(possible_trees) == 0:
 
3622
            # There either aren't any parents, or the parents aren't in the
 
3623
            # cache, so just use the last converted tree
 
3624
            possible_trees.append((basis_id, cache[basis_id]))
3793
3625
        deltas = []
3794
 
        # Generate deltas against each tree, to find the shortest.
3795
 
        texts_possibly_new_in_tree = set()
3796
3626
        for basis_id, basis_tree in possible_trees:
3797
3627
            delta = tree.inventory._make_delta(basis_tree.inventory)
3798
 
            for old_path, new_path, file_id, new_entry in delta:
3799
 
                if new_path is None:
3800
 
                    # This file_id isn't present in the new rev, so we don't
3801
 
                    # care about it.
3802
 
                    continue
3803
 
                if not new_path:
3804
 
                    # Rich roots are handled elsewhere...
3805
 
                    continue
3806
 
                kind = new_entry.kind
3807
 
                if kind != 'directory' and kind != 'file':
3808
 
                    # No text record associated with this inventory entry.
3809
 
                    continue
3810
 
                # This is a directory or file that has changed somehow.
3811
 
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3812
3628
            deltas.append((len(delta), basis_id, delta))
3813
3629
        deltas.sort()
3814
3630
        return deltas[0][1:]
3815
3631
 
3816
 
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
3817
 
        """Find all parent revisions that are absent, but for which the
3818
 
        inventory is present, and copy those inventories.
 
3632
    def _get_parent_keys(self, root_key, parent_map):
 
3633
        """Get the parent keys for a given root id."""
 
3634
        root_id, rev_id = root_key
 
3635
        # Include direct parents of the revision, but only if they used
 
3636
        # the same root_id and are heads.
 
3637
        parent_keys = []
 
3638
        for parent_id in parent_map[rev_id]:
 
3639
            if parent_id == _mod_revision.NULL_REVISION:
 
3640
                continue
 
3641
            if parent_id not in self._revision_id_to_root_id:
 
3642
                # We probably didn't read this revision, go spend the
 
3643
                # extra effort to actually check
 
3644
                try:
 
3645
                    tree = self.source.revision_tree(parent_id)
 
3646
                except errors.NoSuchRevision:
 
3647
                    # Ghost, fill out _revision_id_to_root_id in case we
 
3648
                    # encounter this again.
 
3649
                    # But set parent_root_id to None since we don't really know
 
3650
                    parent_root_id = None
 
3651
                else:
 
3652
                    parent_root_id = tree.get_root_id()
 
3653
                self._revision_id_to_root_id[parent_id] = None
 
3654
            else:
 
3655
                parent_root_id = self._revision_id_to_root_id[parent_id]
 
3656
            if root_id == parent_root_id:
 
3657
                # With stacking we _might_ want to refer to a non-local
 
3658
                # revision, but this code path only applies when we have the
 
3659
                # full content available, so ghosts really are ghosts, not just
 
3660
                # the edge of local data.
 
3661
                parent_keys.append((parent_id,))
 
3662
            else:
 
3663
                # root_id may be in the parent anyway.
 
3664
                try:
 
3665
                    tree = self.source.revision_tree(parent_id)
 
3666
                except errors.NoSuchRevision:
 
3667
                    # ghost, can't refer to it.
 
3668
                    pass
 
3669
                else:
 
3670
                    try:
 
3671
                        parent_keys.append((tree.inventory[root_id].revision,))
 
3672
                    except errors.NoSuchId:
 
3673
                        # not in the tree
 
3674
                        pass
 
3675
        g = graph.Graph(self.source.revisions)
 
3676
        heads = g.heads(parent_keys)
 
3677
        selected_keys = []
 
3678
        for key in parent_keys:
 
3679
            if key in heads and key not in selected_keys:
 
3680
                selected_keys.append(key)
 
3681
        return tuple([(root_id,)+ key for key in selected_keys])
3819
3682
 
3820
 
        This is necessary to preserve correctness when the source is stacked
3821
 
        without fallbacks configured.  (Note that in cases like upgrade the
3822
 
        source may be not have _fallback_repositories even though it is
3823
 
        stacked.)
3824
 
        """
3825
 
        parent_revs = set()
3826
 
        for parents in parent_map.values():
3827
 
            parent_revs.update(parents)
3828
 
        present_parents = self.source.get_parent_map(parent_revs)
3829
 
        absent_parents = set(parent_revs).difference(present_parents)
3830
 
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
3831
 
            (rev_id,) for rev_id in absent_parents)
3832
 
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
3833
 
        for parent_tree in self.source.revision_trees(parent_inv_ids):
3834
 
            current_revision_id = parent_tree.get_revision_id()
3835
 
            parents_parents_keys = parent_invs_keys_for_stacking[
3836
 
                (current_revision_id,)]
3837
 
            parents_parents = [key[-1] for key in parents_parents_keys]
3838
 
            basis_id = _mod_revision.NULL_REVISION
3839
 
            basis_tree = self.source.revision_tree(basis_id)
3840
 
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
3841
 
            self.target.add_inventory_by_delta(
3842
 
                basis_id, delta, current_revision_id, parents_parents)
3843
 
            cache[current_revision_id] = parent_tree
 
3683
    def _new_root_data_stream(self, root_keys_to_create, parent_map):
 
3684
        for root_key in root_keys_to_create:
 
3685
            parent_keys = self._get_parent_keys(root_key, parent_map)
 
3686
            yield versionedfile.FulltextContentFactory(root_key,
 
3687
                parent_keys, None, '')
3844
3688
 
3845
3689
    def _fetch_batch(self, revision_ids, basis_id, cache):
3846
3690
        """Fetch across a few revisions.
3860
3704
        pending_deltas = []
3861
3705
        pending_revisions = []
3862
3706
        parent_map = self.source.get_parent_map(revision_ids)
3863
 
        self._fetch_parent_invs_for_stacking(parent_map, cache)
3864
 
        self.source._safe_to_return_from_cache = True
3865
3707
        for tree in self.source.revision_trees(revision_ids):
3866
 
            # Find a inventory delta for this revision.
3867
 
            # Find text entries that need to be copied, too.
3868
3708
            current_revision_id = tree.get_revision_id()
3869
3709
            parent_ids = parent_map.get(current_revision_id, ())
3870
 
            parent_trees = self._get_trees(parent_ids, cache)
3871
 
            possible_trees = list(parent_trees)
3872
 
            if len(possible_trees) == 0:
3873
 
                # There either aren't any parents, or the parents are ghosts,
3874
 
                # so just use the last converted tree.
3875
 
                possible_trees.append((basis_id, cache[basis_id]))
3876
3710
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3877
 
                                                           possible_trees)
3878
 
            revision = self.source.get_revision(current_revision_id)
3879
 
            pending_deltas.append((basis_id, delta,
3880
 
                current_revision_id, revision.parent_ids))
 
3711
                                                           basis_id, cache)
3881
3712
            if self._converting_to_rich_root:
3882
3713
                self._revision_id_to_root_id[current_revision_id] = \
3883
3714
                    tree.get_root_id()
3884
 
            # Determine which texts are in present in this revision but not in
3885
 
            # any of the available parents.
3886
 
            texts_possibly_new_in_tree = set()
 
3715
            # Find text entries that need to be copied
3887
3716
            for old_path, new_path, file_id, entry in delta:
3888
 
                if new_path is None:
3889
 
                    # This file_id isn't present in the new rev
3890
 
                    continue
3891
 
                if not new_path:
3892
 
                    # This is the root
3893
 
                    if not self.target.supports_rich_root():
3894
 
                        # The target doesn't support rich root, so we don't
3895
 
                        # copy
3896
 
                        continue
3897
 
                    if self._converting_to_rich_root:
3898
 
                        # This can't be copied normally, we have to insert
3899
 
                        # it specially
3900
 
                        root_keys_to_create.add((file_id, entry.revision))
3901
 
                        continue
3902
 
                kind = entry.kind
3903
 
                texts_possibly_new_in_tree.add((file_id, entry.revision))
3904
 
            for basis_id, basis_tree in possible_trees:
3905
 
                basis_inv = basis_tree.inventory
3906
 
                for file_key in list(texts_possibly_new_in_tree):
3907
 
                    file_id, file_revision = file_key
3908
 
                    try:
3909
 
                        entry = basis_inv[file_id]
3910
 
                    except errors.NoSuchId:
3911
 
                        continue
3912
 
                    if entry.revision == file_revision:
3913
 
                        texts_possibly_new_in_tree.remove(file_key)
3914
 
            text_keys.update(texts_possibly_new_in_tree)
 
3717
                if new_path is not None:
 
3718
                    if not new_path:
 
3719
                        # This is the root
 
3720
                        if not self.target.supports_rich_root():
 
3721
                            # The target doesn't support rich root, so we don't
 
3722
                            # copy
 
3723
                            continue
 
3724
                        if self._converting_to_rich_root:
 
3725
                            # This can't be copied normally, we have to insert
 
3726
                            # it specially
 
3727
                            root_keys_to_create.add((file_id, entry.revision))
 
3728
                            continue
 
3729
                    text_keys.add((file_id, entry.revision))
 
3730
            revision = self.source.get_revision(current_revision_id)
 
3731
            pending_deltas.append((basis_id, delta,
 
3732
                current_revision_id, revision.parent_ids))
3915
3733
            pending_revisions.append(revision)
3916
3734
            cache[current_revision_id] = tree
3917
3735
            basis_id = current_revision_id
3918
 
        self.source._safe_to_return_from_cache = False
3919
3736
        # Copy file texts
3920
3737
        from_texts = self.source.texts
3921
3738
        to_texts = self.target.texts
3922
3739
        if root_keys_to_create:
3923
 
            root_stream = _mod_fetch._new_root_data_stream(
3924
 
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
3925
 
                self.source)
 
3740
            root_stream = self._new_root_data_stream(root_keys_to_create,
 
3741
                                                     parent_map)
3926
3742
            to_texts.insert_record_stream(root_stream)
3927
3743
        to_texts.insert_record_stream(from_texts.get_record_stream(
3928
3744
            text_keys, self.target._format._fetch_order,
3935
3751
            # for the new revisions that we are about to insert.  We do this
3936
3752
            # before adding the revisions so that no revision is added until
3937
3753
            # all the inventories it may depend on are added.
3938
 
            # Note that this is overzealous, as we may have fetched these in an
3939
 
            # earlier batch.
3940
3754
            parent_ids = set()
3941
3755
            revision_ids = set()
3942
3756
            for revision in pending_revisions:
3945
3759
            parent_ids.difference_update(revision_ids)
3946
3760
            parent_ids.discard(_mod_revision.NULL_REVISION)
3947
3761
            parent_map = self.source.get_parent_map(parent_ids)
3948
 
            # we iterate over parent_map and not parent_ids because we don't
3949
 
            # want to try copying any revision which is a ghost
3950
 
            for parent_tree in self.source.revision_trees(parent_map):
 
3762
            for parent_tree in self.source.revision_trees(parent_ids):
 
3763
                basis_id, delta = self._get_delta_for_revision(tree, parent_ids, basis_id, cache)
3951
3764
                current_revision_id = parent_tree.get_revision_id()
3952
3765
                parents_parents = parent_map[current_revision_id]
3953
 
                possible_trees = self._get_trees(parents_parents, cache)
3954
 
                if len(possible_trees) == 0:
3955
 
                    # There either aren't any parents, or the parents are
3956
 
                    # ghosts, so just use the last converted tree.
3957
 
                    possible_trees.append((basis_id, cache[basis_id]))
3958
 
                basis_id, delta = self._get_delta_for_revision(parent_tree,
3959
 
                    parents_parents, possible_trees)
3960
3766
                self.target.add_inventory_by_delta(
3961
3767
                    basis_id, delta, current_revision_id, parents_parents)
3962
3768
        # insert signatures and revisions
3976
3782
 
3977
3783
        :param revision_ids: The list of revisions to fetch. Must be in
3978
3784
            topological order.
3979
 
        :param pb: A ProgressTask
 
3785
        :param pb: A ProgressBar
3980
3786
        :return: None
3981
3787
        """
3982
3788
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3984
3790
        cache = lru_cache.LRUCache(100)
3985
3791
        cache[basis_id] = basis_tree
3986
3792
        del basis_tree # We don't want to hang on to it here
3987
 
        hints = []
3988
 
        a_graph = None
3989
 
 
3990
3793
        for offset in range(0, len(revision_ids), batch_size):
3991
3794
            self.target.start_write_group()
3992
3795
            try:
3995
3798
                batch = revision_ids[offset:offset+batch_size]
3996
3799
                basis_id = self._fetch_batch(batch, basis_id, cache)
3997
3800
            except:
3998
 
                self.source._safe_to_return_from_cache = False
3999
3801
                self.target.abort_write_group()
4000
3802
                raise
4001
3803
            else:
4002
 
                hint = self.target.commit_write_group()
4003
 
                if hint:
4004
 
                    hints.extend(hint)
4005
 
        if hints and self.target._format.pack_compresses:
4006
 
            self.target.pack(hint=hints)
 
3804
                self.target.commit_write_group()
4007
3805
        pb.update('Transferring revisions', len(revision_ids),
4008
3806
                  len(revision_ids))
4009
3807
 
4013
3811
        """See InterRepository.fetch()."""
4014
3812
        if fetch_spec is not None:
4015
3813
            raise AssertionError("Not implemented yet...")
4016
 
        ui.ui_factory.warn_experimental_format_fetch(self)
4017
3814
        if (not self.source.supports_rich_root()
4018
3815
            and self.target.supports_rich_root()):
4019
3816
            self._converting_to_rich_root = True
4020
3817
            self._revision_id_to_root_id = {}
4021
3818
        else:
4022
3819
            self._converting_to_rich_root = False
4023
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
4024
 
        if self.source._format.network_name() != self.target._format.network_name():
4025
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
4026
 
                from_format=self.source._format,
4027
 
                to_format=self.target._format)
4028
3820
        revision_ids = self.target.search_missing_revision_ids(self.source,
4029
3821
            revision_id, find_ghosts=find_ghosts).get_keys()
4030
3822
        if not revision_ids:
4036
3828
        # Walk though all revisions; get inventory deltas, copy referenced
4037
3829
        # texts that delta references, insert the delta, revision and
4038
3830
        # signature.
 
3831
        first_rev = self.source.get_revision(revision_ids[0])
4039
3832
        if pb is None:
4040
3833
            my_pb = ui.ui_factory.nested_progress_bar()
4041
3834
            pb = my_pb
4065
3858
            basis_id = first_rev.parent_ids[0]
4066
3859
            # only valid as a basis if the target has it
4067
3860
            self.target.get_revision(basis_id)
4068
 
            # Try to get a basis tree - if it's a ghost it will hit the
 
3861
            # Try to get a basis tree - if its a ghost it will hit the
4069
3862
            # NoSuchRevision case.
4070
3863
            basis_tree = self.source.revision_tree(basis_id)
4071
3864
        except (IndexError, errors.NoSuchRevision):
4078
3871
InterRepository.register_optimiser(InterSameDataRepository)
4079
3872
InterRepository.register_optimiser(InterWeaveRepo)
4080
3873
InterRepository.register_optimiser(InterKnitRepo)
 
3874
InterRepository.register_optimiser(InterPackRepo)
4081
3875
 
4082
3876
 
4083
3877
class CopyConverter(object):
4099
3893
        :param to_convert: The disk object to convert.
4100
3894
        :param pb: a progress bar to use for progress information.
4101
3895
        """
4102
 
        pb = ui.ui_factory.nested_progress_bar()
 
3896
        self.pb = pb
4103
3897
        self.count = 0
4104
3898
        self.total = 4
4105
3899
        # this is only useful with metadir layouts - separated repo content.
4106
3900
        # trigger an assertion if not such
4107
3901
        repo._format.get_format_string()
4108
3902
        self.repo_dir = repo.bzrdir
4109
 
        pb.update('Moving repository to repository.backup')
 
3903
        self.step('Moving repository to repository.backup')
4110
3904
        self.repo_dir.transport.move('repository', 'repository.backup')
4111
3905
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4112
3906
        repo._format.check_conversion_target(self.target_format)
4113
3907
        self.source_repo = repo._format.open(self.repo_dir,
4114
3908
            _found=True,
4115
3909
            _override_transport=backup_transport)
4116
 
        pb.update('Creating new repository')
 
3910
        self.step('Creating new repository')
4117
3911
        converted = self.target_format.initialize(self.repo_dir,
4118
3912
                                                  self.source_repo.is_shared())
4119
3913
        converted.lock_write()
4120
3914
        try:
4121
 
            pb.update('Copying content')
 
3915
            self.step('Copying content into repository.')
4122
3916
            self.source_repo.copy_content_into(converted)
4123
3917
        finally:
4124
3918
            converted.unlock()
4125
 
        pb.update('Deleting old repository content')
 
3919
        self.step('Deleting old repository content.')
4126
3920
        self.repo_dir.transport.delete_tree('repository.backup')
4127
 
        ui.ui_factory.note('repository converted')
4128
 
        pb.finished()
 
3921
        self.pb.note('repository converted')
 
3922
 
 
3923
    def step(self, message):
 
3924
        """Update the pb by a step."""
 
3925
        self.count +=1
 
3926
        self.pb.update(message, self.count, self.total)
4129
3927
 
4130
3928
 
4131
3929
_unescape_map = {
4160
3958
 
4161
3959
class _VersionedFileChecker(object):
4162
3960
 
4163
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
3961
    def __init__(self, repository, text_key_references=None):
4164
3962
        self.repository = repository
4165
3963
        self.text_index = self.repository._generate_text_key_index(
4166
 
            text_key_references=text_key_references, ancestors=ancestors)
 
3964
            text_key_references=text_key_references)
4167
3965
 
4168
3966
    def calculate_file_version_parents(self, text_key):
4169
3967
        """Calculate the correct parents for a file version according to
4187
3985
            revision_id) tuples for versions that are present in this versioned
4188
3986
            file, but not used by the corresponding inventory.
4189
3987
        """
4190
 
        local_progress = None
4191
 
        if progress_bar is None:
4192
 
            local_progress = ui.ui_factory.nested_progress_bar()
4193
 
            progress_bar = local_progress
4194
 
        try:
4195
 
            return self._check_file_version_parents(texts, progress_bar)
4196
 
        finally:
4197
 
            if local_progress:
4198
 
                local_progress.finished()
4199
 
 
4200
 
    def _check_file_version_parents(self, texts, progress_bar):
4201
 
        """See check_file_version_parents."""
4202
3988
        wrong_parents = {}
4203
3989
        self.file_ids = set([file_id for file_id, _ in
4204
3990
            self.text_index.iterkeys()])
4205
3991
        # text keys is now grouped by file_id
 
3992
        n_weaves = len(self.file_ids)
 
3993
        files_in_revisions = {}
 
3994
        revisions_of_files = {}
4206
3995
        n_versions = len(self.text_index)
4207
3996
        progress_bar.update('loading text store', 0, n_versions)
4208
3997
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4210
3999
        text_keys = self.repository.texts.keys()
4211
4000
        unused_keys = frozenset(text_keys) - set(self.text_index)
4212
4001
        for num, key in enumerate(self.text_index.iterkeys()):
4213
 
            progress_bar.update('checking text graph', num, n_versions)
 
4002
            if progress_bar is not None:
 
4003
                progress_bar.update('checking text graph', num, n_versions)
4214
4004
            correct_parents = self.calculate_file_version_parents(key)
4215
4005
            try:
4216
4006
                knit_parents = parent_map[key]
4271
4061
                is_resume = False
4272
4062
            try:
4273
4063
                # locked_insert_stream performs a commit|suspend.
4274
 
                return self._locked_insert_stream(stream, src_format,
4275
 
                    is_resume)
 
4064
                return self._locked_insert_stream(stream, src_format, is_resume)
4276
4065
            except:
4277
4066
                self.target_repo.abort_write_group(suppress_errors=True)
4278
4067
                raise
4302
4091
            else:
4303
4092
                new_pack.set_write_cache_size(1024*1024)
4304
4093
        for substream_type, substream in stream:
4305
 
            if 'stream' in debug.debug_flags:
4306
 
                mutter('inserting substream: %s', substream_type)
4307
4094
            if substream_type == 'texts':
4308
4095
                self.target_repo.texts.insert_record_stream(substream)
4309
4096
            elif substream_type == 'inventories':
4313
4100
                else:
4314
4101
                    self._extract_and_insert_inventories(
4315
4102
                        substream, src_serializer)
4316
 
            elif substream_type == 'inventory-deltas':
4317
 
                self._extract_and_insert_inventory_deltas(
4318
 
                    substream, src_serializer)
4319
4103
            elif substream_type == 'chk_bytes':
4320
4104
                # XXX: This doesn't support conversions, as it assumes the
4321
4105
                #      conversion was done in the fetch code.
4325
4109
                # required if the serializers are different only in terms of
4326
4110
                # the inventory.
4327
4111
                if src_serializer == to_serializer:
4328
 
                    self.target_repo.revisions.insert_record_stream(substream)
 
4112
                    self.target_repo.revisions.insert_record_stream(
 
4113
                        substream)
4329
4114
                else:
4330
4115
                    self._extract_and_insert_revisions(substream,
4331
4116
                        src_serializer)
4351
4136
                ):
4352
4137
                if versioned_file is None:
4353
4138
                    continue
4354
 
                # TODO: key is often going to be a StaticTuple object
4355
 
                #       I don't believe we can define a method by which
4356
 
                #       (prefix,) + StaticTuple will work, though we could
4357
 
                #       define a StaticTuple.sq_concat that would allow you to
4358
 
                #       pass in either a tuple or a StaticTuple as the second
4359
 
                #       object, so instead we could have:
4360
 
                #       StaticTuple(prefix) + key here...
4361
4139
                missing_keys.update((prefix,) + key for key in
4362
4140
                    versioned_file.get_missing_compression_parent_keys())
4363
4141
        except NotImplementedError:
4372
4150
                # missing keys can handle suspending a write group).
4373
4151
                write_group_tokens = self.target_repo.suspend_write_group()
4374
4152
                return write_group_tokens, missing_keys
4375
 
        hint = self.target_repo.commit_write_group()
4376
 
        if (to_serializer != src_serializer and
4377
 
            self.target_repo._format.pack_compresses):
4378
 
            self.target_repo.pack(hint=hint)
 
4153
        self.target_repo.commit_write_group()
4379
4154
        return [], set()
4380
4155
 
4381
 
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
4382
 
        target_rich_root = self.target_repo._format.rich_root_data
4383
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4384
 
        for record in substream:
4385
 
            # Insert the delta directly
4386
 
            inventory_delta_bytes = record.get_bytes_as('fulltext')
4387
 
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
4388
 
            try:
4389
 
                parse_result = deserialiser.parse_text_bytes(
4390
 
                    inventory_delta_bytes)
4391
 
            except inventory_delta.IncompatibleInventoryDelta, err:
4392
 
                trace.mutter("Incompatible delta: %s", err.msg)
4393
 
                raise errors.IncompatibleRevision(self.target_repo._format)
4394
 
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
4395
 
            revision_id = new_id
4396
 
            parents = [key[0] for key in record.parents]
4397
 
            self.target_repo.add_inventory_by_delta(
4398
 
                basis_id, inv_delta, revision_id, parents)
4399
 
 
4400
 
    def _extract_and_insert_inventories(self, substream, serializer,
4401
 
            parse_delta=None):
 
4156
    def _extract_and_insert_inventories(self, substream, serializer):
4402
4157
        """Generate a new inventory versionedfile in target, converting data.
4403
4158
 
4404
4159
        The inventory is retrieved from the source, (deserializing it), and
4405
4160
        stored in the target (reserializing it in a different format).
4406
4161
        """
4407
 
        target_rich_root = self.target_repo._format.rich_root_data
4408
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4409
4162
        for record in substream:
4410
 
            # It's not a delta, so it must be a fulltext in the source
4411
 
            # serializer's format.
4412
4163
            bytes = record.get_bytes_as('fulltext')
4413
4164
            revision_id = record.key[0]
4414
4165
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4415
4166
            parents = [key[0] for key in record.parents]
4416
4167
            self.target_repo.add_inventory(revision_id, inv, parents)
4417
 
            # No need to keep holding this full inv in memory when the rest of
4418
 
            # the substream is likely to be all deltas.
4419
 
            del inv
4420
4168
 
4421
4169
    def _extract_and_insert_revisions(self, substream, serializer):
4422
4170
        for record in substream:
4439
4187
        """Create a StreamSource streaming from from_repository."""
4440
4188
        self.from_repository = from_repository
4441
4189
        self.to_format = to_format
4442
 
        self._record_counter = RecordCounter()
4443
4190
 
4444
4191
    def delta_on_metadata(self):
4445
4192
        """Return True if delta's are permitted on metadata streams.
4472
4219
        return [('signatures', signatures), ('revisions', revisions)]
4473
4220
 
4474
4221
    def _generate_root_texts(self, revs):
4475
 
        """This will be called by get_stream between fetching weave texts and
 
4222
        """This will be called by __fetch between fetching weave texts and
4476
4223
        fetching the inventory weave.
 
4224
 
 
4225
        Subclasses should override this if they need to generate root texts
 
4226
        after fetching weave texts.
4477
4227
        """
4478
4228
        if self._rich_root_upgrade():
4479
 
            return _mod_fetch.Inter1and2Helper(
 
4229
            import bzrlib.fetch
 
4230
            return bzrlib.fetch.Inter1and2Helper(
4480
4231
                self.from_repository).generate_root_texts(revs)
4481
4232
        else:
4482
4233
            return []
4485
4236
        phase = 'file'
4486
4237
        revs = search.get_keys()
4487
4238
        graph = self.from_repository.get_graph()
4488
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
 
4239
        revs = list(graph.iter_topo_order(revs))
4489
4240
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4490
4241
        text_keys = []
4491
4242
        for knit_kind, file_id, revisions in data_to_fetch:
4510
4261
                # will be valid.
4511
4262
                for _ in self._generate_root_texts(revs):
4512
4263
                    yield _
 
4264
                # NB: This currently reopens the inventory weave in source;
 
4265
                # using a single stream interface instead would avoid this.
 
4266
                from_weave = self.from_repository.inventories
4513
4267
                # we fetch only the referenced inventories because we do not
4514
4268
                # know for unselected inventories whether all their required
4515
4269
                # texts are present in the other repository - it could be
4554
4308
            if not keys:
4555
4309
                # No need to stream something we don't have
4556
4310
                continue
4557
 
            if substream_kind == 'inventories':
4558
 
                # Some missing keys are genuinely ghosts, filter those out.
4559
 
                present = self.from_repository.inventories.get_parent_map(keys)
4560
 
                revs = [key[0] for key in present]
4561
 
                # Get the inventory stream more-or-less as we do for the
4562
 
                # original stream; there's no reason to assume that records
4563
 
                # direct from the source will be suitable for the sink.  (Think
4564
 
                # e.g. 2a -> 1.9-rich-root).
4565
 
                for info in self._get_inventory_stream(revs, missing=True):
4566
 
                    yield info
4567
 
                continue
4568
 
 
4569
4311
            # Ask for full texts always so that we don't need more round trips
4570
4312
            # after this stream.
4571
4313
            # Some of the missing keys are genuinely ghosts, so filter absent
4586
4328
        return (not self.from_repository._format.rich_root_data and
4587
4329
            self.to_format.rich_root_data)
4588
4330
 
4589
 
    def _get_inventory_stream(self, revision_ids, missing=False):
 
4331
    def _get_inventory_stream(self, revision_ids):
4590
4332
        from_format = self.from_repository._format
4591
 
        if (from_format.supports_chks and self.to_format.supports_chks and
4592
 
            from_format.network_name() == self.to_format.network_name()):
4593
 
            raise AssertionError(
4594
 
                "this case should be handled by GroupCHKStreamSource")
4595
 
        elif 'forceinvdeltas' in debug.debug_flags:
4596
 
            return self._get_convertable_inventory_stream(revision_ids,
4597
 
                    delta_versus_null=missing)
4598
 
        elif from_format.network_name() == self.to_format.network_name():
4599
 
            # Same format.
4600
 
            return self._get_simple_inventory_stream(revision_ids,
4601
 
                    missing=missing)
4602
 
        elif (not from_format.supports_chks and not self.to_format.supports_chks
4603
 
                and from_format._serializer == self.to_format._serializer):
4604
 
            # Essentially the same format.
4605
 
            return self._get_simple_inventory_stream(revision_ids,
4606
 
                    missing=missing)
 
4333
        if (from_format.supports_chks and self.to_format.supports_chks
 
4334
            and (from_format._serializer == self.to_format._serializer)):
 
4335
            # Both sides support chks, and they use the same serializer, so it
 
4336
            # is safe to transmit the chk pages and inventory pages across
 
4337
            # as-is.
 
4338
            return self._get_chk_inventory_stream(revision_ids)
 
4339
        elif (not from_format.supports_chks):
 
4340
            # Source repository doesn't support chks. So we can transmit the
 
4341
            # inventories 'as-is' and either they are just accepted on the
 
4342
            # target, or the Sink will properly convert it.
 
4343
            return self._get_simple_inventory_stream(revision_ids)
4607
4344
        else:
4608
 
            # Any time we switch serializations, we want to use an
4609
 
            # inventory-delta based approach.
4610
 
            return self._get_convertable_inventory_stream(revision_ids,
4611
 
                    delta_versus_null=missing)
 
4345
            # XXX: Hack to make not-chk->chk fetch: copy the inventories as
 
4346
            #      inventories. Note that this should probably be done somehow
 
4347
            #      as part of bzrlib.repository.StreamSink. Except JAM couldn't
 
4348
            #      figure out how a non-chk repository could possibly handle
 
4349
            #      deserializing an inventory stream from a chk repo, as it
 
4350
            #      doesn't have a way to understand individual pages.
 
4351
            return self._get_convertable_inventory_stream(revision_ids)
4612
4352
 
4613
 
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
4614
 
        # NB: This currently reopens the inventory weave in source;
4615
 
        # using a single stream interface instead would avoid this.
 
4353
    def _get_simple_inventory_stream(self, revision_ids):
4616
4354
        from_weave = self.from_repository.inventories
4617
 
        if missing:
4618
 
            delta_closure = True
4619
 
        else:
4620
 
            delta_closure = not self.delta_on_metadata()
4621
4355
        yield ('inventories', from_weave.get_record_stream(
4622
4356
            [(rev_id,) for rev_id in revision_ids],
4623
 
            self.inventory_fetch_order(), delta_closure))
4624
 
 
4625
 
    def _get_convertable_inventory_stream(self, revision_ids,
4626
 
                                          delta_versus_null=False):
4627
 
        # The two formats are sufficiently different that there is no fast
4628
 
        # path, so we need to send just inventorydeltas, which any
4629
 
        # sufficiently modern client can insert into any repository.
4630
 
        # The StreamSink code expects to be able to
4631
 
        # convert on the target, so we need to put bytes-on-the-wire that can
4632
 
        # be converted.  That means inventory deltas (if the remote is <1.19,
4633
 
        # RemoteStreamSink will fallback to VFS to insert the deltas).
4634
 
        yield ('inventory-deltas',
4635
 
           self._stream_invs_as_deltas(revision_ids,
4636
 
                                       delta_versus_null=delta_versus_null))
4637
 
 
4638
 
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
4639
 
        """Return a stream of inventory-deltas for the given rev ids.
4640
 
 
4641
 
        :param revision_ids: The list of inventories to transmit
4642
 
        :param delta_versus_null: Don't try to find a minimal delta for this
4643
 
            entry, instead compute the delta versus the NULL_REVISION. This
4644
 
            effectively streams a complete inventory. Used for stuff like
4645
 
            filling in missing parents, etc.
4646
 
        """
 
4357
            self.inventory_fetch_order(),
 
4358
            not self.delta_on_metadata()))
 
4359
 
 
4360
    def _get_chk_inventory_stream(self, revision_ids):
 
4361
        """Fetch the inventory texts, along with the associated chk maps."""
 
4362
        # We want an inventory outside of the search set, so that we can filter
 
4363
        # out uninteresting chk pages. For now we use
 
4364
        # _find_revision_outside_set, but if we had a Search with cut_revs, we
 
4365
        # could use that instead.
 
4366
        start_rev_id = self.from_repository._find_revision_outside_set(
 
4367
                            revision_ids)
 
4368
        start_rev_key = (start_rev_id,)
 
4369
        inv_keys_to_fetch = [(rev_id,) for rev_id in revision_ids]
 
4370
        if start_rev_id != _mod_revision.NULL_REVISION:
 
4371
            inv_keys_to_fetch.append((start_rev_id,))
 
4372
        # Any repo that supports chk_bytes must also support out-of-order
 
4373
        # insertion. At least, that is how we expect it to work
 
4374
        # We use get_record_stream instead of iter_inventories because we want
 
4375
        # to be able to insert the stream as well. We could instead fetch
 
4376
        # allowing deltas, and then iter_inventories, but we don't know whether
 
4377
        # source or target is more 'local' anway.
 
4378
        inv_stream = self.from_repository.inventories.get_record_stream(
 
4379
            inv_keys_to_fetch, 'unordered',
 
4380
            True) # We need them as full-texts so we can find their references
 
4381
        uninteresting_chk_roots = set()
 
4382
        interesting_chk_roots = set()
 
4383
        def filter_inv_stream(inv_stream):
 
4384
            for idx, record in enumerate(inv_stream):
 
4385
                ### child_pb.update('fetch inv', idx, len(inv_keys_to_fetch))
 
4386
                bytes = record.get_bytes_as('fulltext')
 
4387
                chk_inv = inventory.CHKInventory.deserialise(
 
4388
                    self.from_repository.chk_bytes, bytes, record.key)
 
4389
                if record.key == start_rev_key:
 
4390
                    uninteresting_chk_roots.add(chk_inv.id_to_entry.key())
 
4391
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4392
                    if p_id_map is not None:
 
4393
                        uninteresting_chk_roots.add(p_id_map.key())
 
4394
                else:
 
4395
                    yield record
 
4396
                    interesting_chk_roots.add(chk_inv.id_to_entry.key())
 
4397
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4398
                    if p_id_map is not None:
 
4399
                        interesting_chk_roots.add(p_id_map.key())
 
4400
        ### pb.update('fetch inventory', 0, 2)
 
4401
        yield ('inventories', filter_inv_stream(inv_stream))
 
4402
        # Now that we have worked out all of the interesting root nodes, grab
 
4403
        # all of the interesting pages and insert them
 
4404
        ### pb.update('fetch inventory', 1, 2)
 
4405
        interesting = chk_map.iter_interesting_nodes(
 
4406
            self.from_repository.chk_bytes, interesting_chk_roots,
 
4407
            uninteresting_chk_roots)
 
4408
        def to_stream_adapter():
 
4409
            """Adapt the iter_interesting_nodes result to a single stream.
 
4410
 
 
4411
            iter_interesting_nodes returns records as it processes them, along
 
4412
            with keys. However, we only want to return the records themselves.
 
4413
            """
 
4414
            for record, items in interesting:
 
4415
                if record is not None:
 
4416
                    yield record
 
4417
        # XXX: We could instead call get_record_stream(records.keys())
 
4418
        #      ATM, this will always insert the records as fulltexts, and
 
4419
        #      requires that you can hang on to records once you have gone
 
4420
        #      on to the next one. Further, it causes the target to
 
4421
        #      recompress the data. Testing shows it to be faster than
 
4422
        #      requesting the records again, though.
 
4423
        yield ('chk_bytes', to_stream_adapter())
 
4424
        ### pb.update('fetch inventory', 2, 2)
 
4425
 
 
4426
    def _get_convertable_inventory_stream(self, revision_ids):
 
4427
        # XXX: One of source or target is using chks, and they don't have
 
4428
        #      compatible serializations. The StreamSink code expects to be
 
4429
        #      able to convert on the target, so we need to put
 
4430
        #      bytes-on-the-wire that can be converted
 
4431
        yield ('inventories', self._stream_invs_as_fulltexts(revision_ids))
 
4432
 
 
4433
    def _stream_invs_as_fulltexts(self, revision_ids):
4647
4434
        from_repo = self.from_repository
 
4435
        from_serializer = from_repo._format._serializer
4648
4436
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4649
4437
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
4650
 
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
4651
 
        # method...
4652
 
        inventories = self.from_repository.iter_inventories(
4653
 
            revision_ids, 'topological')
4654
 
        format = from_repo._format
4655
 
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
4656
 
        inventory_cache = lru_cache.LRUCache(50)
4657
 
        null_inventory = from_repo.revision_tree(
4658
 
            _mod_revision.NULL_REVISION).inventory
4659
 
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
4660
 
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
4661
 
        # repo back into a non-rich-root repo ought to be allowed)
4662
 
        serializer = inventory_delta.InventoryDeltaSerializer(
4663
 
            versioned_root=format.rich_root_data,
4664
 
            tree_references=format.supports_tree_reference)
4665
 
        for inv in inventories:
 
4438
        for inv in self.from_repository.iter_inventories(revision_ids):
 
4439
            # XXX: This is a bit hackish, but it works. Basically,
 
4440
            #      CHKSerializer 'accidentally' supports
 
4441
            #      read/write_inventory_to_string, even though that is never
 
4442
            #      the format that is stored on disk. It *does* give us a
 
4443
            #      single string representation for an inventory, so live with
 
4444
            #      it for now.
 
4445
            #      This would be far better if we had a 'serialized inventory
 
4446
            #      delta' form. Then we could use 'inventory._make_delta', and
 
4447
            #      transmit that. This would both be faster to generate, and
 
4448
            #      result in fewer bytes-on-the-wire.
 
4449
            as_bytes = from_serializer.write_inventory_to_string(inv)
4666
4450
            key = (inv.revision_id,)
4667
4451
            parent_keys = parent_map.get(key, ())
4668
 
            delta = None
4669
 
            if not delta_versus_null and parent_keys:
4670
 
                # The caller did not ask for complete inventories and we have
4671
 
                # some parents that we can delta against.  Make a delta against
4672
 
                # each parent so that we can find the smallest.
4673
 
                parent_ids = [parent_key[0] for parent_key in parent_keys]
4674
 
                for parent_id in parent_ids:
4675
 
                    if parent_id not in invs_sent_so_far:
4676
 
                        # We don't know that the remote side has this basis, so
4677
 
                        # we can't use it.
4678
 
                        continue
4679
 
                    if parent_id == _mod_revision.NULL_REVISION:
4680
 
                        parent_inv = null_inventory
4681
 
                    else:
4682
 
                        parent_inv = inventory_cache.get(parent_id, None)
4683
 
                        if parent_inv is None:
4684
 
                            parent_inv = from_repo.get_inventory(parent_id)
4685
 
                    candidate_delta = inv._make_delta(parent_inv)
4686
 
                    if (delta is None or
4687
 
                        len(delta) > len(candidate_delta)):
4688
 
                        delta = candidate_delta
4689
 
                        basis_id = parent_id
4690
 
            if delta is None:
4691
 
                # Either none of the parents ended up being suitable, or we
4692
 
                # were asked to delta against NULL
4693
 
                basis_id = _mod_revision.NULL_REVISION
4694
 
                delta = inv._make_delta(null_inventory)
4695
 
            invs_sent_so_far.add(inv.revision_id)
4696
 
            inventory_cache[inv.revision_id] = inv
4697
 
            delta_serialized = ''.join(
4698
 
                serializer.delta_to_lines(basis_id, key[-1], delta))
4699
4452
            yield versionedfile.FulltextContentFactory(
4700
 
                key, parent_keys, None, delta_serialized)
 
4453
                key, parent_keys, None, as_bytes)
4701
4454
 
4702
4455
 
4703
4456
def _iter_for_revno(repo, partial_history_cache, stop_index=None,