/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

Implement RemoteRepository.lock_write/unlock to expect and send tokens over the
smart protocol as appropriate, so that locking operations on RemoteRepositories
work correctly.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/bzrdir.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""BzrDir logic. The BzrDir is the basic control directory used by bzr.
18
18
 
19
19
At format 7 this was split out into Branch, Repository and Checkout control
20
20
directories.
21
 
 
22
 
Note: This module has a lot of ``open`` functions/methods that return
23
 
references to in-memory objects. As a rule, there are no matching ``close``
24
 
methods. To free any associated resources, simply stop referencing the
25
 
objects returned.
26
21
"""
27
22
 
28
 
# TODO: Move old formats into a plugin to make this file smaller.
29
 
 
 
23
# TODO: remove unittest dependency; put that stuff inside the test suite
 
24
 
 
25
# TODO: Can we move specific formats into separate modules to make this file
 
26
# smaller?
 
27
 
 
28
from cStringIO import StringIO
30
29
import os
31
 
import sys
32
 
import warnings
 
30
import textwrap
33
31
 
34
32
from bzrlib.lazy_import import lazy_import
35
33
lazy_import(globals(), """
 
34
from copy import deepcopy
36
35
from stat import S_ISDIR
37
 
import textwrap
 
36
import unittest
38
37
 
39
38
import bzrlib
40
39
from bzrlib import (
41
 
    branch,
42
 
    config,
43
40
    errors,
44
 
    graph,
45
41
    lockable_files,
46
42
    lockdir,
47
 
    osutils,
 
43
    registry,
48
44
    remote,
49
 
    repository,
50
45
    revision as _mod_revision,
51
 
    ui,
 
46
    repository as _mod_repository,
 
47
    symbol_versioning,
52
48
    urlutils,
53
 
    versionedfile,
54
 
    win32utils,
55
 
    workingtree,
56
 
    workingtree_4,
57
49
    xml4,
58
50
    xml5,
59
51
    )
60
52
from bzrlib.osutils import (
 
53
    safe_unicode,
 
54
    sha_strings,
61
55
    sha_string,
62
56
    )
63
 
from bzrlib.push import (
64
 
    PushResult,
65
 
    )
66
 
from bzrlib.repofmt import pack_repo
67
 
from bzrlib.smart.client import _SmartClient
 
57
from bzrlib.smart.client import SmartClient
 
58
from bzrlib.store.revision.text import TextRevisionStore
 
59
from bzrlib.store.text import TextStore
68
60
from bzrlib.store.versioned import WeaveStore
69
61
from bzrlib.transactions import WriteTransaction
70
 
from bzrlib.transport import (
71
 
    do_catching_redirections,
72
 
    get_transport,
73
 
    local,
74
 
    )
 
62
from bzrlib.transport import get_transport
75
63
from bzrlib.weave import Weave
76
64
""")
77
65
 
78
 
from bzrlib.trace import (
79
 
    mutter,
80
 
    note,
81
 
    warning,
82
 
    )
83
 
 
84
 
from bzrlib import (
85
 
    hooks,
86
 
    registry,
87
 
    symbol_versioning,
88
 
    )
89
 
    
90
 
    
91
 
class ControlComponent(object):
92
 
    """Abstract base class for control directory components.
93
 
    
94
 
    This provides interfaces that are common across bzrdirs, 
95
 
    repositories, branches, and workingtree control directories.
96
 
    
97
 
    They all expose two urls and transports: the *user* URL is the 
98
 
    one that stops above the control directory (eg .bzr) and that 
99
 
    should normally be used in messages, and the *control* URL is
100
 
    under that in eg .bzr/checkout and is used to read the control
101
 
    files.
102
 
    
103
 
    This can be used as a mixin and is intended to fit with 
104
 
    foreign formats.
105
 
    """
106
 
    
107
 
    @property
108
 
    def control_transport(self):
109
 
        raise NotImplementedError
110
 
   
111
 
    @property
112
 
    def control_url(self):
113
 
        return self.control_transport.base
114
 
    
115
 
    @property
116
 
    def user_transport(self):
117
 
        raise NotImplementedError
118
 
        
119
 
    @property
120
 
    def user_url(self):
121
 
        return self.user_transport.base
122
 
    
123
 
 
124
 
class BzrDir(ControlComponent):
 
66
from bzrlib.trace import mutter
 
67
from bzrlib.transport.local import LocalTransport
 
68
 
 
69
 
 
70
class BzrDir(object):
125
71
    """A .bzr control diretory.
126
 
 
 
72
    
127
73
    BzrDir instances let you create or open any of the things that can be
128
74
    found within .bzr - checkouts, branches and repositories.
129
 
 
130
 
    :ivar transport:
 
75
    
 
76
    transport
131
77
        the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
132
 
    :ivar root_transport:
133
 
        a transport connected to the directory this bzr was opened from
134
 
        (i.e. the parent directory holding the .bzr directory).
135
 
 
136
 
    Everything in the bzrdir should have the same file permissions.
137
 
 
138
 
    :cvar hooks: An instance of BzrDirHooks.
 
78
    root_transport
 
79
        a transport connected to the directory this bzr was opened from.
139
80
    """
140
81
 
141
82
    def break_lock(self):
163
104
        return True
164
105
 
165
106
    def check_conversion_target(self, target_format):
166
 
        """Check that a bzrdir as a whole can be converted to a new format."""
167
 
        # The only current restriction is that the repository content can be 
168
 
        # fetched compatibly with the target.
169
107
        target_repo_format = target_format.repository_format
170
 
        try:
171
 
            self.open_repository()._format.check_conversion_target(
172
 
                target_repo_format)
173
 
        except errors.NoRepositoryPresent:
174
 
            # No repo, no problem.
175
 
            pass
 
108
        source_repo_format = self._format.repository_format
 
109
        source_repo_format.check_conversion_target(target_repo_format)
176
110
 
177
111
    @staticmethod
178
 
    def _check_supported(format, allow_unsupported,
179
 
        recommend_upgrade=True,
180
 
        basedir=None):
181
 
        """Give an error or warning on old formats.
182
 
 
183
 
        :param format: may be any kind of format - workingtree, branch,
184
 
        or repository.
185
 
 
186
 
        :param allow_unsupported: If true, allow opening
187
 
        formats that are strongly deprecated, and which may
188
 
        have limited functionality.
189
 
 
190
 
        :param recommend_upgrade: If true (default), warn
191
 
        the user through the ui object that they may wish
192
 
        to upgrade the object.
 
112
    def _check_supported(format, allow_unsupported):
 
113
        """Check whether format is a supported format.
 
114
 
 
115
        If allow_unsupported is True, this is a no-op.
193
116
        """
194
 
        # TODO: perhaps move this into a base Format class; it's not BzrDir
195
 
        # specific. mbp 20070323
196
117
        if not allow_unsupported and not format.is_supported():
197
118
            # see open_downlevel to open legacy branches.
198
119
            raise errors.UnsupportedFormatError(format=format)
199
 
        if recommend_upgrade \
200
 
            and getattr(format, 'upgrade_recommended', False):
201
 
            ui.ui_factory.recommend_upgrade(
202
 
                format.get_format_description(),
203
 
                basedir)
204
120
 
205
 
    def clone(self, url, revision_id=None, force_new_repo=False,
206
 
              preserve_stacking=False):
 
121
    def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
207
122
        """Clone this bzrdir and its contents to url verbatim.
208
123
 
209
 
        :param url: The url create the clone at.  If url's last component does
210
 
            not exist, it will be created.
211
 
        :param revision_id: The tip revision-id to use for any branch or
212
 
            working tree.  If not None, then the clone operation may tune
213
 
            itself to download less data.
214
 
        :param force_new_repo: Do not use a shared repository for the target
215
 
                               even if one is available.
216
 
        :param preserve_stacking: When cloning a stacked branch, stack the
217
 
            new branch on top of the other branch's stacked-on branch.
218
 
        """
219
 
        return self.clone_on_transport(get_transport(url),
220
 
                                       revision_id=revision_id,
221
 
                                       force_new_repo=force_new_repo,
222
 
                                       preserve_stacking=preserve_stacking)
223
 
 
224
 
    def clone_on_transport(self, transport, revision_id=None,
225
 
        force_new_repo=False, preserve_stacking=False, stacked_on=None,
226
 
        create_prefix=False, use_existing_dir=True):
227
 
        """Clone this bzrdir and its contents to transport verbatim.
228
 
 
229
 
        :param transport: The transport for the location to produce the clone
230
 
            at.  If the target directory does not exist, it will be created.
231
 
        :param revision_id: The tip revision-id to use for any branch or
232
 
            working tree.  If not None, then the clone operation may tune
233
 
            itself to download less data.
234
 
        :param force_new_repo: Do not use a shared repository for the target,
235
 
                               even if one is available.
236
 
        :param preserve_stacking: When cloning a stacked branch, stack the
237
 
            new branch on top of the other branch's stacked-on branch.
238
 
        :param create_prefix: Create any missing directories leading up to
239
 
            to_transport.
240
 
        :param use_existing_dir: Use an existing directory if one exists.
241
 
        """
242
 
        # Overview: put together a broad description of what we want to end up
243
 
        # with; then make as few api calls as possible to do it.
244
 
        
245
 
        # We may want to create a repo/branch/tree, if we do so what format
246
 
        # would we want for each:
247
 
        require_stacking = (stacked_on is not None)
248
 
        format = self.cloning_metadir(require_stacking)
249
 
        
250
 
        # Figure out what objects we want:
 
124
        If urls last component does not exist, it will be created.
 
125
 
 
126
        if revision_id is not None, then the clone operation may tune
 
127
            itself to download less data.
 
128
        :param force_new_repo: Do not use a shared repository for the target 
 
129
                               even if one is available.
 
130
        """
 
131
        self._make_tail(url)
 
132
        basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
 
133
        result = self._format.initialize(url)
251
134
        try:
252
135
            local_repo = self.find_repository()
253
136
        except errors.NoRepositoryPresent:
254
137
            local_repo = None
255
 
        try:
256
 
            local_branch = self.open_branch()
257
 
        except errors.NotBranchError:
258
 
            local_branch = None
259
 
        else:
260
 
            # enable fallbacks when branch is not a branch reference
261
 
            if local_branch.repository.has_same_location(local_repo):
262
 
                local_repo = local_branch.repository
263
 
            if preserve_stacking:
264
 
                try:
265
 
                    stacked_on = local_branch.get_stacked_on_url()
266
 
                except (errors.UnstackableBranchFormat,
267
 
                        errors.UnstackableRepositoryFormat,
268
 
                        errors.NotStacked):
269
 
                    pass
270
 
        # Bug: We create a metadir without knowing if it can support stacking,
271
 
        # we should look up the policy needs first, or just use it as a hint,
272
 
        # or something.
273
138
        if local_repo:
274
 
            make_working_trees = local_repo.make_working_trees()
275
 
            want_shared = local_repo.is_shared()
276
 
            repo_format_name = format.repository_format.network_name()
277
 
        else:
278
 
            make_working_trees = False
279
 
            want_shared = False
280
 
            repo_format_name = None
281
 
 
282
 
        result_repo, result, require_stacking, repository_policy = \
283
 
            format.initialize_on_transport_ex(transport,
284
 
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
285
 
            force_new_repo=force_new_repo, stacked_on=stacked_on,
286
 
            stack_on_pwd=self.root_transport.base,
287
 
            repo_format_name=repo_format_name,
288
 
            make_working_trees=make_working_trees, shared_repo=want_shared)
289
 
        if repo_format_name:
290
 
            try:
291
 
                # If the result repository is in the same place as the
292
 
                # resulting bzr dir, it will have no content, further if the
293
 
                # result is not stacked then we know all content should be
294
 
                # copied, and finally if we are copying up to a specific
295
 
                # revision_id then we can use the pending-ancestry-result which
296
 
                # does not require traversing all of history to describe it.
297
 
                if (result_repo.user_url == result.user_url
298
 
                    and not require_stacking and
299
 
                    revision_id is not None):
300
 
                    fetch_spec = graph.PendingAncestryResult(
301
 
                        [revision_id], local_repo)
302
 
                    result_repo.fetch(local_repo, fetch_spec=fetch_spec)
303
 
                else:
 
139
            # may need to copy content in
 
140
            if force_new_repo:
 
141
                result_repo = local_repo.clone(
 
142
                    result,
 
143
                    revision_id=revision_id,
 
144
                    basis=basis_repo)
 
145
                result_repo.set_make_working_trees(local_repo.make_working_trees())
 
146
            else:
 
147
                try:
 
148
                    result_repo = result.find_repository()
 
149
                    # fetch content this dir needs.
 
150
                    if basis_repo:
 
151
                        # XXX FIXME RBC 20060214 need tests for this when the basis
 
152
                        # is incomplete
 
153
                        result_repo.fetch(basis_repo, revision_id=revision_id)
304
154
                    result_repo.fetch(local_repo, revision_id=revision_id)
305
 
            finally:
306
 
                result_repo.unlock()
307
 
        else:
308
 
            if result_repo is not None:
309
 
                raise AssertionError('result_repo not None(%r)' % result_repo)
 
155
                except errors.NoRepositoryPresent:
 
156
                    # needed to make one anyway.
 
157
                    result_repo = local_repo.clone(
 
158
                        result,
 
159
                        revision_id=revision_id,
 
160
                        basis=basis_repo)
 
161
                    result_repo.set_make_working_trees(local_repo.make_working_trees())
310
162
        # 1 if there is a branch present
311
163
        #   make sure its content is available in the target repository
312
164
        #   clone it.
313
 
        if local_branch is not None:
314
 
            result_branch = local_branch.clone(result, revision_id=revision_id,
315
 
                repository_policy=repository_policy)
316
 
        try:
317
 
            # Cheaper to check if the target is not local, than to try making
318
 
            # the tree and fail.
319
 
            result.root_transport.local_abspath('.')
320
 
            if result_repo is None or result_repo.make_working_trees():
321
 
                self.open_workingtree().clone(result)
 
165
        try:
 
166
            self.open_branch().clone(result, revision_id=revision_id)
 
167
        except errors.NotBranchError:
 
168
            pass
 
169
        try:
 
170
            self.open_workingtree().clone(result, basis=basis_tree)
322
171
        except (errors.NoWorkingTree, errors.NotLocalUrl):
323
172
            pass
324
173
        return result
325
174
 
 
175
    def _get_basis_components(self, basis):
 
176
        """Retrieve the basis components that are available at basis."""
 
177
        if basis is None:
 
178
            return None, None, None
 
179
        try:
 
180
            basis_tree = basis.open_workingtree()
 
181
            basis_branch = basis_tree.branch
 
182
            basis_repo = basis_branch.repository
 
183
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
184
            basis_tree = None
 
185
            try:
 
186
                basis_branch = basis.open_branch()
 
187
                basis_repo = basis_branch.repository
 
188
            except errors.NotBranchError:
 
189
                basis_branch = None
 
190
                try:
 
191
                    basis_repo = basis.open_repository()
 
192
                except errors.NoRepositoryPresent:
 
193
                    basis_repo = None
 
194
        return basis_repo, basis_branch, basis_tree
 
195
 
326
196
    # TODO: This should be given a Transport, and should chdir up; otherwise
327
197
    # this will open a new connection.
328
198
    def _make_tail(self, url):
329
 
        t = get_transport(url)
330
 
        t.ensure_base()
 
199
        head, tail = urlutils.split(url)
 
200
        if tail and tail != '.':
 
201
            t = get_transport(head)
 
202
            try:
 
203
                t.mkdir(tail)
 
204
            except errors.FileExists:
 
205
                pass
331
206
 
 
207
    # TODO: Should take a Transport
332
208
    @classmethod
333
 
    def create(cls, base, format=None, possible_transports=None):
 
209
    def create(cls, base, format=None):
334
210
        """Create a new BzrDir at the url 'base'.
 
211
        
 
212
        This will call the current default formats initialize with base
 
213
        as the only parameter.
335
214
 
336
215
        :param format: If supplied, the format of branch to create.  If not
337
216
            supplied, the default is used.
338
 
        :param possible_transports: If supplied, a list of transports that
339
 
            can be reused to share a remote connection.
340
217
        """
341
218
        if cls is not BzrDir:
342
219
            raise AssertionError("BzrDir.create always creates the default"
343
220
                " format, not one of %r" % cls)
344
 
        t = get_transport(base, possible_transports)
345
 
        t.ensure_base()
 
221
        head, tail = urlutils.split(base)
 
222
        if tail and tail != '.':
 
223
            t = get_transport(head)
 
224
            try:
 
225
                t.mkdir(tail)
 
226
            except errors.FileExists:
 
227
                pass
346
228
        if format is None:
347
229
            format = BzrDirFormat.get_default_format()
348
 
        return format.initialize_on_transport(t)
349
 
 
350
 
    @staticmethod
351
 
    def find_bzrdirs(transport, evaluate=None, list_current=None):
352
 
        """Find bzrdirs recursively from current location.
353
 
 
354
 
        This is intended primarily as a building block for more sophisticated
355
 
        functionality, like finding trees under a directory, or finding
356
 
        branches that use a given repository.
357
 
        :param evaluate: An optional callable that yields recurse, value,
358
 
            where recurse controls whether this bzrdir is recursed into
359
 
            and value is the value to yield.  By default, all bzrdirs
360
 
            are recursed into, and the return value is the bzrdir.
361
 
        :param list_current: if supplied, use this function to list the current
362
 
            directory, instead of Transport.list_dir
363
 
        :return: a generator of found bzrdirs, or whatever evaluate returns.
364
 
        """
365
 
        if list_current is None:
366
 
            def list_current(transport):
367
 
                return transport.list_dir('')
368
 
        if evaluate is None:
369
 
            def evaluate(bzrdir):
370
 
                return True, bzrdir
371
 
 
372
 
        pending = [transport]
373
 
        while len(pending) > 0:
374
 
            current_transport = pending.pop()
375
 
            recurse = True
376
 
            try:
377
 
                bzrdir = BzrDir.open_from_transport(current_transport)
378
 
            except errors.NotBranchError:
379
 
                pass
380
 
            else:
381
 
                recurse, value = evaluate(bzrdir)
382
 
                yield value
383
 
            try:
384
 
                subdirs = list_current(current_transport)
385
 
            except errors.NoSuchFile:
386
 
                continue
387
 
            if recurse:
388
 
                for subdir in sorted(subdirs, reverse=True):
389
 
                    pending.append(current_transport.clone(subdir))
390
 
 
391
 
    def list_branches(self):
392
 
        """Return a sequence of all branches local to this control directory.
393
 
 
394
 
        """
395
 
        try:
396
 
            return [self.open_branch()]
397
 
        except errors.NotBranchError:
398
 
            return []
399
 
 
400
 
    @staticmethod
401
 
    def find_branches(transport):
402
 
        """Find all branches under a transport.
403
 
 
404
 
        This will find all branches below the transport, including branches
405
 
        inside other branches.  Where possible, it will use
406
 
        Repository.find_branches.
407
 
 
408
 
        To list all the branches that use a particular Repository, see
409
 
        Repository.find_branches
410
 
        """
411
 
        def evaluate(bzrdir):
412
 
            try:
413
 
                repository = bzrdir.open_repository()
414
 
            except errors.NoRepositoryPresent:
415
 
                pass
416
 
            else:
417
 
                return False, ([], repository)
418
 
            return True, (bzrdir.list_branches(), None)
419
 
        ret = []
420
 
        for branches, repo in BzrDir.find_bzrdirs(transport,
421
 
                                                  evaluate=evaluate):
422
 
            if repo is not None:
423
 
                ret.extend(repo.find_branches())
424
 
            if branches is not None:
425
 
                ret.extend(branches)
426
 
        return ret
427
 
 
428
 
    def destroy_repository(self):
429
 
        """Destroy the repository in this BzrDir"""
430
 
        raise NotImplementedError(self.destroy_repository)
431
 
 
432
 
    def create_branch(self, name=None):
 
230
        return format.initialize(safe_unicode(base))
 
231
 
 
232
    def create_branch(self):
433
233
        """Create a branch in this BzrDir.
434
234
 
435
 
        :param name: Name of the colocated branch to create, None for
436
 
            the default branch.
437
 
 
438
 
        The bzrdir's format will control what branch format is created.
 
235
        The bzrdirs format will control what branch format is created.
439
236
        For more control see BranchFormatXX.create(a_bzrdir).
440
237
        """
441
238
        raise NotImplementedError(self.create_branch)
442
239
 
443
 
    def destroy_branch(self, name=None):
444
 
        """Destroy a branch in this BzrDir.
445
 
        
446
 
        :param name: Name of the branch to destroy, None for the default 
447
 
            branch.
448
 
        """
449
 
        raise NotImplementedError(self.destroy_branch)
450
 
 
451
240
    @staticmethod
452
241
    def create_branch_and_repo(base, force_new_repo=False, format=None):
453
242
        """Create a new BzrDir, Branch and Repository at the url 'base'.
454
243
 
455
 
        This will use the current default BzrDirFormat unless one is
456
 
        specified, and use whatever
 
244
        This will use the current default BzrDirFormat, and use whatever 
457
245
        repository format that that uses via bzrdir.create_branch and
458
246
        create_repository. If a shared repository is available that is used
459
247
        preferentially.
462
250
 
463
251
        :param base: The URL to create the branch at.
464
252
        :param force_new_repo: If True a new repository is always created.
465
 
        :param format: If supplied, the format of branch to create.  If not
466
 
            supplied, the default is used.
467
253
        """
468
254
        bzrdir = BzrDir.create(base, format)
469
255
        bzrdir._find_or_create_repository(force_new_repo)
470
256
        return bzrdir.create_branch()
471
257
 
472
 
    def determine_repository_policy(self, force_new_repo=False, stack_on=None,
473
 
                                    stack_on_pwd=None, require_stacking=False):
474
 
        """Return an object representing a policy to use.
475
 
 
476
 
        This controls whether a new repository is created, and the format of
477
 
        that repository, or some existing shared repository used instead.
478
 
 
479
 
        If stack_on is supplied, will not seek a containing shared repo.
480
 
 
481
 
        :param force_new_repo: If True, require a new repository to be created.
482
 
        :param stack_on: If supplied, the location to stack on.  If not
483
 
            supplied, a default_stack_on location may be used.
484
 
        :param stack_on_pwd: If stack_on is relative, the location it is
485
 
            relative to.
