/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

  • Committer: Robert Collins
  • Date: 2010-05-05 00:05:29 UTC
  • mto: This revision was merged to the branch mainline in revision 5206.
  • Revision ID: robertc@robertcollins.net-20100505000529-ltmllyms5watqj5u
Make 'pydoc bzrlib.tests.build_tree_shape' useful.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006-2010 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
25
25
objects returned.
26
26
"""
27
27
 
28
 
from __future__ import absolute_import
 
28
# TODO: Move old formats into a plugin to make this file smaller.
29
29
 
 
30
import os
30
31
import sys
 
32
import warnings
31
33
 
32
 
from ..lazy_import import lazy_import
 
34
from bzrlib.lazy_import import lazy_import
33
35
lazy_import(globals(), """
34
 
from breezy import (
35
 
    branch as _mod_branch,
36
 
    cleanup,
 
36
from stat import S_ISDIR
 
37
import textwrap
 
38
 
 
39
import bzrlib
 
40
from bzrlib import (
 
41
    branch,
 
42
    config,
 
43
    errors,
 
44
    graph,
37
45
    lockable_files,
38
46
    lockdir,
39
47
    osutils,
 
48
    remote,
40
49
    repository,
41
50
    revision as _mod_revision,
42
 
    transport as _mod_transport,
43
51
    ui,
44
52
    urlutils,
 
53
    versionedfile,
45
54
    win32utils,
46
 
    )
47
 
from breezy.bzr import (
48
 
    branch as _mod_bzrbranch,
49
 
    fetch,
50
 
    remote,
51
 
    vf_search,
52
 
    workingtree_3,
 
55
    workingtree,
53
56
    workingtree_4,
54
 
    )
55
 
from breezy.bzr import fullhistory as fullhistorybranch
56
 
from breezy.bzr import knitpack_repo
57
 
from breezy.transport import (
 
57
    xml4,
 
58
    xml5,
 
59
    )
 
60
from bzrlib.osutils import (
 
61
    sha_string,
 
62
    )
 
63
from bzrlib.push import (
 
64
    PushResult,
 
65
    )
 
66
from bzrlib.repofmt import pack_repo
 
67
from bzrlib.smart.client import _SmartClient
 
68
from bzrlib.store.versioned import WeaveStore
 
69
from bzrlib.transactions import WriteTransaction
 
70
from bzrlib.transport import (
58
71
    do_catching_redirections,
 
72
    get_transport,
59
73
    local,
60
74
    )
61
 
from breezy.i18n import gettext
 
75
from bzrlib.weave import Weave
62
76
""")
63
77
 
64
 
from ..sixish import viewitems
65
 
from ..trace import (
 
78
from bzrlib.trace import (
66
79
    mutter,
67
80
    note,
68
81
    warning,
69
82
    )
70
83
 
71
 
from .. import (
72
 
    config,
73
 
    controldir,
74
 
    errors,
 
84
from bzrlib import (
 
85
    hooks,
 
86
    registry,
 
87
    symbol_versioning,
75
88
    )
76
 
 
77
 
 
78
 
class MissingFeature(errors.BzrError):
79
 
 
80
 
    _fmt = ("Missing feature %(feature)s not provided by this "
81
 
            "version of Bazaar or any plugin.")
82
 
 
83
 
    def __init__(self, feature):
84
 
        self.feature = feature
85
 
 
86
 
 
87
 
class FeatureAlreadyRegistered(errors.BzrError):
88
 
 
89
 
    _fmt = 'The feature %(feature)s has already been registered.'
90
 
 
91
 
    def __init__(self, feature):
92
 
        self.feature = feature
93
 
 
94
 
 
95
 
class BzrDir(controldir.ControlDir):
 
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):
96
125
    """A .bzr control diretory.
97
126
 
98
127
    BzrDir instances let you create or open any of the things that can be
129
158
                    return
130
159
        thing_to_unlock.break_lock()
131
160
 
 
161
    def can_convert_format(self):
 
162
        """Return true if this bzrdir is one whose format we can convert from."""
 
163
        return True
 
164
 
132
165
    def check_conversion_target(self, target_format):
133
166
        """Check that a bzrdir as a whole can be converted to a new format."""
134
 
        # The only current restriction is that the repository content can be
 
167
        # The only current restriction is that the repository content can be 
135
168
        # fetched compatibly with the target.
136
169
        target_repo_format = target_format.repository_format
137
170
        try:
141
174
            # No repo, no problem.
142
175
            pass
143
176
 
 
177
    @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.
 
193
        """
 
194
        # TODO: perhaps move this into a base Format class; it's not BzrDir
 
195
        # specific. mbp 20070323
 
196
        if not allow_unsupported and not format.is_supported():
 
197
            # see open_downlevel to open legacy branches.
 
198
            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
 
 
205
    def clone(self, url, revision_id=None, force_new_repo=False,
 
206
              preserve_stacking=False):
 
207
        """Clone this bzrdir and its contents to url verbatim.
 
208
 
 
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
 
144
224
    def clone_on_transport(self, transport, revision_id=None,
145
 
                           force_new_repo=False, preserve_stacking=False, stacked_on=None,
146
 
                           create_prefix=False, use_existing_dir=True, no_tree=False,
147
 
                           tag_selector=None):
 
225
        force_new_repo=False, preserve_stacking=False, stacked_on=None,
 
226
        create_prefix=False, use_existing_dir=True):
148
227
        """Clone this bzrdir and its contents to transport verbatim.
149
228
 
150
229
        :param transport: The transport for the location to produce the clone
159
238
        :param create_prefix: Create any missing directories leading up to
160
239
            to_transport.
161
240
        :param use_existing_dir: Use an existing directory if one exists.
162
 
        :param no_tree: If set to true prevents creation of a working tree.
163
241
        """
164
242
        # Overview: put together a broad description of what we want to end up
165
243
        # with; then make as few api calls as possible to do it.
166
 
 
 
244
        
167
245
        # We may want to create a repo/branch/tree, if we do so what format
168
246
        # would we want for each:
169
247
        require_stacking = (stacked_on is not None)
170
248
        format = self.cloning_metadir(require_stacking)
171
 
 
 
249
        
172
250
        # Figure out what objects we want:
173
251
        try:
174
252
            local_repo = self.find_repository()
175
253
        except errors.NoRepositoryPresent:
176
254
            local_repo = None
177
 
        local_branches = self.get_branches()
178
255
        try:
179
 
            local_active_branch = local_branches['']
180
 
        except KeyError:
181
 
            pass
 
256
            local_branch = self.open_branch()
 
257
        except errors.NotBranchError:
 
258
            local_branch = None
182
259
        else:
183
260
            # enable fallbacks when branch is not a branch reference
184
 
            if local_active_branch.repository.has_same_location(local_repo):
185
 
                local_repo = local_active_branch.repository
 
261
            if local_branch.repository.has_same_location(local_repo):
 
262
                local_repo = local_branch.repository
186
263
            if preserve_stacking:
187
264
                try:
188
 
                    stacked_on = local_active_branch.get_stacked_on_url()
189
 
                except (_mod_branch.UnstackableBranchFormat,
 
265
                    stacked_on = local_branch.get_stacked_on_url()
 
266
                except (errors.UnstackableBranchFormat,
190
267
                        errors.UnstackableRepositoryFormat,
191
268
                        errors.NotStacked):
192
269
                    pass
194
271
        # we should look up the policy needs first, or just use it as a hint,
195
272
        # or something.
196
273
        if local_repo:
197
 
            make_working_trees = (local_repo.make_working_trees() and
198
 
                                  not no_tree)
 
274
            make_working_trees = local_repo.make_working_trees()
199
275
            want_shared = local_repo.is_shared()
200
276
            repo_format_name = format.repository_format.network_name()
201
277
        else:
204
280
            repo_format_name = None
205
281
 
206
282
        result_repo, result, require_stacking, repository_policy = \
207
 
            format.initialize_on_transport_ex(
208
 
                transport, use_existing_dir=use_existing_dir,
209
 
                create_prefix=create_prefix, force_new_repo=force_new_repo,
210
 
                stacked_on=stacked_on, stack_on_pwd=self.root_transport.base,
211
 
                repo_format_name=repo_format_name,
212
 
                make_working_trees=make_working_trees, shared_repo=want_shared)
 
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)
213
289
        if repo_format_name:
214
290
            try:
215
291
                # If the result repository is in the same place as the
219
295
                # revision_id then we can use the pending-ancestry-result which
220
296
                # does not require traversing all of history to describe it.
221
297
                if (result_repo.user_url == result.user_url
222
 
                    and not require_stacking
223
 
                        and revision_id is not None):
224
 
                    fetch_spec = vf_search.PendingAncestryResult(
 
298
                    and not require_stacking and
 
299
                    revision_id is not None):
 
300
                    fetch_spec = graph.PendingAncestryResult(
225
301
                        [revision_id], local_repo)
226
302
                    result_repo.fetch(local_repo, fetch_spec=fetch_spec)
227
303
                else:
234
310
        # 1 if there is a branch present
235
311
        #   make sure its content is available in the target repository
236
312
        #   clone it.
237
 
        for name, local_branch in local_branches.items():
238
 
            local_branch.clone(
239
 
                result, revision_id=(None if name != '' else revision_id),
240
 
                repository_policy=repository_policy,
241
 
                name=name, tag_selector=tag_selector)
 
313
        if local_branch is not None:
 
314
            result_branch = local_branch.clone(result, revision_id=revision_id,
 
315
                repository_policy=repository_policy)
242
316
        try:
243
317
            # Cheaper to check if the target is not local, than to try making
244
318
            # the tree and fail.
245
319
            result.root_transport.local_abspath('.')
246
320
            if result_repo is None or result_repo.make_working_trees():
247
 
                self.open_workingtree().clone(result, revision_id=revision_id)
 
321
                self.open_workingtree().clone(result)
248
322
        except (errors.NoWorkingTree, errors.NotLocalUrl):
249
323
            pass
250
324
        return result
252
326
    # TODO: This should be given a Transport, and should chdir up; otherwise
253
327
    # this will open a new connection.
254
328
    def _make_tail(self, url):
255
 
        t = _mod_transport.get_transport(url)
256
 
        t.ensure_base()
 
329
        t = get_transport(url)
 
330
        t.ensure_base()
 
331
 
 
332
    @classmethod
 
333
    def create(cls, base, format=None, possible_transports=None):
 
334
        """Create a new BzrDir at the url 'base'.
 
335
 
 
336
        :param format: If supplied, the format of branch to create.  If not
 
337
            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
        """
 
341
        if cls is not BzrDir:
 
342
            raise AssertionError("BzrDir.create always creates the default"
 
343
                " format, not one of %r" % cls)
 
344
        t = get_transport(base, possible_transports)
 
345
        t.ensure_base()
 
346
        if format is None:
 
347
            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):
 
433
        """Create a branch in this BzrDir.
 
434
 
 
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.
 
439
        For more control see BranchFormatXX.create(a_bzrdir).
 
440
        """
 
441
        raise NotImplementedError(self.create_branch)
 
442
 
 
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
    @staticmethod
 
452
    def create_branch_and_repo(base, force_new_repo=False, format=None):
 
453
        """Create a new BzrDir, Branch and Repository at the url 'base'.
 
454
 
 
455
        This will use the current default BzrDirFormat unless one is
 
456
        specified, and use whatever
 
457
        repository format that that uses via bzrdir.create_branch and
 
458
        create_repository. If a shared repository is available that is used
 
459
        preferentially.
 
460
 
 
461
        The created Branch object is returned.
 
462
 
 
463
        :param base: The URL to create the branch at.
 
464
        :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
        """
 
468
        bzrdir = BzrDir.create(base, format)
 
469
        bzrdir._find_or_create_repository(force_new_repo)
 
470
        return bzrdir.create_branch()
257
471
 
258
472
    def determine_repository_policy(self, force_new_repo=False, stack_on=None,
259
473
                                    stack_on_pwd=None, require_stacking=False):
285
499
            except errors.NoRepositoryPresent:
286
500
                repository = None
287
501
            else:
288
 
                if (found_bzrdir.user_url != self.user_url and
289
 
                        not repository.is_shared()):
 
502
                if (found_bzrdir.user_url != self.user_url 
 
503
                    and not repository.is_shared()):
290
504
                    # Don't look higher, can't use a higher shared repo.
291
505
                    repository = None
292
506
                    stop = True
295
509
            if not stop:
296
510
                return None, False
297
511
            if repository:
298
 
                return UseExistingRepository(
299
 
                    repository, stack_on, stack_on_pwd,
300
 
                    require_stacking=require_stacking), True
 
512
                return UseExistingRepository(repository, stack_on,
 
513
                    stack_on_pwd, require_stacking=require_stacking), True
301
514
            else:
