~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Vincent Ladeuil
  • Date: 2008-01-29 15:16:31 UTC
  • mto: (3206.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 3207.
  • Revision ID: v.ladeuil+lp@free.fr-20080129151631-vqjd13tb405mobx6
Fix two more leaking tmp dirs, by reworking TransformPreview lock handling.

* bzrlib/tests/test_transform.py:
(TestTransformMerge): Revert previous patch and cleanly call
preview.finalize now that we can.

* bzrlib/tests/test_merge.py:
(TestMerge.test_make_preview_transform): Catch TransformPreview
leak.

* bzrlib/builtins.py:
(cmd_merge._do_preview): Finalize the TransformPreview or the
limbodir will stay in /tmp.

* bzrlib/transform.py:
(TreeTransformBase.__init__): Create the _deletiondir since it's
reffered to by finalize.
(TreeTransformBase.finalize): Delete the dir only if _deletiondir
is set.
(TreeTransform.__init__): Use a temp var for deletiondir and set
the attribute after the base class __init__ has been called.
(TransformPreview.__init__): Read locks the tree since finalize
wants to unlock it (as suggested by Aaron).

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
18
 
19
19
At format 7 this was split out into Branch, Repository and Checkout control
20
20
directories.
 
21
 
 
22
Note: This module has a lot of ``open`` functions/methods that return
 
23
references to in-memory objects. As a rule, there are no matching ``close``
 
24
methods. To free any associated resources, simply stop referencing the
 
25
objects returned.
21
26
"""
22
27
 
23
 
from copy import deepcopy
 
28
# TODO: Move old formats into a plugin to make this file smaller.
 
29
 
 
30
from cStringIO import StringIO
24
31
import os
25
 
from cStringIO import StringIO
26
 
from unittest import TestSuite
 
32
import sys
 
33
 
 
34
from bzrlib.lazy_import import lazy_import
 
35
lazy_import(globals(), """
 
36
from stat import S_ISDIR
 
37
import textwrap
 
38
from warnings import warn
27
39
 
28
40
import bzrlib
29
 
import bzrlib.errors as errors
30
 
from bzrlib.lockable_files import LockableFiles, TransportLock
31
 
from bzrlib.lockdir import LockDir
32
 
from bzrlib.osutils import safe_unicode
 
41
from bzrlib import (
 
42
    errors,
 
43
    graph,
 
44
    lockable_files,
 
45
    lockdir,
 
46
    registry,
 
47
    remote,
 
48
    revision as _mod_revision,
 
49
    symbol_versioning,
 
50
    ui,
 
51
    urlutils,
 
52
    win32utils,
 
53
    workingtree,
 
54
    workingtree_4,
 
55
    xml4,
 
56
    xml5,
 
57
    )
33
58
from bzrlib.osutils import (
34
 
                            abspath,
35
 
                            pathjoin,
36
 
                            safe_unicode,
37
 
                            sha_strings,
38
 
                            sha_string,
39
 
                            )
 
59
    sha_strings,
 
60
    sha_string,
 
61
    )
 
62
from bzrlib.smart.client import _SmartClient
 
63
from bzrlib.smart import protocol
40
64
from bzrlib.store.revision.text import TextRevisionStore
41
65
from bzrlib.store.text import TextStore
42
66
from bzrlib.store.versioned import WeaveStore
43
 
from bzrlib.symbol_versioning import *
44
 
from bzrlib.trace import mutter
45
67
from bzrlib.transactions import WriteTransaction
46
 
from bzrlib.transport import get_transport, urlunescape
 
68
from bzrlib.transport import (
 
69
    do_catching_redirections,
 
70
    get_transport,
 
71
    )
 
72
from bzrlib.weave import Weave
 
73
""")
 
74
 
 
75
from bzrlib.trace import (
 
76
    mutter,
 
77
    note,
 
78
    )
47
79
from bzrlib.transport.local import LocalTransport
48
 
from bzrlib.weave import Weave
49
 
from bzrlib.xml4 import serializer_v4
50
 
from bzrlib.xml5 import serializer_v5
 
80
from bzrlib.symbol_versioning import (
 
81
    deprecated_function,
 
82
    deprecated_method,
 
83
    zero_ninetyone,
 
84
    )
51
85
 
52
86
 
53
87
class BzrDir(object):
59
93
    transport
60
94
        the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
61
95
    root_transport
62
 
        a transport connected to the directory this bzr was opened from.
 
96
        a transport connected to the directory this bzr was opened from
 
97
        (i.e. the parent directory holding the .bzr directory).
63
98
    """
64
99
 
65
100
    def break_lock(self):
68
103
        If there is a tree, the tree is opened and break_lock() called.
69
104
        Otherwise, branch is tried, and finally repository.
70
105
        """
 
106
        # XXX: This seems more like a UI function than something that really
 
107
        # belongs in this class.
71
108
        try:
72
109
            thing_to_unlock = self.open_workingtree()
73
110
        except (errors.NotLocalUrl, errors.NoWorkingTree):
84
121
        """Return true if this bzrdir is one whose format we can convert from."""
85
122
        return True
86
123
 
 
124
    def check_conversion_target(self, target_format):
 
125
        target_repo_format = target_format.repository_format
 
126
        source_repo_format = self._format.repository_format
 
127
        source_repo_format.check_conversion_target(target_repo_format)
 
128
 
87
129
    @staticmethod
88
 
    def _check_supported(format, allow_unsupported):
89
 
        """Check whether format is a supported format.
90
 
 
91
 
        If allow_unsupported is True, this is a no-op.
 
130
    def _check_supported(format, allow_unsupported,
 
131
        recommend_upgrade=True,
 
132
        basedir=None):
 
133
        """Give an error or warning on old formats.
 
134
 
 
135
        :param format: may be any kind of format - workingtree, branch, 
 
136
        or repository.
 
137
 
 
138
        :param allow_unsupported: If true, allow opening 
 
139
        formats that are strongly deprecated, and which may 
 
140
        have limited functionality.
 
141
 
 
142
        :param recommend_upgrade: If true (default), warn
 
143
        the user through the ui object that they may wish
 
144
        to upgrade the object.
92
145
        """
 
146
        # TODO: perhaps move this into a base Format class; it's not BzrDir
 
147
        # specific. mbp 20070323
93
148
        if not allow_unsupported and not format.is_supported():
94
149
            # see open_downlevel to open legacy branches.
95
 
            raise errors.UnsupportedFormatError(
96
 
                    'sorry, format %s not supported' % format,
97
 
                    ['use a different bzr version',
98
 
                     'or remove the .bzr directory'
99
 
                     ' and "bzr init" again'])
 
150
            raise errors.UnsupportedFormatError(format=format)
 
151
        if recommend_upgrade \
 
152
            and getattr(format, 'upgrade_recommended', False):
 
153
            ui.ui_factory.recommend_upgrade(
 
154
                format.get_format_description(),
 
155
                basedir)
100
156
 
101
 
    def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
 
157
    def clone(self, url, revision_id=None, force_new_repo=False):
102
158
        """Clone this bzrdir and its contents to url verbatim.
103
159
 
104
 
        If urls last component does not exist, it will be created.
105
 
 
106
 
        if revision_id is not None, then the clone operation may tune
107
 
            itself to download less data.
108
 
        :param force_new_repo: Do not use a shared repository for the target 
109
 
                               even if one is available.
110
 
        """
111
 
        self._make_tail(url)
112
 
        basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
113
 
        result = self._format.initialize(url)
 
160
        If url's last component does not exist, it will be created.
 
161
 
 
162
        if revision_id is not None, then the clone operation may tune
 
163
            itself to download less data.
 
164
        :param force_new_repo: Do not use a shared repository for the target 
 
165
                               even if one is available.
 
166
        """
 
167
        return self.clone_on_transport(get_transport(url),
 
168
                                       revision_id=revision_id,
 
169
                                       force_new_repo=force_new_repo)
 
170
 
 
171
    def clone_on_transport(self, transport, revision_id=None,
 
172
                           force_new_repo=False):
 
173
        """Clone this bzrdir and its contents to transport verbatim.
 
174
 
 
175
        If the target directory does not exist, it will be created.
 
176
 
 
177
        if revision_id is not None, then the clone operation may tune
 
178
            itself to download less data.
 
179
        :param force_new_repo: Do not use a shared repository for the target 
 
180
                               even if one is available.
 
181
        """
 
182
        transport.ensure_base()
 
183
        result = self._format.initialize_on_transport(transport)
114
184
        try:
115
185
            local_repo = self.find_repository()
116
186
        except errors.NoRepositoryPresent:
120
190
            if force_new_repo:
121
191
                result_repo = local_repo.clone(
122
192
                    result,
123
 
                    revision_id=revision_id,
124
 
                    basis=basis_repo)
 
193
                    revision_id=revision_id)
125
194
                result_repo.set_make_working_trees(local_repo.make_working_trees())
126
195
            else:
127
196
                try:
128
197
                    result_repo = result.find_repository()
129
198
                    # fetch content this dir needs.
130
 
                    if basis_repo:
131
 
                        # XXX FIXME RBC 20060214 need tests for this when the basis
132
 
                        # is incomplete
133
 
                        result_repo.fetch(basis_repo, revision_id=revision_id)
134
199
                    result_repo.fetch(local_repo, revision_id=revision_id)
135
200
                except errors.NoRepositoryPresent:
136
201
                    # needed to make one anyway.
137
202
                    result_repo = local_repo.clone(
138
203
                        result,
139
 
                        revision_id=revision_id,
140
 
                        basis=basis_repo)
 
204
                        revision_id=revision_id)
141
205
                    result_repo.set_make_working_trees(local_repo.make_working_trees())
142
206
        # 1 if there is a branch present
143
207
        #   make sure its content is available in the target repository
147
211
        except errors.NotBranchError:
148
212
            pass
149
213
        try:
150
 
            self.open_workingtree().clone(result, basis=basis_tree)
151
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
152
 
            pass
 
214
            result_repo = result.find_repository()
 
215
        except errors.NoRepositoryPresent:
 
216
            result_repo = None
 
217
        if result_repo is None or result_repo.make_working_trees():
 
218
            try:
 
219
                self.open_workingtree().clone(result)
 
220
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
221
                pass
153
222
        return result
154
223
 
155
 
    def _get_basis_components(self, basis):
156
 
        """Retrieve the basis components that are available at basis."""
157
 
        if basis is None:
158
 
            return None, None, None
159
 
        try:
160
 
            basis_tree = basis.open_workingtree()
161
 
            basis_branch = basis_tree.branch
162
 
            basis_repo = basis_branch.repository
163
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
164
 
            basis_tree = None
165
 
            try:
166
 
                basis_branch = basis.open_branch()
167
 
                basis_repo = basis_branch.repository
168
 
            except errors.NotBranchError:
169
 
                basis_branch = None
170
 
                try:
171
 
                    basis_repo = basis.open_repository()
172
 
                except errors.NoRepositoryPresent:
173
 
                    basis_repo = None
174
 
        return basis_repo, basis_branch, basis_tree
175
 
 
 
224
    # TODO: This should be given a Transport, and should chdir up; otherwise
 
225
    # this will open a new connection.
176
226
    def _make_tail(self, url):
177
 
        segments = url.split('/')
178
 
        if segments and segments[-1] not in ('', '.'):
179
 
            parent = '/'.join(segments[:-1])
180
 
            t = bzrlib.transport.get_transport(parent)
181
 
            try:
182
 
                t.mkdir(segments[-1])
183
 
            except errors.FileExists:
184
 
                pass
 
227
        t = get_transport(url)
 
228
        t.ensure_base()
185
229
 
186
230
    @classmethod
187
 
    def create(cls, base):
 
231
    def create(cls, base, format=None, possible_transports=None):
188
232
        """Create a new BzrDir at the url 'base'.
189
233
        
190
 
        This will call the current default formats initialize with base
191
 
        as the only parameter.
192
 
 
193
 
        If you need a specific format, consider creating an instance
194
 
        of that and calling initialize().
 
234
        :param format: If supplied, the format of branch to create.  If not
 
235
            supplied, the default is used.
 
236
        :param possible_transports: If supplied, a list of transports that 
 
237
            can be reused to share a remote connection.
