/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Ian Clatworthy
  • Date: 2009-07-13 06:58:49 UTC
  • mto: (4527.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4529.
  • Revision ID: ian.clatworthy@canonical.com-20090713065849-n7g2rsjyl6dt1mgv
Apply review feedback

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
24
24
    bzrdir,
25
25
    check,
26
26
    chk_map,
27
 
    config,
28
27
    debug,
29
 
    fetch as _mod_fetch,
 
28
    errors,
30
29
    fifo_cache,
31
30
    generate_ids,
32
31
    gpg,
33
32
    graph,
34
33
    inventory,
35
 
    inventory_delta,
36
34
    lazy_regex,
37
35
    lockable_files,
38
36
    lockdir,
39
37
    lru_cache,
40
38
    osutils,
41
39
    revision as _mod_revision,
42
 
    static_tuple,
43
40
    symbol_versioning,
44
 
    trace,
45
41
    tsort,
46
42
    ui,
47
43
    versionedfile,
52
48
from bzrlib.testament import Testament
53
49
""")
54
50
 
55
 
from bzrlib import (
56
 
    errors,
57
 
    registry,
58
 
    )
59
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
51
from bzrlib.decorators import needs_read_lock, needs_write_lock
60
52
from bzrlib.inter import InterObject
61
53
from bzrlib.inventory import (
62
54
    Inventory,
64
56
    ROOT_ID,
65
57
    entry_factory,
66
58
    )
67
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
 
59
from bzrlib import registry
68
60
from bzrlib.trace import (
69
61
    log_exception_quietly, note, mutter, mutter_callsite, warning)
70
62
 
73
65
_deprecation_warning_done = False
74
66
 
75
67
 
76
 
class IsInWriteGroupError(errors.InternalBzrError):
77
 
 
78
 
    _fmt = "May not refresh_data of repo %(repo)s while in a write group."
79
 
 
80
 
    def __init__(self, repo):
81
 
        errors.InternalBzrError.__init__(self, repo=repo)
82
 
 
83
 
 
84
68
class CommitBuilder(object):
85
69
    """Provides an interface to build up a commit.
86
70
 
220
204
            # an inventory delta was accumulated without creating a new
221
205
            # inventory.
222
206
            basis_id = self.basis_delta_revision
223
 
            # We ignore the 'inventory' returned by add_inventory_by_delta
224
 
            # because self.new_inventory is used to hint to the rest of the
225
 
            # system what code path was taken
226
 
            self.inv_sha1, _ = self.repository.add_inventory_by_delta(
 
207
            self.inv_sha1 = self.repository.add_inventory_by_delta(
227
208
                basis_id, self._basis_delta, self._new_revision_id,
228
209
                self.parents)
229
210
        else:
483
464
            if content_summary[2] is None:
484
465
                raise ValueError("Files must not have executable = None")
485
466
            if not store:
486
 
                # We can't trust a check of the file length because of content
487
 
                # filtering...
488
 
                if (# if the exec bit has changed we have to store:
 
467
                if (# if the file length changed we have to store:
 
468
                    parent_entry.text_size != content_summary[1] or
 
469
                    # if the exec bit has changed we have to store:
489
470
                    parent_entry.executable != content_summary[2]):
490
471
                    store = True
491
472
                elif parent_entry.text_sha1 == content_summary[3]:
558
539
                ie.revision = parent_entry.revision
559
540
                return self._get_delta(ie, basis_inv, path), False, None
560
541
            ie.reference_revision = content_summary[3]
561
 
            if ie.reference_revision is None:
562
 
                raise AssertionError("invalid content_summary for nested tree: %r"
563
 
                    % (content_summary,))
564
542
            self._add_text_to_weave(ie.file_id, '', heads, None)
565
543
        else:
566
544
            raise NotImplementedError('unknown kind')
828
806
                seen_root = True
829
807
        self.new_inventory = None
830
808
        if len(inv_delta):
831
 
            # This should perhaps be guarded by a check that the basis we
832
 
            # commit against is the basis for the commit and if not do a delta
833
 
            # against the basis.
834
809
            self._any_changes = True
835
810
        if not seen_root:
836
811
            # housekeeping root entry changes do not affect no-change commits.
870
845
        # versioned roots do not change unless the tree found a change.
871
846
 
872
847
 
873
 
class RepositoryWriteLockResult(LogicalLockResult):
874
 
    """The result of write locking a repository.
875
 
 
876
 
    :ivar repository_token: The token obtained from the underlying lock, or
877
 
        None.
878
 
    :ivar unlock: A callable which will unlock the lock.
879
 
    """
880
 
 
881
 
    def __init__(self, unlock, repository_token):
882
 
        LogicalLockResult.__init__(self, unlock)
883
 
        self.repository_token = repository_token
884
 
 
885
 
    def __repr__(self):
886
 
        return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
887
 
            self.unlock)
888
 
 
889
 
 
890
848
######################################################################
891
849
# Repositories
892
850
 
893
 
 
894
 
class Repository(_RelockDebugMixin, bzrdir.ControlComponent):
 
851
class Repository(object):
895
852
    """Repository holding history for one or more branches.
896
853
 
897
854
    The repository holds and retrieves historical information including
966
923
        """
967
924
        if self._write_group is not self.get_transaction():
968
925
            # has an unlock or relock occured ?
969
 
            if suppress_errors:
970
 
                mutter(
971
 
                '(suppressed) mismatched lock context and write group. %r, %r',
972
 
                self._write_group, self.get_transaction())
973
 
                return
974
926
            raise errors.BzrError(
975
927
                'mismatched lock context and write group. %r, %r' %
976
928
                (self._write_group, self.get_transaction()))
1055
1007
 
1056
1008
        :seealso: add_inventory, for the contract.
1057
1009
        """
1058
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
 
1010
        inv_lines = self._serialise_inventory_to_lines(inv)
1059
1011
        return self._inventory_add_lines(revision_id, parents,
1060
1012
            inv_lines, check_content=False)
1061
1013
 
1110
1062
        check_content=True):
1111
1063
        """Store lines in inv_vf and return the sha1 of the inventory."""
1112
1064
        parents = [(parent,) for parent in parents]
1113
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
1065
        return self.inventories.add_lines((revision_id,), parents, lines,
1114
1066
            check_content=check_content)[0]
1115
 
        self.inventories._access.flush()
1116
 
        return result
1117
1067
 
1118
1068
    def add_revision(self, revision_id, rev, inv=None, config=None):
1119
1069
        """Add rev to the revision store as revision_id.
1195
1145
        # The old API returned a list, should this actually be a set?
1196
1146
        return parent_map.keys()
1197
1147
 
1198
 
    def _check_inventories(self, checker):
1199
 
        """Check the inventories found from the revision scan.
1200
 
        
1201
 
        This is responsible for verifying the sha1 of inventories and
1202
 
        creating a pending_keys set that covers data referenced by inventories.
1203
 
        """
1204
 
        bar = ui.ui_factory.nested_progress_bar()
1205
 
        try:
1206
 
            self._do_check_inventories(checker, bar)
1207
 
        finally:
1208
 
            bar.finished()
1209
 
 
1210
 
    def _do_check_inventories(self, checker, bar):
1211
 
        """Helper for _check_inventories."""
1212
 
        revno = 0
1213
 
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
1214
 
        kinds = ['chk_bytes', 'texts']
1215
 
        count = len(checker.pending_keys)
1216
 
        bar.update("inventories", 0, 2)
1217
 
        current_keys = checker.pending_keys
1218
 
        checker.pending_keys = {}
1219
 
        # Accumulate current checks.
1220
 
        for key in current_keys:
1221
 
            if key[0] != 'inventories' and key[0] not in kinds:
1222
 
                checker._report_items.append('unknown key type %r' % (key,))
1223
 
            keys[key[0]].add(key[1:])
1224
 
        if keys['inventories']:
1225
 
            # NB: output order *should* be roughly sorted - topo or
1226
 
            # inverse topo depending on repository - either way decent
1227
 
            # to just delta against. However, pre-CHK formats didn't
1228
 
            # try to optimise inventory layout on disk. As such the
1229
 
            # pre-CHK code path does not use inventory deltas.
1230
 
            last_object = None
1231
 
            for record in self.inventories.check(keys=keys['inventories']):
1232
 
                if record.storage_kind == 'absent':
1233
 
                    checker._report_items.append(
1234
 
                        'Missing inventory {%s}' % (record.key,))
1235
 
                else:
1236
 
                    last_object = self._check_record('inventories', record,
1237
 
                        checker, last_object,
1238
 
                        current_keys[('inventories',) + record.key])
1239
 
            del keys['inventories']
1240
 
        else:
1241
 
            return
1242
 
        bar.update("texts", 1)
1243
 
        while (checker.pending_keys or keys['chk_bytes']
1244
 
            or keys['texts']):
1245
 
            # Something to check.
1246
 
            current_keys = checker.pending_keys
1247
 
            checker.pending_keys = {}
1248
 
            # Accumulate current checks.
1249
 
            for key in current_keys:
1250
 
                if key[0] not in kinds:
1251
 
                    checker._report_items.append('unknown key type %r' % (key,))
1252
 
                keys[key[0]].add(key[1:])
1253
 
            # Check the outermost kind only - inventories || chk_bytes || texts
1254
 
            for kind in kinds:
1255
 
                if keys[kind]:
1256
 
                    last_object = None
1257
 
                    for record in getattr(self, kind).check(keys=keys[kind]):
1258
 
                        if record.storage_kind == 'absent':
1259
 
                            checker._report_items.append(
1260
 
                                'Missing %s {%s}' % (kind, record.key,))
1261
 
                        else:
1262
 
                            last_object = self._check_record(kind, record,
1263
 
                                checker, last_object, current_keys[(kind,) + record.key])
1264
 
                    keys[kind] = set()
1265
 
                    break
1266
 
 
1267
 
    def _check_record(self, kind, record, checker, last_object, item_data):
1268
 
        """Check a single text from this repository."""
1269
 
        if kind == 'inventories':
1270
 
            rev_id = record.key[0]
1271
 
            inv = self._deserialise_inventory(rev_id,
1272
 
                record.get_bytes_as('fulltext'))
1273
 
            if last_object is not None:
1274
 
                delta = inv._make_delta(last_object)
1275
 
                for old_path, path, file_id, ie in delta:
1276
 
                    if ie is None:
1277
 
                        continue
1278
 
                    ie.check(checker, rev_id, inv)
1279
 
            else:
1280
 
                for path, ie in inv.iter_entries():
1281
 
                    ie.check(checker, rev_id, inv)
1282
 
            if self._format.fast_deltas:
1283
 
                return inv
1284
 
        elif kind == 'chk_bytes':
1285
 
            # No code written to check chk_bytes for this repo format.
1286
 
            checker._report_items.append(
1287
 
                'unsupported key type chk_bytes for %s' % (record.key,))
1288
 
        elif kind == 'texts':
1289
 
            self._check_text(record, checker, item_data)
1290
 
        else:
1291
 
            checker._report_items.append(
1292
 
                'unknown key type %s for %s' % (kind, record.key))
1293
 
 
1294
 
    def _check_text(self, record, checker, item_data):
1295
 
        """Check a single text."""
1296
 
        # Check it is extractable.
1297
 
        # TODO: check length.
1298
 
        if record.storage_kind == 'chunked':
1299
 
            chunks = record.get_bytes_as(record.storage_kind)
1300
 
            sha1 = osutils.sha_strings(chunks)
1301
 
            length = sum(map(len, chunks))
1302
 
        else:
1303
 
            content = record.get_bytes_as('fulltext')
1304
 
            sha1 = osutils.sha_string(content)
1305
 
            length = len(content)
1306
 
        if item_data and sha1 != item_data[1]:
1307
 
            checker._report_items.append(
1308
 
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
1309
 
                (record.key, sha1, item_data[1], item_data[2]))
1310
 
 
1311
1148
    @staticmethod
1312
1149
    def create(a_bzrdir):
1313
1150
        """Construct the current default format repository in a_bzrdir."""
1318
1155
 
1319
1156
        :param _format: The format of the repository on disk.
1320
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.
1321
1162
        """
1322
 
        # In the future we will have a single api for all stores for
1323
 
        # getting file texts, inventories and revisions, then
1324
 
        # this construct will accept instances of those things.
1325
1163
        super(Repository, self).__init__()
1326
1164
        self._format = _format
1327
1165
        # the following are part of the public API for Repository:
1333
1171
        self._reconcile_does_inventory_gc = True
1334
1172
        self._reconcile_fixes_text_parents = False
1335
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()
1336
1179
        self._write_group = None
1337
1180
        # Additional places to query for data.
1338
1181
        self._fallback_repositories = []
1339
1182
        # An InventoryEntry cache, used during deserialization
1340
1183
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
1341
 
        # Is it safe to return inventory entries directly from the entry cache,
1342
 
        # rather copying them?
1343
 
        self._safe_to_return_from_cache = False
1344
 
 
1345
 
    @property
1346
 
    def user_transport(self):
1347
 
        return self.bzrdir.user_transport
1348
 
 
1349
 
    @property
1350
 
    def control_transport(self):
1351
 
        return self._transport
1352
1184
 
1353
1185
    def __repr__(self):
1354
 
        if self._fallback_repositories:
1355
 
            return '%s(%r, fallback_repositories=%r)' % (
1356
 
                self.__class__.__name__,
1357
 
                self.base,
1358
 
                self._fallback_repositories)
1359
 
        else:
1360
 
            return '%s(%r)' % (self.__class__.__name__,
1361
 
                               self.base)
1362
 
 
1363
 
    def _has_same_fallbacks(self, other_repo):
1364
 
        """Returns true if the repositories have the same fallbacks."""
1365
 
        my_fb = self._fallback_repositories
1366
 
        other_fb = other_repo._fallback_repositories
1367
 
        if len(my_fb) != len(other_fb):
1368
 
            return False
1369
 
        for f, g in zip(my_fb, other_fb):
1370
 
            if not f.has_same_location(g):
1371
 
                return False
1372
 
        return True
 
1186
        return '%s(%r)' % (self.__class__.__name__,
 
1187
                           self.base)
1373
1188
 
1374
1189
    def has_same_location(self, other):
1375
1190
        """Returns a boolean indicating if this repository is at the same
1403
1218
        data during reads, and allows a 'write_group' to be obtained. Write
1404
1219
        groups must be used for actual data insertion.
1405
1220
 
1406
 
        A token should be passed in if you know that you have locked the object
1407
 
        some other way, and need to synchronise this object's state with that
1408
 
        fact.
1409
 
 
1410
 
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1411
 
 
1412
1221
        :param token: if this is already locked, then lock_write will fail
1413
1222
            unless the token matches the existing lock.
1414
1223
        :returns: a token if this instance supports tokens, otherwise None.
1417
1226
        :raises MismatchedToken: if the specified token doesn't match the token
1418
1227
            of the existing lock.
1419
1228
        :seealso: start_write_group.
1420
 
        :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
1421
1235
        """
1422
1236
        locked = self.is_locked()
1423
 
        token = self.control_files.lock_write(token=token)
 
1237
        result = self.control_files.lock_write(token=token)
1424
1238
        if not locked:
1425
 
            self._warn_if_deprecated()
1426
 
            self._note_lock('w')
1427
1239
            for repo in self._fallback_repositories:
1428
1240
                # Writes don't affect fallback repos
1429
1241
                repo.lock_read()
1430
1242
            self._refresh_data()
1431
 
        return RepositoryWriteLockResult(self.unlock, token)
 
1243
        return result
1432
1244
 
1433
1245
    def lock_read(self):
1434
 
        """Lock the repository for read operations.
1435
 
 
1436
 
        :return: An object with an unlock method which will release the lock
1437
 
            obtained.
1438
 
        """
1439
1246
        locked = self.is_locked()
1440
1247
        self.control_files.lock_read()
1441
1248
        if not locked:
1442
 
            self._warn_if_deprecated()
1443
 
            self._note_lock('r')
1444
1249
            for repo in self._fallback_repositories:
1445
1250
                repo.lock_read()
1446
1251
            self._refresh_data()
1447
 
        return LogicalLockResult(self.unlock)
1448
1252
 
1449
1253
    def get_physical_lock_status(self):
1450
1254
        return self.control_files.get_physical_lock_status()
1510
1314
 
1511
1315
        # now gather global repository information
1512
1316
        # XXX: This is available for many repos regardless of listability.
1513
 
        if self.user_transport.listable():
 
1317
        if self.bzrdir.root_transport.listable():
1514
1318
            # XXX: do we want to __define len__() ?
1515
1319
            # Maybe the versionedfiles object should provide a different
1516
1320
            # method to get the number of keys.
1526
1330
        :param using: If True, list only branches using this repository.
1527
1331
        """
1528
1332
        if using and not self.is_shared():
1529
 
            return self.bzrdir.list_branches()
 
1333
            try:
 
1334
                return [self.bzrdir.open_branch()]
 
1335
            except errors.NotBranchError:
 
1336
                return []
1530
1337
        class Evaluator(object):
1531
1338
 
1532
1339
            def __init__(self):
1541
1348
                    except errors.NoRepositoryPresent:
1542
1349
                        pass
1543
1350
                    else:
1544
 
                        return False, ([], repository)
 
1351
                        return False, (None, repository)
1545
1352
                self.first_call = False
1546
 
                value = (bzrdir.list_branches(), None)
 
1353
                try:
 
1354
                    value = (bzrdir.open_branch(), None)
 
1355
                except errors.NotBranchError:
 
1356
                    value = (None, None)
1547
1357
                return True, value
1548
1358
 
1549
 
        ret = []
1550
 
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
1551
 
                self.user_transport, evaluate=Evaluator()):
1552
 
            if branches is not None:
1553
 
                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)
