~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: John Arbash Meinel
  • Date: 2010-05-11 10:45:26 UTC
  • mto: This revision was merged to the branch mainline in revision 5225.
  • Revision ID: john@arbash-meinel.com-20100511104526-zxnstcxta22hzw2n
Implement a compiled extension for parsing the text key out of a CHKInventory value.

Related to bug #562666. This seems to shave 5-10% out of the time spent doing a complete
branch of bzr.dev/launchpad/etc.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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,
27
28
    debug,
28
 
    errors,
 
29
    fetch as _mod_fetch,
29
30
    fifo_cache,
30
31
    generate_ids,
31
32
    gpg,
32
33
    graph,
33
34
    inventory,
 
35
    inventory_delta,
34
36
    lazy_regex,
35
37
    lockable_files,
36
38
    lockdir,
37
39
    lru_cache,
38
40
    osutils,
39
41
    revision as _mod_revision,
 
42
    static_tuple,
40
43
    symbol_versioning,
 
44
    trace,
41
45
    tsort,
42
46
    ui,
43
47
    versionedfile,
48
52
from bzrlib.testament import Testament
49
53
""")
50
54
 
51
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
55
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
52
56
from bzrlib.inter import InterObject
53
57
from bzrlib.inventory import (
54
58
    Inventory,
56
60
    ROOT_ID,
57
61
    entry_factory,
58
62
    )
59
 
from bzrlib import registry
 
63
from bzrlib.lock import _RelockDebugMixin
 
64
from bzrlib import (
 
65
    errors,
 
66
    registry,
 
67
    )
60
68
from bzrlib.trace import (
61
69
    log_exception_quietly, note, mutter, mutter_callsite, warning)
62
70
 
65
73
_deprecation_warning_done = False
66
74
 
67
75
 
 
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
 
68
84
class CommitBuilder(object):
69
85
    """Provides an interface to build up a commit.
70
86
 
204
220
            # an inventory delta was accumulated without creating a new
205
221
            # inventory.
206
222
            basis_id = self.basis_delta_revision
207
 
            self.inv_sha1 = self.repository.add_inventory_by_delta(
 
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(
208
227
                basis_id, self._basis_delta, self._new_revision_id,
209
228
                self.parents)
210
229
        else:
464
483
            if content_summary[2] is None:
465
484
                raise ValueError("Files must not have executable = None")
466
485
            if not 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:
 
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:
470
489
                    parent_entry.executable != content_summary[2]):
471
490
                    store = True
472
491
                elif parent_entry.text_sha1 == content_summary[3]:
539
558
                ie.revision = parent_entry.revision
540
559
                return self._get_delta(ie, basis_inv, path), False, None
541
560
            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,))
542
564
            self._add_text_to_weave(ie.file_id, '', heads, None)
543
565
        else:
544
566
            raise NotImplementedError('unknown kind')
806
828
                seen_root = True
807
829
        self.new_inventory = None
808
830
        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.
809
834
            self._any_changes = True
810
835
        if not seen_root:
811
836
            # housekeeping root entry changes do not affect no-change commits.
848
873
######################################################################
849
874
# Repositories
850
875
 
851
 
class Repository(object):
 
876
 
 
877
class Repository(_RelockDebugMixin, bzrdir.ControlComponent):
852
878
    """Repository holding history for one or more branches.
853
879
 
854
880
    The repository holds and retrieves historical information including
923
949
        """
924
950
        if self._write_group is not self.get_transaction():
925
951
            # has an unlock or relock occured ?
 
952
            if suppress_errors:
 
953
                mutter(
 
954
                '(suppressed) mismatched lock context and write group. %r, %r',
 
955
                self._write_group, self.get_transaction())
 
956
                return
926
957
            raise errors.BzrError(
927
958
                'mismatched lock context and write group. %r, %r' %
928
959
                (self._write_group, self.get_transaction()))
1007
1038
 
1008
1039
        :seealso: add_inventory, for the contract.
1009
1040
        """
1010
 
        inv_lines = self._serialise_inventory_to_lines(inv)
 
1041
        inv_lines = self._serializer.write_inventory_to_lines(inv)
1011
1042
        return self._inventory_add_lines(revision_id, parents,
1012
1043
            inv_lines, check_content=False)
1013
1044
 
1062
1093
        check_content=True):
1063
1094
        """Store lines in inv_vf and return the sha1 of the inventory."""
1064
1095
        parents = [(parent,) for parent in parents]
1065
 
        return self.inventories.add_lines((revision_id,), parents, lines,
 
1096
        result = self.inventories.add_lines((revision_id,), parents, lines,
1066
1097
            check_content=check_content)[0]
 
1098
        self.inventories._access.flush()
 
1099
        return result
1067
1100
 
1068
1101
    def add_revision(self, revision_id, rev, inv=None, config=None):
1069
1102
        """Add rev to the revision store as revision_id.
1145
1178
        # The old API returned a list, should this actually be a set?
1146
1179
        return parent_map.keys()
1147
1180
 
 
1181
    def _check_inventories(self, checker):
 
1182
        """Check the inventories found from the revision scan.
 
1183
        
 
1184
        This is responsible for verifying the sha1 of inventories and
 
1185
        creating a pending_keys set that covers data referenced by inventories.
 
1186
        """
 
1187
        bar = ui.ui_factory.nested_progress_bar()
 
1188
        try:
 
1189
            self._do_check_inventories(checker, bar)
 
1190
        finally:
 
1191
            bar.finished()
 
1192
 
 
1193
    def _do_check_inventories(self, checker, bar):
 
1194
        """Helper for _check_inventories."""
 
1195
        revno = 0
 
1196
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
 
1197
        kinds = ['chk_bytes', 'texts']
 
1198
        count = len(checker.pending_keys)
 
1199
        bar.update("inventories", 0, 2)
 
1200
        current_keys = checker.pending_keys
 
1201
        checker.pending_keys = {}
 
1202
        # Accumulate current checks.
 
1203
        for key in current_keys:
 
1204
            if key[0] != 'inventories' and key[0] not in kinds:
 
1205
                checker._report_items.append('unknown key type %r' % (key,))
 
1206
            keys[key[0]].add(key[1:])
 
1207
        if keys['inventories']:
 
1208
            # NB: output order *should* be roughly sorted - topo or
 
1209
            # inverse topo depending on repository - either way decent
 
1210
            # to just delta against. However, pre-CHK formats didn't
 
1211
            # try to optimise inventory layout on disk. As such the
 
1212
            # pre-CHK code path does not use inventory deltas.
 
1213
            last_object = None
 
1214
            for record in self.inventories.check(keys=keys['inventories']):
 
1215
                if record.storage_kind == 'absent':
 
1216
                    checker._report_items.append(
 
1217
                        'Missing inventory {%s}' % (record.key,))
 
1218
                else:
 
1219
                    last_object = self._check_record('inventories', record,
 
1220
                        checker, last_object,
 
1221
                        current_keys[('inventories',) + record.key])
 
1222
            del keys['inventories']
 
1223
        else:
 
1224
            return
 
1225
        bar.update("texts", 1)
 
1226
        while (checker.pending_keys or keys['chk_bytes']
 
1227
            or keys['texts']):
 
1228
            # Something to check.
 
1229
            current_keys = checker.pending_keys
 
1230
            checker.pending_keys = {}
 
1231
            # Accumulate current checks.
 
1232
            for key in current_keys:
 
1233
                if key[0] not in kinds:
 
1234
                    checker._report_items.append('unknown key type %r' % (key,))
 
1235
                keys[key[0]].add(key[1:])
 
1236
            # Check the outermost kind only - inventories || chk_bytes || texts
 
1237
            for kind in kinds:
 
1238
                if keys[kind]:
 
1239
                    last_object = None
 
1240
                    for record in getattr(self, kind).check(keys=keys[kind]):
 
1241
                        if record.storage_kind == 'absent':
 
1242
                            checker._report_items.append(
 
1243
                                'Missing %s {%s}' % (kind, record.key,))
 
1244
                        else:
 
1245
                            last_object = self._check_record(kind, record,
 
1246
                                checker, last_object, current_keys[(kind,) + record.key])
 
1247
                    keys[kind] = set()
 
1248
                    break
 
1249
 
 
1250
    def _check_record(self, kind, record, checker, last_object, item_data):
 
1251
        """Check a single text from this repository."""
 
1252
        if kind == 'inventories':
 
1253
            rev_id = record.key[0]
 
