~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Patch Queue Manager
  • Date: 2015-12-17 18:39:00 UTC
  • mfrom: (6606.1.2 fix-float)
  • Revision ID: pqm@pqm.ubuntu.com-20151217183900-0719du2uv1kwu3lc
(vila) Inline testtools private method to fix an issue in xenial (the
 private implementation has changed in an backward incompatible way).
 (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

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