195
238
        """
196
239
        if cls is not BzrDir:
197
 
            raise AssertionError("BzrDir.create always creates the default format, "
198
 
                    "not one of %r" % cls)
199
 
        segments = base.split('/')
200
 
        if segments and segments[-1] not in ('', '.'):
201
 
            parent = '/'.join(segments[:-1])
202
 
            t = bzrlib.transport.get_transport(parent)
203
 
            try:
204
 
                t.mkdir(segments[-1])
205
 
            except errors.FileExists:
206
 
                pass
207
 
        return BzrDirFormat.get_default_format().initialize(safe_unicode(base))
 
240
            raise AssertionError("BzrDir.create always creates the default"
 
241
                " format, not one of %r" % cls)
 
242
        t = get_transport(base, possible_transports)
 
243
        t.ensure_base()
 
244
        if format is None:
 
245
            format = BzrDirFormat.get_default_format()
 
246
        return format.initialize_on_transport(t)
 
247
 
 
248
    @staticmethod
 
249
    def find_bzrdirs(transport, evaluate=None, list_current=None):
 
250
        """Find bzrdirs recursively from current location.
 
251
 
 
252
        This is intended primarily as a building block for more sophisticated
 
253
        functionality, like finding trees under a directory, or finding
 
254
        branches that use a given repository.
 
255
        :param evaluate: An optional callable that yields recurse, value,
 
256
            where recurse controls whether this bzrdir is recursed into
 
257
            and value is the value to yield.  By default, all bzrdirs
 
258
            are recursed into, and the return value is the bzrdir.
 
259
        :param list_current: if supplied, use this function to list the current
 
260
            directory, instead of Transport.list_dir
 
261
        :return: a generator of found bzrdirs, or whatever evaluate returns.
 
262
        """
 
263
        if list_current is None:
 
264
            def list_current(transport):
 
265
                return transport.list_dir('')
 
266
        if evaluate is None:
 
267
            def evaluate(bzrdir):
 
268
                return True, bzrdir
 
269
 
 
270
        pending = [transport]
 
271
        while len(pending) > 0:
 
272
            current_transport = pending.pop()
 
273
            recurse = True
 
274
            try:
 
275
                bzrdir = BzrDir.open_from_transport(current_transport)
 
276
            except errors.NotBranchError:
 
277
                pass
 
278
            else:
 
279
                recurse, value = evaluate(bzrdir)
 
280
                yield value
 
281
            try:
 
282
                subdirs = list_current(current_transport)
 
283
            except errors.NoSuchFile:
 
284
                continue
 
285
            if recurse:
 
286
                for subdir in sorted(subdirs, reverse=True):
 
287
                    pending.append(current_transport.clone(subdir))
 
288
 
 
289
    @staticmethod
 
290
    def find_branches(transport):
 
291
        """Find all branches under a transport.
 
292
 
 
293
        This will find all branches below the transport, including branches
 
294
        inside other branches.  Where possible, it will use
 
295
        Repository.find_branches.
 
296
 
 
297
        To list all the branches that use a particular Repository, see
 
298
        Repository.find_branches
 
299
        """
 
300
        def evaluate(bzrdir):
 
301
            try:
 
302
                repository = bzrdir.open_repository()
 
303
            except errors.NoRepositoryPresent:
 
304
                pass
 
305
            else:
 
306
                return False, (None, repository)
 
307
            try:
 
308
                branch = bzrdir.open_branch()
 
309
            except errors.NotBranchError:
 
310
                return True, (None, None)
 
311
            else:
 
312
                return True, (branch, None)
 
313
        branches = []
 
314
        for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
 
315
            if repo is not None:
 
316
                branches.extend(repo.find_branches())
 
317
            if branch is not None:
 
318
                branches.append(branch)
 
319
        return branches
 
320
 
 
321
 
 
322
    def destroy_repository(self):
 
323
        """Destroy the repository in this BzrDir"""
 
324
        raise NotImplementedError(self.destroy_repository)
208
325
 
209
326
    def create_branch(self):
210
327
        """Create a branch in this BzrDir.
211
328
 
212
 
        The bzrdirs format will control what branch format is created.
 
329
        The bzrdir's format will control what branch format is created.
213
330
        For more control see BranchFormatXX.create(a_bzrdir).
214
331
        """
215
332
        raise NotImplementedError(self.create_branch)
216
333
 
 
334
    def destroy_branch(self):
 
335
        """Destroy the branch in this BzrDir"""
 
336
        raise NotImplementedError(self.destroy_branch)
 
337
 
217
338
    @staticmethod
218
 
    def create_branch_and_repo(base, force_new_repo=False):
 
339
    def create_branch_and_repo(base, force_new_repo=False, format=None):
219
340
        """Create a new BzrDir, Branch and Repository at the url 'base'.
220
341
 
221
 
        This will use the current default BzrDirFormat, and use whatever 
 
342
        This will use the current default BzrDirFormat unless one is
 
343
        specified, and use whatever 
222
344
        repository format that that uses via bzrdir.create_branch and
223
345
        create_repository. If a shared repository is available that is used
224
346
        preferentially.
227
349
 
228
350
        :param base: The URL to create the branch at.
229
351
        :param force_new_repo: If True a new repository is always created.
 
352
        :param format: If supplied, the format of branch to create.  If not
 
353
            supplied, the default is used.
230
354
        """
231
 
        bzrdir = BzrDir.create(base)
 
355
        bzrdir = BzrDir.create(base, format)
232
356
        bzrdir._find_or_create_repository(force_new_repo)
233
357
        return bzrdir.create_branch()
234
358
 
243
367
        
244
368
    @staticmethod
245
369
    def create_branch_convenience(base, force_new_repo=False,
246
 
                                  force_new_tree=None, format=None):
 
370
                                  force_new_tree=None, format=None,
 
371
                                  possible_transports=None):
247
372
        """Create a new BzrDir, Branch and Repository at the url 'base'.
248
373
 
249
374
        This is a convenience function - it will use an existing repository
250
375
        if possible, can be told explicitly whether to create a working tree or
251
376
        not.
252
377
 
253
 
        This will use the current default BzrDirFormat, and use whatever 
 
378
        This will use the current default BzrDirFormat unless one is
 
379
        specified, and use whatever 
254
380
        repository format that that uses via bzrdir.create_branch and
255
381
        create_repository. If a shared repository is available that is used
256
382
        preferentially. Whatever repository is used, its tree creation policy
265
391
        :param force_new_repo: If True a new repository is always created.
266
392
        :param force_new_tree: If True or False force creation of a tree or 
267
393
                               prevent such creation respectively.
268
 
        :param format: Override for the for the bzrdir format to create
 
394
        :param format: Override for the bzrdir format to create.
 
395
        :param possible_transports: An optional reusable transports list.
269
396
        """
270
397
        if force_new_tree:
271
398
            # check for non local urls
272
 
            t = get_transport(safe_unicode(base))
 
399
            t = get_transport(base, possible_transports)
273
400
            if not isinstance(t, LocalTransport):
274
401
                raise errors.NotLocalUrl(base)
275
 
        if format is None:
276
 
            bzrdir = BzrDir.create(base)
277
 
        else:
278
 
            bzrdir = format.initialize(base)
 
402
        bzrdir = BzrDir.create(base, format, possible_transports)
279
403
        repo = bzrdir._find_or_create_repository(force_new_repo)
280
404
        result = bzrdir.create_branch()
281
 
        if force_new_tree or (repo.make_working_trees() and 
 
405
        if force_new_tree or (repo.make_working_trees() and
282
406
                              force_new_tree is None):
283
407
            try:
284
408
                bzrdir.create_workingtree()
285
409
            except errors.NotLocalUrl:
286
410
                pass
287
411
        return result
288
 
        
 
412
 
289
413
    @staticmethod
290
 
    def create_repository(base, shared=False):
 
414
    @deprecated_function(zero_ninetyone)
 
415
    def create_repository(base, shared=False, format=None):
291
416
        """Create a new BzrDir and Repository at the url 'base'.
292
417
 
293
 
        This will use the current default BzrDirFormat, and use whatever 
294
 
        repository format that that uses for bzrdirformat.create_repository.
 
418
        If no format is supplied, this will default to the current default
 
419
        BzrDirFormat by default, and use whatever repository format that that
 
420
        uses for bzrdirformat.create_repository.
295
421
 
296
 
        ;param shared: Create a shared repository rather than a standalone
 
422
        :param shared: Create a shared repository rather than a standalone
297
423
                       repository.
298
424
        The Repository object is returned.
299
425
 
300
426
        This must be overridden as an instance method in child classes, where
301
427
        it should take no parameters and construct whatever repository format
302
428
        that child class desires.
 
429
 
 
430
        This method is deprecated, please call create_repository on a bzrdir
 
431
        instance instead.
303
432
        """
304
 
        bzrdir = BzrDir.create(base)
305
 
        return bzrdir.create_repository()
 
433
        bzrdir = BzrDir.create(base, format)
 
434
        return bzrdir.create_repository(shared)
306
435
 
307
436
    @staticmethod
308
 
    def create_standalone_workingtree(base):
 
437
    def create_standalone_workingtree(base, format=None):
309
438
        """Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
310
439
 
311
440
        'base' must be a local path or a file:// url.
312
441
 
313
 
        This will use the current default BzrDirFormat, and use whatever 
 
442
        This will use the current default BzrDirFormat unless one is
 
443
        specified, and use whatever 
314
444
        repository format that that uses for bzrdirformat.create_workingtree,
315
445
        create_branch and create_repository.
316
446
 
317
 
        The WorkingTree object is returned.
 
447
        :param format: Override for the bzrdir format to create.
 
448
        :return: The WorkingTree object.
318
449
        """
319
 
        t = get_transport(safe_unicode(base))
 
450
        t = get_transport(base)
320
451
        if not isinstance(t, LocalTransport):
321
452
            raise errors.NotLocalUrl(base)
322
 
        bzrdir = BzrDir.create_branch_and_repo(safe_unicode(base),
323
 
                                               force_new_repo=True).bzrdir
 
453
        bzrdir = BzrDir.create_branch_and_repo(base,
 
454
                                               force_new_repo=True,
 
455
                                               format=format).bzrdir
324
456
        return bzrdir.create_workingtree()
325
457
 
326
 
    def create_workingtree(self, revision_id=None):
 
458
    def create_workingtree(self, revision_id=None, from_branch=None,
 
459
        accelerator_tree=None):
327
460
        """Create a working tree at this BzrDir.
328
461
        
329
 
        revision_id: create it as of this revision id.
 
462
        :param revision_id: create it as of this revision id.
 
463
        :param from_branch: override bzrdir branch (for lightweight checkouts)
 
464
        :param accelerator_tree: A tree which can be used for retrieving file
 
465
            contents more quickly than the revision tree, i.e. a workingtree.
 
466
            The revision tree will be used for cases where accelerator_tree's
 
467
            content is different.
330
468
        """
331
469
        raise NotImplementedError(self.create_workingtree)
332
470
 
 
471
    def retire_bzrdir(self, limit=10000):
 
472
        """Permanently disable the bzrdir.
 
473
 
 
474
        This is done by renaming it to give the user some ability to recover
 
475
        if there was a problem.
 
476
 
 
477
        This will have horrible consequences if anyone has anything locked or
 
478
        in use.
 
479
        :param limit: number of times to retry
 
480
        """
 
481
        i  = 0
 
482
        while True:
 
483
            try:
 
484
                to_path = '.bzr.retired.%d' % i
 
485
                self.root_transport.rename('.bzr', to_path)
 
486
                note("renamed %s to %s"
 
487
                    % (self.root_transport.abspath('.bzr'), to_path))
 
488
                return
 
489
            except (errors.TransportError, IOError, errors.PathError):
 
490
                i += 1
 
491
                if i > limit:
 
492
                    raise
 
493
                else:
 
494
                    pass
 
495
 
 
496
    def destroy_workingtree(self):
 
497
        """Destroy the working tree at this BzrDir.
 
498
 
 
499
        Formats that do not support this may raise UnsupportedOperation.
 
500
        """
 
501
        raise NotImplementedError(self.destroy_workingtree)
 
502
 
 
503
    def destroy_workingtree_metadata(self):
 
504
        """Destroy the control files for the working tree at this BzrDir.
 
505
 
 
506
        The contents of working tree files are not affected.
 
507
        Formats that do not support this may raise UnsupportedOperation.
 
508
        """
 
509
        raise NotImplementedError(self.destroy_workingtree_metadata)
 
510
 
333
511
    def find_repository(self):
334
 
        """Find the repository that should be used for a_bzrdir.
 
