~bzr-pqm/bzr/bzr.dev

3943.2.4 by Martin Pool
Move backup progress indicators from upgrade.py into backup_bzrdir, and tweak text
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
2
#
1534.4.39 by Robert Collins
Basic BzrDir support.
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
7
#
1534.4.39 by Robert Collins
Basic BzrDir support.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
12
#
1534.4.39 by Robert Collins
Basic BzrDir support.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
1534.4.39 by Robert Collins
Basic BzrDir support.
16
17
"""BzrDir logic. The BzrDir is the basic control directory used by bzr.
18
19
At format 7 this was split out into Branch, Repository and Checkout control
20
directories.
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
21
22
Note: This module has a lot of ``open`` functions/methods that return
23
references to in-memory objects. As a rule, there are no matching ``close``
24
methods. To free any associated resources, simply stop referencing the
25
objects returned.
1534.4.39 by Robert Collins
Basic BzrDir support.
26
"""
27
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
28
# TODO: Move old formats into a plugin to make this file smaller.
1910.7.17 by Andrew Bennetts
Various cosmetic changes.
29
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
30
import os
3023.1.1 by Alexander Belchenko
Mark .bzr directories as "hidden" on Windows (#71147)
31
import sys
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
32
33
from bzrlib.lazy_import import lazy_import
34
lazy_import(globals(), """
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
35
from stat import S_ISDIR
2711.2.1 by Martin Pool
Deprecate BzrDir.create_repository
36
import textwrap
1534.4.39 by Robert Collins
Basic BzrDir support.
37
38
import bzrlib
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
39
from bzrlib import (
4294.2.8 by Robert Collins
Reduce round trips pushing new branches substantially.
40
    branch,
3242.1.1 by Aaron Bentley
Implement BzrDir configuration
41
    config,
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
42
    errors,
2776.1.5 by Robert Collins
Add reasonably comprehensive tests for path last modified and per file graph behaviour.
43
    graph,
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
44
    lockable_files,
45
    lockdir,
3350.6.1 by Robert Collins
* New ``versionedfile.KeyMapper`` interface to abstract out the access to
46
    osutils,
2018.5.25 by Andrew Bennetts
Make sure RemoteBzrDirFormat is always registered (John Arbash Meinel, Robert Collins, Andrew Bennetts).
47
    remote,
4294.2.5 by Robert Collins
Reasonable unit test coverage for initialize_on_transport_ex.
48
    repository,
1996.3.12 by John Arbash Meinel
Change how 'revision' is imported to avoid problems later
49
    revision as _mod_revision,
2323.6.4 by Martin Pool
BzrDir._check_supported now also takes care of recommending upgrades, which
50
    ui,
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
51
    urlutils,
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
52
    versionedfile,
3023.1.2 by Alexander Belchenko
Martin's review.
53
    win32utils,
54
    workingtree,
55
    workingtree_4,
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
56
    xml4,
57
    xml5,
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
58
    )
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
59
from bzrlib.osutils import (
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
60
    sha_string,
61
    )
3978.3.14 by Jelmer Vernooij
Move BranchBzrDirInter.push() to BzrDir.push().
62
from bzrlib.push import (
63
    PushResult,
64
    )
4294.2.8 by Robert Collins
Reduce round trips pushing new branches substantially.
65
from bzrlib.repofmt import pack_repo
2018.5.159 by Andrew Bennetts
Rename SmartClient to _SmartClient.
66
from bzrlib.smart.client import _SmartClient
1563.2.25 by Robert Collins
Merge in upstream.
67
from bzrlib.store.versioned import WeaveStore
1563.2.34 by Robert Collins
Remove the commit and rollback transaction methods as misleading, and implement a WriteTransaction
68
from bzrlib.transactions import WriteTransaction
2164.2.21 by Vincent Ladeuil
Take bundles into account.
69
from bzrlib.transport import (
70
    do_catching_redirections,
71
    get_transport,
3224.5.24 by Andrew Bennetts
More minor import tidying suggested by pyflakes.
72
    local,
4005.2.1 by Robert Collins
Fix RemoteBranch to be used correctly in tests using bzr+ssh, to fire off Branch hooks correctly, and improve the branch_implementations tests to check that making a branch gets the right format under test.
73
    remote as remote_transport,
2164.2.21 by Vincent Ladeuil
Take bundles into account.
74
    )
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
75
from bzrlib.weave import Weave
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
76
""")
77
2164.2.1 by v.ladeuil+lp at free
First rough http branch redirection implementation.
78
from bzrlib.trace import (
79
    mutter,
80
    note,
81
    )
3224.5.24 by Andrew Bennetts
More minor import tidying suggested by pyflakes.
82
83
from bzrlib import (
4160.1.1 by Robert Collins
Add a BzrDir.pre_open hook for use by the smart server gaol.
84
    hooks,
3224.5.24 by Andrew Bennetts
More minor import tidying suggested by pyflakes.
85
    registry,
86
    symbol_versioning,
2711.2.1 by Martin Pool
Deprecate BzrDir.create_repository
87
    )
1534.4.39 by Robert Collins
Basic BzrDir support.
88
89
90
class BzrDir(object):
91
    """A .bzr control diretory.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
92
1534.4.39 by Robert Collins
Basic BzrDir support.
93
    BzrDir instances let you create or open any of the things that can be
94
    found within .bzr - checkouts, branches and repositories.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
95
3407.2.13 by Martin Pool
Remove indirection through control_files to get transports
96
    :ivar transport:
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
97
        the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
3407.2.13 by Martin Pool
Remove indirection through control_files to get transports
98
    :ivar root_transport:
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
99
        a transport connected to the directory this bzr was opened from
100
        (i.e. the parent directory holding the .bzr directory).
3416.2.1 by Martin Pool
Add BzrDir._get_file_mode and _get_dir_mode
101
102
    Everything in the bzrdir should have the same file permissions.
4160.1.1 by Robert Collins
Add a BzrDir.pre_open hook for use by the smart server gaol.
103
104
    :cvar hooks: An instance of BzrDirHooks.
1534.4.39 by Robert Collins
Basic BzrDir support.
105
    """
106
1687.1.12 by Robert Collins
Hook in the full break-lock ui.
107
    def break_lock(self):
108
        """Invoke break_lock on the first object in the bzrdir.
109
110
        If there is a tree, the tree is opened and break_lock() called.
111
        Otherwise, branch is tried, and finally repository.
112
        """
1752.2.52 by Andrew Bennetts
Flesh out more Remote* methods needed to open and initialise remote branches/trees/repositories.
113
        # XXX: This seems more like a UI function than something that really
114
        # belongs in this class.
1687.1.12 by Robert Collins
Hook in the full break-lock ui.
115
        try:
116
            thing_to_unlock = self.open_workingtree()
117
        except (errors.NotLocalUrl, errors.NoWorkingTree):
118
            try:
119
                thing_to_unlock = self.open_branch()
120
            except errors.NotBranchError:
121
                try:
122
                    thing_to_unlock = self.open_repository()
123
                except errors.NoRepositoryPresent:
124
                    return
125
        thing_to_unlock.break_lock()
126
1534.5.16 by Robert Collins
Review feedback.
127
    def can_convert_format(self):
128
        """Return true if this bzrdir is one whose format we can convert from."""
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
129
        return True
130
1910.2.12 by Aaron Bentley
Implement knit repo format 2
131
    def check_conversion_target(self, target_format):
132
        target_repo_format = target_format.repository_format
133
        source_repo_format = self._format.repository_format
134
        source_repo_format.check_conversion_target(target_repo_format)
135
1596.2.1 by Robert Collins
Fix BzrDir.open_containing of unsupported branches.
136
    @staticmethod
2323.6.4 by Martin Pool
BzrDir._check_supported now also takes care of recommending upgrades, which
137
    def _check_supported(format, allow_unsupported,
138
        recommend_upgrade=True,
139
        basedir=None):
140
        """Give an error or warning on old formats.
141
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
142
        :param format: may be any kind of format - workingtree, branch,
2323.6.4 by Martin Pool
BzrDir._check_supported now also takes care of recommending upgrades, which
143
        or repository.
144
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
145
        :param allow_unsupported: If true, allow opening
146
        formats that are strongly deprecated, and which may
2323.6.4 by Martin Pool
BzrDir._check_supported now also takes care of recommending upgrades, which
147
        have limited functionality.
148
149
        :param recommend_upgrade: If true (default), warn
150
        the user through the ui object that they may wish
151
        to upgrade the object.
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
152
        """
2323.5.19 by Martin Pool
No upgrade recommendation on source when cloning
153
        # TODO: perhaps move this into a base Format class; it's not BzrDir
154
        # specific. mbp 20070323
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
155
        if not allow_unsupported and not format.is_supported():
1596.2.1 by Robert Collins
Fix BzrDir.open_containing of unsupported branches.
156
            # see open_downlevel to open legacy branches.
1740.5.6 by Martin Pool
Clean up many exception classes.
157
            raise errors.UnsupportedFormatError(format=format)
2323.6.4 by Martin Pool
BzrDir._check_supported now also takes care of recommending upgrades, which
158
        if recommend_upgrade \
159
            and getattr(format, 'upgrade_recommended', False):
160
            ui.ui_factory.recommend_upgrade(
161
                format.get_format_description(),
162
                basedir)
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
163
3242.3.24 by Aaron Bentley
Fix test failures
164
    def clone(self, url, revision_id=None, force_new_repo=False,
165
              preserve_stacking=False):
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
166
        """Clone this bzrdir and its contents to url verbatim.
167
3242.3.36 by Aaron Bentley
Updates from review comments
168
        :param url: The url create the clone at.  If url's last component does
169
            not exist, it will be created.
170
        :param revision_id: The tip revision-id to use for any branch or
171
            working tree.  If not None, then the clone operation may tune
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
172
            itself to download less data.
3242.3.36 by Aaron Bentley
Updates from review comments
173
        :param force_new_repo: Do not use a shared repository for the target
1534.6.6 by Robert Collins
Move find_repository to bzrdir, its not quite ideal there but its simpler and until someone chooses to vary the search by branch type its completely sufficient.
174
                               even if one is available.
3242.3.36 by Aaron Bentley
Updates from review comments
175
        :param preserve_stacking: When cloning a stacked branch, stack the
176
            new branch on top of the other branch's stacked-on branch.
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
177
        """
2475.3.1 by John Arbash Meinel
Fix bug #75721. Update the BzrDir api to add clone_on_transport()
178
        return self.clone_on_transport(get_transport(url),
179
                                       revision_id=revision_id,
3242.3.24 by Aaron Bentley
Fix test failures
180
                                       force_new_repo=force_new_repo,
181
                                       preserve_stacking=preserve_stacking)
2475.3.1 by John Arbash Meinel
Fix bug #75721. Update the BzrDir api to add clone_on_transport()
182
183
    def clone_on_transport(self, transport, revision_id=None,
4294.2.2 by Robert Collins
Move use_existing and create_prefix all the way down to clone_on_transport, reducing duplicate work.
184
        force_new_repo=False, preserve_stacking=False, stacked_on=None,
4294.2.6 by Robert Collins
Report errors back in the UI layer for push, to use the url the user gave us.
185
        create_prefix=False, use_existing_dir=True):
2475.3.1 by John Arbash Meinel
Fix bug #75721. Update the BzrDir api to add clone_on_transport()
186
        """Clone this bzrdir and its contents to transport verbatim.
187
3242.3.36 by Aaron Bentley
Updates from review comments
188
        :param transport: The transport for the location to produce the clone
189
            at.  If the target directory does not exist, it will be created.
190
        :param revision_id: The tip revision-id to use for any branch or
191
            working tree.  If not None, then the clone operation may tune
2475.3.1 by John Arbash Meinel
Fix bug #75721. Update the BzrDir api to add clone_on_transport()
192
            itself to download less data.
3242.3.35 by Aaron Bentley
Cleanups and documentation
193
        :param force_new_repo: Do not use a shared repository for the target,
2475.3.1 by John Arbash Meinel
Fix bug #75721. Update the BzrDir api to add clone_on_transport()
194
                               even if one is available.
3242.3.22 by Aaron Bentley
Make clone stacking optional
195
        :param preserve_stacking: When cloning a stacked branch, stack the
196
            new branch on top of the other branch's stacked-on branch.
4294.2.2 by Robert Collins
Move use_existing and create_prefix all the way down to clone_on_transport, reducing duplicate work.
197
        :param create_prefix: Create any missing directories leading up to
198
            to_transport.
199
        :param use_existing_dir: Use an existing directory if one exists.
2475.3.1 by John Arbash Meinel
Fix bug #75721. Update the BzrDir api to add clone_on_transport()
200
        """
4294.2.4 by Robert Collins
Move dir, bzrdir and repo acquisition into a single method on bzrdir format.
201
        # Overview: put together a broad description of what we want to end up
202
        # with; then make as few api calls as possible to do it.
203
        
204
        # We may want to create a repo/branch/tree, if we do so what format
205
        # would we want for each:
3650.5.1 by Aaron Bentley
Fix push to use clone all the time.
206
        require_stacking = (stacked_on is not None)
4017.2.1 by Robert Collins
Add BzrDirFormatMeta1 test for the amount of rpc calls made initializing over the network.
207
        format = self.cloning_metadir(require_stacking)
4294.2.4 by Robert Collins
Move dir, bzrdir and repo acquisition into a single method on bzrdir format.
208
        
209
        # Figure out what objects we want:
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
210
        try:
1534.6.6 by Robert Collins
Move find_repository to bzrdir, its not quite ideal there but its simpler and until someone chooses to vary the search by branch type its completely sufficient.
211
            local_repo = self.find_repository()
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
212
        except errors.NoRepositoryPresent:
1534.6.6 by Robert Collins
Move find_repository to bzrdir, its not quite ideal there but its simpler and until someone chooses to vary the search by branch type its completely sufficient.
213
            local_repo = None
3242.3.30 by Aaron Bentley
Handle adding fallback repositories in acquire_repository
214
        try:
215
            local_branch = self.open_branch()
216
        except errors.NotBranchError:
217
            local_branch = None
218
        else:
219
            # enable fallbacks when branch is not a branch reference
220
            if local_branch.repository.has_same_location(local_repo):
221
                local_repo = local_branch.repository
222
            if preserve_stacking:
223
                try:
3650.5.1 by Aaron Bentley
Fix push to use clone all the time.
224
                    stacked_on = local_branch.get_stacked_on_url()
3242.3.30 by Aaron Bentley
Handle adding fallback repositories in acquire_repository
225
                except (errors.UnstackableBranchFormat,
226
                        errors.UnstackableRepositoryFormat,
227
                        errors.NotStacked):
228
                    pass
4294.2.4 by Robert Collins
Move dir, bzrdir and repo acquisition into a single method on bzrdir format.
229
        # Bug: We create a metadir without knowing if it can support stacking,
230
        # we should look up the policy needs first, or just use it as a hint,
231
        # or something.
1534.6.6 by Robert Collins
Move find_repository to bzrdir, its not quite ideal there but its simpler and until someone chooses to vary the search by branch type its completely sufficient.
232
        if local_repo:
3242.2.14 by Aaron Bentley
Update from review comments
233
            make_working_trees = local_repo.make_working_trees()
4294.2.4 by Robert Collins
Move dir, bzrdir and repo acquisition into a single method on bzrdir format.
234
            want_shared = local_repo.is_shared()
235
            repo_format_name = format.repository_format.network_name()
236
        else:
237
            make_working_trees = False
238
            want_shared = False
239
            repo_format_name = None
240
241
        result_repo, result, require_stacking, repository_policy = \
242
            format.initialize_on_transport_ex(transport,
243
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
244
            force_new_repo=force_new_repo, stacked_on=stacked_on,
245
            stack_on_pwd=self.root_transport.base,
246
            repo_format_name=repo_format_name,
247
            make_working_trees=make_working_trees, shared_repo=want_shared)
248
        if repo_format_name:
249
            # If the result repository is in the same place as the resulting
250
            # bzr dir, it will have no content, further if the result is not stacked
251
            # then we know all content should be copied, and finally if we are
252
            # copying up to a specific revision_id then we can use the
253
            # pending-ancestry-result which does not require traversing all of
254
            # history to describe it.
255
            if (result_repo.bzrdir.root_transport.base ==
256
                result.root_transport.base and not require_stacking and
257
                revision_id is not None):
4070.9.14 by Andrew Bennetts
Tweaks requested by Robert's review.
258
                fetch_spec = graph.PendingAncestryResult(
259
                    [revision_id], local_repo)
4070.9.8 by Andrew Bennetts
Use MiniSearchResult in clone_on_transport down (further tightening the test_push ratchets), and improve acquire_repository docstrings.
260
                result_repo.fetch(local_repo, fetch_spec=fetch_spec)
261
            else:
262
                result_repo.fetch(local_repo, revision_id=revision_id)
3242.3.30 by Aaron Bentley
Handle adding fallback repositories in acquire_repository
263
        else:
264
            result_repo = None
1534.6.6 by Robert Collins
Move find_repository to bzrdir, its not quite ideal there but its simpler and until someone chooses to vary the search by branch type its completely sufficient.
265
        # 1 if there is a branch present
266
        #   make sure its content is available in the target repository
267
        #   clone it.
3242.3.37 by Aaron Bentley
Updates from reviews
268
        if local_branch is not None:
4050.1.1 by Robert Collins
Fix race condition with branch hooks during cloning when the new branch is stacked.
269
            result_branch = local_branch.clone(result, revision_id=revision_id,
270
                repository_policy=repository_policy)
4044.1.5 by Robert Collins
Stop trying to create working trees during clone when the target bzrdir cannot have a local abspath created for it.
271
        try:
272
            # Cheaper to check if the target is not local, than to try making
273
            # the tree and fail.
274
            result.root_transport.local_abspath('.')
275
            if result_repo is None or result_repo.make_working_trees():
2991.1.2 by Daniel Watkins
Working trees are no longer created by pushing into a local no-trees repo.
276
                self.open_workingtree().clone(result)
4044.1.5 by Robert Collins
Stop trying to create working trees during clone when the target bzrdir cannot have a local abspath created for it.
277
        except (errors.NoWorkingTree, errors.NotLocalUrl):
278
            pass
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
279
        return result
280
1685.1.61 by Martin Pool
[broken] Change BzrDir._make_tail to use urlutils.split
281
    # TODO: This should be given a Transport, and should chdir up; otherwise
282
    # this will open a new connection.
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
283
    def _make_tail(self, url):
2475.3.3 by John Arbash Meinel
Change calls to try/mkdir('.')/except FileExists to ensure_base()
284
        t = get_transport(url)
285
        t.ensure_base()
2475.3.1 by John Arbash Meinel
Fix bug #75721. Update the BzrDir api to add clone_on_transport()
286
1553.5.71 by Martin Pool
Change branch format 5 to use LockDirs, not transport locks
287
    @classmethod
2476.3.8 by Vincent Ladeuil
Mark transports that need to be instrumented or refactored to check
288
    def create(cls, base, format=None, possible_transports=None):
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
289
        """Create a new BzrDir at the url 'base'.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
290
2204.4.13 by Aaron Bentley
Update all test cases to avoid set_default_format
291
        :param format: If supplied, the format of branch to create.  If not
292
            supplied, the default is used.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
293
        :param possible_transports: If supplied, a list of transports that
2476.3.8 by Vincent Ladeuil
Mark transports that need to be instrumented or refactored to check
294
            can be reused to share a remote connection.
1534.4.39 by Robert Collins
Basic BzrDir support.
295
        """
1553.5.71 by Martin Pool
Change branch format 5 to use LockDirs, not transport locks
296
        if cls is not BzrDir:
2204.4.13 by Aaron Bentley
Update all test cases to avoid set_default_format
297
            raise AssertionError("BzrDir.create always creates the default"
298
                " format, not one of %r" % cls)
2476.3.8 by Vincent Ladeuil
Mark transports that need to be instrumented or refactored to check
299
        t = get_transport(base, possible_transports)
2475.3.3 by John Arbash Meinel
Change calls to try/mkdir('.')/except FileExists to ensure_base()
300
        t.ensure_base()
2204.4.13 by Aaron Bentley
Update all test cases to avoid set_default_format
301
        if format is None:
302
            format = BzrDirFormat.get_default_format()
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
303
        return format.initialize_on_transport(t)
1534.4.39 by Robert Collins
Basic BzrDir support.
304
3140.1.1 by Aaron Bentley
Implement find_bzrdir functionality
305
    @staticmethod
306
    def find_bzrdirs(transport, evaluate=None, list_current=None):
307
        """Find bzrdirs recursively from current location.
308
309
        This is intended primarily as a building block for more sophisticated
310
        functionality, like finding trees under a directory, or finding
311
        branches that use a given repository.
312
        :param evaluate: An optional callable that yields recurse, value,
313
            where recurse controls whether this bzrdir is recursed into
314
            and value is the value to yield.  By default, all bzrdirs
315
            are recursed into, and the return value is the bzrdir.
316
        :param list_current: if supplied, use this function to list the current
317
            directory, instead of Transport.list_dir
318
        :return: a generator of found bzrdirs, or whatever evaluate returns.
319
        """
320
        if list_current is None:
321
            def list_current(transport):
322
                return transport.list_dir('')
323
        if evaluate is None:
324
            def evaluate(bzrdir):
325
                return True, bzrdir
326
327
        pending = [transport]
328
        while len(pending) > 0:
329
            current_transport = pending.pop()
330
            recurse = True
331
            try:
332
                bzrdir = BzrDir.open_from_transport(current_transport)
333
            except errors.NotBranchError:
334
                pass
335
            else:
336
                recurse, value = evaluate(bzrdir)
337
                yield value
338
            try:
339
                subdirs = list_current(current_transport)
340
            except errors.NoSuchFile:
341
                continue
342
            if recurse:
343
                for subdir in sorted(subdirs, reverse=True):
344
                    pending.append(current_transport.clone(subdir))
345
3140.1.3 by Aaron Bentley
Add support for finding branches to BzrDir
346
    @staticmethod
347
    def find_branches(transport):
3140.1.7 by Aaron Bentley
Update docs
348
        """Find all branches under a transport.
349
350
        This will find all branches below the transport, including branches
351
        inside other branches.  Where possible, it will use
352
        Repository.find_branches.
353
354
        To list all the branches that use a particular Repository, see
355
        Repository.find_branches
356
        """
3140.1.3 by Aaron Bentley
Add support for finding branches to BzrDir
357
        def evaluate(bzrdir):
358
            try:
359
                repository = bzrdir.open_repository()
360
            except errors.NoRepositoryPresent:
361
                pass
362
            else:
363
                return False, (None, repository)
364
            try:
365
                branch = bzrdir.open_branch()
366
            except errors.NotBranchError:
367
                return True, (None, None)
368
            else:
369
                return True, (branch, None)
370
        branches = []
371
        for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
372
            if repo is not None:
373
                branches.extend(repo.find_branches())
374
            if branch is not None:
375
                branches.append(branch)
376
        return branches
377
2796.2.19 by Aaron Bentley
Support reconfigure --lightweight-checkout
378
    def destroy_repository(self):
379
        """Destroy the repository in this BzrDir"""
380
        raise NotImplementedError(self.destroy_repository)
381
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
382
    def create_branch(self):
383
        """Create a branch in this BzrDir.
384
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
385
        The bzrdir's format will control what branch format is created.
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
386
        For more control see BranchFormatXX.create(a_bzrdir).
387
        """
388
        raise NotImplementedError(self.create_branch)
389
2796.2.6 by Aaron Bentley
Implement destroy_branch
390
    def destroy_branch(self):
2796.2.16 by Aaron Bentley
Documentation updates from review
391
        """Destroy the branch in this BzrDir"""
2796.2.6 by Aaron Bentley
Implement destroy_branch
392
        raise NotImplementedError(self.destroy_branch)
393
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
394
    @staticmethod
2204.4.13 by Aaron Bentley
Update all test cases to avoid set_default_format
395
    def create_branch_and_repo(base, force_new_repo=False, format=None):
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
396
        """Create a new BzrDir, Branch and Repository at the url 'base'.
397
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
398
        This will use the current default BzrDirFormat unless one is
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
399
        specified, and use whatever
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
400
        repository format that that uses via bzrdir.create_branch and
1534.6.6 by Robert Collins
Move find_repository to bzrdir, its not quite ideal there but its simpler and until someone chooses to vary the search by branch type its completely sufficient.
401
        create_repository. If a shared repository is available that is used
402
        preferentially.
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
403
404
        The created Branch object is returned.
1534.6.6 by Robert Collins
Move find_repository to bzrdir, its not quite ideal there but its simpler and until someone chooses to vary the search by branch type its completely sufficient.
405
406
        :param base: The URL to create the branch at.
407
        :param force_new_repo: If True a new repository is always created.
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
408
        :param format: If supplied, the format of branch to create.  If not
409
            supplied, the default is used.
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
410
        """
2204.4.13 by Aaron Bentley
Update all test cases to avoid set_default_format
411
        bzrdir = BzrDir.create(base, format)
1534.6.11 by Robert Collins
Review feedback.
412
        bzrdir._find_or_create_repository(force_new_repo)
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
413
        return bzrdir.create_branch()
1534.6.11 by Robert Collins
Review feedback.
414
3242.3.32 by Aaron Bentley
Defer handling relative stacking URLs as late as possible.
415
    def determine_repository_policy(self, force_new_repo=False, stack_on=None,
3242.3.40 by Aaron Bentley
Turn failing test into KnownFailure
416
                                    stack_on_pwd=None, require_stacking=False):
3242.2.13 by Aaron Bentley
Update docs
417
        """Return an object representing a policy to use.
418
4165.2.1 by Robert Collins
Fix bzr failing to stack when a server requests it and the branch it is pushing from cannot stack but the branch it should stack on can.
419
        This controls whether a new repository is created, and the format of
420
        that repository, or some existing shared repository used instead.
3242.3.35 by Aaron Bentley
Cleanups and documentation
421
422
        If stack_on is supplied, will not seek a containing shared repo.
3575.2.2 by Martin Pool
branch --stacked should force a stacked format
423
3242.3.35 by Aaron Bentley
Cleanups and documentation
424
        :param force_new_repo: If True, require a new repository to be created.
425
        :param stack_on: If supplied, the location to stack on.  If not
426
            supplied, a default_stack_on location may be used.
427
        :param stack_on_pwd: If stack_on is relative, the location it is
428
            relative to.
3242.2.13 by Aaron Bentley
Update docs
429
        """
3242.3.3 by Aaron Bentley
Use _find_containing to determine repository policy
430
        def repository_policy(found_bzrdir):
3242.3.4 by Aaron Bentley
Initial determination of stacking policy
431
            stack_on = None
3242.3.32 by Aaron Bentley
Defer handling relative stacking URLs as late as possible.
432
            stack_on_pwd = None
3641.1.1 by John Arbash Meinel
Merge in 1.6rc5 and revert disabling default stack on policy
433
            config = found_bzrdir.get_config()
3242.3.4 by Aaron Bentley
Initial determination of stacking policy
434
            stop = False
4288.1.1 by Robert Collins
Add support for a RemoteBzrDirConfig to support optimising push operations which need to look for default stacking locations.
435
            stack_on = config.get_default_stack_on()
436
            if stack_on is not None:
437
                stack_on_pwd = found_bzrdir.root_transport.base
438
                stop = True
3242.3.3 by Aaron Bentley
Use _find_containing to determine repository policy
439
            # does it have a repository ?
440
            try:
441
                repository = found_bzrdir.open_repository()
442
            except errors.NoRepositoryPresent:
3242.3.4 by Aaron Bentley
Initial determination of stacking policy
443
                repository = None
444
            else:
445
                if ((found_bzrdir.root_transport.base !=
446
                     self.root_transport.base) and not repository.is_shared()):
4165.2.1 by Robert Collins
Fix bzr failing to stack when a server requests it and the branch it is pushing from cannot stack but the branch it should stack on can.
447
                    # Don't look higher, can't use a higher shared repo.
3242.3.4 by Aaron Bentley
Initial determination of stacking policy
448
                    repository = None
4165.2.1 by Robert Collins
Fix bzr failing to stack when a server requests it and the branch it is pushing from cannot stack but the branch it should stack on can.
449
                    stop = True
3242.3.4 by Aaron Bentley
Initial determination of stacking policy
450
                else:
451
                    stop = True
452
            if not stop:
3242.3.3 by Aaron Bentley
Use _find_containing to determine repository policy
453
                return None, False
3242.3.4 by Aaron Bentley
Initial determination of stacking policy
454
            if repository:
3242.3.32 by Aaron Bentley
Defer handling relative stacking URLs as late as possible.
455
                return UseExistingRepository(repository, stack_on,
3242.3.40 by Aaron Bentley
Turn failing test into KnownFailure
456
                    stack_on_pwd, require_stacking=require_stacking), True
3242.3.3 by Aaron Bentley
Use _find_containing to determine repository policy
457
            else:
3242.3.40 by Aaron Bentley
Turn failing test into KnownFailure
458
                return CreateRepository(self, stack_on, stack_on_pwd,
459
                    require_stacking=require_stacking), True
3242.3.3 by Aaron Bentley
Use _find_containing to determine repository policy
460
3242.2.1 by Aaron Bentley
Abstract policy decisions into determine_repository_policy
461
        if not force_new_repo:
3242.3.30 by Aaron Bentley
Handle adding fallback repositories in acquire_repository
462
            if stack_on is None:
463
                policy = self._find_containing(repository_policy)
464
                if policy is not None:
465
                    return policy
466
            else:
467
                try:
468
                    return UseExistingRepository(self.open_repository(),
3242.3.40 by Aaron Bentley
Turn failing test into KnownFailure
469
                        stack_on, stack_on_pwd,
470
                        require_stacking=require_stacking)
3242.3.30 by Aaron Bentley
Handle adding fallback repositories in acquire_repository
471
                except errors.NoRepositoryPresent:
472
                    pass
3242.3.40 by Aaron Bentley
Turn failing test into KnownFailure
473
        return CreateRepository(self, stack_on, stack_on_pwd,
474
                                require_stacking=require_stacking)
3242.2.1 by Aaron Bentley
Abstract policy decisions into determine_repository_policy
475
1534.6.11 by Robert Collins
Review feedback.
476
    def _find_or_create_repository(self, force_new_repo):
477
        """Create a new repository if needed, returning the repository."""
3242.2.10 by Aaron Bentley
Rename RepositoryPolicy.apply to acquire_repository
478
        policy = self.determine_repository_policy(force_new_repo)
4070.9.2 by Andrew Bennetts
Rough prototype of allowing a SearchResult to be passed to fetch, and using that to improve network conversations.
479
        return policy.acquire_repository()[0]
3242.2.10 by Aaron Bentley
Rename RepositoryPolicy.apply to acquire_repository
480
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
481
    @staticmethod
2476.3.6 by Vincent Ladeuil
Fix the 'init connects multiple times' in a different way.
482
    def create_branch_convenience(base, force_new_repo=False,
483
                                  force_new_tree=None, format=None,
2476.3.11 by Vincent Ladeuil
Cosmetic changes.
484
                                  possible_transports=None):
1534.6.10 by Robert Collins
Finish use of repositories support.
485
        """Create a new BzrDir, Branch and Repository at the url 'base'.
486
487
        This is a convenience function - it will use an existing repository
488
        if possible, can be told explicitly whether to create a working tree or
1534.6.12 by Robert Collins
Typo found by John Meinel.
489
        not.
1534.6.10 by Robert Collins
Finish use of repositories support.
490
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
491
        This will use the current default BzrDirFormat unless one is
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
492
        specified, and use whatever
1534.6.10 by Robert Collins
Finish use of repositories support.
493
        repository format that that uses via bzrdir.create_branch and
494
        create_repository. If a shared repository is available that is used
495
        preferentially. Whatever repository is used, its tree creation policy
496
        is followed.
497
498
        The created Branch object is returned.
499
        If a working tree cannot be made due to base not being a file:// url,
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
500
        no error is raised unless force_new_tree is True, in which case no
1563.1.6 by Robert Collins
Add tests for sftp push, and NonLocalTets for BzrDir.create_branch_convenience, before fixing the failure of it to work on non-local urls.
501
        data is created on disk and NotLocalUrl is raised.
1534.6.10 by Robert Collins
Finish use of repositories support.
502
503
        :param base: The URL to create the branch at.
504
        :param force_new_repo: If True a new repository is always created.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
505
        :param force_new_tree: If True or False force creation of a tree or
1534.6.10 by Robert Collins
Finish use of repositories support.
506
                               prevent such creation respectively.
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
507
        :param format: Override for the bzrdir format to create.
2476.3.8 by Vincent Ladeuil
Mark transports that need to be instrumented or refactored to check
508
        :param possible_transports: An optional reusable transports list.
1534.6.10 by Robert Collins
Finish use of repositories support.
509
        """
1563.1.6 by Robert Collins
Add tests for sftp push, and NonLocalTets for BzrDir.create_branch_convenience, before fixing the failure of it to work on non-local urls.
510
        if force_new_tree:
511
            # check for non local urls
2485.8.45 by Vincent Ladeuil
Take jam's remarks into account.
512
            t = get_transport(base, possible_transports)
3224.5.24 by Andrew Bennetts
More minor import tidying suggested by pyflakes.
513
            if not isinstance(t, local.LocalTransport):
2476.3.6 by Vincent Ladeuil
Fix the 'init connects multiple times' in a different way.
514
                raise errors.NotLocalUrl(base)
2476.3.8 by Vincent Ladeuil
Mark transports that need to be instrumented or refactored to check
515
        bzrdir = BzrDir.create(base, format, possible_transports)
1534.6.11 by Robert Collins
Review feedback.
516
        repo = bzrdir._find_or_create_repository(force_new_repo)
1534.6.10 by Robert Collins
Finish use of repositories support.
517
        result = bzrdir.create_branch()
2476.3.4 by Vincent Ladeuil
Add tests.
518
        if force_new_tree or (repo.make_working_trees() and
1534.6.10 by Robert Collins
Finish use of repositories support.
519
                              force_new_tree is None):
1563.1.6 by Robert Collins
Add tests for sftp push, and NonLocalTets for BzrDir.create_branch_convenience, before fixing the failure of it to work on non-local urls.
520
            try:
521
                bzrdir.create_workingtree()
522
            except errors.NotLocalUrl:
523
                pass
1534.6.10 by Robert Collins
Finish use of repositories support.
524
        return result
2476.3.4 by Vincent Ladeuil
Add tests.
525
1551.8.2 by Aaron Bentley
Add create_checkout_convenience
526
    @staticmethod
2204.4.13 by Aaron Bentley
Update all test cases to avoid set_default_format
527
    def create_standalone_workingtree(base, format=None):
1534.4.42 by Robert Collins
add working tree to the BzrDir facilities.
528
        """Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
529
530
        'base' must be a local path or a file:// url.
531
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
532
        This will use the current default BzrDirFormat unless one is
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
533
        specified, and use whatever
1534.4.42 by Robert Collins
add working tree to the BzrDir facilities.
534
        repository format that that uses for bzrdirformat.create_workingtree,
535
        create_branch and create_repository.
536
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
537
        :param format: Override for the bzrdir format to create.
1910.7.17 by Andrew Bennetts
Various cosmetic changes.
538
        :return: The WorkingTree object.
1534.4.42 by Robert Collins
add working tree to the BzrDir facilities.
539
        """
2485.8.45 by Vincent Ladeuil
Take jam's remarks into account.
540
        t = get_transport(base)
3224.5.24 by Andrew Bennetts
More minor import tidying suggested by pyflakes.
541
        if not isinstance(t, local.LocalTransport):
1534.4.42 by Robert Collins
add working tree to the BzrDir facilities.
542
            raise errors.NotLocalUrl(base)
2485.8.45 by Vincent Ladeuil
Take jam's remarks into account.
543
        bzrdir = BzrDir.create_branch_and_repo(base,
2204.4.13 by Aaron Bentley
Update all test cases to avoid set_default_format
544
                                               force_new_repo=True,
545
                                               format=format).bzrdir
1534.4.42 by Robert Collins
add working tree to the BzrDir facilities.
546
        return bzrdir.create_workingtree()
547
3123.5.17 by Aaron Bentley
Update docs
548
    def create_workingtree(self, revision_id=None, from_branch=None,
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
549
        accelerator_tree=None, hardlink=False):
1508.1.21 by Robert Collins
Implement -r limit for checkout command.
550
        """Create a working tree at this BzrDir.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
551
2955.5.3 by Vincent Ladeuil
Fix second unwanted connection by providing the right branch to create_checkout.
552
        :param revision_id: create it as of this revision id.
553
        :param from_branch: override bzrdir branch (for lightweight checkouts)
3123.5.17 by Aaron Bentley
Update docs
554
        :param accelerator_tree: A tree which can be used for retrieving file
555
            contents more quickly than the revision tree, i.e. a workingtree.
556
            The revision tree will be used for cases where accelerator_tree's
557
            content is different.
1508.1.21 by Robert Collins
Implement -r limit for checkout command.
558
        """
1534.4.42 by Robert Collins
add working tree to the BzrDir facilities.
559
        raise NotImplementedError(self.create_workingtree)
560
3872.3.2 by Jelmer Vernooij
make backup_bzrdir determine the name for the backup files.
561
    def backup_bzrdir(self):
3872.3.1 by Jelmer Vernooij
Allow BzrDir implementation to implement backing up of control directory.
562
        """Backup this bzr control directory.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
563
3872.3.2 by Jelmer Vernooij
make backup_bzrdir determine the name for the backup files.
564
        :return: Tuple with old path name and new path name
3872.3.1 by Jelmer Vernooij
Allow BzrDir implementation to implement backing up of control directory.
565
        """
3943.2.4 by Martin Pool
Move backup progress indicators from upgrade.py into backup_bzrdir, and tweak text
566
        pb = ui.ui_factory.nested_progress_bar()
567
        try:
568
            # FIXME: bug 300001 -- the backup fails if the backup directory
569
            # already exists, but it should instead either remove it or make
570
            # a new backup directory.
571
            #
4032.1.2 by John Arbash Meinel
Track down a few more files that have trailing whitespace.
572
            # FIXME: bug 262450 -- the backup directory should have the same
3943.2.4 by Martin Pool
Move backup progress indicators from upgrade.py into backup_bzrdir, and tweak text
573
            # permissions as the .bzr directory (probably a bug in copy_tree)
574
            old_path = self.root_transport.abspath('.bzr')
575
            new_path = self.root_transport.abspath('backup.bzr')
576
            pb.note('making backup of %s' % (old_path,))
577
            pb.note('  to %s' % (new_path,))
578
            self.root_transport.copy_tree('.bzr', 'backup.bzr')
579
            return (old_path, new_path)
580
        finally:
581
            pb.finished()
3872.3.1 by Jelmer Vernooij
Allow BzrDir implementation to implement backing up of control directory.
582
2830.1.2 by Ian Clatworthy
Incorporate feedback from poolie's review
583
    def retire_bzrdir(self, limit=10000):
2255.14.1 by Martin Pool
Add BzrDir.retire_bzrdir and partly fix subsume
584
        """Permanently disable the bzrdir.
585
586
        This is done by renaming it to give the user some ability to recover
587
        if there was a problem.
588
589
        This will have horrible consequences if anyone has anything locked or
590
        in use.
2830.1.2 by Ian Clatworthy
Incorporate feedback from poolie's review
591
        :param limit: number of times to retry
2255.14.1 by Martin Pool
Add BzrDir.retire_bzrdir and partly fix subsume
592
        """
2830.1.2 by Ian Clatworthy
Incorporate feedback from poolie's review
593
        i  = 0
594
        while True:
2255.14.1 by Martin Pool
Add BzrDir.retire_bzrdir and partly fix subsume
595
            try:
596
                to_path = '.bzr.retired.%d' % i
597
                self.root_transport.rename('.bzr', to_path)
598
                note("renamed %s to %s"
599
                    % (self.root_transport.abspath('.bzr'), to_path))
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
600
                return
2255.14.1 by Martin Pool
Add BzrDir.retire_bzrdir and partly fix subsume
601
            except (errors.TransportError, IOError, errors.PathError):
2830.1.2 by Ian Clatworthy
Incorporate feedback from poolie's review
602
                i += 1
603
                if i > limit:
604
                    raise
605
                else:
606
                    pass
2255.14.1 by Martin Pool
Add BzrDir.retire_bzrdir and partly fix subsume
607
1551.8.37 by Aaron Bentley
Cleaner implementation of destroy_working_tree
608
    def destroy_workingtree(self):
1551.8.36 by Aaron Bentley
Introduce BzrDir.destroy_workingtree
609
        """Destroy the working tree at this BzrDir.
610
611
        Formats that do not support this may raise UnsupportedOperation.
612
        """
613
        raise NotImplementedError(self.destroy_workingtree)
614
1551.8.37 by Aaron Bentley
Cleaner implementation of destroy_working_tree
615
    def destroy_workingtree_metadata(self):
616
        """Destroy the control files for the working tree at this BzrDir.
617
618
        The contents of working tree files are not affected.
619
        Formats that do not support this may raise UnsupportedOperation.
620
        """
621
        raise NotImplementedError(self.destroy_workingtree_metadata)
622
3242.3.2 by Aaron Bentley
Split _find_containing out of find_repository
623
    def _find_containing(self, evaluate):
3242.2.13 by Aaron Bentley
Update docs
624
        """Find something in a containing control directory.
625
626
        This method will scan containing control dirs, until it finds what
627
        it is looking for, decides that it will never find it, or runs out
628
        of containing control directories to check.
629
630
        It is used to implement find_repository and
631
        determine_repository_policy.
632
633
        :param evaluate: A function returning (value, stop).  If stop is True,
634
            the value will be returned.
635
        """
3242.3.2 by Aaron Bentley
Split _find_containing out of find_repository
636
        found_bzrdir = self
637
        while True:
638
            result, stop = evaluate(found_bzrdir)
639
            if stop:
640
                return result
641
            next_transport = found_bzrdir.root_transport.clone('..')
642
            if (found_bzrdir.root_transport.base == next_transport.base):
643
                # top of the file system
644
                return None
645
            # find the next containing bzrdir
646
            try:
647
                found_bzrdir = BzrDir.open_containing_from_transport(
648
                    next_transport)[0]
649
            except errors.NotBranchError:
650
                return None
651
1534.6.6 by Robert Collins
Move find_repository to bzrdir, its not quite ideal there but its simpler and until someone chooses to vary the search by branch type its completely sufficient.
652
    def find_repository(self):
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
653
        """Find the repository that should be used.
1534.6.6 by Robert Collins
Move find_repository to bzrdir, its not quite ideal there but its simpler and until someone chooses to vary the search by branch type its completely sufficient.
654
655
        This does not require a branch as we use it to find the repo for
656
        new branches as well as to hook existing branches up to their
657
        repository.
658
        """
3242.3.2 by Aaron Bentley
Split _find_containing out of find_repository
659
        def usable_repository(found_bzrdir):
1725.2.5 by Robert Collins
Bugfix create_branch_convenience at the root of a file system to not loop
660
            # does it have a repository ?
1534.6.6 by Robert Collins
Move find_repository to bzrdir, its not quite ideal there but its simpler and until someone chooses to vary the search by branch type its completely sufficient.
661
            try:
662
                repository = found_bzrdir.open_repository()
663
            except errors.NoRepositoryPresent:
3242.3.2 by Aaron Bentley
Split _find_containing out of find_repository
664
                return None, False
3242.2.5 by Aaron Bentley
Avoid unnecessary is_shared check
665
            if found_bzrdir.root_transport.base == self.root_transport.base:
666
                return repository, True
667
            elif repository.is_shared():
3242.3.2 by Aaron Bentley
Split _find_containing out of find_repository
668
                return repository, True
1534.6.6 by Robert Collins
Move find_repository to bzrdir, its not quite ideal there but its simpler and until someone chooses to vary the search by branch type its completely sufficient.
669
            else:
3242.2.5 by Aaron Bentley
Avoid unnecessary is_shared check
670
                return None, True
3242.3.2 by Aaron Bentley
Split _find_containing out of find_repository
671
672
        found_repo = self._find_containing(usable_repository)
673
        if found_repo is None:
674
            raise errors.NoRepositoryPresent(self)
675
        return found_repo
1534.6.6 by Robert Collins
Move find_repository to bzrdir, its not quite ideal there but its simpler and until someone chooses to vary the search by branch type its completely sufficient.
676
2414.2.1 by Andrew Bennetts
Some miscellaneous new APIs, tests and other changes from the hpss branch.
677
    def get_branch_reference(self):
678
        """Return the referenced URL for the branch in this bzrdir.
679
680
        :raises NotBranchError: If there is no Branch.
681
        :return: The URL the branch in this bzrdir references if it is a
682
            reference branch, or None for regular branches.
683
        """
684
        return None
685
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
686
    def get_branch_transport(self, branch_format):
687
        """Get the transport for use by branch format in this BzrDir.
688
689
        Note that bzr dirs that do not support format strings will raise
690
        IncompatibleFormat if the branch format they are given has
1759.2.1 by Jelmer Vernooij
Fix some types (found using aspell).
691
        a format string, and vice versa.
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
692
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
693
        If branch_format is None, the transport is returned with no
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
694
        checking. If it is not None, then the returned transport is
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
695
        guaranteed to point to an existing directory ready for use.
696
        """
697
        raise NotImplementedError(self.get_branch_transport)
3416.2.1 by Martin Pool
Add BzrDir._get_file_mode and _get_dir_mode
698
699
    def _find_creation_modes(self):
700
        """Determine the appropriate modes for files and directories.
3641.2.1 by John Arbash Meinel
Fix bug #259855, if a Transport returns 0 for permission bits, ignore it
701
3416.2.1 by Martin Pool
Add BzrDir._get_file_mode and _get_dir_mode
702
        They're always set to be consistent with the base directory,
703
        assuming that this transport allows setting modes.
704
        """
705
        # TODO: Do we need or want an option (maybe a config setting) to turn
706
        # this off or override it for particular locations? -- mbp 20080512
707
        if self._mode_check_done:
708
            return
709
        self._mode_check_done = True
710
        try:
711
            st = self.transport.stat('.')
712
        except errors.TransportNotPossible:
713
            self._dir_mode = None
714
            self._file_mode = None
715
        else:
716
            # Check the directory mode, but also make sure the created
717
            # directories and files are read-write for this user. This is
718
            # mostly a workaround for filesystems which lie about being able to
719
            # write to a directory (cygwin & win32)
3641.2.1 by John Arbash Meinel
Fix bug #259855, if a Transport returns 0 for permission bits, ignore it
720
            if (st.st_mode & 07777 == 00000):
721
                # FTP allows stat but does not return dir/file modes
722
                self._dir_mode = None
723
                self._file_mode = None
724
            else:
725
                self._dir_mode = (st.st_mode & 07777) | 00700
726
                # Remove the sticky and execute bits for files
727
                self._file_mode = self._dir_mode & ~07111
3416.2.1 by Martin Pool
Add BzrDir._get_file_mode and _get_dir_mode
728
729
    def _get_file_mode(self):
730
        """Return Unix mode for newly created files, or None.
731
        """
732
        if not self._mode_check_done:
733
            self._find_creation_modes()
734
        return self._file_mode
735
736
    def _get_dir_mode(self):
737
        """Return Unix mode for newly created directories, or None.
738
        """
739
        if not self._mode_check_done:
740
            self._find_creation_modes()
741
        return self._dir_mode
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
742
1534.4.47 by Robert Collins
Split out repository into .bzr/repository
743
    def get_repository_transport(self, repository_format):
744
        """Get the transport for use by repository format in this BzrDir.
745
746
        Note that bzr dirs that do not support format strings will raise
747
        IncompatibleFormat if the repository format they are given has
1759.2.1 by Jelmer Vernooij
Fix some types (found using aspell).
748
        a format string, and vice versa.
1534.4.47 by Robert Collins
Split out repository into .bzr/repository
749
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
750
        If repository_format is None, the transport is returned with no
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
751
        checking. If it is not None, then the returned transport is
1534.4.47 by Robert Collins
Split out repository into .bzr/repository
752
        guaranteed to point to an existing directory ready for use.
753
        """
754
        raise NotImplementedError(self.get_repository_transport)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
755
1534.4.53 by Robert Collins
Review feedback from John Meinel.
756
    def get_workingtree_transport(self, tree_format):
1534.4.45 by Robert Collins
Start WorkingTree -> .bzr/checkout transition
757
        """Get the transport for use by workingtree format in this BzrDir.
758
759
        Note that bzr dirs that do not support format strings will raise
2100.3.11 by Aaron Bentley
Add join --reference support
760
        IncompatibleFormat if the workingtree format they are given has a
761
        format string, and vice versa.
1534.4.45 by Robert Collins
Start WorkingTree -> .bzr/checkout transition
762
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
763
        If workingtree_format is None, the transport is returned with no
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
764
        checking. If it is not None, then the returned transport is
1534.4.45 by Robert Collins
Start WorkingTree -> .bzr/checkout transition
765
        guaranteed to point to an existing directory ready for use.
766
        """
767
        raise NotImplementedError(self.get_workingtree_transport)
3242.1.1 by Aaron Bentley
Implement BzrDir configuration
768
769
    def get_config(self):
4288.1.1 by Robert Collins
Add support for a RemoteBzrDirConfig to support optimising push operations which need to look for default stacking locations.
770
        """Get configuration for this BzrDir."""
771
        return config.BzrDirConfig(self)
772
773
    def _get_config(self):
774
        """By default, no configuration is available."""
775
        return None
3242.1.1 by Aaron Bentley
Implement BzrDir configuration
776
1534.4.39 by Robert Collins
Basic BzrDir support.
777
    def __init__(self, _transport, _format):
778
        """Initialize a Bzr control dir object.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
779
1534.4.39 by Robert Collins
Basic BzrDir support.
780
        Only really common logic should reside here, concrete classes should be
781
        made with varying behaviours.
782
1534.4.53 by Robert Collins
Review feedback from John Meinel.
783
        :param _format: the format that is creating this BzrDir instance.
784
        :param _transport: the transport this dir is based at.
1534.4.39 by Robert Collins
Basic BzrDir support.
785
        """
786
        self._format = _format
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
787
        self.transport = _transport.clone('.bzr')
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
788
        self.root_transport = _transport
3416.2.1 by Martin Pool
Add BzrDir._get_file_mode and _get_dir_mode
789
        self._mode_check_done = False
1534.4.39 by Robert Collins
Basic BzrDir support.
790
1713.1.9 by Robert Collins
Paired performance tuning of bzr add. (Robert Collins, Martin Pool).
791
    def is_control_filename(self, filename):
792
        """True if filename is the name of a path which is reserved for bzrdir's.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
793
1713.1.9 by Robert Collins
Paired performance tuning of bzr add. (Robert Collins, Martin Pool).
794
        :param filename: A filename within the root transport of this bzrdir.
795
796
        This is true IF and ONLY IF the filename is part of the namespace reserved
797
        for bzr control dirs. Currently this is the '.bzr' directory in the root
798
        of the root_transport. it is expected that plugins will need to extend
799
        this in the future - for instance to make bzr talk with svn working
800
        trees.
801
        """
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
802
        # this might be better on the BzrDirFormat class because it refers to
803
        # all the possible bzrdir disk formats.
804
        # This method is tested via the workingtree is_control_filename tests-
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
805
        # it was extracted from WorkingTree.is_control_filename. If the method's
806
        # contract is extended beyond the current trivial implementation, please
1713.1.9 by Robert Collins
Paired performance tuning of bzr add. (Robert Collins, Martin Pool).
807
        # add new tests for it to the appropriate place.
808
        return filename == '.bzr' or filename.startswith('.bzr/')
809
1534.5.16 by Robert Collins
Review feedback.
810
    def needs_format_conversion(self, format=None):
811
        """Return true if this bzrdir needs convert_format run on it.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
812
813
        For instance, if the repository format is out of date but the
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
814
        branch and working tree are not, this should return True.
1534.5.13 by Robert Collins
Correct buggy test.
815
816
        :param format: Optional parameter indicating a specific desired
1534.5.16 by Robert Collins
Review feedback.
817
                       format we plan to arrive at.
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
818
        """
1556.1.4 by Robert Collins
Add a new format for what will become knit, and the surrounding logic to upgrade repositories within metadirs, and tests for the same.
819
        raise NotImplementedError(self.needs_format_conversion)
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
820
1534.4.39 by Robert Collins
Basic BzrDir support.
821
    @staticmethod
822
    def open_unsupported(base):
823
        """Open a branch which is not supported."""
824
        return BzrDir.open(base, _unsupported=True)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
825
1534.4.39 by Robert Collins
Basic BzrDir support.
826
    @staticmethod
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
827
    def open(base, _unsupported=False, possible_transports=None):
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
828
        """Open an existing bzrdir, rooted at 'base' (url).
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
829
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
830
        :param _unsupported: a private parameter to the BzrDir class.
1534.4.39 by Robert Collins
Basic BzrDir support.
831
        """
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
832
        t = get_transport(base, possible_transports=possible_transports)
1910.11.1 by Andrew Bennetts
Add BzrDir.open_from_transport, refactored from duplicate code, no explicit tests.
833
        return BzrDir.open_from_transport(t, _unsupported=_unsupported)
834
835
    @staticmethod
2018.5.169 by Andrew Bennetts
Add a _server_formats flag to BzrDir.open_from_transport and BzrDirFormat.find_format, make RemoteBranch.control_files into a property.
836
    def open_from_transport(transport, _unsupported=False,
837
                            _server_formats=True):
1910.11.1 by Andrew Bennetts
Add BzrDir.open_from_transport, refactored from duplicate code, no explicit tests.
838
        """Open a bzrdir within a particular directory.
839
840
        :param transport: Transport containing the bzrdir.
841
        :param _unsupported: private.
842
        """
4160.1.1 by Robert Collins
Add a BzrDir.pre_open hook for use by the smart server gaol.
843
        for hook in BzrDir.hooks['pre_open']:
844
            hook(transport)
3878.4.1 by Vincent Ladeuil
Fix bug #245964 by preserving decorators during redirections (when
845
        # Keep initial base since 'transport' may be modified while following
846
        # the redirections.
2164.2.21 by Vincent Ladeuil
Take bundles into account.
847
        base = transport.base
848
        def find_format(transport):
2018.5.169 by Andrew Bennetts
Add a _server_formats flag to BzrDir.open_from_transport and BzrDirFormat.find_format, make RemoteBranch.control_files into a property.
849
            return transport, BzrDirFormat.find_format(
850
                transport, _server_formats=_server_formats)
2164.2.21 by Vincent Ladeuil
Take bundles into account.
851
852
        def redirected(transport, e, redirection_notice):
3878.4.5 by Vincent Ladeuil
Don't use the exception as a parameter for _redirected_to.
853
            redirected_transport = transport._redirected_to(e.source, e.target)
3878.4.1 by Vincent Ladeuil
Fix bug #245964 by preserving decorators during redirections (when
854
            if redirected_transport is None:
855
                raise errors.NotBranchError(base)
2164.2.21 by Vincent Ladeuil
Take bundles into account.
856
            note('%s is%s redirected to %s',
3878.4.1 by Vincent Ladeuil
Fix bug #245964 by preserving decorators during redirections (when
857
                 transport.base, e.permanently, redirected_transport.base)
858
            return redirected_transport
2164.2.21 by Vincent Ladeuil
Take bundles into account.
859
2164.2.22 by Vincent Ladeuil
Take Aaron's review comments into account.
860
        try:
2164.2.28 by Vincent Ladeuil
TestingHTTPServer.test_case_server renamed from test_case to avoid confusions.
861
            transport, format = do_catching_redirections(find_format,
862
                                                         transport,
2164.2.22 by Vincent Ladeuil
Take Aaron's review comments into account.
863
                                                         redirected)
864
        except errors.TooManyRedirections:
865
            raise errors.NotBranchError(base)
2164.2.21 by Vincent Ladeuil
Take bundles into account.
866
1596.2.1 by Robert Collins
Fix BzrDir.open_containing of unsupported branches.
867
        BzrDir._check_supported(format, _unsupported)
1910.11.1 by Andrew Bennetts
Add BzrDir.open_from_transport, refactored from duplicate code, no explicit tests.
868
        return format.open(transport, _found=True)
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
869
4160.2.6 by Andrew Bennetts
Add ignore_fallbacks flag.
870
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
871
        """Open the branch object at this BzrDir if one is present.
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
872
873
        If unsupported is True, then no longer supported branch formats can
874
        still be opened.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
875
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
876
        TODO: static convenience version of this?
877
        """
878
        raise NotImplementedError(self.open_branch)
1534.4.39 by Robert Collins
Basic BzrDir support.
879
880
    @staticmethod
2485.8.37 by Vincent Ladeuil
Fix merge multiple connections. Test suite *not* passing (sftp
881
    def open_containing(url, possible_transports=None):
1534.4.39 by Robert Collins
Basic BzrDir support.
882
        """Open an existing branch which contains url.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
883
1534.6.3 by Robert Collins
find_repository sufficiently robust.
884
        :param url: url to search from.
1534.6.11 by Robert Collins
Review feedback.
885
        See open_containing_from_transport for more detail.
1534.6.3 by Robert Collins
find_repository sufficiently robust.
886
        """
2485.8.37 by Vincent Ladeuil
Fix merge multiple connections. Test suite *not* passing (sftp
887
        transport = get_transport(url, possible_transports)
888
        return BzrDir.open_containing_from_transport(transport)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
889
1534.6.3 by Robert Collins
find_repository sufficiently robust.
890
    @staticmethod
1534.6.11 by Robert Collins
Review feedback.
891
    def open_containing_from_transport(a_transport):
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
892
        """Open an existing branch which contains a_transport.base.
1534.6.3 by Robert Collins
find_repository sufficiently robust.
893
894
        This probes for a branch at a_transport, and searches upwards from there.
1534.4.39 by Robert Collins
Basic BzrDir support.
895
896
        Basically we keep looking up until we find the control directory or
897
        run into the root.  If there isn't one, raises NotBranchError.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
898
        If there is one and it is either an unrecognised format or an unsupported
1534.4.39 by Robert Collins
Basic BzrDir support.
899
        format, UnknownFormatError or UnsupportedFormatError are raised.
900
        If there is one, it is returned, along with the unused portion of url.
1685.1.27 by John Arbash Meinel
BzrDir works in URLs, but WorkingTree works in unicode paths
901
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
902
        :return: The BzrDir that contains the path, and a Unicode path
1685.1.28 by John Arbash Meinel
Changing open_containing to always return a unicode path.
903
                for the rest of the URL.
1534.4.39 by Robert Collins
Basic BzrDir support.
904
        """
905
        # this gets the normalised url back. I.e. '.' -> the full path.
1534.6.3 by Robert Collins
find_repository sufficiently robust.
906
        url = a_transport.base
1534.4.39 by Robert Collins
Basic BzrDir support.
907
        while True:
908
            try:
1910.11.1 by Andrew Bennetts
Add BzrDir.open_from_transport, refactored from duplicate code, no explicit tests.
909
                result = BzrDir.open_from_transport(a_transport)
910
                return result, urlutils.unescape(a_transport.relpath(url))
1534.4.39 by Robert Collins
Basic BzrDir support.
911
            except errors.NotBranchError, e:
1685.1.60 by Martin Pool
[broken] NotBranchError should unescape the url if possible
912
                pass
2018.14.1 by Andrew Bennetts
Update to current hpss branch? Fix lots of test failures.
913
            try:
914
                new_t = a_transport.clone('..')
915
            except errors.InvalidURLJoin:
916
                # reached the root, whatever that may be
917
                raise errors.NotBranchError(path=url)
1534.6.3 by Robert Collins
find_repository sufficiently robust.
918
            if new_t.base == a_transport.base:
1534.4.39 by Robert Collins
Basic BzrDir support.
919
                # reached the root, whatever that may be
920
                raise errors.NotBranchError(path=url)
1534.6.3 by Robert Collins
find_repository sufficiently robust.
921
            a_transport = new_t
1534.4.39 by Robert Collins
Basic BzrDir support.
922
3123.5.11 by Aaron Bentley
Accelerate branching from a lightweight checkout
923
    def _get_tree_branch(self):
924
        """Return the branch and tree, if any, for this bzrdir.
925
3211.4.1 by Robert Collins
* ``RemoteBzrDir._get_tree_branch`` no longer triggers ``_ensure_real``,
926
        Return None for tree if not present or inaccessible.
3123.5.11 by Aaron Bentley
Accelerate branching from a lightweight checkout
927
        Raise NotBranchError if no branch is present.
928
        :return: (tree, branch)
929
        """
930
        try:
931
            tree = self.open_workingtree()
932
        except (errors.NoWorkingTree, errors.NotLocalUrl):
933
            tree = None
934
            branch = self.open_branch()
935
        else:
936
            branch = tree.branch
937
        return tree, branch
938
939
    @classmethod
940
    def open_tree_or_branch(klass, location):
941
        """Return the branch and working tree at a location.
942
943
        If there is no tree at the location, tree will be None.
944
        If there is no branch at the location, an exception will be
945
        raised
946
        :return: (tree, branch)
947
        """
948
        bzrdir = klass.open(location)
949
        return bzrdir._get_tree_branch()
950
2215.3.2 by Aaron Bentley
Add open_containing_tree_or_branch
951
    @classmethod
952
    def open_containing_tree_or_branch(klass, location):
953
        """Return the branch and working tree contained by a location.
954
955
        Returns (tree, branch, relpath).
956
        If there is no tree at containing the location, tree will be None.
957
        If there is no branch containing the location, an exception will be
958
        raised
959
        relpath is the portion of the path that is contained by the branch.
960
        """
961
        bzrdir, relpath = klass.open_containing(location)
3123.5.11 by Aaron Bentley
Accelerate branching from a lightweight checkout
962
        tree, branch = bzrdir._get_tree_branch()
2215.3.2 by Aaron Bentley
Add open_containing_tree_or_branch
963
        return tree, branch, relpath
964
3015.3.39 by Daniel Watkins
Added classmethod bzrlib.bzrdir.BzrDir.open_containing_tree_branch_or_repository.
965
    @classmethod
966
    def open_containing_tree_branch_or_repository(klass, location):
3015.3.57 by Daniel Watkins
Made changes to BzrDir.open_containing_tree_branch_or_repository suggested on list.
967
        """Return the working tree, branch and repo contained by a location.
3015.3.39 by Daniel Watkins
Added classmethod bzrlib.bzrdir.BzrDir.open_containing_tree_branch_or_repository.
968
3015.3.57 by Daniel Watkins
Made changes to BzrDir.open_containing_tree_branch_or_repository suggested on list.
969
        Returns (tree, branch, repository, relpath).
3015.3.39 by Daniel Watkins
Added classmethod bzrlib.bzrdir.BzrDir.open_containing_tree_branch_or_repository.
970
        If there is no tree containing the location, tree will be None.
971
        If there is no branch containing the location, branch will be None.
972
        If there is no repository containing the location, repository will be
973
        None.
3015.3.57 by Daniel Watkins
Made changes to BzrDir.open_containing_tree_branch_or_repository suggested on list.
974
        relpath is the portion of the path that is contained by the innermost
975
        BzrDir.
3015.3.39 by Daniel Watkins
Added classmethod bzrlib.bzrdir.BzrDir.open_containing_tree_branch_or_repository.
976
3015.3.59 by Daniel Watkins
Further tweaks as requested on-list.
977
        If no tree, branch or repository is found, a NotBranchError is raised.
3015.3.39 by Daniel Watkins
Added classmethod bzrlib.bzrdir.BzrDir.open_containing_tree_branch_or_repository.
978
        """
3015.3.57 by Daniel Watkins
Made changes to BzrDir.open_containing_tree_branch_or_repository suggested on list.
979
        bzrdir, relpath = klass.open_containing(location)
3015.3.39 by Daniel Watkins
Added classmethod bzrlib.bzrdir.BzrDir.open_containing_tree_branch_or_repository.
980
        try:
3015.3.51 by Daniel Watkins
Modified open_containing_tree_branch_or_repository as per Aaron's suggestion.
981
            tree, branch = bzrdir._get_tree_branch()
3015.3.39 by Daniel Watkins
Added classmethod bzrlib.bzrdir.BzrDir.open_containing_tree_branch_or_repository.
982
        except errors.NotBranchError:
983
            try:
3015.3.59 by Daniel Watkins
Further tweaks as requested on-list.
984
                repo = bzrdir.find_repository()
3015.3.57 by Daniel Watkins
Made changes to BzrDir.open_containing_tree_branch_or_repository suggested on list.
985
                return None, None, repo, relpath
986
            except (errors.NoRepositoryPresent):
987
                raise errors.NotBranchError(location)
988
        return tree, branch, branch.repository, relpath
3015.3.39 by Daniel Watkins
Added classmethod bzrlib.bzrdir.BzrDir.open_containing_tree_branch_or_repository.
989
1534.4.47 by Robert Collins
Split out repository into .bzr/repository
990
    def open_repository(self, _unsupported=False):
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
991
        """Open the repository object at this BzrDir if one is present.
1534.4.47 by Robert Collins
Split out repository into .bzr/repository
992
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
993
        This will not follow the Branch object pointer - it's strictly a direct
1534.4.47 by Robert Collins
Split out repository into .bzr/repository
994
        open facility. Most client code should use open_branch().repository to
995
        get at a repository.
996
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
997
        :param _unsupported: a private parameter, not part of the api.
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
998
        TODO: static convenience version of this?
999
        """
1000
        raise NotImplementedError(self.open_repository)
1001
2400.2.2 by Robert Collins
Document BzrDir.open_workingtree's new recommend_upgrade parameter.
1002
    def open_workingtree(self, _unsupported=False,
2955.5.3 by Vincent Ladeuil
Fix second unwanted connection by providing the right branch to create_checkout.
1003
                         recommend_upgrade=True, from_branch=None):
1534.4.42 by Robert Collins
add working tree to the BzrDir facilities.
1004
        """Open the workingtree object at this BzrDir if one is present.
2400.2.2 by Robert Collins
Document BzrDir.open_workingtree's new recommend_upgrade parameter.
1005
1006
        :param recommend_upgrade: Optional keyword parameter, when True (the
1007
            default), emit through the ui module a recommendation that the user
1008
            upgrade the working tree when the workingtree being opened is old
1009
            (but still fully supported).
2955.5.3 by Vincent Ladeuil
Fix second unwanted connection by providing the right branch to create_checkout.
1010
        :param from_branch: override bzrdir branch (for lightweight checkouts)
1534.4.42 by Robert Collins
add working tree to the BzrDir facilities.
1011
        """
1012
        raise NotImplementedError(self.open_workingtree)
1013
1662.1.19 by Martin Pool
Better error message when initting existing tree
1014
    def has_branch(self):
1015
        """Tell if this bzrdir contains a branch.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1016
1662.1.19 by Martin Pool
Better error message when initting existing tree
1017
        Note: if you're going to open the branch, you should just go ahead
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1018
        and try, and not ask permission first.  (This method just opens the
1019
        branch and discards it, and that's somewhat expensive.)
1662.1.19 by Martin Pool
Better error message when initting existing tree
1020
        """
1021
        try:
1022
            self.open_branch()
1023
            return True
1024
        except errors.NotBranchError:
1025
            return False
1026
1027
    def has_workingtree(self):
1028
        """Tell if this bzrdir contains a working tree.
1029
1030
        This will still raise an exception if the bzrdir has a workingtree that
1031
        is remote & inaccessible.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1032
1662.1.19 by Martin Pool
Better error message when initting existing tree
1033
        Note: if you're going to open the working tree, you should just go ahead
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1034
        and try, and not ask permission first.  (This method just opens the
1035
        workingtree and discards it, and that's somewhat expensive.)
1662.1.19 by Martin Pool
Better error message when initting existing tree
1036
        """
1037
        try:
2323.6.4 by Martin Pool
BzrDir._check_supported now also takes care of recommending upgrades, which
1038
            self.open_workingtree(recommend_upgrade=False)
1662.1.19 by Martin Pool
Better error message when initting existing tree
1039
            return True
1040
        except errors.NoWorkingTree:
1041
            return False
1042
2018.5.96 by Andrew Bennetts
Merge from bzr.dev, resolving the worst of the semantic conflicts, but there's
1043
    def _cloning_metadir(self):
3575.2.2 by Martin Pool
branch --stacked should force a stacked format
1044
        """Produce a metadir suitable for cloning with.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1045
3575.2.2 by Martin Pool
branch --stacked should force a stacked format
1046
        :returns: (destination_bzrdir_format, source_repository)
1047
        """
2387.1.1 by Robert Collins
Remove the --basis parameter to clone etc. (Robert Collins)
1048
        result_format = self._format.__class__()
1049
        try:
1910.2.41 by Aaron Bentley
Clean up clone format creation
1050
            try:
4160.2.6 by Andrew Bennetts
Add ignore_fallbacks flag.
1051
                branch = self.open_branch(ignore_fallbacks=True)
2387.1.1 by Robert Collins
Remove the --basis parameter to clone etc. (Robert Collins)
1052
                source_repository = branch.repository
3650.2.5 by Aaron Bentley
Stop creating a new instance
1053
                result_format._branch_format = branch._format
1910.2.41 by Aaron Bentley
Clean up clone format creation
1054
            except errors.NotBranchError:
1055
                source_branch = None
2387.1.1 by Robert Collins
Remove the --basis parameter to clone etc. (Robert Collins)
1056
                source_repository = self.open_repository()
2305.3.1 by Andrew Bennetts
Tidy up BzrDir.cloning_metadir: bogus try/except, and basis argument isn't actually used.
1057
        except errors.NoRepositoryPresent:
2100.3.24 by Aaron Bentley
Get all tests passing again
1058
            source_repository = None
2305.3.1 by Andrew Bennetts
Tidy up BzrDir.cloning_metadir: bogus try/except, and basis argument isn't actually used.
1059
        else:
2018.5.138 by Robert Collins
Merge bzr.dev.
1060
            # XXX TODO: This isinstance is here because we have not implemented
1061
            # the fix recommended in bug # 103195 - to delegate this choice the
1062
            # repository itself.
2018.5.94 by Andrew Bennetts
Various small changes in aid of making tests pass (including deleting one invalid test).
1063
            repo_format = source_repository._format
3705.2.1 by Andrew Bennetts
Possible fix for bug 269214
1064
            if isinstance(repo_format, remote.RemoteRepositoryFormat):
1065
                source_repository._ensure_real()
1066
                repo_format = source_repository._real_repository._format
1067
            result_format.repository_format = repo_format
2100.3.28 by Aaron Bentley
Make sprout recursive
1068
        try:
2323.5.19 by Martin Pool
No upgrade recommendation on source when cloning
1069
            # TODO: Couldn't we just probe for the format in these cases,
1070
            # rather than opening the whole tree?  It would be a little
1071
            # faster. mbp 20070401
1072
            tree = self.open_workingtree(recommend_upgrade=False)
2100.3.28 by Aaron Bentley
Make sprout recursive
1073
        except (errors.NoWorkingTree, errors.NotLocalUrl):
1074
            result_format.workingtree_format = None
1075
        else:
1076
            result_format.workingtree_format = tree._format.__class__()
2100.3.21 by Aaron Bentley
Work on checking out by-reference trees
1077
        return result_format, source_repository
1078
3650.3.13 by Aaron Bentley
Make cloning_metadir handle stacking requirements
1079
    def cloning_metadir(self, require_stacking=False):
2100.3.32 by Aaron Bentley
fix tree format, basis_tree call, in sprout
1080
        """Produce a metadir suitable for cloning or sprouting with.
1910.2.41 by Aaron Bentley
Clean up clone format creation
1081
2100.3.32 by Aaron Bentley
fix tree format, basis_tree call, in sprout
1082
        These operations may produce workingtrees (yes, even though they're
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
1083
        "cloning" something that doesn't have a tree), so a viable workingtree
2100.3.32 by Aaron Bentley
fix tree format, basis_tree call, in sprout
1084
        format must be selected.
3575.2.2 by Martin Pool
branch --stacked should force a stacked format
1085
3650.3.13 by Aaron Bentley
Make cloning_metadir handle stacking requirements
1086
        :require_stacking: If True, non-stackable formats will be upgraded
1087
            to similar stackable formats.
3575.2.2 by Martin Pool
branch --stacked should force a stacked format
1088
        :returns: a BzrDirFormat with all component formats either set
3650.3.13 by Aaron Bentley
Make cloning_metadir handle stacking requirements
1089
            appropriately or set to None if that component should not be
3575.2.2 by Martin Pool
branch --stacked should force a stacked format
1090
            created.
2100.3.32 by Aaron Bentley
fix tree format, basis_tree call, in sprout
1091
        """
2100.3.21 by Aaron Bentley
Work on checking out by-reference trees
1092
        format, repository = self._cloning_metadir()
2100.3.32 by Aaron Bentley
fix tree format, basis_tree call, in sprout
1093
        if format._workingtree_format is None:
4294.2.4 by Robert Collins
Move dir, bzrdir and repo acquisition into a single method on bzrdir format.
1094
            # No tree in self.
2100.3.34 by Aaron Bentley
Fix BzrDir.cloning_metadir with no format
1095
            if repository is None:
4294.2.4 by Robert Collins
Move dir, bzrdir and repo acquisition into a single method on bzrdir format.
1096
                # No repository either
2100.3.34 by Aaron Bentley
Fix BzrDir.cloning_metadir with no format
1097
                return format
4294.2.4 by Robert Collins
Move dir, bzrdir and repo acquisition into a single method on bzrdir format.
1098
            # We have a repository, so set a working tree? (Why? This seems to
1099
            # contradict the stated return value in the docstring).
2100.3.21 by Aaron Bentley
Work on checking out by-reference trees
1100
            tree_format = repository._format._matchingbzrdir.workingtree_format
2100.3.28 by Aaron Bentley
Make sprout recursive
1101
            format.workingtree_format = tree_format.__class__()
3904.3.1 by Andrew Bennetts
Probable fix for GaryvdM's bug when pushing a stacked qbzr branch to Launchpad.
1102
        if require_stacking:
1103
            format.require_stacking()
3650.3.13 by Aaron Bentley
Make cloning_metadir handle stacking requirements
1104
        return format
1105
1106
    def checkout_metadir(self):
1107
        return self.cloning_metadir()
3650.3.1 by Aaron Bentley
Ensure stacking policy does not cause format upgrades
1108
2387.1.1 by Robert Collins
Remove the --basis parameter to clone etc. (Robert Collins)
1109
    def sprout(self, url, revision_id=None, force_new_repo=False,
3123.5.8 by Aaron Bentley
Work around double-opening lock issue
1110
               recurse='down', possible_transports=None,
3823.5.1 by John Arbash Meinel
Allow the source branch to pass itself into BzrDir.sprout.
1111
               accelerator_tree=None, hardlink=False, stacked=False,
3983.1.7 by Daniel Watkins
Review comments from jam.
1112
               source_branch=None, create_tree_if_local=True):
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1113
        """Create a copy of this bzrdir prepared for use as a new line of
1114
        development.
1115
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
1116
        If url's last component does not exist, it will be created.
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1117
1118
        Attributes related to the identity of the source branch like
1119
        branch nickname will be cleaned, a working tree is created
1120
        whether one existed before or not; and a local branch is always
1121
        created.
1122
1123
        if revision_id is not None, then the clone operation may tune
1124
            itself to download less data.
3123.5.17 by Aaron Bentley
Update docs
1125
        :param accelerator_tree: A tree which can be used for retrieving file
1126
            contents more quickly than the revision tree, i.e. a workingtree.
1127
            The revision tree will be used for cases where accelerator_tree's
1128
            content is different.
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
1129
        :param hardlink: If true, hard-link files from accelerator_tree,
1130
            where possible.
3221.18.4 by Ian Clatworthy
shallow -> stacked
1131
        :param stacked: If true, create a stacked branch referring to the
3221.13.2 by Robert Collins
Add a shallow parameter to bzrdir.sprout, which involved fixing a lateny bug in pack to pack fetching with ghost discovery.
1132
            location of this control directory.
3983.1.7 by Daniel Watkins
Review comments from jam.
1133
        :param create_tree_if_local: If true, a working-tree will be created
1134
            when working locally.
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1135
        """
2485.8.56 by Vincent Ladeuil
Fix bug #112173 and bzr branch multiple connections.
1136
        target_transport = get_transport(url, possible_transports)
2475.3.3 by John Arbash Meinel
Change calls to try/mkdir('.')/except FileExists to ensure_base()
1137
        target_transport.ensure_base()
3650.3.13 by Aaron Bentley
Make cloning_metadir handle stacking requirements
1138
        cloning_format = self.cloning_metadir(stacked)
3650.3.1 by Aaron Bentley
Ensure stacking policy does not cause format upgrades
1139
        # Create/update the result branch
2475.3.1 by John Arbash Meinel
Fix bug #75721. Update the BzrDir api to add clone_on_transport()
1140
        result = cloning_format.initialize_on_transport(target_transport)
3823.5.1 by John Arbash Meinel
Allow the source branch to pass itself into BzrDir.sprout.
1141
        # if a stacked branch wasn't requested, we don't create one
1142
        # even if the origin was stacked
1143
        stacked_branch_url = None
1144
        if source_branch is not None:
3221.18.4 by Ian Clatworthy
shallow -> stacked
1145
            if stacked:
1146
                stacked_branch_url = self.root_transport.base
3823.5.1 by John Arbash Meinel
Allow the source branch to pass itself into BzrDir.sprout.
1147
            source_repository = source_branch.repository
1148
        else:
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1149
            try:
3823.5.1 by John Arbash Meinel
Allow the source branch to pass itself into BzrDir.sprout.
1150
                source_branch = self.open_branch()
1151
                source_repository = source_branch.repository
1152
                if stacked:
1153
                    stacked_branch_url = self.root_transport.base
1154
            except errors.NotBranchError:
1155
                source_branch = None
1156
                try:
1157
                    source_repository = self.open_repository()
1158
                except errors.NoRepositoryPresent:
1159
                    source_repository = None
3242.3.32 by Aaron Bentley
Defer handling relative stacking URLs as late as possible.
1160
        repository_policy = result.determine_repository_policy(
3242.3.40 by Aaron Bentley
Turn failing test into KnownFailure
1161
            force_new_repo, stacked_branch_url, require_stacking=stacked)
4070.9.2 by Andrew Bennetts
Rough prototype of allowing a SearchResult to be passed to fetch, and using that to improve network conversations.
1162
        result_repo, is_new_repo = repository_policy.acquire_repository()
4070.9.17 by Andrew Bennetts
Don't use PendingAncestrySearch when creating a stacked branch.
1163
        if is_new_repo and revision_id is not None and not stacked:
4070.9.14 by Andrew Bennetts
Tweaks requested by Robert's review.
1164
            fetch_spec = graph.PendingAncestryResult(
1165
                [revision_id], source_repository)
4070.9.2 by Andrew Bennetts
Rough prototype of allowing a SearchResult to be passed to fetch, and using that to improve network conversations.
1166
        else:
1167
            fetch_spec = None
3242.3.32 by Aaron Bentley
Defer handling relative stacking URLs as late as possible.
1168
        if source_repository is not None:
3650.3.1 by Aaron Bentley
Ensure stacking policy does not cause format upgrades
1169
            # Fetch while stacked to prevent unstacked fetch from
1170
            # Branch.sprout.
4070.9.2 by Andrew Bennetts
Rough prototype of allowing a SearchResult to be passed to fetch, and using that to improve network conversations.
1171
            if fetch_spec is None:
1172
                result_repo.fetch(source_repository, revision_id=revision_id)
1173
            else:
1174
                result_repo.fetch(source_repository, fetch_spec=fetch_spec)
3221.18.1 by Ian Clatworthy
tweaks by ianc during review
1175
3650.3.1 by Aaron Bentley
Ensure stacking policy does not cause format upgrades
1176
        if source_branch is None:
3575.2.2 by Martin Pool
branch --stacked should force a stacked format
1177
            # this is for sprouting a bzrdir without a branch; is that
1178
            # actually useful?
3650.3.1 by Aaron Bentley
Ensure stacking policy does not cause format upgrades
1179
            # Not especially, but it's part of the contract.
3221.11.20 by Robert Collins
Support --shallow on branch.
1180
            result_branch = result.create_branch()
3575.2.2 by Martin Pool
branch --stacked should force a stacked format
1181
        else:
4070.3.1 by Robert Collins
Alter branch sprouting with an alternate fix for stacked branches that does not require multiple copy_content_into and set_parent calls, reducing IO and round trips.
1182
            result_branch = source_branch.sprout(result,
1183
                revision_id=revision_id, repository_policy=repository_policy)
3575.2.2 by Martin Pool
branch --stacked should force a stacked format
1184
        mutter("created new branch %r" % (result_branch,))
3221.18.1 by Ian Clatworthy
tweaks by ianc during review
1185
1186
        # Create/update the result working tree
3983.1.7 by Daniel Watkins
Review comments from jam.
1187
        if (create_tree_if_local and
1188
            isinstance(target_transport, local.LocalTransport) and
1189
            (result_repo is None or result_repo.make_working_trees())):
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
1190
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1191
                hardlink=hardlink)
2255.2.77 by Robert Collins
Tune working inventory generation more: walk the blocks, skipping deleted rows.
1192
            wt.lock_write()
1193
            try:
1194
                if wt.path2id('') is None:
3123.5.10 by Aaron Bentley
Restore old handling of set_root_id
1195
                    try:
1196
                        wt.set_root_id(self.open_workingtree.get_root_id())
1197
                    except errors.NoWorkingTree:
1198
                        pass
2255.2.77 by Robert Collins
Tune working inventory generation more: walk the blocks, skipping deleted rows.
1199
            finally:
1200
                wt.unlock()
2100.3.28 by Aaron Bentley
Make sprout recursive
1201
        else:
1202
            wt = None
1203
        if recurse == 'down':
1204
            if wt is not None:
2255.2.226 by Robert Collins
Get merge_nested finally working: change nested tree iterators to take file_ids, and ensure the right branch is connected to in the merge logic. May not be suitable for shared repositories yet.
1205
                basis = wt.basis_tree()
1206
                basis.lock_read()
1207
                subtrees = basis.iter_references()
3744.1.1 by John Arbash Meinel
When branching into a tree-less repository, use the target branch
1208
            elif result_branch is not None:
1209
                basis = result_branch.basis_tree()
1210
                basis.lock_read()
1211
                subtrees = basis.iter_references()
2100.3.28 by Aaron Bentley
Make sprout recursive
1212
            elif source_branch is not None:
2255.2.226 by Robert Collins
Get merge_nested finally working: change nested tree iterators to take file_ids, and ensure the right branch is connected to in the merge logic. May not be suitable for shared repositories yet.
1213
                basis = source_branch.basis_tree()
1214
                basis.lock_read()
1215
                subtrees = basis.iter_references()
2100.3.28 by Aaron Bentley
Make sprout recursive
1216
            else:
2255.2.226 by Robert Collins
Get merge_nested finally working: change nested tree iterators to take file_ids, and ensure the right branch is connected to in the merge logic. May not be suitable for shared repositories yet.
1217
                subtrees = []
1218
                basis = None
1219
            try:
1220
                for path, file_id in subtrees:
1221
                    target = urlutils.join(url, urlutils.escape(path))
1222
                    sublocation = source_branch.reference_parent(file_id, path)
1223
                    sublocation.bzrdir.sprout(target,
1224
                        basis.get_reference_revision(file_id, path),
3221.18.1 by Ian Clatworthy
tweaks by ianc during review
1225
                        force_new_repo=force_new_repo, recurse=recurse,
3221.18.4 by Ian Clatworthy
shallow -> stacked
1226
                        stacked=stacked)
2255.2.226 by Robert Collins
Get merge_nested finally working: change nested tree iterators to take file_ids, and ensure the right branch is connected to in the merge logic. May not be suitable for shared repositories yet.
1227
            finally:
1228
                if basis is not None:
1229
                    basis.unlock()
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1230
        return result
1231
3978.3.15 by Jelmer Vernooij
Rename BzrDir.push() to BzrDir.push_branch().
1232
    def push_branch(self, source, revision_id=None, overwrite=False, 
1233
        remember=False):
3978.3.14 by Jelmer Vernooij
Move BranchBzrDirInter.push() to BzrDir.push().
1234
        """Push the source branch into this BzrDir."""
1235
        br_to = None
1236
        # If we can open a branch, use its direct repository, otherwise see
1237
        # if there is a repository without a branch.
1238
        try:
1239
            br_to = self.open_branch()
1240
        except errors.NotBranchError:
1241
            # Didn't find a branch, can we find a repository?
1242
            repository_to = self.find_repository()
1243
        else:
1244
            # Found a branch, so we must have found a repository
1245
            repository_to = br_to.repository
1246
1247
        push_result = PushResult()
3978.3.16 by Jelmer Vernooij
Add some smoke tests for BzrDir.push_branch().
1248
        push_result.source_branch = source
3978.3.14 by Jelmer Vernooij
Move BranchBzrDirInter.push() to BzrDir.push().
1249
        if br_to is None:
1250
            # We have a repository but no branch, copy the revisions, and then
1251
            # create a branch.
1252
            repository_to.fetch(source.repository, revision_id=revision_id)
1253
            br_to = source.clone(self, revision_id=revision_id)
1254
            if source.get_push_location() is None or remember:
1255
                source.set_push_location(br_to.base)
1256
            push_result.stacked_on = None
1257
            push_result.branch_push_result = None
1258
            push_result.old_revno = None
1259
            push_result.old_revid = _mod_revision.NULL_REVISION
1260
            push_result.target_branch = br_to
1261
            push_result.master_branch = None
1262
            push_result.workingtree_updated = False
1263
        else:
1264
            # We have successfully opened the branch, remember if necessary:
1265
            if source.get_push_location() is None or remember:
1266
                source.set_push_location(br_to.base)
1267
            try:
1268
                tree_to = self.open_workingtree()
1269
            except errors.NotLocalUrl:
1270
                push_result.branch_push_result = source.push(br_to, 
1271
                    overwrite, stop_revision=revision_id)
1272
                push_result.workingtree_updated = False
1273
            except errors.NoWorkingTree:
1274
                push_result.branch_push_result = source.push(br_to,
1275
                    overwrite, stop_revision=revision_id)
1276
                push_result.workingtree_updated = None # Not applicable
1277
            else:
1278
                tree_to.lock_write()
1279
                try:
1280
                    push_result.branch_push_result = source.push(
1281
                        tree_to.branch, overwrite, stop_revision=revision_id)
1282
                    tree_to.update()
1283
                finally:
1284
                    tree_to.unlock()
1285
                push_result.workingtree_updated = True
1286
            push_result.old_revno = push_result.branch_push_result.old_revno
1287
            push_result.old_revid = push_result.branch_push_result.old_revid
3978.3.15 by Jelmer Vernooij
Rename BzrDir.push() to BzrDir.push_branch().
1288
            push_result.target_branch = \
1289
                push_result.branch_push_result.target_branch
3978.3.14 by Jelmer Vernooij
Move BranchBzrDirInter.push() to BzrDir.push().
1290
        return push_result
1291
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
1292
4160.1.1 by Robert Collins
Add a BzrDir.pre_open hook for use by the smart server gaol.
1293
class BzrDirHooks(hooks.Hooks):
1294
    """Hooks for BzrDir operations."""
1295
1296
    def __init__(self):
1297
        """Create the default hooks."""
1298
        hooks.Hooks.__init__(self)
1299
        self.create_hook(hooks.HookPoint('pre_open',
1300
            "Invoked before attempting to open a BzrDir with the transport "
1301
            "that the open will use.", (1, 14), None))
1302
1303
# install the default hooks
1304
BzrDir.hooks = BzrDirHooks()
1305
1306
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1307
class BzrDirPreSplitOut(BzrDir):
1308
    """A common class for the all-in-one formats."""
1309
1534.5.3 by Robert Collins
Make format 4/5/6 branches share a single LockableFiles instance across wt/branch/repository.
1310
    def __init__(self, _transport, _format):
1311
        """See BzrDir.__init__."""
1312
        super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
1313
        self._control_files = lockable_files.LockableFiles(
1314
                                            self.get_branch_transport(None),
1553.5.69 by Martin Pool
BzrDirFormat subclasses can now control what kind of overall lock is used.
1315
                                            self._format._lock_file_name,
1316
                                            self._format._lock_class)
1534.5.3 by Robert Collins
Make format 4/5/6 branches share a single LockableFiles instance across wt/branch/repository.
1317
1687.1.12 by Robert Collins
Hook in the full break-lock ui.
1318
    def break_lock(self):
1319
        """Pre-splitout bzrdirs do not suffer from stale locks."""
1320
        raise NotImplementedError(self.break_lock)
1321
3650.3.13 by Aaron Bentley
Make cloning_metadir handle stacking requirements
1322
    def cloning_metadir(self, require_stacking=False):
3242.2.12 by Aaron Bentley
Get cloning_metadir working properly for old formats
1323
        """Produce a metadir suitable for cloning with."""
3650.3.13 by Aaron Bentley
Make cloning_metadir handle stacking requirements
1324
        if require_stacking:
1325
            return format_registry.make_bzrdir('1.6')
3242.2.12 by Aaron Bentley
Get cloning_metadir working properly for old formats
1326
        return self._format.__class__()
1327
3242.3.37 by Aaron Bentley
Updates from reviews
1328
    def clone(self, url, revision_id=None, force_new_repo=False,
1329
              preserve_stacking=False):
1330
        """See BzrDir.clone().
1331
1332
        force_new_repo has no effect, since this family of formats always
1333
        require a new repository.
1334
        preserve_stacking has no effect, since no source branch using this
1335
        family of formats can be stacked, so there is no stacking to preserve.
1336
        """
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1337
        self._make_tail(url)
1651.1.6 by Martin Pool
Clean up clone-bzrdir code
1338
        result = self._format._initialize_for_clone(url)
2387.1.1 by Robert Collins
Remove the --basis parameter to clone etc. (Robert Collins)
1339
        self.open_repository().clone(result, revision_id=revision_id)
1692.7.9 by Martin Pool
Don't create broken standalone branches over sftp (Malone #43064)
1340
        from_branch = self.open_branch()
1341
        from_branch.clone(result, revision_id=revision_id)
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1342
        try:
3650.5.7 by Aaron Bentley
Fix working tree initialization
1343
            tree = self.open_workingtree()
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1344
        except errors.NotLocalUrl:
1345
            # make a new one, this format always has to have one.
3650.5.7 by Aaron Bentley
Fix working tree initialization
1346
            result._init_workingtree()
1347
        else:
1348
            tree.clone(result)
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1349
        return result
1350
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1351
    def create_branch(self):
1352
        """See BzrDir.create_branch."""
3650.2.2 by Aaron Bentley
Implement get_branch_format, to unify branch creation code
1353
        return self._format.get_branch_format().initialize(self)
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1354
2796.2.6 by Aaron Bentley
Implement destroy_branch
1355
    def destroy_branch(self):
2796.2.16 by Aaron Bentley
Documentation updates from review
1356
        """See BzrDir.destroy_branch."""
2796.2.6 by Aaron Bentley
Implement destroy_branch
1357
        raise errors.UnsupportedOperation(self.destroy_branch, self)
1358
1534.6.1 by Robert Collins
allow API creation of shared repositories
1359
    def create_repository(self, shared=False):
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1360
        """See BzrDir.create_repository."""
1534.6.1 by Robert Collins
allow API creation of shared repositories
1361
        if shared:
1362
            raise errors.IncompatibleFormat('shared repository', self._format)
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1363
        return self.open_repository()
1364
2796.2.19 by Aaron Bentley
Support reconfigure --lightweight-checkout
1365
    def destroy_repository(self):
1366
        """See BzrDir.destroy_repository."""
1367
        raise errors.UnsupportedOperation(self.destroy_repository, self)
1368
3123.5.2 by Aaron Bentley
Allow checkout --files_from
1369
    def create_workingtree(self, revision_id=None, from_branch=None,
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
1370
                           accelerator_tree=None, hardlink=False):
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1371
        """See BzrDir.create_workingtree."""
3650.5.6 by Aaron Bentley
Fix cloning problems by creating missing working tree files
1372
        # The workingtree is sometimes created when the bzrdir is created,
1373
        # but not when cloning.
1374
1508.1.21 by Robert Collins
Implement -r limit for checkout command.
1375
        # this looks buggy but is not -really-
2323.6.4 by Martin Pool
BzrDir._check_supported now also takes care of recommending upgrades, which
1376
        # because this format creates the workingtree when the bzrdir is
1377
        # created
1508.1.21 by Robert Collins
Implement -r limit for checkout command.
1378
        # clone and sprout will have set the revision_id
1379
        # and that will have set it for us, its only
1380
        # specific uses of create_workingtree in isolation
1381
        # that can do wonky stuff here, and that only
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1382
        # happens for creating checkouts, which cannot be
1508.1.21 by Robert Collins
Implement -r limit for checkout command.
1383
        # done on this format anyway. So - acceptable wart.
3650.5.6 by Aaron Bentley
Fix cloning problems by creating missing working tree files
1384
        try:
1385
            result = self.open_workingtree(recommend_upgrade=False)
1386
        except errors.NoSuchFile:
1387
            result = self._init_workingtree()
1508.1.24 by Robert Collins
Add update command for use with checkouts.
1388
        if revision_id is not None:
1996.3.12 by John Arbash Meinel
Change how 'revision' is imported to avoid problems later
1389
            if revision_id == _mod_revision.NULL_REVISION:
1551.8.20 by Aaron Bentley
Fix BzrDir.create_workingtree for NULL_REVISION
1390
                result.set_parent_ids([])
1391
            else:
1392
                result.set_parent_ids([revision_id])
1508.1.21 by Robert Collins
Implement -r limit for checkout command.
1393
        return result
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1394
3650.5.6 by Aaron Bentley
Fix cloning problems by creating missing working tree files
1395
    def _init_workingtree(self):
1396
        from bzrlib.workingtree import WorkingTreeFormat2
1397
        try:
1398
            return WorkingTreeFormat2().initialize(self)
1399
        except errors.NotLocalUrl:
1400
            # Even though we can't access the working tree, we need to
1401
            # create its control files.
3650.5.7 by Aaron Bentley
Fix working tree initialization
1402
            return WorkingTreeFormat2()._stub_initialize_on_transport(
1403
                self.transport, self._control_files._file_mode)
3650.5.6 by Aaron Bentley
Fix cloning problems by creating missing working tree files
1404
1551.8.37 by Aaron Bentley
Cleaner implementation of destroy_working_tree
1405
    def destroy_workingtree(self):
1551.8.36 by Aaron Bentley
Introduce BzrDir.destroy_workingtree
1406
        """See BzrDir.destroy_workingtree."""
1407
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1408
1551.8.37 by Aaron Bentley
Cleaner implementation of destroy_working_tree
1409
    def destroy_workingtree_metadata(self):
1410
        """See BzrDir.destroy_workingtree_metadata."""
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1411
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1551.8.37 by Aaron Bentley
Cleaner implementation of destroy_working_tree
1412
                                          self)
1413
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1414
    def get_branch_transport(self, branch_format):
1415
        """See BzrDir.get_branch_transport()."""
1416
        if branch_format is None:
1417
            return self.transport
1418
        try:
1419
            branch_format.get_format_string()
1420
        except NotImplementedError:
1421
            return self.transport
1422
        raise errors.IncompatibleFormat(branch_format, self._format)
1423
1534.4.47 by Robert Collins
Split out repository into .bzr/repository
1424
    def get_repository_transport(self, repository_format):
1425
        """See BzrDir.get_repository_transport()."""
1426
        if repository_format is None:
1427
            return self.transport
1428
        try:
1429
            repository_format.get_format_string()
1430
        except NotImplementedError:
1431
            return self.transport
1432
        raise errors.IncompatibleFormat(repository_format, self._format)
1433
1534.4.45 by Robert Collins
Start WorkingTree -> .bzr/checkout transition
1434
    def get_workingtree_transport(self, workingtree_format):
1435
        """See BzrDir.get_workingtree_transport()."""
1436
        if workingtree_format is None:
1437
            return self.transport
1438
        try:
1439
            workingtree_format.get_format_string()
1440
        except NotImplementedError:
1441
            return self.transport
1442
        raise errors.IncompatibleFormat(workingtree_format, self._format)
1443
1556.1.4 by Robert Collins
Add a new format for what will become knit, and the surrounding logic to upgrade repositories within metadirs, and tests for the same.
1444
    def needs_format_conversion(self, format=None):
1445
        """See BzrDir.needs_format_conversion()."""
1446
        # if the format is not the same as the system default,
1447
        # an upgrade is needed.
1448
        if format is None:
3943.2.5 by Martin Pool
deprecate needs_format_conversion(format=None)
1449
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1450
                % 'needs_format_conversion(format=None)')