486
 
        """
487
 
        def repository_policy(found_bzrdir):
488
 
            stack_on = None
489
 
            stack_on_pwd = None
490
 
            config = found_bzrdir.get_config()
491
 
            stop = False
492
 
            stack_on = config.get_default_stack_on()
493
 
            if stack_on is not None:
494
 
                stack_on_pwd = found_bzrdir.user_url
495
 
                stop = True
496
 
            # does it have a repository ?
497
 
            try:
498
 
                repository = found_bzrdir.open_repository()
499
 
            except errors.NoRepositoryPresent:
500
 
                repository = None
501
 
            else:
502
 
                if (found_bzrdir.user_url != self.user_url 
503
 
                    and not repository.is_shared()):
504
 
                    # Don't look higher, can't use a higher shared repo.
505
 
                    repository = None
506
 
                    stop = True
507
 
                else:
508
 
                    stop = True
509
 
            if not stop:
510
 
                return None, False
511
 
            if repository:
512
 
                return UseExistingRepository(repository, stack_on,
513
 
                    stack_on_pwd, require_stacking=require_stacking), True
514
 
            else:
515
 
                return CreateRepository(self, stack_on, stack_on_pwd,
516
 
                    require_stacking=require_stacking), True
517
 
 
518
 
        if not force_new_repo:
519
 
            if stack_on is None:
520
 
                policy = self._find_containing(repository_policy)
521
 
                if policy is not None:
522
 
                    return policy
523
 
            else:
524
 
                try:
525
 
                    return UseExistingRepository(self.open_repository(),
526
 
                        stack_on, stack_on_pwd,
527
 
                        require_stacking=require_stacking)
528
 
                except errors.NoRepositoryPresent:
529
 
                    pass
530
 
        return CreateRepository(self, stack_on, stack_on_pwd,
531
 
                                require_stacking=require_stacking)
532
 
 
533
258
    def _find_or_create_repository(self, force_new_repo):
534
259
        """Create a new repository if needed, returning the repository."""
535
 
        policy = self.determine_repository_policy(force_new_repo)
536
 
        return policy.acquire_repository()[0]
537
 
 
 
260
        if force_new_repo:
 
261
            return self.create_repository()
 
262
        try:
 
263
            return self.find_repository()
 
264
        except errors.NoRepositoryPresent:
 
265
            return self.create_repository()
 
266
        
538
267
    @staticmethod
539
268
    def create_branch_convenience(base, force_new_repo=False,
540
 
                                  force_new_tree=None, format=None,
541
 
                                  possible_transports=None):
 
269
                                  force_new_tree=None, format=None):
542
270
        """Create a new BzrDir, Branch and Repository at the url 'base'.
543
271
 
544
272
        This is a convenience function - it will use an existing repository
545
273
        if possible, can be told explicitly whether to create a working tree or
546
274
        not.
547
275
 
548
 
        This will use the current default BzrDirFormat unless one is
549
 
        specified, and use whatever
 
276
        This will use the current default BzrDirFormat, and use whatever 
550
277
        repository format that that uses via bzrdir.create_branch and
551
278
        create_repository. If a shared repository is available that is used
552
279
        preferentially. Whatever repository is used, its tree creation policy
554
281
 
555
282
        The created Branch object is returned.
556
283
        If a working tree cannot be made due to base not being a file:// url,
557
 
        no error is raised unless force_new_tree is True, in which case no
 
284
        no error is raised unless force_new_tree is True, in which case no 
558
285
        data is created on disk and NotLocalUrl is raised.
559
286
 
560
287
        :param base: The URL to create the branch at.
561
288
        :param force_new_repo: If True a new repository is always created.
562
 
        :param force_new_tree: If True or False force creation of a tree or
 
289
        :param force_new_tree: If True or False force creation of a tree or 
563
290
                               prevent such creation respectively.
564
 
        :param format: Override for the bzrdir format to create.
565
 
        :param possible_transports: An optional reusable transports list.
 
291
        :param format: Override for the for the bzrdir format to create
566
292
        """
567
293
        if force_new_tree:
568
294
            # check for non local urls
569
 
            t = get_transport(base, possible_transports)
570
 
            if not isinstance(t, local.LocalTransport):
 
295
            t = get_transport(safe_unicode(base))
 
296
            if not isinstance(t, LocalTransport):
571
297
                raise errors.NotLocalUrl(base)
572
 
        bzrdir = BzrDir.create(base, format, possible_transports)
 
298
        bzrdir = BzrDir.create(base, format)
573
299
        repo = bzrdir._find_or_create_repository(force_new_repo)
574
300
        result = bzrdir.create_branch()
575
 
        if force_new_tree or (repo.make_working_trees() and
 
301
        if force_new_tree or (repo.make_working_trees() and 
576
302
                              force_new_tree is None):
577
303
            try:
578
304
                bzrdir.create_workingtree()
579
305
            except errors.NotLocalUrl:
580
306
                pass
581
307
        return result
 
308
        
 
309
    @staticmethod
 
310
    def create_repository(base, shared=False, format=None):
 
311
        """Create a new BzrDir and Repository at the url 'base'.
 
312
 
 
313
        If no format is supplied, this will default to the current default
 
314
        BzrDirFormat by default, and use whatever repository format that that
 
315
        uses for bzrdirformat.create_repository.
 
316
 
 
317
        :param shared: Create a shared repository rather than a standalone
 
318
                       repository.
 
319
        The Repository object is returned.
 
320
 
 
321
        This must be overridden as an instance method in child classes, where
 
322
        it should take no parameters and construct whatever repository format
 
323
        that child class desires.
 
324
        """
 
325
        bzrdir = BzrDir.create(base, format)
 
326
        return bzrdir.create_repository(shared)
582
327
 
583
328
    @staticmethod
584
329
    def create_standalone_workingtree(base, format=None):
586
331
 
587
332
        'base' must be a local path or a file:// url.
588
333
 
589
 
        This will use the current default BzrDirFormat unless one is
590
 
        specified, and use whatever
 
334
        This will use the current default BzrDirFormat, and use whatever 
591
335
        repository format that that uses for bzrdirformat.create_workingtree,
592
336
        create_branch and create_repository.
593
337
 
594
 
        :param format: Override for the bzrdir format to create.
595
338
        :return: The WorkingTree object.
596
339
        """
597
 
        t = get_transport(base)
598
 
        if not isinstance(t, local.LocalTransport):
 
340
        t = get_transport(safe_unicode(base))
 
341
        if not isinstance(t, LocalTransport):
599
342
            raise errors.NotLocalUrl(base)