302
 
                return CreateRepository(
303
 
                    self, stack_on, stack_on_pwd,
 
515
                return CreateRepository(self, stack_on, stack_on_pwd,
304
516
                    require_stacking=require_stacking), True
305
517
 
306
518
        if not force_new_repo:
310
522
                    return policy
311
523
            else:
312
524
                try:
313
 
                    return UseExistingRepository(
314
 
                        self.open_repository(), stack_on, stack_on_pwd,
 
525
                    return UseExistingRepository(self.open_repository(),
 
526
                        stack_on, stack_on_pwd,
315
527
                        require_stacking=require_stacking)
316
528
                except errors.NoRepositoryPresent:
317
529
                    pass
323
535
        policy = self.determine_repository_policy(force_new_repo)
324
536
        return policy.acquire_repository()[0]
325
537
 
326
 
    def _find_source_repo(self, exit_stack, source_branch):
327
 
        """Find the source branch and repo for a sprout operation.
328
 
 
329
 
        This is helper intended for use by _sprout.
330
 
 
331
 
        :returns: (source_branch, source_repository).  Either or both may be
332
 
            None.  If not None, they will be read-locked (and their unlock(s)
333
 
            scheduled via the exit_stack param).
 
538
    @staticmethod
 
539
    def create_branch_convenience(base, force_new_repo=False,
 
540
                                  force_new_tree=None, format=None,
 
541
                                  possible_transports=None):
 
542
        """Create a new BzrDir, Branch and Repository at the url 'base'.
 
543
 
 
544
        This is a convenience function - it will use an existing repository
 
545
        if possible, can be told explicitly whether to create a working tree or
 
546
        not.
 
547
 
 
548
        This will use the current default BzrDirFormat unless one is
 
549
        specified, and use whatever
 
550
        repository format that that uses via bzrdir.create_branch and
 
551
        create_repository. If a shared repository is available that is used
 
552
        preferentially. Whatever repository is used, its tree creation policy
 
553
        is followed.
 
554
 
 
555
        The created Branch object is returned.
 
556
        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
 
558
        data is created on disk and NotLocalUrl is raised.
 
559
 
 
560
        :param base: The URL to create the branch at.
 
561
        :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
 
563
                               prevent such creation respectively.
 
564
        :param format: Override for the bzrdir format to create.
 
565
        :param possible_transports: An optional reusable transports list.
334
566
        """
335
 
        if source_branch is not None:
336
 
            exit_stack.enter_context(source_branch.lock_read())
337
 
            return source_branch, source_branch.repository
338
 
        try:
339
 
            source_branch = self.open_branch()
340
 
            source_repository = source_branch.repository
341
 
        except errors.NotBranchError:
342
 
            source_branch = None
 
567
        if force_new_tree:
 
568
            # check for non local urls
 
569
            t = get_transport(base, possible_transports)
 
570
            if not isinstance(t, local.LocalTransport):
 
571
                raise errors.NotLocalUrl(base)
 
572
        bzrdir = BzrDir.create(base, format, possible_transports)
 
573
        repo = bzrdir._find_or_create_repository(force_new_repo)
 
574
        result = bzrdir.create_branch()
 
575
        if force_new_tree or (repo.make_working_trees() and
 
576
                              force_new_tree is None):
343
577
            try:
344
 
                source_repository = self.open_repository()
345
 
            except errors.NoRepositoryPresent:
346
 
                source_repository = None
347
 
            else:
348
 
                exit_stack.enter_context(source_repository.lock_read())
349
 
        else:
350
 
            exit_stack.enter_context(source_branch.lock_read())
351
 
        return source_branch, source_repository
352
 
 
353
 
    def sprout(self, url, revision_id=None, force_new_repo=False,
354
 
               recurse='down', possible_transports=None,
355
 
               accelerator_tree=None, hardlink=False, stacked=False,
356
 
               source_branch=None, create_tree_if_local=True,
357
 
               lossy=False):
358
 
        """Create a copy of this controldir prepared for use as a new line of
359
 
        development.
360
 
 
361
 
        If url's last component does not exist, it will be created.
362
 
 
363
 
        Attributes related to the identity of the source branch like
364
 
        branch nickname will be cleaned, a working tree is created
365
 
        whether one existed before or not; and a local branch is always
366
 
        created.
367
 
 
368
 
        if revision_id is not None, then the clone operation may tune
369
 
            itself to download less data.
370
 
 
 
578
                bzrdir.create_workingtree()
 
579
            except errors.NotLocalUrl:
 
580
                pass
 
581
        return result
 
582
 
 
583
    @staticmethod
 
584
    def create_standalone_workingtree(base, format=None):
 
585
        """Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
 
586
 
 
587
        'base' must be a local path or a file:// url.
 
588
 
 
589
        This will use the current default BzrDirFormat unless one is
 
590
        specified, and use whatever
 
591
        repository format that that uses for bzrdirformat.create_workingtree,
 
592
        create_branch and create_repository.
 
593
 
 
594
        :param format: Override for the bzrdir format to create.
 
595
        :return: The WorkingTree object.
 
596
        """
 
597
        t = get_transport(base)
 
598
        if not isinstance(t, local.LocalTransport):
 
599
            raise errors.NotLocalUrl(base)
 
600
        bzrdir = BzrDir.create_branch_and_repo(base,
 
601
                                               force_new_repo=True,
 
602
                                               format=format).bzrdir
 
603
        return bzrdir.create_workingtree()
 
604
 
 
605
    def create_workingtree(self, revision_id=None, from_branch=None,
 
606
        accelerator_tree=None, hardlink=False):
 
607
        """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)
371
611
        :param accelerator_tree: A tree which can be used for retrieving file
372
612
            contents more quickly than the revision tree, i.e. a workingtree.
373
613
            The revision tree will be used for cases where accelerator_tree's
374
614
            content is different.
375
 
        :param hardlink: If true, hard-link files from accelerator_tree,
376
 
            where possible.
377
 
        :param stacked: If true, create a stacked branch referring to the
378
 
            location of this control directory.
379
 
        :param create_tree_if_local: If true, a working-tree will be created
380
 
            when working locally.
381
 
        :return: The created control directory
382
 
        """
383
 
        with cleanup.ExitStack() as stack:
384
 
            fetch_spec_factory = fetch.FetchSpecFactory()
385
 
            if revision_id is not None:
386
 
                fetch_spec_factory.add_revision_ids([revision_id])
387
 
                fetch_spec_factory.source_branch_stop_revision_id = revision_id
388
 
            if possible_transports is None:
389
 
                possible_transports = []
390
 
            else:
391
 
                possible_transports = list(possible_transports) + [
392
 
                    self.root_transport]
393
 
            target_transport = _mod_transport.get_transport(url,
394
 
                                                            possible_transports)
395
 
            target_transport.ensure_base()
396
 
            cloning_format = self.cloning_metadir(stacked)
397
 
            # Create/update the result branch
398
 
            try:
399
 
                result = controldir.ControlDir.open_from_transport(
400
 
                    target_transport)
401
 
            except errors.NotBranchError:
402
 
                result = cloning_format.initialize_on_transport(target_transport)
403
 
            source_branch, source_repository = self._find_source_repo(
404
 
                stack, source_branch)
405
 
            fetch_spec_factory.source_branch = source_branch
406
 
            # if a stacked branch wasn't requested, we don't create one
407
 
            # even if the origin was stacked
408
 
            if stacked and source_branch is not None:
409
 
                stacked_branch_url = self.root_transport.base
410
 
            else:
411
 
                stacked_branch_url = None
412
 
            repository_policy = result.determine_repository_policy(
413
 
                force_new_repo, stacked_branch_url, require_stacking=stacked)
414
 
            result_repo, is_new_repo = repository_policy.acquire_repository(
415
 
                possible_transports=possible_transports)
416
 
            stack.enter_context(result_repo.lock_write())
417
 
            fetch_spec_factory.source_repo = source_repository
418
 
            fetch_spec_factory.target_repo = result_repo
419
 
            if stacked or (len(result_repo._fallback_repositories) != 0):
420
 
                target_repo_kind = fetch.TargetRepoKinds.STACKED
421
 
            elif is_new_repo:
422
 
                target_repo_kind = fetch.TargetRepoKinds.EMPTY
423
 
            else:
424
 
                target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
425
 
            fetch_spec_factory.target_repo_kind = target_repo_kind
426
 
            if source_repository is not None:
427
 
                fetch_spec = fetch_spec_factory.make_fetch_spec()
428
 
                result_repo.fetch(source_repository, fetch_spec=fetch_spec)
429
 
 
430
 
            if source_branch is None:
431
 
                # this is for sprouting a controldir without a branch; is that
432
 
                # actually useful?
433
 
                # Not especially, but it's part of the contract.
434
 
                result_branch = result.create_branch()
435
 
            else:
436
 
                result_branch = source_branch.sprout(
437
 
                    result, revision_id=revision_id,
438
 
                    repository_policy=repository_policy, repository=result_repo)
439
 
            mutter("created new branch %r" % (result_branch,))
440
 
 
441
 
            # Create/update the result working tree
442
 
            if (create_tree_if_local and not result.has_workingtree()
443
 
                    and isinstance(target_transport, local.LocalTransport)
444
 
                    and (result_repo is None or result_repo.make_working_trees())
445
 
                    and result.open_branch(
446
 
                        name="",
447
 
                        possible_transports=possible_transports).name == result_branch.name):
448
 
                wt = result.create_workingtree(
449
 
                    accelerator_tree=accelerator_tree, hardlink=hardlink,
450
 
                    from_branch=result_branch)
451
 
                with wt.lock_write():
452
 
                    if not wt.is_versioned(''):
453
 
                        try:
454
 
                            wt.set_root_id(self.open_workingtree.path2id(''))
455
 
                        except errors.NoWorkingTree:
456
 
                            pass
457
 
            else:
458
 
                wt = None
459
 
            if recurse == 'down':
460
 
                tree = None
461
 
                if wt is not None:
462
 
                    tree = wt
463
 
                    basis = tree.basis_tree()
464
 
                    stack.enter_context(basis.lock_read())
465
 
                elif result_branch is not None:
466
 
                    basis = tree = result_branch.basis_tree()
467
 
                elif source_branch is not None:
468
 
                    basis = tree = source_branch.basis_tree()
469
 
                if tree is not None:
470
 
                    stack.enter_context(tree.lock_read())
471
 
                    subtrees = tree.iter_references()
472
 
                else:
473
 
                    subtrees = []
474
 
                for path in subtrees:
475
 
                    target = urlutils.join(url, urlutils.escape(path))
476
 
                    sublocation = tree.reference_parent(
477
 
                        path, branch=result_branch,
478
 
                        possible_transports=possible_transports)
479
 
                    if sublocation is None:
480
 
                        warning(
481
 
                            'Ignoring nested tree %s, parent location unknown.',
482
 
                            path)
483
 
                        continue
484
 
                    sublocation.controldir.sprout(
485
 
                        target, basis.get_reference_revision(path),
486
 
                        force_new_repo=force_new_repo, recurse=recurse,
487
 
                        stacked=stacked)
488
 
            return result
489
 
 
490
 
    def _available_backup_name(self, base):
491
 
        """Find a non-existing backup file name based on base.
492
 
 
493
 
        See breezy.osutils.available_backup_name about race conditions.
494
 
        """
495
 
        return osutils.available_backup_name(base, self.root_transport.has)
 
615
        """
 
616
        raise NotImplementedError(self.create_workingtree)
496
617
 
497
618
    def backup_bzrdir(self):
498
619
        """Backup this bzr control directory.
499
620
 
500
621
        :return: Tuple with old path name and new path name
501
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
502
630
 
503
 
        with ui.ui_factory.nested_progress_bar():
 
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
            #
504
638
            old_path = self.root_transport.abspath('.bzr')
505
 
            backup_dir = self._available_backup_name('backup.bzr')
506
639
            new_path = self.root_transport.abspath(backup_dir)
507
 
            ui.ui_factory.note(
508
 
                gettext('making backup of {0}\n  to {1}').format(
509
 
                    urlutils.unescape_for_display(old_path, 'utf-8'),
510
 
                    urlutils.unescape_for_display(new_path, 'utf-8')))
 
640
            ui.ui_factory.note('making backup of %s\n  to %s' % (old_path, new_path,))
511
641
            self.root_transport.copy_tree('.bzr', backup_dir)
512
642
            return (old_path, new_path)
 
643
        finally:
 
644
            pb.finished()
513
645
 
514
646
    def retire_bzrdir(self, limit=10000):
515
647
        """Permanently disable the bzrdir.
521
653
        in use.
522
654
        :param limit: number of times to retry
523
655
        """
524
 
        i = 0
 
656
        i  = 0
525
657
        while True:
526
658
            try:
527
659
                to_path = '.bzr.retired.%d' % i
528
660
                self.root_transport.rename('.bzr', to_path)
529
 
                note(gettext("renamed {0} to {1}").format(
530
 
                    self.root_transport.abspath('.bzr'), to_path))
 
661
                note("renamed %s to %s"
 
662
                    % (self.root_transport.abspath('.bzr'), to_path))
531
663
                return
532
664
            except (errors.TransportError, IOError, errors.PathError):
533
665
                i += 1
536
668
                else:
537
669
                    pass
538
670
 
 
671
    def destroy_workingtree(self):
 
672
        """Destroy the working tree at this BzrDir.
 
673
 
 
674
        Formats that do not support this may raise UnsupportedOperation.
 
675
        """
 
676
        raise NotImplementedError(self.destroy_workingtree)
 
677
 
 
678
    def destroy_workingtree_metadata(self):
 
679
        """Destroy the control files for the working tree at this BzrDir.
 
680
 
 
681
        The contents of working tree files are not affected.
 
682
        Formats that do not support this may raise UnsupportedOperation.
 
683
        """
 
684
        raise NotImplementedError(self.destroy_workingtree_metadata)
 
685
 
539
686
    def _find_containing(self, evaluate):
540
687
        """Find something in a containing control directory.
541
688
 
560
707
                return None
561
708
            # find the next containing bzrdir
562
709
            try:
563
 
                found_bzrdir = self.open_containing_from_transport(
 
710
                found_bzrdir = BzrDir.open_containing_from_transport(
564
711
                    next_transport)[0]
565
712
            except errors.NotBranchError:
566
713
                return None
590
737
            raise errors.NoRepositoryPresent(self)
591
738
        return found_repo
592
739
 
 
740
    def get_branch_reference(self):
 
741
        """Return the referenced URL for the branch in this bzrdir.
 
742
 
 
743
        :raises NotBranchError: If there is no Branch.
 
744
        :return: The URL the branch in this bzrdir references if it is a
 
745
            reference branch, or None for regular branches.
 
746
        """
 
747
        return None
 
748
 
 
749
    def get_branch_transport(self, branch_format, name=None):
 
750
        """Get the transport for use by branch format in this BzrDir.
 
751
 
 
752
        Note that bzr dirs that do not support format strings will raise
 
753
        IncompatibleFormat if the branch format they are given has
 
754
        a format string, and vice versa.
 
755
 
 
756
        If branch_format is None, the transport is returned with no
 
757
        checking. If it is not None, then the returned transport is
 
758
        guaranteed to point to an existing directory ready for use.
 
759
        """
 
760
        raise NotImplementedError(self.get_branch_transport)
 
761
 
593
762
    def _find_creation_modes(self):
594
763
        """Determine the appropriate modes for files and directories.
595
764
 
611
780
            # directories and files are read-write for this user. This is
612
781
            # mostly a workaround for filesystems which lie about being able to
613
782
            # write to a directory (cygwin & win32)
614
 
            if (st.st_mode & 0o7777 == 00000):
 
783
            if (st.st_mode & 07777 == 00000):
615
784
                # FTP allows stat but does not return dir/file modes
616
785
                self._dir_mode = None
617
786
                self._file_mode = None
618
787
            else:
619
 
                self._dir_mode = (st.st_mode & 0o7777) | 0o0700
 
788
                self._dir_mode = (st.st_mode & 07777) | 00700
620
789
                # Remove the sticky and execute bits for files
621
 
                self._file_mode = self._dir_mode & ~0o7111
 
790
                self._file_mode = self._dir_mode & ~07111
622
791
 
623
792
    def _get_file_mode(self):
624
793
        """Return Unix mode for newly created files, or None.
634
803
            self._find_creation_modes()
635
804
        return self._dir_mode
636
805
 
 
806
    def get_repository_transport(self, repository_format):
 
807
        """Get the transport for use by repository format in this BzrDir.
 
808
 
 
809
        Note that bzr dirs that do not support format strings will raise
 
810
        IncompatibleFormat if the repository format they are given has
 
811
        a format string, and vice versa.
 
812
 
 
813
        If repository_format is None, the transport is returned with no
 
814
        checking. If it is not None, then the returned transport is
 
815
        guaranteed to point to an existing directory ready for use.
 
816
        """
 
817
        raise NotImplementedError(self.get_repository_transport)
 
818
 
 
819
    def get_workingtree_transport(self, tree_format):
 
820
        """Get the transport for use by workingtree format in this BzrDir.
 
821
 
 
822
        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.
 
825
 
 
826
        If workingtree_format is None, the transport is returned with no
 
827
        checking. If it is not None, then the returned transport is
 
828
        guaranteed to point to an existing directory ready for use.
 
829
        """
 
830
        raise NotImplementedError(self.get_workingtree_transport)
 
831
 
637
832
    def get_config(self):
638
833
        """Get configuration for this BzrDir."""
639
834
        return config.BzrDirConfig(self)
652
847
        :param _transport: the transport this dir is based at.
653
848
        """
654
849
        self._format = _format
655
 
        # these are also under the more standard names of
 
850
        # these are also under the more standard names of 
656
851
        # control_transport and user_transport
657
852
        self.transport = _transport.clone('.bzr')
658
853
        self.root_transport = _transport
659
854
        self._mode_check_done = False
660
 
 
661
 
    @property
 
855
        
 
856
    @property 
662
857
    def user_transport(self):
663
858
        return self.root_transport
664
 
 
 
859
        
665
860
    @property
666
861
    def control_transport(self):
667
862
        return self.transport
668
863
 
 
864
    def is_control_filename(self, filename):
 
865
        """True if filename is the name of a path which is reserved for bzrdir's.
 
866
 
 
867
        :param filename: A filename within the root transport of this bzrdir.
 
868
 
 
869
        This is true IF and ONLY IF the filename is part of the namespace reserved
 
870
        for bzr control dirs. Currently this is the '.bzr' directory in the root
 
871
        of the root_transport. it is expected that plugins will need to extend
 
872
        this in the future - for instance to make bzr talk with svn working
 
873
        trees.
 
874
        """
 
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
 
880
        # add new tests for it to the appropriate place.
 
881
        return filename == '.bzr' or filename.startswith('.bzr/')
 
882
 
 
883
    def needs_format_conversion(self, format=None):
 
884
        """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
 
887
        branch and working tree are not, this should return True.
 
888
 
 
889
        :param format: Optional parameter indicating a specific desired
 
890
                       format we plan to arrive at.
 
891
        """
 
892
        raise NotImplementedError(self.needs_format_conversion)
 
893
 
 
894
    @staticmethod
 
895
    def open_unsupported(base):
 
896
        """Open a branch which is not supported."""
 
897
        return BzrDir.open(base, _unsupported=True)
 
898
 
 
899
    @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.
 
904
        """
 
905
        t = get_transport(base, possible_transports=possible_transports)
 
906
        return BzrDir.open_from_transport(t, _unsupported=_unsupported)
 
907
 
 
908
    @staticmethod
 
909
    def open_from_transport(transport, _unsupported=False,
 
910
                            _server_formats=True):
 
911
        """Open a bzrdir within a particular directory.
 
912
 
 
913
        :param transport: Transport containing the bzrdir.
 
914
        :param _unsupported: private.
 
915
        """
 
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
 
 
940
        BzrDir._check_supported(format, _unsupported)
 
941
        return format.open(transport, _found=True)
 
942
 
 
943
    def open_branch(self, name=None, unsupported=False,
 
944
                    ignore_fallbacks=False):
 
945
        """Open the branch object at this BzrDir if one is present.
 
946
 
 
947
        If unsupported is True, then no longer supported branch formats can
 
948
        still be opened.
 
949
 
 
950
        TODO: static convenience version of this?
 
951
        """
 
952
        raise NotImplementedError(self.open_branch)
 
953
 
 
954
    @staticmethod
 
955
    def open_containing(url, possible_transports=None):
 
956
        """Open an existing branch which contains url.
 
957
 
 
958
        :param url: url to search from.
 
959
        See open_containing_from_transport for more detail.
 
960
        """
 
961
        transport = get_transport(url, possible_transports)
 
962
        return BzrDir.open_containing_from_transport(transport)
 
963
 
 
964
    @staticmethod
 
965
    def open_containing_from_transport(a_transport):
 
966
        """Open an existing branch which contains a_transport.base.
 
967
 
 
968
        This probes for a branch at a_transport, and searches upwards from there.
 
969
 
 
970
        Basically we keep looking up until we find the control directory or
 
971
        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
 
973
        format, UnknownFormatError or UnsupportedFormatError are raised.
 
974
        If there is one, it is returned, along with the unused portion of url.
 
975
 
 
976
        :return: The BzrDir that contains the path, and a Unicode path
 
977
                for the rest of the URL.
 
978
        """
 
979
        # this gets the normalised url back. I.e. '.' -> the full path.
 
980
        url = a_transport.base
 
981
        while True:
 
982
            try:
 
983
                result = BzrDir.open_from_transport(a_transport)
 
984
                return result, urlutils.unescape(a_transport.relpath(url))
 
985
            except errors.NotBranchError, e:
 
986
                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)
 
992
            if new_t.base == a_transport.base:
 
993
                # reached the root, whatever that may be
 
994
                raise errors.NotBranchError(path=url)
 
995
            a_transport = new_t
 
996
 
 
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
    @classmethod
 
1026
    def open_containing_tree_or_branch(klass, location):
 
1027
        """Return the branch and working tree contained by a location.
 
1028
 
 
1029
        Returns (tree, branch, relpath).
 
1030
        If there is no tree at containing the location, tree will be None.
 
1031
        If there is no branch containing the location, an exception will be
 
1032
        raised
 
1033
        relpath is the portion of the path that is contained by the branch.
 
1034
        """
 
1035
        bzrdir, relpath = klass.open_containing(location)
 
1036
        tree, branch = bzrdir._get_tree_branch()
 
1037
        return tree, branch, relpath
 
1038
 
 
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
    def open_repository(self, _unsupported=False):
 
1065
        """Open the repository object at this BzrDir if one is present.
 
1066
 
 
1067
        This will not follow the Branch object pointer - it's strictly a direct
 
1068
        open facility. Most client code should use open_branch().repository to
 
1069
        get at a repository.
 
1070
 
 
1071
        :param _unsupported: a private parameter, not part of the api.
 
1072
        TODO: static convenience version of this?
 
1073
        """
 
1074
        raise NotImplementedError(self.open_repository)
 
1075
 
 
1076
    def open_workingtree(self, _unsupported=False,
 
1077
                         recommend_upgrade=True, from_branch=None):
 
1078
        """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)
 
1085
        """
 
1086
        raise NotImplementedError(self.open_workingtree)
 
1087
 
 
1088
    def has_branch(self, name=None):
 
1089
        """Tell if this bzrdir contains a branch.
 
1090
 
 
1091
        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.)
 
