~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

(jelmer) Remove config argument from VersionedFileRepository.add_revision()
 (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2006-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""BzrDir logic. The BzrDir is the basic control directory used by bzr.
18
18
 
19
19
At format 7 this was split out into Branch, Repository and Checkout control
20
20
directories.
 
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.
21
26
"""
22
27
 
23
 
# TODO: Can we move specific formats into separate modules to make this file
24
 
# smaller?
 
28
from __future__ import absolute_import
25
29
 
26
 
from cStringIO import StringIO
27
 
import os
 
30
import sys
28
31
 
29
32
from bzrlib.lazy_import import lazy_import
30
33
lazy_import(globals(), """
31
 
from stat import S_ISDIR
32
 
import textwrap
33
 
from warnings import warn
34
 
 
35
34
import bzrlib
36
35
from bzrlib import (
 
36
    branch as _mod_branch,
 
37
    cleanup,
37
38
    errors,
 
39
    fetch,
 
40
    graph,
38
41
    lockable_files,
39
42
    lockdir,
40
 
    registry,
 
43
    osutils,
 
44
    pyutils,
41
45
    remote,
 
46
    repository,
42
47
    revision as _mod_revision,
43
 
    symbol_versioning,
 
48
    transport as _mod_transport,
44
49
    ui,
45
50
    urlutils,
46
 
    xml4,
47
 
    xml5,
48
 
    workingtree,
 
51
    vf_search,
 
52
    win32utils,
 
53
    workingtree_3,
49
54
    workingtree_4,
50
55
    )
51
 
from bzrlib.osutils import (
52
 
    sha_strings,
53
 
    sha_string,
54
 
    )
55
 
from bzrlib.smart.client import _SmartClient
56
 
from bzrlib.smart import protocol
57
 
from bzrlib.store.revision.text import TextRevisionStore
58
 
from bzrlib.store.text import TextStore
59
 
from bzrlib.store.versioned import WeaveStore
60
 
from bzrlib.transactions import WriteTransaction
 
56
from bzrlib.repofmt import knitpack_repo
61
57
from bzrlib.transport import (
62
58
    do_catching_redirections,
63
 
    get_transport,
 
59
    local,
64
60
    )
65
 
from bzrlib.weave import Weave
 
61
from bzrlib.i18n import gettext
66
62
""")
67
63
 
68
64
from bzrlib.trace import (
69
65
    mutter,
70
66
    note,
71
67
    )
72
 
from bzrlib.transport.local import LocalTransport
 
68
 
 
69
from bzrlib import (
 
70
    config,
 
71
    controldir,
 
72
    registry,
 
73
    )
73
74
from bzrlib.symbol_versioning import (
74
 
    deprecated_function,
 
75
    deprecated_in,
75
76
    deprecated_method,
76
 
    zero_ninetyone,
77
77
    )
78
78
 
79
79
 
80
 
class BzrDir(object):
 
80
class BzrDir(controldir.ControlDir):
81
81
    """A .bzr control diretory.
82
 
    
 
82
 
83
83
    BzrDir instances let you create or open any of the things that can be
84
84
    found within .bzr - checkouts, branches and repositories.
85
 
    
86
 
    transport
 
85
 
 
86
    :ivar transport:
87
87
        the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
88
 
    root_transport
89
 
        a transport connected to the directory this bzr was opened from.
 
88
    :ivar root_transport:
 
89
        a transport connected to the directory this bzr was opened from
 
90
        (i.e. the parent directory holding the .bzr directory).
 
91
 
 
92
    Everything in the bzrdir should have the same file permissions.
 
93
 
 
94
    :cvar hooks: An instance of BzrDirHooks.
90
95
    """
91
96
 
92
97
    def break_lock(self):
109
114
                    return
110
115
        thing_to_unlock.break_lock()
111
116
 
112
 
    def can_convert_format(self):
113
 
        """Return true if this bzrdir is one whose format we can convert from."""
114
 
        return True
115
 
 
116
117
    def check_conversion_target(self, target_format):
 
118
        """Check that a bzrdir as a whole can be converted to a new format."""
 
119
        # The only current restriction is that the repository content can be 
 
120
        # fetched compatibly with the target.
117
121
        target_repo_format = target_format.repository_format
118
 
        source_repo_format = self._format.repository_format
119
 
        source_repo_format.check_conversion_target(target_repo_format)
120
 
 
121
 
    @staticmethod
122
 
    def _check_supported(format, allow_unsupported,
123
 
        recommend_upgrade=True,
124
 
        basedir=None):
125
 
        """Give an error or warning on old formats.
126
 
 
127
 
        :param format: may be any kind of format - workingtree, branch, 
128
 
        or repository.
129
 
 
130
 
        :param allow_unsupported: If true, allow opening 
131
 
        formats that are strongly deprecated, and which may 
132
 
        have limited functionality.
133
 
 
134
 
        :param recommend_upgrade: If true (default), warn
135
 
        the user through the ui object that they may wish
136
 
        to upgrade the object.
137
 
        """
138
 
        # TODO: perhaps move this into a base Format class; it's not BzrDir
139
 
        # specific. mbp 20070323
140
 
        if not allow_unsupported and not format.is_supported():
141
 
            # see open_downlevel to open legacy branches.
142
 
            raise errors.UnsupportedFormatError(format=format)
143
 
        if recommend_upgrade \
144
 
            and getattr(format, 'upgrade_recommended', False):
145
 
            ui.ui_factory.recommend_upgrade(
146
 
                format.get_format_description(),
147
 
                basedir)
148
 
 
149
 
    def clone(self, url, revision_id=None, force_new_repo=False):
150
 
        """Clone this bzrdir and its contents to url verbatim.
151
 
 
152
 
        If urls last component does not exist, it will be created.
153
 
 
154
 
        if revision_id is not None, then the clone operation may tune
155
 
            itself to download less data.
156
 
        :param force_new_repo: Do not use a shared repository for the target 
157
 
                               even if one is available.
158
 
        """
159
 
        return self.clone_on_transport(get_transport(url),
160
 
                                       revision_id=revision_id,
161
 
                                       force_new_repo=force_new_repo)
 
122
        try:
 
123
            self.open_repository()._format.check_conversion_target(
 
124
                target_repo_format)
 
125
        except errors.NoRepositoryPresent:
 
126
            # No repo, no problem.
 
127
            pass
162
128
 
163
129
    def clone_on_transport(self, transport, revision_id=None,
164
 
                           force_new_repo=False):
 
130
        force_new_repo=False, preserve_stacking=False, stacked_on=None,
 
131
        create_prefix=False, use_existing_dir=True, no_tree=False):
165
132
        """Clone this bzrdir and its contents to transport verbatim.
166
133
 
167
 
        If the target directory does not exist, it will be created.
168
 
 
169
 
        if revision_id is not None, then the clone operation may tune
 
134
        :param transport: The transport for the location to produce the clone
 
135
            at.  If the target directory does not exist, it will be created.
 
136
        :param revision_id: The tip revision-id to use for any branch or
 
137
            working tree.  If not None, then the clone operation may tune
170
138
            itself to download less data.
171
 
        :param force_new_repo: Do not use a shared repository for the target 
 
139
        :param force_new_repo: Do not use a shared repository for the target,
172
140
                               even if one is available.
 
141
        :param preserve_stacking: When cloning a stacked branch, stack the
 
142
            new branch on top of the other branch's stacked-on branch.
 
143
        :param create_prefix: Create any missing directories leading up to
 
144
            to_transport.
 
145
        :param use_existing_dir: Use an existing directory if one exists.
 
146
        :param no_tree: If set to true prevents creation of a working tree.
173
147
        """
174
 
        transport.ensure_base()
175
 
        result = self._format.initialize_on_transport(transport)
 
148
        # Overview: put together a broad description of what we want to end up
 
149
        # with; then make as few api calls as possible to do it.
 
150
 
 
151
        # We may want to create a repo/branch/tree, if we do so what format
 
152
        # would we want for each:
 
153
        require_stacking = (stacked_on is not None)
 
154
        format = self.cloning_metadir(require_stacking)
 
155
 
 
156
        # Figure out what objects we want:
176
157
        try:
177
158
            local_repo = self.find_repository()
178
159
        except errors.NoRepositoryPresent:
179
160
            local_repo = None
 
161
        try:
 
162
            local_branch = self.open_branch()
 
163
        except errors.NotBranchError:
 
164
            local_branch = None
 
165
        else:
 
166
            # enable fallbacks when branch is not a branch reference
 
167
            if local_branch.repository.has_same_location(local_repo):
 
168
                local_repo = local_branch.repository
 
169
            if preserve_stacking:
 
170
                try:
 
171
                    stacked_on = local_branch.get_stacked_on_url()
 
172
                except (errors.UnstackableBranchFormat,
 
173
                        errors.UnstackableRepositoryFormat,
 
174
                        errors.NotStacked):
 
175
                    pass
 
176
        # Bug: We create a metadir without knowing if it can support stacking,
 
177
        # we should look up the policy needs first, or just use it as a hint,
 
178
        # or something.
180
179
        if local_repo:
181
 
            # may need to copy content in
182
 
            if force_new_repo:
183
 
                result_repo = local_repo.clone(
184
 
                    result,
185
 
                    revision_id=revision_id)
186
 
                result_repo.set_make_working_trees(local_repo.make_working_trees())
187
 
            else:
188
 
                try:
189
 
                    result_repo = result.find_repository()
190
 
                    # fetch content this dir needs.
 
180
            make_working_trees = local_repo.make_working_trees() and not no_tree
 
181
            want_shared = local_repo.is_shared()
 
182
            repo_format_name = format.repository_format.network_name()
 
183
        else:
 
184
            make_working_trees = False
 
185
            want_shared = False
 
186
            repo_format_name = None
 
187
 
 
188
        result_repo, result, require_stacking, repository_policy = \
 
189
            format.initialize_on_transport_ex(transport,
 
190
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
191
            force_new_repo=force_new_repo, stacked_on=stacked_on,
 
192
            stack_on_pwd=self.root_transport.base,
 
193
            repo_format_name=repo_format_name,
 
194
            make_working_trees=make_working_trees, shared_repo=want_shared)
 
195
        if repo_format_name:
 
196
            try:
 
197
                # If the result repository is in the same place as the
 
198
                # resulting bzr dir, it will have no content, further if the
 
199
                # result is not stacked then we know all content should be
 
200
                # copied, and finally if we are copying up to a specific
 
201
                # revision_id then we can use the pending-ancestry-result which
 
202
                # does not require traversing all of history to describe it.
 
203
                if (result_repo.user_url == result.user_url
 
204
                    and not require_stacking and
 
205
                    revision_id is not None):
 
206
                    fetch_spec = vf_search.PendingAncestryResult(
 
207
                        [revision_id], local_repo)
 
208
                    result_repo.fetch(local_repo, fetch_spec=fetch_spec)
 
209
                else:
191
210
                    result_repo.fetch(local_repo, revision_id=revision_id)
192
 
                except errors.NoRepositoryPresent:
193
 
                    # needed to make one anyway.
194
 
                    result_repo = local_repo.clone(
195
 
                        result,
196
 
                        revision_id=revision_id)
197
 
                    result_repo.set_make_working_trees(local_repo.make_working_trees())
 
211
            finally:
 
212
                result_repo.unlock()
 
213
        else:
 
214
            if result_repo is not None:
 
215
                raise AssertionError('result_repo not None(%r)' % result_repo)
198
216
        # 1 if there is a branch present
199
217
        #   make sure its content is available in the target repository
200
218
        #   clone it.
201
 
        try:
202
 
            self.open_branch().clone(result, revision_id=revision_id)
203
 
        except errors.NotBranchError:
204
 
            pass
205
 
        try:
206
 
            self.open_workingtree().clone(result)
 
219
        if local_branch is not None:
 
220
            result_branch = local_branch.clone(result, revision_id=revision_id,
 
221
                repository_policy=repository_policy)
 
222
        try:
 
223
            # Cheaper to check if the target is not local, than to try making
 
224
            # the tree and fail.
 
225
            result.root_transport.local_abspath('.')
 
226
            if result_repo is None or result_repo.make_working_trees():
 
227
                self.open_workingtree().clone(result, revision_id=revision_id)
207
228
        except (errors.NoWorkingTree, errors.NotLocalUrl):
208
229
            pass
209
230
        return result
211
232
    # TODO: This should be given a Transport, and should chdir up; otherwise
212
233
    # this will open a new connection.
213
234
    def _make_tail(self, url):
214
 
        t = get_transport(url)
215
 
        t.ensure_base()
216
 
 
217
 
    @classmethod
218
 
    def create(cls, base, format=None, possible_transports=None):
219
 
        """Create a new BzrDir at the url 'base'.
220
 
        
221
 
        This will call the current default formats initialize with base
222
 
        as the only parameter.
223
 
 
224
 
        :param format: If supplied, the format of branch to create.  If not
225
 
            supplied, the default is used.
226
 
        :param possible_transports: If supplied, a list of transports that 
227
 
            can be reused to share a remote connection.
228
 
        """
229
 
        if cls is not BzrDir:
230
 
            raise AssertionError("BzrDir.create always creates the default"
231
 
                " format, not one of %r" % cls)
232
 
        t = get_transport(base, possible_transports)
233
 
        t.ensure_base()
234
 
        if format is None:
235
 
            format = BzrDirFormat.get_default_format()
236
 
        return format.initialize(base, possible_transports)
237
 
 
238
 
    def create_branch(self):
239
 
        """Create a branch in this BzrDir.
240
 
 
241
 
        The bzrdirs format will control what branch format is created.
242
 
        For more control see BranchFormatXX.create(a_bzrdir).
243
 
        """
244
 
        raise NotImplementedError(self.create_branch)
245
 
 
246
 
    @staticmethod
247
 
    def create_branch_and_repo(base, force_new_repo=False, format=None):
248
 
        """Create a new BzrDir, Branch and Repository at the url 'base'.
249
 
 
250
 
        This will use the current default BzrDirFormat, and use whatever 
251
 
        repository format that that uses via bzrdir.create_branch and
252
 
        create_repository. If a shared repository is available that is used
253
 
        preferentially.
254
 
 
255
 
        The created Branch object is returned.
256
 
 
257
 
        :param base: The URL to create the branch at.
258
 
        :param force_new_repo: If True a new repository is always created.
259
 
        """
260
 
        bzrdir = BzrDir.create(base, format)
261
 
        bzrdir._find_or_create_repository(force_new_repo)
262
 
        return bzrdir.create_branch()
 
235
        t = _mod_transport.get_transport(url)
 
236
        t.ensure_base()
 
237
 
 
238
    def determine_repository_policy(self, force_new_repo=False, stack_on=None,
 
239
                                    stack_on_pwd=None, require_stacking=False):
 
240
        """Return an object representing a policy to use.
 
241
 
 
242
        This controls whether a new repository is created, and the format of
 
243
        that repository, or some existing shared repository used instead.
 
244
 
 
245
        If stack_on is supplied, will not seek a containing shared repo.
 
246
 
 
247
        :param force_new_repo: If True, require a new repository to be created.
 
248
        :param stack_on: If supplied, the location to stack on.  If not
 
249
            supplied, a default_stack_on location may be used.
 
250
        :param stack_on_pwd: If stack_on is relative, the location it is
 
251
            relative to.
 
252
        """
 
253
        def repository_policy(found_bzrdir):
 
254
            stack_on = None
 
255
            stack_on_pwd = None
 
256
            config = found_bzrdir.get_config()
 
257
            stop = False
 
258
            stack_on = config.get_default_stack_on()
 
259
            if stack_on is not None:
 
260
                stack_on_pwd = found_bzrdir.user_url
 
261
                stop = True
 
262
            # does it have a repository ?
 
263
            try:
 
264
                repository = found_bzrdir.open_repository()
 
265
            except errors.NoRepositoryPresent:
 
266
                repository = None
 
267
            else:
 
268
                if (found_bzrdir.user_url != self.user_url 
 
269
                    and not repository.is_shared()):
 
270
                    # Don't look higher, can't use a higher shared repo.
 
271
                    repository = None
 
272
                    stop = True
 
273
                else:
 
274
                    stop = True
 
275
            if not stop:
 
276
                return None, False
 
277
            if repository:
 
278
                return UseExistingRepository(repository, stack_on,
 
279
                    stack_on_pwd, require_stacking=require_stacking), True
 
280
            else:
 
281
                return CreateRepository(self, stack_on, stack_on_pwd,
 
282
                    require_stacking=require_stacking), True
 
283
 
 
284
        if not force_new_repo:
 
285
            if stack_on is None:
 
286
                policy = self._find_containing(repository_policy)
 
287
                if policy is not None:
 
288
                    return policy
 
289
            else:
 
290
                try:
 
291
                    return UseExistingRepository(self.open_repository(),
 
292
                        stack_on, stack_on_pwd,
 
293
                        require_stacking=require_stacking)
 
294
                except errors.NoRepositoryPresent:
 
295
                    pass
 
296
        return CreateRepository(self, stack_on, stack_on_pwd,
 
297
                                require_stacking=require_stacking)
263
298
 
264
299
    def _find_or_create_repository(self, force_new_repo):
265
300
        """Create a new repository if needed, returning the repository."""
266
 
        if force_new_repo:
267
 
            return self.create_repository()
268
 
        try:
269
 
            return self.find_repository()
270
 
        except errors.NoRepositoryPresent:
271
 
            return self.create_repository()
 
301
        policy = self.determine_repository_policy(force_new_repo)
 
302
        return policy.acquire_repository()[0]
 
303
 
 
304
    def _find_source_repo(self, add_cleanup, source_branch):
 
305
        """Find the source branch and repo for a sprout operation.
272
306
        
273
 
    @staticmethod
274
 
    def create_branch_convenience(base, force_new_repo=False,
275
 
                                  force_new_tree=None, format=None,
276
 
                                  possible_transports=None):
277
 
        """Create a new BzrDir, Branch and Repository at the url 'base'.
278
 
 
279
 
        This is a convenience function - it will use an existing repository
280
 
        if possible, can be told explicitly whether to create a working tree or
281
 
        not.
282
 
 
283
 
        This will use the current default BzrDirFormat, and use whatever 
284
 
        repository format that that uses via bzrdir.create_branch and
285
 
        create_repository. If a shared repository is available that is used
286
 
        preferentially. Whatever repository is used, its tree creation policy
287
 
        is followed.
288
 
 
289
 
        The created Branch object is returned.
290
 
        If a working tree cannot be made due to base not being a file:// url,
291
 
        no error is raised unless force_new_tree is True, in which case no 
292
 
        data is created on disk and NotLocalUrl is raised.
293
 
 
294
 
        :param base: The URL to create the branch at.
295
 
        :param force_new_repo: If True a new repository is always created.
296
 
        :param force_new_tree: If True or False force creation of a tree or 
297
 
                               prevent such creation respectively.
298
 
        :param format: Override for the for the bzrdir format to create.
299
 
        :param possible_transports: An optional reusable transports list.
300
 
        """
301
 
        if force_new_tree:
302
 
            # check for non local urls
303
 
            t = get_transport(base, possible_transports)
304
 
            if not isinstance(t, LocalTransport):
305
 
                raise errors.NotLocalUrl(base)
306
 
        bzrdir = BzrDir.create(base, format, possible_transports)
307
 
        repo = bzrdir._find_or_create_repository(force_new_repo)
308
 
        result = bzrdir.create_branch()
309
 
        if force_new_tree or (repo.make_working_trees() and
310
 
                              force_new_tree is None):
311
 
            try:
312
 
                bzrdir.create_workingtree()
313
 
            except errors.NotLocalUrl:
314
 
                pass
 
307
        This is helper intended for use by _sprout.
 
308
 
 
309
        :returns: (source_branch, source_repository).  Either or both may be
 
310
            None.  If not None, they will be read-locked (and their unlock(s)
 
311
            scheduled via the add_cleanup param).
 
312
        """
 
313
        if source_branch is not None:
 
314
            add_cleanup(source_branch.lock_read().unlock)
 
315
            return source_branch, source_branch.repository
 
316
        try:
 
317
            source_branch = self.open_branch()
 
318
            source_repository = source_branch.repository
 
319
        except errors.NotBranchError:
 
320
            source_branch = None
 
321
            try:
 
322
                source_repository = self.open_repository()
 
323
            except errors.NoRepositoryPresent:
 
324
                source_repository = None
 
325
            else:
 
326
                add_cleanup(source_repository.lock_read().unlock)
 
327
        else:
 
328
            add_cleanup(source_branch.lock_read().unlock)
 
329
        return source_branch, source_repository
 
330
 
 
331
    def sprout(self, url, revision_id=None, force_new_repo=False,
 
332
               recurse='down', possible_transports=None,
 
333
               accelerator_tree=None, hardlink=False, stacked=False,
 
334
               source_branch=None, create_tree_if_local=True):
 
335
        """Create a copy of this controldir prepared for use as a new line of
 
336
        development.
 
337
 
 
338
        If url's last component does not exist, it will be created.
 
339
 
 
340
        Attributes related to the identity of the source branch like
 
341
        branch nickname will be cleaned, a working tree is created
 
342
        whether one existed before or not; and a local branch is always
 
343
        created.
 
344
 
 
345
        if revision_id is not None, then the clone operation may tune
 
346
            itself to download less data.
 
347
 
 
348
        :param accelerator_tree: A tree which can be used for retrieving file
 
349
            contents more quickly than the revision tree, i.e. a workingtree.
 
350
            The revision tree will be used for cases where accelerator_tree's
 
351
            content is different.
 
352
        :param hardlink: If true, hard-link files from accelerator_tree,
 
353
            where possible.
 
354
        :param stacked: If true, create a stacked branch referring to the
 
355
            location of this control directory.
 
356
        :param create_tree_if_local: If true, a working-tree will be created
 
357
            when working locally.
 
358
        """
 
359
        operation = cleanup.OperationWithCleanups(self._sprout)
 
360
        return operation.run(url, revision_id=revision_id,
 
361
            force_new_repo=force_new_repo, recurse=recurse,
 
362
            possible_transports=possible_transports,
 
363
            accelerator_tree=accelerator_tree, hardlink=hardlink,
 
364
            stacked=stacked, source_branch=source_branch,
 
365
            create_tree_if_local=create_tree_if_local)
 
366
 
 
367
    def _sprout(self, op, url, revision_id=None, force_new_repo=False,
 
368
               recurse='down', possible_transports=None,
 
369
               accelerator_tree=None, hardlink=False, stacked=False,
 
370
               source_branch=None, create_tree_if_local=True):
 
371
        add_cleanup = op.add_cleanup
 
372
        fetch_spec_factory = fetch.FetchSpecFactory()
 
373
        if revision_id is not None:
 
374
            fetch_spec_factory.add_revision_ids([revision_id])
 
375
            fetch_spec_factory.source_branch_stop_revision_id = revision_id
 
376
        if possible_transports is None:
 
377
            possible_transports = []
 
378
        else:
 
379
            possible_transports = list(possible_transports) + [
 
380
                self.root_transport]
 
381
        target_transport = _mod_transport.get_transport(url,
 
382
            possible_transports)
 
383
        target_transport.ensure_base()
 
384
        cloning_format = self.cloning_metadir(stacked)
 
385
        # Create/update the result branch
 
386
        try:
 
387
            result = controldir.ControlDir.open_from_transport(target_transport)
 
388
        except errors.NotBranchError:
 
389
            result = cloning_format.initialize_on_transport(target_transport)
 
390
        source_branch, source_repository = self._find_source_repo(
 
391
            add_cleanup, source_branch)
 
392
        fetch_spec_factory.source_branch = source_branch
 
393
        # if a stacked branch wasn't requested, we don't create one
 
394
        # even if the origin was stacked
 
395
        if stacked and source_branch is not None:
 
396
            stacked_branch_url = self.root_transport.base
 
397
        else:
 
398
            stacked_branch_url = None
 
399
        repository_policy = result.determine_repository_policy(
 
400
            force_new_repo, stacked_branch_url, require_stacking=stacked)
 
401
        result_repo, is_new_repo = repository_policy.acquire_repository(
 
402
            possible_transports=possible_transports)
 
403
        add_cleanup(result_repo.lock_write().unlock)
 
404
        fetch_spec_factory.source_repo = source_repository
 
405
        fetch_spec_factory.target_repo = result_repo
 
406
        if stacked or (len(result_repo._fallback_repositories) != 0):
 
407
            target_repo_kind = fetch.TargetRepoKinds.STACKED
 
408
        elif is_new_repo:
 
409
            target_repo_kind = fetch.TargetRepoKinds.EMPTY
 
410
        else:
 
411
            target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
412
        fetch_spec_factory.target_repo_kind = target_repo_kind
 
413
        if source_repository is not None:
 
414
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
415
            result_repo.fetch(source_repository, fetch_spec=fetch_spec)
 
416
 
 
417
        if source_branch is None:
 
418
            # this is for sprouting a controldir without a branch; is that
 
419
            # actually useful?
 
420
            # Not especially, but it's part of the contract.
 
421
            result_branch = result.create_branch()
 
422
        else:
 
423
            result_branch = source_branch.sprout(result,
 
424
                revision_id=revision_id, repository_policy=repository_policy,
 
425
                repository=result_repo)
 
426
        mutter("created new branch %r" % (result_branch,))
 
427
 
 
428
        # Create/update the result working tree
 
429
        if (create_tree_if_local and not result.has_workingtree() and
 
430
            isinstance(target_transport, local.LocalTransport) and
 
431
            (result_repo is None or result_repo.make_working_trees())):
 
432
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
 
433
                hardlink=hardlink, from_branch=result_branch)
 
434
            wt.lock_write()
 
435
            try:
 
436
                if wt.path2id('') is None:
 
437
                    try:
 
438
                        wt.set_root_id(self.open_workingtree.get_root_id())
 
439
                    except errors.NoWorkingTree:
 
440
                        pass
 
441
            finally:
 
442
                wt.unlock()
 
443
        else:
 
444
            wt = None
 
445
        if recurse == 'down':
 
446
            basis = None
 
447
            if wt is not None:
 
448
                basis = wt.basis_tree()
 
449
            elif result_branch is not None:
 
450
                basis = result_branch.basis_tree()
 
451
            elif source_branch is not None:
 
452
                basis = source_branch.basis_tree()
 
453
            if basis is not None:
 
454
                add_cleanup(basis.lock_read().unlock)
 
455
                subtrees = basis.iter_references()
 
456
            else:
 
457
                subtrees = []
 
458
            for path, file_id in subtrees:
 
459
                target = urlutils.join(url, urlutils.escape(path))
 
460
                sublocation = source_branch.reference_parent(file_id, path)
 
461
                sublocation.bzrdir.sprout(target,
 
462
                    basis.get_reference_revision(file_id, path),
 
463
                    force_new_repo=force_new_repo, recurse=recurse,
 
464
                    stacked=stacked)
315
465
        return result
316
466
 
317
 
    @staticmethod
318
 
    @deprecated_function(zero_ninetyone)
319
 
    def create_repository(base, shared=False, format=None):
320
 
        """Create a new BzrDir and Repository at the url 'base'.
321
 
 
322
 
        If no format is supplied, this will default to the current default
323
 
        BzrDirFormat by default, and use whatever repository format that that
324
 
        uses for bzrdirformat.create_repository.
325
 
 
326
 
        :param shared: Create a shared repository rather than a standalone
327
 
                       repository.
328
 
        The Repository object is returned.
329
 
 
330
 
        This must be overridden as an instance method in child classes, where
331
 
        it should take no parameters and construct whatever repository format
332
 
        that child class desires.
333
 
 
334
 
        This method is deprecated, please call create_repository on a bzrdir
335
 
        instance instead.
336
 
        """
337
 
        bzrdir = BzrDir.create(base, format)
338
 
        return bzrdir.create_repository(shared)
339
 
 
340
 
    @staticmethod
341
 
    def create_standalone_workingtree(base, format=None):
342
 
        """Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
343
 
 
344
 
        'base' must be a local path or a file:// url.
345
 
 
346
 
        This will use the current default BzrDirFormat, and use whatever 
347
 
        repository format that that uses for bzrdirformat.create_workingtree,
348
 
        create_branch and create_repository.
349
 
 
350
 
        :return: The WorkingTree object.
351
 
        """
352
 
        t = get_transport(base)
353
 
        if not isinstance(t, LocalTransport):
354
 
            raise errors.NotLocalUrl(base)
355
 
        bzrdir = BzrDir.create_branch_and_repo(base,
356
 
                                               force_new_repo=True,
357
 
                                               format=format).bzrdir
358
 
        return bzrdir.create_workingtree()
359
 
 
360
 
    def create_workingtree(self, revision_id=None):
361
 
        """Create a working tree at this BzrDir.
362
 
        
363
 
        revision_id: create it as of this revision id.
364
 
        """
365
 
        raise NotImplementedError(self.create_workingtree)
366
 
 
367
 
    def retire_bzrdir(self):
 
467
    @deprecated_method(deprecated_in((2, 3, 0)))
 
468
    def generate_backup_name(self, base):
 
469
        return self._available_backup_name(base)
 
470
 
 
471
    def _available_backup_name(self, base):
 
472
        """Find a non-existing backup file name based on base.
 
473
 
 
474
        See bzrlib.osutils.available_backup_name about race conditions.
 
475
        """
 
476
        return osutils.available_backup_name(base, self.root_transport.has)
 
477
 
 
478
    def backup_bzrdir(self):
 
479
        """Backup this bzr control directory.
 
480
 
 
481
        :return: Tuple with old path name and new path name
 
482
        """
 
483
 
 
484
        pb = ui.ui_factory.nested_progress_bar()
 
485
        try:
 
486
            old_path = self.root_transport.abspath('.bzr')
 
487
            backup_dir = self._available_backup_name('backup.bzr')
 
488
            new_path = self.root_transport.abspath(backup_dir)
 
489
            ui.ui_factory.note(gettext('making backup of {0}\n  to {1}').format(
 
490
                urlutils.unescape_for_display(old_path, 'utf-8'),
 
491
                urlutils.unescape_for_display(new_path, 'utf-8')))
 
492
            self.root_transport.copy_tree('.bzr', backup_dir)
 
493
            return (old_path, new_path)
 
494
        finally:
 
495
            pb.finished()
 
496
 
 
497
    def retire_bzrdir(self, limit=10000):
368
498
        """Permanently disable the bzrdir.
369
499
 
370
500
        This is done by renaming it to give the user some ability to recover
372
502
 
373
503
        This will have horrible consequences if anyone has anything locked or
374
504
        in use.
 
505
        :param limit: number of times to retry
375
506
        """
376
 
        for i in xrange(10000):
 
507
        i  = 0
 
508
        while True:
377
509
            try:
378
510
                to_path = '.bzr.retired.%d' % i
379
511
                self.root_transport.rename('.bzr', to_path)
380
 
                note("renamed %s to %s"
381
 
                    % (self.root_transport.abspath('.bzr'), to_path))
382
 
                break
 
512
                note(gettext("renamed {0} to {1}").format(
 
513
                    self.root_transport.abspath('.bzr'), to_path))
 
514
                return
383
515
            except (errors.TransportError, IOError, errors.PathError):
384
 
                pass
385
 
 
386
 
    def destroy_workingtree(self):
387
 
        """Destroy the working tree at this BzrDir.
388
 
 
389
 
        Formats that do not support this may raise UnsupportedOperation.
390
 
        """
391
 
        raise NotImplementedError(self.destroy_workingtree)
392
 
 
393
 
    def destroy_workingtree_metadata(self):
394
 
        """Destroy the control files for the working tree at this BzrDir.
395
 
 
396
 
        The contents of working tree files are not affected.
397
 
        Formats that do not support this may raise UnsupportedOperation.
398
 
        """
399
 
        raise NotImplementedError(self.destroy_workingtree_metadata)
 
516
                i += 1
 
517
                if i > limit:
 
518
                    raise
 
519
                else:
 
520
                    pass
 
521
 
 
522
    def _find_containing(self, evaluate):
 
523
        """Find something in a containing control directory.
 
524
 
 
525
        This method will scan containing control dirs, until it finds what
 
526
        it is looking for, decides that it will never find it, or runs out
 
527
        of containing control directories to check.
 
528
 
 
529
        It is used to implement find_repository and
 
530
        determine_repository_policy.
 
531
 
 
532
        :param evaluate: A function returning (value, stop).  If stop is True,
 
533
            the value will be returned.
 
534
        """
 
535
        found_bzrdir = self
 
536
        while True:
 
537
            result, stop = evaluate(found_bzrdir)
 
538
            if stop:
 
539
                return result
 
540
            next_transport = found_bzrdir.root_transport.clone('..')
 
541
            if (found_bzrdir.user_url == next_transport.base):
 
542
                # top of the file system
 
543
                return None
 
544
            # find the next containing bzrdir
 
545
            try:
 
546
                found_bzrdir = self.open_containing_from_transport(
 
547
                    next_transport)[0]
 
548
            except errors.NotBranchError:
 
549
                return None
400
550
 
401
551
    def find_repository(self):
402
 
        """Find the repository that should be used for a_bzrdir.
 
552
        """Find the repository that should be used.
403
553
 
404
554
        This does not require a branch as we use it to find the repo for
405
555
        new branches as well as to hook existing branches up to their
406
556
        repository.
407
557
        """
408
 
        try:
409
 
            return self.open_repository()
410
 
        except errors.NoRepositoryPresent:
411
 
            pass
412
 
        next_transport = self.root_transport.clone('..')
413
 
        while True:
414
 
            # find the next containing bzrdir
415
 
            try:
416
 
                found_bzrdir = BzrDir.open_containing_from_transport(
417
 
                    next_transport)[0]
418
 
            except errors.NotBranchError:
419
 
                # none found
420
 
                raise errors.NoRepositoryPresent(self)
 
558
        def usable_repository(found_bzrdir):
421
559
            # does it have a repository ?
422
560
            try:
423
561
                repository = found_bzrdir.open_repository()
424
562
            except errors.NoRepositoryPresent:
425
 
                next_transport = found_bzrdir.root_transport.clone('..')
426
 
                if (found_bzrdir.root_transport.base == next_transport.base):
427
 
                    # top of the file system
428
 
                    break
429
 
                else:
430
 
                    continue
431
 
            if ((found_bzrdir.root_transport.base ==
432
 
                 self.root_transport.base) or repository.is_shared()):
433
 
                return repository
434
 
            else:
435
 
                raise errors.NoRepositoryPresent(self)
436
 
        raise errors.NoRepositoryPresent(self)
437
 
 
438
 
    def get_branch_reference(self):
439
 
        """Return the referenced URL for the branch in this bzrdir.
440
 
 
441
 
        :raises NotBranchError: If there is no Branch.
442
 
        :return: The URL the branch in this bzrdir references if it is a
443
 
            reference branch, or None for regular branches.
444
 
        """
 
563
                return None, False
 
564
            if found_bzrdir.user_url == self.user_url:
 
565
                return repository, True
 
566
            elif repository.is_shared():
 
567
                return repository, True
 
568
            else:
 
569
                return None, True
 
570
 
 
571
        found_repo = self._find_containing(usable_repository)
 
572
        if found_repo is None:
 
573
            raise errors.NoRepositoryPresent(self)
 
574
        return found_repo
 
575
 
 
576
    def _find_creation_modes(self):
 
577
        """Determine the appropriate modes for files and directories.
 
578
 
 
579
        They're always set to be consistent with the base directory,
 
580
        assuming that this transport allows setting modes.
 
581
        """
 
582
        # TODO: Do we need or want an option (maybe a config setting) to turn
 
583
        # this off or override it for particular locations? -- mbp 20080512
 
584
        if self._mode_check_done:
 
585
            return
 
586
        self._mode_check_done = True
 
587
        try:
 
588
            st = self.transport.stat('.')
 
589
        except errors.TransportNotPossible:
 
590
            self._dir_mode = None
 
591
            self._file_mode = None
 
592
        else:
 
593
            # Check the directory mode, but also make sure the created
 
594
            # directories and files are read-write for this user. This is
 
595
            # mostly a workaround for filesystems which lie about being able to
 
596
            # write to a directory (cygwin & win32)
 
597
            if (st.st_mode & 07777 == 00000):
 
598
                # FTP allows stat but does not return dir/file modes
 
599
                self._dir_mode = None
 
600
                self._file_mode = None
 
601
            else:
 
602
                self._dir_mode = (st.st_mode & 07777) | 00700
 
603
                # Remove the sticky and execute bits for files
 
604
                self._file_mode = self._dir_mode & ~07111
 
605
 
 
606
    def _get_file_mode(self):
 
607
        """Return Unix mode for newly created files, or None.
 
608
        """
 
609
        if not self._mode_check_done:
 
610
            self._find_creation_modes()
 
611
        return self._file_mode
 
612
 
 
613
    def _get_dir_mode(self):
 
614
        """Return Unix mode for newly created directories, or None.
 
615
        """
 
616
        if not self._mode_check_done:
 
617
            self._find_creation_modes()
 
618
        return self._dir_mode
 
619
 
 
620
    def get_config(self):
 
621
        """Get configuration for this BzrDir."""
 
622
        return config.BzrDirConfig(self)
 
623
 
 
624
    def _get_config(self):
 
625
        """By default, no configuration is available."""
445
626
        return None
446
627
 
447
 
    def get_branch_transport(self, branch_format):
448
 
        """Get the transport for use by branch format in this BzrDir.
449
 
 
450
 
        Note that bzr dirs that do not support format strings will raise
451
 
        IncompatibleFormat if the branch format they are given has
452
 
        a format string, and vice versa.
453
 
 
454
 
        If branch_format is None, the transport is returned with no 
455
 
        checking. if it is not None, then the returned transport is
456
 
        guaranteed to point to an existing directory ready for use.
457
 
        """
458
 
        raise NotImplementedError(self.get_branch_transport)
459
 
        
460
 
    def get_repository_transport(self, repository_format):
461
 
        """Get the transport for use by repository format in this BzrDir.
462
 
 
463
 
        Note that bzr dirs that do not support format strings will raise
464
 
        IncompatibleFormat if the repository format they are given has
465
 
        a format string, and vice versa.
466
 
 
467
 
        If repository_format is None, the transport is returned with no 
468
 
        checking. if it is not None, then the returned transport is
469
 
        guaranteed to point to an existing directory ready for use.
470
 
        """
471
 
        raise NotImplementedError(self.get_repository_transport)
472
 
        
473
 
    def get_workingtree_transport(self, tree_format):
474
 
        """Get the transport for use by workingtree format in this BzrDir.
475
 
 
476
 
        Note that bzr dirs that do not support format strings will raise
477
 
        IncompatibleFormat if the workingtree format they are given has a
478
 
        format string, and vice versa.
479
 
 
480
 
        If workingtree_format is None, the transport is returned with no 
481
 
        checking. if it is not None, then the returned transport is
482
 
        guaranteed to point to an existing directory ready for use.
483
 
        """
484
 
        raise NotImplementedError(self.get_workingtree_transport)
485
 
        
486
628
    def __init__(self, _transport, _format):
487
629
        """Initialize a Bzr control dir object.
488
 
        
 
630
 
489
631
        Only really common logic should reside here, concrete classes should be
490
632
        made with varying behaviours.
491
633
 
493
635
        :param _transport: the transport this dir is based at.
494
636
        """
495
637
        self._format = _format
 
638
        # these are also under the more standard names of 
 
639
        # control_transport and user_transport
496
640
        self.transport = _transport.clone('.bzr')
497
641
        self.root_transport = _transport
 
642
        self._mode_check_done = False
 
643
 
 
644
    @property 
 
645
    def user_transport(self):
 
646
        return self.root_transport
 
647
 
 
648
    @property
 
649
    def control_transport(self):
 
650
        return self.transport
498
651
 
499
652
    def is_control_filename(self, filename):
500
653
        """True if filename is the name of a path which is reserved for bzrdir's.
501
 
        
 
654
 
502
655
        :param filename: A filename within the root transport of this bzrdir.
503
656
 
504
657
        This is true IF and ONLY IF the filename is part of the namespace reserved
505
658
        for bzr control dirs. Currently this is the '.bzr' directory in the root
506
 
        of the root_transport. it is expected that plugins will need to extend
507
 
        this in the future - for instance to make bzr talk with svn working
508
 
        trees.
 
659
        of the root_transport. 
509
660
        """
510
 
        # this might be better on the BzrDirFormat class because it refers to 
511
 
        # all the possible bzrdir disk formats. 
512
 
        # This method is tested via the workingtree is_control_filename tests- 
513
 
        # it was extracted from WorkingTree.is_control_filename. If the methods
514
 
        # contract is extended beyond the current trivial  implementation please
 
661
        # this might be better on the BzrDirFormat class because it refers to
 
662
        # all the possible bzrdir disk formats.
 
663
        # This method is tested via the workingtree is_control_filename tests-
 
664
        # it was extracted from WorkingTree.is_control_filename. If the method's
 
665
        # contract is extended beyond the current trivial implementation, please
515
666
        # add new tests for it to the appropriate place.
516
667
        return filename == '.bzr' or filename.startswith('.bzr/')
517
668
 
518
 
    def needs_format_conversion(self, format=None):
519
 
        """Return true if this bzrdir needs convert_format run on it.
520
 
        
521
 
        For instance, if the repository format is out of date but the 
522
 
        branch and working tree are not, this should return True.
523
 
 
524
 
        :param format: Optional parameter indicating a specific desired
525
 
                       format we plan to arrive at.
526
 
        """
527
 
        raise NotImplementedError(self.needs_format_conversion)
528
 
 
529
 
    @staticmethod
530
 
    def open_unsupported(base):
531
 
        """Open a branch which is not supported."""
532
 
        return BzrDir.open(base, _unsupported=True)
533
 
        
534
 
    @staticmethod
535
 
    def open(base, _unsupported=False):
536
 
        """Open an existing bzrdir, rooted at 'base' (url)
537
 
        
538
 
        _unsupported is a private parameter to the BzrDir class.
539
 
        """
540
 
        t = get_transport(base)
541
 
        return BzrDir.open_from_transport(t, _unsupported=_unsupported)
542
 
 
543
 
    @staticmethod
544
 
    def open_from_transport(transport, _unsupported=False,
545
 
                            _server_formats=True):
546
 
        """Open a bzrdir within a particular directory.
547
 
 
548
 
        :param transport: Transport containing the bzrdir.
549
 
        :param _unsupported: private.
550
 
        """
551
 
        base = transport.base
552
 
 
553
 
        def find_format(transport):
554
 
            return transport, BzrDirFormat.find_format(
555
 
                transport, _server_formats=_server_formats)
556
 
 
557
 
        def redirected(transport, e, redirection_notice):
558
 
            qualified_source = e.get_source_url()
559
 
            relpath = transport.relpath(qualified_source)
560
 
            if not e.target.endswith(relpath):
561
 
                # Not redirected to a branch-format, not a branch
562
 
                raise errors.NotBranchError(path=e.target)
563
 
            target = e.target[:-len(relpath)]
564
 
            note('%s is%s redirected to %s',
565
 
                 transport.base, e.permanently, target)
566
 
            # Let's try with a new transport
567
 
            qualified_target = e.get_target_url()[:-len(relpath)]
568
 
            # FIXME: If 'transport' has a qualifier, this should
569
 
            # be applied again to the new transport *iff* the
570
 
            # schemes used are the same. It's a bit tricky to
571
 
            # verify, so I'll punt for now
572
 
            # -- vila20070212
573
 
            return get_transport(target)
574
 
 
575
 
        try:
576
 
            transport, format = do_catching_redirections(find_format,
577
 
                                                         transport,
578
 
                                                         redirected)
579
 
        except errors.TooManyRedirections:
580
 
            raise errors.NotBranchError(base)
581
 
 
582
 
        BzrDir._check_supported(format, _unsupported)
583
 
        return format.open(transport, _found=True)
584
 
 
585
 
    def open_branch(self, unsupported=False):
586
 
        """Open the branch object at this BzrDir if one is present.
587
 
 
588
 
        If unsupported is True, then no longer supported branch formats can
589
 
        still be opened.
590
 
        
591
 
        TODO: static convenience version of this?
592
 
        """
593
 
        raise NotImplementedError(self.open_branch)
594
 
 
595
 
    @staticmethod
596
 
    def open_containing(url, possible_transports=None):
597
 
        """Open an existing branch which contains url.
598
 
        
599
 
        :param url: url to search from.
600
 
        See open_containing_from_transport for more detail.
601
 
        """
602
 
        transport = get_transport(url, possible_transports)
603
 
        return BzrDir.open_containing_from_transport(transport)
604
 
    
605
 
    @staticmethod
606
 
    def open_containing_from_transport(a_transport):
607
 
        """Open an existing branch which contains a_transport.base
608
 
 
609
 
        This probes for a branch at a_transport, and searches upwards from there.
610
 
 
611
 
        Basically we keep looking up until we find the control directory or
612
 
        run into the root.  If there isn't one, raises NotBranchError.
613
 
        If there is one and it is either an unrecognised format or an unsupported 
614
 
        format, UnknownFormatError or UnsupportedFormatError are raised.
615
 
        If there is one, it is returned, along with the unused portion of url.
616
 
 
617
 
        :return: The BzrDir that contains the path, and a Unicode path 
618
 
                for the rest of the URL.
619
 
        """
620
 
        # this gets the normalised url back. I.e. '.' -> the full path.
621
 
        url = a_transport.base
622
 
        while True:
623
 
            try:
624
 
                result = BzrDir.open_from_transport(a_transport)
625
 
                return result, urlutils.unescape(a_transport.relpath(url))
626
 
            except errors.NotBranchError, e:
627
 
                pass
628
 
            try:
629
 
                new_t = a_transport.clone('..')
630
 
            except errors.InvalidURLJoin:
631
 
                # reached the root, whatever that may be
632
 
                raise errors.NotBranchError(path=url)
633
 
            if new_t.base == a_transport.base:
634
 
                # reached the root, whatever that may be
635
 
                raise errors.NotBranchError(path=url)
636
 
            a_transport = new_t
637
 
 
638
 
    @classmethod
639
 
    def open_containing_tree_or_branch(klass, location):
640
 
        """Return the branch and working tree contained by a location.
641
 
 
642
 
        Returns (tree, branch, relpath).
643
 
        If there is no tree at containing the location, tree will be None.
644
 
        If there is no branch containing the location, an exception will be
645
 
        raised
646
 
        relpath is the portion of the path that is contained by the branch.
647
 
        """
648
 
        bzrdir, relpath = klass.open_containing(location)
649
 
        try:
650
 
            tree = bzrdir.open_workingtree()
651
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
652
 
            tree = None
653
 
            branch = bzrdir.open_branch()
654
 
        else:
655
 
            branch = tree.branch
656
 
        return tree, branch, relpath
657
 
 
658
 
    def open_repository(self, _unsupported=False):
659
 
        """Open the repository object at this BzrDir if one is present.
660
 
 
661
 
        This will not follow the Branch object pointer - its strictly a direct
662
 
        open facility. Most client code should use open_branch().repository to
663
 
        get at a repository.
664
 
 
665
 
        _unsupported is a private parameter, not part of the api.
666
 
        TODO: static convenience version of this?
667
 
        """
668
 
        raise NotImplementedError(self.open_repository)
669
 
 
670
 
    def open_workingtree(self, _unsupported=False,
671
 
            recommend_upgrade=True):
672
 
        """Open the workingtree object at this BzrDir if one is present.
673
 
 
674
 
        :param recommend_upgrade: Optional keyword parameter, when True (the
675
 
            default), emit through the ui module a recommendation that the user
676
 
            upgrade the working tree when the workingtree being opened is old
677
 
            (but still fully supported).
678
 
        """
679
 
        raise NotImplementedError(self.open_workingtree)
680
 
 
681
 
    def has_branch(self):
682
 
        """Tell if this bzrdir contains a branch.
683
 
        
684
 
        Note: if you're going to open the branch, you should just go ahead
685
 
        and try, and not ask permission first.  (This method just opens the 
686
 
        branch and discards it, and that's somewhat expensive.) 
687
 
        """
688
 
        try:
689
 
            self.open_branch()
690
 
            return True
691
 
        except errors.NotBranchError:
692
 
            return False
693
 
 
694
 
    def has_workingtree(self):
695
 
        """Tell if this bzrdir contains a working tree.
696
 
 
697
 
        This will still raise an exception if the bzrdir has a workingtree that
698
 
        is remote & inaccessible.
699
 
        
700
 
        Note: if you're going to open the working tree, you should just go ahead
701
 
        and try, and not ask permission first.  (This method just opens the 
702
 
        workingtree and discards it, and that's somewhat expensive.) 
703
 
        """
704
 
        try:
705
 
            self.open_workingtree(recommend_upgrade=False)
706
 
            return True
707
 
        except errors.NoWorkingTree:
708
 
            return False
709
 
 
710
669
    def _cloning_metadir(self):
711
 
        """Produce a metadir suitable for cloning with"""
 
670
        """Produce a metadir suitable for cloning with.
 
671
 
 
672
        :returns: (destination_bzrdir_format, source_repository)
 
673
        """
712
674
        result_format = self._format.__class__()
713
675
        try:
714
676
            try:
715
 
                branch = self.open_branch()
 
677
                branch = self.open_branch(ignore_fallbacks=True)
716
678
                source_repository = branch.repository
 
679
                result_format._branch_format = branch._format
717
680
            except errors.NotBranchError:
718
681
                source_branch = None
719
682
                source_repository = self.open_repository()
724
687
            # the fix recommended in bug # 103195 - to delegate this choice the
725
688
            # repository itself.
726
689
            repo_format = source_repository._format
727
 
            if not isinstance(repo_format, remote.RemoteRepositoryFormat):
728
 
                result_format.repository_format = repo_format
 
690
            if isinstance(repo_format, remote.RemoteRepositoryFormat):
 
691
                source_repository._ensure_real()
 
692
                repo_format = source_repository._real_repository._format
 
693
            result_format.repository_format = repo_format
729
694
        try:
730
695
            # TODO: Couldn't we just probe for the format in these cases,
731
696
            # rather than opening the whole tree?  It would be a little
737
702
            result_format.workingtree_format = tree._format.__class__()
738
703
        return result_format, source_repository
739
704
 
740
 
    def cloning_metadir(self):
 
705
    def cloning_metadir(self, require_stacking=False):
741
706
        """Produce a metadir suitable for cloning or sprouting with.
742
707
 
743
708
        These operations may produce workingtrees (yes, even though they're
744
 
        "cloning" something that doesn't have a tree, so a viable workingtree
 
709
        "cloning" something that doesn't have a tree), so a viable workingtree
745
710
        format must be selected.
 
711
 
 
712
        :require_stacking: If True, non-stackable formats will be upgraded
 
713
            to similar stackable formats.
 
714
        :returns: a ControlDirFormat with all component formats either set
 
715
            appropriately or set to None if that component should not be
 
716
            created.
746
717
        """
747
718
        format, repository = self._cloning_metadir()
748
719
        if format._workingtree_format is None:
 
720
            # No tree in self.
749
721
            if repository is None:
 
722
                # No repository either
750
723
                return format
 
724
            # We have a repository, so set a working tree? (Why? This seems to
 
725
            # contradict the stated return value in the docstring).
751
726
            tree_format = repository._format._matchingbzrdir.workingtree_format
752
727
            format.workingtree_format = tree_format.__class__()
 
728
        if require_stacking:
 
729
            format.require_stacking()
753
730
        return format
754
731
 
755
 
    def checkout_metadir(self):
756
 
        return self.cloning_metadir()
757
 
 
758
 
    def sprout(self, url, revision_id=None, force_new_repo=False,
759
 
               recurse='down', possible_transports=None):
760
 
        """Create a copy of this bzrdir prepared for use as a new line of
761
 
        development.
762
 
 
763
 
        If urls last component does not exist, it will be created.
764
 
 
765
 
        Attributes related to the identity of the source branch like
766
 
        branch nickname will be cleaned, a working tree is created
767
 
        whether one existed before or not; and a local branch is always
768
 
        created.
769
 
 
770
 
        if revision_id is not None, then the clone operation may tune
771
 
            itself to download less data.
 
732
    def get_branch_transport(self, branch_format, name=None):
 
733
        """Get the transport for use by branch format in this BzrDir.
 
734
 
 
735
        Note that bzr dirs that do not support format strings will raise
 
736
        IncompatibleFormat if the branch format they are given has
 
737
        a format string, and vice versa.
 
738
 
 
739
        If branch_format is None, the transport is returned with no
 
740
        checking. If it is not None, then the returned transport is
 
741
        guaranteed to point to an existing directory ready for use.
772
742
        """
773
 
        target_transport = get_transport(url, possible_transports)
774
 
        target_transport.ensure_base()
775
 
        cloning_format = self.cloning_metadir()
776
 
        result = cloning_format.initialize_on_transport(target_transport)
777
 
        try:
778
 
            source_branch = self.open_branch()
779
 
            source_repository = source_branch.repository
780
 
        except errors.NotBranchError:
781
 
            source_branch = None
782
 
            try:
783
 
                source_repository = self.open_repository()
784
 
            except errors.NoRepositoryPresent:
785
 
                source_repository = None
786
 
        if force_new_repo:
787
 
            result_repo = None
788
 
        else:
789
 
            try:
790
 
                result_repo = result.find_repository()
791
 
            except errors.NoRepositoryPresent:
792
 
                result_repo = None
793
 
        if source_repository is None and result_repo is not None:
794
 
            pass
795
 
        elif source_repository is None and result_repo is None:
796
 
            # no repo available, make a new one
797
 
            result.create_repository()
798
 
        elif source_repository is not None and result_repo is None:
799
 
            # have source, and want to make a new target repo
800
 
            result_repo = source_repository.sprout(result,
801
 
                                                   revision_id=revision_id)
802
 
        else:
803
 
            # fetch needed content into target.
804
 
            if source_repository is not None:
805
 
                # would rather do 
806
 
                # source_repository.copy_content_into(result_repo,
807
 
                #                                     revision_id=revision_id)
808
 
                # so we can override the copy method
809
 
                result_repo.fetch(source_repository, revision_id=revision_id)
810
 
        if source_branch is not None:
811
 
            source_branch.sprout(result, revision_id=revision_id)
812
 
        else:
813
 
            result.create_branch()
814
 
        if isinstance(target_transport, LocalTransport) and (
815
 
            result_repo is None or result_repo.make_working_trees()):
816
 
            wt = result.create_workingtree()
817
 
            wt.lock_write()
818
 
            try:
819
 
                if wt.path2id('') is None:
820
 
                    try:
821
 
                        wt.set_root_id(self.open_workingtree.get_root_id())
822
 
                    except errors.NoWorkingTree:
823
 
                        pass
824
 
            finally:
825
 
                wt.unlock()
826
 
        else:
827
 
            wt = None
828
 
        if recurse == 'down':
829
 
            if wt is not None:
830
 
                basis = wt.basis_tree()
831
 
                basis.lock_read()
832
 
                subtrees = basis.iter_references()
833
 
                recurse_branch = wt.branch
834
 
            elif source_branch is not None:
835
 
                basis = source_branch.basis_tree()
836
 
                basis.lock_read()
837
 
                subtrees = basis.iter_references()
838
 
                recurse_branch = source_branch
839
 
            else:
840
 
                subtrees = []
841
 
                basis = None
842
 
            try:
843
 
                for path, file_id in subtrees:
844
 
                    target = urlutils.join(url, urlutils.escape(path))
845
 
                    sublocation = source_branch.reference_parent(file_id, path)
846
 
                    sublocation.bzrdir.sprout(target,
847
 
                        basis.get_reference_revision(file_id, path),
848
 
                        force_new_repo=force_new_repo, recurse=recurse)
849
 
            finally:
850
 
                if basis is not None:
851
 
                    basis.unlock()
852
 
        return result
853
 
 
854
 
 
855
 
class BzrDirPreSplitOut(BzrDir):
856
 
    """A common class for the all-in-one formats."""
857
 
 
858
 
    def __init__(self, _transport, _format):
859
 
        """See BzrDir.__init__."""
860
 
        super(BzrDirPreSplitOut, self).__init__(_transport, _format)
861
 
        assert self._format._lock_class == lockable_files.TransportLock
862
 
        assert self._format._lock_file_name == 'branch-lock'
863
 
        self._control_files = lockable_files.LockableFiles(
864
 
                                            self.get_branch_transport(None),
865
 
                                            self._format._lock_file_name,
866
 
                                            self._format._lock_class)
867
 
 
868
 
    def break_lock(self):
869
 
        """Pre-splitout bzrdirs do not suffer from stale locks."""
870
 
        raise NotImplementedError(self.break_lock)
871
 
 
872
 
    def clone(self, url, revision_id=None, force_new_repo=False):
873
 
        """See BzrDir.clone()."""
874
 
        from bzrlib.workingtree import WorkingTreeFormat2
875
 
        self._make_tail(url)
876
 
        result = self._format._initialize_for_clone(url)
877
 
        self.open_repository().clone(result, revision_id=revision_id)
878
 
        from_branch = self.open_branch()
879
 
        from_branch.clone(result, revision_id=revision_id)
880
 
        try:
881
 
            self.open_workingtree().clone(result)
882
 
        except errors.NotLocalUrl:
883
 
            # make a new one, this format always has to have one.
884
 
            try:
885
 
                WorkingTreeFormat2().initialize(result)
886
 
            except errors.NotLocalUrl:
887
 
                # but we cannot do it for remote trees.
888
 
                to_branch = result.open_branch()
889
 
                WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
890
 
        return result
891
 
 
892
 
    def create_branch(self):
893
 
        """See BzrDir.create_branch."""
894
 
        return self.open_branch()
895
 
 
896
 
    def create_repository(self, shared=False):
897
 
        """See BzrDir.create_repository."""
898
 
        if shared:
899
 
            raise errors.IncompatibleFormat('shared repository', self._format)
900
 
        return self.open_repository()
901
 
 
902
 
    def create_workingtree(self, revision_id=None):
903
 
        """See BzrDir.create_workingtree."""
904
 
        # this looks buggy but is not -really-
905
 
        # because this format creates the workingtree when the bzrdir is
906
 
        # created
907
 
        # clone and sprout will have set the revision_id
908
 
        # and that will have set it for us, its only
909
 
        # specific uses of create_workingtree in isolation
910
 
        # that can do wonky stuff here, and that only
911
 
        # happens for creating checkouts, which cannot be 
912
 
        # done on this format anyway. So - acceptable wart.
913
 
        result = self.open_workingtree(recommend_upgrade=False)
914
 
        if revision_id is not None:
915
 
            if revision_id == _mod_revision.NULL_REVISION:
916
 
                result.set_parent_ids([])
917
 
            else:
918
 
                result.set_parent_ids([revision_id])
919
 
        return result
920
 
 
921
 
    def destroy_workingtree(self):
922
 
        """See BzrDir.destroy_workingtree."""
923
 
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
924
 
 
925
 
    def destroy_workingtree_metadata(self):
926
 
        """See BzrDir.destroy_workingtree_metadata."""
927
 
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata, 
928
 
                                          self)
929
 
 
930
 
    def get_branch_transport(self, branch_format):
931
 
        """See BzrDir.get_branch_transport()."""
932
 
        if branch_format is None:
933
 
            return self.transport
934
 
        try:
935
 
            branch_format.get_format_string()
936
 
        except NotImplementedError:
937
 
            return self.transport
938
 
        raise errors.IncompatibleFormat(branch_format, self._format)
 
743
        raise NotImplementedError(self.get_branch_transport)
939
744
 
940
745
    def get_repository_transport(self, repository_format):
941
 
        """See BzrDir.get_repository_transport()."""
942
 
        if repository_format is None:
943
 
            return self.transport
944
 
        try:
945
 
            repository_format.get_format_string()
946
 
        except NotImplementedError:
947
 
            return self.transport
948
 
        raise errors.IncompatibleFormat(repository_format, self._format)
949
 
 
950
 
    def get_workingtree_transport(self, workingtree_format):
951
 
        """See BzrDir.get_workingtree_transport()."""
952
 
        if workingtree_format is None:
953
 
            return self.transport
954
 
        try:
955
 
            workingtree_format.get_format_string()
956
 
        except NotImplementedError:
957
 
            return self.transport
958
 
        raise errors.IncompatibleFormat(workingtree_format, self._format)
959
 
 
960
 
    def needs_format_conversion(self, format=None):
961
 
        """See BzrDir.needs_format_conversion()."""
962
 
        # if the format is not the same as the system default,
963
 
        # an upgrade is needed.
964
 
        if format is None:
965
 
            format = BzrDirFormat.get_default_format()
966
 
        return not isinstance(self._format, format.__class__)
967
 
 
968
 
    def open_branch(self, unsupported=False):
969
 
        """See BzrDir.open_branch."""
970
 
        from bzrlib.branch import BzrBranchFormat4
971
 
        format = BzrBranchFormat4()
972
 
        self._check_supported(format, unsupported)
973
 
        return format.open(self, _found=True)
974
 
 
975
 
    def sprout(self, url, revision_id=None, force_new_repo=False,
976
 
               possible_transports=None):
977
 
        """See BzrDir.sprout()."""
978
 
        from bzrlib.workingtree import WorkingTreeFormat2
979
 
        self._make_tail(url)
980
 
        result = self._format._initialize_for_clone(url)
981
 
        try:
982
 
            self.open_repository().clone(result, revision_id=revision_id)
983
 
        except errors.NoRepositoryPresent:
984
 
            pass
985
 
        try:
986
 
            self.open_branch().sprout(result, revision_id=revision_id)
987
 
        except errors.NotBranchError:
988
 
            pass
989
 
        # we always want a working tree
990
 
        WorkingTreeFormat2().initialize(result)
991
 
        return result
992
 
 
993
 
 
994
 
class BzrDir4(BzrDirPreSplitOut):
995
 
    """A .bzr version 4 control object.
996
 
    
997
 
    This is a deprecated format and may be removed after sept 2006.
998
 
    """
999
 
 
1000
 
    def create_repository(self, shared=False):
1001
 
        """See BzrDir.create_repository."""
1002
 
        return self._format.repository_format.initialize(self, shared)
1003
 
 
1004
 
    def needs_format_conversion(self, format=None):
1005
 
        """Format 4 dirs are always in need of conversion."""
1006
 
        return True
1007
 
 
1008
 
    def open_repository(self):
1009
 
        """See BzrDir.open_repository."""
1010
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
1011
 
        return RepositoryFormat4().open(self, _found=True)
1012
 
 
1013
 
 
1014
 
class BzrDir5(BzrDirPreSplitOut):
1015
 
    """A .bzr version 5 control object.
1016
 
 
1017
 
    This is a deprecated format and may be removed after sept 2006.
1018
 
    """
1019
 
 
1020
 
    def open_repository(self):
1021
 
        """See BzrDir.open_repository."""
1022
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1023
 
        return RepositoryFormat5().open(self, _found=True)
1024
 
 
1025
 
    def open_workingtree(self, _unsupported=False,
1026
 
            recommend_upgrade=True):
1027
 
        """See BzrDir.create_workingtree."""
1028
 
        from bzrlib.workingtree import WorkingTreeFormat2
1029
 
        wt_format = WorkingTreeFormat2()
1030
 
        # we don't warn here about upgrades; that ought to be handled for the
1031
 
        # bzrdir as a whole
1032
 
        return wt_format.open(self, _found=True)
1033
 
 
1034
 
 
1035
 
class BzrDir6(BzrDirPreSplitOut):
1036
 
    """A .bzr version 6 control object.
1037
 
 
1038
 
    This is a deprecated format and may be removed after sept 2006.
1039
 
    """
1040
 
 
1041
 
    def open_repository(self):
1042
 
        """See BzrDir.open_repository."""
1043
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1044
 
        return RepositoryFormat6().open(self, _found=True)
1045
 
 
1046
 
    def open_workingtree(self, _unsupported=False,
1047
 
        recommend_upgrade=True):
1048
 
        """See BzrDir.create_workingtree."""
1049
 
        # we don't warn here about upgrades; that ought to be handled for the
1050
 
        # bzrdir as a whole
1051
 
        from bzrlib.workingtree import WorkingTreeFormat2
1052
 
        return WorkingTreeFormat2().open(self, _found=True)
 
746
        """Get the transport for use by repository format in this BzrDir.
 
747
 
 
748
        Note that bzr dirs that do not support format strings will raise
 
749
        IncompatibleFormat if the repository format they are given has
 
750
        a format string, and vice versa.
 
751
 
 
752
        If repository_format is None, the transport is returned with no
 
753
        checking. If it is not None, then the returned transport is
 
754
        guaranteed to point to an existing directory ready for use.
 
755
        """
 
756
        raise NotImplementedError(self.get_repository_transport)
 
757
 
 
758
    def get_workingtree_transport(self, tree_format):
 
759
        """Get the transport for use by workingtree format in this BzrDir.
 
760
 
 
761
        Note that bzr dirs that do not support format strings will raise
 
762
        IncompatibleFormat if the workingtree format they are given has a
 
763
        format string, and vice versa.
 
764
 
 
765
        If workingtree_format is None, the transport is returned with no
 
766
        checking. If it is not None, then the returned transport is
 
767
        guaranteed to point to an existing directory ready for use.
 
768
        """
 
769
        raise NotImplementedError(self.get_workingtree_transport)
 
770
 
 
771
    @classmethod
 
772
    def create(cls, base, format=None, possible_transports=None):
 
773
        """Create a new BzrDir at the url 'base'.
 
774
 
 
775
        :param format: If supplied, the format of branch to create.  If not
 
776
            supplied, the default is used.
 
777
        :param possible_transports: If supplied, a list of transports that
 
778
            can be reused to share a remote connection.
 
779
        """
 
780
        if cls is not BzrDir:
 
781
            raise AssertionError("BzrDir.create always creates the "
 
782
                "default format, not one of %r" % cls)
 
783
        return controldir.ControlDir.create(base, format=format,
 
784
                possible_transports=possible_transports)
 
785
 
 
786
    def __repr__(self):
 
787
        return "<%s at %r>" % (self.__class__.__name__, self.user_url)
 
788
 
 
789
    def update_feature_flags(self, updated_flags):
 
790
        """Update the features required by this bzrdir.
 
791
 
 
792
        :param updated_flags: Dictionary mapping feature names to necessities
 
793
            A necessity can be None to indicate the feature should be removed
 
794
        """
 
795
        self.control_files.lock_write()
 
796
        try:
 
797
            self._format._update_feature_flags(updated_flags)
 
798
            self.transport.put_bytes('branch-format', self._format.as_string())
 
799
        finally:
 
800
            self.control_files.unlock()
1053
801
 
1054
802
 
1055
803
class BzrDirMeta1(BzrDir):
1056
804
    """A .bzr meta version 1 control object.
1057
 
    
1058
 
    This is the first control object where the 
 
805
 
 
806
    This is the first control object where the
1059
807
    individual aspects are really split out: there are separate repository,
1060
808
    workingtree and branch subdirectories and any subset of the three can be
1061
809
    present within a BzrDir.
1062
810
    """
1063
811
 
 
812
    def __init__(self, _transport, _format):
 
813
        super(BzrDirMeta1, self).__init__(_transport, _format)
 
814
        self.control_files = lockable_files.LockableFiles(self.control_transport,
 
815
            self._format._lock_file_name, self._format._lock_class)
 
816
 
1064
817
    def can_convert_format(self):
1065
818
        """See BzrDir.can_convert_format()."""
1066
819
        return True
1067
820
 
1068
 
    def create_branch(self):
1069
 
        """See BzrDir.create_branch."""
1070
 
        return self._format.get_branch_format().initialize(self)
 
821
    def create_branch(self, name=None, repository=None,
 
822
            append_revisions_only=None):
 
823
        """See BzrDir.create_branch."""
 
824
        if name is None:
 
825
            name = self._get_selected_branch()
 
826
        return self._format.get_branch_format().initialize(self, name=name,
 
827
                repository=repository,
 
828
                append_revisions_only=append_revisions_only)
 
829
 
 
830
    def destroy_branch(self, name=None):
 
831
        """See BzrDir.create_branch."""
 
832
        if name is not None:
 
833
            raise errors.NoColocatedBranchSupport(self)
 
834
        self.transport.delete_tree('branch')
1071
835
 
1072
836
    def create_repository(self, shared=False):
1073
837
        """See BzrDir.create_repository."""
1074
838
        return self._format.repository_format.initialize(self, shared)
1075
839
 
1076
 
    def create_workingtree(self, revision_id=None):
 
840
    def destroy_repository(self):
 
841
        """See BzrDir.destroy_repository."""
 
842
        try:
 
843
            self.transport.delete_tree('repository')
 
844
        except errors.NoSuchFile:
 
845
            raise errors.NoRepositoryPresent(self)
 
846
 
 
847
    def create_workingtree(self, revision_id=None, from_branch=None,
 
848
                           accelerator_tree=None, hardlink=False):
1077
849
        """See BzrDir.create_workingtree."""
1078
 
        from bzrlib.workingtree import WorkingTreeFormat
1079
 
        return self._format.workingtree_format.initialize(self, revision_id)
 
850
        return self._format.workingtree_format.initialize(
 
851
            self, revision_id, from_branch=from_branch,
 
852
            accelerator_tree=accelerator_tree, hardlink=hardlink)
1080
853
 
1081
854
    def destroy_workingtree(self):
1082
855
        """See BzrDir.destroy_workingtree."""
1083
856
        wt = self.open_workingtree(recommend_upgrade=False)
1084
857
        repository = wt.branch.repository
1085
858
        empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1086
 
        wt.revert([], old_tree=empty)
 
859
        # We ignore the conflicts returned by wt.revert since we're about to
 
860
        # delete the wt metadata anyway, all that should be left here are
 
861
        # detritus. But see bug #634470 about subtree .bzr dirs.
 
862
        conflicts = wt.revert(old_tree=empty)
1087
863
        self.destroy_workingtree_metadata()
1088
864
 
1089
865
    def destroy_workingtree_metadata(self):
1090
866
        self.transport.delete_tree('checkout')
1091
867
 
1092
 
    def find_branch_format(self):
 
868
    def find_branch_format(self, name=None):
1093
869
        """Find the branch 'format' for this bzrdir.
1094
870
 
1095
871
        This might be a synthetic object for e.g. RemoteBranch and SVN.
1096
872
        """
1097
 
        from bzrlib.branch import BranchFormat
1098
 
        return BranchFormat.find_format(self)
 
873
        from bzrlib.branch import BranchFormatMetadir
 
874
        return BranchFormatMetadir.find_format(self, name=name)
1099
875
 
1100
876
    def _get_mkdir_mode(self):
1101
877
        """Figure out the mode to use when creating a bzrdir subdir."""
1103
879
                                     lockable_files.TransportLock)
1104
880
        return temp_control._dir_mode
1105
881
 
1106
 
    def get_branch_reference(self):
 
882
    def get_branch_reference(self, name=None):
1107
883
        """See BzrDir.get_branch_reference()."""
1108
 
        from bzrlib.branch import BranchFormat
1109
 
        format = BranchFormat.find_format(self)
1110
 
        return format.get_reference(self)
 
884
        from bzrlib.branch import BranchFormatMetadir
 
885
        format = BranchFormatMetadir.find_format(self, name=name)
 
886
        return format.get_reference(self, name=name)
1111
887
 
1112
 
    def get_branch_transport(self, branch_format):
 
888
    def get_branch_transport(self, branch_format, name=None):
1113
889
        """See BzrDir.get_branch_transport()."""
 
890
        if name is not None:
 
891
            raise errors.NoColocatedBranchSupport(self)
 
892
        # XXX: this shouldn't implicitly create the directory if it's just
 
893
        # promising to get a transport -- mbp 20090727
1114
894
        if branch_format is None:
1115
895
            return self.transport.clone('branch')
1116
896
        try:
1151
931
            pass
1152
932
        return self.transport.clone('checkout')
1153
933
 
1154
 
    def needs_format_conversion(self, format=None):
 
934
    def has_workingtree(self):
 
935
        """Tell if this bzrdir contains a working tree.
 
936
 
 
937
        Note: if you're going to open the working tree, you should just go
 
938
        ahead and try, and not ask permission first.
 
939
        """
 
940
        from bzrlib.workingtree import WorkingTreeFormatMetaDir
 
941
        try:
 
942
            WorkingTreeFormatMetaDir.find_format_string(self)
 
943
        except errors.NoWorkingTree:
 
944
            return False
 
945
        return True
 
946
 
 
947
    def needs_format_conversion(self, format):
1155
948
        """See BzrDir.needs_format_conversion()."""
1156
 
        if format is None:
1157
 
            format = BzrDirFormat.get_default_format()
1158
 
        if not isinstance(self._format, format.__class__):
 
949
        if (not isinstance(self._format, format.__class__) or
 
950
            self._format.get_format_string() != format.get_format_string()):
1159
951
            # it is not a meta dir format, conversion is needed.
1160
952
            return True
1161
953
        # we might want to push this down to the repository?
1166
958
                return True
1167
959
        except errors.NoRepositoryPresent:
1168
960
            pass
1169
 
        try:
1170
 
            if not isinstance(self.open_branch()._format,
 
961
        for branch in self.list_branches():
 
962
            if not isinstance(branch._format,
1171
963
                              format.get_branch_format().__class__):
1172
964
                # the branch needs an upgrade.
1173
965
                return True
1174
 
        except errors.NotBranchError:
1175
 
            pass
1176
966
        try:
1177
967
            my_wt = self.open_workingtree(recommend_upgrade=False)
1178
968
            if not isinstance(my_wt._format,
1183
973
            pass
1184
974
        return False
1185
975
 
1186
 
    def open_branch(self, unsupported=False):
1187
 
        """See BzrDir.open_branch."""
1188
 
        format = self.find_branch_format()
1189
 
        self._check_supported(format, unsupported)
1190
 
        return format.open(self, _found=True)
 
976
    def open_branch(self, name=None, unsupported=False,
 
977
                    ignore_fallbacks=False, possible_transports=None):
 
978
        """See ControlDir.open_branch."""
 
979
        if name is None:
 
980
            name = self._get_selected_branch()
 
981
        format = self.find_branch_format(name=name)
 
982
        format.check_support_status(unsupported)
 
983
        return format.open(self, name=name,
 
984
            _found=True, ignore_fallbacks=ignore_fallbacks,
 
985
            possible_transports=possible_transports)
1191
986
 
1192
987
    def open_repository(self, unsupported=False):
1193
988
        """See BzrDir.open_repository."""
1194
 
        from bzrlib.repository import RepositoryFormat
1195
 
        format = RepositoryFormat.find_format(self)
1196
 
        self._check_supported(format, unsupported)
 
989
        from bzrlib.repository import RepositoryFormatMetaDir
 
990
        format = RepositoryFormatMetaDir.find_format(self)
 
991
        format.check_support_status(unsupported)
1197
992
        return format.open(self, _found=True)
1198
993
 
1199
994
    def open_workingtree(self, unsupported=False,
1200
995
            recommend_upgrade=True):
1201
996
        """See BzrDir.open_workingtree."""
1202
 
        from bzrlib.workingtree import WorkingTreeFormat
1203
 
        format = WorkingTreeFormat.find_format(self)
1204
 
        self._check_supported(format, unsupported,
1205
 
            recommend_upgrade,
 
997
        from bzrlib.workingtree import WorkingTreeFormatMetaDir
 
998
        format = WorkingTreeFormatMetaDir.find_format(self)
 
999
        format.check_support_status(unsupported, recommend_upgrade,
1206
1000
            basedir=self.root_transport.base)
1207
1001
        return format.open(self, _found=True)
1208
1002
 
1209
 
 
1210
 
class BzrDirFormat(object):
1211
 
    """An encapsulation of the initialization and open routines for a format.
1212
 
 
1213
 
    Formats provide three things:
1214
 
     * An initialization routine,
1215
 
     * a format string,
1216
 
     * an open routine.
1217
 
 
1218
 
    Formats are placed in an dict by their format string for reference 
 
1003
    def _get_config(self):
 
1004
        return config.TransportConfig(self.transport, 'control.conf')
 
1005
 
 
1006
 
 
1007
class BzrDirMeta1Colo(BzrDirMeta1):
 
1008
    """BzrDirMeta1 with support for colocated branches.
 
1009
 
 
1010
    This format is experimental, and will eventually be merged back into
 
1011
    BzrDirMeta1.
 
1012
    """
 
1013
 
 
1014
    def _get_branch_path(self, name):
 
1015
        """Obtain the branch path to use.
 
1016
 
 
1017
        This uses the API specified branch name first, and then falls back to
 
1018
        the branch name specified in the URL. If neither of those is specified,
 
1019
        it uses the default branch.
 
1020
 
 
1021
        :param name: Optional branch name to use
 
1022
        :return: Relative path to branch
 
1023
        """
 
1024
        if name is None:
 
1025
            return 'branch'
 
1026
        return urlutils.join('branches', name.encode("utf-8"))
 
1027
 
 
1028
    def _read_branch_list(self):
 
1029
        """Read the branch list.
 
1030
 
 
1031
        :return: List of utf-8 encoded branch names.
 
1032
        """
 
1033
        try:
 
1034
            f = self.control_transport.get('branch-list')
 
1035
        except errors.NoSuchFile:
 
1036
            return []
 
1037
 
 
1038
        ret = []
 
1039
        try:
 
1040
            for name in f:
 
1041
                ret.append(name.rstrip("\n"))
 
1042
        finally:
 
1043
            f.close()
 
1044
        return ret
 
1045
 
 
1046
    def _write_branch_list(self, branches):
 
1047
        """Write out the branch list.
 
1048
 
 
1049
        :param branches: List of utf-8 branch names to write
 
1050
        """
 
1051
        self.transport.put_bytes('branch-list',
 
1052
            "".join([name+"\n" for name in branches]))
 
1053
 
 
1054
    def destroy_branch(self, name=None):
 
1055
        """See BzrDir.create_branch."""
 
1056
        if name is None:
 
1057
            name = self._get_selected_branch()
 
1058
        path = self._get_branch_path(name)
 
1059
        if name is not None:
 
1060
            self.control_files.lock_write()
 
1061
            try:
 
1062
                branches = self._read_branch_list()
 
1063
                try:
 
1064
                    branches.remove(name.encode("utf-8"))
 
1065
                except ValueError:
 
1066
                    raise errors.NotBranchError(name)
 
1067
                self._write_branch_list(branches)
 
1068
            finally:
 
1069
                self.control_files.unlock()
 
1070
        self.transport.delete_tree(path)
 
1071
 
 
1072
    def get_branches(self):
 
1073
        """See ControlDir.get_branches."""
 
1074
        ret = {}
 
1075
        try:
 
1076
            ret[None] = self.open_branch()
 
1077
        except (errors.NotBranchError, errors.NoRepositoryPresent):
 
1078
            pass
 
1079
 
 
1080
        for name in self._read_branch_list():
 
1081
            ret[name] = self.open_branch(name.decode('utf-8'))
 
1082
 
 
1083
        return ret
 
1084
 
 
1085
    def get_branch_transport(self, branch_format, name=None):
 
1086
        """See BzrDir.get_branch_transport()."""
 
1087
        path = self._get_branch_path(name)
 
1088
        # XXX: this shouldn't implicitly create the directory if it's just
 
1089
        # promising to get a transport -- mbp 20090727
 
1090
        if branch_format is None:
 
1091
            return self.transport.clone(path)
 
1092
        try:
 
1093
            branch_format.get_format_string()
 
1094
        except NotImplementedError:
 
1095
            raise errors.IncompatibleFormat(branch_format, self._format)
 
1096
        if name is not None:
 
1097
            try:
 
1098
                self.transport.mkdir('branches', mode=self._get_mkdir_mode())
 
1099
            except errors.FileExists:
 
1100
                pass
 
1101
            branches = self._read_branch_list()
 
1102
            utf8_name = name.encode("utf-8")
 
1103
            if not utf8_name in branches:
 
1104
                self.control_files.lock_write()
 
1105
                try:
 
1106
                    branches = self._read_branch_list()
 
1107
                    branches.append(utf8_name)
 
1108
                    self._write_branch_list(branches)
 
1109
                finally:
 
1110
                    self.control_files.unlock()
 
1111
        try:
 
1112
            self.transport.mkdir(path, mode=self._get_mkdir_mode())
 
1113
        except errors.FileExists:
 
1114
            pass
 
1115
        return self.transport.clone(path)
 
1116
 
 
1117
 
 
1118
class BzrFormat(object):
 
1119
    """Base class for all formats of things living in metadirs.
 
1120
 
 
1121
    This class manages the format string that is stored in the 'format'
 
1122
    or 'branch-format' file.
 
1123
 
 
1124
    All classes for (branch-, repository-, workingtree-) formats that
 
1125
    live in meta directories and have their own 'format' file
 
1126
    (i.e. different from .bzr/branch-format) derive from this class,
 
1127
    as well as the relevant base class for their kind
 
1128
    (BranchFormat, WorkingTreeFormat, RepositoryFormat).
 
1129
 
 
1130
    Each format is identified by a "format" or "branch-format" file with a
 
1131
    single line containing the base format name and then an optional list of
 
1132
    feature flags.
 
1133
 
 
1134
    Feature flags are supported as of bzr 2.5. Setting feature flags on formats
 
1135
    will render them inaccessible to older versions of bzr.
 
1136
 
 
1137
    :ivar features: Dictionary mapping feature names to their necessity
 
1138
    """
 
1139
 
 
1140
    _present_features = set()
 
1141
 
 
1142
    def __init__(self):
 
1143
        self.features = {}
 
1144
 
 
1145
    @classmethod
 
1146
    def register_feature(cls, name):
 
1147
        """Register a feature as being present.
 
1148
 
 
1149
        :param name: Name of the feature
 
1150
        """
 
1151
        if " " in name:
 
1152
            raise ValueError("spaces are not allowed in feature names")
 
1153
        if name in cls._present_features:
 
1154
            raise errors.FeatureAlreadyRegistered(name)
 
1155
        cls._present_features.add(name)
 
1156
 
 
1157
    @classmethod
 
1158
    def unregister_feature(cls, name):
 
1159
        """Unregister a feature."""
 
1160
        cls._present_features.remove(name)
 
1161
 
 
1162
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
1163
            basedir=None):
 
