~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Jonathan Lange
  • Date: 2009-05-01 06:42:30 UTC
  • mto: This revision was merged to the branch mainline in revision 4320.
  • Revision ID: jml@canonical.com-20090501064230-kyk7v49xt8cevd25
Remove InstallFailed, it's not needed anymore.

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()))
1006
969
        """
1007
970
        if not self._format.supports_external_lookups:
1008
971
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
1009
 
        if self.is_locked():
1010
 
            # This repository will call fallback.unlock() when we transition to
1011
 
            # the unlocked state, so we make sure to increment the lock count
1012
 
            repository.lock_read()
1013
972
        self._check_fallback_repository(repository)
1014
973
        self._fallback_repositories.append(repository)
1015
974
        self.texts.add_fallback_versioned_files(repository.texts)
1046
1005
                " id and insertion revid (%r, %r)"
1047
1006
                % (inv.revision_id, revision_id))
1048
1007
        if inv.root is None:
1049
 
            raise errors.RootMissing()
 
1008
            raise AssertionError()
1050
1009
        return self._add_inventory_checked(revision_id, inv, parents)
1051
1010
 
1052
1011
    def _add_inventory_checked(self, revision_id, inv, parents):
1056
1015
 
1057
1016
        :seealso: add_inventory, for the contract.
1058
1017
        """
1059
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
 
1018
        inv_lines = self._serialise_inventory_to_lines(inv)
1060
1019
        return self._inventory_add_lines(revision_id, parents,
1061
1020
            inv_lines, check_content=False)
1062
1021
 
1064
1023
                               parents, basis_inv=None, propagate_caches=False):
1065
1024
        """Add a new inventory expressed as a delta against another revision.
1066
1025
 
1067
 
        See the inventory developers documentation for the theory behind
1068
 
        inventory deltas.
1069
 
 
1070
1026
        :param basis_revision_id: The inventory id the delta was created
1071
1027
            against. (This does not have to be a direct parent.)
1072
1028
        :param delta: The inventory delta (see Inventory.apply_delta for
1111
1067
        check_content=True):
1112
1068
        """Store lines in inv_vf and return the sha1 of the inventory."""
1113
1069
        parents = [(parent,) for parent in parents]
1114
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
1070
        return self.inventories.add_lines((revision_id,), parents, lines,
1115
1071
            check_content=check_content)[0]
1116
 
        self.inventories._access.flush()
1117
 
        return result
1118
1072
 
1119
1073
    def add_revision(self, revision_id, rev, inv=None, config=None):
1120
1074
        """Add rev to the revision store as revision_id.
1196
1150
        # The old API returned a list, should this actually be a set?
1197
1151
        return parent_map.keys()
1198
1152
 
1199
 
    def _check_inventories(self, checker):
1200
 
        """Check the inventories found from the revision scan.
1201
 
        
1202
 
        This is responsible for verifying the sha1 of inventories and
1203
 
        creating a pending_keys set that covers data referenced by inventories.
1204
 
        """
1205
 
        bar = ui.ui_factory.nested_progress_bar()
1206
 
        try:
1207
 
            self._do_check_inventories(checker, bar)
1208
 
        finally:
1209
 
            bar.finished()
1210
 
 
1211
 
    def _do_check_inventories(self, checker, bar):
1212
 
        """Helper for _check_inventories."""
1213
 
        revno = 0
1214
 
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
1215
 
        kinds = ['chk_bytes', 'texts']
1216
 
        count = len(checker.pending_keys)
1217
 
        bar.update("inventories", 0, 2)
1218
 
        current_keys = checker.pending_keys
1219
 
        checker.pending_keys = {}
1220
 
        # Accumulate current checks.
1221
 
        for key in current_keys:
1222
 
            if key[0] != 'inventories' and key[0] not in kinds:
1223
 
                checker._report_items.append('unknown key type %r' % (key,))
1224
 
            keys[key[0]].add(key[1:])
1225
 
        if keys['inventories']:
1226
 
            # NB: output order *should* be roughly sorted - topo or
1227
 
            # inverse topo depending on repository - either way decent
1228
 
            # to just delta against. However, pre-CHK formats didn't
1229
 
            # try to optimise inventory layout on disk. As such the
1230
 
            # pre-CHK code path does not use inventory deltas.
1231
 
            last_object = None
1232
 
            for record in self.inventories.check(keys=keys['inventories']):
1233
 
                if record.storage_kind == 'absent':
1234
 
                    checker._report_items.append(
1235
 
                        'Missing inventory {%s}' % (record.key,))
1236
 
                else:
1237
 
                    last_object = self._check_record('inventories', record,
1238
 
                        checker, last_object,
1239
 
                        current_keys[('inventories',) + record.key])
1240
 
            del keys['inventories']
1241
 
        else:
1242
 
            return
1243
 
        bar.update("texts", 1)
1244
 
        while (checker.pending_keys or keys['chk_bytes']
1245
 
            or keys['texts']):
1246
 
            # Something to check.
1247
 
            current_keys = checker.pending_keys
1248
 
            checker.pending_keys = {}
1249
 
            # Accumulate current checks.
1250
 
            for key in current_keys:
1251
 
                if key[0] not in kinds:
1252
 
                    checker._report_items.append('unknown key type %r' % (key,))
1253
 
                keys[key[0]].add(key[1:])
1254
 
            # Check the outermost kind only - inventories || chk_bytes || texts
1255
 
            for kind in kinds:
1256
 
                if keys[kind]:
1257
 
                    last_object = None
1258
 
                    for record in getattr(self, kind).check(keys=keys[kind]):
1259
 
                        if record.storage_kind == 'absent':
1260
 
                            checker._report_items.append(
1261
 
                                'Missing %s {%s}' % (kind, record.key,))
1262
 
                        else:
1263
 
                            last_object = self._check_record(kind, record,
1264
 
                                checker, last_object, current_keys[(kind,) + record.key])
1265
 
                    keys[kind] = set()
1266
 
                    break
1267
 
 
1268
 
    def _check_record(self, kind, record, checker, last_object, item_data):
1269
 
        """Check a single text from this repository."""
1270
 
        if kind == 'inventories':
1271
 
            rev_id = record.key[0]
1272
 
            inv = self._deserialise_inventory(rev_id,
1273
 
                record.get_bytes_as('fulltext'))
1274
 
            if last_object is not None:
1275
 
                delta = inv._make_delta(last_object)
1276
 
                for old_path, path, file_id, ie in delta:
1277
 
                    if ie is None:
1278
 
                        continue
1279
 
                    ie.check(checker, rev_id, inv)
1280
 
            else:
1281
 
                for path, ie in inv.iter_entries():
1282
 
                    ie.check(checker, rev_id, inv)
1283
 
            if self._format.fast_deltas:
1284
 
                return inv
1285
 
        elif kind == 'chk_bytes':
1286
 
            # No code written to check chk_bytes for this repo format.
1287
 
            checker._report_items.append(
1288
 
                'unsupported key type chk_bytes for %s' % (record.key,))
1289
 
        elif kind == 'texts':
1290
 
            self._check_text(record, checker, item_data)
1291
 
        else:
1292
 
            checker._report_items.append(
1293
 
                'unknown key type %s for %s' % (kind, record.key))
1294
 
 
1295
 
    def _check_text(self, record, checker, item_data):
1296
 
        """Check a single text."""
1297
 
        # Check it is extractable.
1298
 
        # TODO: check length.
1299
 
        if record.storage_kind == 'chunked':
1300
 
            chunks = record.get_bytes_as(record.storage_kind)
1301
 
            sha1 = osutils.sha_strings(chunks)
1302
 
            length = sum(map(len, chunks))
1303
 
        else:
1304
 
            content = record.get_bytes_as('fulltext')
1305
 
            sha1 = osutils.sha_string(content)
1306
 
            length = len(content)
1307
 
        if item_data and sha1 != item_data[1]:
1308
 
            checker._report_items.append(
1309
 
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
1310
 
                (record.key, sha1, item_data[1], item_data[2]))
1311
 
 
1312
1153
    @staticmethod
1313
1154
    def create(a_bzrdir):
1314
1155
        """Construct the current default format repository in a_bzrdir."""
1319
1160
 
1320
1161
        :param _format: The format of the repository on disk.
1321
1162
        :param a_bzrdir: The BzrDir of the repository.
 
1163
 
 
1164
        In the future we will have a single api for all stores for
 
1165
        getting file texts, inventories and revisions, then
 
1166
        this construct will accept instances of those things.
1322
1167
        """
1323
 
        # In the future we will have a single api for all stores for
1324
 
        # getting file texts, inventories and revisions, then
1325
 
        # this construct will accept instances of those things.
1326
1168
        super(Repository, self).__init__()
1327
1169
        self._format = _format
1328
1170
        # the following are part of the public API for Repository:
1334
1176
        self._reconcile_does_inventory_gc = True
1335
1177
        self._reconcile_fixes_text_parents = False
1336
1178
        self._reconcile_backsup_inventory = True
 
1179
        # not right yet - should be more semantically clear ?
 
1180
        #
 
1181
        # TODO: make sure to construct the right store classes, etc, depending
 
1182
        # on whether escaping is required.
 
1183
        self._warn_if_deprecated()
1337
1184
        self._write_group = None
1338
1185
        # Additional places to query for data.
1339
1186
        self._fallback_repositories = []
1340
1187
        # An InventoryEntry cache, used during deserialization
1341
1188
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
1342
 
        # Is it safe to return inventory entries directly from the entry cache,
1343
 
        # rather copying them?
1344
 
        self._safe_to_return_from_cache = False
1345
 
 
1346
 
    @property
1347
 
    def user_transport(self):
1348
 
        return self.bzrdir.user_transport
1349
 
 
1350
 
    @property
1351
 
    def control_transport(self):
1352
 
        return self._transport
1353
1189
 
1354
1190
    def __repr__(self):
1355
 
        if self._fallback_repositories:
1356
 
            return '%s(%r, fallback_repositories=%r)' % (
1357
 
                self.__class__.__name__,
1358
 
                self.base,
1359
 
                self._fallback_repositories)
1360
 
        else:
1361
 
            return '%s(%r)' % (self.__class__.__name__,
1362
 
                               self.base)
1363
 
 
1364
 
    def _has_same_fallbacks(self, other_repo):
1365
 
        """Returns true if the repositories have the same fallbacks."""
1366
 
        my_fb = self._fallback_repositories
1367
 
        other_fb = other_repo._fallback_repositories
1368
 
        if len(my_fb) != len(other_fb):
1369
 
            return False
1370
 
        for f, g in zip(my_fb, other_fb):
1371
 
            if not f.has_same_location(g):
1372
 
                return False
1373
 
        return True
 
1191
        return '%s(%r)' % (self.__class__.__name__,
 
1192
                           self.base)
1374
1193
 
1375
1194
    def has_same_location(self, other):
1376
1195
        """Returns a boolean indicating if this repository is at the same