1554
1364
            if not using and repository is not None:
1555
 
                ret.extend(repository.find_branches())
1556
 
        return ret
 
1365
                branches.extend(repository.find_branches())
 
1366
        return branches
1557
1367
 
1558
1368
    @needs_read_lock
1559
1369
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1588
1398
        """Commit the contents accrued within the current write group.
1589
1399
 
1590
1400
        :seealso: start_write_group.
1591
 
        
1592
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1593
1401
        """
1594
1402
        if self._write_group is not self.get_transaction():
1595
1403
            # has an unlock or relock occured ?
1649
1457
        # but at the moment we're only checking for texts referenced by
1650
1458
        # inventories at the graph's edge.
1651
1459
        key_deps = self.revisions._index._key_dependencies
1652
 
        key_deps.satisfy_refs_for_keys(present_inventories)
 
1460
        key_deps.add_keys(present_inventories)
1653
1461
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1654
1462
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1655
1463
        missing_texts = set()
1668
1476
        return missing_keys
1669
1477
 
1670
1478
    def refresh_data(self):
1671
 
        """Re-read any data needed to synchronise with disk.
 
1479
        """Re-read any data needed to to synchronise with disk.
1672
1480
 
1673
1481
        This method is intended to be called after another repository instance
1674
1482
        (such as one used by a smart server) has inserted data into the
