/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Robert Collins
  • Date: 2009-07-02 07:22:27 UTC
  • mto: This revision was merged to the branch mainline in revision 4505.
  • Revision ID: robertc@robertcollins.net-20090702072227-a2yzortdrjcnls5c
Add documentation describing how and why we use inventory deltas, and what can go wrong with them.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
24
24
    bzrdir,
25
25
    check,
26
26
    chk_map,
27
 
    config,
28
27
    debug,
29
28
    errors,
30
 
    fetch as _mod_fetch,
31
29
    fifo_cache,
32
30
    generate_ids,
33
31
    gpg,
34
32
    graph,
35
33
    inventory,
36
 
    inventory_delta,
37
34
    lazy_regex,
38
35
    lockable_files,
39
36
    lockdir,
40
37
    lru_cache,
41
38
    osutils,
42
39
    revision as _mod_revision,
43
 
    static_tuple,
44
40
    symbol_versioning,
45
 
    trace,
46
41
    tsort,
47
42
    ui,
48
43
    versionedfile,
53
48
from bzrlib.testament import Testament
54
49
""")
55
50
 
56
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
51
from bzrlib.decorators import needs_read_lock, needs_write_lock
57
52
from bzrlib.inter import InterObject
58
53
from bzrlib.inventory import (
59
54
    Inventory,
61
56
    ROOT_ID,
62
57
    entry_factory,
63
58
    )
64
 
from bzrlib.lock import _RelockDebugMixin
65
59
from bzrlib import registry
 
60
from bzrlib.symbol_versioning import (
 
61
        deprecated_method,
 
62
        )
66
63
from bzrlib.trace import (
67
64
    log_exception_quietly, note, mutter, mutter_callsite, warning)
68
65
 
210
207
            # an inventory delta was accumulated without creating a new
211
208
            # inventory.
212
209
            basis_id = self.basis_delta_revision
213
 
            # We ignore the 'inventory' returned by add_inventory_by_delta
214
 
            # because self.new_inventory is used to hint to the rest of the
215
 
            # system what code path was taken
216
 
            self.inv_sha1, _ = self.repository.add_inventory_by_delta(
 
210
            self.inv_sha1 = self.repository.add_inventory_by_delta(
217
211
                basis_id, self._basis_delta, self._new_revision_id,
218
212
                self.parents)
219
213
        else:
473
467
            if content_summary[2] is None:
474
468
                raise ValueError("Files must not have executable = None")
475
469
            if not store:
476
 
                # We can't trust a check of the file length because of content
477
 
                # filtering...
478
 
                if (# if the exec bit has changed we have to store:
 
470
                if (# if the file length changed we have to store:
 
471
                    parent_entry.text_size != content_summary[1] or
 
472
                    # if the exec bit has changed we have to store:
479
473
                    parent_entry.executable != content_summary[2]):
480
474
                    store = True
481
475
                elif parent_entry.text_sha1 == content_summary[3]:
548
542
                ie.revision = parent_entry.revision
549
543
                return self._get_delta(ie, basis_inv, path), False, None
550
544
            ie.reference_revision = content_summary[3]
551
 
            if ie.reference_revision is None:
552
 
                raise AssertionError("invalid content_summary for nested tree: %r"
553
 
                    % (content_summary,))
554
545
            self._add_text_to_weave(ie.file_id, '', heads, None)
555
546
        else:
556
547
            raise NotImplementedError('unknown kind')
797
788
                        # references.
798
789
                        raise errors.UnsupportedOperation(tree.add_reference,
799
790
                            self.repository)
800
 
                    reference_revision = tree.get_reference_revision(change[0])
801
 
                    entry.reference_revision = reference_revision
 
791
                    entry.reference_revision = \
 
792
                        tree.get_reference_revision(change[0])
802
793
                    if (carry_over_possible and
803
794
                        parent_entry.reference_revision == reference_revision):
804
795
                        carried_over = True
818
809
                seen_root = True
819
810
        self.new_inventory = None
820
811
        if len(inv_delta):
821
 
            # This should perhaps be guarded by a check that the basis we
822
 
            # commit against is the basis for the commit and if not do a delta
823
 
            # against the basis.
824
812
            self._any_changes = True
825
813
        if not seen_root:
826
814
            # housekeeping root entry changes do not affect no-change commits.
863
851
######################################################################
864
852
# Repositories
865
853
 
866
 
 
867
 
class Repository(_RelockDebugMixin, bzrdir.ControlComponent):
 
854
class Repository(object):
868
855
    """Repository holding history for one or more branches.
869
856
 
870
857
    The repository holds and retrieves historical information including
939
926
        """
940
927
        if self._write_group is not self.get_transaction():
941
928
            # has an unlock or relock occured ?
942
 
            if suppress_errors:
943
 
                mutter(
944
 
                '(suppressed) mismatched lock context and write group. %r, %r',
945
 
                self._write_group, self.get_transaction())
946
 
                return
947
929
            raise errors.BzrError(
948
930
                'mismatched lock context and write group. %r, %r' %
949
931
                (self._write_group, self.get_transaction()))
1028
1010
 
1029
1011
        :seealso: add_inventory, for the contract.
1030
1012
        """
1031
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
 
1013
        inv_lines = self._serialise_inventory_to_lines(inv)
1032
1014
        return self._inventory_add_lines(revision_id, parents,
1033
1015
            inv_lines, check_content=False)
1034
1016
 
1083
1065
        check_content=True):
1084
1066
        """Store lines in inv_vf and return the sha1 of the inventory."""
1085
1067
        parents = [(parent,) for parent in parents]
1086
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
1068
        return self.inventories.add_lines((revision_id,), parents, lines,
1087
1069
            check_content=check_content)[0]
1088
 
        self.inventories._access.flush()
1089
 
        return result
1090
1070
 
1091
1071
    def add_revision(self, revision_id, rev, inv=None, config=None):
1092
1072
        """Add rev to the revision store as revision_id.
1168
1148
        # The old API returned a list, should this actually be a set?
1169
1149
        return parent_map.keys()
1170
1150
 
1171
 
    def _check_inventories(self, checker):
1172
 
        """Check the inventories found from the revision scan.
1173
 
        
1174
 
        This is responsible for verifying the sha1 of inventories and
1175
 
        creating a pending_keys set that covers data referenced by inventories.
1176
 
        """
1177
 
        bar = ui.ui_factory.nested_progress_bar()
1178
 
        try:
1179
 
            self._do_check_inventories(checker, bar)
1180
 
        finally:
1181
 
            bar.finished()
1182
 
 
1183
 
    def _do_check_inventories(self, checker, bar):
1184
 
        """Helper for _check_inventories."""
1185
 
        revno = 0
1186
 
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
1187
 
        kinds = ['chk_bytes', 'texts']
1188
 
        count = len(checker.pending_keys)
1189
 
        bar.update("inventories", 0, 2)
1190
 
        current_keys = checker.pending_keys
1191
 
        checker.pending_keys = {}
1192
 
        # Accumulate current checks.
1193
 
        for key in current_keys:
1194
 
            if key[0] != 'inventories' and key[0] not in kinds:
1195
 
                checker._report_items.append('unknown key type %r' % (key,))
1196
 
            keys[key[0]].add(key[1:])
1197
 
        if keys['inventories']:
1198
 
            # NB: output order *should* be roughly sorted - topo or
1199
 
            # inverse topo depending on repository - either way decent
1200
 
            # to just delta against. However, pre-CHK formats didn't
1201
 
            # try to optimise inventory layout on disk. As such the
1202
 
            # pre-CHK code path does not use inventory deltas.
1203
 
            last_object = None
1204
 
            for record in self.inventories.check(keys=keys['inventories']):
1205
 
                if record.storage_kind == 'absent':
1206
 
                    checker._report_items.append(
1207
 
                        'Missing inventory {%s}' % (record.key,))
1208
 
                else:
1209
 
                    last_object = self._check_record('inventories', record,
1210
 
                        checker, last_object,
1211
 
                        current_keys[('inventories',) + record.key])
1212
 
            del keys['inventories']
1213
 
        else:
1214
 
            return
1215
 
        bar.update("texts", 1)
1216
 
        while (checker.pending_keys or keys['chk_bytes']
1217
 
            or keys['texts']):
1218
 
            # Something to check.
1219
 
            current_keys = checker.pending_keys
1220
 
            checker.pending_keys = {}
1221
 
            # Accumulate current checks.
1222
 
            for key in current_keys:
1223
 
                if key[0] not in kinds:
1224
 
                    checker._report_items.append('unknown key type %r' % (key,))
1225
 
                keys[key[0]].add(key[1:])
1226
 
            # Check the outermost kind only - inventories || chk_bytes || texts
1227
 
            for kind in kinds:
1228
 
                if keys[kind]:
1229
 
                    last_object = None
1230
 
                    for record in getattr(self, kind).check(keys=keys[kind]):
1231
 
                        if record.storage_kind == 'absent':
1232
 
                            checker._report_items.append(
1233
 
                                'Missing %s {%s}' % (kind, record.key,))
1234
 
                        else:
1235
 
                            last_object = self._check_record(kind, record,
1236
 
                                checker, last_object, current_keys[(kind,) + record.key])
1237
 
                    keys[kind] = set()
1238
 
                    break
1239
 
 
1240
 
    def _check_record(self, kind, record, checker, last_object, item_data):
1241
 
        """Check a single text from this repository."""
1242
 
        if kind == 'inventories':
1243
 
            rev_id = record.key[0]
1244
 
            inv = self._deserialise_inventory(rev_id,
1245
 
                record.get_bytes_as('fulltext'))
1246
 
            if last_object is not None:
1247
 
                delta = inv._make_delta(last_object)
1248
 
                for old_path, path, file_id, ie in delta:
1249
 
                    if ie is None:
1250
 
                        continue
1251
 
                    ie.check(checker, rev_id, inv)
1252
 
            else:
1253
 
                for path, ie in inv.iter_entries():
1254
 
                    ie.check(checker, rev_id, inv)
1255
 
            if self._format.fast_deltas:
1256
 
                return inv
1257
 
        elif kind == 'chk_bytes':
1258
 
            # No code written to check chk_bytes for this repo format.
1259
 
            checker._report_items.append(
1260
 
                'unsupported key type chk_bytes for %s' % (record.key,))
1261
 
        elif kind == 'texts':
1262
 
            self._check_text(record, checker, item_data)
1263
 
        else:
1264
 
            checker._report_items.append(
1265
 
                'unknown key type %s for %s' % (kind, record.key))
1266
 
 
1267
 
    def _check_text(self, record, checker, item_data):
1268
 
        """Check a single text."""
1269
 
        # Check it is extractable.
1270
 
        # TODO: check length.
1271
 
        if record.storage_kind == 'chunked':
1272
 
            chunks = record.get_bytes_as(record.storage_kind)
1273
 
            sha1 = osutils.sha_strings(chunks)
1274
 
            length = sum(map(len, chunks))
1275
 
        else:
1276
 
            content = record.get_bytes_as('fulltext')
1277
 
            sha1 = osutils.sha_string(content)
1278
 
            length = len(content)
1279
 
        if item_data and sha1 != item_data[1]:
1280
 
            checker._report_items.append(
1281
 
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
1282
 
                (record.key, sha1, item_data[1], item_data[2]))
1283
 
 
1284
1151
    @staticmethod
1285
1152
    def create(a_bzrdir):
1286
1153
        """Construct the current default format repository in a_bzrdir."""
1291
1158
 
1292
1159
        :param _format: The format of the repository on disk.
1293
1160
        :param a_bzrdir: The BzrDir of the repository.
 
1161
 
 
1162
        In the future we will have a single api for all stores for
 
1163
        getting file texts, inventories and revisions, then
 
1164
        this construct will accept instances of those things.
1294
1165
        """