1404
1223
        data during reads, and allows a 'write_group' to be obtained. Write
1405
1224
        groups must be used for actual data insertion.
1406
1225
 
1407
 
        A token should be passed in if you know that you have locked the object
1408
 
        some other way, and need to synchronise this object's state with that
1409
 
        fact.
1410
 
 
1411
 
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1412
 
 
1413
1226
        :param token: if this is already locked, then lock_write will fail
1414
1227
            unless the token matches the existing lock.
1415
1228
        :returns: a token if this instance supports tokens, otherwise None.
1418
1231
        :raises MismatchedToken: if the specified token doesn't match the token
1419
1232
            of the existing lock.
1420
1233
        :seealso: start_write_group.
1421
 
        :return: A RepositoryWriteLockResult.
 
1234
 
 
1235
        A token should be passed in if you know that you have locked the object
 
1236
        some other way, and need to synchronise this object's state with that
 
1237
        fact.
 
1238
 
 
1239
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1422
1240
        """
1423
1241
        locked = self.is_locked()
1424
 
        token = self.control_files.lock_write(token=token)
 
1242
        result = self.control_files.lock_write(token=token)
 
1243
        for repo in self._fallback_repositories:
 
1244
            # Writes don't affect fallback repos
 
1245
            repo.lock_read()
1425
1246
        if not locked:
1426
 
            self._warn_if_deprecated()
1427
 
            self._note_lock('w')
1428
 
            for repo in self._fallback_repositories:
1429
 
                # Writes don't affect fallback repos
1430
 
                repo.lock_read()
1431
1247
            self._refresh_data()
1432
 
        return RepositoryWriteLockResult(self.unlock, token)
 
1248
        return result
1433
1249
 
1434
1250
    def lock_read(self):
1435
 
        """Lock the repository for read operations.
1436
 
 
1437
 
        :return: An object with an unlock method which will release the lock
1438
 
            obtained.
1439
 
        """
1440
1251
        locked = self.is_locked()
1441
1252
        self.control_files.lock_read()
 
1253
        for repo in self._fallback_repositories:
 
1254
            repo.lock_read()
1442
1255
        if not locked:
1443
 
            self._warn_if_deprecated()
1444
 
            self._note_lock('r')
1445
 
            for repo in self._fallback_repositories:
1446
 
                repo.lock_read()
1447
1256
            self._refresh_data()
1448
 
        return LogicalLockResult(self.unlock)
1449
1257
 
1450
1258
    def get_physical_lock_status(self):
1451
1259
        return self.control_files.get_physical_lock_status()
1511
1319
 
1512
1320
        # now gather global repository information
1513
1321
        # XXX: This is available for many repos regardless of listability.
1514
 
        if self.user_transport.listable():
 
1322
        if self.bzrdir.root_transport.listable():
1515
1323
            # XXX: do we want to __define len__() ?
1516
1324
            # Maybe the versionedfiles object should provide a different
1517
1325
            # method to get the number of keys.
1527
1335
        :param using: If True, list only branches using this repository.
1528
1336
        """
1529
1337
        if using and not self.is_shared():
1530
 
            return self.bzrdir.list_branches()
 
1338
            try:
 
1339
                return [self.bzrdir.open_branch()]
 
1340
            except errors.NotBranchError:
 
1341
                return []
1531
1342
        class Evaluator(object):
1532
1343
 
1533
1344
            def __init__(self):
1542
1353
                    except errors.NoRepositoryPresent:
1543
1354
                        pass
1544
1355
                    else:
1545
 
                        return False, ([], repository)
 
1356
                        return False, (None, repository)
1546
1357
                self.first_call = False
1547
 
                value = (bzrdir.list_branches(), None)
 
1358
                try:
 
1359
                    value = (bzrdir.open_branch(), None)
 
1360
                except errors.NotBranchError:
 
1361
                    value = (None, None)
1548
1362
                return True, value
1549
1363
 
1550
 
        ret = []
1551
 
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
1552
 
                self.user_transport, evaluate=Evaluator()):
1553
 
            if branches is not None:
1554
 
                ret.extend(branches)
 
1364
        branches = []
 
1365
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1366
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
1367
            if branch is not None:
 
1368
                branches.append(branch)
1555
1369
            if not using and repository is not None:
1556
 
                ret.extend(repository.find_branches())
1557
 
        return ret
 
1370
                branches.extend(repository.find_branches())
 
1371
        return branches
1558
1372
 
1559
1373
    @needs_read_lock
1560
1374
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1589
1403
        """Commit the contents accrued within the current write group.
1590
1404
 
1591
1405
        :seealso: start_write_group.
1592
 
        
1593
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1594
1406
        """
1595
1407
        if self._write_group is not self.get_transaction():
1596
1408
            # has an unlock or relock occured ?
1597
1409
            raise errors.BzrError('mismatched lock context %r and '
1598
1410
                'write group %r.' %
1599
1411
                (self.get_transaction(), self._write_group))
1600
 
        result = self._commit_write_group()
 
1412
        self._commit_write_group()
1601
1413
        self._write_group = None
1602
 
        return result
1603
1414
 
1604
1415
    def _commit_write_group(self):
1605
1416
        """Template method for per-repository write group cleanup.
1613
1424
    def suspend_write_group(self):
1614
1425
        raise errors.UnsuspendableWriteGroup(self)
1615
1426
 
1616
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
 
1427
    def get_missing_parent_inventories(self):
1617
1428
        """Return the keys of missing inventory parents for revisions added in
1618
1429
        this write group.
1619
1430
 
1628
1439
            return set()
1629
1440
        if not self.is_in_write_group():
1630
1441
            raise AssertionError('not in a write group')
1631
 
 
 
1442
                
1632
1443
        # XXX: We assume that every added revision already has its
1633
1444
        # corresponding inventory, so we only check for parent inventories that
1634
1445
        # might be missing, rather than all inventories.
1638
1449
        present_inventories = unstacked_inventories.get_parent_map(
1639
1450
            key[-1:] for key in parents)
1640
1451
        parents.difference_update(present_inventories)
1641
 
        if len(parents) == 0:
1642
 
            # No missing parent inventories.
1643
 
            return set()
1644
 
        if not check_for_missing_texts:
1645
 
            return set(('inventories', rev_id) for (rev_id,) in parents)
1646
 
        # Ok, now we have a list of missing inventories.  But these only matter
1647
 
        # if the inventories that reference them are missing some texts they
1648
 
        # appear to introduce.
1649
 
        # XXX: Texts referenced by all added inventories need to be present,
1650
 
        # but at the moment we're only checking for texts referenced by
1651
 
        # inventories at the graph's edge.
1652
 
        key_deps = self.revisions._index._key_dependencies
1653
 
        key_deps.satisfy_refs_for_keys(present_inventories)
1654
 
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1655
 
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1656
 
        missing_texts = set()
1657
 
        for file_id, version_ids in file_ids.iteritems():
1658
 
            missing_texts.update(
1659
 
                (file_id, version_id) for version_id in version_ids)
1660
 
        present_texts = self.texts.get_parent_map(missing_texts)
1661
 
        missing_texts.difference_update(present_texts)
1662
 
        if not missing_texts:
1663
 
            # No texts are missing, so all revisions and their deltas are
1664
 
            # reconstructable.
1665
 
            return set()
1666
 
        # Alternatively the text versions could be returned as the missing
1667
 
        # keys, but this is likely to be less data.
1668
1452
        missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
1669
1453
        return missing_keys
1670
1454
 
1671
1455
    def refresh_data(self):
1672
 
        """Re-read any data needed to synchronise with disk.
 
1456
        """Re-read any data needed to to synchronise with disk.
1673
1457
 
1674
1458
        This method is intended to be called after another repository instance