1675
 
        repository. On all repositories this will work outside of write groups.
1676
 
        Some repository formats (pack and newer for bzrlib native formats)
1677
 
        support refresh_data inside write groups. If called inside a write
1678
 
        group on a repository that does not support refreshing in a write group
1679
 
        IsInWriteGroupError will be raised.
 
1483
        repository. It may not be called during a write group, but may be
 
1484
        called at any other time.
1680
1485
        """
 
1486
        if self.is_in_write_group():
 
1487
            raise errors.InternalBzrError(
 
1488
                "May not refresh_data while in a write group.")
1681
1489
        self._refresh_data()
1682
1490
 
1683
1491
    def resume_write_group(self, tokens):
1721
1529
            raise errors.InternalBzrError(
1722
1530
                "May not fetch while in a write group.")
1723
1531
        # fast path same-url fetch operations
1724
 
        # TODO: lift out to somewhere common with RemoteRepository
1725
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401646>
1726
 
        if (self.has_same_location(source)
1727
 
            and fetch_spec is None
1728
 
            and self._has_same_fallbacks(source)):
 
1532
        if self.has_same_location(source) and fetch_spec is None:
1729
1533
            # check that last_revision is in 'from' and then return a
1730
1534
            # no-operation.
1731
1535
            if (revision_id is not None and
1756
1560
        :param revprops: Optional dictionary of revision properties.
1757
1561
        :param revision_id: Optional revision id.
1758
1562
        """
1759
 
        if self._fallback_repositories:
1760
 
            raise errors.BzrError("Cannot commit from a lightweight checkout "
1761
 
                "to a stacked branch. See "
1762
 
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1763
1563
        result = self._commit_builder_class(self, parents, config,
1764
1564
            timestamp, timezone, committer, revprops, revision_id)
1765
1565
        self.start_write_group()
1766
1566
        return result
1767
1567
 
1768
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1769
1568
    def unlock(self):
1770
1569
        if (self.control_files._lock_count == 1 and
1771
1570
            self.control_files._lock_mode == 'w'):
1893
1692
 
1894
1693
    @needs_read_lock
1895
1694
    def get_revisions(self, revision_ids):
1896
 
        """Get many revisions at once.
1897
 
        
1898
 
        Repositories that need to check data on every revision read should 
1899
 
        subclass this method.
1900
 
        """
 
1695
        """Get many revisions at once."""
1901
1696
        return self._get_revisions(revision_ids)
1902
1697
 
1903
1698
    @needs_read_lock
1904
1699
    def _get_revisions(self, revision_ids):
1905
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)
1906
1706
        revs = {}
1907
 
        for revid, rev in self._iter_revisions(revision_ids):
1908
 
            if rev is None:
1909
 
                raise errors.NoSuchRevision(self, revid)
1910
 
            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
1911
1713
        return [revs[revid] for revid in revision_ids]
1912
1714
 
1913
 
    def _iter_revisions(self, revision_ids):
1914
 
        """Iterate over revision objects.
1915
 
 
1916
 
        :param revision_ids: An iterable of revisions to examine. None may be
1917
 
            passed to request all revisions known to the repository. Note that
1918
 
            not all repositories can find unreferenced revisions; for those
1919
 
            repositories only referenced ones will be returned.
1920
 
        :return: An iterator of (revid, revision) tuples. Absent revisions (
1921
 
            those asked for but not available) are returned as (revid, None).
1922
 
        """
1923
 
        if revision_ids is None:
1924
 
            revision_ids = self.all_revision_ids()
1925
 
        else:
1926
 
            for rev_id in revision_ids:
1927
 
                if not rev_id or not isinstance(rev_id, basestring):
1928
 
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1929
 
        keys = [(key,) for key in revision_ids]
1930
 
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1931
 
        for record in stream:
1932
 
            revid = record.key[0]
1933
 
            if record.storage_kind == 'absent':
1934
 
                yield (revid, None)
1935
 
            else:
1936
 
                text = record.get_bytes_as('fulltext')
1937
 
                rev = self._serializer.read_revision_from_string(text)
1938
 
                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()
1939
1731
 
1940
1732
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1941
1733
        """Produce a generator of revision deltas.
2184
1976
        """
2185
1977
        selected_keys = set((revid,) for revid in revision_ids)
2186
1978
        w = _inv_weave or self.inventories
