~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Ian Clatworthy
  • Date: 2007-03-22 01:02:07 UTC
  • mto: (2370.2.1 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 2371.
  • Revision ID: ian.clatworthy@internode.on.net-20070322010207-r8xcwjshipoahmcx
Minor corrections to HACKING

Show diffs side-by-side

added added

removed removed

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