1254
            inv = self._deserialise_inventory(rev_id,
 
1255
                record.get_bytes_as('fulltext'))
 
1256
            if last_object is not None:
 
1257
                delta = inv._make_delta(last_object)
 
1258
                for old_path, path, file_id, ie in delta:
 
1259
                    if ie is None:
 
1260
                        continue
 
1261
                    ie.check(checker, rev_id, inv)
 
1262
            else:
 
1263
                for path, ie in inv.iter_entries():
 
1264
                    ie.check(checker, rev_id, inv)
 
1265
            if self._format.fast_deltas:
 
1266
                return inv
 
1267
        elif kind == 'chk_bytes':
 
1268
            # No code written to check chk_bytes for this repo format.
 
1269
            checker._report_items.append(
 
1270
                'unsupported key type chk_bytes for %s' % (record.key,))
 
1271
        elif kind == 'texts':
 
1272
            self._check_text(record, checker, item_data)
 
1273
        else:
 
1274
            checker._report_items.append(
 
1275
                'unknown key type %s for %s' % (kind, record.key))
 
1276
 
 
1277
    def _check_text(self, record, checker, item_data):
 
1278
        """Check a single text."""
 
1279
        # Check it is extractable.
 
1280
        # TODO: check length.
 
1281
        if record.storage_kind == 'chunked':
 
1282
            chunks = record.get_bytes_as(record.storage_kind)
 
1283
            sha1 = osutils.sha_strings(chunks)
 
1284
            length = sum(map(len, chunks))
 
1285
        else:
 
1286
            content = record.get_bytes_as('fulltext')
 
1287
            sha1 = osutils.sha_string(content)
 
1288
            length = len(content)
 
1289
        if item_data and sha1 != item_data[1]:
 
1290
            checker._report_items.append(
 
1291
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
 
1292
                (record.key, sha1, item_data[1], item_data[2]))
 
1293
 
1148
1294
    @staticmethod
1149
1295
    def create(a_bzrdir):
1150
1296
        """Construct the current default format repository in a_bzrdir."""
1155
1301
 
1156
1302
        :param _format: The format of the repository on disk.
1157
1303
        :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.
1162
1304
        """
 
1305
        # In the future we will have a single api for all stores for
 
1306
        # getting file texts, inventories and revisions, then
 
1307
        # this construct will accept instances of those things.
1163
1308
        super(Repository, self).__init__()
1164
1309
        self._format = _format
1165
1310
        # the following are part of the public API for Repository:
1171
1316
        self._reconcile_does_inventory_gc = True
1172
1317
        self._reconcile_fixes_text_parents = False
1173
1318
        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()
1179
1319
        self._write_group = None
1180
1320
        # Additional places to query for data.
1181
1321
        self._fallback_repositories = []
1182
1322
        # An InventoryEntry cache, used during deserialization
1183
1323
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
 
1324
        # Is it safe to return inventory entries directly from the entry cache,
 
1325
        # rather copying them?
 
1326
        self._safe_to_return_from_cache = False
 
1327
 
 
1328
    @property
 
1329
    def user_transport(self):
 
1330
        return self.bzrdir.user_transport
 
1331
 
 
1332
    @property
 
1333
    def control_transport(self):
 
1334
        return self._transport
1184
1335
 
1185
1336
    def __repr__(self):
1186
 
        return '%s(%r)' % (self.__class__.__name__,
1187
 
                           self.base)
 
1337
        if self._fallback_repositories:
 
1338
            return '%s(%r, fallback_repositories=%r)' % (
 
1339
                self.__class__.__name__,
 
1340
                self.base,
 
1341
                self._fallback_repositories)
 
1342
        else:
 
1343
            return '%s(%r)' % (self.__class__.__name__,
 
1344
                               self.base)
 
1345
 
 
1346
    def _has_same_fallbacks(self, other_repo):
 
1347
        """Returns true if the repositories have the same fallbacks."""
 
1348
        my_fb = self._fallback_repositories
 
1349
        other_fb = other_repo._fallback_repositories
 
1350
        if len(my_fb) != len(other_fb):
 
1351
            return False
 
1352
        for f, g in zip(my_fb, other_fb):
 
1353
            if not f.has_same_location(g):
 
1354
                return False
 
1355
        return True
1188
1356
 
1189
1357
    def has_same_location(self, other):
1190
1358
        """Returns a boolean indicating if this repository is at the same
1236
1404
        locked = self.is_locked()
1237
1405
        result = self.control_files.lock_write(token=token)
1238
1406
        if not locked:
 
1407
            self._warn_if_deprecated()
 
1408
            self._note_lock('w')
1239
1409
            for repo in self._fallback_repositories:
1240
1410
                # Writes don't affect fallback repos
1241
1411
                repo.lock_read()
1246
1416
        locked = self.is_locked()
1247
1417
        self.control_files.lock_read()
1248
1418
        if not locked:
 
1419
            self._warn_if_deprecated()
 
1420
            self._note_lock('r')
1249
1421
            for repo in self._fallback_repositories:
1250
1422
                repo.lock_read()
1251
1423
            self._refresh_data()
1314
1486
 
1315
1487
        # now gather global repository information
1316
1488
        # XXX: This is available for many repos regardless of listability.
1317
 
        if self.bzrdir.root_transport.listable():
 
1489
        if self.user_transport.listable():
1318
1490
            # XXX: do we want to __define len__() ?
1319
1491
            # Maybe the versionedfiles object should provide a different
1320
1492
            # method to get the number of keys.
1330
1502
        :param using: If True, list only branches using this repository.
1331
1503
        """
1332
1504
        if using and not self.is_shared():
1333
 
            try:
1334
 
                return [self.bzrdir.open_branch()]
1335
 
            except errors.NotBranchError:
1336
 
                return []
 
1505
            return self.bzrdir.list_branches()
1337
1506
        class Evaluator(object):
1338
1507
 
1339
1508
            def __init__(self):
1348
1517
                    except errors.NoRepositoryPresent:
1349
1518
                        pass
1350
1519
                    else:
1351
 
                        return False, (None, repository)
 
1520
                        return False, ([], repository)
1352
1521
                self.first_call = False
1353
 
                try:
1354
 
                    value = (bzrdir.open_branch(), None)
1355
 
                except errors.NotBranchError:
1356
 
                    value = (None, None)
 
1522
                value = (bzrdir.list_branches(), None)
1357
1523
                return True, value
1358
1524
 
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)
 
1525
        ret = []
 
1526
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
 
1527
                self.user_transport, evaluate=Evaluator()):
 
1528
            if branches is not None:
 
1529
                ret.extend(branches)
1364
1530
            if not using and repository is not None:
1365
 
                branches.extend(repository.find_branches())
1366
 
        return branches
 
1531
                ret.extend(repository.find_branches())
 
1532
        return ret
1367
1533
 
1368
1534
    @needs_read_lock
1369
1535
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1398
1564
        """Commit the contents accrued within the current write group.
1399
1565
 
1400
1566
        :seealso: start_write_group.
 
1567
        
 
1568
        :return: it may return an opaque hint that can be passed to 'pack'.
1401
1569
        """
1402
1570
        if self._write_group is not self.get_transaction():
1403
1571
            # has an unlock or relock occured ?
1457
1625
        # but at the moment we're only checking for texts referenced by
1458
1626
        # inventories at the graph's edge.
1459
1627
        key_deps = self.revisions._index._key_dependencies
1460
 
        key_deps.add_keys(present_inventories)
 
1628
        key_deps.satisfy_refs_for_keys(present_inventories)
1461
1629
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1462
1630
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1463
1631
        missing_texts = set()
1476
1644
        return missing_keys
1477
1645
 
1478
1646
    def refresh_data(self):
1479
 
        """Re-read any data needed to to synchronise with disk.
 
1647
        """Re-read any data needed to synchronise with disk.
1480
1648
 
1481
1649
        This method is intended to be called after another repository instance
1482
1650
        (such as one used by a smart server) has inserted data into the
1483
 
        repository. It may not be called during a write group, but may be
1484
 
        called at any other time.
 
1651
        repository. On all repositories this will work outside of write groups.
 
1652
        Some repository formats (pack and newer for bzrlib native formats)
 
1653
        support refresh_data inside write groups. If called inside a write
 
1654
        group on a repository that does not support refreshing in a write group
 
1655
        IsInWriteGroupError will be raised.
1485
1656
        """
1486
 
        if self.is_in_write_group():
1487
 
            raise errors.InternalBzrError(
1488
 
                "May not refresh_data while in a write group.")