1556.1.4 by Robert Collins
Add a new format for what will become knit, and the surrounding logic to upgrade repositories within metadirs, and tests for the same.
1451
            format = BzrDirFormat.get_default_format()
1452
        return not isinstance(self._format, format.__class__)
1453
4160.2.6 by Andrew Bennetts
Add ignore_fallbacks flag.
1454
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1455
        """See BzrDir.open_branch."""
1456
        from bzrlib.branch import BzrBranchFormat4
1457
        format = BzrBranchFormat4()
1458
        self._check_supported(format, unsupported)
1459
        return format.open(self, _found=True)
1460
2485.8.56 by Vincent Ladeuil
Fix bug #112173 and bzr branch multiple connections.
1461
    def sprout(self, url, revision_id=None, force_new_repo=False,
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
1462
               possible_transports=None, accelerator_tree=None,
4054.3.1 by Martin Pool
BzrDirPreSplitOut.sprout should accept source_branch parameter
1463
               hardlink=False, stacked=False, create_tree_if_local=True,
1464
               source_branch=None):
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1465
        """See BzrDir.sprout()."""
4054.3.1 by Martin Pool
BzrDirPreSplitOut.sprout should accept source_branch parameter
1466
        if source_branch is not None:
1467
            my_branch = self.open_branch()
