~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-08-03 07:15:11 UTC
  • mfrom: (4580.1.2 408199-check-2a)
  • Revision ID: pqm@pqm.ubuntu.com-20090803071511-dwb041qzak0vjzdk
(mbp) check blackbox tests now handle the root being included in the
        file-id count

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
 
    controldir,
29
27
    debug,
30
 
    fetch as _mod_fetch,
 
28
    errors,
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,
 
42
    ui,
47
43
    versionedfile,
48
44
    )
49
45
from bzrlib.bundle import serializer
52
48
from bzrlib.testament import Testament
53
49
""")
54
50
 
55
 
from bzrlib import (
56
 
    errors,
57
 
    registry,
58
 
    ui,
59
 
    )
60
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
51
from bzrlib.decorators import needs_read_lock, needs_write_lock
61
52
from bzrlib.inter import InterObject
62
53
from bzrlib.inventory import (
63
54
    Inventory,
65
56
    ROOT_ID,
66
57
    entry_factory,
67
58
    )
68
 
from bzrlib.recordcounter import RecordCounter
69
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
 
59
from bzrlib import registry
70
60
from bzrlib.trace import (
71
61
    log_exception_quietly, note, mutter, mutter_callsite, warning)
72
62
 
75
65
_deprecation_warning_done = False
76
66
 
77
67
 
78
 
class IsInWriteGroupError(errors.InternalBzrError):
79
 
 
80
 
    _fmt = "May not refresh_data of repo %(repo)s while in a write group."
81
 
 
82
 
    def __init__(self, repo):
83
 
        errors.InternalBzrError.__init__(self, repo=repo)
84
 
 
85
 
 
86
68
class CommitBuilder(object):
87
69
    """Provides an interface to build up a commit.
88
70
 
222
204
            # an inventory delta was accumulated without creating a new
223
205
            # inventory.
224
206
            basis_id = self.basis_delta_revision
225
 
            # We ignore the 'inventory' returned by add_inventory_by_delta
226
 
            # because self.new_inventory is used to hint to the rest of the
227
 
            # system what code path was taken
228
 
            self.inv_sha1, _ = self.repository.add_inventory_by_delta(
 
207
            self.inv_sha1 = self.repository.add_inventory_by_delta(
229
208
                basis_id, self._basis_delta, self._new_revision_id,
230
209
                self.parents)
231
210
        else:
243
222
 
244
223
    def _gen_revision_id(self):
245
224
        """Return new revision-id."""
246
 
        return generate_ids.gen_revision_id(self._committer, self._timestamp)
 
225
        return generate_ids.gen_revision_id(self._config.username(),
 
226
                                            self._timestamp)
247
227
 
248
228
    def _generate_revision_if_needed(self):
249
229
        """Create a revision id if None was supplied.
289
269
 
290
270
        :param tree: The tree which is being committed.
291
271
        """
292
 
        if len(self.parents) == 0:
293
 
            raise errors.RootMissing()
 
272
        # NB: if there are no parents then this method is not called, so no
 
273
        # need to guard on parents having length.
294
274
        entry = entry_factory['directory'](tree.path2id(''), '',
295
275
            None)
296
276
        entry.revision = self._new_revision_id
484
464
            if content_summary[2] is None:
485
465
                raise ValueError("Files must not have executable = None")
486
466
            if not store:
487
 
                # We can't trust a check of the file length because of content
488
 
                # filtering...
489
 
                if (# if the exec bit has changed we have to store:
 
467
                if (# if the file length changed we have to store:
 
468
                    parent_entry.text_size != content_summary[1] or
 
469
                    # if the exec bit has changed we have to store:
490
470
                    parent_entry.executable != content_summary[2]):
491
471
                    store = True
492
472
                elif parent_entry.text_sha1 == content_summary[3]:
559
539
                ie.revision = parent_entry.revision
560
540
                return self._get_delta(ie, basis_inv, path), False, None
561
541
            ie.reference_revision = content_summary[3]
562
 
            if ie.reference_revision is None:
563
 
                raise AssertionError("invalid content_summary for nested tree: %r"
564
 
                    % (content_summary,))
565
542
            self._add_text_to_weave(ie.file_id, '', heads, None)
566
543
        else:
567
544
            raise NotImplementedError('unknown kind')
829
806
                seen_root = True
830
807
        self.new_inventory = None
831
808
        if len(inv_delta):
832
 
            # This should perhaps be guarded by a check that the basis we
833
 
            # commit against is the basis for the commit and if not do a delta
834
 
            # against the basis.
835
809
            self._any_changes = True
836
810
        if not seen_root:
837
811
            # housekeeping root entry changes do not affect no-change commits.
871
845
        # versioned roots do not change unless the tree found a change.
872
846
 
873
847
 
874
 
class RepositoryWriteLockResult(LogicalLockResult):
875
 
    """The result of write locking a repository.
876
 
 
877
 
    :ivar repository_token: The token obtained from the underlying lock, or
878
 
        None.
879
 
    :ivar unlock: A callable which will unlock the lock.
880
 
    """
881
 
 
882
 
    def __init__(self, unlock, repository_token):
883
 
        LogicalLockResult.__init__(self, unlock)
884
 
        self.repository_token = repository_token
885
 
 
886
 
    def __repr__(self):
887
 
        return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
888
 
            self.unlock)
889
 
 
890
 
 
891
848
######################################################################
892
849
# Repositories
893
850
 
894
851
 
895
 
class Repository(_RelockDebugMixin, controldir.ControlComponent):
 
852
class Repository(object):
896
853
    """Repository holding history for one or more branches.
897
854
 
898
855
    The repository holds and retrieves historical information including
967
924
        """
968
925
        if self._write_group is not self.get_transaction():
969
926
            # has an unlock or relock occured ?
970
 
            if suppress_errors:
971
 
                mutter(
972
 
                '(suppressed) mismatched lock context and write group. %r, %r',
973
 
                self._write_group, self.get_transaction())
974
 
                return
975
927
            raise errors.BzrError(
976
928
                'mismatched lock context and write group. %r, %r' %
977
929
                (self._write_group, self.get_transaction()))
1046
998
                " id and insertion revid (%r, %r)"
1047
999
                % (inv.revision_id, revision_id))
1048
1000
        if inv.root is None:
1049
 
            raise errors.RootMissing()
 
1001
            raise AssertionError()
1050
1002
        return self._add_inventory_checked(revision_id, inv, parents)
1051
1003
 
1052
1004
    def _add_inventory_checked(self, revision_id, inv, parents):
1056
1008
 
1057
1009
        :seealso: add_inventory, for the contract.
1058
1010
        """
1059
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
 
1011
        inv_lines = self._serialise_inventory_to_lines(inv)
1060
1012
        return self._inventory_add_lines(revision_id, parents,
1061
1013
            inv_lines, check_content=False)
1062
1014
 
1111
1063
        check_content=True):
1112
1064
        """Store lines in inv_vf and return the sha1 of the inventory."""
1113
1065
        parents = [(parent,) for parent in parents]
1114
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
1066
        return self.inventories.add_lines((revision_id,), parents, lines,
1115
1067
            check_content=check_content)[0]
1116
 
        self.inventories._access.flush()
1117
 
        return result
1118
1068
 
1119
1069
    def add_revision(self, revision_id, rev, inv=None, config=None):
1120
1070
        """Add rev to the revision store as revision_id.
1196
1146
        # The old API returned a list, should this actually be a set?
1197
1147
        return parent_map.keys()
1198
1148
 
1199
 
    def _check_inventories(self, checker):
1200
 
        """Check the inventories found from the revision scan.
1201
 
        
1202
 
        This is responsible for verifying the sha1 of inventories and
1203
 
        creating a pending_keys set that covers data referenced by inventories.
1204
 
        """
1205
 
        bar = ui.ui_factory.nested_progress_bar()
1206
 
        try:
1207
 
            self._do_check_inventories(checker, bar)
1208
 
        finally:
1209
 
            bar.finished()
1210
 
 
1211
 
    def _do_check_inventories(self, checker, bar):
1212
 
        """Helper for _check_inventories."""
1213
 
        revno = 0
1214
 
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
1215
 
        kinds = ['chk_bytes', 'texts']
1216
 
        count = len(checker.pending_keys)
1217
 
        bar.update("inventories", 0, 2)
1218
 
        current_keys = checker.pending_keys
1219
 
        checker.pending_keys = {}
1220
 
        # Accumulate current checks.
1221
 
        for key in current_keys:
1222
 
            if key[0] != 'inventories' and key[0] not in kinds:
1223
 
                checker._report_items.append('unknown key type %r' % (key,))
1224
 
            keys[key[0]].add(key[1:])
1225
 
        if keys['inventories']:
1226
 
            # NB: output order *should* be roughly sorted - topo or
1227
 
            # inverse topo depending on repository - either way decent
1228
 
            # to just delta against. However, pre-CHK formats didn't
1229
 
            # try to optimise inventory layout on disk. As such the
1230
 
            # pre-CHK code path does not use inventory deltas.
1231
 
            last_object = None
1232
 
            for record in self.inventories.check(keys=keys['inventories']):
1233
 
                if record.storage_kind == 'absent':
1234
 
                    checker._report_items.append(
1235
 
                        'Missing inventory {%s}' % (record.key,))
1236
 
                else:
1237
 
                    last_object = self._check_record('inventories', record,
1238
 
                        checker, last_object,
1239
 
                        current_keys[('inventories',) + record.key])
1240
 
            del keys['inventories']
1241
 
        else:
1242
 
            return
1243
 
        bar.update("texts", 1)
1244
 
        while (checker.pending_keys or keys['chk_bytes']
1245
 
            or keys['texts']):
1246
 
            # Something to check.
1247
 
            current_keys = checker.pending_keys
1248
 
            checker.pending_keys = {}
1249
 
            # Accumulate current checks.
1250
 
            for key in current_keys:
1251
 
                if key[0] not in kinds:
1252
 
                    checker._report_items.append('unknown key type %r' % (key,))
1253
 
                keys[key[0]].add(key[1:])
1254
 
            # Check the outermost kind only - inventories || chk_bytes || texts
1255
 
            for kind in kinds:
1256
 
                if keys[kind]:
1257
 
                    last_object = None
1258
 
                    for record in getattr(self, kind).check(keys=keys[kind]):
1259
 
                        if record.storage_kind == 'absent':
1260
 
                            checker._report_items.append(
1261
 
                                'Missing %s {%s}' % (kind, record.key,))
1262
 
                        else:
1263
 
                            last_object = self._check_record(kind, record,
1264
 
                                checker, last_object, current_keys[(kind,) + record.key])
1265
 
                    keys[kind] = set()