600
 
        bzrdir = BzrDir.create_branch_and_repo(base,
 
343
        bzrdir = BzrDir.create_branch_and_repo(safe_unicode(base),
601
344
                                               force_new_repo=True,
602
345
                                               format=format).bzrdir
603
346
        return bzrdir.create_workingtree()
604
347
 
605
 
    def create_workingtree(self, revision_id=None, from_branch=None,
606
 
        accelerator_tree=None, hardlink=False):
 
348
    def create_workingtree(self, revision_id=None):
607
349
        """Create a working tree at this BzrDir.
608
 
 
609
 
        :param revision_id: create it as of this revision id.
610
 
        :param from_branch: override bzrdir branch (for lightweight checkouts)
611
 
        :param accelerator_tree: A tree which can be used for retrieving file
612
 
            contents more quickly than the revision tree, i.e. a workingtree.
613
 
            The revision tree will be used for cases where accelerator_tree's
614
 
            content is different.
 
350
        
 
351
        revision_id: create it as of this revision id.
615
352
        """
616
353
        raise NotImplementedError(self.create_workingtree)
617
354
 
618
 
    def backup_bzrdir(self):
619
 
        """Backup this bzr control directory.
620
 
 
621
 
        :return: Tuple with old path name and new path name
622
 
        """
623
 
        def name_gen(base='backup.bzr'):
624
 
            counter = 1
625
 
            name = "%s.~%d~" % (base, counter)
626
 
            while self.root_transport.has(name):
627
 
                counter += 1
628
 
                name = "%s.~%d~" % (base, counter)
629
 
            return name
630
 
 
631
 
        backup_dir=name_gen()
632
 
        pb = ui.ui_factory.nested_progress_bar()
633
 
        try:
634
 
            # FIXME: bug 300001 -- the backup fails if the backup directory
635
 
            # already exists, but it should instead either remove it or make
636
 
            # a new backup directory.
637
 
            #
638
 
            old_path = self.root_transport.abspath('.bzr')
639
 
            new_path = self.root_transport.abspath(backup_dir)
640
 
            ui.ui_factory.note('making backup of %s\n  to %s' % (old_path, new_path,))
641
 
            self.root_transport.copy_tree('.bzr', backup_dir)
642
 
            return (old_path, new_path)
643
 
        finally:
644
 
            pb.finished()
645
 
 
646
 
    def retire_bzrdir(self, limit=10000):
647
 
        """Permanently disable the bzrdir.
648
 
 
649
 
        This is done by renaming it to give the user some ability to recover
650
 
        if there was a problem.
651
 
 
652
 
        This will have horrible consequences if anyone has anything locked or
653
 
        in use.
654
 
        :param limit: number of times to retry
655
 
        """
656
 
        i  = 0
657
 
        while True:
658
 
            try:
659
 
                to_path = '.bzr.retired.%d' % i
660
 
                self.root_transport.rename('.bzr', to_path)
661
 
                note("renamed %s to %s"
662
 
                    % (self.root_transport.abspath('.bzr'), to_path))
663
 
                return
664
 
            except (errors.TransportError, IOError, errors.PathError):
665
 
                i += 1
666
 
                if i > limit:
667
 
                    raise
668
 
                else:
669
 
                    pass
670
 
 
671
355
    def destroy_workingtree(self):
672
356
        """Destroy the working tree at this BzrDir.
673
357
 
683
367
        """
684
368
        raise NotImplementedError(self.destroy_workingtree_metadata)
685
369
 
686
 
    def _find_containing(self, evaluate):
687
 
        """Find something in a containing control directory.
688
 
 
689
 
        This method will scan containing control dirs, until it finds what
690
 
        it is looking for, decides that it will never find it, or runs out
691
 
        of containing control directories to check.
692
 
 
693
 
        It is used to implement find_repository and
694
 
        determine_repository_policy.
695
 
 
696
 
        :param evaluate: A function returning (value, stop).  If stop is True,
697
 
            the value will be returned.
 
370
    def find_repository(self):
 
371
        """Find the repository that should be used for a_bzrdir.
 
372
 
 
373
        This does not require a branch as we use it to find the repo for
 
374
        new branches as well as to hook existing branches up to their
 
375
        repository.
698
376
        """
699
 
        found_bzrdir = self
 
377
        try:
 
378
            return self.open_repository()
 
379
        except errors.NoRepositoryPresent:
 
380
            pass
 
381
        next_transport = self.root_transport.clone('..')
700
382
        while True:
701
 
            result, stop = evaluate(found_bzrdir)
702
 
            if stop:
703
 
                return result
704
 
            next_transport = found_bzrdir.root_transport.clone('..')
705
 
            if (found_bzrdir.user_url == next_transport.base):
706
 
                # top of the file system
707
 
                return None
708
383
            # find the next containing bzrdir
709
384
            try:
710
385
                found_bzrdir = BzrDir.open_containing_from_transport(
711
386
                    next_transport)[0]
712
387
            except errors.NotBranchError:
713
 
                return None
714
 
 
715
 
    def find_repository(self):
716
 
        """Find the repository that should be used.
717
 
 
718
 
        This does not require a branch as we use it to find the repo for
719
 
        new branches as well as to hook existing branches up to their
720
 
        repository.
721
 
        """
722
 
        def usable_repository(found_bzrdir):
 
388
                # none found
 
389
                raise errors.NoRepositoryPresent(self)
723
390
            # does it have a repository ?
724
391
            try:
725
392
                repository = found_bzrdir.open_repository()
726
393
            except errors.NoRepositoryPresent:
727
 
                return None, False
728
 
            if found_bzrdir.user_url == self.user_url:
729
 
                return repository, True
730
 
            elif repository.is_shared():
731
 
                return repository, True
 
394
                next_transport = found_bzrdir.root_transport.clone('..')
 
395
                if (found_bzrdir.root_transport.base == next_transport.base):
 
396
                    # top of the file system
 
397
                    break
 
398
                else:
 
399
                    continue
 
400
            if ((found_bzrdir.root_transport.base ==
 
401
                 self.root_transport.base) or repository.is_shared()):
 
402
                return repository
732
403
            else:
733
 
                return None, True
734
 
 
735
 
        found_repo = self._find_containing(usable_repository)
736
 
        if found_repo is None:
737
 
            raise errors.NoRepositoryPresent(self)
738
 
        return found_repo
 
404
                raise errors.NoRepositoryPresent(self)
 
405
        raise errors.NoRepositoryPresent(self)
739
406
 
740
407
    def get_branch_reference(self):
741
408
        """Return the referenced URL for the branch in this bzrdir.
746
413
        """
747
414
        return None
748
415
 
749
 
    def get_branch_transport(self, branch_format, name=None):
 
416
    def get_branch_transport(self, branch_format):
750
417
        """Get the transport for use by branch format in this BzrDir.
751
418
 
752
419
        Note that bzr dirs that do not support format strings will raise
753
420
        IncompatibleFormat if the branch format they are given has
754
421
        a format string, and vice versa.
755
422
 
756
 
        If branch_format is None, the transport is returned with no
757
 
        checking. If it is not None, then the returned transport is
 
423
        If branch_format is None, the transport is returned with no 
 
424
        checking. if it is not None, then the returned transport is
758
425
        guaranteed to point to an existing directory ready for use.
759
426
        """
760
427
        raise NotImplementedError(self.get_branch_transport)
761
 
 
762
 
    def _find_creation_modes(self):
763
 
        """Determine the appropriate modes for files and directories.
764
 
 
765
 
        They're always set to be consistent with the base directory,
766
 
        assuming that this transport allows setting modes.
767
 
        """
768
 
        # TODO: Do we need or want an option (maybe a config setting) to turn
769
 
        # this off or override it for particular locations? -- mbp 20080512
770
 
        if self._mode_check_done:
771
 
            return
772
 
        self._mode_check_done = True
773
 
        try:
774
 
            st = self.transport.stat('.')
775
 
        except errors.TransportNotPossible:
776
 
            self._dir_mode = None
777
 
            self._file_mode = None
778
 
        else:
779
 
            # Check the directory mode, but also make sure the created
780
 
            # directories and files are read-write for this user. This is
781
 
            # mostly a workaround for filesystems which lie about being able to
782
 
            # write to a directory (cygwin & win32)
783
 
            if (st.st_mode & 07777 == 00000):
784
 
                # FTP allows stat but does not return dir/file modes
785
 
                self._dir_mode = None
786
 
                self._file_mode = None
787
 
            else:
788
 
                self._dir_mode = (st.st_mode & 07777) | 00700
789
 
                # Remove the sticky and execute bits for files
790
 
                self._file_mode = self._dir_mode & ~07111
791
 
 
792
 
    def _get_file_mode(self):
793
 
        """Return Unix mode for newly created files, or None.
794
 
        """
795
 
        if not self._mode_check_done:
796
 
            self._find_creation_modes()
797
 
        return self._file_mode
798
 
 
799
 
    def _get_dir_mode(self):
800
 
        """Return Unix mode for newly created directories, or None.
801
 
        """
802
 
        if not self._mode_check_done:
803
 
            self._find_creation_modes()
804
 
        return self._dir_mode
805
 
 
 
428
        
806
429
    def get_repository_transport(self, repository_format):
807
430
        """Get the transport for use by repository format in this BzrDir.
808
431
 
810
433
        IncompatibleFormat if the repository format they are given has
811
434
        a format string, and vice versa.
812
435
 
813
 
        If repository_format is None, the transport is returned with no
814
 
        checking. If it is not None, then the returned transport is
 
436
        If repository_format is None, the transport is returned with no 
 
437
        checking. if it is not None, then the returned transport is
815
438
        guaranteed to point to an existing directory ready for use.
816
439
        """
817
440
        raise NotImplementedError(self.get_repository_transport)
818
 
 
 
441
        
819
442
    def get_workingtree_transport(self, tree_format):
820
443
        """Get the transport for use by workingtree format in this BzrDir.
821
444
 
822
445
        Note that bzr dirs that do not support format strings will raise
823
 
        IncompatibleFormat if the workingtree format they are given has a
824
 
        format string, and vice versa.
 
446
        IncompatibleFormat if the workingtree format they are given has
 
447
        a format string, and vice versa.
825
448
 
826
 
        If workingtree_format is None, the transport is returned with no
827
 
        checking. If it is not None, then the returned transport is
 
449
        If workingtree_format is None, the transport is returned with no 
 
450
        checking. if it is not None, then the returned transport is
828
451
        guaranteed to point to an existing directory ready for use.
829
452
        """
830
453
        raise NotImplementedError(self.get_workingtree_transport)
831
 
 
832
 
    def get_config(self):
833
 
        """Get configuration for this BzrDir."""
834
 
        return config.BzrDirConfig(self)
835
 
 
836
 
    def _get_config(self):
837
 
        """By default, no configuration is available."""
838
 
        return None
839
 
 
 
454
        
840
455
    def __init__(self, _transport, _format):
841
456
        """Initialize a Bzr control dir object.
842
 
 
 
457
        
843
458
        Only really common logic should reside here, concrete classes should be
844
459
        made with varying behaviours.
845
460
 
847
462
        :param _transport: the transport this dir is based at.
848
463
        """
849
464
        self._format = _format
850
 
        # these are also under the more standard names of 
851
 
        # control_transport and user_transport
852
465
        self.transport = _transport.clone('.bzr')
853
466
        self.root_transport = _transport
854
 
        self._mode_check_done = False
855
 
        
856
 
    @property 
857
 
    def user_transport(self):
858
 
        return self.root_transport
859
 
        
860
 
    @property
861
 
    def control_transport(self):
862
 
        return self.transport
863
467
 
864
468
    def is_control_filename(self, filename):
865
469
        """True if filename is the name of a path which is reserved for bzrdir's.
866
 
 
 
470
        
867
471
        :param filename: A filename within the root transport of this bzrdir.
868
472
 
869
473
        This is true IF and ONLY IF the filename is part of the namespace reserved
872
476
        this in the future - for instance to make bzr talk with svn working
873
477
        trees.
874
478
        """
875
 
        # this might be better on the BzrDirFormat class because it refers to
876
 
        # all the possible bzrdir disk formats.
877
 
        # This method is tested via the workingtree is_control_filename tests-
878
 
        # it was extracted from WorkingTree.is_control_filename. If the method's
879
 
        # contract is extended beyond the current trivial implementation, please
 
479
        # this might be better on the BzrDirFormat class because it refers to 
 
480
        # all the possible bzrdir disk formats. 
 
481
        # This method is tested via the workingtree is_control_filename tests- 
 
482
        # it was extracted from WorkingTree.is_control_filename. If the methods
 
483
        # contract is extended beyond the current trivial  implementation please
880
484
        # add new tests for it to the appropriate place.
881
485
        return filename == '.bzr' or filename.startswith('.bzr/')
882
486
 
883
487
    def needs_format_conversion(self, format=None):
884
488
        """Return true if this bzrdir needs convert_format run on it.
885
 
 
886
 
        For instance, if the repository format is out of date but the
 
489
        
 
490
        For instance, if the repository format is out of date but the 
887
491
        branch and working tree are not, this should return True.
888
492
 
889
493
        :param format: Optional parameter indicating a specific desired
895
499
    def open_unsupported(base):
896
500
        """Open a branch which is not supported."""
897
501
        return BzrDir.open(base, _unsupported=True)
898
 
 
 
502
        
899
503
    @staticmethod
900
 
    def open(base, _unsupported=False, possible_transports=None):
901
 
        """Open an existing bzrdir, rooted at 'base' (url).
902
 
 
903
 
        :param _unsupported: a private parameter to the BzrDir class.
 
504
    def open(base, _unsupported=False):
 
505
        """Open an existing bzrdir, rooted at 'base' (url)
 
506
        
 
507
        _unsupported is a private parameter to the BzrDir class.
904
508
        """
905
 
        t = get_transport(base, possible_transports=possible_transports)
 
509
        t = get_transport(base)
906
510
        return BzrDir.open_from_transport(t, _unsupported=_unsupported)
907
511
 
908
512
    @staticmethod
909
 
    def open_from_transport(transport, _unsupported=False,
910
 
                            _server_formats=True):
 
513
    def open_from_transport(transport, _unsupported=False):
911
514
        """Open a bzrdir within a particular directory.
912
515
 
913
516
        :param transport: Transport containing the bzrdir.
914
517
        :param _unsupported: private.
915
518
        """
916
 
        for hook in BzrDir.hooks['pre_open']:
917
 
            hook(transport)
918
 
        # Keep initial base since 'transport' may be modified while following
919
 
        # the redirections.
920
 
        base = transport.base
921
 
        def find_format(transport):
922
 
            return transport, BzrDirFormat.find_format(
923
 
                transport, _server_formats=_server_formats)
924
 
 
925
 
        def redirected(transport, e, redirection_notice):
926
 
            redirected_transport = transport._redirected_to(e.source, e.target)
927
 
            if redirected_transport is None:
928
 
                raise errors.NotBranchError(base)
929
 
            note('%s is%s redirected to %s',
930
 
                 transport.base, e.permanently, redirected_transport.base)
931
 
            return redirected_transport
932
 
 
933
 
        try:
934
 
            transport, format = do_catching_redirections(find_format,
935
 
                                                         transport,
936
 
                                                         redirected)
937
 
        except errors.TooManyRedirections:
938
 
            raise errors.NotBranchError(base)
939
 
 
 
519
        format = BzrDirFormat.find_format(transport)
940
520
        BzrDir._check_supported(format, _unsupported)
941
521
        return format.open(transport, _found=True)
942
522
 
943
 
    def open_branch(self, name=None, unsupported=False,
944
 
                    ignore_fallbacks=False):
 
523
    def open_branch(self, unsupported=False):
945
524
        """Open the branch object at this BzrDir if one is present.
946
525
 
947
526
        If unsupported is True, then no longer supported branch formats can
948
527
        still be opened.
949
 
 
 
528
        
950
529
        TODO: static convenience version of this?
951
530
        """
952
531
        raise NotImplementedError(self.open_branch)
953
532
 
954
533
    @staticmethod
955
 
    def open_containing(url, possible_transports=None):
 
534
    def open_containing(url):
956
535
        """Open an existing branch which contains url.
957
 
 
 
536
        
958
537
        :param url: url to search from.
959
538
        See open_containing_from_transport for more detail.
960
539
        """
961
 
        transport = get_transport(url, possible_transports)
962
 
        return BzrDir.open_containing_from_transport(transport)
963
 
 
 
540
        return BzrDir.open_containing_from_transport(get_transport(url))
 
541
    
964
542
    @staticmethod
965
543
    def open_containing_from_transport(a_transport):
966
 
        """Open an existing branch which contains a_transport.base.
 
544
        """Open an existing branch which contains a_transport.base
967
545
 
968
546
        This probes for a branch at a_transport, and searches upwards from there.
969
547
 
970
548
        Basically we keep looking up until we find the control directory or
971
549
        run into the root.  If there isn't one, raises NotBranchError.
972
 
        If there is one and it is either an unrecognised format or an unsupported
 
550
        If there is one and it is either an unrecognised format or an unsupported 
973
551
        format, UnknownFormatError or UnsupportedFormatError are raised.
974
552
        If there is one, it is returned, along with the unused portion of url.
975
553
 
976
 
        :return: The BzrDir that contains the path, and a Unicode path
 
554
        :return: The BzrDir that contains the path, and a Unicode path 
977
555
                for the rest of the URL.
978
556
        """
979
557
        # this gets the normalised url back. I.e. '.' -> the full path.
984
562
                return result, urlutils.unescape(a_transport.relpath(url))
985
563
            except errors.NotBranchError, e:
986
564
                pass
987
 
            try:
988
 
                new_t = a_transport.clone('..')
989
 
            except errors.InvalidURLJoin:
990
 
                # reached the root, whatever that may be
991
 
                raise errors.NotBranchError(path=url)
 
565
            new_t = a_transport.clone('..')
992
566
            if new_t.base == a_transport.base:
993
567
                # reached the root, whatever that may be
994
568
                raise errors.NotBranchError(path=url)
995
569
            a_transport = new_t
996
570
 
997
 
    def _get_tree_branch(self):
998
 
        """Return the branch and tree, if any, for this bzrdir.
999
 
 
1000
 
        Return None for tree if not present or inaccessible.
1001
 
        Raise NotBranchError if no branch is present.
1002
 
        :return: (tree, branch)
1003
 
        """
1004
 
        try:
1005
 
            tree = self.open_workingtree()
1006
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
1007
 
            tree = None
1008
 
            branch = self.open_branch()
1009
 
        else:
1010
 
            branch = tree.branch
1011
 
        return tree, branch
1012
 
 
1013
 
    @classmethod
1014
 
    def open_tree_or_branch(klass, location):
1015
 
        """Return the branch and working tree at a location.
1016
 
 
1017
 
        If there is no tree at the location, tree will be None.
1018
 
        If there is no branch at the location, an exception will be
1019
 
        raised
1020
 
        :return: (tree, branch)
1021
 
        """
1022
 
        bzrdir = klass.open(location)
1023
 
        return bzrdir._get_tree_branch()
1024
 
 
1025
571
    @classmethod
1026
572
    def open_containing_tree_or_branch(klass, location):
1027
573
        """Return the branch and working tree contained by a location.
1033
579
        relpath is the portion of the path that is contained by the branch.
1034
580
        """
1035
581
        bzrdir, relpath = klass.open_containing(location)
1036
 
        tree, branch = bzrdir._get_tree_branch()
 
582
        try:
 
583
            tree = bzrdir.open_workingtree()
 
584
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
585
            tree = None
 
586
            branch = bzrdir.open_branch()
 
587
        else:
 
588
            branch = tree.branch
1037
589
        return tree, branch, relpath
1038
590
 
1039
 
    @classmethod
1040
 
    def open_containing_tree_branch_or_repository(klass, location):
1041
 
        """Return the working tree, branch and repo contained by a location.
1042
 
 
1043
 
        Returns (tree, branch, repository, relpath).
1044
 
        If there is no tree containing the location, tree will be None.
1045
 
        If there is no branch containing the location, branch will be None.
1046
 
        If there is no repository containing the location, repository will be
1047
 
        None.
1048
 
        relpath is the portion of the path that is contained by the innermost
1049
 
        BzrDir.
1050
 
 
1051
 
        If no tree, branch or repository is found, a NotBranchError is raised.
1052
 
        """
1053
 
        bzrdir, relpath = klass.open_containing(location)
1054
 
        try:
1055
 
            tree, branch = bzrdir._get_tree_branch()
1056
 
        except errors.NotBranchError:
1057
 
            try:
1058
 
                repo = bzrdir.find_repository()
1059
 
                return None, None, repo, relpath
1060
 
            except (errors.NoRepositoryPresent):
1061
 
                raise errors.NotBranchError(location)
1062
 
        return tree, branch, branch.repository, relpath
1063
 
 
1064
591
    def open_repository(self, _unsupported=False):
1065
592
        """Open the repository object at this BzrDir if one is present.
1066
593
 
1067
 
        This will not follow the Branch object pointer - it's strictly a direct
 
594
        This will not follow the Branch object pointer - its strictly a direct
1068
595
        open facility. Most client code should use open_branch().repository to
1069
596
        get at a repository.
1070
597
 
1071
 
        :param _unsupported: a private parameter, not part of the api.
 
598
        _unsupported is a private parameter, not part of the api.
1072
599
        TODO: static convenience version of this?
1073
600
        """
1074
601
        raise NotImplementedError(self.open_repository)
1075
602
 
1076
 
    def open_workingtree(self, _unsupported=False,
1077
 
                         recommend_upgrade=True, from_branch=None):
 
603
    def open_workingtree(self, _unsupported=False):
1078
604
        """Open the workingtree object at this BzrDir if one is present.
1079
 
 
1080
 
        :param recommend_upgrade: Optional keyword parameter, when True (the
1081
 
            default), emit through the ui module a recommendation that the user
1082
 
            upgrade the working tree when the workingtree being opened is old
1083
 
            (but still fully supported).
1084
 
        :param from_branch: override bzrdir branch (for lightweight checkouts)
 
605
        
 
606
        TODO: static convenience version of this?
1085
607
        """
1086
608
        raise NotImplementedError(self.open_workingtree)
1087
609
 
1088
 
    def has_branch(self, name=None):
 
610
    def has_branch(self):
1089
611
        """Tell if this bzrdir contains a branch.
1090
 
 
 
612
        
1091
613
        Note: if you're going to open the branch, you should just go ahead
1092
 
        and try, and not ask permission first.  (This method just opens the
1093
 
        branch and discards it, and that's somewhat expensive.)
 
614
        and try, and not ask permission first.  (This method just opens the 
 
615
        branch and discards it, and that's somewhat expensive.) 
1094
616
        """
1095
617
        try:
1096
 
            self.open_branch(name)
 
618
            self.open_branch()
1097
619
            return True
1098
620
        except errors.NotBranchError:
1099
621
            return False
1103
625
 
1104
626
        This will still raise an exception if the bzrdir has a workingtree that
1105
627
        is remote & inaccessible.
1106
 
 
 
628
        
1107
629
        Note: if you're going to open the working tree, you should just go ahead
1108
 
        and try, and not ask permission first.  (This method just opens the
1109
 
        workingtree and discards it, and that's somewhat expensive.)
 
630
        and try, and not ask permission first.  (This method just opens the 
 
631
        workingtree and discards it, and that's somewhat expensive.) 
1110
632
        """
1111
633
        try:
1112
 
            self.open_workingtree(recommend_upgrade=False)
 
634
            self.open_workingtree()
1113
635
            return True
1114
636
        except errors.NoWorkingTree:
1115
637
            return False
1116
638
 
1117
 
    def _cloning_metadir(self):
1118
 
        """Produce a metadir suitable for cloning with.
1119
 
 
1120
 
        :returns: (destination_bzrdir_format, source_repository)
1121
 
        """
 
639
    def cloning_metadir(self, basis=None):
 
640
        """Produce a metadir suitable for cloning with"""
 
641
        def related_repository(bzrdir):
 
642
            try:
 
643
                branch = bzrdir.open_branch()
 
644
                return branch.repository
 
645
            except errors.NotBranchError:
 
646
                source_branch = None
 
647
                return bzrdir.open_repository()
1122
648
        result_format = self._format.__class__()
1123
649
        try:
1124
650
            try:
1125
 
                branch = self.open_branch(ignore_fallbacks=True)
1126
 
                source_repository = branch.repository
1127
 
                result_format._branch_format = branch._format
1128
 
            except errors.NotBranchError:
1129
 
                source_branch = None
1130
 
                source_repository = self.open_repository()
 
651
                source_repository = related_repository(self)
 
652
            except errors.NoRepositoryPresent:
 
653
                if basis is None:
 
654
                    raise
 
655
                source_repository = related_repository(self)
 
656
            result_format.repository_format = source_repository._format
1131
657
        except errors.NoRepositoryPresent:
1132
 
            source_repository = None
1133
 
        else:
1134
 
            # XXX TODO: This isinstance is here because we have not implemented
1135
 
            # the fix recommended in bug # 103195 - to delegate this choice the
1136
 
            # repository itself.
1137
 
            repo_format = source_repository._format
1138
 
            if isinstance(repo_format, remote.RemoteRepositoryFormat):
1139
 
                source_repository._ensure_real()
1140
 
                repo_format = source_repository._real_repository._format
1141
 
            result_format.repository_format = repo_format
1142
 
        try:
1143
 
            # TODO: Couldn't we just probe for the format in these cases,
1144
 
            # rather than opening the whole tree?  It would be a little
1145
 
            # faster. mbp 20070401
1146
 
            tree = self.open_workingtree(recommend_upgrade=False)
1147
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
1148
 
            result_format.workingtree_format = None
1149
 
        else:
1150
 
            result_format.workingtree_format = tree._format.__class__()
1151
 
        return result_format, source_repository
1152
 
 
1153
 
    def cloning_metadir(self, require_stacking=False):
1154
 
        """Produce a metadir suitable for cloning or sprouting with.
1155
 
 
1156
 
        These operations may produce workingtrees (yes, even though they're
1157
 
        "cloning" something that doesn't have a tree), so a viable workingtree
1158
 
        format must be selected.
1159
 
 
1160
 
        :require_stacking: If True, non-stackable formats will be upgraded
1161
 
            to similar stackable formats.
1162
 
        :returns: a BzrDirFormat with all component formats either set
1163
 
            appropriately or set to None if that component should not be
1164
 
            created.
1165
 
        """
1166
 
        format, repository = self._cloning_metadir()
1167
 
        if format._workingtree_format is None:
1168
 
            # No tree in self.
1169
 
            if repository is None:
1170
 
                # No repository either
1171
 
                return format
1172
 
            # We have a repository, so set a working tree? (Why? This seems to
1173
 
            # contradict the stated return value in the docstring).
1174
 
            tree_format = repository._format._matchingbzrdir.workingtree_format
1175
 
            format.workingtree_format = tree_format.__class__()
1176
 
        if require_stacking:
1177
 
            format.require_stacking()
1178
 
        return format
1179
 
 
1180
 
    def checkout_metadir(self):
1181
 
        return self.cloning_metadir()
1182
 
 
1183
 
    def sprout(self, url, revision_id=None, force_new_repo=False,
1184
 
               recurse='down', possible_transports=None,
1185
 
               accelerator_tree=None, hardlink=False, stacked=False,
1186
 
               source_branch=None, create_tree_if_local=True):
 
658
            pass
 
659
        return result_format
 
660
 
 
661
    def sprout(self, url, revision_id=None, basis=None, force_new_repo=False):
1187
662
        """Create a copy of this bzrdir prepared for use as a new line of
1188
663
        development.
1189
664
 
1190
 
        If url's last component does not exist, it will be created.
 
665
        If urls last component does not exist, it will be created.
1191
666
 
1192
667
        Attributes related to the identity of the source branch like
1193
668
        branch nickname will be cleaned, a working tree is created
1196
671
 
1197
672
        if revision_id is not None, then the clone operation may tune
1198
673
            itself to download less data.
1199
 
        :param accelerator_tree: A tree which can be used for retrieving file
1200
 
            contents more quickly than the revision tree, i.e. a workingtree.
1201
 
            The revision tree will be used for cases where accelerator_tree's
1202
 
            content is different.
1203
 
        :param hardlink: If true, hard-link files from accelerator_tree,
1204
 
            where possible.
1205
 
        :param stacked: If true, create a stacked branch referring to the
1206
 
            location of this control directory.
1207
 
        :param create_tree_if_local: If true, a working-tree will be created
1208
 
            when working locally.
1209
674
        """
1210
 
        target_transport = get_transport(url, possible_transports)
1211
 
        target_transport.ensure_base()
1212
 
        cloning_format = self.cloning_metadir(stacked)
1213
 
        # Create/update the result branch
1214
 
        result = cloning_format.initialize_on_transport(target_transport)
1215
 
        # if a stacked branch wasn't requested, we don't create one
1216
 
        # even if the origin was stacked
1217
 
        stacked_branch_url = None
1218
 
        if source_branch is not None:
1219
 
            if stacked:
1220
 
                stacked_branch_url = self.root_transport.base
 
675
        self._make_tail(url)
 
676
        cloning_format = self.cloning_metadir(basis)
 
677
        result = cloning_format.initialize(url)
 
678
        basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
 
679
        try:
 
680
            source_branch = self.open_branch()
1221
681
            source_repository = source_branch.repository
1222
 
        else:
1223
 
            try:
1224
 
                source_branch = self.open_branch()
1225
 
                source_repository = source_branch.repository
1226
 
                if stacked:
1227
 
                    stacked_branch_url = self.root_transport.base
1228
 
            except errors.NotBranchError:
1229
 
                source_branch = None
1230
 
                try:
1231
 
                    source_repository = self.open_repository()
1232
 
                except errors.NoRepositoryPresent:
1233
 
                    source_repository = None
1234
 
        repository_policy = result.determine_repository_policy(
1235
 
            force_new_repo, stacked_branch_url, require_stacking=stacked)
1236
 
        result_repo, is_new_repo = repository_policy.acquire_repository()
1237
 
        if is_new_repo and revision_id is not None and not stacked:
1238
 
            fetch_spec = graph.PendingAncestryResult(
1239
 
                [revision_id], source_repository)
1240
 
        else:
1241
 
            fetch_spec = None
1242
 
        if source_repository is not None:
1243
 
            # Fetch while stacked to prevent unstacked fetch from
1244
 
            # Branch.sprout.
1245
 
            if fetch_spec is None:
 
682
        except errors.NotBranchError:
 
683
            source_branch = None
 
684
            try:
 
685
                source_repository = self.open_repository()
 
686
            except errors.NoRepositoryPresent:
 
687
                # copy the entire basis one if there is one
 
688
                # but there is no repository.
 
689
                source_repository = basis_repo
 
690
        if force_new_repo:
 
691
            result_repo = None
 
692
        else:
 
693
            try:
 
694
                result_repo = result.find_repository()
 
695
            except errors.NoRepositoryPresent:
 
696
                result_repo = None
 
697
        if source_repository is None and result_repo is not None:
 
698
            pass
 
699
        elif source_repository is None and result_repo is None:
 
700
            # no repo available, make a new one
 
701
            result.create_repository()
 
702
        elif source_repository is not None and result_repo is None:
 
703
            # have source, and want to make a new target repo
 
704
            # we don't clone the repo because that preserves attributes
 
705
            # like is_shared(), and we have not yet implemented a 
 
706
            # repository sprout().
 
707
            result_repo = result.create_repository()
 
708
        if result_repo is not None:
 
709
            # fetch needed content into target.
 
710
            if basis_repo:
 
711
                # XXX FIXME RBC 20060214 need tests for this when the basis
 
712
                # is incomplete
 
713
                result_repo.fetch(basis_repo, revision_id=revision_id)
 
714
            if source_repository is not None:
1246
715
                result_repo.fetch(source_repository, revision_id=revision_id)
1247
 
            else:
1248
 
                result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1249
 
 
1250
 
        if source_branch is None:
1251
 
            # this is for sprouting a bzrdir without a branch; is that
1252
 
            # actually useful?
1253
 
            # Not especially, but it's part of the contract.
1254
 
            result_branch = result.create_branch()
1255
 
        else:
1256
 
            result_branch = source_branch.sprout(result,
1257
 
                revision_id=revision_id, repository_policy=repository_policy)
1258
 
        mutter("created new branch %r" % (result_branch,))
1259
 
 
1260
 
        # Create/update the result working tree
1261
 
        if (create_tree_if_local and
1262
 
            isinstance(target_transport, local.LocalTransport) and
1263
 
            (result_repo is None or result_repo.make_working_trees())):
1264
 
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1265
 
                hardlink=hardlink)
1266
 
            wt.lock_write()
1267
 
            try:
1268
 
                if wt.path2id('') is None:
1269
 
                    try:
1270
 
                        wt.set_root_id(self.open_workingtree.get_root_id())
1271
 
                    except errors.NoWorkingTree:
1272
 
                        pass
1273
 
            finally:
1274
 
                wt.unlock()
1275
 
        else:
1276
 
            wt = None
1277
 
        if recurse == 'down':
1278
 
            if wt is not None:
1279
 
                basis = wt.basis_tree()
1280
 
                basis.lock_read()
1281
 
                subtrees = basis.iter_references()
1282
 
            elif result_branch is not None:
1283
 
                basis = result_branch.basis_tree()
1284
 
                basis.lock_read()
1285
 
                subtrees = basis.iter_references()
1286
 
            elif source_branch is not None:
1287
 
                basis = source_branch.basis_tree()
1288
 
                basis.lock_read()
1289
 
                subtrees = basis.iter_references()
1290
 
            else:
1291
 
                subtrees = []
1292
 
                basis = None
1293
 
            try:
1294
 
                for path, file_id in subtrees:
1295
 
                    target = urlutils.join(url, urlutils.escape(path))
1296
 
                    sublocation = source_branch.reference_parent(file_id, path)
1297
 
                    sublocation.bzrdir.sprout(target,
1298
 
                        basis.get_reference_revision(file_id, path),
1299
 
                        force_new_repo=force_new_repo, recurse=recurse,
1300
 
                        stacked=stacked)
1301
 
            finally:
1302
 
                if basis is not None:
1303
 
                    basis.unlock()
 
716
        if source_branch is not None:
 
717
            source_branch.sprout(result, revision_id=revision_id)
 
718
        else:
 
719
            result.create_branch()
 
720
        # TODO: jam 20060426 we probably need a test in here in the
 
721
        #       case that the newly sprouted branch is a remote one
 
722
        if result_repo is None or result_repo.make_working_trees():
 
723
            wt = result.create_workingtree()
 
724
            if wt.inventory.root is None:
 
725
                try:
 
726
                    wt.set_root_id(self.open_workingtree.get_root_id())
 
727
                except errors.NoWorkingTree:
 
728
                    pass
1304
729
        return result
1305
730
 
1306
 
    def push_branch(self, source, revision_id=None, overwrite=False, 
1307
 
        remember=False, create_prefix=False):
1308
 
        """Push the source branch into this BzrDir."""
1309
 
        br_to = None
1310
 
        # If we can open a branch, use its direct repository, otherwise see
1311
 
        # if there is a repository without a branch.
1312
 
        try:
1313
 
            br_to = self.open_branch()
1314
 
        except errors.NotBranchError:
1315
 
            # Didn't find a branch, can we find a repository?
1316
 
            repository_to = self.find_repository()
1317
 
        else:
1318
 
            # Found a branch, so we must have found a repository
1319
 
            repository_to = br_to.repository
1320
 
 
1321
 
        push_result = PushResult()
1322
 
        push_result.source_branch = source
1323
 
        if br_to is None:
1324
 
            # We have a repository but no branch, copy the revisions, and then
1325
 
            # create a branch.
1326
 
            repository_to.fetch(source.repository, revision_id=revision_id)
1327
 
            br_to = source.clone(self, revision_id=revision_id)
1328
 
            if source.get_push_location() is None or remember:
1329
 
                source.set_push_location(br_to.base)
1330
 
            push_result.stacked_on = None
1331
 
            push_result.branch_push_result = None
1332
 
            push_result.old_revno = None
1333
 
            push_result.old_revid = _mod_revision.NULL_REVISION
1334
 
            push_result.target_branch = br_to
1335
 
            push_result.master_branch = None
1336
 
            push_result.workingtree_updated = False
1337
 
        else:
1338
 
            # We have successfully opened the branch, remember if necessary:
1339
 
            if source.get_push_location() is None or remember:
1340
 
                source.set_push_location(br_to.base)
1341
 
            try:
1342
 
                tree_to = self.open_workingtree()
1343
 
            except errors.NotLocalUrl:
1344
 
                push_result.branch_push_result = source.push(br_to, 
1345
 
                    overwrite, stop_revision=revision_id)
1346
 
                push_result.workingtree_updated = False
1347
 
            except errors.NoWorkingTree:
1348
 
                push_result.branch_push_result = source.push(br_to,
1349
 
                    overwrite, stop_revision=revision_id)
1350
 
                push_result.workingtree_updated = None # Not applicable
1351
 
            else:
1352
 
                tree_to.lock_write()
1353
 
                try:
1354
 
                    push_result.branch_push_result = source.push(
1355
 
                        tree_to.branch, overwrite, stop_revision=revision_id)
1356
 
                    tree_to.update()
1357
 
                finally:
1358
 
                    tree_to.unlock()
1359
 
                push_result.workingtree_updated = True
1360
 
            push_result.old_revno = push_result.branch_push_result.old_revno
1361
 
            push_result.old_revid = push_result.branch_push_result.old_revid
1362
 
            push_result.target_branch = \
1363
 
                push_result.branch_push_result.target_branch
1364
 
        return push_result
1365
 
 
1366
 
 
1367
 
class BzrDirHooks(hooks.Hooks):
1368
 
    """Hooks for BzrDir operations."""
1369
 
 
1370
 
    def __init__(self):
1371
 
        """Create the default hooks."""
1372
 
        hooks.Hooks.__init__(self)
1373
 
        self.create_hook(hooks.HookPoint('pre_open',
1374
 
            "Invoked before attempting to open a BzrDir with the transport "
1375
 
            "that the open will use.", (1, 14), None))
1376
 
        self.create_hook(hooks.HookPoint('post_repo_init',
1377
 
            "Invoked after a repository has been initialized. "
1378
 
            "post_repo_init is called with a "
1379
 
            "bzrlib.bzrdir.RepoInitHookParams.",
1380
 
            (2, 2), None))
1381
 
 
1382
 
# install the default hooks
1383
 
BzrDir.hooks = BzrDirHooks()
1384
 
 
1385
 
 
1386
 
class RepoInitHookParams(object):
1387
 
    """Object holding parameters passed to *_repo_init hooks.
1388
 
 
1389
 
    There are 4 fields that hooks may wish to access:
1390
 
 
1391
 
    :ivar repository: Repository created
1392
 
    :ivar format: Repository format
1393
 
    :ivar bzrdir: The bzrdir for the repository
1394
 
    :ivar shared: The repository is shared
1395
 
    """
1396
 
 
1397
 
    def __init__(self, repository, format, a_bzrdir, shared):
1398
 
        """Create a group of RepoInitHook parameters.
1399
 
 
1400
 
        :param repository: Repository created
1401
 
        :param format: Repository format
1402
 
        :param bzrdir: The bzrdir for the repository
1403
 
        :param shared: The repository is shared
1404
 
        """
1405
 
        self.repository = repository
1406
 
        self.format = format
1407
 
        self.bzrdir = a_bzrdir
1408
 
        self.shared = shared
1409
 
 
1410
 
    def __eq__(self, other):
1411
 
        return self.__dict__ == other.__dict__
1412
 
 
1413
 
    def __repr__(self):
1414
 
        if self.repository:
1415
 
            return "<%s for %s>" % (self.__class__.__name__,
1416
 
                self.repository)
1417
 
        else:
1418
 
            return "<%s for %s>" % (self.__class__.__name__,
1419
 
                self.bzrdir)
1420
 
 
1421
731
 
1422
732
class BzrDirPreSplitOut(BzrDir):
1423
733
    """A common class for the all-in-one formats."""
1425
735
    def __init__(self, _transport, _format):
1426
736
        """See BzrDir.__init__."""
1427
737
        super(BzrDirPreSplitOut, self).__init__(_transport, _format)
 
738
        assert self._format._lock_class == lockable_files.TransportLock
 
739
        assert self._format._lock_file_name == 'branch-lock'
1428
740
        self._control_files = lockable_files.LockableFiles(
1429
741
                                            self.get_branch_transport(None),
1430
742
                                            self._format._lock_file_name,
1434
746
        """Pre-splitout bzrdirs do not suffer from stale locks."""
1435
747
        raise NotImplementedError(self.break_lock)
1436
748
 
1437
 
    def cloning_metadir(self, require_stacking=False):
1438
 
        """Produce a metadir suitable for cloning with."""
1439
 
        if require_stacking:
1440
 
            return format_registry.make_bzrdir('1.6')
1441
 
        return self._format.__class__()
1442
 
 
1443
 
    def clone(self, url, revision_id=None, force_new_repo=False,
1444
 
              preserve_stacking=False):
1445
 
        """See BzrDir.clone().
1446
 
 
1447
 
        force_new_repo has no effect, since this family of formats always
1448
 
        require a new repository.
1449
 
        preserve_stacking has no effect, since no source branch using this
1450
 
        family of formats can be stacked, so there is no stacking to preserve.
1451
 
        """
 
749
    def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
 
750
        """See BzrDir.clone()."""
 
751
        from bzrlib.workingtree import WorkingTreeFormat2
1452
752
        self._make_tail(url)
1453
753
        result = self._format._initialize_for_clone(url)
1454
 
        self.open_repository().clone(result, revision_id=revision_id)
 
754
        basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
 
755
        self.open_repository().clone(result, revision_id=revision_id, basis=basis_repo)
1455
756
        from_branch = self.open_branch()
1456
757
        from_branch.clone(result, revision_id=revision_id)
1457
758
        try:
1458
 
            tree = self.open_workingtree()
 
759
            self.open_workingtree().clone(result, basis=basis_tree)
1459
760
        except errors.NotLocalUrl:
1460
761
            # make a new one, this format always has to have one.
1461
 
            result._init_workingtree()
1462
 
        else:
1463
 
            tree.clone(result)
 
762
            try:
 
763
                WorkingTreeFormat2().initialize(result)
 
764
            except errors.NotLocalUrl:
 
765
                # but we cannot do it for remote trees.
 
766
                to_branch = result.open_branch()
 
767
                WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
1464
768
        return result
1465
769
 
1466
 
    def create_branch(self, name=None):
 
770
    def create_branch(self):
1467
771
        """See BzrDir.create_branch."""
1468
 
        return self._format.get_branch_format().initialize(self, name=name)
1469
 
 
1470
 
    def destroy_branch(self, name=None):
1471
 
        """See BzrDir.destroy_branch."""
1472
 
        raise errors.UnsupportedOperation(self.destroy_branch, self)
 
772
        return self.open_branch()
1473
773
 
1474
774
    def create_repository(self, shared=False):
1475
775
        """See BzrDir.create_repository."""
1477
777
            raise errors.IncompatibleFormat('shared repository', self._format)
1478
778
        return self.open_repository()
1479
779
 
1480
 
    def destroy_repository(self):
1481
 
        """See BzrDir.destroy_repository."""
1482
 
        raise errors.UnsupportedOperation(self.destroy_repository, self)
1483
 
 
1484
 
    def create_workingtree(self, revision_id=None, from_branch=None,
1485
 
                           accelerator_tree=None, hardlink=False):
 
780
    def create_workingtree(self, revision_id=None):
1486
781
        """See BzrDir.create_workingtree."""
1487
 
        # The workingtree is sometimes created when the bzrdir is created,
1488
 
        # but not when cloning.
1489
 
 
1490
782
        # this looks buggy but is not -really-
1491
 
        # because this format creates the workingtree when the bzrdir is
1492
 
        # created
1493
783
        # clone and sprout will have set the revision_id
1494
784
        # and that will have set it for us, its only
1495
785
        # specific uses of create_workingtree in isolation
1496
786
        # that can do wonky stuff here, and that only
1497
 
        # happens for creating checkouts, which cannot be
 
787
        # happens for creating checkouts, which cannot be 
1498
788
        # done on this format anyway. So - acceptable wart.
1499
 
        if hardlink:
1500
 
            warning("can't support hardlinked working trees in %r"
1501
 
                % (self,))
1502
 
        try:
1503
 
            result = self.open_workingtree(recommend_upgrade=False)
1504
 
        except errors.NoSuchFile:
1505
 
            result = self._init_workingtree()
 
789
        result = self.open_workingtree()
1506
790
        if revision_id is not None:
1507
791
            if revision_id == _mod_revision.NULL_REVISION:
1508
792
                result.set_parent_ids([])
1510
794
                result.set_parent_ids([revision_id])
1511
795
        return result
1512
796
 
1513
 
    def _init_workingtree(self):
1514
 
        from bzrlib.workingtree import WorkingTreeFormat2
1515
 
        try:
1516
 
            return WorkingTreeFormat2().initialize(self)
1517
 
        except errors.NotLocalUrl:
1518
 
            # Even though we can't access the working tree, we need to
1519
 
            # create its control files.
1520
 
            return WorkingTreeFormat2()._stub_initialize_on_transport(
1521
 
                self.transport, self._control_files._file_mode)
1522
 
 
1523
797
    def destroy_workingtree(self):
1524
798
        """See BzrDir.destroy_workingtree."""
1525
799
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1526
800
 
1527
801
    def destroy_workingtree_metadata(self):
1528
802
        """See BzrDir.destroy_workingtree_metadata."""
1529
 
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
 
803
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata, 
1530
804
                                          self)
1531
805
 
1532
 
    def get_branch_transport(self, branch_format, name=None):
 
806
    def get_branch_transport(self, branch_format):
1533
807
        """See BzrDir.get_branch_transport()."""
1534
 
        if name is not None:
1535
 
            raise errors.NoColocatedBranchSupport(self)
1536
808
        if branch_format is None:
1537
809
            return self.transport
1538
810
        try:
1566
838
        # if the format is not the same as the system default,
1567
839
        # an upgrade is needed.
1568
840
        if format is None:
1569
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1570
 
                % 'needs_format_conversion(format=None)')
1571
841
            format = BzrDirFormat.get_default_format()
1572
842
        return not isinstance(self._format, format.__class__)
1573
843
 
1574
 
    def open_branch(self, name=None, unsupported=False,
1575
 
                    ignore_fallbacks=False):
 
844
    def open_branch(self, unsupported=False):
1576
845
        """See BzrDir.open_branch."""
1577
846
        from bzrlib.branch import BzrBranchFormat4
1578
847
        format = BzrBranchFormat4()
1579
848
        self._check_supported(format, unsupported)
1580
 
        return format.open(self, name, _found=True)
 
849
        return format.open(self, _found=True)
1581
850
 
1582
 
    def sprout(self, url, revision_id=None, force_new_repo=False,
1583
 
               possible_transports=None, accelerator_tree=None,
1584
 
               hardlink=False, stacked=False, create_tree_if_local=True,
1585
 
               source_branch=None):
 
851
    def sprout(self, url, revision_id=None, basis=None, force_new_repo=False):
1586
852
        """See BzrDir.sprout()."""
1587
 
        if source_branch is not None:
1588
 
            my_branch = self.open_branch()
1589
 
            if source_branch.base != my_branch.base:
1590
 
                raise AssertionError(
1591
 
                    "source branch %r is not within %r with branch %r" %
1592
 
                    (source_branch, self, my_branch))
1593
 
        if stacked:
1594
 
            raise errors.UnstackableBranchFormat(
1595
 
                self._format, self.root_transport.base)
1596
 
        if not create_tree_if_local:
1597
 
            raise errors.MustHaveWorkingTree(
1598
 
                self._format, self.root_transport.base)
1599
853
        from bzrlib.workingtree import WorkingTreeFormat2
1600
854
        self._make_tail(url)
1601
855
        result = self._format._initialize_for_clone(url)
 
856
        basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
1602
857
        try:
1603
 
            self.open_repository().clone(result, revision_id=revision_id)
 
858
            self.open_repository().clone(result, revision_id=revision_id, basis=basis_repo)
1604
859
        except errors.NoRepositoryPresent:
1605
860
            pass
1606
861
        try:
1607
862
            self.open_branch().sprout(result, revision_id=revision_id)
1608
863
        except errors.NotBranchError:
1609
864
            pass
1610
 
 
1611
865
        # we always want a working tree
1612
 
        WorkingTreeFormat2().initialize(result,
1613
 
                                        accelerator_tree=accelerator_tree,
1614
 
                                        hardlink=hardlink)
 
866
        WorkingTreeFormat2().initialize(result)
1615
867
        return result
1616
868
 
1617
869
 
1618
870
class BzrDir4(BzrDirPreSplitOut):
1619
871
    """A .bzr version 4 control object.
1620
 
 
 
872
    
1621
873
    This is a deprecated format and may be removed after sept 2006.
1622
874
    """
1623
875
 
1627
879
 
1628
880
    def needs_format_conversion(self, format=None):
1629
881
        """Format 4 dirs are always in need of conversion."""
1630
 
        if format is None:
1631
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1632
 
                % 'needs_format_conversion(format=None)')
1633
882
        return True
1634
883
 
1635
884
    def open_repository(self):
1636
885
        """See BzrDir.open_repository."""
1637
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
886
        from bzrlib.repository import RepositoryFormat4
1638
887
        return RepositoryFormat4().open(self, _found=True)
1639
888
 
1640
889
 
1644
893
    This is a deprecated format and may be removed after sept 2006.
1645
894
    """
1646
895
 
1647
 
    def has_workingtree(self):
1648
 
        """See BzrDir.has_workingtree."""
1649
 
        return True
1650
 
    
1651
896
    def open_repository(self):
1652
897
        """See BzrDir.open_repository."""
1653
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
898
        from bzrlib.repository import RepositoryFormat5
1654
899
        return RepositoryFormat5().open(self, _found=True)
1655
900
 
1656
 
    def open_workingtree(self, _unsupported=False,
1657
 
            recommend_upgrade=True):
 
901
    def open_workingtree(self, _unsupported=False):
1658
902
        """See BzrDir.create_workingtree."""
1659
903
        from bzrlib.workingtree import WorkingTreeFormat2
1660
 
        wt_format = WorkingTreeFormat2()
1661
 
        # we don't warn here about upgrades; that ought to be handled for the
1662
 
        # bzrdir as a whole
1663
 
        return wt_format.open(self, _found=True)
 
904
        return WorkingTreeFormat2().open(self, _found=True)
1664
905
 
1665
906
 
1666
907
class BzrDir6(BzrDirPreSplitOut):
1669
910
    This is a deprecated format and may be removed after sept 2006.
1670
911
    """
1671
912
 
1672
 
    def has_workingtree(self):
1673
 
        """See BzrDir.has_workingtree."""
1674
 
        return True
1675
 
    
1676
913
    def open_repository(self):
1677
914
        """See BzrDir.open_repository."""
1678
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
915
        from bzrlib.repository import RepositoryFormat6
1679
916
        return RepositoryFormat6().open(self, _found=True)
1680
917
 
1681
 
    def open_workingtree(self, _unsupported=False,
1682
 
        recommend_upgrade=True):
 
918
    def open_workingtree(self, _unsupported=False):
1683
919
        """See BzrDir.create_workingtree."""
1684
 
        # we don't warn here about upgrades; that ought to be handled for the
1685
 
        # bzrdir as a whole
1686
920
        from bzrlib.workingtree import WorkingTreeFormat2
1687
921
        return WorkingTreeFormat2().open(self, _found=True)
1688
922
 
1689
923
 
1690
924
class BzrDirMeta1(BzrDir):
1691
925
    """A .bzr meta version 1 control object.
1692
 
 
1693
 
    This is the first control object where the
 
926
    
 
927
    This is the first control object where the 
1694
928
    individual aspects are really split out: there are separate repository,
1695
929
    workingtree and branch subdirectories and any subset of the three can be
1696
930
    present within a BzrDir.
1700
934
        """See BzrDir.can_convert_format()."""
1701
935
        return True
1702
936
 
1703
 
    def create_branch(self, name=None):
1704
 
        """See BzrDir.create_branch."""
1705
 
        return self._format.get_branch_format().initialize(self, name=name)
1706
 
 
1707
 
    def destroy_branch(self, name=None):
1708
 
        """See BzrDir.create_branch."""
1709
 
        if name is not None:
1710
 
            raise errors.NoColocatedBranchSupport(self)
1711
 
        self.transport.delete_tree('branch')
 
937
    def create_branch(self):
 
938
        """See BzrDir.create_branch."""
 
939
        from bzrlib.branch import BranchFormat
 
940
        return BranchFormat.get_default_format().initialize(self)
1712
941
 
1713
942
    def create_repository(self, shared=False):
1714
943
        """See BzrDir.create_repository."""
1715
944
        return self._format.repository_format.initialize(self, shared)
1716
945
 
1717
 
    def destroy_repository(self):
1718
 
        """See BzrDir.destroy_repository."""
1719
 
        self.transport.delete_tree('repository')
1720
 
 
1721
 
    def create_workingtree(self, revision_id=None, from_branch=None,
1722
 
                           accelerator_tree=None, hardlink=False):
 
946
    def create_workingtree(self, revision_id=None):
1723
947
        """See BzrDir.create_workingtree."""
1724
 
        return self._format.workingtree_format.initialize(
1725
 
            self, revision_id, from_branch=from_branch,
1726
 
            accelerator_tree=accelerator_tree, hardlink=hardlink)
 
948
        from bzrlib.workingtree import WorkingTreeFormat
 
949
        return WorkingTreeFormat.get_default_format().initialize(self, revision_id)
1727
950
 
1728
951
    def destroy_workingtree(self):
1729
952
        """See BzrDir.destroy_workingtree."""
1730
 
        wt = self.open_workingtree(recommend_upgrade=False)
 
953
        wt = self.open_workingtree()
1731
954
        repository = wt.branch.repository
1732
955
        empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1733
 
        wt.revert(old_tree=empty)
 
956
        wt.revert([], old_tree=empty)
1734
957
        self.destroy_workingtree_metadata()
1735
958
 
1736
959
    def destroy_workingtree_metadata(self):
1737
960
        self.transport.delete_tree('checkout')
1738
961
 
1739
 
    def find_branch_format(self):
1740
 
        """Find the branch 'format' for this bzrdir.
1741
 
 
1742
 
        This might be a synthetic object for e.g. RemoteBranch and SVN.
1743
 
        """
1744
 
        from bzrlib.branch import BranchFormat
1745
 
        return BranchFormat.find_format(self)
1746
 
 
1747
962
    def _get_mkdir_mode(self):
1748
963
        """Figure out the mode to use when creating a bzrdir subdir."""
1749
964
        temp_control = lockable_files.LockableFiles(self.transport, '',
1756
971
        format = BranchFormat.find_format(self)
1757
972
        return format.get_reference(self)
1758
973
 
1759
 
    def get_branch_transport(self, branch_format, name=None):
 
974
    def get_branch_transport(self, branch_format):
1760
975
        """See BzrDir.get_branch_transport()."""
1761
 
        if name is not None:
1762
 
            raise errors.NoColocatedBranchSupport(self)
1763
 
        # XXX: this shouldn't implicitly create the directory if it's just
1764
 
        # promising to get a transport -- mbp 20090727
1765
976
        if branch_format is None:
1766
977
            return self.transport.clone('branch')
1767
978
        try:
1802
1013
            pass
1803
1014
        return self.transport.clone('checkout')
1804
1015
 
1805
 
    def has_workingtree(self):
1806
 
        """Tell if this bzrdir contains a working tree.
1807
 
 
1808
 
        This will still raise an exception if the bzrdir has a workingtree that
1809
 
        is remote & inaccessible.
1810
 
 
1811
 
        Note: if you're going to open the working tree, you should just go
1812
 
        ahead and try, and not ask permission first.
1813
 
        """
1814
 
        from bzrlib.workingtree import WorkingTreeFormat
1815
 
        try:
1816
 
            WorkingTreeFormat.find_format(self)
1817
 
        except errors.NoWorkingTree:
1818
 
            return False
1819
 
        return True
1820
 
 
1821
1016
    def needs_format_conversion(self, format=None):
1822
1017
        """See BzrDir.needs_format_conversion()."""
1823
1018
        if format is None:
1824
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1825
 
                % 'needs_format_conversion(format=None)')
1826
 
        if format is None:
1827
1019
            format = BzrDirFormat.get_default_format()
1828
1020
        if not isinstance(self._format, format.__class__):
1829
1021
            # it is not a meta dir format, conversion is needed.
1836
1028
                return True
1837
1029
        except errors.NoRepositoryPresent:
1838
1030
            pass
1839
 
        for branch in self.list_branches():
1840
 
            if not isinstance(branch._format,
1841
 
                              format.get_branch_format().__class__):
1842
 
                # the branch needs an upgrade.
1843
 
                return True
1844
 
        try:
1845
 
            my_wt = self.open_workingtree(recommend_upgrade=False)
1846
 
            if not isinstance(my_wt._format,
1847
 
                              format.workingtree_format.__class__):
1848
 
                # the workingtree needs an upgrade.
1849
 
                return True
1850
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
1851
 
            pass
 
1031
        # currently there are no other possible conversions for meta1 formats.
1852
1032
        return False
1853
1033
 
1854
 
    def open_branch(self, name=None, unsupported=False,
1855
 
                    ignore_fallbacks=False):
 
1034
    def open_branch(self, unsupported=False):
1856
1035
        """See BzrDir.open_branch."""
1857
 
        format = self.find_branch_format()
 
1036
        from bzrlib.branch import BranchFormat
 
1037
        format = BranchFormat.find_format(self)
1858
1038
        self._check_supported(format, unsupported)
1859
 
        return format.open(self, name=name,
1860
 
            _found=True, ignore_fallbacks=ignore_fallbacks)
 
1039
        return format.open(self, _found=True)
1861
1040
 
1862
1041
    def open_repository(self, unsupported=False):
1863
1042
        """See BzrDir.open_repository."""
1866
1045
        self._check_supported(format, unsupported)
1867
1046
        return format.open(self, _found=True)
1868
1047
 
1869
 
    def open_workingtree(self, unsupported=False,
1870
 
            recommend_upgrade=True):
 
1048
    def open_workingtree(self, unsupported=False):
1871
1049
        """See BzrDir.open_workingtree."""
1872
1050
        from bzrlib.workingtree import WorkingTreeFormat
1873
1051
        format = WorkingTreeFormat.find_format(self)
1874
 
        self._check_supported(format, unsupported,
1875
 
            recommend_upgrade,
1876
 
            basedir=self.root_transport.base)
 
1052
        self._check_supported(format, unsupported)
1877
1053
        return format.open(self, _found=True)
1878
1054
 
1879
 
    def _get_config(self):
1880
 
        return config.TransportConfig(self.transport, 'control.conf')
1881
 
 
1882
1055
 
1883
1056
class BzrDirFormat(object):
1884
1057
    """An encapsulation of the initialization and open routines for a format.
1888
1061
     * a format string,
1889
1062
     * an open routine.
1890
1063
 
1891
 
    Formats are placed in a dict by their format string for reference
 
1064
    Formats are placed in an dict by their format string for reference 
1892
1065
    during bzrdir opening. These should be subclasses of BzrDirFormat
1893
1066
    for consistency.
1894
1067
 
1895
1068
    Once a format is deprecated, just deprecate the initialize and open
1896
 
    methods on the format class. Do not deprecate the object, as the
 
1069
    methods on the format class. Do not deprecate the object, as the 
1897
1070
    object will be created every system load.
1898
 
 
1899
 
    :cvar colocated_branches: Whether this formats supports colocated branches.
1900
1071
    """
1901
1072
 
1902
1073
    _default_format = None
1907
1078
 
1908
1079
    _control_formats = []
1909
1080
    """The registered control formats - .bzr, ....
1910
 
 
1911
 
    This is a list of BzrDirFormat objects.
1912
 
    """
1913
 
 
1914
 
    _control_server_formats = []
1915
 
    """The registered control server formats, e.g. RemoteBzrDirs.
1916
 
 
 
1081
    
1917
1082
    This is a list of BzrDirFormat objects.
1918
1083
    """
1919
1084
 
1920
1085
    _lock_file_name = 'branch-lock'
1921
1086
 
1922
 
    colocated_branches = False
1923
 
    """Whether co-located branches are supported for this control dir format.
1924
 
    """
1925
 
 
1926
1087
    # _lock_class must be set in subclasses to the lock type, typ.
1927
1088
    # TransportLock or LockDir
1928
1089
 
1929
1090
    @classmethod
1930
 
    def find_format(klass, transport, _server_formats=True):
 
1091
    def find_format(klass, transport):
1931
1092
        """Return the format present at transport."""
1932
 
        if _server_formats:
1933
 
            formats = klass._control_server_formats + klass._control_formats
1934
 
        else:
1935
 
            formats = klass._control_formats
1936
 
        for format in formats:
 
1093
        for format in klass._control_formats:
1937
1094
            try:
1938
1095
                return format.probe_transport(transport)
1939
1096
            except errors.NotBranchError:
1945
1102
    def probe_transport(klass, transport):
1946
1103
        """Return the .bzrdir style format present in a directory."""
1947
1104
        try:
1948
 
            format_string = transport.get_bytes(".bzr/branch-format")
 
1105
            format_string = transport.get(".bzr/branch-format").read()
1949
1106
        except errors.NoSuchFile:
1950
1107
            raise errors.NotBranchError(path=transport.base)
1951
1108
 
1952
1109
        try:
1953
1110
            return klass._formats[format_string]
1954
1111
        except KeyError:
1955
 
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
 
1112
            raise errors.UnknownFormatError(format=format_string)
1956
1113
 
1957
1114
    @classmethod
1958
1115
    def get_default_format(klass):
1976
1133
        current default format. In the case of plugins we can/should provide
1977
1134
        some means for them to extend the range of returnable converters.
1978
1135
 
1979
 
        :param format: Optional format to override the default format of the
 
1136
        :param format: Optional format to override the default format of the 
1980
1137
                       library.
1981
1138
        """
1982
1139
        raise NotImplementedError(self.get_converter)
1983
1140
 
1984
 
    def initialize(self, url, possible_transports=None):
 
1141
    def initialize(self, url):
1985
1142
        """Create a bzr control dir at this url and return an opened copy.
1986
 
 
1987
 
        While not deprecated, this method is very specific and its use will
1988
 
        lead to many round trips to setup a working environment. See
1989
 
        initialize_on_transport_ex for a [nearly] all-in-one method.
1990
 
 
 
1143
        
1991
1144
        Subclasses should typically override initialize_on_transport
1992
1145
        instead of this method.
1993
1146
        """
1994
 
        return self.initialize_on_transport(get_transport(url,
1995
 
                                                          possible_transports))
 
1147
        return self.initialize_on_transport(get_transport(url))
1996
1148
 
1997
1149
    def initialize_on_transport(self, transport):
1998
1150
        """Initialize a new bzrdir in the base directory of a Transport."""
1999
 
        try:
2000
 
            # can we hand off the request to the smart server rather than using
2001
 
            # vfs calls?
2002
 
            client_medium = transport.get_smart_medium()
2003
 
        except errors.NoSmartMedium:
2004
 
            return self._initialize_on_transport_vfs(transport)
2005
 
        else:
2006
 
            # Current RPC's only know how to create bzr metadir1 instances, so
2007
 
            # we still delegate to vfs methods if the requested format is not a
2008
 
            # metadir1
2009
 
            if type(self) != BzrDirMetaFormat1:
2010
 
                return self._initialize_on_transport_vfs(transport)
2011
 
            remote_format = RemoteBzrDirFormat()
2012
 
            self._supply_sub_formats_to(remote_format)
2013
 
            return remote_format.initialize_on_transport(transport)
2014
 
 
2015
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2016
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
2017
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2018
 
        shared_repo=False, vfs_only=False):
2019
 
        """Create this format on transport.
2020
 
 
2021
 
        The directory to initialize will be created.
2022
 
 
2023
 
        :param force_new_repo: Do not use a shared repository for the target,
2024
 
                               even if one is available.
2025
 
        :param create_prefix: Create any missing directories leading up to
2026
 
            to_transport.
2027
 
        :param use_existing_dir: Use an existing directory if one exists.
2028
 
        :param stacked_on: A url to stack any created branch on, None to follow
2029
 
            any target stacking policy.
2030
 
        :param stack_on_pwd: If stack_on is relative, the location it is
2031
 
            relative to.
2032
 
        :param repo_format_name: If non-None, a repository will be
2033
 
            made-or-found. Should none be found, or if force_new_repo is True
2034
 
            the repo_format_name is used to select the format of repository to
2035
 
            create.
2036
 
        :param make_working_trees: Control the setting of make_working_trees
2037
 
            for a new shared repository when one is made. None to use whatever
2038
 
            default the format has.
2039
 
        :param shared_repo: Control whether made repositories are shared or
2040
 
            not.
2041
 
        :param vfs_only: If True do not attempt to use a smart server
2042
 
        :return: repo, bzrdir, require_stacking, repository_policy. repo is
2043
 
            None if none was created or found, bzrdir is always valid.
2044
 
            require_stacking is the result of examining the stacked_on
2045
 
            parameter and any stacking policy found for the target.
2046
 
        """
2047
 
        if not vfs_only:
2048
 
            # Try to hand off to a smart server 
2049
 
            try:
2050
 
                client_medium = transport.get_smart_medium()
2051
 
            except errors.NoSmartMedium:
2052
 
                pass
2053
 
            else:
2054
 
                # TODO: lookup the local format from a server hint.
2055
 
                remote_dir_format = RemoteBzrDirFormat()
2056
 
                remote_dir_format._network_name = self.network_name()
2057
 
                self._supply_sub_formats_to(remote_dir_format)
2058
 
                return remote_dir_format.initialize_on_transport_ex(transport,
2059
 
                    use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2060
 
                    force_new_repo=force_new_repo, stacked_on=stacked_on,
2061
 
                    stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2062
 
                    make_working_trees=make_working_trees, shared_repo=shared_repo)
2063
 
        # XXX: Refactor the create_prefix/no_create_prefix code into a
2064
 
        #      common helper function
2065
 
        # The destination may not exist - if so make it according to policy.
2066
 
        def make_directory(transport):
2067
 
            transport.mkdir('.')
2068
 
            return transport
2069
 
        def redirected(transport, e, redirection_notice):
2070
 
            note(redirection_notice)
2071
 
            return transport._redirected_to(e.source, e.target)
2072
 
        try:
2073
 
            transport = do_catching_redirections(make_directory, transport,
2074
 
                redirected)
2075
 
        except errors.FileExists:
2076
 
            if not use_existing_dir:
2077
 
                raise
2078
 
        except errors.NoSuchFile:
2079
 
            if not create_prefix:
2080
 
                raise
2081
 
            transport.create_prefix()
2082
 
 
2083
 
        require_stacking = (stacked_on is not None)
2084
 
        # Now the target directory exists, but doesn't have a .bzr
2085
 
        # directory. So we need to create it, along with any work to create
2086
 
        # all of the dependent branches, etc.
2087
 
 
2088
 
        result = self.initialize_on_transport(transport)
2089
 
        if repo_format_name:
2090
 
            try:
2091
 
                # use a custom format
2092
 
                result._format.repository_format = \
2093
 
                    repository.network_format_registry.get(repo_format_name)
2094
 
            except AttributeError:
2095
 
                # The format didn't permit it to be set.
2096
 
                pass
2097
 
            # A repository is desired, either in-place or shared.
2098
 
            repository_policy = result.determine_repository_policy(
2099
 
                force_new_repo, stacked_on, stack_on_pwd,
2100
 
                require_stacking=require_stacking)
2101
 
            result_repo, is_new_repo = repository_policy.acquire_repository(
2102
 
                make_working_trees, shared_repo)
2103
 
            if not require_stacking and repository_policy._require_stacking:
2104
 
                require_stacking = True
2105
 
                result._format.require_stacking()
2106
 
            result_repo.lock_write()
2107
 
        else:
2108
 
            result_repo = None
2109
 
            repository_policy = None
2110
 
        return result_repo, result, require_stacking, repository_policy
2111
 
 
2112
 
    def _initialize_on_transport_vfs(self, transport):
2113
 
        """Initialize a new bzrdir using VFS calls.
2114
 
 
2115
 
        :param transport: The transport to create the .bzr directory in.
2116
 
        :return: A
2117
 
        """
2118
 
        # Since we are creating a .bzr directory, inherit the
 
1151
        # Since we don't have a .bzr directory, inherit the
2119
1152
        # mode from the root directory
2120
1153
        temp_control = lockable_files.LockableFiles(transport,
2121
1154
                            '', lockable_files.TransportLock)
2123
1156
                                      # FIXME: RBC 20060121 don't peek under
2124
1157
                                      # the covers
2125
1158
                                      mode=temp_control._dir_mode)
2126
 
        if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
2127
 
            win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
2128
1159
        file_mode = temp_control._file_mode
2129
1160
        del temp_control
2130
 
        bzrdir_transport = transport.clone('.bzr')
2131
 
        utf8_files = [('README',
2132
 
                       "This is a Bazaar control directory.\n"
2133
 
                       "Do not change any files in this directory.\n"
2134
 
                       "See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
 
1161
        mutter('created control directory in ' + transport.base)
 
1162
        control = transport.clone('.bzr')
 
1163
        utf8_files = [('README', 
 
1164
                       "This is a Bazaar-NG control directory.\n"
 
1165
                       "Do not change any files in this directory.\n"),
2135
1166
                      ('branch-format', self.get_format_string()),
2136
1167
                      ]
2137
1168
        # NB: no need to escape relative paths that are url safe.
2138
 
        control_files = lockable_files.LockableFiles(bzrdir_transport,
2139
 
            self._lock_file_name, self._lock_class)
 
1169
        control_files = lockable_files.LockableFiles(control,
 
1170
                            self._lock_file_name, self._lock_class)
2140
1171
        control_files.create_lock()
2141
1172
        control_files.lock_write()
2142
1173
        try:
2143
 
            for (filename, content) in utf8_files:
2144
 
                bzrdir_transport.put_bytes(filename, content,
2145
 
                    mode=file_mode)
 
1174
            for file, content in utf8_files:
 
1175
                control_files.put_utf8(file, content)
2146
1176
        finally:
2147
1177
            control_files.unlock()
2148
1178
        return self.open(transport, _found=True)
2151
1181
        """Is this format supported?
2152
1182
 
2153
1183
        Supported formats must be initializable and openable.
2154
 
        Unsupported formats may not support initialization or committing or
 
1184
        Unsupported formats may not support initialization or committing or 
2155
1185
        some other features depending on the reason for not being supported.
2156
1186
        """
2157
1187
        return True
2158
1188
 
2159
 
    def network_name(self):
2160
 
        """A simple byte string uniquely identifying this format for RPC calls.
2161
 
 
2162
 
        Bzr control formats use thir disk format string to identify the format
2163
 
        over the wire. Its possible that other control formats have more
2164
 
        complex detection requirements, so we permit them to use any unique and
2165
 
        immutable string they desire.
2166
 
        """
2167
 
        raise NotImplementedError(self.network_name)
2168
 
 
2169
1189
    def same_model(self, target_format):
2170
 
        return (self.repository_format.rich_root_data ==
 
1190
        return (self.repository_format.rich_root_data == 
2171
1191
            target_format.rich_root_data)
2172
1192
 
2173
1193
    @classmethod
2174
1194
    def known_formats(klass):
2175
1195
        """Return all the known formats.
2176
 
 
 
1196
        
2177
1197
        Concrete formats should override _known_formats.
2178
1198
        """
2179
 
        # There is double indirection here to make sure that control
2180
 
        # formats used by more than one dir format will only be probed
 
1199
        # There is double indirection here to make sure that control 
 
1200
        # formats used by more than one dir format will only be probed 
2181
1201
        # once. This can otherwise be quite expensive for remote connections.
2182
1202
        result = set()
2183
1203
        for format in klass._control_formats:
2184
1204
            result.update(format._known_formats())
2185
1205
        return result
2186
 
 
 
1206
    
2187
1207
    @classmethod
2188
1208
    def _known_formats(klass):
2189
1209
        """Return the known format instances for this control format."""
2191
1211
 
2192
1212
    def open(self, transport, _found=False):
2193
1213
        """Return an instance of this format for the dir transport points at.
2194
 
 
 
1214
        
2195
1215
        _found is a private parameter, do not use it.
2196
1216
        """
2197
1217
        if not _found:
2198
1218
            found_format = BzrDirFormat.find_format(transport)
2199
1219
            if not isinstance(found_format, self.__class__):
2200
1220
                raise AssertionError("%s was asked to open %s, but it seems to need "
2201
 
                        "format %s"
 
1221
                        "format %s" 
2202
1222
                        % (self, transport, found_format))
2203
 
            # Allow subclasses - use the found format.
2204
 
            self._supply_sub_formats_to(found_format)
2205
 
            return found_format._open(transport)
2206
1223
        return self._open(transport)
2207
1224
 
2208
1225
    def _open(self, transport):
2216
1233
    @classmethod
2217
1234
    def register_format(klass, format):
2218
1235
        klass._formats[format.get_format_string()] = format
2219
 
        # bzr native formats have a network name of their format string.
2220
 
        network_format_registry.register(format.get_format_string(), format.__class__)
2221
1236
 
2222
1237
    @classmethod
2223
1238
    def register_control_format(klass, format):
2224
 
        """Register a format that does not use '.bzr' for its control dir.
 
1239
        """Register a format that does not use '.bzrdir' for its control dir.
2225
1240
 
2226
1241
        TODO: This should be pulled up into a 'ControlDirFormat' base class
2227
 
        which BzrDirFormat can inherit from, and renamed to register_format
 
1242
        which BzrDirFormat can inherit from, and renamed to register_format 
2228
1243
        there. It has been done without that for now for simplicity of
2229
1244
        implementation.
2230
1245
        """
2231
1246
        klass._control_formats.append(format)
2232
1247
 
2233
1248
    @classmethod
2234
 
    def register_control_server_format(klass, format):
2235
 
        """Register a control format for client-server environments.
2236
 
 
2237
 
        These formats will be tried before ones registered with
2238
 
        register_control_format.  This gives implementations that decide to the
2239
 
        chance to grab it before anything looks at the contents of the format
2240
 
        file.
2241
 
        """
2242
 
        klass._control_server_formats.append(format)
 
1249
    @symbol_versioning.deprecated_method(symbol_versioning.zero_fourteen)
 
1250
    def set_default_format(klass, format):
 
1251
        klass._set_default_format(format)
2243
1252
 
2244
1253
    @classmethod
2245
1254
    def _set_default_format(klass, format):
2247
1256
        klass._default_format = format
2248
1257
 
2249
1258
    def __str__(self):
2250
 
        # Trim the newline
2251
 
        return self.get_format_description().rstrip()
2252
 
 
2253
 
    def _supply_sub_formats_to(self, other_format):
2254
 
        """Give other_format the same values for sub formats as this has.
2255
 
 
2256
 
        This method is expected to be used when parameterising a
2257
 
        RemoteBzrDirFormat instance with the parameters from a
2258
 
        BzrDirMetaFormat1 instance.
2259
 
 
2260
 
        :param other_format: other_format is a format which should be
2261
 
            compatible with whatever sub formats are supported by self.
2262
 
        :return: None.
2263
 
        """
 
1259
        return self.get_format_string()[:-1]
2264
1260
 
2265
1261
    @classmethod
2266
1262
    def unregister_format(klass, format):
 
1263
        assert klass._formats[format.get_format_string()] is format
2267
1264
        del klass._formats[format.get_format_string()]
2268
1265
 
2269
1266
    @classmethod
2271
1268
        klass._control_formats.remove(format)
2272
1269
 
2273
1270
 
 
1271
# register BzrDirFormat as a control format
 
1272
BzrDirFormat.register_control_format(BzrDirFormat)
 
1273
 
 
1274
 
2274
1275
class BzrDirFormat4(BzrDirFormat):
2275
1276
    """Bzr dir format 4.
2276
1277
 
2298
1299
        """See BzrDirFormat.get_converter()."""
2299
1300
        # there is one and only one upgrade path here.
2300
1301
        return ConvertBzrDir4To5()
2301
 
 
 
1302
        
2302
1303
    def initialize_on_transport(self, transport):
2303
1304
        """Format 4 branches cannot be created."""
2304
1305
        raise errors.UninitializableFormat(self)
2307
1308
        """Format 4 is not supported.
2308
1309
 
2309
1310
        It is not supported because the model changed from 4 to 5 and the
2310
 
        conversion logic is expensive - so doing it on the fly was not
 
1311
        conversion logic is expensive - so doing it on the fly was not 
2311
1312
        feasible.
2312
1313
        """
2313
1314
        return False
2314
1315
 
2315
 
    def network_name(self):
2316
 
        return self.get_format_string()
2317
 
 
2318
1316
    def _open(self, transport):
2319
1317
        """See BzrDirFormat._open."""
2320
1318
        return BzrDir4(transport, self)
2321
1319
 
2322
1320
    def __return_repository_format(self):
2323
1321
        """Circular import protection."""
2324
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
1322
        from bzrlib.repository import RepositoryFormat4
2325
1323
        return RepositoryFormat4()
2326
1324
    repository_format = property(__return_repository_format)
2327
1325
 
2328
1326
 
2329
 
class BzrDirFormatAllInOne(BzrDirFormat):
2330
 
    """Common class for formats before meta-dirs."""
2331
 
 
2332
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2333
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
2334
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2335
 
        shared_repo=False):
2336
 
        """See BzrDirFormat.initialize_on_transport_ex."""
2337
 
        require_stacking = (stacked_on is not None)
2338
 
        # Format 5 cannot stack, but we've been asked to - actually init
2339
 
        # a Meta1Dir
2340
 
        if require_stacking:
2341
 
            format = BzrDirMetaFormat1()
2342
 
            return format.initialize_on_transport_ex(transport,
2343
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2344
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
2345
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2346
 
                make_working_trees=make_working_trees, shared_repo=shared_repo)
2347
 
        return BzrDirFormat.initialize_on_transport_ex(self, transport,
2348
 
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2349
 
            force_new_repo=force_new_repo, stacked_on=stacked_on,
2350
 
            stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2351
 
            make_working_trees=make_working_trees, shared_repo=shared_repo)
2352
 
 
2353
 
 
2354
 
class BzrDirFormat5(BzrDirFormatAllInOne):
 
1327
class BzrDirFormat5(BzrDirFormat):
2355
1328
    """Bzr control format 5.
2356
1329
 
2357
1330
    This format is a combined format for working tree, branch and repository.
2358
1331
    It has:
2359
 
     - Format 2 working trees [always]
2360
 
     - Format 4 branches [always]
 
1332
     - Format 2 working trees [always] 
 
1333
     - Format 4 branches [always] 
2361
1334
     - Format 5 repositories [always]
2362
1335
       Unhashed stores in the repository.
2363
1336
    """
2368
1341
        """See BzrDirFormat.get_format_string()."""
2369
1342
        return "Bazaar-NG branch, format 5\n"
2370
1343
 
2371
 
    def get_branch_format(self):
2372
 
        from bzrlib import branch
2373
 
        return branch.BzrBranchFormat4()
2374
 
 
2375
1344
    def get_format_description(self):
2376
1345
        """See BzrDirFormat.get_format_description()."""
2377
1346
        return "All-in-one format 5"
2383
1352
 
2384
1353
    def _initialize_for_clone(self, url):
2385
1354
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2386
 
 
 
1355
        
2387
1356
    def initialize_on_transport(self, transport, _cloning=False):
2388
1357
        """Format 5 dirs always have working tree, branch and repository.
2389
 
 
 
1358
        
2390
1359
        Except when they are being cloned.
2391
1360
        """
2392
1361
        from bzrlib.branch import BzrBranchFormat4
2393
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1362
        from bzrlib.repository import RepositoryFormat5
 
1363
        from bzrlib.workingtree import WorkingTreeFormat2
2394
1364
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2395
1365
        RepositoryFormat5().initialize(result, _internal=True)
2396
1366
        if not _cloning:
2397
1367
            branch = BzrBranchFormat4().initialize(result)
2398
 
            result._init_workingtree()
 
1368
            try:
 
1369
                WorkingTreeFormat2().initialize(result)
 
1370
            except errors.NotLocalUrl:
 
1371
                # Even though we can't access the working tree, we need to
 
1372
                # create its control files.
 
1373
                WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
2399
1374
        return result
2400
1375
 
2401
 
    def network_name(self):
2402
 
        return self.get_format_string()
2403
 
 
2404
1376
    def _open(self, transport):
2405
1377
        """See BzrDirFormat._open."""
2406
1378
        return BzrDir5(transport, self)
2407
1379
 
2408
1380
    def __return_repository_format(self):
2409
1381
        """Circular import protection."""
2410
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1382
        from bzrlib.repository import RepositoryFormat5
2411
1383
        return RepositoryFormat5()
2412
1384
    repository_format = property(__return_repository_format)
2413
1385
 
2414
1386
 
2415
 
class BzrDirFormat6(BzrDirFormatAllInOne):
 
1387
class BzrDirFormat6(BzrDirFormat):
2416
1388
    """Bzr control format 6.
2417
1389
 
2418
1390
    This format is a combined format for working tree, branch and repository.
2419
1391
    It has:
2420
 
     - Format 2 working trees [always]
2421
 
     - Format 4 branches [always]
 
1392
     - Format 2 working trees [always] 
 
1393
     - Format 4 branches [always] 
2422
1394
     - Format 6 repositories [always]
2423
1395
    """
2424
1396
 
2432
1404
        """See BzrDirFormat.get_format_description()."""
2433
1405
        return "All-in-one format 6"
2434
1406
 
2435
 
    def get_branch_format(self):
2436
 
        from bzrlib import branch
2437
 
        return branch.BzrBranchFormat4()
2438
 
 
2439
1407
    def get_converter(self, format=None):
2440
1408
        """See BzrDirFormat.get_converter()."""
2441
1409
        # there is one and only one upgrade path here.
2442
1410
        return ConvertBzrDir6ToMeta()
2443
 
 
 
1411
        
2444
1412
    def _initialize_for_clone(self, url):
2445
1413
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2446
1414
 
2447
1415
    def initialize_on_transport(self, transport, _cloning=False):
2448
1416
        """Format 6 dirs always have working tree, branch and repository.
2449
 
 
 
1417
        
2450
1418
        Except when they are being cloned.
2451
1419
        """
2452
1420
        from bzrlib.branch import BzrBranchFormat4
2453
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1421
        from bzrlib.repository import RepositoryFormat6
 
1422
        from bzrlib.workingtree import WorkingTreeFormat2
2454
1423
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2455
1424
        RepositoryFormat6().initialize(result, _internal=True)
2456
1425
        if not _cloning:
2457
1426
            branch = BzrBranchFormat4().initialize(result)
2458
 
            result._init_workingtree()
 
1427
            try:
 
1428
                WorkingTreeFormat2().initialize(result)
 
1429
            except errors.NotLocalUrl:
 
1430
                # Even though we can't access the working tree, we need to
 
1431
                # create its control files.
 
1432
                WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
2459
1433
        return result
2460
1434
 
2461
 
    def network_name(self):
2462
 
        return self.get_format_string()
2463
 
 
2464
1435
    def _open(self, transport):
2465
1436
        """See BzrDirFormat._open."""
2466
1437
        return BzrDir6(transport, self)
2467
1438
 
2468
1439
    def __return_repository_format(self):
2469
1440
        """Circular import protection."""
2470
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1441
        from bzrlib.repository import RepositoryFormat6
2471
1442
        return RepositoryFormat6()
2472
1443
    repository_format = property(__return_repository_format)
2473
1444
 
2485
1456
 
2486
1457
    _lock_class = lockdir.LockDir
2487
1458
 
2488
 
    def __init__(self):
2489
 
        self._workingtree_format = None
2490
 
        self._branch_format = None
2491
 
        self._repository_format = None
2492
 
 
2493
 
    def __eq__(self, other):
2494
 
        if other.__class__ is not self.__class__:
2495
 
            return False
2496
 
        if other.repository_format != self.repository_format:
2497
 
            return False
2498
 
        if other.workingtree_format != self.workingtree_format:
2499
 
            return False
2500
 
        return True
2501
 
 
2502
 
    def __ne__(self, other):
2503
 
        return not self == other
2504
 
 
2505
 
    def get_branch_format(self):
2506
 
        if self._branch_format is None:
2507
 
            from bzrlib.branch import BranchFormat
2508
 
            self._branch_format = BranchFormat.get_default_format()
2509
 
        return self._branch_format
2510
 
 
2511
 
    def set_branch_format(self, format):
2512
 
        self._branch_format = format
2513
 
 
2514
 
    def require_stacking(self, stack_on=None, possible_transports=None,
2515
 
            _skip_repo=False):
2516
 
        """We have a request to stack, try to ensure the formats support it.
2517
 
 
2518
 
        :param stack_on: If supplied, it is the URL to a branch that we want to
2519
 
            stack on. Check to see if that format supports stacking before
2520
 
            forcing an upgrade.
2521
 
        """
2522
 
        # Stacking is desired. requested by the target, but does the place it
2523
 
        # points at support stacking? If it doesn't then we should
2524
 
        # not implicitly upgrade. We check this here.
2525
 
        new_repo_format = None
2526
 
        new_branch_format = None
2527
 
 
2528
 
        # a bit of state for get_target_branch so that we don't try to open it
2529
 
        # 2 times, for both repo *and* branch
2530
 
        target = [None, False, None] # target_branch, checked, upgrade anyway
2531
 
        def get_target_branch():
2532
 
            if target[1]:
2533
 
                # We've checked, don't check again
2534
 
                return target
2535
 
            if stack_on is None:
2536
 
                # No target format, that means we want to force upgrading
2537
 
                target[:] = [None, True, True]
2538
 
                return target
2539
 
            try:
2540
 
                target_dir = BzrDir.open(stack_on,
2541
 
                    possible_transports=possible_transports)
2542
 
            except errors.NotBranchError:
2543
 
                # Nothing there, don't change formats
2544
 
                target[:] = [None, True, False]
2545
 
                return target
2546
 
            except errors.JailBreak:
2547
 
                # JailBreak, JFDI and upgrade anyway
2548
 
                target[:] = [None, True, True]
2549
 
                return target
2550
 
            try:
2551
 
                target_branch = target_dir.open_branch()
2552
 
            except errors.NotBranchError:
2553
 
                # No branch, don't upgrade formats
2554
 
                target[:] = [None, True, False]
2555
 
                return target
2556
 
            target[:] = [target_branch, True, False]
2557
 
            return target
2558
 
 
2559
 
        if (not _skip_repo and
2560
 
                 not self.repository_format.supports_external_lookups):
2561
 
            # We need to upgrade the Repository.
2562
 
            target_branch, _, do_upgrade = get_target_branch()
2563
 
            if target_branch is None:
2564
 
                # We don't have a target branch, should we upgrade anyway?
2565
 
                if do_upgrade:
2566
 
                    # stack_on is inaccessible, JFDI.
2567
 
                    # TODO: bad monkey, hard-coded formats...
2568
 
                    if self.repository_format.rich_root_data:
2569
 
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2570
 
                    else:
2571
 
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5()
2572
 
            else:
2573
 
                # If the target already supports stacking, then we know the
2574
 
                # project is already able to use stacking, so auto-upgrade
2575
 
                # for them
2576
 
                new_repo_format = target_branch.repository._format
2577
 
                if not new_repo_format.supports_external_lookups:
2578
 
                    # target doesn't, source doesn't, so don't auto upgrade
2579
 
                    # repo
2580
 
                    new_repo_format = None
2581
 
            if new_repo_format is not None:
2582
 
                self.repository_format = new_repo_format
2583
 
                note('Source repository format does not support stacking,'
2584
 
                     ' using format:\n  %s',
2585
 
                     new_repo_format.get_format_description())
2586
 
 
2587
 
        if not self.get_branch_format().supports_stacking():
2588
 
            # We just checked the repo, now lets check if we need to
2589
 
            # upgrade the branch format
2590
 
            target_branch, _, do_upgrade = get_target_branch()
2591
 
            if target_branch is None:
2592
 
                if do_upgrade:
2593
 
                    # TODO: bad monkey, hard-coded formats...
2594
 
                    new_branch_format = branch.BzrBranchFormat7()
2595
 
            else:
2596
 
                new_branch_format = target_branch._format
2597
 
                if not new_branch_format.supports_stacking():
2598
 
                    new_branch_format = None
2599
 
            if new_branch_format is not None:
2600
 
                # Does support stacking, use its format.
2601
 
                self.set_branch_format(new_branch_format)
2602
 
                note('Source branch format does not support stacking,'
2603
 
                     ' using format:\n  %s',
2604
 
                     new_branch_format.get_format_description())
2605
 
 
2606
1459
    def get_converter(self, format=None):
2607
1460
        """See BzrDirFormat.get_converter()."""
2608
1461
        if format is None:
2620
1473
        """See BzrDirFormat.get_format_description()."""
2621
1474
        return "Meta directory format 1"
2622
1475
 
2623
 
    def network_name(self):
2624
 
        return self.get_format_string()
2625
 
 
2626
1476
    def _open(self, transport):
2627
1477
        """See BzrDirFormat._open."""
2628
 
        # Create a new format instance because otherwise initialisation of new
2629
 
        # metadirs share the global default format object leading to alias
2630
 
        # problems.
2631
 
        format = BzrDirMetaFormat1()
2632
 
        self._supply_sub_formats_to(format)
2633
 
        return BzrDirMeta1(transport, format)
 
1478
        return BzrDirMeta1(transport, self)
2634
1479
 
2635
1480
    def __return_repository_format(self):
2636
1481
        """Circular import protection."""
2637
 
        if self._repository_format:
 
1482
        if getattr(self, '_repository_format', None):
2638
1483
            return self._repository_format
2639
1484
        from bzrlib.repository import RepositoryFormat
2640
1485
        return RepositoryFormat.get_default_format()
2641
1486
 
2642
 
    def _set_repository_format(self, value):
2643
 
        """Allow changing the repository format for metadir formats."""
 
1487
    def __set_repository_format(self, value):
 
1488
        """Allow changint the repository format for metadir formats."""
2644
1489
        self._repository_format = value
2645
1490
 
2646
 
    repository_format = property(__return_repository_format,
2647
 
        _set_repository_format)
2648
 
 
2649
 
    def _supply_sub_formats_to(self, other_format):
2650
 
        """Give other_format the same values for sub formats as this has.
2651
 
 
2652
 
        This method is expected to be used when parameterising a
2653
 
        RemoteBzrDirFormat instance with the parameters from a
2654
 
        BzrDirMetaFormat1 instance.
2655
 
 
2656
 
        :param other_format: other_format is a format which should be
2657
 
            compatible with whatever sub formats are supported by self.
2658
 
        :return: None.
2659
 
        """
2660
 
        if getattr(self, '_repository_format', None) is not None:
2661
 
            other_format.repository_format = self.repository_format
2662
 
        if self._branch_format is not None:
2663
 
            other_format._branch_format = self._branch_format
2664
 
        if self._workingtree_format is not None:
2665
 
            other_format.workingtree_format = self.workingtree_format
2666
 
 
2667
 
    def __get_workingtree_format(self):
2668
 
        if self._workingtree_format is None:
2669
 
            from bzrlib.workingtree import WorkingTreeFormat
2670
 
            self._workingtree_format = WorkingTreeFormat.get_default_format()
2671
 
        return self._workingtree_format
2672
 
 
2673
 
    def __set_workingtree_format(self, wt_format):
2674
 
        self._workingtree_format = wt_format
2675
 
 
2676
 
    workingtree_format = property(__get_workingtree_format,
2677
 
                                  __set_workingtree_format)
2678
 
 
2679
 
 
2680
 
network_format_registry = registry.FormatRegistry()
2681
 
"""Registry of formats indexed by their network name.
2682
 
 
2683
 
The network name for a BzrDirFormat is an identifier that can be used when
2684
 
referring to formats with smart server operations. See
2685
 
BzrDirFormat.network_name() for more detail.
2686
 
"""
2687
 
 
2688
 
 
2689
 
# Register bzr control format
2690
 
BzrDirFormat.register_control_format(BzrDirFormat)
2691
 
 
2692
 
# Register bzr formats
 
1491
    repository_format = property(__return_repository_format, __set_repository_format)
 
1492
 
 
1493
 
2693
1494
BzrDirFormat.register_format(BzrDirFormat4())
2694
1495
BzrDirFormat.register_format(BzrDirFormat5())
2695
1496
BzrDirFormat.register_format(BzrDirFormat6())
2698
1499
BzrDirFormat._default_format = __default_format
2699
1500
 
2700
1501
 
 
1502
class BzrDirTestProviderAdapter(object):
 
1503
    """A tool to generate a suite testing multiple bzrdir formats at once.
 
1504
 
 
1505
    This is done by copying the test once for each transport and injecting
 
1506
    the transport_server, transport_readonly_server, and bzrdir_format
 
1507
    classes into each copy. Each copy is also given a new id() to make it
 
1508
    easy to identify.
 
1509
    """
 
1510
 
 
1511
    def __init__(self, vfs_factory, transport_server, transport_readonly_server,
 
1512
        formats):
 
1513
        """Create an object to adapt tests.
 
1514
 
 
1515
        :param vfs_server: A factory to create a Transport Server which has
 
1516
            all the VFS methods working, and is writable.
 
1517
        """
 
1518
        self._vfs_factory = vfs_factory
 
1519
        self._transport_server = transport_server
 
1520
        self._transport_readonly_server = transport_readonly_server
 
1521
        self._formats = formats
 
1522
    
 
1523
    def adapt(self, test):
 
1524
        result = unittest.TestSuite()
 
1525
        for format in self._formats:
 
1526
            new_test = deepcopy(test)
 
1527
            new_test.vfs_transport_factory = self._vfs_factory
 
1528
            new_test.transport_server = self._transport_server
 
1529
            new_test.transport_readonly_server = self._transport_readonly_server
 
1530
            new_test.bzrdir_format = format
 
1531
            def make_new_test_id():
 
1532
                new_id = "%s(%s)" % (new_test.id(), format.__class__.__name__)
 
1533
                return lambda: new_id
 
1534
            new_test.id = make_new_test_id()
 
1535
            result.addTest(new_test)
 
1536
        return result
 
1537
 
 
1538
 
2701
1539
class Converter(object):
2702
1540
    """Converts a disk format object from one format to another."""
2703
1541
 
2723
1561
        self.absent_revisions = set()
2724
1562
        self.text_count = 0
2725
1563
        self.revisions = {}
2726
 
 
 
1564
        
2727
1565
    def convert(self, to_convert, pb):
2728
1566
        """See Converter.convert()."""
2729
1567
        self.bzrdir = to_convert
2730
 
        if pb is not None:
2731
 
            warnings.warn("pb parameter to convert() is deprecated")
2732
 
        self.pb = ui.ui_factory.nested_progress_bar()
2733
 
        try:
2734
 
            ui.ui_factory.note('starting upgrade from format 4 to 5')
2735
 
            if isinstance(self.bzrdir.transport, local.LocalTransport):
2736
 
                self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2737
 
            self._convert_to_weaves()
2738
 
            return BzrDir.open(self.bzrdir.user_url)
2739
 
        finally:
2740
 
            self.pb.finished()
 
1568
        self.pb = pb
 
1569
        self.pb.note('starting upgrade from format 4 to 5')
 
1570
        if isinstance(self.bzrdir.transport, LocalTransport):
 
1571
            self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
 
1572
        self._convert_to_weaves()
 
1573
        return BzrDir.open(self.bzrdir.root_transport.base)
2741
1574
 
2742
1575
    def _convert_to_weaves(self):
2743
 
        ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
 
1576
        self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2744
1577
        try:
2745
1578
            # TODO permissions
2746
1579
            stat = self.bzrdir.transport.stat('weaves')
2774
1607
        self.pb.clear()
2775
1608
        self._write_all_weaves()
2776
1609
        self._write_all_revs()
2777
 
        ui.ui_factory.note('upgraded to weaves:')
2778
 
        ui.ui_factory.note('  %6d revisions and inventories' % len(self.revisions))
2779
 
        ui.ui_factory.note('  %6d revisions not present' % len(self.absent_revisions))
2780
 
        ui.ui_factory.note('  %6d texts' % self.text_count)
 
1610
        self.pb.note('upgraded to weaves:')
 
1611
        self.pb.note('  %6d revisions and inventories', len(self.revisions))
 
1612
        self.pb.note('  %6d revisions not present', len(self.absent_revisions))
 
1613
        self.pb.note('  %6d texts', self.text_count)
2781
1614
        self._cleanup_spare_files_after_format4()
2782
 
        self.branch._transport.put_bytes(
2783
 
            'branch-format',
2784
 
            BzrDirFormat5().get_format_string(),
2785
 
            mode=self.bzrdir._get_file_mode())
 
1615
        self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
2786
1616
 
2787
1617
    def _cleanup_spare_files_after_format4(self):
2788
1618
        # FIXME working tree upgrade foo.
2797
1627
 
2798
1628
    def _convert_working_inv(self):
2799
1629
        inv = xml4.serializer_v4.read_inventory(
2800
 
                self.branch._transport.get('inventory'))
2801
 
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2802
 
        self.branch._transport.put_bytes('inventory', new_inv_xml,
2803
 
            mode=self.bzrdir._get_file_mode())
 
1630
                    self.branch.control_files.get('inventory'))
 
1631
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
 
1632
        # FIXME inventory is a working tree change.
 
1633
        self.branch.control_files.put('inventory', StringIO(new_inv_xml))
2804
1634
 
2805
1635
    def _write_all_weaves(self):
2806
1636
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2826
1656
        self.bzrdir.transport.mkdir('revision-store')
2827
1657
        revision_transport = self.bzrdir.transport.clone('revision-store')
2828
1658
        # TODO permissions
2829
 
        from bzrlib.xml5 import serializer_v5
2830
 
        from bzrlib.repofmt.weaverepo import RevisionTextStore
2831
 
        revision_store = RevisionTextStore(revision_transport,
2832
 
            serializer_v5, False, versionedfile.PrefixMapper(),
2833
 
            lambda:True, lambda:True)
 
1659
        _revision_store = TextRevisionStore(TextStore(revision_transport,
 
1660
                                                      prefixed=False,
 
1661
                                                      compressed=True))
2834
1662
        try:
 
1663
            transaction = WriteTransaction()
2835
1664
            for i, rev_id in enumerate(self.converted_revs):
2836
1665
                self.pb.update('write revision', i, len(self.converted_revs))
2837
 
                text = serializer_v5.write_revision_to_string(
2838
 
                    self.revisions[rev_id])
2839
 
                key = (rev_id,)
2840
 
                revision_store.add_lines(key, None, osutils.split_lines(text))
 
1666
                _revision_store.add_revision(self.revisions[rev_id], transaction)
2841
1667
        finally:
2842
1668
            self.pb.clear()
2843
 
 
 
1669
            
2844
1670
    def _load_one_rev(self, rev_id):
2845
1671
        """Load a revision object into memory.
2846
1672
 
2851
1677
                       len(self.known_revisions))
2852
1678
        if not self.branch.repository.has_revision(rev_id):
2853
1679
            self.pb.clear()
2854
 
            ui.ui_factory.note('revision {%s} not present in branch; '
2855
 
                         'will be converted as a ghost' %
 
1680
            self.pb.note('revision {%s} not present in branch; '
 
1681
                         'will be converted as a ghost',
2856
1682
                         rev_id)
2857
1683
            self.absent_revisions.add(rev_id)
2858
1684
        else:
2859
 
            rev = self.branch.repository.get_revision(rev_id)
 
1685
            rev = self.branch.repository._revision_store.get_revision(rev_id,
 
1686
                self.branch.repository.get_transaction())
2860
1687
            for parent_id in rev.parent_ids:
2861
1688
                self.known_revisions.add(parent_id)
2862
1689
                self.to_read.append(parent_id)
2863
1690
            self.revisions[rev_id] = rev
2864
1691
 
2865
1692
    def _load_old_inventory(self, rev_id):
 
1693
        assert rev_id not in self.converted_revs
2866
1694
        old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2867
1695
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2868
1696
        inv.revision_id = rev_id
2869
1697
        rev = self.revisions[rev_id]
 
1698
        if rev.inventory_sha1:
 
1699
            assert rev.inventory_sha1 == sha_string(old_inv_xml), \
 
1700
                'inventory sha mismatch for {%s}' % rev_id
2870
1701
        return inv
2871
1702
 
2872
1703
    def _load_updated_inventory(self, rev_id):
 
1704
        assert rev_id in self.converted_revs
2873
1705
        inv_xml = self.inv_weave.get_text(rev_id)
2874
 
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
 
1706
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml)
2875
1707
        return inv
2876
1708
 
2877
1709
    def _convert_one_rev(self, rev_id):
2881
1713
        present_parents = [p for p in rev.parent_ids
2882
1714
                           if p not in self.absent_revisions]
2883
1715
        self._convert_revision_contents(rev, inv, present_parents)
2884
 
        self._store_new_inv(rev, inv, present_parents)
 
1716
        self._store_new_weave(rev, inv, present_parents)
2885
1717
        self.converted_revs.add(rev_id)
2886
1718
 
2887
 
    def _store_new_inv(self, rev, inv, present_parents):
 
1719
    def _store_new_weave(self, rev, inv, present_parents):
 
1720
        # the XML is now updated with text versions
 
1721
        if __debug__:
 
1722
            entries = inv.iter_entries()
 
1723
            entries.next()
 
1724
            for path, ie in entries:
 
1725
                assert getattr(ie, 'revision', None) is not None, \
 
1726
                    'no revision on {%s} in {%s}' % \
 
1727
                    (file_id, rev.revision_id)
2888
1728
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2889
1729
        new_inv_sha1 = sha_string(new_inv_xml)
2890
 
        self.inv_weave.add_lines(rev.revision_id,
 
1730
        self.inv_weave.add_lines(rev.revision_id, 
2891
1731
                                 present_parents,
2892
1732
                                 new_inv_xml.splitlines(True))
2893
1733
        rev.inventory_sha1 = new_inv_sha1
2918
1758
            w = Weave(file_id)
2919
1759
            self.text_weaves[file_id] = w
2920
1760
        text_changed = False
2921
 
        parent_candiate_entries = ie.parent_candidates(parent_invs)
2922
 
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2923
 
        # XXX: Note that this is unordered - and this is tolerable because
2924
 
        # the previous code was also unordered.
2925
 
        previous_entries = dict((head, parent_candiate_entries[head]) for head
2926
 
            in heads)
 
1761
        previous_entries = ie.find_previous_heads(parent_invs,
 
1762
                                                  None,
 
1763
                                                  None,
 
1764
                                                  entry_vf=w)
 
1765
        for old_revision in previous_entries:
 
1766
                # if this fails, its a ghost ?
 
1767
                assert old_revision in self.converted_revs, \
 
1768
                    "Revision {%s} not in converted_revs" % old_revision
2927
1769
        self.snapshot_ie(previous_entries, ie, w, rev_id)
2928
1770
        del ie.text_id
2929
 
 
2930
 
    def get_parent_map(self, revision_ids):
2931
 
        """See graph.StackedParentsProvider.get_parent_map"""
2932
 
        return dict((revision_id, self.revisions[revision_id])
2933
 
                    for revision_id in revision_ids
2934
 
                     if revision_id in self.revisions)
 
1771
        assert getattr(ie, 'revision', None) is not None
2935
1772
 
2936
1773
    def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2937
1774
        # TODO: convert this logic, which is ~= snapshot to
2938
1775
        # a call to:. This needs the path figured out. rather than a work_tree
2939
1776
        # a v4 revision_tree can be given, or something that looks enough like
2940
1777
        # one to give the file content to the entry if it needs it.
2941
 
        # and we need something that looks like a weave store for snapshot to
 
1778
        # and we need something that looks like a weave store for snapshot to 
2942
1779
        # save against.
2943
1780
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2944
1781
        if len(previous_revisions) == 1:
2947
1784
                ie.revision = previous_ie.revision
2948
1785
                return
2949
1786
        if ie.has_text():
2950
 
            text = self.branch.repository._text_store.get(ie.text_id)
 
1787
            text = self.branch.repository.text_store.get(ie.text_id)
2951
1788
            file_lines = text.readlines()
 
1789
            assert sha_strings(file_lines) == ie.text_sha1
 
1790
            assert sum(map(len, file_lines)) == ie.text_size
2952
1791
            w.add_lines(rev_id, previous_revisions, file_lines)
2953
1792
            self.text_count += 1
2954
1793
        else:
2984
1823
    def convert(self, to_convert, pb):
2985
1824
        """See Converter.convert()."""
2986
1825
        self.bzrdir = to_convert
2987
 
        pb = ui.ui_factory.nested_progress_bar()
2988
 
        try:
2989
 
            ui.ui_factory.note('starting upgrade from format 5 to 6')
2990
 
            self._convert_to_prefixed()
2991
 
            return BzrDir.open(self.bzrdir.user_url)
2992
 
        finally:
2993
 
            pb.finished()
 
1826
        self.pb = pb
 
1827
        self.pb.note('starting upgrade from format 5 to 6')
 
1828
        self._convert_to_prefixed()
 
1829
        return BzrDir.open(self.bzrdir.root_transport.base)
2994
1830
 
2995
1831
    def _convert_to_prefixed(self):
2996
1832
        from bzrlib.store import TransportStore
2997
1833
        self.bzrdir.transport.delete('branch-format')
2998
1834
        for store_name in ["weaves", "revision-store"]:
2999
 
            ui.ui_factory.note("adding prefixes to %s" % store_name)
 
1835
            self.pb.note("adding prefixes to %s" % store_name)
3000
1836
            store_transport = self.bzrdir.transport.clone(store_name)
3001
1837
            store = TransportStore(store_transport, prefixed=True)
3002
1838
            for urlfilename in store_transport.list_dir('.'):
3004
1840
                if (filename.endswith(".weave") or
3005
1841
                    filename.endswith(".gz") or
3006
1842
                    filename.endswith(".sig")):
3007
 
                    file_id, suffix = os.path.splitext(filename)
 
1843
                    file_id = os.path.splitext(filename)[0]
3008
1844
                else:
3009
1845
                    file_id = filename
3010
 
                    suffix = ''
3011
 
                new_name = store._mapper.map((file_id,)) + suffix
 
1846
                prefix_dir = store.hash_prefix(file_id)
3012
1847
                # FIXME keep track of the dirs made RBC 20060121
3013
1848
                try:
3014
 
                    store_transport.move(filename, new_name)
 
1849
                    store_transport.move(filename, prefix_dir + '/' + filename)
3015
1850
                except errors.NoSuchFile: # catches missing dirs strangely enough
3016
 
                    store_transport.mkdir(osutils.dirname(new_name))
3017
 
                    store_transport.move(filename, new_name)
3018
 
        self.bzrdir.transport.put_bytes(
3019
 
            'branch-format',
3020
 
            BzrDirFormat6().get_format_string(),
3021
 
            mode=self.bzrdir._get_file_mode())
 
1851
                    store_transport.mkdir(prefix_dir)
 
1852
                    store_transport.move(filename, prefix_dir + '/' + filename)
 
1853
        self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
3022
1854
 
3023
1855
 
3024
1856
class ConvertBzrDir6ToMeta(Converter):
3026
1858
 
3027
1859
    def convert(self, to_convert, pb):
3028
1860
        """See Converter.convert()."""
3029
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
3030
1861
        from bzrlib.branch import BzrBranchFormat5
3031
1862
        self.bzrdir = to_convert
3032
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
1863
        self.pb = pb
3033
1864
        self.count = 0
3034
1865
        self.total = 20 # the steps we know about
3035
1866
        self.garbage_inventories = []
3036
 
        self.dir_mode = self.bzrdir._get_dir_mode()
3037
 
        self.file_mode = self.bzrdir._get_file_mode()
3038
1867
 
3039
 
        ui.ui_factory.note('starting upgrade from format 6 to metadir')
3040
 
        self.bzrdir.transport.put_bytes(
3041
 
                'branch-format',
3042
 
                "Converting to format 6",
3043
 
                mode=self.file_mode)
 
1868
        self.pb.note('starting upgrade from format 6 to metadir')
 
1869
        self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
3044
1870
        # its faster to move specific files around than to open and use the apis...
3045
1871
        # first off, nuke ancestry.weave, it was never used.
3046
1872
        try:
3056
1882
            if name.startswith('basis-inventory.'):
3057
1883
                self.garbage_inventories.append(name)
3058
1884
        # create new directories for repository, working tree and branch
 
1885
        self.dir_mode = self.bzrdir._control_files._dir_mode
 
1886
        self.file_mode = self.bzrdir._control_files._file_mode
3059
1887
        repository_names = [('inventory.weave', True),
3060
1888
                            ('revision-store', True),
3061
1889
                            ('weaves', True)]
3063
1891
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
3064
1892
        self.make_lock('repository')
3065
1893
        # we hard code the formats here because we are converting into
3066
 
        # the meta format. The meta format upgrader can take this to a
 
1894
        # the meta format. The meta format upgrader can take this to a 
3067
1895
        # future format within each component.
3068
 
        self.put_format('repository', RepositoryFormat7())
 
1896
        self.put_format('repository', _mod_repository.RepositoryFormat7())
3069
1897
        for entry in repository_names:
3070
1898
            self.move_entry('repository', entry)
3071
1899
 
3092
1920
        else:
3093
1921
            has_checkout = True
3094
1922
        if not has_checkout:
3095
 
            ui.ui_factory.note('No working tree.')
 
1923
            self.pb.note('No working tree.')
3096
1924
            # If some checkout files are there, we may as well get rid of them.
3097
1925
            for name, mandatory in checkout_files:
3098
1926
                if name in bzrcontents:
3109
1937
            for entry in checkout_files:
3110
1938
                self.move_entry('checkout', entry)
3111
1939
            if last_revision is not None:
3112
 
                self.bzrdir.transport.put_bytes(
 
1940
                self.bzrdir._control_files.put_utf8(
3113
1941
                    'checkout/last-revision', last_revision)
3114
 
        self.bzrdir.transport.put_bytes(
3115
 
            'branch-format',
3116
 
            BzrDirMetaFormat1().get_format_string(),
3117
 
            mode=self.file_mode)
3118
 
        self.pb.finished()
3119
 
        return BzrDir.open(self.bzrdir.user_url)
 
1942
        self.bzrdir._control_files.put_utf8(
 
1943
            'branch-format', BzrDirMetaFormat1().get_format_string())
 
1944
        return BzrDir.open(self.bzrdir.root_transport.base)
3120
1945
 
3121
1946
    def make_lock(self, name):
3122
1947
        """Make a lock for the new control dir name."""
3139
1964
                raise
3140
1965
 
3141
1966
    def put_format(self, dirname, format):
3142
 
        self.bzrdir.transport.put_bytes('%s/format' % dirname,
3143
 
            format.get_format_string(),
3144
 
            self.file_mode)
 
1967
        self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
3145
1968
 
3146
1969
 
3147
1970
class ConvertMetaToMeta(Converter):
3157
1980
    def convert(self, to_convert, pb):
3158
1981
        """See Converter.convert()."""
3159
1982
        self.bzrdir = to_convert
3160
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
1983
        self.pb = pb
3161
1984
        self.count = 0
3162
1985
        self.total = 1
3163
1986
        self.step('checking repository format')
3168
1991
        else:
3169
1992
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
3170
1993
                from bzrlib.repository import CopyConverter
3171
 
                ui.ui_factory.note('starting repository conversion')
 
1994
                self.pb.note('starting repository conversion')
3172
1995
                converter = CopyConverter(self.target_format.repository_format)
3173
1996
                converter.convert(repo, pb)
3174
 
        for branch in self.bzrdir.list_branches():
3175
 
            # TODO: conversions of Branch and Tree should be done by
3176
 
            # InterXFormat lookups/some sort of registry.
3177
 
            # Avoid circular imports
3178
 
            from bzrlib import branch as _mod_branch
3179
 
            old = branch._format.__class__
3180
 
            new = self.target_format.get_branch_format().__class__
3181
 
            while old != new:
3182
 
                if (old == _mod_branch.BzrBranchFormat5 and
3183
 
                    new in (_mod_branch.BzrBranchFormat6,
3184
 
                        _mod_branch.BzrBranchFormat7,
3185
 
                        _mod_branch.BzrBranchFormat8)):
3186
 
                    branch_converter = _mod_branch.Converter5to6()
3187
 
                elif (old == _mod_branch.BzrBranchFormat6 and
3188
 
                    new in (_mod_branch.BzrBranchFormat7,
3189
 
                            _mod_branch.BzrBranchFormat8)):
3190
 
                    branch_converter = _mod_branch.Converter6to7()
3191
 
                elif (old == _mod_branch.BzrBranchFormat7 and
3192
 
                      new is _mod_branch.BzrBranchFormat8):
3193
 
                    branch_converter = _mod_branch.Converter7to8()
3194
 
                else:
3195
 
                    raise errors.BadConversionTarget("No converter", new,
3196
 
                        branch._format)
3197
 
                branch_converter.convert(branch)
3198
 
                branch = self.bzrdir.open_branch()
3199
 
                old = branch._format.__class__
3200
 
        try:
3201
 
            tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
3202
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
3203
 
            pass
3204
 
        else:
3205
 
            # TODO: conversions of Branch and Tree should be done by
3206
 
            # InterXFormat lookups
3207
 
            if (isinstance(tree, workingtree.WorkingTree3) and
3208
 
                not isinstance(tree, workingtree_4.DirStateWorkingTree) and
3209
 
                isinstance(self.target_format.workingtree_format,
3210
 
                    workingtree_4.DirStateWorkingTreeFormat)):
3211
 
                workingtree_4.Converter3to4().convert(tree)
3212
 
            if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3213
 
                not isinstance(tree, workingtree_4.WorkingTree5) and
3214
 
                isinstance(self.target_format.workingtree_format,
3215
 
                    workingtree_4.WorkingTreeFormat5)):
3216
 
                workingtree_4.Converter4to5().convert(tree)
3217
 
            if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3218
 
                not isinstance(tree, workingtree_4.WorkingTree6) and
3219
 
                isinstance(self.target_format.workingtree_format,
3220
 
                    workingtree_4.WorkingTreeFormat6)):
3221
 
                workingtree_4.Converter4or5to6().convert(tree)
3222
 
        self.pb.finished()
3223
1997
        return to_convert
3224
1998
 
3225
1999
 
3226
 
# This is not in remote.py because it's relatively small, and needs to be
3227
 
# registered. Putting it in remote.py creates a circular import problem.
 
2000
# This is not in remote.py because it's small, and needs to be registered.
 
2001
# Putting it in remote.py creates a circular import problem.
3228
2002
# we can make it a lazy object if the control formats is turned into something
3229
2003
# like a registry.
3230
2004
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3231
2005
    """Format representing bzrdirs accessed via a smart server"""
3232
2006
 
3233
 
    def __init__(self):
3234
 
        BzrDirMetaFormat1.__init__(self)
3235
 
        # XXX: It's a bit ugly that the network name is here, because we'd
3236
 
        # like to believe that format objects are stateless or at least
3237
 
        # immutable,  However, we do at least avoid mutating the name after
3238
 
        # it's returned.  See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
3239
 
        self._network_name = None
3240
 
 
3241
 
    def __repr__(self):
3242
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
3243
 
            self._network_name)
3244
 
 
3245
2007
    def get_format_description(self):
3246
 
        if self._network_name:
3247
 
            real_format = network_format_registry.get(self._network_name)
3248
 
            return 'Remote: ' + real_format.get_format_description()
3249
2008
        return 'bzr remote bzrdir'
3250
 
 
3251
 
    def get_format_string(self):
3252
 
        raise NotImplementedError(self.get_format_string)
3253
 
 
3254
 
    def network_name(self):
3255
 
        if self._network_name:
3256
 
            return self._network_name
3257
 
        else:
3258
 
            raise AssertionError("No network name set.")
3259
 
 
 
2009
    
3260
2010
    @classmethod
3261
2011
    def probe_transport(klass, transport):
3262
2012
        """Return a RemoteBzrDirFormat object if it looks possible."""
3263
2013
        try:
3264
 
            medium = transport.get_smart_medium()
 
2014
            transport.get_smart_client()
3265
2015
        except (NotImplementedError, AttributeError,
3266
 
                errors.TransportNotPossible, errors.NoSmartMedium,
3267
 
                errors.SmartProtocolError):
 
2016
                errors.TransportNotPossible):
3268
2017
            # no smart server, so not a branch for this format type.
3269
2018
            raise errors.NotBranchError(path=transport.base)
3270
2019
        else:
3271
 
            # Decline to open it if the server doesn't support our required
3272
 
            # version (3) so that the VFS-based transport will do it.
3273
 
            if medium.should_probe():
3274
 
                try:
3275
 
                    server_version = medium.protocol_version()
3276
 
                except errors.SmartProtocolError:
3277
 
                    # Apparently there's no usable smart server there, even though
3278
 
                    # the medium supports the smart protocol.
3279
 
                    raise errors.NotBranchError(path=transport.base)
3280
 
                if server_version != '2':
3281
 
                    raise errors.NotBranchError(path=transport.base)
3282
2020
            return klass()
3283
2021
 
3284
2022
    def initialize_on_transport(self, transport):
3285
 
        try:
3286
 
            # hand off the request to the smart server
3287
 
            client_medium = transport.get_smart_medium()
3288
 
        except errors.NoSmartMedium:
3289
 
            # TODO: lookup the local format from a server hint.
3290
 
            local_dir_format = BzrDirMetaFormat1()
3291
 
            return local_dir_format.initialize_on_transport(transport)
3292
 
        client = _SmartClient(client_medium)
 
2023
        # hand off the request to the smart server
 
2024
        medium = transport.get_smart_medium()
 
2025
        client = SmartClient(medium)
3293
2026
        path = client.remote_path_from_transport(transport)
3294
 
        try:
3295
 
            response = client.call('BzrDirFormat.initialize', path)
3296
 
        except errors.ErrorFromSmartServer, err:
3297
 
            remote._translate_error(err, path=path)
3298
 
        if response[0] != 'ok':
3299
 
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3300
 
        format = RemoteBzrDirFormat()
3301
 
        self._supply_sub_formats_to(format)
3302
 
        return remote.RemoteBzrDir(transport, format)
3303
 
 
3304
 
    def parse_NoneTrueFalse(self, arg):
3305
 
        if not arg:
3306
 
            return None
3307
 
        if arg == 'False':
3308
 
            return False
3309
 
        if arg == 'True':
3310
 
            return True
3311
 
        raise AssertionError("invalid arg %r" % arg)
3312
 
 
3313
 
    def _serialize_NoneTrueFalse(self, arg):
3314
 
        if arg is False:
3315
 
            return 'False'
3316
 
        if arg:
3317
 
            return 'True'
3318
 
        return ''
3319
 
 
3320
 
    def _serialize_NoneString(self, arg):
3321
 
        return arg or ''
3322
 
 
3323
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3324
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
3325
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3326
 
        shared_repo=False):