512
        """Find the repository that should be used.
335
513
 
336
514
        This does not require a branch as we use it to find the repo for
337
515
        new branches as well as to hook existing branches up to their
343
521
            pass
344
522
        next_transport = self.root_transport.clone('..')
345
523
        while True:
 
524
            # find the next containing bzrdir
346
525
            try:
347
526
                found_bzrdir = BzrDir.open_containing_from_transport(
348
527
                    next_transport)[0]
349
528
            except errors.NotBranchError:
 
529
                # none found
350
530
                raise errors.NoRepositoryPresent(self)
 
531
            # does it have a repository ?
351
532
            try:
352
533
                repository = found_bzrdir.open_repository()
353
534
            except errors.NoRepositoryPresent:
354
535
                next_transport = found_bzrdir.root_transport.clone('..')
355
 
                continue
356
 
            if ((found_bzrdir.root_transport.base == 
 
536
                if (found_bzrdir.root_transport.base == next_transport.base):
 
537
                    # top of the file system
 
538
                    break
 
539
                else:
 
540
                    continue
 
541
            if ((found_bzrdir.root_transport.base ==
357
542
                 self.root_transport.base) or repository.is_shared()):
358
543
                return repository
359
544
            else:
360
545
                raise errors.NoRepositoryPresent(self)
361
546
        raise errors.NoRepositoryPresent(self)
362
547
 
 
548
    def get_branch_reference(self):
 
549
        """Return the referenced URL for the branch in this bzrdir.
 
550
 
 
551
        :raises NotBranchError: If there is no Branch.
 
552
        :return: The URL the branch in this bzrdir references if it is a
 
553
            reference branch, or None for regular branches.
 
554
        """
 
555
        return None
 
556
 
363
557
    def get_branch_transport(self, branch_format):
364
558
        """Get the transport for use by branch format in this BzrDir.
365
559
 
366
560
        Note that bzr dirs that do not support format strings will raise
367
561
        IncompatibleFormat if the branch format they are given has
368
 
        a format string, and vice verca.
 
562
        a format string, and vice versa.
369
563
 
370
564
        If branch_format is None, the transport is returned with no 
371
 
        checking. if it is not None, then the returned transport is
 
565
        checking. If it is not None, then the returned transport is
372
566
        guaranteed to point to an existing directory ready for use.
373
567
        """
374
568
        raise NotImplementedError(self.get_branch_transport)
378
572
 
379
573
        Note that bzr dirs that do not support format strings will raise
380
574
        IncompatibleFormat if the repository format they are given has
381
 
        a format string, and vice verca.
 
575
        a format string, and vice versa.
382
576
 
383
577
        If repository_format is None, the transport is returned with no 
384
 
        checking. if it is not None, then the returned transport is
 
578
        checking. If it is not None, then the returned transport is
385
579
        guaranteed to point to an existing directory ready for use.
386
580
        """
387
581
        raise NotImplementedError(self.get_repository_transport)
390
584
        """Get the transport for use by workingtree format in this BzrDir.
391
585
 
392
586
        Note that bzr dirs that do not support format strings will raise
393
 
        IncompatibleFormat if the workingtree format they are given has
394
 
        a format string, and vice verca.
 
587
        IncompatibleFormat if the workingtree format they are given has a
 
588
        format string, and vice versa.
395
589
 
396
590
        If workingtree_format is None, the transport is returned with no 
397
 
        checking. if it is not None, then the returned transport is
 
591
        checking. If it is not None, then the returned transport is
398
592
        guaranteed to point to an existing directory ready for use.
399
593
        """
400
594
        raise NotImplementedError(self.get_workingtree_transport)
426
620
        # this might be better on the BzrDirFormat class because it refers to 
427
621
        # all the possible bzrdir disk formats. 
428
622
        # This method is tested via the workingtree is_control_filename tests- 
429
 
        # it was extractd from WorkingTree.is_control_filename. If the methods
430
 
        # contract is extended beyond the current trivial  implementation please
 
623
        # it was extracted from WorkingTree.is_control_filename. If the method's
 
624
        # contract is extended beyond the current trivial implementation, please
431
625
        # add new tests for it to the appropriate place.
432
626
        return filename == '.bzr' or filename.startswith('.bzr/')
433
627
 
448
642
        return BzrDir.open(base, _unsupported=True)
449
643
        
450
644
    @staticmethod
451
 
    def open(base, _unsupported=False):
452
 
        """Open an existing bzrdir, rooted at 'base' (url)
 
645
    def open(base, _unsupported=False, possible_transports=None):
 
646
        """Open an existing bzrdir, rooted at 'base' (url).
453
647
        
454
 
        _unsupported is a private parameter to the BzrDir class.
455
 
        """
456
 
        t = get_transport(base)
457
 
        mutter("trying to open %r with transport %r", base, t)
458
 
        format = BzrDirFormat.find_format(t)
 
648
        :param _unsupported: a private parameter to the BzrDir class.
 
649
        """
 
650
        t = get_transport(base, possible_transports=possible_transports)
 
651
        return BzrDir.open_from_transport(t, _unsupported=_unsupported)
 
652
 
 
653
    @staticmethod
 
654
    def open_from_transport(transport, _unsupported=False,
 
655
                            _server_formats=True):
 
656
        """Open a bzrdir within a particular directory.
 
657
 
 
658
        :param transport: Transport containing the bzrdir.
 
659
        :param _unsupported: private.
 
660
        """
 
661
        base = transport.base
 
662
 
 
663
        def find_format(transport):
 
664
            return transport, BzrDirFormat.find_format(
 
665
                transport, _server_formats=_server_formats)
 
666
 
 
667
        def redirected(transport, e, redirection_notice):
 
668
            qualified_source = e.get_source_url()
 
669
            relpath = transport.relpath(qualified_source)
 
670
            if not e.target.endswith(relpath):
 
671
                # Not redirected to a branch-format, not a branch
 
672
                raise errors.NotBranchError(path=e.target)
 
673
            target = e.target[:-len(relpath)]
 
674
            note('%s is%s redirected to %s',
 
675
                 transport.base, e.permanently, target)
 
676
            # Let's try with a new transport
 
677
            # FIXME: If 'transport' has a qualifier, this should
 
678
            # be applied again to the new transport *iff* the
 
679
            # schemes used are the same. Uncomment this code
 
680
            # once the function (and tests) exist.
 
681
            # -- vila20070212
 
682
            #target = urlutils.copy_url_qualifiers(original, target)
 
683
            return get_transport(target)
 
684
 
 
685
        try:
 
686
            transport, format = do_catching_redirections(find_format,
 
687
                                                         transport,
 
688
                                                         redirected)
 
689
        except errors.TooManyRedirections:
 
690
            raise errors.NotBranchError(base)
 
691
 
459
692
        BzrDir._check_supported(format, _unsupported)
460
 
        return format.open(t, _found=True)
 
693
        return format.open(transport, _found=True)
461
694
 
462
695
    def open_branch(self, unsupported=False):
463
696
        """Open the branch object at this BzrDir if one is present.
470
703
        raise NotImplementedError(self.open_branch)
471
704
 
472
705
    @staticmethod
473
 
    def open_containing(url):
 
706
    def open_containing(url, possible_transports=None):
474
707
        """Open an existing branch which contains url.
475
708
        
476
709
        :param url: url to search from.
477
710
        See open_containing_from_transport for more detail.
478
711
        """
479
 
        return BzrDir.open_containing_from_transport(get_transport(url))
 
712
        transport = get_transport(url, possible_transports)
 
713
        return BzrDir.open_containing_from_transport(transport)
480
714
    
481
715
    @staticmethod
482
716
    def open_containing_from_transport(a_transport):
483
 
        """Open an existing branch which contains a_transport.base
 
717
        """Open an existing branch which contains a_transport.base.
484
718
 
485
719
        This probes for a branch at a_transport, and searches upwards from there.
486
720
 
489
723
        If there is one and it is either an unrecognised format or an unsupported 
490
724
        format, UnknownFormatError or UnsupportedFormatError are raised.
491
725
        If there is one, it is returned, along with the unused portion of url.
 
726
 
 
727
        :return: The BzrDir that contains the path, and a Unicode path 
 
728
                for the rest of the URL.
492
729
        """
493
730
        # this gets the normalised url back. I.e. '.' -> the full path.
494
731
        url = a_transport.base
495
732
        while True:
496
733
            try:
497
 
                format = BzrDirFormat.find_format(a_transport)
498
 
                BzrDir._check_supported(format, False)
499
 
                return format.open(a_transport), a_transport.relpath(url)
 
734
                result = BzrDir.open_from_transport(a_transport)
 
735
                return result, urlutils.unescape(a_transport.relpath(url))
500
736
            except errors.NotBranchError, e:
501
 
                mutter('not a branch in: %r %s', a_transport.base, e)
502
 
            new_t = a_transport.clone('..')
 
737
                pass
 
738
            try:
 
739
                new_t = a_transport.clone('..')
 
740
            except errors.InvalidURLJoin:
 
741
                # reached the root, whatever that may be
 
742
                raise errors.NotBranchError(path=url)
503
743
            if new_t.base == a_transport.base:
504
744
                # reached the root, whatever that may be
505
745
                raise errors.NotBranchError(path=url)
506
746
            a_transport = new_t
507
747
 
 
748
    def _get_tree_branch(self):
 
749
        """Return the branch and tree, if any, for this bzrdir.
 
750
 
 
751
        Return None for tree if not present.
 
752
        Raise NotBranchError if no branch is present.
 
753
        :return: (tree, branch)
 
754
        """
 
755
        try:
 
756
            tree = self.open_workingtree()
 
757
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
758
            tree = None
 
759
            branch = self.open_branch()
 
760
        else:
 
761
            branch = tree.branch
 
762
        return tree, branch
 
763
 
 
764
    @classmethod
 
765
    def open_tree_or_branch(klass, location):
 
766
        """Return the branch and working tree at a location.
 
767
 
 
768
        If there is no tree at the location, tree will be None.
 
769
        If there is no branch at the location, an exception will be
 
770
        raised
 
771
        :return: (tree, branch)
 
772
        """
 
773
        bzrdir = klass.open(location)
 
774
        return bzrdir._get_tree_branch()
 
775
 
 
776
    @classmethod
 
777
    def open_containing_tree_or_branch(klass, location):
 
778
        """Return the branch and working tree contained by a location.
 
779
 
 
780
        Returns (tree, branch, relpath).
 
781
        If there is no tree at containing the location, tree will be None.
 
782
        If there is no branch containing the location, an exception will be
 
783
        raised
 
784
        relpath is the portion of the path that is contained by the branch.
 
785
        """
 
786
        bzrdir, relpath = klass.open_containing(location)
 
787
        tree, branch = bzrdir._get_tree_branch()
 
788
        return tree, branch, relpath
 
789
 
508
790
    def open_repository(self, _unsupported=False):
509
791
        """Open the repository object at this BzrDir if one is present.
510
792
 
511
 
        This will not follow the Branch object pointer - its strictly a direct
 
793
        This will not follow the Branch object pointer - it's strictly a direct
512
794
        open facility. Most client code should use open_branch().repository to
513
795
        get at a repository.
514
796
 
515
 
        _unsupported is a private parameter, not part of the api.
 
797
        :param _unsupported: a private parameter, not part of the api.
516
798
        TODO: static convenience version of this?
517
799
        """
518
800
        raise NotImplementedError(self.open_repository)
519
801
 
520
 
    def open_workingtree(self, _unsupported=False):
 
802
    def open_workingtree(self, _unsupported=False,
 
803
                         recommend_upgrade=True, from_branch=None):
521
804
        """Open the workingtree object at this BzrDir if one is present.
522
 
        
523
 
        TODO: static convenience version of this?
 
805
 
 
806
        :param recommend_upgrade: Optional keyword parameter, when True (the
 
807
            default), emit through the ui module a recommendation that the user
 
808
            upgrade the working tree when the workingtree being opened is old
 
809
            (but still fully supported).
 
810
        :param from_branch: override bzrdir branch (for lightweight checkouts)
524
811
        """
525
812
        raise NotImplementedError(self.open_workingtree)
526
813
 
548
835
        workingtree and discards it, and that's somewhat expensive.) 
549
836
        """
550
837
        try:
551
 
            self.open_workingtree()
 
838
            self.open_workingtree(recommend_upgrade=False)
552
839
            return True
553
840
        except errors.NoWorkingTree:
554
841
            return False
555
842
 
556
 
    def sprout(self, url, revision_id=None, basis=None, force_new_repo=False):
 
843
    def _cloning_metadir(self):
 
844
        """Produce a metadir suitable for cloning with."""
 
845
        result_format = self._format.__class__()
 
846
        try:
 
847
            try:
 
848
                branch = self.open_branch()
 
849
                source_repository = branch.repository
 
850
            except errors.NotBranchError:
 
851
                source_branch = None
 
852
                source_repository = self.open_repository()
 
853
        except errors.NoRepositoryPresent:
 
854
            source_repository = None
 
855
        else:
 
856
            # XXX TODO: This isinstance is here because we have not implemented
 
857
            # the fix recommended in bug # 103195 - to delegate this choice the
 
858
            # repository itself.
 
859
            repo_format = source_repository._format
 
860
            if not isinstance(repo_format, remote.RemoteRepositoryFormat):
 
861
                result_format.repository_format = repo_format
 
862
        try:
 
863
            # TODO: Couldn't we just probe for the format in these cases,
 
864
            # rather than opening the whole tree?  It would be a little
 
865
            # faster. mbp 20070401
 
866
            tree = self.open_workingtree(recommend_upgrade=False)
 
867
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
868
            result_format.workingtree_format = None
 
869
        else:
 
870
            result_format.workingtree_format = tree._format.__class__()
 
871
        return result_format, source_repository
 
872
 
 
873
    def cloning_metadir(self):
 
874
        """Produce a metadir suitable for cloning or sprouting with.
 
