~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-04-09 20:23:07 UTC
  • mfrom: (4265.1.4 bbc-merge)
  • Revision ID: pqm@pqm.ubuntu.com-20090409202307-n0depb16qepoe21o
(jam) Change _fetch_uses_deltas = False for CHK repos until we can
        write a better fix.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
24
24
    bzrdir,
25
25
    check,
26
26
    chk_map,
27
 
    config,
28
27
    debug,
29
28
    errors,
30
 
    fetch as _mod_fetch,
31
29
    fifo_cache,
32
30
    generate_ids,
33
31
    gpg,
34
32
    graph,
35
33
    inventory,
36
 
    inventory_delta,
37
34
    lazy_regex,
38
35
    lockable_files,
39
36
    lockdir,
40
37
    lru_cache,
41
38
    osutils,
42
39
    revision as _mod_revision,
43
 
    static_tuple,
44
40
    symbol_versioning,
45
 
    trace,
46
41
    tsort,
47
42
    ui,
48
43
    versionedfile,
53
48
from bzrlib.testament import Testament
54
49
""")
55
50
 
56
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
51
from bzrlib.decorators import needs_read_lock, needs_write_lock
57
52
from bzrlib.inter import InterObject
58
53
from bzrlib.inventory import (
59
54
    Inventory,
61
56
    ROOT_ID,
62
57
    entry_factory,
63
58
    )
64
 
from bzrlib.lock import _RelockDebugMixin
65
59
from bzrlib import registry
 
60
from bzrlib.symbol_versioning import (
 
61
        deprecated_method,
 
62
        )
66
63
from bzrlib.trace import (
67
64
    log_exception_quietly, note, mutter, mutter_callsite, warning)
68
65
 
210
207
            # an inventory delta was accumulated without creating a new
211
208
            # inventory.
212
209
            basis_id = self.basis_delta_revision
213
 
            # We ignore the 'inventory' returned by add_inventory_by_delta
214
 
            # because self.new_inventory is used to hint to the rest of the
215
 
            # system what code path was taken
216
 
            self.inv_sha1, _ = self.repository.add_inventory_by_delta(
 
210
            self.inv_sha1 = self.repository.add_inventory_by_delta(
217
211
                basis_id, self._basis_delta, self._new_revision_id,
218
212
                self.parents)
219
213
        else:
473
467
            if content_summary[2] is None:
474
468
                raise ValueError("Files must not have executable = None")
475
469
            if not store:
476
 
                # We can't trust a check of the file length because of content
477
 
                # filtering...
478
 
                if (# if the exec bit has changed we have to store:
 
470
                if (# if the file length changed we have to store:
 
471
                    parent_entry.text_size != content_summary[1] or
 
472
                    # if the exec bit has changed we have to store:
479
473
                    parent_entry.executable != content_summary[2]):
480
474
                    store = True
481
475
                elif parent_entry.text_sha1 == content_summary[3]:
500
494
            ie.executable = content_summary[2]
501
495
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
502
496
            try:
503
 
                text = file_obj.read()
 
497
                lines = file_obj.readlines()
504
498
            finally:
505
499
                file_obj.close()
506
500
            try:
507
501
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
508
 
                    ie.file_id, text, heads, nostore_sha)
 
502
                    ie.file_id, lines, heads, nostore_sha)
509
503
                # Let the caller know we generated a stat fingerprint.
510
504
                fingerprint = (ie.text_sha1, stat_value)
511
505
            except errors.ExistingContent:
523
517
                # carry over:
524
518
                ie.revision = parent_entry.revision
525
519
                return self._get_delta(ie, basis_inv, path), False, None
526
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
520
            lines = []
 
521
            self._add_text_to_weave(ie.file_id, lines, heads, None)
527
522
        elif kind == 'symlink':
528
523
            current_link_target = content_summary[3]
529
524
            if not store:
537
532
                ie.symlink_target = parent_entry.symlink_target
538
533
                return self._get_delta(ie, basis_inv, path), False, None
539
534
            ie.symlink_target = current_link_target
540
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
535
            lines = []
 
536
            self._add_text_to_weave(ie.file_id, lines, heads, None)
541
537
        elif kind == 'tree-reference':
542
538
            if not store:
543
539
                if content_summary[3] != parent_entry.reference_revision:
548
544
                ie.revision = parent_entry.revision
549
545
                return self._get_delta(ie, basis_inv, path), False, None
550
546
            ie.reference_revision = content_summary[3]
551
 
            if ie.reference_revision is None:
552
 
                raise AssertionError("invalid content_summary for nested tree: %r"
553
 
                    % (content_summary,))
554
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
547
            lines = []
 
548
            self._add_text_to_weave(ie.file_id, lines, heads, None)
555
549
        else:
556
550
            raise NotImplementedError('unknown kind')
557
551
        ie.revision = self._new_revision_id
751
745
                        entry.executable = True
752
746
                    else:
753
747
                        entry.executable = False
754
 
                    if (carry_over_possible and
 
748
                    if (carry_over_possible and 
755
749
                        parent_entry.executable == entry.executable):
756
750
                            # Check the file length, content hash after reading
757
751
                            # the file.
760
754
                        nostore_sha = None
761
755
                    file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
762
756
                    try:
763
 
                        text = file_obj.read()
 
757
                        lines = file_obj.readlines()
764
758
                    finally:
765
759
                        file_obj.close()
766
760
                    try:
767
761
                        entry.text_sha1, entry.text_size = self._add_text_to_weave(
768
 
                            file_id, text, heads, nostore_sha)
 
762
                            file_id, lines, heads, nostore_sha)
769
763
                        yield file_id, change[1][1], (entry.text_sha1, stat_value)
770
764
                    except errors.ExistingContent:
771
765
                        # No content change against a carry_over parent
780
774
                        parent_entry.symlink_target == entry.symlink_target):
781
775
                        carried_over = True
782
776
                    else:
783
 
                        self._add_text_to_weave(change[0], '', heads, None)
 
777
                        self._add_text_to_weave(change[0], [], heads, None)
784
778
                elif kind == 'directory':
785
779
                    if carry_over_possible:
786
780
                        carried_over = True
788
782
                        # Nothing to set on the entry.
789
783
                        # XXX: split into the Root and nonRoot versions.
790
784
                        if change[1][1] != '' or self.repository.supports_rich_root():
791
 
                            self._add_text_to_weave(change[0], '', heads, None)
 
785
                            self._add_text_to_weave(change[0], [], heads, None)
792
786
                elif kind == 'tree-reference':
793
787
                    if not self.repository._format.supports_tree_reference:
794
788
                        # This isn't quite sane as an error, but we shouldn't
797
791
                        # references.
798
792
                        raise errors.UnsupportedOperation(tree.add_reference,
799
793
                            self.repository)
800
 
                    reference_revision = tree.get_reference_revision(change[0])
801
 
                    entry.reference_revision = reference_revision
 
794
                    entry.reference_revision = \
 
795
                        tree.get_reference_revision(change[0])
802
796
                    if (carry_over_possible and
803
797
                        parent_entry.reference_revision == reference_revision):
804
798
                        carried_over = True
805
799
                    else:
806
 
                        self._add_text_to_weave(change[0], '', heads, None)
 
800
                        self._add_text_to_weave(change[0], [], heads, None)
807
801
                else:
808
802
                    raise AssertionError('unknown kind %r' % kind)
809
803
                if not carried_over:
818
812
                seen_root = True
819
813
        self.new_inventory = None
820
814
        if len(inv_delta):
821
 
            # This should perhaps be guarded by a check that the basis we
822
 
            # commit against is the basis for the commit and if not do a delta
823
 
            # against the basis.
824
815
            self._any_changes = True
825
816
        if not seen_root:
826
817
            # housekeeping root entry changes do not affect no-change commits.
827
818
            self._require_root_change(tree)
828
819
        self.basis_delta_revision = basis_revision_id
829
820
 
830
 
    def _add_text_to_weave(self, file_id, new_text, parents, nostore_sha):
831
 
        parent_keys = tuple([(file_id, parent) for parent in parents])
832
 
        return self.repository.texts._add_text(
833
 
            (file_id, self._new_revision_id), parent_keys, new_text,
834
 
            nostore_sha=nostore_sha, random_id=self.random_revid)[0:2]
 
821
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
 
822
        # Note: as we read the content directly from the tree, we know its not
 
823
        # been turned into unicode or badly split - but a broken tree
 
824
        # implementation could give us bad output from readlines() so this is
 
825
        # not a guarantee of safety. What would be better is always checking
 
826
        # the content during test suite execution. RBC 20070912
 
827
        parent_keys = tuple((file_id, parent) for parent in parents)
 
828
        return self.repository.texts.add_lines(
 
829
            (file_id, self._new_revision_id), parent_keys, new_lines,
 
830
            nostore_sha=nostore_sha, random_id=self.random_revid,
 
831
            check_content=False)[0:2]
835
832
 
836
833
 
837
834
class RootCommitBuilder(CommitBuilder):
863
860
######################################################################
864
861
# Repositories
865
862
 
866
 
 
867
 
class Repository(_RelockDebugMixin, bzrdir.ControlComponent):
 
863
class Repository(object):
868
864
    """Repository holding history for one or more branches.
869
865
 
870
866
    The repository holds and retrieves historical information including
939
935
        """
940
936
        if self._write_group is not self.get_transaction():
941
937
            # has an unlock or relock occured ?
942
 
            if suppress_errors:
943
 
                mutter(
944
 
                '(suppressed) mismatched lock context and write group. %r, %r',
945
 
                self._write_group, self.get_transaction())
946
 
                return
947
938
            raise errors.BzrError(
948
939
                'mismatched lock context and write group. %r, %r' %
949
940
                (self._write_group, self.get_transaction()))
978
969
        """
979
970
        if not self._format.supports_external_lookups:
980
971
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
981
 
        if self.is_locked():
982
 
            # This repository will call fallback.unlock() when we transition to
983
 
            # the unlocked state, so we make sure to increment the lock count
984
 
            repository.lock_read()
985
972
        self._check_fallback_repository(repository)
986
973
        self._fallback_repositories.append(repository)
987
974
        self.texts.add_fallback_versioned_files(repository.texts)
1028
1015
 
1029
1016
        :seealso: add_inventory, for the contract.
1030
1017
        """
1031
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
 
1018
        inv_lines = self._serialise_inventory_to_lines(inv)
1032
1019
        return self._inventory_add_lines(revision_id, parents,
1033
1020
            inv_lines, check_content=False)
1034
1021
 
1036
1023
                               parents, basis_inv=None, propagate_caches=False):
1037
1024
        """Add a new inventory expressed as a delta against another revision.
1038
1025
 
1039
 
        See the inventory developers documentation for the theory behind
1040
 
        inventory deltas.
1041
 
 
1042
1026
        :param basis_revision_id: The inventory id the delta was created
1043
1027
            against. (This does not have to be a direct parent.)
1044
1028
        :param delta: The inventory delta (see Inventory.apply_delta for
1083
1067
        check_content=True):
1084
1068
        """Store lines in inv_vf and return the sha1 of the inventory."""
1085
1069
        parents = [(parent,) for parent in parents]
1086
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
1070
        return self.inventories.add_lines((revision_id,), parents, lines,
1087
1071
            check_content=check_content)[0]
1088
 
        self.inventories._access.flush()
1089
 
        return result
1090
1072
 
1091
1073
    def add_revision(self, revision_id, rev, inv=None, config=None):
1092
1074
        """Add rev to the revision store as revision_id.
1168
1150
        # The old API returned a list, should this actually be a set?
1169
1151
        return parent_map.keys()
1170
1152
 
1171
 
    def _check_inventories(self, checker):
1172
 
        """Check the inventories found from the revision scan.
1173
 
        
1174
 
        This is responsible for verifying the sha1 of inventories and
1175
 
        creating a pending_keys set that covers data referenced by inventories.