1266
 
                    break
1267
 
 
1268
 
    def _check_record(self, kind, record, checker, last_object, item_data):
1269
 
        """Check a single text from this repository."""
1270
 
        if kind == 'inventories':
1271
 
            rev_id = record.key[0]
1272
 
            inv = self._deserialise_inventory(rev_id,
1273
 
                record.get_bytes_as('fulltext'))
1274
 
            if last_object is not None:
1275
 
                delta = inv._make_delta(last_object)
1276
 
                for old_path, path, file_id, ie in delta:
1277
 
                    if ie is None:
1278
 
                        continue
1279
 
                    ie.check(checker, rev_id, inv)
1280
 
            else:
1281
 
                for path, ie in inv.iter_entries():
1282
 
                    ie.check(checker, rev_id, inv)
1283
 
            if self._format.fast_deltas:
1284
 
                return inv
1285
 
        elif kind == 'chk_bytes':
1286
 
            # No code written to check chk_bytes for this repo format.
1287
 
            checker._report_items.append(
1288
 
                'unsupported key type chk_bytes for %s' % (record.key,))
1289
 
        elif kind == 'texts':
1290
 
            self._check_text(record, checker, item_data)
1291
 
        else:
1292
 
            checker._report_items.append(
1293
 
                'unknown key type %s for %s' % (kind, record.key))
1294
 
 
1295
 
    def _check_text(self, record, checker, item_data):
1296
 
        """Check a single text."""
1297
 
        # Check it is extractable.
1298
 
        # TODO: check length.
1299
 
        if record.storage_kind == 'chunked':
1300
 
            chunks = record.get_bytes_as(record.storage_kind)
1301
 
            sha1 = osutils.sha_strings(chunks)
1302
 
            length = sum(map(len, chunks))
1303
 
        else:
1304
 
            content = record.get_bytes_as('fulltext')
1305
 
            sha1 = osutils.sha_string(content)
1306
 
            length = len(content)
1307
 
        if item_data and sha1 != item_data[1]:
1308
 
            checker._report_items.append(
1309
 
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
1310
 
                (record.key, sha1, item_data[1], item_data[2]))
1311
 
 
1312
1149
    @staticmethod
1313
1150
    def create(a_bzrdir):
1314
1151
        """Construct the current default format repository in a_bzrdir."""
1319
1156
 
1320
1157
        :param _format: The format of the repository on disk.
1321
1158
        :param a_bzrdir: The BzrDir of the repository.
 
1159
 
 
1160
        In the future we will have a single api for all stores for
 
1161
        getting file texts, inventories and revisions, then
 
1162
        this construct will accept instances of those things.
1322
1163
        """
1323
 
        # In the future we will have a single api for all stores for
1324
 
        # getting file texts, inventories and revisions, then
1325
 
        # this construct will accept instances of those things.
1326
1164
        super(Repository, self).__init__()
1327
1165
        self._format = _format
1328
1166
        # the following are part of the public API for Repository:
1334
1172
        self._reconcile_does_inventory_gc = True
1335
1173
        self._reconcile_fixes_text_parents = False
1336
1174
        self._reconcile_backsup_inventory = True
 
1175
        # not right yet - should be more semantically clear ?
 
1176
        #
 
1177
        # TODO: make sure to construct the right store classes, etc, depending
 
1178
        # on whether escaping is required.
 
1179
        self._warn_if_deprecated()
1337
1180
        self._write_group = None
1338
1181
        # Additional places to query for data.
1339
1182
        self._fallback_repositories = []
1340
1183
        # An InventoryEntry cache, used during deserialization
1341
1184
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
1342
 
        # Is it safe to return inventory entries directly from the entry cache,
1343
 
        # rather copying them?
1344
 
        self._safe_to_return_from_cache = False
1345
 
 
1346
 
    @property
1347
 
    def user_transport(self):
1348
 
        return self.bzrdir.user_transport
1349
 
 
1350
 
    @property
1351
 
    def control_transport(self):
1352
 
        return self._transport
1353
1185
 
1354
1186
    def __repr__(self):
1355
1187
        if self._fallback_repositories:
1404
1236
        data during reads, and allows a 'write_group' to be obtained. Write
1405
1237
        groups must be used for actual data insertion.
1406
1238
 
1407
 
        A token should be passed in if you know that you have locked the object
1408
 
        some other way, and need to synchronise this object's state with that
1409
 
        fact.
1410
 
 
1411
 
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1412
 
 
1413
1239
        :param token: if this is already locked, then lock_write will fail
1414
1240
            unless the token matches the existing lock.
1415
1241
        :returns: a token if this instance supports tokens, otherwise None.
1418
1244
        :raises MismatchedToken: if the specified token doesn't match the token
1419
1245
            of the existing lock.
1420
1246
        :seealso: start_write_group.
1421
 
        :return: A RepositoryWriteLockResult.
 
1247
 
 
1248
        A token should be passed in if you know that you have locked the object
 
1249
        some other way, and need to synchronise this object's state with that
 
1250
        fact.
 
1251
 
 
1252
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1422
1253
        """
1423
1254
        locked = self.is_locked()
1424
 
        token = self.control_files.lock_write(token=token)
 
1255
        result = self.control_files.lock_write(token=token)
1425
1256
        if not locked:
1426
 
            self._warn_if_deprecated()
1427
 
            self._note_lock('w')
1428
1257
            for repo in self._fallback_repositories:
1429
1258
                # Writes don't affect fallback repos
1430
1259
                repo.lock_read()
1431
1260
            self._refresh_data()
1432
 
        return RepositoryWriteLockResult(self.unlock, token)
 
1261
        return result
1433
1262
 
1434
1263
    def lock_read(self):
1435
 
        """Lock the repository for read operations.
1436
 
 
1437
 
        :return: An object with an unlock method which will release the lock
1438
 
            obtained.
1439
 
        """
1440
1264
        locked = self.is_locked()
1441
1265
        self.control_files.lock_read()
1442
1266
        if not locked:
1443
 
            self._warn_if_deprecated()
1444
 
            self._note_lock('r')
1445
1267
            for repo in self._fallback_repositories:
1446
1268
                repo.lock_read()
1447
1269
            self._refresh_data()
1448
 
        return LogicalLockResult(self.unlock)
1449
1270
 
1450
1271
    def get_physical_lock_status(self):
1451
1272
        return self.control_files.get_physical_lock_status()
1511
1332
 
1512
1333
        # now gather global repository information
1513
1334
        # XXX: This is available for many repos regardless of listability.
1514
 
        if self.user_transport.listable():
 
1335
        if self.bzrdir.root_transport.listable():
1515
1336
            # XXX: do we want to __define len__() ?
1516
1337
            # Maybe the versionedfiles object should provide a different
1517
1338
            # method to get the number of keys.
1527
1348
        :param using: If True, list only branches using this repository.
1528
1349
        """
1529
1350
        if using and not self.is_shared():
1530
 
            return self.bzrdir.list_branches()
 
1351
            try:
 
1352
                return [self.bzrdir.open_branch()]
 
1353
            except errors.NotBranchError:
 
1354
                return []
1531
1355
        class Evaluator(object):
1532
1356
 
1533
1357
            def __init__(self):
1542
1366
                    except errors.NoRepositoryPresent:
1543
1367
                        pass
1544
1368
                    else:
1545
 
                        return False, ([], repository)
 
1369
                        return False, (None, repository)
1546
1370
                self.first_call = False
1547
 
                value = (bzrdir.list_branches(), None)
 
1371
                try:
 
1372
                    value = (bzrdir.open_branch(), None)
 
1373
                except errors.NotBranchError:
 
1374
                    value = (None, None)
1548
1375
                return True, value
1549
1376
 
1550
 
        ret = []
1551
 
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
1552
 
                self.user_transport, evaluate=Evaluator()):
1553
 
            if branches is not None:
1554
 
                ret.extend(branches)
 
1377
        branches = []
 
1378
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1379
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
1380
            if branch is not None:
 
1381
                branches.append(branch)
1555
1382
            if not using and repository is not None:
1556
 
                ret.extend(repository.find_branches())
1557
 
        return ret
 
1383
                branches.extend(repository.find_branches())
 
1384
        return branches
1558
1385
 
1559
1386
    @needs_read_lock
1560
1387
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1589
1416
        """Commit the contents accrued within the current write group.
1590
1417
 
1591
1418
        :seealso: start_write_group.
1592
 
        
1593
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1594
1419
        """
1595
1420
        if self._write_group is not self.get_transaction():
1596
1421
            # has an unlock or relock occured ?
1650
1475
        # but at the moment we're only checking for texts referenced by
1651
1476
        # inventories at the graph's edge.
1652
1477
        key_deps = self.revisions._index._key_dependencies
1653
 
        key_deps.satisfy_refs_for_keys(present_inventories)
 
1478
        key_deps.add_keys(present_inventories)
1654
1479
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1655
1480
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1656
1481
        missing_texts = set()
1669
1494
        return missing_keys
1670
1495
 
1671
1496
    def refresh_data(self):
1672
 
        """Re-read any data needed to synchronise with disk.
 
1497
        """Re-read any data needed to to synchronise with disk.
1673
1498
 
1674
1499
        This method is intended to be called after another repository instance
1675
1500
        (such as one used by a smart server) has inserted data into the
1676
 
        repository. On all repositories this will work outside of write groups.
1677
 
        Some repository formats (pack and newer for bzrlib native formats)
1678
 
        support refresh_data inside write groups. If called inside a write
1679
 
        group on a repository that does not support refreshing in a write group
1680
 
        IsInWriteGroupError will be raised.
 
1501
        repository. It may not be called during a write group, but may be
 
1502
        called at any other time.
1681
1503
        """
 
1504
        if self.is_in_write_group():
 
1505
            raise errors.InternalBzrError(
 
1506
                "May not refresh_data while in a write group.")
1682
1507
        self._refresh_data()
1683
1508
 
1684
1509
    def resume_write_group(self, tokens):
1723
1548
                "May not fetch while in a write group.")
1724
1549
        # fast path same-url fetch operations
1725
1550
        # TODO: lift out to somewhere common with RemoteRepository
1726
 
        # <https://bugs.launchpad.net/bzr/+bug/401646>
 
1551
        # <https://bugs.edge.launchpad.net/bzr/+bug/401646>
1727
1552
        if (self.has_same_location(source)
1728
1553
            and fetch_spec is None
1729
1554
            and self._has_same_fallbacks(source)):
1757
1582
        :param revprops: Optional dictionary of revision properties.
1758
1583
        :param revision_id: Optional revision id.