2187
 
        return self._find_file_ids_from_xml_inventory_lines(
2188
 
            w.iter_lines_added_or_present_in_keys(
2189
 
                selected_keys, pb=None),
2190
 
            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()
2191
1987
 
2192
1988
    def iter_files_bytes(self, desired_files):
2193
1989
        """Iterate through file versions.
2275
2071
                batch_size]
2276
2072
            if not to_query:
2277
2073
                break
2278
 
            for revision_id in to_query:
 
2074
            for rev_tree in self.revision_trees(to_query):
 
2075
                revision_id = rev_tree.get_revision_id()
2279
2076
                parent_ids = ancestors[revision_id]
2280
2077
                for text_key in revision_keys[revision_id]:
2281
2078
                    pb.update("Calculating text parents", processed_texts)
2354
2151
        num_file_ids = len(file_ids)
2355
2152
        for file_id, altered_versions in file_ids.iteritems():
2356
2153
            if pb is not None:
2357
 
                pb.update("Fetch texts", count, num_file_ids)
 
2154
                pb.update("fetch texts", count, num_file_ids)
2358
2155
            count += 1
2359
2156
            yield ("file", file_id, altered_versions)
2360
2157
 
2381
2178
        """Get Inventory object by revision id."""
2382
2179
        return self.iter_inventories([revision_id]).next()
2383
2180
 
2384
 
    def iter_inventories(self, revision_ids, ordering=None):
 
2181
    def iter_inventories(self, revision_ids):
2385
2182
        """Get many inventories by revision_ids.
2386
2183
 
2387
2184
        This will buffer some or all of the texts used in constructing the
2389
2186
        time.
2390
2187
 
2391
2188
        :param revision_ids: The expected revision ids of the inventories.
2392
 
        :param ordering: optional ordering, e.g. 'topological'.  If not
2393
 
            specified, the order of revision_ids will be preserved (by
2394
 
            buffering if necessary).
2395
2189
        :return: An iterator of inventories.
2396
2190
        """
2397
2191
        if ((None in revision_ids)
2398
2192
            or (_mod_revision.NULL_REVISION in revision_ids)):
2399
2193
            raise ValueError('cannot get null revision inventory')
2400
 
        return self._iter_inventories(revision_ids, ordering)
 
2194
        return self._iter_inventories(revision_ids)
2401
2195
 
2402
 
    def _iter_inventories(self, revision_ids, ordering):
 
2196
    def _iter_inventories(self, revision_ids):
2403
2197
        """single-document based inventory iteration."""
2404
 
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2405
 
        for text, revision_id in inv_xmls:
2406
 
            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)
2407
2200
 
2408
 
    def _iter_inventory_xmls(self, revision_ids, ordering):
2409
 
        if ordering is None:
2410
 
            order_as_requested = True
2411
 
            ordering = 'unordered'
2412
 
        else:
2413
 
            order_as_requested = False
 
2201
    def _iter_inventory_xmls(self, revision_ids):
2414
2202
        keys = [(revision_id,) for revision_id in revision_ids]
2415
 
        if not keys:
2416
 
            return
2417
 
        if order_as_requested:
2418
 
            key_iter = iter(keys)
2419
 
            next_key = key_iter.next()
2420
 
        stream = self.inventories.get_record_stream(keys, ordering, True)
 
2203
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2421
2204
        text_chunks = {}
2422
2205
        for record in stream:
2423
2206
            if record.storage_kind != 'absent':
2424
 
                chunks = record.get_bytes_as('chunked')
2425
 
                if order_as_requested:
2426
 
                    text_chunks[record.key] = chunks
2427
 
                else:
2428
 
                    yield ''.join(chunks), record.key[-1]
 
2207
                text_chunks[record.key] = record.get_bytes_as('chunked')
2429
2208
            else:
2430
2209
                raise errors.NoSuchRevision(self, record.key)
2431
 
            if order_as_requested:
2432
 
                # Yield as many results as we can while preserving order.
2433
 
                while next_key in text_chunks:
2434
 
                    chunks = text_chunks.pop(next_key)
2435
 
                    yield ''.join(chunks), next_key[-1]
2436
 
                    try:
2437
 
                        next_key = key_iter.next()
2438
 
                    except StopIteration:
2439
 
                        # We still want to fully consume the get_record_stream,
2440
 
                        # just in case it is not actually finished at this point
2441
 
                        next_key = None
2442
 
                        break
 
2210
        for key in keys:
 
2211
            chunks = text_chunks.pop(key)
 
2212
            yield ''.join(chunks), key[-1]
2443
2213
 
2444
 
    def _deserialise_inventory(self, revision_id, xml):
 
2214
    def deserialise_inventory(self, revision_id, xml):
2445
2215
        """Transform the xml into an inventory object.
2446
2216
 
2447
2217
        :param revision_id: The expected revision id of the inventory.
2448
2218
        :param xml: A serialised inventory.
2449
2219
        """
2450
2220
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2451
 
                    entry_cache=self._inventory_entry_cache,
2452
 
                    return_from_cache=self._safe_to_return_from_cache)
 
2221
                    entry_cache=self._inventory_entry_cache)
2453
2222
        if result.revision_id != revision_id:
2454
2223
            raise AssertionError('revision id mismatch %s != %s' % (
2455
2224
                result.revision_id, revision_id))
2456
2225
        return result
2457
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
 
2458
2233
    def get_serializer_format(self):
2459
2234
        return self._serializer.format_num
2460
2235
 
2461
2236
    @needs_read_lock
2462
 
    def _get_inventory_xml(self, revision_id):
2463
 
        """Get serialized inventory as a string."""
2464
 
        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])
2465
2240
        try:
2466
2241
            text, revision_id = texts.next()
2467
2242
        except StopIteration:
2468
2243
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2469
2244
        return text
2470
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
 
2471
2252
    def get_rev_id_for_revno(self, revno, known_pair):
2472
2253
        """Return the revision id of a revno, given a later (revno, revid)
2473
2254
        pair in the same history.
2524
2305
            else:
2525
2306
                next_id = parents[0]
2526
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
 
2527
2324
    def is_shared(self):
2528
2325
        """Return True if this repository is flagged as a shared repository."""
2529
2326
        raise NotImplementedError(self.is_shared)
2563
2360
            return RevisionTree(self, Inventory(root_id=None),
2564
2361
                                _mod_revision.NULL_REVISION)
2565
2362
        else:
2566
 
            inv = self.get_inventory(revision_id)
 
2363
            inv = self.get_revision_inventory(revision_id)
2567
2364
            return RevisionTree(self, inv, revision_id)
2568
2365
 
2569
2366
    def revision_trees(self, revision_ids):
2622
2419
            keys = tsort.topo_sort(parent_map)
2623
2420
        return [None] + list(keys)
2624
2421
 
2625
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
2422
    def pack(self, hint=None):
2626
2423
        """Compress the data within the repository.
2627
2424
 
2628
2425
        This operation only makes sense for some repository types. For other
2638
2435
            obtained from the result of commit_write_group(). Out of
2639
2436
            date hints are simply ignored, because concurrent operations
2640
2437
            can obsolete them rapidly.
2641
 
 
2642
 
        :param clean_obsolete_packs: Clean obsolete packs immediately after
2643
 
            the pack operation.
2644
2438
        """
2645
2439
 
2646
2440
    def get_transaction(self):
2662
2456
        for ((revision_id,), parent_keys) in \
2663
2457
                self.revisions.get_parent_map(query_keys).iteritems():
2664
2458
            if parent_keys:
2665
 
                result[revision_id] = tuple([parent_revid
2666
 
                    for (parent_revid,) in parent_keys])
 
2459
                result[revision_id] = tuple(parent_revid
 
2460
                    for (parent_revid,) in parent_keys)
2667
2461
            else:
2668
2462
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2669
2463
        return result
2671
2465
    def _make_parents_provider(self):
2672
2466
        return self
2673
2467
 
2674
 
    @needs_read_lock
2675
 
    def get_known_graph_ancestry(self, revision_ids):
2676
 
        """Return the known graph for a set of revision ids and their ancestors.
2677
 
        """
2678
 
        st = static_tuple.StaticTuple
2679
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
2680
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
2681
 
        return graph.GraphThunkIdsToKeys(known_graph)
2682
 
 
2683
2468
    def get_graph(self, other_repository=None):
2684
2469
        """Return the graph walker for this repository format"""
2685
2470
        parents_provider = self._make_parents_provider()
2689
2474
                [parents_provider, other_repository._make_parents_provider()])
2690
2475
        return graph.Graph(parents_provider)
2691
2476
 
2692
 
    def _get_versioned_file_checker(self, text_key_references=None,
2693
 
        ancestors=None):
 
2477
    def _get_versioned_file_checker(self, text_key_references=None):
2694
2478
        """Return an object suitable for checking versioned files.
2695
2479
        
2696
2480
        :param text_key_references: if non-None, an already built
2698
2482
            to whether they were referred to by the inventory of the
2699
2483
            revision_id that they contain. If None, this will be
2700
2484
            calculated.
2701
 
        :param ancestors: Optional result from
2702
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2703
 
            available.
2704
2485
        """
2705
2486
        return _VersionedFileChecker(self,
2706
 
            text_key_references=text_key_references, ancestors=ancestors)
 
2487
            text_key_references=text_key_references)
2707
2488
 
2708
2489
    def revision_ids_to_search_result(self, result_set):
2709
2490
        """Convert a set of revision ids to a graph SearchResult."""
2759
2540
        return record.get_bytes_as('fulltext')
2760
2541
 
2761
2542
    @needs_read_lock
2762
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
2543
    def check(self, revision_ids=None):
2763
2544
        """Check consistency of all history of given revision_ids.
2764
2545
 
2765
2546
        Different repository implementations should override _check().
2766
2547
 
2767
2548
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2768
2549
             will be checked.  Typically the last revision_id of a branch.
2769
 
        :param callback_refs: A dict of check-refs to resolve and callback
2770
 
            the check/_check method on the items listed as wanting the ref.
2771
 
            see bzrlib.check.
2772
 
        :param check_repo: If False do not check the repository contents, just 
2773
 
            calculate the data callback_refs requires and call them back.
2774
2550
        """
2775
 
        return self._check(revision_ids, callback_refs=callback_refs,
2776
 
            check_repo=check_repo)
 
2551
        return self._check(revision_ids)
2777
2552
 
2778
 
    def _check(self, revision_ids, callback_refs, check_repo):
2779
 
        result = check.Check(self, check_repo=check_repo)
2780
 
        result.check(callback_refs)
 
2553
    def _check(self, revision_ids):
 
2554
        result = check.Check(self)
 
2555
        result.check()
2781
2556
        return result
2782
2557
 