875
 
 
876
        These operations may produce workingtrees (yes, even though they're
 
877
        "cloning" something that doesn't have a tree), so a viable workingtree
 
878
        format must be selected.
 
879
        """
 
880
        format, repository = self._cloning_metadir()
 
881
        if format._workingtree_format is None:
 
882
            if repository is None:
 
883
                return format
 
884
            tree_format = repository._format._matchingbzrdir.workingtree_format
 
885
            format.workingtree_format = tree_format.__class__()
 
886
        return format
 
887
 
 
888
    def checkout_metadir(self):
 
889
        return self.cloning_metadir()
 
890
 
 
891
    def sprout(self, url, revision_id=None, force_new_repo=False,
 
892
               recurse='down', possible_transports=None,
 
893
               accelerator_tree=None):
557
894
        """Create a copy of this bzrdir prepared for use as a new line of
558
895
        development.
559
896
 
560
 
        If urls last component does not exist, it will be created.
 
897
        If url's last component does not exist, it will be created.
561
898
 
562
899
        Attributes related to the identity of the source branch like
563
900
        branch nickname will be cleaned, a working tree is created
566
903
 
567
904
        if revision_id is not None, then the clone operation may tune
568
905
            itself to download less data.
 
906
        :param accelerator_tree: A tree which can be used for retrieving file
 
907
            contents more quickly than the revision tree, i.e. a workingtree.
 
908
            The revision tree will be used for cases where accelerator_tree's
 
909
            content is different.
569
910
        """
570
 
        self._make_tail(url)
571
 
        result = self._format.initialize(url)
572
 
        basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
 
911
        target_transport = get_transport(url, possible_transports)
 
912
        target_transport.ensure_base()
 
913
        cloning_format = self.cloning_metadir()
 
914
        result = cloning_format.initialize_on_transport(target_transport)
573
915
        try:
574
916
            source_branch = self.open_branch()
575
917
            source_repository = source_branch.repository
578
920
            try:
579
921
                source_repository = self.open_repository()
580
922
            except errors.NoRepositoryPresent:
581
 
                # copy the entire basis one if there is one
582
 
                # but there is no repository.
583
 
                source_repository = basis_repo
 
923
                source_repository = None
584
924
        if force_new_repo:
585
925
            result_repo = None
586
926
        else:
595
935
            result.create_repository()
596
936
        elif source_repository is not None and result_repo is None:
597
937
            # have source, and want to make a new target repo
598
 
            # we dont clone the repo because that preserves attributes
599
 
            # like is_shared(), and we have not yet implemented a 
600
 
            # repository sprout().
601
 
            result_repo = result.create_repository()
602
 
        if result_repo is not None:
 
938
            result_repo = source_repository.sprout(result,
 
939
                                                   revision_id=revision_id)
 
940
        else:
603
941
            # fetch needed content into target.
604
 
            if basis_repo:
605
 
                # XXX FIXME RBC 20060214 need tests for this when the basis
606
 
                # is incomplete
607
 
                result_repo.fetch(basis_repo, revision_id=revision_id)
608
 
            result_repo.fetch(source_repository, revision_id=revision_id)
 
942
            if source_repository is not None:
 
943
                # would rather do 
 
944
                # source_repository.copy_content_into(result_repo,
 
945
                #                                     revision_id=revision_id)
 
946
                # so we can override the copy method
 
947
                result_repo.fetch(source_repository, revision_id=revision_id)
609
948
        if source_branch is not None:
610
949
            source_branch.sprout(result, revision_id=revision_id)
611
950
        else:
612
951
            result.create_branch()
613
 
        if result_repo is None or result_repo.make_working_trees():
614
 
            result.create_workingtree()
 
952
        if isinstance(target_transport, LocalTransport) and (
 
953
            result_repo is None or result_repo.make_working_trees()):
 
954
            wt = result.create_workingtree(accelerator_tree=accelerator_tree)
 
955
            wt.lock_write()
 
956
            try:
 
957
                if wt.path2id('') is None:
 
958
                    try:
 
959
                        wt.set_root_id(self.open_workingtree.get_root_id())
 
960
                    except errors.NoWorkingTree:
 
961
                        pass
 
962
            finally:
 
963
                wt.unlock()
 
964
        else:
 
965
            wt = None
 
966
        if recurse == 'down':
 
967
            if wt is not None:
 
968
                basis = wt.basis_tree()
 
969
                basis.lock_read()
 
970
                subtrees = basis.iter_references()
 
971
                recurse_branch = wt.branch
 
972
            elif source_branch is not None:
 
973
                basis = source_branch.basis_tree()
 
974
                basis.lock_read()
 
975
                subtrees = basis.iter_references()
 
976
                recurse_branch = source_branch
 
977
            else:
 
978
                subtrees = []
 
979
                basis = None
 
980
            try:
 
981
                for path, file_id in subtrees:
 
982
                    target = urlutils.join(url, urlutils.escape(path))
 
983
                    sublocation = source_branch.reference_parent(file_id, path)
 
984
                    sublocation.bzrdir.sprout(target,
 
985
                        basis.get_reference_revision(file_id, path),
 
986
                        force_new_repo=force_new_repo, recurse=recurse)
 
987
            finally:
 
988
                if basis is not None:
 
989
                    basis.unlock()
615
990
        return result
616
991
 
617
992
 
621
996
    def __init__(self, _transport, _format):
622
997
        """See BzrDir.__init__."""
623
998
        super(BzrDirPreSplitOut, self).__init__(_transport, _format)
624
 
        assert self._format._lock_class == TransportLock
 
999
        assert self._format._lock_class == lockable_files.TransportLock
625
1000
        assert self._format._lock_file_name == 'branch-lock'
626
 
        self._control_files = LockableFiles(self.get_branch_transport(None),
 
1001
        self._control_files = lockable_files.LockableFiles(
 
1002
                                            self.get_branch_transport(None),
627
1003
                                            self._format._lock_file_name,
628
1004
                                            self._format._lock_class)
629
1005
 
631
1007
        """Pre-splitout bzrdirs do not suffer from stale locks."""
632
1008
        raise NotImplementedError(self.break_lock)
633
1009
 
634
 
    def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
 
1010
    def clone(self, url, revision_id=None, force_new_repo=False):
635
1011
        """See BzrDir.clone()."""
636
1012
        from bzrlib.workingtree import WorkingTreeFormat2
637
1013
        self._make_tail(url)
638
1014
        result = self._format._initialize_for_clone(url)
639
 
        basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
640
 
        self.open_repository().clone(result, revision_id=revision_id, basis=basis_repo)
 
1015
        self.open_repository().clone(result, revision_id=revision_id)
641
1016
        from_branch = self.open_branch()
642
1017
        from_branch.clone(result, revision_id=revision_id)
643
1018
        try:
644
 
            self.open_workingtree().clone(result, basis=basis_tree)
 
1019
            self.open_workingtree().clone(result)
645
1020
        except errors.NotLocalUrl:
646
1021
            # make a new one, this format always has to have one.
647
1022
            try:
656
1031
        """See BzrDir.create_branch."""
657
1032
        return self.open_branch()
658
1033
 
 
1034
    def destroy_branch(self):
 
1035
        """See BzrDir.destroy_branch."""
 
1036
        raise errors.UnsupportedOperation(self.destroy_branch, self)
 
1037
 
659
1038
    def create_repository(self, shared=False):
660
1039
        """See BzrDir.create_repository."""
661
1040
        if shared:
662
1041
            raise errors.IncompatibleFormat('shared repository', self._format)
663
1042
        return self.open_repository()
664
1043
 
665
 
    def create_workingtree(self, revision_id=None):
 
1044
    def destroy_repository(self):
 
1045
        """See BzrDir.destroy_repository."""
 
1046
        raise errors.UnsupportedOperation(self.destroy_repository, self)
 
1047
 
 
1048
    def create_workingtree(self, revision_id=None, from_branch=None,
 
1049
                           accelerator_tree=None):
666
1050
        """See BzrDir.create_workingtree."""
667
1051
        # this looks buggy but is not -really-
 
1052
        # because this format creates the workingtree when the bzrdir is
 
1053
        # created
668
1054
        # clone and sprout will have set the revision_id
669
1055
        # and that will have set it for us, its only
670
1056
        # specific uses of create_workingtree in isolation
671
1057
        # that can do wonky stuff here, and that only
672
1058
        # happens for creating checkouts, which cannot be 
673
1059
        # done on this format anyway. So - acceptable wart.
674
 
        result = self.open_workingtree()
 
1060
        result = self.open_workingtree(recommend_upgrade=False)
675
1061
        if revision_id is not None:
676
 
            result.set_last_revision(revision_id)
 
1062
            if revision_id == _mod_revision.NULL_REVISION:
 
1063
                result.set_parent_ids([])
 
1064
            else:
 
1065
                result.set_parent_ids([revision_id])
677
1066
        return result
678
1067
 
 
1068
    def destroy_workingtree(self):
 
1069
        """See BzrDir.destroy_workingtree."""
 
1070
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
 
1071
 
 
1072
    def destroy_workingtree_metadata(self):
 
1073
        """See BzrDir.destroy_workingtree_metadata."""
 
1074
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata, 
 
1075
                                          self)
 
1076
 
679
1077
    def get_branch_transport(self, branch_format):
680
1078
        """See BzrDir.get_branch_transport()."""
681
1079
        if branch_format is None:
721
1119
        self._check_supported(format, unsupported)
722
1120
        return format.open(self, _found=True)
723
1121
 
724
 
    def sprout(self, url, revision_id=None, basis=None):
 
1122
    def sprout(self, url, revision_id=None, force_new_repo=False,
 
1123
               possible_transports=None, accelerator_tree=None):
725
1124
        """See BzrDir.sprout()."""
726
1125
        from bzrlib.workingtree import WorkingTreeFormat2
727
1126
        self._make_tail(url)
728
1127
        result = self._format._initialize_for_clone(url)
729
 
        basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
730
1128
        try:
731
 
            self.open_repository().clone(result, revision_id=revision_id, basis=basis_repo)
 
1129
            self.open_repository().clone(result, revision_id=revision_id)
732
1130
        except errors.NoRepositoryPresent:
733
1131
            pass
734
1132
        try:
736
1134
        except errors.NotBranchError:
737
1135
            pass
738
1136
        # we always want a working tree
739
 
        WorkingTreeFormat2().initialize(result)
 
1137
        WorkingTreeFormat2().initialize(result,
 
1138
                                        accelerator_tree=accelerator_tree)
740
1139
        return result
741
1140
 
742
1141
 
756
1155
 
757
1156
    def open_repository(self):
758
1157
        """See BzrDir.open_repository."""
759
 
        from bzrlib.repository import RepositoryFormat4
 
1158
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
760
1159
        return RepositoryFormat4().open(self, _found=True)
761
1160
 
762
1161
 
768
1167
 
769
1168
    def open_repository(self):
770
1169
        """See BzrDir.open_repository."""
771
 
        from bzrlib.repository import RepositoryFormat5
 
1170
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
772
1171
        return RepositoryFormat5().open(self, _found=True)
773
1172
 
774
 
    def open_workingtree(self, _unsupported=False):
 
1173
    def open_workingtree(self, _unsupported=False,
 
1174
            recommend_upgrade=True):
775
1175
        """See BzrDir.create_workingtree."""
776
1176
        from bzrlib.workingtree import WorkingTreeFormat2
777
 
        return WorkingTreeFormat2().open(self, _found=True)
 
1177
        wt_format = WorkingTreeFormat2()
 
1178
        # we don't warn here about upgrades; that ought to be handled for the
 
1179
        # bzrdir as a whole
 
1180
        return wt_format.open(self, _found=True)
778
1181
 
779
1182
 
780
1183
class BzrDir6(BzrDirPreSplitOut):
785
1188
 
786
1189
    def open_repository(self):
787
1190
        """See BzrDir.open_repository."""
788
 
        from bzrlib.repository import RepositoryFormat6
 
1191
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
789
1192
        return RepositoryFormat6().open(self, _found=True)
790
1193
 
791
 
    def open_workingtree(self, _unsupported=False):
 
1194
    def open_workingtree(self, _unsupported=False,
 
1195
        recommend_upgrade=True):
792
1196
        """See BzrDir.create_workingtree."""
 
1197
        # we don't warn here about upgrades; that ought to be handled for the
 
1198
        # bzrdir as a whole
793
1199
        from bzrlib.workingtree import WorkingTreeFormat2
794
1200
        return WorkingTreeFormat2().open(self, _found=True)
795
1201
 
809
1215
 
810
1216
    def create_branch(self):
811
1217
        """See BzrDir.create_branch."""
812
 
        from bzrlib.branch import BranchFormat
813
 
        return BranchFormat.get_default_format().initialize(self)
 
1218
        return self._format.get_branch_format().initialize(self)
 
1219
 
 
1220
    def destroy_branch(self):
 
1221
        """See BzrDir.create_branch."""
 
1222
        self.transport.delete_tree('branch')
814
1223
 
815
1224
    def create_repository(self, shared=False):
816
1225
        """See BzrDir.create_repository."""
817
1226
        return self._format.repository_format.initialize(self, shared)
818
1227
 
819
 
    def create_workingtree(self, revision_id=None):
 
1228
    def destroy_repository(self):
 
1229
        """See BzrDir.destroy_repository."""
 
1230
        self.transport.delete_tree('repository')
 
1231
 
 
1232
    def create_workingtree(self, revision_id=None, from_branch=None,
 
1233
                           accelerator_tree=None):
820
1234
        """See BzrDir.create_workingtree."""
821
 
        from bzrlib.workingtree import WorkingTreeFormat
822
 
        return WorkingTreeFormat.get_default_format().initialize(self, revision_id)
 
1235
        return self._format.workingtree_format.initialize(
 
1236
            self, revision_id, from_branch=from_branch,
 
1237
            accelerator_tree=accelerator_tree)
 
1238
 
 
1239
    def destroy_workingtree(self):
 
1240
        """See BzrDir.destroy_workingtree."""
 
1241
        wt = self.open_workingtree(recommend_upgrade=False)
 
1242
        repository = wt.branch.repository
 
1243
        empty = repository.revision_tree(_mod_revision.NULL_REVISION)
 
1244
        wt.revert(old_tree=empty)
 
1245
        self.destroy_workingtree_metadata()
 
1246
 
 
1247
    def destroy_workingtree_metadata(self):
 
1248
        self.transport.delete_tree('checkout')
 
1249
 
 
1250
    def find_branch_format(self):
 
1251
        """Find the branch 'format' for this bzrdir.
 
1252
 
 
1253
        This might be a synthetic object for e.g. RemoteBranch and SVN.
 
1254
        """
 
1255
        from bzrlib.branch import BranchFormat
 
1256
        return BranchFormat.find_format(self)
823
1257
 
824
1258
    def _get_mkdir_mode(self):
825
1259
        """Figure out the mode to use when creating a bzrdir subdir."""
826
 
        temp_control = LockableFiles(self.transport, '', TransportLock)
 
1260
        temp_control = lockable_files.LockableFiles(self.transport, '',
 
1261
                                     lockable_files.TransportLock)
827
1262
        return temp_control._dir_mode
828
1263
 
 
1264
    def get_branch_reference(self):
 
1265
        """See BzrDir.get_branch_reference()."""
 
1266
        from bzrlib.branch import BranchFormat
 
1267
        format = BranchFormat.find_format(self)
 
1268
        return format.get_reference(self)
 
1269
 
829
1270
    def get_branch_transport(self, branch_format):
830
1271
        """See BzrDir.get_branch_transport()."""
831
1272
        if branch_format is None:
883
1324
                return True
884
1325
        except errors.NoRepositoryPresent:
885
1326
            pass
886
 
        # currently there are no other possible conversions for meta1 formats.
 
1327
        try:
 
1328
            if not isinstance(self.open_branch()._format,
 
1329
                              format.get_branch_format().__class__):
 
1330
                # the branch needs an upgrade.
 
1331
                return True
 
1332
        except errors.NotBranchError:
 
1333
            pass
 
1334
        try:
 
1335
            my_wt = self.open_workingtree(recommend_upgrade=False)
 
1336
            if not isinstance(my_wt._format,
 
1337
                              format.workingtree_format.__class__):
 
1338
                # the workingtree needs an upgrade.
 
1339
                return True
 
1340
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
1341
            pass
887
1342
        return False
888
1343
 
889
1344
    def open_branch(self, unsupported=False):
890
1345
        """See BzrDir.open_branch."""
891
 
        from bzrlib.branch import BranchFormat
892
 
        format = BranchFormat.find_format(self)
 
1346
        format = self.find_branch_format()
893
1347
        self._check_supported(format, unsupported)
894
1348
        return format.open(self, _found=True)
895
1349
 
900
1354
        self._check_supported(format, unsupported)
901
1355
        return format.open(self, _found=True)
902
1356
 
903
 
    def open_workingtree(self, unsupported=False):
 
1357
    def open_workingtree(self, unsupported=False,
 
1358
            recommend_upgrade=True):
904
1359
        """See BzrDir.open_workingtree."""
905
1360
        from bzrlib.workingtree import WorkingTreeFormat
906
1361
        format = WorkingTreeFormat.find_format(self)
907
 
        self._check_supported(format, unsupported)
 
1362
        self._check_supported(format, unsupported,
 
1363
            recommend_upgrade,
 
1364
            basedir=self.root_transport.base)
908
1365
        return format.open(self, _found=True)
909
1366
 
910
1367
 
916
1373
     * a format string,
917
1374
     * an open routine.
918
1375
 
919
 
    Formats are placed in an dict by their format string for reference 
 
1376
    Formats are placed in a dict by their format string for reference 
920
1377
    during bzrdir opening. These should be subclasses of BzrDirFormat
921
1378
    for consistency.
922
1379
 
931
1388
    _formats = {}
932
1389
    """The known formats."""
933
1390
 
 
1391
    _control_formats = []
 
1392
    """The registered control formats - .bzr, ....
 
1393
    
 
1394
    This is a list of BzrDirFormat objects.
 
1395
    """
 
1396
 
 
1397
    _control_server_formats = []
 
1398
    """The registered control server formats, e.g. RemoteBzrDirs.
 
1399
 
 
1400
    This is a list of BzrDirFormat objects.
 
1401
    """
 
1402
 
934
1403
    _lock_file_name = 'branch-lock'
935
1404
 
936
1405
    # _lock_class must be set in subclasses to the lock type, typ.
937
1406
    # TransportLock or LockDir
938
1407
 
939
1408
    @classmethod
940
 
    def find_format(klass, transport):
941
 
        """Return the format registered for URL."""
 
1409
    def find_format(klass, transport, _server_formats=True):
 
1410
        """Return the format present at transport."""
 
1411
        if _server_formats:
 
1412
            formats = klass._control_server_formats + klass._control_formats
 
1413
        else:
 
1414
            formats = klass._control_formats
 
1415
        for format in formats:
 
1416
            try:
 
1417
                return format.probe_transport(transport)
 
1418
            except errors.NotBranchError:
 
1419
                # this format does not find a control dir here.
 
1420
                pass
 
1421
        raise errors.NotBranchError(path=transport.base)
 
1422
 
 
1423
    @classmethod
 
1424
    def probe_transport(klass, transport):
 
1425
        """Return the .bzrdir style format present in a directory."""
942
1426
        try:
943
1427
            format_string = transport.get(".bzr/branch-format").read()
 
1428
        except errors.NoSuchFile:
 
1429
            raise errors.NotBranchError(path=transport.base)
 
1430
 
 
1431
        try:
944
1432
            return klass._formats[format_string]
945
 
        except errors.NoSuchFile:
946
 
            raise errors.NotBranchError(path=transport.base)
947
1433
        except KeyError:
948
 
            raise errors.UnknownFormatError(format_string)
 
1434
            raise errors.UnknownFormatError(format=format_string)
949
1435
 
950
1436
    @classmethod
951
1437
    def get_default_format(klass):
966
1452
        This returns a bzrlib.bzrdir.Converter object.
967
1453
 
968
1454
        This should return the best upgrader to step this format towards the
969
 
        current default format. In the case of plugins we can/shouold provide
 
1455
        current default format. In the case of plugins we can/should provide
970
1456
        some means for them to extend the range of returnable converters.
971
1457
 
972
 
        :param format: Optional format to override the default foramt of the 
 
1458
        :param format: Optional format to override the default format of the 
973
1459
                       library.
974
1460
        """
975
1461
        raise NotImplementedError(self.get_converter)
976
1462
 
977
 
    def initialize(self, url):
 
1463
    def initialize(self, url, possible_transports=None):
978
1464
        """Create a bzr control dir at this url and return an opened copy.
979
1465
        
980
1466
        Subclasses should typically override initialize_on_transport
981
1467
        instead of this method.
982
1468
        """
983
 
        return self.initialize_on_transport(get_transport(url))
 
1469
        return self.initialize_on_transport(get_transport(url,
 
1470
                                                          possible_transports))
984
1471
 
985
1472
    def initialize_on_transport(self, transport):
986
1473
        """Initialize a new bzrdir in the base directory of a Transport."""
987
 
        # Since we don'transport have a .bzr directory, inherit the
 
1474
        # Since we don't have a .bzr directory, inherit the
988
1475
        # mode from the root directory
989
 
        temp_control = LockableFiles(transport, '', TransportLock)
 
1476
        temp_control = lockable_files.LockableFiles(transport,
 
1477
                            '', lockable_files.TransportLock)
990
1478
        temp_control._transport.mkdir('.bzr',
991
 
                                      # FIXME: RBC 20060121 dont peek under
 
1479
                                      # FIXME: RBC 20060121 don't peek under
992
1480
                                      # the covers
993
1481
                                      mode=temp_control._dir_mode)
 
1482
        if sys.platform == 'win32' and isinstance(transport, LocalTransport):
 
1483
            win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
994
1484
        file_mode = temp_control._file_mode
995
1485
        del temp_control
996
1486
        mutter('created control directory in ' + transport.base)
1001
1491
                      ('branch-format', self.get_format_string()),
1002
1492
                      ]