1759
1584
        """
1760
 
        if self._fallback_repositories:
1761
 
            raise errors.BzrError("Cannot commit from a lightweight checkout "
1762
 
                "to a stacked branch. See "
1763
 
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1764
1585
        result = self._commit_builder_class(self, parents, config,
1765
1586
            timestamp, timezone, committer, revprops, revision_id)
1766
1587
        self.start_write_group()
1767
1588
        return result
1768
1589
 
1769
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1770
1590
    def unlock(self):
1771
1591
        if (self.control_files._lock_count == 1 and
1772
1592
            self.control_files._lock_mode == 'w'):
1894
1714
 
1895
1715
    @needs_read_lock
1896
1716
    def get_revisions(self, revision_ids):
1897
 
        """Get many revisions at once.
1898
 
        
1899
 
        Repositories that need to check data on every revision read should 
1900
 
        subclass this method.
1901
 
        """
 
1717
        """Get many revisions at once."""
1902
1718
        return self._get_revisions(revision_ids)
1903
1719
 
1904
1720
    @needs_read_lock
1905
1721
    def _get_revisions(self, revision_ids):
1906
1722
        """Core work logic to get many revisions without sanity checks."""
 
1723
        for rev_id in revision_ids:
 
1724
            if not rev_id or not isinstance(rev_id, basestring):
 
1725
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1726
        keys = [(key,) for key in revision_ids]
 
1727
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1907
1728
        revs = {}
1908
 
        for revid, rev in self._iter_revisions(revision_ids):
1909
 
            if rev is None:
1910
 
                raise errors.NoSuchRevision(self, revid)
1911
 
            revs[revid] = rev
 
1729
        for record in stream:
 
1730
            if record.storage_kind == 'absent':
 
1731
                raise errors.NoSuchRevision(self, record.key[0])
 
1732
            text = record.get_bytes_as('fulltext')
 
1733
            rev = self._serializer.read_revision_from_string(text)
 
1734
            revs[record.key[0]] = rev
1912
1735
        return [revs[revid] for revid in revision_ids]
1913
1736
 
1914
 
    def _iter_revisions(self, revision_ids):
1915
 
        """Iterate over revision objects.
1916
 
 
1917
 
        :param revision_ids: An iterable of revisions to examine. None may be
1918
 
            passed to request all revisions known to the repository. Note that
1919
 
            not all repositories can find unreferenced revisions; for those
1920
 
            repositories only referenced ones will be returned.
1921
 
        :return: An iterator of (revid, revision) tuples. Absent revisions (
1922
 
            those asked for but not available) are returned as (revid, None).
1923
 
        """
1924
 
        if revision_ids is None:
1925
 
            revision_ids = self.all_revision_ids()
1926
 
        else:
1927
 
            for rev_id in revision_ids:
1928
 
                if not rev_id or not isinstance(rev_id, basestring):
1929
 
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1930
 
        keys = [(key,) for key in revision_ids]
1931
 
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1932
 
        for record in stream:
1933
 
            revid = record.key[0]
1934
 
            if record.storage_kind == 'absent':
1935
 
                yield (revid, None)
1936
 
            else:
1937
 
                text = record.get_bytes_as('fulltext')
1938
 
                rev = self._serializer.read_revision_from_string(text)
1939
 
                yield (revid, rev)
 
1737
    @needs_read_lock
 
1738
    def get_revision_xml(self, revision_id):
 
1739
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1740
        #       would have already do it.
 
1741
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1742
        # TODO: this can't just be replaced by:
 
1743
        # return self._serializer.write_revision_to_string(
 
1744
        #     self.get_revision(revision_id))
 
1745
        # as cStringIO preservers the encoding unlike write_revision_to_string
 
1746
        # or some other call down the path.
 
1747
        rev = self.get_revision(revision_id)
 
1748
        rev_tmp = cStringIO.StringIO()
 
1749
        # the current serializer..
 
1750
        self._serializer.write_revision(rev, rev_tmp)
 
1751
        rev_tmp.seek(0)
 
1752
        return rev_tmp.getvalue()
1940
1753
 
1941
1754
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1942
1755
        """Produce a generator of revision deltas.
2185
1998
        """
2186
1999
        selected_keys = set((revid,) for revid in revision_ids)
2187
2000
        w = _inv_weave or self.inventories
2188
 
        return self._find_file_ids_from_xml_inventory_lines(
2189
 
            w.iter_lines_added_or_present_in_keys(
2190
 
                selected_keys, pb=None),
2191
 
            selected_keys)
 
2001
        pb = ui.ui_factory.nested_progress_bar()
 
2002
        try:
 
2003
            return self._find_file_ids_from_xml_inventory_lines(
 
2004
                w.iter_lines_added_or_present_in_keys(
 
2005
                    selected_keys, pb=pb),
 
2006
                selected_keys)
 
2007
        finally:
 
2008
            pb.finished()
2192
2009
 
2193
2010
    def iter_files_bytes(self, desired_files):
2194
2011
        """Iterate through file versions.
2276
2093
                batch_size]
2277
2094
            if not to_query:
2278
2095
                break
2279
 
            for revision_id in to_query:
 
2096
            for rev_tree in self.revision_trees(to_query):
 
2097
                revision_id = rev_tree.get_revision_id()
2280
2098
                parent_ids = ancestors[revision_id]
2281
2099
                for text_key in revision_keys[revision_id]:
2282
2100
                    pb.update("Calculating text parents", processed_texts)
2355
2173
        num_file_ids = len(file_ids)
2356
2174
        for file_id, altered_versions in file_ids.iteritems():
2357
2175
            if pb is not None:
2358
 
                pb.update("Fetch texts", count, num_file_ids)
 
2176
                pb.update("fetch texts", count, num_file_ids)
2359
2177
            count += 1
2360
2178
            yield ("file", file_id, altered_versions)
2361
2179
 
2382
2200
        """Get Inventory object by revision id."""
2383
2201
        return self.iter_inventories([revision_id]).next()
2384
2202
 
2385
 
    def iter_inventories(self, revision_ids, ordering=None):
 
2203
    def iter_inventories(self, revision_ids):
2386
2204
        """Get many inventories by revision_ids.
2387
2205
 
2388
2206
        This will buffer some or all of the texts used in constructing the
2390
2208
        time.
2391
2209
 
2392
2210
        :param revision_ids: The expected revision ids of the inventories.
2393
 
        :param ordering: optional ordering, e.g. 'topological'.  If not
2394
 
            specified, the order of revision_ids will be preserved (by
2395
 
            buffering if necessary).
2396
2211
        :return: An iterator of inventories.
2397
2212
        """
2398
2213
        if ((None in revision_ids)
2399
2214
            or (_mod_revision.NULL_REVISION in revision_ids)):
2400
2215
            raise ValueError('cannot get null revision inventory')
2401
 
        return self._iter_inventories(revision_ids, ordering)
 
2216
        return self._iter_inventories(revision_ids)
2402
2217
 
2403
 
    def _iter_inventories(self, revision_ids, ordering):
 
2218
    def _iter_inventories(self, revision_ids):
2404
2219
        """single-document based inventory iteration."""
2405
 
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2406
 
        for text, revision_id in inv_xmls:
2407
 
            yield self._deserialise_inventory(revision_id, text)
 
2220
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
 
2221
            yield self.deserialise_inventory(revision_id, text)
2408
2222
 
2409
 
    def _iter_inventory_xmls(self, revision_ids, ordering):
2410
 
        if ordering is None:
2411
 
            order_as_requested = True
2412
 
            ordering = 'unordered'
2413
 
        else:
2414
 
            order_as_requested = False
 
2223
    def _iter_inventory_xmls(self, revision_ids):
2415
2224
        keys = [(revision_id,) for revision_id in revision_ids]
2416
 
        if not keys:
2417
 
            return
2418
 
        if order_as_requested:
2419
 
            key_iter = iter(keys)
2420
 
            next_key = key_iter.next()
2421
 
        stream = self.inventories.get_record_stream(keys, ordering, True)
 
2225
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2422
2226
        text_chunks = {}
2423
2227
        for record in stream:
2424
2228
            if record.storage_kind != 'absent':
2425
 
                chunks = record.get_bytes_as('chunked')
2426
 
                if order_as_requested:
2427
 
                    text_chunks[record.key] = chunks
2428
 
                else:
2429
 
                    yield ''.join(chunks), record.key[-1]
 
2229
                text_chunks[record.key] = record.get_bytes_as('chunked')
2430
2230
            else:
2431
2231
                raise errors.NoSuchRevision(self, record.key)
2432
 
            if order_as_requested:
2433
 
                # Yield as many results as we can while preserving order.
2434
 
                while next_key in text_chunks:
2435
 
                    chunks = text_chunks.pop(next_key)
2436
 
                    yield ''.join(chunks), next_key[-1]
2437
 
                    try:
2438
 
                        next_key = key_iter.next()
2439
 
                    except StopIteration:
2440
 
                        # We still want to fully consume the get_record_stream,
2441
 
                        # just in case it is not actually finished at this point
2442
 
                        next_key = None
2443
 
                        break
 
2232
        for key in keys:
 
2233
            chunks = text_chunks.pop(key)
 
2234
            yield ''.join(chunks), key[-1]
2444
2235
 
2445
 
    def _deserialise_inventory(self, revision_id, xml):
 
2236
    def deserialise_inventory(self, revision_id, xml):
2446
2237
        """Transform the xml into an inventory object.
2447
2238
 
2448
2239
        :param revision_id: The expected revision id of the inventory.
2449
2240
        :param xml: A serialised inventory.
2450
2241
        """
2451
2242
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2452
 
                    entry_cache=self._inventory_entry_cache,
2453
 
                    return_from_cache=self._safe_to_return_from_cache)
 
2243
                    entry_cache=self._inventory_entry_cache)
2454
2244
        if result.revision_id != revision_id:
2455
2245
            raise AssertionError('revision id mismatch %s != %s' % (
2456
2246
                result.revision_id, revision_id))
2457
2247
        return result
2458
2248
 
 
2249
    def serialise_inventory(self, inv):
 
2250
        return self._serializer.write_inventory_to_string(inv)
 
2251
 
 
2252
    def _serialise_inventory_to_lines(self, inv):
 
2253
        return self._serializer.write_inventory_to_lines(inv)
 
2254
 
2459
2255
    def get_serializer_format(self):
2460
2256
        return self._serializer.format_num
2461
2257
 
2462
2258
    @needs_read_lock
2463
 
    def _get_inventory_xml(self, revision_id):
2464
 
        """Get serialized inventory as a string."""
2465
 
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
 
2259
    def get_inventory_xml(self, revision_id):
 
2260
        """Get inventory XML as a file object."""
 
