~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-06-23 15:27:50 UTC
  • mfrom: (4398.9.1 _add_text_docstrings)
  • Revision ID: pqm@pqm.ubuntu.com-20090623152750-ecuv25e1te21w2pc
(Matt Nordhoff) Update _add_text docstrings that still referred to
        add_text.

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]:
548
542
                ie.revision = parent_entry.revision
549
543
                return self._get_delta(ie, basis_inv, path), False, None
550
544
            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
545
            self._add_text_to_weave(ie.file_id, '', heads, None)
555
546
        else:
556
547
            raise NotImplementedError('unknown kind')
797
788
                        # references.
798
789
                        raise errors.UnsupportedOperation(tree.add_reference,
799
790
                            self.repository)
800
 
                    reference_revision = tree.get_reference_revision(change[0])
801
 
                    entry.reference_revision = reference_revision
 
791
                    entry.reference_revision = \
 
792
                        tree.get_reference_revision(change[0])
802
793
                    if (carry_over_possible and
803
794
                        parent_entry.reference_revision == reference_revision):
804
795
                        carried_over = True
818
809
                seen_root = True
819
810
        self.new_inventory = None
820
811
        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
812
            self._any_changes = True
825
813
        if not seen_root:
826
814
            # housekeeping root entry changes do not affect no-change commits.
860
848
        # versioned roots do not change unless the tree found a change.
861
849
 
862
850
 
863
 
class RepositoryWriteLockResult(object):
864
 
    """The result of write locking a repository.
865
 
 
866
 
    :ivar repository_token: The token obtained from the underlying lock, or
867
 
        None.
868
 
    :ivar unlock: A callable which will unlock the lock.
869
 
    """
870
 
 
871
 
    def __init__(self, unlock, repository_token):
872
 
        self.repository_token = repository_token
873
 
        self.unlock = unlock
874
 
 
875
 
 
876
851
######################################################################
877
852
# Repositories
878
853
 
879
 
 
880
 
class Repository(_RelockDebugMixin, bzrdir.ControlComponent):
 
854
class Repository(object):
881
855
    """Repository holding history for one or more branches.
882
856
 
883
857
    The repository holds and retrieves historical information including
952
926
        """
953
927
        if self._write_group is not self.get_transaction():
954
928
            # has an unlock or relock occured ?
955
 
            if suppress_errors:
956
 
                mutter(
957
 
                '(suppressed) mismatched lock context and write group. %r, %r',
958
 
                self._write_group, self.get_transaction())
959
 
                return
960
929
            raise errors.BzrError(
961
930
                'mismatched lock context and write group. %r, %r' %
962
931
                (self._write_group, self.get_transaction()))
1041
1010
 
1042
1011
        :seealso: add_inventory, for the contract.
1043
1012
        """
1044
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
 
1013
        inv_lines = self._serialise_inventory_to_lines(inv)
1045
1014
        return self._inventory_add_lines(revision_id, parents,
1046
1015
            inv_lines, check_content=False)
1047
1016
 
1049
1018
                               parents, basis_inv=None, propagate_caches=False):
1050
1019
        """Add a new inventory expressed as a delta against another revision.
1051
1020
 
1052
 
        See the inventory developers documentation for the theory behind
1053
 
        inventory deltas.
1054
 
 
1055
1021
        :param basis_revision_id: The inventory id the delta was created
1056
1022
            against. (This does not have to be a direct parent.)
1057
1023
        :param delta: The inventory delta (see Inventory.apply_delta for
1096
1062
        check_content=True):
1097
1063
        """Store lines in inv_vf and return the sha1 of the inventory."""
1098
1064
        parents = [(parent,) for parent in parents]
1099
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
1065
        return self.inventories.add_lines((revision_id,), parents, lines,
1100
1066
            check_content=check_content)[0]
1101
 
        self.inventories._access.flush()
1102
 
        return result
1103
1067
 
1104
1068
    def add_revision(self, revision_id, rev, inv=None, config=None):
1105
1069
        """Add rev to the revision store as revision_id.
1181
1145
        # The old API returned a list, should this actually be a set?
1182
1146
        return parent_map.keys()
1183
1147
 
1184
 
    def _check_inventories(self, checker):
1185
 
        """Check the inventories found from the revision scan.
1186
 
        
1187
 
        This is responsible for verifying the sha1 of inventories and
1188
 
        creating a pending_keys set that covers data referenced by inventories.
1189
 
        """
1190
 
        bar = ui.ui_factory.nested_progress_bar()
1191
 
        try:
1192
 
            self._do_check_inventories(checker, bar)
1193
 
        finally:
1194
 
            bar.finished()
1195
 
 
1196
 
    def _do_check_inventories(self, checker, bar):
1197
 
        """Helper for _check_inventories."""
1198
 
        revno = 0
1199
 
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
1200
 
        kinds = ['chk_bytes', 'texts']
1201
 
        count = len(checker.pending_keys)
1202
 
        bar.update("inventories", 0, 2)
1203
 
        current_keys = checker.pending_keys
1204
 
        checker.pending_keys = {}
1205
 
        # Accumulate current checks.
1206
 
        for key in current_keys:
1207
 
            if key[0] != 'inventories' and key[0] not in kinds:
1208
 
                checker._report_items.append('unknown key type %r' % (key,))
1209
 
            keys[key[0]].add(key[1:])
1210
 
        if keys['inventories']:
1211
 
            # NB: output order *should* be roughly sorted - topo or
1212
 
            # inverse topo depending on repository - either way decent
1213
 
            # to just delta against. However, pre-CHK formats didn't
1214
 
            # try to optimise inventory layout on disk. As such the
1215
 
            # pre-CHK code path does not use inventory deltas.
1216
 
            last_object = None
1217
 
            for record in self.inventories.check(keys=keys['inventories']):
1218
 
                if record.storage_kind == 'absent':
1219
 
                    checker._report_items.append(
1220
 
                        'Missing inventory {%s}' % (record.key,))
1221
 
                else:
1222
 
                    last_object = self._check_record('inventories', record,
1223
 
                        checker, last_object,
1224
 
                        current_keys[('inventories',) + record.key])
1225
 
            del keys['inventories']
1226
 
        else:
1227
 
            return
1228
 
        bar.update("texts", 1)
1229
 
        while (checker.pending_keys or keys['chk_bytes']
1230
 
            or keys['texts']):
1231
 
            # Something to check.
1232
 
            current_keys = checker.pending_keys
1233
 
            checker.pending_keys = {}
1234
 
            # Accumulate current checks.
1235
 
            for key in current_keys:
1236
 
                if key[0] not in kinds:
1237
 
                    checker._report_items.append('unknown key type %r' % (key,))
1238
 
                keys[key[0]].add(key[1:])
1239
 
            # Check the outermost kind only - inventories || chk_bytes || texts
1240
 
            for kind in kinds:
1241
 
                if keys[kind]:
1242
 
                    last_object = None
1243
 
                    for record in getattr(self, kind).check(keys=keys[kind]):
1244
 
                        if record.storage_kind == 'absent':
1245
 
                            checker._report_items.append(
1246
 
                                'Missing %s {%s}' % (kind, record.key,))
1247
 
                        else:
1248
 
                            last_object = self._check_record(kind, record,
1249
 
                                checker, last_object, current_keys[(kind,) + record.key])
1250
 
                    keys[kind] = set()
1251
 
                    break
1252
 
 
1253
 
    def _check_record(self, kind, record, checker, last_object, item_data):
1254
 
        """Check a single text from this repository."""
1255
 
        if kind == 'inventories':
1256
 
            rev_id = record.key[0]
1257
 
            inv = self._deserialise_inventory(rev_id,
1258
 
                record.get_bytes_as('fulltext'))
1259
 
            if last_object is not None:
1260
 
                delta = inv._make_delta(last_object)
1261
 
                for old_path, path, file_id, ie in delta:
1262
 
                    if ie is None:
1263
 
                        continue
1264
 
                    ie.check(checker, rev_id, inv)
1265
 
            else:
1266
 
                for path, ie in inv.iter_entries():
1267
 
                    ie.check(checker, rev_id, inv)
1268
 
            if self._format.fast_deltas:
1269
 
                return inv
1270
 
        elif kind == 'chk_bytes':
1271
 
            # No code written to check chk_bytes for this repo format.
1272
 
            checker._report_items.append(
1273
 
                'unsupported key type chk_bytes for %s' % (record.key,))
1274
 
        elif kind == 'texts':
1275
 
            self._check_text(record, checker, item_data)
1276
 
        else:
1277
 
            checker._report_items.append(
1278
 
                'unknown key type %s for %s' % (kind, record.key))
1279
 
 
1280
 
    def _check_text(self, record, checker, item_data):
1281
 
        """Check a single text."""
1282
 
        # Check it is extractable.
1283
 
        # TODO: check length.
1284
 
        if record.storage_kind == 'chunked':
1285
 
            chunks = record.get_bytes_as(record.storage_kind)
1286
 
            sha1 = osutils.sha_strings(chunks)
1287
 
            length = sum(map(len, chunks))
1288
 
        else:
1289
 
            content = record.get_bytes_as('fulltext')
1290
 
            sha1 = osutils.sha_string(content)
1291
 
            length = len(content)
1292
 
        if item_data and sha1 != item_data[1]:
1293
 
            checker._report_items.append(
1294
 
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
1295
 
                (record.key, sha1, item_data[1], item_data[2]))
1296
 
 
1297
1148
    @staticmethod
1298
1149
    def create(a_bzrdir):
1299
1150
        """Construct the current default format repository in a_bzrdir."""
1304
1155
 
1305
1156
        :param _format: The format of the repository on disk.
1306
1157
        :param a_bzrdir: The BzrDir of the repository.
 
1158
 
 
1159
        In the future we will have a single api for all stores for
 
1160
        getting file texts, inventories and revisions, then
 
1161
        this construct will accept instances of those things.
1307
1162
        """
1308
 
        # In the future we will have a single api for all stores for
1309
 
        # getting file texts, inventories and revisions, then
1310
 
        # this construct will accept instances of those things.