1164
        for name, necessity in self.features.iteritems():
 
1165
            if name in self._present_features:
 
1166
                continue
 
1167
            if necessity == "optional":
 
1168
                mutter("ignoring optional missing feature %s", name)
 
1169
                continue
 
1170
            elif necessity == "required":
 
1171
                raise errors.MissingFeature(name)
 
1172
            else:
 
1173
                mutter("treating unknown necessity as require for %s",
 
1174
                       name)
 
1175
                raise errors.MissingFeature(name)
 
1176
 
 
1177
    @classmethod
 
1178
    def get_format_string(cls):
 
1179
        """Return the ASCII format string that identifies this format."""
 
1180
        raise NotImplementedError(cls.get_format_string)
 
1181
 
 
1182
    @classmethod
 
1183
    def from_string(cls, text):
 
1184
        format_string = cls.get_format_string()
 
1185
        if not text.startswith(format_string):
 
1186
            raise AssertionError("Invalid format header %r for %r" % (text, cls))
 
1187
        lines = text[len(format_string):].splitlines()
 
1188
        ret = cls()
 
1189
        for lineno, line in enumerate(lines):
 
1190
            try:
 
1191
                (necessity, feature) = line.split(" ", 1)
 
1192
            except ValueError:
 
1193
                raise errors.ParseFormatError(format=cls, lineno=lineno+2,
 
1194
                    line=line, text=text)
 