2261
        texts = self._iter_inventory_xmls([revision_id])
2466
2262
        try:
2467
2263
            text, revision_id = texts.next()
2468
2264
        except StopIteration:
2469
2265
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2470
2266
        return text
2471
2267
 
 
2268
    @needs_read_lock
 
2269
    def get_inventory_sha1(self, revision_id):
 
2270
        """Return the sha1 hash of the inventory entry
 
2271
        """
 
2272
        return self.get_revision(revision_id).inventory_sha1
 
2273
 
2472
2274
    def get_rev_id_for_revno(self, revno, known_pair):
2473
2275
        """Return the revision id of a revno, given a later (revno, revid)
2474
2276
        pair in the same history.
2525
2327
            else:
2526
2328
                next_id = parents[0]
2527
2329
 
 
2330
    @needs_read_lock
 
2331
    def get_revision_inventory(self, revision_id):
 
2332
        """Return inventory of a past revision."""
 
2333
        # TODO: Unify this with get_inventory()
 
2334
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
2335
        # must be the same as its revision, so this is trivial.
 
2336
        if revision_id is None:
 
2337
            # This does not make sense: if there is no revision,
 
2338
            # then it is the current tree inventory surely ?!
 
2339
            # and thus get_root_id() is something that looks at the last
 
2340
            # commit on the branch, and the get_root_id is an inventory check.
 
2341
            raise NotImplementedError
 
2342
            # return Inventory(self.get_root_id())
 
2343
        else:
 
2344
            return self.get_inventory(revision_id)
 
2345
 
2528
2346
    def is_shared(self):
2529
2347
        """Return True if this repository is flagged as a shared repository."""
2530
2348
        raise NotImplementedError(self.is_shared)
2564
2382
            return RevisionTree(self, Inventory(root_id=None),
2565
2383
                                _mod_revision.NULL_REVISION)
2566
2384
        else:
2567
 
            inv = self.get_inventory(revision_id)
 
2385
            inv = self.get_revision_inventory(revision_id)
2568
2386
            return RevisionTree(self, inv, revision_id)
2569
2387
 
2570
2388
    def revision_trees(self, revision_ids):
2623
2441
            keys = tsort.topo_sort(parent_map)
2624
2442
        return [None] + list(keys)
2625
2443
 
2626
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
2444
    def pack(self, hint=None):
2627
2445
        """Compress the data within the repository.
2628
2446
 
2629
2447
        This operation only makes sense for some repository types. For other
2639
2457
            obtained from the result of commit_write_group(). Out of
2640
2458
            date hints are simply ignored, because concurrent operations
2641
2459
            can obsolete them rapidly.
2642
 
 
2643
 
        :param clean_obsolete_packs: Clean obsolete packs immediately after
2644
 
            the pack operation.
2645
2460
        """
2646
2461
 
2647
2462
    def get_transaction(self):
2663
2478
        for ((revision_id,), parent_keys) in \
2664
2479
                self.revisions.get_parent_map(query_keys).iteritems():
2665
2480
            if parent_keys:
2666
 
                result[revision_id] = tuple([parent_revid
2667
 
                    for (parent_revid,) in parent_keys])
 
2481
                result[revision_id] = tuple(parent_revid
 
2482
                    for (parent_revid,) in parent_keys)
2668
2483
            else:
2669
2484
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2670
2485
        return result
2672
2487
    def _make_parents_provider(self):
2673
2488
        return self
2674
2489
 
2675
 
    @needs_read_lock
2676
 
    def get_known_graph_ancestry(self, revision_ids):
2677
 
        """Return the known graph for a set of revision ids and their ancestors.
2678
 
        """
2679
 
        st = static_tuple.StaticTuple
2680
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
2681
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
2682
 
        return graph.GraphThunkIdsToKeys(known_graph)
2683
 
 
2684
2490
    def get_graph(self, other_repository=None):
2685
2491
        """Return the graph walker for this repository format"""
2686
2492
        parents_provider = self._make_parents_provider()
2690
2496
                [parents_provider, other_repository._make_parents_provider()])
2691
2497
        return graph.Graph(parents_provider)
2692
2498
 
2693
 
    def _get_versioned_file_checker(self, text_key_references=None,
2694
 
        ancestors=None):
 
2499
    def _get_versioned_file_checker(self, text_key_references=None):
2695
2500
        """Return an object suitable for checking versioned files.
2696
2501
        
2697
2502
        :param text_key_references: if non-None, an already built
2699
2504
            to whether they were referred to by the inventory of the
2700
2505
            revision_id that they contain. If None, this will be
2701
2506
            calculated.
2702
 
        :param ancestors: Optional result from
2703
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2704
 
            available.
2705
2507
        """
2706
2508
        return _VersionedFileChecker(self,
2707
 
            text_key_references=text_key_references, ancestors=ancestors)
 
2509
            text_key_references=text_key_references)
2708
2510
 
2709
2511
    def revision_ids_to_search_result(self, result_set):
2710
2512
        """Convert a set of revision ids to a graph SearchResult."""
2760
2562
        return record.get_bytes_as('fulltext')
2761
2563
 
2762
2564
    @needs_read_lock
2763
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
2565
    def check(self, revision_ids=None):
2764
2566
        """Check consistency of all history of given revision_ids.
2765
2567
 
2766
2568
        Different repository implementations should override _check().
2767
2569
 
2768
2570
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2769
2571
             will be checked.  Typically the last revision_id of a branch.
2770
 
        :param callback_refs: A dict of check-refs to resolve and callback
2771
 
            the check/_check method on the items listed as wanting the ref.
2772
 
            see bzrlib.check.
2773
 
        :param check_repo: If False do not check the repository contents, just 
2774
 
            calculate the data callback_refs requires and call them back.
2775
2572
        """
2776
 
        return self._check(revision_ids, callback_refs=callback_refs,
2777
 
            check_repo=check_repo)
 
2573
        return self._check(revision_ids)
2778
2574
 
2779
 
    def _check(self, revision_ids, callback_refs, check_repo):
2780
 
        result = check.Check(self, check_repo=check_repo)
2781
 
        result.check(callback_refs)
 
2575
    def _check(self, revision_ids):
 
2576
        result = check.Check(self)
 
2577
        result.check()
2782
2578
        return result
2783
2579
 
2784
 
    def _warn_if_deprecated(self, branch=None):
 
2580
    def _warn_if_deprecated(self):
2785
2581
        global _deprecation_warning_done
2786
2582
        if _deprecation_warning_done:
2787
2583
            return
2788
 
        try:
2789
 
            if branch is None:
2790
 
                conf = config.GlobalConfig()
2791
 
            else:
2792
 
                conf = branch.get_config()
2793
 
            if conf.suppress_warning('format_deprecation'):
2794
 
                return
2795
 
            warning("Format %s for %s is deprecated -"
2796
 
                    " please use 'bzr upgrade' to get better performance"
2797
 
                    % (self._format, self.bzrdir.transport.base))
2798
 
        finally:
2799
 
            _deprecation_warning_done = True
 
2584
        _deprecation_warning_done = True
 
2585
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
2586
                % (self._format, self.bzrdir.transport.base))
2800
2587
 
2801
2588
    def supports_rich_root(self):
2802
2589
        return self._format.rich_root_data
3083
2870
    # help), and for fetching when data won't have come from the same
3084
2871
    # compressor.
3085
2872
    pack_compresses = False
3086
 
    # Does the repository inventory storage understand references to trees?
3087
 
    supports_tree_reference = None
3088
 
    # Is the format experimental ?
3089
 
    experimental = False
3090
2873
 
3091
 
    def __repr__(self):
3092
 
        return "%s()" % self.__class__.__name__
 
2874
    def __str__(self):
 
2875
        return "<%s>" % self.__class__.__name__
3093
2876
 
3094
2877
    def __eq__(self, other):
3095
2878
        # format objects are generally stateless
3108
2891
        """
3109
2892
        try:
3110
2893
            transport = a_bzrdir.get_repository_transport(None)
3111
 
            format_string = transport.get_bytes("format")
 
2894
            format_string = transport.get("format").read()
3112
2895
            return format_registry.get(format_string)
3113
2896
        except errors.NoSuchFile:
3114
2897
            raise errors.NoRepositoryPresent(a_bzrdir)
3196
2979
        raise NotImplementedError(self.network_name)
3197
2980
 
3198
2981
    def check_conversion_target(self, target_format):
3199
 
        if self.rich_root_data and not target_format.rich_root_data:
3200
 
            raise errors.BadConversionTarget(
3201
 
                'Does not support rich root data.', target_format,
3202
 
                from_format=self)
3203
 
        if (self.supports_tree_reference and 
3204
 
            not getattr(target_format, 'supports_tree_reference', False)):
3205
 
            raise errors.BadConversionTarget(
3206
 
                'Does not support nested trees', target_format,
3207
 
                from_format=self)
 
2982
        raise NotImplementedError(self.check_conversion_target)
3208
2983
 
3209
2984
    def open(self, a_bzrdir, _found=False):
3210
2985
        """Return an instance of this format for the bzrdir a_bzrdir.
3213
2988
        """
3214
2989
        raise NotImplementedError(self.open)
3215
2990
 
3216
 
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
3217
 
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
3218
 
        hooks = BzrDir.hooks['post_repo_init']
3219
 
        if not hooks:
3220
 
            return
3221
 
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
3222
 
        for hook in hooks:
3223
 
            hook(params)
3224
 
 
3225
2991
 
3226
2992
class MetaDirRepositoryFormat(RepositoryFormat):
3227
2993
    """Common base class for the new repositories using the metadir layout."""
3432
3198
 
3433
3199
        :param revision_id: if None all content is copied, if NULL_REVISION no
3434
3200
                            content is copied.
3435
 
        :param pb: ignored.
 
3201
        :param pb: optional progress bar to use for progress reports. If not
 
3202
                   provided a default one will be created.
3436
3203
        :return: None.
3437
3204
        """
3438
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3439
3205
        from bzrlib.fetch import RepoFetcher
3440
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
3441
 
        if self.source._format.network_name() != self.target._format.network_name():
3442
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
3443
 
                from_format=self.source._format,
3444
 
                to_format=self.target._format)
3445
3206
        f = RepoFetcher(to_repository=self.target,
3446
3207
                               from_repository=self.source,
3447
3208
                               last_revision=revision_id,
3448
3209
                               fetch_spec=fetch_spec,
3449
 
                               find_ghosts=find_ghosts)
 
3210
                               pb=pb, find_ghosts=find_ghosts)
3450
3211
 
3451
3212
    def _walk_to_common_revisions(self, revision_ids):
3452
3213
        """Walk out from revision_ids in source to revisions target has.