3327
 
        try:
3328
 
            # hand off the request to the smart server
3329
 
            client_medium = transport.get_smart_medium()
3330
 
        except errors.NoSmartMedium:
3331
 
            do_vfs = True
3332
 
        else:
3333
 
            # Decline to open it if the server doesn't support our required
3334
 
            # version (3) so that the VFS-based transport will do it.
3335
 
            if client_medium.should_probe():
3336
 
                try:
3337
 
                    server_version = client_medium.protocol_version()
3338
 
                    if server_version != '2':
3339
 
                        do_vfs = True
3340
 
                    else:
3341
 
                        do_vfs = False
3342
 
                except errors.SmartProtocolError:
3343
 
                    # Apparently there's no usable smart server there, even though
3344
 
                    # the medium supports the smart protocol.
3345
 
                    do_vfs = True
3346
 
            else:
3347
 
                do_vfs = False
3348
 
        if not do_vfs:
3349
 
            client = _SmartClient(client_medium)
3350
 
            path = client.remote_path_from_transport(transport)
3351
 
            if client_medium._is_remote_before((1, 16)):
3352
 
                do_vfs = True
3353
 
        if do_vfs:
3354
 
            # TODO: lookup the local format from a server hint.
3355
 
            local_dir_format = BzrDirMetaFormat1()