1468
            if source_branch.base != my_branch.base:
1469
                raise AssertionError(
1470
                    "source branch %r is not within %r with branch %r" %
1471
                    (source_branch, self, my_branch))
3221.18.4 by Ian Clatworthy
shallow -> stacked
1472
        if stacked:
3221.13.2 by Robert Collins
Add a shallow parameter to bzrdir.sprout, which involved fixing a lateny bug in pack to pack fetching with ghost discovery.
1473
            raise errors.UnstackableBranchFormat(
1474
                self._format, self.root_transport.base)
3983.1.11 by Daniel Watkins
Old BzrDirs which must have working trees are now allowed for in the test.
1475
        if not create_tree_if_local:
1476
            raise errors.MustHaveWorkingTree(
1477
                self._format, self.root_transport.base)
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1478
        from bzrlib.workingtree import WorkingTreeFormat2
1479
        self._make_tail(url)
1651.1.6 by Martin Pool
Clean up clone-bzrdir code
1480
        result = self._format._initialize_for_clone(url)
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1481
        try:
2387.1.1 by Robert Collins
Remove the --basis parameter to clone etc. (Robert Collins)
1482
            self.open_repository().clone(result, revision_id=revision_id)
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1483
        except errors.NoRepositoryPresent:
1484
            pass