1311
1163
        super(Repository, self).__init__()
1312
1164
        self._format = _format
1313
1165
        # the following are part of the public API for Repository:
1319
1171
        self._reconcile_does_inventory_gc = True
1320
1172
        self._reconcile_fixes_text_parents = False
1321
1173
        self._reconcile_backsup_inventory = True
 
1174
        # not right yet - should be more semantically clear ?
 
1175
        #
 
1176
        # TODO: make sure to construct the right store classes, etc, depending
 
1177
        # on whether escaping is required.
 
1178
        self._warn_if_deprecated()
1322
1179
        self._write_group = None
1323
1180
        # Additional places to query for data.
1324
1181
        self._fallback_repositories = []
1325
1182
        # An InventoryEntry cache, used during deserialization
1326
1183
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
1327
 
        # Is it safe to return inventory entries directly from the entry cache,
1328
 
        # rather copying them?
1329
 
        self._safe_to_return_from_cache = False
1330
 
 
1331
 
    @property
1332
 
    def user_transport(self):
1333
 
        return self.bzrdir.user_transport
1334
 
 
1335
 
    @property
1336
 
    def control_transport(self):
1337
 
        return self._transport
1338
1184
 
1339
1185
    def __repr__(self):
1340
 
        if self._fallback_repositories:
1341
 
            return '%s(%r, fallback_repositories=%r)' % (
1342
 
                self.__class__.__name__,
1343
 
                self.base,
1344
 
                self._fallback_repositories)
1345
 
        else:
1346
 
            return '%s(%r)' % (self.__class__.__name__,
1347
 
                               self.base)
1348
 
 
1349
 
    def _has_same_fallbacks(self, other_repo):
1350
 
        """Returns true if the repositories have the same fallbacks."""
1351
 
        my_fb = self._fallback_repositories
1352
 
        other_fb = other_repo._fallback_repositories
1353
 
        if len(my_fb) != len(other_fb):
1354
 
            return False
1355
 
        for f, g in zip(my_fb, other_fb):
1356
 
            if not f.has_same_location(g):
1357
 
                return False
1358
 
        return True
 
1186
        return '%s(%r)' % (self.__class__.__name__,
 
1187
                           self.base)
1359
1188
 
1360
1189
    def has_same_location(self, other):
1361
1190
        """Returns a boolean indicating if this repository is at the same
1389
1218
        data during reads, and allows a 'write_group' to be obtained. Write
1390
1219
        groups must be used for actual data insertion.
1391
1220
 
1392
 
        A token should be passed in if you know that you have locked the object
1393
 
        some other way, and need to synchronise this object's state with that
1394
 
        fact.
1395
 
 
1396
 
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1397
 
 
1398
1221
        :param token: if this is already locked, then lock_write will fail
1399
1222
            unless the token matches the existing lock.
1400
1223
        :returns: a token if this instance supports tokens, otherwise None.
1403
1226
        :raises MismatchedToken: if the specified token doesn't match the token
1404
1227
            of the existing lock.
1405
1228
        :seealso: start_write_group.
1406
 
        :return: A RepositoryWriteLockResult.
 
1229
 
 
1230
        A token should be passed in if you know that you have locked the object
 
1231
        some other way, and need to synchronise this object's state with that
 
1232
        fact.
 
1233
 
 
1234
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1407
1235
        """
1408
1236
        locked = self.is_locked()
1409
 
        token = self.control_files.lock_write(token=token)
 
1237
        result = self.control_files.lock_write(token=token)
1410
1238
        if not locked:
1411
 
            self._warn_if_deprecated()
1412
 
            self._note_lock('w')
1413
1239
            for repo in self._fallback_repositories:
1414
1240
                # Writes don't affect fallback repos
1415
1241
                repo.lock_read()
1416
1242
            self._refresh_data()
1417
 
        return RepositoryWriteLockResult(self.unlock, token)
 
1243
        return result
1418
1244
 
1419
1245
    def lock_read(self):
1420
 
        """Lock the repository for read operations.
1421
 
 
1422
 
        :return: An object with an unlock method which will release the lock
1423
 
            obtained.
1424
 
        """
1425
1246
        locked = self.is_locked()
1426
1247
        self.control_files.lock_read()
1427
1248
        if not locked:
1428
 
            self._warn_if_deprecated()
1429
 
            self._note_lock('r')
1430
1249
            for repo in self._fallback_repositories:
1431
1250
                repo.lock_read()
1432
1251
            self._refresh_data()
1433
 
        return self
1434
1252
 
1435
1253
    def get_physical_lock_status(self):
1436
1254
        return self.control_files.get_physical_lock_status()
1496
1314
 
1497
1315
        # now gather global repository information
1498
1316
        # XXX: This is available for many repos regardless of listability.
1499
 
        if self.user_transport.listable():
 
1317
        if self.bzrdir.root_transport.listable():
1500
1318
            # XXX: do we want to __define len__() ?
1501
1319
            # Maybe the versionedfiles object should provide a different
1502
1320
            # method to get the number of keys.
1512
1330
        :param using: If True, list only branches using this repository.
1513
1331
        """
1514
1332
        if using and not self.is_shared():
1515
 
            return self.bzrdir.list_branches()
 
1333
            try:
 
1334
                return [self.bzrdir.open_branch()]
 
1335
            except errors.NotBranchError:
 
1336
                return []
1516
1337
        class Evaluator(object):
1517
1338
 
1518
1339
            def __init__(self):
1527
1348
                    except errors.NoRepositoryPresent:
1528
1349
                        pass
1529
1350
                    else:
1530
 
                        return False, ([], repository)
 
1351
                        return False, (None, repository)
1531
1352
                self.first_call = False
1532
 
                value = (bzrdir.list_branches(), None)
 
1353
                try:
 
1354
                    value = (bzrdir.open_branch(), None)
 
1355
                except errors.NotBranchError:
 
1356
                    value = (None, None)
1533
1357
                return True, value
1534
1358
 
1535
 
        ret = []
1536
 
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
1537
 
                self.user_transport, evaluate=Evaluator()):
1538
 
            if branches is not None:
1539
 
                ret.extend(branches)
 
1359
        branches = []
 
1360
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1361
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
1362
            if branch is not None:
 
1363
                branches.append(branch)
1540
1364
            if not using and repository is not None:
1541
 
                ret.extend(repository.find_branches())
1542
 
        return ret
 
1365
                branches.extend(repository.find_branches())
 
1366
        return branches
1543
1367
 
1544
1368
    @needs_read_lock
1545
1369
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1574
1398
        """Commit the contents accrued within the current write group.
1575
1399
 
1576
1400
        :seealso: start_write_group.
1577
 
        
1578
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1579
1401
        """
1580
1402
        if self._write_group is not self.get_transaction():
1581
1403
            # has an unlock or relock occured ?
1635
1457
        # but at the moment we're only checking for texts referenced by
1636
1458
        # inventories at the graph's edge.
1637
1459
        key_deps = self.revisions._index._key_dependencies
1638
 
        key_deps.satisfy_refs_for_keys(present_inventories)
 
1460
        key_deps.add_keys(present_inventories)
1639
1461
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1640
1462
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1641
1463
        missing_texts = set()
1707
1529
            raise errors.InternalBzrError(
1708
1530
                "May not fetch while in a write group.")
1709
1531
        # fast path same-url fetch operations
1710
 
        # TODO: lift out to somewhere common with RemoteRepository
1711
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401646>
1712
 
        if (self.has_same_location(source)
1713
 
            and fetch_spec is None
1714
 
            and self._has_same_fallbacks(source)):
 
1532
        if self.has_same_location(source) and fetch_spec is None:
1715
1533
            # check that last_revision is in 'from' and then return a
1716
1534
            # no-operation.
1717
1535
            if (revision_id is not None and
1742
1560
        :param revprops: Optional dictionary of revision properties.
1743
1561
        :param revision_id: Optional revision id.
1744
1562
        """
1745
 
        if self._fallback_repositories:
