~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Neil Martinsen-Burrell
  • Date: 2008-06-19 06:57:22 UTC
  • mto: (3505.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3506.
  • Revision ID: nmb@wartburg.edu-20080619065722-dboa3ko7ap8dcf2p
Fix bug 228058: user names with @ signs should work

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