1675
1459
        (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.
 
1460
        repository. It may not be called during a write group, but may be
 
1461
        called at any other time.
1681
1462
        """
 
1463
        if self.is_in_write_group():
 
1464
            raise errors.InternalBzrError(
 
1465
                "May not refresh_data while in a write group.")
1682
1466
        self._refresh_data()
1683
1467
 
1684
1468
    def resume_write_group(self, tokens):
1722
1506
            raise errors.InternalBzrError(
1723
1507
                "May not fetch while in a write group.")
1724
1508
        # 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)):
 
1509
        if self.has_same_location(source) and fetch_spec is None:
1730
1510
            # check that last_revision is in 'from' and then return a
1731
1511
            # no-operation.
1732
1512
            if (revision_id is not None and
1757
1537
        :param revprops: Optional dictionary of revision properties.
1758
1538
        :param revision_id: Optional revision id.
1759
1539
        """
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
1540
        result = self._commit_builder_class(self, parents, config,
1765
1541
            timestamp, timezone, committer, revprops, revision_id)
1766
1542
        self.start_write_group()
1767
1543
        return result
1768
1544
 
1769
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1770
1545
    def unlock(self):
1771
1546
        if (self.control_files._lock_count == 1 and
1772
1547
            self.control_files._lock_mode == 'w'):
1778
1553
        self.control_files.unlock()
1779
1554
        if self.control_files._lock_count == 0:
1780
1555
            self._inventory_entry_cache.clear()
1781
 
            for repo in self._fallback_repositories:
1782
 
                repo.unlock()
 
1556
        for repo in self._fallback_repositories:
 
1557
            repo.unlock()
1783
1558
 
1784
1559
    @needs_read_lock
1785
1560
    def clone(self, a_bzrdir, revision_id=None):
1894
1669
 
1895
1670
    @needs_read_lock
1896
1671
    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
 
        """
 
1672
        """Get many revisions at once."""
1902
1673
        return self._get_revisions(revision_ids)
1903
1674
 
1904
1675
    @needs_read_lock
1905
1676
    def _get_revisions(self, revision_ids):
1906
1677
        """Core work logic to get many revisions without sanity checks."""
 
1678
        for rev_id in revision_ids:
 
1679
            if not rev_id or not isinstance(rev_id, basestring):
 
1680
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1681
        keys = [(key,) for key in revision_ids]
 
1682
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1907
1683
        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
 
1684
        for record in stream:
 
1685
            if record.storage_kind == 'absent':
 
1686
                raise errors.NoSuchRevision(self, record.key[0])
 
1687
            text = record.get_bytes_as('fulltext')
 
1688
            rev = self._serializer.read_revision_from_string(text)
 
1689
            revs[record.key[0]] = rev
1912
1690
        return [revs[revid] for revid in revision_ids]
1913
1691
 
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)
 
1692
    @needs_read_lock
 
1693
    def get_revision_xml(self, revision_id):
 
1694
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1695
        #       would have already do it.
 
1696
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1697
        # TODO: this can't just be replaced by:
 
1698
        # return self._serializer.write_revision_to_string(
 
1699
        #     self.get_revision(revision_id))
 
1700
        # as cStringIO preservers the encoding unlike write_revision_to_string
 
1701
        # or some other call down the path.
 
1702
        rev = self.get_revision(revision_id)
 
1703
        rev_tmp = cStringIO.StringIO()
 
1704
        # the current serializer..
 
1705
        self._serializer.write_revision(rev, rev_tmp)
 
1706
        rev_tmp.seek(0)
 
1707
        return rev_tmp.getvalue()
1940
1708
 
1941
1709
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1942
1710
        """Produce a generator of revision deltas.
2120
1888
                    yield line, revid
2121
1889
 
2122
1890
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
2123
 
        revision_keys):
 
1891
        revision_ids):
2124
1892
        """Helper routine for fileids_altered_by_revision_ids.
2125
1893
 
2126
1894
        This performs the translation of xml lines to revision ids.
2127
1895
 
2128
1896
        :param line_iterator: An iterator of lines, origin_version_id
2129
 
        :param revision_keys: The revision ids to filter for. This should be a
 
1897
        :param revision_ids: The revision ids to filter for. This should be a
2130
1898
            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.
 
1899
            the revision id from each parsed line will be looked up in the
 
1900
            revision_ids filter.
2133
1901
        :return: a dictionary mapping altered file-ids to an iterable of
2134
1902
        revision_ids. Each altered file-ids has the exact revision_ids that
2135
1903
        altered it listed explicitly.
2136
1904
        """
2137
1905
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
2138
1906
                line_iterator).iterkeys())
2139
 
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
 
1907
        # Note that revision_ids are revision keys.
 
1908
        parent_maps = self.revisions.get_parent_map(revision_ids)
 
1909
        parents = set()
 
1910
        map(parents.update, parent_maps.itervalues())
 
1911
        parents.difference_update(revision_ids)
2140
1912
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
2141
 
            self._inventory_xml_lines_for_keys(parent_keys)))
 
1913
            self._inventory_xml_lines_for_keys(parents)))
2142
1914
        new_keys = seen - parent_seen
2143
1915
        result = {}
2144
1916
        setdefault = result.setdefault
2146
1918
            setdefault(key[0], set()).add(key[-1])
2147
1919
        return result
2148
1920
 
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
1921
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
2177
1922
        """Find the file ids and versions affected by revisions.
2178
1923
 
2185
1930
        """
2186
1931
        selected_keys = set((revid,) for revid in revision_ids)
2187
1932
        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)
 
1933
        pb = ui.ui_factory.nested_progress_bar()
 
1934
        try:
 
1935
            return self._find_file_ids_from_xml_inventory_lines(
 
1936
                w.iter_lines_added_or_present_in_keys(
 
1937
                    selected_keys, pb=pb),
 
1938
                selected_keys)
 
1939
        finally:
 
1940
            pb.finished()
2192
1941
 
2193
1942
    def iter_files_bytes(self, desired_files):
2194
1943
        """Iterate through file versions.
2276
2025
                batch_size]
2277
2026
            if not to_query:
2278
2027
                break
2279
 
            for revision_id in to_query:
 
2028
            for rev_tree in self.revision_trees(to_query):
 
2029
                revision_id = rev_tree.get_revision_id()
2280
2030
                parent_ids = ancestors[revision_id]
2281
2031
                for text_key in revision_keys[revision_id]:
2282
2032
                    pb.update("Calculating text parents", processed_texts)
2355
2105
        num_file_ids = len(file_ids)
2356
2106
        for file_id, altered_versions in file_ids.iteritems():
2357
2107
            if pb is not None:
2358
 
                pb.update("Fetch texts", count, num_file_ids)
 
2108
                pb.update("fetch texts", count, num_file_ids)
2359
2109
            count += 1
2360
2110
            yield ("file", file_id, altered_versions)
2361
2111
 
2382
2132
        """Get Inventory object by revision id."""
2383
2133
        return self.iter_inventories([revision_id]).next()
2384
2134
 
2385
 
    def iter_inventories(self, revision_ids, ordering=None):
 
2135
    def iter_inventories(self, revision_ids):
2386
2136
        """Get many inventories by revision_ids.
2387
2137
 
2388
2138
        This will buffer some or all of the texts used in constructing the
2390
2140
        time.
2391
2141
 
2392
2142
        :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
2143
        :return: An iterator of inventories.
2397
2144
        """
2398
2145
        if ((None in revision_ids)
2399
2146
            or (_mod_revision.NULL_REVISION in revision_ids)):
2400
2147
            raise ValueError('cannot get null revision inventory')
2401
 
        return self._iter_inventories(revision_ids, ordering)
 
2148
        return self._iter_inventories(revision_ids)
2402
2149
 
2403
 
    def _iter_inventories(self, revision_ids, ordering):
 
2150
    def _iter_inventories(self, revision_ids):
2404
2151
        """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)
 
2152
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
 
2153
            yield self.deserialise_inventory(revision_id, text)
2408
2154
 
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
 
2155
    def _iter_inventory_xmls(self, revision_ids):
2415
2156
        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)
 
2157
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2422
2158
        text_chunks = {}
2423
2159
        for record in stream:
2424
2160
            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]
 
2161
                text_chunks[record.key] = record.get_bytes_as('chunked')
2430
2162
            else:
2431
2163
                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
 
2164
        for key in keys:
 
2165
            chunks = text_chunks.pop(key)
 
2166
            yield ''.join(chunks), key[-1]
2444
2167
 
2445
 
    def _deserialise_inventory(self, revision_id, xml):
 
2168
    def deserialise_inventory(self, revision_id, xml):
2446
2169
        """Transform the xml into an inventory object.
2447
2170
 
2448
2171
        :param revision_id: The expected revision id of the inventory.
2449
2172
        :param xml: A serialised inventory.
2450
2173
        """
2451
2174
        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)
 
2175
                    entry_cache=self._inventory_entry_cache)
2454
2176
        if result.revision_id != revision_id:
2455
2177
            raise AssertionError('revision id mismatch %s != %s' % (
2456
2178
                result.revision_id, revision_id))
2457
2179
        return result
2458
2180
 
 
2181
    def serialise_inventory(self, inv):
 
2182
        return self._serializer.write_inventory_to_string(inv)
 
2183
 
 
2184
    def _serialise_inventory_to_lines(self, inv):
 
2185
        return self._serializer.write_inventory_to_lines(inv)
 
2186
 
2459
2187
    def get_serializer_format(self):
2460
2188
        return self._serializer.format_num
2461
2189
 
2462
2190
    @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')
 
2191
    def get_inventory_xml(self, revision_id):
 
2192
        """Get inventory XML as a file object."""
 
2193
        texts = self._iter_inventory_xmls([revision_id])
2466
2194
        try:
2467
2195
            text, revision_id = texts.next()
2468
2196
        except StopIteration:
2469
2197
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2470
2198
        return text
2471
2199
 
2472
 
    def get_rev_id_for_revno(self, revno, known_pair):
2473
 
        """Return the revision id of a revno, given a later (revno, revid)
2474
 
        pair in the same history.
2475
 
 
2476
 
        :return: if found (True, revid).  If the available history ran out
2477
 
            before reaching the revno, then this returns
2478
 
            (False, (closest_revno, closest_revid)).
 
2200
    @needs_read_lock
 
2201
    def get_inventory_sha1(self, revision_id):
 
2202
        """Return the sha1 hash of the inventory entry