1746
 
            raise errors.BzrError("Cannot commit from a lightweight checkout "
1747
 
                "to a stacked branch. See "
1748
 
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1749
1563
        result = self._commit_builder_class(self, parents, config,
1750
1564
            timestamp, timezone, committer, revprops, revision_id)
1751
1565
        self.start_write_group()
1752
1566
        return result
1753
1567
 
1754
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1755
1568
    def unlock(self):
1756
1569
        if (self.control_files._lock_count == 1 and
1757
1570
            self.control_files._lock_mode == 'w'):
1879
1692
 
1880
1693
    @needs_read_lock
1881
1694
    def get_revisions(self, revision_ids):
1882
 
        """Get many revisions at once.
1883
 
        
1884
 
        Repositories that need to check data on every revision read should 
1885
 
        subclass this method.
1886
 
        """
 
1695
        """Get many revisions at once."""
1887
1696
        return self._get_revisions(revision_ids)
1888
1697
 
1889
1698
    @needs_read_lock
1890
1699
    def _get_revisions(self, revision_ids):
1891
1700
        """Core work logic to get many revisions without sanity checks."""
 
1701
        for rev_id in revision_ids:
 
1702
            if not rev_id or not isinstance(rev_id, basestring):
 
1703
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1704
        keys = [(key,) for key in revision_ids]
 
1705
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1892
1706
        revs = {}
1893
 
        for revid, rev in self._iter_revisions(revision_ids):
1894
 
            if rev is None:
1895
 
                raise errors.NoSuchRevision(self, revid)
1896
 
            revs[revid] = rev
 
1707
        for record in stream:
 
1708
            if record.storage_kind == 'absent':
 
1709
                raise errors.NoSuchRevision(self, record.key[0])
 
1710
            text = record.get_bytes_as('fulltext')
 
1711
            rev = self._serializer.read_revision_from_string(text)
 
1712
            revs[record.key[0]] = rev
1897
1713
        return [revs[revid] for revid in revision_ids]
1898
1714
 
1899
 
    def _iter_revisions(self, revision_ids):
1900
 
        """Iterate over revision objects.
1901
 
 
1902
 
        :param revision_ids: An iterable of revisions to examine. None may be
1903
 
            passed to request all revisions known to the repository. Note that
1904
 
            not all repositories can find unreferenced revisions; for those
1905
 
            repositories only referenced ones will be returned.
1906
 
        :return: An iterator of (revid, revision) tuples. Absent revisions (
1907
 
            those asked for but not available) are returned as (revid, None).
1908
 
        """
1909
 
        if revision_ids is None:
1910
 
            revision_ids = self.all_revision_ids()
1911
 
        else:
1912
 
            for rev_id in revision_ids:
1913
 
                if not rev_id or not isinstance(rev_id, basestring):
1914
 
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1915
 
        keys = [(key,) for key in revision_ids]
1916
 
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1917
 
        for record in stream:
1918
 
            revid = record.key[0]
1919
 
            if record.storage_kind == 'absent':
1920
 
                yield (revid, None)
1921
 
            else:
1922
 
                text = record.get_bytes_as('fulltext')
1923
 
                rev = self._serializer.read_revision_from_string(text)
1924
 
                yield (revid, rev)
 
1715
    @needs_read_lock
 
1716
    def get_revision_xml(self, revision_id):
 
1717
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1718
        #       would have already do it.
 
1719
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1720
        # TODO: this can't just be replaced by:
 
1721
        # return self._serializer.write_revision_to_string(
 
1722
        #     self.get_revision(revision_id))
 
1723
        # as cStringIO preservers the encoding unlike write_revision_to_string
 
1724
        # or some other call down the path.
 
1725
        rev = self.get_revision(revision_id)
 
1726
        rev_tmp = cStringIO.StringIO()
 
1727
        # the current serializer..
 
1728
        self._serializer.write_revision(rev, rev_tmp)
 
1729
        rev_tmp.seek(0)
 
1730
        return rev_tmp.getvalue()
1925
1731
 
1926
1732
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1927
1733
        """Produce a generator of revision deltas.
2170
1976
        """
2171
1977
        selected_keys = set((revid,) for revid in revision_ids)
2172
1978
        w = _inv_weave or self.inventories
2173
 
        return self._find_file_ids_from_xml_inventory_lines(
2174
 
            w.iter_lines_added_or_present_in_keys(
2175
 
                selected_keys, pb=None),
2176
 
            selected_keys)
 
1979
        pb = ui.ui_factory.nested_progress_bar()
 
1980
        try:
 
1981
            return self._find_file_ids_from_xml_inventory_lines(
 
1982
                w.iter_lines_added_or_present_in_keys(
 
1983
                    selected_keys, pb=pb),
 
1984
                selected_keys)
 
1985
        finally:
 
1986
            pb.finished()
2177
1987
 
2178
1988
    def iter_files_bytes(self, desired_files):
2179
1989
        """Iterate through file versions.
2261
2071
                batch_size]
2262
2072
            if not to_query:
2263
2073
                break
2264
 
            for revision_id in to_query:
 
2074
            for rev_tree in self.revision_trees(to_query):
 
2075
                revision_id = rev_tree.get_revision_id()
2265
2076
                parent_ids = ancestors[revision_id]
2266
2077
                for text_key in revision_keys[revision_id]:
2267
2078
                    pb.update("Calculating text parents", processed_texts)
2340
2151
        num_file_ids = len(file_ids)
2341
2152
        for file_id, altered_versions in file_ids.iteritems():
2342
2153
            if pb is not None:
2343
 
                pb.update("Fetch texts", count, num_file_ids)
 
2154
                pb.update("fetch texts", count, num_file_ids)
2344
2155
            count += 1
2345
2156
            yield ("file", file_id, altered_versions)
2346
2157
 
2367
2178
        """Get Inventory object by revision id."""
2368
2179
        return self.iter_inventories([revision_id]).next()
2369
2180
 
2370
 
    def iter_inventories(self, revision_ids, ordering=None):
 
2181
    def iter_inventories(self, revision_ids):
2371
2182
        """Get many inventories by revision_ids.
2372
2183
 
2373
2184
        This will buffer some or all of the texts used in constructing the
2375
2186
        time.
2376
2187
 
2377
2188
        :param revision_ids: The expected revision ids of the inventories.
2378
 
        :param ordering: optional ordering, e.g. 'topological'.  If not
2379
 
            specified, the order of revision_ids will be preserved (by
2380
 
            buffering if necessary).
2381
2189
        :return: An iterator of inventories.
2382
2190
        """
2383
2191
        if ((None in revision_ids)
2384
2192
            or (_mod_revision.NULL_REVISION in revision_ids)):
2385
2193
            raise ValueError('cannot get null revision inventory')
2386
 
        return self._iter_inventories(revision_ids, ordering)
 
2194
        return self._iter_inventories(revision_ids)
2387
2195
 
2388
 
    def _iter_inventories(self, revision_ids, ordering):
 
2196
    def _iter_inventories(self, revision_ids):
2389
2197
        """single-document based inventory iteration."""
2390
 
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2391
 
        for text, revision_id in inv_xmls:
2392
 
            yield self._deserialise_inventory(revision_id, text)
 
2198
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
 
2199
            yield self.deserialise_inventory(revision_id, text)
2393
2200
 
2394
 
    def _iter_inventory_xmls(self, revision_ids, ordering):
2395
 
        if ordering is None:
2396
 
            order_as_requested = True
2397
 
            ordering = 'unordered'
2398
 
        else:
2399
 
            order_as_requested = False
 
2201
    def _iter_inventory_xmls(self, revision_ids):
2400
2202
        keys = [(revision_id,) for revision_id in revision_ids]
2401
 
        if not keys:
2402
 
            return
2403
 
        if order_as_requested:
2404
 
            key_iter = iter(keys)
2405
 
            next_key = key_iter.next()
2406
 
        stream = self.inventories.get_record_stream(keys, ordering, True)
 
2203
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2407
2204
        text_chunks = {}
2408
2205
        for record in stream:
2409
2206
            if record.storage_kind != 'absent':
2410
 
                chunks = record.get_bytes_as('chunked')
2411
 
                if order_as_requested:
2412
 
                    text_chunks[record.key] = chunks
2413
 
                else:
2414
 
                    yield ''.join(chunks), record.key[-1]
 
2207
                text_chunks[record.key] = record.get_bytes_as('chunked')
2415
2208
            else:
2416
2209
                raise errors.NoSuchRevision(self, record.key)
2417
 
            if order_as_requested:
2418
 
                # Yield as many results as we can while preserving order.
2419
 
                while next_key in text_chunks:
2420
 
                    chunks = text_chunks.pop(next_key)
2421
 
                    yield ''.join(chunks), next_key[-1]
2422
 
                    try:
2423
 
                        next_key = key_iter.next()
2424
 
                    except StopIteration:
2425
 
                        # We still want to fully consume the get_record_stream,
2426
 
                        # just in case it is not actually finished at this point
2427
 
                        next_key = None
2428
 
                        break
 
2210
        for key in keys:
 
2211
            chunks = text_chunks.pop(key)
 
2212
            yield ''.join(chunks), key[-1]
2429
2213
 
2430
 
    def _deserialise_inventory(self, revision_id, xml):
 
2214
    def deserialise_inventory(self, revision_id, xml):
2431
2215
        """Transform the xml into an inventory object.
2432
2216
 
2433
2217
        :param revision_id: The expected revision id of the inventory.
2434
2218
        :param xml: A serialised inventory.
2435
2219
        """
2436
2220
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2437
 
                    entry_cache=self._inventory_entry_cache,
2438
 
                    return_from_cache=self._safe_to_return_from_cache)
 
2221
                    entry_cache=self._inventory_entry_cache)
2439
2222
        if result.revision_id != revision_id:
2440
2223
            raise AssertionError('revision id mismatch %s != %s' % (
2441
2224
                result.revision_id, revision_id))
2442
2225
        return result
2443
2226
 
 
2227
    def serialise_inventory(self, inv):
 
2228
        return self._serializer.write_inventory_to_string(inv)
 
2229
 
 
2230
    def _serialise_inventory_to_lines(self, inv):
 
2231
        return self._serializer.write_inventory_to_lines(inv)
 
2232
 
2444
2233
    def get_serializer_format(self):
2445
2234
        return self._serializer.format_num
2446
2235
 
2447
2236
    @needs_read_lock
2448
 
    def _get_inventory_xml(self, revision_id):
2449
 
        """Get serialized inventory as a string."""
2450
 
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
 
2237
    def get_inventory_xml(self, revision_id):
 
2238
        """Get inventory XML as a file object."""
 
2239
        texts = self._iter_inventory_xmls([revision_id])
2451
2240
        try:
2452
2241
            text, revision_id = texts.next()
2453
2242
        except StopIteration:
2454
2243
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2455
2244
        return text
2456
2245
 
 
2246
    @needs_read_lock
 
2247
    def get_inventory_sha1(self, revision_id):
 
2248
        """Return the sha1 hash of the inventory entry
 
2249
        """
 
2250
        return self.get_revision(revision_id).inventory_sha1
 
2251
 
2457
2252
    def get_rev_id_for_revno(self, revno, known_pair):
2458
2253
        """Return the revision id of a revno, given a later (revno, revid)
2459
2254
        pair in the same history.
2510
2305
            else:
2511
2306
                next_id = parents[0]
2512
2307
 
 
2308
    @needs_read_lock
 
2309
    def get_revision_inventory(self, revision_id):
 
2310
        """Return inventory of a past revision."""
 
2311
        # TODO: Unify this with get_inventory()
 
2312
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
2313
        # must be the same as its revision, so this is trivial.
 
2314
        if revision_id is None:
 
2315
            # This does not make sense: if there is no revision,
 
2316
            # then it is the current tree inventory surely ?!
 
2317
            # and thus get_root_id() is something that looks at the last
 
2318
            # commit on the branch, and the get_root_id is an inventory check.
 
2319
            raise NotImplementedError
 
2320
            # return Inventory(self.get_root_id())
 
2321
        else:
 
2322
            return self.get_inventory(revision_id)
 
2323
 
2513
2324
    def is_shared(self):
2514
2325
        """Return True if this repository is flagged as a shared repository."""
2515
2326
        raise NotImplementedError(self.is_shared)
2549
2360
            return RevisionTree(self, Inventory(root_id=None),
2550
2361
                                _mod_revision.NULL_REVISION)
2551
2362
        else:
2552
 
            inv = self.get_inventory(revision_id)
 
2363
            inv = self.get_revision_inventory(revision_id)
2553
2364
            return RevisionTree(self, inv, revision_id)
2554
2365
 
2555
2366
    def revision_trees(self, revision_ids):
2608
2419
            keys = tsort.topo_sort(parent_map)
2609
2420
        return [None] + list(keys)
2610
2421
 
2611
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
2422
    def pack(self, hint=None):
2612
2423
        """Compress the data within the repository.
2613
2424
 
2614
2425
        This operation only makes sense for some repository types. For other
2624
2435
            obtained from the result of commit_write_group(). Out of
2625
2436
            date hints are simply ignored, because concurrent operations
2626
2437
            can obsolete them rapidly.
2627
 
 
2628
 
        :param clean_obsolete_packs: Clean obsolete packs immediately after
2629
 
            the pack operation.
2630
2438
        """
2631
2439
 
2632
2440
    def get_transaction(self):
2648
2456
        for ((revision_id,), parent_keys) in \
2649
2457
                self.revisions.get_parent_map(query_keys).iteritems():
2650
2458
            if parent_keys:
2651
 
                result[revision_id] = tuple([parent_revid
2652
 
                    for (parent_revid,) in parent_keys])
 
2459
                result[revision_id] = tuple(parent_revid
 
2460
                    for (parent_revid,) in parent_keys)
2653
2461
            else:
2654
2462
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2655
2463
        return result
2657
2465
    def _make_parents_provider(self):
2658
2466
        return self
2659
2467
 
2660
 
    @needs_read_lock
2661
 
    def get_known_graph_ancestry(self, revision_ids):
2662
 
        """Return the known graph for a set of revision ids and their ancestors.
2663
 
        """
2664
 
        st = static_tuple.StaticTuple
2665
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
2666
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
2667
 
        return graph.GraphThunkIdsToKeys(known_graph)
2668
 
 
2669
2468
    def get_graph(self, other_repository=None):
2670
2469
        """Return the graph walker for this repository format"""
2671
2470
        parents_provider = self._make_parents_provider()
2675
2474
                [parents_provider, other_repository._make_parents_provider()])