1176
 
        """
1177
 
        bar = ui.ui_factory.nested_progress_bar()
1178
 
        try:
1179
 
            self._do_check_inventories(checker, bar)
1180
 
        finally:
1181
 
            bar.finished()
1182
 
 
1183
 
    def _do_check_inventories(self, checker, bar):
1184
 
        """Helper for _check_inventories."""
1185
 
        revno = 0
1186
 
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
1187
 
        kinds = ['chk_bytes', 'texts']
1188
 
        count = len(checker.pending_keys)
1189
 
        bar.update("inventories", 0, 2)
1190
 
        current_keys = checker.pending_keys
1191
 
        checker.pending_keys = {}
1192
 
        # Accumulate current checks.
1193
 
        for key in current_keys:
1194
 
            if key[0] != 'inventories' and key[0] not in kinds:
1195
 
                checker._report_items.append('unknown key type %r' % (key,))
1196
 
            keys[key[0]].add(key[1:])
1197
 
        if keys['inventories']:
1198
 
            # NB: output order *should* be roughly sorted - topo or
1199
 
            # inverse topo depending on repository - either way decent
1200
 
            # to just delta against. However, pre-CHK formats didn't
1201
 
            # try to optimise inventory layout on disk. As such the
1202
 
            # pre-CHK code path does not use inventory deltas.
1203
 
            last_object = None
1204
 
            for record in self.inventories.check(keys=keys['inventories']):
1205
 
                if record.storage_kind == 'absent':
1206
 
                    checker._report_items.append(
1207
 
                        'Missing inventory {%s}' % (record.key,))
1208
 
                else:
1209
 
                    last_object = self._check_record('inventories', record,
1210
 
                        checker, last_object,
1211
 
                        current_keys[('inventories',) + record.key])
1212
 
            del keys['inventories']
1213
 
        else:
1214
 
            return
1215
 
        bar.update("texts", 1)
1216
 
        while (checker.pending_keys or keys['chk_bytes']
1217
 
            or keys['texts']):
1218
 
            # Something to check.
1219
 
            current_keys = checker.pending_keys
1220
 
            checker.pending_keys = {}
1221
 
            # Accumulate current checks.
1222
 
            for key in current_keys:
1223
 
                if key[0] not in kinds:
1224
 
                    checker._report_items.append('unknown key type %r' % (key,))
1225
 
                keys[key[0]].add(key[1:])
1226
 
            # Check the outermost kind only - inventories || chk_bytes || texts
1227
 
            for kind in kinds:
1228
 
                if keys[kind]:
1229
 
                    last_object = None
1230
 
                    for record in getattr(self, kind).check(keys=keys[kind]):
1231
 
                        if record.storage_kind == 'absent':
1232
 
                            checker._report_items.append(
1233
 
                                'Missing %s {%s}' % (kind, record.key,))
1234
 
                        else:
1235
 
                            last_object = self._check_record(kind, record,
1236
 
                                checker, last_object, current_keys[(kind,) + record.key])
1237
 
                    keys[kind] = set()
1238
 
                    break
1239
 
 
1240
 
    def _check_record(self, kind, record, checker, last_object, item_data):
1241
 
        """Check a single text from this repository."""
1242
 
        if kind == 'inventories':
1243
 
            rev_id = record.key[0]
1244
 
            inv = self._deserialise_inventory(rev_id,
1245
 
                record.get_bytes_as('fulltext'))
1246
 
            if last_object is not None:
1247
 
                delta = inv._make_delta(last_object)
1248
 
                for old_path, path, file_id, ie in delta:
1249
 
                    if ie is None:
1250
 
                        continue
1251
 
                    ie.check(checker, rev_id, inv)
1252
 
            else:
1253
 
                for path, ie in inv.iter_entries():
1254
 
                    ie.check(checker, rev_id, inv)
1255
 
            if self._format.fast_deltas:
1256
 
                return inv
1257
 
        elif kind == 'chk_bytes':
1258
 
            # No code written to check chk_bytes for this repo format.
1259
 
            checker._report_items.append(
1260
 
                'unsupported key type chk_bytes for %s' % (record.key,))
1261
 
        elif kind == 'texts':
1262
 
            self._check_text(record, checker, item_data)
1263
 
        else:
1264
 
            checker._report_items.append(
1265
 
                'unknown key type %s for %s' % (kind, record.key))
1266
 
 
1267
 
    def _check_text(self, record, checker, item_data):
1268
 
        """Check a single text."""
1269
 
        # Check it is extractable.
1270
 
        # TODO: check length.
1271
 
        if record.storage_kind == 'chunked':
1272
 
            chunks = record.get_bytes_as(record.storage_kind)
1273
 
            sha1 = osutils.sha_strings(chunks)
1274
 
            length = sum(map(len, chunks))
1275
 
        else:
1276
 
            content = record.get_bytes_as('fulltext')
1277
 
            sha1 = osutils.sha_string(content)
1278
 
            length = len(content)
1279
 
        if item_data and sha1 != item_data[1]:
1280
 
            checker._report_items.append(
1281
 
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
1282
 
                (record.key, sha1, item_data[1], item_data[2]))
1283
 
 
1284
1153
    @staticmethod
1285
1154
    def create(a_bzrdir):
1286
1155
        """Construct the current default format repository in a_bzrdir."""
1291
1160
 
1292
1161
        :param _format: The format of the repository on disk.
1293
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.
1294
1167
        """
1295
 
        # In the future we will have a single api for all stores for
1296
 
        # getting file texts, inventories and revisions, then
1297
 
        # this construct will accept instances of those things.
1298
1168
        super(Repository, self).__init__()
1299
1169
        self._format = _format
1300
1170
        # the following are part of the public API for Repository:
1306
1176
        self._reconcile_does_inventory_gc = True
1307
1177
        self._reconcile_fixes_text_parents = False
1308
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()
1309
1184
        self._write_group = None
1310
1185
        # Additional places to query for data.
1311
1186
        self._fallback_repositories = []
1312
1187
        # An InventoryEntry cache, used during deserialization
1313
1188
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
1314
 
        # Is it safe to return inventory entries directly from the entry cache,
1315
 
        # rather copying them?
1316
 
        self._safe_to_return_from_cache = False
1317
 
 
1318
 
    @property
1319
 
    def user_transport(self):
1320
 
        return self.bzrdir.user_transport
1321
 
 
1322
 
    @property
1323
 
    def control_transport(self):
1324
 
        return self._transport
1325
1189
 
1326
1190
    def __repr__(self):
1327
 
        if self._fallback_repositories:
1328
 
            return '%s(%r, fallback_repositories=%r)' % (
1329
 
                self.__class__.__name__,
1330
 
                self.base,
1331
 
                self._fallback_repositories)
1332
 
        else:
1333
 
            return '%s(%r)' % (self.__class__.__name__,
1334
 
                               self.base)
1335
 
 
1336
 
    def _has_same_fallbacks(self, other_repo):
1337
 
        """Returns true if the repositories have the same fallbacks."""
1338
 
        my_fb = self._fallback_repositories
1339
 
        other_fb = other_repo._fallback_repositories
1340
 
        if len(my_fb) != len(other_fb):
1341
 
            return False
1342
 
        for f, g in zip(my_fb, other_fb):
1343
 
            if not f.has_same_location(g):
1344
 
                return False
1345
 
        return True
 
1191
        return '%s(%r)' % (self.__class__.__name__,
 
1192
                           self.base)
1346
1193
 
1347
1194
    def has_same_location(self, other):
1348
1195
        """Returns a boolean indicating if this repository is at the same
1393
1240
        """
1394
1241
        locked = self.is_locked()
1395
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()
1396
1246
        if not locked:
1397
 
            self._warn_if_deprecated()
1398
 
            self._note_lock('w')
1399
 
            for repo in self._fallback_repositories:
1400
 
                # Writes don't affect fallback repos
1401
 
                repo.lock_read()
1402
1247
            self._refresh_data()
1403
1248
        return result
1404
1249
 
1405
1250
    def lock_read(self):
1406
1251
        locked = self.is_locked()
1407
1252
        self.control_files.lock_read()
 
1253
        for repo in self._fallback_repositories:
 
1254
            repo.lock_read()
1408
1255
        if not locked:
1409
 
            self._warn_if_deprecated()
1410
 
            self._note_lock('r')
1411
 
            for repo in self._fallback_repositories:
1412
 
                repo.lock_read()
1413
1256
            self._refresh_data()
1414
1257
 
1415
1258
    def get_physical_lock_status(self):
1476
1319
 
1477
1320
        # now gather global repository information
1478
1321
        # XXX: This is available for many repos regardless of listability.
1479
 
        if self.user_transport.listable():
 
1322
        if self.bzrdir.root_transport.listable():
1480
1323
            # XXX: do we want to __define len__() ?
1481
1324
            # Maybe the versionedfiles object should provide a different
1482
1325
            # method to get the number of keys.
1492
1335
        :param using: If True, list only branches using this repository.
1493
1336
        """
1494
1337
        if using and not self.is_shared():
1495
 
            return self.bzrdir.list_branches()
 
1338
            try:
 
1339
                return [self.bzrdir.open_branch()]
 
1340
            except errors.NotBranchError:
 
1341
                return []
1496
1342
        class Evaluator(object):
1497
1343
 
1498
1344
            def __init__(self):
1507
1353
                    except errors.NoRepositoryPresent:
1508
1354
                        pass
1509
1355
                    else:
1510
 
                        return False, ([], repository)
 
1356
                        return False, (None, repository)
1511
1357
                self.first_call = False
1512
 
                value = (bzrdir.list_branches(), None)
 
1358
                try:
 
1359
                    value = (bzrdir.open_branch(), None)
 
1360
                except errors.NotBranchError:
 
1361
                    value = (None, None)
1513
1362
                return True, value
1514
1363
 
1515
 
        ret = []
1516
 
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
1517
 
                self.user_transport, evaluate=Evaluator()):
1518
 
            if branches is not None:
1519
 
                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)
1520
1369
            if not using and repository is not None:
1521
 
                ret.extend(repository.find_branches())
1522
 
        return ret
 
1370
                branches.extend(repository.find_branches())
 
1371
        return branches
1523
1372
 
1524
1373
    @needs_read_lock
1525
1374
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1554
1403
        """Commit the contents accrued within the current write group.
1555
1404
 
1556
1405
        :seealso: start_write_group.
1557
 
        
1558
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1559
1406
        """
1560
1407
        if self._write_group is not self.get_transaction():
1561
1408
            # has an unlock or relock occured ?
1562
1409
            raise errors.BzrError('mismatched lock context %r and '
1563
1410
                'write group %r.' %
1564
1411
                (self.get_transaction(), self._write_group))
1565
 
        result = self._commit_write_group()
 
1412
        self._commit_write_group()
1566
1413
        self._write_group = None
1567
 
        return result
1568
1414
 
1569
1415
    def _commit_write_group(self):
1570
1416
        """Template method for per-repository write group cleanup.
1578
1424
    def suspend_write_group(self):
1579
1425
        raise errors.UnsuspendableWriteGroup(self)
1580
1426
 
1581
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
1582
 
        """Return the keys of missing inventory parents for revisions added in
1583
 
        this write group.
1584
 
 
1585
 
        A revision is not complete if the inventory delta for that revision
1586
 
        cannot be calculated.  Therefore if the parent inventories of a
1587
 
        revision are not present, the revision is incomplete, and e.g. cannot
1588
 
        be streamed by a smart server.  This method finds missing inventory
1589
 
        parents for revisions added in this write group.
1590
 
        """
1591
 
        if not self._format.supports_external_lookups:
1592
 
            # This is only an issue for stacked repositories
1593
 
            return set()
1594
 
        if not self.is_in_write_group():
1595
 
            raise AssertionError('not in a write group')
1596
 
 
1597
 
        # XXX: We assume that every added revision already has its
1598
 
        # corresponding inventory, so we only check for parent inventories that
1599
 
        # might be missing, rather than all inventories.
1600
 
        parents = set(self.revisions._index.get_missing_parents())
1601
 
        parents.discard(_mod_revision.NULL_REVISION)
1602
 
        unstacked_inventories = self.inventories._index
1603
 
        present_inventories = unstacked_inventories.get_parent_map(
1604
 
            key[-1:] for key in parents)
1605
 
        parents.difference_update(present_inventories)
1606
 
        if len(parents) == 0:
1607
 
            # No missing parent inventories.
1608
 
            return set()
1609
 
        if not check_for_missing_texts:
1610
 
            return set(('inventories', rev_id) for (rev_id,) in parents)
1611
 
        # Ok, now we have a list of missing inventories.  But these only matter
1612
 
        # if the inventories that reference them are missing some texts they
1613
 
        # appear to introduce.
1614
 
        # XXX: Texts referenced by all added inventories need to be present,
1615
 
        # but at the moment we're only checking for texts referenced by
1616
 
        # inventories at the graph's edge.
1617
 
        key_deps = self.revisions._index._key_dependencies
1618
 
        key_deps.satisfy_refs_for_keys(present_inventories)
1619
 
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1620
 
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1621
 
        missing_texts = set()
1622
 
        for file_id, version_ids in file_ids.iteritems():
1623
 
            missing_texts.update(
1624
 
                (file_id, version_id) for version_id in version_ids)
1625
 
        present_texts = self.texts.get_parent_map(missing_texts)
1626
 
        missing_texts.difference_update(present_texts)
1627
 
        if not missing_texts:
1628
 
            # No texts are missing, so all revisions and their deltas are
1629
 
            # reconstructable.
1630
 
            return set()
1631
 
        # Alternatively the text versions could be returned as the missing
1632
 
        # keys, but this is likely to be less data.
1633
 
        missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
1634
 
        return missing_keys
1635
 
 
1636
1427
    def refresh_data(self):
1637
1428
        """Re-read any data needed to to synchronise with disk.
1638
1429
 
1687
1478
            raise errors.InternalBzrError(
1688
1479
                "May not fetch while in a write group.")
1689
1480
        # fast path same-url fetch operations
1690
 
        # TODO: lift out to somewhere common with RemoteRepository
1691
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401646>
1692
 
        if (self.has_same_location(source)
1693
 
            and fetch_spec is None
1694
 
            and self._has_same_fallbacks(source)):
 
1481
        if self.has_same_location(source) and fetch_spec is None:
1695
1482
            # check that last_revision is in 'from' and then return a
1696
1483
            # no-operation.
1697
1484
            if (revision_id is not None and
1722
1509
        :param revprops: Optional dictionary of revision properties.
1723
1510
        :param revision_id: Optional revision id.
1724
1511
        """
1725
 
        if self._fallback_repositories:
1726
 
            raise errors.BzrError("Cannot commit from a lightweight checkout "
1727
 
                "to a stacked branch. See "
1728
 
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1729
1512
        result = self._commit_builder_class(self, parents, config,
1730
1513
            timestamp, timezone, committer, revprops, revision_id)
1731
1514
        self.start_write_group()
1732
1515
        return result
1733
1516
 
1734
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1735
1517
    def unlock(self):
1736
1518
        if (self.control_files._lock_count == 1 and
1737
1519
            self.control_files._lock_mode == 'w'):
1743
1525
        self.control_files.unlock()
1744
1526
        if self.control_files._lock_count == 0:
1745
1527
            self._inventory_entry_cache.clear()
1746
 
            for repo in self._fallback_repositories:
1747
 
                repo.unlock()
 
1528
        for repo in self._fallback_repositories:
 
1529
            repo.unlock()
1748
1530
 
1749
1531
    @needs_read_lock
1750
1532
    def clone(self, a_bzrdir, revision_id=None):
1859
1641
 
1860
1642
    @needs_read_lock
1861
1643
    def get_revisions(self, revision_ids):
1862
 
        """Get many revisions at once.
1863
 
        
1864
 
        Repositories that need to check data on every revision read should 
1865
 
        subclass this method.
1866
 
        """
 
1644
        """Get many revisions at once."""
1867
1645
        return self._get_revisions(revision_ids)
1868
1646
 
1869
1647
    @needs_read_lock
1870
1648
    def _get_revisions(self, revision_ids):
1871
1649
        """Core work logic to get many revisions without sanity checks."""
 
1650
        for rev_id in revision_ids:
 
1651
            if not rev_id or not isinstance(rev_id, basestring):
 
1652
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1653
        keys = [(key,) for key in revision_ids]
 
1654
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1872
1655
        revs = {}
1873
 
        for revid, rev in self._iter_revisions(revision_ids):
1874
 
            if rev is None:
1875
 
                raise errors.NoSuchRevision(self, revid)
1876
 
            revs[revid] = rev
 
1656
        for record in stream:
 
1657
            if record.storage_kind == 'absent':
 
1658
                raise errors.NoSuchRevision(self, record.key[0])
 
1659
            text = record.get_bytes_as('fulltext')
 
1660
            rev = self._serializer.read_revision_from_string(text)
 
1661
            revs[record.key[0]] = rev
1877
1662
        return [revs[revid] for revid in revision_ids]
1878
1663
 
1879
 
    def _iter_revisions(self, revision_ids):
1880
 
        """Iterate over revision objects.
1881
 
 
1882
 
        :param revision_ids: An iterable of revisions to examine. None may be
1883
 
            passed to request all revisions known to the repository. Note that
1884
 
            not all repositories can find unreferenced revisions; for those
1885
 
            repositories only referenced ones will be returned.
1886
 
        :return: An iterator of (revid, revision) tuples. Absent revisions (
1887
 
            those asked for but not available) are returned as (revid, None).
1888
 
        """
1889
 
        if revision_ids is None:
1890
 
            revision_ids = self.all_revision_ids()
1891
 
        else:
1892
 
            for rev_id in revision_ids:
1893
 
                if not rev_id or not isinstance(rev_id, basestring):
1894
 
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1895
 
        keys = [(key,) for key in revision_ids]
1896
 
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1897
 
        for record in stream:
1898
 
            revid = record.key[0]
1899
 
            if record.storage_kind == 'absent':
1900
 
                yield (revid, None)
1901
 
            else:
1902
 
                text = record.get_bytes_as('fulltext')
1903
 
                rev = self._serializer.read_revision_from_string(text)
1904
 
                yield (revid, rev)
 
1664
    @needs_read_lock
 
1665
    def get_revision_xml(self, revision_id):
 
1666
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1667
        #       would have already do it.
 
1668
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1669
        # TODO: this can't just be replaced by:
 
1670
        # return self._serializer.write_revision_to_string(
 
1671
        #     self.get_revision(revision_id))
 
1672
        # as cStringIO preservers the encoding unlike write_revision_to_string
 
1673
        # or some other call down the path.
 
1674
        rev = self.get_revision(revision_id)
 
1675
        rev_tmp = cStringIO.StringIO()
 
1676
        # the current serializer..
 
1677
        self._serializer.write_revision(rev, rev_tmp)
 
1678
        rev_tmp.seek(0)
 
1679
        return rev_tmp.getvalue()
1905
1680
 
1906
1681
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1907
1682
        """Produce a generator of revision deltas.
2085
1860
                    yield line, revid
2086
1861
 
2087
1862
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
2088
 
        revision_keys):
 
1863
        revision_ids):
2089
1864
        """Helper routine for fileids_altered_by_revision_ids.
2090
1865
 
2091
1866
        This performs the translation of xml lines to revision ids.
2092
1867
 
2093
1868
        :param line_iterator: An iterator of lines, origin_version_id
2094
 
        :param revision_keys: The revision ids to filter for. This should be a
 
1869
        :param revision_ids: The revision ids to filter for. This should be a
2095
1870
            set or other type which supports efficient __contains__ lookups, as
2096
 
            the revision key from each parsed line will be looked up in the
2097
 
            revision_keys filter.
 
1871
            the revision id from each parsed line will be looked up in the
 
1872
            revision_ids filter.
2098
1873
        :return: a dictionary mapping altered file-ids to an iterable of
2099
1874
        revision_ids. Each altered file-ids has the exact revision_ids that
2100
1875
        altered it listed explicitly.
2101
1876
        """
2102
1877
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
2103
1878
                line_iterator).iterkeys())
2104
 
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
 
1879
        # Note that revision_ids are revision keys.
 
1880
        parent_maps = self.revisions.get_parent_map(revision_ids)
 
1881
        parents = set()
 
1882
        map(parents.update, parent_maps.itervalues())
 
1883
        parents.difference_update(revision_ids)
2105
1884
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
2106
 
            self._inventory_xml_lines_for_keys(parent_keys)))
 
1885
            self._inventory_xml_lines_for_keys(parents)))
2107
1886
        new_keys = seen - parent_seen
2108
1887
        result = {}
2109
1888
        setdefault = result.setdefault
2111
1890
            setdefault(key[0], set()).add(key[-1])
2112
1891
        return result
2113
1892
 
2114
 
    def _find_parent_ids_of_revisions(self, revision_ids):
2115
 
        """Find all parent ids that are mentioned in the revision graph.
2116
 
 
2117
 
        :return: set of revisions that are parents of revision_ids which are
2118
 
            not part of revision_ids themselves
2119
 
        """
2120
 
        parent_map = self.get_parent_map(revision_ids)
2121
 
        parent_ids = set()
2122
 
        map(parent_ids.update, parent_map.itervalues())
2123
 
        parent_ids.difference_update(revision_ids)
2124
 
        parent_ids.discard(_mod_revision.NULL_REVISION)
2125
 
        return parent_ids
2126
 
 
2127
 
    def _find_parent_keys_of_revisions(self, revision_keys):
2128
 
        """Similar to _find_parent_ids_of_revisions, but used with keys.
2129
 
 
2130
 
        :param revision_keys: An iterable of revision_keys.
2131
 
        :return: The parents of all revision_keys that are not already in
2132
 
            revision_keys
2133
 
        """
2134
 
        parent_map = self.revisions.get_parent_map(revision_keys)
2135
 
        parent_keys = set()
2136
 
        map(parent_keys.update, parent_map.itervalues())
2137
 
        parent_keys.difference_update(revision_keys)
2138
 
        parent_keys.discard(_mod_revision.NULL_REVISION)
2139
 
        return parent_keys
2140
 
 
2141
1893
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
2142
1894
        """Find the file ids and versions affected by revisions.
2143
1895
 
2150
1902
        """
2151
1903
        selected_keys = set((revid,) for revid in revision_ids)
2152
1904
        w = _inv_weave or self.inventories
2153
 
        return self._find_file_ids_from_xml_inventory_lines(
2154
 
            w.iter_lines_added_or_present_in_keys(
2155
 
                selected_keys, pb=None),
2156
 
            selected_keys)
 
1905
        pb = ui.ui_factory.nested_progress_bar()
 
1906
        try:
 
1907
            return self._find_file_ids_from_xml_inventory_lines(
 
1908
                w.iter_lines_added_or_present_in_keys(
 
1909
                    selected_keys, pb=pb),
 
1910
                selected_keys)
 
1911
        finally:
 
1912
            pb.finished()
2157
1913
 
2158
1914
    def iter_files_bytes(self, desired_files):
2159
1915
        """Iterate through file versions.
2241
1997
                batch_size]
2242
1998
            if not to_query:
2243
1999
                break
2244
 
            for revision_id in to_query:
 
2000
            for rev_tree in self.revision_trees(to_query):
 
2001
                revision_id = rev_tree.get_revision_id()
2245
2002
                parent_ids = ancestors[revision_id]
2246
2003
                for text_key in revision_keys[revision_id]:
2247
2004
                    pb.update("Calculating text parents", processed_texts)
2320
2077
        num_file_ids = len(file_ids)
2321
2078
        for file_id, altered_versions in file_ids.iteritems():
2322
2079
            if pb is not None:
2323
 
                pb.update("Fetch texts", count, num_file_ids)
 
2080
                pb.update("fetch texts", count, num_file_ids)
2324
2081
            count += 1
2325
2082
            yield ("file", file_id, altered_versions)
2326
2083
 
2347
2104
        """Get Inventory object by revision id."""
2348
2105
        return self.iter_inventories([revision_id]).next()
2349
2106
 
2350
 
    def iter_inventories(self, revision_ids, ordering=None):
 
2107
    def iter_inventories(self, revision_ids):
2351
2108
        """Get many inventories by revision_ids.
2352
2109
 
2353
2110
        This will buffer some or all of the texts used in constructing the
2355
2112
        time.
2356
2113
 
2357
2114
        :param revision_ids: The expected revision ids of the inventories.
2358
 
        :param ordering: optional ordering, e.g. 'topological'.  If not
2359
 
            specified, the order of revision_ids will be preserved (by
2360
 
            buffering if necessary).
2361
2115
        :return: An iterator of inventories.
2362
2116
        """
2363
2117
        if ((None in revision_ids)
2364
2118
            or (_mod_revision.NULL_REVISION in revision_ids)):
2365
2119
            raise ValueError('cannot get null revision inventory')
2366
 
        return self._iter_inventories(revision_ids, ordering)
 
2120
        return self._iter_inventories(revision_ids)
2367
2121
 
2368
 
    def _iter_inventories(self, revision_ids, ordering):
 
2122
    def _iter_inventories(self, revision_ids):
2369
2123
        """single-document based inventory iteration."""
2370
 
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2371
 
        for text, revision_id in inv_xmls:
2372
 
            yield self._deserialise_inventory(revision_id, text)
 
2124
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
 
2125
            yield self.deserialise_inventory(revision_id, text)
2373
2126
 
2374
 
    def _iter_inventory_xmls(self, revision_ids, ordering):
2375
 
        if ordering is None:
2376
 
            order_as_requested = True
2377
 
            ordering = 'unordered'
2378
 
        else:
2379
 
            order_as_requested = False
 
2127
    def _iter_inventory_xmls(self, revision_ids):
2380
2128
        keys = [(revision_id,) for revision_id in revision_ids]
2381
 
        if not keys:
2382
 
            return
2383
 
        if order_as_requested:
2384
 
            key_iter = iter(keys)
2385
 
            next_key = key_iter.next()
2386
 
        stream = self.inventories.get_record_stream(keys, ordering, True)
 
2129
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2387
2130
        text_chunks = {}
2388
2131
        for record in stream:
2389
2132
            if record.storage_kind != 'absent':
2390
 
                chunks = record.get_bytes_as('chunked')
2391
 
                if order_as_requested:
2392
 
                    text_chunks[record.key] = chunks
2393
 
                else:
2394
 
                    yield ''.join(chunks), record.key[-1]
 
2133
                text_chunks[record.key] = record.get_bytes_as('chunked')
2395
2134
            else:
2396
2135
                raise errors.NoSuchRevision(self, record.key)
2397
 
            if order_as_requested:
2398
 
                # Yield as many results as we can while preserving order.
2399
 
                while next_key in text_chunks:
2400
 
                    chunks = text_chunks.pop(next_key)
2401
 
                    yield ''.join(chunks), next_key[-1]
2402
 
                    try:
2403
 
                        next_key = key_iter.next()
2404
 
                    except StopIteration:
2405
 
                        # We still want to fully consume the get_record_stream,
2406
 
                        # just in case it is not actually finished at this point
2407
 
                        next_key = None
2408
 
                        break
 
2136
        for key in keys:
 
2137
            chunks = text_chunks.pop(key)
 
2138
            yield ''.join(chunks), key[-1]
2409
2139
 
2410
 
    def _deserialise_inventory(self, revision_id, xml):
 
2140
    def deserialise_inventory(self, revision_id, xml):
2411
2141
        """Transform the xml into an inventory object.
2412
2142
 
2413
2143
        :param revision_id: The expected revision id of the inventory.
2414
2144
        :param xml: A serialised inventory.
2415
2145
        """
2416
2146
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2417
 
                    entry_cache=self._inventory_entry_cache,
2418
 
                    return_from_cache=self._safe_to_return_from_cache)
 
2147
                    entry_cache=self._inventory_entry_cache)
2419
2148
        if result.revision_id != revision_id:
2420
2149
            raise AssertionError('revision id mismatch %s != %s' % (
2421
2150
                result.revision_id, revision_id))
2422
2151
        return result
2423
2152
 
 
2153
    def serialise_inventory(self, inv):
 
2154
        return self._serializer.write_inventory_to_string(inv)
 
2155
 
 
2156
    def _serialise_inventory_to_lines(self, inv):
 
2157
        return self._serializer.write_inventory_to_lines(inv)
 
2158
 
2424
2159
    def get_serializer_format(self):
2425
2160
        return self._serializer.format_num
2426
2161
 
2427
2162
    @needs_read_lock
2428
 
    def _get_inventory_xml(self, revision_id):
2429
 
        """Get serialized inventory as a string."""
2430
 
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
 
2163
    def get_inventory_xml(self, revision_id):
 
2164
        """Get inventory XML as a file object."""
 
2165
        texts = self._iter_inventory_xmls([revision_id])
2431
2166
        try:
2432
2167
            text, revision_id = texts.next()
2433
2168
        except StopIteration:
2434
2169
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2435
2170
        return text
2436
2171
 
2437
 
    def get_rev_id_for_revno(self, revno, known_pair):