1195
            ret.features[feature] = necessity
 
1196
        return ret
 
1197
 
 
1198
    def as_string(self):
 
1199
        """Return the string representation of this format.
 
1200
        """
 
1201
        lines = [self.get_format_string()]
 
1202
        lines.extend([("%s %s\n" % (item[1], item[0])) for item in
 
1203
            self.features.iteritems()])
 
1204
        return "".join(lines)
 
1205
 
 
1206
    @classmethod
 
1207
    def _find_format(klass, registry, kind, format_string):
 
1208
        try:
 
1209
            first_line = format_string[:format_string.index("\n")+1]
 
1210
        except ValueError:
 
1211
            first_line = format_string
 
1212
        try:
 
1213
            cls = registry.get(first_line)
 
1214
        except KeyError:
 
1215
            raise errors.UnknownFormatError(format=first_line, kind=kind)
 
1216
        return cls.from_string(format_string)
 
1217
 
 
1218
    def network_name(self):
 
1219
        """A simple byte string uniquely identifying this format for RPC calls.
 
1220
 
 
1221
        Metadir branch formats use their format string.
 
1222
        """
 
1223
        return self.as_string()
 
1224
 
 
1225
    def __eq__(self, other):
 
1226
        return (self.__class__ is other.__class__ and
 
1227
                self.features == other.features)
 