1003
1493
        # NB: no need to escape relative paths that are url safe.
1004
 
        control_files = LockableFiles(control, self._lock_file_name, 
1005
 
                                      self._lock_class)
 
1494
        control_files = lockable_files.LockableFiles(control,
 
1495
                            self._lock_file_name, self._lock_class)
1006
1496
        control_files.create_lock()
1007
1497
        control_files.lock_write()
1008
1498
        try:
1021
1511
        """
1022
1512
        return True
1023
1513
 
 
1514
    def same_model(self, target_format):
 
1515
        return (self.repository_format.rich_root_data == 
 
1516
            target_format.rich_root_data)
 
1517
 
 
1518
    @classmethod
 
1519
    def known_formats(klass):
 
1520
        """Return all the known formats.
 
1521
        
 
1522
        Concrete formats should override _known_formats.
 
1523
        """
 
1524
        # There is double indirection here to make sure that control 
 
1525
        # formats used by more than one dir format will only be probed 
 
1526
        # once. This can otherwise be quite expensive for remote connections.
 
1527
        result = set()
 
1528
        for format in klass._control_formats:
 
1529
            result.update(format._known_formats())
 
1530
        return result
 
1531
    
 
1532
    @classmethod
 
1533
    def _known_formats(klass):
 
1534
        """Return the known format instances for this control format."""
 
1535
        return set(klass._formats.values())
 
1536
 
1024
1537
    def open(self, transport, _found=False):
1025
1538
        """Return an instance of this format for the dir transport points at.
1026
1539
        
1027
1540
        _found is a private parameter, do not use it.
1028
1541
        """
1029
1542
        if not _found:
1030
 
            assert isinstance(BzrDirFormat.find_format(transport),
1031
 
                              self.__class__)
 
1543
            found_format = BzrDirFormat.find_format(transport)
 
1544
            if not isinstance(found_format, self.__class__):
 
1545
                raise AssertionError("%s was asked to open %s, but it seems to need "
 
1546
                        "format %s" 
 
1547
                        % (self, transport, found_format))
1032
1548
        return self._open(transport)
1033
1549
 
1034
1550
    def _open(self, transport):
1044
1560
        klass._formats[format.get_format_string()] = format
1045
1561
 
1046
1562
    @classmethod
 
1563
    def register_control_format(klass, format):
 
1564
        """Register a format that does not use '.bzr' for its control dir.
 
1565
 
 
1566
        TODO: This should be pulled up into a 'ControlDirFormat' base class
 
1567
        which BzrDirFormat can inherit from, and renamed to register_format 
 
1568
        there. It has been done without that for now for simplicity of
 
1569
        implementation.
 
1570
        """
 
1571
        klass._control_formats.append(format)
 
1572
 
 
1573
    @classmethod
 
1574
    def register_control_server_format(klass, format):
 
1575
        """Register a control format for client-server environments.
 