2438
 
        """Return the revision id of a revno, given a later (revno, revid)
2439
 
        pair in the same history.
2440
 
 
2441
 
        :return: if found (True, revid).  If the available history ran out
2442
 
            before reaching the revno, then this returns
2443
 
            (False, (closest_revno, closest_revid)).
 
2172
    @needs_read_lock
 
2173
    def get_inventory_sha1(self, revision_id):
 
2174
        """Return the sha1 hash of the inventory entry
2444
2175
        """
2445
 
        known_revno, known_revid = known_pair
2446
 
        partial_history = [known_revid]
2447
 
        distance_from_known = known_revno - revno
2448
 
        if distance_from_known < 0:
2449
 
            raise ValueError(
2450
 
                'requested revno (%d) is later than given known revno (%d)'
2451
 
                % (revno, known_revno))
2452
 
        try:
2453
 
            _iter_for_revno(
2454
 
                self, partial_history, stop_index=distance_from_known)
2455
 
        except errors.RevisionNotPresent, err:
2456
 
            if err.revision_id == known_revid:
2457
 
                # The start revision (known_revid) wasn't found.
2458
 
                raise
2459
 
            # This is a stacked repository with no fallbacks, or a there's a
2460
 
            # left-hand ghost.  Either way, even though the revision named in
2461
 
            # the error isn't in this repo, we know it's the next step in this
2462
 
            # left-hand history.
2463
 
            partial_history.append(err.revision_id)
2464
 
        if len(partial_history) <= distance_from_known:
2465
 
            # Didn't find enough history to get a revid for the revno.
2466
 
            earliest_revno = known_revno - len(partial_history) + 1
2467
 
            return (False, (earliest_revno, partial_history[-1]))
2468
 
        if len(partial_history) - 1 > distance_from_known:
2469
 
            raise AssertionError('_iter_for_revno returned too much history')
2470
 
        return (True, partial_history[-1])
 
2176
        return self.get_revision(revision_id).inventory_sha1
2471
2177
 
2472
2178
    def iter_reverse_revision_history(self, revision_id):
2473
2179
        """Iterate backwards through revision ids in the lefthand history
2480
2186
        while True:
2481
2187
            if next_id in (None, _mod_revision.NULL_REVISION):
2482
2188
                return
2483
 
            try:
2484
 
                parents = graph.get_parent_map([next_id])[next_id]
2485
 
            except KeyError:
2486
 
                raise errors.RevisionNotPresent(next_id, self)
2487
2189
            yield next_id
 
2190
            # Note: The following line may raise KeyError in the event of
 
2191
            # truncated history. We decided not to have a try:except:raise
 
2192
            # RevisionNotPresent here until we see a use for it, because of the
 
2193
            # cost in an inner loop that is by its very nature O(history).
 
2194
            # Robert Collins 20080326
 
2195
            parents = graph.get_parent_map([next_id])[next_id]
2488
2196
            if len(parents) == 0:
2489
2197
                return
2490
2198
            else:
2491
2199
                next_id = parents[0]
2492
2200
 
 
2201
    @needs_read_lock
 
2202
    def get_revision_inventory(self, revision_id):
 
2203
        """Return inventory of a past revision."""
 
2204
        # TODO: Unify this with get_inventory()
 
2205
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
2206
        # must be the same as its revision, so this is trivial.
 
2207
        if revision_id is None:
 
2208
            # This does not make sense: if there is no revision,
 
2209
            # then it is the current tree inventory surely ?!
 
2210
            # and thus get_root_id() is something that looks at the last
 
2211
            # commit on the branch, and the get_root_id is an inventory check.
 
2212
            raise NotImplementedError
 
2213
            # return Inventory(self.get_root_id())
 
2214
        else:
 
2215
            return self.get_inventory(revision_id)
 
2216
 
2493
2217
    def is_shared(self):
2494
2218
        """Return True if this repository is flagged as a shared repository."""
2495
2219
        raise NotImplementedError(self.is_shared)
2529
2253
            return RevisionTree(self, Inventory(root_id=None),
2530
2254
                                _mod_revision.NULL_REVISION)
2531
2255
        else:
2532
 
            inv = self.get_inventory(revision_id)
 
2256
            inv = self.get_revision_inventory(revision_id)
2533
2257
            return RevisionTree(self, inv, revision_id)
2534
2258
 
2535
2259
    def revision_trees(self, revision_ids):
2588
2312
            keys = tsort.topo_sort(parent_map)
2589
2313
        return [None] + list(keys)
2590
2314
 
2591
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
2315
    def pack(self):
2592
2316
        """Compress the data within the repository.
2593
2317
 
2594
2318
        This operation only makes sense for some repository types. For other
2597
2321
        This stub method does not require a lock, but subclasses should use
2598
2322
        @needs_write_lock as this is a long running call its reasonable to
2599
2323
        implicitly lock for the user.
2600
 
 
2601
 
        :param hint: If not supplied, the whole repository is packed.
2602
 
            If supplied, the repository may use the hint parameter as a
2603
 
            hint for the parts of the repository to pack. A hint can be
2604
 
            obtained from the result of commit_write_group(). Out of
2605
 
            date hints are simply ignored, because concurrent operations
2606
 
            can obsolete them rapidly.
2607
 
 
2608
 
        :param clean_obsolete_packs: Clean obsolete packs immediately after
2609
 
            the pack operation.
2610
2324
        """
2611
2325
 
2612
2326
    def get_transaction(self):
2613
2327
        return self.control_files.get_transaction()
2614
2328
 
2615
2329
    def get_parent_map(self, revision_ids):
2616
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
2330
        """See graph._StackedParentsProvider.get_parent_map"""
2617
2331
        # revisions index works in keys; this just works in revisions
2618
2332
        # therefore wrap and unwrap
2619
2333
        query_keys = []
2628
2342
        for ((revision_id,), parent_keys) in \
2629
2343
                self.revisions.get_parent_map(query_keys).iteritems():
2630
2344
            if parent_keys:
2631
 
                result[revision_id] = tuple([parent_revid
2632
 
                    for (parent_revid,) in parent_keys])
 
2345
                result[revision_id] = tuple(parent_revid
 
2346
                    for (parent_revid,) in parent_keys)
2633
2347
            else:
2634
2348
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2635
2349
        return result
2637
2351
    def _make_parents_provider(self):
2638
2352
        return self
2639
2353
 
2640
 
    @needs_read_lock
2641
 
    def get_known_graph_ancestry(self, revision_ids):
2642
 
        """Return the known graph for a set of revision ids and their ancestors.
2643
 
        """
2644
 
        st = static_tuple.StaticTuple
2645
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
2646
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
2647
 
        return graph.GraphThunkIdsToKeys(known_graph)
2648
 
 
2649
2354
    def get_graph(self, other_repository=None):
2650
2355
        """Return the graph walker for this repository format"""
2651
2356
        parents_provider = self._make_parents_provider()
2652
2357
        if (other_repository is not None and
2653
2358
            not self.has_same_location(other_repository)):
2654
 
            parents_provider = graph.StackedParentsProvider(
 
2359
            parents_provider = graph._StackedParentsProvider(
2655
2360
                [parents_provider, other_repository._make_parents_provider()])
2656
2361
        return graph.Graph(parents_provider)
2657
2362
 
2658
 
    def _get_versioned_file_checker(self, text_key_references=None,
2659
 
        ancestors=None):
 
2363
    def _get_versioned_file_checker(self, text_key_references=None):
2660
2364
        """Return an object suitable for checking versioned files.
2661
2365
        
2662
2366
        :param text_key_references: if non-None, an already built
2664
2368
            to whether they were referred to by the inventory of the
2665
2369
            revision_id that they contain. If None, this will be
2666
2370
            calculated.
2667
 
        :param ancestors: Optional result from
2668
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2669
 
            available.
2670
2371
        """
2671
2372
        return _VersionedFileChecker(self,
2672
 
            text_key_references=text_key_references, ancestors=ancestors)
 
2373
            text_key_references=text_key_references)
2673
2374
 
2674
2375
    def revision_ids_to_search_result(self, result_set):
2675
2376
        """Convert a set of revision ids to a graph SearchResult."""
2725
2426
        return record.get_bytes_as('fulltext')
2726
2427
 
2727
2428
    @needs_read_lock
2728
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
2429
    def check(self, revision_ids=None):
2729
2430
        """Check consistency of all history of given revision_ids.
2730
2431
 
2731
2432
        Different repository implementations should override _check().
2732
2433
 
2733
2434
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2734
2435
             will be checked.  Typically the last revision_id of a branch.
2735
 
        :param callback_refs: A dict of check-refs to resolve and callback
2736
 
            the check/_check method on the items listed as wanting the ref.
2737
 
            see bzrlib.check.
2738
 
        :param check_repo: If False do not check the repository contents, just 
2739
 
            calculate the data callback_refs requires and call them back.
2740
2436
        """
2741
 
        return self._check(revision_ids, callback_refs=callback_refs,
2742
 
            check_repo=check_repo)
 
2437
        return self._check(revision_ids)
2743
2438
 
2744
 
    def _check(self, revision_ids, callback_refs, check_repo):
2745
 
        result = check.Check(self, check_repo=check_repo)
2746
 
        result.check(callback_refs)
 
2439
    def _check(self, revision_ids):
 
2440
        result = check.Check(self)
 
2441
        result.check()
2747
2442
        return result
2748
2443
 
2749
 
    def _warn_if_deprecated(self, branch=None):
 
2444
    def _warn_if_deprecated(self):
2750
2445
        global _deprecation_warning_done
2751
2446
        if _deprecation_warning_done:
2752
2447
            return
2753
 
        try:
2754
 
            if branch is None:
2755
 
                conf = config.GlobalConfig()
2756
 
            else:
2757
 
                conf = branch.get_config()
2758
 
            if conf.suppress_warning('format_deprecation'):
2759
 
                return
2760
 
            warning("Format %s for %s is deprecated -"
2761
 
                    " please use 'bzr upgrade' to get better performance"
2762
 
                    % (self._format, self.bzrdir.transport.base))
2763
 
        finally:
2764
 
            _deprecation_warning_done = True
 
2448
        _deprecation_warning_done = True
 
2449
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
2450
                % (self._format, self.bzrdir.transport.base))
2765
2451
 
2766
2452
    def supports_rich_root(self):
2767
2453
        return self._format.rich_root_data
3043
2729
    # Does this format have < O(tree_size) delta generation. Used to hint what
3044
2730
    # code path for commit, amongst other things.
3045
2731
    fast_deltas = None
3046
 
    # Does doing a pack operation compress data? Useful for the pack UI command
3047
 
    # (so if there is one pack, the operation can still proceed because it may
3048
 
    # help), and for fetching when data won't have come from the same
3049
 
    # compressor.
3050
 
    pack_compresses = False
3051
 
    # Does the repository inventory storage understand references to trees?
3052
 
    supports_tree_reference = None
3053
 
    # Is the format experimental ?
3054
 
    experimental = False
3055
2732
 
3056
 
    def __repr__(self):
3057
 
        return "%s()" % self.__class__.__name__
 
2733
    def __str__(self):
 
2734
        return "<%s>" % self.__class__.__name__
3058
2735
 
3059
2736
    def __eq__(self, other):
3060
2737
        # format objects are generally stateless
3073
2750
        """
3074
2751
        try:
3075
2752
            transport = a_bzrdir.get_repository_transport(None)
3076
 
            format_string = transport.get_bytes("format")
 
2753
            format_string = transport.get("format").read()
3077
2754
            return format_registry.get(format_string)
3078
2755
        except errors.NoSuchFile:
3079
2756
            raise errors.NoRepositoryPresent(a_bzrdir)
3161
2838
        raise NotImplementedError(self.network_name)
3162
2839
 
3163
2840
    def check_conversion_target(self, target_format):
3164
 
        if self.rich_root_data and not target_format.rich_root_data:
3165
 
            raise errors.BadConversionTarget(
3166
 
                'Does not support rich root data.', target_format,
3167
 
                from_format=self)
3168
 
        if (self.supports_tree_reference and 
3169
 
            not getattr(target_format, 'supports_tree_reference', False)):
3170
 
            raise errors.BadConversionTarget(
3171
 
                'Does not support nested trees', target_format,
3172
 
                from_format=self)
 
2841
        raise NotImplementedError(self.check_conversion_target)
3173
2842
 
3174
2843
    def open(self, a_bzrdir, _found=False):
3175
2844
        """Return an instance of this format for the bzrdir a_bzrdir.
3178
2847
        """
3179
2848
        raise NotImplementedError(self.open)
3180
2849
 
3181
 
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
3182
 
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
3183
 
        hooks = BzrDir.hooks['post_repo_init']
3184
 
        if not hooks:
3185
 
            return
3186
 
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
3187
 
        for hook in hooks:
3188
 
            hook(params)
3189
 
 
3190
2850
 
3191
2851
class MetaDirRepositoryFormat(RepositoryFormat):
3192
2852
    """Common base class for the new repositories using the metadir layout."""
3343
3003
    'RepositoryFormatCHK1',
3344
3004
    )
3345
3005
 
3346
 
format_registry.register_lazy(
3347
 
    'Bazaar development format - chk repository with bencode revision '
3348
 
        'serialization (needs bzr.dev from 1.16)\n',
3349
 
    'bzrlib.repofmt.groupcompress_repo',
3350
 
    'RepositoryFormatCHK2',
3351
 
    )
3352
 
format_registry.register_lazy(
3353
 
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
3354
 
    'bzrlib.repofmt.groupcompress_repo',
3355
 
    'RepositoryFormat2a',
3356
 
    )
3357
 
 
3358
3006
 
3359
3007
class InterRepository(InterObject):
3360
3008
    """This class represents operations taking place between two repositories.
3397
3045
 
3398
3046
        :param revision_id: if None all content is copied, if NULL_REVISION no
3399
3047
                            content is copied.