1295
 
        # In the future we will have a single api for all stores for
1296
 
        # getting file texts, inventories and revisions, then
1297
 
        # this construct will accept instances of those things.
1298
1166
        super(Repository, self).__init__()
1299
1167
        self._format = _format
1300
1168
        # the following are part of the public API for Repository:
1306
1174
        self._reconcile_does_inventory_gc = True
1307
1175
        self._reconcile_fixes_text_parents = False
1308
1176
        self._reconcile_backsup_inventory = True
 
1177
        # not right yet - should be more semantically clear ?
 
1178
        #
 
1179
        # TODO: make sure to construct the right store classes, etc, depending
 
1180
        # on whether escaping is required.
 
1181
        self._warn_if_deprecated()
1309
1182
        self._write_group = None
1310
1183
        # Additional places to query for data.
1311
1184
        self._fallback_repositories = []
1312
1185
        # An InventoryEntry cache, used during deserialization
1313
1186
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
1314
 
        # Is it safe to return inventory entries directly from the entry cache,
1315
 
        # rather copying them?
1316
 
        self._safe_to_return_from_cache = False
1317
 
 
1318
 
    @property
1319
 
    def user_transport(self):
1320
 
        return self.bzrdir.user_transport
1321
 
 
1322
 
    @property
1323
 
    def control_transport(self):
1324
 
        return self._transport
1325
1187
 
1326
1188
    def __repr__(self):
1327
 
        if self._fallback_repositories:
1328
 
            return '%s(%r, fallback_repositories=%r)' % (
1329
 
                self.__class__.__name__,
1330
 
                self.base,
1331
 
                self._fallback_repositories)
1332
 
        else:
1333
 
            return '%s(%r)' % (self.__class__.__name__,
1334
 
                               self.base)
1335
 
 
1336
 
    def _has_same_fallbacks(self, other_repo):
1337
 
        """Returns true if the repositories have the same fallbacks."""
1338
 
        my_fb = self._fallback_repositories
1339
 
        other_fb = other_repo._fallback_repositories
1340
 
        if len(my_fb) != len(other_fb):
1341
 
            return False
1342
 
        for f, g in zip(my_fb, other_fb):
1343
 
            if not f.has_same_location(g):
1344
 
                return False
1345
 
        return True
 
1189
        return '%s(%r)' % (self.__class__.__name__,
 
1190
                           self.base)
1346
1191
 
1347
1192
    def has_same_location(self, other):
1348
1193
        """Returns a boolean indicating if this repository is at the same
1394
1239
        locked = self.is_locked()
1395
1240
        result = self.control_files.lock_write(token=token)
1396
1241
        if not locked:
1397
 
            self._warn_if_deprecated()
1398
 
            self._note_lock('w')
1399
1242
            for repo in self._fallback_repositories:
1400
1243
                # Writes don't affect fallback repos
1401
1244
                repo.lock_read()
1406
1249
        locked = self.is_locked()
1407
1250
        self.control_files.lock_read()
1408
1251
        if not locked:
1409
 
            self._warn_if_deprecated()
1410
 
            self._note_lock('r')
1411
1252
            for repo in self._fallback_repositories:
1412
1253
                repo.lock_read()
1413
1254
            self._refresh_data()
1476
1317
 
1477
1318
        # now gather global repository information
1478
1319
        # XXX: This is available for many repos regardless of listability.
1479
 
        if self.user_transport.listable():
 
1320
        if self.bzrdir.root_transport.listable():
1480
1321
            # XXX: do we want to __define len__() ?
1481
1322
            # Maybe the versionedfiles object should provide a different
1482
1323
            # method to get the number of keys.
1492
1333
        :param using: If True, list only branches using this repository.
1493
1334
        """
1494
1335
        if using and not self.is_shared():
1495
 
            return self.bzrdir.list_branches()
 
1336
            try:
 
1337
                return [self.bzrdir.open_branch()]
 
1338
            except errors.NotBranchError:
 
1339
                return []
1496
1340
        class Evaluator(object):
1497
1341
 
1498
1342
            def __init__(self):
1507
1351
                    except errors.NoRepositoryPresent:
1508
1352
                        pass
1509
1353
                    else:
1510
 
                        return False, ([], repository)
 
1354
                        return False, (None, repository)
1511
1355
                self.first_call = False
1512
 
                value = (bzrdir.list_branches(), None)
 
1356
                try:
 
1357
                    value = (bzrdir.open_branch(), None)
 
1358
                except errors.NotBranchError:
 
1359
                    value = (None, None)
1513
1360
                return True, value
1514
1361
 
1515
 
        ret = []
1516
 
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
1517
 
                self.user_transport, evaluate=Evaluator()):
1518
 
            if branches is not None:
1519
 
                ret.extend(branches)
 
1362
        branches = []
 
1363
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1364
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
1365
            if branch is not None:
 
1366
                branches.append(branch)
1520
1367
            if not using and repository is not None:
1521
 
                ret.extend(repository.find_branches())
1522
 
        return ret
 
1368
                branches.extend(repository.find_branches())
 
1369
        return branches
1523
1370
 
1524
1371
    @needs_read_lock
1525
1372
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1554
1401
        """Commit the contents accrued within the current write group.
1555
1402
 
1556
1403
        :seealso: start_write_group.
1557
 
        
1558
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1559
1404
        """
1560
1405
        if self._write_group is not self.get_transaction():
1561
1406
            # has an unlock or relock occured ?
1615
1460
        # but at the moment we're only checking for texts referenced by
1616
1461
        # inventories at the graph's edge.
1617
1462
        key_deps = self.revisions._index._key_dependencies
1618
 
        key_deps.satisfy_refs_for_keys(present_inventories)
 
1463
        key_deps.add_keys(present_inventories)
1619
1464
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1620
1465
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1621
1466
        missing_texts = set()
1687
1532
            raise errors.InternalBzrError(
1688
1533
                "May not fetch while in a write group.")
1689
1534
        # fast path same-url fetch operations
1690
 
        # TODO: lift out to somewhere common with RemoteRepository
1691
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401646>
1692
 
        if (self.has_same_location(source)
1693
 
            and fetch_spec is None
1694
 
            and self._has_same_fallbacks(source)):
 
1535
        if self.has_same_location(source) and fetch_spec is None:
1695
1536
            # check that last_revision is in 'from' and then return a
1696
1537
            # no-operation.