1094
        """
 
1095
        try:
 
1096
            self.open_branch(name)
 
1097
            return True
 
1098
        except errors.NotBranchError:
 
1099
            return False
 
1100
 
 
1101
    def has_workingtree(self):
 
1102
        """Tell if this bzrdir contains a working tree.
 
1103
 
 
1104
        This will still raise an exception if the bzrdir has a workingtree that
 
1105
        is remote & inaccessible.
 
1106
 
 
1107
        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.)
 
1110
        """
 
1111
        try:
 
1112
            self.open_workingtree(recommend_upgrade=False)
 
1113
            return True
 
1114
        except errors.NoWorkingTree:
 
1115
            return False
 
1116
 
669
1117
    def _cloning_metadir(self):
670
1118
        """Produce a metadir suitable for cloning with.
671
1119
 
678
1126
                source_repository = branch.repository
679
1127
                result_format._branch_format = branch._format
680
1128
            except errors.NotBranchError:
 
1129
                source_branch = None
681
1130
                source_repository = self.open_repository()
682
1131
        except errors.NoRepositoryPresent:
683
1132
            source_repository = None
710
1159
 
711
1160
        :require_stacking: If True, non-stackable formats will be upgraded
712
1161
            to similar stackable formats.
713
 
        :returns: a ControlDirFormat with all component formats either set
 
1162
        :returns: a BzrDirFormat with all component formats either set
714
1163
            appropriately or set to None if that component should not be
715
1164
            created.
716
1165
        """
722
1171
                return format
723
1172
            # We have a repository, so set a working tree? (Why? This seems to
724
1173
            # contradict the stated return value in the docstring).
725
 
            tree_format = (
726
 
                repository._format._matchingcontroldir.workingtree_format)
 
1174
            tree_format = repository._format._matchingbzrdir.workingtree_format
727
1175
            format.workingtree_format = tree_format.__class__()
728
1176
        if require_stacking:
729
1177
            format.require_stacking()
730
1178
        return format
731
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):
 
1187
        """Create a copy of this bzrdir prepared for use as a new line of
 
1188
        development.
 
1189
 
 
1190
        If url's last component does not exist, it will be created.
 
1191
 
 
1192
        Attributes related to the identity of the source branch like
 
1193
        branch nickname will be cleaned, a working tree is created
 
1194
        whether one existed before or not; and a local branch is always
 
1195
        created.
 
1196
 
 
1197
        if revision_id is not None, then the clone operation may tune
 
1198
            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
        """
 
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
 
1221
            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:
 
1246
                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()
 
1304
        return result
 
1305
 
 
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
 
 
1422
class BzrDirPreSplitOut(BzrDir):
 
1423
    """A common class for the all-in-one formats."""
 
1424
 
 
1425
    def __init__(self, _transport, _format):
 
1426
        """See BzrDir.__init__."""
 
1427
        super(BzrDirPreSplitOut, self).__init__(_transport, _format)
 
1428
        self._control_files = lockable_files.LockableFiles(
 
1429
                                            self.get_branch_transport(None),
 
1430
                                            self._format._lock_file_name,
 
1431
                                            self._format._lock_class)
 
1432
 
 
1433
    def break_lock(self):
 
1434
        """Pre-splitout bzrdirs do not suffer from stale locks."""
 
1435
        raise NotImplementedError(self.break_lock)
 
1436
 
 
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
        """
 
1452
        self._make_tail(url)
 
1453
        result = self._format._initialize_for_clone(url)
 
1454
        self.open_repository().clone(result, revision_id=revision_id)
 
1455
        from_branch = self.open_branch()
 
1456
        from_branch.clone(result, revision_id=revision_id)
 
1457
        try:
 
1458
            tree = self.open_workingtree()
 
1459
        except errors.NotLocalUrl:
 
1460
            # make a new one, this format always has to have one.
 
1461
            result._init_workingtree()
 
1462
        else:
 
1463
            tree.clone(result)
 
1464
        return result
 
1465
 
 
1466
    def create_branch(self, name=None):
 
1467
        """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)
 
1473
 
 
1474
    def create_repository(self, shared=False):
 
1475
        """See BzrDir.create_repository."""
 
1476
        if shared:
 
1477
            raise errors.IncompatibleFormat('shared repository', self._format)
 
1478
        return self.open_repository()
 
1479
 
 
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):
 
1486
        """See BzrDir.create_workingtree."""
 
1487
        # The workingtree is sometimes created when the bzrdir is created,
 
1488
        # but not when cloning.
 
1489
 
 
1490
        # this looks buggy but is not -really-
 
1491
        # because this format creates the workingtree when the bzrdir is
 
1492
        # created
 
1493
        # clone and sprout will have set the revision_id
 
1494
        # and that will have set it for us, its only
 
1495
        # specific uses of create_workingtree in isolation
 
1496
        # that can do wonky stuff here, and that only
 
1497
        # happens for creating checkouts, which cannot be
 
1498
        # 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()
 
1506
        if revision_id is not None:
 
1507
            if revision_id == _mod_revision.NULL_REVISION:
 
1508
                result.set_parent_ids([])
 
1509
            else:
 
1510
                result.set_parent_ids([revision_id])
 
1511
        return result
 
1512
 
 
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
    def destroy_workingtree(self):
 
1524
        """See BzrDir.destroy_workingtree."""
 
1525
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
 
1526
 
 
1527
    def destroy_workingtree_metadata(self):
 
1528
        """See BzrDir.destroy_workingtree_metadata."""
 
1529
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
 
1530
                                          self)
 
1531
 
732
1532
    def get_branch_transport(self, branch_format, name=None):
733
 
        """Get the transport for use by branch format in this BzrDir.
734
 
 
735
 
        Note that bzr dirs that do not support format strings will raise
736
 
        IncompatibleFormat if the branch format they are given has
737
 
        a format string, and vice versa.
738
 
 
739
 
        If branch_format is None, the transport is returned with no
740
 
        checking. If it is not None, then the returned transport is
741
 
        guaranteed to point to an existing directory ready for use.
742
 
        """
743
 
        raise NotImplementedError(self.get_branch_transport)
 
1533
        """See BzrDir.get_branch_transport()."""
 
1534
        if name is not None:
 
1535
            raise errors.NoColocatedBranchSupport(self)
 
1536
        if branch_format is None:
 
1537
            return self.transport
 
1538
        try:
 
1539
            branch_format.get_format_string()
 
1540
        except NotImplementedError:
 
1541
            return self.transport
 
1542
        raise errors.IncompatibleFormat(branch_format, self._format)
744
1543
 
745
1544
    def get_repository_transport(self, repository_format):
746
 
        """Get the transport for use by repository format in this BzrDir.
747
 
 
748
 
        Note that bzr dirs that do not support format strings will raise
749
 
        IncompatibleFormat if the repository format they are given has
750
 
        a format string, and vice versa.
751
 
 
752
 
        If repository_format is None, the transport is returned with no
753
 
        checking. If it is not None, then the returned transport is
754
 
        guaranteed to point to an existing directory ready for use.
755
 
        """
756
 
        raise NotImplementedError(self.get_repository_transport)
757
 
 
758
 
    def get_workingtree_transport(self, tree_format):
759
 
        """Get the transport for use by workingtree format in this BzrDir.
760
 
 
761
 
        Note that bzr dirs that do not support format strings will raise
762
 
        IncompatibleFormat if the workingtree format they are given has a
763
 
        format string, and vice versa.
764
 
 
765
 
        If workingtree_format is None, the transport is returned with no
766
 
        checking. If it is not None, then the returned transport is
767
 
        guaranteed to point to an existing directory ready for use.
768
 
        """
769
 
        raise NotImplementedError(self.get_workingtree_transport)
770
 
 
771
 
    @classmethod
772
 
    def create(cls, base, format=None, possible_transports=None):
773
 
        """Create a new BzrDir at the url 'base'.
774
 
 
775
 
        :param format: If supplied, the format of branch to create.  If not
776
 
            supplied, the default is used.
777
 
        :param possible_transports: If supplied, a list of transports that
778
 
            can be reused to share a remote connection.
779
 
        """
780
 
        if cls is not BzrDir:
781
 
            raise AssertionError("BzrDir.create always creates the "
782
 
                                 "default format, not one of %r" % cls)
783
 
        return controldir.ControlDir.create(
784
 
            base, format=format, possible_transports=possible_transports)
785
 
 
786
 
    def __repr__(self):
787
 
        return "<%s at %r>" % (self.__class__.__name__, self.user_url)
788
 
 
789
 
    def update_feature_flags(self, updated_flags):
790
 
        """Update the features required by this bzrdir.
791
 
 
792
 
        :param updated_flags: Dictionary mapping feature names to necessities
793
 
            A necessity can be None to indicate the feature should be removed
794
 
        """
795
 
        self.control_files.lock_write()
796
 
        try:
797
 
            self._format._update_feature_flags(updated_flags)
798
 
            self.transport.put_bytes('branch-format', self._format.as_string())
799
 
        finally:
800
 
            self.control_files.unlock()
 
1545
        """See BzrDir.get_repository_transport()."""
 
1546
        if repository_format is None:
 
1547
            return self.transport
 
1548
        try:
 
1549
            repository_format.get_format_string()
 
1550
        except NotImplementedError:
 
1551
            return self.transport
 
1552
        raise errors.IncompatibleFormat(repository_format, self._format)
 
1553
 
 
1554
    def get_workingtree_transport(self, workingtree_format):
 
1555
        """See BzrDir.get_workingtree_transport()."""
 
1556
        if workingtree_format is None:
 
1557
            return self.transport
 
1558
        try:
 
1559
            workingtree_format.get_format_string()
 
1560
        except NotImplementedError:
 
1561
            return self.transport
 
1562
        raise errors.IncompatibleFormat(workingtree_format, self._format)
 
1563
 
 
1564
    def needs_format_conversion(self, format=None):
 
1565
        """See BzrDir.needs_format_conversion()."""
 
1566
        # if the format is not the same as the system default,
 
1567
        # an upgrade is needed.
 
1568
        if format is None:
 
1569
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
 
1570
                % 'needs_format_conversion(format=None)')
 
1571
            format = BzrDirFormat.get_default_format()
 
1572
        return not isinstance(self._format, format.__class__)
 
1573
 
 
1574
    def open_branch(self, name=None, unsupported=False,
 
1575
                    ignore_fallbacks=False):
 
1576
        """See BzrDir.open_branch."""
 
1577
        from bzrlib.branch import BzrBranchFormat4
 
1578
        format = BzrBranchFormat4()
 
1579
        self._check_supported(format, unsupported)
 
1580
        return format.open(self, name, _found=True)
 
1581
 
 
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):
 
1586
        """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
        from bzrlib.workingtree import WorkingTreeFormat2
 
1600
        self._make_tail(url)
 
1601
        result = self._format._initialize_for_clone(url)
 
1602
        try:
 
1603
            self.open_repository().clone(result, revision_id=revision_id)
 
1604
        except errors.NoRepositoryPresent:
 
1605
            pass
 
1606
        try:
 
1607
            self.open_branch().sprout(result, revision_id=revision_id)
 
1608
        except errors.NotBranchError:
 
1609
            pass
 
1610
 
 
1611
        # we always want a working tree
 
1612
        WorkingTreeFormat2().initialize(result,
 
1613
                                        accelerator_tree=accelerator_tree,
 
1614
                                        hardlink=hardlink)
 
1615
        return result
 
1616
 
 
1617
 
 
1618
class BzrDir4(BzrDirPreSplitOut):
 
1619
    """A .bzr version 4 control object.
 
1620
 
 
1621
    This is a deprecated format and may be removed after sept 2006.
 
1622
    """
 
1623
 
 
1624
    def create_repository(self, shared=False):
 
1625
        """See BzrDir.create_repository."""
 
1626
        return self._format.repository_format.initialize(self, shared)
 
1627
 
 
1628
    def needs_format_conversion(self, format=None):
 
1629
        """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
        return True
 
1634
 
 
1635
    def open_repository(self):
 
1636
        """See BzrDir.open_repository."""
 
1637
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
1638
        return RepositoryFormat4().open(self, _found=True)
 
1639
 
 
1640
 
 
1641
class BzrDir5(BzrDirPreSplitOut):
 
1642
    """A .bzr version 5 control object.
 
1643
 
 
1644
    This is a deprecated format and may be removed after sept 2006.
 
1645
    """
 
1646
 
 
1647
    def has_workingtree(self):
 
1648
        """See BzrDir.has_workingtree."""
 
1649
        return True
 
1650
    
 
1651
    def open_repository(self):
 
1652
        """See BzrDir.open_repository."""
 
1653
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1654
        return RepositoryFormat5().open(self, _found=True)
 
1655
 
 
1656
    def open_workingtree(self, _unsupported=False,
 
1657
            recommend_upgrade=True):
 
1658
        """See BzrDir.create_workingtree."""
 
1659
        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)
 
1664
 
 
1665
 
 
1666
class BzrDir6(BzrDirPreSplitOut):
 
1667
    """A .bzr version 6 control object.
 
1668
 
 
1669
    This is a deprecated format and may be removed after sept 2006.
 
1670
    """
 
1671
 
 
1672
    def has_workingtree(self):
 
1673
        """See BzrDir.has_workingtree."""
 
1674
        return True
 
1675
    
 
1676
    def open_repository(self):
 
1677
        """See BzrDir.open_repository."""
 
1678
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1679
        return RepositoryFormat6().open(self, _found=True)
 
1680
 
 
1681
    def open_workingtree(self, _unsupported=False,
 
1682
        recommend_upgrade=True):
 
1683
        """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
        from bzrlib.workingtree import WorkingTreeFormat2
 
1687
        return WorkingTreeFormat2().open(self, _found=True)
801
1688
 
802
1689
 
803
1690
class BzrDirMeta1(BzrDir):
809
1696
    present within a BzrDir.