2479
2203
        """
2480
 
        known_revno, known_revid = known_pair
2481
 
        partial_history = [known_revid]
2482
 
        distance_from_known = known_revno - revno
2483
 
        if distance_from_known < 0:
2484
 
            raise ValueError(
2485
 
                'requested revno (%d) is later than given known revno (%d)'
2486
 
                % (revno, known_revno))
2487
 
        try:
2488
 
            _iter_for_revno(
2489
 
                self, partial_history, stop_index=distance_from_known)
2490
 
        except errors.RevisionNotPresent, err:
2491
 
            if err.revision_id == known_revid:
2492
 
                # The start revision (known_revid) wasn't found.
2493
 
                raise
2494
 
            # This is a stacked repository with no fallbacks, or a there's a
2495
 
            # left-hand ghost.  Either way, even though the revision named in
2496
 
            # the error isn't in this repo, we know it's the next step in this
2497
 
            # left-hand history.
2498
 
            partial_history.append(err.revision_id)
2499
 
        if len(partial_history) <= distance_from_known:
2500
 
            # Didn't find enough history to get a revid for the revno.
2501
 
            earliest_revno = known_revno - len(partial_history) + 1
2502
 
            return (False, (earliest_revno, partial_history[-1]))
2503
 
        if len(partial_history) - 1 > distance_from_known:
2504
 
            raise AssertionError('_iter_for_revno returned too much history')
2505
 
        return (True, partial_history[-1])
 
2204
        return self.get_revision(revision_id).inventory_sha1
2506
2205
 
2507
2206
    def iter_reverse_revision_history(self, revision_id):
2508
2207
        """Iterate backwards through revision ids in the lefthand history
2511
2210
            ancestors will be traversed.
2512
2211
        """
2513
2212
        graph = self.get_graph()
2514
 
        stop_revisions = (None, _mod_revision.NULL_REVISION)
2515
 
        return graph.iter_lefthand_ancestry(revision_id, stop_revisions)
 
2213
        next_id = revision_id
 
2214
        while True:
 
2215
            if next_id in (None, _mod_revision.NULL_REVISION):
 
2216
                return
 
2217
            yield next_id
 
2218
            # Note: The following line may raise KeyError in the event of
 
2219
            # truncated history. We decided not to have a try:except:raise
 
2220
            # RevisionNotPresent here until we see a use for it, because of the
 
2221
            # cost in an inner loop that is by its very nature O(history).
 
2222
            # Robert Collins 20080326
 
2223
            parents = graph.get_parent_map([next_id])[next_id]
 
2224
            if len(parents) == 0:
 
2225
                return
 
2226
            else:
 
2227
                next_id = parents[0]
 
2228
 
 
2229
    @needs_read_lock
 
2230
    def get_revision_inventory(self, revision_id):
 
2231
        """Return inventory of a past revision."""
 
2232
        # TODO: Unify this with get_inventory()
 
2233
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
2234
        # must be the same as its revision, so this is trivial.
 
2235
        if revision_id is None:
 
2236
            # This does not make sense: if there is no revision,
 
2237
            # then it is the current tree inventory surely ?!
 
2238
            # and thus get_root_id() is something that looks at the last
 
2239
            # commit on the branch, and the get_root_id is an inventory check.
 
2240
            raise NotImplementedError
 
2241
            # return Inventory(self.get_root_id())
 
2242
        else:
 
2243
            return self.get_inventory(revision_id)
2516
2244
 
2517
2245
    def is_shared(self):
2518
2246
        """Return True if this repository is flagged as a shared repository."""
2553
2281
            return RevisionTree(self, Inventory(root_id=None),
2554
2282
                                _mod_revision.NULL_REVISION)
2555
2283
        else:
2556
 
            inv = self.get_inventory(revision_id)
 
2284
            inv = self.get_revision_inventory(revision_id)
2557
2285
            return RevisionTree(self, inv, revision_id)
2558
2286
 
2559
2287
    def revision_trees(self, revision_ids):
2612
2340
            keys = tsort.topo_sort(parent_map)
2613
2341
        return [None] + list(keys)
2614
2342
 
2615
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
2343
    def pack(self):
2616
2344
        """Compress the data within the repository.
2617
2345
 
2618
2346
        This operation only makes sense for some repository types. For other
2619
2347
        types it should be a no-op that just returns.
2620
2348
 
2621
2349
        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
 
2350
        @needs_write_lock as this is a long running call its reasonable to
2623
2351
        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
2352
        """
2635
2353
 
2636
2354
    def get_transaction(self):
2637
2355
        return self.control_files.get_transaction()
2638
2356
 
2639
2357
    def get_parent_map(self, revision_ids):
2640
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
2358
        """See graph._StackedParentsProvider.get_parent_map"""
2641
2359
        # revisions index works in keys; this just works in revisions
2642
2360
        # therefore wrap and unwrap
2643
2361
        query_keys = []
2652
2370
        for ((revision_id,), parent_keys) in \
2653
2371
                self.revisions.get_parent_map(query_keys).iteritems():
2654
2372
            if parent_keys:
2655
 
                result[revision_id] = tuple([parent_revid
2656
 
                    for (parent_revid,) in parent_keys])
 
2373
                result[revision_id] = tuple(parent_revid
 
2374
                    for (parent_revid,) in parent_keys)
2657
2375
            else:
2658
2376
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2659
2377
        return result
2661
2379
    def _make_parents_provider(self):
2662
2380
        return self
2663
2381
 
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
2382
    def get_graph(self, other_repository=None):
2674
2383
        """Return the graph walker for this repository format"""
2675
2384
        parents_provider = self._make_parents_provider()
2676
2385
        if (other_repository is not None and
2677
2386
            not self.has_same_location(other_repository)):
2678
 
            parents_provider = graph.StackedParentsProvider(
 
2387
            parents_provider = graph._StackedParentsProvider(
2679
2388
                [parents_provider, other_repository._make_parents_provider()])
2680
2389
        return graph.Graph(parents_provider)
2681
2390
 
2682
 
    def _get_versioned_file_checker(self, text_key_references=None,
2683
 
        ancestors=None):
 
2391
    def _get_versioned_file_checker(self, text_key_references=None):
2684
2392
        """Return an object suitable for checking versioned files.
2685
2393
        
2686
2394
        :param text_key_references: if non-None, an already built
2688
2396
            to whether they were referred to by the inventory of the
2689
2397
            revision_id that they contain. If None, this will be
2690
2398
            calculated.
2691
 
        :param ancestors: Optional result from
2692
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2693
 
            available.
2694
2399
        """
2695
2400
        return _VersionedFileChecker(self,
2696
 
            text_key_references=text_key_references, ancestors=ancestors)
 
2401
            text_key_references=text_key_references)
2697
2402
 
2698
2403
    def revision_ids_to_search_result(self, result_set):
2699
2404
        """Convert a set of revision ids to a graph SearchResult."""
2749
2454
        return record.get_bytes_as('fulltext')
2750
2455
 
2751
2456
    @needs_read_lock
2752
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
2457
    def check(self, revision_ids=None):
2753
2458
        """Check consistency of all history of given revision_ids.
2754
2459
 
2755
2460
        Different repository implementations should override _check().
2756
2461
 
2757
2462
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2758
2463
             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
2464
        """
2765
 
        return self._check(revision_ids, callback_refs=callback_refs,
2766
 
            check_repo=check_repo)
 
2465
        return self._check(revision_ids)
2767
2466
 
2768
 
    def _check(self, revision_ids, callback_refs, check_repo):
2769
 
        result = check.Check(self, check_repo=check_repo)
2770
 
        result.check(callback_refs)
 
2467
    def _check(self, revision_ids):
 
2468
        result = check.Check(self)
 
2469
        result.check()
2771
2470
        return result
2772
2471
 
2773
 
    def _warn_if_deprecated(self, branch=None):
 
2472
    def _warn_if_deprecated(self):
2774
2473
        global _deprecation_warning_done
2775
2474
        if _deprecation_warning_done:
2776
2475
            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
 
2476
        _deprecation_warning_done = True
 
2477
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
2478
                % (self._format, self.bzrdir.transport.base))
2789
2479
 
2790
2480
    def supports_rich_root(self):
2791
2481
        return self._format.rich_root_data
3067
2757
    # Does this format have < O(tree_size) delta generation. Used to hint what
3068
2758
    # code path for commit, amongst other things.
3069
2759
    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
2760
 
3080
 
    def __repr__(self):
3081
 
        return "%s()" % self.__class__.__name__
 
2761
    def __str__(self):
 
2762
        return "<%s>" % self.__class__.__name__
3082
2763
 
3083
2764
    def __eq__(self, other):
3084
2765
        # format objects are generally stateless
3097
2778
        """
3098
2779
        try:
3099
2780
            transport = a_bzrdir.get_repository_transport(None)
3100
 
            format_string = transport.get_bytes("format")
 
2781
            format_string = transport.get("format").read()
3101
2782
            return format_registry.get(format_string)
3102
2783
        except errors.NoSuchFile:
3103
2784
            raise errors.NoRepositoryPresent(a_bzrdir)
3185
2866
        raise NotImplementedError(self.network_name)
3186
2867
 
3187
2868
    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)
 
2869
        raise NotImplementedError(self.check_conversion_target)
3197
2870
 
3198
2871
    def open(self, a_bzrdir, _found=False):
3199
2872
        """Return an instance of this format for the bzrdir a_bzrdir.
3202
2875
        """
3203
2876
        raise NotImplementedError(self.open)
3204
2877
 
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
2878
 
3215
2879
class MetaDirRepositoryFormat(RepositoryFormat):
3216
2880
    """Common base class for the new repositories using the metadir layout."""
3367
3031
    'RepositoryFormatCHK1',
3368
3032
    )
3369
3033
 
3370
 
format_registry.register_lazy(
3371
 
    'Bazaar development format - chk repository with bencode revision '
3372
 
        'serialization (needs bzr.dev from 1.16)\n',
3373
 
    'bzrlib.repofmt.groupcompress_repo',
3374
 
    'RepositoryFormatCHK2',
3375
 
    )
3376
 
format_registry.register_lazy(
3377
 
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
3378
 
    'bzrlib.repofmt.groupcompress_repo',
3379
 
    'RepositoryFormat2a',
3380
 
    )
3381
 
format_registry.register_lazy(
3382
 
    'Bazaar development format 8\n',
3383
 
    'bzrlib.repofmt.groupcompress_repo',
3384
 
    'RepositoryFormat2aSubtree',
3385
 
    )
3386
 
 
3387
3034
 
