← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Jelmer Vernooij
  • Date: 2011-04-19 10:42:59 UTC
  • mto: This revision was merged to the branch mainline in revision 5806.
  • Revision ID: jelmer@samba.org-20110419104259-g9exlcp1f5jdu3ci
Move Inventory._get_mutable_inventory -> mutable_inventory_from_tree.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/repository.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
16
16
 
17
17
from bzrlib.lazy_import import lazy_import
18
18
lazy_import(globals(), """
19
 
import cStringIO
20
 
import re
21
19
import time
22
20
 
23
21
from bzrlib import (
24
22
    bzrdir,
25
23
    check,
26
 
    chk_map,
27
24
    config,
 
25
    controldir,
28
26
    debug,
29
 
    errors,
30
27
    fetch as _mod_fetch,
31
28
    fifo_cache,
32
29
    generate_ids,
33
30
    gpg,
34
31
    graph,
35
 
    inventory,
36
32
    inventory_delta,
37
 
    lazy_regex,
38
33
    lockable_files,
39
34
    lockdir,
40
35
    lru_cache,
41
36
    osutils,
42
37
    revision as _mod_revision,
43
38
    static_tuple,
44
 
    symbol_versioning,
45
 
    trace,
46
39
    tsort,
47
 
    ui,
48
40
    versionedfile,
49
41
    )
50
42
from bzrlib.bundle import serializer
51
 
from bzrlib.revisiontree import RevisionTree
 
43
from bzrlib.recordcounter import RecordCounter
 
44
from bzrlib.revisiontree import InventoryRevisionTree
52
45
from bzrlib.store.versioned import VersionedFileStore
53
46
from bzrlib.testament import Testament
54
47
""")
55
48
 
 
49
from bzrlib import (
 
50
    errors,
 
51
    registry,
 
52
    symbol_versioning,
 
53
    ui,
 
54
    )
56
55
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
57
56
from bzrlib.inter import InterObject
58
57
from bzrlib.inventory import (
61
60
    ROOT_ID,
62
61
    entry_factory,
63
62
    )
64
 
from bzrlib.lock import _RelockDebugMixin
65
 
from bzrlib import registry
 
63
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
66
64
from bzrlib.trace import (
67
65
    log_exception_quietly, note, mutter, mutter_callsite, warning)
68
66
 
71
69
_deprecation_warning_done = False
72
70
 
73
71
 
 
72
class IsInWriteGroupError(errors.InternalBzrError):
 
73
 
 
74
    _fmt = "May not refresh_data of repo %(repo)s while in a write group."
 
75
 
 
76
    def __init__(self, repo):
 
77
        errors.InternalBzrError.__init__(self, repo=repo)
 
78
 
 
79
 
74
80
class CommitBuilder(object):
75
81
    """Provides an interface to build up a commit.
76
82
 
82
88
    record_root_entry = True
83
89
    # the default CommitBuilder does not manage trees whose root is versioned.
84
90
    _versioned_root = False
 
91
    # this commit builder supports the record_entry_contents interface
 
92
    supports_record_entry_contents = True
85
93
 
86
94
    def __init__(self, repository, parents, config, timestamp=None,
87
95
                 timezone=None, committer=None, revprops=None,
88
 
                 revision_id=None):
 
96
                 revision_id=None, lossy=False):
89
97
        """Initiate a CommitBuilder.
90
98
 
91
99
        :param repository: Repository to commit to.
92
100
        :param parents: Revision ids of the parents of the new revision.
93
 
        :param config: Configuration to use.
94
101
        :param timestamp: Optional timestamp recorded for commit.
95
102
        :param timezone: Optional timezone for timestamp.
96
103
        :param committer: Optional committer to set for commit.
97
104
        :param revprops: Optional dictionary of revision properties.
98
105
        :param revision_id: Optional revision id.
 
106
        :param lossy: Whether to discard data that can not be natively
 
107
            represented, when pushing to a foreign VCS 
99
108
        """
100
109
        self._config = config
 
110
        self._lossy = lossy
101
111
 
102
112
        if committer is None:
103
113
            self._committer = self._config.username()
 
114
        elif not isinstance(committer, unicode):
 
115
            self._committer = committer.decode() # throw if non-ascii
104
116
        else:
105
117
            self._committer = committer
106
118
 
160
172
            self._validate_unicode_text(value,
161
173
                                        'revision property (%s)' % (key,))
162
174
 
 
175
    def _ensure_fallback_inventories(self):
 
176
        """Ensure that appropriate inventories are available.
 
177
 
 
178
        This only applies to repositories that are stacked, and is about
 
179
        enusring the stacking invariants. Namely, that for any revision that is
 
180
        present, we either have all of the file content, or we have the parent
 
181
        inventory and the delta file content.
 
182
        """
 
183
        if not self.repository._fallback_repositories:
 
184
            return
 
185
        if not self.repository._format.supports_chks:
 
186
            raise errors.BzrError("Cannot commit directly to a stacked branch"
 
187
                " in pre-2a formats. See "
 
188
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
 
189
        # This is a stacked repo, we need to make sure we have the parent
 
190
        # inventories for the parents.
 
191
        parent_keys = [(p,) for p in self.parents]
 
192
        parent_map = self.repository.inventories._index.get_parent_map(parent_keys)
 
193
        missing_parent_keys = set([pk for pk in parent_keys
 
194
                                       if pk not in parent_map])
 
195
        fallback_repos = list(reversed(self.repository._fallback_repositories))
 
196
        missing_keys = [('inventories', pk[0])
 
197
                        for pk in missing_parent_keys]
 
198
        resume_tokens = []
 
199
        while missing_keys and fallback_repos:
 
200
            fallback_repo = fallback_repos.pop()
 
201
            source = fallback_repo._get_source(self.repository._format)
 
202
            sink = self.repository._get_sink()
 
203
            stream = source.get_stream_for_missing_keys(missing_keys)
 
204
            missing_keys = sink.insert_stream_without_locking(stream,
 
205
                self.repository._format)
 
206
        if missing_keys:
 
207
            raise errors.BzrError('Unable to fill in parent inventories for a'
 
208
                                  ' stacked branch')
 
209
 
163
210
    def commit(self, message):
164
211
        """Make the actual commit.
165
212
 
177
224
        rev.parent_ids = self.parents
178
225
        self.repository.add_revision(self._new_revision_id, rev,
179
226
            self.new_inventory, self._config)
 
227
        self._ensure_fallback_inventories()
180
228
        self.repository.commit_write_group()
181
229
        return self._new_revision_id
182
230
 
188
236
    def revision_tree(self):
189
237
        """Return the tree that was just committed.
190
238
 
191
 
        After calling commit() this can be called to get a RevisionTree
192
 
        representing the newly committed tree. This is preferred to
193
 
        calling Repository.revision_tree() because that may require
194
 
        deserializing the inventory, while we already have a copy in
 
239
        After calling commit() this can be called to get a
 
240
        InventoryRevisionTree representing the newly committed tree. This is
 
241
        preferred to calling Repository.revision_tree() because that may
 
242
        require deserializing the inventory, while we already have a copy in
195
243
        memory.
196
244
        """
197
245
        if self.new_inventory is None:
198
246
            self.new_inventory = self.repository.get_inventory(
199
247
                self._new_revision_id)
200
 
        return RevisionTree(self.repository, self.new_inventory,
 
248
        return InventoryRevisionTree(self.repository, self.new_inventory,
201
249
            self._new_revision_id)
202
250
 
203
251
    def finish_inventory(self):
231
279
 
232
280
    def _gen_revision_id(self):
233
281
        """Return new revision-id."""
234
 
        return generate_ids.gen_revision_id(self._config.username(),
235
 
                                            self._timestamp)
 
282
        return generate_ids.gen_revision_id(self._committer, self._timestamp)
236
283
 
237
284
    def _generate_revision_if_needed(self):
238
285
        """Create a revision id if None was supplied.
278
325
 
279
326
        :param tree: The tree which is being committed.
280
327
        """
281
 
        # NB: if there are no parents then this method is not called, so no
282
 
        # need to guard on parents having length.
 
328
        if len(self.parents) == 0:
 
329
            raise errors.RootMissing()
283
330
        entry = entry_factory['directory'](tree.path2id(''), '',
284
331
            None)
285
332
        entry.revision = self._new_revision_id
423
470
            else:
424
471
                # we don't need to commit this, because the caller already
425
472
                # determined that an existing revision of this file is
426
 
                # appropriate. If its not being considered for committing then
 
473
                # appropriate. If it's not being considered for committing then
427
474
                # it and all its parents to the root must be unaltered so
428
475
                # no-change against the basis.
429
476
                if ie.revision == self._new_revision_id:
745
792
                    # after iter_changes examines and decides it has changed,
746
793
                    # we will unconditionally record a new version even if some
747
794
                    # other process reverts it while commit is running (with
748
 
                    # the revert happening after iter_changes did it's
 
795
                    # the revert happening after iter_changes did its
749
796
                    # examination).
750
797
                    if change[7][1]:
751
798
                        entry.executable = True
860
907
        # versioned roots do not change unless the tree found a change.
861
908
 
862
909
 
 
910
class RepositoryWriteLockResult(LogicalLockResult):
 
911
    """The result of write locking a repository.
 
912
 
 
913
    :ivar repository_token: The token obtained from the underlying lock, or
 
914
        None.
 
915
    :ivar unlock: A callable which will unlock the lock.
 
916
    """
 
917
 
 
918
    def __init__(self, unlock, repository_token):
 
919
        LogicalLockResult.__init__(self, unlock)
 
920
        self.repository_token = repository_token
 
921
 
 
922
    def __repr__(self):
 
923
        return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
 
924
            self.unlock)
 