3400
 
        :param pb: ignored.
 
3048
        :param pb: optional progress bar to use for progress reports. If not
 
3049
                   provided a default one will be created.
3401
3050
        :return: None.
3402
3051
        """
3403
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3404
3052
        from bzrlib.fetch import RepoFetcher
3405
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
3406
 
        if self.source._format.network_name() != self.target._format.network_name():
3407
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
3408
 
                from_format=self.source._format,
3409
 
                to_format=self.target._format)
3410
3053
        f = RepoFetcher(to_repository=self.target,
3411
3054
                               from_repository=self.source,
3412
3055
                               last_revision=revision_id,
3413
3056
                               fetch_spec=fetch_spec,
3414
 
                               find_ghosts=find_ghosts)
 
3057
                               pb=pb, find_ghosts=find_ghosts)
3415
3058
 
3416
3059
    def _walk_to_common_revisions(self, revision_ids):
3417
3060
        """Walk out from revision_ids in source to revisions target has.
3421
3064
        """
3422
3065
        target_graph = self.target.get_graph()
3423
3066
        revision_ids = frozenset(revision_ids)
 
3067
        # Fast path for the case where all the revisions are already in the
 
3068
        # target repo.
 
3069
        # (Although this does incur an extra round trip for the
 
3070
        # fairly common case where the target doesn't already have the revision
 
3071
        # we're pushing.)
 
3072
        if set(target_graph.get_parent_map(revision_ids)) == revision_ids:
 
3073
            return graph.SearchResult(revision_ids, set(), 0, set())
3424
3074
        missing_revs = set()
3425
3075
        source_graph = self.source.get_graph()
3426
3076
        # ensure we don't pay silly lookup costs.
3586
3236
                self.target.texts.insert_record_stream(
3587
3237
                    self.source.texts.get_record_stream(
3588
3238
                        self.source.texts.keys(), 'topological', False))
3589
 
                pb.update('Copying inventory', 0, 1)
 
3239
                pb.update('copying inventory', 0, 1)
3590
3240
                self.target.inventories.insert_record_stream(
3591
3241
                    self.source.inventories.get_record_stream(
3592
3242
                        self.source.inventories.keys(), 'topological', False))
3706
3356
        return self.source.revision_ids_to_search_result(result_set)
3707
3357
 
3708
3358
 
 
3359
class InterPackRepo(InterSameDataRepository):
 
3360
    """Optimised code paths between Pack based repositories."""
 
3361
 
 
3362
    @classmethod
 
3363
    def _get_repo_format_to_test(self):
 
3364
        from bzrlib.repofmt import pack_repo
 
3365
        return pack_repo.RepositoryFormatKnitPack1()
 
3366
 
 
3367
    @staticmethod
 
3368
    def is_compatible(source, target):
 
3369
        """Be compatible with known Pack formats.
 
3370
 
 
3371
        We don't test for the stores being of specific types because that
 
3372
        could lead to confusing results, and there is no need to be
 
3373
        overly general.
 
3374
 
 
3375
        InterPackRepo does not support CHK based repositories.
 
3376
        """
 
3377
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
3378
        from bzrlib.repofmt.groupcompress_repo import RepositoryFormatCHK1
 
3379
        try:
 
3380
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
3381
                isinstance(target._format, RepositoryFormatPack))
 
3382
            not_packs = (isinstance(source._format, RepositoryFormatCHK1) or
 
3383
                isinstance(target._format, RepositoryFormatCHK1))
 
3384
        except AttributeError:
 
3385
            return False
 
3386
        if not_packs or not are_packs:
 
3387
            return False
 
3388
        return InterRepository._same_model(source, target)
 
3389
 
 
3390
    @needs_write_lock
 
3391
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
 
3392
            fetch_spec=None):
 
3393
        """See InterRepository.fetch()."""
 
3394
        if (len(self.source._fallback_repositories) > 0 or
 
3395
            len(self.target._fallback_repositories) > 0):
 
3396
            # The pack layer is not aware of fallback repositories, so when
 
3397
            # fetching from a stacked repository or into a stacked repository
 
3398
            # we use the generic fetch logic which uses the VersionedFiles
 
3399
            # attributes on repository.
 
3400
            from bzrlib.fetch import RepoFetcher
 
3401
            fetcher = RepoFetcher(self.target, self.source, revision_id,
 
3402
                    pb, find_ghosts, fetch_spec=fetch_spec)
 
3403
        if fetch_spec is not None:
 
3404
            if len(list(fetch_spec.heads)) != 1:
 
3405
                raise AssertionError(
 
3406
                    "InterPackRepo.fetch doesn't support "
 
3407
                    "fetching multiple heads yet.")
 
3408
            revision_id = list(fetch_spec.heads)[0]
 
3409
            fetch_spec = None
 
3410
        if revision_id is None:
 
3411
            # TODO:
 
3412
            # everything to do - use pack logic
 
3413
            # to fetch from all packs to one without
 
3414
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
3415
            # till then:
 
3416
            source_revision_ids = frozenset(self.source.all_revision_ids())
 
3417
            revision_ids = source_revision_ids - \
 
3418
                frozenset(self.target.get_parent_map(source_revision_ids))
 
3419
            revision_keys = [(revid,) for revid in revision_ids]
 
3420
            index = self.target._pack_collection.revision_index.combined_index
 
3421
            present_revision_ids = set(item[1][0] for item in
 
3422
                index.iter_entries(revision_keys))
 
3423
            revision_ids = set(revision_ids) - present_revision_ids
 
3424
            # implementing the TODO will involve:
 
3425
            # - detecting when all of a pack is selected
 
3426
            # - avoiding as much as possible pre-selection, so the
 
3427
            # more-core routines such as create_pack_from_packs can filter in
 
3428
            # a just-in-time fashion. (though having a HEADS list on a
 
3429
            # repository might make this a lot easier, because we could
 
3430
            # sensibly detect 'new revisions' without doing a full index scan.
 
3431
        elif _mod_revision.is_null(revision_id):
 
3432
            # nothing to do:
 
3433
            return (0, [])
 
3434
        else:
 
3435
            try:
 
3436
                revision_ids = self.search_missing_revision_ids(revision_id,
 
3437
                    find_ghosts=find_ghosts).get_keys()
 
3438
            except errors.NoSuchRevision:
 
3439
                raise errors.InstallFailed([revision_id])
 
3440
            if len(revision_ids) == 0:
 
3441
                return (0, [])
 
3442
        return self._pack(self.source, self.target, revision_ids)
 
3443
 
 
3444
    def _pack(self, source, target, revision_ids):
 
3445
        from bzrlib.repofmt.pack_repo import Packer
 
3446
        packs = source._pack_collection.all_packs()
 
3447
        pack = Packer(self.target._pack_collection, packs, '.fetch',
 
3448
            revision_ids).pack()
 
3449
        if pack is not None:
 
3450
            self.target._pack_collection._save_pack_names()
 
3451
            copied_revs = pack.get_revision_count()
 
3452
            # Trigger an autopack. This may duplicate effort as we've just done
 
3453
            # a pack creation, but for now it is simpler to think about as
 
3454
            # 'upload data, then repack if needed'.
 
3455
            self.target._pack_collection.autopack()
 
3456
            return (copied_revs, [])
 
3457
        else:
 
3458
            return (0, [])
 
3459
 
 
3460
    @needs_read_lock
 
3461
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
3462
        """See InterRepository.missing_revision_ids().
 
3463
 
 
3464
        :param find_ghosts: Find ghosts throughout the ancestry of
 
3465
            revision_id.
 
3466
        """
 
3467
        if not find_ghosts and revision_id is not None:
 
3468
            return self._walk_to_common_revisions([revision_id])
 
3469
        elif revision_id is not None:
 
3470
            # Find ghosts: search for revisions pointing from one repository to
 
3471
            # the other, and vice versa, anywhere in the history of revision_id.
 
3472
            graph = self.target.get_graph(other_repository=self.source)
 
3473
            searcher = graph._make_breadth_first_searcher([revision_id])
 
3474
            found_ids = set()
 
3475
            while True:
 
3476
                try:
 
3477
                    next_revs, ghosts = searcher.next_with_ghosts()
 
3478
                except StopIteration:
 
3479
                    break
 
3480
                if revision_id in ghosts:
 
3481
                    raise errors.NoSuchRevision(self.source, revision_id)
 
3482
                found_ids.update(next_revs)
 
3483
                found_ids.update(ghosts)
 
3484
            found_ids = frozenset(found_ids)
 
3485
            # Double query here: should be able to avoid this by changing the
 
3486
            # graph api further.
 
3487
            result_set = found_ids - frozenset(
 
3488
                self.target.get_parent_map(found_ids))
 
3489
        else:
 
3490
            source_ids = self.source.all_revision_ids()
 
3491
            # source_ids is the worst possible case we may need to pull.
 
3492
            # now we want to filter source_ids against what we actually
 
3493
            # have in target, but don't try to check for existence where we know
 
3494
            # we do not have a revision as that would be pointless.
 
3495
            target_ids = set(self.target.all_revision_ids())
 
3496
            result_set = set(source_ids).difference(target_ids)
 
3497
        return self.source.revision_ids_to_search_result(result_set)
 
3498
 
 
3499
 
3709
3500
class InterDifferingSerializer(InterRepository):
3710
3501
 
3711
3502
    @classmethod
3718
3509
        # This is redundant with format.check_conversion_target(), however that
3719
3510
        # raises an exception, and we just want to say "False" as in we won't
3720
3511
        # support converting between these formats.
3721
 
        if 'IDS_never' in debug.debug_flags:
3722
 
            return False
3723
3512
        if source.supports_rich_root() and not target.supports_rich_root():
3724
3513
            return False
3725
3514
        if (source._format.supports_tree_reference
3726
3515
            and not target._format.supports_tree_reference):
3727
3516
            return False
3728
 
        if target._fallback_repositories and target._format.supports_chks:
3729
 
            # IDS doesn't know how to copy CHKs for the parent inventories it
3730
 
            # adds to stacked repos.
3731
 
            return False
3732
 
        if 'IDS_always' in debug.debug_flags:
3733
 
            return True
3734
 
        # Only use this code path for local source and target.  IDS does far
3735
 
        # too much IO (both bandwidth and roundtrips) over a network.
3736
 
        if not source.bzrdir.transport.base.startswith('file:///'):
3737
 
            return False
3738
 
        if not target.bzrdir.transport.base.startswith('file:///'):
3739
 
            return False
3740
3517
        return True
3741
3518
 
3742
 
    def _get_trees(self, revision_ids, cache):
3743
 
        possible_trees = []
3744
 
        for rev_id in revision_ids:
3745
 
            if rev_id in cache:
3746
 
                possible_trees.append((rev_id, cache[rev_id]))
3747
 
            else:
3748
 
                # Not cached, but inventory might be present anyway.
3749
 
                try:
3750
 
                    tree = self.source.revision_tree(rev_id)
3751
 
                except errors.NoSuchRevision:
3752
 
                    # Nope, parent is ghost.
3753
 
                    pass
3754
 
                else:
3755
 
                    cache[rev_id] = tree
3756
 
                    possible_trees.append((rev_id, tree))
3757
 
        return possible_trees
3758
 
 
3759
 
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
 
3519
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
3760
3520
        """Get the best delta and base for this revision.
3761
3521
 
3762
3522
        :return: (basis_id, delta)
3763
3523
        """
 
3524
        possible_trees = [(parent_id, cache[parent_id])
 
3525
                          for parent_id in parent_ids
 
3526
                           if parent_id in cache]
 
3527
        if len(possible_trees) == 0:
 
3528
            # There either aren't any parents, or the parents aren't in the
 
3529
            # cache, so just use the last converted tree
 
3530
            possible_trees.append((basis_id, cache[basis_id]))
3764
3531
        deltas = []
3765
 
        # Generate deltas against each tree, to find the shortest.
3766
 
        texts_possibly_new_in_tree = set()
3767
3532
        for basis_id, basis_tree in possible_trees:
3768
3533
            delta = tree.inventory._make_delta(basis_tree.inventory)
3769
 
            for old_path, new_path, file_id, new_entry in delta:
3770
 
                if new_path is None:
3771
 
                    # This file_id isn't present in the new rev, so we don't
3772
 
                    # care about it.
3773
 
                    continue
3774
 
                if not new_path:
3775
 
                    # Rich roots are handled elsewhere...
3776
 
                    continue
3777
 
                kind = new_entry.kind
3778
 
                if kind != 'directory' and kind != 'file':
3779
 
                    # No text record associated with this inventory entry.
3780
 
                    continue
3781
 
                # This is a directory or file that has changed somehow.
3782
 
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3783
3534
            deltas.append((len(delta), basis_id, delta))
3784
3535
        deltas.sort()
3785
3536
        return deltas[0][1:]
3786
3537
 
3787
 
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
3788
 
        """Find all parent revisions that are absent, but for which the
3789
 
        inventory is present, and copy those inventories.
3790
 
 
3791
 
        This is necessary to preserve correctness when the source is stacked
3792
 
        without fallbacks configured.  (Note that in cases like upgrade the
3793
 
        source may be not have _fallback_repositories even though it is
3794
 
        stacked.)