1489
1657
        self._refresh_data()
1490
1658
 
1491
1659
    def resume_write_group(self, tokens):
1529
1697
            raise errors.InternalBzrError(
1530
1698
                "May not fetch while in a write group.")
1531
1699
        # fast path same-url fetch operations
1532
 
        if self.has_same_location(source) and fetch_spec is None:
 
1700
        # TODO: lift out to somewhere common with RemoteRepository
 
1701
        # <https://bugs.edge.launchpad.net/bzr/+bug/401646>
 
1702
        if (self.has_same_location(source)
 
1703
            and fetch_spec is None
 
1704
            and self._has_same_fallbacks(source)):
1533
1705
            # check that last_revision is in 'from' and then return a
1534
1706
            # no-operation.
1535
1707
            if (revision_id is not None and
1560
1732
        :param revprops: Optional dictionary of revision properties.
1561
1733
        :param revision_id: Optional revision id.
1562
1734
        """
 
1735
        if self._fallback_repositories:
 
1736
            raise errors.BzrError("Cannot commit from a lightweight checkout "
 
1737
                "to a stacked branch. See "
 
1738
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1563
1739
        result = self._commit_builder_class(self, parents, config,
1564
1740
            timestamp, timezone, committer, revprops, revision_id)
1565
1741
        self.start_write_group()
1566
1742
        return result
1567
1743
 
 
1744
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1568
1745
    def unlock(self):
1569
1746
        if (self.control_files._lock_count == 1 and
1570
1747
            self.control_files._lock_mode == 'w'):
1692
1869
 
1693
1870
    @needs_read_lock
1694
1871
    def get_revisions(self, revision_ids):
1695
 
        """Get many revisions at once."""
 
1872
        """Get many revisions at once.
 
1873
        
 
1874
        Repositories that need to check data on every revision read should 
 
1875
        subclass this method.
 
1876
        """
1696
1877
        return self._get_revisions(revision_ids)
1697
1878
 
1698
1879
    @needs_read_lock
1699
1880
    def _get_revisions(self, revision_ids):
1700
1881
        """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)
 
1882
        revs = {}
 
1883
        for revid, rev in self._iter_revisions(revision_ids):
 
1884
            if rev is None:
 
1885
                raise errors.NoSuchRevision(self, revid)
 
1886
            revs[revid] = rev
 
1887
        return [revs[revid] for revid in revision_ids]
 
1888
 
 
1889
    def _iter_revisions(self, revision_ids):
 
1890
        """Iterate over revision objects.
 
1891
 
 
1892
        :param revision_ids: An iterable of revisions to examine. None may be
 
1893
            passed to request all revisions known to the repository. Note that
 
1894
            not all repositories can find unreferenced revisions; for those
 
1895
            repositories only referenced ones will be returned.
 
1896
        :return: An iterator of (revid, revision) tuples. Absent revisions (
 
1897
            those asked for but not available) are returned as (revid, None).
 
1898
        """
 
1899
        if revision_ids is None:
 
1900
            revision_ids = self.all_revision_ids()
 
1901
        else:
 
1902
            for rev_id in revision_ids:
 
1903
                if not rev_id or not isinstance(rev_id, basestring):
 
1904
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1704
1905
        keys = [(key,) for key in revision_ids]
1705
1906
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1706
 
        revs = {}
1707
1907
        for record in stream:
 
1908
            revid = record.key[0]
1708
1909
            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
1713
 
        return [revs[revid] for revid in revision_ids]
1714
 
 
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()
 
1910
                yield (revid, None)
 
1911
            else:
 
1912
                text = record.get_bytes_as('fulltext')
 
1913
                rev = self._serializer.read_revision_from_string(text)
 
1914
                yield (revid, rev)
1731
1915
 
1732
1916
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1733
1917
        """Produce a generator of revision deltas.
1976
2160
        """
1977
2161
        selected_keys = set((revid,) for revid in revision_ids)
1978
2162
        w = _inv_weave or self.inventories
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()
 
2163
        return self._find_file_ids_from_xml_inventory_lines(
 
2164
            w.iter_lines_added_or_present_in_keys(
 
2165
                selected_keys, pb=None),
 
2166
            selected_keys)
1987
2167
 
1988
2168
    def iter_files_bytes(self, desired_files):
1989
2169
        """Iterate through file versions.
2071
2251
                batch_size]
2072
2252
            if not to_query:
2073
2253
                break
2074
 
            for rev_tree in self.revision_trees(to_query):
2075
 
                revision_id = rev_tree.get_revision_id()
 
2254
            for revision_id in to_query:
2076
2255
                parent_ids = ancestors[revision_id]
2077
2256
                for text_key in revision_keys[revision_id]:
2078
2257
                    pb.update("Calculating text parents", processed_texts)
2151
2330
        num_file_ids = len(file_ids)
2152
2331
        for file_id, altered_versions in file_ids.iteritems():
2153
2332
            if pb is not None:
2154
 
                pb.update("fetch texts", count, num_file_ids)
 
2333
                pb.update("Fetch texts", count, num_file_ids)
2155
2334
            count += 1
2156
2335
            yield ("file", file_id, altered_versions)
2157
2336
 
2178
2357
        """Get Inventory object by revision id."""
2179
2358
        return self.iter_inventories([revision_id]).next()
2180
2359
 
2181
 
    def iter_inventories(self, revision_ids):
 
2360
    def iter_inventories(self, revision_ids, ordering=None):
2182
2361
        """Get many inventories by revision_ids.
2183
2362
 
2184
2363
        This will buffer some or all of the texts used in constructing the
2186
2365
        time.
2187
2366
 
2188
2367
        :param revision_ids: The expected revision ids of the inventories.
 
2368
        :param ordering: optional ordering, e.g. 'topological'.  If not
 
2369
            specified, the order of revision_ids will be preserved (by
 
2370
            buffering if necessary).
2189
2371
        :return: An iterator of inventories.
2190
2372
        """
2191
2373
        if ((None in revision_ids)
2192
2374
            or (_mod_revision.NULL_REVISION in revision_ids)):
2193
2375
            raise ValueError('cannot get null revision inventory')
2194
 
        return self._iter_inventories(revision_ids)
 
2376
        return self._iter_inventories(revision_ids, ordering)
2195
2377
 
2196
 
    def _iter_inventories(self, revision_ids):
 
2378
    def _iter_inventories(self, revision_ids, ordering):
2197
2379
        """single-document based inventory iteration."""
2198
 
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
2199
 
            yield self.deserialise_inventory(revision_id, text)
 
2380
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
 
2381
        for text, revision_id in inv_xmls:
 
2382
            yield self._deserialise_inventory(revision_id, text)
2200
2383
 
2201
 
    def _iter_inventory_xmls(self, revision_ids):
 
2384
    def _iter_inventory_xmls(self, revision_ids, ordering):
 
2385
        if ordering is None:
 
2386
            order_as_requested = True
 
2387
            ordering = 'unordered'
 
2388
        else:
 
2389
            order_as_requested = False
2202
2390
        keys = [(revision_id,) for revision_id in revision_ids]
2203
 
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
 
2391
        if not keys:
 
2392
            return
 
2393
        if order_as_requested:
 
2394
            key_iter = iter(keys)
 
2395
            next_key = key_iter.next()
 
2396
        stream = self.inventories.get_record_stream(keys, ordering, True)
2204
2397
        text_chunks = {}
2205
2398
        for record in stream:
2206
2399
            if record.storage_kind != 'absent':
2207
 
                text_chunks[record.key] = record.get_bytes_as('chunked')
 
2400
                chunks = record.get_bytes_as('chunked')
 
2401
                if order_as_requested:
 
2402
                    text_chunks[record.key] = chunks
 
2403
                else:
 
2404
                    yield ''.join(chunks), record.key[-1]
2208
2405
            else:
2209
2406
                raise errors.NoSuchRevision(self, record.key)
2210
 
        for key in keys:
2211
 
            chunks = text_chunks.pop(key)
2212
 
            yield ''.join(chunks), key[-1]
 
2407
            if order_as_requested:
 
2408
                # Yield as many results as we can while preserving order.
 
2409
                while next_key in text_chunks:
 
2410
                    chunks = text_chunks.pop(next_key)
 
2411
                    yield ''.join(chunks), next_key[-1]
 
2412
                    try:
 
2413
                        next_key = key_iter.next()
 
2414
                    except StopIteration:
 
2415
                        # We still want to fully consume the get_record_stream,
 
2416
                        # just in case it is not actually finished at this point
 
2417
                        next_key = None
 
2418
                        break
2213
2419
 
2214
 
    def deserialise_inventory(self, revision_id, xml):
 
2420
    def _deserialise_inventory(self, revision_id, xml):
2215
2421
        """Transform the xml into an inventory object.