3356
 
            self._supply_sub_formats_to(local_dir_format)
3357
 
            return local_dir_format.initialize_on_transport_ex(transport,
3358
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3359
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3360
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3361
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3362
 
                vfs_only=True)
3363
 
        return self._initialize_on_transport_ex_rpc(client, path, transport,
3364
 
            use_existing_dir, create_prefix, force_new_repo, stacked_on,
3365
 
            stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3366
 
 
3367
 
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
3368
 
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
3369
 
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3370
 
        args = []
3371
 
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3372
 
        args.append(self._serialize_NoneTrueFalse(create_prefix))
3373
 
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
3374
 
        args.append(self._serialize_NoneString(stacked_on))
3375
 
        # stack_on_pwd is often/usually our transport
3376
 
        if stack_on_pwd:
3377
 
            try:
3378
 
                stack_on_pwd = transport.relpath(stack_on_pwd)
3379
 
                if not stack_on_pwd:
3380
 
                    stack_on_pwd = '.'
3381
 
            except errors.PathNotChild:
3382
 
                pass
3383
 
        args.append(self._serialize_NoneString(stack_on_pwd))
3384
 
        args.append(self._serialize_NoneString(repo_format_name))
3385
 
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
3386
 
        args.append(self._serialize_NoneTrueFalse(shared_repo))
3387
 
        request_network_name = self._network_name or \
3388
 
            BzrDirFormat.get_default_format().network_name()
3389
 
        try:
3390
 
            response = client.call('BzrDirFormat.initialize_ex_1.16',
3391
 
                request_network_name, path, *args)
3392
 
        except errors.UnknownSmartMethod:
3393
 
            client._medium._remember_remote_is_before((1,16))
3394
 
            local_dir_format = BzrDirMetaFormat1()
3395
 
            self._supply_sub_formats_to(local_dir_format)
3396
 
            return local_dir_format.initialize_on_transport_ex(transport,
3397
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3398
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3399
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3400
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3401
 
                vfs_only=True)
3402
 
        except errors.ErrorFromSmartServer, err:
3403
 
            remote._translate_error(err, path=path)
3404
 
        repo_path = response[0]
3405
 
        bzrdir_name = response[6]
3406
 
        require_stacking = response[7]
3407
 
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
3408
 
        format = RemoteBzrDirFormat()
3409
 
        format._network_name = bzrdir_name
3410
 
        self._supply_sub_formats_to(format)
3411
 
        bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3412
 
        if repo_path:
3413
 
            repo_format = remote.response_tuple_to_repo_format(response[1:])
3414
 
            if repo_path == '.':
3415
 
                repo_path = ''
3416
 
            if repo_path:
3417
 
                repo_bzrdir_format = RemoteBzrDirFormat()
3418
 
                repo_bzrdir_format._network_name = response[5]
3419
 
                repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3420
 
                    repo_bzrdir_format)