810
1697
    """
811
1698
 
812
 
    def _get_branch_path(self, name):
813
 
        """Obtain the branch path to use.
814
 
 
815
 
        This uses the API specified branch name first, and then falls back to
816
 
        the branch name specified in the URL. If neither of those is specified,
817
 
        it uses the default branch.
818
 
 
819
 
        :param name: Optional branch name to use
820
 
        :return: Relative path to branch
821
 
        """
822
 
        if name == "":
823
 
            return 'branch'
824
 
        return urlutils.join('branches', urlutils.escape(name))
825
 
 
826
 
    def _read_branch_list(self):
827
 
        """Read the branch list.
828
 
 
829
 
        :return: List of branch names.
830
 
        """
831
 
        try:
832
 
            f = self.control_transport.get('branch-list')
833
 
        except errors.NoSuchFile:
834
 
            return []
835
 
 
836
 
        ret = []
837
 
        try:
838
 
            for name in f:
839
 
                ret.append(name.rstrip(b"\n").decode('utf-8'))
840
 
        finally:
841
 
            f.close()
842
 
        return ret
843
 
 
844
 
    def _write_branch_list(self, branches):
845
 
        """Write out the branch list.
846
 
 
847
 
        :param branches: List of utf-8 branch names to write
848
 
        """
849
 
        self.transport.put_bytes(
850
 
            'branch-list',
851
 
            b"".join([name.encode('utf-8') + b"\n" for name in branches]))
852
 
 
853
 
    def __init__(self, _transport, _format):
854
 
        super(BzrDirMeta1, self).__init__(_transport, _format)
855
 
        self.control_files = lockable_files.LockableFiles(
856
 
            self.control_transport, self._format._lock_file_name,
857
 
            self._format._lock_class)
858
 
 
859
1699
    def can_convert_format(self):
860
1700
        """See BzrDir.can_convert_format()."""
861
1701
        return True
862
1702
 
863
 
    def create_branch(self, name=None, repository=None,
864
 
                      append_revisions_only=None):
865
 
        """See ControlDir.create_branch."""
866
 
        if name is None:
867
 
            name = self._get_selected_branch()
868
 
        return self._format.get_branch_format().initialize(
869
 
            self, name=name, repository=repository,
870
 
            append_revisions_only=append_revisions_only)
 
1703
    def create_branch(self, name=None):
 
1704
        """See BzrDir.create_branch."""
 
1705
        return self._format.get_branch_format().initialize(self, name=name)
871
1706
 
872
1707
    def destroy_branch(self, name=None):
873
 
        """See ControlDir.destroy_branch."""
874
 
        if name is None:
875
 
            name = self._get_selected_branch()
876
 
        path = self._get_branch_path(name)
877
 
        if name != u"":
878
 
            self.control_files.lock_write()
879
 
            try:
880
 
                branches = self._read_branch_list()
881
 
                try:
882
 
                    branches.remove(name)
883
 
                except ValueError:
884
 
                    raise errors.NotBranchError(name)
885
 
                self._write_branch_list(branches)
886
 
            finally:
887
 
                self.control_files.unlock()
888
 
        try:
889
 
            self.transport.delete_tree(path)
890
 
        except errors.NoSuchFile:
891
 
            raise errors.NotBranchError(
892
 
                path=urlutils.join(self.transport.base, path), controldir=self)
 
1708
        """See BzrDir.create_branch."""
 
1709
        if name is not None:
 
1710
            raise errors.NoColocatedBranchSupport(self)
 
1711
        self.transport.delete_tree('branch')
893
1712
 
894
1713
    def create_repository(self, shared=False):
895
1714
        """See BzrDir.create_repository."""
897
1716
 
898
1717
    def destroy_repository(self):
899
1718
        """See BzrDir.destroy_repository."""
900
 
        try:
901
 
            self.transport.delete_tree('repository')
902
 
        except errors.NoSuchFile:
903
 
            raise errors.NoRepositoryPresent(self)
 
1719
        self.transport.delete_tree('repository')
904
1720
 
905
1721
    def create_workingtree(self, revision_id=None, from_branch=None,
906
1722
                           accelerator_tree=None, hardlink=False):
914
1730
        wt = self.open_workingtree(recommend_upgrade=False)
915
1731
        repository = wt.branch.repository
916
1732
        empty = repository.revision_tree(_mod_revision.NULL_REVISION)
917
 
        # We ignore the conflicts returned by wt.revert since we're about to
918
 
        # delete the wt metadata anyway, all that should be left here are
919
 
        # detritus. But see bug #634470 about subtree .bzr dirs.
920
1733
        wt.revert(old_tree=empty)
921
1734
        self.destroy_workingtree_metadata()
922
1735
 
923
1736
    def destroy_workingtree_metadata(self):
924
1737
        self.transport.delete_tree('checkout')
925
1738
 
926
 
    def find_branch_format(self, name=None):
 
1739
    def find_branch_format(self):
927
1740
        """Find the branch 'format' for this bzrdir.
928
1741
 
929
1742
        This might be a synthetic object for e.g. RemoteBranch and SVN.
930
1743
        """
931
 
        from .branch import BranchFormatMetadir
932
 
        return BranchFormatMetadir.find_format(self, name=name)
 
1744
        from bzrlib.branch import BranchFormat
 
1745
        return BranchFormat.find_format(self)
933
1746
 
934
1747
    def _get_mkdir_mode(self):
935
1748
        """Figure out the mode to use when creating a bzrdir subdir."""
936
 
        temp_control = lockable_files.LockableFiles(
937
 
            self.transport, '', lockable_files.TransportLock)
 
1749
        temp_control = lockable_files.LockableFiles(self.transport, '',
 
1750
                                     lockable_files.TransportLock)
938
1751
        return temp_control._dir_mode
939
1752
 
940
 
    def get_branch_reference(self, name=None):
 
1753
    def get_branch_reference(self):
941
1754
        """See BzrDir.get_branch_reference()."""
942
 
        from .branch import BranchFormatMetadir
943
 
        format = BranchFormatMetadir.find_format(self, name=name)
944
 
        return format.get_reference(self, name=name)
945
 
 
946
 
    def set_branch_reference(self, target_branch, name=None):
947
 
        format = _mod_bzrbranch.BranchReferenceFormat()
948
 
        if (self.control_url == target_branch.controldir.control_url
949
 
                and name == target_branch.name):
950
 
            raise controldir.BranchReferenceLoop(target_branch)
951
 
        return format.initialize(self, target_branch=target_branch, name=name)
 
1755
        from bzrlib.branch import BranchFormat
 
1756
        format = BranchFormat.find_format(self)
 
1757
        return format.get_reference(self)
952
1758
 
953
1759
    def get_branch_transport(self, branch_format, name=None):
954
1760
        """See BzrDir.get_branch_transport()."""
955
 
        if name is None:
956
 
            name = self._get_selected_branch()
957
 
        path = self._get_branch_path(name)
 
1761
        if name is not None:
 
1762
            raise errors.NoColocatedBranchSupport(self)
958
1763
        # XXX: this shouldn't implicitly create the directory if it's just
959
1764
        # promising to get a transport -- mbp 20090727
960
1765
        if branch_format is None:
961
 
            return self.transport.clone(path)
 
1766
            return self.transport.clone('branch')
962
1767
        try:
963
1768
            branch_format.get_format_string()
964
1769
        except NotImplementedError:
965
1770
            raise errors.IncompatibleFormat(branch_format, self._format)
966
 
        if name != "":
967
 
            branches = self._read_branch_list()
968
 
            if name not in branches:
969
 
                self.control_files.lock_write()
970
 
                try:
971
 
                    branches = self._read_branch_list()
972
 
                    dirname = urlutils.dirname(name)
973
 
                    if dirname != u"" and dirname in branches:
974
 
                        raise errors.ParentBranchExists(name)
975
 
                    child_branches = [
976
 
                        b.startswith(name + u"/") for b in branches]
977
 
                    if any(child_branches):
978
 
                        raise errors.AlreadyBranchError(name)
979
 
                    branches.append(name)
980
 
                    self._write_branch_list(branches)
981
 
                finally:
982
 
                    self.control_files.unlock()
983
 
        branch_transport = self.transport.clone(path)
984
 
        mode = self._get_mkdir_mode()
985
 
        branch_transport.create_prefix(mode=mode)
986
1771
        try:
987
 
            self.transport.mkdir(path, mode=mode)
 
1772
            self.transport.mkdir('branch', mode=self._get_mkdir_mode())
988
1773
        except errors.FileExists:
989
1774
            pass
990
 
        return self.transport.clone(path)
 
1775
        return self.transport.clone('branch')
991
1776
 
992
1777
    def get_repository_transport(self, repository_format):
993
1778
        """See BzrDir.get_repository_transport()."""
1017
1802
            pass
1018
1803
        return self.transport.clone('checkout')
1019
1804
 
1020
 
    def branch_names(self):
1021
 
        """See ControlDir.branch_names."""
1022
 
        ret = []
1023
 
        try:
1024
 
            self.get_branch_reference()
1025
 
        except errors.NotBranchError:
1026
 
            pass
1027
 
        else:
1028
 
            ret.append("")
1029
 
        ret.extend(self._read_branch_list())
1030
 
        return ret
1031
 
 
1032
 
    def get_branches(self):
1033
 
        """See ControlDir.get_branches."""
1034
 
        ret = {}
1035
 
        try:
1036
 
            ret[""] = self.open_branch(name="")
1037
 
        except (errors.NotBranchError, errors.NoRepositoryPresent):
1038
 
            pass
1039
 
 
1040
 
        for name in self._read_branch_list():
1041
 
            ret[name] = self.open_branch(name=name)
1042
 
 
1043
 
        return ret
1044
 
 
1045
1805
    def has_workingtree(self):
1046
1806
        """Tell if this bzrdir contains a working tree.
1047
1807
 
 
1808
        This will still raise an exception if the bzrdir has a workingtree that
 
1809
        is remote & inaccessible.
 
1810
 
1048
1811
        Note: if you're going to open the working tree, you should just go
1049
1812
        ahead and try, and not ask permission first.
1050
1813
        """
1051
 
        from .workingtree import WorkingTreeFormatMetaDir
 
1814
        from bzrlib.workingtree import WorkingTreeFormat
1052
1815
        try:
1053
 
            WorkingTreeFormatMetaDir.find_format_string(self)
 
1816
            WorkingTreeFormat.find_format(self)
1054
1817
        except errors.NoWorkingTree:
1055
1818
            return False
1056
1819
        return True
1057
1820
 
1058
 
    def needs_format_conversion(self, format):
 
1821
    def needs_format_conversion(self, format=None):
1059
1822
        """See BzrDir.needs_format_conversion()."""
1060
 
        if (not isinstance(self._format, format.__class__)
1061
 
                or self._format.get_format_string() != format.get_format_string()):
 
1823
        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
            format = BzrDirFormat.get_default_format()
 
1828
        if not isinstance(self._format, format.__class__):
1062
1829
            # it is not a meta dir format, conversion is needed.
1063
1830
            return True
1064
1831
        # we might want to push this down to the repository?
1085
1852
        return False
1086
1853
 
1087
1854
    def open_branch(self, name=None, unsupported=False,
1088
 
                    ignore_fallbacks=False, possible_transports=None):
1089
 
        """See ControlDir.open_branch."""
1090
 
        if name is None:
1091
 
            name = self._get_selected_branch()
1092
 
        format = self.find_branch_format(name=name)
1093
 
        format.check_support_status(unsupported)
1094
 
        if possible_transports is None:
1095
 
            possible_transports = []
1096
 
        else:
1097
 
            possible_transports = list(possible_transports)
1098
 
        possible_transports.append(self.root_transport)
 
1855
                    ignore_fallbacks=False):
 
1856
        """See BzrDir.open_branch."""
 
1857
        format = self.find_branch_format()
 
1858
        self._check_supported(format, unsupported)
1099
1859
        return format.open(self, name=name,
1100
 
                           _found=True, ignore_fallbacks=ignore_fallbacks,
1101
 
                           possible_transports=possible_transports)
 
1860
            _found=True, ignore_fallbacks=ignore_fallbacks)
1102
1861
 
1103
1862
    def open_repository(self, unsupported=False):
1104
1863
        """See BzrDir.open_repository."""
1105
 
        from .repository import RepositoryFormatMetaDir
1106
 
        format = RepositoryFormatMetaDir.find_format(self)
1107
 
        format.check_support_status(unsupported)
 
1864
        from bzrlib.repository import RepositoryFormat
 
1865
        format = RepositoryFormat.find_format(self)
 
1866
        self._check_supported(format, unsupported)
1108
1867
        return format.open(self, _found=True)
1109
1868
 
1110
1869
    def open_workingtree(self, unsupported=False,
1111
 
                         recommend_upgrade=True):
 
1870
            recommend_upgrade=True):
1112
1871
        """See BzrDir.open_workingtree."""
1113
 
        from .workingtree import WorkingTreeFormatMetaDir
1114
 
        format = WorkingTreeFormatMetaDir.find_format(self)
1115
 
        format.check_support_status(unsupported, recommend_upgrade,
1116
 
                                    basedir=self.root_transport.base)
 
1872
        from bzrlib.workingtree import WorkingTreeFormat
 
1873
        format = WorkingTreeFormat.find_format(self)
 
1874
        self._check_supported(format, unsupported,
 
1875
            recommend_upgrade,
 
1876
            basedir=self.root_transport.base)
1117
1877
        return format.open(self, _found=True)
1118
1878
 
1119
1879
    def _get_config(self):
1120
1880
        return config.TransportConfig(self.transport, 'control.conf')
1121
1881
 
1122
1882
 
1123
 
class BzrFormat(object):
1124
 
    """Base class for all formats of things living in metadirs.
1125
 
 
1126
 
    This class manages the format string that is stored in the 'format'
1127
 
    or 'branch-format' file.
1128
 
 
1129
 
    All classes for (branch-, repository-, workingtree-) formats that
1130
 
    live in meta directories and have their own 'format' file
1131
 
    (i.e. different from .bzr/branch-format) derive from this class,
1132
 
    as well as the relevant base class for their kind
1133
 
    (BranchFormat, WorkingTreeFormat, RepositoryFormat).
1134
 
 
1135
 
    Each format is identified by a "format" or "branch-format" file with a
1136
 
    single line containing the base format name and then an optional list of
1137
 
    feature flags.
1138
 
 
1139
 
    Feature flags are supported as of bzr 2.5. Setting feature flags on formats
1140
 
    will render them inaccessible to older versions of bzr.
1141
 
 
1142
 
    :ivar features: Dictionary mapping feature names to their necessity
1143
 
    """
1144
 
 
1145
 
    _present_features = set()
1146
 
 
1147
 
    def __init__(self):
1148
 
        self.features = {}
1149
 
 
1150
 
    @classmethod
1151
 
    def register_feature(cls, name):
1152
 
        """Register a feature as being present.
1153
 
 
1154
 
        :param name: Name of the feature
1155
 
        """
1156
 
        if b" " in name:
1157
 
            raise ValueError("spaces are not allowed in feature names")
1158
 
        if name in cls._present_features:
1159
 
            raise FeatureAlreadyRegistered(name)
1160
 
        cls._present_features.add(name)
1161
 
 
1162
 
    @classmethod
1163
 
    def unregister_feature(cls, name):
1164
 
        """Unregister a feature."""
1165
 
        cls._present_features.remove(name)
1166
 
 
1167
 
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1168
 
                             basedir=None):
1169
 
        for name, necessity in viewitems(self.features):
1170
 
            if name in self._present_features:
1171
 
                continue
1172
 
            if necessity == b"optional":
1173
 
                mutter("ignoring optional missing feature %s", name)
1174
 
                continue
1175
 
            elif necessity == b"required":
1176
 
                raise MissingFeature(name)
1177
 
            else:
1178
 
                mutter("treating unknown necessity as require for %s",
1179
 
                       name)
1180
 
                raise MissingFeature(name)
1181
 
 
1182
 
    @classmethod
1183
 
    def get_format_string(cls):
1184
 
        """Return the ASCII format string that identifies this format."""
1185
 
        raise NotImplementedError(cls.get_format_string)
1186
 
 
1187
 
    @classmethod
1188
 
    def from_string(cls, text):
1189
 
        format_string = cls.get_format_string()
1190
 
        if not text.startswith(format_string):
1191
 
            raise AssertionError(
1192
 
                "Invalid format header %r for %r" % (text, cls))
1193
 
        lines = text[len(format_string):].splitlines()
1194
 
        ret = cls()
1195
 
        for lineno, line in enumerate(lines):
1196
 
            try:
1197
 
                (necessity, feature) = line.split(b" ", 1)
1198
 
            except ValueError:
1199
 
                raise errors.ParseFormatError(format=cls, lineno=lineno + 2,
1200
 
                                              line=line, text=text)
1201
 
            ret.features[feature] = necessity
1202
 
        return ret
1203
 
 
1204
 
    def as_string(self):
1205
 
        """Return the string representation of this format.