2676
2475
        return graph.Graph(parents_provider)
2677
2476
 
2678
 
    def _get_versioned_file_checker(self, text_key_references=None,
2679
 
        ancestors=None):
 
2477
    def _get_versioned_file_checker(self, text_key_references=None):
2680
2478
        """Return an object suitable for checking versioned files.
2681
2479
        
2682
2480
        :param text_key_references: if non-None, an already built
2684
2482
            to whether they were referred to by the inventory of the
2685
2483
            revision_id that they contain. If None, this will be
2686
2484
            calculated.
2687
 
        :param ancestors: Optional result from
2688
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2689
 
            available.
2690
2485
        """
2691
2486
        return _VersionedFileChecker(self,
2692
 
            text_key_references=text_key_references, ancestors=ancestors)
 
2487
            text_key_references=text_key_references)
2693
2488
 
2694
2489
    def revision_ids_to_search_result(self, result_set):
2695
2490
        """Convert a set of revision ids to a graph SearchResult."""
2745
2540
        return record.get_bytes_as('fulltext')
2746
2541
 
2747
2542
    @needs_read_lock
2748
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
2543
    def check(self, revision_ids=None):
2749
2544
        """Check consistency of all history of given revision_ids.
2750
2545
 
2751
2546
        Different repository implementations should override _check().
2752
2547
 
2753
2548
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2754
2549
             will be checked.  Typically the last revision_id of a branch.
2755
 
        :param callback_refs: A dict of check-refs to resolve and callback
2756
 
            the check/_check method on the items listed as wanting the ref.
2757
 
            see bzrlib.check.
2758
 
        :param check_repo: If False do not check the repository contents, just 
2759
 
            calculate the data callback_refs requires and call them back.
2760
2550
        """
2761
 
        return self._check(revision_ids, callback_refs=callback_refs,
2762
 
            check_repo=check_repo)
 
2551
        return self._check(revision_ids)
2763
2552
 
2764
 
    def _check(self, revision_ids, callback_refs, check_repo):
2765
 
        result = check.Check(self, check_repo=check_repo)
2766
 
        result.check(callback_refs)
 
2553
    def _check(self, revision_ids):
 
2554
        result = check.Check(self)
 
2555
        result.check()
2767
2556
        return result
2768
2557
 
2769
 
    def _warn_if_deprecated(self, branch=None):
 
2558
    def _warn_if_deprecated(self):
2770
2559
        global _deprecation_warning_done
2771
2560
        if _deprecation_warning_done:
2772
2561
            return
2773
 
        try:
2774
 
            if branch is None:
2775
 
                conf = config.GlobalConfig()
2776
 
            else:
2777
 
                conf = branch.get_config()
2778
 
            if conf.suppress_warning('format_deprecation'):
2779
 
                return
2780
 
            warning("Format %s for %s is deprecated -"
2781
 
                    " please use 'bzr upgrade' to get better performance"
2782
 
                    % (self._format, self.bzrdir.transport.base))
2783
 
        finally:
2784
 
            _deprecation_warning_done = True
 
2562
        _deprecation_warning_done = True
 
2563
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
2564
                % (self._format, self.bzrdir.transport.base))
2785
2565
 
2786
2566
    def supports_rich_root(self):
2787
2567
        return self._format.rich_root_data
3068
2848
    # help), and for fetching when data won't have come from the same
3069
2849
    # compressor.
3070
2850
    pack_compresses = False
3071
 
    # Does the repository inventory storage understand references to trees?
3072
 
    supports_tree_reference = None
3073
 
    # Is the format experimental ?
3074
 
    experimental = False
3075
2851
 
3076
 
    def __repr__(self):
3077
 
        return "%s()" % self.__class__.__name__
 
2852
    def __str__(self):
 
2853
        return "<%s>" % self.__class__.__name__
3078
2854
 
3079
2855
    def __eq__(self, other):
3080
2856
        # format objects are generally stateless
3093
2869
        """
3094
2870
        try:
3095
2871
            transport = a_bzrdir.get_repository_transport(None)
3096
 
            format_string = transport.get_bytes("format")
 
2872
            format_string = transport.get("format").read()
3097
2873
            return format_registry.get(format_string)
3098
2874
        except errors.NoSuchFile:
3099
2875
            raise errors.NoRepositoryPresent(a_bzrdir)
3181
2957
        raise NotImplementedError(self.network_name)
3182
2958
 
3183
2959
    def check_conversion_target(self, target_format):
3184
 
        if self.rich_root_data and not target_format.rich_root_data:
3185
 
            raise errors.BadConversionTarget(
3186
 
                'Does not support rich root data.', target_format,
3187
 
                from_format=self)
3188
 
        if (self.supports_tree_reference and 
3189
 
            not getattr(target_format, 'supports_tree_reference', False)):
3190
 
            raise errors.BadConversionTarget(
3191
 
                'Does not support nested trees', target_format,
3192
 
                from_format=self)
 
2960
        raise NotImplementedError(self.check_conversion_target)
3193
2961
 
3194
2962
    def open(self, a_bzrdir, _found=False):
3195
2963
        """Return an instance of this format for the bzrdir a_bzrdir.
3198
2966
        """
3199
2967
        raise NotImplementedError(self.open)
3200
2968
 
3201
 
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
3202
 
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
3203
 
        hooks = BzrDir.hooks['post_repo_init']
3204
 
        if not hooks:
3205
 
            return
3206
 
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
3207
 
        for hook in hooks:
3208
 
            hook(params)
3209
 
 
3210
2969
 
3211
2970
class MetaDirRepositoryFormat(RepositoryFormat):
3212
2971
    """Common base class for the new repositories using the metadir layout."""
3417
3176
 
3418
3177
        :param revision_id: if None all content is copied, if NULL_REVISION no
3419
3178
                            content is copied.
3420
 
        :param pb: ignored.
 
3179
        :param pb: optional progress bar to use for progress reports. If not
 
3180
                   provided a default one will be created.
3421
3181
        :return: None.
3422
3182
        """
3423
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3424
3183
        from bzrlib.fetch import RepoFetcher
3425
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
3426
 
        if self.source._format.network_name() != self.target._format.network_name():
3427
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
3428
 
                from_format=self.source._format,
3429
 
                to_format=self.target._format)
3430
3184
        f = RepoFetcher(to_repository=self.target,
3431
3185
                               from_repository=self.source,
3432
3186
                               last_revision=revision_id,
3433
3187
                               fetch_spec=fetch_spec,
3434
 
                               find_ghosts=find_ghosts)
 
3188
                               pb=pb, find_ghosts=find_ghosts)
3435
3189
 
3436
3190
    def _walk_to_common_revisions(self, revision_ids):