3795
 
        """
3796
 
        parent_revs = set()
3797
 
        for parents in parent_map.values():
3798
 
            parent_revs.update(parents)
3799
 
        present_parents = self.source.get_parent_map(parent_revs)
3800
 
        absent_parents = set(parent_revs).difference(present_parents)
3801
 
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
3802
 
            (rev_id,) for rev_id in absent_parents)
3803
 
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
3804
 
        for parent_tree in self.source.revision_trees(parent_inv_ids):
3805
 
            current_revision_id = parent_tree.get_revision_id()
3806
 
            parents_parents_keys = parent_invs_keys_for_stacking[
3807
 
                (current_revision_id,)]
3808
 
            parents_parents = [key[-1] for key in parents_parents_keys]
3809
 
            basis_id = _mod_revision.NULL_REVISION
3810
 
            basis_tree = self.source.revision_tree(basis_id)
3811
 
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
3812
 
            self.target.add_inventory_by_delta(
3813
 
                basis_id, delta, current_revision_id, parents_parents)
3814
 
            cache[current_revision_id] = parent_tree
3815
 
 
3816
 
    def _fetch_batch(self, revision_ids, basis_id, cache, a_graph=None):
 
3538
    def _get_parent_keys(self, root_key, parent_map):
 
3539
        """Get the parent keys for a given root id."""
 
3540
        root_id, rev_id = root_key
 
3541
        # Include direct parents of the revision, but only if they used
 
3542
        # the same root_id.
 
3543
        parent_keys = []
 
3544
        for parent_id in parent_map[rev_id]:
 
3545
            if parent_id == _mod_revision.NULL_REVISION:
 
3546
                continue
 
3547
            if parent_id not in self._revision_id_to_root_id:
 
3548
                # We probably didn't read this revision, go spend the
 
3549
                # extra effort to actually check
 
3550
                try:
 
3551
                    tree = self.source.revision_tree(parent_id)
 
3552
                except errors.NoSuchRevision:
 
3553
                    # Ghost, fill out _revision_id_to_root_id in case we
 
3554
                    # encounter this again.
 
3555
                    # But set parent_root_id to None since we don't really know
 
3556
                    parent_root_id = None
 
3557
                else:
 
3558
                    parent_root_id = tree.get_root_id()
 
3559
                self._revision_id_to_root_id[parent_id] = None
 
3560
            else:
 
3561
                parent_root_id = self._revision_id_to_root_id[parent_id]
 
3562
            if root_id == parent_root_id or parent_root_id is None:
 
3563
                parent_keys.append((root_id, parent_id))
 
3564
        return tuple(parent_keys)
 
3565
 
 
3566
    def _new_root_data_stream(self, root_keys_to_create, parent_map):
 
3567
        for root_key in root_keys_to_create:
 
3568
            parent_keys = self._get_parent_keys(root_key, parent_map)
 
3569
            yield versionedfile.FulltextContentFactory(root_key,
 
3570
                parent_keys, None, '')
 
3571
 
 
3572
    def _fetch_batch(self, revision_ids, basis_id, cache):
3817
3573
        """Fetch across a few revisions.
3818
3574
 
3819
3575
        :param revision_ids: The revisions to copy
3820
3576
        :param basis_id: The revision_id of a tree that must be in cache, used
3821
3577
            as a basis for delta when no other base is available
3822
3578
        :param cache: A cache of RevisionTrees that we can use.
3823
 
        :param a_graph: A Graph object to determine the heads() of the
3824
 
            rich-root data stream.
3825
3579
        :return: The revision_id of the last converted tree. The RevisionTree
3826
3580
            for it will be in cache
3827
3581
        """
3833
3587
        pending_deltas = []
3834
3588
        pending_revisions = []
3835
3589
        parent_map = self.source.get_parent_map(revision_ids)
3836
 
        self._fetch_parent_invs_for_stacking(parent_map, cache)
3837
 
        self.source._safe_to_return_from_cache = True
3838
3590
        for tree in self.source.revision_trees(revision_ids):
3839
 
            # Find a inventory delta for this revision.
3840
 
            # Find text entries that need to be copied, too.
3841
3591
            current_revision_id = tree.get_revision_id()
3842
3592
            parent_ids = parent_map.get(current_revision_id, ())
3843
 
            parent_trees = self._get_trees(parent_ids, cache)
3844
 
            possible_trees = list(parent_trees)
3845
 
            if len(possible_trees) == 0:
3846
 
                # There either aren't any parents, or the parents are ghosts,
3847
 
                # so just use the last converted tree.
3848
 
                possible_trees.append((basis_id, cache[basis_id]))
3849
3593
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3850
 
                                                           possible_trees)
3851
 
            revision = self.source.get_revision(current_revision_id)
3852
 
            pending_deltas.append((basis_id, delta,
3853
 
                current_revision_id, revision.parent_ids))
 
3594
                                                           basis_id, cache)
3854
3595
            if self._converting_to_rich_root:
3855
3596
                self._revision_id_to_root_id[current_revision_id] = \
3856
3597
                    tree.get_root_id()
3857
 
            # Determine which texts are in present in this revision but not in
3858
 
            # any of the available parents.
3859
 
            texts_possibly_new_in_tree = set()
 
3598
            # Find text entries that need to be copied
3860
3599
            for old_path, new_path, file_id, entry in delta:
3861
 
                if new_path is None:
3862
 
                    # This file_id isn't present in the new rev
3863
 
                    continue
3864
 
                if not new_path:
3865
 
                    # This is the root
3866
 
                    if not self.target.supports_rich_root():
3867
 
                        # The target doesn't support rich root, so we don't
3868
 
                        # copy
3869
 
                        continue
3870
 
                    if self._converting_to_rich_root:
3871
 
                        # This can't be copied normally, we have to insert
3872
 
                        # it specially
3873
 
                        root_keys_to_create.add((file_id, entry.revision))
3874
 
                        continue
3875
 
                kind = entry.kind
3876
 
                texts_possibly_new_in_tree.add((file_id, entry.revision))
3877
 
            for basis_id, basis_tree in possible_trees:
3878
 
                basis_inv = basis_tree.inventory
3879
 
                for file_key in list(texts_possibly_new_in_tree):
3880
 
                    file_id, file_revision = file_key
3881
 
                    try:
3882
 
                        entry = basis_inv[file_id]
3883
 
                    except errors.NoSuchId:
3884
 
                        continue
3885
 
                    if entry.revision == file_revision:
3886
 
                        texts_possibly_new_in_tree.remove(file_key)
3887
 
            text_keys.update(texts_possibly_new_in_tree)
 
3600
                if new_path is not None:
 
3601
                    if not new_path:
 
3602
                        # This is the root
 
3603
                        if not self.target.supports_rich_root():
 
3604
                            # The target doesn't support rich root, so we don't
 
3605
                            # copy
 
3606
                            continue
 
3607
                        if self._converting_to_rich_root:
 
3608
                            # This can't be copied normally, we have to insert
 
3609
                            # it specially
 
3610
                            root_keys_to_create.add((file_id, entry.revision))
 
3611
                            continue
 
3612
                    text_keys.add((file_id, entry.revision))
 
3613
            revision = self.source.get_revision(current_revision_id)
 
3614
            pending_deltas.append((basis_id, delta,
 
3615
                current_revision_id, revision.parent_ids))
3888
3616
            pending_revisions.append(revision)
3889
3617
            cache[current_revision_id] = tree
3890
3618
            basis_id = current_revision_id
3891
 
        self.source._safe_to_return_from_cache = False
3892
3619
        # Copy file texts
3893
3620
        from_texts = self.source.texts
3894
3621
        to_texts = self.target.texts
3895
3622
        if root_keys_to_create:
3896
 
            root_stream = _mod_fetch._new_root_data_stream(
3897
 
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
3898
 
                self.source, graph=a_graph)
 
3623
            root_stream = self._new_root_data_stream(root_keys_to_create,
 
3624
                                                     parent_map)
3899
3625
            to_texts.insert_record_stream(root_stream)
3900
3626
        to_texts.insert_record_stream(from_texts.get_record_stream(
3901
3627
            text_keys, self.target._format._fetch_order,
3902
3628
            not self.target._format._fetch_uses_deltas))
3903
 
        # insert inventory deltas
 
3629
        # insert deltas
3904
3630
        for delta in pending_deltas:
3905
3631
            self.target.add_inventory_by_delta(*delta)
3906
 
        if self.target._fallback_repositories:
3907
 
            # Make sure this stacked repository has all the parent inventories
3908
 
            # for the new revisions that we are about to insert.  We do this
3909
 
            # before adding the revisions so that no revision is added until
3910
 
            # all the inventories it may depend on are added.
3911
 
            # Note that this is overzealous, as we may have fetched these in an
3912
 
            # earlier batch.
3913
 
            parent_ids = set()
3914
 
            revision_ids = set()
3915
 
            for revision in pending_revisions:
3916
 
                revision_ids.add(revision.revision_id)
3917
 
                parent_ids.update(revision.parent_ids)
3918
 
            parent_ids.difference_update(revision_ids)
3919
 
            parent_ids.discard(_mod_revision.NULL_REVISION)
3920
 
            parent_map = self.source.get_parent_map(parent_ids)
3921
 
            # we iterate over parent_map and not parent_ids because we don't
3922
 
            # want to try copying any revision which is a ghost
3923
 
            for parent_tree in self.source.revision_trees(parent_map):
3924
 
                current_revision_id = parent_tree.get_revision_id()
3925
 
                parents_parents = parent_map[current_revision_id]
3926
 
                possible_trees = self._get_trees(parents_parents, cache)
3927
 
                if len(possible_trees) == 0:
3928
 
                    # There either aren't any parents, or the parents are
3929
 
                    # ghosts, so just use the last converted tree.
3930
 
                    possible_trees.append((basis_id, cache[basis_id]))
3931
 
                basis_id, delta = self._get_delta_for_revision(parent_tree,
3932
 
                    parents_parents, possible_trees)
3933
 
                self.target.add_inventory_by_delta(
3934
 
                    basis_id, delta, current_revision_id, parents_parents)
3935
3632
        # insert signatures and revisions
3936
3633
        for revision in pending_revisions:
3937
3634
            try:
3949
3646
 
3950
3647
        :param revision_ids: The list of revisions to fetch. Must be in
3951
3648
            topological order.
3952
 
        :param pb: A ProgressTask
 
3649
        :param pb: A ProgressBar
3953
3650
        :return: None
3954
3651
        """
3955
3652
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3957
3654
        cache = lru_cache.LRUCache(100)
3958
3655
        cache[basis_id] = basis_tree
3959
3656
        del basis_tree # We don't want to hang on to it here
3960
 
        hints = []
3961
 
        if self._converting_to_rich_root and len(revision_ids) > 100:
3962
 
            a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
3963
 
                                                            revision_ids)
3964
 
        else:
3965
 
            a_graph = None
3966
 
 
3967
3657
        for offset in range(0, len(revision_ids), batch_size):
3968
3658
            self.target.start_write_group()
3969
3659
            try:
3970
3660
                pb.update('Transferring revisions', offset,
3971
3661
                          len(revision_ids))
3972
3662
                batch = revision_ids[offset:offset+batch_size]
3973
 
                basis_id = self._fetch_batch(batch, basis_id, cache,
3974
 
                                             a_graph=a_graph)
 
3663
                basis_id = self._fetch_batch(batch, basis_id, cache)
3975
3664
            except:
3976
 
                self.source._safe_to_return_from_cache = False
3977
3665
                self.target.abort_write_group()
3978
3666
                raise
3979
3667
            else:
3980
 
                hint = self.target.commit_write_group()
3981
 
                if hint:
3982
 
                    hints.extend(hint)
3983
 
        if hints and self.target._format.pack_compresses:
3984
 
            self.target.pack(hint=hints)
 
3668
                self.target.commit_write_group()
3985
3669
        pb.update('Transferring revisions', len(revision_ids),
3986
3670
                  len(revision_ids))
3987
3671
 
3991
3675
        """See InterRepository.fetch()."""
3992
3676
        if fetch_spec is not None:
3993
3677
            raise AssertionError("Not implemented yet...")
3994
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3995
3678
        if (not self.source.supports_rich_root()
3996
3679
            and self.target.supports_rich_root()):
3997
3680
            self._converting_to_rich_root = True
3998
3681
            self._revision_id_to_root_id = {}
3999
3682
        else:
4000
3683
            self._converting_to_rich_root = False
4001
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
4002
 
        if self.source._format.network_name() != self.target._format.network_name():
4003
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
4004
 
                from_format=self.source._format,
4005
 
                to_format=self.target._format)
4006
3684
        revision_ids = self.target.search_missing_revision_ids(self.source,
4007
3685
            revision_id, find_ghosts=find_ghosts).get_keys()
4008
3686
        if not revision_ids:
4014
3692
        # Walk though all revisions; get inventory deltas, copy referenced
4015
3693
        # texts that delta references, insert the delta, revision and
4016
3694
        # signature.
 
3695
        first_rev = self.source.get_revision(revision_ids[0])
4017
3696
        if pb is None:
4018
3697
            my_pb = ui.ui_factory.nested_progress_bar()
4019
3698
            pb = my_pb
4056
3735
InterRepository.register_optimiser(InterSameDataRepository)
4057
3736
InterRepository.register_optimiser(InterWeaveRepo)
4058
3737
InterRepository.register_optimiser(InterKnitRepo)
 
3738
InterRepository.register_optimiser(InterPackRepo)
4059
3739
 
4060
3740
 
4061
3741
class CopyConverter(object):
4077
3757
        :param to_convert: The disk object to convert.
4078
3758
        :param pb: a progress bar to use for progress information.