1228
 
 
1229
    def _update_feature_flags(self, updated_flags):
 
1230
        """Update the feature flags in this format.
 
1231
 
 
1232
        :param updated_flags: Updated feature flags
 
1233
        """
 
1234
        for name, necessity in updated_flags.iteritems():
 
1235
            if necessity is None:
 
1236
                try:
 
1237
                    del self.features[name]
 
1238
                except KeyError:
 
1239
                    pass
 
1240
            else:
 
1241
                self.features[name] = necessity
 
1242
 
 
1243
 
 
1244
class BzrProber(controldir.Prober):
 
1245
    """Prober for formats that use a .bzr/ control directory."""
 
1246
 
 
1247
    formats = registry.FormatRegistry(controldir.network_format_registry)
 
1248
    """The known .bzr formats."""
 
1249
 
 
1250
    @classmethod
 
1251
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1252
    def register_bzrdir_format(klass, format):
 
1253
        klass.formats.register(format.get_format_string(), format)
 
1254
 
 
1255
    @classmethod
 
1256
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1257
    def unregister_bzrdir_format(klass, format):
 
1258
        klass.formats.remove(format.get_format_string())
 
1259
 
 
1260
    @classmethod
 
1261
    def probe_transport(klass, transport):
 
1262
        """Return the .bzrdir style format present in a directory."""
 
1263
        try:
 
1264
            format_string = transport.get_bytes(".bzr/branch-format")
 
1265
        except errors.NoSuchFile:
 
1266
            raise errors.NotBranchError(path=transport.base)
 
1267
        try:
 
1268
            first_line = format_string[:format_string.index("\n")+1]
 
1269
        except ValueError:
 
1270
            first_line = format_string
 
1271
        try:
 
1272
            cls = klass.formats.get(first_line)
 
1273
        except KeyError:
 
1274
            raise errors.UnknownFormatError(format=first_line, kind='bzrdir')
 
1275
        return cls.from_string(format_string)
 
1276
 
 
1277
    @classmethod
 
1278
    def known_formats(cls):
 
1279
        result = set()
 
1280
        for name, format in cls.formats.iteritems():
 
1281
            if callable(format):
 
1282
                format = format()
 
1283
            result.add(format)
 
1284
        return result
 
1285
 
 
1286
 
 
1287
controldir.ControlDirFormat.register_prober(BzrProber)
 
1288
 
 
1289
 
 
1290
class RemoteBzrProber(controldir.Prober):
 
1291
    """Prober for remote servers that provide a Bazaar smart server."""
 
1292
 
 
1293
    @classmethod
 
1294
    def probe_transport(klass, transport):
 
1295
        """Return a RemoteBzrDirFormat object if it looks possible."""
 
1296
        try:
 
1297
            medium = transport.get_smart_medium()
 
1298
        except (NotImplementedError, AttributeError,
 
1299
                errors.TransportNotPossible, errors.NoSmartMedium,
 
1300
                errors.SmartProtocolError):
 
1301
            # no smart server, so not a branch for this format type.
 
1302
            raise errors.NotBranchError(path=transport.base)
 
1303
        else:
 
1304
            # Decline to open it if the server doesn't support our required
 
1305
            # version (3) so that the VFS-based transport will do it.
 
1306
            if medium.should_probe():
 
1307
                try:
 
1308
                    server_version = medium.protocol_version()
 
1309
                except errors.SmartProtocolError:
 
1310
                    # Apparently there's no usable smart server there, even though
 
1311
                    # the medium supports the smart protocol.
 
1312
                    raise errors.NotBranchError(path=transport.base)
 
1313
                if server_version != '2':
 
1314
                    raise errors.NotBranchError(path=transport.base)
 
1315
            from bzrlib.remote import RemoteBzrDirFormat
 
1316
            return RemoteBzrDirFormat()
 
1317
 
 
1318
    @classmethod
 
1319
    def known_formats(cls):
 
1320
        from bzrlib.remote import RemoteBzrDirFormat
 
1321
        return set([RemoteBzrDirFormat()])
 
1322
 
 
1323
 
 
1324
class BzrDirFormat(BzrFormat, controldir.ControlDirFormat):
 
1325
    """ControlDirFormat base class for .bzr/ directories.
 
1326
 
 
1327
    Formats are placed in a dict by their format string for reference
1219
1328
    during bzrdir opening. These should be subclasses of BzrDirFormat
1220
1329
    for consistency.
1221
1330
 
1222
1331
    Once a format is deprecated, just deprecate the initialize and open
1223
 
    methods on the format class. Do not deprecate the object, as the 
 
1332
    methods on the format class. Do not deprecate the object, as the
1224
1333
    object will be created every system load.
1225
1334
    """