1206
 
        """
1207
 
        lines = [self.get_format_string()]
1208
 
        lines.extend([(item[1] + b" " + item[0] + b"\n")
1209
 
                      for item in sorted(viewitems(self.features))])
1210
 
        return b"".join(lines)
1211
 
 
1212
 
    @classmethod
1213
 
    def _find_format(klass, registry, kind, format_string):
1214
 
        try:
1215
 
            first_line = format_string[:format_string.index(b"\n") + 1]
1216
 
        except ValueError:
1217
 
            first_line = format_string
1218
 
        try:
1219
 
            cls = registry.get(first_line)
1220
 
        except KeyError:
1221
 
            raise errors.UnknownFormatError(format=first_line, kind=kind)
1222
 
        return cls.from_string(format_string)
1223
 
 
1224
 
    def network_name(self):
1225
 
        """A simple byte string uniquely identifying this format for RPC calls.
1226
 
 
1227
 
        Metadir branch formats use their format string.
1228
 
        """
1229
 
        return self.as_string()
1230
 
 
1231
 
    def __eq__(self, other):
1232
 
        return (self.__class__ is other.__class__
1233
 
                and self.features == other.features)
1234
 
 
1235
 
    def _update_feature_flags(self, updated_flags):
1236
 
        """Update the feature flags in this format.
1237
 
 
1238
 
        :param updated_flags: Updated feature flags
1239
 
        """
1240
 
        for name, necessity in updated_flags.items():
1241
 
            if necessity is None:
1242
 
                try:
1243
 
                    del self.features[name]
1244
 
                except KeyError:
1245
 
                    pass
1246
 
            else:
1247
 
                self.features[name] = necessity
1248
 
 
1249
 
 
1250
 
class BzrDirFormat(BzrFormat, controldir.ControlDirFormat):
1251
 
    """ControlDirFormat base class for .bzr/ directories.
 
1883
class BzrDirFormat(object):
 
1884
    """An encapsulation of the initialization and open routines for a format.
 
1885
 
 
1886
    Formats provide three things:
 
1887
     * An initialization routine,
 
1888
     * a format string,
 
1889
     * an open routine.
1252
1890
 
1253
1891
    Formats are placed in a dict by their format string for reference
1254
1892
    during bzrdir opening. These should be subclasses of BzrDirFormat
1257
1895
    Once a format is deprecated, just deprecate the initialize and open
1258
1896
    methods on the format class. Do not deprecate the object, as the
1259
1897
    object will be created every system load.
 
1898
 
 
1899
    :cvar colocated_branches: Whether this formats supports colocated branches.
 
1900
    """
 
1901
 
 
1902
    _default_format = None
 
1903
    """The default format used for new .bzr dirs."""
 
1904
 
 
1905
    _formats = {}
 
1906
    """The known formats."""
 
1907
 
 
1908
    _control_formats = []
 
1909
    """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
 
 
1917
    This is a list of BzrDirFormat objects.
1260
1918
    """
1261
1919
 
1262
1920
    _lock_file_name = 'branch-lock'
1263
1921
 
 
1922
    colocated_branches = False
 
1923
    """Whether co-located branches are supported for this control dir format.
 
1924
    """
 
1925
 
1264
1926
    # _lock_class must be set in subclasses to the lock type, typ.
1265
1927
    # TransportLock or LockDir
1266
1928
 
 
1929
    @classmethod
 
1930
    def find_format(klass, transport, _server_formats=True):
 
1931
        """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:
 
1937
            try:
 
1938
                return format.probe_transport(transport)
 
1939
            except errors.NotBranchError:
 
1940
                # this format does not find a control dir here.
 
1941
                pass
 
1942
        raise errors.NotBranchError(path=transport.base)
 
1943
 
 
1944
    @classmethod
 
1945
    def probe_transport(klass, transport):
 
1946
        """Return the .bzrdir style format present in a directory."""
 
1947
        try:
 
1948
            format_string = transport.get_bytes(".bzr/branch-format")
 
1949
        except errors.NoSuchFile:
 
1950
            raise errors.NotBranchError(path=transport.base)
 
1951
 
 
1952
        try:
 
1953
            return klass._formats[format_string]
 
1954
        except KeyError:
 
1955
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
 
1956
 
 
1957
    @classmethod
 
1958
    def get_default_format(klass):
 
1959
        """Return the current default format."""
 
1960
        return klass._default_format
 
1961
 
 
1962
    def get_format_string(self):
 
1963
        """Return the ASCII format string that identifies this format."""
 
1964
        raise NotImplementedError(self.get_format_string)
 
1965
 
 
1966
    def get_format_description(self):
 
1967
        """Return the short description for this format."""
 
1968
        raise NotImplementedError(self.get_format_description)
 
1969
 
 
1970
    def get_converter(self, format=None):
 
1971
        """Return the converter to use to convert bzrdirs needing converts.
 
1972
 
 
1973
        This returns a bzrlib.bzrdir.Converter object.
 
1974
 
 
1975
        This should return the best upgrader to step this format towards the
 
1976
        current default format. In the case of plugins we can/should provide
 
1977
        some means for them to extend the range of returnable converters.
 
1978
 
 
1979
        :param format: Optional format to override the default format of the
 
1980
                       library.
 
1981
        """
 
1982
        raise NotImplementedError(self.get_converter)
 
1983
 
 
1984
    def initialize(self, url, possible_transports=None):
 
1985
        """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
 
 
1991
        Subclasses should typically override initialize_on_transport
 
1992
        instead of this method.
 
1993
        """
 
1994
        return self.initialize_on_transport(get_transport(url,
 
1995
                                                          possible_transports))
 
1996
 
1267
1997
    def initialize_on_transport(self, transport):
1268
1998
        """Initialize a new bzrdir in the base directory of a Transport."""
1269
1999
        try:
1276
2006
            # Current RPC's only know how to create bzr metadir1 instances, so
1277
2007
            # we still delegate to vfs methods if the requested format is not a
1278
2008
            # metadir1
1279
 
            if not isinstance(self, BzrDirMetaFormat1):
 
2009
            if type(self) != BzrDirMetaFormat1:
1280
2010
                return self._initialize_on_transport_vfs(transport)
1281
 
            from .remote import RemoteBzrDirFormat
1282
2011
            remote_format = RemoteBzrDirFormat()
1283
2012
            self._supply_sub_formats_to(remote_format)
1284
2013
            return remote_format.initialize_on_transport(transport)
1285
2014
 
1286
2015
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1287
 
                                   create_prefix=False, force_new_repo=False, stacked_on=None,
1288
 
                                   stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
1289
 
                                   shared_repo=False, vfs_only=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):
1290
2019
        """Create this format on transport.
1291
2020
 
1292
2021
        The directory to initialize will be created.
1310
2039
        :param shared_repo: Control whether made repositories are shared or
1311
2040
            not.
1312
2041
        :param vfs_only: If True do not attempt to use a smart server
1313
 
        :return: repo, controldir, require_stacking, repository_policy. repo is
 
2042
        :return: repo, bzrdir, require_stacking, repository_policy. repo is
1314
2043
            None if none was created or found, bzrdir is always valid.
1315
2044
            require_stacking is the result of examining the stacked_on
1316
2045
            parameter and any stacking policy found for the target.
1317
2046
        """
1318
2047
        if not vfs_only:
1319
 
            # Try to hand off to a smart server
 
2048
            # Try to hand off to a smart server 
1320
2049
            try:
1321
2050
                client_medium = transport.get_smart_medium()
1322
2051
            except errors.NoSmartMedium:
1323
2052
                pass
1324
2053
            else:
1325
 
                from .remote import RemoteBzrDirFormat
1326
2054
                # TODO: lookup the local format from a server hint.
1327
2055
                remote_dir_format = RemoteBzrDirFormat()
1328
2056
                remote_dir_format._network_name = self.network_name()
1329
2057
                self._supply_sub_formats_to(remote_dir_format)
1330
 
                return remote_dir_format.initialize_on_transport_ex(
1331
 
                    transport, use_existing_dir=use_existing_dir,
1332
 
                    create_prefix=create_prefix, force_new_repo=force_new_repo,
1333
 
                    stacked_on=stacked_on, stack_on_pwd=stack_on_pwd,
1334
 
                    repo_format_name=repo_format_name,
1335
 
                    make_working_trees=make_working_trees,
1336
 
                    shared_repo=shared_repo)
 
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)
1337
2063
        # XXX: Refactor the create_prefix/no_create_prefix code into a
1338
2064
        #      common helper function
1339
2065
        # The destination may not exist - if so make it according to policy.
1340
 
 
1341
2066
        def make_directory(transport):
1342
2067
            transport.mkdir('.')
1343
2068
            return transport
1344
 
 
1345
2069
        def redirected(transport, e, redirection_notice):
1346
2070
            note(redirection_notice)
1347
2071
            return transport._redirected_to(e.source, e.target)
1348
2072
        try:
1349
2073
            transport = do_catching_redirections(make_directory, transport,
1350
 
                                                 redirected)
 
2074
                redirected)
1351
2075
        except errors.FileExists:
1352
2076
            if not use_existing_dir:
1353
2077
                raise
1394
2118
        # Since we are creating a .bzr directory, inherit the
1395
2119
        # mode from the root directory
1396
2120
        temp_control = lockable_files.LockableFiles(transport,
1397
 
                                                    '', lockable_files.TransportLock)
1398
 
        try:
1399
 
            temp_control._transport.mkdir('.bzr',
1400
 
                                          # FIXME: RBC 20060121 don't peek under
1401
 
                                          # the covers
1402
 
                                          mode=temp_control._dir_mode)
1403
 
        except errors.FileExists:
1404
 
            raise errors.AlreadyControlDirError(transport.base)
 
2121
                            '', lockable_files.TransportLock)
 
2122
        temp_control._transport.mkdir('.bzr',
 
2123
                                      # FIXME: RBC 20060121 don't peek under
 
2124
                                      # the covers
 
2125
                                      mode=temp_control._dir_mode)
1405
2126
        if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
1406
2127
            win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1407
2128
        file_mode = temp_control._file_mode
1408
2129
        del temp_control
1409
2130
        bzrdir_transport = transport.clone('.bzr')
1410
2131
        utf8_files = [('README',
1411
 
                       b"This is a Bazaar control directory.\n"
1412
 
                       b"Do not change any files in this directory.\n"
1413
 
                       b"See http://bazaar.canonical.com/ for more information about Bazaar.\n"),
1414
 
                      ('branch-format', self.as_string()),
 
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"),
 
2135
                      ('branch-format', self.get_format_string()),
1415
2136
                      ]
1416
2137
        # NB: no need to escape relative paths that are url safe.
1417
2138
        control_files = lockable_files.LockableFiles(bzrdir_transport,
1418
 
                                                     self._lock_file_name, self._lock_class)
 
2139
            self._lock_file_name, self._lock_class)
1419
2140
        control_files.create_lock()
1420
2141
        control_files.lock_write()
1421
2142
        try:
1422
2143
            for (filename, content) in utf8_files:
1423
2144
                bzrdir_transport.put_bytes(filename, content,
1424
 
                                           mode=file_mode)
 
2145
                    mode=file_mode)
1425
2146
        finally:
1426
2147
            control_files.unlock()
1427
2148
        return self.open(transport, _found=True)
1428
2149
 
 
2150
    def is_supported(self):
 
2151
        """Is this format supported?
 
2152
 
 
2153
        Supported formats must be initializable and openable.
 
2154
        Unsupported formats may not support initialization or committing or
 
2155
        some other features depending on the reason for not being supported.
 
2156
        """
 
2157
        return True
 
2158
 
 
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
    def same_model(self, target_format):
 
2170
        return (self.repository_format.rich_root_data ==
 
2171
            target_format.rich_root_data)
 
2172
 
 
2173
    @classmethod
 
2174
    def known_formats(klass):
 
2175
        """Return all the known formats.
 
2176
 
 
2177
        Concrete formats should override _known_formats.
 
2178
        """
 
2179
        # There is double indirection here to make sure that control
 
2180
        # formats used by more than one dir format will only be probed
 
2181
        # once. This can otherwise be quite expensive for remote connections.
 
2182
        result = set()
 
2183
        for format in klass._control_formats:
 
2184
            result.update(format._known_formats())
 
2185
        return result
 
2186
 
 
2187
    @classmethod
 
2188
    def _known_formats(klass):
 
2189
        """Return the known format instances for this control format."""
 
2190
        return set(klass._formats.values())
 
2191
 
1429
2192
    def open(self, transport, _found=False):
1430
2193
        """Return an instance of this format for the dir transport points at.
1431
2194
 
1432
2195
        _found is a private parameter, do not use it.
1433
2196
        """
1434
2197
        if not _found:
1435
 
            found_format = controldir.ControlDirFormat.find_format(transport)
 
2198
            found_format = BzrDirFormat.find_format(transport)
1436
2199
            if not isinstance(found_format, self.__class__):
1437
2200
                raise AssertionError("%s was asked to open %s, but it seems to need "
1438
 
                                     "format %s"
1439
 
                                     % (self, transport, found_format))
 
2201
                        "format %s"
 
2202
                        % (self, transport, found_format))
1440
2203
            # Allow subclasses - use the found format.
1441
2204
            self._supply_sub_formats_to(found_format)
1442
2205
            return found_format._open(transport)
1450
2213
        """
1451
2214
        raise NotImplementedError(self._open)
1452
2215
 
 
2216
    @classmethod
 
2217
    def register_format(klass, format):
 
2218
        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
 
 
2222
    @classmethod
 
2223
    def register_control_format(klass, format):
 
2224
        """Register a format that does not use '.bzr' for its control dir.
 
2225
 
 
2226
        TODO: This should be pulled up into a 'ControlDirFormat' base class
 
2227
        which BzrDirFormat can inherit from, and renamed to register_format
 
2228
        there. It has been done without that for now for simplicity of
 
2229
        implementation.
 
2230
        """
 
2231
        klass._control_formats.append(format)
 
2232
 
 
2233
    @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)
 
2243
 
 
2244
    @classmethod
 
2245
    def _set_default_format(klass, format):
 
2246
        """Set default format (for testing behavior of defaults only)"""
 
2247
        klass._default_format = format
 
2248
 
 
2249
    def __str__(self):
 
2250
        # Trim the newline
 
2251
        return self.get_format_description().rstrip()
 
2252
 
1453
2253
    def _supply_sub_formats_to(self, other_format):
1454
2254
        """Give other_format the same values for sub formats as this has.
1455
2255
 
1461
2261
            compatible with whatever sub formats are supported by self.
1462
2262
        :return: None.
1463
2263
        """
1464
 
        other_format.features = dict(self.features)
1465
 
 
1466
 
    def supports_transport(self, transport):
1467
 
        # bzr formats can be opened over all known transports
1468
 
        return True
1469
 
 
1470
 
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1471
 
                             basedir=None):
1472
 
        controldir.ControlDirFormat.check_support_status(self,
1473
 
                                                         allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
1474
 
                                                         basedir=basedir)
1475
 
        BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
1476
 
                                       recommend_upgrade=recommend_upgrade, basedir=basedir)
1477
 
 
1478
 
    @classmethod
1479
 
    def is_control_filename(klass, filename):
1480
 
        """True if filename is the name of a path which is reserved for bzrdir's.
1481
 
 
1482
 
        :param filename: A filename within the root transport of this bzrdir.
1483
 
 
1484
 
        This is true IF and ONLY IF the filename is part of the namespace
1485
 
        reserved for bzr control dirs. Currently this is the '.bzr' directory
1486
 
        in the root of the root_transport.
1487
 
        """
1488
 
        # this might be better on the BzrDirFormat class because it refers to
1489
 
        # all the possible bzrdir disk formats.
1490
 
        # This method is tested via the workingtree is_control_filename tests-
1491
 
        # it was extracted from WorkingTree.is_control_filename. If the
1492
 
        # method's contract is extended beyond the current trivial
1493
 
        # implementation, please add new tests for it to the appropriate place.
1494
 
        return filename == '.bzr' or filename.startswith('.bzr/')
 
2264
 
 
2265
    @classmethod
 
2266
    def unregister_format(klass, format):
 
2267
        del klass._formats[format.get_format_string()]
 
2268
 
 
2269
    @classmethod
 
2270
    def unregister_control_format(klass, format):
 
2271
        klass._control_formats.remove(format)
 
2272
 
 
2273
 
 
2274
class BzrDirFormat4(BzrDirFormat):
 