1697
1538
            if (revision_id is not None and
1722
1563
        :param revprops: Optional dictionary of revision properties.
1723
1564
        :param revision_id: Optional revision id.
1724
1565
        """
1725
 
        if self._fallback_repositories:
1726
 
            raise errors.BzrError("Cannot commit from a lightweight checkout "
1727
 
                "to a stacked branch. See "
1728
 
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1729
1566
        result = self._commit_builder_class(self, parents, config,
1730
1567
            timestamp, timezone, committer, revprops, revision_id)
1731
1568
        self.start_write_group()
1732
1569
        return result
1733
1570
 
1734
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1735
1571
    def unlock(self):
1736
1572
        if (self.control_files._lock_count == 1 and
1737
1573
            self.control_files._lock_mode == 'w'):
1859
1695
 
1860
1696
    @needs_read_lock
1861
1697
    def get_revisions(self, revision_ids):
1862
 
        """Get many revisions at once.
1863
 
        
1864
 
        Repositories that need to check data on every revision read should 
1865
 
        subclass this method.
1866
 
        """
 
1698
        """Get many revisions at once."""
1867
1699
        return self._get_revisions(revision_ids)
1868
1700
 
1869
1701
    @needs_read_lock
1870
1702
    def _get_revisions(self, revision_ids):
1871
1703
        """Core work logic to get many revisions without sanity checks."""
 
1704
        for rev_id in revision_ids:
 
1705
            if not rev_id or not isinstance(rev_id, basestring):
 
1706
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1707
        keys = [(key,) for key in revision_ids]
 
1708
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1872
1709
        revs = {}
1873
 
        for revid, rev in self._iter_revisions(revision_ids):
1874
 
            if rev is None:
1875
 
                raise errors.NoSuchRevision(self, revid)
1876
 
            revs[revid] = rev
 
1710
        for record in stream:
 
1711
            if record.storage_kind == 'absent':
 
1712
                raise errors.NoSuchRevision(self, record.key[0])
 
1713
            text = record.get_bytes_as('fulltext')
 
1714
            rev = self._serializer.read_revision_from_string(text)
 
1715
            revs[record.key[0]] = rev
1877
1716
        return [revs[revid] for revid in revision_ids]
1878
1717
 
1879
 
    def _iter_revisions(self, revision_ids):
1880
 
        """Iterate over revision objects.
1881
 
 
1882
 
        :param revision_ids: An iterable of revisions to examine. None may be
1883
 
            passed to request all revisions known to the repository. Note that
1884
 
            not all repositories can find unreferenced revisions; for those
1885
 
            repositories only referenced ones will be returned.
1886
 
        :return: An iterator of (revid, revision) tuples. Absent revisions (
1887
 
            those asked for but not available) are returned as (revid, None).
1888
 
        """
1889
 
        if revision_ids is None:
1890
 
            revision_ids = self.all_revision_ids()
1891
 
        else:
1892
 
            for rev_id in revision_ids:
1893
 
                if not rev_id or not isinstance(rev_id, basestring):
1894
 
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1895
 
        keys = [(key,) for key in revision_ids]
1896
 
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1897
 
        for record in stream:
1898
 
            revid = record.key[0]
1899
 
            if record.storage_kind == 'absent':
1900
 
                yield (revid, None)
1901
 
            else:
1902
 
                text = record.get_bytes_as('fulltext')
1903
 
                rev = self._serializer.read_revision_from_string(text)
1904
 
                yield (revid, rev)
 
1718
    @needs_read_lock
 
1719
    def get_revision_xml(self, revision_id):
 
1720
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1721
        #       would have already do it.
 
1722
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1723
        # TODO: this can't just be replaced by:
 
1724
        # return self._serializer.write_revision_to_string(
 
1725
        #     self.get_revision(revision_id))
 
1726
        # as cStringIO preservers the encoding unlike write_revision_to_string
 
1727
        # or some other call down the path.
 
1728
        rev = self.get_revision(revision_id)
 
1729
        rev_tmp = cStringIO.StringIO()
 
1730
        # the current serializer..
 
1731
        self._serializer.write_revision(rev, rev_tmp)
 
1732
        rev_tmp.seek(0)
 
1733
        return rev_tmp.getvalue()
1905
1734
 
1906
1735
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1907
1736
        """Produce a generator of revision deltas.
2150
1979
        """
2151
1980
        selected_keys = set((revid,) for revid in revision_ids)
2152
1981
        w = _inv_weave or self.inventories
2153
 
        return self._find_file_ids_from_xml_inventory_lines(
2154
 
            w.iter_lines_added_or_present_in_keys(
2155
 
                selected_keys, pb=None),
2156
 
            selected_keys)
 
1982
        pb = ui.ui_factory.nested_progress_bar()
 
1983
        try:
 
1984
            return self._find_file_ids_from_xml_inventory_lines(
 
1985
                w.iter_lines_added_or_present_in_keys(
 
1986
                    selected_keys, pb=pb),
 
1987
                selected_keys)
 
1988
        finally:
 
1989
            pb.finished()
2157
1990
 
2158
1991
    def iter_files_bytes(self, desired_files):
2159
1992
        """Iterate through file versions.
2241
2074
                batch_size]
2242
2075
            if not to_query:
2243
2076
                break
2244
 
            for revision_id in to_query:
 
2077
            for rev_tree in self.revision_trees(to_query):
 
2078
                revision_id = rev_tree.get_revision_id()
2245
2079
                parent_ids = ancestors[revision_id]
2246
2080
                for text_key in revision_keys[revision_id]:
2247
2081
                    pb.update("Calculating text parents", processed_texts)
2320
2154
        num_file_ids = len(file_ids)
2321
2155
        for file_id, altered_versions in file_ids.iteritems():
2322
2156
            if pb is not None:
2323
 
                pb.update("Fetch texts", count, num_file_ids)
 
2157
                pb.update("fetch texts", count, num_file_ids)
2324
2158
            count += 1
2325
2159
            yield ("file", file_id, altered_versions)
2326
2160
 
2347
2181
        """Get Inventory object by revision id."""
2348
2182
        return self.iter_inventories([revision_id]).next()
2349
2183
 
2350
 
    def iter_inventories(self, revision_ids, ordering=None):
 
2184
    def iter_inventories(self, revision_ids):
2351
2185
        """Get many inventories by revision_ids.
2352
2186
 
2353
2187
        This will buffer some or all of the texts used in constructing the
2355
2189
        time.
2356
2190
 
2357
2191
        :param revision_ids: The expected revision ids of the inventories.
2358
 
        :param ordering: optional ordering, e.g. 'topological'.  If not
2359
 
            specified, the order of revision_ids will be preserved (by
2360
 
            buffering if necessary).
2361
2192
        :return: An iterator of inventories.
2362
2193
        """
2363
2194
        if ((None in revision_ids)
2364
2195
            or (_mod_revision.NULL_REVISION in revision_ids)):
2365
2196
            raise ValueError('cannot get null revision inventory')
2366
 
        return self._iter_inventories(revision_ids, ordering)
 
2197
        return self._iter_inventories(revision_ids)
2367
2198
 
2368
 
    def _iter_inventories(self, revision_ids, ordering):
 
2199
    def _iter_inventories(self, revision_ids):
2369
2200
        """single-document based inventory iteration."""
2370
 
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2371
 
        for text, revision_id in inv_xmls:
2372
 
            yield self._deserialise_inventory(revision_id, text)
 
2201
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
 
2202
            yield self.deserialise_inventory(revision_id, text)
2373
2203
 
2374
 
    def _iter_inventory_xmls(self, revision_ids, ordering):
2375
 
        if ordering is None:
2376
 
            order_as_requested = True
2377
 
            ordering = 'unordered'
2378
 
        else:
2379
 
            order_as_requested = False
 
2204
    def _iter_inventory_xmls(self, revision_ids):
2380
2205
        keys = [(revision_id,) for revision_id in revision_ids]
2381
 
        if not keys:
2382
 
            return
2383
 
        if order_as_requested:
2384
 
            key_iter = iter(keys)
2385
 
            next_key = key_iter.next()
2386
 
        stream = self.inventories.get_record_stream(keys, ordering, True)
 
2206
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2387
2207
        text_chunks = {}
2388
2208
        for record in stream:
2389
2209
            if record.storage_kind != 'absent':
2390
 
                chunks = record.get_bytes_as('chunked')
2391
 
                if order_as_requested:
2392
 
                    text_chunks[record.key] = chunks
2393
 
                else:
2394
 
                    yield ''.join(chunks), record.key[-1]
 
2210
                text_chunks[record.key] = record.get_bytes_as('chunked')
2395
2211
            else:
2396
2212
                raise errors.NoSuchRevision(self, record.key)
2397
 
            if order_as_requested:
2398
 
                # Yield as many results as we can while preserving order.
2399
 
                while next_key in text_chunks:
2400
 
                    chunks = text_chunks.pop(next_key)
2401
 
                    yield ''.join(chunks), next_key[-1]
2402
 
                    try:
2403
 
                        next_key = key_iter.next()
2404
 
                    except StopIteration:
2405
 
                        # We still want to fully consume the get_record_stream,
2406
 
                        # just in case it is not actually finished at this point
2407
 
                        next_key = None
2408
 
                        break
 
2213
        for key in keys:
 
2214
            chunks = text_chunks.pop(key)
 
2215
            yield ''.join(chunks), key[-1]
2409
2216
 
2410
 
    def _deserialise_inventory(self, revision_id, xml):
 
2217
    def deserialise_inventory(self, revision_id, xml):
2411
2218
        """Transform the xml into an inventory object.
2412
2219
 
2413
2220
        :param revision_id: The expected revision id of the inventory.
2414
2221
        :param xml: A serialised inventory.
2415
2222
        """
2416
2223
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2417
 
                    entry_cache=self._inventory_entry_cache,
2418
 
                    return_from_cache=self._safe_to_return_from_cache)
 
2224
                    entry_cache=self._inventory_entry_cache)
2419
2225
        if result.revision_id != revision_id:
2420
2226
            raise AssertionError('revision id mismatch %s != %s' % (
2421
2227
                result.revision_id, revision_id))
2422
2228
        return result
2423
2229
 
 
2230
    def serialise_inventory(self, inv):
 
2231
        return self._serializer.write_inventory_to_string(inv)
 
2232
 
 
2233
    def _serialise_inventory_to_lines(self, inv):
 
2234
        return self._serializer.write_inventory_to_lines(inv)
 
2235
 
2424
2236
    def get_serializer_format(self):
2425
2237
        return self._serializer.format_num
2426
2238
 
2427
2239
    @needs_read_lock
2428
 
    def _get_inventory_xml(self, revision_id):
2429
 
        """Get serialized inventory as a string."""
2430
 
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
 
2240
    def get_inventory_xml(self, revision_id):
 
2241
        """Get inventory XML as a file object."""
 
2242
        texts = self._iter_inventory_xmls([revision_id])
2431
2243
        try:
2432
2244
            text, revision_id = texts.next()
2433
2245
        except StopIteration:
2434
2246
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2435
2247
        return text
2436
2248
 
 
2249
    @needs_read_lock
 
2250
    def get_inventory_sha1(self, revision_id):
 
2251
        """Return the sha1 hash of the inventory entry
 
2252
        """
 
2253
        return self.get_revision(revision_id).inventory_sha1
 
2254
 
2437
2255
    def get_rev_id_for_revno(self, revno, known_pair):