2783
 
    def _warn_if_deprecated(self, branch=None):
 
2558
    def _warn_if_deprecated(self):
2784
2559
        global _deprecation_warning_done
2785
2560
        if _deprecation_warning_done:
2786
2561
            return
2787
 
        try:
2788
 
            if branch is None:
2789
 
                conf = config.GlobalConfig()
2790
 
            else:
2791
 
                conf = branch.get_config()
2792
 
            if conf.suppress_warning('format_deprecation'):
2793
 
                return
2794
 
            warning("Format %s for %s is deprecated -"
2795
 
                    " please use 'bzr upgrade' to get better performance"
2796
 
                    % (self._format, self.bzrdir.transport.base))
2797
 
        finally:
2798
 
            _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))
2799
2565
 
2800
2566
    def supports_rich_root(self):
2801
2567
        return self._format.rich_root_data
3082
2848
    # help), and for fetching when data won't have come from the same
3083
2849
    # compressor.
3084
2850
    pack_compresses = False
3085
 
    # Does the repository inventory storage understand references to trees?
3086
 
    supports_tree_reference = None
3087
 
    # Is the format experimental ?
3088
 
    experimental = False
3089
2851
 
3090
 
    def __repr__(self):
3091
 
        return "%s()" % self.__class__.__name__
 
2852
    def __str__(self):
 
2853
        return "<%s>" % self.__class__.__name__
3092
2854
 
3093
2855
    def __eq__(self, other):
3094
2856
        # format objects are generally stateless
3107
2869
        """
3108
2870
        try:
3109
2871
            transport = a_bzrdir.get_repository_transport(None)
3110
 
            format_string = transport.get_bytes("format")
 
2872
            format_string = transport.get("format").read()
3111
2873
            return format_registry.get(format_string)
3112
2874
        except errors.NoSuchFile:
3113
2875
            raise errors.NoRepositoryPresent(a_bzrdir)
3195
2957
        raise NotImplementedError(self.network_name)
3196
2958
 
3197
2959
    def check_conversion_target(self, target_format):
3198
 
        if self.rich_root_data and not target_format.rich_root_data:
3199
 
            raise errors.BadConversionTarget(
3200
 
                'Does not support rich root data.', target_format,
3201
 
                from_format=self)
3202
 
        if (self.supports_tree_reference and 
3203
 
            not getattr(target_format, 'supports_tree_reference', False)):
3204
 
            raise errors.BadConversionTarget(
3205
 
                'Does not support nested trees', target_format,
3206
 
                from_format=self)
 
2960
        raise NotImplementedError(self.check_conversion_target)
3207
2961
 
3208
2962
    def open(self, a_bzrdir, _found=False):
3209
2963
        """Return an instance of this format for the bzrdir a_bzrdir.
3212
2966
        """
3213
2967
        raise NotImplementedError(self.open)
3214
2968
 
3215
 
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
3216
 
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
3217
 
        hooks = BzrDir.hooks['post_repo_init']
3218
 
        if not hooks:
3219
 
            return
3220
 
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
3221
 
        for hook in hooks:
3222
 
            hook(params)
3223
 
 
3224
2969
 
3225
2970
class MetaDirRepositoryFormat(RepositoryFormat):
3226
2971
    """Common base class for the new repositories using the metadir layout."""
3431
3176
 
3432
3177
        :param revision_id: if None all content is copied, if NULL_REVISION no
3433
3178
                            content is copied.
3434
 
        :param pb: ignored.
 
3179
        :param pb: optional progress bar to use for progress reports. If not
 
3180
                   provided a default one will be created.
3435
3181
        :return: None.
3436
3182
        """
3437
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3438
3183
        from bzrlib.fetch import RepoFetcher
3439
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
3440
 
        if self.source._format.network_name() != self.target._format.network_name():
3441
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
3442
 
                from_format=self.source._format,
3443
 
                to_format=self.target._format)
3444
3184
        f = RepoFetcher(to_repository=self.target,
3445
3185
                               from_repository=self.source,
3446
3186
                               last_revision=revision_id,
3447
3187
                               fetch_spec=fetch_spec,
3448
 
                               find_ghosts=find_ghosts)
 
3188
                               pb=pb, find_ghosts=find_ghosts)
3449
3189
 
3450
3190
    def _walk_to_common_revisions(self, revision_ids):
3451
3191
        """Walk out from revision_ids in source to revisions target has.
3620
3360
                self.target.texts.insert_record_stream(
3621
3361
                    self.source.texts.get_record_stream(
3622
3362
                        self.source.texts.keys(), 'topological', False))
3623
 
                pb.update('Copying inventory', 0, 1)
 
3363
                pb.update('copying inventory', 0, 1)
3624
3364
                self.target.inventories.insert_record_stream(
3625
3365
                    self.source.inventories.get_record_stream(
3626
3366
                        self.source.inventories.keys(), 'topological', False))
3752
3492
        # This is redundant with format.check_conversion_target(), however that
3753
3493
        # raises an exception, and we just want to say "False" as in we won't
3754
3494
        # support converting between these formats.
3755
 
        if 'IDS_never' in debug.debug_flags:
3756
 
            return False
3757
3495
        if source.supports_rich_root() and not target.supports_rich_root():
3758
3496
            return False
3759
3497
        if (source._format.supports_tree_reference
3760
3498
            and not target._format.supports_tree_reference):
3761
3499
            return False
3762
 
        if target._fallback_repositories and target._format.supports_chks:
3763
 
            # IDS doesn't know how to copy CHKs for the parent inventories it
3764
 
            # adds to stacked repos.
3765
 
            return False
3766
 
        if 'IDS_always' in debug.debug_flags:
3767
 
            return True
3768
 
        # Only use this code path for local source and target.  IDS does far
3769
 
        # too much IO (both bandwidth and roundtrips) over a network.
3770
 
        if not source.bzrdir.transport.base.startswith('file:///'):
3771
 
            return False
3772
 
        if not target.bzrdir.transport.base.startswith('file:///'):
3773
 
            return False
3774
3500
        return True
3775
3501
 
3776
 
    def _get_trees(self, revision_ids, cache):
3777
 
        possible_trees = []
3778
 
        for rev_id in revision_ids:
3779
 
            if rev_id in cache:
3780
 
                possible_trees.append((rev_id, cache[rev_id]))
3781
 
            else:
3782
 
                # Not cached, but inventory might be present anyway.
3783
 
                try:
3784
 
                    tree = self.source.revision_tree(rev_id)
3785
 
                except errors.NoSuchRevision:
3786
 
                    # Nope, parent is ghost.
3787
 
                    pass
3788
 
                else:
3789
 
                    cache[rev_id] = tree
3790
 
                    possible_trees.append((rev_id, tree))
3791
 
        return possible_trees
3792
 
 
3793
 
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
 
3502
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
3794
3503
        """Get the best delta and base for this revision.
3795
3504
 
3796
3505
        :return: (basis_id, delta)
3797
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]))
3798
3514
        deltas = []
3799
 
        # Generate deltas against each tree, to find the shortest.
3800
 
        texts_possibly_new_in_tree = set()
3801
3515
        for basis_id, basis_tree in possible_trees:
3802
3516
            delta = tree.inventory._make_delta(basis_tree.inventory)
3803
 
            for old_path, new_path, file_id, new_entry in delta:
3804
 
                if new_path is None:
3805
 
                    # This file_id isn't present in the new rev, so we don't
3806
 
                    # care about it.
3807
 
                    continue
3808
 
                if not new_path:
3809
 
                    # Rich roots are handled elsewhere...
3810
 
                    continue
3811
 
                kind = new_entry.kind
3812
 
                if kind != 'directory' and kind != 'file':
3813
 
                    # No text record associated with this inventory entry.
3814
 
                    continue
3815
 
                # This is a directory or file that has changed somehow.
3816
 
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3817
3517
            deltas.append((len(delta), basis_id, delta))
3818
3518
        deltas.sort()
3819
3519
        return deltas[0][1:]
3820
3520
 
3821
 
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
3822
 
        """Find all parent revisions that are absent, but for which the
3823
 
        inventory is present, and copy those inventories.
3824
 
 
3825
 
        This is necessary to preserve correctness when the source is stacked
3826
 
        without fallbacks configured.  (Note that in cases like upgrade the
3827
 
        source may be not have _fallback_repositories even though it is
3828
 
        stacked.)
3829
 
        """
3830
 
        parent_revs = set()
3831
 
        for parents in parent_map.values():
3832
 
            parent_revs.update(parents)
3833
 
        present_parents = self.source.get_parent_map(parent_revs)
3834
 
        absent_parents = set(parent_revs).difference(present_parents)