1485
        try:
1486
            self.open_branch().sprout(result, revision_id=revision_id)
1487
        except errors.NotBranchError:
1488
            pass
3983.1.4 by Daniel Watkins
Added 'no_tree' parameter to BzrDirPreSplitOut.
1489
3983.1.7 by Daniel Watkins
Review comments from jam.
1490
        # we always want a working tree
1491
        WorkingTreeFormat2().initialize(result,
1492
                                        accelerator_tree=accelerator_tree,
1493
                                        hardlink=hardlink)
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1494
        return result
1495
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1496
1497
class BzrDir4(BzrDirPreSplitOut):
1508.1.25 by Robert Collins
Update per review comments.
1498
    """A .bzr version 4 control object.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1499
1508.1.25 by Robert Collins
Update per review comments.
1500
    This is a deprecated format and may be removed after sept 2006.
1501
    """
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
1502
1534.6.1 by Robert Collins
allow API creation of shared repositories
1503
    def create_repository(self, shared=False):
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
1504
        """See BzrDir.create_repository."""
1556.1.4 by Robert Collins
Add a new format for what will become knit, and the surrounding logic to upgrade repositories within metadirs, and tests for the same.
1505
        return self._format.repository_format.initialize(self, shared)
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
1506
1534.5.16 by Robert Collins
Review feedback.
1507
    def needs_format_conversion(self, format=None):
1508
        """Format 4 dirs are always in need of conversion."""
3943.2.5 by Martin Pool
deprecate needs_format_conversion(format=None)
1509
        if format is None:
1510
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1511
                % 'needs_format_conversion(format=None)')
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
1512
        return True
1513
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
1514
    def open_repository(self):
1515
        """See BzrDir.open_repository."""
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
1516
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
1517
        return RepositoryFormat4().open(self, _found=True)
1518
1519
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1520
class BzrDir5(BzrDirPreSplitOut):
1508.1.25 by Robert Collins
Update per review comments.
1521
    """A .bzr version 5 control object.
1522
1523
    This is a deprecated format and may be removed after sept 2006.
1524
    """
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
1525
1526
    def open_repository(self):
1527
        """See BzrDir.open_repository."""
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
1528
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
1529
        return RepositoryFormat5().open(self, _found=True)
1530
2323.6.4 by Martin Pool
BzrDir._check_supported now also takes care of recommending upgrades, which
1531
    def open_workingtree(self, _unsupported=False,
1532
            recommend_upgrade=True):
1534.4.42 by Robert Collins
add working tree to the BzrDir facilities.
1533
        """See BzrDir.create_workingtree."""
1534
        from bzrlib.workingtree import WorkingTreeFormat2
2323.6.4 by Martin Pool
BzrDir._check_supported now also takes care of recommending upgrades, which
1535
        wt_format = WorkingTreeFormat2()
1536
        # we don't warn here about upgrades; that ought to be handled for the
1537
        # bzrdir as a whole
1538
        return wt_format.open(self, _found=True)
1534.4.42 by Robert Collins
add working tree to the BzrDir facilities.
1539
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
1540
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1541
class BzrDir6(BzrDirPreSplitOut):
1508.1.25 by Robert Collins
Update per review comments.
1542
    """A .bzr version 6 control object.
1543
1544
    This is a deprecated format and may be removed after sept 2006.
1545
    """
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
1546
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1547
    def open_repository(self):
1548
        """See BzrDir.open_repository."""
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
1549
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1550
        return RepositoryFormat6().open(self, _found=True)
1551
2323.6.4 by Martin Pool
BzrDir._check_supported now also takes care of recommending upgrades, which
1552
    def open_workingtree(self, _unsupported=False,
1553
        recommend_upgrade=True):
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1554
        """See BzrDir.create_workingtree."""
2323.6.4 by Martin Pool
BzrDir._check_supported now also takes care of recommending upgrades, which
1555
        # we don't warn here about upgrades; that ought to be handled for the
1556
        # bzrdir as a whole
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1557
        from bzrlib.workingtree import WorkingTreeFormat2
1558
        return WorkingTreeFormat2().open(self, _found=True)
1559
1560
1561
class BzrDirMeta1(BzrDir):
1562
    """A .bzr meta version 1 control object.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1563
1564
    This is the first control object where the
1553.5.67 by Martin Pool
doc
1565
    individual aspects are really split out: there are separate repository,
1566
    workingtree and branch subdirectories and any subset of the three can be
1567
    present within a BzrDir.
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1568
    """
1569
1534.5.16 by Robert Collins
Review feedback.
1570
    def can_convert_format(self):
1571
        """See BzrDir.can_convert_format()."""
1556.1.4 by Robert Collins
Add a new format for what will become knit, and the surrounding logic to upgrade repositories within metadirs, and tests for the same.
1572
        return True
1534.5.10 by Robert Collins
Make upgrade driver unaware of the specific formats in play.
1573
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1574
    def create_branch(self):
1575
        """See BzrDir.create_branch."""
2230.3.55 by Aaron Bentley
Updates from review
1576
        return self._format.get_branch_format().initialize(self)
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1577
2796.2.6 by Aaron Bentley
Implement destroy_branch
1578
    def destroy_branch(self):
1579
        """See BzrDir.create_branch."""
1580
        self.transport.delete_tree('branch')
1581
1534.6.1 by Robert Collins
allow API creation of shared repositories
1582
    def create_repository(self, shared=False):
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
1583
        """See BzrDir.create_repository."""
1556.1.4 by Robert Collins
Add a new format for what will become knit, and the surrounding logic to upgrade repositories within metadirs, and tests for the same.
1584
        return self._format.repository_format.initialize(self, shared)
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
1585
2796.2.19 by Aaron Bentley
Support reconfigure --lightweight-checkout
1586
    def destroy_repository(self):
1587
        """See BzrDir.destroy_repository."""
1588
        self.transport.delete_tree('repository')
1589
3123.5.2 by Aaron Bentley
Allow checkout --files_from
1590
    def create_workingtree(self, revision_id=None, from_branch=None,
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
1591
                           accelerator_tree=None, hardlink=False):
1534.4.42 by Robert Collins
add working tree to the BzrDir facilities.
1592
        """See BzrDir.create_workingtree."""
2955.5.3 by Vincent Ladeuil
Fix second unwanted connection by providing the right branch to create_checkout.
1593
        return self._format.workingtree_format.initialize(
3123.5.2 by Aaron Bentley
Allow checkout --files_from
1594
            self, revision_id, from_branch=from_branch,
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
1595
            accelerator_tree=accelerator_tree, hardlink=hardlink)
1534.4.42 by Robert Collins
add working tree to the BzrDir facilities.
1596
1551.8.37 by Aaron Bentley
Cleaner implementation of destroy_working_tree
1597
    def destroy_workingtree(self):
1551.8.36 by Aaron Bentley
Introduce BzrDir.destroy_workingtree
1598
        """See BzrDir.destroy_workingtree."""
2323.6.4 by Martin Pool
BzrDir._check_supported now also takes care of recommending upgrades, which
1599
        wt = self.open_workingtree(recommend_upgrade=False)
1551.8.37 by Aaron Bentley
Cleaner implementation of destroy_working_tree
1600
        repository = wt.branch.repository
2094.3.5 by John Arbash Meinel
Fix imports to ensure modules are loaded before they are used
1601
        empty = repository.revision_tree(_mod_revision.NULL_REVISION)
2748.3.2 by Aaron Bentley
Fix revert, remove-tree, and various tests to use None for 'no files specified'
1602
        wt.revert(old_tree=empty)
1551.8.37 by Aaron Bentley
Cleaner implementation of destroy_working_tree
1603
        self.destroy_workingtree_metadata()
1604
1605
    def destroy_workingtree_metadata(self):
1606
        self.transport.delete_tree('checkout')
1551.8.36 by Aaron Bentley
Introduce BzrDir.destroy_workingtree
1607
2414.2.1 by Andrew Bennetts
Some miscellaneous new APIs, tests and other changes from the hpss branch.
1608
    def find_branch_format(self):
1609
        """Find the branch 'format' for this bzrdir.
1610
1611
        This might be a synthetic object for e.g. RemoteBranch and SVN.
1612
        """
1613
        from bzrlib.branch import BranchFormat
1614
        return BranchFormat.find_format(self)
1615
1666.1.4 by Robert Collins
* 'Metadir' is now the default disk format. This improves behaviour in
1616
    def _get_mkdir_mode(self):
1617
        """Figure out the mode to use when creating a bzrdir subdir."""
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
1618
        temp_control = lockable_files.LockableFiles(self.transport, '',
1619
                                     lockable_files.TransportLock)
1666.1.4 by Robert Collins
* 'Metadir' is now the default disk format. This improves behaviour in
1620
        return temp_control._dir_mode
1621
2414.2.1 by Andrew Bennetts
Some miscellaneous new APIs, tests and other changes from the hpss branch.
1622
    def get_branch_reference(self):
1623
        """See BzrDir.get_branch_reference()."""
1624
        from bzrlib.branch import BranchFormat
1625
        format = BranchFormat.find_format(self)
1626
        return format.get_reference(self)
1627
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1628
    def get_branch_transport(self, branch_format):
1629
        """See BzrDir.get_branch_transport()."""
1630
        if branch_format is None:
1631
            return self.transport.clone('branch')
1632
        try:
1633
            branch_format.get_format_string()
1634
        except NotImplementedError:
1635
            raise errors.IncompatibleFormat(branch_format, self._format)
1636
        try:
1666.1.4 by Robert Collins
* 'Metadir' is now the default disk format. This improves behaviour in
1637
            self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1638
        except errors.FileExists:
1639
            pass
1640
        return self.transport.clone('branch')
1641
1534.4.47 by Robert Collins
Split out repository into .bzr/repository
1642
    def get_repository_transport(self, repository_format):
1643
        """See BzrDir.get_repository_transport()."""
1644
        if repository_format is None:
1645
            return self.transport.clone('repository')
1646
        try:
1647
            repository_format.get_format_string()
1648
        except NotImplementedError:
1649
            raise errors.IncompatibleFormat(repository_format, self._format)
1650
        try:
1666.1.4 by Robert Collins
* 'Metadir' is now the default disk format. This improves behaviour in
1651
            self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1534.4.47 by Robert Collins
Split out repository into .bzr/repository
1652
        except errors.FileExists:
1653
            pass
1654
        return self.transport.clone('repository')
1655
1534.4.45 by Robert Collins
Start WorkingTree -> .bzr/checkout transition
1656
    def get_workingtree_transport(self, workingtree_format):
1657
        """See BzrDir.get_workingtree_transport()."""
1658
        if workingtree_format is None:
1659
            return self.transport.clone('checkout')
1660
        try:
1661
            workingtree_format.get_format_string()
1662
        except NotImplementedError:
1663
            raise errors.IncompatibleFormat(workingtree_format, self._format)
1664
        try:
1666.1.4 by Robert Collins
* 'Metadir' is now the default disk format. This improves behaviour in
1665
            self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1534.4.45 by Robert Collins
Start WorkingTree -> .bzr/checkout transition
1666
        except errors.FileExists:
1667
            pass
1668
        return self.transport.clone('checkout')
1669
1534.5.16 by Robert Collins
Review feedback.
1670
    def needs_format_conversion(self, format=None):
1671
        """See BzrDir.needs_format_conversion()."""
1556.1.4 by Robert Collins
Add a new format for what will become knit, and the surrounding logic to upgrade repositories within metadirs, and tests for the same.
1672
        if format is None:
3943.2.5 by Martin Pool
deprecate needs_format_conversion(format=None)
1673
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1674
                % 'needs_format_conversion(format=None)')
1675
        if format is None:
1556.1.4 by Robert Collins
Add a new format for what will become knit, and the surrounding logic to upgrade repositories within metadirs, and tests for the same.
1676
            format = BzrDirFormat.get_default_format()
1677
        if not isinstance(self._format, format.__class__):
1678
            # it is not a meta dir format, conversion is needed.
1679
            return True
1680
        # we might want to push this down to the repository?
1681
        try:
1682
            if not isinstance(self.open_repository()._format,
1683
                              format.repository_format.__class__):
1684
                # the repository needs an upgrade.
1685
                return True
1686
        except errors.NoRepositoryPresent:
1687
            pass
2230.3.29 by Aaron Bentley
Implement conversion to branch 6
1688
        try:
1689
            if not isinstance(self.open_branch()._format,
2230.3.55 by Aaron Bentley
Updates from review
1690
                              format.get_branch_format().__class__):
2255.12.1 by Robert Collins
Implement upgrade for working trees.
1691
                # the branch needs an upgrade.
1692
                return True
1693
        except errors.NotBranchError:
1694
            pass
1695
        try:
2323.6.4 by Martin Pool
BzrDir._check_supported now also takes care of recommending upgrades, which
1696
            my_wt = self.open_workingtree(recommend_upgrade=False)
1697
            if not isinstance(my_wt._format,
2255.12.1 by Robert Collins
Implement upgrade for working trees.
1698
                              format.workingtree_format.__class__):
1699
                # the workingtree needs an upgrade.
1700
                return True
2255.2.196 by Robert Collins
Fix test_upgrade defects related to non local or absent working trees.
1701
        except (errors.NoWorkingTree, errors.NotLocalUrl):
2255.12.1 by Robert Collins
Implement upgrade for working trees.
1702
            pass
1534.5.10 by Robert Collins
Make upgrade driver unaware of the specific formats in play.
1703
        return False
1704
4160.2.6 by Andrew Bennetts
Add ignore_fallbacks flag.
1705
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1706
        """See BzrDir.open_branch."""
2414.2.1 by Andrew Bennetts
Some miscellaneous new APIs, tests and other changes from the hpss branch.
1707
        format = self.find_branch_format()
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
1708
        self._check_supported(format, unsupported)
4160.2.6 by Andrew Bennetts
Add ignore_fallbacks flag.
1709
        return format.open(self, _found=True, ignore_fallbacks=ignore_fallbacks)
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
1710
1534.4.47 by Robert Collins
Split out repository into .bzr/repository
1711
    def open_repository(self, unsupported=False):
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
1712
        """See BzrDir.open_repository."""
1534.4.47 by Robert Collins
Split out repository into .bzr/repository
1713
        from bzrlib.repository import RepositoryFormat
1714
        format = RepositoryFormat.find_format(self)
1715
        self._check_supported(format, unsupported)
1716
        return format.open(self, _found=True)
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
1717
2323.6.4 by Martin Pool
BzrDir._check_supported now also takes care of recommending upgrades, which
1718
    def open_workingtree(self, unsupported=False,
1719
            recommend_upgrade=True):
1508.1.21 by Robert Collins
Implement -r limit for checkout command.
1720
        """See BzrDir.open_workingtree."""
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
1721
        from bzrlib.workingtree import WorkingTreeFormat
1722
        format = WorkingTreeFormat.find_format(self)
2323.6.4 by Martin Pool
BzrDir._check_supported now also takes care of recommending upgrades, which
1723
        self._check_supported(format, unsupported,
1724
            recommend_upgrade,
2323.6.5 by Martin Pool
Recommended-upgrade message should give base dir not the control dir url
1725
            basedir=self.root_transport.base)
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
1726
        return format.open(self, _found=True)
1534.4.42 by Robert Collins
add working tree to the BzrDir facilities.
1727
3242.1.1 by Aaron Bentley
Implement BzrDir configuration
1728
    def _get_config(self):
4288.1.1 by Robert Collins
Add support for a RemoteBzrDirConfig to support optimising push operations which need to look for default stacking locations.
1729
        return config.TransportConfig(self.transport, 'control.conf')
1534.4.39 by Robert Collins
Basic BzrDir support.
1730
4294.2.4 by Robert Collins
Move dir, bzrdir and repo acquisition into a single method on bzrdir format.
1731
1534.4.39 by Robert Collins
Basic BzrDir support.
1732
class BzrDirFormat(object):
1733
    """An encapsulation of the initialization and open routines for a format.
1734
1735
    Formats provide three things:
1736
     * An initialization routine,
1737
     * a format string,
1738
     * an open routine.
1739
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1740
    Formats are placed in a dict by their format string for reference
1534.4.39 by Robert Collins
Basic BzrDir support.
1741
    during bzrdir opening. These should be subclasses of BzrDirFormat
1742
    for consistency.
1743
1744
    Once a format is deprecated, just deprecate the initialize and open
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1745
    methods on the format class. Do not deprecate the object, as the
1534.4.39 by Robert Collins
Basic BzrDir support.
1746
    object will be created every system load.
1747
    """
1748
1749
    _default_format = None
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
1750
    """The default format used for new .bzr dirs."""
1534.4.39 by Robert Collins
Basic BzrDir support.
1751
1752
    _formats = {}
1753
    """The known formats."""
1754
1733.1.7 by Jelmer Vernooij
Change set of control dir formats to list.
1755
    _control_formats = []
1733.1.6 by Jelmer Vernooij
Fix a couple of minor issues after review by Martin.
1756
    """The registered control formats - .bzr, ....
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1757
1733.1.7 by Jelmer Vernooij
Change set of control dir formats to list.
1758
    This is a list of BzrDirFormat objects.
1733.1.6 by Jelmer Vernooij
Fix a couple of minor issues after review by Martin.
1759
    """
1733.1.1 by Robert Collins
Support non '.bzr' control directories in bzrdir.
1760
2018.5.169 by Andrew Bennetts
Add a _server_formats flag to BzrDir.open_from_transport and BzrDirFormat.find_format, make RemoteBranch.control_files into a property.
1761
    _control_server_formats = []
1762
    """The registered control server formats, e.g. RemoteBzrDirs.
1763
1764
    This is a list of BzrDirFormat objects.
1765
    """
1766
1553.5.69 by Martin Pool
BzrDirFormat subclasses can now control what kind of overall lock is used.
1767
    _lock_file_name = 'branch-lock'
1768
1769
    # _lock_class must be set in subclasses to the lock type, typ.
1770
    # TransportLock or LockDir
1771
1534.4.39 by Robert Collins
Basic BzrDir support.
1772
    @classmethod
2018.5.169 by Andrew Bennetts
Add a _server_formats flag to BzrDir.open_from_transport and BzrDirFormat.find_format, make RemoteBranch.control_files into a property.
1773
    def find_format(klass, transport, _server_formats=True):
1733.1.1 by Robert Collins
Support non '.bzr' control directories in bzrdir.
1774
        """Return the format present at transport."""
2018.5.169 by Andrew Bennetts
Add a _server_formats flag to BzrDir.open_from_transport and BzrDirFormat.find_format, make RemoteBranch.control_files into a property.
1775
        if _server_formats:
1776
            formats = klass._control_server_formats + klass._control_formats
1777
        else:
1778
            formats = klass._control_formats
1779
        for format in formats:
1733.1.1 by Robert Collins
Support non '.bzr' control directories in bzrdir.
1780
            try:
1781
                return format.probe_transport(transport)
1782
            except errors.NotBranchError:
1783
                # this format does not find a control dir here.
1784
                pass
1785
        raise errors.NotBranchError(path=transport.base)
1786
1787
    @classmethod
1788
    def probe_transport(klass, transport):
1752.2.52 by Andrew Bennetts
Flesh out more Remote* methods needed to open and initialise remote branches/trees/repositories.
1789
        """Return the .bzrdir style format present in a directory."""
1534.4.39 by Robert Collins
Basic BzrDir support.
1790
        try:
2164.2.18 by Vincent Ladeuil
Take Aaron comments into account.
1791
            format_string = transport.get(".bzr/branch-format").read()
1733.2.3 by Michael Ellerman
Don't coallesce try blocks, it can lead to confusing exceptions.
1792
        except errors.NoSuchFile:
1793
            raise errors.NotBranchError(path=transport.base)
1794
1795
        try:
1534.4.39 by Robert Collins
Basic BzrDir support.
1796
            return klass._formats[format_string]
1797
        except KeyError:
3246.3.2 by Daniel Watkins
Modified uses of errors.UnknownFormatError.
1798
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1534.4.39 by Robert Collins
Basic BzrDir support.
1799
1800
    @classmethod
1801
    def get_default_format(klass):
1802
        """Return the current default format."""
1803
        return klass._default_format
1804
1805
    def get_format_string(self):
1806
        """Return the ASCII format string that identifies this format."""
1807
        raise NotImplementedError(self.get_format_string)
1808
1624.3.19 by Olaf Conradi
New call get_format_description to give a user-friendly description of a
1809
    def get_format_description(self):
1810
        """Return the short description for this format."""
1811
        raise NotImplementedError(self.get_format_description)
1812
1534.5.16 by Robert Collins
Review feedback.
1813
    def get_converter(self, format=None):
1814
        """Return the converter to use to convert bzrdirs needing converts.
1534.5.10 by Robert Collins
Make upgrade driver unaware of the specific formats in play.
1815
1816
        This returns a bzrlib.bzrdir.Converter object.
1817
1818
        This should return the best upgrader to step this format towards the
1759.2.1 by Jelmer Vernooij
Fix some types (found using aspell).
1819
        current default format. In the case of plugins we can/should provide
1534.5.10 by Robert Collins
Make upgrade driver unaware of the specific formats in play.
1820
        some means for them to extend the range of returnable converters.
1534.5.13 by Robert Collins
Correct buggy test.
1821
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1822
        :param format: Optional format to override the default format of the
1534.5.13 by Robert Collins
Correct buggy test.
1823
                       library.
1534.5.10 by Robert Collins
Make upgrade driver unaware of the specific formats in play.
1824
        """
1534.5.16 by Robert Collins
Review feedback.
1825
        raise NotImplementedError(self.get_converter)
1534.5.10 by Robert Collins
Make upgrade driver unaware of the specific formats in play.
1826
2476.3.8 by Vincent Ladeuil
Mark transports that need to be instrumented or refactored to check
1827
    def initialize(self, url, possible_transports=None):
1608.2.8 by Martin Pool
Separate out BzrDir.initialize_on_transport so it
1828
        """Create a bzr control dir at this url and return an opened copy.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1829
4294.2.5 by Robert Collins
Reasonable unit test coverage for initialize_on_transport_ex.
1830
        While not deprecated, this method is very specific and its use will
1831
        lead to many round trips to setup a working environment. See
1832
        initialize_on_transport_ex for a [nearly] all-in-one method.
1833
1608.2.8 by Martin Pool
Separate out BzrDir.initialize_on_transport so it
1834
        Subclasses should typically override initialize_on_transport
1835
        instead of this method.
1836
        """
2476.3.8 by Vincent Ladeuil
Mark transports that need to be instrumented or refactored to check
1837
        return self.initialize_on_transport(get_transport(url,
1838
                                                          possible_transports))
1608.2.8 by Martin Pool
Separate out BzrDir.initialize_on_transport so it
1839
1651.1.6 by Martin Pool
Clean up clone-bzrdir code
1840
    def initialize_on_transport(self, transport):
1608.2.8 by Martin Pool
Separate out BzrDir.initialize_on_transport so it
1841
        """Initialize a new bzrdir in the base directory of a Transport."""
4017.2.2 by Robert Collins
Perform creation of BzrDirMetaFormat1 control directories using an RPC where possible. (Robert Collins)
1842
        try:
1843
            # can we hand off the request to the smart server rather than using
1844
            # vfs calls?
1845
            client_medium = transport.get_smart_medium()
1846
        except errors.NoSmartMedium:
1847
            return self._initialize_on_transport_vfs(transport)
1848
        else:
1849
            # Current RPC's only know how to create bzr metadir1 instances, so
1850
            # we still delegate to vfs methods if the requested format is not a
1851
            # metadir1
1852
            if type(self) != BzrDirMetaFormat1:
1853
                return self._initialize_on_transport_vfs(transport)
1854
            remote_format = RemoteBzrDirFormat()
1855
            self._supply_sub_formats_to(remote_format)
1856
            return remote_format.initialize_on_transport(transport)
1857
4294.2.4 by Robert Collins
Move dir, bzrdir and repo acquisition into a single method on bzrdir format.
1858
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1859
        create_prefix=False, force_new_repo=False, stacked_on=None,
4294.2.5 by Robert Collins
Reasonable unit test coverage for initialize_on_transport_ex.
1860
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
4294.2.8 by Robert Collins
Reduce round trips pushing new branches substantially.
1861
        shared_repo=False, vfs_only=False):
4294.2.4 by Robert Collins
Move dir, bzrdir and repo acquisition into a single method on bzrdir format.
1862
        """Create this format on transport.
1863
4294.2.7 by Robert Collins
Start building up a BzrDir.initialize_ex verb for the smart server.
1864
        The directory to initialize will be created.
1865
4294.2.4 by Robert Collins
Move dir, bzrdir and repo acquisition into a single method on bzrdir format.
1866
        :param force_new_repo: Do not use a shared repository for the target,
1867
                               even if one is available.
1868
        :param create_prefix: Create any missing directories leading up to
1869
            to_transport.
1870
        :param use_existing_dir: Use an existing directory if one exists.
1871
        :param stacked_on: A url to stack any created branch on, None to follow
1872
            any target stacking policy.
1873
        :param stack_on_pwd: If stack_on is relative, the location it is
1874
            relative to.
1875
        :param repo_format_name: If non-None, a repository will be
1876
            made-or-found. Should none be found, or if force_new_repo is True
1877
            the repo_format_name is used to select the format of repository to
1878
            create.
1879
        :param make_working_trees: Control the setting of make_working_trees
4294.2.5 by Robert Collins
Reasonable unit test coverage for initialize_on_transport_ex.
1880
            for a new shared repository when one is made. None to use whatever
1881
            default the format has.
4294.2.4 by Robert Collins
Move dir, bzrdir and repo acquisition into a single method on bzrdir format.
1882
        :param shared_repo: Control whether made repositories are shared or
1883
            not.
4294.2.8 by Robert Collins
Reduce round trips pushing new branches substantially.
1884
        :param vfs_only: If True do not attempt to use a smart server
4294.2.5 by Robert Collins
Reasonable unit test coverage for initialize_on_transport_ex.
1885
        :return: repo, bzrdir, require_stacking, repository_policy. repo is
1886
            None if none was created or found, bzrdir is always valid.
1887
            require_stacking is the result of examining the stacked_on
1888
            parameter and any stacking policy found for the target.
4294.2.4 by Robert Collins
Move dir, bzrdir and repo acquisition into a single method on bzrdir format.
1889
        """
4294.2.8 by Robert Collins
Reduce round trips pushing new branches substantially.
1890
        if not vfs_only:
1891
            # Try to hand off to a smart server 
1892
            try:
1893
                client_medium = transport.get_smart_medium()
1894
            except errors.NoSmartMedium:
1895
                pass
1896
            else:
1897
                # TODO: lookup the local format from a server hint.
1898
                remote_dir_format = RemoteBzrDirFormat()
1899
                remote_dir_format._network_name = self.network_name()
1900
                self._supply_sub_formats_to(remote_dir_format)
1901
                return remote_dir_format.initialize_on_transport_ex(transport,
1902
                    use_existing_dir=use_existing_dir, create_prefix=create_prefix,
1903
                    force_new_repo=force_new_repo, stacked_on=stacked_on,
1904
                    stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
1905
                    make_working_trees=make_working_trees, shared_repo=shared_repo)