2275
    """Bzr dir format 4.
 
2276
 
 
2277
    This format is a combined format for working tree, branch and repository.
 
2278
    It has:
 
2279
     - Format 1 working trees [always]
 
2280
     - Format 4 branches [always]
 
2281
     - Format 4 repositories [always]
 
2282
 
 
2283
    This format is deprecated: it indexes texts using a text it which is
 
2284
    removed in format 5; write support for this format has been removed.
 
2285
    """
 
2286
 
 
2287
    _lock_class = lockable_files.TransportLock
 
2288
 
 
2289
    def get_format_string(self):
 
2290
        """See BzrDirFormat.get_format_string()."""
 
2291
        return "Bazaar-NG branch, format 0.0.4\n"
 
2292
 
 
2293
    def get_format_description(self):
 
2294
        """See BzrDirFormat.get_format_description()."""
 
2295
        return "All-in-one format 4"
 
2296
 
 
2297
    def get_converter(self, format=None):
 
2298
        """See BzrDirFormat.get_converter()."""
 
2299
        # there is one and only one upgrade path here.
 
2300
        return ConvertBzrDir4To5()
 
2301
 
 
2302
    def initialize_on_transport(self, transport):
 
2303
        """Format 4 branches cannot be created."""
 
2304
        raise errors.UninitializableFormat(self)
 
2305
 
 
2306
    def is_supported(self):
 
2307
        """Format 4 is not supported.
 
2308
 
 
2309
        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
 
2311
        feasible.
 
2312
        """
 
2313
        return False
 
2314
 
 
2315
    def network_name(self):
 
2316
        return self.get_format_string()
 
2317
 
 
2318
    def _open(self, transport):
 
2319
        """See BzrDirFormat._open."""
 
2320
        return BzrDir4(transport, self)
 
2321
 
 
2322
    def __return_repository_format(self):
 
2323
        """Circular import protection."""
 
2324
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
2325
        return RepositoryFormat4()
 
2326
    repository_format = property(__return_repository_format)
 
2327
 
 
2328
 
 
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):
 
2355
    """Bzr control format 5.
 
2356
 
 
2357
    This format is a combined format for working tree, branch and repository.
 
2358
    It has:
 
2359
     - Format 2 working trees [always]
 
2360
     - Format 4 branches [always]
 
2361
     - Format 5 repositories [always]
 
2362
       Unhashed stores in the repository.
 
2363
    """
 
2364
 
 
2365
    _lock_class = lockable_files.TransportLock
 
2366
 
 
2367
    def get_format_string(self):
 
2368
        """See BzrDirFormat.get_format_string()."""
 
2369
        return "Bazaar-NG branch, format 5\n"
 
2370
 
 
2371
    def get_branch_format(self):
 
2372
        from bzrlib import branch
 
2373
        return branch.BzrBranchFormat4()
 
2374
 
 
2375
    def get_format_description(self):
 
2376
        """See BzrDirFormat.get_format_description()."""
 
2377
        return "All-in-one format 5"
 
2378
 
 
2379
    def get_converter(self, format=None):
 
2380
        """See BzrDirFormat.get_converter()."""
 
2381
        # there is one and only one upgrade path here.
 
2382
        return ConvertBzrDir5To6()
 
2383
 
 
2384
    def _initialize_for_clone(self, url):
 
2385
        return self.initialize_on_transport(get_transport(url), _cloning=True)
 
2386
 
 
2387
    def initialize_on_transport(self, transport, _cloning=False):
 
2388
        """Format 5 dirs always have working tree, branch and repository.
 
2389
 
 
2390
        Except when they are being cloned.
 
2391
        """
 
2392
        from bzrlib.branch import BzrBranchFormat4
 
2393
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
2394
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
 
2395
        RepositoryFormat5().initialize(result, _internal=True)
 
2396
        if not _cloning:
 
2397
            branch = BzrBranchFormat4().initialize(result)
 
2398
            result._init_workingtree()
 
2399
        return result
 
2400
 
 
2401
    def network_name(self):
 
2402
        return self.get_format_string()
 
2403
 
 
2404
    def _open(self, transport):
 
2405
        """See BzrDirFormat._open."""
 
2406
        return BzrDir5(transport, self)
 
2407
 
 
2408
    def __return_repository_format(self):
 
2409
        """Circular import protection."""
 
2410
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
2411
        return RepositoryFormat5()
 
2412
    repository_format = property(__return_repository_format)
 
2413
 
 
2414
 
 
2415
class BzrDirFormat6(BzrDirFormatAllInOne):
 
2416
    """Bzr control format 6.
 
2417
 
 
2418
    This format is a combined format for working tree, branch and repository.
 
2419
    It has:
 
2420
     - Format 2 working trees [always]
 
2421
     - Format 4 branches [always]
 
2422
     - Format 6 repositories [always]
 
2423
    """
 
2424
 
 
2425
    _lock_class = lockable_files.TransportLock
 
2426
 
 
2427
    def get_format_string(self):
 
2428
        """See BzrDirFormat.get_format_string()."""
 
2429
        return "Bazaar-NG branch, format 6\n"
 
2430
 
 
2431
    def get_format_description(self):
 
2432
        """See BzrDirFormat.get_format_description()."""
 
2433
        return "All-in-one format 6"
 
2434
 
 
2435
    def get_branch_format(self):
 
2436
        from bzrlib import branch
 
2437
        return branch.BzrBranchFormat4()
 
2438
 
 
2439
    def get_converter(self, format=None):
 
2440
        """See BzrDirFormat.get_converter()."""
 
2441
        # there is one and only one upgrade path here.
 
2442
        return ConvertBzrDir6ToMeta()
 
2443
 
 
2444
    def _initialize_for_clone(self, url):
 
2445
        return self.initialize_on_transport(get_transport(url), _cloning=True)
 
2446
 
 
2447
    def initialize_on_transport(self, transport, _cloning=False):
 
2448
        """Format 6 dirs always have working tree, branch and repository.
 
2449
 
 
2450
        Except when they are being cloned.
 
2451
        """
 
2452
        from bzrlib.branch import BzrBranchFormat4
 
2453
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
2454
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
 
2455
        RepositoryFormat6().initialize(result, _internal=True)
 
2456
        if not _cloning:
 
2457
            branch = BzrBranchFormat4().initialize(result)
 
2458
            result._init_workingtree()
 
2459
        return result
 
2460
 
 
2461
    def network_name(self):
 
2462
        return self.get_format_string()
 
2463
 
 
2464
    def _open(self, transport):
 
2465
        """See BzrDirFormat._open."""
 
2466
        return BzrDir6(transport, self)
 
2467
 
 
2468
    def __return_repository_format(self):
 
2469
        """Circular import protection."""
 
2470
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
2471
        return RepositoryFormat6()
 
2472
    repository_format = property(__return_repository_format)
1495
2473
 
1496
2474
 
1497
2475
class BzrDirMetaFormat1(BzrDirFormat):
1499
2477
 
1500
2478
    This is the first format with split out working tree, branch and repository
1501
2479
    disk storage.
1502
 
 
1503
2480
    It has:
1504
 
 
1505
 
    - Format 3 working trees [optional]
1506
 
    - Format 5 branches [optional]
1507
 
    - Format 7 repositories [optional]
 
2481
     - Format 3 working trees [optional]
 
2482
     - Format 5 branches [optional]
 
2483
     - Format 7 repositories [optional]
1508
2484
    """
1509
2485
 
1510
2486
    _lock_class = lockdir.LockDir
1511
2487
 
1512
 
    fixed_components = False
1513
 
 
1514
 
    colocated_branches = True
1515
 
 
1516
2488
    def __init__(self):
1517
 
        BzrDirFormat.__init__(self)
1518
2489
        self._workingtree_format = None
1519
2490
        self._branch_format = None
1520
2491
        self._repository_format = None
1526
2497
            return False
1527
2498
        if other.workingtree_format != self.workingtree_format:
1528
2499
            return False
1529
 
        if other.features != self.features:
1530
 
            return False
1531
2500
        return True
1532
2501
 
1533
2502
    def __ne__(self, other):
1535
2504
 
1536
2505
    def get_branch_format(self):
1537
2506
        if self._branch_format is None:
1538
 
            from .branch import format_registry as branch_format_registry
1539
 
            self._branch_format = branch_format_registry.get_default()
 
2507
            from bzrlib.branch import BranchFormat
 
2508
            self._branch_format = BranchFormat.get_default_format()
1540
2509
        return self._branch_format
1541
2510
 
1542
2511
    def set_branch_format(self, format):
1543
2512
        self._branch_format = format
1544
2513
 
1545
2514
    def require_stacking(self, stack_on=None, possible_transports=None,
1546
 
                         _skip_repo=False):
 
2515
            _skip_repo=False):
1547
2516
        """We have a request to stack, try to ensure the formats support it.
1548
2517
 
1549
2518
        :param stack_on: If supplied, it is the URL to a branch that we want to
1558
2527
 
1559
2528
        # a bit of state for get_target_branch so that we don't try to open it
1560
2529
        # 2 times, for both repo *and* branch
1561
 
        target = [None, False, None]  # target_branch, checked, upgrade anyway
1562
 
 
 
2530
        target = [None, False, None] # target_branch, checked, upgrade anyway
1563
2531
        def get_target_branch():
1564
2532
            if target[1]:
1565
2533
                # We've checked, don't check again
1570
2538
                return target
1571
2539
            try:
1572
2540
                target_dir = BzrDir.open(stack_on,
1573
 
                                         possible_transports=possible_transports)
 
2541
                    possible_transports=possible_transports)
1574
2542
            except errors.NotBranchError:
1575
2543
                # Nothing there, don't change formats
1576
2544
                target[:] = [None, True, False]
1588
2556
            target[:] = [target_branch, True, False]
1589
2557
            return target
1590
2558
 
1591
 
        if (not _skip_repo
1592
 
                and not self.repository_format.supports_external_lookups):
 
2559
        if (not _skip_repo and
 
2560
                 not self.repository_format.supports_external_lookups):
1593
2561
            # We need to upgrade the Repository.
1594
2562
            target_branch, _, do_upgrade = get_target_branch()
1595
2563
            if target_branch is None:
1598
2566
                    # stack_on is inaccessible, JFDI.
1599
2567
                    # TODO: bad monkey, hard-coded formats...
1600
2568
                    if self.repository_format.rich_root_data:
1601
 
                        new_repo_format = knitpack_repo.RepositoryFormatKnitPack5RichRoot()
 
2569
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
1602
2570
                    else:
1603
 
                        new_repo_format = knitpack_repo.RepositoryFormatKnitPack5()
 
2571
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5()
1604
2572
            else:
1605
2573
                # If the target already supports stacking, then we know the
1606
2574
                # project is already able to use stacking, so auto-upgrade
1612
2580
                    new_repo_format = None
1613
2581
            if new_repo_format is not None:
1614
2582
                self.repository_format = new_repo_format
1615
 
                note(gettext('Source repository format does not support stacking,'
1616
 
                             ' using format:\n  %s'),
 
2583
                note('Source repository format does not support stacking,'
 
2584
                     ' using format:\n  %s',
1617
2585
                     new_repo_format.get_format_description())
1618
2586
 
1619
2587
        if not self.get_branch_format().supports_stacking():
1623
2591
            if target_branch is None:
1624
2592
                if do_upgrade:
1625
2593
                    # TODO: bad monkey, hard-coded formats...
1626
 
                    from .branch import BzrBranchFormat7
1627
 
                    new_branch_format = BzrBranchFormat7()
 
2594
                    new_branch_format = branch.BzrBranchFormat7()
1628
2595
            else:
1629
2596
                new_branch_format = target_branch._format
1630
2597
                if not new_branch_format.supports_stacking():
1632
2599
            if new_branch_format is not None:
1633
2600
                # Does support stacking, use its format.
1634
2601
                self.set_branch_format(new_branch_format)
1635
 
                note(gettext('Source branch format does not support stacking,'
1636
 
                             ' using format:\n  %s'),
 
2602
                note('Source branch format does not support stacking,'
 
2603
                     ' using format:\n  %s',
1637
2604
                     new_branch_format.get_format_description())
1638
2605
 
1639
2606
    def get_converter(self, format=None):
1640
2607
        """See BzrDirFormat.get_converter()."""
1641
2608
        if format is None:
1642
2609
            format = BzrDirFormat.get_default_format()
1643
 
        if (isinstance(self, BzrDirMetaFormat1)
1644
 
                and isinstance(format, BzrDirMetaFormat1Colo)):
1645
 
            return ConvertMetaToColo(format)
1646
 
        if (isinstance(self, BzrDirMetaFormat1Colo)
1647
 
                and isinstance(format, BzrDirMetaFormat1)):
1648
 
            return ConvertMetaToColo(format)
1649
2610
        if not isinstance(self, format.__class__):
1650
2611
            # converting away from metadir is not implemented
1651
2612
            raise NotImplementedError(self.get_converter)
1652
2613
        return ConvertMetaToMeta(format)
1653
2614
 
1654
 
    @classmethod
1655
 
    def get_format_string(cls):
 
2615
    def get_format_string(self):
1656
2616
        """See BzrDirFormat.get_format_string()."""
1657
 
        return b"Bazaar-NG meta directory, format 1\n"
 
2617
        return "Bazaar-NG meta directory, format 1\n"
1658
2618
 
1659
2619
    def get_format_description(self):
1660
2620
        """See BzrDirFormat.get_format_description()."""
1661
2621
        return "Meta directory format 1"
1662
2622
 
 
2623
    def network_name(self):
 
2624
        return self.get_format_string()
 
2625
 
1663
2626
    def _open(self, transport):
1664
2627
        """See BzrDirFormat._open."""
1665
2628
        # Create a new format instance because otherwise initialisation of new
1673
2636
        """Circular import protection."""
1674
2637
        if self._repository_format:
1675
2638
            return self._repository_format
1676
 
        from .repository import format_registry
1677
 
        return format_registry.get_default()
 
2639
        from bzrlib.repository import RepositoryFormat
 
2640
        return RepositoryFormat.get_default_format()
1678
2641
 
1679
2642
    def _set_repository_format(self, value):
1680
2643
        """Allow changing the repository format for metadir formats."""
1681
2644
        self._repository_format = value
1682
2645
 
1683
2646
    repository_format = property(__return_repository_format,
1684
 
                                 _set_repository_format)
 
2647
        _set_repository_format)
1685
2648
 
1686
2649
    def _supply_sub_formats_to(self, other_format):
1687
2650
        """Give other_format the same values for sub formats as this has.
1694
2657
            compatible with whatever sub formats are supported by self.
1695
2658
        :return: None.
1696
2659
        """
1697
 
        super(BzrDirMetaFormat1, self)._supply_sub_formats_to(other_format)
1698
2660
        if getattr(self, '_repository_format', None) is not None:
1699
2661
            other_format.repository_format = self.repository_format
1700
2662
        if self._branch_format is not None:
1704
2666
 
1705
2667
    def __get_workingtree_format(self):
1706
2668
        if self._workingtree_format is None:
1707
 
            from .workingtree import (
1708
 
                format_registry as wt_format_registry,
1709
 
                )
1710
 
            self._workingtree_format = wt_format_registry.get_default()
 
2669
            from bzrlib.workingtree import WorkingTreeFormat
 
2670
            self._workingtree_format = WorkingTreeFormat.get_default_format()
1711
2671
        return self._workingtree_format
1712
2672
 
1713
2673
    def __set_workingtree_format(self, wt_format):
1714
2674
        self._workingtree_format = wt_format
1715
2675
 
1716
 
    def __repr__(self):
1717
 
        return "<%r>" % (self.__class__.__name__,)
1718
 
 
1719
2676
    workingtree_format = property(__get_workingtree_format,
1720
2677
                                  __set_workingtree_format)
1721
2678
 
1722
2679
 
1723
 
class BzrDirMetaFormat1Colo(BzrDirMetaFormat1):
1724
 
    """BzrDirMeta1 format with support for colocated branches."""
1725
 
 
1726
 
    colocated_branches = True
1727
 
 
1728
 
    @classmethod
1729
 
    def get_format_string(cls):
1730
 
        """See BzrDirFormat.get_format_string()."""
1731
 
        return b"Bazaar meta directory, format 1 (with colocated branches)\n"
1732
 
 
1733
 
    def get_format_description(self):
1734
 
        """See BzrDirFormat.get_format_description()."""
1735
 
        return "Meta directory format 1 with support for colocated branches"
1736
 
 
1737
 
    def _open(self, transport):
1738
 
        """See BzrDirFormat._open."""
1739
 
        # Create a new format instance because otherwise initialisation of new
1740
 
        # metadirs share the global default format object leading to alias
1741
 
        # problems.
1742
 
        format = BzrDirMetaFormat1Colo()
1743
 
        self._supply_sub_formats_to(format)
1744
 
        return BzrDirMeta1(transport, format)
1745
 
 
1746
 
 
1747
 
class ConvertMetaToMeta(controldir.Converter):
 
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
 
2693
BzrDirFormat.register_format(BzrDirFormat4())
 
2694
BzrDirFormat.register_format(BzrDirFormat5())
 
2695
BzrDirFormat.register_format(BzrDirFormat6())
 
2696
__default_format = BzrDirMetaFormat1()
 
2697
BzrDirFormat.register_format(__default_format)
 
2698
BzrDirFormat._default_format = __default_format
 
2699
 
 
2700
 
 
2701
class Converter(object):
 
2702
    """Converts a disk format object from one format to another."""
 
2703
 
 
2704
    def convert(self, to_convert, pb):
 
2705
        """Perform the conversion of to_convert, giving feedback via pb.
 
2706
 
 
2707
        :param to_convert: The disk object to convert.
 
2708
        :param pb: a progress bar to use for progress information.
 
2709
        """
 
2710
 
 
2711
    def step(self, message):
 
2712
        """Update the pb by a step."""
 
2713
        self.count +=1
 
2714
        self.pb.update(message, self.count, self.total)
 
2715
 
 
2716
 
 
2717
class ConvertBzrDir4To5(Converter):
 
2718
    """Converts format 4 bzr dirs to format 5."""
 
2719
 
 
2720
    def __init__(self):
 
2721
        super(ConvertBzrDir4To5, self).__init__()
 
2722
        self.converted_revs = set()
 
2723
        self.absent_revisions = set()
 
2724
        self.text_count = 0
 
2725
        self.revisions = {}
 
2726
 
 
2727
    def convert(self, to_convert, pb):
 
2728
        """See Converter.convert()."""
 
2729
        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()
 
2741
 
 
2742
    def _convert_to_weaves(self):
 
2743
        ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
 
2744
        try:
 
2745
            # TODO permissions
 
2746
            stat = self.bzrdir.transport.stat('weaves')
 
2747
            if not S_ISDIR(stat.st_mode):
 
2748
                self.bzrdir.transport.delete('weaves')
 
2749
                self.bzrdir.transport.mkdir('weaves')
 
2750
        except errors.NoSuchFile:
 
2751
            self.bzrdir.transport.mkdir('weaves')
 
2752
        # deliberately not a WeaveFile as we want to build it up slowly.
 
2753
        self.inv_weave = Weave('inventory')
 
2754
        # holds in-memory weaves for all files
 
2755
        self.text_weaves = {}
 
2756
        self.bzrdir.transport.delete('branch-format')
 
2757
        self.branch = self.bzrdir.open_branch()
 
2758
        self._convert_working_inv()
 
2759
        rev_history = self.branch.revision_history()
 
2760
        # to_read is a stack holding the revisions we still need to process;
 
2761
        # appending to it adds new highest-priority revisions
 
2762
        self.known_revisions = set(rev_history)
 
2763
        self.to_read = rev_history[-1:]
 
2764
        while self.to_read:
 
2765
            rev_id = self.to_read.pop()
 
2766
            if (rev_id not in self.revisions
 
2767
                and rev_id not in self.absent_revisions):
 
2768
                self._load_one_rev(rev_id)
 
2769
        self.pb.clear()
 
2770
        to_import = self._make_order()
 
2771
        for i, rev_id in enumerate(to_import):
 
2772
            self.pb.update('converting revision', i, len(to_import))
 
2773
            self._convert_one_rev(rev_id)
 
2774
        self.pb.clear()
 
2775
        self._write_all_weaves()
 
2776
        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)
 