3421
 
            else:
3422
 
                repo_bzr = bzrdir
3423
 
            final_stack = response[8] or None
3424
 
            final_stack_pwd = response[9] or None
3425
 
            if final_stack_pwd:
3426
 
                final_stack_pwd = urlutils.join(
3427
 
                    transport.base, final_stack_pwd)
3428
 
            remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3429
 
            if len(response) > 10:
3430
 
                # Updated server verb that locks remotely.
3431
 
                repo_lock_token = response[10] or None
3432
 
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3433
 
                if repo_lock_token:
3434
 
                    remote_repo.dont_leave_lock_in_place()
3435
 
            else:
3436
 
                remote_repo.lock_write()
3437
 
            policy = UseExistingRepository(remote_repo, final_stack,
3438
 
                final_stack_pwd, require_stacking)
3439
 
            policy.acquire_repository()
3440
 
        else:
3441
 
            remote_repo = None
3442
 
            policy = None
3443
 
        bzrdir._format.set_branch_format(self.get_branch_format())
3444
 
        if require_stacking:
3445
 
            # The repo has already been created, but we need to make sure that
3446
 
            # we'll make a stackable branch.
3447
 
            bzrdir._format.require_stacking(_skip_repo=True)
3448
 
        return remote_repo, bzrdir, require_stacking, policy
 