2438
2256
        """Return the revision id of a revno, given a later (revno, revid)
2439
2257
        pair in the same history.
2490
2308
            else:
2491
2309
                next_id = parents[0]
2492
2310
 
 
2311
    @needs_read_lock
 
2312
    def get_revision_inventory(self, revision_id):
 
2313
        """Return inventory of a past revision."""
 
2314
        # TODO: Unify this with get_inventory()
 
2315
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
2316
        # must be the same as its revision, so this is trivial.
 
2317
        if revision_id is None:
 
2318
            # This does not make sense: if there is no revision,
 
2319
            # then it is the current tree inventory surely ?!
 
2320
            # and thus get_root_id() is something that looks at the last
 
2321
            # commit on the branch, and the get_root_id is an inventory check.
 
2322
            raise NotImplementedError
 
2323
            # return Inventory(self.get_root_id())
 
2324
        else:
 
2325
            return self.get_inventory(revision_id)
 
2326
 
2493
2327
    def is_shared(self):
2494
2328
        """Return True if this repository is flagged as a shared repository."""
2495
2329
        raise NotImplementedError(self.is_shared)
2529
2363
            return RevisionTree(self, Inventory(root_id=None),
2530
2364
                                _mod_revision.NULL_REVISION)
2531
2365
        else:
2532
 
            inv = self.get_inventory(revision_id)
 
2366
            inv = self.get_revision_inventory(revision_id)
2533
2367
            return RevisionTree(self, inv, revision_id)
2534
2368
 
2535
2369
    def revision_trees(self, revision_ids):
2588
2422
            keys = tsort.topo_sort(parent_map)
2589
2423
        return [None] + list(keys)
2590
2424
 
2591
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
2425
    def pack(self, hint=None):
2592
2426
        """Compress the data within the repository.
2593
2427
 
2594
2428
        This operation only makes sense for some repository types. For other
2604
2438
            obtained from the result of commit_write_group(). Out of
2605
2439
            date hints are simply ignored, because concurrent operations
2606
2440
            can obsolete them rapidly.
2607
 
 
2608
 
        :param clean_obsolete_packs: Clean obsolete packs immediately after
2609
 
            the pack operation.
2610
2441
        """
2611
2442
 
2612
2443
    def get_transaction(self):
2628
2459
        for ((revision_id,), parent_keys) in \
2629
2460
                self.revisions.get_parent_map(query_keys).iteritems():
2630
2461
            if parent_keys:
2631
 
                result[revision_id] = tuple([parent_revid
2632
 
                    for (parent_revid,) in parent_keys])
 
2462
                result[revision_id] = tuple(parent_revid
 
2463
                    for (parent_revid,) in parent_keys)
2633
2464
            else:
2634
2465
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2635
2466
        return result
2637
2468
    def _make_parents_provider(self):
2638
2469
        return self
2639
2470
 
2640
 
    @needs_read_lock
2641
 
    def get_known_graph_ancestry(self, revision_ids):
2642
 
        """Return the known graph for a set of revision ids and their ancestors.
2643
 
        """
2644
 
        st = static_tuple.StaticTuple
2645
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
2646
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
2647
 
        return graph.GraphThunkIdsToKeys(known_graph)
2648
 
 
2649
2471
    def get_graph(self, other_repository=None):
2650
2472
        """Return the graph walker for this repository format"""
2651
2473
        parents_provider = self._make_parents_provider()
2655
2477
                [parents_provider, other_repository._make_parents_provider()])
2656
2478
        return graph.Graph(parents_provider)
2657
2479
 
2658
 
    def _get_versioned_file_checker(self, text_key_references=None,
2659
 
        ancestors=None):
 
2480
    def _get_versioned_file_checker(self, text_key_references=None):
2660
2481
        """Return an object suitable for checking versioned files.
2661
2482
        
2662
2483
        :param text_key_references: if non-None, an already built
2664
2485
            to whether they were referred to by the inventory of the
2665
2486
            revision_id that they contain. If None, this will be
2666
2487
            calculated.
2667
 
        :param ancestors: Optional result from
2668
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2669
 
            available.
2670
2488
        """
2671
2489
        return _VersionedFileChecker(self,
2672
 
            text_key_references=text_key_references, ancestors=ancestors)
 
2490
            text_key_references=text_key_references)
2673
2491
 
2674
2492
    def revision_ids_to_search_result(self, result_set):
2675
2493
        """Convert a set of revision ids to a graph SearchResult."""
2725
2543
        return record.get_bytes_as('fulltext')
2726
2544
 
2727
2545
    @needs_read_lock
2728
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
2546
    def check(self, revision_ids=None):
2729
2547
        """Check consistency of all history of given revision_ids.
2730
2548
 
2731
2549
        Different repository implementations should override _check().
2732
2550
 
2733
2551
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2734
2552
             will be checked.  Typically the last revision_id of a branch.
2735
 
        :param callback_refs: A dict of check-refs to resolve and callback
2736
 
            the check/_check method on the items listed as wanting the ref.
2737
 
            see bzrlib.check.
2738
 
        :param check_repo: If False do not check the repository contents, just 
2739
 
            calculate the data callback_refs requires and call them back.
2740
2553
        """
2741
 
        return self._check(revision_ids, callback_refs=callback_refs,
2742
 
            check_repo=check_repo)
 
2554
        return self._check(revision_ids)
2743
2555
 
2744
 
    def _check(self, revision_ids, callback_refs, check_repo):
2745
 
        result = check.Check(self, check_repo=check_repo)
2746
 
        result.check(callback_refs)
 
2556
    def _check(self, revision_ids):
 
2557
        result = check.Check(self)
 
2558
        result.check()
2747
2559
        return result
2748
2560
 
2749
 
    def _warn_if_deprecated(self, branch=None):
 
2561
    def _warn_if_deprecated(self):
2750
2562
        global _deprecation_warning_done
2751
2563
        if _deprecation_warning_done:
2752
2564
            return
2753
 
        try:
2754
 
            if branch is None:
2755
 
                conf = config.GlobalConfig()
2756
 
            else:
2757
 
                conf = branch.get_config()
2758
 
            if conf.suppress_warning('format_deprecation'):
2759
 
                return
2760
 
            warning("Format %s for %s is deprecated -"
2761
 
                    " please use 'bzr upgrade' to get better performance"
2762
 
                    % (self._format, self.bzrdir.transport.base))
2763
 
        finally:
2764
 
            _deprecation_warning_done = True
 
2565
        _deprecation_warning_done = True
 
2566
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
2567
                % (self._format, self.bzrdir.transport.base))
2765
2568
 
2766
2569
    def supports_rich_root(self):
2767
2570
        return self._format.rich_root_data
3048
2851
    # help), and for fetching when data won't have come from the same
3049
2852
    # compressor.
3050
2853
    pack_compresses = False
3051
 
    # Does the repository inventory storage understand references to trees?
3052
 
    supports_tree_reference = None
3053
 
    # Is the format experimental ?
3054
 
    experimental = False
3055
2854
 
3056
 
    def __repr__(self):
3057
 
        return "%s()" % self.__class__.__name__
 
2855
    def __str__(self):
 
2856
        return "<%s>" % self.__class__.__name__
3058
2857
 
3059
2858
    def __eq__(self, other):
3060
2859
        # format objects are generally stateless
3073
2872
        """
3074
2873
        try:
3075
2874
            transport = a_bzrdir.get_repository_transport(None)
3076
 
            format_string = transport.get_bytes("format")
 
2875
            format_string = transport.get("format").read()
3077
2876
            return format_registry.get(format_string)
3078
2877
        except errors.NoSuchFile:
3079
2878
            raise errors.NoRepositoryPresent(a_bzrdir)
3161
2960
        raise NotImplementedError(self.network_name)
3162
2961
 
3163
2962
    def check_conversion_target(self, target_format):
3164
 
        if self.rich_root_data and not target_format.rich_root_data:
3165
 
            raise errors.BadConversionTarget(
3166
 
                'Does not support rich root data.', target_format,
3167
 
                from_format=self)
3168
 
        if (self.supports_tree_reference and 
3169
 
            not getattr(target_format, 'supports_tree_reference', False)):
3170
 
            raise errors.BadConversionTarget(
3171
 
                'Does not support nested trees', target_format,
3172
 
                from_format=self)
 
2963
        raise NotImplementedError(self.check_conversion_target)
3173
2964
 
3174
2965
    def open(self, a_bzrdir, _found=False):
3175
2966
        """Return an instance of this format for the bzrdir a_bzrdir.
3178
2969
        """
3179
2970
        raise NotImplementedError(self.open)
3180
2971
 
3181
 
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
3182
 
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
3183
 
        hooks = BzrDir.hooks['post_repo_init']
3184
 
        if not hooks:
3185
 
            return
3186
 
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
3187
 
        for hook in hooks:
3188
 
            hook(params)
3189
 
 
3190
2972
 
3191
2973
class MetaDirRepositoryFormat(RepositoryFormat):
3192
2974
    """Common base class for the new repositories using the metadir layout."""
3397
3179
 
3398
3180
        :param revision_id: if None all content is copied, if NULL_REVISION no
3399
3181
                            content is copied.
3400
 
        :param pb: ignored.
 
3182
        :param pb: optional progress bar to use for progress reports. If not
 
3183
                   provided a default one will be created.
3401
3184
        :return: None.
3402
3185
        """
3403
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3404
3186
        from bzrlib.fetch import RepoFetcher
3405
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
3406
 
        if self.source._format.network_name() != self.target._format.network_name():
3407
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
3408
 
                from_format=self.source._format,
3409
 
                to_format=self.target._format)
3410
3187
        f = RepoFetcher(to_repository=self.target,
3411
3188
                               from_repository=self.source,
3412
3189
                               last_revision=revision_id,
3413
3190
                               fetch_spec=fetch_spec,
3414
 
                               find_ghosts=find_ghosts)
 
3191
                               pb=pb, find_ghosts=find_ghosts)
3415
3192
 
3416
3193
    def _walk_to_common_revisions(self, revision_ids):
3417
3194
        """Walk out from revision_ids in source to revisions target has.
3586
3363
                self.target.texts.insert_record_stream(
3587
3364
                    self.source.texts.get_record_stream(
3588
3365
                        self.source.texts.keys(), 'topological', False))
3589
 
                pb.update('Copying inventory', 0, 1)
 
3366
                pb.update('copying inventory', 0, 1)
3590
3367
                self.target.inventories.insert_record_stream(
3591
3368
                    self.source.inventories.get_record_stream(
3592
3369
                        self.source.inventories.keys(), 'topological', False))
3718
3495
        # This is redundant with format.check_conversion_target(), however that
3719
3496
        # raises an exception, and we just want to say "False" as in we won't
3720
3497
        # support converting between these formats.
3721
 
        if 'IDS_never' in debug.debug_flags:
3722
 
            return False
3723
3498
        if source.supports_rich_root() and not target.supports_rich_root():