3621
3382
                self.target.texts.insert_record_stream(
3622
3383
                    self.source.texts.get_record_stream(
3623
3384
                        self.source.texts.keys(), 'topological', False))
3624
 
                pb.update('Copying inventory', 0, 1)
 
3385
                pb.update('copying inventory', 0, 1)
3625
3386
                self.target.inventories.insert_record_stream(
3626
3387
                    self.source.inventories.get_record_stream(
3627
3388
                        self.source.inventories.keys(), 'topological', False))
3753
3514
        # This is redundant with format.check_conversion_target(), however that
3754
3515
        # raises an exception, and we just want to say "False" as in we won't
3755
3516
        # support converting between these formats.
3756
 
        if 'IDS_never' in debug.debug_flags:
3757
 
            return False
3758
3517
        if source.supports_rich_root() and not target.supports_rich_root():
3759
3518
            return False
3760
3519
        if (source._format.supports_tree_reference
3761
3520
            and not target._format.supports_tree_reference):
3762
3521
            return False
3763
 
        if target._fallback_repositories and target._format.supports_chks:
3764
 
            # IDS doesn't know how to copy CHKs for the parent inventories it
3765
 
            # adds to stacked repos.
3766
 
            return False
3767
 
        if 'IDS_always' in debug.debug_flags:
3768
 
            return True
3769
 
        # Only use this code path for local source and target.  IDS does far
3770
 
        # too much IO (both bandwidth and roundtrips) over a network.
3771
 
        if not source.bzrdir.transport.base.startswith('file:///'):
3772
 
            return False
3773
 
        if not target.bzrdir.transport.base.startswith('file:///'):
3774
 
            return False
3775
3522
        return True
3776
3523
 
3777
 
    def _get_trees(self, revision_ids, cache):
3778
 
        possible_trees = []
3779
 
        for rev_id in revision_ids:
3780
 
            if rev_id in cache:
3781
 
                possible_trees.append((rev_id, cache[rev_id]))
3782
 
            else:
3783
 
                # Not cached, but inventory might be present anyway.
3784
 
                try:
3785
 
                    tree = self.source.revision_tree(rev_id)
3786
 
                except errors.NoSuchRevision:
3787
 
                    # Nope, parent is ghost.
3788
 
                    pass
3789
 
                else:
3790
 
                    cache[rev_id] = tree
3791
 
                    possible_trees.append((rev_id, tree))
3792
 
        return possible_trees
3793
 
 
3794
 
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
 
3524
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
3795
3525
        """Get the best delta and base for this revision.
3796
3526
 
3797
3527
        :return: (basis_id, delta)
3798
3528
        """
 
3529
        possible_trees = [(parent_id, cache[parent_id])
 
3530
                          for parent_id in parent_ids
 
3531
                           if parent_id in cache]
 
3532
        if len(possible_trees) == 0:
 
3533
            # There either aren't any parents, or the parents aren't in the
 
3534
            # cache, so just use the last converted tree
 
3535
            possible_trees.append((basis_id, cache[basis_id]))
3799
3536
        deltas = []
3800
 
        # Generate deltas against each tree, to find the shortest.
3801
 
        texts_possibly_new_in_tree = set()
3802
3537
        for basis_id, basis_tree in possible_trees:
3803
3538
            delta = tree.inventory._make_delta(basis_tree.inventory)
3804
 
            for old_path, new_path, file_id, new_entry in delta:
3805
 
                if new_path is None:
3806
 
                    # This file_id isn't present in the new rev, so we don't
3807
 
                    # care about it.
3808
 
                    continue
3809
 
                if not new_path:
3810
 
                    # Rich roots are handled elsewhere...
3811
 
                    continue
3812
 
                kind = new_entry.kind
3813
 
                if kind != 'directory' and kind != 'file':
3814
 
                    # No text record associated with this inventory entry.
3815
 
                    continue
3816
 
                # This is a directory or file that has changed somehow.
3817
 
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3818
3539
            deltas.append((len(delta), basis_id, delta))
3819
3540
        deltas.sort()
3820
3541
        return deltas[0][1:]
3821
3542
 
3822
 
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
3823
 
        """Find all parent revisions that are absent, but for which the
3824
 
        inventory is present, and copy those inventories.
3825
 
 
3826
 
        This is necessary to preserve correctness when the source is stacked
3827
 
        without fallbacks configured.  (Note that in cases like upgrade the
3828
 
        source may be not have _fallback_repositories even though it is
3829
 
        stacked.)
3830
 
        """
3831
 
        parent_revs = set()
3832
 
        for parents in parent_map.values():
3833
 
            parent_revs.update(parents)
3834
 
        present_parents = self.source.get_parent_map(parent_revs)
3835
 
        absent_parents = set(parent_revs).difference(present_parents)
3836
 
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
3837
 
            (rev_id,) for rev_id in absent_parents)
3838
 
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
3839
 
        for parent_tree in self.source.revision_trees(parent_inv_ids):
3840
 
            current_revision_id = parent_tree.get_revision_id()
3841
 
            parents_parents_keys = parent_invs_keys_for_stacking[
3842
 
                (current_revision_id,)]
3843
 
            parents_parents = [key[-1] for key in parents_parents_keys]
3844
 
            basis_id = _mod_revision.NULL_REVISION
3845
 
            basis_tree = self.source.revision_tree(basis_id)
3846
 
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
3847
 
            self.target.add_inventory_by_delta(
3848
 
                basis_id, delta, current_revision_id, parents_parents)
3849
 
            cache[current_revision_id] = parent_tree
3850
 
 
3851
 
    def _fetch_batch(self, revision_ids, basis_id, cache, a_graph=None):
 
3543
    def _get_parent_keys(self, root_key, parent_map):
 
3544
        """Get the parent keys for a given root id."""
 
3545
        root_id, rev_id = root_key
 
3546
        # Include direct parents of the revision, but only if they used
 
3547
        # the same root_id and are heads.
 
3548
        parent_keys = []
 
3549
        for parent_id in parent_map[rev_id]:
 
3550
            if parent_id == _mod_revision.NULL_REVISION:
 
3551
                continue
 
3552
            if parent_id not in self._revision_id_to_root_id:
 
3553
                # We probably didn't read this revision, go spend the
 
3554
                # extra effort to actually check
 
3555
                try:
 
3556
                    tree = self.source.revision_tree(parent_id)
 
3557
                except errors.NoSuchRevision:
 
3558
                    # Ghost, fill out _revision_id_to_root_id in case we
 
3559
                    # encounter this again.
 
3560
                    # But set parent_root_id to None since we don't really know
 
3561
                    parent_root_id = None
 
3562
                else:
 
3563
                    parent_root_id = tree.get_root_id()
 
3564
                self._revision_id_to_root_id[parent_id] = None
 
3565
            else:
 
3566
                parent_root_id = self._revision_id_to_root_id[parent_id]
 
3567
            if root_id == parent_root_id:
 
3568
                # With stacking we _might_ want to refer to a non-local
 
3569
                # revision, but this code path only applies when we have the
 
3570
                # full content available, so ghosts really are ghosts, not just
 
3571
                # the edge of local data.
 
3572
                parent_keys.append((parent_id,))
 
3573
            else:
 
3574
                # root_id may be in the parent anyway.
 
3575
                try:
 
3576
                    tree = self.source.revision_tree(parent_id)
 
3577
                except errors.NoSuchRevision:
 
3578
                    # ghost, can't refer to it.
 
3579
                    pass
 
3580
                else:
 
3581
                    try:
 
3582
                        parent_keys.append((tree.inventory[root_id].revision,))
 
3583
                    except errors.NoSuchId:
 
3584
                        # not in the tree
 
3585
                        pass
 
3586
        g = graph.Graph(self.source.revisions)
 
3587
        heads = g.heads(parent_keys)
 
3588
        selected_keys = []
 
3589
        for key in parent_keys:
 
3590
            if key in heads and key not in selected_keys:
 
3591
                selected_keys.append(key)
 
3592
        return tuple([(root_id,)+ key for key in selected_keys])
 
3593
 
 
3594
    def _new_root_data_stream(self, root_keys_to_create, parent_map):
 
3595
        for root_key in root_keys_to_create:
 
3596
            parent_keys = self._get_parent_keys(root_key, parent_map)
 
3597
            yield versionedfile.FulltextContentFactory(root_key,
 
3598
                parent_keys, None, '')
 
3599
 
 
3600
    def _fetch_batch(self, revision_ids, basis_id, cache):
3852
3601
        """Fetch across a few revisions.
3853
3602
 
3854
3603
        :param revision_ids: The revisions to copy
3855
3604
        :param basis_id: The revision_id of a tree that must be in cache, used
3856
3605
            as a basis for delta when no other base is available
3857
3606
        :param cache: A cache of RevisionTrees that we can use.
3858
 
        :param a_graph: A Graph object to determine the heads() of the
3859
 
            rich-root data stream.
3860
3607
        :return: The revision_id of the last converted tree. The RevisionTree
3861
3608
            for it will be in cache
3862
3609
        """
3868
3615
        pending_deltas = []
3869
3616
        pending_revisions = []
3870
3617
        parent_map = self.source.get_parent_map(revision_ids)
3871
 
        self._fetch_parent_invs_for_stacking(parent_map, cache)
3872
 
        self.source._safe_to_return_from_cache = True
3873
3618
        for tree in self.source.revision_trees(revision_ids):
3874
 
            # Find a inventory delta for this revision.
3875
 
            # Find text entries that need to be copied, too.
3876
3619
            current_revision_id = tree.get_revision_id()
3877
3620
            parent_ids = parent_map.get(current_revision_id, ())
3878
 
            parent_trees = self._get_trees(parent_ids, cache)
3879
 
            possible_trees = list(parent_trees)
3880
 
            if len(possible_trees) == 0:
3881
 
                # There either aren't any parents, or the parents are ghosts,
3882
 
                # so just use the last converted tree.
3883
 
                possible_trees.append((basis_id, cache[basis_id]))
3884
3621
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3885
 
                                                           possible_trees)
3886
 
            revision = self.source.get_revision(current_revision_id)
3887
 
            pending_deltas.append((basis_id, delta,
3888
 
                current_revision_id, revision.parent_ids))
 
3622
                                                           basis_id, cache)
3889
3623
            if self._converting_to_rich_root:
3890
3624
                self._revision_id_to_root_id[current_revision_id] = \
3891
3625
                    tree.get_root_id()
3892
 
            # Determine which texts are in present in this revision but not in
3893
 
            # any of the available parents.
3894
 
            texts_possibly_new_in_tree = set()
 
3626
            # Find text entries that need to be copied