3388
3035
class InterRepository(InterObject):
3389
3036
    """This class represents operations taking place between two repositories.
3426
3073
 
3427
3074
        :param revision_id: if None all content is copied, if NULL_REVISION no
3428
3075
                            content is copied.
3429
 
        :param pb: ignored.
 
3076
        :param pb: optional progress bar to use for progress reports. If not
 
3077
                   provided a default one will be created.
3430
3078
        :return: None.
3431
3079
        """
3432
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3433
3080
        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
3081
        f = RepoFetcher(to_repository=self.target,
3440
3082
                               from_repository=self.source,
3441
3083
                               last_revision=revision_id,
3442
3084
                               fetch_spec=fetch_spec,
3443
 
                               find_ghosts=find_ghosts)
 
3085
                               pb=pb, find_ghosts=find_ghosts)
3444
3086
 
3445
3087
    def _walk_to_common_revisions(self, revision_ids):
3446
3088
        """Walk out from revision_ids in source to revisions target has.
3450
3092
        """
3451
3093
        target_graph = self.target.get_graph()
3452
3094
        revision_ids = frozenset(revision_ids)
 
3095
        # Fast path for the case where all the revisions are already in the
 
3096
        # target repo.
 
3097
        # (Although this does incur an extra round trip for the
 
3098
        # fairly common case where the target doesn't already have the revision
 
3099
        # we're pushing.)
 
3100
        if set(target_graph.get_parent_map(revision_ids)) == revision_ids:
 
3101
            return graph.SearchResult(revision_ids, set(), 0, set())
3453
3102
        missing_revs = set()
3454
3103
        source_graph = self.source.get_graph()
3455
3104
        # ensure we don't pay silly lookup costs.
3615
3264
                self.target.texts.insert_record_stream(
3616
3265
                    self.source.texts.get_record_stream(
3617
3266
                        self.source.texts.keys(), 'topological', False))
3618
 
                pb.update('Copying inventory', 0, 1)
 
3267
                pb.update('copying inventory', 0, 1)
3619
3268
                self.target.inventories.insert_record_stream(
3620
3269
                    self.source.inventories.get_record_stream(
3621
3270
                        self.source.inventories.keys(), 'topological', False))
3735
3384
        return self.source.revision_ids_to_search_result(result_set)
3736
3385
 
3737
3386
 
 
3387
class InterPackRepo(InterSameDataRepository):
 
3388
    """Optimised code paths between Pack based repositories."""
 
3389
 
 
3390
    @classmethod
 
3391
    def _get_repo_format_to_test(self):
 
3392
        from bzrlib.repofmt import pack_repo
 
3393
        return pack_repo.RepositoryFormatKnitPack6RichRoot()
 
3394
 
 
3395
    @staticmethod
 
3396
    def is_compatible(source, target):
 
3397
        """Be compatible with known Pack formats.
 
3398
 
 
3399
        We don't test for the stores being of specific types because that
 
3400
        could lead to confusing results, and there is no need to be
 
3401
        overly general.
 
3402
 
 
3403
        InterPackRepo does not support CHK based repositories.
 
3404
        """
 
3405
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
3406
        from bzrlib.repofmt.groupcompress_repo import RepositoryFormatCHK1
 
3407
        try:
 
3408
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
3409
                isinstance(target._format, RepositoryFormatPack))
 
3410
            not_packs = (isinstance(source._format, RepositoryFormatCHK1) or
 
3411
                isinstance(target._format, RepositoryFormatCHK1))
 
3412
        except AttributeError:
 
3413
            return False
 
3414
        if not_packs or not are_packs:
 
3415
            return False
 
3416
        return InterRepository._same_model(source, target)
 
3417
 
 
3418
    @needs_write_lock
 
3419
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
 
3420
            fetch_spec=None):
 
3421
        """See InterRepository.fetch()."""
 
3422
        if (len(self.source._fallback_repositories) > 0 or
 
3423
            len(self.target._fallback_repositories) > 0):
 
3424
            # The pack layer is not aware of fallback repositories, so when
 
3425
            # fetching from a stacked repository or into a stacked repository
 
3426
            # we use the generic fetch logic which uses the VersionedFiles
 
3427
            # attributes on repository.
 
3428
            from bzrlib.fetch import RepoFetcher
 
3429
            fetcher = RepoFetcher(self.target, self.source, revision_id,
 
3430
                    pb, find_ghosts, fetch_spec=fetch_spec)
 
3431
        if fetch_spec is not None:
 
3432
            if len(list(fetch_spec.heads)) != 1:
 
3433
                raise AssertionError(
 
3434
                    "InterPackRepo.fetch doesn't support "
 
3435
                    "fetching multiple heads yet.")
 
3436
            revision_id = list(fetch_spec.heads)[0]
 
3437
            fetch_spec = None
 
3438
        if revision_id is None:
 
3439
            # TODO:
 
3440
            # everything to do - use pack logic
 
3441
            # to fetch from all packs to one without
 
3442
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
3443
            # till then:
 
3444
            source_revision_ids = frozenset(self.source.all_revision_ids())
 
3445
            revision_ids = source_revision_ids - \
 
3446
                frozenset(self.target.get_parent_map(source_revision_ids))
 
3447
            revision_keys = [(revid,) for revid in revision_ids]
 
3448
            index = self.target._pack_collection.revision_index.combined_index
 
3449
            present_revision_ids = set(item[1][0] for item in
 
3450
                index.iter_entries(revision_keys))
 
3451
            revision_ids = set(revision_ids) - present_revision_ids
 
3452
            # implementing the TODO will involve:
 
3453
            # - detecting when all of a pack is selected
 
3454
            # - avoiding as much as possible pre-selection, so the
 
3455
            # more-core routines such as create_pack_from_packs can filter in
 
3456
            # a just-in-time fashion. (though having a HEADS list on a
 
3457
            # repository might make this a lot easier, because we could
 
3458
            # sensibly detect 'new revisions' without doing a full index scan.
 
3459
        elif _mod_revision.is_null(revision_id):
 
3460
            # nothing to do:
 
3461
            return (0, [])
 
3462
        else:
 
3463
            revision_ids = self.search_missing_revision_ids(revision_id,
 
3464
                find_ghosts=find_ghosts).get_keys()
 
3465
            if len(revision_ids) == 0:
 
3466
                return (0, [])
 
3467
        return self._pack(self.source, self.target, revision_ids)
 
3468
 
 
3469
    def _pack(self, source, target, revision_ids):
 
3470
        from bzrlib.repofmt.pack_repo import Packer
 
3471
        packs = source._pack_collection.all_packs()
 
3472
        pack = Packer(self.target._pack_collection, packs, '.fetch',
 
3473
            revision_ids).pack()
 
3474
        if pack is not None:
 
3475
            self.target._pack_collection._save_pack_names()
 
3476
            copied_revs = pack.get_revision_count()
 
3477
            # Trigger an autopack. This may duplicate effort as we've just done
 
3478
            # a pack creation, but for now it is simpler to think about as
 
3479
            # 'upload data, then repack if needed'.
 
3480
            self.target._pack_collection.autopack()
 
3481
            return (copied_revs, [])
 
3482
        else:
 
3483
            return (0, [])
 
3484
 
 
3485
    @needs_read_lock
 
3486
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
3487
        """See InterRepository.missing_revision_ids().
 
3488
 
 
3489
        :param find_ghosts: Find ghosts throughout the ancestry of
 
3490
            revision_id.
 
3491
        """
 
3492
        if not find_ghosts and revision_id is not None:
 
3493
            return self._walk_to_common_revisions([revision_id])
 
3494
        elif revision_id is not None:
 
3495
            # Find ghosts: search for revisions pointing from one repository to
 
3496
            # the other, and vice versa, anywhere in the history of revision_id.
 
3497
            graph = self.target.get_graph(other_repository=self.source)
 
3498
            searcher = graph._make_breadth_first_searcher([revision_id])
 
3499
            found_ids = set()
 
3500
            while True:
 
3501
                try:
 
3502
                    next_revs, ghosts = searcher.next_with_ghosts()
 
3503
                except StopIteration:
 
3504
                    break
 
3505
                if revision_id in ghosts:
 
3506
                    raise errors.NoSuchRevision(self.source, revision_id)
 
3507
                found_ids.update(next_revs)
 
3508
                found_ids.update(ghosts)
 
3509
            found_ids = frozenset(found_ids)
 
3510
            # Double query here: should be able to avoid this by changing the
 
3511
            # graph api further.
 
3512
            result_set = found_ids - frozenset(
 
3513
                self.target.get_parent_map(found_ids))
 
3514
        else:
 
3515
            source_ids = self.source.all_revision_ids()
 
3516
            # source_ids is the worst possible case we may need to pull.
 
3517
            # now we want to filter source_ids against what we actually
 
3518
            # have in target, but don't try to check for existence where we know
 
3519
            # we do not have a revision as that would be pointless.
 
3520
            target_ids = set(self.target.all_revision_ids())
 
3521
            result_set = set(source_ids).difference(target_ids)
 
3522
        return self.source.revision_ids_to_search_result(result_set)
 
3523
 
 
3524
 
3738
3525
class InterDifferingSerializer(InterRepository):
3739
3526
 
3740
3527
    @classmethod
3747
3534
        # This is redundant with format.check_conversion_target(), however that
3748
3535
        # raises an exception, and we just want to say "False" as in we won't
3749
3536
        # support converting between these formats.
3750
 
        if 'IDS_never' in debug.debug_flags:
3751
 
            return False
3752
3537
        if source.supports_rich_root() and not target.supports_rich_root():
3753
3538
            return False
3754
3539
        if (source._format.supports_tree_reference
3755
3540
            and not target._format.supports_tree_reference):
3756
3541
            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
3542
        return True
3770
3543
 
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):
 
3544
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
3789
3545
        """Get the best delta and base for this revision.
3790
3546
 
3791
3547
        :return: (basis_id, delta)
3792
3548
        """
 