3724
3499
            return False
3725
3500
        if (source._format.supports_tree_reference
3726
3501
            and not target._format.supports_tree_reference):
3727
3502
            return False
3728
 
        if target._fallback_repositories and target._format.supports_chks:
3729
 
            # IDS doesn't know how to copy CHKs for the parent inventories it
3730
 
            # adds to stacked repos.
3731
 
            return False
3732
 
        if 'IDS_always' in debug.debug_flags:
3733
 
            return True
3734
 
        # Only use this code path for local source and target.  IDS does far
3735
 
        # too much IO (both bandwidth and roundtrips) over a network.
3736
 
        if not source.bzrdir.transport.base.startswith('file:///'):
3737
 
            return False
3738
 
        if not target.bzrdir.transport.base.startswith('file:///'):
3739
 
            return False
3740
3503
        return True
3741
3504
 
3742
 
    def _get_trees(self, revision_ids, cache):
3743
 
        possible_trees = []
3744
 
        for rev_id in revision_ids:
3745
 
            if rev_id in cache:
3746
 
                possible_trees.append((rev_id, cache[rev_id]))
3747
 
            else:
3748
 
                # Not cached, but inventory might be present anyway.
3749
 
                try:
3750
 
                    tree = self.source.revision_tree(rev_id)
3751
 
                except errors.NoSuchRevision:
3752
 
                    # Nope, parent is ghost.
3753
 
                    pass
3754
 
                else:
3755
 
                    cache[rev_id] = tree
3756
 
                    possible_trees.append((rev_id, tree))
3757
 
        return possible_trees
3758
 
 
3759
 
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
 
3505
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
3760
3506
        """Get the best delta and base for this revision.
3761
3507
 
3762
3508
        :return: (basis_id, delta)
3763
3509
        """
 
3510
        possible_trees = [(parent_id, cache[parent_id])
 
3511
                          for parent_id in parent_ids
 
3512
                           if parent_id in cache]
 
3513
        if len(possible_trees) == 0:
 
3514
            # There either aren't any parents, or the parents aren't in the
 
3515
            # cache, so just use the last converted tree
 
3516
            possible_trees.append((basis_id, cache[basis_id]))
3764
3517
        deltas = []
3765
 
        # Generate deltas against each tree, to find the shortest.
3766
 
        texts_possibly_new_in_tree = set()
3767
3518
        for basis_id, basis_tree in possible_trees:
3768
3519
            delta = tree.inventory._make_delta(basis_tree.inventory)
3769
 
            for old_path, new_path, file_id, new_entry in delta:
3770
 
                if new_path is None:
3771
 
                    # This file_id isn't present in the new rev, so we don't
3772
 
                    # care about it.
3773
 
                    continue
3774
 
                if not new_path:
3775
 
                    # Rich roots are handled elsewhere...
3776
 
                    continue
3777
 
                kind = new_entry.kind
3778
 
                if kind != 'directory' and kind != 'file':
3779
 
                    # No text record associated with this inventory entry.
3780
 
                    continue
3781
 
                # This is a directory or file that has changed somehow.
3782
 
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3783
3520
            deltas.append((len(delta), basis_id, delta))
3784
3521
        deltas.sort()
3785
3522
        return deltas[0][1:]
3786
3523
 
3787
 
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
3788
 
        """Find all parent revisions that are absent, but for which the
3789
 
        inventory is present, and copy those inventories.
3790
 
 
3791
 
        This is necessary to preserve correctness when the source is stacked
3792
 
        without fallbacks configured.  (Note that in cases like upgrade the
3793
 
        source may be not have _fallback_repositories even though it is
3794
 
        stacked.)
3795
 
        """
3796
 
        parent_revs = set()
3797
 
        for parents in parent_map.values():
3798
 
            parent_revs.update(parents)
3799
 
        present_parents = self.source.get_parent_map(parent_revs)
3800
 
        absent_parents = set(parent_revs).difference(present_parents)
3801
 
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
3802
 
            (rev_id,) for rev_id in absent_parents)
3803
 
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
3804
 
        for parent_tree in self.source.revision_trees(parent_inv_ids):
3805
 
            current_revision_id = parent_tree.get_revision_id()
3806
 
            parents_parents_keys = parent_invs_keys_for_stacking[
3807
 
                (current_revision_id,)]
3808
 
            parents_parents = [key[-1] for key in parents_parents_keys]
3809
 
            basis_id = _mod_revision.NULL_REVISION
3810
 
            basis_tree = self.source.revision_tree(basis_id)
3811
 
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
3812
 
            self.target.add_inventory_by_delta(
3813
 
                basis_id, delta, current_revision_id, parents_parents)
3814
 
            cache[current_revision_id] = parent_tree
3815
 
 
3816
 
    def _fetch_batch(self, revision_ids, basis_id, cache, a_graph=None):
 
3524
    def _get_parent_keys(self, root_key, parent_map):
 
3525
        """Get the parent keys for a given root id."""
 
3526
        root_id, rev_id = root_key
 
3527
        # Include direct parents of the revision, but only if they used
 
3528
        # the same root_id and are heads.
 
3529
        parent_keys = []
 
3530
        for parent_id in parent_map[rev_id]:
 
3531
            if parent_id == _mod_revision.NULL_REVISION:
 
3532
                continue
 
3533
            if parent_id not in self._revision_id_to_root_id:
 
3534
                # We probably didn't read this revision, go spend the
 
3535
                # extra effort to actually check
 
3536
                try:
 
3537
                    tree = self.source.revision_tree(parent_id)
 
3538
                except errors.NoSuchRevision:
 
3539
                    # Ghost, fill out _revision_id_to_root_id in case we
 
3540
                    # encounter this again.
 
3541
                    # But set parent_root_id to None since we don't really know
 
3542
                    parent_root_id = None
 
3543
                else:
 
3544
                    parent_root_id = tree.get_root_id()
 
3545
                self._revision_id_to_root_id[parent_id] = None
 
3546
            else:
 
3547
                parent_root_id = self._revision_id_to_root_id[parent_id]
 
3548
            if root_id == parent_root_id:
 
3549
                # With stacking we _might_ want to refer to a non-local
 
3550
                # revision, but this code path only applies when we have the
 
3551
                # full content available, so ghosts really are ghosts, not just
 
3552
                # the edge of local data.
 
3553
                parent_keys.append((parent_id,))
 
3554
            else:
 
3555
                # root_id may be in the parent anyway.
 
3556
                try:
 
3557
                    tree = self.source.revision_tree(parent_id)
 
3558
                except errors.NoSuchRevision:
 
3559
                    # ghost, can't refer to it.
 
3560
                    pass
 
3561
                else:
 
3562
                    try:
 
3563
                        parent_keys.append((tree.inventory[root_id].revision,))
 
3564
                    except errors.NoSuchId:
 
3565
                        # not in the tree
 
3566
                        pass
 
3567
        g = graph.Graph(self.source.revisions)
 
3568
        heads = g.heads(parent_keys)
 
3569
        selected_keys = []
 
3570
        for key in parent_keys:
 
3571
            if key in heads and key not in selected_keys:
 
3572
                selected_keys.append(key)
 
3573
        return tuple([(root_id,)+ key for key in selected_keys])
 
3574
 
 
3575
    def _new_root_data_stream(self, root_keys_to_create, parent_map):
 
3576
        for root_key in root_keys_to_create:
 
3577
            parent_keys = self._get_parent_keys(root_key, parent_map)
 
3578
            yield versionedfile.FulltextContentFactory(root_key,
 
3579
                parent_keys, None, '')
 
3580
 
 
3581
    def _fetch_batch(self, revision_ids, basis_id, cache):
3817
3582
        """Fetch across a few revisions.
3818
3583
 
3819
3584
        :param revision_ids: The revisions to copy
3820
3585
        :param basis_id: The revision_id of a tree that must be in cache, used
3821
3586
            as a basis for delta when no other base is available
3822
3587
        :param cache: A cache of RevisionTrees that we can use.
3823
 
        :param a_graph: A Graph object to determine the heads() of the
3824
 
            rich-root data stream.
3825
3588
        :return: The revision_id of the last converted tree. The RevisionTree
3826
3589
            for it will be in cache
3827
3590
        """
3833
3596
        pending_deltas = []
3834
3597
        pending_revisions = []
3835
3598
        parent_map = self.source.get_parent_map(revision_ids)
3836
 
        self._fetch_parent_invs_for_stacking(parent_map, cache)
3837
 
        self.source._safe_to_return_from_cache = True
3838
3599
        for tree in self.source.revision_trees(revision_ids):
3839
 
            # Find a inventory delta for this revision.
3840
 
            # Find text entries that need to be copied, too.
3841
3600
            current_revision_id = tree.get_revision_id()
3842
3601
            parent_ids = parent_map.get(current_revision_id, ())
3843
 
            parent_trees = self._get_trees(parent_ids, cache)
3844
 
            possible_trees = list(parent_trees)
3845
 
            if len(possible_trees) == 0:
3846
 
                # There either aren't any parents, or the parents are ghosts,
3847
 
                # so just use the last converted tree.
3848
 
                possible_trees.append((basis_id, cache[basis_id]))
3849
3602
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3850
 
                                                           possible_trees)
3851
 
            revision = self.source.get_revision(current_revision_id)
3852
 
            pending_deltas.append((basis_id, delta,
3853
 
                current_revision_id, revision.parent_ids))
 
3603
                                                           basis_id, cache)
3854
3604
            if self._converting_to_rich_root:
3855
3605
                self._revision_id_to_root_id[current_revision_id] = \
3856
3606
                    tree.get_root_id()
3857
 
            # Determine which texts are in present in this revision but not in
3858
 
            # any of the available parents.
3859
 
            texts_possibly_new_in_tree = set()
 
3607
            # Find text entries that need to be copied
3860
3608
            for old_path, new_path, file_id, entry in delta:
3861
 
                if new_path is None:
3862
 
                    # This file_id isn't present in the new rev
3863
 
                    continue
3864
 
                if not new_path:
3865
 
                    # This is the root
3866
 
                    if not self.target.supports_rich_root():