3835
 
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
3836
 
            (rev_id,) for rev_id in absent_parents)
3837
 
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
3838
 
        for parent_tree in self.source.revision_trees(parent_inv_ids):
3839
 
            current_revision_id = parent_tree.get_revision_id()
3840
 
            parents_parents_keys = parent_invs_keys_for_stacking[
3841
 
                (current_revision_id,)]
3842
 
            parents_parents = [key[-1] for key in parents_parents_keys]
3843
 
            basis_id = _mod_revision.NULL_REVISION
3844
 
            basis_tree = self.source.revision_tree(basis_id)
3845
 
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
3846
 
            self.target.add_inventory_by_delta(
3847
 
                basis_id, delta, current_revision_id, parents_parents)
3848
 
            cache[current_revision_id] = parent_tree
3849
 
 
3850
 
    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):
3851
3579
        """Fetch across a few revisions.
3852
3580
 
3853
3581
        :param revision_ids: The revisions to copy
3854
3582
        :param basis_id: The revision_id of a tree that must be in cache, used
3855
3583
            as a basis for delta when no other base is available
3856
3584
        :param cache: A cache of RevisionTrees that we can use.
3857
 
        :param a_graph: A Graph object to determine the heads() of the
3858
 
            rich-root data stream.
3859
3585
        :return: The revision_id of the last converted tree. The RevisionTree
3860
3586
            for it will be in cache
3861
3587
        """
3867
3593
        pending_deltas = []
3868
3594
        pending_revisions = []
3869
3595
        parent_map = self.source.get_parent_map(revision_ids)
3870
 
        self._fetch_parent_invs_for_stacking(parent_map, cache)
3871
 
        self.source._safe_to_return_from_cache = True
3872
3596
        for tree in self.source.revision_trees(revision_ids):
3873
 
            # Find a inventory delta for this revision.
3874
 
            # Find text entries that need to be copied, too.
3875
3597
            current_revision_id = tree.get_revision_id()
3876
3598
            parent_ids = parent_map.get(current_revision_id, ())
3877
 
            parent_trees = self._get_trees(parent_ids, cache)
3878
 
            possible_trees = list(parent_trees)
3879
 
            if len(possible_trees) == 0:
3880
 
                # There either aren't any parents, or the parents are ghosts,
3881
 
                # so just use the last converted tree.
3882
 
                possible_trees.append((basis_id, cache[basis_id]))
3883
3599
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3884
 
                                                           possible_trees)
3885
 
            revision = self.source.get_revision(current_revision_id)
3886
 
            pending_deltas.append((basis_id, delta,
3887
 
                current_revision_id, revision.parent_ids))
 
3600
                                                           basis_id, cache)
3888
3601
            if self._converting_to_rich_root:
3889
3602
                self._revision_id_to_root_id[current_revision_id] = \
3890
3603
                    tree.get_root_id()
3891
 
            # Determine which texts are in present in this revision but not in
3892
 
            # any of the available parents.
3893
 
            texts_possibly_new_in_tree = set()
 
3604
            # Find text entries that need to be copied
3894
3605
            for old_path, new_path, file_id, entry in delta:
3895
 
                if new_path is None:
3896
 
                    # This file_id isn't present in the new rev
3897
 
                    continue
3898
 
                if not new_path:
3899
 
                    # This is the root
3900
 
                    if not self.target.supports_rich_root():
3901
 
                        # The target doesn't support rich root, so we don't
3902
 
                        # copy
3903
 
                        continue
3904
 
                    if self._converting_to_rich_root:
3905
 
                        # This can't be copied normally, we have to insert
3906
 
                        # it specially
3907
 
                        root_keys_to_create.add((file_id, entry.revision))
3908
 
                        continue
3909
 
                kind = entry.kind
3910
 
                texts_possibly_new_in_tree.add((file_id, entry.revision))
3911
 
            for basis_id, basis_tree in possible_trees:
3912
 
                basis_inv = basis_tree.inventory
3913
 
                for file_key in list(texts_possibly_new_in_tree):
3914
 
                    file_id, file_revision = file_key
3915
 
                    try:
3916
 
                        entry = basis_inv[file_id]
3917
 
                    except errors.NoSuchId:
3918
 
                        continue
3919
 
                    if entry.revision == file_revision:
3920
 
                        texts_possibly_new_in_tree.remove(file_key)
3921
 
            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))
3922
3622
            pending_revisions.append(revision)
3923
3623
            cache[current_revision_id] = tree
3924
3624
            basis_id = current_revision_id
3925
 
        self.source._safe_to_return_from_cache = False
3926
3625
        # Copy file texts
3927
3626
        from_texts = self.source.texts
3928
3627
        to_texts = self.target.texts
3929
3628
        if root_keys_to_create:
3930
 
            root_stream = _mod_fetch._new_root_data_stream(
3931
 
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
3932
 
                self.source, graph=a_graph)
 
3629
            root_stream = self._new_root_data_stream(root_keys_to_create,
 
3630
                                                     parent_map)
3933
3631
            to_texts.insert_record_stream(root_stream)
3934
3632
        to_texts.insert_record_stream(from_texts.get_record_stream(
3935
3633
            text_keys, self.target._format._fetch_order,
3942
3640
            # for the new revisions that we are about to insert.  We do this
3943
3641
            # before adding the revisions so that no revision is added until
3944
3642
            # all the inventories it may depend on are added.
3945
 
            # Note that this is overzealous, as we may have fetched these in an
3946
 
            # earlier batch.
3947
3643
            parent_ids = set()
3948
3644
            revision_ids = set()
3949
3645
            for revision in pending_revisions:
3952
3648
            parent_ids.difference_update(revision_ids)
3953
3649
            parent_ids.discard(_mod_revision.NULL_REVISION)
3954
3650
            parent_map = self.source.get_parent_map(parent_ids)
3955
 
            # we iterate over parent_map and not parent_ids because we don't
3956
 
            # want to try copying any revision which is a ghost
3957
 
            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)
3958
3653
                current_revision_id = parent_tree.get_revision_id()
3959
3654
                parents_parents = parent_map[current_revision_id]
3960
 
                possible_trees = self._get_trees(parents_parents, cache)
3961
 
                if len(possible_trees) == 0:
3962
 
                    # There either aren't any parents, or the parents are
3963
 
                    # ghosts, so just use the last converted tree.
3964
 
                    possible_trees.append((basis_id, cache[basis_id]))
3965
 
                basis_id, delta = self._get_delta_for_revision(parent_tree,
3966
 
                    parents_parents, possible_trees)
3967
3655
                self.target.add_inventory_by_delta(
3968
3656
                    basis_id, delta, current_revision_id, parents_parents)
3969
3657
        # insert signatures and revisions
3983
3671
 
3984
3672
        :param revision_ids: The list of revisions to fetch. Must be in
3985
3673
            topological order.
3986
 
        :param pb: A ProgressTask
 
3674
        :param pb: A ProgressBar
3987
3675
        :return: None
3988
3676
        """
3989
3677
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3992
3680
        cache[basis_id] = basis_tree
3993
3681
        del basis_tree # We don't want to hang on to it here
3994
3682
        hints = []
3995
 
        if self._converting_to_rich_root and len(revision_ids) > 100:
3996
 
            a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
3997
 
                                                            revision_ids)
3998
 
        else:
3999
 
            a_graph = None
4000
 
 
4001
3683
        for offset in range(0, len(revision_ids), batch_size):
4002
3684
            self.target.start_write_group()
4003
3685
            try:
4004
3686
                pb.update('Transferring revisions', offset,
4005
3687
                          len(revision_ids))
4006
3688
                batch = revision_ids[offset:offset+batch_size]
4007
 
                basis_id = self._fetch_batch(batch, basis_id, cache,
4008
 
                                             a_graph=a_graph)
 
3689
                basis_id = self._fetch_batch(batch, basis_id, cache)
4009
3690
            except:
4010
 
                self.source._safe_to_return_from_cache = False
4011
3691
                self.target.abort_write_group()
4012
3692
                raise
4013
3693
            else:
4025
3705
        """See InterRepository.fetch()."""
4026
3706
        if fetch_spec is not None:
4027
3707
            raise AssertionError("Not implemented yet...")
4028
 
        ui.ui_factory.warn_experimental_format_fetch(self)
4029
3708
        if (not self.source.supports_rich_root()
4030
3709
            and self.target.supports_rich_root()):
4031
3710
            self._converting_to_rich_root = True
4032
3711
            self._revision_id_to_root_id = {}
4033
3712
        else:
4034
3713
            self._converting_to_rich_root = False
4035
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
4036
 
        if self.source._format.network_name() != self.target._format.network_name():
4037
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
4038
 
                from_format=self.source._format,
4039
 
                to_format=self.target._format)
4040
3714
        revision_ids = self.target.search_missing_revision_ids(self.source,
4041
3715
            revision_id, find_ghosts=find_ghosts).get_keys()
4042
3716
        if not revision_ids:
4048
3722
        # Walk though all revisions; get inventory deltas, copy referenced
4049
3723
        # texts that delta references, insert the delta, revision and
4050
3724
        # signature.
 
3725
        first_rev = self.source.get_revision(revision_ids[0])
4051
3726
        if pb is None:
4052
3727
            my_pb = ui.ui_factory.nested_progress_bar()
4053
3728
            pb = my_pb
4111
3786
        :param to_convert: The disk object to convert.
4112
3787
        :param pb: a progress bar to use for progress information.
4113
3788
        """
4114
 
        pb = ui.ui_factory.nested_progress_bar()
 
3789
        self.pb = pb
4115
3790
        self.count = 0
4116
3791
        self.total = 4
4117
3792
        # this is only useful with metadir layouts - separated repo content.
4118
3793
        # trigger an assertion if not such
4119
3794
        repo._format.get_format_string()
4120
3795
        self.repo_dir = repo.bzrdir
4121
 
        pb.update('Moving repository to repository.backup')
 
3796
        self.step('Moving repository to repository.backup')
4122
3797
        self.repo_dir.transport.move('repository', 'repository.backup')
4123
3798
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4124
3799
        repo._format.check_conversion_target(self.target_format)
4125
3800
        self.source_repo = repo._format.open(self.repo_dir,
4126
3801
            _found=True,
4127
3802
            _override_transport=backup_transport)
4128
 
        pb.update('Creating new repository')
 
3803
        self.step('Creating new repository')
4129
3804
        converted = self.target_format.initialize(self.repo_dir,
4130
3805
                                                  self.source_repo.is_shared())
4131
3806
        converted.lock_write()
4132
3807
        try:
4133
 
            pb.update('Copying content')
 
3808
            self.step('Copying content into repository.')
4134
3809
            self.source_repo.copy_content_into(converted)
4135
3810
        finally:
4136
3811
            converted.unlock()
4137
 
        pb.update('Deleting old repository content')
 
3812
        self.step('Deleting old repository content.')
4138
3813
        self.repo_dir.transport.delete_tree('repository.backup')
4139
 
        ui.ui_factory.note('repository converted')
4140
 
        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)