2216
2422
 
2217
2423
        :param revision_id: The expected revision id of the inventory.
2218
2424
        :param xml: A serialised inventory.
2219
2425
        """
2220
2426
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2221
 
                    entry_cache=self._inventory_entry_cache)
 
2427
                    entry_cache=self._inventory_entry_cache,
 
2428
                    return_from_cache=self._safe_to_return_from_cache)
2222
2429
        if result.revision_id != revision_id:
2223
2430
            raise AssertionError('revision id mismatch %s != %s' % (
2224
2431
                result.revision_id, revision_id))
2225
2432
        return result
2226
2433
 
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
 
 
2233
2434
    def get_serializer_format(self):
2234
2435
        return self._serializer.format_num
2235
2436
 
2236
2437
    @needs_read_lock
2237
 
    def get_inventory_xml(self, revision_id):
2238
 
        """Get inventory XML as a file object."""
2239
 
        texts = self._iter_inventory_xmls([revision_id])
 
2438
    def _get_inventory_xml(self, revision_id):
 
2439
        """Get serialized inventory as a string."""
 
2440
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
2240
2441
        try:
2241
2442
            text, revision_id = texts.next()
2242
2443
        except StopIteration:
2243
2444
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2244
2445
        return text
2245
2446
 
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
 
 
2252
2447
    def get_rev_id_for_revno(self, revno, known_pair):
2253
2448
        """Return the revision id of a revno, given a later (revno, revid)
2254
2449
        pair in the same history.
2305
2500
            else:
2306
2501
                next_id = parents[0]
2307
2502
 
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
 
 
2324
2503
    def is_shared(self):
2325
2504
        """Return True if this repository is flagged as a shared repository."""
2326
2505
        raise NotImplementedError(self.is_shared)
2360
2539
            return RevisionTree(self, Inventory(root_id=None),
2361
2540
                                _mod_revision.NULL_REVISION)
2362
2541
        else:
2363
 
            inv = self.get_revision_inventory(revision_id)
 
2542
            inv = self.get_inventory(revision_id)
2364
2543
            return RevisionTree(self, inv, revision_id)
2365
2544
 
2366
2545
    def revision_trees(self, revision_ids):
2419
2598
            keys = tsort.topo_sort(parent_map)
2420
2599
        return [None] + list(keys)
2421
2600
 
2422
 
    def pack(self, hint=None):
 
2601
    def pack(self, hint=None, clean_obsolete_packs=False):
2423
2602
        """Compress the data within the repository.
2424
2603
 
2425
2604
        This operation only makes sense for some repository types. For other
2435
2614
            obtained from the result of commit_write_group(). Out of
2436
2615
            date hints are simply ignored, because concurrent operations
2437
2616
            can obsolete them rapidly.
 
2617
 
 
2618
        :param clean_obsolete_packs: Clean obsolete packs immediately after
 
2619
            the pack operation.
2438
2620
        """
2439
2621
 
2440
2622
    def get_transaction(self):
2456
2638
        for ((revision_id,), parent_keys) in \
2457
2639
                self.revisions.get_parent_map(query_keys).iteritems():
2458
2640
            if parent_keys:
2459
 
                result[revision_id] = tuple(parent_revid
2460
 
                    for (parent_revid,) in parent_keys)
 
2641
                result[revision_id] = tuple([parent_revid
 
2642
                    for (parent_revid,) in parent_keys])
2461
2643
            else:
2462
2644
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2463
2645
        return result
2465
2647
    def _make_parents_provider(self):
2466
2648
        return self
2467
2649
 
 
2650
    @needs_read_lock
 
2651
    def get_known_graph_ancestry(self, revision_ids):
 
2652
        """Return the known graph for a set of revision ids and their ancestors.
 
2653
        """
 
2654
        st = static_tuple.StaticTuple
 
2655
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
 
2656
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
 
2657
        return graph.GraphThunkIdsToKeys(known_graph)
 
2658
 
2468
2659
    def get_graph(self, other_repository=None):
2469
2660
        """Return the graph walker for this repository format"""
2470
2661
        parents_provider = self._make_parents_provider()
2474
2665
                [parents_provider, other_repository._make_parents_provider()])
2475
2666
        return graph.Graph(parents_provider)
2476
2667
 
2477
 
    def _get_versioned_file_checker(self, text_key_references=None):
 
2668
    def _get_versioned_file_checker(self, text_key_references=None,
 
2669
        ancestors=None):
2478
2670
        """Return an object suitable for checking versioned files.
2479
2671
        
2480
2672
        :param text_key_references: if non-None, an already built
2482
2674
            to whether they were referred to by the inventory of the
2483
2675
            revision_id that they contain. If None, this will be
2484
2676
            calculated.
 
2677
        :param ancestors: Optional result from
 
2678
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
 
2679
            available.
2485
2680
        """
2486
2681
        return _VersionedFileChecker(self,
2487
 
            text_key_references=text_key_references)
 
2682
            text_key_references=text_key_references, ancestors=ancestors)
2488
2683
 
2489
2684
    def revision_ids_to_search_result(self, result_set):
2490
2685
        """Convert a set of revision ids to a graph SearchResult."""
2540
2735
        return record.get_bytes_as('fulltext')
2541
2736
 
2542
2737
    @needs_read_lock
2543
 
    def check(self, revision_ids=None):
 
2738
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
2544
2739
        """Check consistency of all history of given revision_ids.
2545
2740
 
2546
2741
        Different repository implementations should override _check().
2547
2742
 
2548
2743
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2549
2744
             will be checked.  Typically the last revision_id of a branch.
 
2745
        :param callback_refs: A dict of check-refs to resolve and callback
 
2746
            the check/_check method on the items listed as wanting the ref.
 
2747
            see bzrlib.check.
 
2748
        :param check_repo: If False do not check the repository contents, just 
 
2749
            calculate the data callback_refs requires and call them back.
2550
2750
        """
2551
 
        return self._check(revision_ids)
 
2751
        return self._check(revision_ids, callback_refs=callback_refs,
 
2752
            check_repo=check_repo)
2552
2753
 
2553
 
    def _check(self, revision_ids):
2554
 
        result = check.Check(self)
2555
 
        result.check()
 
2754
    def _check(self, revision_ids, callback_refs, check_repo):
 
2755
        result = check.Check(self, check_repo=check_repo)
 
2756
        result.check(callback_refs)
2556
2757
        return result
2557
2758
 
2558
 
    def _warn_if_deprecated(self):
 
2759
    def _warn_if_deprecated(self, branch=None):
2559
2760
        global _deprecation_warning_done
2560
2761
        if _deprecation_warning_done:
2561
2762
            return
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))
 
2763
        try:
 
2764
            if branch is None:
 
2765
                conf = config.GlobalConfig()
 
2766
            else:
 
2767
                conf = branch.get_config()
 
2768
            if conf.suppress_warning('format_deprecation'):
 
2769
                return
 
2770
            warning("Format %s for %s is deprecated -"
 
2771
                    " please use 'bzr upgrade' to get better performance"
 
2772
                    % (self._format, self.bzrdir.transport.base))
 
2773
        finally:
 
2774
            _deprecation_warning_done = True
2565
2775
 
2566
2776
    def supports_rich_root(self):
2567
2777
        return self._format.rich_root_data
2848
3058
    # help), and for fetching when data won't have come from the same
2849
3059
    # compressor.
2850
3060
    pack_compresses = False
 
3061
    # Does the repository inventory storage understand references to trees?
 
3062
    supports_tree_reference = None
 
3063
    # Is the format experimental ?
 
3064
    experimental = False
2851
3065
 
2852
 
    def __str__(self):
2853
 
        return "<%s>" % self.__class__.__name__
 
3066
    def __repr__(self):
 
3067
        return "%s()" % self.__class__.__name__
2854
3068
 
2855
3069
    def __eq__(self, other):
2856
3070
        # format objects are generally stateless