3867
 
                        # The target doesn't support rich root, so we don't
3868
 
                        # copy
3869
 
                        continue
3870
 
                    if self._converting_to_rich_root:
3871
 
                        # This can't be copied normally, we have to insert
3872
 
                        # it specially
3873
 
                        root_keys_to_create.add((file_id, entry.revision))
3874
 
                        continue
3875
 
                kind = entry.kind
3876
 
                texts_possibly_new_in_tree.add((file_id, entry.revision))
3877
 
            for basis_id, basis_tree in possible_trees:
3878
 
                basis_inv = basis_tree.inventory
3879
 
                for file_key in list(texts_possibly_new_in_tree):
3880
 
                    file_id, file_revision = file_key
3881
 
                    try:
3882
 
                        entry = basis_inv[file_id]
3883
 
                    except errors.NoSuchId:
3884
 
                        continue
3885
 
                    if entry.revision == file_revision:
3886
 
                        texts_possibly_new_in_tree.remove(file_key)
3887
 
            text_keys.update(texts_possibly_new_in_tree)
 
3609
                if new_path is not None:
 
3610
                    if not new_path:
 
3611
                        # This is the root
 
3612
                        if not self.target.supports_rich_root():
 
3613
                            # The target doesn't support rich root, so we don't
 
3614
                            # copy
 
3615
                            continue
 
3616
                        if self._converting_to_rich_root:
 
3617
                            # This can't be copied normally, we have to insert
 
3618
                            # it specially
 
3619
                            root_keys_to_create.add((file_id, entry.revision))
 
3620
                            continue
 
3621
                    text_keys.add((file_id, entry.revision))
 
3622
            revision = self.source.get_revision(current_revision_id)
 
3623
            pending_deltas.append((basis_id, delta,
 
3624
                current_revision_id, revision.parent_ids))
3888
3625
            pending_revisions.append(revision)
3889
3626
            cache[current_revision_id] = tree
3890
3627
            basis_id = current_revision_id
3891
 
        self.source._safe_to_return_from_cache = False
3892
3628
        # Copy file texts
3893
3629
        from_texts = self.source.texts
3894
3630
        to_texts = self.target.texts
3895
3631
        if root_keys_to_create:
3896
 
            root_stream = _mod_fetch._new_root_data_stream(
3897
 
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
3898
 
                self.source, graph=a_graph)
 
3632
            root_stream = self._new_root_data_stream(root_keys_to_create,
 
3633
                                                     parent_map)
3899
3634
            to_texts.insert_record_stream(root_stream)