3549
        possible_trees = [(parent_id, cache[parent_id])
 
3550
                          for parent_id in parent_ids
 
3551
                           if parent_id in cache]
 
3552
        if len(possible_trees) == 0:
 
3553
            # There either aren't any parents, or the parents aren't in the
 
3554
            # cache, so just use the last converted tree
 
3555
            possible_trees.append((basis_id, cache[basis_id]))
3793
3556
        deltas = []
3794
 
        # Generate deltas against each tree, to find the shortest.
3795
 
        texts_possibly_new_in_tree = set()
3796
3557
        for basis_id, basis_tree in possible_trees:
3797
3558
            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
3559
            deltas.append((len(delta), basis_id, delta))
3813
3560
        deltas.sort()
3814
3561
        return deltas[0][1:]
3815
3562
 
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.
 
3563
    def _get_parent_keys(self, root_key, parent_map):
 
3564
        """Get the parent keys for a given root id."""
 
3565
        root_id, rev_id = root_key
 
3566
        # Include direct parents of the revision, but only if they used
 
3567
        # the same root_id.
 
3568
        parent_keys = []
 
3569
        for parent_id in parent_map[rev_id]:
 
3570
            if parent_id == _mod_revision.NULL_REVISION:
 
3571
                continue
 
3572
            if parent_id not in self._revision_id_to_root_id:
 
3573
                # We probably didn't read this revision, go spend the
 
3574
                # extra effort to actually check
 
3575
                try:
 
3576
                    tree = self.source.revision_tree(parent_id)
 
3577
                except errors.NoSuchRevision:
 
3578
                    # Ghost, fill out _revision_id_to_root_id in case we
 
3579
                    # encounter this again.
 
3580
                    # But set parent_root_id to None since we don't really know
 
3581
                    parent_root_id = None
 
3582
                else:
 
3583
                    parent_root_id = tree.get_root_id()
 
3584
                self._revision_id_to_root_id[parent_id] = None
 
3585
            else:
 
3586
                parent_root_id = self._revision_id_to_root_id[parent_id]
 
3587
            if root_id == parent_root_id or parent_root_id is None:
 
3588
                parent_keys.append((root_id, parent_id))
 
3589
        return tuple(parent_keys)
3819
3590
 
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
 
3591
    def _new_root_data_stream(self, root_keys_to_create, parent_map):
 
3592
        for root_key in root_keys_to_create:
 
3593
            parent_keys = self._get_parent_keys(root_key, parent_map)
 
3594
            yield versionedfile.FulltextContentFactory(root_key,
 
3595
                parent_keys, None, '')
3844
3596
 
3845
3597
    def _fetch_batch(self, revision_ids, basis_id, cache):
3846
3598
        """Fetch across a few revisions.
3860
3612
        pending_deltas = []
3861
3613
        pending_revisions = []
3862
3614
        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
3615
        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
3616
            current_revision_id = tree.get_revision_id()
3869
3617
            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
3618
            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))
 
3619
                                                           basis_id, cache)
3881
3620
            if self._converting_to_rich_root:
3882
3621
                self._revision_id_to_root_id[current_revision_id] = \
3883
3622
                    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()
 
3623
            # Find text entries that need to be copied
3887
3624
            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)
 
3625
                if new_path is not None:
 
3626
                    if not new_path:
 
3627
                        # This is the root
 
3628
                        if not self.target.supports_rich_root():
 
3629
                            # The target doesn't support rich root, so we don't
 
3630
                            # copy
 
3631
                            continue
 
3632
                        if self._converting_to_rich_root:
 
3633
                            # This can't be copied normally, we have to insert
 
3634
                            # it specially
 
3635
                            root_keys_to_create.add((file_id, entry.revision))
 
3636
                            continue
 
3637
                    text_keys.add((file_id, entry.revision))
 
3638
            revision = self.source.get_revision(current_revision_id)
 
3639
            pending_deltas.append((basis_id, delta,
 
3640
                current_revision_id, revision.parent_ids))
3915
3641
            pending_revisions.append(revision)
3916
3642
            cache[current_revision_id] = tree
3917
3643
            basis_id = current_revision_id
3918
 
        self.source._safe_to_return_from_cache = False
3919
3644
        # Copy file texts
3920
3645
        from_texts = self.source.texts
3921
3646
        to_texts = self.target.texts
3922
3647
        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)
 
3648
            root_stream = self._new_root_data_stream(root_keys_to_create,
 
3649
                                                     parent_map)
3926
3650
            to_texts.insert_record_stream(root_stream)
3927
3651
        to_texts.insert_record_stream(from_texts.get_record_stream(
3928
3652
            text_keys, self.target._format._fetch_order,
3935
3659
            # for the new revisions that we are about to insert.  We do this
3936
3660
            # before adding the revisions so that no revision is added until
3937
3661
            # 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
3662
            parent_ids = set()
3941
3663
            revision_ids = set()
3942
3664
            for revision in pending_revisions:
3945
3667
            parent_ids.difference_update(revision_ids)
3946
3668
            parent_ids.discard(_mod_revision.NULL_REVISION)
3947
3669
            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):
 
3670
            for parent_tree in self.source.revision_trees(parent_ids):
 
3671
                basis_id, delta = self._get_delta_for_revision(tree, parent_ids, basis_id, cache)
3951
3672
                current_revision_id = parent_tree.get_revision_id()
3952
3673
                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
3674
                self.target.add_inventory_by_delta(
3961
3675
                    basis_id, delta, current_revision_id, parents_parents)
3962
3676
        # insert signatures and revisions
3976
3690
 
3977
3691
        :param revision_ids: The list of revisions to fetch. Must be in
3978
3692
            topological order.
3979
 
        :param pb: A ProgressTask
 
3693
        :param pb: A ProgressBar
3980
3694
        :return: None
3981
3695
        """
3982
3696
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3984
3698
        cache = lru_cache.LRUCache(100)
3985
3699
        cache[basis_id] = basis_tree
3986
3700
        del basis_tree # We don't want to hang on to it here
3987
 
        hints = []
3988
 
        a_graph = None
3989
 
 
3990
3701
        for offset in range(0, len(revision_ids), batch_size):
3991
3702
            self.target.start_write_group()
3992
3703
            try:
3995
3706
                batch = revision_ids[offset:offset+batch_size]
3996
3707
                basis_id = self._fetch_batch(batch, basis_id, cache)
3997
3708
            except:
3998
 
                self.source._safe_to_return_from_cache = False
3999
3709
                self.target.abort_write_group()
4000
3710
                raise
4001
3711
            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)
 
3712
                self.target.commit_write_group()
4007
3713
        pb.update('Transferring revisions', len(revision_ids),
4008
3714
                  len(revision_ids))
4009
3715
 
4013
3719
        """See InterRepository.fetch()."""
4014
3720
        if fetch_spec is not None:
4015
3721
            raise AssertionError("Not implemented yet...")
4016
 
        ui.ui_factory.warn_experimental_format_fetch(self)
4017
3722
        if (not self.source.supports_rich_root()
4018
3723
            and self.target.supports_rich_root()):
4019
3724
            self._converting_to_rich_root = True
4020
3725
            self._revision_id_to_root_id = {}
4021
3726
        else:
4022
3727
            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
3728
        revision_ids = self.target.search_missing_revision_ids(self.source,
4029
3729
            revision_id, find_ghosts=find_ghosts).get_keys()
4030
3730
        if not revision_ids:
4036
3736
        # Walk though all revisions; get inventory deltas, copy referenced
4037
3737
        # texts that delta references, insert the delta, revision and
4038
3738
        # signature.
 
3739
        first_rev = self.source.get_revision(revision_ids[0])
4039
3740
        if pb is None:
4040
3741
            my_pb = ui.ui_factory.nested_progress_bar()
4041
3742
            pb = my_pb
4065
3766
            basis_id = first_rev.parent_ids[0]
4066
3767
            # only valid as a basis if the target has it
4067
3768
            self.target.get_revision(basis_id)
4068
 
            # Try to get a basis tree - if it's a ghost it will hit the
 
3769
            # Try to get a basis tree - if its a ghost it will hit the
4069
3770
            # NoSuchRevision case.
4070
3771
            basis_tree = self.source.revision_tree(basis_id)
4071
3772
        except (IndexError, errors.NoSuchRevision):
4078
3779
InterRepository.register_optimiser(InterSameDataRepository)
4079
3780
InterRepository.register_optimiser(InterWeaveRepo)
4080
3781
InterRepository.register_optimiser(InterKnitRepo)
 
3782
InterRepository.register_optimiser(InterPackRepo)
4081
3783
 
4082
3784
 
4083
3785
class CopyConverter(object):
4099
3801
        :param to_convert: The disk object to convert.
4100
3802
        :param pb: a progress bar to use for progress information.