925
 
 
926
 
863
927
######################################################################
864
928
# Repositories
865
929
 
866
930
 
867
 
class Repository(_RelockDebugMixin, bzrdir.ControlComponent):
 
931
class Repository(_RelockDebugMixin, controldir.ControlComponent):
868
932
    """Repository holding history for one or more branches.
869
933
 
870
934
    The repository holds and retrieves historical information including
917
981
        pointing to .bzr/repository.
918
982
    """
919
983
 
920
 
    # What class to use for a CommitBuilder. Often its simpler to change this
 
984
    # What class to use for a CommitBuilder. Often it's simpler to change this
921
985
    # in a Repository class subclass rather than to override
922
986
    # get_commit_builder.
923
987
    _commit_builder_class = CommitBuilder
924
 
    # The search regex used by xml based repositories to determine what things
925
 
    # where changed in a single commit.
926
 
    _file_ids_altered_regex = lazy_regex.lazy_compile(
927
 
        r'file_id="(?P<file_id>[^"]+)"'
928
 
        r'.* revision="(?P<revision_id>[^"]+)"'
929
 
        )
930
988
 
931
989
    def abort_write_group(self, suppress_errors=False):
932
990
        """Commit the contents accrued within the current write group.
1018
1076
                " id and insertion revid (%r, %r)"
1019
1077
                % (inv.revision_id, revision_id))
1020
1078
        if inv.root is None:
1021
 
            raise AssertionError()
 
1079
            raise errors.RootMissing()
1022
1080
        return self._add_inventory_checked(revision_id, inv, parents)
1023
1081
 
1024
1082
    def _add_inventory_checked(self, revision_id, inv, parents):
1376
1434
        data during reads, and allows a 'write_group' to be obtained. Write
1377
1435
        groups must be used for actual data insertion.
1378
1436
 
 
1437
        A token should be passed in if you know that you have locked the object
 
1438
        some other way, and need to synchronise this object's state with that
 
1439
        fact.
 
1440
 
 
1441
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
 
1442
 
1379
1443
        :param token: if this is already locked, then lock_write will fail
1380
1444
            unless the token matches the existing lock.
1381
1445
        :returns: a token if this instance supports tokens, otherwise None.
1384
1448
        :raises MismatchedToken: if the specified token doesn't match the token
1385
1449
            of the existing lock.
1386
1450
        :seealso: start_write_group.
1387
 
 
1388
 
        A token should be passed in if you know that you have locked the object
1389
 
        some other way, and need to synchronise this object's state with that
1390
 
        fact.
1391
 
 
1392
 
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
 
1451
        :return: A RepositoryWriteLockResult.
1393
1452
        """
1394
1453
        locked = self.is_locked()
1395
 
        result = self.control_files.lock_write(token=token)
 
1454
        token = self.control_files.lock_write(token=token)
1396
1455
        if not locked:
1397
1456
            self._warn_if_deprecated()
1398
1457
            self._note_lock('w')
1400
1459
                # Writes don't affect fallback repos
1401
1460
                repo.lock_read()
1402
1461
            self._refresh_data()
1403
 
        return result
 
1462
        return RepositoryWriteLockResult(self.unlock, token)
1404
1463
 
1405
1464
    def lock_read(self):
 
1465
        """Lock the repository for read operations.
 
1466
 
 
1467
        :return: An object with an unlock method which will release the lock
 
1468
            obtained.
 
1469
        """
1406
1470
        locked = self.is_locked()
1407
1471
        self.control_files.lock_read()
1408
1472
        if not locked:
1411
1475
            for repo in self._fallback_repositories:
1412
1476
                repo.lock_read()
1413
1477
            self._refresh_data()
 
1478
        return LogicalLockResult(self.unlock)
1414
1479
 
1415
1480
    def get_physical_lock_status(self):
1416
1481
        return self.control_files.get_physical_lock_status()
1522
1587
        return ret
1523
1588
 
1524
1589
    @needs_read_lock
1525
 
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
1590
    def search_missing_revision_ids(self, other,
 
1591
            revision_id=symbol_versioning.DEPRECATED_PARAMETER,
 
1592
            find_ghosts=True, revision_ids=None, if_present_ids=None):
1526
1593
        """Return the revision ids that other has that this does not.
1527
1594
 
1528
1595
        These are returned in topological order.
1529
1596
 
1530
1597
        revision_id: only return revision ids included by revision_id.
1531
1598
        """
 
1599
        if symbol_versioning.deprecated_passed(revision_id):
 
1600
            symbol_versioning.warn(
 
1601
                'search_missing_revision_ids(revision_id=...) was '
 
1602
                'deprecated in 2.4.  Use revision_ids=[...] instead.',
 
1603
                DeprecationWarning, stacklevel=3)
 
1604
            if revision_ids is not None:
 
1605
                raise AssertionError(
 
1606
                    'revision_ids is mutually exclusive with revision_id')
 
1607
            if revision_id is not None:
 
1608
                revision_ids = [revision_id]
1532
1609
        return InterRepository.get(other, self).search_missing_revision_ids(
1533
 
            revision_id, find_ghosts)
 
1610
            find_ghosts=find_ghosts, revision_ids=revision_ids,
 
1611
            if_present_ids=if_present_ids)
1534
1612
 
1535
1613
    @staticmethod
1536
1614
    def open(base):
1634
1712
        return missing_keys
1635
1713
 
1636
1714
    def refresh_data(self):
1637
 
        """Re-read any data needed to to synchronise with disk.
 
1715
        """Re-read any data needed to synchronise with disk.
1638
1716
 
1639
1717
        This method is intended to be called after another repository instance
1640
1718
        (such as one used by a smart server) has inserted data into the
1641
 
        repository. It may not be called during a write group, but may be
1642
 
        called at any other time.
 
1719
        repository. On all repositories this will work outside of write groups.
 
1720
        Some repository formats (pack and newer for bzrlib native formats)
 
1721
        support refresh_data inside write groups. If called inside a write
 
1722
        group on a repository that does not support refreshing in a write group
 
1723
        IsInWriteGroupError will be raised.
1643
1724
        """
1644
 
        if self.is_in_write_group():
1645
 
            raise errors.InternalBzrError(
1646
 
                "May not refresh_data while in a write group.")
1647
1725
        self._refresh_data()
1648
1726
 
1649
1727
    def resume_write_group(self, tokens):
1658
1736
    def _resume_write_group(self, tokens):
1659
1737
        raise errors.UnsuspendableWriteGroup(self)
1660
1738
 
1661
 
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
 
1739
    def fetch(self, source, revision_id=None, find_ghosts=False,
1662
1740
            fetch_spec=None):
1663
1741
        """Fetch the content required to construct revision_id from source.
1664
1742
 
1688
1766
                "May not fetch while in a write group.")
1689
1767
        # fast path same-url fetch operations
1690
1768
        # TODO: lift out to somewhere common with RemoteRepository
1691
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401646>
 
1769
        # <https://bugs.launchpad.net/bzr/+bug/401646>
1692
1770
        if (self.has_same_location(source)
1693
1771
            and fetch_spec is None
1694
1772
            and self._has_same_fallbacks(source)):
1698
1776
                not _mod_revision.is_null(revision_id)):
1699
1777
                self.get_revision(revision_id)
1700
1778
            return 0, []