2781
        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())
 
2786
 
 
2787
    def _cleanup_spare_files_after_format4(self):
 
2788
        # FIXME working tree upgrade foo.
 
2789
        for n in 'merged-patches', 'pending-merged-patches':
 
2790
            try:
 
2791
                ## assert os.path.getsize(p) == 0
 
2792
                self.bzrdir.transport.delete(n)
 
2793
            except errors.NoSuchFile:
 
2794
                pass
 
2795
        self.bzrdir.transport.delete_tree('inventory-store')
 
2796
        self.bzrdir.transport.delete_tree('text-store')
 
2797
 
 
2798
    def _convert_working_inv(self):
 
2799
        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())
 
2804
 
 
2805
    def _write_all_weaves(self):
 
2806
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
 
2807
        weave_transport = self.bzrdir.transport.clone('weaves')
 
2808
        weaves = WeaveStore(weave_transport, prefixed=False)
 
2809
        transaction = WriteTransaction()
 
2810
 
 
2811
        try:
 
2812
            i = 0
 
2813
            for file_id, file_weave in self.text_weaves.items():
 
2814
                self.pb.update('writing weave', i, len(self.text_weaves))
 
2815
                weaves._put_weave(file_id, file_weave, transaction)
 
2816
                i += 1
 
2817
            self.pb.update('inventory', 0, 1)
 
2818
            controlweaves._put_weave('inventory', self.inv_weave, transaction)
 
2819
            self.pb.update('inventory', 1, 1)
 
2820
        finally:
 
2821
            self.pb.clear()
 
2822
 
 
2823
    def _write_all_revs(self):
 
2824
        """Write all revisions out in new form."""
 
2825
        self.bzrdir.transport.delete_tree('revision-store')
 
2826
        self.bzrdir.transport.mkdir('revision-store')
 
2827
        revision_transport = self.bzrdir.transport.clone('revision-store')
 
2828
        # 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)
 
2834
        try:
 
2835
            for i, rev_id in enumerate(self.converted_revs):
 
2836
                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))
 
2841
        finally:
 
2842
            self.pb.clear()
 
2843
 
 
2844
    def _load_one_rev(self, rev_id):
 
2845
        """Load a revision object into memory.
 
2846
 
 
2847
        Any parents not either loaded or abandoned get queued to be
 
2848
        loaded."""
 
2849
        self.pb.update('loading revision',
 
2850
                       len(self.revisions),
 
2851
                       len(self.known_revisions))
 
2852
        if not self.branch.repository.has_revision(rev_id):
 
2853
            self.pb.clear()
 
2854
            ui.ui_factory.note('revision {%s} not present in branch; '
 
2855
                         'will be converted as a ghost' %
 
2856
                         rev_id)
 
2857
            self.absent_revisions.add(rev_id)
 
2858
        else:
 
2859
            rev = self.branch.repository.get_revision(rev_id)
 
2860
            for parent_id in rev.parent_ids:
 
2861
                self.known_revisions.add(parent_id)
 
2862
                self.to_read.append(parent_id)
 
2863
            self.revisions[rev_id] = rev
 
2864
 
 
2865
    def _load_old_inventory(self, rev_id):
 
2866
        old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
 
2867
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
 
2868
        inv.revision_id = rev_id
 
2869
        rev = self.revisions[rev_id]
 
2870
        return inv
 
2871
 
 
2872
    def _load_updated_inventory(self, rev_id):
 
2873
        inv_xml = self.inv_weave.get_text(rev_id)
 
2874
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
 
2875
        return inv
 
2876
 
 
2877
    def _convert_one_rev(self, rev_id):
 
2878
        """Convert revision and all referenced objects to new format."""
 
2879
        rev = self.revisions[rev_id]
 
2880
        inv = self._load_old_inventory(rev_id)
 
2881
        present_parents = [p for p in rev.parent_ids
 
2882
                           if p not in self.absent_revisions]
 
2883
        self._convert_revision_contents(rev, inv, present_parents)
 
2884
        self._store_new_inv(rev, inv, present_parents)
 
2885
        self.converted_revs.add(rev_id)
 
2886
 
 
2887
    def _store_new_inv(self, rev, inv, present_parents):
 
2888
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
 
2889
        new_inv_sha1 = sha_string(new_inv_xml)
 
2890
        self.inv_weave.add_lines(rev.revision_id,
 
2891
                                 present_parents,
 
2892
                                 new_inv_xml.splitlines(True))
 
2893
        rev.inventory_sha1 = new_inv_sha1
 
2894
 
 
2895
    def _convert_revision_contents(self, rev, inv, present_parents):
 
2896
        """Convert all the files within a revision.
 
2897
 
 
2898
        Also upgrade the inventory to refer to the text revision ids."""
 
2899
        rev_id = rev.revision_id
 
2900
        mutter('converting texts of revision {%s}',
 
2901
               rev_id)
 
2902
        parent_invs = map(self._load_updated_inventory, present_parents)
 
2903
        entries = inv.iter_entries()
 
2904
        entries.next()
 
2905
        for path, ie in entries:
 
2906
            self._convert_file_version(rev, ie, parent_invs)
 
2907
 
 
2908
    def _convert_file_version(self, rev, ie, parent_invs):
 
2909
        """Convert one version of one file.
 
2910
 
 
2911
        The file needs to be added into the weave if it is a merge
 
2912
        of >=2 parents or if it's changed from its parent.
 
2913
        """
 
2914
        file_id = ie.file_id
 
2915
        rev_id = rev.revision_id
 
2916
        w = self.text_weaves.get(file_id)
 
2917
        if w is None:
 
2918
            w = Weave(file_id)
 
2919
            self.text_weaves[file_id] = w
 
2920
        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)
 
2927
        self.snapshot_ie(previous_entries, ie, w, rev_id)
 
2928
        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)
 
2935
 
 
2936
    def snapshot_ie(self, previous_revisions, ie, w, rev_id):
 
2937
        # TODO: convert this logic, which is ~= snapshot to
 
2938
        # a call to:. This needs the path figured out. rather than a work_tree
 
2939
        # a v4 revision_tree can be given, or something that looks enough like
 
2940
        # 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
 
2942
        # save against.
 
2943
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
 
2944
        if len(previous_revisions) == 1:
 
2945
            previous_ie = previous_revisions.values()[0]
 
2946
            if ie._unchanged(previous_ie):
 
2947
                ie.revision = previous_ie.revision
 
2948
                return
 
2949
        if ie.has_text():
 
2950
            text = self.branch.repository._text_store.get(ie.text_id)
 
2951
            file_lines = text.readlines()
 
2952
            w.add_lines(rev_id, previous_revisions, file_lines)
 
2953
            self.text_count += 1
 
2954
        else:
 
2955
            w.add_lines(rev_id, previous_revisions, [])
 
2956
        ie.revision = rev_id
 
2957
 
 
2958
    def _make_order(self):
 
2959
        """Return a suitable order for importing revisions.
 
2960
 
 
2961
        The order must be such that an revision is imported after all
 
2962
        its (present) parents.
 
2963
        """
 
2964
        todo = set(self.revisions.keys())
 
2965
        done = self.absent_revisions.copy()
 
2966
        order = []
 
2967
        while todo:
 
2968
            # scan through looking for a revision whose parents
 
2969
            # are all done
 
2970
            for rev_id in sorted(list(todo)):
 
2971
                rev = self.revisions[rev_id]
 
2972
                parent_ids = set(rev.parent_ids)
 
2973
                if parent_ids.issubset(done):
 
2974
                    # can take this one now
 
2975
                    order.append(rev_id)
 
2976
                    todo.remove(rev_id)
 
2977
                    done.add(rev_id)
 
2978
        return order
 
2979
 
 
2980
 
 
2981
class ConvertBzrDir5To6(Converter):
 
2982
    """Converts format 5 bzr dirs to format 6."""
 
2983
 
 
2984
    def convert(self, to_convert, pb):
 
2985
        """See Converter.convert()."""
 
2986
        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()
 
2994
 
 
2995
    def _convert_to_prefixed(self):
 
2996
        from bzrlib.store import TransportStore
 
2997
        self.bzrdir.transport.delete('branch-format')
 
2998
        for store_name in ["weaves", "revision-store"]:
 
2999
            ui.ui_factory.note("adding prefixes to %s" % store_name)
 
3000
            store_transport = self.bzrdir.transport.clone(store_name)
 
3001
            store = TransportStore(store_transport, prefixed=True)
 
3002
            for urlfilename in store_transport.list_dir('.'):
 
3003
                filename = urlutils.unescape(urlfilename)
 
3004
                if (filename.endswith(".weave") or
 
3005
                    filename.endswith(".gz") or
 
3006
                    filename.endswith(".sig")):
 
3007
                    file_id, suffix = os.path.splitext(filename)
 
3008
                else:
 
3009
                    file_id = filename
 
3010
                    suffix = ''
 
3011
                new_name = store._mapper.map((file_id,)) + suffix
 
3012
                # FIXME keep track of the dirs made RBC 20060121
 
3013
                try:
 
3014
                    store_transport.move(filename, new_name)
 
3015
                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())
 
3022
 
 
3023
 
 
3024
class ConvertBzrDir6ToMeta(Converter):
 
3025
    """Converts format 6 bzr dirs to metadirs."""
 
3026
 
 
3027
    def convert(self, to_convert, pb):
 
3028
        """See Converter.convert()."""
 
3029
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
 
3030
        from bzrlib.branch import BzrBranchFormat5
 
3031
        self.bzrdir = to_convert
 
3032
        self.pb = ui.ui_factory.nested_progress_bar()
 
3033
        self.count = 0
 
3034
        self.total = 20 # the steps we know about
 
3035
        self.garbage_inventories = []
 
3036
        self.dir_mode = self.bzrdir._get_dir_mode()
 
3037
        self.file_mode = self.bzrdir._get_file_mode()
 
3038
 
 
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)
 
3044
        # its faster to move specific files around than to open and use the apis...
 
3045
        # first off, nuke ancestry.weave, it was never used.
 
3046
        try:
 
3047
            self.step('Removing ancestry.weave')
 
3048
            self.bzrdir.transport.delete('ancestry.weave')
 
3049
        except errors.NoSuchFile:
 
3050
            pass
 
3051
        # find out whats there
 
3052
        self.step('Finding branch files')
 
3053
        last_revision = self.bzrdir.open_branch().last_revision()
 
3054
        bzrcontents = self.bzrdir.transport.list_dir('.')
 
3055
        for name in bzrcontents:
 
3056
            if name.startswith('basis-inventory.'):
 
3057
                self.garbage_inventories.append(name)
 
3058
        # create new directories for repository, working tree and branch
 
3059
        repository_names = [('inventory.weave', True),
 
3060
                            ('revision-store', True),
 
3061
                            ('weaves', True)]
 
3062
        self.step('Upgrading repository  ')
 
3063
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
 
3064
        self.make_lock('repository')
 
3065
        # we hard code the formats here because we are converting into
 
3066
        # the meta format. The meta format upgrader can take this to a
 
3067
        # future format within each component.
 
3068
        self.put_format('repository', RepositoryFormat7())
 
3069
        for entry in repository_names:
 
3070
            self.move_entry('repository', entry)
 
3071
 
 
3072
        self.step('Upgrading branch      ')
 
3073
        self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
 
3074
        self.make_lock('branch')
 
3075
        self.put_format('branch', BzrBranchFormat5())
 
3076
        branch_files = [('revision-history', True),
 
3077
                        ('branch-name', True),
 
3078
                        ('parent', False)]
 
3079
        for entry in branch_files:
 
3080
            self.move_entry('branch', entry)
 
3081
 
 
3082
        checkout_files = [('pending-merges', True),
 
3083
                          ('inventory', True),
 
3084
                          ('stat-cache', False)]
 
3085
        # If a mandatory checkout file is not present, the branch does not have
 
3086
        # a functional checkout. Do not create a checkout in the converted
 
3087
        # branch.
 
3088
        for name, mandatory in checkout_files:
 
3089
            if mandatory and name not in bzrcontents:
 
3090
                has_checkout = False
 
3091
                break
 
3092
        else:
 
3093
            has_checkout = True
 
3094
        if not has_checkout:
 
3095
            ui.ui_factory.note('No working tree.')
 
3096
            # If some checkout files are there, we may as well get rid of them.
 
3097
            for name, mandatory in checkout_files:
 
3098
                if name in bzrcontents:
 
3099
                    self.bzrdir.transport.delete(name)
 
3100
        else:
 
3101
            from bzrlib.workingtree import WorkingTreeFormat3
 
3102
            self.step('Upgrading working tree')
 
3103
            self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
 
3104
            self.make_lock('checkout')
 
3105
            self.put_format(
 
3106
                'checkout', WorkingTreeFormat3())
 
3107
            self.bzrdir.transport.delete_multi(
 
3108
                self.garbage_inventories, self.pb)
 
3109
            for entry in checkout_files:
 
3110
                self.move_entry('checkout', entry)
 
3111
            if last_revision is not None:
 