4141
3820
 
4142
3821
 
4143
3822
_unescape_map = {
4172
3851
 
4173
3852
class _VersionedFileChecker(object):
4174
3853
 
4175
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
3854
    def __init__(self, repository, text_key_references=None):
4176
3855
        self.repository = repository
4177
3856
        self.text_index = self.repository._generate_text_key_index(
4178
 
            text_key_references=text_key_references, ancestors=ancestors)
 
3857
            text_key_references=text_key_references)
4179
3858
 
4180
3859
    def calculate_file_version_parents(self, text_key):
4181
3860
        """Calculate the correct parents for a file version according to
4199
3878
            revision_id) tuples for versions that are present in this versioned
4200
3879
            file, but not used by the corresponding inventory.
4201
3880
        """
4202
 
        local_progress = None
4203
 
        if progress_bar is None:
4204
 
            local_progress = ui.ui_factory.nested_progress_bar()
4205
 
            progress_bar = local_progress
4206
 
        try:
4207
 
            return self._check_file_version_parents(texts, progress_bar)
4208
 
        finally:
4209
 
            if local_progress:
4210
 
                local_progress.finished()
4211
 
 
4212
 
    def _check_file_version_parents(self, texts, progress_bar):
4213
 
        """See check_file_version_parents."""
4214
3881
        wrong_parents = {}
4215
3882
        self.file_ids = set([file_id for file_id, _ in
4216
3883
            self.text_index.iterkeys()])
4217
3884
        # text keys is now grouped by file_id
 
3885
        n_weaves = len(self.file_ids)
 
3886
        files_in_revisions = {}
 
3887
        revisions_of_files = {}
4218
3888
        n_versions = len(self.text_index)
4219
3889
        progress_bar.update('loading text store', 0, n_versions)
4220
3890
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4222
3892
        text_keys = self.repository.texts.keys()
4223
3893
        unused_keys = frozenset(text_keys) - set(self.text_index)
4224
3894
        for num, key in enumerate(self.text_index.iterkeys()):
4225
 
            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)
4226
3897
            correct_parents = self.calculate_file_version_parents(key)
4227
3898
            try:
4228
3899
                knit_parents = parent_map[key]
4313
3984
            else:
4314
3985
                new_pack.set_write_cache_size(1024*1024)
4315
3986
        for substream_type, substream in stream:
4316
 
            if 'stream' in debug.debug_flags:
4317
 
                mutter('inserting substream: %s', substream_type)
4318
3987
            if substream_type == 'texts':
4319
3988
                self.target_repo.texts.insert_record_stream(substream)
4320
3989
            elif substream_type == 'inventories':
4324
3993
                else:
4325
3994
                    self._extract_and_insert_inventories(
4326
3995
                        substream, src_serializer)
4327
 
            elif substream_type == 'inventory-deltas':
4328
 
                self._extract_and_insert_inventory_deltas(
4329
 
                    substream, src_serializer)
4330
3996
            elif substream_type == 'chk_bytes':
4331
3997
                # XXX: This doesn't support conversions, as it assumes the
4332
3998
                #      conversion was done in the fetch code.
4363
4029
                ):
4364
4030
                if versioned_file is None:
4365
4031
                    continue
4366
 
                # TODO: key is often going to be a StaticTuple object
4367
 
                #       I don't believe we can define a method by which
4368
 
                #       (prefix,) + StaticTuple will work, though we could
4369
 
                #       define a StaticTuple.sq_concat that would allow you to
4370
 
                #       pass in either a tuple or a StaticTuple as the second
4371
 
                #       object, so instead we could have:
4372
 
                #       StaticTuple(prefix) + key here...
4373
4032
                missing_keys.update((prefix,) + key for key in
4374
4033
                    versioned_file.get_missing_compression_parent_keys())
4375
4034
        except NotImplementedError:
4390
4049
            self.target_repo.pack(hint=hint)
4391
4050
        return [], set()
4392
4051
 
4393
 
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
4394
 
        target_rich_root = self.target_repo._format.rich_root_data
4395
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4396
 
        for record in substream:
4397
 
            # Insert the delta directly
4398
 
            inventory_delta_bytes = record.get_bytes_as('fulltext')
4399
 
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
4400
 
            try:
4401
 
                parse_result = deserialiser.parse_text_bytes(
4402
 
                    inventory_delta_bytes)
4403
 
            except inventory_delta.IncompatibleInventoryDelta, err:
4404
 
                trace.mutter("Incompatible delta: %s", err.msg)
4405
 
                raise errors.IncompatibleRevision(self.target_repo._format)
4406
 
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
4407
 
            revision_id = new_id
4408
 
            parents = [key[0] for key in record.parents]
4409
 
            self.target_repo.add_inventory_by_delta(
4410
 
                basis_id, inv_delta, revision_id, parents)
4411
 
 
4412
 
    def _extract_and_insert_inventories(self, substream, serializer,
4413
 
            parse_delta=None):
 
4052
    def _extract_and_insert_inventories(self, substream, serializer):
4414
4053
        """Generate a new inventory versionedfile in target, converting data.
4415
4054
 
4416
4055
        The inventory is retrieved from the source, (deserializing it), and
4417
4056
        stored in the target (reserializing it in a different format).
4418
4057
        """
4419
 
        target_rich_root = self.target_repo._format.rich_root_data
4420
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4421
4058
        for record in substream:
4422
 
            # It's not a delta, so it must be a fulltext in the source
4423
 
            # serializer's format.
4424
4059
            bytes = record.get_bytes_as('fulltext')
4425
4060
            revision_id = record.key[0]
4426
4061
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4427
4062
            parents = [key[0] for key in record.parents]
4428
4063
            self.target_repo.add_inventory(revision_id, inv, parents)
4429
 
            # No need to keep holding this full inv in memory when the rest of
4430
 
            # the substream is likely to be all deltas.
4431
 
            del inv
4432
4064
 
4433
4065
    def _extract_and_insert_revisions(self, substream, serializer):
4434
4066
        for record in substream:
4483
4115
        return [('signatures', signatures), ('revisions', revisions)]
4484
4116
 
