~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Martin Pool
  • Date: 2007-07-13 04:22:17 UTC
  • mto: This revision was merged to the branch mainline in revision 2618.
  • Revision ID: mbp@sourcefrog.net-20070713042217-mnkwb9przs8x2de0
Move bencode tests from within their module into our test suite

Show diffs side-by-side

added added

removed removed

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