3112
                self.bzrdir.transport.put_bytes(
 
3113
                    '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)
 
3120
 
 
3121
    def make_lock(self, name):
 
3122
        """Make a lock for the new control dir name."""
 
3123
        self.step('Make %s lock' % name)
 
3124
        ld = lockdir.LockDir(self.bzrdir.transport,
 
3125
                             '%s/lock' % name,
 
3126
                             file_modebits=self.file_mode,
 
3127
                             dir_modebits=self.dir_mode)
 
3128
        ld.create()
 
3129
 
 
3130
    def move_entry(self, new_dir, entry):
 
3131
        """Move then entry name into new_dir."""
 
3132
        name = entry[0]
 
3133
        mandatory = entry[1]
 
3134
        self.step('Moving %s' % name)
 
3135
        try:
 
3136
            self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
 
3137
        except errors.NoSuchFile:
 
3138
            if mandatory:
 
3139
                raise
 
3140
 
 
3141
    def put_format(self, dirname, format):
 
3142
        self.bzrdir.transport.put_bytes('%s/format' % dirname,
 
3143
            format.get_format_string(),
 
3144
            self.file_mode)
 
3145
 
 
3146
 
 
3147
class ConvertMetaToMeta(Converter):
1748
3148
    """Converts the components of metadirs."""
1749
3149
 
1750
3150
    def __init__(self, target_format):
1756
3156
 
1757
3157
    def convert(self, to_convert, pb):
1758
3158
        """See Converter.convert()."""
1759
 
        self.controldir = to_convert
1760
 
        with ui.ui_factory.nested_progress_bar() as self.pb:
1761
 
            self.count = 0
1762
 
            self.total = 1
1763
 
            self.step('checking repository format')
1764
 
            try:
1765
 
                repo = self.controldir.open_repository()
1766
 
            except errors.NoRepositoryPresent:
1767
 
                pass
1768
 
            else:
1769
 
                repo_fmt = self.target_format.repository_format
1770
 
                if not isinstance(repo._format, repo_fmt.__class__):
1771
 
                    from ..repository import CopyConverter
1772
 
                    ui.ui_factory.note(gettext('starting repository conversion'))
1773
 
                    if not repo_fmt.supports_overriding_transport:
1774
 
                        raise AssertionError(
1775
 
                            "Repository in metadir does not support "
1776
 
                            "overriding transport")
1777
 
                    converter = CopyConverter(self.target_format.repository_format)
1778
 
                    converter.convert(repo, pb)
1779
 
            for branch in self.controldir.list_branches():
1780
 
                # TODO: conversions of Branch and Tree should be done by
1781
 
                # InterXFormat lookups/some sort of registry.
1782
 
                # Avoid circular imports
 
3159
        self.bzrdir = to_convert
 
3160
        self.pb = ui.ui_factory.nested_progress_bar()
 
3161
        self.count = 0
 
3162
        self.total = 1
 
3163
        self.step('checking repository format')
 
3164
        try:
 
3165
            repo = self.bzrdir.open_repository()
 
3166
        except errors.NoRepositoryPresent:
 
3167
            pass
 
3168
        else:
 
3169
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
 
3170
                from bzrlib.repository import CopyConverter
 
3171
                ui.ui_factory.note('starting repository conversion')
 
3172
                converter = CopyConverter(self.target_format.repository_format)
 
3173
                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()
1783
3199
                old = branch._format.__class__
1784
 
                new = self.target_format.get_branch_format().__class__
1785
 
                while old != new:
1786
 
                    if (old == fullhistorybranch.BzrBranchFormat5
1787
 
                        and new in (_mod_bzrbranch.BzrBranchFormat6,
1788
 
                                    _mod_bzrbranch.BzrBranchFormat7,
1789
 
                                    _mod_bzrbranch.BzrBranchFormat8)):
1790
 
                        branch_converter = _mod_bzrbranch.Converter5to6()
1791
 
                    elif (old == _mod_bzrbranch.BzrBranchFormat6
1792
 
                          and new in (_mod_bzrbranch.BzrBranchFormat7,
1793
 
                                      _mod_bzrbranch.BzrBranchFormat8)):
1794
 
                        branch_converter = _mod_bzrbranch.Converter6to7()
1795
 
                    elif (old == _mod_bzrbranch.BzrBranchFormat7
1796
 
                          and new is _mod_bzrbranch.BzrBranchFormat8):
1797
 
                        branch_converter = _mod_bzrbranch.Converter7to8()
1798
 
                    else:
1799
 
                        raise errors.BadConversionTarget("No converter", new,
1800
 
                                                         branch._format)
1801
 
                    branch_converter.convert(branch)
1802
 
                    branch = self.controldir.open_branch()
1803
 
                    old = branch._format.__class__
1804
 
            try:
1805
 
                tree = self.controldir.open_workingtree(recommend_upgrade=False)
1806
 
            except (errors.NoWorkingTree, errors.NotLocalUrl):
1807
 
                pass
1808
 
            else:
1809
 
                # TODO: conversions of Branch and Tree should be done by
1810
 
                # InterXFormat lookups
1811
 
                if (isinstance(tree, workingtree_3.WorkingTree3)
1812
 
                    and not isinstance(tree, workingtree_4.DirStateWorkingTree)
1813
 
                    and isinstance(self.target_format.workingtree_format,
1814
 
                                   workingtree_4.DirStateWorkingTreeFormat)):
1815
 
                    workingtree_4.Converter3to4().convert(tree)
1816
 
                if (isinstance(tree, workingtree_4.DirStateWorkingTree)
1817
 
                    and not isinstance(tree, workingtree_4.WorkingTree5)
1818
 
                    and isinstance(self.target_format.workingtree_format,
1819
 
                                   workingtree_4.WorkingTreeFormat5)):
1820
 
                    workingtree_4.Converter4to5().convert(tree)
1821
 
                if (isinstance(tree, workingtree_4.DirStateWorkingTree)
1822
 
                    and not isinstance(tree, workingtree_4.WorkingTree6)
1823
 
                    and isinstance(self.target_format.workingtree_format,
1824
 
                                   workingtree_4.WorkingTreeFormat6)):
1825
 
                    workingtree_4.Converter4or5to6().convert(tree)
 
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()
1826
3223
        return to_convert
1827
3224
 
1828
3225
 
1829
 
class ConvertMetaToColo(controldir.Converter):
1830
 
    """Add colocated branch support."""
1831
 
 
1832
 
    def __init__(self, target_format):
1833
 
        """Create a converter.that upgrades a metadir to the colo format.
1834
 
 
1835
 
        :param target_format: The final metadir format that is desired.
1836
 
        """
1837
 
        self.target_format = target_format
1838
 
 
1839
 
    def convert(self, to_convert, pb):
1840
 
        """See Converter.convert()."""
1841
 
        to_convert.transport.put_bytes('branch-format',
1842
 
                                       self.target_format.as_string())
1843
 
        return BzrDir.open_from_transport(to_convert.root_transport)
1844
 
 
1845
 
 
1846
 
class ConvertMetaToColo(controldir.Converter):
1847
 
    """Convert a 'development-colo' bzrdir to a '2a' bzrdir."""
1848
 
 
1849
 
    def __init__(self, target_format):
1850
 
        """Create a converter that converts a 'development-colo' metadir
1851
 
        to a '2a' metadir.
1852
 
 
1853
 
        :param target_format: The final metadir format that is desired.
1854
 
        """
1855
 
        self.target_format = target_format
1856
 
 
1857
 
    def convert(self, to_convert, pb):
1858
 
        """See Converter.convert()."""
1859
 
        to_convert.transport.put_bytes('branch-format',
1860
 
                                       self.target_format.as_string())
1861
 
        return BzrDir.open_from_transport(to_convert.root_transport)
1862
 
 
1863
 
 
1864
 
class CreateRepository(controldir.RepositoryAcquisitionPolicy):
 
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.
 
3228
# we can make it a lazy object if the control formats is turned into something
 
3229
# like a registry.
 
3230
class RemoteBzrDirFormat(BzrDirMetaFormat1):
 
3231
    """Format representing bzrdirs accessed via a smart server"""
 
3232
 
 
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
    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
        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
 
 
3260
    @classmethod
 
3261
    def probe_transport(klass, transport):
 
3262
        """Return a RemoteBzrDirFormat object if it looks possible."""
 
3263
        try:
 
3264
            medium = transport.get_smart_medium()
 
3265
        except (NotImplementedError, AttributeError,
 
3266
                errors.TransportNotPossible, errors.NoSmartMedium,
 
3267
                errors.SmartProtocolError):
 
3268
            # no smart server, so not a branch for this format type.
 
3269
            raise errors.NotBranchError(path=transport.base)
 
3270
        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
            return klass()
 
3283
 
 
3284
    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)
 
3293
        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
 
3449
 
 
3450
    def _open(self, transport):
 
3451
        return remote.RemoteBzrDir(transport, self)
 
3452
 
 
3453
    def __eq__(self, other):
 
3454
        if not isinstance(other, RemoteBzrDirFormat):
 
3455
            return False
 
3456
        return self.get_format_description() == other.get_format_description()
 
3457
 
 
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)
 
3489
 
 
3490
 
 
3491
class BzrDirFormatInfo(object):
 
3492
 
 
3493
    def __init__(self, native, deprecated, hidden, experimental):
 
3494
        self.deprecated = deprecated
 
3495
        self.native = native
 
3496
        self.hidden = hidden
 
3497
        self.experimental = experimental
 
3498
 
 
3499
 
 
3500
class BzrDirFormatRegistry(registry.Registry):
 
3501
    """Registry of user-selectable BzrDir subformats.
 
3502
 
 
3503
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
 
3504
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
 
3505
    """
 
3506
 
 
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):
 
3524
        """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.
 
3535
        """
 
3536
        # This should be expanded to support setting WorkingTree and Branch
 
3537
        # 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
        def helper():
 
3553
            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)
 
3560
            return bd
 
3561
        self.register(key, helper, help, native, deprecated, hidden,
 
3562
            experimental, alias)
 
3563
 
 
3564
    def register(self, key, factory, help, native=True, deprecated=False,
 
3565
                 hidden=False, experimental=False, alias=False):
 
3566
        """Register a BzrDirFormat factory.
 
3567
 
 
3568
        The factory must be a callable that takes one parameter: the key.
 
3569
        It must produce an instance of the BzrDirFormat when called.
 
3570
 
 
3571
        This function mainly exists to prevent the info object from being
 
3572
        supplied directly.
 
3573
        """
 
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)
 
3579
 
 
3580
    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)
 
3587
 
 
3588
    def set_default(self, key):
 
3589
        """Set the 'default' key to be a clone of the supplied key.
 
3590
 
 
3591
        This method must be called once and only once.
 
3592
        """
 
3593
        registry.Registry.register(self, 'default', self.get(key),
 
3594
            self.get_help(key), info=self.get_info(key))
 
3595
        self._aliases.add('default')
 
3596
 
 
3597
    def set_default_repository(self, key):
 
3598
        """Set the FormatRegistry default and Repository default.
 
3599
 
 
3600
        This is a transitional method while Repository.set_default_format
 
3601
        is deprecated.
 
3602
        """
 
3603
        if 'default' in self:
 
3604
            self.remove('default')
 
3605
        self.set_default(key)
 
3606
        format = self.get('default')()
 
3607
 
 
3608
    def make_bzrdir(self, key):
 
3609
        return self.get(key)()
 
3610
 
 
3611
    def help_topic(self, topic):
 
3612
        output = ""
 
3613
        default_realkey = None
 
3614
        default_help = self.get_help('default')
 
3615
        help_pairs = []
 
3616
        for key in self._registration_order:
 
3617
            if key == 'default':
 
3618
                continue
 
3619
            help = self.get_help(key)
 
3620
            if help == default_help:
 
3621
                default_realkey = key
 
3622
            else:
 
3623
                help_pairs.append((key, help))
 
3624
 
 
3625
        def wrapped(key, help, info):
 
3626
            if info.native:
 
3627
                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'))
 
3635
        deprecated_pairs = []
 
3636
        experimental_pairs = []
 
3637
        for key, help in help_pairs:
 
3638
            info = self.get_info(key)
 
3639
            if info.hidden:
 
3640
                continue
 
3641
            elif info.deprecated:
 
3642
                deprecated_pairs.append((key, help))
 
3643
            elif info.experimental:
 
3644
                experimental_pairs.append((key, help))
 
3645
            else:
 
3646
                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
        if len(deprecated_pairs) > 0:
 
3658
            other_output += "\nDeprecated formats are shown below.\n\n"
 
3659
            for key, help in deprecated_pairs:
 
3660
                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):
1865
3768
    """A policy of creating a new repository"""
1866
3769
 
1867
 
    def __init__(self, controldir, stack_on=None, stack_on_pwd=None,
 
3770
    def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
1868
3771
                 require_stacking=False):
1869
 
        """Constructor.
1870
 
 
1871
 
        :param controldir: The controldir to create the repository on.
 
3772
        """
 
3773
        Constructor.
 
3774
        :param bzrdir: The bzrdir to create the repository on.
1872
3775
        :param stack_on: A location to stack on
1873
3776
        :param stack_on_pwd: If stack_on is relative, the location it is
1874
3777
            relative to.
1875
3778
        """
1876
 
        super(CreateRepository, self).__init__(
1877
 
            stack_on, stack_on_pwd, require_stacking)
1878
 
        self._controldir = controldir
 
3779
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
 
3780
                                             require_stacking)
 
3781
        self._bzrdir = bzrdir
1879
3782
 
1880
 
    def acquire_repository(self, make_working_trees=None, shared=False,
1881
 
                           possible_transports=None):
 
3783
    def acquire_repository(self, make_working_trees=None, shared=False):
1882
3784
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
1883
3785
 
1884
 
        Creates the desired repository in the controldir we already have.
 
3786
        Creates the desired repository in the bzrdir we already have.
1885
3787
        """
1886
 
        if possible_transports is None:
1887
 
            possible_transports = []
1888
 
        else:
1889
 
            possible_transports = list(possible_transports)
1890
 
        possible_transports.append(self._controldir.root_transport)
1891
3788
        stack_on = self._get_full_stack_on()
1892
3789
        if stack_on:
1893
 
            format = self._controldir._format
 
3790
            format = self._bzrdir._format
1894
3791
            format.require_stacking(stack_on=stack_on,
1895
 
                                    possible_transports=possible_transports)
 
3792
                                    possible_transports=[self._bzrdir.root_transport])
1896
3793
            if not self._require_stacking:
1897
3794
                # We have picked up automatic stacking somewhere.
1898
 
                note(gettext('Using default stacking branch {0} at {1}').format(
1899
 
                    self._stack_on, self._stack_on_pwd))
1900
 
        repository = self._controldir.create_repository(shared=shared)
 
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)
1901
3798
        self._add_fallback(repository,
1902
 
                           possible_transports=possible_transports)
 
3799
                           possible_transports=[self._bzrdir.transport])
1903
3800
        if make_working_trees is not None:
1904
3801
            repository.set_make_working_trees(make_working_trees)
1905
3802
        return repository, True
1906
3803
 
1907
3804
 
1908
 
class UseExistingRepository(controldir.RepositoryAcquisitionPolicy):
 
3805
class UseExistingRepository(RepositoryAcquisitionPolicy):
1909
3806
    """A policy of reusing an existing repository"""
1910
3807
 
1911
3808
    def __init__(self, repository, stack_on=None, stack_on_pwd=None,
1917
3814
        :param stack_on_pwd: If stack_on is relative, the location it is
1918
3815
            relative to.
1919
3816
        """
1920
 
        super(UseExistingRepository, self).__init__(
1921
 
            stack_on, stack_on_pwd, require_stacking)
 
3817
        RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
 
3818
                                             require_stacking)
1922
3819
        self._repository = repository
1923
3820
 
1924
 
    def acquire_repository(self, make_working_trees=None, shared=False,
1925
 
                           possible_transports=None):
 
3821
    def acquire_repository(self, make_working_trees=None, shared=False):
1926
3822
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
1927
3823
 
1928
3824
        Returns an existing repository to use.
1929
3825
        """
1930
 
        if possible_transports is None:
1931
 
            possible_transports = []
1932
 
        else:
1933
 
            possible_transports = list(possible_transports)
1934
 
        possible_transports.append(self._repository.controldir.transport)
1935
3826
        self._add_fallback(self._repository,
1936
 
                           possible_transports=possible_transports)
 
3827
                       possible_transports=[self._repository.bzrdir.transport])
1937
3828
        return self._repository, False
1938
3829
 
1939
3830
 
1940
 
controldir.ControlDirFormat._default_format = BzrDirMetaFormat1()
 
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.
 
3834
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
format_registry.register('weave', BzrDirFormat6,
 
3839
    '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',
 
3845
    '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')