1226
1335
 
1227
 
    _default_format = None
1228
 
    """The default format used for new .bzr dirs."""
1229
 
 
1230
 
    _formats = {}
1231
 
    """The known formats."""
1232
 
 
1233
 
    _control_formats = []
1234
 
    """The registered control formats - .bzr, ....
1235
 
    
1236
 
    This is a list of BzrDirFormat objects.
1237
 
    """
1238
 
 
1239
 
    _control_server_formats = []
1240
 
    """The registered control server formats, e.g. RemoteBzrDirs.
1241
 
 
1242
 
    This is a list of BzrDirFormat objects.
1243
 
    """
1244
 
 
1245
1336
    _lock_file_name = 'branch-lock'
1246
1337
 
1247
1338
    # _lock_class must be set in subclasses to the lock type, typ.
1248
1339
    # TransportLock or LockDir
1249
1340
 
1250
 
    @classmethod
1251
 
    def find_format(klass, transport, _server_formats=True):
1252
 
        """Return the format present at transport."""
1253
 
        if _server_formats:
1254
 
            formats = klass._control_server_formats + klass._control_formats
1255
 
        else:
1256
 
            formats = klass._control_formats
1257
 
        for format in formats:
1258
 
            try:
1259
 
                return format.probe_transport(transport)
1260
 
            except errors.NotBranchError:
1261
 
                # this format does not find a control dir here.
1262
 
                pass
1263
 
        raise errors.NotBranchError(path=transport.base)
1264
 
 
1265
 
    @classmethod
1266
 
    def probe_transport(klass, transport):
1267
 
        """Return the .bzrdir style format present in a directory."""
1268
 
        try:
1269
 
            format_string = transport.get(".bzr/branch-format").read()
1270
 
        except errors.NoSuchFile:
1271
 
            raise errors.NotBranchError(path=transport.base)
1272
 
 
1273
 
        try:
1274
 
            return klass._formats[format_string]
1275
 
        except KeyError:
1276
 
            raise errors.UnknownFormatError(format=format_string)
1277
 
 
1278
 
    @classmethod
1279
 
    def get_default_format(klass):
1280
 
        """Return the current default format."""
1281
 
        return klass._default_format
1282
 
 
1283
 
    def get_format_string(self):
1284
 
        """Return the ASCII format string that identifies this format."""
1285
 
        raise NotImplementedError(self.get_format_string)
1286
 
 
1287
 
    def get_format_description(self):
1288
 
        """Return the short description for this format."""
1289
 
        raise NotImplementedError(self.get_format_description)
1290
 
 
1291
 
    def get_converter(self, format=None):
1292
 
        """Return the converter to use to convert bzrdirs needing converts.
1293
 
 
1294
 
        This returns a bzrlib.bzrdir.Converter object.
1295
 
 
1296
 
        This should return the best upgrader to step this format towards the
1297
 
        current default format. In the case of plugins we can/should provide
1298
 
        some means for them to extend the range of returnable converters.
1299
 
 
1300
 
        :param format: Optional format to override the default format of the 
1301
 
                       library.
1302
 
        """
1303
 
        raise NotImplementedError(self.get_converter)
1304
 
 
1305
 
    def initialize(self, url, possible_transports=None):
1306
 
        """Create a bzr control dir at this url and return an opened copy.
1307
 
        
1308
 
        Subclasses should typically override initialize_on_transport
1309
 
        instead of this method.
1310
 
        """
1311
 
        return self.initialize_on_transport(get_transport(url,
1312
 
                                                          possible_transports))
1313
 
 
1314
1341
    def initialize_on_transport(self, transport):
1315
1342
        """Initialize a new bzrdir in the base directory of a Transport."""
1316
 
        # Since we don't have a .bzr directory, inherit the
 
1343
        try:
 
1344
            # can we hand off the request to the smart server rather than using
 
1345
            # vfs calls?
 
1346
            client_medium = transport.get_smart_medium()
 
1347
        except errors.NoSmartMedium:
 
1348
            return self._initialize_on_transport_vfs(transport)
 
1349
        else:
 
1350
            # Current RPC's only know how to create bzr metadir1 instances, so
 
1351
            # we still delegate to vfs methods if the requested format is not a
 
1352
            # metadir1
 
1353
            if type(self) != BzrDirMetaFormat1:
 
1354
                return self._initialize_on_transport_vfs(transport)
 
1355
            from bzrlib.remote import RemoteBzrDirFormat
 
1356
            remote_format = RemoteBzrDirFormat()
 
1357
            self._supply_sub_formats_to(remote_format)
 
1358
            return remote_format.initialize_on_transport(transport)
 
1359
 
 
1360
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
 
1361
        create_prefix=False, force_new_repo=False, stacked_on=None,
 
1362
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
 
1363
        shared_repo=False, vfs_only=False):
 
1364
        """Create this format on transport.
 
1365
 
 
1366
        The directory to initialize will be created.
 
1367
 
 
1368
        :param force_new_repo: Do not use a shared repository for the target,
 
1369
                               even if one is available.
 
1370
        :param create_prefix: Create any missing directories leading up to
 
1371
            to_transport.
 
1372
        :param use_existing_dir: Use an existing directory if one exists.
 
1373
        :param stacked_on: A url to stack any created branch on, None to follow
 
1374
            any target stacking policy.
 
1375
        :param stack_on_pwd: If stack_on is relative, the location it is
 
1376
            relative to.
 
1377
        :param repo_format_name: If non-None, a repository will be
 
1378
            made-or-found. Should none be found, or if force_new_repo is True
 
1379
            the repo_format_name is used to select the format of repository to
 
1380
            create.
 
1381
        :param make_working_trees: Control the setting of make_working_trees
 
1382
            for a new shared repository when one is made. None to use whatever
 
1383
            default the format has.
 
1384
        :param shared_repo: Control whether made repositories are shared or
 
1385
            not.
 
1386
        :param vfs_only: If True do not attempt to use a smart server
 
1387
        :return: repo, bzrdir, require_stacking, repository_policy. repo is
 
1388
            None if none was created or found, bzrdir is always valid.
 
1389
            require_stacking is the result of examining the stacked_on
 
1390
            parameter and any stacking policy found for the target.
 
1391
        """
 
1392
        if not vfs_only:
 
1393
            # Try to hand off to a smart server 
 
1394
            try:
 
1395
                client_medium = transport.get_smart_medium()
 
1396
            except errors.NoSmartMedium:
 
1397
                pass
 
1398
            else:
 
1399
                from bzrlib.remote import RemoteBzrDirFormat
 
1400
                # TODO: lookup the local format from a server hint.
 
1401
                remote_dir_format = RemoteBzrDirFormat()
 
1402
                remote_dir_format._network_name = self.network_name()
 
1403
                self._supply_sub_formats_to(remote_dir_format)
 
1404
                return remote_dir_format.initialize_on_transport_ex(transport,
 
1405
                    use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
1406
                    force_new_repo=force_new_repo, stacked_on=stacked_on,
 
1407
                    stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
1408
                    make_working_trees=make_working_trees, shared_repo=shared_repo)
 
1409
        # XXX: Refactor the create_prefix/no_create_prefix code into a
 
1410
        #      common helper function
 
1411
        # The destination may not exist - if so make it according to policy.
 
1412
        def make_directory(transport):
 
1413
            transport.mkdir('.')
 
1414
            return transport
 
1415
        def redirected(transport, e, redirection_notice):
 
1416
            note(redirection_notice)
 
1417
            return transport._redirected_to(e.source, e.target)
 
1418
        try:
 
1419
            transport = do_catching_redirections(make_directory, transport,
 
1420
                redirected)
 
1421
        except errors.FileExists:
 
1422
            if not use_existing_dir:
 
1423
                raise
 
1424
        except errors.NoSuchFile:
 
1425
            if not create_prefix:
 
1426
                raise
 
1427
            transport.create_prefix()
 
1428
 
 
1429
        require_stacking = (stacked_on is not None)
 
1430
        # Now the target directory exists, but doesn't have a .bzr
 
1431
        # directory. So we need to create it, along with any work to create
 
1432
        # all of the dependent branches, etc.
 
1433
 
 
1434
        result = self.initialize_on_transport(transport)
 
1435
        if repo_format_name:
 
1436
            try:
 
1437
                # use a custom format
 
1438
                result._format.repository_format = \
 
1439
                    repository.network_format_registry.get(repo_format_name)
 
1440
            except AttributeError:
 
1441
                # The format didn't permit it to be set.
 
1442
                pass
 
1443
            # A repository is desired, either in-place or shared.
 
1444
            repository_policy = result.determine_repository_policy(
 
1445
                force_new_repo, stacked_on, stack_on_pwd,
 
1446
                require_stacking=require_stacking)
 
1447
            result_repo, is_new_repo = repository_policy.acquire_repository(
 
1448
                make_working_trees, shared_repo)
 
1449
            if not require_stacking and repository_policy._require_stacking:
 
1450
                require_stacking = True
 
1451
                result._format.require_stacking()
 
1452
            result_repo.lock_write()
 
1453
        else:
 
1454
            result_repo = None
 
1455
            repository_policy = None
 
1456
        return result_repo, result, require_stacking, repository_policy
 
1457
 
 
1458
    def _initialize_on_transport_vfs(self, transport):
 
1459
        """Initialize a new bzrdir using VFS calls.
 
1460
 
 
1461
        :param transport: The transport to create the .bzr directory in.
 
1462
        :return: A
 
1463
        """
 
1464
        # Since we are creating a .bzr directory, inherit the
1317
1465
        # mode from the root directory
1318
1466
        temp_control = lockable_files.LockableFiles(transport,
1319
1467
                            '', lockable_files.TransportLock)
1321
1469
                                      # FIXME: RBC 20060121 don't peek under
1322
1470
                                      # the covers
1323
1471
                                      mode=temp_control._dir_mode)
 
1472
        if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
 
1473
            win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1324
1474
        file_mode = temp_control._file_mode
1325
1475
        del temp_control
1326
 
        mutter('created control directory in ' + transport.base)
1327
 
        control = transport.clone('.bzr')