2869
3083
        """
2870
3084
        try:
2871
3085
            transport = a_bzrdir.get_repository_transport(None)
2872
 
            format_string = transport.get("format").read()
 
3086
            format_string = transport.get_bytes("format")
2873
3087
            return format_registry.get(format_string)
2874
3088
        except errors.NoSuchFile:
2875
3089
            raise errors.NoRepositoryPresent(a_bzrdir)
2957
3171
        raise NotImplementedError(self.network_name)
2958
3172
 
2959
3173
    def check_conversion_target(self, target_format):
2960
 
        raise NotImplementedError(self.check_conversion_target)
 
3174
        if self.rich_root_data and not target_format.rich_root_data:
 
3175
            raise errors.BadConversionTarget(
 
3176
                'Does not support rich root data.', target_format,
 
3177
                from_format=self)
 
3178
        if (self.supports_tree_reference and 
 
3179
            not getattr(target_format, 'supports_tree_reference', False)):
 
3180
            raise errors.BadConversionTarget(
 
3181
                'Does not support nested trees', target_format,
 
3182
                from_format=self)
2961
3183
 
2962
3184
    def open(self, a_bzrdir, _found=False):
2963
3185
        """Return an instance of this format for the bzrdir a_bzrdir.
2966
3188
        """
2967
3189
        raise NotImplementedError(self.open)
2968
3190
 
 
3191
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
 
3192
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
 
3193
        hooks = BzrDir.hooks['post_repo_init']
 
3194
        if not hooks:
 
3195
            return
 
3196
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
 
3197
        for hook in hooks:
 
3198
            hook(params)
 
3199
 
2969
3200
 
2970
3201
class MetaDirRepositoryFormat(RepositoryFormat):
2971
3202
    """Common base class for the new repositories using the metadir layout."""
3176
3407
 
3177
3408
        :param revision_id: if None all content is copied, if NULL_REVISION no
3178
3409
                            content is copied.
3179
 
        :param pb: optional progress bar to use for progress reports. If not
3180
 
                   provided a default one will be created.
 
3410
        :param pb: ignored.
3181
3411
        :return: None.
3182
3412
        """
 
3413
        ui.ui_factory.warn_experimental_format_fetch(self)
3183
3414
        from bzrlib.fetch import RepoFetcher
 
3415
        # See <https://launchpad.net/bugs/456077> asking for a warning here
 
3416
        if self.source._format.network_name() != self.target._format.network_name():
 
3417
            ui.ui_factory.show_user_warning('cross_format_fetch',
 
3418
                from_format=self.source._format,
 
3419
                to_format=self.target._format)
3184
3420
        f = RepoFetcher(to_repository=self.target,
3185
3421
                               from_repository=self.source,
3186
3422
                               last_revision=revision_id,
3187
3423
                               fetch_spec=fetch_spec,
3188
 
                               pb=pb, find_ghosts=find_ghosts)
 
3424
                               find_ghosts=find_ghosts)
3189
3425
 
3190
3426
    def _walk_to_common_revisions(self, revision_ids):
3191
3427
        """Walk out from revision_ids in source to revisions target has.
3360
3596
                self.target.texts.insert_record_stream(
3361
3597
                    self.source.texts.get_record_stream(
3362
3598
                        self.source.texts.keys(), 'topological', False))
3363
 
                pb.update('copying inventory', 0, 1)
 
3599
                pb.update('Copying inventory', 0, 1)
3364
3600
                self.target.inventories.insert_record_stream(
3365
3601
                    self.source.inventories.get_record_stream(
3366
3602
                        self.source.inventories.keys(), 'topological', False))
3492
3728
        # This is redundant with format.check_conversion_target(), however that
3493
3729
        # raises an exception, and we just want to say "False" as in we won't
3494
3730
        # support converting between these formats.
 
3731
        if 'IDS_never' in debug.debug_flags:
 
3732
            return False
3495
3733
        if source.supports_rich_root() and not target.supports_rich_root():
3496
3734
            return False
3497
3735
        if (source._format.supports_tree_reference
3498
3736
            and not target._format.supports_tree_reference):
3499
3737
            return False
 
3738
        if target._fallback_repositories and target._format.supports_chks:
 
3739
            # IDS doesn't know how to copy CHKs for the parent inventories it
 
3740
            # adds to stacked repos.
 
3741
            return False
 
3742
        if 'IDS_always' in debug.debug_flags:
 
3743
            return True
 
3744
        # Only use this code path for local source and target.  IDS does far
 
3745
        # too much IO (both bandwidth and roundtrips) over a network.
 
3746
        if not source.bzrdir.transport.base.startswith('file:///'):
 
3747
            return False
 
3748
        if not target.bzrdir.transport.base.startswith('file:///'):
 
3749
            return False
3500
3750
        return True
3501
3751
 
3502
 
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
 
3752
    def _get_trees(self, revision_ids, cache):
 
3753
        possible_trees = []
 
3754
        for rev_id in revision_ids:
 
3755
            if rev_id in cache:
 
3756
                possible_trees.append((rev_id, cache[rev_id]))
 
3757
            else:
 
3758
                # Not cached, but inventory might be present anyway.
 
3759
                try:
 
3760
                    tree = self.source.revision_tree(rev_id)
 
3761
                except errors.NoSuchRevision:
 
3762
                    # Nope, parent is ghost.
 
3763
                    pass
 
3764
                else:
 
3765
                    cache[rev_id] = tree
 
3766
                    possible_trees.append((rev_id, tree))
 
3767
        return possible_trees
 
3768
 
 
3769
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
3503
3770
        """Get the best delta and base for this revision.
3504
3771
 
3505
3772
        :return: (basis_id, delta)
3506
3773
        """
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]))
3514
3774
        deltas = []
 
3775
        # Generate deltas against each tree, to find the shortest.
 
3776
        texts_possibly_new_in_tree = set()
3515
3777
        for basis_id, basis_tree in possible_trees:
3516
3778
            delta = tree.inventory._make_delta(basis_tree.inventory)
 
3779
            for old_path, new_path, file_id, new_entry in delta:
 
3780
                if new_path is None:
 
3781
                    # This file_id isn't present in the new rev, so we don't
 
3782
                    # care about it.
 
3783
                    continue
 
3784
                if not new_path:
 
3785
                    # Rich roots are handled elsewhere...
 
3786
                    continue
 
3787
                kind = new_entry.kind
 
3788
                if kind != 'directory' and kind != 'file':
 
3789
                    # No text record associated with this inventory entry.
 
3790
                    continue
 
3791
                # This is a directory or file that has changed somehow.
 
3792
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3517
3793
            deltas.append((len(delta), basis_id, delta))
3518
3794
        deltas.sort()
3519
3795
        return deltas[0][1:]
3520
3796
 
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):
 
3797
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
 
3798
        """Find all parent revisions that are absent, but for which the
 
3799
        inventory is present, and copy those inventories.
 
3800
 
 
3801
        This is necessary to preserve correctness when the source is stacked
 
3802
        without fallbacks configured.  (Note that in cases like upgrade the
 
3803
        source may be not have _fallback_repositories even though it is
 
3804
        stacked.)
 
3805
        """
 
3806
        parent_revs = set()
 
3807
        for parents in parent_map.values():
 
3808
            parent_revs.update(parents)
 
3809
        present_parents = self.source.get_parent_map(parent_revs)
 
3810
        absent_parents = set(parent_revs).difference(present_parents)
 
3811
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
 
3812
            (rev_id,) for rev_id in absent_parents)
 
3813
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
 
3814
        for parent_tree in self.source.revision_trees(parent_inv_ids):
 
3815
            current_revision_id = parent_tree.get_revision_id()
 
3816
            parents_parents_keys = parent_invs_keys_for_stacking[
 
3817
                (current_revision_id,)]
 
3818
            parents_parents = [key[-1] for key in parents_parents_keys]
 
3819
            basis_id = _mod_revision.NULL_REVISION
 
3820
            basis_tree = self.source.revision_tree(basis_id)
 
3821
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
 
3822
            self.target.add_inventory_by_delta(
 
3823
                basis_id, delta, current_revision_id, parents_parents)
 
3824
            cache[current_revision_id] = parent_tree
 
3825
 
 
3826
    def _fetch_batch(self, revision_ids, basis_id, cache, a_graph=None):
3579
3827
        """Fetch across a few revisions.
3580
3828
 
3581
3829
        :param revision_ids: The revisions to copy
3582
3830
        :param basis_id: The revision_id of a tree that must be in cache, used
3583
3831
            as a basis for delta when no other base is available
3584
3832
        :param cache: A cache of RevisionTrees that we can use.
 
3833
        :param a_graph: A Graph object to determine the heads() of the
 