4485
4117
    def _generate_root_texts(self, revs):
4486
 
        """This will be called by get_stream between fetching weave texts and
 
4118
        """This will be called by __fetch between fetching weave texts and
4487
4119
        fetching the inventory weave.
 
4120
 
 
4121
        Subclasses should override this if they need to generate root texts
 
4122
        after fetching weave texts.
4488
4123
        """
4489
4124
        if self._rich_root_upgrade():
4490
 
            return _mod_fetch.Inter1and2Helper(
 
4125
            import bzrlib.fetch
 
4126
            return bzrlib.fetch.Inter1and2Helper(
4491
4127
                self.from_repository).generate_root_texts(revs)
4492
4128
        else:
4493
4129
            return []
4496
4132
        phase = 'file'
4497
4133
        revs = search.get_keys()
4498
4134
        graph = self.from_repository.get_graph()
4499
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
 
4135
        revs = list(graph.iter_topo_order(revs))
4500
4136
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4501
4137
        text_keys = []
4502
4138
        for knit_kind, file_id, revisions in data_to_fetch:
4521
4157
                # will be valid.
4522
4158
                for _ in self._generate_root_texts(revs):
4523
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
4524
4163
                # we fetch only the referenced inventories because we do not
4525
4164
                # know for unselected inventories whether all their required
4526
4165
                # texts are present in the other repository - it could be
4565
4204
            if not keys:
4566
4205
                # No need to stream something we don't have
4567
4206
                continue
4568
 
            if substream_kind == 'inventories':
4569
 
                # Some missing keys are genuinely ghosts, filter those out.
4570
 
                present = self.from_repository.inventories.get_parent_map(keys)
4571
 
                revs = [key[0] for key in present]
4572
 
                # Get the inventory stream more-or-less as we do for the
4573
 
                # original stream; there's no reason to assume that records
4574
 
                # direct from the source will be suitable for the sink.  (Think
4575
 
                # e.g. 2a -> 1.9-rich-root).
4576
 
                for info in self._get_inventory_stream(revs, missing=True):
4577
 
                    yield info
4578
 
                continue
4579
 
 
4580
4207
            # Ask for full texts always so that we don't need more round trips
4581
4208
            # after this stream.
4582
4209
            # Some of the missing keys are genuinely ghosts, so filter absent
4597
4224
        return (not self.from_repository._format.rich_root_data and
4598
4225
            self.to_format.rich_root_data)
4599
4226
 
4600
 
    def _get_inventory_stream(self, revision_ids, missing=False):
 
4227
    def _get_inventory_stream(self, revision_ids):
4601
4228
        from_format = self.from_repository._format
4602
 
        if (from_format.supports_chks and self.to_format.supports_chks and
4603
 
            from_format.network_name() == self.to_format.network_name()):
4604
 
            raise AssertionError(
4605
 
                "this case should be handled by GroupCHKStreamSource")
4606
 
        elif 'forceinvdeltas' in debug.debug_flags:
4607
 
            return self._get_convertable_inventory_stream(revision_ids,
4608
 
                    delta_versus_null=missing)
4609
 
        elif from_format.network_name() == self.to_format.network_name():
4610
 
            # Same format.
4611
 
            return self._get_simple_inventory_stream(revision_ids,
4612
 
                    missing=missing)
4613
 
        elif (not from_format.supports_chks and not self.to_format.supports_chks
4614
 
                and from_format._serializer == self.to_format._serializer):
4615
 
            # Essentially the same format.
4616
 
            return self._get_simple_inventory_stream(revision_ids,
4617
 
                    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)
4618
4240
        else:
4619
 
            # Any time we switch serializations, we want to use an
4620
 
            # inventory-delta based approach.
4621
 
            return self._get_convertable_inventory_stream(revision_ids,
4622
 
                    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)
4623
4248
 
4624
 
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
4625
 
        # NB: This currently reopens the inventory weave in source;
4626
 
        # using a single stream interface instead would avoid this.
 
4249
    def _get_simple_inventory_stream(self, revision_ids):
4627
4250
        from_weave = self.from_repository.inventories
4628
 
        if missing:
4629
 
            delta_closure = True
4630
 
        else:
4631
 
            delta_closure = not self.delta_on_metadata()
4632
4251
        yield ('inventories', from_weave.get_record_stream(
4633
4252
            [(rev_id,) for rev_id in revision_ids],
4634
 
            self.inventory_fetch_order(), delta_closure))
4635
 
 
4636
 
    def _get_convertable_inventory_stream(self, revision_ids,
4637
 
                                          delta_versus_null=False):
4638
 
        # The two formats are sufficiently different that there is no fast
4639
 
        # path, so we need to send just inventorydeltas, which any
4640
 
        # sufficiently modern client can insert into any repository.
4641
 
        # The StreamSink code expects to be able to
4642
 
        # convert on the target, so we need to put bytes-on-the-wire that can
4643
 
        # be converted.  That means inventory deltas (if the remote is <1.19,
4644
 
        # RemoteStreamSink will fallback to VFS to insert the deltas).
4645
 
        yield ('inventory-deltas',
4646
 
           self._stream_invs_as_deltas(revision_ids,
4647
 
                                       delta_versus_null=delta_versus_null))
4648
 
 
4649
 
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
4650
 
        """Return a stream of inventory-deltas for the given rev ids.
4651
 
 
4652
 
        :param revision_ids: The list of inventories to transmit
4653
 
        :param delta_versus_null: Don't try to find a minimal delta for this
4654
 
            entry, instead compute the delta versus the NULL_REVISION. This
4655
 
            effectively streams a complete inventory. Used for stuff like
4656
 
            filling in missing parents, etc.
4657
 
        """
 
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):
4658
4330
        from_repo = self.from_repository
 
4331
        from_serializer = from_repo._format._serializer
4659
4332
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4660
4333
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
4661
 
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
4662
 
        # method...
4663
 
        inventories = self.from_repository.iter_inventories(
4664
 
            revision_ids, 'topological')
4665
 
        format = from_repo._format
4666
 
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
4667
 
        inventory_cache = lru_cache.LRUCache(50)
4668
 
        null_inventory = from_repo.revision_tree(
4669
 
            _mod_revision.NULL_REVISION).inventory
4670
 
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
4671
 
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
4672
 
        # repo back into a non-rich-root repo ought to be allowed)
4673
 
        serializer = inventory_delta.InventoryDeltaSerializer(
4674
 
            versioned_root=format.rich_root_data,
4675
 
            tree_references=format.supports_tree_reference)
4676
 
        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)
4677
4346
            key = (inv.revision_id,)
4678
4347
            parent_keys = parent_map.get(key, ())
4679
 
            delta = None
4680
 
            if not delta_versus_null and parent_keys:
4681
 
                # The caller did not ask for complete inventories and we have
4682
 
                # some parents that we can delta against.  Make a delta against
4683
 
                # each parent so that we can find the smallest.
4684
 
                parent_ids = [parent_key[0] for parent_key in parent_keys]
4685
 
                for parent_id in parent_ids:
4686
 
                    if parent_id not in invs_sent_so_far:
4687
 
                        # We don't know that the remote side has this basis, so
4688
 
                        # we can't use it.
4689
 
                        continue
4690
 
                    if parent_id == _mod_revision.NULL_REVISION:
4691
 
                        parent_inv = null_inventory
4692
 
                    else:
4693
 
                        parent_inv = inventory_cache.get(parent_id, None)
4694
 
                        if parent_inv is None:
4695
 
                            parent_inv = from_repo.get_inventory(parent_id)
4696
 
                    candidate_delta = inv._make_delta(parent_inv)
4697
 
                    if (delta is None or
4698
 
                        len(delta) > len(candidate_delta)):
4699
 
                        delta = candidate_delta
4700
 
                        basis_id = parent_id
4701
 
            if delta is None:
4702
 
                # Either none of the parents ended up being suitable, or we
4703
 
                # were asked to delta against NULL
4704
 
                basis_id = _mod_revision.NULL_REVISION
4705
 
                delta = inv._make_delta(null_inventory)
4706
 
            invs_sent_so_far.add(inv.revision_id)
4707
 
            inventory_cache[inv.revision_id] = inv
4708
 
            delta_serialized = ''.join(
4709
 
                serializer.delta_to_lines(basis_id, key[-1], delta))
4710
4348
            yield versionedfile.FulltextContentFactory(
4711
 
                key, parent_keys, None, delta_serialized)
 
4349
                key, parent_keys, None, as_bytes)
4712
4350
 
4713
4351
 
4714
4352
def _iter_for_revno(repo, partial_history_cache, stop_index=None,