1328
 
        utf8_files = [('README', 
1329
 
                       "This is a Bazaar-NG control directory.\n"
1330
 
                       "Do not change any files in this directory.\n"),
1331
 
                      ('branch-format', self.get_format_string()),
 
1476
        bzrdir_transport = transport.clone('.bzr')
 
1477
        utf8_files = [('README',
 
1478
                       "This is a Bazaar control directory.\n"
 
1479
                       "Do not change any files in this directory.\n"
 
1480
                       "See http://bazaar.canonical.com/ for more information about Bazaar.\n"),
 
1481
                      ('branch-format', self.as_string()),
1332
1482
                      ]
1333
1483
        # NB: no need to escape relative paths that are url safe.
1334
 
        control_files = lockable_files.LockableFiles(control,
1335
 
                            self._lock_file_name, self._lock_class)
 
1484
        control_files = lockable_files.LockableFiles(bzrdir_transport,
 
1485
            self._lock_file_name, self._lock_class)
1336
1486
        control_files.create_lock()
1337
1487
        control_files.lock_write()
1338
1488
        try:
1339
 
            for file, content in utf8_files:
1340
 
                control_files.put_utf8(file, content)
 
1489
            for (filename, content) in utf8_files:
 
1490
                bzrdir_transport.put_bytes(filename, content,
 
1491
                    mode=file_mode)
1341
1492
        finally:
1342
1493
            control_files.unlock()
1343
1494
        return self.open(transport, _found=True)
1344
1495
 
1345
 
    def is_supported(self):
1346
 
        """Is this format supported?
1347
 
 
1348
 
        Supported formats must be initializable and openable.
1349
 
        Unsupported formats may not support initialization or committing or 
1350
 
        some other features depending on the reason for not being supported.
1351
 
        """
1352
 
        return True
1353
 
 
1354
 
    def same_model(self, target_format):
1355
 
        return (self.repository_format.rich_root_data == 
1356
 
            target_format.rich_root_data)
1357
 
 
1358
 
    @classmethod
1359
 
    def known_formats(klass):
1360
 
        """Return all the known formats.
1361
 
        
1362
 
        Concrete formats should override _known_formats.
1363
 
        """
1364
 
        # There is double indirection here to make sure that control 
1365
 
        # formats used by more than one dir format will only be probed 
1366
 
        # once. This can otherwise be quite expensive for remote connections.
1367
 
        result = set()
1368
 
        for format in klass._control_formats:
1369
 
            result.update(format._known_formats())
1370
 
        return result
1371
 
    
1372
 
    @classmethod
1373
 
    def _known_formats(klass):
1374
 
        """Return the known format instances for this control format."""
1375
 
        return set(klass._formats.values())
1376
 
 
1377
1496
    def open(self, transport, _found=False):
1378
1497
        """Return an instance of this format for the dir transport points at.
1379
 
        
 
1498
 
1380
1499
        _found is a private parameter, do not use it.
1381
1500
        """
1382
1501
        if not _found:
1383
 
            found_format = BzrDirFormat.find_format(transport)
 
1502
            found_format = controldir.ControlDirFormat.find_format(transport)
1384
1503
            if not isinstance(found_format, self.__class__):
1385
1504
                raise AssertionError("%s was asked to open %s, but it seems to need "
1386
 
                        "format %s" 
 
1505
                        "format %s"
1387
1506
                        % (self, transport, found_format))
 
1507
            # Allow subclasses - use the found format.
 
1508
            self._supply_sub_formats_to(found_format)
 
1509
            return found_format._open(transport)
1388
1510
        return self._open(transport)
1389
1511
 
1390
1512
    def _open(self, transport):
1395
1517
        """
1396
1518
        raise NotImplementedError(self._open)
1397
1519
 
1398
 
    @classmethod
1399
 
    def register_format(klass, format):
1400
 
        klass._formats[format.get_format_string()] = format
1401
 
 
1402
 
    @classmethod
1403
 
    def register_control_format(klass, format):
1404
 
        """Register a format that does not use '.bzr' for its control dir.
1405
 
 
1406
 
        TODO: This should be pulled up into a 'ControlDirFormat' base class
1407
 
        which BzrDirFormat can inherit from, and renamed to register_format 
1408
 
        there. It has been done without that for now for simplicity of
1409
 
        implementation.
1410
 
        """
1411
 
        klass._control_formats.append(format)
1412
 
 
1413
 
    @classmethod
1414
 
    def register_control_server_format(klass, format):
1415
 
        """Register a control format for client-server environments.
1416
 
 
1417
 
        These formats will be tried before ones registered with
1418
 
        register_control_format.  This gives implementations that decide to the
1419
 
        chance to grab it before anything looks at the contents of the format
1420
 
        file.
1421
 
        """
1422
 
        klass._control_server_formats.append(format)
1423
 
 
1424
 
    @classmethod
1425
 
    @symbol_versioning.deprecated_method(symbol_versioning.zero_fourteen)
1426
 
    def set_default_format(klass, format):
1427
 
        klass._set_default_format(format)
1428
 
 
1429
 
    @classmethod
1430
 
    def _set_default_format(klass, format):
1431
 
        """Set default format (for testing behavior of defaults only)"""
1432
 
        klass._default_format = format
1433
 
 
1434
 
    def __str__(self):
1435
 
        return self.get_format_string()[:-1]
1436
 
 
1437
 
    @classmethod
1438
 
    def unregister_format(klass, format):
1439
 
        assert klass._formats[format.get_format_string()] is format
1440
 
        del klass._formats[format.get_format_string()]
1441
 
 
1442
 
    @classmethod
1443
 
    def unregister_control_format(klass, format):
1444
 
        klass._control_formats.remove(format)
1445
 
 
1446
 
 
1447
 
class BzrDirFormat4(BzrDirFormat):
1448
 
    """Bzr dir format 4.
1449
 
 
1450
 
    This format is a combined format for working tree, branch and repository.
1451
 
    It has:
1452
 
     - Format 1 working trees [always]
1453
 
     - Format 4 branches [always]
1454
 
     - Format 4 repositories [always]
1455
 
 
1456
 
    This format is deprecated: it indexes texts using a text it which is
1457
 
    removed in format 5; write support for this format has been removed.
1458
 
    """
1459
 
 
1460
 
    _lock_class = lockable_files.TransportLock
1461
 
 
1462
 
    def get_format_string(self):
1463
 
        """See BzrDirFormat.get_format_string()."""
1464
 
        return "Bazaar-NG branch, format 0.0.4\n"
1465
 
 
1466
 
    def get_format_description(self):
1467
 
        """See BzrDirFormat.get_format_description()."""
1468
 
        return "All-in-one format 4"
1469
 
 
1470
 
    def get_converter(self, format=None):
1471
 
        """See BzrDirFormat.get_converter()."""
1472
 
        # there is one and only one upgrade path here.
1473
 
        return ConvertBzrDir4To5()
1474
 
        
1475
 
    def initialize_on_transport(self, transport):
1476
 
        """Format 4 branches cannot be created."""
1477
 
        raise errors.UninitializableFormat(self)
1478
 
 
1479
 
    def is_supported(self):
1480
 
        """Format 4 is not supported.
1481
 
 
1482
 
        It is not supported because the model changed from 4 to 5 and the
1483
 
        conversion logic is expensive - so doing it on the fly was not 
1484
 
        feasible.
1485
 
        """
1486
 
        return False
1487
 
 
1488
 
    def _open(self, transport):
1489
 
        """See BzrDirFormat._open."""
1490
 
        return BzrDir4(transport, self)
1491
 
 
1492
 
    def __return_repository_format(self):
1493
 
        """Circular import protection."""
1494
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
1495
 
        return RepositoryFormat4()
1496
 
    repository_format = property(__return_repository_format)
1497
 
 
1498
 
 
1499
 
class BzrDirFormat5(BzrDirFormat):
1500
 
    """Bzr control format 5.
1501
 
 
1502
 
    This format is a combined format for working tree, branch and repository.
1503
 
    It has:
1504
 
     - Format 2 working trees [always] 
1505
 
     - Format 4 branches [always] 
1506
 
     - Format 5 repositories [always]
1507
 
       Unhashed stores in the repository.
1508
 
    """
1509
 
 
1510
 
    _lock_class = lockable_files.TransportLock
1511
 
 
1512
 
    def get_format_string(self):
1513
 
        """See BzrDirFormat.get_format_string()."""
1514
 
        return "Bazaar-NG branch, format 5\n"
1515
 
 
1516
 
    def get_format_description(self):
1517
 
        """See BzrDirFormat.get_format_description()."""
1518
 
        return "All-in-one format 5"
1519
 
 
1520
 
    def get_converter(self, format=None):
1521
 
        """See BzrDirFormat.get_converter()."""
1522
 
        # there is one and only one upgrade path here.
1523
 
        return ConvertBzrDir5To6()
1524
 
 
1525
 
    def _initialize_for_clone(self, url):
1526
 
        return self.initialize_on_transport(get_transport(url), _cloning=True)
1527
 
        
1528
 
    def initialize_on_transport(self, transport, _cloning=False):
1529
 
        """Format 5 dirs always have working tree, branch and repository.
1530
 
        
1531
 
        Except when they are being cloned.
1532
 
        """
1533
 
        from bzrlib.branch import BzrBranchFormat4
1534
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1535
 
        from bzrlib.workingtree import WorkingTreeFormat2
1536
 
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1537
 
        RepositoryFormat5().initialize(result, _internal=True)
1538
 
        if not _cloning:
1539
 
            branch = BzrBranchFormat4().initialize(result)
1540
 
            try:
1541
 
                WorkingTreeFormat2().initialize(result)
1542
 
            except errors.NotLocalUrl:
1543
 
                # Even though we can't access the working tree, we need to
1544
 
                # create its control files.
1545
 
                WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1546
 
        return result
1547
 
 
1548
 
    def _open(self, transport):
1549
 
        """See BzrDirFormat._open."""
1550
 
        return BzrDir5(transport, self)
1551
 
 
1552
 
    def __return_repository_format(self):
1553
 
        """Circular import protection."""
1554
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1555
 
        return RepositoryFormat5()
1556
 
    repository_format = property(__return_repository_format)
1557
 
 
1558
 
 
1559
 
class BzrDirFormat6(BzrDirFormat):
1560
 
    """Bzr control format 6.
1561
 
 
1562
 
    This format is a combined format for working tree, branch and repository.
1563
 
    It has:
1564
 
     - Format 2 working trees [always] 
1565
 
     - Format 4 branches [always] 
1566
 
     - Format 6 repositories [always]
1567
 
    """
1568
 
 
1569
 
    _lock_class = lockable_files.TransportLock
1570
 
 
1571
 
    def get_format_string(self):
1572
 
        """See BzrDirFormat.get_format_string()."""
1573
 
        return "Bazaar-NG branch, format 6\n"
1574
 
 
1575
 
    def get_format_description(self):
1576
 
        """See BzrDirFormat.get_format_description()."""
1577
 
        return "All-in-one format 6"
1578
 
 
1579
 
    def get_converter(self, format=None):
1580
 
        """See BzrDirFormat.get_converter()."""
1581
 
        # there is one and only one upgrade path here.
1582
 
        return ConvertBzrDir6ToMeta()
1583
 
        
1584
 
    def _initialize_for_clone(self, url):
1585
 
        return self.initialize_on_transport(get_transport(url), _cloning=True)
1586
 
 
1587
 
    def initialize_on_transport(self, transport, _cloning=False):
1588
 
        """Format 6 dirs always have working tree, branch and repository.
1589
 
        
1590
 
        Except when they are being cloned.
1591
 
        """
1592
 
        from bzrlib.branch import BzrBranchFormat4
1593
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1594
 
        from bzrlib.workingtree import WorkingTreeFormat2
1595
 
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1596
 
        RepositoryFormat6().initialize(result, _internal=True)
1597
 
        if not _cloning:
1598
 
            branch = BzrBranchFormat4().initialize(result)
1599
 
            try:
1600
 
                WorkingTreeFormat2().initialize(result)
1601
 
            except errors.NotLocalUrl:
1602
 
                # Even though we can't access the working tree, we need to
1603
 
                # create its control files.
1604
 
                WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1605
 
        return result
1606
 
 
1607
 
    def _open(self, transport):
1608
 
        """See BzrDirFormat._open."""
1609
 
        return BzrDir6(transport, self)
1610
 
 
1611
 
    def __return_repository_format(self):
1612
 
        """Circular import protection."""
1613
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1614
 
        return RepositoryFormat6()
1615
 
    repository_format = property(__return_repository_format)
 
1520
    def _supply_sub_formats_to(self, other_format):
 
1521
        """Give other_format the same values for sub formats as this has.
 
1522
 
 
1523
        This method is expected to be used when parameterising a
 
1524
        RemoteBzrDirFormat instance with the parameters from a
 
1525
        BzrDirMetaFormat1 instance.
 
1526
 
 
1527
        :param other_format: other_format is a format which should be
 
1528
            compatible with whatever sub formats are supported by self.
 
1529
        :return: None.
 
1530
        """
 
1531
        other_format.features = dict(self.features)
 
1532
 
 
1533
    def supports_transport(self, transport):
 
1534
        # bzr formats can be opened over all known transports
 
1535
        return True
 
1536
 
 
1537
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
1538
            basedir=None):
 
1539
        controldir.ControlDirFormat.check_support_status(self,
 
1540
            allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
 
1541
            basedir=basedir)
 
1542
        BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
 
1543
            recommend_upgrade=recommend_upgrade, basedir=basedir)
1616
1544
 
1617
1545
 
1618
1546
class BzrDirMetaFormat1(BzrDirFormat):
1620
1548
 
1621
1549
    This is the first format with split out working tree, branch and repository
1622
1550
    disk storage.
 
1551
 
1623
1552
    It has:
1624
 
     - Format 3 working trees [optional]
1625
 
     - Format 5 branches [optional]
1626
 
     - Format 7 repositories [optional]
 
1553
 
 
1554
    - Format 3 working trees [optional]
 
1555
    - Format 5 branches [optional]
 
1556
    - Format 7 repositories [optional]
1627
1557
    """
1628
1558
 
1629
1559
    _lock_class = lockdir.LockDir
1630
1560
 
 
1561
    fixed_components = False
 
1562
 
 
1563
    colocated_branches = False
 
1564
 
1631
1565
    def __init__(self):
 
1566
        BzrDirFormat.__init__(self)
1632
1567
        self._workingtree_format = None
1633
1568
        self._branch_format = None
 
1569
        self._repository_format = None
1634
1570
 
1635
1571
    def __eq__(self, other):
1636
1572
        if other.__class__ is not self.__class__:
1639
1575
            return False
1640
1576
        if other.workingtree_format != self.workingtree_format:
1641
1577
            return False
 
1578
        if other.features != self.features:
 
1579
            return False
1642
1580
        return True
1643
1581
 
1644
1582
    def __ne__(self, other):
1646
1584
 
1647
1585
    def get_branch_format(self):
1648
1586
        if self._branch_format is None:
1649
 
            from bzrlib.branch import BranchFormat
1650
 
            self._branch_format = BranchFormat.get_default_format()
 
1587
            from bzrlib.branch import format_registry as branch_format_registry
 
1588
            self._branch_format = branch_format_registry.get_default()
1651
1589
        return self._branch_format
1652
1590
 
1653
1591
    def set_branch_format(self, format):
1654
1592
        self._branch_format = format
1655
1593
 
 
1594
    def require_stacking(self, stack_on=None, possible_transports=None,
 
1595
            _skip_repo=False):
 
1596
        """We have a request to stack, try to ensure the formats support it.
 
1597
 
 
1598
        :param stack_on: If supplied, it is the URL to a branch that we want to
 
1599
            stack on. Check to see if that format supports stacking before
 
1600
            forcing an upgrade.
 
1601
        """
 
1602
        # Stacking is desired. requested by the target, but does the place it
 
1603
        # points at support stacking? If it doesn't then we should
 
1604
        # not implicitly upgrade. We check this here.
 
1605
        new_repo_format = None
 
1606
        new_branch_format = None
 
1607
 
 
1608
        # a bit of state for get_target_branch so that we don't try to open it
 
1609
        # 2 times, for both repo *and* branch
 
1610
        target = [None, False, None] # target_branch, checked, upgrade anyway
 
1611
        def get_target_branch():
 
1612
            if target[1]:
 
1613
                # We've checked, don't check again
 
1614
                return target
 
1615
            if stack_on is None:
 
1616
                # No target format, that means we want to force upgrading
 
1617
                target[:] = [None, True, True]
 
1618
                return target
 
1619
            try:
 
1620
                target_dir = BzrDir.open(stack_on,
 
1621
                    possible_transports=possible_transports)
 
1622
            except errors.NotBranchError:
 
1623
                # Nothing there, don't change formats
 
1624
                target[:] = [None, True, False]
 
1625
                return target
 
1626
            except errors.JailBreak:
 
1627
                # JailBreak, JFDI and upgrade anyway
 
1628
                target[:] = [None, True, True]
 
1629
                return target
 
1630
            try:
 
1631
                target_branch = target_dir.open_branch()
 
1632
            except errors.NotBranchError:
 
1633
                # No branch, don't upgrade formats
 
1634
                target[:] = [None, True, False]
 
1635
                return target
 
1636
            target[:] = [target_branch, True, False]
 
1637
            return target
 
1638
 
 
1639
        if (not _skip_repo and
 
1640
                 not self.repository_format.supports_external_lookups):
 
1641
            # We need to upgrade the Repository.
 
1642
            target_branch, _, do_upgrade = get_target_branch()
 
1643
            if target_branch is None:
 
1644
                # We don't have a target branch, should we upgrade anyway?
 
1645
                if do_upgrade:
 
1646
                    # stack_on is inaccessible, JFDI.
 
1647
                    # TODO: bad monkey, hard-coded formats...
 
1648
                    if self.repository_format.rich_root_data:
 
1649
                        new_repo_format = knitpack_repo.RepositoryFormatKnitPack5RichRoot()
 
1650
                    else:
 
1651
                        new_repo_format = knitpack_repo.RepositoryFormatKnitPack5()
 
1652
            else:
 
1653
                # If the target already supports stacking, then we know the
 
1654
                # project is already able to use stacking, so auto-upgrade
 
1655
                # for them
 
1656
                new_repo_format = target_branch.repository._format
 
1657
                if not new_repo_format.supports_external_lookups:
 
1658
                    # target doesn't, source doesn't, so don't auto upgrade
 
1659
                    # repo
 
1660
                    new_repo_format = None
 
1661
            if new_repo_format is not None:
 
1662
                self.repository_format = new_repo_format
 
1663
                note(gettext('Source repository format does not support stacking,'
 
1664
                     ' using format:\n  %s'),
 
1665
                     new_repo_format.get_format_description())
 
1666
 
 
1667
        if not self.get_branch_format().supports_stacking():
 
1668
            # We just checked the repo, now lets check if we need to
 
1669
            # upgrade the branch format
 
1670
            target_branch, _, do_upgrade = get_target_branch()
 
1671
            if target_branch is None:
 
1672
                if do_upgrade:
 
1673
                    # TODO: bad monkey, hard-coded formats...
 
1674
                    from bzrlib.branch import BzrBranchFormat7
 
1675
                    new_branch_format = BzrBranchFormat7()
 
1676
            else:
 
1677
                new_branch_format = target_branch._format
 
1678
                if not new_branch_format.supports_stacking():
 
1679
                    new_branch_format = None
 
1680
            if new_branch_format is not None:
 
1681
                # Does support stacking, use its format.
 
1682
                self.set_branch_format(new_branch_format)
 
1683
                note(gettext('Source branch format does not support stacking,'
 
1684
                     ' using format:\n  %s'),
 
1685
                     new_branch_format.get_format_description())
 
1686
 
1656
1687
    def get_converter(self, format=None):
1657
1688
        """See BzrDirFormat.get_converter()."""
1658
1689
        if format is None:
1659
1690
            format = BzrDirFormat.get_default_format()
 
1691
        if (type(self) is BzrDirMetaFormat1 and
 
1692
            type(format) is BzrDirMetaFormat1Colo):
 
1693
            return ConvertMetaToColo(format)
 
1694
        if (type(self) is BzrDirMetaFormat1Colo and
 
1695
            type(format) is BzrDirMetaFormat1):
 
1696
            return ConvertMetaRemoveColo(format)
1660
1697
        if not isinstance(self, format.__class__):
1661
1698
            # converting away from metadir is not implemented
1662
1699
            raise NotImplementedError(self.get_converter)
1663
1700
        return ConvertMetaToMeta(format)
1664
1701
 
1665
 
    def get_format_string(self):
 
1702
    @classmethod
 
1703
    def get_format_string(cls):
1666
1704
        """See BzrDirFormat.get_format_string()."""
1667
1705
        return "Bazaar-NG meta directory, format 1\n"
1668
1706
 
1672
1710
 
1673
1711
    def _open(self, transport):
1674
1712
        """See BzrDirFormat._open."""
1675
 
        return BzrDirMeta1(transport, self)
 
1713
        # Create a new format instance because otherwise initialisation of new
 
1714
        # metadirs share the global default format object leading to alias
 
1715
        # problems.
 
1716
        format = BzrDirMetaFormat1()
 
1717
        self._supply_sub_formats_to(format)
 
1718
        return BzrDirMeta1(transport, format)
1676
1719
 
1677
1720
    def __return_repository_format(self):
1678
1721
        """Circular import protection."""
1679
 
        if getattr(self, '_repository_format', None):
 
1722
        if self._repository_format:
1680
1723
            return self._repository_format
1681
 
        from bzrlib.repository import RepositoryFormat
1682
 
        return RepositoryFormat.get_default_format()
 
1724
        from bzrlib.repository import format_registry
 
1725
        return format_registry.get_default()
1683
1726
 
1684
 
    def __set_repository_format(self, value):
1685
 
        """Allow changint the repository format for metadir formats."""
 
1727
    def _set_repository_format(self, value):
 
1728
        """Allow changing the repository format for metadir formats."""
1686
1729
        self._repository_format = value
1687
1730
 
1688
 
    repository_format = property(__return_repository_format, __set_repository_format)
 
1731
    repository_format = property(__return_repository_format,
 
1732
        _set_repository_format)
 
1733
 
 
1734
    def _supply_sub_formats_to(self, other_format):
 
1735
        """Give other_format the same values for sub formats as this has.
 
1736
 
 
1737
        This method is expected to be used when parameterising a
 
1738
        RemoteBzrDirFormat instance with the parameters from a
 
1739
        BzrDirMetaFormat1 instance.
 
1740
 
 
1741
        :param other_format: other_format is a format which should be
 
1742
            compatible with whatever sub formats are supported by self.
 
1743
        :return: None.
 
1744
        """
 
1745
        super(BzrDirMetaFormat1, self)._supply_sub_formats_to(other_format)
 
1746
        if getattr(self, '_repository_format', None) is not None:
 
1747
            other_format.repository_format = self.repository_format
 
1748
        if self._branch_format is not None:
 
1749
            other_format._branch_format = self._branch_format
 
1750
        if self._workingtree_format is not None:
 
1751
            other_format.workingtree_format = self.workingtree_format
1689
1752
 
1690
1753
    def __get_workingtree_format(self):
1691
1754
        if self._workingtree_format is None:
1692
 
            from bzrlib.workingtree import WorkingTreeFormat
1693
 
            self._workingtree_format = WorkingTreeFormat.get_default_format()
 
1755
            from bzrlib.workingtree import (
 
1756
                format_registry as wt_format_registry,
 
1757
                )
 
1758
            self._workingtree_format = wt_format_registry.get_default()
1694
1759
        return self._workingtree_format
1695
1760
 
1696
1761
    def __set_workingtree_format(self, wt_format):
1697
1762
        self._workingtree_format = wt_format
1698
1763
 
 
1764
    def __repr__(self):
 
1765
        return "<%r>" % (self.__class__.__name__,)
 
1766
 
1699
1767
    workingtree_format = property(__get_workingtree_format,
1700
1768
                                  __set_workingtree_format)
1701
1769
 
1702
1770
 
1703
 
# Register bzr control format
1704
 
BzrDirFormat.register_control_format(BzrDirFormat)
1705
 
 
1706
1771
# Register bzr formats
1707
 
BzrDirFormat.register_format(BzrDirFormat4())
1708
 
BzrDirFormat.register_format(BzrDirFormat5())
1709
 
BzrDirFormat.register_format(BzrDirFormat6())
1710
 
__default_format = BzrDirMetaFormat1()
1711
 
BzrDirFormat.register_format(__default_format)
1712
 
BzrDirFormat._default_format = __default_format
1713
 
 
1714
 
 
1715
 
class Converter(object):
1716
 
    """Converts a disk format object from one format to another."""
1717
 
 
1718
 
    def convert(self, to_convert, pb):
1719
 
        """Perform the conversion of to_convert, giving feedback via pb.
1720
 
 
1721
 
        :param to_convert: The disk object to convert.
1722
 
        :param pb: a progress bar to use for progress information.
1723
 
        """
1724
 
 
1725
 
    def step(self, message):
1726
 
        """Update the pb by a step."""
1727
 
        self.count +=1
1728
 
        self.pb.update(message, self.count, self.total)
1729
 
 
1730
 
 
1731
 
class ConvertBzrDir4To5(Converter):
1732
 
    """Converts format 4 bzr dirs to format 5."""
1733
 
 
1734
 
    def __init__(self):
1735
 
        super(ConvertBzrDir4To5, self).__init__()
1736
 
        self.converted_revs = set()
1737
 
        self.absent_revisions = set()
1738
 
        self.text_count = 0
1739
 
        self.revisions = {}
1740
 
        
1741
 
    def convert(self, to_convert, pb):
1742
 
        """See Converter.convert()."""
1743
 
        self.bzrdir = to_convert
1744
 
        self.pb = pb
1745
 
        self.pb.note('starting upgrade from format 4 to 5')
1746
 
        if isinstance(self.bzrdir.transport, LocalTransport):
1747
 
            self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
1748
 
        self._convert_to_weaves()
1749
 
        return BzrDir.open(self.bzrdir.root_transport.base)
1750
 
 
1751
 
    def _convert_to_weaves(self):
1752
 
        self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
1753
 
        try:
1754
 
            # TODO permissions
1755
 
            stat = self.bzrdir.transport.stat('weaves')
1756
 
            if not S_ISDIR(stat.st_mode):
1757
 
                self.bzrdir.transport.delete('weaves')
1758
 
                self.bzrdir.transport.mkdir('weaves')
1759
 
        except errors.NoSuchFile:
1760
 
            self.bzrdir.transport.mkdir('weaves')
1761
 
        # deliberately not a WeaveFile as we want to build it up slowly.
1762
 
        self.inv_weave = Weave('inventory')
1763
 
        # holds in-memory weaves for all files
1764
 
        self.text_weaves = {}
1765
 
        self.bzrdir.transport.delete('branch-format')
1766
 
        self.branch = self.bzrdir.open_branch()
1767
 
        self._convert_working_inv()
1768
 
        rev_history = self.branch.revision_history()
1769
 
        # to_read is a stack holding the revisions we still need to process;
1770
 
        # appending to it adds new highest-priority revisions
1771
 
        self.known_revisions = set(rev_history)
1772
 
        self.to_read = rev_history[-1:]
1773
 
        while self.to_read:
1774
 
            rev_id = self.to_read.pop()
1775
 
            if (rev_id not in self.revisions
1776
 
                and rev_id not in self.absent_revisions):
1777
 
                self._load_one_rev(rev_id)
1778
 
        self.pb.clear()
1779
 
        to_import = self._make_order()
1780
 
        for i, rev_id in enumerate(to_import):
1781
 
            self.pb.update('converting revision', i, len(to_import))
1782
 
            self._convert_one_rev(rev_id)
1783
 
        self.pb.clear()
1784
 
        self._write_all_weaves()
1785
 
        self._write_all_revs()
1786
 
        self.pb.note('upgraded to weaves:')
1787
 
        self.pb.note('  %6d revisions and inventories', len(self.revisions))
1788
 
        self.pb.note('  %6d revisions not present', len(self.absent_revisions))
1789
 
        self.pb.note('  %6d texts', self.text_count)
1790
 
        self._cleanup_spare_files_after_format4()
1791
 
        self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
1792
 
 
1793
 
    def _cleanup_spare_files_after_format4(self):
1794
 
        # FIXME working tree upgrade foo.
1795
 
        for n in 'merged-patches', 'pending-merged-patches':
1796
 
            try:
1797
 
                ## assert os.path.getsize(p) == 0
1798
 
                self.bzrdir.transport.delete(n)
1799
 
            except errors.NoSuchFile:
1800
 
                pass
1801
 
        self.bzrdir.transport.delete_tree('inventory-store')
1802
 
        self.bzrdir.transport.delete_tree('text-store')
1803
 
 
1804
 
    def _convert_working_inv(self):
1805
 
        inv = xml4.serializer_v4.read_inventory(
1806
 
                    self.branch.control_files.get('inventory'))
1807
 
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
1808
 
        # FIXME inventory is a working tree change.
1809
 
        self.branch.control_files.put('inventory', StringIO(new_inv_xml))
1810
 
 
1811
 
    def _write_all_weaves(self):
1812
 
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
1813
 
        weave_transport = self.bzrdir.transport.clone('weaves')
1814
 
        weaves = WeaveStore(weave_transport, prefixed=False)
1815
 
        transaction = WriteTransaction()
1816
 
 
1817
 
        try:
1818
 
            i = 0
1819
 
            for file_id, file_weave in self.text_weaves.items():
1820
 
                self.pb.update('writing weave', i, len(self.text_weaves))
1821
 
                weaves._put_weave(file_id, file_weave, transaction)
1822
 
                i += 1
1823
 
            self.pb.update('inventory', 0, 1)
1824
 
            controlweaves._put_weave('inventory', self.inv_weave, transaction)
1825
 
            self.pb.update('inventory', 1, 1)
1826
 
        finally:
1827
 
            self.pb.clear()
1828
 
 
1829
 
    def _write_all_revs(self):
1830
 
        """Write all revisions out in new form."""
1831
 
        self.bzrdir.transport.delete_tree('revision-store')
1832
 
        self.bzrdir.transport.mkdir('revision-store')
1833
 
        revision_transport = self.bzrdir.transport.clone('revision-store')
1834
 
        # TODO permissions
1835
 
        _revision_store = TextRevisionStore(TextStore(revision_transport,
1836
 
                                                      prefixed=False,
1837
 
                                                      compressed=True))
1838
 
        try:
1839
 
            transaction = WriteTransaction()
1840
 
            for i, rev_id in enumerate(self.converted_revs):
1841
 
                self.pb.update('write revision', i, len(self.converted_revs))
1842
 
                _revision_store.add_revision(self.revisions[rev_id], transaction)
1843
 
        finally:
1844
 
            self.pb.clear()
1845
 
            
1846
 
    def _load_one_rev(self, rev_id):
1847
 
        """Load a revision object into memory.
1848
 
 
1849
 
        Any parents not either loaded or abandoned get queued to be
1850
 
        loaded."""
1851
 
        self.pb.update('loading revision',
1852
 
                       len(self.revisions),
1853
 
                       len(self.known_revisions))
1854
 
        if not self.branch.repository.has_revision(rev_id):
1855
 
            self.pb.clear()
1856
 
            self.pb.note('revision {%s} not present in branch; '
1857
 
                         'will be converted as a ghost',
1858
 
                         rev_id)
1859
 
            self.absent_revisions.add(rev_id)
1860
 
        else:
1861
 
            rev = self.branch.repository._revision_store.get_revision(rev_id,
1862
 
                self.branch.repository.get_transaction())
1863
 
            for parent_id in rev.parent_ids:
1864
 
                self.known_revisions.add(parent_id)
1865
 
                self.to_read.append(parent_id)
1866
 
            self.revisions[rev_id] = rev
1867
 
 
1868
 
    def _load_old_inventory(self, rev_id):
1869
 
        assert rev_id not in self.converted_revs
1870
 
        old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
1871
 
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
1872
 
        inv.revision_id = rev_id
1873
 
        rev = self.revisions[rev_id]
1874
 
        if rev.inventory_sha1:
1875
 
            assert rev.inventory_sha1 == sha_string(old_inv_xml), \
1876
 
                'inventory sha mismatch for {%s}' % rev_id
1877
 
        return inv
1878
 
 
1879
 
    def _load_updated_inventory(self, rev_id):
1880
 
        assert rev_id in self.converted_revs
1881
 
        inv_xml = self.inv_weave.get_text(rev_id)
1882
 
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml)
1883
 
        return inv
1884
 
 
1885
 
    def _convert_one_rev(self, rev_id):
1886
 
        """Convert revision and all referenced objects to new format."""
1887
 
        rev = self.revisions[rev_id]
1888
 
        inv = self._load_old_inventory(rev_id)
1889
 
        present_parents = [p for p in rev.parent_ids
1890
 
                           if p not in self.absent_revisions]
1891
 
        self._convert_revision_contents(rev, inv, present_parents)
1892
 
        self._store_new_weave(rev, inv, present_parents)
1893
 
        self.converted_revs.add(rev_id)
1894
 
 
1895
 
    def _store_new_weave(self, rev, inv, present_parents):
1896
 
        # the XML is now updated with text versions
1897
 
        if __debug__:
1898
 
            entries = inv.iter_entries()
1899
 
            entries.next()
1900
 
            for path, ie in entries:
1901
 
                assert getattr(ie, 'revision', None) is not None, \
1902
 
                    'no revision on {%s} in {%s}' % \
1903
 
                    (file_id, rev.revision_id)
1904
 
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
1905
 
        new_inv_sha1 = sha_string(new_inv_xml)
1906
 
        self.inv_weave.add_lines(rev.revision_id, 
1907
 
                                 present_parents,
1908
 
                                 new_inv_xml.splitlines(True))
1909
 
        rev.inventory_sha1 = new_inv_sha1
1910
 
 
1911
 
    def _convert_revision_contents(self, rev, inv, present_parents):
1912
 
        """Convert all the files within a revision.
1913
 
 
1914
 
        Also upgrade the inventory to refer to the text revision ids."""
1915
 
        rev_id = rev.revision_id
1916
 
        mutter('converting texts of revision {%s}',
1917
 
               rev_id)
1918
 
        parent_invs = map(self._load_updated_inventory, present_parents)
1919
 
        entries = inv.iter_entries()
1920
 
        entries.next()
1921
 
        for path, ie in entries:
1922
 
            self._convert_file_version(rev, ie, parent_invs)
1923
 
 
1924
 
    def _convert_file_version(self, rev, ie, parent_invs):
1925
 
        """Convert one version of one file.
1926
 
 
1927
 
        The file needs to be added into the weave if it is a merge
1928
 
        of >=2 parents or if it's changed from its parent.
1929
 
        """
1930
 
        file_id = ie.file_id
1931
 
        rev_id = rev.revision_id
1932
 
        w = self.text_weaves.get(file_id)