3834
            rich-root data stream.
3585
3835
        :return: The revision_id of the last converted tree. The RevisionTree
3586
3836
            for it will be in cache
3587
3837
        """
3593
3843
        pending_deltas = []
3594
3844
        pending_revisions = []
3595
3845
        parent_map = self.source.get_parent_map(revision_ids)
 
3846
        self._fetch_parent_invs_for_stacking(parent_map, cache)
 
3847
        self.source._safe_to_return_from_cache = True
3596
3848
        for tree in self.source.revision_trees(revision_ids):
 
3849
            # Find a inventory delta for this revision.
 
3850
            # Find text entries that need to be copied, too.
3597
3851
            current_revision_id = tree.get_revision_id()
3598
3852
            parent_ids = parent_map.get(current_revision_id, ())
 
3853
            parent_trees = self._get_trees(parent_ids, cache)
 
3854
            possible_trees = list(parent_trees)
 
3855
            if len(possible_trees) == 0:
 
3856
                # There either aren't any parents, or the parents are ghosts,
 
3857
                # so just use the last converted tree.
 
3858
                possible_trees.append((basis_id, cache[basis_id]))
3599
3859
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3600
 
                                                           basis_id, cache)
 
3860
                                                           possible_trees)
 
3861
            revision = self.source.get_revision(current_revision_id)
 
3862
            pending_deltas.append((basis_id, delta,
 
3863
                current_revision_id, revision.parent_ids))
3601
3864
            if self._converting_to_rich_root:
3602
3865
                self._revision_id_to_root_id[current_revision_id] = \
3603
3866
                    tree.get_root_id()
3604
 
            # Find text entries that need to be copied
 
3867
            # Determine which texts are in present in this revision but not in
 
3868
            # any of the available parents.
 
3869
            texts_possibly_new_in_tree = set()
3605
3870
            for old_path, new_path, file_id, entry in delta:
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))
 
3871
                if new_path is None:
 
3872
                    # This file_id isn't present in the new rev
 
3873
                    continue
 
3874
                if not new_path:
 
3875
                    # This is the root
 
3876
                    if not self.target.supports_rich_root():
 
3877
                        # The target doesn't support rich root, so we don't
 
3878
                        # copy
 
3879
                        continue
 
3880
                    if self._converting_to_rich_root:
 
3881
                        # This can't be copied normally, we have to insert
 
3882
                        # it specially
 
3883
                        root_keys_to_create.add((file_id, entry.revision))
 
3884
                        continue
 
3885
                kind = entry.kind
 
3886
                texts_possibly_new_in_tree.add((file_id, entry.revision))
 
3887
            for basis_id, basis_tree in possible_trees:
 
3888
                basis_inv = basis_tree.inventory
 
3889
                for file_key in list(texts_possibly_new_in_tree):
 
3890
                    file_id, file_revision = file_key
 
3891
                    try:
 
3892
                        entry = basis_inv[file_id]
 
3893
                    except errors.NoSuchId:
 
3894
                        continue
 
3895
                    if entry.revision == file_revision:
 
3896
                        texts_possibly_new_in_tree.remove(file_key)
 
3897
            text_keys.update(texts_possibly_new_in_tree)
3622
3898
            pending_revisions.append(revision)
3623
3899
            cache[current_revision_id] = tree
3624
3900
            basis_id = current_revision_id
 
3901
        self.source._safe_to_return_from_cache = False
3625
3902
        # Copy file texts
3626
3903
        from_texts = self.source.texts
3627
3904
        to_texts = self.target.texts
3628
3905
        if root_keys_to_create:
3629
 
            root_stream = self._new_root_data_stream(root_keys_to_create,
3630
 
                                                     parent_map)
 
3906
            root_stream = _mod_fetch._new_root_data_stream(
 
3907
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
 
3908
                self.source, graph=a_graph)
3631
3909
            to_texts.insert_record_stream(root_stream)
3632
3910
        to_texts.insert_record_stream(from_texts.get_record_stream(
3633
3911
            text_keys, self.target._format._fetch_order,
3640
3918
            # for the new revisions that we are about to insert.  We do this
3641
3919
            # before adding the revisions so that no revision is added until
3642
3920
            # all the inventories it may depend on are added.
 
3921
            # Note that this is overzealous, as we may have fetched these in an
 
3922
            # earlier batch.
3643
3923
            parent_ids = set()
3644
3924
            revision_ids = set()
3645
3925
            for revision in pending_revisions:
3648
3928
            parent_ids.difference_update(revision_ids)
3649
3929
            parent_ids.discard(_mod_revision.NULL_REVISION)
3650
3930
            parent_map = self.source.get_parent_map(parent_ids)
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)
 
3931
            # we iterate over parent_map and not parent_ids because we don't
 
3932
            # want to try copying any revision which is a ghost
 
3933
            for parent_tree in self.source.revision_trees(parent_map):
3653
3934
                current_revision_id = parent_tree.get_revision_id()
3654
3935
                parents_parents = parent_map[current_revision_id]
 
3936
                possible_trees = self._get_trees(parents_parents, cache)
 
3937
                if len(possible_trees) == 0:
 
3938
                    # There either aren't any parents, or the parents are
 
3939
                    # ghosts, so just use the last converted tree.
 
3940
                    possible_trees.append((basis_id, cache[basis_id]))
 
3941
                basis_id, delta = self._get_delta_for_revision(parent_tree,
 
3942
                    parents_parents, possible_trees)
3655
3943
                self.target.add_inventory_by_delta(
3656
3944
                    basis_id, delta, current_revision_id, parents_parents)
3657
3945
        # insert signatures and revisions
3671
3959
 
3672
3960
        :param revision_ids: The list of revisions to fetch. Must be in
3673
3961
            topological order.
3674
 
        :param pb: A ProgressBar
 
3962
        :param pb: A ProgressTask
3675
3963
        :return: None
3676
3964
        """
3677
3965
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3680
3968
        cache[basis_id] = basis_tree
3681
3969
        del basis_tree # We don't want to hang on to it here
3682
3970
        hints = []
 
3971
        if self._converting_to_rich_root and len(revision_ids) > 100:
 
3972
            a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
 
3973
                                                            revision_ids)
 
3974
        else:
 
3975
            a_graph = None
 
3976
 
3683
3977
        for offset in range(0, len(revision_ids), batch_size):
3684
3978
            self.target.start_write_group()
3685
3979
            try:
3686
3980
                pb.update('Transferring revisions', offset,
3687
3981
                          len(revision_ids))
3688
3982
                batch = revision_ids[offset:offset+batch_size]
3689
 
                basis_id = self._fetch_batch(batch, basis_id, cache)
 
3983
                basis_id = self._fetch_batch(batch, basis_id, cache,
 
3984
                                             a_graph=a_graph)
3690
3985
            except:
 
3986
                self.source._safe_to_return_from_cache = False
3691
3987
                self.target.abort_write_group()
3692
3988
                raise
3693
3989
            else:
3705
4001
        """See InterRepository.fetch()."""
3706
4002
        if fetch_spec is not None:
3707
4003
            raise AssertionError("Not implemented yet...")
 
4004
        ui.ui_factory.warn_experimental_format_fetch(self)
3708
4005
        if (not self.source.supports_rich_root()
3709
4006
            and self.target.supports_rich_root()):
3710
4007
            self._converting_to_rich_root = True
3711
4008
            self._revision_id_to_root_id = {}
3712
4009
        else:
3713
4010
            self._converting_to_rich_root = False
 
4011
        # See <https://launchpad.net/bugs/456077> asking for a warning here
 
4012
        if self.source._format.network_name() != self.target._format.network_name():
 
4013
            ui.ui_factory.show_user_warning('cross_format_fetch',
 
4014
                from_format=self.source._format,
 
4015
                to_format=self.target._format)
3714
4016
        revision_ids = self.target.search_missing_revision_ids(self.source,
3715
4017
            revision_id, find_ghosts=find_ghosts).get_keys()
3716
4018
        if not revision_ids:
3722
4024
        # Walk though all revisions; get inventory deltas, copy referenced
3723
4025
        # texts that delta references, insert the delta, revision and
3724
4026
        # signature.
3725
 
        first_rev = self.source.get_revision(revision_ids[0])
3726
4027
        if pb is None:
3727
4028
            my_pb = ui.ui_factory.nested_progress_bar()
3728
4029
            pb = my_pb
3786
4087
        :param to_convert: The disk object to convert.