3895
3627
            for old_path, new_path, file_id, entry in delta:
3896
 
                if new_path is None:
3897
 
                    # This file_id isn't present in the new rev
3898
 
                    continue
3899
 
                if not new_path:
3900
 
                    # This is the root
3901
 
                    if not self.target.supports_rich_root():
3902
 
                        # The target doesn't support rich root, so we don't
3903
 
                        # copy
3904
 
                        continue
3905
 
                    if self._converting_to_rich_root:
3906
 
                        # This can't be copied normally, we have to insert
3907
 
                        # it specially
3908
 
                        root_keys_to_create.add((file_id, entry.revision))
3909
 
                        continue
3910
 
                kind = entry.kind
3911
 
                texts_possibly_new_in_tree.add((file_id, entry.revision))
3912
 
            for basis_id, basis_tree in possible_trees:
3913
 
                basis_inv = basis_tree.inventory
3914
 
                for file_key in list(texts_possibly_new_in_tree):
3915
 
                    file_id, file_revision = file_key
3916
 
                    try:
3917
 
                        entry = basis_inv[file_id]
3918
 
                    except errors.NoSuchId:
3919
 
                        continue
3920
 
                    if entry.revision == file_revision:
3921
 
                        texts_possibly_new_in_tree.remove(file_key)
3922
 
            text_keys.update(texts_possibly_new_in_tree)
 
3628
                if new_path is not None:
 
3629
                    if not new_path:
 
3630
                        # This is the root
 
3631
                        if not self.target.supports_rich_root():
 
3632
                            # The target doesn't support rich root, so we don't
 
3633
                            # copy
 
3634
                            continue
 
3635
                        if self._converting_to_rich_root:
 
3636
                            # This can't be copied normally, we have to insert
 
3637
                            # it specially
 
3638
                            root_keys_to_create.add((file_id, entry.revision))
 
3639
                            continue
 
3640
                    text_keys.add((file_id, entry.revision))
 
3641
            revision = self.source.get_revision(current_revision_id)
 
3642
            pending_deltas.append((basis_id, delta,
 
3643
                current_revision_id, revision.parent_ids))
3923
3644
            pending_revisions.append(revision)
3924
3645
            cache[current_revision_id] = tree
3925
3646
            basis_id = current_revision_id
3926
 
        self.source._safe_to_return_from_cache = False
3927
3647
        # Copy file texts
3928
3648
        from_texts = self.source.texts
3929
3649
        to_texts = self.target.texts
3930
3650
        if root_keys_to_create:
3931
 
            root_stream = _mod_fetch._new_root_data_stream(
3932
 
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
3933
 
                self.source, graph=a_graph)
 
3651
            root_stream = self._new_root_data_stream(root_keys_to_create,
 
3652
                                                     parent_map)
3934
3653
            to_texts.insert_record_stream(root_stream)