2027
        response = SmartClient(medium).call('BzrDirFormat.initialize', path)
 
2028
        assert response[0] in ('ok', ), 'unexpected response code %s' % (response,)
 
2029
        return remote.RemoteBzrDir(transport)
3449
2030
 
3450
2031
    def _open(self, transport):
3451
 
        return remote.RemoteBzrDir(transport, self)
 
2032
        return remote.RemoteBzrDir(transport)
3452
2033
 
3453
2034
    def __eq__(self, other):
3454
2035
        if not isinstance(other, RemoteBzrDirFormat):
3455
2036
            return False
3456
2037
        return self.get_format_description() == other.get_format_description()
3457
2038
 
3458
 
    def __return_repository_format(self):
3459
 
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
3460
 
        # repository format has been asked for, tell the RemoteRepositoryFormat
3461
 
        # that it should use that for init() etc.
3462
 
        result = remote.RemoteRepositoryFormat()
3463
 
        custom_format = getattr(self, '_repository_format', None)
3464
 
        if custom_format:
3465
 
            if isinstance(custom_format, remote.RemoteRepositoryFormat):
3466
 
                return custom_format
3467
 
            else:
3468
 
                # We will use the custom format to create repositories over the
3469
 
                # wire; expose its details like rich_root_data for code to
3470
 
                # query
3471
 
                result._custom_format = custom_format
3472
 
        return result
3473
 
 
3474
 
    def get_branch_format(self):
3475
 
        result = BzrDirMetaFormat1.get_branch_format(self)
3476
 
        if not isinstance(result, remote.RemoteBranchFormat):
3477
 
            new_result = remote.RemoteBranchFormat()
3478
 
            new_result._custom_format = result
3479
 
            # cache the result
3480
 
            self.set_branch_format(new_result)
3481
 
            result = new_result
3482
 
        return result
3483
 
 
3484
 
    repository_format = property(__return_repository_format,
3485
 
        BzrDirMetaFormat1._set_repository_format) #.im_func)
3486
 
 
3487
 
 
3488
 
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
 
2039
 
 
2040
# We can't use register_control_format because it adds it at a lower priority
 
2041
# than the existing branches, whereas this should take priority.
 
2042
BzrDirFormat._control_formats.insert(0, RemoteBzrDirFormat)
3489
2043
 
3490
2044
 
3491
2045
class BzrDirFormatInfo(object):
3492
2046
 
3493
 
    def __init__(self, native, deprecated, hidden, experimental):
 
2047
    def __init__(self, native, deprecated):
3494
2048
        self.deprecated = deprecated
3495
2049
        self.native = native
3496
 
        self.hidden = hidden
3497
 
        self.experimental = experimental
3498
2050
 
3499
2051
 
3500
2052
class BzrDirFormatRegistry(registry.Registry):
3501
2053
    """Registry of user-selectable BzrDir subformats.
3502
 
 
 
2054
    
3503
2055
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3504
2056
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
3505
2057
    """
3506
2058
 
3507
 
    def __init__(self):
3508
 
        """Create a BzrDirFormatRegistry."""
3509
 
        self._aliases = set()
3510
 
        self._registration_order = list()
3511
 
        super(BzrDirFormatRegistry, self).__init__()
3512
 
 
3513
 
    def aliases(self):
3514
 
        """Return a set of the format names which are aliases."""
3515
 
        return frozenset(self._aliases)
3516
 
 
3517
 
    def register_metadir(self, key,
3518
 
             repository_format, help, native=True, deprecated=False,
3519
 
             branch_format=None,
3520
 
             tree_format=None,
3521
 
             hidden=False,
3522
 
             experimental=False,
3523
 
             alias=False):
 
