~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: John Arbash Meinel
  • Date: 2008-05-19 21:35:52 UTC
  • mto: This revision was merged to the branch mainline in revision 3441.
  • Revision ID: john@arbash-meinel.com-20080519213552-8jc1yc4w8rqhgzri
switch find_unmerged to use the new function

The api is very compatible, so we don't really need to expose a new function.
So make it hidden, and leave find_unmerged to take out the write lock and call it.

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