4294.2.4 by Robert Collins
Move dir, bzrdir and repo acquisition into a single method on bzrdir format.
1906
        # XXX: Refactor the create_prefix/no_create_prefix code into a
1907
        #      common helper function
1908
        # The destination may not exist - if so make it according to policy.
1909
        def make_directory(transport):
1910
            transport.mkdir('.')
1911
            return transport
1912
        def redirected(transport, e, redirection_notice):
1913
            note(redirection_notice)
1914
            return transport._redirected_to(e.source, e.target)
1915
        try:
1916
            transport = do_catching_redirections(make_directory, transport,
1917
                redirected)
1918
        except errors.FileExists:
1919
            if not use_existing_dir:
1920
                raise
1921
        except errors.NoSuchFile:
1922
            if not create_prefix:
1923
                raise
1924
            transport.create_prefix()
1925
1926
        require_stacking = (stacked_on is not None)
1927
        # Now the target directory exists, but doesn't have a .bzr
1928
        # directory. So we need to create it, along with any work to create
1929
        # all of the dependent branches, etc.
4294.2.5 by Robert Collins
Reasonable unit test coverage for initialize_on_transport_ex.
1930
4294.2.4 by Robert Collins
Move dir, bzrdir and repo acquisition into a single method on bzrdir format.
1931
        result = self.initialize_on_transport(transport)
1932
        if repo_format_name:
4294.2.5 by Robert Collins
Reasonable unit test coverage for initialize_on_transport_ex.
1933
            try:
1934
                # use a custom format
1935
                result._format.repository_format = \
1936
                    repository.network_format_registry.get(repo_format_name)
1937
            except AttributeError:
1938
                # The format didn't permit it to be set.
1939
                pass
4294.2.4 by Robert Collins
Move dir, bzrdir and repo acquisition into a single method on bzrdir format.
1940
            # A repository is desired, either in-place or shared.
1941
            repository_policy = result.determine_repository_policy(
1942
                force_new_repo, stacked_on, stack_on_pwd,
1943
                require_stacking=require_stacking)
1944
            result_repo, is_new_repo = repository_policy.acquire_repository(
1945
                make_working_trees, shared_repo)
1946
            if not require_stacking and repository_policy._require_stacking:
1947
                require_stacking = True
1948
                result._format.require_stacking()
1949
        else:
1950
            result_repo = None
1951
            repository_policy = None
1952
        return result_repo, result, require_stacking, repository_policy
1953
4017.2.2 by Robert Collins
Perform creation of BzrDirMetaFormat1 control directories using an RPC where possible. (Robert Collins)
1954
    def _initialize_on_transport_vfs(self, transport):
1955
        """Initialize a new bzrdir using VFS calls.
4032.1.2 by John Arbash Meinel
Track down a few more files that have trailing whitespace.
1956
4017.2.2 by Robert Collins
Perform creation of BzrDirMetaFormat1 control directories using an RPC where possible. (Robert Collins)
1957
        :param transport: The transport to create the .bzr directory in.
1958
        :return: A
1959
        """
1960
        # Since we are creating a .bzr directory, inherit the
1534.4.39 by Robert Collins
Basic BzrDir support.
1961
        # mode from the root directory
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
1962
        temp_control = lockable_files.LockableFiles(transport,
1963
                            '', lockable_files.TransportLock)
1534.4.39 by Robert Collins
Basic BzrDir support.
1964
        temp_control._transport.mkdir('.bzr',
1759.2.2 by Jelmer Vernooij
Revert some of my spelling fixes and fix some typos after review by Aaron.
1965
                                      # FIXME: RBC 20060121 don't peek under
1534.4.39 by Robert Collins
Basic BzrDir support.
1966
                                      # the covers
1967
                                      mode=temp_control._dir_mode)
3224.5.24 by Andrew Bennetts
More minor import tidying suggested by pyflakes.
1968
        if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
3023.1.2 by Alexander Belchenko
Martin's review.
1969
            win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1534.4.39 by Robert Collins
Basic BzrDir support.
1970
        file_mode = temp_control._file_mode
1971
        del temp_control
3407.2.5 by Martin Pool
Deprecate LockableFiles.put_utf8
1972
        bzrdir_transport = transport.clone('.bzr')
1973
        utf8_files = [('README',
3250.2.1 by Marius Kruger
update .bzr/README to not refer to Bazaar-NG, and add link to website.
1974
                       "This is a Bazaar control directory.\n"
1975
                       "Do not change any files in this directory.\n"
1976
                       "See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
1534.4.39 by Robert Collins
Basic BzrDir support.
1977
                      ('branch-format', self.get_format_string()),
1978
                      ]
1979
        # NB: no need to escape relative paths that are url safe.
3407.2.5 by Martin Pool
Deprecate LockableFiles.put_utf8
1980
        control_files = lockable_files.LockableFiles(bzrdir_transport,
1981
            self._lock_file_name, self._lock_class)
1553.5.60 by Martin Pool
New LockableFiles.create_lock() method
1982
        control_files.create_lock()
1534.4.39 by Robert Collins
Basic BzrDir support.
1983
        control_files.lock_write()
1984
        try:
3407.2.5 by Martin Pool
Deprecate LockableFiles.put_utf8
1985
            for (filename, content) in utf8_files:
3407.2.12 by Martin Pool
Fix creation mode of control files
1986
                bzrdir_transport.put_bytes(filename, content,
1987
                    mode=file_mode)
1534.4.39 by Robert Collins
Basic BzrDir support.
1988
        finally:
1989
            control_files.unlock()
4017.2.2 by Robert Collins
Perform creation of BzrDirMetaFormat1 control directories using an RPC where possible. (Robert Collins)
1990
        return self.open(transport, _found=True)
1534.4.39 by Robert Collins
Basic BzrDir support.
1991
1992
    def is_supported(self):
1993
        """Is this format supported?
1994
1995
        Supported formats must be initializable and openable.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1996
        Unsupported formats may not support initialization or committing or
1534.4.39 by Robert Collins
Basic BzrDir support.
1997
        some other features depending on the reason for not being supported.
1998
        """
1999
        return True
2000
4070.2.1 by Robert Collins
Add a BzrDirFormat.network_name.
2001
    def network_name(self):
2002
        """A simple byte string uniquely identifying this format for RPC calls.
2003
2004
        Bzr control formats use thir disk format string to identify the format
2005
        over the wire. Its possible that other control formats have more
2006
        complex detection requirements, so we permit them to use any unique and
2007
        immutable string they desire.
2008
        """
2009
        raise NotImplementedError(self.network_name)
2010
1910.2.14 by Aaron Bentley
Fail when trying to use interrepository on Knit2 and Knit1
2011
    def same_model(self, target_format):
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2012
        return (self.repository_format.rich_root_data ==
1910.2.14 by Aaron Bentley
Fail when trying to use interrepository on Knit2 and Knit1
2013
            target_format.rich_root_data)
2014
1733.1.3 by Robert Collins
Extend the test suite to run bzrdir conformance tests on non .bzr based control dirs.
2015
    @classmethod
2016
    def known_formats(klass):
2017
        """Return all the known formats.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2018
1733.1.3 by Robert Collins
Extend the test suite to run bzrdir conformance tests on non .bzr based control dirs.
2019
        Concrete formats should override _known_formats.
2020
        """
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2021
        # There is double indirection here to make sure that control
2022
        # formats used by more than one dir format will only be probed
1733.1.6 by Jelmer Vernooij
Fix a couple of minor issues after review by Martin.
2023
        # once. This can otherwise be quite expensive for remote connections.
1733.1.3 by Robert Collins
Extend the test suite to run bzrdir conformance tests on non .bzr based control dirs.
2024
        result = set()
2025
        for format in klass._control_formats:
2026
            result.update(format._known_formats())
2027
        return result
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2028
1733.1.3 by Robert Collins
Extend the test suite to run bzrdir conformance tests on non .bzr based control dirs.
2029
    @classmethod
2030
    def _known_formats(klass):
2031
        """Return the known format instances for this control format."""
2032
        return set(klass._formats.values())
2033
1534.4.39 by Robert Collins
Basic BzrDir support.
2034
    def open(self, transport, _found=False):
2035
        """Return an instance of this format for the dir transport points at.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2036
1534.4.39 by Robert Collins
Basic BzrDir support.
2037
        _found is a private parameter, do not use it.
2038
        """
2039
        if not _found:
2090.2.2 by Martin Pool
Fix an assertion with side effects
2040
            found_format = BzrDirFormat.find_format(transport)
2041
            if not isinstance(found_format, self.__class__):
2042
                raise AssertionError("%s was asked to open %s, but it seems to need "
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2043
                        "format %s"
2090.2.2 by Martin Pool
Fix an assertion with side effects
2044
                        % (self, transport, found_format))
4005.2.1 by Robert Collins
Fix RemoteBranch to be used correctly in tests using bzr+ssh, to fire off Branch hooks correctly, and improve the branch_implementations tests to check that making a branch gets the right format under test.
2045
            # Allow subclasses - use the found format.
2046
            self._supply_sub_formats_to(found_format)
2047
            return found_format._open(transport)
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
2048
        return self._open(transport)
2049
2050
    def _open(self, transport):
2051
        """Template method helper for opening BzrDirectories.
2052
2053
        This performs the actual open and any additional logic or parameter
2054
        passing.
2055
        """
2056
        raise NotImplementedError(self._open)
1534.4.39 by Robert Collins
Basic BzrDir support.
2057
2058
    @classmethod
2059
    def register_format(klass, format):
2060
        klass._formats[format.get_format_string()] = format
4070.2.1 by Robert Collins
Add a BzrDirFormat.network_name.
2061
        # bzr native formats have a network name of their format string.
4075.2.1 by Robert Collins
Audit and make sure we are registering network_name's as factories, not instances.
2062
        network_format_registry.register(format.get_format_string(), format.__class__)
1534.4.39 by Robert Collins
Basic BzrDir support.
2063
2064
    @classmethod
1733.1.1 by Robert Collins
Support non '.bzr' control directories in bzrdir.
2065
    def register_control_format(klass, format):
2164.2.13 by v.ladeuil+lp at free
Add tests for redirection. Preserve transport decorations.
2066
        """Register a format that does not use '.bzr' for its control dir.
1733.1.1 by Robert Collins
Support non '.bzr' control directories in bzrdir.
2067
2068
        TODO: This should be pulled up into a 'ControlDirFormat' base class
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2069
        which BzrDirFormat can inherit from, and renamed to register_format
1733.1.1 by Robert Collins
Support non '.bzr' control directories in bzrdir.
2070
        there. It has been done without that for now for simplicity of
2071
        implementation.
2072
        """
1733.1.7 by Jelmer Vernooij
Change set of control dir formats to list.
2073
        klass._control_formats.append(format)
1733.1.1 by Robert Collins
Support non '.bzr' control directories in bzrdir.
2074
2075
    @classmethod
2018.5.163 by Andrew Bennetts
Deal with various review comments from Robert.
2076
    def register_control_server_format(klass, format):
2077
        """Register a control format for client-server environments.
2078
2079
        These formats will be tried before ones registered with
2080
        register_control_format.  This gives implementations that decide to the
2081
        chance to grab it before anything looks at the contents of the format
2082
        file.
2083
        """
2018.5.169 by Andrew Bennetts
Add a _server_formats flag to BzrDir.open_from_transport and BzrDirFormat.find_format, make RemoteBranch.control_files into a property.
2084
        klass._control_server_formats.append(format)
2018.5.163 by Andrew Bennetts
Deal with various review comments from Robert.
2085
2086
    @classmethod
2204.4.13 by Aaron Bentley
Update all test cases to avoid set_default_format
2087
    def _set_default_format(klass, format):
2088
        """Set default format (for testing behavior of defaults only)"""
2089
        klass._default_format = format
2090
1534.5.1 by Robert Collins
Give info some reasonable output and tests.
2091
    def __str__(self):
2830.1.1 by Ian Clatworthy
bzrdir.py code clean-ups
2092
        # Trim the newline
4032.3.2 by Robert Collins
Create and use a RPC call to create branches on bzr servers rather than using VFS calls.
2093
        return self.get_format_description().rstrip()
1534.5.1 by Robert Collins
Give info some reasonable output and tests.
2094
4005.2.1 by Robert Collins
Fix RemoteBranch to be used correctly in tests using bzr+ssh, to fire off Branch hooks correctly, and improve the branch_implementations tests to check that making a branch gets the right format under test.
2095
    def _supply_sub_formats_to(self, other_format):
2096
        """Give other_format the same values for sub formats as this has.
2097
2098
        This method is expected to be used when parameterising a
2099
        RemoteBzrDirFormat instance with the parameters from a
2100
        BzrDirMetaFormat1 instance.
2101
2102
        :param other_format: other_format is a format which should be
2103
            compatible with whatever sub formats are supported by self.
2104
        :return: None.
2105
        """
2106
1534.4.39 by Robert Collins
Basic BzrDir support.
2107
    @classmethod
2108
    def unregister_format(klass, format):
2109
        del klass._formats[format.get_format_string()]
2110
1733.1.1 by Robert Collins
Support non '.bzr' control directories in bzrdir.
2111
    @classmethod
2112
    def unregister_control_format(klass, format):
2113
        klass._control_formats.remove(format)
2114
2115
1534.4.39 by Robert Collins
Basic BzrDir support.
2116
class BzrDirFormat4(BzrDirFormat):
2117
    """Bzr dir format 4.
2118
2119
    This format is a combined format for working tree, branch and repository.
2120
    It has:
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2121
     - Format 1 working trees [always]
2122
     - Format 4 branches [always]
2123
     - Format 4 repositories [always]
1534.4.39 by Robert Collins
Basic BzrDir support.
2124
2125
    This format is deprecated: it indexes texts using a text it which is
2126
    removed in format 5; write support for this format has been removed.
2127
    """
2128
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
2129
    _lock_class = lockable_files.TransportLock
1553.5.69 by Martin Pool
BzrDirFormat subclasses can now control what kind of overall lock is used.
2130
1534.4.39 by Robert Collins
Basic BzrDir support.
2131
    def get_format_string(self):
2132
        """See BzrDirFormat.get_format_string()."""
2133
        return "Bazaar-NG branch, format 0.0.4\n"
2134
1624.3.19 by Olaf Conradi
New call get_format_description to give a user-friendly description of a
2135
    def get_format_description(self):
2136
        """See BzrDirFormat.get_format_description()."""
2137
        return "All-in-one format 4"
2138
1534.5.16 by Robert Collins
Review feedback.
2139
    def get_converter(self, format=None):
2140
        """See BzrDirFormat.get_converter()."""
1534.5.13 by Robert Collins
Correct buggy test.
2141
        # there is one and only one upgrade path here.
1534.5.10 by Robert Collins
Make upgrade driver unaware of the specific formats in play.
2142
        return ConvertBzrDir4To5()
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2143
1651.1.6 by Martin Pool
Clean up clone-bzrdir code
2144
    def initialize_on_transport(self, transport):
1534.4.39 by Robert Collins
Basic BzrDir support.
2145
        """Format 4 branches cannot be created."""
2146
        raise errors.UninitializableFormat(self)
2147
2148
    def is_supported(self):
2149
        """Format 4 is not supported.
2150
2151
        It is not supported because the model changed from 4 to 5 and the
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2152
        conversion logic is expensive - so doing it on the fly was not
1534.4.39 by Robert Collins
Basic BzrDir support.
2153
        feasible.
2154
        """
2155
        return False
2156
4070.2.1 by Robert Collins
Add a BzrDirFormat.network_name.
2157
    def network_name(self):
2158
        return self.get_format_string()
2159
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
2160
    def _open(self, transport):
2161
        """See BzrDirFormat._open."""
2162
        return BzrDir4(transport, self)
2163
1556.1.4 by Robert Collins
Add a new format for what will become knit, and the surrounding logic to upgrade repositories within metadirs, and tests for the same.
2164
    def __return_repository_format(self):
2165
        """Circular import protection."""
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
2166
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
1910.2.12 by Aaron Bentley
Implement knit repo format 2
2167
        return RepositoryFormat4()
1556.1.4 by Robert Collins
Add a new format for what will become knit, and the surrounding logic to upgrade repositories within metadirs, and tests for the same.
2168
    repository_format = property(__return_repository_format)
2169
1534.4.39 by Robert Collins
Basic BzrDir support.
2170
4294.2.5 by Robert Collins
Reasonable unit test coverage for initialize_on_transport_ex.
2171
class BzrDirFormatAllInOne(BzrDirFormat):
2172
    """Common class for formats before meta-dirs."""
2173
2174
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2175
        create_prefix=False, force_new_repo=False, stacked_on=None,
2176
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2177
        shared_repo=False):
2178
        """See BzrDirFormat.initialize_on_transport_ex."""
2179
        require_stacking = (stacked_on is not None)
4294.2.10 by Robert Collins
Review feedback.
2180
        # Format 5 cannot stack, but we've been asked to - actually init
4294.2.5 by Robert Collins
Reasonable unit test coverage for initialize_on_transport_ex.
2181
        # a Meta1Dir
2182
        if require_stacking:
2183
            format = BzrDirMetaFormat1()
2184
            return format.initialize_on_transport_ex(transport,
2185
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2186
                force_new_repo=force_new_repo, stacked_on=stacked_on,
2187
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2188
                make_working_trees=make_working_trees, shared_repo=shared_repo)
2189
        return BzrDirFormat.initialize_on_transport_ex(self, transport,
2190
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2191
            force_new_repo=force_new_repo, stacked_on=stacked_on,
2192
            stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2193
            make_working_trees=make_working_trees, shared_repo=shared_repo)
2194
2195
2196
class BzrDirFormat5(BzrDirFormatAllInOne):
1534.4.39 by Robert Collins
Basic BzrDir support.
2197
    """Bzr control format 5.
2198
2199
    This format is a combined format for working tree, branch and repository.
2200
    It has:
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2201
     - Format 2 working trees [always]
2202
     - Format 4 branches [always]
1534.4.53 by Robert Collins
Review feedback from John Meinel.
2203
     - Format 5 repositories [always]
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2204
       Unhashed stores in the repository.
1534.4.39 by Robert Collins
Basic BzrDir support.
2205
    """
2206
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
2207
    _lock_class = lockable_files.TransportLock
1553.5.69 by Martin Pool
BzrDirFormat subclasses can now control what kind of overall lock is used.
2208
1534.4.39 by Robert Collins
Basic BzrDir support.
2209
    def get_format_string(self):
2210
        """See BzrDirFormat.get_format_string()."""
2211
        return "Bazaar-NG branch, format 5\n"
2212
3650.2.2 by Aaron Bentley
Implement get_branch_format, to unify branch creation code
2213
    def get_branch_format(self):
2214
        from bzrlib import branch
2215
        return branch.BzrBranchFormat4()
2216
1624.3.19 by Olaf Conradi
New call get_format_description to give a user-friendly description of a
2217
    def get_format_description(self):
2218
        """See BzrDirFormat.get_format_description()."""
2219
        return "All-in-one format 5"
2220
1534.5.16 by Robert Collins
Review feedback.
2221
    def get_converter(self, format=None):
2222
        """See BzrDirFormat.get_converter()."""
1534.5.13 by Robert Collins
Correct buggy test.
2223
        # there is one and only one upgrade path here.
1534.5.10 by Robert Collins
Make upgrade driver unaware of the specific formats in play.
2224
        return ConvertBzrDir5To6()
1651.1.6 by Martin Pool
Clean up clone-bzrdir code
2225
2226
    def _initialize_for_clone(self, url):
2227
        return self.initialize_on_transport(get_transport(url), _cloning=True)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2228
1608.2.8 by Martin Pool
Separate out BzrDir.initialize_on_transport so it
2229
    def initialize_on_transport(self, transport, _cloning=False):
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2230
        """Format 5 dirs always have working tree, branch and repository.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2231
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2232
        Except when they are being cloned.
2233
        """
2234
        from bzrlib.branch import BzrBranchFormat4
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
2235
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1651.1.6 by Martin Pool
Clean up clone-bzrdir code
2236
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2237
        RepositoryFormat5().initialize(result, _internal=True)
2238
        if not _cloning:
1910.5.1 by Andrew Bennetts
Make some old formats create at least a stub working tree rather than incomplete bzrdirs, and change some tests to use the test suite transport rather than hard-coded to local-only.
2239
            branch = BzrBranchFormat4().initialize(result)
3650.5.6 by Aaron Bentley
Fix cloning problems by creating missing working tree files
2240
            result._init_workingtree()
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2241
        return result
2242
4070.2.1 by Robert Collins
Add a BzrDirFormat.network_name.
2243
    def network_name(self):
2244
        return self.get_format_string()
2245
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
2246
    def _open(self, transport):
2247
        """See BzrDirFormat._open."""
2248
        return BzrDir5(transport, self)
2249
1556.1.4 by Robert Collins
Add a new format for what will become knit, and the surrounding logic to upgrade repositories within metadirs, and tests for the same.
2250
    def __return_repository_format(self):
2251
        """Circular import protection."""
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
2252
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1910.2.12 by Aaron Bentley
Implement knit repo format 2
2253
        return RepositoryFormat5()
1556.1.4 by Robert Collins
Add a new format for what will become knit, and the surrounding logic to upgrade repositories within metadirs, and tests for the same.
2254
    repository_format = property(__return_repository_format)
2255
1534.4.39 by Robert Collins
Basic BzrDir support.
2256
4294.2.5 by Robert Collins
Reasonable unit test coverage for initialize_on_transport_ex.
2257
class BzrDirFormat6(BzrDirFormatAllInOne):
1534.4.39 by Robert Collins
Basic BzrDir support.
2258
    """Bzr control format 6.
2259
2260
    This format is a combined format for working tree, branch and repository.
2261
    It has:
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2262
     - Format 2 working trees [always]
2263
     - Format 4 branches [always]
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2264
     - Format 6 repositories [always]
1534.4.39 by Robert Collins
Basic BzrDir support.
2265
    """
2266
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
2267
    _lock_class = lockable_files.TransportLock
1553.5.69 by Martin Pool
BzrDirFormat subclasses can now control what kind of overall lock is used.
2268
1534.4.39 by Robert Collins
Basic BzrDir support.
2269
    def get_format_string(self):
2270
        """See BzrDirFormat.get_format_string()."""
2271
        return "Bazaar-NG branch, format 6\n"
2272
1624.3.19 by Olaf Conradi
New call get_format_description to give a user-friendly description of a
2273
    def get_format_description(self):
2274
        """See BzrDirFormat.get_format_description()."""
2275
        return "All-in-one format 6"
2276
3650.2.2 by Aaron Bentley
Implement get_branch_format, to unify branch creation code
2277
    def get_branch_format(self):
2278
        from bzrlib import branch
2279
        return branch.BzrBranchFormat4()
2280
1534.5.16 by Robert Collins
Review feedback.
2281
    def get_converter(self, format=None):
2282
        """See BzrDirFormat.get_converter()."""
1534.5.13 by Robert Collins
Correct buggy test.
2283
        # there is one and only one upgrade path here.
1534.5.10 by Robert Collins
Make upgrade driver unaware of the specific formats in play.
2284
        return ConvertBzrDir6ToMeta()
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2285
1651.1.6 by Martin Pool
Clean up clone-bzrdir code
2286
    def _initialize_for_clone(self, url):
2287
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2288
1608.2.8 by Martin Pool
Separate out BzrDir.initialize_on_transport so it
2289
    def initialize_on_transport(self, transport, _cloning=False):
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2290
        """Format 6 dirs always have working tree, branch and repository.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2291
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2292
        Except when they are being cloned.
2293
        """
2294
        from bzrlib.branch import BzrBranchFormat4
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
2295
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1651.1.6 by Martin Pool
Clean up clone-bzrdir code
2296
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2297
        RepositoryFormat6().initialize(result, _internal=True)
2298
        if not _cloning:
1910.5.1 by Andrew Bennetts
Make some old formats create at least a stub working tree rather than incomplete bzrdirs, and change some tests to use the test suite transport rather than hard-coded to local-only.
2299
            branch = BzrBranchFormat4().initialize(result)
3650.5.7 by Aaron Bentley
Fix working tree initialization
2300
            result._init_workingtree()
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2301
        return result
2302
4070.2.1 by Robert Collins
Add a BzrDirFormat.network_name.
2303
    def network_name(self):
2304
        return self.get_format_string()
2305
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
2306
    def _open(self, transport):
2307
        """See BzrDirFormat._open."""
2308
        return BzrDir6(transport, self)
2309
1556.1.4 by Robert Collins
Add a new format for what will become knit, and the surrounding logic to upgrade repositories within metadirs, and tests for the same.
2310
    def __return_repository_format(self):
2311
        """Circular import protection."""
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
2312
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1910.2.12 by Aaron Bentley
Implement knit repo format 2
2313
        return RepositoryFormat6()
1556.1.4 by Robert Collins
Add a new format for what will become knit, and the surrounding logic to upgrade repositories within metadirs, and tests for the same.
2314
    repository_format = property(__return_repository_format)
2315
1534.4.39 by Robert Collins
Basic BzrDir support.
2316
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
2317
class BzrDirMetaFormat1(BzrDirFormat):
2318
    """Bzr meta control format 1
2319
2320
    This is the first format with split out working tree, branch and repository
2321
    disk storage.
2322
    It has:
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2323
     - Format 3 working trees [optional]
2324
     - Format 5 branches [optional]
2325
     - Format 7 repositories [optional]
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
2326
    """
2327
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
2328
    _lock_class = lockdir.LockDir
1553.5.69 by Martin Pool
BzrDirFormat subclasses can now control what kind of overall lock is used.
2329
2100.3.10 by Aaron Bentley
Ensure added references are serialized properly, beef up Workingtreee3
2330
    def __init__(self):
2331
        self._workingtree_format = None
2230.3.1 by Aaron Bentley
Get branch6 creation working
2332
        self._branch_format = None
4070.2.3 by Robert Collins
Get BzrDir.cloning_metadir working.
2333
        self._repository_format = None
2100.3.10 by Aaron Bentley
Ensure added references are serialized properly, beef up Workingtreee3
2334
2100.3.15 by Aaron Bentley
get test suite passing
2335
    def __eq__(self, other):
2336
        if other.__class__ is not self.__class__:
2337
            return False
2338
        if other.repository_format != self.repository_format:
2339
            return False
2340
        if other.workingtree_format != self.workingtree_format:
2341
            return False
2342
        return True
2343
2100.3.35 by Aaron Bentley
equality operations on bzrdir
2344
    def __ne__(self, other):
2345
        return not self == other
2346
2230.3.55 by Aaron Bentley
Updates from review
2347
    def get_branch_format(self):
2230.3.1 by Aaron Bentley
Get branch6 creation working
2348
        if self._branch_format is None:
2349
            from bzrlib.branch import BranchFormat
2350
            self._branch_format = BranchFormat.get_default_format()
2351
        return self._branch_format
2352
2230.3.55 by Aaron Bentley
Updates from review
2353
    def set_branch_format(self, format):
2230.3.1 by Aaron Bentley
Get branch6 creation working
2354
        self._branch_format = format
2355
3904.3.1 by Andrew Bennetts
Probable fix for GaryvdM's bug when pushing a stacked qbzr branch to Launchpad.
2356
    def require_stacking(self):
2357
        if not self.get_branch_format().supports_stacking():
2358
            # We need to make a stacked branch, but the default format for the
2359
            # target doesn't support stacking.  So force a branch that *can*
2360
            # support stacking.
2361
            from bzrlib.branch import BzrBranchFormat7
4032.3.2 by Robert Collins
Create and use a RPC call to create branches on bzr servers rather than using VFS calls.
2362
            branch_format = BzrBranchFormat7()
2363
            self.set_branch_format(branch_format)
2364
            mutter("using %r for stacking" % (branch_format,))
3904.3.1 by Andrew Bennetts
Probable fix for GaryvdM's bug when pushing a stacked qbzr branch to Launchpad.
2365
            from bzrlib.repofmt import pack_repo
2366
            if self.repository_format.rich_root_data:
2367
                bzrdir_format_name = '1.6.1-rich-root'
2368
                repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2369
            else:
2370
                bzrdir_format_name = '1.6'
2371
                repo_format = pack_repo.RepositoryFormatKnitPack5()
2372
            note('Source format does not support stacking, using format:'
2373
                 ' \'%s\'\n  %s\n',
2374
                 bzrdir_format_name, repo_format.get_format_description())
2375
            self.repository_format = repo_format
2376
1556.1.4 by Robert Collins
Add a new format for what will become knit, and the surrounding logic to upgrade repositories within metadirs, and tests for the same.
2377
    def get_converter(self, format=None):
2378
        """See BzrDirFormat.get_converter()."""
2379
        if format is None:
2380
            format = BzrDirFormat.get_default_format()
2381
        if not isinstance(self, format.__class__):
2382
            # converting away from metadir is not implemented
2383
            raise NotImplementedError(self.get_converter)
2384
        return ConvertMetaToMeta(format)
2385
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
2386
    def get_format_string(self):
2387
        """See BzrDirFormat.get_format_string()."""
2388
        return "Bazaar-NG meta directory, format 1\n"
2389
1624.3.19 by Olaf Conradi
New call get_format_description to give a user-friendly description of a
2390
    def get_format_description(self):
2391
        """See BzrDirFormat.get_format_description()."""
2392
        return "Meta directory format 1"
2393
4070.2.1 by Robert Collins
Add a BzrDirFormat.network_name.
2394
    def network_name(self):
2395
        return self.get_format_string()
2396
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
2397
    def _open(self, transport):
2398
        """See BzrDirFormat._open."""
4294.2.12 by Robert Collins
Prevent aliasing issues with BzrDirMetaFormat1 by making a new format object in _open.
2399
        # Create a new format instance because otherwise initialisation of new
2400
        # metadirs share the global default format object leading to alias
2401
        # problems.
2402
        format = BzrDirMetaFormat1()
2403
        self._supply_sub_formats_to(format)
2404
        return BzrDirMeta1(transport, format)
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
2405
1556.1.4 by Robert Collins
Add a new format for what will become knit, and the surrounding logic to upgrade repositories within metadirs, and tests for the same.
2406
    def __return_repository_format(self):
2407
        """Circular import protection."""
4070.2.3 by Robert Collins
Get BzrDir.cloning_metadir working.
2408
        if self._repository_format:
1556.1.4 by Robert Collins
Add a new format for what will become knit, and the surrounding logic to upgrade repositories within metadirs, and tests for the same.
2409
            return self._repository_format
2410
        from bzrlib.repository import RepositoryFormat
2411
        return RepositoryFormat.get_default_format()
2412
4005.2.1 by Robert Collins
Fix RemoteBranch to be used correctly in tests using bzr+ssh, to fire off Branch hooks correctly, and improve the branch_implementations tests to check that making a branch gets the right format under test.
2413
    def _set_repository_format(self, value):
3015.2.8 by Robert Collins
Typo in __set_repository_format's docstring.
2414
        """Allow changing the repository format for metadir formats."""
1556.1.4 by Robert Collins
Add a new format for what will become knit, and the surrounding logic to upgrade repositories within metadirs, and tests for the same.
2415
        self._repository_format = value
1553.5.72 by Martin Pool
Clean up test for Branch5 lockdirs
2416
4005.2.1 by Robert Collins
Fix RemoteBranch to be used correctly in tests using bzr+ssh, to fire off Branch hooks correctly, and improve the branch_implementations tests to check that making a branch gets the right format under test.
2417
    repository_format = property(__return_repository_format,
2418
        _set_repository_format)
2419
2420
    def _supply_sub_formats_to(self, other_format):