3437
3191
        """Walk out from revision_ids in source to revisions target has.
3606
3360
                self.target.texts.insert_record_stream(
3607
3361
                    self.source.texts.get_record_stream(
3608
3362
                        self.source.texts.keys(), 'topological', False))
3609
 
                pb.update('Copying inventory', 0, 1)
 
3363
                pb.update('copying inventory', 0, 1)
3610
3364
                self.target.inventories.insert_record_stream(
3611
3365
                    self.source.inventories.get_record_stream(
3612
3366
                        self.source.inventories.keys(), 'topological', False))
3738
3492
        # This is redundant with format.check_conversion_target(), however that
3739
3493
        # raises an exception, and we just want to say "False" as in we won't
3740
3494
        # support converting between these formats.
3741
 
        if 'IDS_never' in debug.debug_flags:
3742
 
            return False
3743
3495
        if source.supports_rich_root() and not target.supports_rich_root():
3744
3496
            return False
3745
3497
        if (source._format.supports_tree_reference
3746
3498
            and not target._format.supports_tree_reference):
3747
3499
            return False
3748
 
        if target._fallback_repositories and target._format.supports_chks:
3749
 
            # IDS doesn't know how to copy CHKs for the parent inventories it
3750
 
            # adds to stacked repos.
3751
 
            return False
3752
 
        if 'IDS_always' in debug.debug_flags:
3753
 
            return True
3754
 
        # Only use this code path for local source and target.  IDS does far
3755
 
        # too much IO (both bandwidth and roundtrips) over a network.
3756
 
        if not source.bzrdir.transport.base.startswith('file:///'):
3757
 
            return False
3758
 
        if not target.bzrdir.transport.base.startswith('file:///'):
3759
 
            return False
3760
3500
        return True
3761
3501
 
3762
 
    def _get_trees(self, revision_ids, cache):
3763
 
        possible_trees = []
3764
 
        for rev_id in revision_ids:
3765
 
            if rev_id in cache:
3766
 
                possible_trees.append((rev_id, cache[rev_id]))
3767
 
            else:
3768
 
                # Not cached, but inventory might be present anyway.
3769
 
                try:
3770
 
                    tree = self.source.revision_tree(rev_id)
3771
 
                except errors.NoSuchRevision:
3772
 
                    # Nope, parent is ghost.
3773
 
                    pass
3774
 
                else:
3775
 
                    cache[rev_id] = tree
3776
 
                    possible_trees.append((rev_id, tree))
3777
 
        return possible_trees
3778
 
 
3779
 
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
 
3502
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
3780
3503
        """Get the best delta and base for this revision.
3781
3504
 
3782
3505
        :return: (basis_id, delta)
3783
3506
        """
 
3507
        possible_trees = [(parent_id, cache[parent_id])
 
3508
                          for parent_id in parent_ids
 
3509
                           if parent_id in cache]
 
3510
        if len(possible_trees) == 0:
 
3511
            # There either aren't any parents, or the parents aren't in the
 
3512
            # cache, so just use the last converted tree
 
3513
            possible_trees.append((basis_id, cache[basis_id]))
3784
3514
        deltas = []
3785
 
        # Generate deltas against each tree, to find the shortest.
3786
 
        texts_possibly_new_in_tree = set()
3787
3515
        for basis_id, basis_tree in possible_trees:
3788
3516
            delta = tree.inventory._make_delta(basis_tree.inventory)
3789
 
            for old_path, new_path, file_id, new_entry in delta:
3790
 
                if new_path is None:
3791
 
                    # This file_id isn't present in the new rev, so we don't
3792
 
                    # care about it.
3793
 
                    continue
3794
 
                if not new_path:
3795
 
                    # Rich roots are handled elsewhere...
3796
 
                    continue
3797
 
                kind = new_entry.kind
3798
 
                if kind != 'directory' and kind != 'file':
3799
 
                    # No text record associated with this inventory entry.
3800
 
                    continue
3801
 
                # This is a directory or file that has changed somehow.
3802
 
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3803
3517
            deltas.append((len(delta), basis_id, delta))
3804
3518
        deltas.sort()
3805
3519
        return deltas[0][1:]
3806
3520
 
3807
 
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
3808
 
        """Find all parent revisions that are absent, but for which the
3809
 
        inventory is present, and copy those inventories.
3810
 
 
3811
 
        This is necessary to preserve correctness when the source is stacked
3812
 
        without fallbacks configured.  (Note that in cases like upgrade the
3813
 
        source may be not have _fallback_repositories even though it is
3814
 
        stacked.)
3815
 
        """
3816
 
        parent_revs = set()
3817
 
        for parents in parent_map.values():
3818
 
            parent_revs.update(parents)
3819
 
        present_parents = self.source.get_parent_map(parent_revs)
3820
 
        absent_parents = set(parent_revs).difference(present_parents)
3821
 
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
3822
 
            (rev_id,) for rev_id in absent_parents)
3823
 
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
3824
 
        for parent_tree in self.source.revision_trees(parent_inv_ids):
3825
 
            current_revision_id = parent_tree.get_revision_id()
3826
 
            parents_parents_keys = parent_invs_keys_for_stacking[
3827
 
                (current_revision_id,)]
3828
 
            parents_parents = [key[-1] for key in parents_parents_keys]
3829
 
            basis_id = _mod_revision.NULL_REVISION
3830
 
            basis_tree = self.source.revision_tree(basis_id)
3831
 
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
3832
 
            self.target.add_inventory_by_delta(
3833
 
                basis_id, delta, current_revision_id, parents_parents)
3834
 
            cache[current_revision_id] = parent_tree
3835
 
 
3836
 
    def _fetch_batch(self, revision_ids, basis_id, cache, a_graph=None):
 
3521
    def _get_parent_keys(self, root_key, parent_map):
 
3522
        """Get the parent keys for a given root id."""
 
3523
        root_id, rev_id = root_key
 
3524
        # Include direct parents of the revision, but only if they used
 
3525
        # the same root_id and are heads.
 
3526
        parent_keys = []
 
3527
        for parent_id in parent_map[rev_id]:
 
3528
            if parent_id == _mod_revision.NULL_REVISION:
 
3529
                continue
 
3530
            if parent_id not in self._revision_id_to_root_id:
 
3531
                # We probably didn't read this revision, go spend the
 
3532
                # extra effort to actually check
 
3533
                try:
 
3534
                    tree = self.source.revision_tree(parent_id)
 
3535
                except errors.NoSuchRevision:
 
3536
                    # Ghost, fill out _revision_id_to_root_id in case we
 
3537
                    # encounter this again.
 
3538
                    # But set parent_root_id to None since we don't really know
 
3539
                    parent_root_id = None
 
3540
                else:
 
3541
                    parent_root_id = tree.get_root_id()
 
3542
                self._revision_id_to_root_id[parent_id] = None
 
3543
            else:
 
3544
                parent_root_id = self._revision_id_to_root_id[parent_id]
 
3545
            if root_id == parent_root_id:
 
3546
                # With stacking we _might_ want to refer to a non-local
 
3547
                # revision, but this code path only applies when we have the
 
3548
                # full content available, so ghosts really are ghosts, not just
 
3549
                # the edge of local data.
 
3550
                parent_keys.append((parent_id,))
 
3551
            else:
 
3552
                # root_id may be in the parent anyway.
 
3553
                try:
 
3554
                    tree = self.source.revision_tree(parent_id)
 
3555
                except errors.NoSuchRevision:
 
3556
                    # ghost, can't refer to it.
 
3557
                    pass
 
3558
                else:
 
3559
                    try:
 
3560
                        parent_keys.append((tree.inventory[root_id].revision,))
 
3561
                    except errors.NoSuchId:
 
3562
                        # not in the tree
 
3563
                        pass
 
3564
        g = graph.Graph(self.source.revisions)
 
3565
        heads = g.heads(parent_keys)
 
3566
        selected_keys = []
 
3567
        for key in parent_keys:
 
3568
            if key in heads and key not in selected_keys:
 
3569
                selected_keys.append(key)
 
3570
        return tuple([(root_id,)+ key for key in selected_keys])
 
3571
 
 
3572
    def _new_root_data_stream(self, root_keys_to_create, parent_map):
 
3573
        for root_key in root_keys_to_create:
 
3574
            parent_keys = self._get_parent_keys(root_key, parent_map)
 
3575
            yield versionedfile.FulltextContentFactory(root_key,
 
3576
                parent_keys, None, '')
 
3577
 
 
3578
    def _fetch_batch(self, revision_ids, basis_id, cache):
3837
3579
        """Fetch across a few revisions.
3838
3580
 
3839
3581
        :param revision_ids: The revisions to copy
3840
3582
        :param basis_id: The revision_id of a tree that must be in cache, used
3841
3583
            as a basis for delta when no other base is available
3842
3584
        :param cache: A cache of RevisionTrees that we can use.
3843
 
        :param a_graph: A Graph object to determine the heads() of the
3844
 
            rich-root data stream.
3845
3585
        :return: The revision_id of the last converted tree. The RevisionTree
3846
3586
            for it will be in cache