3787
4088
        :param pb: a progress bar to use for progress information.
3788
4089
        """
3789
 
        self.pb = pb
 
4090
        pb = ui.ui_factory.nested_progress_bar()
3790
4091
        self.count = 0
3791
4092
        self.total = 4
3792
4093
        # this is only useful with metadir layouts - separated repo content.
3793
4094
        # trigger an assertion if not such
3794
4095
        repo._format.get_format_string()
3795
4096
        self.repo_dir = repo.bzrdir
3796
 
        self.step('Moving repository to repository.backup')
 
4097
        pb.update('Moving repository to repository.backup')
3797
4098
        self.repo_dir.transport.move('repository', 'repository.backup')
3798
4099
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
3799
4100
        repo._format.check_conversion_target(self.target_format)
3800
4101
        self.source_repo = repo._format.open(self.repo_dir,
3801
4102
            _found=True,
3802
4103
            _override_transport=backup_transport)
3803
 
        self.step('Creating new repository')
 
4104
        pb.update('Creating new repository')
3804
4105
        converted = self.target_format.initialize(self.repo_dir,
3805
4106
                                                  self.source_repo.is_shared())
3806
4107
        converted.lock_write()
3807
4108
        try:
3808
 
            self.step('Copying content into repository.')
 
4109
            pb.update('Copying content')
3809
4110
            self.source_repo.copy_content_into(converted)
3810
4111
        finally:
3811
4112
            converted.unlock()
3812
 
        self.step('Deleting old repository content.')
 
4113
        pb.update('Deleting old repository content')
3813
4114
        self.repo_dir.transport.delete_tree('repository.backup')
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)
 
4115
        ui.ui_factory.note('repository converted')
 
4116
        pb.finished()
3820
4117
 
3821
4118
 
3822
4119
_unescape_map = {
3851
4148
 
3852
4149
class _VersionedFileChecker(object):
3853
4150
 
3854
 
    def __init__(self, repository, text_key_references=None):
 
4151
    def __init__(self, repository, text_key_references=None, ancestors=None):
3855
4152
        self.repository = repository
3856
4153
        self.text_index = self.repository._generate_text_key_index(
3857
 
            text_key_references=text_key_references)
 
4154
            text_key_references=text_key_references, ancestors=ancestors)
3858
4155
 
3859
4156
    def calculate_file_version_parents(self, text_key):
3860
4157
        """Calculate the correct parents for a file version according to
3878
4175
            revision_id) tuples for versions that are present in this versioned
3879
4176
            file, but not used by the corresponding inventory.
3880
4177
        """
 
4178
        local_progress = None
 
4179
        if progress_bar is None:
 
4180
            local_progress = ui.ui_factory.nested_progress_bar()
 
4181
            progress_bar = local_progress
 
4182
        try:
 
4183
            return self._check_file_version_parents(texts, progress_bar)
 
4184
        finally:
 
4185
            if local_progress:
 
4186
                local_progress.finished()
 
4187
 
 
4188
    def _check_file_version_parents(self, texts, progress_bar):
 
4189
        """See check_file_version_parents."""
3881
4190
        wrong_parents = {}
3882
4191
        self.file_ids = set([file_id for file_id, _ in
3883
4192
            self.text_index.iterkeys()])
3884
4193
        # text keys is now grouped by file_id
3885
 
        n_weaves = len(self.file_ids)
3886
 
        files_in_revisions = {}
3887
 
        revisions_of_files = {}
3888
4194
        n_versions = len(self.text_index)
3889
4195
        progress_bar.update('loading text store', 0, n_versions)
3890
4196
        parent_map = self.repository.texts.get_parent_map(self.text_index)
3892
4198
        text_keys = self.repository.texts.keys()
3893
4199
        unused_keys = frozenset(text_keys) - set(self.text_index)
3894
4200
        for num, key in enumerate(self.text_index.iterkeys()):
3895
 
            if progress_bar is not None:
3896
 
                progress_bar.update('checking text graph', num, n_versions)
 
4201
            progress_bar.update('checking text graph', num, n_versions)
3897
4202
            correct_parents = self.calculate_file_version_parents(key)
3898
4203
            try:
3899
4204
                knit_parents = parent_map[key]
3984
4289
            else:
3985
4290
                new_pack.set_write_cache_size(1024*1024)
3986
4291
        for substream_type, substream in stream:
 
4292
            if 'stream' in debug.debug_flags:
 
4293
                mutter('inserting substream: %s', substream_type)
3987
4294
            if substream_type == 'texts':
3988
4295
                self.target_repo.texts.insert_record_stream(substream)
3989
4296
            elif substream_type == 'inventories':
3993
4300
                else:
3994
4301
                    self._extract_and_insert_inventories(
3995
4302
                        substream, src_serializer)
 
4303
            elif substream_type == 'inventory-deltas':
 
4304
                self._extract_and_insert_inventory_deltas(
 
4305
                    substream, src_serializer)
3996
4306
            elif substream_type == 'chk_bytes':
3997
4307
                # XXX: This doesn't support conversions, as it assumes the
3998
4308
                #      conversion was done in the fetch code.
4029
4339
                ):
4030
4340
                if versioned_file is None:
4031
4341
                    continue
 
4342
                # TODO: key is often going to be a StaticTuple object
 
4343
                #       I don't believe we can define a method by which
 
4344
                #       (prefix,) + StaticTuple will work, though we could
 
4345
                #       define a StaticTuple.sq_concat that would allow you to
 
4346
                #       pass in either a tuple or a StaticTuple as the second
 
4347
                #       object, so instead we could have:
 
4348
                #       StaticTuple(prefix) + key here...
4032
4349
                missing_keys.update((prefix,) + key for key in
4033
4350
                    versioned_file.get_missing_compression_parent_keys())
4034
4351
        except NotImplementedError:
4049
4366
            self.target_repo.pack(hint=hint)
4050
4367
        return [], set()
4051
4368
 
4052
 
    def _extract_and_insert_inventories(self, substream, serializer):
 
4369
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
 
4370
        target_rich_root = self.target_repo._format.rich_root_data
 
4371
        target_tree_refs = self.target_repo._format.supports_tree_reference
 
4372
        for record in substream:
 
4373
            # Insert the delta directly
 
4374
            inventory_delta_bytes = record.get_bytes_as('fulltext')
 
4375
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
 
4376
            try:
 
4377
                parse_result = deserialiser.parse_text_bytes(
 
4378
                    inventory_delta_bytes)
 
4379
            except inventory_delta.IncompatibleInventoryDelta, err:
 
4380
                trace.mutter("Incompatible delta: %s", err.msg)
 
4381
                raise errors.IncompatibleRevision(self.target_repo._format)
 
4382
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
 
4383
            revision_id = new_id
 
4384
            parents = [key[0] for key in record.parents]
 
4385
            self.target_repo.add_inventory_by_delta(
 
4386
                basis_id, inv_delta, revision_id, parents)
 
4387
 
 
4388
    def _extract_and_insert_inventories(self, substream, serializer,
 
4389
            parse_delta=None):
4053
4390
        """Generate a new inventory versionedfile in target, converting data.
4054
4391
 
4055
4392
        The inventory is retrieved from the source, (deserializing it), and
4056
4393
        stored in the target (reserializing it in a different format).
4057
4394
        """
 
4395
        target_rich_root = self.target_repo._format.rich_root_data
 
4396
        target_tree_refs = self.target_repo._format.supports_tree_reference
4058
4397
        for record in substream:
 
4398
            # It's not a delta, so it must be a fulltext in the source
 
4399
            # serializer's format.
4059
4400
            bytes = record.get_bytes_as('fulltext')
4060
4401
            revision_id = record.key[0]
4061
4402
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4062
4403
            parents = [key[0] for key in record.parents]
4063
4404
            self.target_repo.add_inventory(revision_id, inv, parents)
 
4405
            # No need to keep holding this full inv in memory when the rest of
 
4406
            # the substream is likely to be all deltas.
 
4407
            del inv
4064
4408
 
4065
4409
    def _extract_and_insert_revisions(self, substream, serializer):
4066
4410
        for record in substream:
4115
4459
        return [('signatures', signatures), ('revisions', revisions)]
4116
4460
 
4117
4461
    def _generate_root_texts(self, revs):
4118
 
        """This will be called by __fetch between fetching weave texts and
 
4462
        """This will be called by get_stream between fetching weave texts and
4119
4463
        fetching the inventory weave.
4120
 
 
4121
 
        Subclasses should override this if they need to generate root texts
4122
 
        after fetching weave texts.
4123
4464
        """