2421
        """Give other_format the same values for sub formats as this has.
2422
2423
        This method is expected to be used when parameterising a
2424
        RemoteBzrDirFormat instance with the parameters from a
2425
        BzrDirMetaFormat1 instance.
2426
2427
        :param other_format: other_format is a format which should be
2428
            compatible with whatever sub formats are supported by self.
2429
        :return: None.
2430
        """
2431
        if getattr(self, '_repository_format', None) is not None:
2432
            other_format.repository_format = self.repository_format
2433
        if self._branch_format is not None:
2434
            other_format._branch_format = self._branch_format
2435
        if self._workingtree_format is not None:
2436
            other_format.workingtree_format = self.workingtree_format
1556.1.4 by Robert Collins
Add a new format for what will become knit, and the surrounding logic to upgrade repositories within metadirs, and tests for the same.
2437
2100.3.10 by Aaron Bentley
Ensure added references are serialized properly, beef up Workingtreee3
2438
    def __get_workingtree_format(self):
2439
        if self._workingtree_format is None:
2440
            from bzrlib.workingtree import WorkingTreeFormat
2441
            self._workingtree_format = WorkingTreeFormat.get_default_format()
2442
        return self._workingtree_format
2443
2444
    def __set_workingtree_format(self, wt_format):
2445
        self._workingtree_format = wt_format
2446
2447
    workingtree_format = property(__get_workingtree_format,
2448
                                  __set_workingtree_format)
2449
1534.4.44 by Robert Collins
Make a new BzrDir format that uses a versioned branch format in a branch/ subdirectory.
2450
4070.2.1 by Robert Collins
Add a BzrDirFormat.network_name.
2451
network_format_registry = registry.FormatRegistry()
2452
"""Registry of formats indexed by their network name.
2453
2454
The network name for a BzrDirFormat is an identifier that can be used when
2455
referring to formats with smart server operations. See
2456
BzrDirFormat.network_name() for more detail.
2457
"""
2458
2459
2164.2.19 by Vincent Ladeuil
Revert BzrDirFormat1 registering.
2460
# Register bzr control format
2461
BzrDirFormat.register_control_format(BzrDirFormat)
2164.2.13 by v.ladeuil+lp at free
Add tests for redirection. Preserve transport decorations.
2462
2463
# Register bzr formats
1534.4.39 by Robert Collins
Basic BzrDir support.
2464
BzrDirFormat.register_format(BzrDirFormat4())
2465
BzrDirFormat.register_format(BzrDirFormat5())
1666.1.4 by Robert Collins
* 'Metadir' is now the default disk format. This improves behaviour in
2466
BzrDirFormat.register_format(BzrDirFormat6())
2467
__default_format = BzrDirMetaFormat1()
1534.4.39 by Robert Collins
Basic BzrDir support.
2468
BzrDirFormat.register_format(__default_format)
2204.4.13 by Aaron Bentley
Update all test cases to avoid set_default_format
2469
BzrDirFormat._default_format = __default_format
1534.4.39 by Robert Collins
Basic BzrDir support.
2470
2471
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2472
class Converter(object):
2473
    """Converts a disk format object from one format to another."""
2474
1534.5.10 by Robert Collins
Make upgrade driver unaware of the specific formats in play.
2475
    def convert(self, to_convert, pb):
2476
        """Perform the conversion of to_convert, giving feedback via pb.
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2477
1534.5.10 by Robert Collins
Make upgrade driver unaware of the specific formats in play.
2478
        :param to_convert: The disk object to convert.
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2479
        :param pb: a progress bar to use for progress information.
2480
        """
2481
1556.1.4 by Robert Collins
Add a new format for what will become knit, and the surrounding logic to upgrade repositories within metadirs, and tests for the same.
2482
    def step(self, message):
2483
        """Update the pb by a step."""
2484
        self.count +=1
2485
        self.pb.update(message, self.count, self.total)
2486
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2487
2488
class ConvertBzrDir4To5(Converter):
2489
    """Converts format 4 bzr dirs to format 5."""
2490
1534.5.10 by Robert Collins
Make upgrade driver unaware of the specific formats in play.
2491
    def __init__(self):
2492
        super(ConvertBzrDir4To5, self).__init__()
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2493
        self.converted_revs = set()
2494
        self.absent_revisions = set()
2495
        self.text_count = 0
2496
        self.revisions = {}
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2497
1534.5.10 by Robert Collins
Make upgrade driver unaware of the specific formats in play.
2498
    def convert(self, to_convert, pb):
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2499
        """See Converter.convert()."""
1534.5.10 by Robert Collins
Make upgrade driver unaware of the specific formats in play.
2500
        self.bzrdir = to_convert
2501
        self.pb = pb
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2502
        self.pb.note('starting upgrade from format 4 to 5')
3224.5.24 by Andrew Bennetts
More minor import tidying suggested by pyflakes.
2503
        if isinstance(self.bzrdir.transport, local.LocalTransport):
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2504
            self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2505
        self._convert_to_weaves()
2506
        return BzrDir.open(self.bzrdir.root_transport.base)
2507
2508
    def _convert_to_weaves(self):
2509
        self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2510
        try:
2511
            # TODO permissions
2512
            stat = self.bzrdir.transport.stat('weaves')
2513
            if not S_ISDIR(stat.st_mode):
2514
                self.bzrdir.transport.delete('weaves')
2515
                self.bzrdir.transport.mkdir('weaves')
2516
        except errors.NoSuchFile:
2517
            self.bzrdir.transport.mkdir('weaves')
1563.2.10 by Robert Collins
Change weave store to be a versioned store, using WeaveFiles which maintain integrity without needing explicit 'put' operations.
2518
        # deliberately not a WeaveFile as we want to build it up slowly.
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2519
        self.inv_weave = Weave('inventory')
2520
        # holds in-memory weaves for all files
2521
        self.text_weaves = {}
2522
        self.bzrdir.transport.delete('branch-format')
2523
        self.branch = self.bzrdir.open_branch()
2524
        self._convert_working_inv()
2525
        rev_history = self.branch.revision_history()
2526
        # to_read is a stack holding the revisions we still need to process;
2527
        # appending to it adds new highest-priority revisions
2528
        self.known_revisions = set(rev_history)
2529
        self.to_read = rev_history[-1:]
2530
        while self.to_read:
2531
            rev_id = self.to_read.pop()
2532
            if (rev_id not in self.revisions
2533
                and rev_id not in self.absent_revisions):
2534
                self._load_one_rev(rev_id)
2535
        self.pb.clear()
2536
        to_import = self._make_order()
2537
        for i, rev_id in enumerate(to_import):
2538
            self.pb.update('converting revision', i, len(to_import))
2539
            self._convert_one_rev(rev_id)
2540
        self.pb.clear()
2541
        self._write_all_weaves()
2542
        self._write_all_revs()
2543
        self.pb.note('upgraded to weaves:')
2544
        self.pb.note('  %6d revisions and inventories', len(self.revisions))
2545
        self.pb.note('  %6d revisions not present', len(self.absent_revisions))
2546
        self.pb.note('  %6d texts', self.text_count)
2547
        self._cleanup_spare_files_after_format4()
3407.2.13 by Martin Pool
Remove indirection through control_files to get transports
2548
        self.branch._transport.put_bytes(
3407.2.5 by Martin Pool
Deprecate LockableFiles.put_utf8
2549
            'branch-format',
2550
            BzrDirFormat5().get_format_string(),
3446.1.1 by Martin Pool
merge further LockableFile deprecations
2551
            mode=self.bzrdir._get_file_mode())
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2552
2553
    def _cleanup_spare_files_after_format4(self):
2554
        # FIXME working tree upgrade foo.
2555
        for n in 'merged-patches', 'pending-merged-patches':
2556
            try:
2557
                ## assert os.path.getsize(p) == 0
2558
                self.bzrdir.transport.delete(n)
2559
            except errors.NoSuchFile:
2560
                pass
2561
        self.bzrdir.transport.delete_tree('inventory-store')
2562
        self.bzrdir.transport.delete_tree('text-store')
2563
2564
    def _convert_working_inv(self):
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
2565
        inv = xml4.serializer_v4.read_inventory(
3407.2.1 by Martin Pool
Deprecate LockableFiles.get
2566
                self.branch._transport.get('inventory'))
2817.2.1 by Robert Collins
* Inventory serialisation no longer double-sha's the content.
2567
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
3407.2.1 by Martin Pool
Deprecate LockableFiles.get
2568
        self.branch._transport.put_bytes('inventory', new_inv_xml,
3446.1.1 by Martin Pool
merge further LockableFile deprecations
2569
            mode=self.bzrdir._get_file_mode())
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2570
2571
    def _write_all_weaves(self):
2572
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2573
        weave_transport = self.bzrdir.transport.clone('weaves')
2574
        weaves = WeaveStore(weave_transport, prefixed=False)
1563.2.34 by Robert Collins
Remove the commit and rollback transaction methods as misleading, and implement a WriteTransaction
2575
        transaction = WriteTransaction()
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2576
2577
        try:
1563.2.10 by Robert Collins
Change weave store to be a versioned store, using WeaveFiles which maintain integrity without needing explicit 'put' operations.
2578
            i = 0
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2579
            for file_id, file_weave in self.text_weaves.items():
2580
                self.pb.update('writing weave', i, len(self.text_weaves))
1563.2.10 by Robert Collins
Change weave store to be a versioned store, using WeaveFiles which maintain integrity without needing explicit 'put' operations.
2581
                weaves._put_weave(file_id, file_weave, transaction)
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2582
                i += 1
1563.2.10 by Robert Collins
Change weave store to be a versioned store, using WeaveFiles which maintain integrity without needing explicit 'put' operations.
2583
            self.pb.update('inventory', 0, 1)
2584
            controlweaves._put_weave('inventory', self.inv_weave, transaction)
2585
            self.pb.update('inventory', 1, 1)
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2586
        finally:
2587
            self.pb.clear()
2588
2589
    def _write_all_revs(self):
2590
        """Write all revisions out in new form."""
2591
        self.bzrdir.transport.delete_tree('revision-store')
2592
        self.bzrdir.transport.mkdir('revision-store')
2593
        revision_transport = self.bzrdir.transport.clone('revision-store')
2594
        # TODO permissions
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
2595
        from bzrlib.xml5 import serializer_v5
3350.6.10 by Martin Pool
VersionedFiles review cleanups
2596
        from bzrlib.repofmt.weaverepo import RevisionTextStore
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
2597
        revision_store = RevisionTextStore(revision_transport,
2598
            serializer_v5, False, versionedfile.PrefixMapper(),
2599
            lambda:True, lambda:True)
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2600
        try:
2601
            for i, rev_id in enumerate(self.converted_revs):
2602
                self.pb.update('write revision', i, len(self.converted_revs))
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
2603
                text = serializer_v5.write_revision_to_string(
2604
                    self.revisions[rev_id])
2605
                key = (rev_id,)
2606
                revision_store.add_lines(key, None, osutils.split_lines(text))
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2607
        finally:
2608
            self.pb.clear()
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2609
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2610
    def _load_one_rev(self, rev_id):
2611
        """Load a revision object into memory.
2612
2613
        Any parents not either loaded or abandoned get queued to be
2614
        loaded."""
2615
        self.pb.update('loading revision',
2616
                       len(self.revisions),
2617
                       len(self.known_revisions))
1563.2.22 by Robert Collins
Move responsibility for repository.has_revision into RevisionStore
2618
        if not self.branch.repository.has_revision(rev_id):
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2619
            self.pb.clear()
2620
            self.pb.note('revision {%s} not present in branch; '
2621
                         'will be converted as a ghost',
2622
                         rev_id)
2623
            self.absent_revisions.add(rev_id)
2624
        else:
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
2625
            rev = self.branch.repository.get_revision(rev_id)
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2626
            for parent_id in rev.parent_ids:
2627
                self.known_revisions.add(parent_id)
2628
                self.to_read.append(parent_id)
2629
            self.revisions[rev_id] = rev
2630
2631
    def _load_old_inventory(self, rev_id):
2632
        old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
2633
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
1910.2.36 by Aaron Bentley
Get upgrade from format4 under test and fixed for all formats
2634
        inv.revision_id = rev_id
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2635
        rev = self.revisions[rev_id]
2636
        return inv
2637
2638
    def _load_updated_inventory(self, rev_id):
2639
        inv_xml = self.inv_weave.get_text(rev_id)
3169.2.2 by Robert Collins
Add a test to Repository.deserialise_inventory that the resulting ivnentory is the one asked for, and update relevant tests. Also tweak the model 1 to 2 regenerate inventories logic to use the revision trees parent marker which is more accurate in some cases.
2640
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2641
        return inv
2642
2643
    def _convert_one_rev(self, rev_id):
2644
        """Convert revision and all referenced objects to new format."""
2645
        rev = self.revisions[rev_id]
2646
        inv = self._load_old_inventory(rev_id)
2647
        present_parents = [p for p in rev.parent_ids
2648
                           if p not in self.absent_revisions]
2649
        self._convert_revision_contents(rev, inv, present_parents)
2817.2.1 by Robert Collins
* Inventory serialisation no longer double-sha's the content.
2650
        self._store_new_inv(rev, inv, present_parents)
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2651
        self.converted_revs.add(rev_id)
2652
2817.2.1 by Robert Collins
* Inventory serialisation no longer double-sha's the content.
2653
    def _store_new_inv(self, rev, inv, present_parents):
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
2654
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2655
        new_inv_sha1 = sha_string(new_inv_xml)
2817.2.1 by Robert Collins
* Inventory serialisation no longer double-sha's the content.
2656
        self.inv_weave.add_lines(rev.revision_id,
1563.2.28 by Robert Collins
Add total_size to the revision_store api.
2657
                                 present_parents,
2658
                                 new_inv_xml.splitlines(True))
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2659
        rev.inventory_sha1 = new_inv_sha1
2660
2661
    def _convert_revision_contents(self, rev, inv, present_parents):
2662
        """Convert all the files within a revision.
2663
2664
        Also upgrade the inventory to refer to the text revision ids."""
2665
        rev_id = rev.revision_id
2666
        mutter('converting texts of revision {%s}',
2667
               rev_id)
2668
        parent_invs = map(self._load_updated_inventory, present_parents)
1731.1.62 by Aaron Bentley
Changes from review comments
2669
        entries = inv.iter_entries()
2670
        entries.next()
2671
        for path, ie in entries:
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2672
            self._convert_file_version(rev, ie, parent_invs)
2673
2674
    def _convert_file_version(self, rev, ie, parent_invs):
2675
        """Convert one version of one file.
2676
2677
        The file needs to be added into the weave if it is a merge
2678
        of >=2 parents or if it's changed from its parent.
2679
        """
2680
        file_id = ie.file_id
2681
        rev_id = rev.revision_id
2682
        w = self.text_weaves.get(file_id)
2683
        if w is None:
2684
            w = Weave(file_id)
2685
            self.text_weaves[file_id] = w
2686
        text_changed = False
2776.1.5 by Robert Collins
Add reasonably comprehensive tests for path last modified and per file graph behaviour.
2687
        parent_candiate_entries = ie.parent_candidates(parent_invs)
2688
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2689
        # XXX: Note that this is unordered - and this is tolerable because
2776.1.5 by Robert Collins
Add reasonably comprehensive tests for path last modified and per file graph behaviour.
2690
        # the previous code was also unordered.
2691
        previous_entries = dict((head, parent_candiate_entries[head]) for head
2692
            in heads)
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2693
        self.snapshot_ie(previous_entries, ie, w, rev_id)
2694
        del ie.text_id
2695
3099.3.7 by John Arbash Meinel
Another parent provider I didn't realize existed.
2696
    def get_parent_map(self, revision_ids):
2697
        """See graph._StackedParentsProvider.get_parent_map"""
2698
        return dict((revision_id, self.revisions[revision_id])
2699
                    for revision_id in revision_ids
2700
                     if revision_id in self.revisions)
2701
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2702
    def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2703
        # TODO: convert this logic, which is ~= snapshot to
2704
        # a call to:. This needs the path figured out. rather than a work_tree
2705
        # a v4 revision_tree can be given, or something that looks enough like
2706
        # one to give the file content to the entry if it needs it.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2707
        # and we need something that looks like a weave store for snapshot to
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2708
        # save against.
2709
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2710
        if len(previous_revisions) == 1:
2711
            previous_ie = previous_revisions.values()[0]
2712
            if ie._unchanged(previous_ie):
2713
                ie.revision = previous_ie.revision
2714
                return
2715
        if ie.has_text():
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
2716
            text = self.branch.repository._text_store.get(ie.text_id)
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2717
            file_lines = text.readlines()
1563.2.18 by Robert Collins
get knit repositories really using knits for text storage.
2718
            w.add_lines(rev_id, previous_revisions, file_lines)
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2719
            self.text_count += 1
2720
        else:
1563.2.18 by Robert Collins
get knit repositories really using knits for text storage.
2721
            w.add_lines(rev_id, previous_revisions, [])
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2722
        ie.revision = rev_id
2723
2724
    def _make_order(self):
2725
        """Return a suitable order for importing revisions.
2726
2727
        The order must be such that an revision is imported after all
2728
        its (present) parents.
2729
        """
2730
        todo = set(self.revisions.keys())
2731
        done = self.absent_revisions.copy()
1534.5.11 by Robert Collins
Implement upgrades to Metaformat trees.
2732
        order = []
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2733
        while todo:
2734
            # scan through looking for a revision whose parents
2735
            # are all done
2736
            for rev_id in sorted(list(todo)):
2737
                rev = self.revisions[rev_id]
2738
                parent_ids = set(rev.parent_ids)
2739
                if parent_ids.issubset(done):
2740
                    # can take this one now
1534.5.11 by Robert Collins
Implement upgrades to Metaformat trees.
2741
                    order.append(rev_id)
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2742
                    todo.remove(rev_id)
2743
                    done.add(rev_id)
1534.5.11 by Robert Collins
Implement upgrades to Metaformat trees.
2744
        return order
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2745
2746
2747
class ConvertBzrDir5To6(Converter):
2748
    """Converts format 5 bzr dirs to format 6."""
2749
1534.5.10 by Robert Collins
Make upgrade driver unaware of the specific formats in play.
2750
    def convert(self, to_convert, pb):
2751
        """See Converter.convert()."""
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2752
        self.bzrdir = to_convert
1534.5.10 by Robert Collins
Make upgrade driver unaware of the specific formats in play.
2753
        self.pb = pb
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2754
        self.pb.note('starting upgrade from format 5 to 6')
2755
        self._convert_to_prefixed()
2756
        return BzrDir.open(self.bzrdir.root_transport.base)
2757
2758
    def _convert_to_prefixed(self):
1608.2.1 by Martin Pool
[merge] Storage filename escaping
2759
        from bzrlib.store import TransportStore
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2760
        self.bzrdir.transport.delete('branch-format')
2761
        for store_name in ["weaves", "revision-store"]:
1608.2.1 by Martin Pool
[merge] Storage filename escaping
2762
            self.pb.note("adding prefixes to %s" % store_name)
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2763
            store_transport = self.bzrdir.transport.clone(store_name)
1608.2.1 by Martin Pool
[merge] Storage filename escaping
2764
            store = TransportStore(store_transport, prefixed=True)
1608.1.1 by Martin Pool
[patch] LocalTransport.list_dir should return url-quoted strings (ddaa)
2765
            for urlfilename in store_transport.list_dir('.'):
1685.1.45 by John Arbash Meinel
Moved url functions into bzrlib.urlutils
2766
                filename = urlutils.unescape(urlfilename)
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2767
                if (filename.endswith(".weave") or
2768
                    filename.endswith(".gz") or
2769
                    filename.endswith(".sig")):
3350.6.1 by Robert Collins
* New ``versionedfile.KeyMapper`` interface to abstract out the access to
2770
                    file_id, suffix = os.path.splitext(filename)
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2771
                else:
2772
                    file_id = filename
3350.6.1 by Robert Collins
* New ``versionedfile.KeyMapper`` interface to abstract out the access to
2773
                    suffix = ''
2774
                new_name = store._mapper.map((file_id,)) + suffix
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2775
                # FIXME keep track of the dirs made RBC 20060121
2776
                try:
3350.6.1 by Robert Collins
* New ``versionedfile.KeyMapper`` interface to abstract out the access to
2777
                    store_transport.move(filename, new_name)
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2778
                except errors.NoSuchFile: # catches missing dirs strangely enough
3350.6.1 by Robert Collins
* New ``versionedfile.KeyMapper`` interface to abstract out the access to
2779
                    store_transport.mkdir(osutils.dirname(new_name))
2780
                    store_transport.move(filename, new_name)
3407.2.5 by Martin Pool
Deprecate LockableFiles.put_utf8
2781
        self.bzrdir.transport.put_bytes(
2782
            'branch-format',
2783
            BzrDirFormat6().get_format_string(),
3407.2.18 by Martin Pool
BzrDir takes responsibility for default file/dir modes
2784
            mode=self.bzrdir._get_file_mode())
1534.5.7 by Robert Collins
Start factoring out the upgrade policy logic.
2785
2786
1534.5.10 by Robert Collins
Make upgrade driver unaware of the specific formats in play.
2787
class ConvertBzrDir6ToMeta(Converter):
2788
    """Converts format 6 bzr dirs to metadirs."""
2789
2790
    def convert(self, to_convert, pb):
2791
        """See Converter.convert()."""
2241.1.11 by Martin Pool
Get rid of RepositoryFormat*_instance objects. Instead the format
2792
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
2094.3.5 by John Arbash Meinel
Fix imports to ensure modules are loaded before they are used
2793
        from bzrlib.branch import BzrBranchFormat5
1534.5.10 by Robert Collins
Make upgrade driver unaware of the specific formats in play.
2794
        self.bzrdir = to_convert
2795
        self.pb = pb
1534.5.11 by Robert Collins
Implement upgrades to Metaformat trees.
2796
        self.count = 0
2797
        self.total = 20 # the steps we know about
2798
        self.garbage_inventories = []
3407.2.18 by Martin Pool
BzrDir takes responsibility for default file/dir modes
2799
        self.dir_mode = self.bzrdir._get_dir_mode()
2800
        self.file_mode = self.bzrdir._get_file_mode()
1534.5.11 by Robert Collins
Implement upgrades to Metaformat trees.
2801
1534.5.13 by Robert Collins
Correct buggy test.
2802
        self.pb.note('starting upgrade from format 6 to metadir')
3407.2.5 by Martin Pool
Deprecate LockableFiles.put_utf8
2803
        self.bzrdir.transport.put_bytes(
2804
                'branch-format',
2805
                "Converting to format 6",
2806
                mode=self.file_mode)
1534.5.11 by Robert Collins
Implement upgrades to Metaformat trees.
2807
        # its faster to move specific files around than to open and use the apis...
2808
        # first off, nuke ancestry.weave, it was never used.
2809
        try:
2810
            self.step('Removing ancestry.weave')
2811
            self.bzrdir.transport.delete('ancestry.weave')
2812
        except errors.NoSuchFile:
2813
            pass
2814
        # find out whats there
2815
        self.step('Finding branch files')
1666.1.3 by Robert Collins
Fix and test upgrades from bzrdir 6 over SFTP.
2816
        last_revision = self.bzrdir.open_branch().last_revision()
1534.5.11 by Robert Collins
Implement upgrades to Metaformat trees.
2817
        bzrcontents = self.bzrdir.transport.list_dir('.')
2818
        for name in bzrcontents:
2819
            if name.startswith('basis-inventory.'):
2820
                self.garbage_inventories.append(name)
2821
        # create new directories for repository, working tree and branch
2822
        repository_names = [('inventory.weave', True),
2823
                            ('revision-store', True),
2824
                            ('weaves', True)]
2825
        self.step('Upgrading repository  ')
1553.5.79 by Martin Pool
upgrade to metadir should create LockDirs not files
2826
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
1534.5.11 by Robert Collins
Implement upgrades to Metaformat trees.
2827
        self.make_lock('repository')
2828
        # we hard code the formats here because we are converting into
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2829
        # the meta format. The meta format upgrader can take this to a
1534.5.11 by Robert Collins
Implement upgrades to Metaformat trees.
2830
        # future format within each component.
2241.1.11 by Martin Pool
Get rid of RepositoryFormat*_instance objects. Instead the format
2831
        self.put_format('repository', RepositoryFormat7())
1534.5.11 by Robert Collins
Implement upgrades to Metaformat trees.
2832
        for entry in repository_names:
2833
            self.move_entry('repository', entry)
2834
2835
        self.step('Upgrading branch      ')
1553.5.79 by Martin Pool
upgrade to metadir should create LockDirs not files
2836
        self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
1534.5.11 by Robert Collins
Implement upgrades to Metaformat trees.
2837
        self.make_lock('branch')
2094.3.5 by John Arbash Meinel
Fix imports to ensure modules are loaded before they are used
2838
        self.put_format('branch', BzrBranchFormat5())
1534.5.11 by Robert Collins
Implement upgrades to Metaformat trees.
2839
        branch_files = [('revision-history', True),
2840
                        ('branch-name', True),
2841
                        ('parent', False)]
2842
        for entry in branch_files:
2843
            self.move_entry('branch', entry)
2844
2845
        checkout_files = [('pending-merges', True),
2846
                          ('inventory', True),
2847
                          ('stat-cache', False)]
1959.3.1 by John Arbash Meinel
David Allouche: bzr upgrade should work if there is no working tree
2848
        # If a mandatory checkout file is not present, the branch does not have
2849
        # a functional checkout. Do not create a checkout in the converted
2850
        # branch.
2851
        for name, mandatory in checkout_files:
2852
            if mandatory and name not in bzrcontents:
2853
                has_checkout = False
2854
                break
2855
        else:
2856
            has_checkout = True
2857
        if not has_checkout:
2858
            self.pb.note('No working tree.')
2859
            # If some checkout files are there, we may as well get rid of them.
2860
            for name, mandatory in checkout_files:
2861
                if name in bzrcontents:
2862
                    self.bzrdir.transport.delete(name)
2863
        else:
2123.2.1 by John Arbash Meinel
Fix bug #70716, make bzrlib.bzrdir directly import bzrlib.workingtree
2864
            from bzrlib.workingtree import WorkingTreeFormat3
1959.3.1 by John Arbash Meinel
David Allouche: bzr upgrade should work if there is no working tree
2865
            self.step('Upgrading working tree')
2866
            self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2867
            self.make_lock('checkout')
2868
            self.put_format(
2123.2.1 by John Arbash Meinel
Fix bug #70716, make bzrlib.bzrdir directly import bzrlib.workingtree
2869
                'checkout', WorkingTreeFormat3())
1959.3.1 by John Arbash Meinel
David Allouche: bzr upgrade should work if there is no working tree
2870
            self.bzrdir.transport.delete_multi(
2871
                self.garbage_inventories, self.pb)
2872
            for entry in checkout_files:
2873
                self.move_entry('checkout', entry)
2874
            if last_revision is not None:
3407.2.5 by Martin Pool
Deprecate LockableFiles.put_utf8
2875
                self.bzrdir.transport.put_bytes(
1959.3.1 by John Arbash Meinel
David Allouche: bzr upgrade should work if there is no working tree
2876
                    'checkout/last-revision', last_revision)
3407.2.5 by Martin Pool
Deprecate LockableFiles.put_utf8
2877
        self.bzrdir.transport.put_bytes(
2878
            'branch-format',
2879
            BzrDirMetaFormat1().get_format_string(),
2880
            mode=self.file_mode)
1534.5.10 by Robert Collins
Make upgrade driver unaware of the specific formats in play.
2881
        return BzrDir.open(self.bzrdir.root_transport.base)
2882
1534.5.11 by Robert Collins
Implement upgrades to Metaformat trees.
2883
    def make_lock(self, name):
2884
        """Make a lock for the new control dir name."""
2885
        self.step('Make %s lock' % name)
1996.3.3 by John Arbash Meinel
Shave off another 40ms by demand loading branch and bzrdir
2886
        ld = lockdir.LockDir(self.bzrdir.transport,
2887
                             '%s/lock' % name,
2888
                             file_modebits=self.file_mode,
2889
                             dir_modebits=self.dir_mode)
1553.5.79 by Martin Pool
upgrade to metadir should create LockDirs not files
2890
        ld.create()
1534.5.11 by Robert Collins
Implement upgrades to Metaformat trees.
2891
2892
    def move_entry(self, new_dir, entry):
2893
        """Move then entry name into new_dir."""
2894
        name = entry[0]
2895
        mandatory = entry[1]
2896
        self.step('Moving %s' % name)
2897
        try:
2898
            self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2899
        except errors.NoSuchFile:
2900
            if mandatory:
2901
                raise
2902
2903
    def put_format(self, dirname, format):
3407.2.5 by Martin Pool
Deprecate LockableFiles.put_utf8
2904
        self.bzrdir.transport.put_bytes('%s/format' % dirname,
2905
            format.get_format_string(),
2906
            self.file_mode)
1534.5.11 by Robert Collins
Implement upgrades to Metaformat trees.
2907
1556.1.4 by Robert Collins
Add a new format for what will become knit, and the surrounding logic to upgrade repositories within metadirs, and tests for the same.
2908
2909
class ConvertMetaToMeta(Converter):
2910
    """Converts the components of metadirs."""
2911
2912
    def __init__(self, target_format):
2913
        """Create a metadir to metadir converter.
2914
2915
        :param target_format: The final metadir format that is desired.
2916
        """
2917
        self.target_format = target_format
2918
2919
    def convert(self, to_convert, pb):
2920
        """See Converter.convert()."""
2921
        self.bzrdir = to_convert
2922
        self.pb = pb
2923
        self.count = 0
2924
        self.total = 1
2925
        self.step('checking repository format')
2926
        try:
2927
            repo = self.bzrdir.open_repository()
2928
        except errors.NoRepositoryPresent:
2929
            pass
2930
        else:
2931
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
2932
                from bzrlib.repository import CopyConverter
2933
                self.pb.note('starting repository conversion')
2934
                converter = CopyConverter(self.target_format.repository_format)
2935
                converter.convert(repo, pb)
2230.3.29 by Aaron Bentley
Implement conversion to branch 6
2936
        try:
2937
            branch = self.bzrdir.open_branch()
2938
        except errors.NotBranchError:
2939
            pass
2940
        else:
2255.12.1 by Robert Collins
Implement upgrade for working trees.
2941
            # TODO: conversions of Branch and Tree should be done by
3221.11.5 by Robert Collins
Correctly handle multi-step branch upgrades.
2942
            # InterXFormat lookups/some sort of registry.
2230.3.29 by Aaron Bentley
Implement conversion to branch 6
2943
            # Avoid circular imports
2944
            from bzrlib import branch as _mod_branch
3221.11.5 by Robert Collins
Correctly handle multi-step branch upgrades.
2945
            old = branch._format.__class__
2946
            new = self.target_format.get_branch_format().__class__
2947
            while old != new:
2948
                if (old == _mod_branch.BzrBranchFormat5 and
2949
                    new in (_mod_branch.BzrBranchFormat6,
4273.1.13 by Aaron Bentley
Implement upgrade from branch format 7 to 8.
2950
                        _mod_branch.BzrBranchFormat7,
2951
                        _mod_branch.BzrBranchFormat8)):
3221.11.5 by Robert Collins
Correctly handle multi-step branch upgrades.
2952
                    branch_converter = _mod_branch.Converter5to6()
2953
                elif (old == _mod_branch.BzrBranchFormat6 and
4273.1.13 by Aaron Bentley
Implement upgrade from branch format 7 to 8.
2954
                    new in (_mod_branch.BzrBranchFormat7,
2955
                            _mod_branch.BzrBranchFormat8)):
3221.11.5 by Robert Collins
Correctly handle multi-step branch upgrades.
2956
                    branch_converter = _mod_branch.Converter6to7()