3847
3587
        """
3853
3593
        pending_deltas = []
3854
3594
        pending_revisions = []
3855
3595
        parent_map = self.source.get_parent_map(revision_ids)
3856
 
        self._fetch_parent_invs_for_stacking(parent_map, cache)
3857
 
        self.source._safe_to_return_from_cache = True
3858
3596
        for tree in self.source.revision_trees(revision_ids):
3859
 
            # Find a inventory delta for this revision.
3860
 
            # Find text entries that need to be copied, too.
3861
3597
            current_revision_id = tree.get_revision_id()
3862
3598
            parent_ids = parent_map.get(current_revision_id, ())
3863
 
            parent_trees = self._get_trees(parent_ids, cache)
3864
 
            possible_trees = list(parent_trees)
3865
 
            if len(possible_trees) == 0:
3866
 
                # There either aren't any parents, or the parents are ghosts,
3867
 
                # so just use the last converted tree.
3868
 
                possible_trees.append((basis_id, cache[basis_id]))
3869
3599
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3870
 
                                                           possible_trees)
3871
 
            revision = self.source.get_revision(current_revision_id)
3872
 
            pending_deltas.append((basis_id, delta,
3873
 
                current_revision_id, revision.parent_ids))
 
3600
                                                           basis_id, cache)
3874
3601
            if self._converting_to_rich_root:
3875
3602
                self._revision_id_to_root_id[current_revision_id] = \
3876
3603
                    tree.get_root_id()
3877
 
            # Determine which texts are in present in this revision but not in
3878
 
            # any of the available parents.
3879
 
            texts_possibly_new_in_tree = set()
 
3604
            # Find text entries that need to be copied
3880
3605
            for old_path, new_path, file_id, entry in delta:
3881
 
                if new_path is None:
3882
 
                    # This file_id isn't present in the new rev
3883
 
                    continue
3884
 
                if not new_path:
3885
 
                    # This is the root
3886
 
                    if not self.target.supports_rich_root():
3887
 
                        # The target doesn't support rich root, so we don't
3888
 
                        # copy
3889
 
                        continue
3890
 
                    if self._converting_to_rich_root:
3891
 
                        # This can't be copied normally, we have to insert
3892
 
                        # it specially
3893
 
                        root_keys_to_create.add((file_id, entry.revision))
3894
 
                        continue
3895
 
                kind = entry.kind
3896
 
                texts_possibly_new_in_tree.add((file_id, entry.revision))
3897
 
            for basis_id, basis_tree in possible_trees:
3898
 
                basis_inv = basis_tree.inventory
3899
 
                for file_key in list(texts_possibly_new_in_tree):
3900
 
                    file_id, file_revision = file_key
3901
 
                    try:
3902
 
                        entry = basis_inv[file_id]
3903
 
                    except errors.NoSuchId:
3904
 
                        continue
3905
 
                    if entry.revision == file_revision:
3906
 
                        texts_possibly_new_in_tree.remove(file_key)
3907
 
            text_keys.update(texts_possibly_new_in_tree)
 
3606
                if new_path is not None:
 
3607
                    if not new_path:
 
3608
                        # This is the root
 
3609
                        if not self.target.supports_rich_root():
 
3610
                            # The target doesn't support rich root, so we don't
 
3611
                            # copy
 
3612
                            continue
 
3613
                        if self._converting_to_rich_root:
 
3614
                            # This can't be copied normally, we have to insert
 
3615
                            # it specially
 
3616
                            root_keys_to_create.add((file_id, entry.revision))
 
3617
                            continue
 
3618
                    text_keys.add((file_id, entry.revision))
 
3619
            revision = self.source.get_revision(current_revision_id)
 
3620
            pending_deltas.append((basis_id, delta,
 
3621
                current_revision_id, revision.parent_ids))
3908
3622
            pending_revisions.append(revision)
3909
3623
            cache[current_revision_id] = tree
3910
3624
            basis_id = current_revision_id
3911
 
        self.source._safe_to_return_from_cache = False
3912
3625
        # Copy file texts
3913
3626
        from_texts = self.source.texts
3914
3627
        to_texts = self.target.texts
3915
3628
        if root_keys_to_create:
3916
 
            root_stream = _mod_fetch._new_root_data_stream(
3917
 
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
3918
 
                self.source, graph=a_graph)
 
3629
            root_stream = self._new_root_data_stream(root_keys_to_create,
 
3630
                                                     parent_map)
3919
3631
            to_texts.insert_record_stream(root_stream)
3920
3632
        to_texts.insert_record_stream(from_texts.get_record_stream(
3921
3633
            text_keys, self.target._format._fetch_order,
3928
3640
            # for the new revisions that we are about to insert.  We do this
3929
3641
            # before adding the revisions so that no revision is added until
3930
3642
            # all the inventories it may depend on are added.
3931
 
            # Note that this is overzealous, as we may have fetched these in an
3932
 
            # earlier batch.
3933
3643
            parent_ids = set()
3934
3644
            revision_ids = set()
3935
3645
            for revision in pending_revisions:
3938
3648
            parent_ids.difference_update(revision_ids)
3939
3649
            parent_ids.discard(_mod_revision.NULL_REVISION)
3940
3650
            parent_map = self.source.get_parent_map(parent_ids)
3941
 
            # we iterate over parent_map and not parent_ids because we don't
3942
 
            # want to try copying any revision which is a ghost
3943
 
            for parent_tree in self.source.revision_trees(parent_map):
 
3651
            for parent_tree in self.source.revision_trees(parent_ids):
 
3652
                basis_id, delta = self._get_delta_for_revision(tree, parent_ids, basis_id, cache)
3944
3653
                current_revision_id = parent_tree.get_revision_id()
3945
3654
                parents_parents = parent_map[current_revision_id]
3946
 
                possible_trees = self._get_trees(parents_parents, cache)
3947
 
                if len(possible_trees) == 0:
3948
 
                    # There either aren't any parents, or the parents are
3949
 
                    # ghosts, so just use the last converted tree.
3950
 
                    possible_trees.append((basis_id, cache[basis_id]))
3951
 
                basis_id, delta = self._get_delta_for_revision(parent_tree,
3952
 
                    parents_parents, possible_trees)
3953
3655
                self.target.add_inventory_by_delta(
3954
3656
                    basis_id, delta, current_revision_id, parents_parents)
3955
3657
        # insert signatures and revisions
3969
3671
 
3970
3672
        :param revision_ids: The list of revisions to fetch. Must be in
3971
3673
            topological order.
3972
 
        :param pb: A ProgressTask
 
3674
        :param pb: A ProgressBar
3973
3675
        :return: None
3974
3676
        """
3975
3677
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3978
3680
        cache[basis_id] = basis_tree
3979
3681
        del basis_tree # We don't want to hang on to it here
3980
3682
        hints = []
3981
 
        if self._converting_to_rich_root and len(revision_ids) > 100:
3982
 
            a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
3983
 
                                                            revision_ids)
3984
 
        else:
3985
 
            a_graph = None
3986
 
 
3987
3683
        for offset in range(0, len(revision_ids), batch_size):
3988
3684
            self.target.start_write_group()
3989
3685
            try:
3990
3686
                pb.update('Transferring revisions', offset,
3991
3687
                          len(revision_ids))
3992
3688
                batch = revision_ids[offset:offset+batch_size]
3993
 
                basis_id = self._fetch_batch(batch, basis_id, cache,
3994
 
                                             a_graph=a_graph)
 
3689
                basis_id = self._fetch_batch(batch, basis_id, cache)
3995
3690
            except:
3996
 
                self.source._safe_to_return_from_cache = False
3997
3691
                self.target.abort_write_group()
3998
3692
                raise
3999
3693
            else:
4011
3705
        """See InterRepository.fetch()."""
4012
3706
        if fetch_spec is not None:
4013
3707
            raise AssertionError("Not implemented yet...")
4014
 
        ui.ui_factory.warn_experimental_format_fetch(self)
4015
3708
        if (not self.source.supports_rich_root()
4016
3709
            and self.target.supports_rich_root()):
4017
3710
            self._converting_to_rich_root = True
4018
3711
            self._revision_id_to_root_id = {}
4019
3712
        else:
4020
3713
            self._converting_to_rich_root = False
4021
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
4022
 
        if self.source._format.network_name() != self.target._format.network_name():
4023
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
4024
 
                from_format=self.source._format,
4025
 
                to_format=self.target._format)
4026
3714
        revision_ids = self.target.search_missing_revision_ids(self.source,
4027
3715
            revision_id, find_ghosts=find_ghosts).get_keys()
4028
3716
        if not revision_ids:
4034
3722
        # Walk though all revisions; get inventory deltas, copy referenced
4035
3723
        # texts that delta references, insert the delta, revision and
4036
3724
        # signature.
 
3725
        first_rev = self.source.get_revision(revision_ids[0])
4037
3726
        if pb is None:
4038
3727
            my_pb = ui.ui_factory.nested_progress_bar()
4039
3728
            pb = my_pb
4097
3786
        :param to_convert: The disk object to convert.
4098
3787
        :param pb: a progress bar to use for progress information.
4099
3788
        """
4100
 
        pb = ui.ui_factory.nested_progress_bar()
 
3789
        self.pb = pb
4101
3790
        self.count = 0
4102
3791
        self.total = 4
4103
3792
        # this is only useful with metadir layouts - separated repo content.
4104
3793
        # trigger an assertion if not such
4105
3794
        repo._format.get_format_string()
4106
3795
        self.repo_dir = repo.bzrdir
4107
 
        pb.update('Moving repository to repository.backup')
 
3796
        self.step('Moving repository to repository.backup')
4108
3797
        self.repo_dir.transport.move('repository', 'repository.backup')
4109
3798
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4110
3799
        repo._format.check_conversion_target(self.target_format)
4111
3800
        self.source_repo = repo._format.open(self.repo_dir,
4112
3801
            _found=True,
4113
3802
            _override_transport=backup_transport)
4114
 
        pb.update('Creating new repository')
 
3803
        self.step('Creating new repository')
4115
3804
        converted = self.target_format.initialize(self.repo_dir,
4116
3805
                                                  self.source_repo.is_shared())
4117
3806
        converted.lock_write()
4118
3807
        try:
4119
 
            pb.update('Copying content')
 
3808
            self.step('Copying content into repository.')
4120
3809
            self.source_repo.copy_content_into(converted)
4121
3810
        finally:
4122
3811
            converted.unlock()
4123
 
        pb.update('Deleting old repository content')
 
3812
        self.step('Deleting old repository content.')
4124
3813
        self.repo_dir.transport.delete_tree('repository.backup')
4125
 
        ui.ui_factory.note('repository converted')
4126
 
        pb.finished()
 
3814
        self.pb.note('repository converted')
 
3815
 
 
3816
    def step(self, message):
 
3817
        """Update the pb by a step."""
 
3818
        self.count +=1
 
3819
        self.pb.update(message, self.count, self.total)
4127
3820
 
4128
3821
 
4129
3822
_unescape_map = {
4158
3851
 
4159
3852
class _VersionedFileChecker(object):
4160
3853
 
4161
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
3854
    def __init__(self, repository, text_key_references=None):
4162
3855
        self.repository = repository
4163
3856
        self.text_index = self.repository._generate_text_key_index(
4164
 
            text_key_references=text_key_references, ancestors=ancestors)
 
3857
            text_key_references=text_key_references)
4165
3858
 
4166
3859
    def calculate_file_version_parents(self, text_key):
4167
3860
        """Calculate the correct parents for a file version according to
4185
3878
            revision_id) tuples for versions that are present in this versioned
4186
3879
            file, but not used by the corresponding inventory.