1933
 
        if w is None:
1934
 
            w = Weave(file_id)
1935
 
            self.text_weaves[file_id] = w
1936
 
        text_changed = False
1937
 
        previous_entries = ie.find_previous_heads(parent_invs,
1938
 
                                                  None,
1939
 
                                                  None,
1940
 
                                                  entry_vf=w)
1941
 
        for old_revision in previous_entries:
1942
 
                # if this fails, its a ghost ?
1943
 
                assert old_revision in self.converted_revs, \
1944
 
                    "Revision {%s} not in converted_revs" % old_revision
1945
 
        self.snapshot_ie(previous_entries, ie, w, rev_id)
1946
 
        del ie.text_id
1947
 
        assert getattr(ie, 'revision', None) is not None
1948
 
 
1949
 
    def snapshot_ie(self, previous_revisions, ie, w, rev_id):
1950
 
        # TODO: convert this logic, which is ~= snapshot to
1951
 
        # a call to:. This needs the path figured out. rather than a work_tree
1952
 
        # a v4 revision_tree can be given, or something that looks enough like
1953
 
        # one to give the file content to the entry if it needs it.
1954
 
        # and we need something that looks like a weave store for snapshot to 
1955
 
        # save against.
1956
 
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
1957
 
        if len(previous_revisions) == 1:
1958
 
            previous_ie = previous_revisions.values()[0]
1959
 
            if ie._unchanged(previous_ie):
1960
 
                ie.revision = previous_ie.revision
1961
 
                return
1962
 
        if ie.has_text():
1963
 
            text = self.branch.repository.weave_store.get(ie.text_id)
1964
 
            file_lines = text.readlines()
1965
 
            assert sha_strings(file_lines) == ie.text_sha1
1966
 
            assert sum(map(len, file_lines)) == ie.text_size
1967
 
            w.add_lines(rev_id, previous_revisions, file_lines)
1968
 
            self.text_count += 1
1969
 
        else:
1970
 
            w.add_lines(rev_id, previous_revisions, [])
1971
 
        ie.revision = rev_id
1972
 
 
1973
 
    def _make_order(self):
1974
 
        """Return a suitable order for importing revisions.
1975
 
 
1976
 
        The order must be such that an revision is imported after all
1977
 
        its (present) parents.
1978
 
        """
1979
 
        todo = set(self.revisions.keys())
1980
 
        done = self.absent_revisions.copy()
1981
 
        order = []
1982
 
        while todo:
1983
 
            # scan through looking for a revision whose parents
1984
 
            # are all done
1985
 
            for rev_id in sorted(list(todo)):
1986
 
                rev = self.revisions[rev_id]
1987
 
                parent_ids = set(rev.parent_ids)
1988
 
                if parent_ids.issubset(done):
1989
 
                    # can take this one now
1990
 
                    order.append(rev_id)
1991
 
                    todo.remove(rev_id)
1992
 
                    done.add(rev_id)
1993
 
        return order
1994
 
 
1995
 
 
1996
 
class ConvertBzrDir5To6(Converter):
1997
 
    """Converts format 5 bzr dirs to format 6."""
1998
 
 
1999
 
    def convert(self, to_convert, pb):
2000
 
        """See Converter.convert()."""
2001
 
        self.bzrdir = to_convert
2002
 
        self.pb = pb
2003
 
        self.pb.note('starting upgrade from format 5 to 6')
2004
 
        self._convert_to_prefixed()
2005
 
        return BzrDir.open(self.bzrdir.root_transport.base)
2006
 
 
2007
 
    def _convert_to_prefixed(self):
2008
 
        from bzrlib.store import TransportStore
2009
 
        self.bzrdir.transport.delete('branch-format')
2010
 
        for store_name in ["weaves", "revision-store"]:
2011
 
            self.pb.note("adding prefixes to %s" % store_name)
2012
 
            store_transport = self.bzrdir.transport.clone(store_name)
2013
 
            store = TransportStore(store_transport, prefixed=True)
2014
 
            for urlfilename in store_transport.list_dir('.'):
2015
 
                filename = urlutils.unescape(urlfilename)
2016
 
                if (filename.endswith(".weave") or
2017
 
                    filename.endswith(".gz") or
2018
 
                    filename.endswith(".sig")):
2019
 
                    file_id = os.path.splitext(filename)[0]
2020
 
                else:
2021
 
                    file_id = filename
2022
 
                prefix_dir = store.hash_prefix(file_id)
2023
 
                # FIXME keep track of the dirs made RBC 20060121
2024
 
                try:
2025
 
                    store_transport.move(filename, prefix_dir + '/' + filename)
2026
 
                except errors.NoSuchFile: # catches missing dirs strangely enough
2027
 
                    store_transport.mkdir(prefix_dir)
2028
 
                    store_transport.move(filename, prefix_dir + '/' + filename)
2029
 
        self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
2030
 
 
2031
 
 
2032
 
class ConvertBzrDir6ToMeta(Converter):
2033
 
    """Converts format 6 bzr dirs to metadirs."""
2034
 
 
2035
 
    def convert(self, to_convert, pb):
2036
 
        """See Converter.convert()."""
2037
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
2038
 
        from bzrlib.branch import BzrBranchFormat5
2039
 
        self.bzrdir = to_convert
2040
 
        self.pb = pb
2041
 
        self.count = 0
2042
 
        self.total = 20 # the steps we know about
2043
 
        self.garbage_inventories = []
2044
 
 
2045
 
        self.pb.note('starting upgrade from format 6 to metadir')
2046
 
        self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
2047
 
        # its faster to move specific files around than to open and use the apis...
2048
 
        # first off, nuke ancestry.weave, it was never used.
2049
 
        try:
2050
 
            self.step('Removing ancestry.weave')
2051
 
            self.bzrdir.transport.delete('ancestry.weave')
2052
 
        except errors.NoSuchFile:
2053
 
            pass
2054
 
        # find out whats there
2055
 
        self.step('Finding branch files')
2056
 
        last_revision = self.bzrdir.open_branch().last_revision()
2057
 
        bzrcontents = self.bzrdir.transport.list_dir('.')
2058
 
        for name in bzrcontents:
2059
 
            if name.startswith('basis-inventory.'):
2060
 
                self.garbage_inventories.append(name)
2061
 
        # create new directories for repository, working tree and branch
2062
 
        self.dir_mode = self.bzrdir._control_files._dir_mode
2063
 
        self.file_mode = self.bzrdir._control_files._file_mode
2064
 
        repository_names = [('inventory.weave', True),
2065
 
                            ('revision-store', True),
2066
 
                            ('weaves', True)]
2067
 
        self.step('Upgrading repository  ')
2068
 
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2069
 
        self.make_lock('repository')
2070
 
        # we hard code the formats here because we are converting into
2071
 
        # the meta format. The meta format upgrader can take this to a 
2072
 
        # future format within each component.
2073
 
        self.put_format('repository', RepositoryFormat7())
2074
 
        for entry in repository_names:
2075
 
            self.move_entry('repository', entry)
2076
 
 
2077
 
        self.step('Upgrading branch      ')
2078
 
        self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2079
 
        self.make_lock('branch')
2080
 
        self.put_format('branch', BzrBranchFormat5())
2081
 
        branch_files = [('revision-history', True),
2082
 
                        ('branch-name', True),
2083
 
                        ('parent', False)]
2084
 
        for entry in branch_files:
2085
 
            self.move_entry('branch', entry)
2086
 
 
2087
 
        checkout_files = [('pending-merges', True),
2088
 
                          ('inventory', True),
2089
 
                          ('stat-cache', False)]
2090
 
        # If a mandatory checkout file is not present, the branch does not have
2091
 
        # a functional checkout. Do not create a checkout in the converted
2092
 
        # branch.
2093
 
        for name, mandatory in checkout_files:
2094
 
            if mandatory and name not in bzrcontents:
2095
 
                has_checkout = False
2096
 
                break
2097
 
        else:
2098
 
            has_checkout = True
2099
 
        if not has_checkout:
2100
 
            self.pb.note('No working tree.')
2101
 
            # If some checkout files are there, we may as well get rid of them.
2102
 
            for name, mandatory in checkout_files:
2103
 
                if name in bzrcontents:
2104
 
                    self.bzrdir.transport.delete(name)
2105
 
        else:
2106
 
            from bzrlib.workingtree import WorkingTreeFormat3
2107
 
            self.step('Upgrading working tree')
2108
 
            self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2109
 
            self.make_lock('checkout')
2110
 
            self.put_format(
2111
 
                'checkout', WorkingTreeFormat3())
2112
 
            self.bzrdir.transport.delete_multi(
2113
 
                self.garbage_inventories, self.pb)
2114
 
            for entry in checkout_files:
2115
 
                self.move_entry('checkout', entry)
2116
 
            if last_revision is not None:
2117
 
                self.bzrdir._control_files.put_utf8(
2118
 
                    'checkout/last-revision', last_revision)
2119
 
        self.bzrdir._control_files.put_utf8(
2120
 
            'branch-format', BzrDirMetaFormat1().get_format_string())
2121
 
        return BzrDir.open(self.bzrdir.root_transport.base)
2122
 
 
2123
 
    def make_lock(self, name):
2124
 
        """Make a lock for the new control dir name."""
2125
 
        self.step('Make %s lock' % name)
2126
 
        ld = lockdir.LockDir(self.bzrdir.transport,
2127
 
                             '%s/lock' % name,
2128
 
                             file_modebits=self.file_mode,
2129
 
                             dir_modebits=self.dir_mode)
2130
 
        ld.create()
2131
 
 
2132
 
    def move_entry(self, new_dir, entry):
2133
 
        """Move then entry name into new_dir."""
2134
 
        name = entry[0]
2135
 
        mandatory = entry[1]
2136
 
        self.step('Moving %s' % name)
2137
 
        try:
2138
 
            self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2139
 
        except errors.NoSuchFile:
2140
 
            if mandatory:
2141
 
                raise
2142
 
 
2143
 
    def put_format(self, dirname, format):
2144
 
        self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
2145
 
 
2146
 
 
2147
 
class ConvertMetaToMeta(Converter):
 
1772
BzrProber.formats.register(BzrDirMetaFormat1.get_format_string(),
 
1773
    BzrDirMetaFormat1)
 
1774
controldir.ControlDirFormat._default_format = BzrDirMetaFormat1()
 
1775
 
 
1776
 
 
1777
class BzrDirMetaFormat1Colo(BzrDirMetaFormat1):
 
1778
    """BzrDirMeta1 format with support for colocated branches."""
 
1779
 
 
1780
    colocated_branches = True
 
1781
 
 
1782
    @classmethod
 
1783
    def get_format_string(cls):
 
1784
        """See BzrDirFormat.get_format_string()."""
 
1785
        return "Bazaar meta directory, format 1 (with colocated branches)\n"
 
1786
 
 
1787
    def get_format_description(self):
 
1788
        """See BzrDirFormat.get_format_description()."""
 
1789
        return "Meta directory format 1 with support for colocated branches"
 
1790
 
 
1791
    def _open(self, transport):
 
1792
        """See BzrDirFormat._open."""
 
1793
        # Create a new format instance because otherwise initialisation of new
 
1794
        # metadirs share the global default format object leading to alias
 
1795
        # problems.
 
1796
        format = BzrDirMetaFormat1Colo()
 
1797
        self._supply_sub_formats_to(format)
 
1798
        return BzrDirMeta1Colo(transport, format)
 
1799
 
 
1800
 
 
1801
BzrProber.formats.register(BzrDirMetaFormat1Colo.get_format_string(),
 
1802
    BzrDirMetaFormat1Colo)
 
1803
 
 
1804
 
 
1805
class ConvertMetaToMeta(controldir.Converter):
2148
1806
    """Converts the components of metadirs."""
2149
1807
 
2150
1808
    def __init__(self, target_format):
2157
1815
    def convert(self, to_convert, pb):
2158
1816
        """See Converter.convert()."""
2159
1817
        self.bzrdir = to_convert
2160
 
        self.pb = pb
 
1818
        self.pb = ui.ui_factory.nested_progress_bar()
2161
1819
        self.count = 0
2162
1820
        self.total = 1
2163
1821
        self.step('checking repository format')
2168
1826
        else:
2169
1827
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
2170
1828
                from bzrlib.repository import CopyConverter
2171
 
                self.pb.note('starting repository conversion')
 
1829
                ui.ui_factory.note(gettext('starting repository conversion'))
2172
1830
                converter = CopyConverter(self.target_format.repository_format)
2173
1831
                converter.convert(repo, pb)
2174
 
        try:
2175
 
            branch = self.bzrdir.open_branch()
2176
 
        except errors.NotBranchError:
2177
 
            pass
2178
 
        else:
 
1832
        for branch in self.bzrdir.list_branches():
2179
1833
            # TODO: conversions of Branch and Tree should be done by
2180
 
            # InterXFormat lookups
 
1834
            # InterXFormat lookups/some sort of registry.
2181
1835
            # Avoid circular imports
2182
 
            from bzrlib import branch as _mod_branch
2183
 
            if (branch._format.__class__ is _mod_branch.BzrBranchFormat5 and
2184
 
                self.target_format.get_branch_format().__class__ is
2185
 
                _mod_branch.BzrBranchFormat6):
2186
 
                branch_converter = _mod_branch.Converter5to6()
 
1836
            old = branch._format.__class__
 
1837
            new = self.target_format.get_branch_format().__class__
 
1838
            while old != new:
 
1839
                if (old == _mod_branch.BzrBranchFormat5 and
 
1840
                    new in (_mod_branch.BzrBranchFormat6,
 
1841
                        _mod_branch.BzrBranchFormat7,
 
1842
                        _mod_branch.BzrBranchFormat8)):
 
1843
                    branch_converter = _mod_branch.Converter5to6()
 
1844
                elif (old == _mod_branch.BzrBranchFormat6 and
 
1845
                    new in (_mod_branch.BzrBranchFormat7,
 
1846
                            _mod_branch.BzrBranchFormat8)):
 
1847
                    branch_converter = _mod_branch.Converter6to7()
 
1848
                elif (old == _mod_branch.BzrBranchFormat7 and
 
1849
                      new is _mod_branch.BzrBranchFormat8):
 
1850
                    branch_converter = _mod_branch.Converter7to8()
 
1851
                else:
 
1852
                    raise errors.BadConversionTarget("No converter", new,
 
1853
                        branch._format)
2187
1854
                branch_converter.convert(branch)
 
1855
                branch = self.bzrdir.open_branch()
 
1856
                old = branch._format.__class__
2188
1857
        try:
2189
1858
            tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
2190
1859
        except (errors.NoWorkingTree, errors.NotLocalUrl):
2192
1861
        else:
2193
1862
            # TODO: conversions of Branch and Tree should be done by
2194
1863
            # InterXFormat lookups
2195
 
            if (isinstance(tree, workingtree.WorkingTree3) and
2196
 
                not isinstance(tree, workingtree_4.WorkingTree4) and
 
1864
            if (isinstance(tree, workingtree_3.WorkingTree3) and
 
1865
                not isinstance(tree, workingtree_4.DirStateWorkingTree) and
2197
1866
                isinstance(self.target_format.workingtree_format,
2198
 
                    workingtree_4.WorkingTreeFormat4)):
 
1867
                    workingtree_4.DirStateWorkingTreeFormat)):
2199
1868
                workingtree_4.Converter3to4().convert(tree)
 
1869
            if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
 
1870
                not isinstance(tree, workingtree_4.WorkingTree5) and
 
1871
                isinstance(self.target_format.workingtree_format,
 
1872
                    workingtree_4.WorkingTreeFormat5)):
 
1873
                workingtree_4.Converter4to5().convert(tree)
 
1874
            if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
 
1875
                not isinstance(tree, workingtree_4.WorkingTree6) and
 
1876
                isinstance(self.target_format.workingtree_format,
 
1877
                    workingtree_4.WorkingTreeFormat6)):
 
1878
                workingtree_4.Converter4or5to6().convert(tree)
 
1879
        self.pb.finished()
2200
1880
        return to_convert
2201
1881
 
2202
1882
 
2203
 
# This is not in remote.py because it's small, and needs to be registered.
2204
 
# Putting it in remote.py creates a circular import problem.
2205
 
# we can make it a lazy object if the control formats is turned into something
2206
 
# like a registry.
2207
 
class RemoteBzrDirFormat(BzrDirMetaFormat1):
2208
 
    """Format representing bzrdirs accessed via a smart server"""
2209
 
 
2210
 
    def get_format_description(self):
2211
 
        return 'bzr remote bzrdir'
2212
 
    
2213
 
    @classmethod
2214
 
    def probe_transport(klass, transport):
2215
 
        """Return a RemoteBzrDirFormat object if it looks possible."""
2216
 
        try:
2217
 
            client = transport.get_smart_client()
2218
 
        except (NotImplementedError, AttributeError,
2219
 
                errors.TransportNotPossible):
2220
 
            # no smart server, so not a branch for this format type.
2221
 
            raise errors.NotBranchError(path=transport.base)
2222
 
        else:
2223
 
            # Send a 'hello' request in protocol version one, and decline to
2224
 
            # open it if the server doesn't support our required version (2) so
2225
 
            # that the VFS-based transport will do it.
2226
 
            request = client.get_request()
2227
 
            smart_protocol = protocol.SmartClientRequestProtocolOne(request)
2228
 
            server_version = smart_protocol.query_version()
2229
 
            if server_version != 2:
2230
 
                raise errors.NotBranchError(path=transport.base)
2231
 
            return klass()
2232
 
 
2233
 
    def initialize_on_transport(self, transport):
2234
 
        try:
2235
 
            # hand off the request to the smart server
2236
 
            shared_medium = transport.get_shared_medium()
2237
 
        except errors.NoSmartMedium:
2238
 
            # TODO: lookup the local format from a server hint.
2239
 
            local_dir_format = BzrDirMetaFormat1()
2240
 
            return local_dir_format.initialize_on_transport(transport)
2241
 
        client = _SmartClient(shared_medium)
2242
 
        path = client.remote_path_from_transport(transport)
2243
 
        response = _SmartClient(shared_medium).call('BzrDirFormat.initialize',
2244
 
                                                    path)
2245
 
        assert response[0] in ('ok', ), 'unexpected response code %s' % (response,)
2246
 
        return remote.RemoteBzrDir(transport)
2247
 
 
2248
 
    def _open(self, transport):
2249
 
        return remote.RemoteBzrDir(transport)
2250
 
 
2251
 
    def __eq__(self, other):
2252
 
        if not isinstance(other, RemoteBzrDirFormat):
2253
 
            return False
2254
 
        return self.get_format_description() == other.get_format_description()
2255
 
 
2256
 
 
2257
 
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
2258
 
 
2259
 
 
2260
 
class BzrDirFormatInfo(object):
2261
 
 
2262
 
    def __init__(self, native, deprecated, hidden):
2263
 
        self.deprecated = deprecated
2264
 
        self.native = native
2265
 
        self.hidden = hidden
2266
 
 
2267
 
 
2268
 
class BzrDirFormatRegistry(registry.Registry):
2269
 
    """Registry of user-selectable BzrDir subformats.
2270
 
    
2271
 
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
2272
 
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
2273
 
    """
2274
 
 
2275
 
    def register_metadir(self, key,
2276
 
             repository_format, help, native=True, deprecated=False,
2277
 
             branch_format=None,
2278
 
             tree_format=None,
2279
 
             hidden=False):
2280
 
        """Register a metadir subformat.
2281
 
 
2282
 
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2283
 
        by the Repository format.
2284
 
 
2285
 
        :param repository_format: The fully-qualified repository format class
2286
 
            name as a string.
2287
 
        :param branch_format: Fully-qualified branch format class name as
2288
 
            a string.
2289
 
        :param tree_format: Fully-qualified tree format class name as
2290
 
            a string.
2291
 
        """
2292
 
        # This should be expanded to support setting WorkingTree and Branch
2293
 
        # formats, once BzrDirMetaFormat1 supports that.
2294
 
        def _load(full_name):
2295
 
            mod_name, factory_name = full_name.rsplit('.', 1)
2296
 
            try:
2297
 
                mod = __import__(mod_name, globals(), locals(),
2298
 
                        [factory_name])
2299
 
            except ImportError, e:
2300
 
                raise ImportError('failed to load %s: %s' % (full_name, e))
2301
 
            try:
2302
 
                factory = getattr(mod, factory_name)
2303
 
            except AttributeError:
2304
 
                raise AttributeError('no factory %s in module %r'
2305
 
                    % (full_name, mod))
2306
 
            return factory()
2307
 
 
2308
 
        def helper():
2309
 
            bd = BzrDirMetaFormat1()
2310
 
            if branch_format is not None:
2311
 
                bd.set_branch_format(_load(branch_format))
2312
 
            if tree_format is not None:
2313
 
                bd.workingtree_format = _load(tree_format)
2314
 
            if repository_format is not None:
2315
 
                bd.repository_format = _load(repository_format)
2316
 
            return bd
2317
 
        self.register(key, helper, help, native, deprecated, hidden)
2318
 
 
2319
 
    def register(self, key, factory, help, native=True, deprecated=False,
2320
 
                 hidden=False):
2321
 
        """Register a BzrDirFormat factory.
2322
 
        
2323
 
        The factory must be a callable that takes one parameter: the key.
2324
 
        It must produce an instance of the BzrDirFormat when called.
2325
 
 
2326
 
        This function mainly exists to prevent the info object from being
2327
 
        supplied directly.
2328
 
        """
2329
 
        registry.Registry.register(self, key, factory, help, 
2330
 
            BzrDirFormatInfo(native, deprecated, hidden))
2331
 
 
2332
 
    def register_lazy(self, key, module_name, member_name, help, native=True,
2333
 
                      deprecated=False, hidden=False):
2334
 
        registry.Registry.register_lazy(self, key, module_name, member_name, 
2335
 
            help, BzrDirFormatInfo(native, deprecated, hidden))
2336
 
 
2337
 
    def set_default(self, key):
2338
 
        """Set the 'default' key to be a clone of the supplied key.
2339
 
        
2340
 
        This method must be called once and only once.
2341
 
        """
2342
 
        registry.Registry.register(self, 'default', self.get(key), 
2343
 
            self.get_help(key), info=self.get_info(key))
2344
 
 
2345
 
    def set_default_repository(self, key):
2346
 
        """Set the FormatRegistry default and Repository default.
2347
 
        
2348
 
        This is a transitional method while Repository.set_default_format
2349
 
        is deprecated.
2350
 
        """