3935
3654
        to_texts.insert_record_stream(from_texts.get_record_stream(
3936
3655
            text_keys, self.target._format._fetch_order,
3943
3662
            # for the new revisions that we are about to insert.  We do this
3944
3663
            # before adding the revisions so that no revision is added until
3945
3664
            # all the inventories it may depend on are added.
3946
 
            # Note that this is overzealous, as we may have fetched these in an
3947
 
            # earlier batch.
3948
3665
            parent_ids = set()
3949
3666
            revision_ids = set()
3950
3667
            for revision in pending_revisions:
3953
3670
            parent_ids.difference_update(revision_ids)
3954
3671
            parent_ids.discard(_mod_revision.NULL_REVISION)
3955
3672
            parent_map = self.source.get_parent_map(parent_ids)
3956
 
            # we iterate over parent_map and not parent_ids because we don't
3957
 
            # want to try copying any revision which is a ghost
3958
 
            for parent_tree in self.source.revision_trees(parent_map):
 
3673
            for parent_tree in self.source.revision_trees(parent_ids):
 
3674
                basis_id, delta = self._get_delta_for_revision(tree, parent_ids, basis_id, cache)
3959
3675
                current_revision_id = parent_tree.get_revision_id()
3960
3676
                parents_parents = parent_map[current_revision_id]
3961
 
                possible_trees = self._get_trees(parents_parents, cache)
3962
 
                if len(possible_trees) == 0:
3963
 
                    # There either aren't any parents, or the parents are
3964
 
                    # ghosts, so just use the last converted tree.
3965
 
                    possible_trees.append((basis_id, cache[basis_id]))
3966
 
                basis_id, delta = self._get_delta_for_revision(parent_tree,
3967
 
                    parents_parents, possible_trees)
3968
3677
                self.target.add_inventory_by_delta(
3969
3678
                    basis_id, delta, current_revision_id, parents_parents)
3970
3679
        # insert signatures and revisions
3984
3693
 
3985
3694
        :param revision_ids: The list of revisions to fetch. Must be in
3986
3695
            topological order.
3987
 
        :param pb: A ProgressTask
 
3696
        :param pb: A ProgressBar
3988
3697
        :return: None
3989
3698
        """
3990
3699
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3993
3702
        cache[basis_id] = basis_tree
3994
3703
        del basis_tree # We don't want to hang on to it here
3995
3704
        hints = []
3996
 
        if self._converting_to_rich_root and len(revision_ids) > 100:
3997
 
            a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
3998
 
                                                            revision_ids)
3999
 
        else:
4000
 
            a_graph = None
4001
 
 
4002
3705
        for offset in range(0, len(revision_ids), batch_size):
4003
3706
            self.target.start_write_group()
4004
3707
            try:
4005
3708
                pb.update('Transferring revisions', offset,
4006
3709
                          len(revision_ids))
4007
3710
                batch = revision_ids[offset:offset+batch_size]
4008
 
                basis_id = self._fetch_batch(batch, basis_id, cache,
4009
 
                                             a_graph=a_graph)
 
3711
                basis_id = self._fetch_batch(batch, basis_id, cache)
4010
3712
            except:
4011
 
                self.source._safe_to_return_from_cache = False
4012
3713
                self.target.abort_write_group()
4013
3714
                raise
4014
3715
            else:
4026
3727
        """See InterRepository.fetch()."""
4027
3728
        if fetch_spec is not None:
4028
3729
            raise AssertionError("Not implemented yet...")
4029
 
        ui.ui_factory.warn_experimental_format_fetch(self)
4030
3730
        if (not self.source.supports_rich_root()
4031
3731
            and self.target.supports_rich_root()):
4032
3732
            self._converting_to_rich_root = True
4033
3733
            self._revision_id_to_root_id = {}
4034
3734
        else:
4035
3735
            self._converting_to_rich_root = False
4036
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
4037
 
        if self.source._format.network_name() != self.target._format.network_name():
4038
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
4039
 
                from_format=self.source._format,
4040
 
                to_format=self.target._format)
4041
3736
        revision_ids = self.target.search_missing_revision_ids(self.source,
4042
3737
            revision_id, find_ghosts=find_ghosts).get_keys()
4043
3738
        if not revision_ids:
4049
3744
        # Walk though all revisions; get inventory deltas, copy referenced
4050
3745
        # texts that delta references, insert the delta, revision and
4051
3746
        # signature.
 
3747
        first_rev = self.source.get_revision(revision_ids[0])
4052
3748
        if pb is None:
4053
3749
            my_pb = ui.ui_factory.nested_progress_bar()
4054
3750
            pb = my_pb
4112
3808
        :param to_convert: The disk object to convert.
4113
3809
        :param pb: a progress bar to use for progress information.
4114
3810
        """
4115
 
        pb = ui.ui_factory.nested_progress_bar()
 
3811
        self.pb = pb
4116
3812
        self.count = 0
4117
3813
        self.total = 4
4118
3814
        # this is only useful with metadir layouts - separated repo content.
4119
3815
        # trigger an assertion if not such
4120
3816
        repo._format.get_format_string()
4121
3817
        self.repo_dir = repo.bzrdir
4122
 
        pb.update('Moving repository to repository.backup')
 
3818
        self.step('Moving repository to repository.backup')
4123
3819
        self.repo_dir.transport.move('repository', 'repository.backup')
4124
3820
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4125
3821
        repo._format.check_conversion_target(self.target_format)
4126
3822
        self.source_repo = repo._format.open(self.repo_dir,
4127
3823
            _found=True,
4128
3824
            _override_transport=backup_transport)
4129
 
        pb.update('Creating new repository')
 
3825
        self.step('Creating new repository')
4130
3826
        converted = self.target_format.initialize(self.repo_dir,
4131
3827
                                                  self.source_repo.is_shared())
4132
3828
        converted.lock_write()
4133
3829
        try:
4134
 
            pb.update('Copying content')
 
3830
            self.step('Copying content into repository.')
4135
3831
            self.source_repo.copy_content_into(converted)
4136
3832
        finally:
4137
3833
            converted.unlock()
4138
 
        pb.update('Deleting old repository content')
 
3834
        self.step('Deleting old repository content.')
4139
3835
        self.repo_dir.transport.delete_tree('repository.backup')
4140
 
        ui.ui_factory.note('repository converted')
4141
 
        pb.finished()
 
3836
        self.pb.note('repository converted')
 
3837
 
 
3838
    def step(self, message):
 
3839
        """Update the pb by a step."""
 
3840
        self.count +=1
 
3841
        self.pb.update(message, self.count, self.total)
4142
3842
 
4143
3843
 
4144
3844
_unescape_map = {
4173
3873
 
4174
3874
class _VersionedFileChecker(object):
4175
3875
 
4176
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
3876
    def __init__(self, repository, text_key_references=None):
4177
3877
        self.repository = repository
4178
3878
        self.text_index = self.repository._generate_text_key_index(
4179
 
            text_key_references=text_key_references, ancestors=ancestors)
 
3879
            text_key_references=text_key_references)
4180
3880
 
4181
3881
    def calculate_file_version_parents(self, text_key):
4182
3882
        """Calculate the correct parents for a file version according to
4200
3900
            revision_id) tuples for versions that are present in this versioned
4201
3901
            file, but not used by the corresponding inventory.
4202
3902
        """
4203
 
        local_progress = None
4204
 
        if progress_bar is None:
4205
 
            local_progress = ui.ui_factory.nested_progress_bar()
4206
 
            progress_bar = local_progress
4207
 
        try:
4208
 
            return self._check_file_version_parents(texts, progress_bar)
4209
 
        finally:
4210
 
            if local_progress:
4211
 
                local_progress.finished()
4212
 
 
4213
 
    def _check_file_version_parents(self, texts, progress_bar):
4214
 
        """See check_file_version_parents."""
4215
3903
        wrong_parents = {}
4216
3904
        self.file_ids = set([file_id for file_id, _ in
4217
3905
            self.text_index.iterkeys()])
4218
3906
        # text keys is now grouped by file_id
 
3907
        n_weaves = len(self.file_ids)
 
3908
        files_in_revisions = {}
 
3909
        revisions_of_files = {}
4219
3910
        n_versions = len(self.text_index)
4220
3911
        progress_bar.update('loading text store', 0, n_versions)
4221
3912
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4223
3914
        text_keys = self.repository.texts.keys()
4224
3915
        unused_keys = frozenset(text_keys) - set(self.text_index)
4225
3916
        for num, key in enumerate(self.text_index.iterkeys()):
4226
 
            progress_bar.update('checking text graph', num, n_versions)
 
3917
            if progress_bar is not None:
 
3918
                progress_bar.update('checking text graph', num, n_versions)
4227
3919
            correct_parents = self.calculate_file_version_parents(key)
4228
3920
            try:
4229
3921
                knit_parents = parent_map[key]
4284
3976
                is_resume = False
4285
3977
            try:
4286
3978
                # locked_insert_stream performs a commit|suspend.
4287
 
                return self._locked_insert_stream(stream, src_format,
4288
 
                    is_resume)
 
3979
                return self._locked_insert_stream(stream, src_format, is_resume)
4289
3980
            except:
4290
3981
                self.target_repo.abort_write_group(suppress_errors=True)
4291
3982
                raise
4315
4006
            else:
4316
4007
                new_pack.set_write_cache_size(1024*1024)
4317
4008
        for substream_type, substream in stream:
4318
 
            if 'stream' in debug.debug_flags:
4319
 
                mutter('inserting substream: %s', substream_type)
4320
4009
            if substream_type == 'texts':
4321
4010
                self.target_repo.texts.insert_record_stream(substream)
4322
4011
            elif substream_type == 'inventories':
4326
4015
                else:
4327
4016
                    self._extract_and_insert_inventories(
4328
4017
                        substream, src_serializer)
4329
 
            elif substream_type == 'inventory-deltas':
4330
 
                self._extract_and_insert_inventory_deltas(
4331
 
                    substream, src_serializer)
4332
4018
            elif substream_type == 'chk_bytes':
4333
4019
                # XXX: This doesn't support conversions, as it assumes the
4334
4020
                #      conversion was done in the fetch code.
4338
4024
                # required if the serializers are different only in terms of
4339
4025
                # the inventory.
4340
4026
                if src_serializer == to_serializer:
4341
 
                    self.target_repo.revisions.insert_record_stream(substream)
 
4027
                    self.target_repo.revisions.insert_record_stream(
 
4028
                        substream)
4342
4029
                else:
4343
4030
                    self._extract_and_insert_revisions(substream,
4344
4031
                        src_serializer)
4364
4051
                ):
4365
4052
                if versioned_file is None:
4366
4053
                    continue
4367
 
                # TODO: key is often going to be a StaticTuple object
4368
 
                #       I don't believe we can define a method by which
4369
 
                #       (prefix,) + StaticTuple will work, though we could
4370
 
                #       define a StaticTuple.sq_concat that would allow you to
4371
 
                #       pass in either a tuple or a StaticTuple as the second
4372
 
                #       object, so instead we could have:
4373
 
                #       StaticTuple(prefix) + key here...
4374
4054
                missing_keys.update((prefix,) + key for key in
4375
4055
                    versioned_file.get_missing_compression_parent_keys())
4376
4056
        except NotImplementedError:
4391
4071
            self.target_repo.pack(hint=hint)
4392
4072
        return [], set()
4393
4073
 
4394
 
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
4395
 
        target_rich_root = self.target_repo._format.rich_root_data
4396
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4397
 
        for record in substream:
4398
 
            # Insert the delta directly
4399
 
            inventory_delta_bytes = record.get_bytes_as('fulltext')
4400
 
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
4401
 
            try:
4402
 
                parse_result = deserialiser.parse_text_bytes(
4403
 
                    inventory_delta_bytes)
4404
 
            except inventory_delta.IncompatibleInventoryDelta, err:
4405
 
                trace.mutter("Incompatible delta: %s", err.msg)
4406
 
                raise errors.IncompatibleRevision(self.target_repo._format)
4407
 
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
4408
 
            revision_id = new_id
4409
 
            parents = [key[0] for key in record.parents]
4410
 
            self.target_repo.add_inventory_by_delta(
4411
 
                basis_id, inv_delta, revision_id, parents)
4412
 
 
4413
 
    def _extract_and_insert_inventories(self, substream, serializer,
4414
 
            parse_delta=None):
 
4074
    def _extract_and_insert_inventories(self, substream, serializer):
4415
4075
        """Generate a new inventory versionedfile in target, converting data.
4416
4076
 
4417
4077
        The inventory is retrieved from the source, (deserializing it), and
4418
4078
        stored in the target (reserializing it in a different format).
4419
4079
        """
4420
 
        target_rich_root = self.target_repo._format.rich_root_data
4421
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4422
4080
        for record in substream:
4423
 
            # It's not a delta, so it must be a fulltext in the source
4424
 
            # serializer's format.
4425
4081
            bytes = record.get_bytes_as('fulltext')
4426
4082
            revision_id = record.key[0]
4427
4083
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4428
4084
            parents = [key[0] for key in record.parents]
4429
4085
            self.target_repo.add_inventory(revision_id, inv, parents)
4430
 
            # No need to keep holding this full inv in memory when the rest of
4431
 
            # the substream is likely to be all deltas.
4432
 
            del inv
4433
4086
 
4434
4087
    def _extract_and_insert_revisions(self, substream, serializer):
4435
4088
        for record in substream:
4452
4105
        """Create a StreamSource streaming from from_repository."""
4453
4106
        self.from_repository = from_repository
4454
4107
        self.to_format = to_format
4455
 
        self._record_counter = RecordCounter()
4456
4108
 
4457
4109
    def delta_on_metadata(self):
4458
4110
        """Return True if delta's are permitted on metadata streams.
4485
4137
        return [('signatures', signatures), ('revisions', revisions)]
4486
4138
 
4487
4139
    def _generate_root_texts(self, revs):
4488
 
        """This will be called by get_stream between fetching weave texts and
 
4140
        """This will be called by __fetch between fetching weave texts and
4489
4141
        fetching the inventory weave.
 
4142
 
 
4143
        Subclasses should override this if they need to generate root texts
 
4144
        after fetching weave texts.
4490
4145
        """
4491
4146
        if self._rich_root_upgrade():
4492
 
            return _mod_fetch.Inter1and2Helper(
 
4147
            import bzrlib.fetch
 
4148
            return bzrlib.fetch.Inter1and2Helper(
4493
4149
                self.from_repository).generate_root_texts(revs)
4494
4150
        else:
4495
4151
            return []
4498
4154
        phase = 'file'
4499
4155
        revs = search.get_keys()
4500
4156
        graph = self.from_repository.get_graph()
4501
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
 
4157
        revs = list(graph.iter_topo_order(revs))
4502
4158
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4503
4159
        text_keys = []
4504
4160
        for knit_kind, file_id, revisions in data_to_fetch:
4523
4179
                # will be valid.
4524
4180
                for _ in self._generate_root_texts(revs):
4525
4181
                    yield _
 
4182
                # NB: This currently reopens the inventory weave in source;
 
4183
                # using a single stream interface instead would avoid this.
 
4184
                from_weave = self.from_repository.inventories
4526
4185
                # we fetch only the referenced inventories because we do not
4527
4186
                # know for unselected inventories whether all their required
4528
4187
                # texts are present in the other repository - it could be
4567
4226
            if not keys:
4568
4227
                # No need to stream something we don't have
4569
4228
                continue
4570
 
            if substream_kind == 'inventories':
4571
 
                # Some missing keys are genuinely ghosts, filter those out.
4572
 
                present = self.from_repository.inventories.get_parent_map(keys)
4573
 
                revs = [key[0] for key in present]
4574
 
                # Get the inventory stream more-or-less as we do for the
4575
 
                # original stream; there's no reason to assume that records
4576
 
                # direct from the source will be suitable for the sink.  (Think
4577
 
                # e.g. 2a -> 1.9-rich-root).
4578
 
                for info in self._get_inventory_stream(revs, missing=True):
4579
 
                    yield info
4580
 
                continue
4581
 
 
4582
4229
            # Ask for full texts always so that we don't need more round trips
4583
4230
            # after this stream.
4584
4231
            # Some of the missing keys are genuinely ghosts, so filter absent
4599
4246
        return (not self.from_repository._format.rich_root_data and
4600
4247
            self.to_format.rich_root_data)
4601
4248
 
4602
 
    def _get_inventory_stream(self, revision_ids, missing=False):
 
4249
    def _get_inventory_stream(self, revision_ids):
4603
4250
        from_format = self.from_repository._format
4604
 
        if (from_format.supports_chks and self.to_format.supports_chks and
4605
 
            from_format.network_name() == self.to_format.network_name()):
4606
 
            raise AssertionError(
4607
 
                "this case should be handled by GroupCHKStreamSource")
4608
 
        elif 'forceinvdeltas' in debug.debug_flags:
4609
 
            return self._get_convertable_inventory_stream(revision_ids,
4610
 
                    delta_versus_null=missing)
4611
 
        elif from_format.network_name() == self.to_format.network_name():
4612
 
            # Same format.
4613
 
            return self._get_simple_inventory_stream(revision_ids,
4614
 
                    missing=missing)
4615
 
        elif (not from_format.supports_chks and not self.to_format.supports_chks
4616
 
                and from_format._serializer == self.to_format._serializer):
4617
 
            # Essentially the same format.
4618
 
            return self._get_simple_inventory_stream(revision_ids,
4619
 
                    missing=missing)
 
4251
        if (from_format.supports_chks and self.to_format.supports_chks
 
4252
            and (from_format._serializer == self.to_format._serializer)):
 
4253
            # Both sides support chks, and they use the same serializer, so it
 
4254
            # is safe to transmit the chk pages and inventory pages across
 
4255
            # as-is.
 
4256
            return self._get_chk_inventory_stream(revision_ids)
 
4257
        elif (not from_format.supports_chks):
 
4258
            # Source repository doesn't support chks. So we can transmit the
 
4259
            # inventories 'as-is' and either they are just accepted on the
 
4260
            # target, or the Sink will properly convert it.
 
4261
            return self._get_simple_inventory_stream(revision_ids)
4620
4262
        else:
4621
 
            # Any time we switch serializations, we want to use an
4622
 
            # inventory-delta based approach.
4623
 
            return self._get_convertable_inventory_stream(revision_ids,
4624
 
                    delta_versus_null=missing)
 
4263
            # XXX: Hack to make not-chk->chk fetch: copy the inventories as
 
4264
            #      inventories. Note that this should probably be done somehow
 
4265
            #      as part of bzrlib.repository.StreamSink. Except JAM couldn't
 
4266
            #      figure out how a non-chk repository could possibly handle
 
4267
            #      deserializing an inventory stream from a chk repo, as it
 
4268
            #      doesn't have a way to understand individual pages.
 
4269
            return self._get_convertable_inventory_stream(revision_ids)
4625
4270
 
4626
 
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
4627
 
        # NB: This currently reopens the inventory weave in source;
4628
 
        # using a single stream interface instead would avoid this.
 
4271
    def _get_simple_inventory_stream(self, revision_ids):
4629
4272
        from_weave = self.from_repository.inventories
4630
 
        if missing:
4631
 
            delta_closure = True
4632
 
        else:
4633
 
            delta_closure = not self.delta_on_metadata()
4634
4273
        yield ('inventories', from_weave.get_record_stream(
4635
4274
            [(rev_id,) for rev_id in revision_ids],
4636
 
            self.inventory_fetch_order(), delta_closure))
4637
 
 
4638
 
    def _get_convertable_inventory_stream(self, revision_ids,
4639
 
                                          delta_versus_null=False):
4640
 
        # The two formats are sufficiently different that there is no fast
4641
 
        # path, so we need to send just inventorydeltas, which any
4642
 
        # sufficiently modern client can insert into any repository.
4643
 
        # The StreamSink code expects to be able to
4644
 
        # convert on the target, so we need to put bytes-on-the-wire that can
4645
 
        # be converted.  That means inventory deltas (if the remote is <1.19,
4646
 
        # RemoteStreamSink will fallback to VFS to insert the deltas).
4647
 
        yield ('inventory-deltas',
4648
 
           self._stream_invs_as_deltas(revision_ids,
4649
 
                                       delta_versus_null=delta_versus_null))
4650
 
 
4651
 
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
4652
 
        """Return a stream of inventory-deltas for the given rev ids.
4653
 
 
4654
 
        :param revision_ids: The list of inventories to transmit
4655
 
        :param delta_versus_null: Don't try to find a minimal delta for this
4656
 
            entry, instead compute the delta versus the NULL_REVISION. This
4657
 
            effectively streams a complete inventory. Used for stuff like
4658
 
            filling in missing parents, etc.
4659
 
        """
 
4275
            self.inventory_fetch_order(),
 
4276
            not self.delta_on_metadata()))
 