1576
 
 
1577
        These formats will be tried before ones registered with
 
1578
        register_control_format.  This gives implementations that decide to the
 
1579
        chance to grab it before anything looks at the contents of the format
 
1580
        file.
 
1581
        """
 
1582
        klass._control_server_formats.append(format)
 
1583
 
 
1584
    @classmethod
 
1585
    @symbol_versioning.deprecated_method(symbol_versioning.zero_fourteen)
1047
1586
    def set_default_format(klass, format):
 
1587
        klass._set_default_format(format)
 
1588
 
 
1589
    @classmethod
 
1590
    def _set_default_format(klass, format):
 
1591
        """Set default format (for testing behavior of defaults only)"""
1048
1592
        klass._default_format = format
1049
1593
 
1050
1594
    def __str__(self):
1051
 
        return self.get_format_string()[:-1]
 
1595
        # Trim the newline
 
1596
        return self.get_format_string().rstrip()
1052
1597
 
1053
1598
    @classmethod
1054
1599
    def unregister_format(klass, format):
1055
1600
        assert klass._formats[format.get_format_string()] is format
1056
1601
        del klass._formats[format.get_format_string()]
1057
1602
 
 
1603
    @classmethod
 
1604
    def unregister_control_format(klass, format):
 
1605
        klass._control_formats.remove(format)
 
1606
 
1058
1607
 
1059
1608
class BzrDirFormat4(BzrDirFormat):
1060
1609
    """Bzr dir format 4.
1069
1618
    removed in format 5; write support for this format has been removed.
1070
1619
    """
1071
1620
 
1072
 
    _lock_class = TransportLock
 
1621
    _lock_class = lockable_files.TransportLock
1073
1622
 
1074
1623
    def get_format_string(self):
1075
1624
        """See BzrDirFormat.get_format_string()."""
1103
1652
 
1104
1653
    def __return_repository_format(self):
1105
1654
        """Circular import protection."""
1106
 
        from bzrlib.repository import RepositoryFormat4
1107
 
        return RepositoryFormat4(self)
 
1655
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
1656
        return RepositoryFormat4()
1108
1657
    repository_format = property(__return_repository_format)
1109
1658
 
1110
1659
 
1119
1668
       Unhashed stores in the repository.
1120
1669
    """
1121
1670
 
1122
 
    _lock_class = TransportLock
 
1671
    _lock_class = lockable_files.TransportLock
1123
1672
 
1124
1673
    def get_format_string(self):
1125
1674
        """See BzrDirFormat.get_format_string()."""
1143
1692
        Except when they are being cloned.
1144
1693
        """
1145
1694
        from bzrlib.branch import BzrBranchFormat4
1146
 
        from bzrlib.repository import RepositoryFormat5
 
1695
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1147
1696
        from bzrlib.workingtree import WorkingTreeFormat2
1148
1697
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1149
1698
        RepositoryFormat5().initialize(result, _internal=True)
1150
1699
        if not _cloning:
1151
 
            BzrBranchFormat4().initialize(result)
1152
 
            WorkingTreeFormat2().initialize(result)
 
1700
            branch = BzrBranchFormat4().initialize(result)
 
1701
            try:
 
1702
                WorkingTreeFormat2().initialize(result)
 
1703
            except errors.NotLocalUrl:
 
1704
                # Even though we can't access the working tree, we need to
 
1705
                # create its control files.
 
1706
                WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1153
1707
        return result
1154
1708
 
1155
1709
    def _open(self, transport):
1158
1712
 
1159
1713
    def __return_repository_format(self):
1160
1714
        """Circular import protection."""
1161
 
        from bzrlib.repository import RepositoryFormat5
1162
 
        return RepositoryFormat5(self)
 
1715
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1716
        return RepositoryFormat5()
1163
1717
    repository_format = property(__return_repository_format)
1164
1718
 
1165
1719
 
1173
1727
     - Format 6 repositories [always]
1174
1728
    """
1175
1729
 
1176
 
    _lock_class = TransportLock
 
1730
    _lock_class = lockable_files.TransportLock
1177
1731
 
1178
1732
    def get_format_string(self):
1179
1733
        """See BzrDirFormat.get_format_string()."""
1197
1751
        Except when they are being cloned.
1198
1752
        """
1199
1753
        from bzrlib.branch import BzrBranchFormat4
1200
 
        from bzrlib.repository import RepositoryFormat6
 
1754
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1201
1755
        from bzrlib.workingtree import WorkingTreeFormat2
1202
1756
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1203
1757
        RepositoryFormat6().initialize(result, _internal=True)
1204
1758
        if not _cloning:
1205
 
            BzrBranchFormat4().initialize(result)
 
1759
            branch = BzrBranchFormat4().initialize(result)
1206
1760
            try:
1207
1761
                WorkingTreeFormat2().initialize(result)
1208
1762
            except errors.NotLocalUrl:
1209
 
                # emulate pre-check behaviour for working tree and silently 
1210
 
                # fail.
1211
 
                pass
 
1763
                # Even though we can't access the working tree, we need to
 
1764
                # create its control files.
 
1765
                WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1212
1766
        return result
1213
1767
 
1214
1768
    def _open(self, transport):
1217
1771
 
1218
1772
    def __return_repository_format(self):
1219
1773
        """Circular import protection."""
1220
 
        from bzrlib.repository import RepositoryFormat6
1221
 
        return RepositoryFormat6(self)
 
1774
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1775
        return RepositoryFormat6()
1222
1776
    repository_format = property(__return_repository_format)
1223
1777
 
1224
1778
 
1233
1787
     - Format 7 repositories [optional]
1234
1788
    """
1235
1789
 
1236
 
    _lock_class = LockDir
 
1790
    _lock_class = lockdir.LockDir
 
1791
 
 
1792
    def __init__(self):
 
1793
        self._workingtree_format = None
 
1794
        self._branch_format = None
 
1795
 
 
1796
    def __eq__(self, other):
 
1797
        if other.__class__ is not self.__class__:
 
1798
            return False
 
1799
        if other.repository_format != self.repository_format:
 
1800
            return False
 
1801
        if other.workingtree_format != self.workingtree_format:
 
1802
            return False
 
1803
        return True
 
1804
 
 
1805
    def __ne__(self, other):
 
1806
        return not self == other
 
1807
 
 
1808
    def get_branch_format(self):
 
1809
        if self._branch_format is None:
 
1810
            from bzrlib.branch import BranchFormat
 
1811
            self._branch_format = BranchFormat.get_default_format()
 
1812
        return self._branch_format
 
1813
 
 
1814
    def set_branch_format(self, format):
 
1815
        self._branch_format = format
1237
1816
 
1238
1817
    def get_converter(self, format=None):
1239
1818
        """See BzrDirFormat.get_converter()."""
1264
1843
        return RepositoryFormat.get_default_format()
1265
1844
 
1266
1845
    def __set_repository_format(self, value):
1267
 
        """Allow changint the repository format for metadir formats."""
 
1846
        """Allow changing the repository format for metadir formats."""
1268
1847
        self._repository_format = value
1269
1848
 
1270
1849
    repository_format = property(__return_repository_format, __set_repository_format)
1271
1850
 
1272
 
 
 
1851
    def __get_workingtree_format(self):
 
1852
        if self._workingtree_format is None:
 
1853
            from bzrlib.workingtree import WorkingTreeFormat
 
1854
            self._workingtree_format = WorkingTreeFormat.get_default_format()
 
1855
        return self._workingtree_format
 
1856
 
 
1857
    def __set_workingtree_format(self, wt_format):
 
1858
        self._workingtree_format = wt_format
 
1859
 
 
1860
    workingtree_format = property(__get_workingtree_format,
 
1861
                                  __set_workingtree_format)
 
1862
 
 
1863
 
 
1864
# Register bzr control format
 
1865
BzrDirFormat.register_control_format(BzrDirFormat)
 
1866
 
 
1867
# Register bzr formats
1273
1868
BzrDirFormat.register_format(BzrDirFormat4())
1274
1869
BzrDirFormat.register_format(BzrDirFormat5())
1275
1870
BzrDirFormat.register_format(BzrDirFormat6())
1276
1871
__default_format = BzrDirMetaFormat1()
1277
1872
BzrDirFormat.register_format(__default_format)
1278
 
BzrDirFormat.set_default_format(__default_format)
1279
 
 
1280
 
 
1281
 
class BzrDirTestProviderAdapter(object):
1282
 
    """A tool to generate a suite testing multiple bzrdir formats at once.
1283
 
 
1284
 
    This is done by copying the test once for each transport and injecting
1285
 
    the transport_server, transport_readonly_server, and bzrdir_format
1286
 
    classes into each copy. Each copy is also given a new id() to make it
1287
 
    easy to identify.
1288
 
    """
1289
 
 
1290
 
    def __init__(self, transport_server, transport_readonly_server, formats):
1291
 
        self._transport_server = transport_server
1292
 
        self._transport_readonly_server = transport_readonly_server
1293
 
        self._formats = formats
1294
 
    
1295
 
    def adapt(self, test):
1296
 
        result = TestSuite()
1297
 
        for format in self._formats:
1298
 
            new_test = deepcopy(test)
1299
 
            new_test.transport_server = self._transport_server
1300
 
            new_test.transport_readonly_server = self._transport_readonly_server
1301
 
            new_test.bzrdir_format = format
1302
 
            def make_new_test_id():
1303
 
                new_id = "%s(%s)" % (new_test.id(), format.__class__.__name__)
1304
 
                return lambda: new_id
1305
 
            new_test.id = make_new_test_id()
1306
 
            result.addTest(new_test)
1307
 
        return result
1308
 
 
1309
 
 
1310
 
class ScratchDir(BzrDir6):
1311
 
    """Special test class: a bzrdir that cleans up itself..
1312
 
 
1313
 
    >>> d = ScratchDir()
1314
 
    >>> base = d.transport.base
1315
 
    >>> isdir(base)
1316
 
    True
1317
 
    >>> b.transport.__del__()
1318
 
    >>> isdir(base)
1319
 
    False
1320
 
    """
1321
 
 
1322
 
    def __init__(self, files=[], dirs=[], transport=None):
1323
 
        """Make a test branch.
1324
 
 
1325
 
        This creates a temporary directory and runs init-tree in it.
1326
 
 
1327
 
        If any files are listed, they are created in the working copy.
1328
 
        """
1329
 
        if transport is None:
1330
 
            transport = bzrlib.transport.local.ScratchTransport()
1331
 
            # local import for scope restriction
1332
 
            BzrDirFormat6().initialize(transport.base)
1333
 
            super(ScratchDir, self).__init__(transport, BzrDirFormat6())
1334
 
            self.create_repository()
1335
 
            self.create_branch()
1336
 
            self.create_workingtree()
1337
 
        else:
1338
 
            super(ScratchDir, self).__init__(transport, BzrDirFormat6())
1339
 
 
1340
 
        # BzrBranch creates a clone to .bzr and then forgets about the
1341
 
        # original transport. A ScratchTransport() deletes itself and
1342
 
        # everything underneath it when it goes away, so we need to
1343
 
        # grab a local copy to prevent that from happening
1344
 
        self._transport = transport
1345
 
 
1346
 
        for d in dirs:
1347
 
            self._transport.mkdir(d)
1348
 
            
1349
 
        for f in files:
1350
 
            self._transport.put(f, 'content of %s' % f)
1351
 
 
1352
 
    def clone(self):
1353
 
        """
1354
 
        >>> orig = ScratchDir(files=["file1", "file2"])
1355
 
        >>> os.listdir(orig.base)
1356
 
        [u'.bzr', u'file1', u'file2']
1357
 
        >>> clone = orig.clone()
1358
 
        >>> if os.name != 'nt':
1359
 
        ...   os.path.samefile(orig.base, clone.base)
1360
 
        ... else:
1361
 
        ...   orig.base == clone.base
1362
 
        ...
1363
 
        False
1364
 
        >>> os.listdir(clone.base)
1365
 
        [u'.bzr', u'file1', u'file2']
1366
 
        """
1367
 
        from shutil import copytree
1368
 
        from bzrlib.osutils import mkdtemp
1369
 
        base = mkdtemp()
1370
 
        os.rmdir(base)
1371
 
        copytree(self.base, base, symlinks=True)
1372
 
        return ScratchDir(
1373
 
            transport=bzrlib.transport.local.ScratchTransport(base))
 
1873
BzrDirFormat._default_format = __default_format
1374
1874
 
1375
1875
 
1376
1876
class Converter(object):
1463
1963
        self.bzrdir.transport.delete_tree('text-store')
1464
1964
 
1465
1965
    def _convert_working_inv(self):
1466
 
        inv = serializer_v4.read_inventory(self.branch.control_files.get('inventory'))