4079
3759
        """
4080
 
        pb = ui.ui_factory.nested_progress_bar()
 
3760
        self.pb = pb
4081
3761
        self.count = 0
4082
3762
        self.total = 4
4083
3763
        # this is only useful with metadir layouts - separated repo content.
4084
3764
        # trigger an assertion if not such
4085
3765
        repo._format.get_format_string()
4086
3766
        self.repo_dir = repo.bzrdir
4087
 
        pb.update('Moving repository to repository.backup')
 
3767
        self.step('Moving repository to repository.backup')
4088
3768
        self.repo_dir.transport.move('repository', 'repository.backup')
4089
3769
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4090
3770
        repo._format.check_conversion_target(self.target_format)
4091
3771
        self.source_repo = repo._format.open(self.repo_dir,
4092
3772
            _found=True,
4093
3773
            _override_transport=backup_transport)
4094
 
        pb.update('Creating new repository')
 
3774
        self.step('Creating new repository')
4095
3775
        converted = self.target_format.initialize(self.repo_dir,
4096
3776
                                                  self.source_repo.is_shared())
4097
3777
        converted.lock_write()
4098
3778
        try:
4099
 
            pb.update('Copying content')
 
3779
            self.step('Copying content into repository.')
4100
3780
            self.source_repo.copy_content_into(converted)
4101
3781
        finally:
4102
3782
            converted.unlock()
4103
 
        pb.update('Deleting old repository content')
 
3783
        self.step('Deleting old repository content.')
4104
3784
        self.repo_dir.transport.delete_tree('repository.backup')
4105
 
        ui.ui_factory.note('repository converted')
4106
 
        pb.finished()
 
3785
        self.pb.note('repository converted')
 
3786
 
 
3787
    def step(self, message):
 
3788
        """Update the pb by a step."""
 
3789
        self.count +=1
 
3790
        self.pb.update(message, self.count, self.total)
4107
3791
 
4108
3792
 
4109
3793
_unescape_map = {
4138
3822
 
4139
3823
class _VersionedFileChecker(object):
4140
3824
 
4141
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
3825
    def __init__(self, repository, text_key_references=None):
4142
3826
        self.repository = repository
4143
3827
        self.text_index = self.repository._generate_text_key_index(
4144
 
            text_key_references=text_key_references, ancestors=ancestors)
 
3828
            text_key_references=text_key_references)
4145
3829
 
4146
3830
    def calculate_file_version_parents(self, text_key):
4147
3831
        """Calculate the correct parents for a file version according to
4165
3849
            revision_id) tuples for versions that are present in this versioned
4166
3850
            file, but not used by the corresponding inventory.
4167
3851
        """
4168
 
        local_progress = None
4169
 
        if progress_bar is None:
4170
 
            local_progress = ui.ui_factory.nested_progress_bar()
4171
 
            progress_bar = local_progress
4172
 
        try:
4173
 
            return self._check_file_version_parents(texts, progress_bar)
4174
 
        finally:
4175
 
            if local_progress:
4176
 
                local_progress.finished()
4177
 
 
4178
 
    def _check_file_version_parents(self, texts, progress_bar):
4179
 
        """See check_file_version_parents."""
4180
3852
        wrong_parents = {}
4181
3853
        self.file_ids = set([file_id for file_id, _ in
4182
3854
            self.text_index.iterkeys()])
4183
3855
        # text keys is now grouped by file_id
 
3856
        n_weaves = len(self.file_ids)
 
3857
        files_in_revisions = {}
 
3858
        revisions_of_files = {}
4184
3859
        n_versions = len(self.text_index)
4185
3860
        progress_bar.update('loading text store', 0, n_versions)
4186
3861
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4188
3863
        text_keys = self.repository.texts.keys()
4189
3864
        unused_keys = frozenset(text_keys) - set(self.text_index)
4190
3865
        for num, key in enumerate(self.text_index.iterkeys()):
4191
 
            progress_bar.update('checking text graph', num, n_versions)
 
3866
            if progress_bar is not None:
 
3867
                progress_bar.update('checking text graph', num, n_versions)
4192
3868
            correct_parents = self.calculate_file_version_parents(key)
4193
3869
            try:
4194
3870
                knit_parents = parent_map[key]
4243
3919
        try:
4244
3920
            if resume_tokens:
4245
3921
                self.target_repo.resume_write_group(resume_tokens)
4246
 
                is_resume = True
4247
3922
            else:
4248
3923
                self.target_repo.start_write_group()
4249
 
                is_resume = False
4250
3924
            try:
4251
3925
                # locked_insert_stream performs a commit|suspend.
4252
 
                return self._locked_insert_stream(stream, src_format, is_resume)
 
3926
                return self._locked_insert_stream(stream, src_format)
4253
3927
            except:
4254
3928
                self.target_repo.abort_write_group(suppress_errors=True)
4255
3929
                raise
4256
3930
        finally:
4257
3931
            self.target_repo.unlock()
4258
3932
 
4259
 
    def _locked_insert_stream(self, stream, src_format, is_resume):
 
3933
    def _locked_insert_stream(self, stream, src_format):
4260
3934
        to_serializer = self.target_repo._format._serializer
4261
3935
        src_serializer = src_format._serializer
4262
 
        new_pack = None
4263
3936
        if to_serializer == src_serializer:
4264
3937
            # If serializers match and the target is a pack repository, set the
4265
3938
            # write cache size on the new pack.  This avoids poor performance
4279
3952
            else:
4280
3953
                new_pack.set_write_cache_size(1024*1024)
4281
3954
        for substream_type, substream in stream:
4282
 
            if 'stream' in debug.debug_flags:
4283
 
                mutter('inserting substream: %s', substream_type)
4284
3955
            if substream_type == 'texts':
4285
3956
                self.target_repo.texts.insert_record_stream(substream)
4286
3957
            elif substream_type == 'inventories':
4290
3961
                else:
4291
3962
                    self._extract_and_insert_inventories(
4292
3963
                        substream, src_serializer)
4293
 
            elif substream_type == 'inventory-deltas':
4294
 
                self._extract_and_insert_inventory_deltas(
4295
 
                    substream, src_serializer)
4296
3964
            elif substream_type == 'chk_bytes':
4297
3965
                # XXX: This doesn't support conversions, as it assumes the
4298
3966
                #      conversion was done in the fetch code.
4311
3979
                self.target_repo.signatures.insert_record_stream(substream)
4312
3980
            else:
4313
3981
                raise AssertionError('kaboom! %s' % (substream_type,))
4314
 
        # Done inserting data, and the missing_keys calculations will try to
4315
 
        # read back from the inserted data, so flush the writes to the new pack
4316
 
        # (if this is pack format).
4317
 
        if new_pack is not None:
4318
 
            new_pack._write_data('', flush=True)
4319
 
        # Find all the new revisions (including ones from resume_tokens)
4320
 
        missing_keys = self.target_repo.get_missing_parent_inventories(
4321
 
            check_for_missing_texts=is_resume)
4322
3982
        try:
 
3983
            missing_keys = set()
4323
3984
            for prefix, versioned_file in (
4324
3985
                ('texts', self.target_repo.texts),
4325
3986
                ('inventories', self.target_repo.inventories),
4326
3987
                ('revisions', self.target_repo.revisions),
4327
3988
                ('signatures', self.target_repo.signatures),
4328
 
                ('chk_bytes', self.target_repo.chk_bytes),
4329
3989
                ):
4330
 
                if versioned_file is None:
4331
 
                    continue
4332
 
                # TODO: key is often going to be a StaticTuple object
4333
 
                #       I don't believe we can define a method by which
4334
 
                #       (prefix,) + StaticTuple will work, though we could
4335
 
                #       define a StaticTuple.sq_concat that would allow you to
4336
 
                #       pass in either a tuple or a StaticTuple as the second
4337
 
                #       object, so instead we could have:
4338
 
                #       StaticTuple(prefix) + key here...
4339
3990
                missing_keys.update((prefix,) + key for key in
4340
3991
                    versioned_file.get_missing_compression_parent_keys())
4341
3992
        except NotImplementedError:
4350
4001
                # missing keys can handle suspending a write group).
4351
4002
                write_group_tokens = self.target_repo.suspend_write_group()
4352
4003
                return write_group_tokens, missing_keys
4353
 
        hint = self.target_repo.commit_write_group()
4354
 
        if (to_serializer != src_serializer and
4355
 
            self.target_repo._format.pack_compresses):
4356
 
            self.target_repo.pack(hint=hint)
 
4004
        self.target_repo.commit_write_group()
4357
4005
        return [], set()
4358
4006
 
4359
 
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
4360
 
        target_rich_root = self.target_repo._format.rich_root_data
4361
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4362
 
        for record in substream:
4363
 
            # Insert the delta directly
4364
 
            inventory_delta_bytes = record.get_bytes_as('fulltext')
4365
 
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
4366
 
            try:
4367
 
                parse_result = deserialiser.parse_text_bytes(
4368
 
                    inventory_delta_bytes)
4369
 
            except inventory_delta.IncompatibleInventoryDelta, err:
4370
 
                trace.mutter("Incompatible delta: %s", err.msg)
4371
 
                raise errors.IncompatibleRevision(self.target_repo._format)
4372
 
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
4373
 
            revision_id = new_id
4374
 
            parents = [key[0] for key in record.parents]
4375
 
            self.target_repo.add_inventory_by_delta(
4376
 
                basis_id, inv_delta, revision_id, parents)
4377
 
 
4378
 
    def _extract_and_insert_inventories(self, substream, serializer,
4379
 
            parse_delta=None):
 
4007
    def _extract_and_insert_inventories(self, substream, serializer):
4380
4008
        """Generate a new inventory versionedfile in target, converting data.
4381
4009
 
4382
4010
        The inventory is retrieved from the source, (deserializing it), and
4383
4011
        stored in the target (reserializing it in a different format).
4384
4012
        """
4385
 
        target_rich_root = self.target_repo._format.rich_root_data
4386
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4387
4013
        for record in substream:
4388
 
            # It's not a delta, so it must be a fulltext in the source
4389
 
            # serializer's format.
4390
4014
            bytes = record.get_bytes_as('fulltext')
4391
4015
            revision_id = record.key[0]
4392
4016
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4393
4017
            parents = [key[0] for key in record.parents]
4394
4018
            self.target_repo.add_inventory(revision_id, inv, parents)
4395
 
            # No need to keep holding this full inv in memory when the rest of
4396
 
            # the substream is likely to be all deltas.
4397
 
            del inv
4398
4019
 
4399
4020
    def _extract_and_insert_revisions(self, substream, serializer):
4400
4021
        for record in substream:
4449
4070
        return [('signatures', signatures), ('revisions', revisions)]
4450
4071
 
4451
4072
    def _generate_root_texts(self, revs):
4452
 
        """This will be called by get_stream between fetching weave texts and
 
4073
        """This will be called by __fetch between fetching weave texts and
4453
4074
        fetching the inventory weave.
 
4075
 
 
4076
        Subclasses should override this if they need to generate root texts
 
4077
        after fetching weave texts.
4454
4078
        """
4455
4079
        if self._rich_root_upgrade():
4456
 
            return _mod_fetch.Inter1and2Helper(
 
4080
            import bzrlib.fetch
 
4081
            return bzrlib.fetch.Inter1and2Helper(
4457
4082
                self.from_repository).generate_root_texts(revs)
4458
4083
        else:
4459
4084
            return []
4462
4087
        phase = 'file'
4463
4088
        revs = search.get_keys()
4464
4089
        graph = self.from_repository.get_graph()
4465
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
 
4090
        revs = list(graph.iter_topo_order(revs))
4466
4091
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4467
4092
        text_keys = []
4468
4093
        for knit_kind, file_id, revisions in data_to_fetch:
4487
4112
                # will be valid.
4488
4113
                for _ in self._generate_root_texts(revs):
4489
4114
                    yield _
 
4115
                # NB: This currently reopens the inventory weave in source;
 
4116
                # using a single stream interface instead would avoid this.
 
4117
                from_weave = self.from_repository.inventories
4490
4118
                # we fetch only the referenced inventories because we do not
4491
4119
                # know for unselected inventories whether all their required
4492
4120
                # texts are present in the other repository - it could be
4511
4139
        keys['texts'] = set()
4512
4140
        keys['revisions'] = set()
4513
4141
        keys['inventories'] = set()
4514
 
        keys['chk_bytes'] = set()
4515
4142
        keys['signatures'] = set()
4516
4143
        for key in missing_keys:
4517
4144
            keys[key[0]].add(key[1:])
4524
4151
                    keys['revisions'],))
4525
4152
        for substream_kind, keys in keys.iteritems():
4526
4153
            vf = getattr(self.from_repository, substream_kind)
4527
 
            if vf is None and keys:
4528
 
                    raise AssertionError(
4529
 
                        "cannot fill in keys for a versioned file we don't"
4530
 
                        " have: %s needs %s" % (substream_kind, keys))
4531
 
            if not keys:
4532
 
                # No need to stream something we don't have
4533
 
                continue
4534
 
            if substream_kind == 'inventories':
4535
 
                # Some missing keys are genuinely ghosts, filter those out.
4536
 
                present = self.from_repository.inventories.get_parent_map(keys)
4537
 
                revs = [key[0] for key in present]
4538
 
                # Get the inventory stream more-or-less as we do for the
4539
 
                # original stream; there's no reason to assume that records
4540
 
                # direct from the source will be suitable for the sink.  (Think
4541
 
                # e.g. 2a -> 1.9-rich-root).
4542
 
                for info in self._get_inventory_stream(revs, missing=True):
4543
 
                    yield info
4544
 
                continue
4545
 
 
4546
4154
            # Ask for full texts always so that we don't need more round trips
4547
4155
            # after this stream.
4548
 
            # Some of the missing keys are genuinely ghosts, so filter absent
4549
 
            # records. The Sink is responsible for doing another check to
4550
 
            # ensure that ghosts don't introduce missing data for future
4551
 
            # fetches.
4552
 
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
4553
 
                self.to_format._fetch_order, True))
 
4156
            stream = vf.get_record_stream(keys,
 
4157
                self.to_format._fetch_order, True)
4554
4158
            yield substream_kind, stream
4555
4159
 
4556
4160
    def inventory_fetch_order(self):
4563
4167
        return (not self.from_repository._format.rich_root_data and
4564
4168
            self.to_format.rich_root_data)