4273.1.13 by Aaron Bentley
Implement upgrade from branch format 7 to 8.
2957
                elif (old == _mod_branch.BzrBranchFormat7 and
2958
                      new is _mod_branch.BzrBranchFormat8):
2959
                    branch_converter = _mod_branch.Converter7to8()
3221.11.5 by Robert Collins
Correctly handle multi-step branch upgrades.
2960
                else:
2961
                    raise errors.BadConversionTarget("No converter", new)
2230.3.29 by Aaron Bentley
Implement conversion to branch 6
2962
                branch_converter.convert(branch)
3221.11.5 by Robert Collins
Correctly handle multi-step branch upgrades.
2963
                branch = self.bzrdir.open_branch()
2964
                old = branch._format.__class__
2255.12.1 by Robert Collins
Implement upgrade for working trees.
2965
        try:
2323.6.4 by Martin Pool
BzrDir._check_supported now also takes care of recommending upgrades, which
2966
            tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
2255.2.196 by Robert Collins
Fix test_upgrade defects related to non local or absent working trees.
2967
        except (errors.NoWorkingTree, errors.NotLocalUrl):
2255.12.1 by Robert Collins
Implement upgrade for working trees.
2968
            pass
2969
        else:
2970
            # TODO: conversions of Branch and Tree should be done by
2971
            # InterXFormat lookups
2972
            if (isinstance(tree, workingtree.WorkingTree3) and
3907.2.3 by Ian Clatworthy
DirStateWorkingTree and DirStateWorkingTreeFormat base classes introduced
2973
                not isinstance(tree, workingtree_4.DirStateWorkingTree) and
2255.12.1 by Robert Collins
Implement upgrade for working trees.
2974
                isinstance(self.target_format.workingtree_format,
3907.2.3 by Ian Clatworthy
DirStateWorkingTree and DirStateWorkingTreeFormat base classes introduced
2975
                    workingtree_4.DirStateWorkingTreeFormat)):
2255.12.1 by Robert Collins
Implement upgrade for working trees.
2976
                workingtree_4.Converter3to4().convert(tree)
3907.2.3 by Ian Clatworthy
DirStateWorkingTree and DirStateWorkingTreeFormat base classes introduced
2977
            if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
2978
                not isinstance(tree, workingtree_4.WorkingTree5) and
3586.1.8 by Ian Clatworthy
add workingtree_5 and initial upgrade code
2979
                isinstance(self.target_format.workingtree_format,
3907.2.3 by Ian Clatworthy
DirStateWorkingTree and DirStateWorkingTreeFormat base classes introduced
2980
                    workingtree_4.WorkingTreeFormat5)):
2981
                workingtree_4.Converter4to5().convert(tree)
4210.4.2 by Ian Clatworthy
split filtered views support out into WorkingTreeFormat6
2982
            if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
2983
                not isinstance(tree, workingtree_4.WorkingTree6) and
2984
                isinstance(self.target_format.workingtree_format,
2985
                    workingtree_4.WorkingTreeFormat6)):
2986
                workingtree_4.Converter4or5to6().convert(tree)
1556.1.4 by Robert Collins
Add a new format for what will become knit, and the surrounding logic to upgrade repositories within metadirs, and tests for the same.
2987
        return to_convert
1731.2.18 by Aaron Bentley
Get extract in repository under test
2988
2989
4294.2.7 by Robert Collins
Start building up a BzrDir.initialize_ex verb for the smart server.
2990
# This is not in remote.py because it's relatively small, and needs to be
2991
# registered. Putting it in remote.py creates a circular import problem.
2018.5.28 by Robert Collins
Fix RemoteBzrDirFormat probe api usage.
2992
# we can make it a lazy object if the control formats is turned into something
2993
# like a registry.
2018.5.25 by Andrew Bennetts
Make sure RemoteBzrDirFormat is always registered (John Arbash Meinel, Robert Collins, Andrew Bennetts).
2994
class RemoteBzrDirFormat(BzrDirMetaFormat1):
2995
    """Format representing bzrdirs accessed via a smart server"""
2996
4070.2.1 by Robert Collins
Add a BzrDirFormat.network_name.
2997
    def __init__(self):
2998
        BzrDirMetaFormat1.__init__(self)
2999
        self._network_name = None
3000
2018.5.25 by Andrew Bennetts
Make sure RemoteBzrDirFormat is always registered (John Arbash Meinel, Robert Collins, Andrew Bennetts).
3001
    def get_format_description(self):
3002
        return 'bzr remote bzrdir'
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
3003
4032.3.2 by Robert Collins
Create and use a RPC call to create branches on bzr servers rather than using VFS calls.
3004
    def get_format_string(self):
3005
        raise NotImplementedError(self.get_format_string)
4032.3.6 by Robert Collins
Fix test_source errors.
3006
4070.2.1 by Robert Collins
Add a BzrDirFormat.network_name.
3007
    def network_name(self):
3008
        if self._network_name:
3009
            return self._network_name
3010
        else:
3011
            raise AssertionError("No network name set.")
3012
2018.5.28 by Robert Collins
Fix RemoteBzrDirFormat probe api usage.
3013
    @classmethod
3014
    def probe_transport(klass, transport):
3015
        """Return a RemoteBzrDirFormat object if it looks possible."""
2018.5.25 by Andrew Bennetts
Make sure RemoteBzrDirFormat is always registered (John Arbash Meinel, Robert Collins, Andrew Bennetts).
3016
        try:
3241.1.4 by Andrew Bennetts
Use get_smart_medium as suggested by Robert, and deal with the fallout.
3017
            medium = transport.get_smart_medium()
2018.5.25 by Andrew Bennetts
Make sure RemoteBzrDirFormat is always registered (John Arbash Meinel, Robert Collins, Andrew Bennetts).
3018
        except (NotImplementedError, AttributeError,
3245.4.47 by Andrew Bennetts
Don't automatically send 'hello' requests from RemoteBzrDirFormat.probe_transport unless we have to (i.e. the transport is HTTP).
3019
                errors.TransportNotPossible, errors.NoSmartMedium,
3020
                errors.SmartProtocolError):
2018.5.28 by Robert Collins
Fix RemoteBzrDirFormat probe api usage.
3021
            # no smart server, so not a branch for this format type.
3022
            raise errors.NotBranchError(path=transport.base)
2018.5.25 by Andrew Bennetts
Make sure RemoteBzrDirFormat is always registered (John Arbash Meinel, Robert Collins, Andrew Bennetts).
3023
        else:
3241.1.2 by Andrew Bennetts
Tidy comments.
3024
            # Decline to open it if the server doesn't support our required
3245.4.14 by Andrew Bennetts
Merge from bzr.dev (via loom thread).
3025
            # version (3) so that the VFS-based transport will do it.
3245.4.47 by Andrew Bennetts
Don't automatically send 'hello' requests from RemoteBzrDirFormat.probe_transport unless we have to (i.e. the transport is HTTP).
3026
            if medium.should_probe():
3027
                try:
3028
                    server_version = medium.protocol_version()
3029
                except errors.SmartProtocolError:
3030
                    # Apparently there's no usable smart server there, even though
3031
                    # the medium supports the smart protocol.
3032
                    raise errors.NotBranchError(path=transport.base)
3033
                if server_version != '2':
3034
                    raise errors.NotBranchError(path=transport.base)
2018.5.28 by Robert Collins
Fix RemoteBzrDirFormat probe api usage.
3035
            return klass()
2018.5.25 by Andrew Bennetts
Make sure RemoteBzrDirFormat is always registered (John Arbash Meinel, Robert Collins, Andrew Bennetts).
3036
2018.5.42 by Robert Collins
Various hopefully improvements, but wsgi is broken, handing over to spiv :).
3037
    def initialize_on_transport(self, transport):
2018.5.128 by Robert Collins
Have RemoteBzrDirFormat create a local format object when it is asked to initialize something on a non-smart transport - allowing sprout to work cleanly.
3038
        try:
3039
            # hand off the request to the smart server
3313.2.1 by Andrew Bennetts
Change _SmartClient's API to accept a medium and a base, rather than a _SharedConnection.
3040
            client_medium = transport.get_smart_medium()
2018.5.128 by Robert Collins
Have RemoteBzrDirFormat create a local format object when it is asked to initialize something on a non-smart transport - allowing sprout to work cleanly.
3041
        except errors.NoSmartMedium:
3042
            # TODO: lookup the local format from a server hint.
3043
            local_dir_format = BzrDirMetaFormat1()
3044
            return local_dir_format.initialize_on_transport(transport)
3431.3.2 by Andrew Bennetts
Remove 'base' from _SmartClient entirely, now that the medium has it.
3045
        client = _SmartClient(client_medium)
2018.5.42 by Robert Collins
Various hopefully improvements, but wsgi is broken, handing over to spiv :).
3046
        path = client.remote_path_from_transport(transport)
3313.2.1 by Andrew Bennetts
Change _SmartClient's API to accept a medium and a base, rather than a _SharedConnection.
3047
        response = client.call('BzrDirFormat.initialize', path)
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
3048
        if response[0] != 'ok':
3049
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
4005.2.3 by Robert Collins
Fix test failure due to shared format objects being returned from initialize_on_transport.
3050
        format = RemoteBzrDirFormat()
3051
        self._supply_sub_formats_to(format)
3052
        return remote.RemoteBzrDir(transport, format)
2018.5.42 by Robert Collins
Various hopefully improvements, but wsgi is broken, handing over to spiv :).
3053
4294.2.8 by Robert Collins
Reduce round trips pushing new branches substantially.
3054
    def parse_NoneTrueFalse(self, arg):
3055
        if not arg:
3056
            return None
3057
        if arg == 'False':
3058
            return False
3059
        if arg == 'True':
3060
            return True
3061
        raise AssertionError("invalid arg %r" % arg)
3062
4294.2.7 by Robert Collins
Start building up a BzrDir.initialize_ex verb for the smart server.
3063
    def _serialize_NoneTrueFalse(self, arg):
3064
        if arg is False:
3065
            return 'False'
3066
        if arg:
3067
            return 'True'
3068
        return ''
3069
4294.2.8 by Robert Collins
Reduce round trips pushing new branches substantially.
3070
    def _serialize_NoneString(self, arg):
3071
        return arg or ''
3072
4294.2.7 by Robert Collins
Start building up a BzrDir.initialize_ex verb for the smart server.
3073
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3074
        create_prefix=False, force_new_repo=False, stacked_on=None,
3075
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3076
        shared_repo=False):
3077
        try:
3078
            # hand off the request to the smart server
3079
            client_medium = transport.get_smart_medium()
3080
        except errors.NoSmartMedium:
4294.2.9 by Robert Collins
Fixup tests broken by cleaning up the layering.
3081
            do_vfs = True
3082
        else:
3083
            # Decline to open it if the server doesn't support our required
3084
            # version (3) so that the VFS-based transport will do it.
3085
            if client_medium.should_probe():
3086
                try:
3087
                    server_version = client_medium.protocol_version()
3088
                    if server_version != '2':
3089
                        do_vfs = True
3090
                    else:
3091
                        do_vfs = False
3092
                except errors.SmartProtocolError:
3093
                    # Apparently there's no usable smart server there, even though
3094
                    # the medium supports the smart protocol.
3095
                    do_vfs = True
3096
            else:
3097
                do_vfs = False
3098
        if not do_vfs:
3099
            client = _SmartClient(client_medium)
3100
            path = client.remote_path_from_transport(transport)
3101
            if client_medium._is_remote_before((1, 15)):
3102
                do_vfs = True
3103
        if do_vfs:
4294.2.7 by Robert Collins
Start building up a BzrDir.initialize_ex verb for the smart server.
3104
            # TODO: lookup the local format from a server hint.
3105
            local_dir_format = BzrDirMetaFormat1()
3106
            self._supply_sub_formats_to(local_dir_format)
3107
            return local_dir_format.initialize_on_transport_ex(transport,
3108
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3109
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3110
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
4294.2.8 by Robert Collins
Reduce round trips pushing new branches substantially.
3111
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3112
                vfs_only=True)
4294.2.7 by Robert Collins
Start building up a BzrDir.initialize_ex verb for the smart server.
3113
        args = []
3114
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
4294.2.8 by Robert Collins
Reduce round trips pushing new branches substantially.
3115
        args.append(self._serialize_NoneTrueFalse(create_prefix))
3116
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
3117
        args.append(self._serialize_NoneString(stacked_on))
3118
        # stack_on_pwd is often/usually our transport
3119
        if stack_on_pwd:
3120
            try:
3121
                stack_on_pwd = transport.relpath(stack_on_pwd)
3122
                if not stack_on_pwd:
3123
                    stack_on_pwd = '.'
3124
            except errors.PathNotChild:
3125
                pass
3126
        args.append(self._serialize_NoneString(stack_on_pwd))
3127
        args.append(self._serialize_NoneString(repo_format_name))
3128
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
3129
        args.append(self._serialize_NoneTrueFalse(shared_repo))
3130
        if self._network_name is None:
3131
            self._network_name = \
3132
            BzrDirFormat.get_default_format().network_name()
4294.2.7 by Robert Collins
Start building up a BzrDir.initialize_ex verb for the smart server.
3133
        try:
4294.2.8 by Robert Collins
Reduce round trips pushing new branches substantially.
3134
            response = client.call('BzrDirFormat.initialize_ex',
3135
                self.network_name(), path, *args)
4294.2.7 by Robert Collins
Start building up a BzrDir.initialize_ex verb for the smart server.
3136
        except errors.UnknownSmartMethod:
3137
            local_dir_format = BzrDirMetaFormat1()
3138
            self._supply_sub_formats_to(local_dir_format)
3139
            return local_dir_format.initialize_on_transport_ex(transport,
3140
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3141
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3142
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
4294.2.8 by Robert Collins
Reduce round trips pushing new branches substantially.
3143
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3144
                vfs_only=True)
3145
        repo_path = response[0]
3146
        bzrdir_name = response[6]
3147
        require_stacking = response[7]
3148
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
4294.2.7 by Robert Collins
Start building up a BzrDir.initialize_ex verb for the smart server.
3149
        format = RemoteBzrDirFormat()
4294.2.8 by Robert Collins
Reduce round trips pushing new branches substantially.
3150
        format._network_name = bzrdir_name
4294.2.7 by Robert Collins
Start building up a BzrDir.initialize_ex verb for the smart server.
3151
        self._supply_sub_formats_to(format)
4294.2.8 by Robert Collins
Reduce round trips pushing new branches substantially.
3152
        bzrdir = remote.RemoteBzrDir(transport, format)
3153
        if repo_path:
3154
            repo_format = remote.response_tuple_to_repo_format(response[1:])
3155
            if repo_path == '.':
3156
                repo_path = ''
3157
            if repo_path:
3158
                repo_bzrdir_format = RemoteBzrDirFormat()
3159
                repo_bzrdir_format._network_name = response[5]
3160
                repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3161
                    repo_bzrdir_format)
3162
            else:
3163
                repo_bzr = bzrdir
3164
            final_stack = response[8] or None
3165
            final_stack_pwd = response[9] or None
3166
            remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3167
            policy = UseExistingRepository(remote_repo, final_stack,
3168
                final_stack_pwd, require_stacking)
3169
            policy.acquire_repository()
3170
        else:
3171
            remote_repo = None
3172
            policy = None
3173
        return remote_repo, bzrdir, require_stacking, policy
4294.2.7 by Robert Collins
Start building up a BzrDir.initialize_ex verb for the smart server.
3174
2018.5.25 by Andrew Bennetts
Make sure RemoteBzrDirFormat is always registered (John Arbash Meinel, Robert Collins, Andrew Bennetts).
3175
    def _open(self, transport):
4005.2.1 by Robert Collins
Fix RemoteBranch to be used correctly in tests using bzr+ssh, to fire off Branch hooks correctly, and improve the branch_implementations tests to check that making a branch gets the right format under test.
3176
        return remote.RemoteBzrDir(transport, self)
2018.5.25 by Andrew Bennetts
Make sure RemoteBzrDirFormat is always registered (John Arbash Meinel, Robert Collins, Andrew Bennetts).
3177
3178
    def __eq__(self, other):
3179
        if not isinstance(other, RemoteBzrDirFormat):
3180
            return False
3181
        return self.get_format_description() == other.get_format_description()
3182
4005.2.1 by Robert Collins
Fix RemoteBranch to be used correctly in tests using bzr+ssh, to fire off Branch hooks correctly, and improve the branch_implementations tests to check that making a branch gets the right format under test.
3183
    def __return_repository_format(self):
3184
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
3185
        # repository format has been asked for, tell the RemoteRepositoryFormat
3186
        # that it should use that for init() etc.
4165.2.1 by Robert Collins
Fix bzr failing to stack when a server requests it and the branch it is pushing from cannot stack but the branch it should stack on can.
3187
        result = remote.RemoteRepositoryFormat()
4005.2.1 by Robert Collins
Fix RemoteBranch to be used correctly in tests using bzr+ssh, to fire off Branch hooks correctly, and improve the branch_implementations tests to check that making a branch gets the right format under test.
3188
        custom_format = getattr(self, '_repository_format', None)
3189
        if custom_format:
4017.3.2 by Robert Collins
Reduce the number of round trips required to create a repository over the network.
3190
            if isinstance(custom_format, remote.RemoteRepositoryFormat):
4165.2.1 by Robert Collins
Fix bzr failing to stack when a server requests it and the branch it is pushing from cannot stack but the branch it should stack on can.
3191
                return custom_format
4017.3.2 by Robert Collins
Reduce the number of round trips required to create a repository over the network.
3192
            else:
4165.2.1 by Robert Collins
Fix bzr failing to stack when a server requests it and the branch it is pushing from cannot stack but the branch it should stack on can.
3193
                # We will use the custom format to create repositories over the
3194
                # wire; expose its details like rich_root_data for code to
3195
                # query
4017.3.2 by Robert Collins
Reduce the number of round trips required to create a repository over the network.
3196
                result._custom_format = custom_format
4005.2.1 by Robert Collins
Fix RemoteBranch to be used correctly in tests using bzr+ssh, to fire off Branch hooks correctly, and improve the branch_implementations tests to check that making a branch gets the right format under test.
3197
        return result
3198
4032.3.2 by Robert Collins
Create and use a RPC call to create branches on bzr servers rather than using VFS calls.
3199
    def get_branch_format(self):
3200
        result = BzrDirMetaFormat1.get_branch_format(self)
3201
        if not isinstance(result, remote.RemoteBranchFormat):
3202
            new_result = remote.RemoteBranchFormat()
3203
            new_result._custom_format = result
3204
            # cache the result
3205
            self.set_branch_format(new_result)
3206
            result = new_result
3207
        return result
3208
4005.2.1 by Robert Collins
Fix RemoteBranch to be used correctly in tests using bzr+ssh, to fire off Branch hooks correctly, and improve the branch_implementations tests to check that making a branch gets the right format under test.
3209
    repository_format = property(__return_repository_format,
3210
        BzrDirMetaFormat1._set_repository_format) #.im_func)
3845.1.1 by John Arbash Meinel
Ensure that RepositoryFormat._matchingbzrdir.repository_format matches.
3211
2018.5.25 by Andrew Bennetts
Make sure RemoteBzrDirFormat is always registered (John Arbash Meinel, Robert Collins, Andrew Bennetts).
3212
2018.5.163 by Andrew Bennetts
Deal with various review comments from Robert.
3213
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
2018.5.45 by Andrew Bennetts
Merge from bzr.dev
3214
3215
2204.4.4 by Aaron Bentley
Use BzrDirFormatInfo to distinguish native and deprecated formats
3216
class BzrDirFormatInfo(object):
3217
2939.2.2 by Ian Clatworthy
allow bzrdir formats to be registered as experimental
3218
    def __init__(self, native, deprecated, hidden, experimental):
2204.4.4 by Aaron Bentley
Use BzrDirFormatInfo to distinguish native and deprecated formats
3219
        self.deprecated = deprecated
3220
        self.native = native
1551.13.2 by Aaron Bentley
Hide dirstate-with-subtree format
3221
        self.hidden = hidden
2939.2.2 by Ian Clatworthy
allow bzrdir formats to be registered as experimental
3222
        self.experimental = experimental
2204.4.4 by Aaron Bentley
Use BzrDirFormatInfo to distinguish native and deprecated formats
3223
3224
2204.4.1 by Aaron Bentley
Add 'formats' help topic
3225
class BzrDirFormatRegistry(registry.Registry):
3226
    """Registry of user-selectable BzrDir subformats.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
3227
2204.4.1 by Aaron Bentley
Add 'formats' help topic
3228
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3229
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
3230
    """
3231
3152.2.2 by Robert Collins
The bzrdir format registry now accepts an ``alias`` keyword to
3232
    def __init__(self):
3233
        """Create a BzrDirFormatRegistry."""
3234
        self._aliases = set()
3892.1.2 by Ian Clatworthy
split formats topic into multiple topics
3235
        self._registration_order = list()
3152.2.2 by Robert Collins
The bzrdir format registry now accepts an ``alias`` keyword to
3236
        super(BzrDirFormatRegistry, self).__init__()
3237
3238
    def aliases(self):
3239
        """Return a set of the format names which are aliases."""
3240
        return frozenset(self._aliases)
3241
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
3242
    def register_metadir(self, key,
3243
             repository_format, help, native=True, deprecated=False,
3244
             branch_format=None,
1551.13.2 by Aaron Bentley
Hide dirstate-with-subtree format
3245
             tree_format=None,
2939.2.2 by Ian Clatworthy
allow bzrdir formats to be registered as experimental
3246
             hidden=False,
3152.2.2 by Robert Collins
The bzrdir format registry now accepts an ``alias`` keyword to
3247
             experimental=False,
3248
             alias=False):
2204.4.1 by Aaron Bentley
Add 'formats' help topic
3249
        """Register a metadir subformat.
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
3250
3251
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
4070.2.1 by Robert Collins
Add a BzrDirFormat.network_name.
3252
        by the Repository/Branch/WorkingTreeformats.
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
3253
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
3254
        :param repository_format: The fully-qualified repository format class
3255
            name as a string.
3256
        :param branch_format: Fully-qualified branch format class name as
3257
            a string.
3258
        :param tree_format: Fully-qualified tree format class name as
3259
            a string.
2204.4.1 by Aaron Bentley
Add 'formats' help topic
3260
        """
3261
        # This should be expanded to support setting WorkingTree and Branch
3262
        # formats, once BzrDirMetaFormat1 supports that.
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
3263
        def _load(full_name):
3264
            mod_name, factory_name = full_name.rsplit('.', 1)
2241.1.21 by Martin Pool
Change register_metadir to take fully-qualified repository class name.
3265
            try:
3266
                mod = __import__(mod_name, globals(), locals(),
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
3267
                        [factory_name])
2241.1.21 by Martin Pool
Change register_metadir to take fully-qualified repository class name.
3268
            except ImportError, e:
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
3269
                raise ImportError('failed to load %s: %s' % (full_name, e))
2241.1.21 by Martin Pool
Change register_metadir to take fully-qualified repository class name.
3270
            try:
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
3271
                factory = getattr(mod, factory_name)
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
3272
            except AttributeError:
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
3273
                raise AttributeError('no factory %s in module %r'
3274
                    % (full_name, mod))
3275
            return factory()
3276
3277
        def helper():
2204.4.1 by Aaron Bentley
Add 'formats' help topic
3278
            bd = BzrDirMetaFormat1()
2230.3.1 by Aaron Bentley
Get branch6 creation working
3279
            if branch_format is not None:
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
3280
                bd.set_branch_format(_load(branch_format))
3281
            if tree_format is not None:
3282
                bd.workingtree_format = _load(tree_format)
3283
            if repository_format is not None:
3284
                bd.repository_format = _load(repository_format)
2204.4.1 by Aaron Bentley
Add 'formats' help topic
3285
            return bd
2939.2.2 by Ian Clatworthy
allow bzrdir formats to be registered as experimental
3286
        self.register(key, helper, help, native, deprecated, hidden,
3152.2.2 by Robert Collins
The bzrdir format registry now accepts an ``alias`` keyword to
3287
            experimental, alias)
2204.4.1 by Aaron Bentley
Add 'formats' help topic
3288
1551.13.2 by Aaron Bentley
Hide dirstate-with-subtree format
3289
    def register(self, key, factory, help, native=True, deprecated=False,
3152.2.2 by Robert Collins
The bzrdir format registry now accepts an ``alias`` keyword to
3290
                 hidden=False, experimental=False, alias=False):
2204.4.1 by Aaron Bentley
Add 'formats' help topic
3291
        """Register a BzrDirFormat factory.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
3292
2204.4.1 by Aaron Bentley
Add 'formats' help topic
3293
        The factory must be a callable that takes one parameter: the key.
3294
        It must produce an instance of the BzrDirFormat when called.
3295
3296
        This function mainly exists to prevent the info object from being
3297
        supplied directly.
3298
        """
3152.2.1 by Robert Collins
* A new repository format 'development' has been added. This format will
3299
        registry.Registry.register(self, key, factory, help,
2939.2.2 by Ian Clatworthy
allow bzrdir formats to be registered as experimental
3300
            BzrDirFormatInfo(native, deprecated, hidden, experimental))
3152.2.2 by Robert Collins
The bzrdir format registry now accepts an ``alias`` keyword to
3301
        if alias:
3302
            self._aliases.add(key)
3892.1.2 by Ian Clatworthy
split formats topic into multiple topics
3303
        self._registration_order.append(key)
2204.4.1 by Aaron Bentley
Add 'formats' help topic
3304
2204.4.7 by Aaron Bentley
restore register_lazy, remove register_factory, other updates
3305
    def register_lazy(self, key, module_name, member_name, help, native=True,
3152.2.2 by Robert Collins
The bzrdir format registry now accepts an ``alias`` keyword to
3306
        deprecated=False, hidden=False, experimental=False, alias=False):