3900
3635
        to_texts.insert_record_stream(from_texts.get_record_stream(
3901
3636
            text_keys, self.target._format._fetch_order,
3908
3643
            # for the new revisions that we are about to insert.  We do this
3909
3644
            # before adding the revisions so that no revision is added until
3910
3645
            # all the inventories it may depend on are added.
3911
 
            # Note that this is overzealous, as we may have fetched these in an
3912
 
            # earlier batch.
3913
3646
            parent_ids = set()
3914
3647
            revision_ids = set()
3915
3648
            for revision in pending_revisions:
3918
3651
            parent_ids.difference_update(revision_ids)
3919
3652
            parent_ids.discard(_mod_revision.NULL_REVISION)
3920
3653
            parent_map = self.source.get_parent_map(parent_ids)
3921
 
            # we iterate over parent_map and not parent_ids because we don't
3922
 
            # want to try copying any revision which is a ghost
3923
 
            for parent_tree in self.source.revision_trees(parent_map):
 
3654
            for parent_tree in self.source.revision_trees(parent_ids):
 
3655
                basis_id, delta = self._get_delta_for_revision(tree, parent_ids, basis_id, cache)
3924
3656
                current_revision_id = parent_tree.get_revision_id()
3925
3657
                parents_parents = parent_map[current_revision_id]
3926
 
                possible_trees = self._get_trees(parents_parents, cache)
3927
 
                if len(possible_trees) == 0:
3928
 
                    # There either aren't any parents, or the parents are
3929
 
                    # ghosts, so just use the last converted tree.
3930
 
                    possible_trees.append((basis_id, cache[basis_id]))
3931
 
                basis_id, delta = self._get_delta_for_revision(parent_tree,
3932
 
                    parents_parents, possible_trees)
3933
3658
                self.target.add_inventory_by_delta(
3934
3659
                    basis_id, delta, current_revision_id, parents_parents)
3935
3660
        # insert signatures and revisions
3949
3674
 
3950
3675
        :param revision_ids: The list of revisions to fetch. Must be in
3951
3676
            topological order.
3952
 
        :param pb: A ProgressTask
 
3677
        :param pb: A ProgressBar
3953
3678
        :return: None
3954
3679
        """
3955
3680
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3958
3683
        cache[basis_id] = basis_tree
3959
3684
        del basis_tree # We don't want to hang on to it here
3960
3685
        hints = []
3961
 
        if self._converting_to_rich_root and len(revision_ids) > 100:
3962
 
            a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
3963
 
                                                            revision_ids)
3964
 
        else:
3965
 
            a_graph = None
3966
 
 
3967
3686
        for offset in range(0, len(revision_ids), batch_size):
3968
3687
            self.target.start_write_group()
3969
3688
            try:
3970
3689
                pb.update('Transferring revisions', offset,
3971
3690
                          len(revision_ids))
3972
3691
                batch = revision_ids[offset:offset+batch_size]
3973
 
                basis_id = self._fetch_batch(batch, basis_id, cache,
3974
 
                                             a_graph=a_graph)
 
3692
                basis_id = self._fetch_batch(batch, basis_id, cache)
3975
3693
            except:
3976
 
                self.source._safe_to_return_from_cache = False
3977
3694
                self.target.abort_write_group()
3978
3695
                raise
3979
3696
            else:
3991
3708
        """See InterRepository.fetch()."""
3992
3709
        if fetch_spec is not None:
3993
3710
            raise AssertionError("Not implemented yet...")
3994
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3995
3711
        if (not self.source.supports_rich_root()
3996
3712
            and self.target.supports_rich_root()):
3997
3713
            self._converting_to_rich_root = True
3998
3714
            self._revision_id_to_root_id = {}
3999
3715
        else:
4000
3716
            self._converting_to_rich_root = False
4001
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
4002
 
        if self.source._format.network_name() != self.target._format.network_name():
4003
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
4004
 
                from_format=self.source._format,
4005
 
                to_format=self.target._format)
4006
3717
        revision_ids = self.target.search_missing_revision_ids(self.source,
4007
3718
            revision_id, find_ghosts=find_ghosts).get_keys()
4008
3719
        if not revision_ids:
4014
3725
        # Walk though all revisions; get inventory deltas, copy referenced
4015
3726
        # texts that delta references, insert the delta, revision and
4016
3727
        # signature.
 
3728
        first_rev = self.source.get_revision(revision_ids[0])
4017
3729
        if pb is None:
4018
3730
            my_pb = ui.ui_factory.nested_progress_bar()
4019
3731
            pb = my_pb
4077
3789
        :param to_convert: The disk object to convert.
4078
3790
        :param pb: a progress bar to use for progress information.
4079
3791
        """
4080
 
        pb = ui.ui_factory.nested_progress_bar()
 
3792
        self.pb = pb
4081
3793
        self.count = 0
4082
3794
        self.total = 4
4083
3795
        # this is only useful with metadir layouts - separated repo content.
4084
3796
        # trigger an assertion if not such
4085
3797
        repo._format.get_format_string()
4086
3798
        self.repo_dir = repo.bzrdir
4087
 
        pb.update('Moving repository to repository.backup')
 
3799
        self.step('Moving repository to repository.backup')
4088
3800
        self.repo_dir.transport.move('repository', 'repository.backup')
4089
3801
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4090
3802
        repo._format.check_conversion_target(self.target_format)
4091
3803
        self.source_repo = repo._format.open(self.repo_dir,
4092
3804
            _found=True,
4093
3805
            _override_transport=backup_transport)
4094
 
        pb.update('Creating new repository')
 
3806
        self.step('Creating new repository')
4095
3807
        converted = self.target_format.initialize(self.repo_dir,
4096
3808
                                                  self.source_repo.is_shared())
4097
3809
        converted.lock_write()
4098
3810
        try:
4099
 
            pb.update('Copying content')
 
3811
            self.step('Copying content into repository.')
4100
3812
            self.source_repo.copy_content_into(converted)
4101
3813
        finally:
4102
3814
            converted.unlock()
4103
 
        pb.update('Deleting old repository content')
 
3815
        self.step('Deleting old repository content.')
4104
3816
        self.repo_dir.transport.delete_tree('repository.backup')
4105
 
        ui.ui_factory.note('repository converted')
4106
 
        pb.finished()
 
3817
        self.pb.note('repository converted')
 
3818
 
 
3819
    def step(self, message):
 
3820
        """Update the pb by a step."""
 
3821
        self.count +=1
 
3822
        self.pb.update(message, self.count, self.total)
4107
3823
 
4108
3824
 
4109
3825
_unescape_map = {
4138
3854
 
4139
3855
class _VersionedFileChecker(object):
4140
3856
 
4141
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
3857
    def __init__(self, repository, text_key_references=None):
4142
3858
        self.repository = repository
4143
3859
        self.text_index = self.repository._generate_text_key_index(
4144
 
            text_key_references=text_key_references, ancestors=ancestors)
 
3860
            text_key_references=text_key_references)
4145
3861
 
4146
3862
    def calculate_file_version_parents(self, text_key):
4147
3863
        """Calculate the correct parents for a file version according to
4165
3881
            revision_id) tuples for versions that are present in this versioned
4166
3882
            file, but not used by the corresponding inventory.
4167
3883
        """
4168
 
        local_progress = None
4169
 
        if progress_bar is None:
4170
 
            local_progress = ui.ui_factory.nested_progress_bar()
4171
 
            progress_bar = local_progress
4172
 
        try:
4173
 
            return self._check_file_version_parents(texts, progress_bar)
4174
 
        finally:
4175
 
            if local_progress:
4176
 
                local_progress.finished()
4177
 
 
4178
 
    def _check_file_version_parents(self, texts, progress_bar):
4179
 
        """See check_file_version_parents."""
4180
3884
        wrong_parents = {}
4181
3885
        self.file_ids = set([file_id for file_id, _ in
4182
3886
            self.text_index.iterkeys()])
4183
3887
        # text keys is now grouped by file_id
 
3888
        n_weaves = len(self.file_ids)
 
3889
        files_in_revisions = {}
 
3890
        revisions_of_files = {}
4184
3891
        n_versions = len(self.text_index)
4185
3892
        progress_bar.update('loading text store', 0, n_versions)
4186
3893
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4188
3895
        text_keys = self.repository.texts.keys()
4189
3896
        unused_keys = frozenset(text_keys) - set(self.text_index)
4190
3897
        for num, key in enumerate(self.text_index.iterkeys()):
4191
 
            progress_bar.update('checking text graph', num, n_versions)
 
3898
            if progress_bar is not None:
 
3899
                progress_bar.update('checking text graph', num, n_versions)
4192
3900
            correct_parents = self.calculate_file_version_parents(key)
4193
3901
            try:
4194
3902
                knit_parents = parent_map[key]
4279
3987
            else:
4280
3988
                new_pack.set_write_cache_size(1024*1024)
4281
3989
        for substream_type, substream in stream:
4282
 
            if 'stream' in debug.debug_flags:
4283
 
                mutter('inserting substream: %s', substream_type)
4284
3990
            if substream_type == 'texts':
4285
3991
                self.target_repo.texts.insert_record_stream(substream)
4286
3992
            elif substream_type == 'inventories':
4290
3996
                else:
4291
3997
                    self._extract_and_insert_inventories(
4292
3998
                        substream, src_serializer)
4293
 
            elif substream_type == 'inventory-deltas':
4294
 
                self._extract_and_insert_inventory_deltas(
4295
 
                    substream, src_serializer)
4296
3999
            elif substream_type == 'chk_bytes':
4297
4000
                # XXX: This doesn't support conversions, as it assumes the
4298
4001
                #      conversion was done in the fetch code.
4329
4032
                ):
4330
4033
                if versioned_file is None:
4331
4034
                    continue
4332
 
                # TODO: key is often going to be a StaticTuple object
4333
 
                #       I don't believe we can define a method by which
4334
 
                #       (prefix,) + StaticTuple will work, though we could
4335
 
                #       define a StaticTuple.sq_concat that would allow you to
4336
 
                #       pass in either a tuple or a StaticTuple as the second
4337
 
                #       object, so instead we could have:
4338
 
                #       StaticTuple(prefix) + key here...
4339
4035
                missing_keys.update((prefix,) + key for key in
4340
4036
                    versioned_file.get_missing_compression_parent_keys())
4341
4037
        except NotImplementedError:
4356
4052
            self.target_repo.pack(hint=hint)
4357
4053
        return [], set()
4358
4054
 
4359
 
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
4360
 
        target_rich_root = self.target_repo._format.rich_root_data
4361
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4362
 
        for record in substream:
4363
 
            # Insert the delta directly
4364
 
            inventory_delta_bytes = record.get_bytes_as('fulltext')
4365
 
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
4366
 
            try:
4367
 
                parse_result = deserialiser.parse_text_bytes(
4368
 
                    inventory_delta_bytes)
4369
 
            except inventory_delta.IncompatibleInventoryDelta, err:
4370
 
                trace.mutter("Incompatible delta: %s", err.msg)
4371
 
                raise errors.IncompatibleRevision(self.target_repo._format)
4372
 
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
4373
 
            revision_id = new_id
4374
 
            parents = [key[0] for key in record.parents]
4375
 
            self.target_repo.add_inventory_by_delta(
4376
 
                basis_id, inv_delta, revision_id, parents)
4377
 
 
4378
 
    def _extract_and_insert_inventories(self, substream, serializer,
4379
 
            parse_delta=None):
 
4055
    def _extract_and_insert_inventories(self, substream, serializer):
4380
4056
        """Generate a new inventory versionedfile in target, converting data.
4381
4057
 
4382
4058
        The inventory is retrieved from the source, (deserializing it), and
4383
4059
        stored in the target (reserializing it in a different format).
4384
4060
        """
4385
 
        target_rich_root = self.target_repo._format.rich_root_data
4386
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4387
4061
        for record in substream:
4388
 
            # It's not a delta, so it must be a fulltext in the source
4389
 
            # serializer's format.
4390
4062
            bytes = record.get_bytes_as('fulltext')
4391
4063
            revision_id = record.key[0]
4392
4064
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4393
4065
            parents = [key[0] for key in record.parents]
4394
4066
            self.target_repo.add_inventory(revision_id, inv, parents)
4395
 
            # No need to keep holding this full inv in memory when the rest of
4396
 
            # the substream is likely to be all deltas.
4397
 
            del inv
4398
4067
 
4399
4068
    def _extract_and_insert_revisions(self, substream, serializer):
4400
4069
        for record in substream:
4449
4118
        return [('signatures', signatures), ('revisions', revisions)]
4450
4119
 
4451
4120
    def _generate_root_texts(self, revs):
4452
 
        """This will be called by get_stream between fetching weave texts and
 
4121
        """This will be called by __fetch between fetching weave texts and
4453
4122
        fetching the inventory weave.
 
4123
 
 
4124
        Subclasses should override this if they need to generate root texts
 
4125
        after fetching weave texts.
4454
4126
        """
4455
4127
        if self._rich_root_upgrade():
4456
 
            return _mod_fetch.Inter1and2Helper(
 
4128
            import bzrlib.fetch
 
4129
            return bzrlib.fetch.Inter1and2Helper(
4457
4130
                self.from_repository).generate_root_texts(revs)
4458
4131
        else:
4459
4132
            return []
4462
4135
        phase = 'file'
4463
4136
        revs = search.get_keys()
4464
4137
        graph = self.from_repository.get_graph()
4465
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
 
4138
        revs = list(graph.iter_topo_order(revs))
4466
4139
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4467
4140
        text_keys = []
4468
4141
        for knit_kind, file_id, revisions in data_to_fetch:
4487
4160
                # will be valid.
4488
4161
                for _ in self._generate_root_texts(revs):
4489
4162
                    yield _
 
4163
                # NB: This currently reopens the inventory weave in source;
 
4164
                # using a single stream interface instead would avoid this.
 
4165
                from_weave = self.from_repository.inventories
4490
4166
                # we fetch only the referenced inventories because we do not
4491
4167
                # know for unselected inventories whether all their required
4492
4168
                # texts are present in the other repository - it could be
4531
4207
            if not keys:
4532
4208
                # No need to stream something we don't have
4533
4209
                continue
4534
 
            if substream_kind == 'inventories':
4535
 
                # Some missing keys are genuinely ghosts, filter those out.
4536
 
                present = self.from_repository.inventories.get_parent_map(keys)
4537
 
                revs = [key[0] for key in present]
4538
 
                # Get the inventory stream more-or-less as we do for the
4539
 
                # original stream; there's no reason to assume that records
4540
 
                # direct from the source will be suitable for the sink.  (Think
4541
 
                # e.g. 2a -> 1.9-rich-root).
4542
 
                for info in self._get_inventory_stream(revs, missing=True):
4543
 
                    yield info
4544
 
                continue
4545
 
 
4546
4210
            # Ask for full texts always so that we don't need more round trips
4547
4211
            # after this stream.
4548
4212
            # Some of the missing keys are genuinely ghosts, so filter absent
4563
4227
        return (not self.from_repository._format.rich_root_data and
4564
4228
            self.to_format.rich_root_data)
4565
4229
 
4566
 
    def _get_inventory_stream(self, revision_ids, missing=False):
 
4230
    def _get_inventory_stream(self, revision_ids):
4567
4231
        from_format = self.from_repository._format
4568
 
        if (from_format.supports_chks and self.to_format.supports_chks and
4569
 
            from_format.network_name() == self.to_format.network_name()):
4570
 
            raise AssertionError(
4571
 
                "this case should be handled by GroupCHKStreamSource")
4572
 
        elif 'forceinvdeltas' in debug.debug_flags:
4573
 
            return self._get_convertable_inventory_stream(revision_ids,
4574
 
                    delta_versus_null=missing)
4575
 
        elif from_format.network_name() == self.to_format.network_name():
4576
 
            # Same format.
4577
 
            return self._get_simple_inventory_stream(revision_ids,
4578
 
                    missing=missing)
4579
 
        elif (not from_format.supports_chks and not self.to_format.supports_chks
4580
 
                and from_format._serializer == self.to_format._serializer):
4581
 
            # Essentially the same format.
4582
 
            return self._get_simple_inventory_stream(revision_ids,
4583
 
                    missing=missing)
 
4232
        if (from_format.supports_chks and self.to_format.supports_chks
 
4233
            and (from_format._serializer == self.to_format._serializer)):
 
4234
            # Both sides support chks, and they use the same serializer, so it
 
4235
            # is safe to transmit the chk pages and inventory pages across
 
4236
            # as-is.
 
4237
            return self._get_chk_inventory_stream(revision_ids)
 
4238
        elif (not from_format.supports_chks):
 
4239
            # Source repository doesn't support chks. So we can transmit the
 
4240
            # inventories 'as-is' and either they are just accepted on the
 
4241
            # target, or the Sink will properly convert it.
 
4242
            return self._get_simple_inventory_stream(revision_ids)
4584
4243
        else:
4585
 
            # Any time we switch serializations, we want to use an
4586
 
            # inventory-delta based approach.
4587
 
            return self._get_convertable_inventory_stream(revision_ids,
4588
 
                    delta_versus_null=missing)
 
4244
            # XXX: Hack to make not-chk->chk fetch: copy the inventories as
 
4245
            #      inventories. Note that this should probably be done somehow
 
4246
            #      as part of bzrlib.repository.StreamSink. Except JAM couldn't
 
4247
            #      figure out how a non-chk repository could possibly handle
 
4248
            #      deserializing an inventory stream from a chk repo, as it
 
4249
            #      doesn't have a way to understand individual pages.
 
4250
            return self._get_convertable_inventory_stream(revision_ids)
4589
4251
 
4590
 
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
4591
 
        # NB: This currently reopens the inventory weave in source;
4592
 
        # using a single stream interface instead would avoid this.
 
4252
    def _get_simple_inventory_stream(self, revision_ids):
4593
4253
        from_weave = self.from_repository.inventories
4594
 
        if missing:
4595
 
            delta_closure = True
4596
 
        else:
4597
 
            delta_closure = not self.delta_on_metadata()
4598
4254
        yield ('inventories', from_weave.get_record_stream(
4599
4255
            [(rev_id,) for rev_id in revision_ids],
4600
 
            self.inventory_fetch_order(), delta_closure))
4601
 
 
4602
 
    def _get_convertable_inventory_stream(self, revision_ids,
4603
 
                                          delta_versus_null=False):
4604
 
        # The two formats are sufficiently different that there is no fast
4605
 
        # path, so we need to send just inventorydeltas, which any
4606
 
        # sufficiently modern client can insert into any repository.
4607
 
        # The StreamSink code expects to be able to
4608
 
        # convert on the target, so we need to put bytes-on-the-wire that can
4609
 
        # be converted.  That means inventory deltas (if the remote is <1.19,
4610
 
        # RemoteStreamSink will fallback to VFS to insert the deltas).
4611
 
        yield ('inventory-deltas',
4612
 
           self._stream_invs_as_deltas(revision_ids,
4613
 
                                       delta_versus_null=delta_versus_null))
4614
 
 
4615
 
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
4616
 
        """Return a stream of inventory-deltas for the given rev ids.
4617
 
 
4618
 
        :param revision_ids: The list of inventories to transmit
4619
 
        :param delta_versus_null: Don't try to find a minimal delta for this
4620
 
            entry, instead compute the delta versus the NULL_REVISION. This
4621
 
            effectively streams a complete inventory. Used for stuff like
4622
 
            filling in missing parents, etc.
4623
 
        """
 
4256
            self.inventory_fetch_order(),
 
4257
            not self.delta_on_metadata()))
 
4258
 
 
4259
    def _get_chk_inventory_stream(self, revision_ids):
 
4260
        """Fetch the inventory texts, along with the associated chk maps."""
 
4261
        # We want an inventory outside of the search set, so that we can filter
 
4262
        # out uninteresting chk pages. For now we use
 
4263
        # _find_revision_outside_set, but if we had a Search with cut_revs, we
 
4264
        # could use that instead.
 
4265
        start_rev_id = self.from_repository._find_revision_outside_set(
 
4266
                            revision_ids)
 
4267
        start_rev_key = (start_rev_id,)
 
4268
        inv_keys_to_fetch = [(rev_id,) for rev_id in revision_ids]
 
4269
        if start_rev_id != _mod_revision.NULL_REVISION:
 
4270
            inv_keys_to_fetch.append((start_rev_id,))
 
4271
        # Any repo that supports chk_bytes must also support out-of-order
 
4272
        # insertion. At least, that is how we expect it to work
 
4273
        # We use get_record_stream instead of iter_inventories because we want
 
4274
        # to be able to insert the stream as well. We could instead fetch
 
4275
        # allowing deltas, and then iter_inventories, but we don't know whether
 
4276
        # source or target is more 'local' anway.
 
4277
        inv_stream = self.from_repository.inventories.get_record_stream(
 
4278
            inv_keys_to_fetch, 'unordered',
 
4279
            True) # We need them as full-texts so we can find their references
 
4280
        uninteresting_chk_roots = set()
 
4281
        interesting_chk_roots = set()
 
4282
        def filter_inv_stream(inv_stream):
 
4283
            for idx, record in enumerate(inv_stream):
 
4284
                ### child_pb.update('fetch inv', idx, len(inv_keys_to_fetch))
 
4285
                bytes = record.get_bytes_as('fulltext')
 
4286
                chk_inv = inventory.CHKInventory.deserialise(
 
4287
                    self.from_repository.chk_bytes, bytes, record.key)
 
4288
                if record.key == start_rev_key:
 
4289
                    uninteresting_chk_roots.add(chk_inv.id_to_entry.key())
 
4290
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4291
                    if p_id_map is not None:
 
4292
                        uninteresting_chk_roots.add(p_id_map.key())
 
4293
                else:
 
4294
                    yield record
 
4295
                    interesting_chk_roots.add(chk_inv.id_to_entry.key())
 
4296
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4297
                    if p_id_map is not None:
 
4298
                        interesting_chk_roots.add(p_id_map.key())
 
4299
        ### pb.update('fetch inventory', 0, 2)
 
4300
        yield ('inventories', filter_inv_stream(inv_stream))
 
4301
        # Now that we have worked out all of the interesting root nodes, grab
 
4302
        # all of the interesting pages and insert them
 
4303
        ### pb.update('fetch inventory', 1, 2)
 
4304
        interesting = chk_map.iter_interesting_nodes(
 
4305
            self.from_repository.chk_bytes, interesting_chk_roots,
 
4306
            uninteresting_chk_roots)
 
4307
        def to_stream_adapter():
 
4308
            """Adapt the iter_interesting_nodes result to a single stream.
 
4309
 
 
4310
            iter_interesting_nodes returns records as it processes them, along
 
4311
            with keys. However, we only want to return the records themselves.
 
4312
            """
 
4313
            for record, items in interesting:
 
4314
                if record is not None:
 
4315
                    yield record
 
4316
        # XXX: We could instead call get_record_stream(records.keys())
 
4317
        #      ATM, this will always insert the records as fulltexts, and
 
4318
        #      requires that you can hang on to records once you have gone
 
4319
        #      on to the next one. Further, it causes the target to
 
4320
        #      recompress the data. Testing shows it to be faster than
 
4321
        #      requesting the records again, though.
 
4322
        yield ('chk_bytes', to_stream_adapter())
 
4323
        ### pb.update('fetch inventory', 2, 2)
 
4324
 
 
4325
    def _get_convertable_inventory_stream(self, revision_ids):
 
4326
        # XXX: One of source or target is using chks, and they don't have
 
4327
        #      compatible serializations. The StreamSink code expects to be
 
4328
        #      able to convert on the target, so we need to put
 
4329
        #      bytes-on-the-wire that can be converted
 
4330
        yield ('inventories', self._stream_invs_as_fulltexts(revision_ids))
 
4331
 
 
4332
    def _stream_invs_as_fulltexts(self, revision_ids):
4624
4333
        from_repo = self.from_repository
 
4334
        from_serializer = from_repo._format._serializer
4625
4335
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4626
4336
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
4627
 
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
4628
 
        # method...
4629
 
        inventories = self.from_repository.iter_inventories(
4630
 
            revision_ids, 'topological')
4631
 
        format = from_repo._format
4632
 
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
4633
 
        inventory_cache = lru_cache.LRUCache(50)
4634
 
        null_inventory = from_repo.revision_tree(
4635
 
            _mod_revision.NULL_REVISION).inventory
4636
 
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
4637
 
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
4638
 
        # repo back into a non-rich-root repo ought to be allowed)
4639
 
        serializer = inventory_delta.InventoryDeltaSerializer(
4640
 
            versioned_root=format.rich_root_data,
4641
 
            tree_references=format.supports_tree_reference)
4642
 
        for inv in inventories:
 
4337
        for inv in self.from_repository.iter_inventories(revision_ids):
 
4338
            # XXX: This is a bit hackish, but it works. Basically,
 
4339
            #      CHKSerializer 'accidentally' supports
 
4340
            #      read/write_inventory_to_string, even though that is never
 
4341
            #      the format that is stored on disk. It *does* give us a
 
4342
            #      single string representation for an inventory, so live with
 
4343
            #      it for now.
 
4344
            #      This would be far better if we had a 'serialized inventory
 
4345
            #      delta' form. Then we could use 'inventory._make_delta', and
 
4346
            #      transmit that. This would both be faster to generate, and
 
4347
            #      result in fewer bytes-on-the-wire.
 
4348
            as_bytes = from_serializer.write_inventory_to_string(inv)
4643
4349
            key = (inv.revision_id,)
4644
4350
            parent_keys = parent_map.get(key, ())
4645
 
            delta = None
4646
 
            if not delta_versus_null and parent_keys:
4647
 
                # The caller did not ask for complete inventories and we have
4648
 
                # some parents that we can delta against.  Make a delta against
4649
 
                # each parent so that we can find the smallest.
4650
 
                parent_ids = [parent_key[0] for parent_key in parent_keys]
4651
 
                for parent_id in parent_ids:
4652
 
                    if parent_id not in invs_sent_so_far:
4653
 
                        # We don't know that the remote side has this basis, so
4654
 
                        # we can't use it.
4655
 
                        continue
4656
 
                    if parent_id == _mod_revision.NULL_REVISION:
4657
 
                        parent_inv = null_inventory
4658
 
                    else:
4659
 
                        parent_inv = inventory_cache.get(parent_id, None)
4660
 
                        if parent_inv is None:
4661
 
                            parent_inv = from_repo.get_inventory(parent_id)
4662
 
                    candidate_delta = inv._make_delta(parent_inv)
4663
 
                    if (delta is None or
4664
 
                        len(delta) > len(candidate_delta)):
4665
 
                        delta = candidate_delta
4666
 
                        basis_id = parent_id
4667
 
            if delta is None:
4668
 
                # Either none of the parents ended up being suitable, or we
4669
 
                # were asked to delta against NULL
4670
 
                basis_id = _mod_revision.NULL_REVISION
4671
 
                delta = inv._make_delta(null_inventory)
4672
 
            invs_sent_so_far.add(inv.revision_id)
4673
 
            inventory_cache[inv.revision_id] = inv
4674
 
            delta_serialized = ''.join(
4675
 
                serializer.delta_to_lines(basis_id, key[-1], delta))
4676
4351
            yield versionedfile.FulltextContentFactory(
4677
 
                key, parent_keys, None, delta_serialized)
 
4352
                key, parent_keys, None, as_bytes)
4678
4353
 
4679
4354
 
4680
4355
def _iter_for_revno(repo, partial_history_cache, stop_index=None,