2351
 
        if 'default' in self:
2352
 
            self.remove('default')
2353
 
        self.set_default(key)
2354
 
        format = self.get('default')()
2355
 
        assert isinstance(format, BzrDirMetaFormat1)
2356
 
 
2357
 
    def make_bzrdir(self, key):
2358
 
        return self.get(key)()
2359
 
 
2360
 
    def help_topic(self, topic):
2361
 
        output = textwrap.dedent("""\
2362
 
            These formats can be used for creating branches, working trees, and
2363
 
            repositories.
2364
 
 
2365
 
            """)
2366
 
        default_realkey = None
2367
 
        default_help = self.get_help('default')
2368
 
        help_pairs = []
2369
 
        for key in self.keys():
2370
 
            if key == 'default':
2371
 
                continue
2372
 
            help = self.get_help(key)
2373
 
            if help == default_help:
2374
 
                default_realkey = key
2375
 
            else:
2376
 
                help_pairs.append((key, help))
2377
 
 
2378
 
        def wrapped(key, help, info):
2379
 
            if info.native:
2380
 
                help = '(native) ' + help
2381
 
            return ':%s:\n%s\n\n' % (key, 
2382
 
                    textwrap.fill(help, initial_indent='    ', 
2383
 
                    subsequent_indent='    '))
2384
 
        if default_realkey is not None:
2385
 
            output += wrapped(default_realkey, '(default) %s' % default_help,
2386
 
                              self.get_info('default'))
2387
 
        deprecated_pairs = []
2388
 
        for key, help in help_pairs:
2389
 
            info = self.get_info(key)
2390
 
            if info.hidden:
2391
 
                continue
2392
 
            elif info.deprecated:
2393
 
                deprecated_pairs.append((key, help))
2394
 
            else:
2395
 
                output += wrapped(key, help, info)
2396
 
        if len(deprecated_pairs) > 0:
2397
 
            output += "Deprecated formats are shown below.\n\n"
2398
 
            for key, help in deprecated_pairs:
2399
 
                info = self.get_info(key)
2400
 
                output += wrapped(key, help, info)
2401
 
 
2402
 
        return output
2403
 
 
2404
 
 
2405
 
format_registry = BzrDirFormatRegistry()
2406
 
format_registry.register('weave', BzrDirFormat6,
2407
 
    'Pre-0.8 format.  Slower than knit and does not'
2408
 
    ' support checkouts or shared repositories.',
2409
 
    deprecated=True)
2410
 
format_registry.register_metadir('knit',
 
1883
class ConvertMetaToColo(controldir.Converter):
 
1884
    """Add colocated branch support."""
 
1885
 
 
1886
    def __init__(self, target_format):
 
1887
        """Create a converter.that upgrades a metadir to the colo format.
 
1888
 
 
1889
        :param target_format: The final metadir format that is desired.
 
1890
        """
 
1891
        self.target_format = target_format
 
1892
 
 
1893
    def convert(self, to_convert, pb):
 
1894
        """See Converter.convert()."""
 
1895
        to_convert.transport.put_bytes('branch-format',
 
1896
            self.target_format.as_string())
 
1897
        return BzrDir.open_from_transport(to_convert.root_transport)
 
1898
 
 
1899
 
 
1900
class ConvertMetaRemoveColo(controldir.Converter):
 
1901
    """Remove colocated branch support from a bzrdir."""
 
1902
 
 
1903
    def __init__(self, target_format):
 
1904
        """Create a converter.that downgrades a colocated branch metadir
 
1905
        to a regular metadir.
 
1906
 
 
1907
        :param target_format: The final metadir format that is desired.
 
1908
        """
 
1909
        self.target_format = target_format
 
1910
 
 
1911
    def convert(self, to_convert, pb):
 
1912
        """See Converter.convert()."""
 
1913
        to_convert.control_files.lock_write()
 
1914
        try:
 
1915
            branches = to_convert.list_branches()
 
1916
            if len(branches) > 1:
 
1917
                raise errors.BzrError("remove all but a single "
 
1918
                    "colocated branch when downgrading")
 
1919
        finally:
 
1920
            to_convert.control_files.unlock()
 
1921
        to_convert.transport.put_bytes('branch-format',
 
1922
            self.target_format.as_string())
 
1923
        return BzrDir.open_from_transport(to_convert.root_transport)
 
1924
 
 
1925
 
 
1926
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
 
1927
 
 
1928
 
 
1929
class RepositoryAcquisitionPolicy(object):
 
1930
    """Abstract base class for repository acquisition policies.
 
1931
 
 
1932
    A repository acquisition policy decides how a BzrDir acquires a repository
 
1933
    for a branch that is being created.  The most basic policy decision is
 
1934
    whether to create a new repository or use an existing one.
 
1935
    """
 
1936
    def __init__(self, stack_on, stack_on_pwd, require_stacking):
 
1937
        """Constructor.
 
1938
 
 
1939
        :param stack_on: A location to stack on
 
1940
        :param stack_on_pwd: If stack_on is relative, the location it is
 
1941
            relative to.
 
1942
        :param require_stacking: If True, it is a failure to not stack.
 
1943
        """
 
1944
        self._stack_on = stack_on
 
1945
        self._stack_on_pwd = stack_on_pwd
 
1946
        self._require_stacking = require_stacking
 
1947
 
 
1948
    def configure_branch(self, branch):
 
1949
        """Apply any configuration data from this policy to the branch.
 
1950
 
 
1951
        Default implementation sets repository stacking.
 
1952
        """
 
1953
        if self._stack_on is None:
 
1954
            return
 
1955
        if self._stack_on_pwd is None:
 
1956
            stack_on = self._stack_on
 
1957
        else:
 
1958
            try:
 
1959
                stack_on = urlutils.rebase_url(self._stack_on,
 
1960
                    self._stack_on_pwd,
 
1961
                    branch.user_url)
 
1962
            except errors.InvalidRebaseURLs:
 
1963
                stack_on = self._get_full_stack_on()
 
1964
        try:
 
1965
            branch.set_stacked_on_url(stack_on)
 
1966
        except (errors.UnstackableBranchFormat,
 
1967
                errors.UnstackableRepositoryFormat):
 
1968
            if self._require_stacking:
 
1969
                raise
 
1970
 
 
1971
    def requires_stacking(self):
 
1972
        """Return True if this policy requires stacking."""
 
1973
        return self._stack_on is not None and self._require_stacking
 
1974
 
 
1975
    def _get_full_stack_on(self):
 
1976
        """Get a fully-qualified URL for the stack_on location."""
 
1977
        if self._stack_on is None:
 
1978
            return None
 
1979
        if self._stack_on_pwd is None:
 
1980
            return self._stack_on
 
1981
        else:
 
1982
            return urlutils.join(self._stack_on_pwd, self._stack_on)
 
1983
 
 
1984
    def _add_fallback(self, repository, possible_transports=None):
 
1985
        """Add a fallback to the supplied repository, if stacking is set."""
 
1986
        stack_on = self._get_full_stack_on()
 
1987
        if stack_on is None:
 
1988
            return
 
1989
        try:
 
1990
            stacked_dir = BzrDir.open(stack_on,
 
1991
                                      possible_transports=possible_transports)
 
1992
        except errors.JailBreak:
 
1993
            # We keep the stacking details, but we are in the server code so
 
1994
            # actually stacking is not needed.
 
1995
            return
 
1996
        try:
 
1997
            stacked_repo = stacked_dir.open_branch().repository
 
1998
        except errors.NotBranchError:
 
1999
            stacked_repo = stacked_dir.open_repository()
 
2000
        try:
 
2001
            repository.add_fallback_repository(stacked_repo)
 
2002
        except errors.UnstackableRepositoryFormat:
 
2003
            if self._require_stacking:
 
2004
                raise
 
2005
        else:
 
2006
            self._require_stacking = True
 
2007
 
 
2008
    def acquire_repository(self, make_working_trees=None, shared=False,
 
2009
            possible_transports=None):
 
2010
        """Acquire a repository for this bzrdir.
 
2011
 
 
2012
        Implementations may create a new repository or use a pre-exising
 
2013
        repository.
 
2014
 
 
2015
        :param make_working_trees: If creating a repository, set
 
2016
            make_working_trees to this value (if non-None)
 
2017
        :param shared: If creating a repository, make it shared if True
 
2018
        :return: A repository, is_new_flag (True if the repository was
 
2019
            created).
 
2020
        """
 
2021
        raise NotImplementedError(RepositoryAcquisitionPolicy.acquire_repository)
 
2022
 
 
2023
 
 
2024
class CreateRepository(RepositoryAcquisitionPolicy):
 
2025
    """A policy of creating a new repository"""
 
2026
 
 
2027
    def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
 
2028
                 require_stacking=False):
 
2029
        """Constructor.
 
2030
 
 
2031
        :param bzrdir: The bzrdir to create the repository on.
 
2032
        :param stack_on: A location to stack on
 
2033
        :param stack_on_pwd: If stack_on is relative, the location it is
 
2034
            relative to.
 
2035
        """
 
2036
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
 
2037
                                             require_stacking)
 
2038
        self._bzrdir = bzrdir
 
2039
 
 
2040
    def acquire_repository(self, make_working_trees=None, shared=False,
 
2041
            possible_transports=None):
 
2042
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
 
2043
 
 
2044
        Creates the desired repository in the bzrdir we already have.
 
2045
        """
 
2046
        if possible_transports is None:
 
2047
            possible_transports = []
 
2048
        else:
 
2049
            possible_transports = list(possible_transports)
 
2050
        possible_transports.append(self._bzrdir.root_transport)
 
2051
        stack_on = self._get_full_stack_on()
 
2052
        if stack_on:
 
2053
            format = self._bzrdir._format
 
2054
            format.require_stacking(stack_on=stack_on,
 
2055
                                    possible_transports=possible_transports)
 
2056
            if not self._require_stacking:
 
2057
                # We have picked up automatic stacking somewhere.
 
2058
                note(gettext('Using default stacking branch {0} at {1}').format(
 
2059
                    self._stack_on, self._stack_on_pwd))
 
2060
        repository = self._bzrdir.create_repository(shared=shared)
 
2061
        self._add_fallback(repository,
 
2062
                           possible_transports=possible_transports)
 
2063
        if make_working_trees is not None:
 
2064
            repository.set_make_working_trees(make_working_trees)
 
2065
        return repository, True
 
2066
 
 
2067
 
 
2068
class UseExistingRepository(RepositoryAcquisitionPolicy):
 
2069
    """A policy of reusing an existing repository"""
 
2070
 
 
2071
    def __init__(self, repository, stack_on=None, stack_on_pwd=None,
 
2072
                 require_stacking=False):
 
2073
        """Constructor.
 
2074
 
 
2075
        :param repository: The repository to use.
 
2076
        :param stack_on: A location to stack on
 
2077
        :param stack_on_pwd: If stack_on is relative, the location it is
 
2078
            relative to.
 
2079
        """
 
2080
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
 
2081
                                             require_stacking)
 
2082
        self._repository = repository
 
2083
 
 
2084
    def acquire_repository(self, make_working_trees=None, shared=False,
 
2085
            possible_transports=None):
 
2086
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
 
2087
 
 
2088
        Returns an existing repository to use.
 
2089
        """
 
2090
        if possible_transports is None:
 
2091
            possible_transports = []
 
2092
        else:
 
2093
            possible_transports = list(possible_transports)
 
2094
        possible_transports.append(self._repository.bzrdir.transport)
 
2095
        self._add_fallback(self._repository,
 
2096
                       possible_transports=possible_transports)
 
2097
        return self._repository, False
 
2098
 
 
2099
 
 
2100
def register_metadir(registry, key,
 
2101
         repository_format, help, native=True, deprecated=False,
 
2102
         branch_format=None,
 
2103
         tree_format=None,
 
2104
         hidden=False,
 
2105
         experimental=False,
 
2106
         alias=False, bzrdir_format=None):
 
2107
    """Register a metadir subformat.
 
2108
 
 
2109
    These all use a meta bzrdir, but can be parameterized by the
 
2110
    Repository/Branch/WorkingTreeformats.
 
2111
 
 
2112
    :param repository_format: The fully-qualified repository format class
 
2113
        name as a string.
 
2114
    :param branch_format: Fully-qualified branch format class name as
 
2115
        a string.
 
2116
    :param tree_format: Fully-qualified tree format class name as
 
2117
        a string.
 
2118
    """
 
2119
    if bzrdir_format is None:
 
2120
        bzrdir_format = BzrDirMetaFormat1
 
2121
    # This should be expanded to support setting WorkingTree and Branch
 
2122
    # formats, once the API supports that.
 
2123
    def _load(full_name):
 
2124
        mod_name, factory_name = full_name.rsplit('.', 1)
 
2125
        try:
 
2126
            factory = pyutils.get_named_object(mod_name, factory_name)
 
2127
        except ImportError, e:
 
2128
            raise ImportError('failed to load %s: %s' % (full_name, e))
 
2129
        except AttributeError:
 
2130
            raise AttributeError('no factory %s in module %r'
 
2131
                % (full_name, sys.modules[mod_name]))
 
2132
        return factory()
 
2133
 
 
2134
    def helper():
 
2135
        bd = bzrdir_format()
 
2136
        if branch_format is not None:
 
2137
            bd.set_branch_format(_load(branch_format))
 
2138
        if tree_format is not None:
 
2139
            bd.workingtree_format = _load(tree_format)
 
2140
        if repository_format is not None:
 
2141
            bd.repository_format = _load(repository_format)
 
2142
        return bd
 
2143
    registry.register(key, helper, help, native, deprecated, hidden,
 
2144
        experimental, alias)
 
2145
 
 
2146
register_metadir(controldir.format_registry, 'knit',
2411
2147
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2412
2148
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
2413
2149
    branch_format='bzrlib.branch.BzrBranchFormat5',
2414
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat3')
2415
 
format_registry.register_metadir('metaweave',
2416
 
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
2417
 
    'Transitional format in 0.8.  Slower than knit.',
2418
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
2419
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2420
 
    deprecated=True)
2421
 
format_registry.register_metadir('dirstate',
2422
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2423
 
    help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2424
 
        'above when accessed over the network.',
2425
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
2426
 
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
2427
 
    # directly from workingtree_4 triggers a circular import.
2428
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2429
 
    )
2430
 
format_registry.register_metadir('dirstate-tags',
2431
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2432
 
    help='New in 0.15: Fast local operations and improved scaling for '
2433
 
        'network operations. Additionally adds support for tags.'
2434
 
        ' Incompatible with bzr < 0.15.',
2435
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
2436
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2437
 
    )
2438
 
format_registry.register_metadir('dirstate-with-subtree',
 
2150
    tree_format='bzrlib.workingtree_3.WorkingTreeFormat3',
 
2151
    hidden=True,
 
2152
    deprecated=True)
 
2153
register_metadir(controldir.format_registry, 'dirstate',
 
2154
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
2155
    help='Format using dirstate for working trees. '
 
2156
        'Compatible with bzr 0.8 and '
 
2157
        'above when accessed over the network. Introduced in bzr 0.15.',
 
2158
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
2159
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2160
    hidden=True,
 
2161
    deprecated=True)
 
2162
register_metadir(controldir.format_registry, 'dirstate-tags',
 
2163
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
2164
    help='Variant of dirstate with support for tags. '
 
2165
        'Introduced in bzr 0.15.',
 
2166
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2167
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2168
    hidden=True,
 
2169
    deprecated=True)
 
2170
register_metadir(controldir.format_registry, 'rich-root',
 
2171
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
 
2172
    help='Variant of dirstate with better handling of tree roots. '
 
2173
        'Introduced in bzr 1.0',
 
2174
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2175
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2176
    hidden=True,
 
2177
    deprecated=True)
 
2178
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
2439
2179
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2440
 
    help='New in 0.15: Fast local operations and improved scaling for '
2441
 
        'network operations. Additionally adds support for versioning nested '
2442
 
        'bzr branches. Incompatible with bzr < 0.15.',
2443
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
2444
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2445
 
    hidden=True,
2446
 
    )
2447
 
format_registry.set_default('dirstate-tags')
 
2180
    help='Variant of dirstate with support for nested trees. '
 
2181
         'Introduced in 0.15.',
 
2182
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2183
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2184
    experimental=True,
 
2185
    hidden=True,
 
2186
    )
 
2187
register_metadir(controldir.format_registry, 'pack-0.92',
 
2188
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack1',
 
2189
    help='Pack-based format used in 1.x series. Introduced in 0.92. '
 
2190
        'Interoperates with bzr repositories before 0.92 but cannot be '
 
2191
        'read by bzr < 0.92. '
 
2192
        ,
 
2193
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2194
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2195
    deprecated=True,
 
2196
    )
 
2197
register_metadir(controldir.format_registry, 'pack-0.92-subtree',
 
2198
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack3',
 
2199
    help='Pack-based format used in 1.x series, with subtree support. '
 
2200
        'Introduced in 0.92. Interoperates with '
 
2201
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
 
2202
        ,
 
2203
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2204
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2205
    hidden=True,
 
2206
    deprecated=True,
 
2207
    experimental=True,
 
2208
    )
 
2209
register_metadir(controldir.format_registry, 'rich-root-pack',
 
2210
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack4',
 
2211
    help='A variant of pack-0.92 that supports rich-root data '
 
2212
         '(needed for bzr-svn and bzr-git). Introduced in 1.0.',
 
2213
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2214
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2215
    hidden=True,
 
2216
    deprecated=True,
 
2217
    )
 
2218
register_metadir(controldir.format_registry, '1.6',
 
2219
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5',
 
2220
    help='A format that allows a branch to indicate that there is another '
 
2221
         '(stacked) repository that should be used to access data that is '
 
2222
         'not present locally.',
 
2223
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2224
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2225
    hidden=True,
 
2226
    deprecated=True,
 
2227
    )
 
2228
register_metadir(controldir.format_registry, '1.6.1-rich-root',
 
2229
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5RichRoot',
 
2230
    help='A variant of 1.6 that supports rich-root data '
 
2231
         '(needed for bzr-svn and bzr-git).',
 
2232
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2233
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2234
    hidden=True,
 
2235
    deprecated=True,
 
2236
    )
 
2237
register_metadir(controldir.format_registry, '1.9',
 
2238
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
 
2239
    help='A repository format using B+tree indexes. These indexes '
 
2240
         'are smaller in size, have smarter caching and provide faster '
 
2241
         'performance for most operations.',
 
2242
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2243
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2244
    hidden=True,
 
2245
    deprecated=True,
 
2246
    )
 
2247
register_metadir(controldir.format_registry, '1.9-rich-root',
 
2248
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
 
2249
    help='A variant of 1.9 that supports rich-root data '
 
2250
         '(needed for bzr-svn and bzr-git).',
 
2251
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2252
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2253
    hidden=True,
 
2254
    deprecated=True,
 
2255
    )
 
2256
register_metadir(controldir.format_registry, '1.14',
 
2257
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
 
2258
    help='A working-tree format that supports content filtering.',
 
2259
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2260
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
 
2261
    hidden=True,
 
2262
    deprecated=True,
 
2263
    )
 
2264
register_metadir(controldir.format_registry, '1.14-rich-root',
 
2265
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
 
2266
    help='A variant of 1.14 that supports rich-root data '
 
2267
         '(needed for bzr-svn and bzr-git).',
 
2268
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2269
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
 
2270
    hidden=True,
 
2271
    deprecated=True,
 
2272
    )
 
2273
# The following un-numbered 'development' formats should always just be aliases.
 
2274
register_metadir(controldir.format_registry, 'development-subtree',
 
2275
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2aSubtree',
 
2276
    help='Current development format, subtree variant. Can convert data to and '
 
2277
        'from pack-0.92-subtree (and anything compatible with '
 
2278
        'pack-0.92-subtree) format repositories. Repositories and branches in '
 
2279
        'this format can only be read by bzr.dev. Please read '
 
2280
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
2281
        'before use.',
 
2282
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2283
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
2284
    experimental=True,
 
2285
    hidden=True,
 
2286
    alias=False, # Restore to being an alias when an actual development subtree format is added
 
2287
                 # This current non-alias status is simply because we did not introduce a
 
2288
                 # chk based subtree format.
 
2289
    )
 
2290
register_metadir(controldir.format_registry, 'development5-subtree',
 
2291
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatPackDevelopment2Subtree',
 
2292
    help='Development format, subtree variant. Can convert data to and '
 
2293
        'from pack-0.92-subtree (and anything compatible with '
 
2294
        'pack-0.92-subtree) format repositories. Repositories and branches in '
 
2295
        'this format can only be read by bzr.dev. Please read '
 
2296
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
2297
        'before use.',
 
2298
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2299
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
2300
    experimental=True,
 
2301
    hidden=True,
 
2302
    alias=False,
 
2303
    )
 
2304
 
 
2305
register_metadir(controldir.format_registry, 'development-colo',
 
2306
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
 
2307
    help='The 2a format with experimental support for colocated branches.\n',
 
2308
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2309
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
2310
    experimental=True,
 
2311
    bzrdir_format=BzrDirMetaFormat1Colo,
 
2312
    )
 
2313
 
 
2314
 
 
2315
# And the development formats above will have aliased one of the following:
 
2316
 
 
2317
# Finally, the current format.
 
2318
register_metadir(controldir.format_registry, '2a',
 
2319
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
 
2320
    help='Format for the bzr 2.0 series.\n'
 
2321
        'Uses group-compress storage.\n'
 
2322
        'Provides rich roots which are a one-way transition.\n',
 
2323
        # 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
 
2324
        # 'rich roots. Supported by bzr 1.16 and later.',
 
2325
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2326
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
2327
    experimental=False,
 
2328
    )
 
2329
 
 
2330
# The following format should be an alias for the rich root equivalent 
 
2331
# of the default format
 
2332
register_metadir(controldir.format_registry, 'default-rich-root',
 
2333
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
 
2334
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2335
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
2336
    alias=True,
 
2337
    hidden=True,
 
2338
    help='Same as 2a.')
 
2339
 
 
2340
# The current format that is made on 'bzr init'.
 
2341
format_name = config.GlobalStack().get('default_format')
 
2342
controldir.format_registry.set_default(format_name)
 
2343
 
 
2344
# XXX 2010-08-20 JRV: There is still a lot of code relying on
 
2345
# bzrlib.bzrdir.format_registry existing. When BzrDir.create/BzrDir.open/etc
 
2346
# get changed to ControlDir.create/ControlDir.open/etc this should be removed.
 
2347
format_registry = controldir.format_registry