3152.2.1 by Robert Collins
* A new repository format 'development' has been added. This format will
3307
        registry.Registry.register_lazy(self, key, module_name, member_name,
2939.2.2 by Ian Clatworthy
allow bzrdir formats to be registered as experimental
3308
            help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3152.2.2 by Robert Collins
The bzrdir format registry now accepts an ``alias`` keyword to
3309
        if alias:
3310
            self._aliases.add(key)
3892.1.2 by Ian Clatworthy
split formats topic into multiple topics
3311
        self._registration_order.append(key)
2204.4.1 by Aaron Bentley
Add 'formats' help topic
3312
3313
    def set_default(self, key):
3314
        """Set the 'default' key to be a clone of the supplied key.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
3315
2204.4.1 by Aaron Bentley
Add 'formats' help topic
3316
        This method must be called once and only once.
3317
        """
3152.2.1 by Robert Collins
* A new repository format 'development' has been added. This format will
3318
        registry.Registry.register(self, 'default', self.get(key),
2204.4.4 by Aaron Bentley
Use BzrDirFormatInfo to distinguish native and deprecated formats
3319
            self.get_help(key), info=self.get_info(key))
3152.2.2 by Robert Collins
The bzrdir format registry now accepts an ``alias`` keyword to
3320
        self._aliases.add('default')
2204.4.1 by Aaron Bentley
Add 'formats' help topic
3321
2204.4.11 by Aaron Bentley
deprecate Repository.set_default_format, update upgrade tests
3322
    def set_default_repository(self, key):
3323
        """Set the FormatRegistry default and Repository default.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
3324
2204.4.11 by Aaron Bentley
deprecate Repository.set_default_format, update upgrade tests
3325
        This is a transitional method while Repository.set_default_format
3326
        is deprecated.
3327
        """
3328
        if 'default' in self:
3329
            self.remove('default')
3330
        self.set_default(key)
3331
        format = self.get('default')()
3332
2204.4.1 by Aaron Bentley
Add 'formats' help topic
3333
    def make_bzrdir(self, key):
2204.4.7 by Aaron Bentley
restore register_lazy, remove register_factory, other updates
3334
        return self.get(key)()
2204.4.1 by Aaron Bentley
Add 'formats' help topic
3335
3336
    def help_topic(self, topic):
3892.1.2 by Ian Clatworthy
split formats topic into multiple topics
3337
        output = ""
2711.2.4 by Martin Pool
Fix unbound variable error in BzrDirFormatRegistry.get_help (test order dependent)
3338
        default_realkey = None
2204.4.1 by Aaron Bentley
Add 'formats' help topic
3339
        default_help = self.get_help('default')
3340
        help_pairs = []
3892.1.2 by Ian Clatworthy
split formats topic into multiple topics
3341
        for key in self._registration_order:
2204.4.1 by Aaron Bentley
Add 'formats' help topic
3342
            if key == 'default':
3343
                continue
3344
            help = self.get_help(key)
3345
            if help == default_help:
3346
                default_realkey = key
3347
            else:
3348
                help_pairs.append((key, help))
3349
2204.4.4 by Aaron Bentley
Use BzrDirFormatInfo to distinguish native and deprecated formats
3350
        def wrapped(key, help, info):
3351
            if info.native:
3352
                help = '(native) ' + help
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
3353
            return ':%s:\n%s\n\n' % (key,
3354
                    textwrap.fill(help, initial_indent='    ',
2204.4.1 by Aaron Bentley
Add 'formats' help topic
3355
                    subsequent_indent='    '))
2711.2.4 by Martin Pool
Fix unbound variable error in BzrDirFormatRegistry.get_help (test order dependent)
3356
        if default_realkey is not None:
3357
            output += wrapped(default_realkey, '(default) %s' % default_help,
3358
                              self.get_info('default'))
2204.4.4 by Aaron Bentley
Use BzrDirFormatInfo to distinguish native and deprecated formats
3359
        deprecated_pairs = []
2939.2.2 by Ian Clatworthy
allow bzrdir formats to be registered as experimental
3360
        experimental_pairs = []
2204.4.1 by Aaron Bentley
Add 'formats' help topic
3361
        for key, help in help_pairs:
2204.4.4 by Aaron Bentley
Use BzrDirFormatInfo to distinguish native and deprecated formats
3362
            info = self.get_info(key)
1551.13.2 by Aaron Bentley
Hide dirstate-with-subtree format
3363
            if info.hidden:
3364
                continue
3365
            elif info.deprecated:
2204.4.4 by Aaron Bentley
Use BzrDirFormatInfo to distinguish native and deprecated formats
3366
                deprecated_pairs.append((key, help))
2939.2.2 by Ian Clatworthy
allow bzrdir formats to be registered as experimental
3367
            elif info.experimental:
3368
                experimental_pairs.append((key, help))
2204.4.4 by Aaron Bentley
Use BzrDirFormatInfo to distinguish native and deprecated formats
3369
            else:
3370
                output += wrapped(key, help, info)
3892.1.2 by Ian Clatworthy
split formats topic into multiple topics
3371
        output += "\nSee ``bzr help formats`` for more about storage formats."
3372
        other_output = ""
2939.2.2 by Ian Clatworthy
allow bzrdir formats to be registered as experimental
3373
        if len(experimental_pairs) > 0:
3892.1.2 by Ian Clatworthy
split formats topic into multiple topics
3374
            other_output += "Experimental formats are shown below.\n\n"
2939.2.2 by Ian Clatworthy
allow bzrdir formats to be registered as experimental
3375
            for key, help in experimental_pairs:
3376
                info = self.get_info(key)
3892.1.2 by Ian Clatworthy
split formats topic into multiple topics
3377
                other_output += wrapped(key, help, info)
3378
        else:
3379
            other_output += \
3380
                "No experimental formats are available.\n\n"
2204.4.4 by Aaron Bentley
Use BzrDirFormatInfo to distinguish native and deprecated formats
3381
        if len(deprecated_pairs) > 0:
3892.1.2 by Ian Clatworthy
split formats topic into multiple topics
3382
            other_output += "\nDeprecated formats are shown below.\n\n"
2204.4.4 by Aaron Bentley
Use BzrDirFormatInfo to distinguish native and deprecated formats
3383
            for key, help in deprecated_pairs:
3384
                info = self.get_info(key)
3892.1.2 by Ian Clatworthy
split formats topic into multiple topics
3385
                other_output += wrapped(key, help, info)
3386
        else:
3387
            other_output += \
3388
                "\nNo deprecated formats are available.\n\n"
3389
        other_output += \
3390
            "\nSee ``bzr help formats`` for more about storage formats."
2204.4.4 by Aaron Bentley
Use BzrDirFormatInfo to distinguish native and deprecated formats
3391
3892.1.2 by Ian Clatworthy
split formats topic into multiple topics
3392
        if topic == 'other-formats':
3393
            return other_output
3394
        else:
3395
            return output
2204.4.1 by Aaron Bentley
Add 'formats' help topic
3396
3397
3242.2.14 by Aaron Bentley
Update from review comments
3398
class RepositoryAcquisitionPolicy(object):
3399
    """Abstract base class for repository acquisition policies.
3242.3.7 by Aaron Bentley
Delegate stacking to configure_branch
3400
3242.2.14 by Aaron Bentley
Update from review comments
3401
    A repository acquisition policy decides how a BzrDir acquires a repository
3402
    for a branch that is being created.  The most basic policy decision is
3403
    whether to create a new repository or use an existing one.
3404
    """
3242.3.40 by Aaron Bentley
Turn failing test into KnownFailure
3405
    def __init__(self, stack_on, stack_on_pwd, require_stacking):
3242.3.35 by Aaron Bentley
Cleanups and documentation
3406
        """Constructor.
3407
3408
        :param stack_on: A location to stack on
3409
        :param stack_on_pwd: If stack_on is relative, the location it is
3410
            relative to.
3242.3.40 by Aaron Bentley
Turn failing test into KnownFailure
3411
        :param require_stacking: If True, it is a failure to not stack.
3242.3.35 by Aaron Bentley
Cleanups and documentation
3412
        """
3242.3.7 by Aaron Bentley
Delegate stacking to configure_branch
3413
        self._stack_on = stack_on
3242.3.32 by Aaron Bentley
Defer handling relative stacking URLs as late as possible.
3414
        self._stack_on_pwd = stack_on_pwd
3242.3.40 by Aaron Bentley
Turn failing test into KnownFailure
3415
        self._require_stacking = require_stacking
3242.3.7 by Aaron Bentley
Delegate stacking to configure_branch
3416
3417
    def configure_branch(self, branch):
3242.2.13 by Aaron Bentley
Update docs
3418
        """Apply any configuration data from this policy to the branch.
3419
3242.3.18 by Aaron Bentley
Clean up repository-policy work
3420
        Default implementation sets repository stacking.
3242.2.13 by Aaron Bentley
Update docs
3421
        """
3242.3.33 by Aaron Bentley
Handle relative URL stacking cleanly
3422
        if self._stack_on is None:
3423
            return
3424
        if self._stack_on_pwd is None:
3425
            stack_on = self._stack_on
3426
        else:
3427
            try:
3242.3.32 by Aaron Bentley
Defer handling relative stacking URLs as late as possible.
3428
                stack_on = urlutils.rebase_url(self._stack_on,
3429
                    self._stack_on_pwd,
3430
                    branch.bzrdir.root_transport.base)
3242.3.33 by Aaron Bentley
Handle relative URL stacking cleanly
3431
            except errors.InvalidRebaseURLs:
3432
                stack_on = self._get_full_stack_on()
3242.3.37 by Aaron Bentley
Updates from reviews
3433
        try:
3537.3.5 by Martin Pool
merge trunk including stacking policy
3434
            branch.set_stacked_on_url(stack_on)
4126.1.1 by Andrew Bennetts
Fix bug when pushing stackable branch in unstackable repo to default-stacking target.
3435
        except (errors.UnstackableBranchFormat,
3436
                errors.UnstackableRepositoryFormat):
3242.3.40 by Aaron Bentley
Turn failing test into KnownFailure
3437
            if self._require_stacking:
3438
                raise
3242.3.33 by Aaron Bentley
Handle relative URL stacking cleanly
3439
3440
    def _get_full_stack_on(self):
3242.3.35 by Aaron Bentley
Cleanups and documentation
3441
        """Get a fully-qualified URL for the stack_on location."""
3242.3.33 by Aaron Bentley
Handle relative URL stacking cleanly
3442
        if self._stack_on is None:
3443
            return None
3444
        if self._stack_on_pwd is None:
3445
            return self._stack_on
3446
        else:
3447
            return urlutils.join(self._stack_on_pwd, self._stack_on)
3242.3.7 by Aaron Bentley
Delegate stacking to configure_branch
3448
3928.3.2 by John Arbash Meinel
Track down the other cause of us connecting multiple times.
3449
    def _add_fallback(self, repository, possible_transports=None):
3242.3.35 by Aaron Bentley
Cleanups and documentation
3450
        """Add a fallback to the supplied repository, if stacking is set."""
3242.3.33 by Aaron Bentley
Handle relative URL stacking cleanly
3451
        stack_on = self._get_full_stack_on()
3452
        if stack_on is None:
3242.3.30 by Aaron Bentley
Handle adding fallback repositories in acquire_repository
3453
            return
4294.2.8 by Robert Collins
Reduce round trips pushing new branches substantially.
3454
        try:
3455
            stacked_dir = BzrDir.open(stack_on,
3456
                                      possible_transports=possible_transports)
3457
        except errors.JailBreak:
3458
            # We keep the stacking details, but we are in the server code so
3459
            # actually stacking is not needed.
3460
            return
3242.3.30 by Aaron Bentley
Handle adding fallback repositories in acquire_repository
3461
        try:
3462
            stacked_repo = stacked_dir.open_branch().repository
3463
        except errors.NotBranchError:
3464
            stacked_repo = stacked_dir.open_repository()
3242.3.37 by Aaron Bentley
Updates from reviews
3465
        try:
3466
            repository.add_fallback_repository(stacked_repo)
3467
        except errors.UnstackableRepositoryFormat:
3242.3.40 by Aaron Bentley
Turn failing test into KnownFailure
3468
            if self._require_stacking:
3469
                raise
3904.3.1 by Andrew Bennetts
Probable fix for GaryvdM's bug when pushing a stacked qbzr branch to Launchpad.
3470
        else:
3471
            self._require_stacking = True
3242.3.30 by Aaron Bentley
Handle adding fallback repositories in acquire_repository
3472
3242.2.10 by Aaron Bentley
Rename RepositoryPolicy.apply to acquire_repository
3473
    def acquire_repository(self, make_working_trees=None, shared=False):
3242.2.14 by Aaron Bentley
Update from review comments
3474
        """Acquire a repository for this bzrdir.
3475
3476
        Implementations may create a new repository or use a pre-exising
3477
        repository.
3478
        :param make_working_trees: If creating a repository, set
3479
            make_working_trees to this value (if non-None)
3480
        :param shared: If creating a repository, make it shared if True
4070.9.8 by Andrew Bennetts
Use MiniSearchResult in clone_on_transport down (further tightening the test_push ratchets), and improve acquire_repository docstrings.
3481
        :return: A repository, is_new_flag (True if the repository was
3482
            created).
3242.2.14 by Aaron Bentley
Update from review comments
3483
        """
3484
        raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3485
3486
3487
class CreateRepository(RepositoryAcquisitionPolicy):
3242.2.13 by Aaron Bentley
Update docs
3488
    """A policy of creating a new repository"""
3242.2.1 by Aaron Bentley
Abstract policy decisions into determine_repository_policy
3489
3242.3.40 by Aaron Bentley
Turn failing test into KnownFailure
3490
    def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3491
                 require_stacking=False):
3242.3.35 by Aaron Bentley
Cleanups and documentation
3492
        """
3493
        Constructor.
3494
        :param bzrdir: The bzrdir to create the repository on.
3495
        :param stack_on: A location to stack on
3496
        :param stack_on_pwd: If stack_on is relative, the location it is
3497
            relative to.
3498
        """
3242.3.40 by Aaron Bentley
Turn failing test into KnownFailure
3499
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3500
                                             require_stacking)
3242.2.1 by Aaron Bentley
Abstract policy decisions into determine_repository_policy
3501
        self._bzrdir = bzrdir
3502
3242.2.10 by Aaron Bentley
Rename RepositoryPolicy.apply to acquire_repository
3503
    def acquire_repository(self, make_working_trees=None, shared=False):
3242.2.14 by Aaron Bentley
Update from review comments
3504
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
3242.2.13 by Aaron Bentley
Update docs
3505
3242.2.14 by Aaron Bentley
Update from review comments
3506
        Creates the desired repository in the bzrdir we already have.
3242.2.13 by Aaron Bentley
Update docs
3507
        """
4165.2.1 by Robert Collins
Fix bzr failing to stack when a server requests it and the branch it is pushing from cannot stack but the branch it should stack on can.
3508
        stack_on = self._get_full_stack_on()
3509
        if stack_on:
3510
            # Stacking is desired. requested by the target, but does the place it
3511
            # points at support stacking? If it doesn't then we should
3512
            # not implicitly upgrade. We check this here.
3513
            format = self._bzrdir._format
3514
            if not (format.repository_format.supports_external_lookups
3515
                and format.get_branch_format().supports_stacking()):
3516
                # May need to upgrade - but only do if the target also
3517
                # supports stacking. Note that this currently wastes
3518
                # network round trips to check - but we only do this
3519
                # when the source can't stack so it will fade away
3520
                # as people do upgrade.
4294.2.8 by Robert Collins
Reduce round trips pushing new branches substantially.
3521
                branch_format = None
3522
                repo_format = None
4165.2.1 by Robert Collins
Fix bzr failing to stack when a server requests it and the branch it is pushing from cannot stack but the branch it should stack on can.
3523
                try:
3524
                    target_dir = BzrDir.open(stack_on,
3525
                        possible_transports=[self._bzrdir.root_transport])
3526
                except errors.NotBranchError:
3527
                    # Nothing there, don't change formats
3528
                    pass
4294.2.8 by Robert Collins
Reduce round trips pushing new branches substantially.
3529
                except errors.JailBreak:
3530
                    # stack_on is inaccessible, JFDI.
3531
                    if format.repository_format.rich_root_data:
3532
                        repo_format = pack_repo.RepositoryFormatKnitPack6RichRoot()
3533
                    else:
3534
                        repo_format = pack_repo.RepositoryFormatKnitPack6()
3535
                    branch_format = branch.BzrBranchFormat7()
4165.2.1 by Robert Collins
Fix bzr failing to stack when a server requests it and the branch it is pushing from cannot stack but the branch it should stack on can.
3536
                else:
3537
                    try:
3538
                        target_branch = target_dir.open_branch()
3539
                    except errors.NotBranchError:
3540
                        # No branch, don't change formats
3541
                        pass
3542
                    else:
3543
                        branch_format = target_branch._format
3544
                        repo_format = target_branch.repository._format
3545
                        if not (branch_format.supports_stacking()
3546
                            and repo_format.supports_external_lookups):
3547
                            # Doesn't stack itself, don't force an upgrade
4294.2.8 by Robert Collins
Reduce round trips pushing new branches substantially.
3548
                            branch_format = None
3549
                            repo_format = None
3550
                if branch_format and repo_format:
3551
                    # Does support stacking, use its format.
3552
                    format.repository_format = repo_format
3553
                    format.set_branch_format(branch_format)
3554
                    note('Source format does not support stacking, '
3555
                        'using format: \'%s\'\n  %s\n',
3556
                        branch_format.get_format_description(),
3557
                        repo_format.get_format_description())
4165.2.1 by Robert Collins
Fix bzr failing to stack when a server requests it and the branch it is pushing from cannot stack but the branch it should stack on can.
3558
            if not self._require_stacking:
3559
                # We have picked up automatic stacking somewhere.
3560
                note('Using default stacking branch %s at %s', self._stack_on,
3561
                    self._stack_on_pwd)
3650.3.9 by Aaron Bentley
Move responsibility for stackable repo format to _get_metadir
3562
        repository = self._bzrdir.create_repository(shared=shared)
3928.3.2 by John Arbash Meinel
Track down the other cause of us connecting multiple times.
3563
        self._add_fallback(repository,
3564
                           possible_transports=[self._bzrdir.transport])
3242.2.4 by Aaron Bentley
Only set working tree policty when specified
3565
        if make_working_trees is not None:
3242.3.6 by Aaron Bentley
Work around strange test failure
3566
            repository.set_make_working_trees(make_working_trees)
4070.9.2 by Andrew Bennetts
Rough prototype of allowing a SearchResult to be passed to fetch, and using that to improve network conversations.
3567
        return repository, True
3242.2.2 by Aaron Bentley
Merge policy updates from stacked-policy thread
3568
3569
3242.2.14 by Aaron Bentley
Update from review comments
3570
class UseExistingRepository(RepositoryAcquisitionPolicy):
3242.2.13 by Aaron Bentley
Update docs
3571
    """A policy of reusing an existing repository"""
3242.2.1 by Aaron Bentley
Abstract policy decisions into determine_repository_policy
3572
3242.3.40 by Aaron Bentley
Turn failing test into KnownFailure
3573
    def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3574
                 require_stacking=False):
3242.3.35 by Aaron Bentley
Cleanups and documentation
3575
        """Constructor.
3576
3577
        :param repository: The repository to use.
3578
        :param stack_on: A location to stack on
3579
        :param stack_on_pwd: If stack_on is relative, the location it is
3580
            relative to.
3581
        """
3242.3.40 by Aaron Bentley
Turn failing test into KnownFailure
3582
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3583
                                             require_stacking)
3242.2.1 by Aaron Bentley
Abstract policy decisions into determine_repository_policy
3584
        self._repository = repository
3585
3242.2.10 by Aaron Bentley
Rename RepositoryPolicy.apply to acquire_repository
3586
    def acquire_repository(self, make_working_trees=None, shared=False):
3242.2.14 by Aaron Bentley
Update from review comments
3587
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
3242.2.13 by Aaron Bentley
Update docs
3588
4070.9.8 by Andrew Bennetts
Use MiniSearchResult in clone_on_transport down (further tightening the test_push ratchets), and improve acquire_repository docstrings.
3589
        Returns an existing repository to use.
3242.2.13 by Aaron Bentley
Update docs
3590
        """
3928.3.2 by John Arbash Meinel
Track down the other cause of us connecting multiple times.
3591
        self._add_fallback(self._repository,
3592
                       possible_transports=[self._repository.bzrdir.transport])
4070.9.2 by Andrew Bennetts
Rough prototype of allowing a SearchResult to be passed to fetch, and using that to improve network conversations.
3593
        return self._repository, False
3242.2.1 by Aaron Bentley
Abstract policy decisions into determine_repository_policy
3594
3595
3892.1.2 by Ian Clatworthy
split formats topic into multiple topics
3596
# Please register new formats after old formats so that formats
3597
# appear in chronological order and format descriptions can build
3598
# on previous ones.
2204.4.1 by Aaron Bentley
Add 'formats' help topic
3599
format_registry = BzrDirFormatRegistry()
3990.5.3 by Robert Collins
Docs and polish on RepositoryFormat.network_name.
3600
# The pre-0.8 formats have their repository format network name registered in
3601
# repository.py. MetaDir formats have their repository format network name
3602
# inferred from their disk format string.
2204.4.7 by Aaron Bentley
restore register_lazy, remove register_factory, other updates
3603
format_registry.register('weave', BzrDirFormat6,
2204.4.4 by Aaron Bentley
Use BzrDirFormatInfo to distinguish native and deprecated formats
3604
    'Pre-0.8 format.  Slower than knit and does not'
2241.1.6 by Martin Pool
Move Knit repositories into the submodule bzrlib.repofmt.knitrepo and
3605
    ' support checkouts or shared repositories.',
3606
    deprecated=True)
2241.1.21 by Martin Pool
Change register_metadir to take fully-qualified repository class name.
3607
format_registry.register_metadir('metaweave',
3608
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
2230.3.30 by Aaron Bentley
Fix whitespace issues
3609
    'Transitional format in 0.8.  Slower than knit.',
2255.12.1 by Robert Collins
Implement upgrade for working trees.
3610
    branch_format='bzrlib.branch.BzrBranchFormat5',
2255.2.209 by Robert Collins
Remove circular imports in bzrdir format definitions.
3611
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2204.4.4 by Aaron Bentley
Use BzrDirFormatInfo to distinguish native and deprecated formats
3612
    deprecated=True)
3892.1.2 by Ian Clatworthy
split formats topic into multiple topics
3613
format_registry.register_metadir('knit',
3614
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3615
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
3616
    branch_format='bzrlib.branch.BzrBranchFormat5',
3617
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3618
    deprecated=True)
2255.12.1 by Robert Collins
Implement upgrade for working trees.
3619
format_registry.register_metadir('dirstate',
3620
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3621
    help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3622
        'above when accessed over the network.',
3623
    branch_format='bzrlib.branch.BzrBranchFormat5',
2255.2.209 by Robert Collins
Remove circular imports in bzrdir format definitions.
3624
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3625
    # directly from workingtree_4 triggers a circular import.
3626
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3892.1.1 by Ian Clatworthy
improve help on storage formats
3627
    deprecated=True)
1551.13.1 by Aaron Bentley
Introduce dirstate-tags format
3628
format_registry.register_metadir('dirstate-tags',
3629
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3630
    help='New in 0.15: Fast local operations and improved scaling for '
1551.13.2 by Aaron Bentley
Hide dirstate-with-subtree format
3631
        'network operations. Additionally adds support for tags.'
3632
        ' Incompatible with bzr < 0.15.',
1551.13.1 by Aaron Bentley
Introduce dirstate-tags format
3633
    branch_format='bzrlib.branch.BzrBranchFormat6',
3634
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3892.1.1 by Ian Clatworthy
improve help on storage formats
3635
    deprecated=True)
2996.2.1 by Aaron Bentley
Add KnitRepositoryFormat4
3636
format_registry.register_metadir('rich-root',
3637
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3638
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
3892.1.2 by Ian Clatworthy
split formats topic into multiple topics
3639
        ' bzr < 1.0.',
2996.2.1 by Aaron Bentley
Add KnitRepositoryFormat4
3640
    branch_format='bzrlib.branch.BzrBranchFormat6',
3641
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3892.1.1 by Ian Clatworthy
improve help on storage formats
3642
    deprecated=True)
2255.12.1 by Robert Collins
Implement upgrade for working trees.
3643
format_registry.register_metadir('dirstate-with-subtree',
3644
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3645
    help='New in 0.15: Fast local operations and improved scaling for '
3646
        'network operations. Additionally adds support for versioning nested '
3647
        'bzr branches. Incompatible with bzr < 0.15.',
3648
    branch_format='bzrlib.branch.BzrBranchFormat6',
2255.2.209 by Robert Collins
Remove circular imports in bzrdir format definitions.
3649
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3170.4.3 by Adeodato Simó
Mark the subtree formats as experimental instead of hidden, and remove hidden=True from the rich-root ones.
3650
    experimental=True,
3170.4.4 by Adeodato Simó
Keep the hidden flag for subtree formats after review from Aaron.
3651
    hidden=True,
2255.12.1 by Robert Collins
Implement upgrade for working trees.
3652
    )
3010.3.2 by Martin Pool
Rename pack0.92 to pack-0.92
3653
format_registry.register_metadir('pack-0.92',
2592.3.224 by Martin Pool
Rename GraphKnitRepository etc to KnitPackRepository
3654
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
2939.2.1 by Ian Clatworthy
use 'knitpack' naming instead of 'experimental' for pack formats
3655
    help='New in 0.92: Pack-based format with data compatible with '
2939.2.6 by Ian Clatworthy
more review feedback from lifeless and poolie
3656
        'dirstate-tags format repositories. Interoperates with '
3657
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3010.3.1 by Martin Pool
Rename knitpack-experimental format to pack0.92 (not experimental)
3658
        'Previously called knitpack-experimental.  '
3659
        'For more information, see '
3660
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2592.3.22 by Robert Collins
Add new experimental repository formats.
3661
    branch_format='bzrlib.branch.BzrBranchFormat6',
3662
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3663
    )
3010.3.2 by Martin Pool
Rename pack0.92 to pack-0.92
3664
format_registry.register_metadir('pack-0.92-subtree',
2592.3.224 by Martin Pool
Rename GraphKnitRepository etc to KnitPackRepository
3665
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
2939.2.1 by Ian Clatworthy
use 'knitpack' naming instead of 'experimental' for pack formats
3666
    help='New in 0.92: Pack-based format with data compatible with '
2939.2.6 by Ian Clatworthy
more review feedback from lifeless and poolie
3667
        'dirstate-with-subtree format repositories. Interoperates with '
3668
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3010.3.1 by Martin Pool
Rename knitpack-experimental format to pack0.92 (not experimental)
3669
        'Previously called knitpack-experimental.  '
3670
        'For more information, see '
3671
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2592.3.22 by Robert Collins
Add new experimental repository formats.
3672
    branch_format='bzrlib.branch.BzrBranchFormat6',
3673
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3190.1.2 by Aaron Bentley
Undo spurious change
3674
    hidden=True,
3170.4.3 by Adeodato Simó
Mark the subtree formats as experimental instead of hidden, and remove hidden=True from the rich-root ones.
3675
    experimental=True,
2592.3.22 by Robert Collins
Add new experimental repository formats.
3676
    )
2996.2.11 by Aaron Bentley
Implement rich-root-pack format ( #164639)
3677
format_registry.register_metadir('rich-root-pack',
3678
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3892.1.2 by Ian Clatworthy
split formats topic into multiple topics
3679
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
4119.6.2 by Jelmer Vernooij
Use existing alias mechanism for default-rich-root.
3680
         '(needed for bzr-svn and bzr-git).',
2996.2.11 by Aaron Bentley
Implement rich-root-pack format ( #164639)
3681
    branch_format='bzrlib.branch.BzrBranchFormat6',
3682
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3152.2.1 by Robert Collins
* A new repository format 'development' has been added. This format will
3683
    )
3575.2.1 by Martin Pool
Rename stacked format to 1.6
3684
format_registry.register_metadir('1.6',
3549.1.5 by Martin Pool
Add stable format names for stacked branches
3685
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3892.1.6 by Ian Clatworthy
include feedback from poolie
3686
    help='A format that allows a branch to indicate that there is another '
3687
         '(stacked) repository that should be used to access data that is '
3688
         'not present locally.',
3549.1.5 by Martin Pool
Add stable format names for stacked branches
3689
    branch_format='bzrlib.branch.BzrBranchFormat7',
3690
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3691
    )
3606.10.2 by John Arbash Meinel
Name the new format 1.6.1-rich-root, and NEWS for fixing bug #262333
3692
format_registry.register_metadir('1.6.1-rich-root',
3549.1.6 by Martin Pool
Change stacked-subtree to stacked-rich-root
3693
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3892.1.2 by Ian Clatworthy
split formats topic into multiple topics
3694
    help='A variant of 1.6 that supports rich-root data '
4119.6.2 by Jelmer Vernooij
Use existing alias mechanism for default-rich-root.
3695
         '(needed for bzr-svn and bzr-git).',
3549.1.5 by Martin Pool
Add stable format names for stacked branches
3696
    branch_format='bzrlib.branch.BzrBranchFormat7',
3697
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3698
    )
3805.3.1 by John Arbash Meinel
Add repository 1.9 format, and update the documentation.
3699
format_registry.register_metadir('1.9',
3700
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3892.1.6 by Ian Clatworthy
include feedback from poolie
3701
    help='A repository format using B+tree indexes. These indexes '
3892.1.4 by Ian Clatworthy
rich-root explanation and improved help for 1.6 and 1.9 formats
3702
         'are smaller in size, have smarter caching and provide faster '
3703
         'performance for most operations.',
3805.3.1 by John Arbash Meinel
Add repository 1.9 format, and update the documentation.
3704
    branch_format='bzrlib.branch.BzrBranchFormat7',
3705
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3706
    )
3707
format_registry.register_metadir('1.9-rich-root',
3708
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3892.1.2 by Ian Clatworthy
split formats topic into multiple topics
3709
    help='A variant of 1.9 that supports rich-root data '
4119.6.2 by Jelmer Vernooij
Use existing alias mechanism for default-rich-root.
3710
         '(needed for bzr-svn and bzr-git).',
3805.3.1 by John Arbash Meinel
Add repository 1.9 format, and update the documentation.
3711
    branch_format='bzrlib.branch.BzrBranchFormat7',
3712
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3713
    )
4210.4.1 by Ian Clatworthy
replace experimental development-wt5 formats with 1.14 formats
3714
format_registry.register_metadir('1.14',
3586.2.10 by Ian Clatworthy
rename formats from 1.7-* to 1.12-*
3715
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
4210.4.2 by Ian Clatworthy
split filtered views support out into WorkingTreeFormat6
3716
    help='A working-tree format that supports content filtering.',
3586.2.6 by Ian Clatworthy
add 1.7 and 1.7-rich-root formats
3717
    branch_format='bzrlib.branch.BzrBranchFormat7',
3995.7.1 by John Arbash Meinel
Fix bug #328135.
3718
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3586.2.6 by Ian Clatworthy
add 1.7 and 1.7-rich-root formats
3719
    )
4210.4.1 by Ian Clatworthy
replace experimental development-wt5 formats with 1.14 formats
3720
format_registry.register_metadir('1.14-rich-root',
3586.2.10 by Ian Clatworthy
rename formats from 1.7-* to 1.12-*
3721
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
4210.4.1 by Ian Clatworthy
replace experimental development-wt5 formats with 1.14 formats
3722
    help='A variant of 1.14 that supports rich-root data '
4119.6.2 by Jelmer Vernooij
Use existing alias mechanism for default-rich-root.
3723
         '(needed for bzr-svn and bzr-git).',
3586.2.6 by Ian Clatworthy
add 1.7 and 1.7-rich-root formats
3724
    branch_format='bzrlib.branch.BzrBranchFormat7',
3995.7.1 by John Arbash Meinel
Fix bug #328135.
3725
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3586.2.6 by Ian Clatworthy
add 1.7 and 1.7-rich-root formats
3726
    )
4241.6.8 by Robert Collins, John Arbash Meinel, Ian Clatworthy, Vincent Ladeuil
Add --development6-rich-root, disabling the legacy and unneeded development2 format, and activating the tests for CHK features disabled pending this format. (Robert Collins, John Arbash Meinel, Ian Clatworthy, Vincent Ladeuil)
3727
# The following un-numbered 'development' formats should always just be aliases.
3728
format_registry.register_metadir('development-rich-root',
3729
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
4241.15.17 by Matt Nordhoff
development-rich-root's help string didn't say it supported rich roots.
3730
    help='Current development format. Supports rich roots. Can convert data '
3731
        'to and from rich-root-pack (and anything compatible with '
3732
        'rich-root-pack) format repositories. Repositories and branches in '
3733
        'this format can only be read by bzr.dev. Please read '
3152.2.1 by Robert Collins
* A new repository format 'development' has been added. This format will
3734
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3735
        'before use.',
3221.11.2 by Robert Collins
Create basic stackable branch facility.
3736
    branch_format='bzrlib.branch.BzrBranchFormat7',
4241.6.8 by Robert Collins, John Arbash Meinel, Ian Clatworthy, Vincent Ladeuil
Add --development6-rich-root, disabling the legacy and unneeded development2 format, and activating the tests for CHK features disabled pending this format. (Robert Collins, John Arbash Meinel, Ian Clatworthy, Vincent Ladeuil)
3737
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3152.2.1 by Robert Collins
* A new repository format 'development' has been added. This format will
3738
    experimental=True,
3152.2.2 by Robert Collins
The bzrdir format registry now accepts an ``alias`` keyword to
3739
    alias=True,
3152.2.1 by Robert Collins
* A new repository format 'development' has been added. This format will
3740
    )
3741
format_registry.register_metadir('development-subtree',
3735.1.1 by Robert Collins
Add development2 formats using BTree indices.
3742
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3152.2.1 by Robert Collins
* A new repository format 'development' has been added. This format will
3743
    help='Current development format, subtree variant. Can convert data to and '
3221.11.7 by Robert Collins
Merge in real stacked repository work.
3744
        'from pack-0.92-subtree (and anything compatible with '
3745
        'pack-0.92-subtree) format repositories. Repositories and branches in '
3746
        'this format can only be read by bzr.dev. Please read '
3152.2.1 by Robert Collins
* A new repository format 'development' has been added. This format will
3747
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3748
        'before use.',
3221.11.2 by Robert Collins
Create basic stackable branch facility.
3749
    branch_format='bzrlib.branch.BzrBranchFormat7',
4241.6.8 by Robert Collins, John Arbash Meinel, Ian Clatworthy, Vincent Ladeuil
Add --development6-rich-root, disabling the legacy and unneeded development2 format, and activating the tests for CHK features disabled pending this format. (Robert Collins, John Arbash Meinel, Ian Clatworthy, Vincent Ladeuil)
3750
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3152.2.1 by Robert Collins
* A new repository format 'development' has been added. This format will
3751
    experimental=True,
4241.6.8 by Robert Collins, John Arbash Meinel, Ian Clatworthy, Vincent Ladeuil
Add --development6-rich-root, disabling the legacy and unneeded development2 format, and activating the tests for CHK features disabled pending this format. (Robert Collins, John Arbash Meinel, Ian Clatworthy, Vincent Ladeuil)
3752
    alias=False, # Restore to being an alias when an actual development subtree format is added
3753
                 # This current non-alias status is simply because we did not introduce a
3754
                 # chk based subtree format.
3152.2.1 by Robert Collins
* A new repository format 'development' has been added. This format will
3755
    )
4241.6.8 by Robert Collins, John Arbash Meinel, Ian Clatworthy, Vincent Ladeuil
Add --development6-rich-root, disabling the legacy and unneeded development2 format, and activating the tests for CHK features disabled pending this format. (Robert Collins, John Arbash Meinel, Ian Clatworthy, Vincent Ladeuil)
3756
3735.1.1 by Robert Collins
Add development2 formats using BTree indices.
3757
# And the development formats above will have aliased one of the following:
4241.6.8 by Robert Collins, John Arbash Meinel, Ian Clatworthy, Vincent Ladeuil
Add --development6-rich-root, disabling the legacy and unneeded development2 format, and activating the tests for CHK features disabled pending this format. (Robert Collins, John Arbash Meinel, Ian Clatworthy, Vincent Ladeuil)
3758
format_registry.register_metadir('development6-rich-root',
3759
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3760
    help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
3761
        'Please read '
3762
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3763
        'before use.',
3764
    branch_format='bzrlib.branch.BzrBranchFormat7',
3765
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3766
    hidden=True,
3735.31.1 by John Arbash Meinel
Bring the groupcompress plugin into the brisbane-core branch.
3767
    experimental=True,
3768
    )
3769
4119.6.2 by Jelmer Vernooij
Use existing alias mechanism for default-rich-root.
3770
# The following format should be an alias for the rich root equivalent 
3771
# of the default format
3772
format_registry.register_metadir('default-rich-root',
3773
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3774
    help='Default format, rich root variant. (needed for bzr-svn and bzr-git).',
3775
    branch_format='bzrlib.branch.BzrBranchFormat6',
3776
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3777
    alias=True,
3778
    )
3221.11.2 by Robert Collins
Create basic stackable branch facility.
3779
# The current format that is made on 'bzr init'.
3044.1.3 by Martin Pool
Set the default format to pack-0.92
3780
format_registry.set_default('pack-0.92')