2059
    def register_metadir(self, key, repo, help, native=True, deprecated=False):
3524
2060
        """Register a metadir subformat.
3525
 
 
3526
 
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3527
 
        by the Repository/Branch/WorkingTreeformats.
3528
 
 
3529
 
        :param repository_format: The fully-qualified repository format class
3530
 
            name as a string.
3531
 
        :param branch_format: Fully-qualified branch format class name as
3532
 
            a string.
3533
 
        :param tree_format: Fully-qualified tree format class name as
3534
 
            a string.
 
2061
        
 
2062
        repo is the repository format name as a string.
3535
2063
        """
3536
2064
        # This should be expanded to support setting WorkingTree and Branch
3537
2065
        # formats, once BzrDirMetaFormat1 supports that.
3538
 
        def _load(full_name):
3539
 
            mod_name, factory_name = full_name.rsplit('.', 1)
3540
 
            try:
3541
 
                mod = __import__(mod_name, globals(), locals(),
3542
 
                        [factory_name])
3543
 
            except ImportError, e:
3544
 
                raise ImportError('failed to load %s: %s' % (full_name, e))
3545
 
            try:
3546
 
                factory = getattr(mod, factory_name)
3547
 
            except AttributeError:
3548
 
                raise AttributeError('no factory %s in module %r'
3549
 
                    % (full_name, mod))
3550
 
            return factory()
3551
 
 
3552
2066
        def helper():
 
2067
            import bzrlib.repository
 
2068
            repo_format = getattr(bzrlib.repository, repo)
3553
2069
            bd = BzrDirMetaFormat1()
3554
 
            if branch_format is not None:
3555
 
                bd.set_branch_format(_load(branch_format))
3556
 
            if tree_format is not None:
3557
 
                bd.workingtree_format = _load(tree_format)
3558
 
            if repository_format is not None:
3559
 
                bd.repository_format = _load(repository_format)
 
2070
            bd.repository_format = repo_format()
3560
2071
            return bd
3561
 
        self.register(key, helper, help, native, deprecated, hidden,
3562
 
            experimental, alias)
 
2072
        self.register(key, helper, help, native, deprecated)
3563
2073
 
3564
 
    def register(self, key, factory, help, native=True, deprecated=False,
3565
 
                 hidden=False, experimental=False, alias=False):
 
2074
    def register(self, key, factory, help, native=True, deprecated=False):
3566
2075
        """Register a BzrDirFormat factory.
3567
 
 
 
2076
        
3568
2077
        The factory must be a callable that takes one parameter: the key.
3569
2078
        It must produce an instance of the BzrDirFormat when called.
3570
2079
 
3571
2080
        This function mainly exists to prevent the info object from being
3572
2081
        supplied directly.
3573
2082
        """
3574
 
        registry.Registry.register(self, key, factory, help,
3575
 
            BzrDirFormatInfo(native, deprecated, hidden, experimental))
3576
 
        if alias:
3577
 
            self._aliases.add(key)
3578
 
        self._registration_order.append(key)
 
2083
        registry.Registry.register(self, key, factory, help, 
 
2084
            BzrDirFormatInfo(native, deprecated))
3579
2085
 
3580
2086
    def register_lazy(self, key, module_name, member_name, help, native=True,
3581
 
        deprecated=False, hidden=False, experimental=False, alias=False):
3582
 
        registry.Registry.register_lazy(self, key, module_name, member_name,
3583
 
            help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3584
 
        if alias:
3585
 
            self._aliases.add(key)
3586
 
        self._registration_order.append(key)
 
2087
                      deprecated=False):
 
2088
        registry.Registry.register_lazy(self, key, module_name, member_name, 
 
2089
            help, BzrDirFormatInfo(native, deprecated))
3587
2090
 
3588
2091
    def set_default(self, key):
3589
2092
        """Set the 'default' key to be a clone of the supplied key.
3590
 
 
 
2093
        
3591
2094
        This method must be called once and only once.
3592
2095
        """
3593
 
        registry.Registry.register(self, 'default', self.get(key),
 
2096
        registry.Registry.register(self, 'default', self.get(key), 
3594
2097
            self.get_help(key), info=self.get_info(key))
3595
 
        self._aliases.add('default')
3596
2098
 
3597
2099
    def set_default_repository(self, key):
3598
2100
        """Set the FormatRegistry default and Repository default.
3599
 
 
 
2101
        
3600
2102
        This is a transitional method while Repository.set_default_format
3601
2103
        is deprecated.
3602
2104
        """
3604
2106
            self.remove('default')
3605
2107
        self.set_default(key)
3606
2108
        format = self.get('default')()
 
2109
        assert isinstance(format, BzrDirMetaFormat1)
3607
2110
 
3608
2111
    def make_bzrdir(self, key):
3609
2112
        return self.get(key)()
3610
2113
 
3611
2114
    def help_topic(self, topic):
3612
 
        output = ""
3613
 
        default_realkey = None
 
2115
        output = textwrap.dedent("""\
 
2116
            Bazaar directory formats
 
2117
            ------------------------
 
2118
 
 
2119
            These formats can be used for creating branches, working trees, and
 
2120
            repositories.
 
2121
 
 
2122
            """)
3614
2123
        default_help = self.get_help('default')
3615
2124
        help_pairs = []
3616
 
        for key in self._registration_order:
 
2125
        for key in self.keys():
3617
2126
            if key == 'default':
3618
2127
                continue
3619
2128
            help = self.get_help(key)
3625
2134
        def wrapped(key, help, info):
3626
2135
            if info.native:
3627
2136
                help = '(native) ' + help
3628
 
            return ':%s:\n%s\n\n' % (key,
3629
 
                textwrap.fill(help, initial_indent='    ',
3630
 
                    subsequent_indent='    ',
3631
 
                    break_long_words=False))
3632
 
        if default_realkey is not None:
3633
 
            output += wrapped(default_realkey, '(default) %s' % default_help,
3634
 
                              self.get_info('default'))
 
2137
            return '  %s:\n%s\n\n' % (key, 
 
2138
                    textwrap.fill(help, initial_indent='    ', 
 
2139
                    subsequent_indent='    '))
 
2140
        output += wrapped('%s/default' % default_realkey, default_help,
 
2141
                          self.get_info('default'))
3635
2142
        deprecated_pairs = []
3636
 
        experimental_pairs = []
3637
2143
        for key, help in help_pairs:
3638
2144
            info = self.get_info(key)
3639
 
            if info.hidden:
3640
 
                continue
3641
 
            elif info.deprecated:
 
2145
            if info.deprecated:
3642
2146
                deprecated_pairs.append((key, help))
3643
 
            elif info.experimental:
3644
 
                experimental_pairs.append((key, help))
3645
2147
            else:
3646
2148
                output += wrapped(key, help, info)
3647
 
        output += "\nSee :doc:`formats-help` for more about storage formats."
3648
 
        other_output = ""
3649
 
        if len(experimental_pairs) > 0:
3650
 
            other_output += "Experimental formats are shown below.\n\n"
3651
 
            for key, help in experimental_pairs:
3652
 
                info = self.get_info(key)
3653
 
                other_output += wrapped(key, help, info)
3654
 
        else:
3655
 
            other_output += \
3656
 
                "No experimental formats are available.\n\n"
3657
2149
        if len(deprecated_pairs) > 0:
3658
 
            other_output += "\nDeprecated formats are shown below.\n\n"
 
2150
            output += "Deprecated formats\n------------------\n\n"
3659
2151
            for key, help in deprecated_pairs:
3660
2152
                info = self.get_info(key)
3661
 
                other_output += wrapped(key, help, info)
3662
 
        else:
3663
 
            other_output += \
3664
 
                "\nNo deprecated formats are available.\n\n"
3665
 
        other_output += \
3666
 
                "\nSee :doc:`formats-help` for more about storage formats."
3667
 
 
3668
 
        if topic == 'other-formats':
3669
 
            return other_output
3670
 
        else:
3671
 
            return output
3672
 
 
3673
 
 
3674
 
class RepositoryAcquisitionPolicy(object):
3675
 
    """Abstract base class for repository acquisition policies.
3676
 
 
3677
 
    A repository acquisition policy decides how a BzrDir acquires a repository
3678
 
    for a branch that is being created.  The most basic policy decision is
3679
 
    whether to create a new repository or use an existing one.
3680
 
    """
3681
 
    def __init__(self, stack_on, stack_on_pwd, require_stacking):
3682
 
        """Constructor.
3683
 
 
3684
 
        :param stack_on: A location to stack on
3685
 
        :param stack_on_pwd: If stack_on is relative, the location it is
3686
 
            relative to.
3687
 
        :param require_stacking: If True, it is a failure to not stack.
3688
 
        """
3689
 
        self._stack_on = stack_on
3690
 
        self._stack_on_pwd = stack_on_pwd
3691
 
        self._require_stacking = require_stacking
3692
 
 
3693
 
    def configure_branch(self, branch):
3694
 
        """Apply any configuration data from this policy to the branch.
3695
 
 
3696
 
        Default implementation sets repository stacking.
3697
 
        """
3698
 
        if self._stack_on is None:
3699
 
            return
3700
 
        if self._stack_on_pwd is None:
3701
 
            stack_on = self._stack_on
3702
 
        else:
3703
 
            try:
3704
 
                stack_on = urlutils.rebase_url(self._stack_on,
3705
 
                    self._stack_on_pwd,
3706
 
                    branch.user_url)
3707
 
            except errors.InvalidRebaseURLs:
3708
 
                stack_on = self._get_full_stack_on()
3709
 
        try:
3710
 
            branch.set_stacked_on_url(stack_on)
3711
 
        except (errors.UnstackableBranchFormat,
3712
 
                errors.UnstackableRepositoryFormat):
3713
 
            if self._require_stacking:
3714
 
                raise
3715
 
 
3716
 
    def requires_stacking(self):
3717
 
        """Return True if this policy requires stacking."""
3718
 
        return self._stack_on is not None and self._require_stacking
3719
 
 
3720
 
    def _get_full_stack_on(self):
3721
 
        """Get a fully-qualified URL for the stack_on location."""
3722
 
        if self._stack_on is None:
3723
 
            return None
3724
 
        if self._stack_on_pwd is None:
3725
 
            return self._stack_on
3726
 
        else:
3727
 
            return urlutils.join(self._stack_on_pwd, self._stack_on)
3728
 
 
3729
 
    def _add_fallback(self, repository, possible_transports=None):
3730
 
        """Add a fallback to the supplied repository, if stacking is set."""
3731
 
        stack_on = self._get_full_stack_on()
3732
 
        if stack_on is None:
3733
 
            return
3734
 
        try:
3735
 
            stacked_dir = BzrDir.open(stack_on,
3736
 
                                      possible_transports=possible_transports)
3737
 
        except errors.JailBreak:
3738
 
            # We keep the stacking details, but we are in the server code so
3739
 
            # actually stacking is not needed.
3740
 
            return
3741
 
        try:
3742
 
            stacked_repo = stacked_dir.open_branch().repository
3743
 
        except errors.NotBranchError:
3744
 
            stacked_repo = stacked_dir.open_repository()
3745
 
        try:
3746
 
            repository.add_fallback_repository(stacked_repo)
3747
 
        except errors.UnstackableRepositoryFormat:
3748
 
            if self._require_stacking:
3749
 
                raise
3750
 
        else:
3751
 
            self._require_stacking = True
3752
 
 
3753
 
    def acquire_repository(self, make_working_trees=None, shared=False):
3754
 
        """Acquire a repository for this bzrdir.
3755
 
 
3756
 
        Implementations may create a new repository or use a pre-exising
3757
 
        repository.
3758
 
        :param make_working_trees: If creating a repository, set
3759
 
            make_working_trees to this value (if non-None)
3760
 
        :param shared: If creating a repository, make it shared if True
3761
 
        :return: A repository, is_new_flag (True if the repository was
3762
 
            created).
3763
 
        """
3764
 
        raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3765
 
 
3766
 
 
3767
 
class CreateRepository(RepositoryAcquisitionPolicy):
3768
 
    """A policy of creating a new repository"""
3769
 
 
3770
 
    def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3771
 
                 require_stacking=False):
3772
 
        """
3773
 
        Constructor.
3774
 
        :param bzrdir: The bzrdir to create the repository on.
3775
 
        :param stack_on: A location to stack on
3776
 
        :param stack_on_pwd: If stack_on is relative, the location it is
3777
 
            relative to.
3778
 
        """
3779
 
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3780
 
                                             require_stacking)
3781
 
        self._bzrdir = bzrdir
3782
 
 
3783
 
    def acquire_repository(self, make_working_trees=None, shared=False):
3784
 
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
3785
 
 
3786
 
        Creates the desired repository in the bzrdir we already have.
3787
 
        """
3788
 
        stack_on = self._get_full_stack_on()
3789
 
        if stack_on:
3790
 
            format = self._bzrdir._format
3791
 
            format.require_stacking(stack_on=stack_on,
3792
 
                                    possible_transports=[self._bzrdir.root_transport])
3793
 
            if not self._require_stacking:
3794
 
                # We have picked up automatic stacking somewhere.
3795
 
                note('Using default stacking branch %s at %s', self._stack_on,
3796
 
                    self._stack_on_pwd)
3797
 
        repository = self._bzrdir.create_repository(shared=shared)
3798
 
        self._add_fallback(repository,
3799
 
                           possible_transports=[self._bzrdir.transport])
3800
 
        if make_working_trees is not None:
3801
 
            repository.set_make_working_trees(make_working_trees)
3802
 
        return repository, True
3803
 
 
3804
 
 
3805
 
class UseExistingRepository(RepositoryAcquisitionPolicy):
3806
 
    """A policy of reusing an existing repository"""
3807
 
 
3808
 
    def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3809
 
                 require_stacking=False):
3810
 
        """Constructor.
3811
 
 
3812
 
        :param repository: The repository to use.
3813
 
        :param stack_on: A location to stack on
3814
 
        :param stack_on_pwd: If stack_on is relative, the location it is
3815
 
            relative to.
3816
 
        """
3817
 
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3818
 
                                             require_stacking)
3819
 
        self._repository = repository
3820
 
 
3821
 
    def acquire_repository(self, make_working_trees=None, shared=False):
3822
 
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
3823
 
 
3824
 
        Returns an existing repository to use.
3825
 
        """
3826
 
        self._add_fallback(self._repository,
3827
 
                       possible_transports=[self._repository.bzrdir.transport])
3828
 
        return self._repository, False
3829
 
 
3830
 
 
3831
 
# Please register new formats after old formats so that formats
3832
 
# appear in chronological order and format descriptions can build
3833
 
# on previous ones.
 
2153
                output += wrapped(key, help, info)
 
2154
 
 
2155
        return output
 
2156
 
 
2157
 
3834
2158
format_registry = BzrDirFormatRegistry()
3835
 
# The pre-0.8 formats have their repository format network name registered in
3836
 
# repository.py. MetaDir formats have their repository format network name
3837
 
# inferred from their disk format string.
3838
2159
format_registry.register('weave', BzrDirFormat6,
3839
2160
    'Pre-0.8 format.  Slower than knit and does not'
3840
 
    ' support checkouts or shared repositories.',
3841
 
    hidden=True,
3842
 
    deprecated=True)
3843
 
format_registry.register_metadir('metaweave',
3844
 
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
 
2161
    ' support checkouts or shared repositories.', deprecated=True)
 
2162
format_registry.register_metadir('knit', 'RepositoryFormatKnit1',
 
2163
    'Format using knits.  Recommended.')
 
2164
format_registry.set_default('knit')
 
2165
format_registry.register_metadir('metaweave', 'RepositoryFormat7',
3845
2166
    'Transitional format in 0.8.  Slower than knit.',
3846
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
3847
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3848
 
    hidden=True,
3849
 
    deprecated=True)
3850
 
format_registry.register_metadir('knit',
3851
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3852
 
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
3853
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
3854
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3855
 
    hidden=True,
3856
 
    deprecated=True)
3857
 
format_registry.register_metadir('dirstate',
3858
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3859
 
    help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3860
 
        'above when accessed over the network.',
3861
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
3862
 
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3863
 
    # directly from workingtree_4 triggers a circular import.
3864
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3865
 
    hidden=True,
3866
 
    deprecated=True)
3867
 
format_registry.register_metadir('dirstate-tags',
3868
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3869
 
    help='New in 0.15: Fast local operations and improved scaling for '
3870
 
        'network operations. Additionally adds support for tags.'
3871
 
        ' Incompatible with bzr < 0.15.',
3872
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3873
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3874
 
    hidden=True,
3875
 
    deprecated=True)
3876
 
format_registry.register_metadir('rich-root',
3877
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3878
 
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
3879
 
        ' bzr < 1.0.',
3880
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3881
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3882
 
    hidden=True,
3883
 
    deprecated=True)
3884
 
format_registry.register_metadir('dirstate-with-subtree',
3885
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3886
 
    help='New in 0.15: Fast local operations and improved scaling for '
3887
 
        'network operations. Additionally adds support for versioning nested '
3888
 
        'bzr branches. Incompatible with bzr < 0.15.',
3889
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3890
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3891
 
    experimental=True,
3892
 
    hidden=True,
3893
 
    )
3894
 
format_registry.register_metadir('pack-0.92',
3895
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3896
 
    help='New in 0.92: Pack-based format with data compatible with '
3897
 
        'dirstate-tags format repositories. Interoperates with '
3898
 
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3899
 
        ,
3900
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3901
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3902
 
    )
3903
 
format_registry.register_metadir('pack-0.92-subtree',
3904
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3905
 
    help='New in 0.92: Pack-based format with data compatible with '
3906
 
        'dirstate-with-subtree format repositories. Interoperates with '
3907
 
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3908
 
        ,
3909
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3910
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3911
 
    hidden=True,
3912
 
    experimental=True,
3913
 
    )
3914
 
format_registry.register_metadir('rich-root-pack',
3915
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3916
 
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3917
 
         '(needed for bzr-svn and bzr-git).',
3918
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3919
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3920
 
    hidden=True,
3921
 
    )
3922
 
format_registry.register_metadir('1.6',
3923
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3924
 
    help='A format that allows a branch to indicate that there is another '
3925
 
         '(stacked) repository that should be used to access data that is '
3926
 
         'not present locally.',
3927
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3928
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3929
 
    hidden=True,
3930
 
    )
3931
 
format_registry.register_metadir('1.6.1-rich-root',
3932
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3933
 
    help='A variant of 1.6 that supports rich-root data '
3934
 
         '(needed for bzr-svn and bzr-git).',
3935
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3936
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3937
 
    hidden=True,
3938
 
    )
3939
 
format_registry.register_metadir('1.9',
3940
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3941
 
    help='A repository format using B+tree indexes. These indexes '
3942
 
         'are smaller in size, have smarter caching and provide faster '
3943
 
         'performance for most operations.',
3944
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3945
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3946
 
    hidden=True,
3947
 
    )
3948
 
format_registry.register_metadir('1.9-rich-root',
3949
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3950
 
    help='A variant of 1.9 that supports rich-root data '
3951
 
         '(needed for bzr-svn and bzr-git).',
3952
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3953
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3954
 
    hidden=True,
3955
 
    )
3956
 
format_registry.register_metadir('1.14',
3957
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3958
 
    help='A working-tree format that supports content filtering.',
3959
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3960
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3961
 
    )
3962
 
format_registry.register_metadir('1.14-rich-root',
3963
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3964
 
    help='A variant of 1.14 that supports rich-root data '
3965
 
         '(needed for bzr-svn and bzr-git).',
3966
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3967
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3968
 
    )
3969
 
# The following un-numbered 'development' formats should always just be aliases.
3970
 
format_registry.register_metadir('development-rich-root',
3971
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3972
 
    help='Current development format. Supports rich roots. Can convert data '
3973
 
        'to and from rich-root-pack (and anything compatible with '
3974
 
        'rich-root-pack) format repositories. Repositories and branches in '
3975
 
        'this format can only be read by bzr.dev. Please read '
3976
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3977
 
        'before use.',
3978
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3979
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3980
 
    experimental=True,
3981
 
    alias=True,
3982
 
    hidden=True,
3983
 
    )
3984
 
format_registry.register_metadir('development-subtree',
3985
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3986
 
    help='Current development format, subtree variant. Can convert data to and '
3987
 
        'from pack-0.92-subtree (and anything compatible with '
3988
 
        'pack-0.92-subtree) format repositories. Repositories and branches in '
3989
 
        'this format can only be read by bzr.dev. Please read '
3990
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3991
 
        'before use.',
3992
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3993
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3994
 
    experimental=True,
3995
 
    hidden=True,
3996
 
    alias=False, # Restore to being an alias when an actual development subtree format is added
3997
 
                 # This current non-alias status is simply because we did not introduce a
3998
 
                 # chk based subtree format.
3999
 
    )
4000
 
 
4001
 
# And the development formats above will have aliased one of the following:
4002
 
format_registry.register_metadir('development6-rich-root',
4003
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
4004
 
    help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
4005
 
        'Please read '
4006
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4007
 
        'before use.',
4008
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4009
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4010
 
    hidden=True,
4011
 
    experimental=True,
4012
 
    )
4013
 
 
4014
 
format_registry.register_metadir('development7-rich-root',
4015
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
4016
 
    help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
4017
 
        'rich roots. Please read '
4018
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4019
 
        'before use.',
4020
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4021
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4022
 
    hidden=True,
4023
 
    experimental=True,
4024
 
    )
4025
 
 
4026
 
format_registry.register_metadir('2a',
4027
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4028
 
    help='First format for bzr 2.0 series.\n'
4029
 
        'Uses group-compress storage.\n'
4030
 
        'Provides rich roots which are a one-way transition.\n',
4031
 
        # 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
4032
 
        # 'rich roots. Supported by bzr 1.16 and later.',
4033
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4034
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4035
 
    experimental=True,
4036
 
    )
4037
 
 
4038
 
# The following format should be an alias for the rich root equivalent 
4039
 
# of the default format
4040
 
format_registry.register_metadir('default-rich-root',
4041
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4042
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4043
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4044
 
    alias=True,
4045
 
    hidden=True,
4046
 
    help='Same as 2a.')
4047
 
 
4048
 
# The current format that is made on 'bzr init'.
4049
 
format_registry.set_default('2a')
 
2167
    deprecated=True)
 
2168
format_registry.register_metadir('experimental-knit2', 'RepositoryFormatKnit2',
 
2169
    'Experimental successor to knit.  Use at your own risk.')