~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Martin Packman
  • Date: 2012-03-27 17:32:19 UTC
  • mto: (6437.54.3 2.5)
  • mto: This revision was merged to the branch mainline in revision 6525.
  • Revision ID: martin.packman@canonical.com-20120327173219-401pil42gke8j0xh
Fall back to sys.prefix not /usr when looking for .mo files

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