4124
4465
        if self._rich_root_upgrade():
4125
 
            import bzrlib.fetch
4126
 
            return bzrlib.fetch.Inter1and2Helper(
 
4466
            return _mod_fetch.Inter1and2Helper(
4127
4467
                self.from_repository).generate_root_texts(revs)
4128
4468
        else:
4129
4469
            return []
4132
4472
        phase = 'file'
4133
4473
        revs = search.get_keys()
4134
4474
        graph = self.from_repository.get_graph()
4135
 
        revs = list(graph.iter_topo_order(revs))
 
4475
        revs = tsort.topo_sort(graph.get_parent_map(revs))
4136
4476
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4137
4477
        text_keys = []
4138
4478
        for knit_kind, file_id, revisions in data_to_fetch:
4157
4497
                # will be valid.
4158
4498
                for _ in self._generate_root_texts(revs):
4159
4499
                    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
4163
4500
                # we fetch only the referenced inventories because we do not
4164
4501
                # know for unselected inventories whether all their required
4165
4502
                # texts are present in the other repository - it could be
4204
4541
            if not keys:
4205
4542
                # No need to stream something we don't have
4206
4543
                continue
 
4544
            if substream_kind == 'inventories':
 
4545
                # Some missing keys are genuinely ghosts, filter those out.
 
4546
                present = self.from_repository.inventories.get_parent_map(keys)
 
4547
                revs = [key[0] for key in present]
 
4548
                # Get the inventory stream more-or-less as we do for the
 
4549
                # original stream; there's no reason to assume that records
 
4550
                # direct from the source will be suitable for the sink.  (Think
 
4551
                # e.g. 2a -> 1.9-rich-root).
 
4552
                for info in self._get_inventory_stream(revs, missing=True):
 
4553
                    yield info
 
4554
                continue
 
4555
 
4207
4556
            # Ask for full texts always so that we don't need more round trips
4208
4557
            # after this stream.
4209
4558
            # Some of the missing keys are genuinely ghosts, so filter absent
4224
4573
        return (not self.from_repository._format.rich_root_data and
4225
4574
            self.to_format.rich_root_data)
4226
4575
 
4227
 
    def _get_inventory_stream(self, revision_ids):
 
4576
    def _get_inventory_stream(self, revision_ids, missing=False):
4228
4577
        from_format = self.from_repository._format
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)
 
4578
        if (from_format.supports_chks and self.to_format.supports_chks and
 
4579
            from_format.network_name() == self.to_format.network_name()):
 
4580
            raise AssertionError(
 
4581
                "this case should be handled by GroupCHKStreamSource")
 
4582
        elif 'forceinvdeltas' in debug.debug_flags:
 
4583
            return self._get_convertable_inventory_stream(revision_ids,
 
4584
                    delta_versus_null=missing)
 
4585
        elif from_format.network_name() == self.to_format.network_name():
 
4586
            # Same format.
 
4587
            return self._get_simple_inventory_stream(revision_ids,
 
4588
                    missing=missing)
 
4589
        elif (not from_format.supports_chks and not self.to_format.supports_chks
 
4590
                and from_format._serializer == self.to_format._serializer):
 
4591
            # Essentially the same format.
 
4592
            return self._get_simple_inventory_stream(revision_ids,
 
4593
                    missing=missing)
4240
4594
        else:
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)
 
4595
            # Any time we switch serializations, we want to use an
 
4596
            # inventory-delta based approach.
 
4597
            return self._get_convertable_inventory_stream(revision_ids,
 
4598
                    delta_versus_null=missing)
4248
4599
 
4249
 
    def _get_simple_inventory_stream(self, revision_ids):
 
4600
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
 
4601
        # NB: This currently reopens the inventory weave in source;
 
4602
        # using a single stream interface instead would avoid this.
4250
4603
        from_weave = self.from_repository.inventories
 
4604
        if missing:
 
4605
            delta_closure = True
 
4606
        else:
 
4607
            delta_closure = not self.delta_on_metadata()
4251
4608
        yield ('inventories', from_weave.get_record_stream(
4252
4609
            [(rev_id,) for rev_id in revision_ids],
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):
 
4610
            self.inventory_fetch_order(), delta_closure))
 
4611
 
 
4612
    def _get_convertable_inventory_stream(self, revision_ids,
 
4613
                                          delta_versus_null=False):
 
4614
        # The two formats are sufficiently different that there is no fast
 
4615
        # path, so we need to send just inventorydeltas, which any
 
4616
        # sufficiently modern client can insert into any repository.
 
4617
        # The StreamSink code expects to be able to
 
4618
        # convert on the target, so we need to put bytes-on-the-wire that can
 
4619
        # be converted.  That means inventory deltas (if the remote is <1.19,
 
4620
        # RemoteStreamSink will fallback to VFS to insert the deltas).
 
4621
        yield ('inventory-deltas',
 
4622
           self._stream_invs_as_deltas(revision_ids,
 
4623
                                       delta_versus_null=delta_versus_null))
 
4624
 
 
4625
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
 
4626
        """Return a stream of inventory-deltas for the given rev ids.
 
4627
 
 
4628
        :param revision_ids: The list of inventories to transmit
 
4629
        :param delta_versus_null: Don't try to find a minimal delta for this
 
4630
            entry, instead compute the delta versus the NULL_REVISION. This
 
4631
            effectively streams a complete inventory. Used for stuff like
 
4632
            filling in missing parents, etc.
 
4633
        """
4330
4634
        from_repo = self.from_repository
4331
 
        from_serializer = from_repo._format._serializer
4332
4635
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4333
4636
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
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)
 
4637
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
 
4638
        # method...
 
4639
        inventories = self.from_repository.iter_inventories(
 
4640
            revision_ids, 'topological')
 
4641
        format = from_repo._format
 
4642
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
 
4643
        inventory_cache = lru_cache.LRUCache(50)
 
4644
        null_inventory = from_repo.revision_tree(
 
4645
            _mod_revision.NULL_REVISION).inventory
 
4646
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
 
4647
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
 
4648
        # repo back into a non-rich-root repo ought to be allowed)
 
4649
        serializer = inventory_delta.InventoryDeltaSerializer(
 
4650
            versioned_root=format.rich_root_data,
 
4651
            tree_references=format.supports_tree_reference)
 
4652
        for inv in inventories:
4346
4653
            key = (inv.revision_id,)
4347
4654
            parent_keys = parent_map.get(key, ())
 
4655
            delta = None
 
4656
            if not delta_versus_null and parent_keys:
 
4657
                # The caller did not ask for complete inventories and we have
 
4658
                # some parents that we can delta against.  Make a delta against
 
4659
                # each parent so that we can find the smallest.
 
4660
                parent_ids = [parent_key[0] for parent_key in parent_keys]
 
4661
                for parent_id in parent_ids:
 
4662
                    if parent_id not in invs_sent_so_far:
 
4663
                        # We don't know that the remote side has this basis, so
 
4664
                        # we can't use it.
 
4665
                        continue
 
4666
                    if parent_id == _mod_revision.NULL_REVISION:
 
4667
                        parent_inv = null_inventory
 
4668
                    else:
 
4669
                        parent_inv = inventory_cache.get(parent_id, None)
 
4670
                        if parent_inv is None:
 
4671
                            parent_inv = from_repo.get_inventory(parent_id)
 
4672
                    candidate_delta = inv._make_delta(parent_inv)
 
4673
                    if (delta is None or
 
4674
                        len(delta) > len(candidate_delta)):
 
4675
                        delta = candidate_delta
 
4676
                        basis_id = parent_id
 
4677
            if delta is None:
 
4678
                # Either none of the parents ended up being suitable, or we
 
4679
                # were asked to delta against NULL
 
4680
                basis_id = _mod_revision.NULL_REVISION
 
4681
                delta = inv._make_delta(null_inventory)
 
4682
            invs_sent_so_far.add(inv.revision_id)
 
4683
            inventory_cache[inv.revision_id] = inv
 
4684
            delta_serialized = ''.join(
 
4685
                serializer.delta_to_lines(basis_id, key[-1], delta))
4348
4686
            yield versionedfile.FulltextContentFactory(
4349
 
                key, parent_keys, None, as_bytes)
 
4687
                key, parent_keys, None, delta_serialized)
4350
4688
 
4351
4689
 
4352
4690
def _iter_for_revno(repo, partial_history_cache, stop_index=None,