4187
3880
        """
4188
 
        local_progress = None
4189
 
        if progress_bar is None:
4190
 
            local_progress = ui.ui_factory.nested_progress_bar()
4191
 
            progress_bar = local_progress
4192
 
        try:
4193
 
            return self._check_file_version_parents(texts, progress_bar)
4194
 
        finally:
4195
 
            if local_progress:
4196
 
                local_progress.finished()
4197
 
 
4198
 
    def _check_file_version_parents(self, texts, progress_bar):
4199
 
        """See check_file_version_parents."""
4200
3881
        wrong_parents = {}
4201
3882
        self.file_ids = set([file_id for file_id, _ in
4202
3883
            self.text_index.iterkeys()])
4203
3884
        # text keys is now grouped by file_id
 
3885
        n_weaves = len(self.file_ids)
 
3886
        files_in_revisions = {}
 
3887
        revisions_of_files = {}
4204
3888
        n_versions = len(self.text_index)
4205
3889
        progress_bar.update('loading text store', 0, n_versions)
4206
3890
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4208
3892
        text_keys = self.repository.texts.keys()
4209
3893
        unused_keys = frozenset(text_keys) - set(self.text_index)
4210
3894
        for num, key in enumerate(self.text_index.iterkeys()):
4211
 
            progress_bar.update('checking text graph', num, n_versions)
 
3895
            if progress_bar is not None:
 
3896
                progress_bar.update('checking text graph', num, n_versions)
4212
3897
            correct_parents = self.calculate_file_version_parents(key)
4213
3898
            try:
4214
3899
                knit_parents = parent_map[key]
4299
3984
            else:
4300
3985
                new_pack.set_write_cache_size(1024*1024)
4301
3986
        for substream_type, substream in stream:
4302
 
            if 'stream' in debug.debug_flags:
4303
 
                mutter('inserting substream: %s', substream_type)
4304
3987
            if substream_type == 'texts':
4305
3988
                self.target_repo.texts.insert_record_stream(substream)
4306
3989
            elif substream_type == 'inventories':
4310
3993
                else:
4311
3994
                    self._extract_and_insert_inventories(
4312
3995
                        substream, src_serializer)
4313
 
            elif substream_type == 'inventory-deltas':
4314
 
                self._extract_and_insert_inventory_deltas(
4315
 
                    substream, src_serializer)
4316
3996
            elif substream_type == 'chk_bytes':
4317
3997
                # XXX: This doesn't support conversions, as it assumes the
4318
3998
                #      conversion was done in the fetch code.
4349
4029
                ):
4350
4030
                if versioned_file is None:
4351
4031
                    continue
4352
 
                # TODO: key is often going to be a StaticTuple object
4353
 
                #       I don't believe we can define a method by which
4354
 
                #       (prefix,) + StaticTuple will work, though we could
4355
 
                #       define a StaticTuple.sq_concat that would allow you to
4356
 
                #       pass in either a tuple or a StaticTuple as the second
4357
 
                #       object, so instead we could have:
4358
 
                #       StaticTuple(prefix) + key here...
4359
4032
                missing_keys.update((prefix,) + key for key in
4360
4033
                    versioned_file.get_missing_compression_parent_keys())
4361
4034
        except NotImplementedError:
4376
4049
            self.target_repo.pack(hint=hint)
4377
4050
        return [], set()
4378
4051
 
4379
 
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
4380
 
        target_rich_root = self.target_repo._format.rich_root_data
4381
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4382
 
        for record in substream:
4383
 
            # Insert the delta directly
4384
 
            inventory_delta_bytes = record.get_bytes_as('fulltext')
4385
 
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
4386
 
            try:
4387
 
                parse_result = deserialiser.parse_text_bytes(
4388
 
                    inventory_delta_bytes)
4389
 
            except inventory_delta.IncompatibleInventoryDelta, err:
4390
 
                trace.mutter("Incompatible delta: %s", err.msg)
4391
 
                raise errors.IncompatibleRevision(self.target_repo._format)
4392
 
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
4393
 
            revision_id = new_id
4394
 
            parents = [key[0] for key in record.parents]
4395
 
            self.target_repo.add_inventory_by_delta(
4396
 
                basis_id, inv_delta, revision_id, parents)
4397
 
 
4398
 
    def _extract_and_insert_inventories(self, substream, serializer,
4399
 
            parse_delta=None):
 
4052
    def _extract_and_insert_inventories(self, substream, serializer):
4400
4053
        """Generate a new inventory versionedfile in target, converting data.
4401
4054
 
4402
4055
        The inventory is retrieved from the source, (deserializing it), and
4403
4056
        stored in the target (reserializing it in a different format).
4404
4057
        """
4405
 
        target_rich_root = self.target_repo._format.rich_root_data
4406
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4407
4058
        for record in substream:
4408
 
            # It's not a delta, so it must be a fulltext in the source
4409
 
            # serializer's format.
4410
4059
            bytes = record.get_bytes_as('fulltext')
4411
4060
            revision_id = record.key[0]
4412
4061
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4413
4062
            parents = [key[0] for key in record.parents]
4414
4063
            self.target_repo.add_inventory(revision_id, inv, parents)
4415
 
            # No need to keep holding this full inv in memory when the rest of
4416
 
            # the substream is likely to be all deltas.
4417
 
            del inv
4418
4064
 
4419
4065
    def _extract_and_insert_revisions(self, substream, serializer):
4420
4066
        for record in substream:
4469
4115
        return [('signatures', signatures), ('revisions', revisions)]
4470
4116
 
4471
4117
    def _generate_root_texts(self, revs):
4472
 
        """This will be called by get_stream between fetching weave texts and
 
4118
        """This will be called by __fetch between fetching weave texts and
4473
4119
        fetching the inventory weave.
 
4120
 
 
4121
        Subclasses should override this if they need to generate root texts
 
4122
        after fetching weave texts.
4474
4123
        """
4475
4124
        if self._rich_root_upgrade():
4476
 
            return _mod_fetch.Inter1and2Helper(
 
4125
            import bzrlib.fetch
 
4126
            return bzrlib.fetch.Inter1and2Helper(
4477
4127
                self.from_repository).generate_root_texts(revs)
4478
4128
        else:
4479
4129
            return []
4482
4132
        phase = 'file'
4483
4133
        revs = search.get_keys()
4484
4134
        graph = self.from_repository.get_graph()
4485
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
 
4135
        revs = list(graph.iter_topo_order(revs))
4486
4136
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4487
4137
        text_keys = []
4488
4138
        for knit_kind, file_id, revisions in data_to_fetch:
4507
4157
                # will be valid.
4508
4158
                for _ in self._generate_root_texts(revs):
4509
4159
                    yield _
 
4160
                # NB: This currently reopens the inventory weave in source;
 
4161
                # using a single stream interface instead would avoid this.
 
4162
                from_weave = self.from_repository.inventories
4510
4163
                # we fetch only the referenced inventories because we do not
4511
4164
                # know for unselected inventories whether all their required
4512
4165
                # texts are present in the other repository - it could be
4551
4204
            if not keys:
4552
4205
                # No need to stream something we don't have
4553
4206
                continue
4554
 
            if substream_kind == 'inventories':
4555
 
                # Some missing keys are genuinely ghosts, filter those out.
4556
 
                present = self.from_repository.inventories.get_parent_map(keys)
4557
 
                revs = [key[0] for key in present]
4558
 
                # Get the inventory stream more-or-less as we do for the
4559
 
                # original stream; there's no reason to assume that records
4560
 
                # direct from the source will be suitable for the sink.  (Think
4561
 
                # e.g. 2a -> 1.9-rich-root).
4562
 
                for info in self._get_inventory_stream(revs, missing=True):
4563
 
                    yield info
4564
 
                continue
4565
 
 
4566
4207
            # Ask for full texts always so that we don't need more round trips
4567
4208
            # after this stream.
4568
4209
            # Some of the missing keys are genuinely ghosts, so filter absent
4583
4224
        return (not self.from_repository._format.rich_root_data and
4584
4225
            self.to_format.rich_root_data)
4585
4226
 
4586
 
    def _get_inventory_stream(self, revision_ids, missing=False):
 
4227
    def _get_inventory_stream(self, revision_ids):
4587
4228
        from_format = self.from_repository._format
4588
 
        if (from_format.supports_chks and self.to_format.supports_chks and
4589
 
            from_format.network_name() == self.to_format.network_name()):
4590
 
            raise AssertionError(
4591
 
                "this case should be handled by GroupCHKStreamSource")
4592
 
        elif 'forceinvdeltas' in debug.debug_flags:
4593
 
            return self._get_convertable_inventory_stream(revision_ids,
4594
 
                    delta_versus_null=missing)
4595
 
        elif from_format.network_name() == self.to_format.network_name():
4596
 
            # Same format.
4597
 
            return self._get_simple_inventory_stream(revision_ids,
4598
 
                    missing=missing)
4599
 
        elif (not from_format.supports_chks and not self.to_format.supports_chks
4600
 
                and from_format._serializer == self.to_format._serializer):
4601
 
            # Essentially the same format.
4602
 
            return self._get_simple_inventory_stream(revision_ids,
4603
 
                    missing=missing)
 
4229
        if (from_format.supports_chks and self.to_format.supports_chks
 
4230
            and (from_format._serializer == self.to_format._serializer)):
 
4231
            # Both sides support chks, and they use the same serializer, so it
 
4232
            # is safe to transmit the chk pages and inventory pages across
 
4233
            # as-is.
 
4234
            return self._get_chk_inventory_stream(revision_ids)
 
4235
        elif (not from_format.supports_chks):
 
4236
            # Source repository doesn't support chks. So we can transmit the
 
4237
            # inventories 'as-is' and either they are just accepted on the
 
4238
            # target, or the Sink will properly convert it.
 
4239
            return self._get_simple_inventory_stream(revision_ids)
4604
4240
        else:
4605
 
            # Any time we switch serializations, we want to use an
4606
 
            # inventory-delta based approach.
4607
 
            return self._get_convertable_inventory_stream(revision_ids,
4608
 
                    delta_versus_null=missing)
 
4241
            # XXX: Hack to make not-chk->chk fetch: copy the inventories as
 
4242
            #      inventories. Note that this should probably be done somehow
 
4243
            #      as part of bzrlib.repository.StreamSink. Except JAM couldn't
 
4244
            #      figure out how a non-chk repository could possibly handle
 
4245
            #      deserializing an inventory stream from a chk repo, as it
 
4246
            #      doesn't have a way to understand individual pages.
 
4247
            return self._get_convertable_inventory_stream(revision_ids)
4609
4248
 
4610
 
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
4611
 
        # NB: This currently reopens the inventory weave in source;
4612
 
        # using a single stream interface instead would avoid this.
 
4249
    def _get_simple_inventory_stream(self, revision_ids):
4613
4250
        from_weave = self.from_repository.inventories
4614
 
        if missing:
4615
 
            delta_closure = True
4616
 
        else:
4617
 
            delta_closure = not self.delta_on_metadata()
4618
4251
        yield ('inventories', from_weave.get_record_stream(
4619
4252
            [(rev_id,) for rev_id in revision_ids],
4620
 
            self.inventory_fetch_order(), delta_closure))
4621
 
 
4622
 
    def _get_convertable_inventory_stream(self, revision_ids,
4623
 
                                          delta_versus_null=False):
4624
 
        # The two formats are sufficiently different that there is no fast
4625
 
        # path, so we need to send just inventorydeltas, which any
4626
 
        # sufficiently modern client can insert into any repository.
4627
 
        # The StreamSink code expects to be able to
4628
 
        # convert on the target, so we need to put bytes-on-the-wire that can
4629
 
        # be converted.  That means inventory deltas (if the remote is <1.19,
4630
 
        # RemoteStreamSink will fallback to VFS to insert the deltas).
4631
 
        yield ('inventory-deltas',
4632
 
           self._stream_invs_as_deltas(revision_ids,
4633
 
                                       delta_versus_null=delta_versus_null))
4634
 
 
4635
 
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
4636
 
        """Return a stream of inventory-deltas for the given rev ids.
4637
 
 
4638
 
        :param revision_ids: The list of inventories to transmit
4639
 
        :param delta_versus_null: Don't try to find a minimal delta for this
4640
 
            entry, instead compute the delta versus the NULL_REVISION. This
4641
 
            effectively streams a complete inventory. Used for stuff like
4642
 
            filling in missing parents, etc.
4643
 
        """
 
4253
            self.inventory_fetch_order(),
 
4254
            not self.delta_on_metadata()))
 