1467
 
        new_inv_xml = serializer_v5.write_inventory_to_string(inv)
 
1966
        inv = xml4.serializer_v4.read_inventory(
 
1967
                    self.branch.control_files.get('inventory'))
 
1968
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
1468
1969
        # FIXME inventory is a working tree change.
1469
 
        self.branch.control_files.put('inventory', new_inv_xml)
 
1970
        self.branch.control_files.put('inventory', StringIO(new_inv_xml))
1470
1971
 
1471
1972
    def _write_all_weaves(self):
1472
1973
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
1496
1997
                                                      prefixed=False,
1497
1998
                                                      compressed=True))
1498
1999
        try:
1499
 
            transaction = bzrlib.transactions.WriteTransaction()
 
2000
            transaction = WriteTransaction()
1500
2001
            for i, rev_id in enumerate(self.converted_revs):
1501
2002
                self.pb.update('write revision', i, len(self.converted_revs))
1502
2003
                _revision_store.add_revision(self.revisions[rev_id], transaction)
1528
2029
    def _load_old_inventory(self, rev_id):
1529
2030
        assert rev_id not in self.converted_revs
1530
2031
        old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
1531
 
        inv = serializer_v4.read_inventory_from_string(old_inv_xml)
 
2032
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
 
2033
        inv.revision_id = rev_id
1532
2034
        rev = self.revisions[rev_id]
1533
2035
        if rev.inventory_sha1:
1534
2036
            assert rev.inventory_sha1 == sha_string(old_inv_xml), \
1538
2040
    def _load_updated_inventory(self, rev_id):
1539
2041
        assert rev_id in self.converted_revs
1540
2042
        inv_xml = self.inv_weave.get_text(rev_id)
1541
 
        inv = serializer_v5.read_inventory_from_string(inv_xml)
 
2043
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
1542
2044
        return inv
1543
2045
 
1544
2046
    def _convert_one_rev(self, rev_id):
1548
2050
        present_parents = [p for p in rev.parent_ids
1549
2051
                           if p not in self.absent_revisions]
1550
2052
        self._convert_revision_contents(rev, inv, present_parents)
1551
 
        self._store_new_weave(rev, inv, present_parents)
 
2053
        self._store_new_inv(rev, inv, present_parents)
1552
2054
        self.converted_revs.add(rev_id)
1553
2055
 
1554
 
    def _store_new_weave(self, rev, inv, present_parents):
 
2056
    def _store_new_inv(self, rev, inv, present_parents):
1555
2057
        # the XML is now updated with text versions
1556
2058
        if __debug__:
1557
 
            for file_id in inv:
1558
 
                ie = inv[file_id]
1559
 
                if ie.kind == 'root_directory':
1560
 
                    continue
1561
 
                assert hasattr(ie, 'revision'), \
 
2059
            entries = inv.iter_entries()
 
2060
            entries.next()
 
2061
            for path, ie in entries:
 
2062
                assert getattr(ie, 'revision', None) is not None, \
1562
2063
                    'no revision on {%s} in {%s}' % \
1563
2064
                    (file_id, rev.revision_id)
1564
 
        new_inv_xml = serializer_v5.write_inventory_to_string(inv)
 
2065
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
1565
2066
        new_inv_sha1 = sha_string(new_inv_xml)