4565
4169
 
4566
 
    def _get_inventory_stream(self, revision_ids, missing=False):
 
4170
    def _get_inventory_stream(self, revision_ids):
4567
4171
        from_format = self.from_repository._format
4568
 
        if (from_format.supports_chks and self.to_format.supports_chks and
4569
 
            from_format.network_name() == self.to_format.network_name()):
4570
 
            raise AssertionError(
4571
 
                "this case should be handled by GroupCHKStreamSource")
4572
 
        elif 'forceinvdeltas' in debug.debug_flags:
4573
 
            return self._get_convertable_inventory_stream(revision_ids,
4574
 
                    delta_versus_null=missing)
4575
 
        elif from_format.network_name() == self.to_format.network_name():
4576
 
            # Same format.
4577
 
            return self._get_simple_inventory_stream(revision_ids,
4578
 
                    missing=missing)
4579
 
        elif (not from_format.supports_chks and not self.to_format.supports_chks
4580
 
                and from_format._serializer == self.to_format._serializer):
4581
 
            # Essentially the same format.
4582
 
            return self._get_simple_inventory_stream(revision_ids,
4583
 
                    missing=missing)
 
4172
        if (from_format.supports_chks and self.to_format.supports_chks
 
4173
            and (from_format._serializer == self.to_format._serializer)):
 
4174
            # Both sides support chks, and they use the same serializer, so it
 
4175
            # is safe to transmit the chk pages and inventory pages across
 
4176
            # as-is.
 
4177
            return self._get_chk_inventory_stream(revision_ids)
 
4178
        elif (not from_format.supports_chks):
 
4179
            # Source repository doesn't support chks. So we can transmit the
 
4180
            # inventories 'as-is' and either they are just accepted on the
 
4181
            # target, or the Sink will properly convert it.
 
4182
            return self._get_simple_inventory_stream(revision_ids)
4584
4183
        else:
4585
 
            # Any time we switch serializations, we want to use an
4586
 
            # inventory-delta based approach.
4587
 
            return self._get_convertable_inventory_stream(revision_ids,
4588
 
                    delta_versus_null=missing)
 
4184
            # XXX: Hack to make not-chk->chk fetch: copy the inventories as
 
4185
            #      inventories. Note that this should probably be done somehow
 
4186
            #      as part of bzrlib.repository.StreamSink. Except JAM couldn't
 
4187
            #      figure out how a non-chk repository could possibly handle
 
4188
            #      deserializing an inventory stream from a chk repo, as it
 
4189
            #      doesn't have a way to understand individual pages.
 
4190
            return self._get_convertable_inventory_stream(revision_ids)
4589
4191
 
4590
 
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
4591
 
        # NB: This currently reopens the inventory weave in source;
4592
 
        # using a single stream interface instead would avoid this.
 
4192
    def _get_simple_inventory_stream(self, revision_ids):
4593
4193
        from_weave = self.from_repository.inventories
4594
 
        if missing:
4595
 
            delta_closure = True
4596
 
        else:
4597
 
            delta_closure = not self.delta_on_metadata()
4598
4194
        yield ('inventories', from_weave.get_record_stream(
4599
4195
            [(rev_id,) for rev_id in revision_ids],
4600
 
            self.inventory_fetch_order(), delta_closure))
4601
 
 
4602
 
    def _get_convertable_inventory_stream(self, revision_ids,
4603
 
                                          delta_versus_null=False):
4604
 
        # The two formats are sufficiently different that there is no fast
4605
 
        # path, so we need to send just inventorydeltas, which any
4606
 
        # sufficiently modern client can insert into any repository.
4607
 
        # The StreamSink code expects to be able to
4608
 
        # convert on the target, so we need to put bytes-on-the-wire that can
4609
 
        # be converted.  That means inventory deltas (if the remote is <1.19,
4610
 
        # RemoteStreamSink will fallback to VFS to insert the deltas).
4611
 
        yield ('inventory-deltas',
4612
 
           self._stream_invs_as_deltas(revision_ids,
4613
 
                                       delta_versus_null=delta_versus_null))
4614
 
 
4615
 
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
4616
 
        """Return a stream of inventory-deltas for the given rev ids.
4617
 
 
4618
 
        :param revision_ids: The list of inventories to transmit
4619
 
        :param delta_versus_null: Don't try to find a minimal delta for this
4620
 
            entry, instead compute the delta versus the NULL_REVISION. This
4621
 
            effectively streams a complete inventory. Used for stuff like
4622
 
            filling in missing parents, etc.
4623
 
        """
 
4196
            self.inventory_fetch_order(),
 
4197
            not self.delta_on_metadata()))
 
4198
 
 
4199
    def _get_chk_inventory_stream(self, revision_ids):
 
4200
        """Fetch the inventory texts, along with the associated chk maps."""
 
4201
        # We want an inventory outside of the search set, so that we can filter
 
4202
        # out uninteresting chk pages. For now we use
 
4203
        # _find_revision_outside_set, but if we had a Search with cut_revs, we
 
4204
        # could use that instead.
 
4205
        start_rev_id = self.from_repository._find_revision_outside_set(
 
4206
                            revision_ids)
 
4207
        start_rev_key = (start_rev_id,)
 
4208
        inv_keys_to_fetch = [(rev_id,) for rev_id in revision_ids]
 
4209
        if start_rev_id != _mod_revision.NULL_REVISION:
 
4210
            inv_keys_to_fetch.append((start_rev_id,))
 
4211
        # Any repo that supports chk_bytes must also support out-of-order
 
4212
        # insertion. At least, that is how we expect it to work
 
4213
        # We use get_record_stream instead of iter_inventories because we want
 
4214
        # to be able to insert the stream as well. We could instead fetch
 
4215
        # allowing deltas, and then iter_inventories, but we don't know whether
 
4216
        # source or target is more 'local' anway.
 
4217
        inv_stream = self.from_repository.inventories.get_record_stream(
 
4218
            inv_keys_to_fetch, 'unordered',
 
4219
            True) # We need them as full-texts so we can find their references
 
4220
        uninteresting_chk_roots = set()
 
4221
        interesting_chk_roots = set()
 
4222
        def filter_inv_stream(inv_stream):
 
4223
            for idx, record in enumerate(inv_stream):
 
4224
                ### child_pb.update('fetch inv', idx, len(inv_keys_to_fetch))
 
4225
                bytes = record.get_bytes_as('fulltext')
 
4226
                chk_inv = inventory.CHKInventory.deserialise(
 
4227
                    self.from_repository.chk_bytes, bytes, record.key)
 
4228
                if record.key == start_rev_key:
 
4229
                    uninteresting_chk_roots.add(chk_inv.id_to_entry.key())
 
4230
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4231
                    if p_id_map is not None:
 
4232
                        uninteresting_chk_roots.add(p_id_map.key())
 
4233
                else:
 
4234
                    yield record
 
4235
                    interesting_chk_roots.add(chk_inv.id_to_entry.key())
 
4236
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4237
                    if p_id_map is not None:
 
4238
                        interesting_chk_roots.add(p_id_map.key())
 
4239
        ### pb.update('fetch inventory', 0, 2)
 
4240
        yield ('inventories', filter_inv_stream(inv_stream))
 
4241
        # Now that we have worked out all of the interesting root nodes, grab
 
4242
        # all of the interesting pages and insert them
 
4243
        ### pb.update('fetch inventory', 1, 2)
 
4244
        interesting = chk_map.iter_interesting_nodes(
 
4245
            self.from_repository.chk_bytes, interesting_chk_roots,
 
4246
            uninteresting_chk_roots)
 
4247
        def to_stream_adapter():
 
4248
            """Adapt the iter_interesting_nodes result to a single stream.
 
4249
 
 
4250
            iter_interesting_nodes returns records as it processes them, along
 
4251
            with keys. However, we only want to return the records themselves.
 
4252
            """
 
4253
            for record, items in interesting:
 
4254
                if record is not None:
 
4255
                    yield record
 
4256
        # XXX: We could instead call get_record_stream(records.keys())
 
4257
        #      ATM, this will always insert the records as fulltexts, and
 
4258
        #      requires that you can hang on to records once you have gone
 
4259
        #      on to the next one. Further, it causes the target to
 
4260
        #      recompress the data. Testing shows it to be faster than
 
4261
        #      requesting the records again, though.
 
4262
        yield ('chk_bytes', to_stream_adapter())
 
4263
        ### pb.update('fetch inventory', 2, 2)
 
4264
 
 
4265
    def _get_convertable_inventory_stream(self, revision_ids):
 
4266
        # XXX: One of source or target is using chks, and they don't have
 
4267
        #      compatible serializations. The StreamSink code expects to be
 
4268
        #      able to convert on the target, so we need to put
 
4269
        #      bytes-on-the-wire that can be converted
 
4270
        yield ('inventories', self._stream_invs_as_fulltexts(revision_ids))
 
4271
 
 
4272
    def _stream_invs_as_fulltexts(self, revision_ids):
4624
4273
        from_repo = self.from_repository
 
4274
        from_serializer = from_repo._format._serializer
4625
4275
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4626
4276
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
4627
 
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
4628
 
        # method...
4629
 
        inventories = self.from_repository.iter_inventories(
4630
 
            revision_ids, 'topological')
4631
 
        format = from_repo._format
4632
 
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
4633
 
        inventory_cache = lru_cache.LRUCache(50)
4634
 
        null_inventory = from_repo.revision_tree(
4635
 
            _mod_revision.NULL_REVISION).inventory
4636
 
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
4637
 
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
4638
 
        # repo back into a non-rich-root repo ought to be allowed)
4639
 
        serializer = inventory_delta.InventoryDeltaSerializer(
4640
 
            versioned_root=format.rich_root_data,
4641
 
            tree_references=format.supports_tree_reference)
4642
 
        for inv in inventories:
 
4277
        for inv in self.from_repository.iter_inventories(revision_ids):
 
4278
            # XXX: This is a bit hackish, but it works. Basically,
 
4279
            #      CHKSerializer 'accidentally' supports
 
4280
            #      read/write_inventory_to_string, even though that is never
 
4281
            #      the format that is stored on disk. It *does* give us a
 
4282
            #      single string representation for an inventory, so live with
 
4283
            #      it for now.
 
4284
            #      This would be far better if we had a 'serialized inventory
 
4285
            #      delta' form. Then we could use 'inventory._make_delta', and
 
4286
            #      transmit that. This would both be faster to generate, and
 
4287
            #      result in fewer bytes-on-the-wire.
 
4288
            as_bytes = from_serializer.write_inventory_to_string(inv)
4643
4289
            key = (inv.revision_id,)
4644
4290
            parent_keys = parent_map.get(key, ())
4645
 
            delta = None
4646
 
            if not delta_versus_null and parent_keys:
4647
 
                # The caller did not ask for complete inventories and we have
4648
 
                # some parents that we can delta against.  Make a delta against
4649
 
                # each parent so that we can find the smallest.
4650
 
                parent_ids = [parent_key[0] for parent_key in parent_keys]
4651
 
                for parent_id in parent_ids:
4652
 
                    if parent_id not in invs_sent_so_far:
4653
 
                        # We don't know that the remote side has this basis, so
4654
 
                        # we can't use it.
4655
 
                        continue
4656
 
                    if parent_id == _mod_revision.NULL_REVISION:
4657
 
                        parent_inv = null_inventory
4658
 
                    else:
4659
 
                        parent_inv = inventory_cache.get(parent_id, None)
4660
 
                        if parent_inv is None:
4661
 
                            parent_inv = from_repo.get_inventory(parent_id)
4662
 
                    candidate_delta = inv._make_delta(parent_inv)
4663
 
                    if (delta is None or
4664
 
                        len(delta) > len(candidate_delta)):
4665
 
                        delta = candidate_delta
4666
 
                        basis_id = parent_id
4667
 
            if delta is None:
4668
 
                # Either none of the parents ended up being suitable, or we
4669
 
                # were asked to delta against NULL
4670
 
                basis_id = _mod_revision.NULL_REVISION
4671
 
                delta = inv._make_delta(null_inventory)
4672
 
            invs_sent_so_far.add(inv.revision_id)
4673
 
            inventory_cache[inv.revision_id] = inv
4674
 
            delta_serialized = ''.join(
4675
 
                serializer.delta_to_lines(basis_id, key[-1], delta))
4676
4291
            yield versionedfile.FulltextContentFactory(
4677
 
                key, parent_keys, None, delta_serialized)
4678
 
 
4679
 
 
4680
 
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
4681
 
                    stop_revision=None):
4682
 
    """Extend the partial history to include a given index
4683
 
 
4684
 
    If a stop_index is supplied, stop when that index has been reached.
4685
 
    If a stop_revision is supplied, stop when that revision is
4686
 
    encountered.  Otherwise, stop when the beginning of history is
4687
 
    reached.
4688
 
 
4689
 
    :param stop_index: The index which should be present.  When it is
4690
 
        present, history extension will stop.
4691
 
    :param stop_revision: The revision id which should be present.  When
4692
 
        it is encountered, history extension will stop.
4693
 
    """
4694
 
    start_revision = partial_history_cache[-1]
4695
 
    iterator = repo.iter_reverse_revision_history(start_revision)
4696
 
    try:
4697
 
        #skip the last revision in the list
4698
 
        iterator.next()
4699
 
        while True:
4700
 
            if (stop_index is not None and
4701
 
                len(partial_history_cache) > stop_index):
4702
 
                break
4703
 
            if partial_history_cache[-1] == stop_revision:
4704
 
                break
4705
 
            revision_id = iterator.next()
4706
 
            partial_history_cache.append(revision_id)
4707
 
    except StopIteration:
4708
 
        # No more history
4709
 
        return
 
4292
                key, parent_keys, None, as_bytes)
4710
4293