4277
 
 
4278
    def _get_chk_inventory_stream(self, revision_ids):
 
4279
        """Fetch the inventory texts, along with the associated chk maps."""
 
4280
        # We want an inventory outside of the search set, so that we can filter
 
4281
        # out uninteresting chk pages. For now we use
 
4282
        # _find_revision_outside_set, but if we had a Search with cut_revs, we
 
4283
        # could use that instead.
 
4284
        start_rev_id = self.from_repository._find_revision_outside_set(
 
4285
                            revision_ids)
 
4286
        start_rev_key = (start_rev_id,)
 
4287
        inv_keys_to_fetch = [(rev_id,) for rev_id in revision_ids]
 
4288
        if start_rev_id != _mod_revision.NULL_REVISION:
 
4289
            inv_keys_to_fetch.append((start_rev_id,))
 
4290
        # Any repo that supports chk_bytes must also support out-of-order
 
4291
        # insertion. At least, that is how we expect it to work
 
4292
        # We use get_record_stream instead of iter_inventories because we want
 
4293
        # to be able to insert the stream as well. We could instead fetch
 
4294
        # allowing deltas, and then iter_inventories, but we don't know whether
 
4295
        # source or target is more 'local' anway.
 
4296
        inv_stream = self.from_repository.inventories.get_record_stream(
 
4297
            inv_keys_to_fetch, 'unordered',
 
4298
            True) # We need them as full-texts so we can find their references
 
4299
        uninteresting_chk_roots = set()
 
4300
        interesting_chk_roots = set()
 
4301
        def filter_inv_stream(inv_stream):
 
4302
            for idx, record in enumerate(inv_stream):
 
4303
                ### child_pb.update('fetch inv', idx, len(inv_keys_to_fetch))
 
4304
                bytes = record.get_bytes_as('fulltext')
 
4305
                chk_inv = inventory.CHKInventory.deserialise(
 
4306
                    self.from_repository.chk_bytes, bytes, record.key)
 
4307
                if record.key == start_rev_key:
 
4308
                    uninteresting_chk_roots.add(chk_inv.id_to_entry.key())
 
4309
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4310
                    if p_id_map is not None:
 
4311
                        uninteresting_chk_roots.add(p_id_map.key())
 
4312
                else:
 
4313
                    yield record
 
4314
                    interesting_chk_roots.add(chk_inv.id_to_entry.key())
 
4315
                    p_id_map = chk_inv.parent_id_basename_to_file_id
 
4316
                    if p_id_map is not None:
 
4317
                        interesting_chk_roots.add(p_id_map.key())
 
4318
        ### pb.update('fetch inventory', 0, 2)
 
4319
        yield ('inventories', filter_inv_stream(inv_stream))
 
4320
        # Now that we have worked out all of the interesting root nodes, grab
 
4321
        # all of the interesting pages and insert them
 
4322
        ### pb.update('fetch inventory', 1, 2)
 
4323
        interesting = chk_map.iter_interesting_nodes(
 
4324
            self.from_repository.chk_bytes, interesting_chk_roots,
 
4325
            uninteresting_chk_roots)
 
4326
        def to_stream_adapter():
 
4327
            """Adapt the iter_interesting_nodes result to a single stream.
 
4328
 
 
4329
            iter_interesting_nodes returns records as it processes them, along
 
4330
            with keys. However, we only want to return the records themselves.
 
4331
            """
 
4332
            for record, items in interesting:
 
4333
                if record is not None:
 
4334
                    yield record
 
4335
        # XXX: We could instead call get_record_stream(records.keys())
 
4336
        #      ATM, this will always insert the records as fulltexts, and
 
4337
        #      requires that you can hang on to records once you have gone
 
4338
        #      on to the next one. Further, it causes the target to
 
4339
        #      recompress the data. Testing shows it to be faster than
 
4340
        #      requesting the records again, though.
 
4341
        yield ('chk_bytes', to_stream_adapter())
 
4342
        ### pb.update('fetch inventory', 2, 2)
 
4343
 
 
4344
    def _get_convertable_inventory_stream(self, revision_ids):
 
4345
        # XXX: One of source or target is using chks, and they don't have
 
4346
        #      compatible serializations. The StreamSink code expects to be
 
4347
        #      able to convert on the target, so we need to put
 
4348
        #      bytes-on-the-wire that can be converted
 
4349
        yield ('inventories', self._stream_invs_as_fulltexts(revision_ids))
 
4350
 
 
4351
    def _stream_invs_as_fulltexts(self, revision_ids):
4660
4352
        from_repo = self.from_repository
 
4353
        from_serializer = from_repo._format._serializer
4661
4354
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4662
4355
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
4663
 
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
4664
 
        # method...
4665
 
        inventories = self.from_repository.iter_inventories(
4666
 
            revision_ids, 'topological')
4667
 
        format = from_repo._format
4668
 
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
4669
 
        inventory_cache = lru_cache.LRUCache(50)
4670
 
        null_inventory = from_repo.revision_tree(
4671
 
            _mod_revision.NULL_REVISION).inventory
4672
 
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
4673
 
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
4674
 
        # repo back into a non-rich-root repo ought to be allowed)
4675
 
        serializer = inventory_delta.InventoryDeltaSerializer(
4676
 
            versioned_root=format.rich_root_data,
4677
 
            tree_references=format.supports_tree_reference)
4678
 
        for inv in inventories:
 
4356
        for inv in self.from_repository.iter_inventories(revision_ids):
 
4357
            # XXX: This is a bit hackish, but it works. Basically,
 
4358
            #      CHKSerializer 'accidentally' supports
 
4359
            #      read/write_inventory_to_string, even though that is never
 
4360
            #      the format that is stored on disk. It *does* give us a
 
4361
            #      single string representation for an inventory, so live with
 
4362
            #      it for now.
 
4363
            #      This would be far better if we had a 'serialized inventory
 
4364
            #      delta' form. Then we could use 'inventory._make_delta', and
 
4365
            #      transmit that. This would both be faster to generate, and
 
4366
            #      result in fewer bytes-on-the-wire.
 
4367
            as_bytes = from_serializer.write_inventory_to_string(inv)
4679
4368
            key = (inv.revision_id,)
4680
4369
            parent_keys = parent_map.get(key, ())
4681
 
            delta = None
4682
 
            if not delta_versus_null and parent_keys:
4683
 
                # The caller did not ask for complete inventories and we have
4684
 
                # some parents that we can delta against.  Make a delta against
4685
 
                # each parent so that we can find the smallest.
4686
 
                parent_ids = [parent_key[0] for parent_key in parent_keys]
4687
 
                for parent_id in parent_ids:
4688
 
                    if parent_id not in invs_sent_so_far:
4689
 
                        # We don't know that the remote side has this basis, so
4690
 
                        # we can't use it.
4691
 
                        continue
4692
 
                    if parent_id == _mod_revision.NULL_REVISION:
4693
 
                        parent_inv = null_inventory
4694
 
                    else:
4695
 
                        parent_inv = inventory_cache.get(parent_id, None)
4696
 
                        if parent_inv is None:
4697
 
                            parent_inv = from_repo.get_inventory(parent_id)
4698
 
                    candidate_delta = inv._make_delta(parent_inv)
4699
 
                    if (delta is None or
4700
 
                        len(delta) > len(candidate_delta)):
4701
 
                        delta = candidate_delta
4702
 
                        basis_id = parent_id
4703
 
            if delta is None:
4704
 
                # Either none of the parents ended up being suitable, or we
4705
 
                # were asked to delta against NULL
4706
 
                basis_id = _mod_revision.NULL_REVISION
4707
 
                delta = inv._make_delta(null_inventory)
4708
 
            invs_sent_so_far.add(inv.revision_id)
4709
 
            inventory_cache[inv.revision_id] = inv
4710
 
            delta_serialized = ''.join(
4711
 
                serializer.delta_to_lines(basis_id, key[-1], delta))
4712
4370
            yield versionedfile.FulltextContentFactory(
4713
 
                key, parent_keys, None, delta_serialized)
 
4371
                key, parent_keys, None, as_bytes)
4714
4372
 
4715
4373
 
4716
4374
def _iter_for_revno(repo, partial_history_cache, stop_index=None,