4101
3803
        """
4102
 
        pb = ui.ui_factory.nested_progress_bar()
 
3804
        self.pb = pb
4103
3805
        self.count = 0
4104
3806
        self.total = 4
4105
3807
        # this is only useful with metadir layouts - separated repo content.
4106
3808
        # trigger an assertion if not such
4107
3809
        repo._format.get_format_string()
4108
3810
        self.repo_dir = repo.bzrdir
4109
 
        pb.update('Moving repository to repository.backup')
 
3811
        self.step('Moving repository to repository.backup')
4110
3812
        self.repo_dir.transport.move('repository', 'repository.backup')
4111
3813
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4112
3814
        repo._format.check_conversion_target(self.target_format)
4113
3815
        self.source_repo = repo._format.open(self.repo_dir,
4114
3816
            _found=True,
4115
3817
            _override_transport=backup_transport)
4116
 
        pb.update('Creating new repository')
 
3818
        self.step('Creating new repository')
4117
3819
        converted = self.target_format.initialize(self.repo_dir,
4118
3820
                                                  self.source_repo.is_shared())
4119
3821
        converted.lock_write()
4120
3822
        try:
4121
 
            pb.update('Copying content')
 
3823
            self.step('Copying content into repository.')
4122
3824
            self.source_repo.copy_content_into(converted)
4123
3825
        finally:
4124
3826
            converted.unlock()
4125
 
        pb.update('Deleting old repository content')
 
3827
        self.step('Deleting old repository content.')
4126
3828
        self.repo_dir.transport.delete_tree('repository.backup')
4127
 
        ui.ui_factory.note('repository converted')
4128
 
        pb.finished()
 
3829
        self.pb.note('repository converted')
 
3830
 
 
3831
    def step(self, message):
 
3832
        """Update the pb by a step."""
 
3833
        self.count +=1
 
3834
        self.pb.update(message, self.count, self.total)
4129
3835
 
4130
3836
 
4131
3837
_unescape_map = {
4160
3866
 
4161
3867
class _VersionedFileChecker(object):
4162
3868
 
4163
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
3869
    def __init__(self, repository, text_key_references=None):
4164
3870
        self.repository = repository
4165
3871
        self.text_index = self.repository._generate_text_key_index(
4166
 
            text_key_references=text_key_references, ancestors=ancestors)
 
3872
            text_key_references=text_key_references)
4167
3873
 
4168
3874
    def calculate_file_version_parents(self, text_key):
4169
3875
        """Calculate the correct parents for a file version according to
4187
3893
            revision_id) tuples for versions that are present in this versioned
4188
3894
            file, but not used by the corresponding inventory.
4189
3895
        """
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
3896
        wrong_parents = {}
4203
3897
        self.file_ids = set([file_id for file_id, _ in
4204
3898
            self.text_index.iterkeys()])
4205
3899
        # text keys is now grouped by file_id
 
3900
        n_weaves = len(self.file_ids)
 
3901
        files_in_revisions = {}
 
3902
        revisions_of_files = {}
4206
3903
        n_versions = len(self.text_index)
4207
3904
        progress_bar.update('loading text store', 0, n_versions)
4208
3905
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4210
3907
        text_keys = self.repository.texts.keys()
4211
3908
        unused_keys = frozenset(text_keys) - set(self.text_index)
4212
3909
        for num, key in enumerate(self.text_index.iterkeys()):
4213
 
            progress_bar.update('checking text graph', num, n_versions)
 
3910
            if progress_bar is not None:
 
3911
                progress_bar.update('checking text graph', num, n_versions)
4214
3912
            correct_parents = self.calculate_file_version_parents(key)
4215
3913
            try:
4216
3914
                knit_parents = parent_map[key]
4265
3963
        try:
4266
3964
            if resume_tokens:
4267
3965
                self.target_repo.resume_write_group(resume_tokens)
4268
 
                is_resume = True
4269
3966
            else:
4270
3967
                self.target_repo.start_write_group()
4271
 
                is_resume = False
4272
3968
            try:
4273
3969
                # locked_insert_stream performs a commit|suspend.
4274
 
                return self._locked_insert_stream(stream, src_format,
4275
 
                    is_resume)
 
3970
                return self._locked_insert_stream(stream, src_format)
4276
3971
            except:
4277
3972
                self.target_repo.abort_write_group(suppress_errors=True)
4278
3973
                raise
4279
3974
        finally:
4280
3975
            self.target_repo.unlock()
4281
3976
 
4282
 
    def _locked_insert_stream(self, stream, src_format, is_resume):
 
3977
    def _locked_insert_stream(self, stream, src_format):
4283
3978
        to_serializer = self.target_repo._format._serializer
4284
3979
        src_serializer = src_format._serializer
4285
 
        new_pack = None
4286
3980
        if to_serializer == src_serializer:
4287
3981
            # If serializers match and the target is a pack repository, set the
4288
3982
            # write cache size on the new pack.  This avoids poor performance
4302
3996
            else:
4303
3997
                new_pack.set_write_cache_size(1024*1024)
4304
3998
        for substream_type, substream in stream:
4305
 
            if 'stream' in debug.debug_flags:
4306
 
                mutter('inserting substream: %s', substream_type)
4307
3999
            if substream_type == 'texts':
4308
4000
                self.target_repo.texts.insert_record_stream(substream)
4309
4001
            elif substream_type == 'inventories':
4313
4005
                else:
4314
4006
                    self._extract_and_insert_inventories(
4315
4007
                        substream, src_serializer)
4316
 
            elif substream_type == 'inventory-deltas':
4317
 
                self._extract_and_insert_inventory_deltas(
4318
 
                    substream, src_serializer)
4319
4008
            elif substream_type == 'chk_bytes':
4320
4009
                # XXX: This doesn't support conversions, as it assumes the
4321
4010
                #      conversion was done in the fetch code.
4325
4014
                # required if the serializers are different only in terms of
4326
4015
                # the inventory.
4327
4016
                if src_serializer == to_serializer:
4328
 
                    self.target_repo.revisions.insert_record_stream(substream)
 
4017
                    self.target_repo.revisions.insert_record_stream(
 
4018
                        substream)
4329
4019
                else:
4330
4020
                    self._extract_and_insert_revisions(substream,
4331
4021
                        src_serializer)
4333
4023
                self.target_repo.signatures.insert_record_stream(substream)
4334
4024
            else:
4335
4025
                raise AssertionError('kaboom! %s' % (substream_type,))
4336
 
        # Done inserting data, and the missing_keys calculations will try to
4337
 
        # read back from the inserted data, so flush the writes to the new pack
4338
 
        # (if this is pack format).
4339
 
        if new_pack is not None:
4340
 
            new_pack._write_data('', flush=True)
4341
4026
        # Find all the new revisions (including ones from resume_tokens)
4342
 
        missing_keys = self.target_repo.get_missing_parent_inventories(
4343
 
            check_for_missing_texts=is_resume)
 
4027
        missing_keys = self.target_repo.get_missing_parent_inventories()
4344
4028
        try:
4345
4029
            for prefix, versioned_file in (
4346
4030
                ('texts', self.target_repo.texts),
4347
4031
                ('inventories', self.target_repo.inventories),
4348
4032
                ('revisions', self.target_repo.revisions),
4349
4033
                ('signatures', self.target_repo.signatures),
4350
 
                ('chk_bytes', self.target_repo.chk_bytes),
4351
4034
                ):
4352
 
                if versioned_file is None:
4353
 
                    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
4035
                missing_keys.update((prefix,) + key for key in
4362
4036
                    versioned_file.get_missing_compression_parent_keys())
4363
4037
        except NotImplementedError:
4372
4046
                # missing keys can handle suspending a write group).
4373
4047
                write_group_tokens = self.target_repo.suspend_write_group()
4374
4048
                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)
 
4049
        self.target_repo.commit_write_group()
4379
4050
        return [], set()
4380
4051
 
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):
 
4052
    def _extract_and_insert_inventories(self, substream, serializer):
4402
4053
        """Generate a new inventory versionedfile in target, converting data.
4403
4054
 
4404
4055
        The inventory is retrieved from the source, (deserializing it), and
4405
4056
        stored in the target (reserializing it in a different format).
4406
4057
        """
4407
 
        target_rich_root = self.target_repo._format.rich_root_data
4408
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4409
4058
        for record in substream:
4410
 
            # It's not a delta, so it must be a fulltext in the source
4411
 
            # serializer's format.
4412
4059
            bytes = record.get_bytes_as('fulltext')
4413
4060
            revision_id = record.key[0]
4414
4061
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4415
4062
            parents = [key[0] for key in record.parents]
4416
4063
            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
4064
 
4421
4065
    def _extract_and_insert_revisions(self, substream, serializer):
4422
4066
        for record in substream:
4439
4083
        """Create a StreamSource streaming from from_repository."""
4440
4084
        self.from_repository = from_repository
4441
4085
        self.to_format = to_format
4442
 
        self._record_counter = RecordCounter()
4443
4086
 
4444
4087
    def delta_on_metadata(self):
4445
4088
        """Return True if delta's are permitted on metadata streams.
4472
4115
        return [('signatures', signatures), ('revisions', revisions)]
4473
4116
 
4474
4117
    def _generate_root_texts(self, revs):
4475
 
        """This will be called by get_stream between fetching weave texts and
 
4118
        """This will be called by __fetch between fetching weave texts and
4476
4119
        fetching the inventory weave.
 
4120
 
 
4121
        Subclasses should override this if they need to generate root texts
 
4122
        after fetching weave texts.