4255
 
 
4256
    def _get_chk_inventory_stream(self, revision_ids):
 
4257
        """Fetch the inventory texts, along with the associated chk maps."""
 
4258
        # We want an inventory outside of the search set, so that we can filter
 
4259
        # out uninteresting chk pages. For now we use
 
4260
        # _find_revision_outside_set, but if we had a Search with cut_revs, we
 
4261
        # could use that instead.
 
4262
        start_rev_id = self.from_repository._find_revision_outside_set(
 
4263
                            revision_ids)
 
4264
        start_rev_key = (start_rev_id,)
 
4265
        inv_keys_to_fetch = [(rev_id,) for rev_id in revision_ids]
 
4266
        if start_rev_id != _mod_revision.NULL_REVISION:
 
4267
            inv_keys_to_fetch.append((start_rev_id,))
 
4268
        # Any repo that supports chk_bytes must also support out-of-order
 
4269
        # insertion. At least, that is how we expect it to work
 
4270
        # We use get_record_stream instead of iter_inventories because we want
 
4271
        # to be able to insert the stream as well. We could instead fetch
 
4272
        # allowing deltas, and then iter_inventories, but we don't know whether
 
4273
        # source or target is more 'local' anway.
 
4274
        inv_stream = self.from_repository.inventories.get_record_stream(
 
4275
            inv_keys_to_fetch, 'unordered',
 
4276
            True) # We need them as full-texts so we can find their references
 
4277
        uninteresting_chk_roots = set()
 
4278
        interesting_chk_roots = set()
 
4279
        def filter_inv_stream(inv_stream):
 
4280
            for idx, record in enumerate(inv_stream):
 
4281
                ### child_pb.update('fetch inv', idx, len(inv_keys_to_fetch))
 
4282
                bytes = record.get_bytes_as('fulltext')
 
4283
                chk_inv = inventory.CHKInventory.deserialise(
 
4284
                    self.from_repository.chk_bytes, bytes, record.key)
 
4285
                if record.key == start_rev_key:
 
4286
                    uninteresting_chk_roots.add(chk_inv.id_to_entry.key())
 
4287
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4288
                    if p_id_map is not None:
 
4289
                        uninteresting_chk_roots.add(p_id_map.key())
 
4290
                else:
 
4291
                    yield record
 
4292
                    interesting_chk_roots.add(chk_inv.id_to_entry.key())
 
4293
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4294
                    if p_id_map is not None:
 
4295
                        interesting_chk_roots.add(p_id_map.key())
 
4296
        ### pb.update('fetch inventory', 0, 2)
 
4297
        yield ('inventories', filter_inv_stream(inv_stream))
 
4298
        # Now that we have worked out all of the interesting root nodes, grab
 
4299
        # all of the interesting pages and insert them
 
4300
        ### pb.update('fetch inventory', 1, 2)
 
4301
        interesting = chk_map.iter_interesting_nodes(
 
4302
            self.from_repository.chk_bytes, interesting_chk_roots,
 
4303
            uninteresting_chk_roots)
 
4304
        def to_stream_adapter():
 
4305
            """Adapt the iter_interesting_nodes result to a single stream.
 
4306
 
 
4307
            iter_interesting_nodes returns records as it processes them, along
 
4308
            with keys. However, we only want to return the records themselves.
 
4309
            """
 
4310
            for record, items in interesting:
 
4311
                if record is not None:
 
4312
                    yield record
 
4313
        # XXX: We could instead call get_record_stream(records.keys())
 
4314
        #      ATM, this will always insert the records as fulltexts, and
 
4315
        #      requires that you can hang on to records once you have gone
 
4316
        #      on to the next one. Further, it causes the target to
 
4317
        #      recompress the data. Testing shows it to be faster than
 
4318
        #      requesting the records again, though.
 
4319
        yield ('chk_bytes', to_stream_adapter())
 
4320
        ### pb.update('fetch inventory', 2, 2)
 
4321
 
 
4322
    def _get_convertable_inventory_stream(self, revision_ids):
 
4323
        # XXX: One of source or target is using chks, and they don't have
 
4324
        #      compatible serializations. The StreamSink code expects to be
 
4325
        #      able to convert on the target, so we need to put
 
4326
        #      bytes-on-the-wire that can be converted
 
4327
        yield ('inventories', self._stream_invs_as_fulltexts(revision_ids))
 
4328
 
 
4329
    def _stream_invs_as_fulltexts(self, revision_ids):
4644
4330
        from_repo = self.from_repository
 
4331
        from_serializer = from_repo._format._serializer
4645
4332
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4646
4333
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
4647
 
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
4648
 
        # method...
4649
 
        inventories = self.from_repository.iter_inventories(
4650
 
            revision_ids, 'topological')
4651
 
        format = from_repo._format
4652
 
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
4653
 
        inventory_cache = lru_cache.LRUCache(50)
4654
 
        null_inventory = from_repo.revision_tree(
4655
 
            _mod_revision.NULL_REVISION).inventory
4656
 
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
4657
 
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
4658
 
        # repo back into a non-rich-root repo ought to be allowed)
4659
 
        serializer = inventory_delta.InventoryDeltaSerializer(
4660
 
            versioned_root=format.rich_root_data,
4661
 
            tree_references=format.supports_tree_reference)
4662
 
        for inv in inventories:
 
4334
        for inv in self.from_repository.iter_inventories(revision_ids):
 
4335
            # XXX: This is a bit hackish, but it works. Basically,
 
4336
            #      CHKSerializer 'accidentally' supports
 
4337
            #      read/write_inventory_to_string, even though that is never
 
4338
            #      the format that is stored on disk. It *does* give us a
 
4339
            #      single string representation for an inventory, so live with
 
4340
            #      it for now.
 
4341
            #      This would be far better if we had a 'serialized inventory
 
4342
            #      delta' form. Then we could use 'inventory._make_delta', and
 
4343
            #      transmit that. This would both be faster to generate, and
 
4344
            #      result in fewer bytes-on-the-wire.
 
4345
            as_bytes = from_serializer.write_inventory_to_string(inv)
4663
4346
            key = (inv.revision_id,)
4664
4347
            parent_keys = parent_map.get(key, ())
4665
 
            delta = None
4666
 
            if not delta_versus_null and parent_keys:
4667
 
                # The caller did not ask for complete inventories and we have
4668
 
                # some parents that we can delta against.  Make a delta against
4669
 
                # each parent so that we can find the smallest.
4670
 
                parent_ids = [parent_key[0] for parent_key in parent_keys]
4671
 
                for parent_id in parent_ids:
4672
 
                    if parent_id not in invs_sent_so_far:
4673
 
                        # We don't know that the remote side has this basis, so
4674
 
                        # we can't use it.
4675
 
                        continue
4676
 
                    if parent_id == _mod_revision.NULL_REVISION:
4677
 
                        parent_inv = null_inventory
4678
 
                    else:
4679
 
                        parent_inv = inventory_cache.get(parent_id, None)
4680
 
                        if parent_inv is None:
4681
 
                            parent_inv = from_repo.get_inventory(parent_id)
4682
 
                    candidate_delta = inv._make_delta(parent_inv)
4683
 
                    if (delta is None or
4684
 
                        len(delta) > len(candidate_delta)):
4685
 
                        delta = candidate_delta
4686
 
                        basis_id = parent_id
4687
 
            if delta is None:
4688
 
                # Either none of the parents ended up being suitable, or we
4689
 
                # were asked to delta against NULL
4690
 
                basis_id = _mod_revision.NULL_REVISION
4691
 
                delta = inv._make_delta(null_inventory)
4692
 
            invs_sent_so_far.add(inv.revision_id)
4693
 
            inventory_cache[inv.revision_id] = inv
4694
 
            delta_serialized = ''.join(
4695
 
                serializer.delta_to_lines(basis_id, key[-1], delta))
4696
4348
            yield versionedfile.FulltextContentFactory(
4697
 
                key, parent_keys, None, delta_serialized)
 
4349
                key, parent_keys, None, as_bytes)
4698
4350
 
4699
4351
 
4700
4352
def _iter_for_revno(repo, partial_history_cache, stop_index=None,