~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Robert Collins
  • Date: 2007-10-23 22:14:32 UTC
  • mto: (2592.6.3 repository)
  • mto: This revision was merged to the branch mainline in revision 2967.
  • Revision ID: robertc@robertcollins.net-20071023221432-j8zndh1oiegql3cu
* Commit updates the state of the working tree via a delta rather than
  supplying entirely new basis trees. For commit of a single specified file
  this reduces the wall clock time for commit by roughly a 30%.
  (Robert Collins, Martin Pool)

Show diffs side-by-side

added added

removed removed

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