1566
 
        self.inv_weave.add_lines(rev.revision_id, 
 
2067
        self.inv_weave.add_lines(rev.revision_id,
1567
2068
                                 present_parents,
1568
2069
                                 new_inv_xml.splitlines(True))
1569
2070
        rev.inventory_sha1 = new_inv_sha1
1576
2077
        mutter('converting texts of revision {%s}',
1577
2078
               rev_id)
1578
2079
        parent_invs = map(self._load_updated_inventory, present_parents)
1579
 
        for file_id in inv:
1580
 
            ie = inv[file_id]
 
2080
        entries = inv.iter_entries()
 
2081
        entries.next()
 
2082
        for path, ie in entries:
1581
2083
            self._convert_file_version(rev, ie, parent_invs)
1582
2084
 
1583
2085
    def _convert_file_version(self, rev, ie, parent_invs):
1586
2088
        The file needs to be added into the weave if it is a merge
1587
2089
        of >=2 parents or if it's changed from its parent.
1588
2090
        """
1589
 
        if ie.kind == 'root_directory':
1590
 
            return
1591
2091
        file_id = ie.file_id
1592
2092
        rev_id = rev.revision_id
1593
2093
        w = self.text_weaves.get(file_id)
1595
2095
            w = Weave(file_id)
1596
2096
            self.text_weaves[file_id] = w
1597
2097
        text_changed = False
1598
 
        previous_entries = ie.find_previous_heads(parent_invs,
1599
 
                                                  None,
1600
 
                                                  None,
1601
 
                                                  entry_vf=w)
1602
 
        for old_revision in previous_entries:
1603
 
                # if this fails, its a ghost ?
1604
 
                assert old_revision in self.converted_revs 
 
2098
        parent_candiate_entries = ie.parent_candidates(parent_invs)
 
2099
        for old_revision in parent_candiate_entries.keys():
 
2100
            # if this fails, its a ghost ?
 
2101
            assert old_revision in self.converted_revs, \
 
2102
                "Revision {%s} not in converted_revs" % old_revision
 
2103
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
 
2104
        # XXX: Note that this is unordered - and this is tolerable because 
 
2105
        # the previous code was also unordered.
 
2106
        previous_entries = dict((head, parent_candiate_entries[head]) for head
 
2107
            in heads)
1605
2108
        self.snapshot_ie(previous_entries, ie, w, rev_id)
1606
2109
        del ie.text_id
1607
2110
        assert getattr(ie, 'revision', None) is not None
1608
2111
 
 
2112
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
 
2113
    def get_parents(self, revision_ids):
 
2114
        for revision_id in revision_ids:
 
2115
            yield self.revisions[revision_id].parent_ids
 
2116
 
 
2117
    def get_parent_map(self, revision_ids):
 
2118
        """See graph._StackedParentsProvider.get_parent_map"""
 
2119
        return dict((revision_id, self.revisions[revision_id])
 
2120
                    for revision_id in revision_ids
 
2121
                     if revision_id in self.revisions)
 
2122
 
1609
2123
    def snapshot_ie(self, previous_revisions, ie, w, rev_id):
1610
2124
        # TODO: convert this logic, which is ~= snapshot to
1611
2125
        # a call to:. This needs the path figured out. rather than a work_tree
1620
2134
                ie.revision = previous_ie.revision
1621
2135
                return
1622
2136
        if ie.has_text():
1623
 
            text = self.branch.repository.text_store.get(ie.text_id)
 
2137
            text = self.branch.repository.weave_store.get(ie.text_id)
1624
2138
            file_lines = text.readlines()
1625
2139
            assert sha_strings(file_lines) == ie.text_sha1
1626
2140
            assert sum(map(len, file_lines)) == ie.text_size
1672
2186
            store_transport = self.bzrdir.transport.clone(store_name)
1673
2187
            store = TransportStore(store_transport, prefixed=True)
1674
2188
            for urlfilename in store_transport.list_dir('.'):
1675
 
                filename = urlunescape(urlfilename)
 
2189
                filename = urlutils.unescape(urlfilename)
1676
2190
                if (filename.endswith(".weave") or
1677
2191
                    filename.endswith(".gz") or
1678
2192
                    filename.endswith(".sig")):
1694
2208
 
1695
2209
    def convert(self, to_convert, pb):
1696
2210
        """See Converter.convert()."""
 
2211
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
 
2212
        from bzrlib.branch import BzrBranchFormat5
1697
2213
        self.bzrdir = to_convert
1698
2214
        self.pb = pb
1699
2215
        self.count = 0
1728
2244
        # we hard code the formats here because we are converting into
1729
2245
        # the meta format. The meta format upgrader can take this to a 
1730
2246
        # future format within each component.
1731
 
        self.put_format('repository', bzrlib.repository.RepositoryFormat7())
 
2247
        self.put_format('repository', RepositoryFormat7())
1732
2248
        for entry in repository_names:
1733
2249
            self.move_entry('repository', entry)
1734
2250
 
1735
2251
        self.step('Upgrading branch      ')
1736
2252
        self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
1737
2253
        self.make_lock('branch')
1738
 
        self.put_format('branch', bzrlib.branch.BzrBranchFormat5())
 
2254
        self.put_format('branch', BzrBranchFormat5())
1739
2255
        branch_files = [('revision-history', True),
1740
2256
                        ('branch-name', True),
1741
2257
                        ('parent', False)]
1742
2258
        for entry in branch_files:
1743
2259
            self.move_entry('branch', entry)
1744
2260
 
1745
 
        self.step('Upgrading working tree')
1746
 
        self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
1747
 
        self.make_lock('checkout')
1748
 
        self.put_format('checkout', bzrlib.workingtree.WorkingTreeFormat3())
1749
 
        self.bzrdir.transport.delete_multi(self.garbage_inventories, self.pb)
1750
2261
        checkout_files = [('pending-merges', True),
1751
2262
                          ('inventory', True),
1752
2263
                          ('stat-cache', False)]
1753
 
        for entry in checkout_files:
1754
 
            self.move_entry('checkout', entry)
1755
 
        if last_revision is not None:
1756
 
            self.bzrdir._control_files.put_utf8('checkout/last-revision',
1757
 
                                                last_revision)
1758
 
        self.bzrdir._control_files.put_utf8('branch-format', BzrDirMetaFormat1().get_format_string())
 
2264
        # If a mandatory checkout file is not present, the branch does not have
 
2265
        # a functional checkout. Do not create a checkout in the converted
 
2266
        # branch.
 
2267
        for name, mandatory in checkout_files:
 
2268
            if mandatory and name not in bzrcontents:
 
2269
                has_checkout = False
 
2270
                break
 
2271
        else:
 
2272
            has_checkout = True
 
2273
        if not has_checkout:
 
2274
            self.pb.note('No working tree.')
 
2275
            # If some checkout files are there, we may as well get rid of them.
 
2276
            for name, mandatory in checkout_files:
 
2277
                if name in bzrcontents:
 
2278
                    self.bzrdir.transport.delete(name)
 
2279
        else:
 
2280
            from bzrlib.workingtree import WorkingTreeFormat3
 
2281
            self.step('Upgrading working tree')
 
2282
            self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
 
2283
            self.make_lock('checkout')
 
2284
            self.put_format(
 
2285
                'checkout', WorkingTreeFormat3())
 
2286
            self.bzrdir.transport.delete_multi(
 
2287
                self.garbage_inventories, self.pb)
 
2288
            for entry in checkout_files:
 
2289
                self.move_entry('checkout', entry)
 
2290
            if last_revision is not None:
 
2291
                self.bzrdir._control_files.put_utf8(
 
2292
                    'checkout/last-revision', last_revision)
 
2293
        self.bzrdir._control_files.put_utf8(
 
2294
            'branch-format', BzrDirMetaFormat1().get_format_string())
1759
2295
        return BzrDir.open(self.bzrdir.root_transport.base)
1760
2296
 
1761
2297
    def make_lock(self, name):
1762
2298
        """Make a lock for the new control dir name."""
1763
2299
        self.step('Make %s lock' % name)
1764
 
        ld = LockDir(self.bzrdir.transport, 
1765
 
                     '%s/lock' % name,
1766
 
                     file_modebits=self.file_mode,
1767
 
                     dir_modebits=self.dir_mode)
 
2300
        ld = lockdir.LockDir(self.bzrdir.transport,
 
2301
                             '%s/lock' % name,
 
2302
                             file_modebits=self.file_mode,
 
2303
                             dir_modebits=self.dir_mode)
1768
2304
        ld.create()
1769
2305
 
1770
2306
    def move_entry(self, new_dir, entry):
1809
2345
                self.pb.note('starting repository conversion')
1810
2346
                converter = CopyConverter(self.target_format.repository_format)
1811
2347
                converter.convert(repo, pb)
 
2348
        try:
 
2349
            branch = self.bzrdir.open_branch()
 
2350
        except errors.NotBranchError:
 
2351
            pass
 
2352
        else:
 
2353
            # TODO: conversions of Branch and Tree should be done by
 
2354
            # InterXFormat lookups
 
2355
            # Avoid circular imports
 
2356
            from bzrlib import branch as _mod_branch
 
2357
            if (branch._format.__class__ is _mod_branch.BzrBranchFormat5 and
 
2358
                self.target_format.get_branch_format().__class__ is
 
2359
                _mod_branch.BzrBranchFormat6):
 
2360
                branch_converter = _mod_branch.Converter5to6()
 
2361
                branch_converter.convert(branch)
 
2362
        try:
 
2363
            tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
 
2364
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
2365
            pass
 
2366
        else:
 
2367
            # TODO: conversions of Branch and Tree should be done by
 
2368
            # InterXFormat lookups
 
2369
            if (isinstance(tree, workingtree.WorkingTree3) and
 
2370
                not isinstance(tree, workingtree_4.WorkingTree4) and
 
2371
                isinstance(self.target_format.workingtree_format,
 
2372
                    workingtree_4.WorkingTreeFormat4)):
 
2373
                workingtree_4.Converter3to4().convert(tree)
1812
2374
        return to_convert
 
2375
 
 
2376
 
 
2377
# This is not in remote.py because it's small, and needs to be registered.
 
2378
# Putting it in remote.py creates a circular import problem.
 
2379
# we can make it a lazy object if the control formats is turned into something
 
2380
# like a registry.
 
2381
class RemoteBzrDirFormat(BzrDirMetaFormat1):
 
2382
    """Format representing bzrdirs accessed via a smart server"""
 
2383
 
 
2384
    def get_format_description(self):
 
2385
        return 'bzr remote bzrdir'
 
2386
    
 
2387
    @classmethod
 
2388
    def probe_transport(klass, transport):
 
2389
        """Return a RemoteBzrDirFormat object if it looks possible."""
 
2390
        try:
 
2391
            client = transport.get_smart_client()
 
2392
        except (NotImplementedError, AttributeError,
 
2393
                errors.TransportNotPossible):
 
2394
            # no smart server, so not a branch for this format type.
 
2395
            raise errors.NotBranchError(path=transport.base)
 
2396
        else:
 
2397
            # Send a 'hello' request in protocol version one, and decline to
 
2398
            # open it if the server doesn't support our required version (2) so
 
2399
            # that the VFS-based transport will do it.
 
2400
            request = client.get_request()
 
2401
            smart_protocol = protocol.SmartClientRequestProtocolOne(request)
 
2402
            server_version = smart_protocol.query_version()
 
2403
            if server_version != 2:
 
2404
                raise errors.NotBranchError(path=transport.base)
 
2405
            return klass()
 
2406
 
 
2407
    def initialize_on_transport(self, transport):
 
2408
        try:
 
2409
            # hand off the request to the smart server
 
2410
            shared_medium = transport.get_shared_medium()
 
2411
        except errors.NoSmartMedium:
 
2412
            # TODO: lookup the local format from a server hint.
 
2413
            local_dir_format = BzrDirMetaFormat1()
 
2414
            return local_dir_format.initialize_on_transport(transport)
 
2415
        client = _SmartClient(shared_medium)
 
2416
        path = client.remote_path_from_transport(transport)
 
2417
        response = _SmartClient(shared_medium).call('BzrDirFormat.initialize',
 
2418
                                                    path)
 
2419
        assert response[0] in ('ok', ), 'unexpected response code %s' % (response,)
 
2420
        return remote.RemoteBzrDir(transport)
 
2421
 
 
2422
    def _open(self, transport):
 
2423
        return remote.RemoteBzrDir(transport)
 
2424
 
 
2425
    def __eq__(self, other):
 
2426
        if not isinstance(other, RemoteBzrDirFormat):
 
2427
            return False
 
2428
        return self.get_format_description() == other.get_format_description()
 
2429
 
 
2430
 
 
2431
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
 
2432
 
 
2433
 
 
2434
class BzrDirFormatInfo(object):
 
2435
 
 
2436
    def __init__(self, native, deprecated, hidden, experimental):
 
2437
        self.deprecated = deprecated
 
2438
        self.native = native
 
2439
        self.hidden = hidden
 
2440
        self.experimental = experimental
 
2441
 
 
2442
 
 
2443
class BzrDirFormatRegistry(registry.Registry):
 
2444
    """Registry of user-selectable BzrDir subformats.
 
2445
    
 
2446
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
 
2447
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
 
2448
    """
 
2449
 
 
2450
    def register_metadir(self, key,
 
2451
             repository_format, help, native=True, deprecated=False,
 
2452
             branch_format=None,
 
2453
             tree_format=None,
 
2454
             hidden=False,
 
2455
             experimental=False):
 
2456
        """Register a metadir subformat.
 
2457
 
 
2458
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
 
2459
        by the Repository format.
 
2460
 
 
2461
        :param repository_format: The fully-qualified repository format class
 
2462
            name as a string.
 
2463
        :param branch_format: Fully-qualified branch format class name as
 
2464
            a string.
 
2465
        :param tree_format: Fully-qualified tree format class name as
 
2466
            a string.
 
2467
        """
 
2468
        # This should be expanded to support setting WorkingTree and Branch
 
2469
        # formats, once BzrDirMetaFormat1 supports that.
 
2470
        def _load(full_name):
 
2471
            mod_name, factory_name = full_name.rsplit('.', 1)
 
2472
            try:
 
2473
                mod = __import__(mod_name, globals(), locals(),
 
2474
                        [factory_name])
 
2475
            except ImportError, e:
 
2476
                raise ImportError('failed to load %s: %s' % (full_name, e))
 
2477
            try:
 
2478
                factory = getattr(mod, factory_name)
 
2479
            except AttributeError:
 
2480
                raise AttributeError('no factory %s in module %r'
 
2481
                    % (full_name, mod))
 
2482
            return factory()
 
2483
 
 
2484
        def helper():
 
2485
            bd = BzrDirMetaFormat1()
 
2486
            if branch_format is not None:
 
2487
                bd.set_branch_format(_load(branch_format))
 
2488
            if tree_format is not None:
 
2489
                bd.workingtree_format = _load(tree_format)
 
2490
            if repository_format is not None:
 
2491
                bd.repository_format = _load(repository_format)
 
2492
            return bd
 
2493
        self.register(key, helper, help, native, deprecated, hidden,
 
2494
            experimental)
 
2495
 
 
2496
    def register(self, key, factory, help, native=True, deprecated=False,
 
2497
                 hidden=False, experimental=False):
 
2498
        """Register a BzrDirFormat factory.
 
2499
        
 
2500
        The factory must be a callable that takes one parameter: the key.
 
2501
        It must produce an instance of the BzrDirFormat when called.
 
2502
 
 
2503
        This function mainly exists to prevent the info object from being
 
2504
        supplied directly.
 
2505
        """
 
2506
        registry.Registry.register(self, key, factory, help, 
 
2507
            BzrDirFormatInfo(native, deprecated, hidden, experimental))
 
2508
 
 
2509
    def register_lazy(self, key, module_name, member_name, help, native=True,
 
2510
                      deprecated=False, hidden=False, experimental=False):
 
2511
        registry.Registry.register_lazy(self, key, module_name, member_name, 
 
2512
            help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
 
2513
 
 
2514
    def set_default(self, key):
 
2515
        """Set the 'default' key to be a clone of the supplied key.
 
2516
        
 
2517
        This method must be called once and only once.
 
2518
        """
 
2519
        registry.Registry.register(self, 'default', self.get(key), 
 
2520
            self.get_help(key), info=self.get_info(key))
 
2521
 
 
2522
    def set_default_repository(self, key):
 
2523
        """Set the FormatRegistry default and Repository default.
 
2524
        
 
2525
        This is a transitional method while Repository.set_default_format
 
2526
        is deprecated.
 
2527
        """
 
2528
        if 'default' in self:
 
2529
            self.remove('default')
 
2530
        self.set_default(key)
 
2531
        format = self.get('default')()
 
2532
        assert isinstance(format, BzrDirMetaFormat1)
 
2533
 
 
2534
    def make_bzrdir(self, key):
 
2535
        return self.get(key)()
 
2536
 
 
2537
    def help_topic(self, topic):
 
2538
        output = textwrap.dedent("""\
 
2539
            These formats can be used for creating branches, working trees, and
 
2540
            repositories.
 
2541
 
 
2542
            """)
 
2543
        default_realkey = None
 
2544
        default_help = self.get_help('default')
 
2545
        help_pairs = []
 
2546
        for key in self.keys():
 
2547
            if key == 'default':
 
2548
                continue
 
2549
            help = self.get_help(key)
 
2550
            if help == default_help:
 
2551
                default_realkey = key
 
2552
            else:
 
2553
                help_pairs.append((key, help))
 
2554
 
 
2555
        def wrapped(key, help, info):
 
2556
            if info.native:
 
2557
                help = '(native) ' + help
 
2558
            return ':%s:\n%s\n\n' % (key, 
 
2559
                    textwrap.fill(help, initial_indent='    ', 
 
2560
                    subsequent_indent='    '))
 
2561
        if default_realkey is not None:
 
2562
            output += wrapped(default_realkey, '(default) %s' % default_help,
 
2563
                              self.get_info('default'))
 
2564
        deprecated_pairs = []
 
2565
        experimental_pairs = []
 
2566
        for key, help in help_pairs:
 
2567
            info = self.get_info(key)
 
2568
            if info.hidden:
 
2569
                continue
 
2570
            elif info.deprecated:
 
2571
                deprecated_pairs.append((key, help))
 
2572
            elif info.experimental:
 
2573
                experimental_pairs.append((key, help))
 
2574
            else:
 
2575
                output += wrapped(key, help, info)
 
2576
        if len(experimental_pairs) > 0:
 
2577
            output += "Experimental formats are shown below.\n\n"
 
2578
            for key, help in experimental_pairs:
 
2579
                info = self.get_info(key)
 
2580
                output += wrapped(key, help, info)
 
2581
        if len(deprecated_pairs) > 0:
 
2582
            output += "Deprecated formats are shown below.\n\n"
 
2583
            for key, help in deprecated_pairs:
 
2584
                info = self.get_info(key)
 
2585
                output += wrapped(key, help, info)
 
2586
 
 
2587
        return output
 
2588
 
 
2589
 
 
2590
format_registry = BzrDirFormatRegistry()
 
2591
format_registry.register('weave', BzrDirFormat6,
 
2592
    'Pre-0.8 format.  Slower than knit and does not'
 
2593
    ' support checkouts or shared repositories.',
 
2594
    deprecated=True)
 
2595
format_registry.register_metadir('knit',
 
2596
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
2597
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
 
2598
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
2599
    tree_format='bzrlib.workingtree.WorkingTreeFormat3')
 
2600
format_registry.register_metadir('metaweave',
 
2601
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
 
2602
    'Transitional format in 0.8.  Slower than knit.',
 
2603
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
2604
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
 
2605
    deprecated=True)
 
2606
format_registry.register_metadir('dirstate',
 
2607
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
2608
    help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
 
2609
        'above when accessed over the network.',
 
2610
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
2611
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
 
2612
    # directly from workingtree_4 triggers a circular import.
 
2613
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2614
    )
 
2615
format_registry.register_metadir('dirstate-tags',
 
2616
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
2617
    help='New in 0.15: Fast local operations and improved scaling for '
 
2618
        'network operations. Additionally adds support for tags.'
 
2619
        ' Incompatible with bzr < 0.15.',
 
2620
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2621
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2622
    )
 
2623
format_registry.register_metadir('rich-root',
 
2624
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
 
2625
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
 
2626
        ' bzr < 1.0',
 
2627
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2628
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2629
    )
 
2630
format_registry.register_metadir('dirstate-with-subtree',
 
2631
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
 
2632
    help='New in 0.15: Fast local operations and improved scaling for '
 
2633
        'network operations. Additionally adds support for versioning nested '
 
2634
        'bzr branches. Incompatible with bzr < 0.15.',
 
2635
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2636
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2637
    experimental=True,
 
2638
    hidden=True,
 
2639
    )
 
2640
format_registry.register_metadir('pack-0.92',
 
2641
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
 
2642
    help='New in 0.92: Pack-based format with data compatible with '
 
2643
        'dirstate-tags format repositories. Interoperates with '
 
2644
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
 
2645
        'Previously called knitpack-experimental.  '
 
2646
        'For more information, see '
 
2647
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
 
2648
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2649
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2650
    )
 
2651
format_registry.register_metadir('pack-0.92-subtree',
 
2652
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
 
2653
    help='New in 0.92: Pack-based format with data compatible with '
 
2654
        'dirstate-with-subtree format repositories. Interoperates with '
 
2655
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
 
2656
        'Previously called knitpack-experimental.  '
 
2657
        'For more information, see '
 
2658
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
 
2659
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2660
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2661
    hidden=True,
 
2662
    experimental=True,
 
2663
    )
 
2664
format_registry.register_metadir('rich-root-pack',
 
2665
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
 
2666
    help='New in 1.0: Pack-based format with data compatible with '
 
2667
        'rich-root format repositories. Incompatible with'
 
2668
        ' bzr < 1.0',
 
2669
    branch_format='bzrlib.branch.BzrBranchFormat6',
 
2670
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2671
    )
 
2672
format_registry.set_default('pack-0.92')