4477
4123
        """
4478
4124
        if self._rich_root_upgrade():
4479
 
            return _mod_fetch.Inter1and2Helper(
 
4125
            import bzrlib.fetch
 
4126
            return bzrlib.fetch.Inter1and2Helper(
4480
4127
                self.from_repository).generate_root_texts(revs)
4481
4128
        else:
4482
4129
            return []
4485
4132
        phase = 'file'
4486
4133
        revs = search.get_keys()
4487
4134
        graph = self.from_repository.get_graph()
4488
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
 
4135
        revs = list(graph.iter_topo_order(revs))
4489
4136
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4490
4137
        text_keys = []
4491
4138
        for knit_kind, file_id, revisions in data_to_fetch:
4510
4157
                # will be valid.
4511
4158
                for _ in self._generate_root_texts(revs):
4512
4159
                    yield _
 
4160
                # NB: This currently reopens the inventory weave in source;
 
4161
                # using a single stream interface instead would avoid this.
 
4162
                from_weave = self.from_repository.inventories
4513
4163
                # we fetch only the referenced inventories because we do not
4514
4164
                # know for unselected inventories whether all their required
4515
4165
                # texts are present in the other repository - it could be
4534
4184
        keys['texts'] = set()
4535
4185
        keys['revisions'] = set()
4536
4186
        keys['inventories'] = set()
4537
 
        keys['chk_bytes'] = set()
4538
4187
        keys['signatures'] = set()
4539
4188
        for key in missing_keys:
4540
4189
            keys[key[0]].add(key[1:])
4547
4196
                    keys['revisions'],))
4548
4197
        for substream_kind, keys in keys.iteritems():
4549
4198
            vf = getattr(self.from_repository, substream_kind)
4550
 
            if vf is None and keys:
4551
 
                    raise AssertionError(
4552
 
                        "cannot fill in keys for a versioned file we don't"
4553
 
                        " have: %s needs %s" % (substream_kind, keys))
4554
 
            if not keys:
4555
 
                # No need to stream something we don't have
4556
 
                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
4199
            # Ask for full texts always so that we don't need more round trips
4570
4200
            # after this stream.
4571
 
            # Some of the missing keys are genuinely ghosts, so filter absent
4572
 
            # records. The Sink is responsible for doing another check to
4573
 
            # ensure that ghosts don't introduce missing data for future
4574
 
            # fetches.
4575
 
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
4576
 
                self.to_format._fetch_order, True))
 
4201
            stream = vf.get_record_stream(keys,
 
4202
                self.to_format._fetch_order, True)
4577
4203
            yield substream_kind, stream
4578
4204
 
4579
4205
    def inventory_fetch_order(self):
4586
4212
        return (not self.from_repository._format.rich_root_data and
4587
4213
            self.to_format.rich_root_data)
4588
4214
 
4589
 
    def _get_inventory_stream(self, revision_ids, missing=False):
 
4215
    def _get_inventory_stream(self, revision_ids):
4590
4216
        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)
 
4217
        if (from_format.supports_chks and self.to_format.supports_chks
 
4218
            and (from_format._serializer == self.to_format._serializer)):
 
4219
            # Both sides support chks, and they use the same serializer, so it
 
4220
            # is safe to transmit the chk pages and inventory pages across
 
4221
            # as-is.
 
4222
            return self._get_chk_inventory_stream(revision_ids)
 
4223
        elif (not from_format.supports_chks):
 
4224
            # Source repository doesn't support chks. So we can transmit the
 
4225
            # inventories 'as-is' and either they are just accepted on the
 
4226
            # target, or the Sink will properly convert it.
 
4227
            return self._get_simple_inventory_stream(revision_ids)
4607
4228
        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)
 
4229
            # XXX: Hack to make not-chk->chk fetch: copy the inventories as
 
4230
            #      inventories. Note that this should probably be done somehow
 
4231
            #      as part of bzrlib.repository.StreamSink. Except JAM couldn't
 
4232
            #      figure out how a non-chk repository could possibly handle
 
4233
            #      deserializing an inventory stream from a chk repo, as it
 
4234
            #      doesn't have a way to understand individual pages.
 
4235
            return self._get_convertable_inventory_stream(revision_ids)
4612
4236
 
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.
 
4237
    def _get_simple_inventory_stream(self, revision_ids):
4616
4238
        from_weave = self.from_repository.inventories
4617
 
        if missing:
4618
 
            delta_closure = True
4619
 
        else:
4620
 
            delta_closure = not self.delta_on_metadata()
4621
4239
        yield ('inventories', from_weave.get_record_stream(
4622
4240
            [(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
 
        """
 
4241
            self.inventory_fetch_order(),
 
4242
            not self.delta_on_metadata()))
 
4243
 
 
4244
    def _get_chk_inventory_stream(self, revision_ids):
 
4245
        """Fetch the inventory texts, along with the associated chk maps."""
 
4246
        # We want an inventory outside of the search set, so that we can filter
 
4247
        # out uninteresting chk pages. For now we use
 
4248
        # _find_revision_outside_set, but if we had a Search with cut_revs, we
 
4249
        # could use that instead.
 
4250
        start_rev_id = self.from_repository._find_revision_outside_set(
 
4251
                            revision_ids)
 
4252
        start_rev_key = (start_rev_id,)
 
4253
        inv_keys_to_fetch = [(rev_id,) for rev_id in revision_ids]
 
4254
        if start_rev_id != _mod_revision.NULL_REVISION:
 
4255
            inv_keys_to_fetch.append((start_rev_id,))
 
4256
        # Any repo that supports chk_bytes must also support out-of-order
 
4257
        # insertion. At least, that is how we expect it to work
 
4258
        # We use get_record_stream instead of iter_inventories because we want
 
4259
        # to be able to insert the stream as well. We could instead fetch
 
4260
        # allowing deltas, and then iter_inventories, but we don't know whether
 
4261
        # source or target is more 'local' anway.
 
4262
        inv_stream = self.from_repository.inventories.get_record_stream(
 
4263
            inv_keys_to_fetch, 'unordered',
 
4264
            True) # We need them as full-texts so we can find their references
 
4265
        uninteresting_chk_roots = set()
 
4266
        interesting_chk_roots = set()
 
4267
        def filter_inv_stream(inv_stream):
 
4268
            for idx, record in enumerate(inv_stream):
 
4269
                ### child_pb.update('fetch inv', idx, len(inv_keys_to_fetch))
 
4270
                bytes = record.get_bytes_as('fulltext')
 
4271
                chk_inv = inventory.CHKInventory.deserialise(
 
4272
                    self.from_repository.chk_bytes, bytes, record.key)
 
4273
                if record.key == start_rev_key:
 
4274
                    uninteresting_chk_roots.add(chk_inv.id_to_entry.key())
 
4275
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4276
                    if p_id_map is not None:
 
4277
                        uninteresting_chk_roots.add(p_id_map.key())
 
4278
                else:
 
4279
                    yield record
 
4280
                    interesting_chk_roots.add(chk_inv.id_to_entry.key())
 
4281
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4282
                    if p_id_map is not None:
 
4283
                        interesting_chk_roots.add(p_id_map.key())
 
4284
        ### pb.update('fetch inventory', 0, 2)
 
4285
        yield ('inventories', filter_inv_stream(inv_stream))
 
4286
        # Now that we have worked out all of the interesting root nodes, grab
 
4287
        # all of the interesting pages and insert them
 
4288
        ### pb.update('fetch inventory', 1, 2)
 
4289
        interesting = chk_map.iter_interesting_nodes(
 
4290
            self.from_repository.chk_bytes, interesting_chk_roots,
 
4291
            uninteresting_chk_roots)
 
4292
        def to_stream_adapter():
 
4293
            """Adapt the iter_interesting_nodes result to a single stream.
 
4294
 
 
4295
            iter_interesting_nodes returns records as it processes them, along
 
4296
            with keys. However, we only want to return the records themselves.
 
4297
            """
 
4298
            for record, items in interesting:
 
4299
                if record is not None:
 
4300
                    yield record
 
4301
        # XXX: We could instead call get_record_stream(records.keys())
 
4302
        #      ATM, this will always insert the records as fulltexts, and
 
4303
        #      requires that you can hang on to records once you have gone
 
4304
        #      on to the next one. Further, it causes the target to
 
4305
        #      recompress the data. Testing shows it to be faster than
 
4306
        #      requesting the records again, though.
 
4307
        yield ('chk_bytes', to_stream_adapter())
 
4308
        ### pb.update('fetch inventory', 2, 2)
 
4309
 
 
4310
    def _get_convertable_inventory_stream(self, revision_ids):
 
4311
        # XXX: One of source or target is using chks, and they don't have
 
4312
        #      compatible serializations. The StreamSink code expects to be
 
4313
        #      able to convert on the target, so we need to put
 
4314
        #      bytes-on-the-wire that can be converted
 
4315
        yield ('inventories', self._stream_invs_as_fulltexts(revision_ids))
 
4316
 
 
4317
    def _stream_invs_as_fulltexts(self, revision_ids):
4647
4318
        from_repo = self.from_repository
 
4319
        from_serializer = from_repo._format._serializer
4648
4320
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4649
4321
        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:
 
4322
        for inv in self.from_repository.iter_inventories(revision_ids):
 
4323
            # XXX: This is a bit hackish, but it works. Basically,
 
4324
            #      CHKSerializer 'accidentally' supports
 
4325
            #      read/write_inventory_to_string, even though that is never
 
4326
            #      the format that is stored on disk. It *does* give us a
 
4327
            #      single string representation for an inventory, so live with
 
4328
            #      it for now.
 
4329
            #      This would be far better if we had a 'serialized inventory
 
4330
            #      delta' form. Then we could use 'inventory._make_delta', and
 
4331
            #      transmit that. This would both be faster to generate, and
 
4332
            #      result in fewer bytes-on-the-wire.
 
4333
            as_bytes = from_serializer.write_inventory_to_string(inv)
4666
4334
            key = (inv.revision_id,)
4667
4335
            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
4336
            yield versionedfile.FulltextContentFactory(
4700
 
                key, parent_keys, None, delta_serialized)
4701
 
 
4702
 
 
4703
 
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
4704
 
                    stop_revision=None):
4705
 
    """Extend the partial history to include a given index
4706
 
 
4707
 
    If a stop_index is supplied, stop when that index has been reached.
4708
 
    If a stop_revision is supplied, stop when that revision is
4709
 
    encountered.  Otherwise, stop when the beginning of history is
4710
 
    reached.
4711
 
 
4712
 
    :param stop_index: The index which should be present.  When it is
4713
 
        present, history extension will stop.
4714
 
    :param stop_revision: The revision id which should be present.  When
4715
 
        it is encountered, history extension will stop.
4716
 
    """
4717
 
    start_revision = partial_history_cache[-1]
4718
 
    iterator = repo.iter_reverse_revision_history(start_revision)
4719
 
    try:
4720
 
        #skip the last revision in the list
4721
 
        iterator.next()
4722
 
        while True:
4723
 
            if (stop_index is not None and
4724
 
                len(partial_history_cache) > stop_index):
4725
 
                break
4726
 
            if partial_history_cache[-1] == stop_revision:
4727
 
                break
4728
 
            revision_id = iterator.next()
4729
 
            partial_history_cache.append(revision_id)
4730
 
    except StopIteration:
4731
 
        # No more history
4732
 
        return
 
4337
                key, parent_keys, None, as_bytes)
4733
4338