1701
 
        # if there is no specific appropriate InterRepository, this will get
1702
 
        # the InterRepository base class, which raises an
1703
 
        # IncompatibleRepositories when asked to fetch.
1704
1779
        inter = InterRepository.get(source, self)
1705
 
        return inter.fetch(revision_id=revision_id, pb=pb,
 
1780
        return inter.fetch(revision_id=revision_id,
1706
1781
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1707
1782
 
1708
1783
    def create_bundle(self, target, base, fileobj, format=None):
1710
1785
 
1711
1786
    def get_commit_builder(self, branch, parents, config, timestamp=None,
1712
1787
                           timezone=None, committer=None, revprops=None,
1713
 
                           revision_id=None):
 
1788
                           revision_id=None, lossy=False):
1714
1789
        """Obtain a CommitBuilder for this repository.
1715
1790
 
1716
1791
        :param branch: Branch to commit to.
1721
1796
        :param committer: Optional committer to set for commit.
1722
1797
        :param revprops: Optional dictionary of revision properties.
1723
1798
        :param revision_id: Optional revision id.
 
1799
        :param lossy: Whether to discard data that can not be natively
 
1800
            represented, when pushing to a foreign VCS
1724
1801
        """
1725
 
        if self._fallback_repositories:
1726
 
            raise errors.BzrError("Cannot commit from a lightweight checkout "
1727
 
                "to a stacked branch. See "
 
1802
        if self._fallback_repositories and not self._format.supports_chks:
 
1803
            raise errors.BzrError("Cannot commit directly to a stacked branch"
 
1804
                " in pre-2a formats. See "
1728
1805
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1729
1806
        result = self._commit_builder_class(self, parents, config,
1730
 
            timestamp, timezone, committer, revprops, revision_id)
 
1807
            timestamp, timezone, committer, revprops, revision_id,
 
1808
            lossy)
1731
1809
        self.start_write_group()
1732
1810
        return result
1733
1811
 
1979
2057
        w = self.inventories
1980
2058
        pb = ui.ui_factory.nested_progress_bar()
1981
2059
        try:
1982
 
            return self._find_text_key_references_from_xml_inventory_lines(
 
2060
            return self._serializer._find_text_key_references(
1983
2061
                w.iter_lines_added_or_present_in_keys(revision_keys, pb=pb))
1984
2062
        finally:
1985
2063
            pb.finished()
1986
2064
 
1987
 
    def _find_text_key_references_from_xml_inventory_lines(self,
1988
 
        line_iterator):
1989
 
        """Core routine for extracting references to texts from inventories.
1990
 
 
1991
 
        This performs the translation of xml lines to revision ids.
1992
 
 
1993
 
        :param line_iterator: An iterator of lines, origin_version_id
1994
 
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1995
 
            to whether they were referred to by the inventory of the
1996
 
            revision_id that they contain. Note that if that revision_id was
1997
 
            not part of the line_iterator's output then False will be given -
1998
 
            even though it may actually refer to that key.
1999
 
        """
2000
 
        if not self._serializer.support_altered_by_hack:
2001
 
            raise AssertionError(
2002
 
                "_find_text_key_references_from_xml_inventory_lines only "
2003
 
                "supported for branches which store inventory as unnested xml"
2004
 
                ", not on %r" % self)
2005
 
        result = {}
2006
 
 
2007
 
        # this code needs to read every new line in every inventory for the
2008
 
        # inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
2009
 
        # not present in one of those inventories is unnecessary but not
2010
 
        # harmful because we are filtering by the revision id marker in the
2011
 
        # inventory lines : we only select file ids altered in one of those
2012
 
        # revisions. We don't need to see all lines in the inventory because
2013
 
        # only those added in an inventory in rev X can contain a revision=X
2014
 
        # line.
2015
 
        unescape_revid_cache = {}
2016
 
        unescape_fileid_cache = {}
2017
 
 
2018
 
        # jam 20061218 In a big fetch, this handles hundreds of thousands
2019
 
        # of lines, so it has had a lot of inlining and optimizing done.
2020
 
        # Sorry that it is a little bit messy.
2021
 
        # Move several functions to be local variables, since this is a long
2022
 
        # running loop.
2023
 
        search = self._file_ids_altered_regex.search
2024
 
        unescape = _unescape_xml
2025
 
        setdefault = result.setdefault
2026
 
        for line, line_key in line_iterator:
2027
 
            match = search(line)
2028
 
            if match is None:
2029
 
                continue
2030
 
            # One call to match.group() returning multiple items is quite a
2031
 
            # bit faster than 2 calls to match.group() each returning 1
2032
 
            file_id, revision_id = match.group('file_id', 'revision_id')
2033
 
 
2034
 
            # Inlining the cache lookups helps a lot when you make 170,000
2035
 
            # lines and 350k ids, versus 8.4 unique ids.
2036
 
            # Using a cache helps in 2 ways:
2037
 
            #   1) Avoids unnecessary decoding calls
2038
 
            #   2) Re-uses cached strings, which helps in future set and
2039
 
            #      equality checks.
2040
 
            # (2) is enough that removing encoding entirely along with
2041
 
            # the cache (so we are using plain strings) results in no
2042
 
            # performance improvement.
2043
 
            try:
2044
 
                revision_id = unescape_revid_cache[revision_id]
2045
 
            except KeyError:
2046
 
                unescaped = unescape(revision_id)
2047
 
                unescape_revid_cache[revision_id] = unescaped
2048
 
                revision_id = unescaped
2049
 
 
2050
 
            # Note that unconditionally unescaping means that we deserialise
2051
 
            # every fileid, which for general 'pull' is not great, but we don't
2052
 
            # really want to have some many fulltexts that this matters anyway.
2053
 
            # RBC 20071114.
2054
 
            try:
2055
 
                file_id = unescape_fileid_cache[file_id]
2056
 
            except KeyError:
2057
 
                unescaped = unescape(file_id)
2058
 
                unescape_fileid_cache[file_id] = unescaped
2059
 
                file_id = unescaped
2060
 
 
2061
 
            key = (file_id, revision_id)
2062
 
            setdefault(key, False)
2063
 
            if revision_id == line_key[-1]:
2064
 
                result[key] = True
2065
 
        return result
2066
 
 
2067
2065
    def _inventory_xml_lines_for_keys(self, keys):
2068
2066
        """Get a line iterator of the sort needed for findind references.
2069
2067
 
2099
2097
        revision_ids. Each altered file-ids has the exact revision_ids that
2100
2098
        altered it listed explicitly.
2101
2099
        """
2102
 
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
 
2100
        seen = set(self._serializer._find_text_key_references(
2103
2101
                line_iterator).iterkeys())
2104
2102
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
2105
 
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
 
2103
        parent_seen = set(self._serializer._find_text_key_references(
2106
2104
            self._inventory_xml_lines_for_keys(parent_keys)))
2107
2105
        new_keys = seen - parent_seen
2108
2106
        result = {}
2476
2474
            ancestors will be traversed.
2477
2475
        """
2478
2476
        graph = self.get_graph()
2479
 
        next_id = revision_id
2480
 
        while True:
2481
 
            if next_id in (None, _mod_revision.NULL_REVISION):
2482
 
                return
2483
 
            try:
2484
 
                parents = graph.get_parent_map([next_id])[next_id]
2485
 
            except KeyError:
2486
 
                raise errors.RevisionNotPresent(next_id, self)
2487
 
            yield next_id
2488
 
            if len(parents) == 0:
2489
 
                return
2490
 
            else:
2491
 
                next_id = parents[0]
 
2477
        stop_revisions = (None, _mod_revision.NULL_REVISION)
 
2478
        return graph.iter_lefthand_ancestry(revision_id, stop_revisions)
2492
2479
 
2493
2480
    def is_shared(self):
2494
2481
        """Return True if this repository is flagged as a shared repository."""
2526
2513
        # TODO: refactor this to use an existing revision object
2527
2514
        # so we don't need to read it in twice.
2528
2515
        if revision_id == _mod_revision.NULL_REVISION:
2529
 
            return RevisionTree(self, Inventory(root_id=None),
2530
 
                                _mod_revision.NULL_REVISION)
 
2516
            return InventoryRevisionTree(self,
 
2517
                Inventory(root_id=None), _mod_revision.NULL_REVISION)
2531
2518
        else:
2532
2519
            inv = self.get_inventory(revision_id)
2533
 
            return RevisionTree(self, inv, revision_id)
 
2520
            return InventoryRevisionTree(self, inv, revision_id)
2534
2521
 
2535
2522
    def revision_trees(self, revision_ids):
2536
2523
        """Return Trees for revisions in this repository.
2540
2527
        """
2541
2528
        inventories = self.iter_inventories(revision_ids)
2542
2529
        for inv in inventories:
2543
 
            yield RevisionTree(self, inv, inv.revision_id)
 
2530
            yield InventoryRevisionTree(self, inv, inv.revision_id)
2544
2531
 
2545
2532
    def _filtered_revision_trees(self, revision_ids, file_ids):
2546
2533
        """Return Tree for a revision on this branch with only some files.
2556
2543
            # Should we introduce a FilteredRevisionTree class rather
2557
2544
            # than pre-filter the inventory here?
2558
2545
            filtered_inv = inv.filter(file_ids)
2559
 
            yield RevisionTree(self, filtered_inv, filtered_inv.revision_id)
 
2546
            yield InventoryRevisionTree(self, filtered_inv, filtered_inv.revision_id)
2560
2547
 
2561
2548
    @needs_read_lock
2562
2549
    def get_ancestry(self, revision_id, topo_sorted=True):
2595
2582
        types it should be a no-op that just returns.
2596
2583
 
2597
2584
        This stub method does not require a lock, but subclasses should use
2598
 
        @needs_write_lock as this is a long running call its reasonable to
 
2585
        @needs_write_lock as this is a long running call it's reasonable to
2599
2586
        implicitly lock for the user.
2600
2587
 
2601
2588
        :param hint: If not supplied, the whole repository is packed.
2747
2734
        return result
2748
2735
 
2749
2736
    def _warn_if_deprecated(self, branch=None):
 
2737
        if not self._format.is_deprecated():
 
2738
            return
2750
2739
        global _deprecation_warning_done
2751
2740
        if _deprecation_warning_done:
2752
2741
            return
2782
2771
                except UnicodeDecodeError:
2783
2772
                    raise errors.NonAsciiRevisionId(method, self)
2784
2773
 
2785
 
    def revision_graph_can_have_wrong_parents(self):
2786
 
        """Is it possible for this repository to have a revision graph with
2787
 
        incorrect parents?
 
2774
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
 
2775
        """Find revisions with different parent lists in the revision object
 
2776
        and in the index graph.
2788
2777
 
2789
 
        If True, then this repository must also implement
2790
 
        _find_inconsistent_revision_parents so that check and reconcile can
2791
 
        check for inconsistencies before proceeding with other checks that may
2792
 
        depend on the revision index being consistent.
 
2778
        :param revisions_iterator: None, or an iterator of (revid,
 
2779
            Revision-or-None). This iterator controls the revisions checked.
 
2780
        :returns: an iterator yielding tuples of (revison-id, parents-in-index,
 
2781
            parents-in-revision).
2793
2782
        """
2794
 
        raise NotImplementedError(self.revision_graph_can_have_wrong_parents)
2795
 
 
2796
 
 
2797
 
# remove these delegates a while after bzr 0.15
2798
 
def __make_delegated(name, from_module):
2799
 
    def _deprecated_repository_forwarder():
2800
 
        symbol_versioning.warn('%s moved to %s in bzr 0.15'
2801
 
            % (name, from_module),
2802
 
            DeprecationWarning,
2803
 
            stacklevel=2)
2804
 
        m = __import__(from_module, globals(), locals(), [name])
2805
 
        try:
2806
 
            return getattr(m, name)
2807
 
        except AttributeError:
2808
 
            raise AttributeError('module %s has no name %s'
2809
 
                    % (m, name))
2810
 
    globals()[name] = _deprecated_repository_forwarder
2811
 
 
2812
 
for _name in [
2813
 
        'AllInOneRepository',
2814
 
        'WeaveMetaDirRepository',
2815
 
        'PreSplitOutRepositoryFormat',
2816
 
        'RepositoryFormat4',
2817
 
        'RepositoryFormat5',
2818
 
        'RepositoryFormat6',
2819
 
        'RepositoryFormat7',
2820
 
        ]:
2821
 
    __make_delegated(_name, 'bzrlib.repofmt.weaverepo')
2822
 
 
2823
 
for _name in [
2824
 
        'KnitRepository',
2825
 
        'RepositoryFormatKnit',
2826
 
        'RepositoryFormatKnit1',
2827
 
        ]:
2828
 
    __make_delegated(_name, 'bzrlib.repofmt.knitrepo')
 
2783
        if not self.is_locked():
 
2784
            raise AssertionError()
 
2785
        vf = self.revisions
 
2786
        if revisions_iterator is None:
 
2787
            revisions_iterator = self._iter_revisions(None)
 
2788
        for revid, revision in revisions_iterator:
 
2789
            if revision is None:
 
2790
                pass
 
2791
            parent_map = vf.get_parent_map([(revid,)])
 
2792
            parents_according_to_index = tuple(parent[-1] for parent in
 
2793
                parent_map[(revid,)])
 
2794
            parents_according_to_revision = tuple(revision.parent_ids)
 
2795
            if parents_according_to_index != parents_according_to_revision:
 
2796
                yield (revid, parents_according_to_index,
 
2797
                    parents_according_to_revision)
 
2798
 
 
2799
    def _check_for_inconsistent_revision_parents(self):
 
2800
        inconsistencies = list(self._find_inconsistent_revision_parents())
 
2801
        if inconsistencies:
 
2802
            raise errors.BzrCheckError(
 
2803
                "Revision knit has inconsistent parents.")
2829
2804
 
2830
2805
 
2831
2806
def install_revision(repository, rev, revision_tree):
2965
2940
            control_files)
2966
2941
 
2967
2942
 
 
2943
class RepositoryFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2944
    """Repository format registry."""
 
2945
 
 
2946
    def get_default(self):
 
2947
        """Return the current default format."""
 
2948
        from bzrlib import bzrdir
 
2949
        return bzrdir.format_registry.make_bzrdir('default').repository_format
 
2950
 
 
2951
 
2968
2952
network_format_registry = registry.FormatRegistry()
2969
2953
"""Registry of formats indexed by their network name.
2970
2954
 
2974
2958
"""
2975
2959
 
2976
2960
 
2977
 
format_registry = registry.FormatRegistry(network_format_registry)
 
2961
format_registry = RepositoryFormatRegistry(network_format_registry)
2978
2962
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
2979
2963
 
2980
2964
This can contain either format instances themselves, or classes/factories that
2985
2969
#####################################################################
2986
2970
# Repository Formats
2987
2971
 
2988
 
class RepositoryFormat(object):
 
2972
class RepositoryFormat(controldir.ControlComponentFormat):
2989
2973
    """A repository format.
2990
2974
 
2991
2975
    Formats provide four things:
3052
3036
    supports_tree_reference = None
3053
3037
    # Is the format experimental ?
3054
3038
    experimental = False
 
3039
    # Does this repository format escape funky characters, or does it create files with
 
3040
    # similar names as the versioned files in its contents on disk ?
 
3041
    supports_funky_characters = None
 
3042
    # Does this repository format support leaving locks?
 
3043
    supports_leaving_lock = None
 
3044
    # Does this format support the full VersionedFiles interface?
 
3045
    supports_full_versioned_files = None
 
3046
    # Does this format support signing revision signatures?
 
3047
    supports_revision_signatures = True
 
3048
    # Can the revision graph have incorrect parents?
 
3049
    revision_graph_can_have_wrong_parents = None
3055
3050
 
3056
3051
    def __repr__(self):
3057
3052
        return "%s()" % self.__class__.__name__
3082
3077
                                            kind='repository')
3083
3078
 
3084
3079
    @classmethod
 
3080
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
3085
3081
    def register_format(klass, format):
3086
 
        format_registry.register(format.get_format_string(), format)
 
3082
        format_registry.register(format)
3087
3083
 
3088
3084
    @classmethod
 
3085
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
3089
3086
    def unregister_format(klass, format):
3090
 
        format_registry.remove(format.get_format_string())
 
3087
        format_registry.remove(format)
3091
3088
 
3092
3089
    @classmethod
 
3090
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
3093
3091
    def get_default_format(klass):
3094
3092
        """Return the current default format."""
3095
 
        from bzrlib import bzrdir
3096
 
        return bzrdir.format_registry.make_bzrdir('default').repository_format
 
3093
        return format_registry.get_default()
3097
3094
 
3098
3095
    def get_format_string(self):
3099
3096
        """Return the ASCII format string that identifies this format.
3150
3147
        """
3151
3148
        return True
3152
3149
 
 
3150
    def is_deprecated(self):
 
3151
        """Is this format deprecated?
 
3152
 
 
3153
        Deprecated formats may trigger a user-visible warning recommending
 
3154
        the user to upgrade. They are still fully supported.
 
3155
        """
 
3156
        return False
 
3157
 
3153
3158
    def network_name(self):
3154
3159
        """A simple byte string uniquely identifying this format for RPC calls.
3155
3160
 
3194
3199
    rich_root_data = False
3195
3200
    supports_tree_reference = False
3196
3201
    supports_external_lookups = False
 
3202
    supports_leaving_lock = True
3197
3203
 
3198
3204
    @property
3199
3205
    def _matchingbzrdir(self):
3237
3243
        return self.get_format_string()
3238
3244
 
3239
3245
 
3240
 
# Pre-0.8 formats that don't have a disk format string (because they are
3241
 
# versioned by the matching control directory). We use the control directories
3242
 
# disk format string as a key for the network_name because they meet the
3243
 
# constraints (simple string, unique, immutable).
3244
 
network_format_registry.register_lazy(
3245
 
    "Bazaar-NG branch, format 5\n",
3246
 
    'bzrlib.repofmt.weaverepo',
3247
 
    'RepositoryFormat5',
3248
 
)
3249
 
network_format_registry.register_lazy(
3250
 
    "Bazaar-NG branch, format 6\n",
3251
 
    'bzrlib.repofmt.weaverepo',
3252
 
    'RepositoryFormat6',
3253
 
)
3254
 
 
3255
3246
# formats which have no format string are not discoverable or independently
3256
3247
# creatable on disk, so are not registered in format_registry.  They're
3257
 
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
 
3248
# all in bzrlib.repofmt.knitreponow.  When an instance of one of these is
3258
3249
# needed, it's constructed directly by the BzrDir.  Non-native formats where
3259
3250
# the repository is not separately opened are similar.
3260
3251
 
3261
3252
format_registry.register_lazy(
3262
 
    'Bazaar-NG Repository format 7',
3263
 
    'bzrlib.repofmt.weaverepo',
3264
 
    'RepositoryFormat7'
3265
 
    )
3266
 
 
3267
 
format_registry.register_lazy(
3268
3253
    'Bazaar-NG Knit Repository Format 1',
3269
3254
    'bzrlib.repofmt.knitrepo',
3270
3255
    'RepositoryFormatKnit1',
3287
3272
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
3288
3273
format_registry.register_lazy(
3289
3274
    'Bazaar pack repository format 1 (needs bzr 0.92)\n',
3290
 
    'bzrlib.repofmt.pack_repo',
 
3275
    'bzrlib.repofmt.knitpack_repo',
3291
3276
    'RepositoryFormatKnitPack1',
3292
3277
    )
3293
3278
format_registry.register_lazy(
3294
3279
    'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
3295
 
    'bzrlib.repofmt.pack_repo',
 
3280
    'bzrlib.repofmt.knitpack_repo',
3296
3281
    'RepositoryFormatKnitPack3',
3297
3282
    )
3298
3283
format_registry.register_lazy(
3299
3284
    'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
3300
 
    'bzrlib.repofmt.pack_repo',
 
3285
    'bzrlib.repofmt.knitpack_repo',
3301
3286
    'RepositoryFormatKnitPack4',
3302
3287
    )
3303
3288
format_registry.register_lazy(
3304
3289
    'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
3305
 
    'bzrlib.repofmt.pack_repo',
 
3290
    'bzrlib.repofmt.knitpack_repo',
3306
3291
    'RepositoryFormatKnitPack5',
3307
3292
    )
3308
3293
format_registry.register_lazy(
3309
3294
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
3310
 
    'bzrlib.repofmt.pack_repo',
 
3295
    'bzrlib.repofmt.knitpack_repo',
3311
3296
    'RepositoryFormatKnitPack5RichRoot',
3312
3297
    )
3313
3298
format_registry.register_lazy(
3314
3299
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
3315
 
    'bzrlib.repofmt.pack_repo',
 
3300
    'bzrlib.repofmt.knitpack_repo',
3316
3301
    'RepositoryFormatKnitPack5RichRootBroken',
3317
3302
    )
3318
3303
format_registry.register_lazy(
3319
3304
    'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
3320
 
    'bzrlib.repofmt.pack_repo',
 
3305
    'bzrlib.repofmt.knitpack_repo',
3321
3306
    'RepositoryFormatKnitPack6',
3322
3307
    )
3323
3308
format_registry.register_lazy(
3324
3309
    'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
3325
 
    'bzrlib.repofmt.pack_repo',
 
3310
    'bzrlib.repofmt.knitpack_repo',
3326
3311
    'RepositoryFormatKnitPack6RichRoot',
3327
3312
    )
 
3313
format_registry.register_lazy(
 
3314
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
 
3315
    'bzrlib.repofmt.groupcompress_repo',
 
3316
    'RepositoryFormat2a',
 
3317
    )
3328
3318
 
3329
3319
# Development formats.
3330
 
# Obsolete but kept pending a CHK based subtree format.
 
3320
# Check their docstrings to see if/when they are obsolete.
3331
3321
format_registry.register_lazy(
3332
3322
    ("Bazaar development format 2 with subtree support "
3333
3323
        "(needs bzr.dev from before 1.8)\n"),
3334
 
    'bzrlib.repofmt.pack_repo',
 
3324
    'bzrlib.repofmt.knitpack_repo',
3335
3325
    'RepositoryFormatPackDevelopment2Subtree',
3336
3326
    )
3337
 
 
3338
 
# 1.14->1.16 go below here
3339
 
format_registry.register_lazy(
3340
 
    'Bazaar development format - group compression and chk inventory'
3341
 
        ' (needs bzr.dev from 1.14)\n',
3342
 
    'bzrlib.repofmt.groupcompress_repo',
3343
 
    'RepositoryFormatCHK1',
3344
 
    )
3345
 
 
3346
 
format_registry.register_lazy(
3347
 
    'Bazaar development format - chk repository with bencode revision '
3348
 
        'serialization (needs bzr.dev from 1.16)\n',
3349
 
    'bzrlib.repofmt.groupcompress_repo',
3350
 
    'RepositoryFormatCHK2',
3351
 
    )
3352
 
format_registry.register_lazy(
3353
 
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
3354
 
    'bzrlib.repofmt.groupcompress_repo',
3355
 
    'RepositoryFormat2a',
 
3327
format_registry.register_lazy(
 
3328
    'Bazaar development format 8\n',
 
3329
    'bzrlib.repofmt.groupcompress_repo',
 
3330
    'RepositoryFormat2aSubtree',
3356
3331
    )
3357
3332
 
3358
3333
 
3389
3364
        self.target.fetch(self.source, revision_id=revision_id)
3390
3365
 
3391
3366
    @needs_write_lock
3392
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
 
3367
    def fetch(self, revision_id=None, find_ghosts=False,
3393
3368
            fetch_spec=None):
3394
3369
        """Fetch the content required to construct revision_id.
3395
3370
 
3397
3372
 
3398
3373
        :param revision_id: if None all content is copied, if NULL_REVISION no
3399
3374
                            content is copied.
3400
 
        :param pb: ignored.
3401
3375
        :return: None.
3402
3376
        """
3403
3377
        ui.ui_factory.warn_experimental_format_fetch(self)
3413
3387
                               fetch_spec=fetch_spec,
3414
3388
                               find_ghosts=find_ghosts)
3415
3389
 
3416
 
    def _walk_to_common_revisions(self, revision_ids):
 
3390
    def _walk_to_common_revisions(self, revision_ids, if_present_ids=None):
3417
3391
        """Walk out from revision_ids in source to revisions target has.
3418
3392
 
3419
3393
        :param revision_ids: The start point for the search.
3421
3395
        """
3422
3396
        target_graph = self.target.get_graph()
3423
3397
        revision_ids = frozenset(revision_ids)
 
3398
        if if_present_ids:
 
3399
            all_wanted_revs = revision_ids.union(if_present_ids)
 
3400
        else:
 
3401
            all_wanted_revs = revision_ids
3424
3402
        missing_revs = set()
3425
3403
        source_graph = self.source.get_graph()
3426
3404
        # ensure we don't pay silly lookup costs.
3427
 
        searcher = source_graph._make_breadth_first_searcher(revision_ids)
 
3405
        searcher = source_graph._make_breadth_first_searcher(all_wanted_revs)
3428
3406
        null_set = frozenset([_mod_revision.NULL_REVISION])
3429
3407
        searcher_exhausted = False
3430
3408
        while True:
3466
3444
        return searcher.get_result()
3467
3445
 
3468
3446
    @needs_read_lock
3469
 
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
3447
    def search_missing_revision_ids(self,
 
3448
            revision_id=symbol_versioning.DEPRECATED_PARAMETER,
 
3449
            find_ghosts=True, revision_ids=None, if_present_ids=None):
3470
3450
        """Return the revision ids that source has that target does not.
3471
3451
 
3472
3452
        :param revision_id: only return revision ids included by this
3473
 
                            revision_id.
 
3453
            revision_id.
 
3454
        :param revision_ids: return revision ids included by these
 
3455
            revision_ids.  NoSuchRevision will be raised if any of these
 
3456
            revisions are not present.
 
3457
        :param if_present_ids: like revision_ids, but will not cause
 
3458
            NoSuchRevision if any of these are absent, instead they will simply
 
3459
            not be in the result.  This is useful for e.g. finding revisions
 
3460
            to fetch for tags, which may reference absent revisions.
3474
3461
        :param find_ghosts: If True find missing revisions in deep history
3475
3462
            rather than just finding the surface difference.
3476
3463
        :return: A bzrlib.graph.SearchResult.
3477
3464
        """
 
3465
        if symbol_versioning.deprecated_passed(revision_id):
 
3466
            symbol_versioning.warn(
 
3467
                'search_missing_revision_ids(revision_id=...) was '
 
3468
                'deprecated in 2.4.  Use revision_ids=[...] instead.',
 
3469
                DeprecationWarning, stacklevel=2)
 
3470
            if revision_ids is not None:
 
3471
                raise AssertionError(
 
3472
                    'revision_ids is mutually exclusive with revision_id')
 
3473
            if revision_id is not None:
 
3474
                revision_ids = [revision_id]
 
3475
        del revision_id
3478
3476
        # stop searching at found target revisions.
3479
 
        if not find_ghosts and revision_id is not None:
3480
 
            return self._walk_to_common_revisions([revision_id])
 
3477
        if not find_ghosts and (revision_ids is not None or if_present_ids is
 
3478
                not None):
 
3479
            return self._walk_to_common_revisions(revision_ids,
 
3480
                    if_present_ids=if_present_ids)
3481
3481
        # generic, possibly worst case, slow code path.
3482
3482
        target_ids = set(self.target.all_revision_ids())
3483
 
        if revision_id is not None:
3484
 
            source_ids = self.source.get_ancestry(revision_id)
3485
 
            if source_ids[0] is not None:
3486
 
                raise AssertionError()
3487
 
            source_ids.pop(0)
3488
 
        else:
3489
 
            source_ids = self.source.all_revision_ids()
 
3483
        source_ids = self._present_source_revisions_for(
 
3484
            revision_ids, if_present_ids)
3490
3485
        result_set = set(source_ids).difference(target_ids)
3491
3486
        return self.source.revision_ids_to_search_result(result_set)
3492
3487
 
 
3488
    def _present_source_revisions_for(self, revision_ids, if_present_ids=None):
 
3489
        """Returns set of all revisions in ancestry of revision_ids present in
 
3490
        the source repo.
 
3491
 
 
3492
        :param revision_ids: if None, all revisions in source are returned.
 
3493
        :param if_present_ids: like revision_ids, but if any/all of these are
 
3494
            absent no error is raised.
 
3495
        """
 
3496
        if revision_ids is not None or if_present_ids is not None:
 
3497
            # First, ensure all specified revisions exist.  Callers expect
 
3498
            # NoSuchRevision when they pass absent revision_ids here.
 
3499
            if revision_ids is None:
 
3500
                revision_ids = set()
 
3501
            if if_present_ids is None:
 
3502
                if_present_ids = set()
 
3503
            revision_ids = set(revision_ids)
 
3504
            if_present_ids = set(if_present_ids)
 
3505
            all_wanted_ids = revision_ids.union(if_present_ids)
 
3506
            graph = self.source.get_graph()
 
3507
            present_revs = set(graph.get_parent_map(all_wanted_ids))
 
3508
            missing = revision_ids.difference(present_revs)
 
3509
            if missing:
 
3510
                raise errors.NoSuchRevision(self.source, missing.pop())
 
3511
            found_ids = all_wanted_ids.intersection(present_revs)
 
3512
            source_ids = [rev_id for (rev_id, parents) in
 
3513
                          graph.iter_ancestry(found_ids)
 
3514
                          if rev_id != _mod_revision.NULL_REVISION
 
3515
                          and parents is not None]
 
3516
        else:
 
3517
            source_ids = self.source.all_revision_ids()
 
3518
        return set(source_ids)
 
3519
 
3493
3520
    @staticmethod
3494
3521
    def _same_model(source, target):
3495
3522
        """True if source and target have the same data representation.
3536
3563
        return InterRepository._same_model(source, target)
3537
3564
 
3538
3565
 
3539
 
class InterWeaveRepo(InterSameDataRepository):
3540
 
    """Optimised code paths between Weave based repositories.
3541
 
 
3542
 
    This should be in bzrlib/repofmt/weaverepo.py but we have not yet
3543
 
    implemented lazy inter-object optimisation.
3544
 
    """
3545
 
 
3546
 
    @classmethod
3547
 
    def _get_repo_format_to_test(self):
3548
 
        from bzrlib.repofmt import weaverepo
3549
 
        return weaverepo.RepositoryFormat7()
3550
 
 
3551
 
    @staticmethod
3552
 
    def is_compatible(source, target):
3553
 
        """Be compatible with known Weave formats.
3554
 
 
3555
 
        We don't test for the stores being of specific types because that
3556
 
        could lead to confusing results, and there is no need to be
3557
 
        overly general.
3558
 
        """
3559
 
        from bzrlib.repofmt.weaverepo import (
3560
 
                RepositoryFormat5,
3561
 
                RepositoryFormat6,
3562
 
                RepositoryFormat7,
3563
 
                )
3564
 
        try:
3565
 
            return (isinstance(source._format, (RepositoryFormat5,
3566
 
                                                RepositoryFormat6,
3567
 
                                                RepositoryFormat7)) and
3568
 
                    isinstance(target._format, (RepositoryFormat5,
3569
 
                                                RepositoryFormat6,
3570
 
                                                RepositoryFormat7)))
3571
 
        except AttributeError:
3572
 
            return False
3573
 
 
3574
 
    @needs_write_lock
3575
 
    def copy_content(self, revision_id=None):
3576
 
        """See InterRepository.copy_content()."""
3577
 
        # weave specific optimised path:
3578
 
        try:
3579
 
            self.target.set_make_working_trees(self.source.make_working_trees())
3580
 
        except (errors.RepositoryUpgradeRequired, NotImplemented):
3581
 
            pass
3582
 
        # FIXME do not peek!
3583
 
        if self.source._transport.listable():
3584
 
            pb = ui.ui_factory.nested_progress_bar()
3585
 
            try:
3586
 
                self.target.texts.insert_record_stream(
3587
 
                    self.source.texts.get_record_stream(
3588
 
                        self.source.texts.keys(), 'topological', False))
3589
 
                pb.update('Copying inventory', 0, 1)
3590
 
                self.target.inventories.insert_record_stream(
3591
 
                    self.source.inventories.get_record_stream(
3592
 
                        self.source.inventories.keys(), 'topological', False))
3593
 
                self.target.signatures.insert_record_stream(
3594
 
                    self.source.signatures.get_record_stream(
3595
 
                        self.source.signatures.keys(),
3596
 
                        'unordered', True))
3597
 
                self.target.revisions.insert_record_stream(
3598
 
                    self.source.revisions.get_record_stream(
3599
 
                        self.source.revisions.keys(),
3600
 
                        'topological', True))
3601
 
            finally:
3602
 
                pb.finished()
3603
 
        else:
3604
 
            self.target.fetch(self.source, revision_id=revision_id)
3605
 
 
3606
 
    @needs_read_lock
3607
 
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3608
 
        """See InterRepository.missing_revision_ids()."""
3609
 
        # we want all revisions to satisfy revision_id in source.
3610
 
        # but we don't want to stat every file here and there.
3611
 
        # we want then, all revisions other needs to satisfy revision_id
3612
 
        # checked, but not those that we have locally.
3613
 
        # so the first thing is to get a subset of the revisions to
3614
 
        # satisfy revision_id in source, and then eliminate those that
3615
 
        # we do already have.
3616
 
        # this is slow on high latency connection to self, but as this
3617
 
        # disk format scales terribly for push anyway due to rewriting
3618
 
        # inventory.weave, this is considered acceptable.
3619
 
        # - RBC 20060209
3620
 
        if revision_id is not None:
3621
 
            source_ids = self.source.get_ancestry(revision_id)
3622
 
            if source_ids[0] is not None:
3623
 
                raise AssertionError()
3624
 
            source_ids.pop(0)
3625
 
        else:
3626
 
            source_ids = self.source._all_possible_ids()
3627
 
        source_ids_set = set(source_ids)
3628
 
        # source_ids is the worst possible case we may need to pull.
3629
 
        # now we want to filter source_ids against what we actually
3630
 
        # have in target, but don't try to check for existence where we know
3631
 
        # we do not have a revision as that would be pointless.
3632
 
        target_ids = set(self.target._all_possible_ids())
3633
 
        possibly_present_revisions = target_ids.intersection(source_ids_set)
3634
 
        actually_present_revisions = set(
3635
 
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
3636
 
        required_revisions = source_ids_set.difference(actually_present_revisions)
3637
 
        if revision_id is not None:
3638
 
            # we used get_ancestry to determine source_ids then we are assured all
3639
 
            # revisions referenced are present as they are installed in topological order.
3640
 
            # and the tip revision was validated by get_ancestry.
3641
 
            result_set = required_revisions
3642
 
        else:
3643
 
            # if we just grabbed the possibly available ids, then
3644
 
            # we only have an estimate of whats available and need to validate
3645
 
            # that against the revision records.
3646
 
            result_set = set(
3647
 
                self.source._eliminate_revisions_not_present(required_revisions))
3648
 
        return self.source.revision_ids_to_search_result(result_set)
3649
 
 
3650
 
 
3651
 
class InterKnitRepo(InterSameDataRepository):
3652
 
    """Optimised code paths between Knit based repositories."""
3653
 
 
3654
 
    @classmethod
3655
 
    def _get_repo_format_to_test(self):
3656
 
        from bzrlib.repofmt import knitrepo
3657
 
        return knitrepo.RepositoryFormatKnit1()
3658
 
 
3659
 
    @staticmethod
3660
 
    def is_compatible(source, target):
3661
 
        """Be compatible with known Knit formats.
3662
 
 
3663
 
        We don't test for the stores being of specific types because that
3664
 
        could lead to confusing results, and there is no need to be
3665
 
        overly general.
3666
 
        """
3667
 
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit
3668
 
        try:
3669
 
            are_knits = (isinstance(source._format, RepositoryFormatKnit) and
3670
 
                isinstance(target._format, RepositoryFormatKnit))
3671
 
        except AttributeError:
3672
 
            return False
3673
 
        return are_knits and InterRepository._same_model(source, target)
3674
 
 
3675
 
    @needs_read_lock
3676
 
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3677
 
        """See InterRepository.missing_revision_ids()."""
3678
 
        if revision_id is not None:
3679
 
            source_ids = self.source.get_ancestry(revision_id)
3680
 
            if source_ids[0] is not None:
3681
 
                raise AssertionError()
3682
 
            source_ids.pop(0)
3683
 
        else:
3684
 
            source_ids = self.source.all_revision_ids()
3685
 
        source_ids_set = set(source_ids)
3686
 
        # source_ids is the worst possible case we may need to pull.
3687
 
        # now we want to filter source_ids against what we actually
3688
 
        # have in target, but don't try to check for existence where we know
3689
 
        # we do not have a revision as that would be pointless.
3690
 
        target_ids = set(self.target.all_revision_ids())
3691
 
        possibly_present_revisions = target_ids.intersection(source_ids_set)
3692
 
        actually_present_revisions = set(
3693
 
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
3694
 
        required_revisions = source_ids_set.difference(actually_present_revisions)
3695
 
        if revision_id is not None:
3696
 
            # we used get_ancestry to determine source_ids then we are assured all
3697
 
            # revisions referenced are present as they are installed in topological order.
3698
 
            # and the tip revision was validated by get_ancestry.
3699
 
            result_set = required_revisions
3700
 
        else:
3701
 
            # if we just grabbed the possibly available ids, then
3702
 
            # we only have an estimate of whats available and need to validate
3703
 
            # that against the revision records.
3704
 
            result_set = set(
3705
 
                self.source._eliminate_revisions_not_present(required_revisions))
3706
 
        return self.source.revision_ids_to_search_result(result_set)
3707
 
 
3708
 
 
3709
3566
class InterDifferingSerializer(InterRepository):
3710
3567
 
3711
3568
    @classmethod
3813
3670
                basis_id, delta, current_revision_id, parents_parents)
3814
3671
            cache[current_revision_id] = parent_tree
3815
3672
 
3816
 
    def _fetch_batch(self, revision_ids, basis_id, cache, a_graph=None):
 
3673
    def _fetch_batch(self, revision_ids, basis_id, cache):
3817
3674
        """Fetch across a few revisions.
3818
3675
 
3819
3676
        :param revision_ids: The revisions to copy
3820
3677
        :param basis_id: The revision_id of a tree that must be in cache, used
3821
3678
            as a basis for delta when no other base is available
3822
3679
        :param cache: A cache of RevisionTrees that we can use.
3823
 
        :param a_graph: A Graph object to determine the heads() of the
3824
 
            rich-root data stream.
3825
3680
        :return: The revision_id of the last converted tree. The RevisionTree
3826
3681
            for it will be in cache
3827
3682
        """
3895
3750
        if root_keys_to_create:
3896
3751
            root_stream = _mod_fetch._new_root_data_stream(
3897
3752
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
3898
 
                self.source, graph=a_graph)
 
3753
                self.source)
3899
3754
            to_texts.insert_record_stream(root_stream)
3900
3755
        to_texts.insert_record_stream(from_texts.get_record_stream(
3901
3756
            text_keys, self.target._format._fetch_order,
3958
3813
        cache[basis_id] = basis_tree
3959
3814
        del basis_tree # We don't want to hang on to it here
3960
3815
        hints = []
3961
 
        if self._converting_to_rich_root and len(revision_ids) > 100:
3962
 
            a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
3963
 
                                                            revision_ids)
3964
 
        else:
3965
 
            a_graph = None
 
3816
        a_graph = None
3966
3817
 
3967
3818
        for offset in range(0, len(revision_ids), batch_size):
3968
3819
            self.target.start_write_group()
3970
3821
                pb.update('Transferring revisions', offset,
3971
3822
                          len(revision_ids))
3972
3823
                batch = revision_ids[offset:offset+batch_size]
3973
 
                basis_id = self._fetch_batch(batch, basis_id, cache,
3974
 
                                             a_graph=a_graph)
 
3824
                basis_id = self._fetch_batch(batch, basis_id, cache)
3975
3825
            except:
3976
3826
                self.source._safe_to_return_from_cache = False
3977
3827
                self.target.abort_write_group()
3986
3836
                  len(revision_ids))
3987
3837
 
3988
3838
    @needs_write_lock
3989
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
 
3839
    def fetch(self, revision_id=None, find_ghosts=False,
3990
3840
            fetch_spec=None):
3991
3841
        """See InterRepository.fetch()."""
3992
3842
        if fetch_spec is not None:
3993
 
            raise AssertionError("Not implemented yet...")
 
3843
            revision_ids = fetch_spec.get_keys()
 
3844
        else:
 
3845
            revision_ids = None
3994
3846
        ui.ui_factory.warn_experimental_format_fetch(self)
3995
3847
        if (not self.source.supports_rich_root()
3996
3848
            and self.target.supports_rich_root()):
4003
3855
            ui.ui_factory.show_user_warning('cross_format_fetch',
4004
3856
                from_format=self.source._format,
4005
3857
                to_format=self.target._format)
4006
 
        revision_ids = self.target.search_missing_revision_ids(self.source,
4007
 
            revision_id, find_ghosts=find_ghosts).get_keys()
 
3858
        if revision_ids is None:
 
3859
            if revision_id:
 
3860
                search_revision_ids = [revision_id]
 
3861
            else:
 
3862
                search_revision_ids = None
 
3863
            revision_ids = self.target.search_missing_revision_ids(self.source,
 
3864
                revision_ids=search_revision_ids,
 
3865
                find_ghosts=find_ghosts).get_keys()
4008
3866
        if not revision_ids:
4009
3867
            return 0, 0
4010
3868
        revision_ids = tsort.topo_sort(
4014
3872
        # Walk though all revisions; get inventory deltas, copy referenced
4015
3873
        # texts that delta references, insert the delta, revision and
4016
3874
        # signature.
4017
 
        if pb is None:
4018
 
            my_pb = ui.ui_factory.nested_progress_bar()
4019
 
            pb = my_pb
4020
 
        else:
4021
 
            symbol_versioning.warn(
4022
 
                symbol_versioning.deprecated_in((1, 14, 0))
4023
 
                % "pb parameter to fetch()")
4024
 
            my_pb = None
 
3875
        pb = ui.ui_factory.nested_progress_bar()
4025
3876
        try:
4026
3877
            self._fetch_all_revisions(revision_ids, pb)
4027
3878
        finally:
4028
 
            if my_pb is not None:
4029
 
                my_pb.finished()
 
3879
            pb.finished()
4030
3880
        return len(revision_ids), 0
4031
3881
 
4032
3882
    def _get_basis(self, first_revision_id):
4043
3893
            basis_id = first_rev.parent_ids[0]
4044
3894
            # only valid as a basis if the target has it
4045
3895
            self.target.get_revision(basis_id)
4046
 
            # Try to get a basis tree - if its a ghost it will hit the
 
3896
            # Try to get a basis tree - if it's a ghost it will hit the
4047
3897
            # NoSuchRevision case.
4048
3898
            basis_tree = self.source.revision_tree(basis_id)
4049
3899
        except (IndexError, errors.NoSuchRevision):
4054
3904
 
4055
3905
InterRepository.register_optimiser(InterDifferingSerializer)
4056
3906
InterRepository.register_optimiser(InterSameDataRepository)
4057
 
InterRepository.register_optimiser(InterWeaveRepo)
4058
 
InterRepository.register_optimiser(InterKnitRepo)
4059
3907
 
4060
3908
 
4061
3909
class CopyConverter(object):
4106
3954
        pb.finished()
4107
3955
 
4108
3956
 
4109
 
_unescape_map = {
4110
 
    'apos':"'",
4111
 
    'quot':'"',
4112
 
    'amp':'&',
4113
 
    'lt':'<',
4114
 
    'gt':'>'
4115
 
}
4116
 
 
4117
 
 
4118
 
def _unescaper(match, _map=_unescape_map):
4119
 
    code = match.group(1)
4120
 
    try:
4121
 
        return _map[code]
4122
 
    except KeyError:
4123
 
        if not code.startswith('#'):
4124
 
            raise
4125
 
        return unichr(int(code[1:])).encode('utf8')
4126
 
 
4127
 
 
4128
 
_unescape_re = None
4129
 
 
4130
 
 
4131
 
def _unescape_xml(data):
4132
 
    """Unescape predefined XML entities in a string of data."""
4133
 
    global _unescape_re
4134
 
    if _unescape_re is None:
4135
 
        _unescape_re = re.compile('\&([^;]*);')
4136
 
    return _unescape_re.sub(_unescaper, data)
4137
 
 
4138
 
 
4139
3957
class _VersionedFileChecker(object):
4140
3958
 
4141
3959
    def __init__(self, repository, text_key_references=None, ancestors=None):
4200
4018
        return wrong_parents, unused_keys
4201
4019
 
4202
4020
 
4203
 
def _old_get_graph(repository, revision_id):
4204
 
    """DO NOT USE. That is all. I'm serious."""
4205
 
    graph = repository.get_graph()
4206
 
    revision_graph = dict(((key, value) for key, value in
4207
 
        graph.iter_ancestry([revision_id]) if value is not None))
4208
 
    return _strip_NULL_ghosts(revision_graph)
4209
 
 
4210
 
 
4211
4021
def _strip_NULL_ghosts(revision_graph):
4212
4022
    """Also don't use this. more compatibility code for unmigrated clients."""
4213
4023
    # Filter ghosts, and null:
4249
4059
                is_resume = False
4250
4060
            try:
4251
4061
                # locked_insert_stream performs a commit|suspend.
4252
 
                return self._locked_insert_stream(stream, src_format, is_resume)
 
4062
                missing_keys = self.insert_stream_without_locking(stream,
 
4063
                                    src_format, is_resume)
 
4064
                if missing_keys:
 
4065
                    # suspend the write group and tell the caller what we is
 
4066
                    # missing. We know we can suspend or else we would not have
 
4067
                    # entered this code path. (All repositories that can handle
 
4068
                    # missing keys can handle suspending a write group).
 
4069
                    write_group_tokens = self.target_repo.suspend_write_group()
 
4070
                    return write_group_tokens, missing_keys
 
4071
                hint = self.target_repo.commit_write_group()
 
4072
                to_serializer = self.target_repo._format._serializer
 
4073
                src_serializer = src_format._serializer
 
4074
                if (to_serializer != src_serializer and
 
4075
                    self.target_repo._format.pack_compresses):
 
4076
                    self.target_repo.pack(hint=hint)
 
4077
                return [], set()
4253
4078
            except:
4254
4079
                self.target_repo.abort_write_group(suppress_errors=True)
4255
4080
                raise
4256
4081
        finally:
4257
4082
            self.target_repo.unlock()
4258
4083
 
4259
 
    def _locked_insert_stream(self, stream, src_format, is_resume):
 
4084
    def insert_stream_without_locking(self, stream, src_format,
 
4085
                                      is_resume=False):
 
4086
        """Insert a stream's content into the target repository.
 
4087
 
 
4088
        This assumes that you already have a locked repository and an active
 
4089
        write group.
 
4090
 
 
4091
        :param src_format: a bzr repository format.
 
4092
        :param is_resume: Passed down to get_missing_parent_inventories to
 
4093
            indicate if we should be checking for missing texts at the same
 
4094
            time.
 
4095
 
 
4096
        :return: A set of keys that are missing.
 
4097
        """
 
4098
        if not self.target_repo.is_write_locked():
 
4099
            raise errors.ObjectNotLocked(self)
 
4100
        if not self.target_repo.is_in_write_group():
 
4101
            raise errors.BzrError('you must already be in a write group')
4260
4102
        to_serializer = self.target_repo._format._serializer
4261
4103
        src_serializer = src_format._serializer
4262
4104
        new_pack = None
4302
4144
                # required if the serializers are different only in terms of
4303
4145
                # the inventory.
4304
4146
                if src_serializer == to_serializer:
4305
 
                    self.target_repo.revisions.insert_record_stream(
4306
 
                        substream)
 
4147
                    self.target_repo.revisions.insert_record_stream(substream)
4307
4148
                else:
4308
4149
                    self._extract_and_insert_revisions(substream,
4309
4150
                        src_serializer)
4342
4183
            # cannot even attempt suspending, and missing would have failed
4343
4184
            # during stream insertion.
4344
4185
            missing_keys = set()
4345
 
        else:
4346
 
            if missing_keys:
4347
 
                # suspend the write group and tell the caller what we is
4348
 
                # missing. We know we can suspend or else we would not have
4349
 
                # entered this code path. (All repositories that can handle
4350
 
                # missing keys can handle suspending a write group).
4351
 
                write_group_tokens = self.target_repo.suspend_write_group()
4352
 
                return write_group_tokens, missing_keys
4353
 
        hint = self.target_repo.commit_write_group()
4354
 
        if (to_serializer != src_serializer and
4355
 
            self.target_repo._format.pack_compresses):
4356
 
            self.target_repo.pack(hint=hint)
4357
 
        return [], set()
 
4186
        return missing_keys
4358
4187
 
4359
4188
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
4360
4189
        target_rich_root = self.target_repo._format.rich_root_data
4367
4196
                parse_result = deserialiser.parse_text_bytes(
4368
4197
                    inventory_delta_bytes)
4369
4198
            except inventory_delta.IncompatibleInventoryDelta, err:
4370
 
                trace.mutter("Incompatible delta: %s", err.msg)
 
4199
                mutter("Incompatible delta: %s", err.msg)
4371
4200
                raise errors.IncompatibleRevision(self.target_repo._format)
4372
4201
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
4373
4202
            revision_id = new_id
4417
4246
        """Create a StreamSource streaming from from_repository."""
4418
4247
        self.from_repository = from_repository
4419
4248
        self.to_format = to_format
 
4249
        self._record_counter = RecordCounter()
4420
4250
 
4421
4251
    def delta_on_metadata(self):
4422
4252
        """Return True if delta's are permitted on metadata streams.
4707
4537
    except StopIteration:
4708
4538
        # No more history
4709
4539
        return
4710