~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Jelmer Vernooij
  • Date: 2011-10-14 13:56:45 UTC
  • mfrom: (6215 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6216.
  • Revision ID: jelmer@samba.org-20111014135645-phc3q3y21k2ks0s2
Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2006-2011 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
 
# TODO: Move old formats into a plugin to make this file smaller.
29
 
 
30
 
import os
31
28
import sys
32
29
 
33
30
from bzrlib.lazy_import import lazy_import
34
31
lazy_import(globals(), """
35
 
from stat import S_ISDIR
36
 
import textwrap
37
 
 
38
32
import bzrlib
39
33
from bzrlib import (
40
 
    branch,
41
 
    config,
 
34
    branch as _mod_branch,
 
35
    cleanup,
42
36
    errors,
 
37
    fetch,
43
38
    graph,
44
39
    lockable_files,
45
40
    lockdir,
46
41
    osutils,
 
42
    pyutils,
47
43
    remote,
48
44
    repository,
49
45
    revision as _mod_revision,
 
46
    transport as _mod_transport,
50
47
    ui,
51
48
    urlutils,
52
 
    versionedfile,
53
49
    win32utils,
54
 
    workingtree,
 
50
    workingtree_3,
55
51
    workingtree_4,
56
 
    xml4,
57
 
    xml5,
58
 
    )
59
 
from bzrlib.osutils import (
60
 
    sha_string,
61
 
    )
62
 
from bzrlib.push import (
63
 
    PushResult,
64
 
    )
65
 
from bzrlib.repofmt import pack_repo
66
 
from bzrlib.smart.client import _SmartClient
67
 
from bzrlib.store.versioned import WeaveStore
68
 
from bzrlib.transactions import WriteTransaction
 
52
    )
 
53
from bzrlib.repofmt import knitpack_repo
69
54
from bzrlib.transport import (
70
55
    do_catching_redirections,
71
 
    get_transport,
72
56
    local,
73
57
    )
74
 
from bzrlib.weave import Weave
 
58
from bzrlib.i18n import gettext
75
59
""")
76
60
 
77
61
from bzrlib.trace import (
80
64
    )
81
65
 
82
66
from bzrlib import (
83
 
    hooks,
 
67
    config,
 
68
    controldir,
84
69
    registry,
85
 
    symbol_versioning,
86
 
    )
87
 
 
88
 
 
89
 
class BzrDir(object):
 
70
    )
 
71
from bzrlib.symbol_versioning import (
 
72
    deprecated_in,
 
73
    deprecated_method,
 
74
    )
 
75
 
 
76
 
 
77
class BzrDir(controldir.ControlDir):
90
78
    """A .bzr control diretory.
91
79
 
92
80
    BzrDir instances let you create or open any of the things that can be
123
111
                    return
124
112
        thing_to_unlock.break_lock()
125
113
 
126
 
    def can_convert_format(self):
127
 
        """Return true if this bzrdir is one whose format we can convert from."""
128
 
        return True
129
 
 
130
114
    def check_conversion_target(self, target_format):
 
115
        """Check that a bzrdir as a whole can be converted to a new format."""
 
116
        # The only current restriction is that the repository content can be 
 
117
        # fetched compatibly with the target.
131
118
        target_repo_format = target_format.repository_format
132
 
        source_repo_format = self._format.repository_format
133
 
        source_repo_format.check_conversion_target(target_repo_format)
134
 
 
135
 
    @staticmethod
136
 
    def _check_supported(format, allow_unsupported,
137
 
        recommend_upgrade=True,
138
 
        basedir=None):
139
 
        """Give an error or warning on old formats.
140
 
 
141
 
        :param format: may be any kind of format - workingtree, branch,
142
 
        or repository.
143
 
 
144
 
        :param allow_unsupported: If true, allow opening
145
 
        formats that are strongly deprecated, and which may
146
 
        have limited functionality.
147
 
 
148
 
        :param recommend_upgrade: If true (default), warn
149
 
        the user through the ui object that they may wish
150
 
        to upgrade the object.
151
 
        """
152
 
        # TODO: perhaps move this into a base Format class; it's not BzrDir
153
 
        # specific. mbp 20070323
154
 
        if not allow_unsupported and not format.is_supported():
155
 
            # see open_downlevel to open legacy branches.
156
 
            raise errors.UnsupportedFormatError(format=format)
157
 
        if recommend_upgrade \
158
 
            and getattr(format, 'upgrade_recommended', False):
159
 
            ui.ui_factory.recommend_upgrade(
160
 
                format.get_format_description(),
161
 
                basedir)
162
 
 
163
 
    def clone(self, url, revision_id=None, force_new_repo=False,
164
 
              preserve_stacking=False):
165
 
        """Clone this bzrdir and its contents to url verbatim.
166
 
 
167
 
        :param url: The url create the clone at.  If url's last component does
168
 
            not exist, it will be created.
169
 
        :param revision_id: The tip revision-id to use for any branch or
170
 
            working tree.  If not None, then the clone operation may tune
171
 
            itself to download less data.
172
 
        :param force_new_repo: Do not use a shared repository for the target
173
 
                               even if one is available.
174
 
        :param preserve_stacking: When cloning a stacked branch, stack the
175
 
            new branch on top of the other branch's stacked-on branch.
176
 
        """
177
 
        return self.clone_on_transport(get_transport(url),
178
 
                                       revision_id=revision_id,
179
 
                                       force_new_repo=force_new_repo,
180
 
                                       preserve_stacking=preserve_stacking)
 
119
        try:
 
120
            self.open_repository()._format.check_conversion_target(
 
121
                target_repo_format)
 
122
        except errors.NoRepositoryPresent:
 
123
            # No repo, no problem.
 
124
            pass
181
125
 
182
126
    def clone_on_transport(self, transport, revision_id=None,
183
127
        force_new_repo=False, preserve_stacking=False, stacked_on=None,
184
 
        create_prefix=False, use_existing_dir=True):
 
128
        create_prefix=False, use_existing_dir=True, no_tree=False):
185
129
        """Clone this bzrdir and its contents to transport verbatim.
186
130
 
187
131
        :param transport: The transport for the location to produce the clone
196
140
        :param create_prefix: Create any missing directories leading up to
197
141
            to_transport.
198
142
        :param use_existing_dir: Use an existing directory if one exists.
 
143
        :param no_tree: If set to true prevents creation of a working tree.
199
144
        """
200
145
        # Overview: put together a broad description of what we want to end up
201
146
        # with; then make as few api calls as possible to do it.
202
 
        
 
147
 
203
148
        # We may want to create a repo/branch/tree, if we do so what format
204
149
        # would we want for each:
205
150
        require_stacking = (stacked_on is not None)
206
151
        format = self.cloning_metadir(require_stacking)
207
 
        
 
152
 
208
153
        # Figure out what objects we want:
209
154
        try:
210
155
            local_repo = self.find_repository()
229
174
        # we should look up the policy needs first, or just use it as a hint,
230
175
        # or something.
231
176
        if local_repo:
232
 
            make_working_trees = local_repo.make_working_trees()
 
177
            make_working_trees = local_repo.make_working_trees() and not no_tree
233
178
            want_shared = local_repo.is_shared()
234
179
            repo_format_name = format.repository_format.network_name()
235
180
        else:
252
197
                # copied, and finally if we are copying up to a specific
253
198
                # revision_id then we can use the pending-ancestry-result which
254
199
                # does not require traversing all of history to describe it.
255
 
                if (result_repo.bzrdir.root_transport.base ==
256
 
                    result.root_transport.base and not require_stacking and
 
200
                if (result_repo.user_url == result.user_url
 
201
                    and not require_stacking and
257
202
                    revision_id is not None):
258
203
                    fetch_spec = graph.PendingAncestryResult(
259
204
                        [revision_id], local_repo)
276
221
            # the tree and fail.
277
222
            result.root_transport.local_abspath('.')
278
223
            if result_repo is None or result_repo.make_working_trees():
279
 
                self.open_workingtree().clone(result)
 
224
                self.open_workingtree().clone(result, revision_id=revision_id)
280
225
        except (errors.NoWorkingTree, errors.NotLocalUrl):
281
226
            pass
282
227
        return result
284
229
    # TODO: This should be given a Transport, and should chdir up; otherwise
285
230
    # this will open a new connection.
286
231
    def _make_tail(self, url):
287
 
        t = get_transport(url)
288
 
        t.ensure_base()
289
 
 
290
 
    @classmethod
291
 
    def create(cls, base, format=None, possible_transports=None):
292
 
        """Create a new BzrDir at the url 'base'.
293
 
 
294
 
        :param format: If supplied, the format of branch to create.  If not
295
 
            supplied, the default is used.
296
 
        :param possible_transports: If supplied, a list of transports that
297
 
            can be reused to share a remote connection.
298
 
        """
299
 
        if cls is not BzrDir:
300
 
            raise AssertionError("BzrDir.create always creates the default"
301
 
                " format, not one of %r" % cls)
302
 
        t = get_transport(base, possible_transports)
303
 
        t.ensure_base()
304
 
        if format is None:
305
 
            format = BzrDirFormat.get_default_format()
306
 
        return format.initialize_on_transport(t)
307
 
 
308
 
    @staticmethod
309
 
    def find_bzrdirs(transport, evaluate=None, list_current=None):
310
 
        """Find bzrdirs recursively from current location.
311
 
 
312
 
        This is intended primarily as a building block for more sophisticated
313
 
        functionality, like finding trees under a directory, or finding
314
 
        branches that use a given repository.
315
 
        :param evaluate: An optional callable that yields recurse, value,
316
 
            where recurse controls whether this bzrdir is recursed into
317
 
            and value is the value to yield.  By default, all bzrdirs
318
 
            are recursed into, and the return value is the bzrdir.
319
 
        :param list_current: if supplied, use this function to list the current
320
 
            directory, instead of Transport.list_dir
321
 
        :return: a generator of found bzrdirs, or whatever evaluate returns.
322
 
        """
323
 
        if list_current is None:
324
 
            def list_current(transport):
325
 
                return transport.list_dir('')
326
 
        if evaluate is None:
327
 
            def evaluate(bzrdir):
328
 
                return True, bzrdir
329
 
 
330
 
        pending = [transport]
331
 
        while len(pending) > 0:
332
 
            current_transport = pending.pop()
333
 
            recurse = True
334
 
            try:
335
 
                bzrdir = BzrDir.open_from_transport(current_transport)
336
 
            except errors.NotBranchError:
337
 
                pass
338
 
            else:
339
 
                recurse, value = evaluate(bzrdir)
340
 
                yield value
341
 
            try:
342
 
                subdirs = list_current(current_transport)
343
 
            except errors.NoSuchFile:
344
 
                continue
345
 
            if recurse:
346
 
                for subdir in sorted(subdirs, reverse=True):
347
 
                    pending.append(current_transport.clone(subdir))
348
 
 
349
 
    @staticmethod
350
 
    def find_branches(transport):
351
 
        """Find all branches under a transport.
352
 
 
353
 
        This will find all branches below the transport, including branches
354
 
        inside other branches.  Where possible, it will use
355
 
        Repository.find_branches.
356
 
 
357
 
        To list all the branches that use a particular Repository, see
358
 
        Repository.find_branches
359
 
        """
360
 
        def evaluate(bzrdir):
361
 
            try:
362
 
                repository = bzrdir.open_repository()
363
 
            except errors.NoRepositoryPresent:
364
 
                pass
365
 
            else:
366
 
                return False, (None, repository)
367
 
            try:
368
 
                branch = bzrdir.open_branch()
369
 
            except errors.NotBranchError:
370
 
                return True, (None, None)
371
 
            else:
372
 
                return True, (branch, None)
373
 
        branches = []
374
 
        for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
375
 
            if repo is not None:
376
 
                branches.extend(repo.find_branches())
377
 
            if branch is not None:
378
 
                branches.append(branch)
379
 
        return branches
380
 
 
381
 
    def destroy_repository(self):
382
 
        """Destroy the repository in this BzrDir"""
383
 
        raise NotImplementedError(self.destroy_repository)
384
 
 
385
 
    def create_branch(self):
386
 
        """Create a branch in this BzrDir.
387
 
 
388
 
        The bzrdir's format will control what branch format is created.
389
 
        For more control see BranchFormatXX.create(a_bzrdir).
390
 
        """
391
 
        raise NotImplementedError(self.create_branch)
392
 
 
393
 
    def destroy_branch(self):
394
 
        """Destroy the branch in this BzrDir"""
395
 
        raise NotImplementedError(self.destroy_branch)
396
 
 
397
 
    @staticmethod
398
 
    def create_branch_and_repo(base, force_new_repo=False, format=None):
399
 
        """Create a new BzrDir, Branch and Repository at the url 'base'.
400
 
 
401
 
        This will use the current default BzrDirFormat unless one is
402
 
        specified, and use whatever
403
 
        repository format that that uses via bzrdir.create_branch and
404
 
        create_repository. If a shared repository is available that is used
405
 
        preferentially.
406
 
 
407
 
        The created Branch object is returned.
408
 
 
409
 
        :param base: The URL to create the branch at.
410
 
        :param force_new_repo: If True a new repository is always created.
411
 
        :param format: If supplied, the format of branch to create.  If not
412
 
            supplied, the default is used.
413
 
        """
414
 
        bzrdir = BzrDir.create(base, format)
415
 
        bzrdir._find_or_create_repository(force_new_repo)
416
 
        return bzrdir.create_branch()
 
232
        t = _mod_transport.get_transport(url)
 
233
        t.ensure_base()
417
234
 
418
235
    def determine_repository_policy(self, force_new_repo=False, stack_on=None,
419
236
                                    stack_on_pwd=None, require_stacking=False):
437
254
            stop = False
438
255
            stack_on = config.get_default_stack_on()
439
256
            if stack_on is not None:
440
 
                stack_on_pwd = found_bzrdir.root_transport.base
 
257
                stack_on_pwd = found_bzrdir.user_url
441
258
                stop = True
442
259
            # does it have a repository ?
443
260
            try:
445
262
            except errors.NoRepositoryPresent:
446
263
                repository = None
447
264
            else:
448
 
                if ((found_bzrdir.root_transport.base !=
449
 
                     self.root_transport.base) and not repository.is_shared()):
 
265
                if (found_bzrdir.user_url != self.user_url 
 
266
                    and not repository.is_shared()):
450
267
                    # Don't look higher, can't use a higher shared repo.
451
268
                    repository = None
452
269
                    stop = True
481
298
        policy = self.determine_repository_policy(force_new_repo)
482
299
        return policy.acquire_repository()[0]
483
300
 
484
 
    @staticmethod
485
 
    def create_branch_convenience(base, force_new_repo=False,
486
 
                                  force_new_tree=None, format=None,
487
 
                                  possible_transports=None):
488
 
        """Create a new BzrDir, Branch and Repository at the url 'base'.
489
 
 
490
 
        This is a convenience function - it will use an existing repository
491
 
        if possible, can be told explicitly whether to create a working tree or
492
 
        not.
493
 
 
494
 
        This will use the current default BzrDirFormat unless one is
495
 
        specified, and use whatever
496
 
        repository format that that uses via bzrdir.create_branch and
497
 
        create_repository. If a shared repository is available that is used
498
 
        preferentially. Whatever repository is used, its tree creation policy
499
 
        is followed.
500
 
 
501
 
        The created Branch object is returned.
502
 
        If a working tree cannot be made due to base not being a file:// url,
503
 
        no error is raised unless force_new_tree is True, in which case no
504
 
        data is created on disk and NotLocalUrl is raised.
505
 
 
506
 
        :param base: The URL to create the branch at.
507
 
        :param force_new_repo: If True a new repository is always created.
508
 
        :param force_new_tree: If True or False force creation of a tree or
509
 
                               prevent such creation respectively.
510
 
        :param format: Override for the bzrdir format to create.
511
 
        :param possible_transports: An optional reusable transports list.
 
301
    def _find_source_repo(self, add_cleanup, source_branch):
 
302
        """Find the source branch and repo for a sprout operation.
 
303
        
 
304
        This is helper intended for use by _sprout.
 
305
 
 
306
        :returns: (source_branch, source_repository).  Either or both may be
 
307
            None.  If not None, they will be read-locked (and their unlock(s)
 
308
            scheduled via the add_cleanup param).
512
309
        """
513
 
        if force_new_tree:
514
 
            # check for non local urls
515
 
            t = get_transport(base, possible_transports)
516
 
            if not isinstance(t, local.LocalTransport):
517
 
                raise errors.NotLocalUrl(base)
518
 
        bzrdir = BzrDir.create(base, format, possible_transports)
519
 
        repo = bzrdir._find_or_create_repository(force_new_repo)
520
 
        result = bzrdir.create_branch()
521
 
        if force_new_tree or (repo.make_working_trees() and
522
 
                              force_new_tree is None):
 
310
        if source_branch is not None:
 
311
            add_cleanup(source_branch.lock_read().unlock)
 
312
            return source_branch, source_branch.repository
 
313
        try:
 
314
            source_branch = self.open_branch()
 
315
            source_repository = source_branch.repository
 
316
        except errors.NotBranchError:
 
317
            source_branch = None
523
318
            try:
524
 
                bzrdir.create_workingtree()
525
 
            except errors.NotLocalUrl:
526
 
                pass
527
 
        return result
528
 
 
529
 
    @staticmethod
530
 
    def create_standalone_workingtree(base, format=None):
531
 
        """Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
532
 
 
533
 
        'base' must be a local path or a file:// url.
534
 
 
535
 
        This will use the current default BzrDirFormat unless one is
536
 
        specified, and use whatever
537
 
        repository format that that uses for bzrdirformat.create_workingtree,
538
 
        create_branch and create_repository.
539
 
 
540
 
        :param format: Override for the bzrdir format to create.
541
 
        :return: The WorkingTree object.
542
 
        """
543
 
        t = get_transport(base)
544
 
        if not isinstance(t, local.LocalTransport):
545
 
            raise errors.NotLocalUrl(base)
546
 
        bzrdir = BzrDir.create_branch_and_repo(base,
547
 
                                               force_new_repo=True,
548
 
                                               format=format).bzrdir
549
 
        return bzrdir.create_workingtree()
550
 
 
551
 
    def create_workingtree(self, revision_id=None, from_branch=None,
552
 
        accelerator_tree=None, hardlink=False):
553
 
        """Create a working tree at this BzrDir.
554
 
 
555
 
        :param revision_id: create it as of this revision id.
556
 
        :param from_branch: override bzrdir branch (for lightweight checkouts)
 
319
                source_repository = self.open_repository()
 
320
            except errors.NoRepositoryPresent:
 
321
                source_repository = None
 
322
            else:
 
323
                add_cleanup(source_repository.lock_read().unlock)
 
324
        else:
 
325
            add_cleanup(source_branch.lock_read().unlock)
 
326
        return source_branch, source_repository
 
327
 
 
328
    def sprout(self, url, revision_id=None, force_new_repo=False,
 
329
               recurse='down', possible_transports=None,
 
330
               accelerator_tree=None, hardlink=False, stacked=False,
 
331
               source_branch=None, create_tree_if_local=True):
 
332
        """Create a copy of this controldir prepared for use as a new line of
 
333
        development.
 
334
 
 
335
        If url's last component does not exist, it will be created.
 
336
 
 
337
        Attributes related to the identity of the source branch like
 
338
        branch nickname will be cleaned, a working tree is created
 
339
        whether one existed before or not; and a local branch is always
 
340
        created.
 
341
 
 
342
        if revision_id is not None, then the clone operation may tune
 
343
            itself to download less data.
 
344
 
557
345
        :param accelerator_tree: A tree which can be used for retrieving file
558
346
            contents more quickly than the revision tree, i.e. a workingtree.
559
347
            The revision tree will be used for cases where accelerator_tree's
560
348
            content is different.
561
 
        """
562
 
        raise NotImplementedError(self.create_workingtree)
 
349
        :param hardlink: If true, hard-link files from accelerator_tree,
 
350
            where possible.
 
351
        :param stacked: If true, create a stacked branch referring to the
 
352
            location of this control directory.
 
353
        :param create_tree_if_local: If true, a working-tree will be created
 
354
            when working locally.
 
355
        """
 
356
        operation = cleanup.OperationWithCleanups(self._sprout)
 
357
        return operation.run(url, revision_id=revision_id,
 
358
            force_new_repo=force_new_repo, recurse=recurse,
 
359
            possible_transports=possible_transports,
 
360
            accelerator_tree=accelerator_tree, hardlink=hardlink,
 
361
            stacked=stacked, source_branch=source_branch,
 
362
            create_tree_if_local=create_tree_if_local)
 
363
 
 
364
    def _sprout(self, op, url, revision_id=None, force_new_repo=False,
 
365
               recurse='down', possible_transports=None,
 
366
               accelerator_tree=None, hardlink=False, stacked=False,
 
367
               source_branch=None, create_tree_if_local=True):
 
368
        add_cleanup = op.add_cleanup
 
369
        fetch_spec_factory = fetch.FetchSpecFactory()
 
370
        if revision_id is not None:
 
371
            fetch_spec_factory.add_revision_ids([revision_id])
 
372
            fetch_spec_factory.source_branch_stop_revision_id = revision_id
 
373
        target_transport = _mod_transport.get_transport(url,
 
374
            possible_transports)
 
375
        target_transport.ensure_base()
 
376
        cloning_format = self.cloning_metadir(stacked)
 
377
        # Create/update the result branch
 
378
        result = cloning_format.initialize_on_transport(target_transport)
 
379
        source_branch, source_repository = self._find_source_repo(
 
380
            add_cleanup, source_branch)
 
381
        fetch_spec_factory.source_branch = source_branch
 
382
        # if a stacked branch wasn't requested, we don't create one
 
383
        # even if the origin was stacked
 
384
        if stacked and source_branch is not None:
 
385
            stacked_branch_url = self.root_transport.base
 
386
        else:
 
387
            stacked_branch_url = None
 
388
        repository_policy = result.determine_repository_policy(
 
389
            force_new_repo, stacked_branch_url, require_stacking=stacked)
 
390
        result_repo, is_new_repo = repository_policy.acquire_repository()
 
391
        add_cleanup(result_repo.lock_write().unlock)
 
392
        fetch_spec_factory.source_repo = source_repository
 
393
        fetch_spec_factory.target_repo = result_repo
 
394
        if stacked or (len(result_repo._fallback_repositories) != 0):
 
395
            target_repo_kind = fetch.TargetRepoKinds.STACKED
 
396
        elif is_new_repo:
 
397
            target_repo_kind = fetch.TargetRepoKinds.EMPTY
 
398
        else:
 
399
            target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
400
        fetch_spec_factory.target_repo_kind = target_repo_kind
 
401
        if source_repository is not None:
 
402
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
403
            result_repo.fetch(source_repository, fetch_spec=fetch_spec)
 
404
 
 
405
        if source_branch is None:
 
406
            # this is for sprouting a controldir without a branch; is that
 
407
            # actually useful?
 
408
            # Not especially, but it's part of the contract.
 
409
            result_branch = result.create_branch()
 
410
        else:
 
411
            result_branch = source_branch.sprout(result,
 
412
                revision_id=revision_id, repository_policy=repository_policy,
 
413
                repository=result_repo)
 
414
        mutter("created new branch %r" % (result_branch,))
 
415
 
 
416
        # Create/update the result working tree
 
417
        if (create_tree_if_local and
 
418
            isinstance(target_transport, local.LocalTransport) and
 
419
            (result_repo is None or result_repo.make_working_trees())):
 
420
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
 
421
                hardlink=hardlink, from_branch=result_branch)
 
422
            wt.lock_write()
 
423
            try:
 
424
                if wt.path2id('') is None:
 
425
                    try:
 
426
                        wt.set_root_id(self.open_workingtree.get_root_id())
 
427
                    except errors.NoWorkingTree:
 
428
                        pass
 
429
            finally:
 
430
                wt.unlock()
 
431
        else:
 
432
            wt = None
 
433
        if recurse == 'down':
 
434
            basis = None
 
435
            if wt is not None:
 
436
                basis = wt.basis_tree()
 
437
            elif result_branch is not None:
 
438
                basis = result_branch.basis_tree()
 
439
            elif source_branch is not None:
 
440
                basis = source_branch.basis_tree()
 
441
            if basis is not None:
 
442
                add_cleanup(basis.lock_read().unlock)
 
443
                subtrees = basis.iter_references()
 
444
            else:
 
445
                subtrees = []
 
446
            for path, file_id in subtrees:
 
447
                target = urlutils.join(url, urlutils.escape(path))
 
448
                sublocation = source_branch.reference_parent(file_id, path)
 
449
                sublocation.bzrdir.sprout(target,
 
450
                    basis.get_reference_revision(file_id, path),
 
451
                    force_new_repo=force_new_repo, recurse=recurse,
 
452
                    stacked=stacked)
 
453
        return result
 
454
 
 
455
    @deprecated_method(deprecated_in((2, 3, 0)))
 
456
    def generate_backup_name(self, base):
 
457
        return self._available_backup_name(base)
 
458
 
 
459
    def _available_backup_name(self, base):
 
460
        """Find a non-existing backup file name based on base.
 
461
 
 
462
        See bzrlib.osutils.available_backup_name about race conditions.
 
463
        """
 
464
        return osutils.available_backup_name(base, self.root_transport.has)
563
465
 
564
466
    def backup_bzrdir(self):
565
467
        """Backup this bzr control directory.
566
468
 
567
469
        :return: Tuple with old path name and new path name
568
470
        """
 
471
 
569
472
        pb = ui.ui_factory.nested_progress_bar()
570
473
        try:
571
 
            # FIXME: bug 300001 -- the backup fails if the backup directory
572
 
            # already exists, but it should instead either remove it or make
573
 
            # a new backup directory.
574
 
            #
575
 
            # FIXME: bug 262450 -- the backup directory should have the same
576
 
            # permissions as the .bzr directory (probably a bug in copy_tree)
577
474
            old_path = self.root_transport.abspath('.bzr')
578
 
            new_path = self.root_transport.abspath('backup.bzr')
579
 
            pb.note('making backup of %s' % (old_path,))
580
 
            pb.note('  to %s' % (new_path,))
581
 
            self.root_transport.copy_tree('.bzr', 'backup.bzr')
 
475
            backup_dir = self._available_backup_name('backup.bzr')
 
476
            new_path = self.root_transport.abspath(backup_dir)
 
477
            ui.ui_factory.note(gettext('making backup of {0}\n  to {1}').format(
 
478
                urlutils.unescape_for_display(old_path, 'utf-8'),
 
479
                urlutils.unescape_for_display(new_path, 'utf-8')))
 
480
            self.root_transport.copy_tree('.bzr', backup_dir)
582
481
            return (old_path, new_path)
583
482
        finally:
584
483
            pb.finished()
598
497
            try:
599
498
                to_path = '.bzr.retired.%d' % i
600
499
                self.root_transport.rename('.bzr', to_path)
601
 
                note("renamed %s to %s"
602
 
                    % (self.root_transport.abspath('.bzr'), to_path))
 
500
                note(gettext("renamed {0} to {1}").format(
 
501
                    self.root_transport.abspath('.bzr'), to_path))
603
502
                return
604
503
            except (errors.TransportError, IOError, errors.PathError):
605
504
                i += 1
608
507
                else:
609
508
                    pass
610
509
 
611
 
    def destroy_workingtree(self):
612
 
        """Destroy the working tree at this BzrDir.
613
 
 
614
 
        Formats that do not support this may raise UnsupportedOperation.
615
 
        """
616
 
        raise NotImplementedError(self.destroy_workingtree)
617
 
 
618
 
    def destroy_workingtree_metadata(self):
619
 
        """Destroy the control files for the working tree at this BzrDir.
620
 
 
621
 
        The contents of working tree files are not affected.
622
 
        Formats that do not support this may raise UnsupportedOperation.
623
 
        """
624
 
        raise NotImplementedError(self.destroy_workingtree_metadata)
625
 
 
626
510
    def _find_containing(self, evaluate):
627
511
        """Find something in a containing control directory.
628
512
 
642
526
            if stop:
643
527
                return result
644
528
            next_transport = found_bzrdir.root_transport.clone('..')
645
 
            if (found_bzrdir.root_transport.base == next_transport.base):
 
529
            if (found_bzrdir.user_url == next_transport.base):
646
530
                # top of the file system
647
531
                return None
648
532
            # find the next containing bzrdir
649
533
            try:
650
 
                found_bzrdir = BzrDir.open_containing_from_transport(
 
534
                found_bzrdir = self.open_containing_from_transport(
651
535
                    next_transport)[0]
652
536
            except errors.NotBranchError:
653
537
                return None
665
549
                repository = found_bzrdir.open_repository()
666
550
            except errors.NoRepositoryPresent:
667
551
                return None, False
668
 
            if found_bzrdir.root_transport.base == self.root_transport.base:
 
552
            if found_bzrdir.user_url == self.user_url:
669
553
                return repository, True
670
554
            elif repository.is_shared():
671
555
                return repository, True
677
561
            raise errors.NoRepositoryPresent(self)
678
562
        return found_repo
679
563
 
680
 
    def get_branch_reference(self):
681
 
        """Return the referenced URL for the branch in this bzrdir.
682
 
 
683
 
        :raises NotBranchError: If there is no Branch.
684
 
        :return: The URL the branch in this bzrdir references if it is a
685
 
            reference branch, or None for regular branches.
686
 
        """
687
 
        return None
688
 
 
689
 
    def get_branch_transport(self, branch_format):
690
 
        """Get the transport for use by branch format in this BzrDir.
691
 
 
692
 
        Note that bzr dirs that do not support format strings will raise
693
 
        IncompatibleFormat if the branch format they are given has
694
 
        a format string, and vice versa.
695
 
 
696
 
        If branch_format is None, the transport is returned with no
697
 
        checking. If it is not None, then the returned transport is
698
 
        guaranteed to point to an existing directory ready for use.
699
 
        """
700
 
        raise NotImplementedError(self.get_branch_transport)
701
 
 
702
564
    def _find_creation_modes(self):
703
565
        """Determine the appropriate modes for files and directories.
704
566
 
743
605
            self._find_creation_modes()
744
606
        return self._dir_mode
745
607
 
746
 
    def get_repository_transport(self, repository_format):
747
 
        """Get the transport for use by repository format in this BzrDir.
748
 
 
749
 
        Note that bzr dirs that do not support format strings will raise
750
 
        IncompatibleFormat if the repository format they are given has
751
 
        a format string, and vice versa.
752
 
 
753
 
        If repository_format is None, the transport is returned with no
754
 
        checking. If it is not None, then the returned transport is
755
 
        guaranteed to point to an existing directory ready for use.
756
 
        """
757
 
        raise NotImplementedError(self.get_repository_transport)
758
 
 
759
 
    def get_workingtree_transport(self, tree_format):
760
 
        """Get the transport for use by workingtree format in this BzrDir.
761
 
 
762
 
        Note that bzr dirs that do not support format strings will raise
763
 
        IncompatibleFormat if the workingtree format they are given has a
764
 
        format string, and vice versa.
765
 
 
766
 
        If workingtree_format is None, the transport is returned with no
767
 
        checking. If it is not None, then the returned transport is
768
 
        guaranteed to point to an existing directory ready for use.
769
 
        """
770
 
        raise NotImplementedError(self.get_workingtree_transport)
771
 
 
772
608
    def get_config(self):
773
609
        """Get configuration for this BzrDir."""
774
610
        return config.BzrDirConfig(self)
787
623
        :param _transport: the transport this dir is based at.
788
624
        """
789
625
        self._format = _format
 
626
        # these are also under the more standard names of 
 
627
        # control_transport and user_transport
790
628
        self.transport = _transport.clone('.bzr')
791
629
        self.root_transport = _transport
792
630
        self._mode_check_done = False
793
631
 
 
632
    @property 
 
633
    def user_transport(self):
 
634
        return self.root_transport
 
635
 
 
636
    @property
 
637
    def control_transport(self):
 
638
        return self.transport
 
639
 
794
640
    def is_control_filename(self, filename):
795
641
        """True if filename is the name of a path which is reserved for bzrdir's.
796
642
 
798
644
 
799
645
        This is true IF and ONLY IF the filename is part of the namespace reserved
800
646
        for bzr control dirs. Currently this is the '.bzr' directory in the root
801
 
        of the root_transport. it is expected that plugins will need to extend
802
 
        this in the future - for instance to make bzr talk with svn working
803
 
        trees.
 
647
        of the root_transport. 
804
648
        """
805
649
        # this might be better on the BzrDirFormat class because it refers to
806
650
        # all the possible bzrdir disk formats.
810
654
        # add new tests for it to the appropriate place.
811
655
        return filename == '.bzr' or filename.startswith('.bzr/')
812
656
 
813
 
    def needs_format_conversion(self, format=None):
814
 
        """Return true if this bzrdir needs convert_format run on it.
815
 
 
816
 
        For instance, if the repository format is out of date but the
817
 
        branch and working tree are not, this should return True.
818
 
 
819
 
        :param format: Optional parameter indicating a specific desired
820
 
                       format we plan to arrive at.
821
 
        """
822
 
        raise NotImplementedError(self.needs_format_conversion)
823
 
 
824
 
    @staticmethod
825
 
    def open_unsupported(base):
826
 
        """Open a branch which is not supported."""
827
 
        return BzrDir.open(base, _unsupported=True)
828
 
 
829
 
    @staticmethod
830
 
    def open(base, _unsupported=False, possible_transports=None):
831
 
        """Open an existing bzrdir, rooted at 'base' (url).
832
 
 
833
 
        :param _unsupported: a private parameter to the BzrDir class.
834
 
        """
835
 
        t = get_transport(base, possible_transports=possible_transports)
836
 
        return BzrDir.open_from_transport(t, _unsupported=_unsupported)
837
 
 
838
 
    @staticmethod
839
 
    def open_from_transport(transport, _unsupported=False,
840
 
                            _server_formats=True):
841
 
        """Open a bzrdir within a particular directory.
842
 
 
843
 
        :param transport: Transport containing the bzrdir.
844
 
        :param _unsupported: private.
845
 
        """
846
 
        for hook in BzrDir.hooks['pre_open']:
847
 
            hook(transport)
848
 
        # Keep initial base since 'transport' may be modified while following
849
 
        # the redirections.
850
 
        base = transport.base
851
 
        def find_format(transport):
852
 
            return transport, BzrDirFormat.find_format(
853
 
                transport, _server_formats=_server_formats)
854
 
 
855
 
        def redirected(transport, e, redirection_notice):
856
 
            redirected_transport = transport._redirected_to(e.source, e.target)
857
 
            if redirected_transport is None:
858
 
                raise errors.NotBranchError(base)
859
 
            note('%s is%s redirected to %s',
860
 
                 transport.base, e.permanently, redirected_transport.base)
861
 
            return redirected_transport
862
 
 
863
 
        try:
864
 
            transport, format = do_catching_redirections(find_format,
865
 
                                                         transport,
866
 
                                                         redirected)
867
 
        except errors.TooManyRedirections:
868
 
            raise errors.NotBranchError(base)
869
 
 
870
 
        BzrDir._check_supported(format, _unsupported)
871
 
        return format.open(transport, _found=True)
872
 
 
873
 
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
874
 
        """Open the branch object at this BzrDir if one is present.
875
 
 
876
 
        If unsupported is True, then no longer supported branch formats can
877
 
        still be opened.
878
 
 
879
 
        TODO: static convenience version of this?
880
 
        """
881
 
        raise NotImplementedError(self.open_branch)
882
 
 
883
 
    @staticmethod
884
 
    def open_containing(url, possible_transports=None):
885
 
        """Open an existing branch which contains url.
886
 
 
887
 
        :param url: url to search from.
888
 
        See open_containing_from_transport for more detail.
889
 
        """
890
 
        transport = get_transport(url, possible_transports)
891
 
        return BzrDir.open_containing_from_transport(transport)
892
 
 
893
 
    @staticmethod
894
 
    def open_containing_from_transport(a_transport):
895
 
        """Open an existing branch which contains a_transport.base.
896
 
 
897
 
        This probes for a branch at a_transport, and searches upwards from there.
898
 
 
899
 
        Basically we keep looking up until we find the control directory or
900
 
        run into the root.  If there isn't one, raises NotBranchError.
901
 
        If there is one and it is either an unrecognised format or an unsupported
902
 
        format, UnknownFormatError or UnsupportedFormatError are raised.
903
 
        If there is one, it is returned, along with the unused portion of url.
904
 
 
905
 
        :return: The BzrDir that contains the path, and a Unicode path
906
 
                for the rest of the URL.
907
 
        """
908
 
        # this gets the normalised url back. I.e. '.' -> the full path.
909
 
        url = a_transport.base
910
 
        while True:
911
 
            try:
912
 
                result = BzrDir.open_from_transport(a_transport)
913
 
                return result, urlutils.unescape(a_transport.relpath(url))
914
 
            except errors.NotBranchError, e:
915
 
                pass
916
 
            try:
917
 
                new_t = a_transport.clone('..')
918
 
            except errors.InvalidURLJoin:
919
 
                # reached the root, whatever that may be
920
 
                raise errors.NotBranchError(path=url)
921
 
            if new_t.base == a_transport.base:
922
 
                # reached the root, whatever that may be
923
 
                raise errors.NotBranchError(path=url)
924
 
            a_transport = new_t
925
 
 
926
 
    def _get_tree_branch(self):
927
 
        """Return the branch and tree, if any, for this bzrdir.
928
 
 
929
 
        Return None for tree if not present or inaccessible.
930
 
        Raise NotBranchError if no branch is present.
931
 
        :return: (tree, branch)
932
 
        """
933
 
        try:
934
 
            tree = self.open_workingtree()
935
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
936
 
            tree = None
937
 
            branch = self.open_branch()
938
 
        else:
939
 
            branch = tree.branch
940
 
        return tree, branch
941
 
 
942
 
    @classmethod
943
 
    def open_tree_or_branch(klass, location):
944
 
        """Return the branch and working tree at a location.
945
 
 
946
 
        If there is no tree at the location, tree will be None.
947
 
        If there is no branch at the location, an exception will be
948
 
        raised
949
 
        :return: (tree, branch)
950
 
        """
951
 
        bzrdir = klass.open(location)
952
 
        return bzrdir._get_tree_branch()
953
 
 
954
 
    @classmethod
955
 
    def open_containing_tree_or_branch(klass, location):
956
 
        """Return the branch and working tree contained by a location.
957
 
 
958
 
        Returns (tree, branch, relpath).
959
 
        If there is no tree at containing the location, tree will be None.
960
 
        If there is no branch containing the location, an exception will be
961
 
        raised
962
 
        relpath is the portion of the path that is contained by the branch.
963
 
        """
964
 
        bzrdir, relpath = klass.open_containing(location)
965
 
        tree, branch = bzrdir._get_tree_branch()
966
 
        return tree, branch, relpath
967
 
 
968
 
    @classmethod
969
 
    def open_containing_tree_branch_or_repository(klass, location):
970
 
        """Return the working tree, branch and repo contained by a location.
971
 
 
972
 
        Returns (tree, branch, repository, relpath).
973
 
        If there is no tree containing the location, tree will be None.
974
 
        If there is no branch containing the location, branch will be None.
975
 
        If there is no repository containing the location, repository will be
976
 
        None.
977
 
        relpath is the portion of the path that is contained by the innermost
978
 
        BzrDir.
979
 
 
980
 
        If no tree, branch or repository is found, a NotBranchError is raised.
981
 
        """
982
 
        bzrdir, relpath = klass.open_containing(location)
983
 
        try:
984
 
            tree, branch = bzrdir._get_tree_branch()
985
 
        except errors.NotBranchError:
986
 
            try:
987
 
                repo = bzrdir.find_repository()
988
 
                return None, None, repo, relpath
989
 
            except (errors.NoRepositoryPresent):
990
 
                raise errors.NotBranchError(location)
991
 
        return tree, branch, branch.repository, relpath
992
 
 
993
 
    def open_repository(self, _unsupported=False):
994
 
        """Open the repository object at this BzrDir if one is present.
995
 
 
996
 
        This will not follow the Branch object pointer - it's strictly a direct
997
 
        open facility. Most client code should use open_branch().repository to
998
 
        get at a repository.
999
 
 
1000
 
        :param _unsupported: a private parameter, not part of the api.
1001
 
        TODO: static convenience version of this?
1002
 
        """
1003
 
        raise NotImplementedError(self.open_repository)
1004
 
 
1005
 
    def open_workingtree(self, _unsupported=False,
1006
 
                         recommend_upgrade=True, from_branch=None):
1007
 
        """Open the workingtree object at this BzrDir if one is present.
1008
 
 
1009
 
        :param recommend_upgrade: Optional keyword parameter, when True (the
1010
 
            default), emit through the ui module a recommendation that the user
1011
 
            upgrade the working tree when the workingtree being opened is old
1012
 
            (but still fully supported).
1013
 
        :param from_branch: override bzrdir branch (for lightweight checkouts)
1014
 
        """
1015
 
        raise NotImplementedError(self.open_workingtree)
1016
 
 
1017
 
    def has_branch(self):
1018
 
        """Tell if this bzrdir contains a branch.
1019
 
 
1020
 
        Note: if you're going to open the branch, you should just go ahead
1021
 
        and try, and not ask permission first.  (This method just opens the
1022
 
        branch and discards it, and that's somewhat expensive.)
1023
 
        """
1024
 
        try:
1025
 
            self.open_branch()
1026
 
            return True
1027
 
        except errors.NotBranchError:
1028
 
            return False
1029
 
 
1030
 
    def has_workingtree(self):
1031
 
        """Tell if this bzrdir contains a working tree.
1032
 
 
1033
 
        This will still raise an exception if the bzrdir has a workingtree that
1034
 
        is remote & inaccessible.
1035
 
 
1036
 
        Note: if you're going to open the working tree, you should just go ahead
1037
 
        and try, and not ask permission first.  (This method just opens the
1038
 
        workingtree and discards it, and that's somewhat expensive.)
1039
 
        """
1040
 
        try:
1041
 
            self.open_workingtree(recommend_upgrade=False)
1042
 
            return True
1043
 
        except errors.NoWorkingTree:
1044
 
            return False
1045
 
 
1046
657
    def _cloning_metadir(self):
1047
658
        """Produce a metadir suitable for cloning with.
1048
659
 
1088
699
 
1089
700
        :require_stacking: If True, non-stackable formats will be upgraded
1090
701
            to similar stackable formats.
1091
 
        :returns: a BzrDirFormat with all component formats either set
 
702
        :returns: a ControlDirFormat with all component formats either set
1092
703
            appropriately or set to None if that component should not be
1093
704
            created.
1094
705
        """
1106
717
            format.require_stacking()
1107
718
        return format
1108
719
 
1109
 
    def checkout_metadir(self):
1110
 
        return self.cloning_metadir()
1111
 
 
1112
 
    def sprout(self, url, revision_id=None, force_new_repo=False,
1113
 
               recurse='down', possible_transports=None,
1114
 
               accelerator_tree=None, hardlink=False, stacked=False,
1115
 
               source_branch=None, create_tree_if_local=True):
1116
 
        """Create a copy of this bzrdir prepared for use as a new line of
1117
 
        development.
1118
 
 
1119
 
        If url's last component does not exist, it will be created.
1120
 
 
1121
 
        Attributes related to the identity of the source branch like
1122
 
        branch nickname will be cleaned, a working tree is created
1123
 
        whether one existed before or not; and a local branch is always
1124
 
        created.
1125
 
 
1126
 
        if revision_id is not None, then the clone operation may tune
1127
 
            itself to download less data.
1128
 
        :param accelerator_tree: A tree which can be used for retrieving file
1129
 
            contents more quickly than the revision tree, i.e. a workingtree.
1130
 
            The revision tree will be used for cases where accelerator_tree's
1131
 
            content is different.
1132
 
        :param hardlink: If true, hard-link files from accelerator_tree,
1133
 
            where possible.
1134
 
        :param stacked: If true, create a stacked branch referring to the
1135
 
            location of this control directory.
1136
 
        :param create_tree_if_local: If true, a working-tree will be created
1137
 
            when working locally.
1138
 
        """
1139
 
        target_transport = get_transport(url, possible_transports)
1140
 
        target_transport.ensure_base()
1141
 
        cloning_format = self.cloning_metadir(stacked)
1142
 
        # Create/update the result branch
1143
 
        result = cloning_format.initialize_on_transport(target_transport)
1144
 
        # if a stacked branch wasn't requested, we don't create one
1145
 
        # even if the origin was stacked
1146
 
        stacked_branch_url = None
1147
 
        if source_branch is not None:
1148
 
            if stacked:
1149
 
                stacked_branch_url = self.root_transport.base
1150
 
            source_repository = source_branch.repository
1151
 
        else:
1152
 
            try:
1153
 
                source_branch = self.open_branch()
1154
 
                source_repository = source_branch.repository
1155
 
                if stacked:
1156
 
                    stacked_branch_url = self.root_transport.base
1157
 
            except errors.NotBranchError:
1158
 
                source_branch = None
1159
 
                try:
1160
 
                    source_repository = self.open_repository()
1161
 
                except errors.NoRepositoryPresent:
1162
 
                    source_repository = None
1163
 
        repository_policy = result.determine_repository_policy(
1164
 
            force_new_repo, stacked_branch_url, require_stacking=stacked)
1165
 
        result_repo, is_new_repo = repository_policy.acquire_repository()
1166
 
        if is_new_repo and revision_id is not None and not stacked:
1167
 
            fetch_spec = graph.PendingAncestryResult(
1168
 
                [revision_id], source_repository)
1169
 
        else:
1170
 
            fetch_spec = None
1171
 
        if source_repository is not None:
1172
 
            # Fetch while stacked to prevent unstacked fetch from
1173
 
            # Branch.sprout.
1174
 
            if fetch_spec is None:
1175
 
                result_repo.fetch(source_repository, revision_id=revision_id)
1176
 
            else:
1177
 
                result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1178
 
 
1179
 
        if source_branch is None:
1180
 
            # this is for sprouting a bzrdir without a branch; is that
1181
 
            # actually useful?
1182
 
            # Not especially, but it's part of the contract.
1183
 
            result_branch = result.create_branch()
1184
 
        else:
1185
 
            result_branch = source_branch.sprout(result,
1186
 
                revision_id=revision_id, repository_policy=repository_policy)
1187
 
        mutter("created new branch %r" % (result_branch,))
1188
 
 
1189
 
        # Create/update the result working tree
1190
 
        if (create_tree_if_local and
1191
 
            isinstance(target_transport, local.LocalTransport) and
1192
 
            (result_repo is None or result_repo.make_working_trees())):
1193
 
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1194
 
                hardlink=hardlink)
1195
 
            wt.lock_write()
1196
 
            try:
1197
 
                if wt.path2id('') is None:
1198
 
                    try:
1199
 
                        wt.set_root_id(self.open_workingtree.get_root_id())
1200
 
                    except errors.NoWorkingTree:
1201
 
                        pass
1202
 
            finally:
1203
 
                wt.unlock()
1204
 
        else:
1205
 
            wt = None
1206
 
        if recurse == 'down':
1207
 
            if wt is not None:
1208
 
                basis = wt.basis_tree()
1209
 
                basis.lock_read()
1210
 
                subtrees = basis.iter_references()
1211
 
            elif result_branch is not None:
1212
 
                basis = result_branch.basis_tree()
1213
 
                basis.lock_read()
1214
 
                subtrees = basis.iter_references()
1215
 
            elif source_branch is not None:
1216
 
                basis = source_branch.basis_tree()
1217
 
                basis.lock_read()
1218
 
                subtrees = basis.iter_references()
1219
 
            else:
1220
 
                subtrees = []
1221
 
                basis = None
1222
 
            try:
1223
 
                for path, file_id in subtrees:
1224
 
                    target = urlutils.join(url, urlutils.escape(path))
1225
 
                    sublocation = source_branch.reference_parent(file_id, path)
1226
 
                    sublocation.bzrdir.sprout(target,
1227
 
                        basis.get_reference_revision(file_id, path),
1228
 
                        force_new_repo=force_new_repo, recurse=recurse,
1229
 
                        stacked=stacked)
1230
 
            finally:
1231
 
                if basis is not None:
1232
 
                    basis.unlock()
1233
 
        return result
1234
 
 
1235
 
    def push_branch(self, source, revision_id=None, overwrite=False, 
1236
 
        remember=False, create_prefix=False):
1237
 
        """Push the source branch into this BzrDir."""
1238
 
        br_to = None
1239
 
        # If we can open a branch, use its direct repository, otherwise see
1240
 
        # if there is a repository without a branch.
1241
 
        try:
1242
 
            br_to = self.open_branch()
1243
 
        except errors.NotBranchError:
1244
 
            # Didn't find a branch, can we find a repository?
1245
 
            repository_to = self.find_repository()
1246
 
        else:
1247
 
            # Found a branch, so we must have found a repository
1248
 
            repository_to = br_to.repository
1249
 
 
1250
 
        push_result = PushResult()
1251
 
        push_result.source_branch = source
1252
 
        if br_to is None:
1253
 
            # We have a repository but no branch, copy the revisions, and then
1254
 
            # create a branch.
1255
 
            repository_to.fetch(source.repository, revision_id=revision_id)
1256
 
            br_to = source.clone(self, revision_id=revision_id)
1257
 
            if source.get_push_location() is None or remember:
1258
 
                source.set_push_location(br_to.base)
1259
 
            push_result.stacked_on = None
1260
 
            push_result.branch_push_result = None
1261
 
            push_result.old_revno = None
1262
 
            push_result.old_revid = _mod_revision.NULL_REVISION
1263
 
            push_result.target_branch = br_to
1264
 
            push_result.master_branch = None
1265
 
            push_result.workingtree_updated = False
1266
 
        else:
1267
 
            # We have successfully opened the branch, remember if necessary:
1268
 
            if source.get_push_location() is None or remember:
1269
 
                source.set_push_location(br_to.base)
1270
 
            try:
1271
 
                tree_to = self.open_workingtree()
1272
 
            except errors.NotLocalUrl:
1273
 
                push_result.branch_push_result = source.push(br_to, 
1274
 
                    overwrite, stop_revision=revision_id)
1275
 
                push_result.workingtree_updated = False
1276
 
            except errors.NoWorkingTree:
1277
 
                push_result.branch_push_result = source.push(br_to,
1278
 
                    overwrite, stop_revision=revision_id)
1279
 
                push_result.workingtree_updated = None # Not applicable
1280
 
            else:
1281
 
                tree_to.lock_write()
1282
 
                try:
1283
 
                    push_result.branch_push_result = source.push(
1284
 
                        tree_to.branch, overwrite, stop_revision=revision_id)
1285
 
                    tree_to.update()
1286
 
                finally:
1287
 
                    tree_to.unlock()
1288
 
                push_result.workingtree_updated = True
1289
 
            push_result.old_revno = push_result.branch_push_result.old_revno
1290
 
            push_result.old_revid = push_result.branch_push_result.old_revid
1291
 
            push_result.target_branch = \
1292
 
                push_result.branch_push_result.target_branch
1293
 
        return push_result
1294
 
 
1295
 
 
1296
 
class BzrDirHooks(hooks.Hooks):
1297
 
    """Hooks for BzrDir operations."""
1298
 
 
1299
 
    def __init__(self):
1300
 
        """Create the default hooks."""
1301
 
        hooks.Hooks.__init__(self)
1302
 
        self.create_hook(hooks.HookPoint('pre_open',
1303
 
            "Invoked before attempting to open a BzrDir with the transport "
1304
 
            "that the open will use.", (1, 14), None))
1305
 
 
1306
 
# install the default hooks
1307
 
BzrDir.hooks = BzrDirHooks()
1308
 
 
1309
 
 
1310
 
class BzrDirPreSplitOut(BzrDir):
1311
 
    """A common class for the all-in-one formats."""
1312
 
 
1313
 
    def __init__(self, _transport, _format):
1314
 
        """See BzrDir.__init__."""
1315
 
        super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1316
 
        self._control_files = lockable_files.LockableFiles(
1317
 
                                            self.get_branch_transport(None),
1318
 
                                            self._format._lock_file_name,
1319
 
                                            self._format._lock_class)
1320
 
 
1321
 
    def break_lock(self):
1322
 
        """Pre-splitout bzrdirs do not suffer from stale locks."""
1323
 
        raise NotImplementedError(self.break_lock)
1324
 
 
1325
 
    def cloning_metadir(self, require_stacking=False):
1326
 
        """Produce a metadir suitable for cloning with."""
1327
 
        if require_stacking:
1328
 
            return format_registry.make_bzrdir('1.6')
1329
 
        return self._format.__class__()
1330
 
 
1331
 
    def clone(self, url, revision_id=None, force_new_repo=False,
1332
 
              preserve_stacking=False):
1333
 
        """See BzrDir.clone().
1334
 
 
1335
 
        force_new_repo has no effect, since this family of formats always
1336
 
        require a new repository.
1337
 
        preserve_stacking has no effect, since no source branch using this
1338
 
        family of formats can be stacked, so there is no stacking to preserve.
1339
 
        """
1340
 
        self._make_tail(url)
1341
 
        result = self._format._initialize_for_clone(url)
1342
 
        self.open_repository().clone(result, revision_id=revision_id)
1343
 
        from_branch = self.open_branch()
1344
 
        from_branch.clone(result, revision_id=revision_id)
1345
 
        try:
1346
 
            tree = self.open_workingtree()
1347
 
        except errors.NotLocalUrl:
1348
 
            # make a new one, this format always has to have one.
1349
 
            result._init_workingtree()
1350
 
        else:
1351
 
            tree.clone(result)
1352
 
        return result
1353
 
 
1354
 
    def create_branch(self):
1355
 
        """See BzrDir.create_branch."""
1356
 
        return self._format.get_branch_format().initialize(self)
1357
 
 
1358
 
    def destroy_branch(self):
1359
 
        """See BzrDir.destroy_branch."""
1360
 
        raise errors.UnsupportedOperation(self.destroy_branch, self)
1361
 
 
1362
 
    def create_repository(self, shared=False):
1363
 
        """See BzrDir.create_repository."""
1364
 
        if shared:
1365
 
            raise errors.IncompatibleFormat('shared repository', self._format)
1366
 
        return self.open_repository()
1367
 
 
1368
 
    def destroy_repository(self):
1369
 
        """See BzrDir.destroy_repository."""
1370
 
        raise errors.UnsupportedOperation(self.destroy_repository, self)
1371
 
 
1372
 
    def create_workingtree(self, revision_id=None, from_branch=None,
1373
 
                           accelerator_tree=None, hardlink=False):
1374
 
        """See BzrDir.create_workingtree."""
1375
 
        # The workingtree is sometimes created when the bzrdir is created,
1376
 
        # but not when cloning.
1377
 
 
1378
 
        # this looks buggy but is not -really-
1379
 
        # because this format creates the workingtree when the bzrdir is
1380
 
        # created
1381
 
        # clone and sprout will have set the revision_id
1382
 
        # and that will have set it for us, its only
1383
 
        # specific uses of create_workingtree in isolation
1384
 
        # that can do wonky stuff here, and that only
1385
 
        # happens for creating checkouts, which cannot be
1386
 
        # done on this format anyway. So - acceptable wart.
1387
 
        try:
1388
 
            result = self.open_workingtree(recommend_upgrade=False)
1389
 
        except errors.NoSuchFile:
1390
 
            result = self._init_workingtree()
1391
 
        if revision_id is not None:
1392
 
            if revision_id == _mod_revision.NULL_REVISION:
1393
 
                result.set_parent_ids([])
1394
 
            else:
1395
 
                result.set_parent_ids([revision_id])
1396
 
        return result
1397
 
 
1398
 
    def _init_workingtree(self):
1399
 
        from bzrlib.workingtree import WorkingTreeFormat2
1400
 
        try:
1401
 
            return WorkingTreeFormat2().initialize(self)
1402
 
        except errors.NotLocalUrl:
1403
 
            # Even though we can't access the working tree, we need to
1404
 
            # create its control files.
1405
 
            return WorkingTreeFormat2()._stub_initialize_on_transport(
1406
 
                self.transport, self._control_files._file_mode)
1407
 
 
1408
 
    def destroy_workingtree(self):
1409
 
        """See BzrDir.destroy_workingtree."""
1410
 
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1411
 
 
1412
 
    def destroy_workingtree_metadata(self):
1413
 
        """See BzrDir.destroy_workingtree_metadata."""
1414
 
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1415
 
                                          self)
1416
 
 
1417
 
    def get_branch_transport(self, branch_format):
1418
 
        """See BzrDir.get_branch_transport()."""
1419
 
        if branch_format is None:
1420
 
            return self.transport
1421
 
        try:
1422
 
            branch_format.get_format_string()
1423
 
        except NotImplementedError:
1424
 
            return self.transport
1425
 
        raise errors.IncompatibleFormat(branch_format, self._format)
 
720
    def get_branch_transport(self, branch_format, name=None):
 
721
        """Get the transport for use by branch format in this BzrDir.
 
722
 
 
723
        Note that bzr dirs that do not support format strings will raise
 
724
        IncompatibleFormat if the branch format they are given has
 
725
        a format string, and vice versa.
 
726
 
 
727
        If branch_format is None, the transport is returned with no
 
728
        checking. If it is not None, then the returned transport is
 
729
        guaranteed to point to an existing directory ready for use.
 
730
        """
 
731
        raise NotImplementedError(self.get_branch_transport)
1426
732
 
1427
733
    def get_repository_transport(self, repository_format):
1428
 
        """See BzrDir.get_repository_transport()."""
1429
 
        if repository_format is None:
1430
 
            return self.transport
1431
 
        try:
1432
 
            repository_format.get_format_string()
1433
 
        except NotImplementedError:
1434
 
            return self.transport
1435
 
        raise errors.IncompatibleFormat(repository_format, self._format)
1436
 
 
1437
 
    def get_workingtree_transport(self, workingtree_format):
1438
 
        """See BzrDir.get_workingtree_transport()."""
1439
 
        if workingtree_format is None:
1440
 
            return self.transport
1441
 
        try:
1442
 
            workingtree_format.get_format_string()
1443
 
        except NotImplementedError:
1444
 
            return self.transport
1445
 
        raise errors.IncompatibleFormat(workingtree_format, self._format)
1446
 
 
1447
 
    def needs_format_conversion(self, format=None):
1448
 
        """See BzrDir.needs_format_conversion()."""
1449
 
        # if the format is not the same as the system default,
1450
 
        # an upgrade is needed.
1451
 
        if format is None:
1452
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1453
 
                % 'needs_format_conversion(format=None)')
1454
 
            format = BzrDirFormat.get_default_format()
1455
 
        return not isinstance(self._format, format.__class__)
1456
 
 
1457
 
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
1458
 
        """See BzrDir.open_branch."""
1459
 
        from bzrlib.branch import BzrBranchFormat4
1460
 
        format = BzrBranchFormat4()
1461
 
        self._check_supported(format, unsupported)
1462
 
        return format.open(self, _found=True)
1463
 
 
1464
 
    def sprout(self, url, revision_id=None, force_new_repo=False,
1465
 
               possible_transports=None, accelerator_tree=None,
1466
 
               hardlink=False, stacked=False, create_tree_if_local=True,
1467
 
               source_branch=None):
1468
 
        """See BzrDir.sprout()."""
1469
 
        if source_branch is not None:
1470
 
            my_branch = self.open_branch()
1471
 
            if source_branch.base != my_branch.base:
1472
 
                raise AssertionError(
1473
 
                    "source branch %r is not within %r with branch %r" %
1474
 
                    (source_branch, self, my_branch))
1475
 
        if stacked:
1476
 
            raise errors.UnstackableBranchFormat(
1477
 
                self._format, self.root_transport.base)
1478
 
        if not create_tree_if_local:
1479
 
            raise errors.MustHaveWorkingTree(
1480
 
                self._format, self.root_transport.base)
1481
 
        from bzrlib.workingtree import WorkingTreeFormat2
1482
 
        self._make_tail(url)
1483
 
        result = self._format._initialize_for_clone(url)
1484
 
        try:
1485
 
            self.open_repository().clone(result, revision_id=revision_id)
1486
 
        except errors.NoRepositoryPresent:
1487
 
            pass
1488
 
        try:
1489
 
            self.open_branch().sprout(result, revision_id=revision_id)
1490
 
        except errors.NotBranchError:
1491
 
            pass
1492
 
 
1493
 
        # we always want a working tree
1494
 
        WorkingTreeFormat2().initialize(result,
1495
 
                                        accelerator_tree=accelerator_tree,
1496
 
                                        hardlink=hardlink)
1497
 
        return result
1498
 
 
1499
 
 
1500
 
class BzrDir4(BzrDirPreSplitOut):
1501
 
    """A .bzr version 4 control object.
1502
 
 
1503
 
    This is a deprecated format and may be removed after sept 2006.
1504
 
    """
1505
 
 
1506
 
    def create_repository(self, shared=False):
1507
 
        """See BzrDir.create_repository."""
1508
 
        return self._format.repository_format.initialize(self, shared)
1509
 
 
1510
 
    def needs_format_conversion(self, format=None):
1511
 
        """Format 4 dirs are always in need of conversion."""
1512
 
        if format is None:
1513
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1514
 
                % 'needs_format_conversion(format=None)')
1515
 
        return True
1516
 
 
1517
 
    def open_repository(self):
1518
 
        """See BzrDir.open_repository."""
1519
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
1520
 
        return RepositoryFormat4().open(self, _found=True)
1521
 
 
1522
 
 
1523
 
class BzrDir5(BzrDirPreSplitOut):
1524
 
    """A .bzr version 5 control object.
1525
 
 
1526
 
    This is a deprecated format and may be removed after sept 2006.
1527
 
    """
1528
 
 
1529
 
    def open_repository(self):
1530
 
        """See BzrDir.open_repository."""
1531
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1532
 
        return RepositoryFormat5().open(self, _found=True)
1533
 
 
1534
 
    def open_workingtree(self, _unsupported=False,
1535
 
            recommend_upgrade=True):
1536
 
        """See BzrDir.create_workingtree."""
1537
 
        from bzrlib.workingtree import WorkingTreeFormat2
1538
 
        wt_format = WorkingTreeFormat2()
1539
 
        # we don't warn here about upgrades; that ought to be handled for the
1540
 
        # bzrdir as a whole
1541
 
        return wt_format.open(self, _found=True)
1542
 
 
1543
 
 
1544
 
class BzrDir6(BzrDirPreSplitOut):
1545
 
    """A .bzr version 6 control object.
1546
 
 
1547
 
    This is a deprecated format and may be removed after sept 2006.
1548
 
    """
1549
 
 
1550
 
    def open_repository(self):
1551
 
        """See BzrDir.open_repository."""
1552
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1553
 
        return RepositoryFormat6().open(self, _found=True)
1554
 
 
1555
 
    def open_workingtree(self, _unsupported=False,
1556
 
        recommend_upgrade=True):
1557
 
        """See BzrDir.create_workingtree."""
1558
 
        # we don't warn here about upgrades; that ought to be handled for the
1559
 
        # bzrdir as a whole
1560
 
        from bzrlib.workingtree import WorkingTreeFormat2
1561
 
        return WorkingTreeFormat2().open(self, _found=True)
 
734
        """Get the transport for use by repository format in this BzrDir.
 
735
 
 
736
        Note that bzr dirs that do not support format strings will raise
 
737
        IncompatibleFormat if the repository format they are given has
 
738
        a format string, and vice versa.
 
739
 
 
740
        If repository_format is None, the transport is returned with no
 
741
        checking. If it is not None, then the returned transport is
 
742
        guaranteed to point to an existing directory ready for use.
 
743
        """
 
744
        raise NotImplementedError(self.get_repository_transport)
 
745
 
 
746
    def get_workingtree_transport(self, tree_format):
 
747
        """Get the transport for use by workingtree format in this BzrDir.
 
748
 
 
749
        Note that bzr dirs that do not support format strings will raise
 
750
        IncompatibleFormat if the workingtree format they are given has a
 
751
        format string, and vice versa.
 
752
 
 
753
        If workingtree_format is None, the transport is returned with no
 
754
        checking. If it is not None, then the returned transport is
 
755
        guaranteed to point to an existing directory ready for use.
 
756
        """
 
757
        raise NotImplementedError(self.get_workingtree_transport)
 
758
 
 
759
    @classmethod
 
760
    def create(cls, base, format=None, possible_transports=None):
 
761
        """Create a new BzrDir at the url 'base'.
 
762
 
 
763
        :param format: If supplied, the format of branch to create.  If not
 
764
            supplied, the default is used.
 
765
        :param possible_transports: If supplied, a list of transports that
 
766
            can be reused to share a remote connection.
 
767
        """
 
768
        if cls is not BzrDir:
 
769
            raise AssertionError("BzrDir.create always creates the "
 
770
                "default format, not one of %r" % cls)
 
771
        return controldir.ControlDir.create(base, format=format,
 
772
                possible_transports=possible_transports)
1562
773
 
1563
774
 
1564
775
class BzrDirMeta1(BzrDir):
1574
785
        """See BzrDir.can_convert_format()."""
1575
786
        return True
1576
787
 
1577
 
    def create_branch(self):
 
788
    def create_branch(self, name=None, repository=None,
 
789
            append_revisions_only=None):
1578
790
        """See BzrDir.create_branch."""
1579
 
        return self._format.get_branch_format().initialize(self)
 
791
        return self._format.get_branch_format().initialize(self, name=name,
 
792
                repository=repository,
 
793
                append_revisions_only=append_revisions_only)
1580
794
 
1581
 
    def destroy_branch(self):
 
795
    def destroy_branch(self, name=None):
1582
796
        """See BzrDir.create_branch."""
 
797
        if name is not None:
 
798
            raise errors.NoColocatedBranchSupport(self)
1583
799
        self.transport.delete_tree('branch')
1584
800
 
1585
801
    def create_repository(self, shared=False):
1602
818
        wt = self.open_workingtree(recommend_upgrade=False)
1603
819
        repository = wt.branch.repository
1604
820
        empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1605
 
        wt.revert(old_tree=empty)
 
821
        # We ignore the conflicts returned by wt.revert since we're about to
 
822
        # delete the wt metadata anyway, all that should be left here are
 
823
        # detritus. But see bug #634470 about subtree .bzr dirs.
 
824
        conflicts = wt.revert(old_tree=empty)
1606
825
        self.destroy_workingtree_metadata()
1607
826
 
1608
827
    def destroy_workingtree_metadata(self):
1609
828
        self.transport.delete_tree('checkout')
1610
829
 
1611
 
    def find_branch_format(self):
 
830
    def find_branch_format(self, name=None):
1612
831
        """Find the branch 'format' for this bzrdir.
1613
832
 
1614
833
        This might be a synthetic object for e.g. RemoteBranch and SVN.
1615
834
        """
1616
835
        from bzrlib.branch import BranchFormat
1617
 
        return BranchFormat.find_format(self)
 
836
        return BranchFormat.find_format(self, name=name)
1618
837
 
1619
838
    def _get_mkdir_mode(self):
1620
839
        """Figure out the mode to use when creating a bzrdir subdir."""
1622
841
                                     lockable_files.TransportLock)
1623
842
        return temp_control._dir_mode
1624
843
 
1625
 
    def get_branch_reference(self):
 
844
    def get_branch_reference(self, name=None):
1626
845
        """See BzrDir.get_branch_reference()."""
1627
846
        from bzrlib.branch import BranchFormat
1628
 
        format = BranchFormat.find_format(self)
1629
 
        return format.get_reference(self)
 
847
        format = BranchFormat.find_format(self, name=name)
 
848
        return format.get_reference(self, name=name)
1630
849
 
1631
 
    def get_branch_transport(self, branch_format):
 
850
    def get_branch_transport(self, branch_format, name=None):
1632
851
        """See BzrDir.get_branch_transport()."""
 
852
        if name is not None:
 
853
            raise errors.NoColocatedBranchSupport(self)
 
854
        # XXX: this shouldn't implicitly create the directory if it's just
 
855
        # promising to get a transport -- mbp 20090727
1633
856
        if branch_format is None:
1634
857
            return self.transport.clone('branch')
1635
858
        try:
1670
893
            pass
1671
894
        return self.transport.clone('checkout')
1672
895
 
1673
 
    def needs_format_conversion(self, format=None):
 
896
    def has_workingtree(self):
 
897
        """Tell if this bzrdir contains a working tree.
 
898
 
 
899
        Note: if you're going to open the working tree, you should just go
 
900
        ahead and try, and not ask permission first.
 
901
        """
 
902
        from bzrlib.workingtree import WorkingTreeFormat
 
903
        try:
 
904
            WorkingTreeFormat.find_format_string(self)
 
905
        except errors.NoWorkingTree:
 
906
            return False
 
907
        return True
 
908
 
 
909
    def needs_format_conversion(self, format):
1674
910
        """See BzrDir.needs_format_conversion()."""
1675
 
        if format is None:
1676
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1677
 
                % 'needs_format_conversion(format=None)')
1678
 
        if format is None:
1679
 
            format = BzrDirFormat.get_default_format()
1680
 
        if not isinstance(self._format, format.__class__):
 
911
        if (not isinstance(self._format, format.__class__) or
 
912
            self._format.get_format_string() != format.get_format_string()):
1681
913
            # it is not a meta dir format, conversion is needed.
1682
914
            return True
1683
915
        # we might want to push this down to the repository?
1688
920
                return True
1689
921
        except errors.NoRepositoryPresent:
1690
922
            pass
1691
 
        try:
1692
 
            if not isinstance(self.open_branch()._format,
 
923
        for branch in self.list_branches():
 
924
            if not isinstance(branch._format,
1693
925
                              format.get_branch_format().__class__):
1694
926
                # the branch needs an upgrade.
1695
927
                return True
1696
 
        except errors.NotBranchError:
1697
 
            pass
1698
928
        try:
1699
929
            my_wt = self.open_workingtree(recommend_upgrade=False)
1700
930
            if not isinstance(my_wt._format,
1705
935
            pass
1706
936
        return False
1707
937
 
1708
 
    def open_branch(self, unsupported=False, ignore_fallbacks=False):
 
938
    def open_branch(self, name=None, unsupported=False,
 
939
                    ignore_fallbacks=False):
1709
940
        """See BzrDir.open_branch."""
1710
 
        format = self.find_branch_format()
1711
 
        self._check_supported(format, unsupported)
1712
 
        return format.open(self, _found=True, ignore_fallbacks=ignore_fallbacks)
 
941
        format = self.find_branch_format(name=name)
 
942
        format.check_support_status(unsupported)
 
943
        return format.open(self, name=name,
 
944
            _found=True, ignore_fallbacks=ignore_fallbacks)
1713
945
 
1714
946
    def open_repository(self, unsupported=False):
1715
947
        """See BzrDir.open_repository."""
1716
948
        from bzrlib.repository import RepositoryFormat
1717
949
        format = RepositoryFormat.find_format(self)
1718
 
        self._check_supported(format, unsupported)
 
950
        format.check_support_status(unsupported)
1719
951
        return format.open(self, _found=True)
1720
952
 
1721
953
    def open_workingtree(self, unsupported=False,
1723
955
        """See BzrDir.open_workingtree."""
1724
956
        from bzrlib.workingtree import WorkingTreeFormat
1725
957
        format = WorkingTreeFormat.find_format(self)
1726
 
        self._check_supported(format, unsupported,
1727
 
            recommend_upgrade,
 
958
        format.check_support_status(unsupported, recommend_upgrade,
1728
959
            basedir=self.root_transport.base)
1729
960
        return format.open(self, _found=True)
1730
961
 
1732
963
        return config.TransportConfig(self.transport, 'control.conf')
1733
964
 
1734
965
 
1735
 
class BzrDirFormat(object):
1736
 
    """An encapsulation of the initialization and open routines for a format.
1737
 
 
1738
 
    Formats provide three things:
1739
 
     * An initialization routine,
1740
 
     * a format string,
1741
 
     * an open routine.
 
966
class BzrDirMeta1Colo(BzrDirMeta1):
 
967
    """BzrDirMeta1 with support for colocated branches.
 
968
 
 
969
    This format is experimental, and will eventually be merged back into
 
970
    BzrDirMeta1.
 
971
    """
 
972
 
 
973
    def __init__(self, _transport, _format):
 
974
        super(BzrDirMeta1Colo, self).__init__(_transport, _format)
 
975
        self.control_files = lockable_files.LockableFiles(_transport,
 
976
            self._format._lock_file_name, self._format._lock_class)
 
977
 
 
978
    def _get_branch_path(self, name):
 
979
        """Obtain the branch path to use.
 
980
 
 
981
        This uses the API specified branch name first, and then falls back to
 
982
        the branch name specified in the URL. If neither of those is specified,
 
983
        it uses the default branch.
 
984
 
 
985
        :param name: Optional branch name to use
 
986
        :return: Relative path to branch, branch name
 
987
        """
 
988
        if name is None:
 
989
            name = self._get_selected_branch()
 
990
        if name is None:
 
991
            return 'branch', None
 
992
        return urlutils.join('branches', name), name
 
993
 
 
994
    def _read_branch_list(self):
 
995
        """Read the branch list.
 
996
 
 
997
        :return: List of utf-8 encoded branch names.
 
998
        """
 
999
        try:
 
1000
            f = self.control_transport.get('branch-list')
 
1001
        except errors.NoSuchFile:
 
1002
            return []
 
1003
 
 
1004
        ret = []
 
1005
        try:
 
1006
            for name in f:
 
1007
                ret.append(name.rstrip("\n"))
 
1008
        finally:
 
1009
            f.close()
 
1010
        return ret
 
1011
 
 
1012
    def _write_branch_list(self, branches):
 
1013
        """Write out the branch list.
 
1014
 
 
1015
        :param branches: List of utf-8 branch names to write
 
1016
        """
 
1017
        self.transport.put_bytes('branch-list',
 
1018
            "".join([name+"\n" for name in branches]))
 
1019
 
 
1020
    def destroy_branch(self, name=None):
 
1021
        """See BzrDir.create_branch."""
 
1022
        path, name = self._get_branch_path(name)
 
1023
        if name is not None:
 
1024
            self.control_files.lock_write()
 
1025
            try:
 
1026
                branches = self._read_branch_list()
 
1027
                try:
 
1028
                    branches.remove(name)
 
1029
                except ValueError:
 
1030
                    raise errors.NotBranchError(name)
 
1031
                self._write_branch_list(name)
 
1032
            finally:
 
1033
                self.control_files.unlock()
 
1034
        self.transport.delete_tree(path)
 
1035
 
 
1036
    def list_branches(self):
 
1037
        """See ControlDir.list_branches."""
 
1038
        ret = []
 
1039
        # Default branch
 
1040
        try:
 
1041
            ret.append(self.open_branch())
 
1042
        except (errors.NotBranchError, errors.NoRepositoryPresent):
 
1043
            pass
 
1044
 
 
1045
        # colocated branches
 
1046
        ret.extend([self.open_branch(name) for name in
 
1047
                    self._read_branch_list()])
 
1048
 
 
1049
        return ret
 
1050
 
 
1051
    def get_branch_transport(self, branch_format, name=None):
 
1052
        """See BzrDir.get_branch_transport()."""
 
1053
        path, name = self._get_branch_path(name)
 
1054
        # XXX: this shouldn't implicitly create the directory if it's just
 
1055
        # promising to get a transport -- mbp 20090727
 
1056
        if branch_format is None:
 
1057
            return self.transport.clone(path)
 
1058
        try:
 
1059
            branch_format.get_format_string()
 
1060
        except NotImplementedError:
 
1061
            raise errors.IncompatibleFormat(branch_format, self._format)
 
1062
        if name is not None:
 
1063
            try:
 
1064
                self.transport.mkdir('branches', mode=self._get_mkdir_mode())
 
1065
            except errors.FileExists:
 
1066
                pass
 
1067
            branches = self._read_branch_list()
 
1068
            if not name in branches:
 
1069
                self.control_files.lock_write()
 
1070
                try:
 
1071
                    branches = self._read_branch_list()
 
1072
                    branches.append(name)
 
1073
                    self._write_branch_list(branches)
 
1074
                finally:
 
1075
                    self.control_files.unlock()
 
1076
        try:
 
1077
            self.transport.mkdir(path, mode=self._get_mkdir_mode())
 
1078
        except errors.FileExists:
 
1079
            pass
 
1080
        return self.transport.clone(path)
 
1081
 
 
1082
 
 
1083
class BzrProber(controldir.Prober):
 
1084
    """Prober for formats that use a .bzr/ control directory."""
 
1085
 
 
1086
    formats = registry.FormatRegistry(controldir.network_format_registry)
 
1087
    """The known .bzr formats."""
 
1088
 
 
1089
    @classmethod
 
1090
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1091
    def register_bzrdir_format(klass, format):
 
1092
        klass.formats.register(format.get_format_string(), format)
 
1093
 
 
1094
    @classmethod
 
1095
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1096
    def unregister_bzrdir_format(klass, format):
 
1097
        klass.formats.remove(format.get_format_string())
 
1098
 
 
1099
    @classmethod
 
1100
    def probe_transport(klass, transport):
 
1101
        """Return the .bzrdir style format present in a directory."""
 
1102
        try:
 
1103
            format_string = transport.get_bytes(".bzr/branch-format")
 
1104
        except errors.NoSuchFile:
 
1105
            raise errors.NotBranchError(path=transport.base)
 
1106
        try:
 
1107
            return klass.formats.get(format_string)
 
1108
        except KeyError:
 
1109
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
 
1110
 
 
1111
    @classmethod
 
1112
    def known_formats(cls):
 
1113
        result = set()
 
1114
        for name, format in cls.formats.iteritems():
 
1115
            if callable(format):
 
1116
                format = format()
 
1117
            result.add(format)
 
1118
        return result
 
1119
 
 
1120
 
 
1121
controldir.ControlDirFormat.register_prober(BzrProber)
 
1122
 
 
1123
 
 
1124
class RemoteBzrProber(controldir.Prober):
 
1125
    """Prober for remote servers that provide a Bazaar smart server."""
 
1126
 
 
1127
    @classmethod
 
1128
    def probe_transport(klass, transport):
 
1129
        """Return a RemoteBzrDirFormat object if it looks possible."""
 
1130
        try:
 
1131
            medium = transport.get_smart_medium()
 
1132
        except (NotImplementedError, AttributeError,
 
1133
                errors.TransportNotPossible, errors.NoSmartMedium,
 
1134
                errors.SmartProtocolError):
 
1135
            # no smart server, so not a branch for this format type.
 
1136
            raise errors.NotBranchError(path=transport.base)
 
1137
        else:
 
1138
            # Decline to open it if the server doesn't support our required
 
1139
            # version (3) so that the VFS-based transport will do it.
 
1140
            if medium.should_probe():
 
1141
                try:
 
1142
                    server_version = medium.protocol_version()
 
1143
                except errors.SmartProtocolError:
 
1144
                    # Apparently there's no usable smart server there, even though
 
1145
                    # the medium supports the smart protocol.
 
1146
                    raise errors.NotBranchError(path=transport.base)
 
1147
                if server_version != '2':
 
1148
                    raise errors.NotBranchError(path=transport.base)
 
1149
            from bzrlib.remote import RemoteBzrDirFormat
 
1150
            return RemoteBzrDirFormat()
 
1151
 
 
1152
    @classmethod
 
1153
    def known_formats(cls):
 
1154
        from bzrlib.remote import RemoteBzrDirFormat
 
1155
        return set([RemoteBzrDirFormat()])
 
1156
 
 
1157
 
 
1158
class BzrDirFormat(controldir.ControlDirFormat):
 
1159
    """ControlDirFormat base class for .bzr/ directories.
1742
1160
 
1743
1161
    Formats are placed in a dict by their format string for reference
1744
1162
    during bzrdir opening. These should be subclasses of BzrDirFormat
1749
1167
    object will be created every system load.
1750
1168
    """
1751
1169
 
1752
 
    _default_format = None
1753
 
    """The default format used for new .bzr dirs."""
1754
 
 
1755
 
    _formats = {}
1756
 
    """The known formats."""
1757
 
 
1758
 
    _control_formats = []
1759
 
    """The registered control formats - .bzr, ....
1760
 
 
1761
 
    This is a list of BzrDirFormat objects.
1762
 
    """
1763
 
 
1764
 
    _control_server_formats = []
1765
 
    """The registered control server formats, e.g. RemoteBzrDirs.
1766
 
 
1767
 
    This is a list of BzrDirFormat objects.
1768
 
    """
1769
 
 
1770
1170
    _lock_file_name = 'branch-lock'
1771
1171
 
1772
1172
    # _lock_class must be set in subclasses to the lock type, typ.
1773
1173
    # TransportLock or LockDir
1774
1174
 
1775
1175
    @classmethod
1776
 
    def find_format(klass, transport, _server_formats=True):
1777
 
        """Return the format present at transport."""
1778
 
        if _server_formats:
1779
 
            formats = klass._control_server_formats + klass._control_formats
1780
 
        else:
1781
 
            formats = klass._control_formats
1782
 
        for format in formats:
1783
 
            try:
1784
 
                return format.probe_transport(transport)
1785
 
            except errors.NotBranchError:
1786
 
                # this format does not find a control dir here.
1787
 
                pass
1788
 
        raise errors.NotBranchError(path=transport.base)
1789
 
 
1790
 
    @classmethod
1791
 
    def probe_transport(klass, transport):
1792
 
        """Return the .bzrdir style format present in a directory."""
1793
 
        try:
1794
 
            format_string = transport.get(".bzr/branch-format").read()
1795
 
        except errors.NoSuchFile:
1796
 
            raise errors.NotBranchError(path=transport.base)
1797
 
 
1798
 
        try:
1799
 
            return klass._formats[format_string]
1800
 
        except KeyError:
1801
 
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1802
 
 
1803
 
    @classmethod
1804
 
    def get_default_format(klass):
1805
 
        """Return the current default format."""
1806
 
        return klass._default_format
1807
 
 
1808
 
    def get_format_string(self):
 
1176
    def get_format_string(cls):
1809
1177
        """Return the ASCII format string that identifies this format."""
1810
 
        raise NotImplementedError(self.get_format_string)
1811
 
 
1812
 
    def get_format_description(self):
1813
 
        """Return the short description for this format."""
1814
 
        raise NotImplementedError(self.get_format_description)
1815
 
 
1816
 
    def get_converter(self, format=None):
1817
 
        """Return the converter to use to convert bzrdirs needing converts.
1818
 
 
1819
 
        This returns a bzrlib.bzrdir.Converter object.
1820
 
 
1821
 
        This should return the best upgrader to step this format towards the
1822
 
        current default format. In the case of plugins we can/should provide
1823
 
        some means for them to extend the range of returnable converters.
1824
 
 
1825
 
        :param format: Optional format to override the default format of the
1826
 
                       library.
1827
 
        """
1828
 
        raise NotImplementedError(self.get_converter)
1829
 
 
1830
 
    def initialize(self, url, possible_transports=None):
1831
 
        """Create a bzr control dir at this url and return an opened copy.
1832
 
 
1833
 
        While not deprecated, this method is very specific and its use will
1834
 
        lead to many round trips to setup a working environment. See
1835
 
        initialize_on_transport_ex for a [nearly] all-in-one method.
1836
 
 
1837
 
        Subclasses should typically override initialize_on_transport
1838
 
        instead of this method.
1839
 
        """
1840
 
        return self.initialize_on_transport(get_transport(url,
1841
 
                                                          possible_transports))
 
1178
        raise NotImplementedError(cls.get_format_string)
1842
1179
 
1843
1180
    def initialize_on_transport(self, transport):
1844
1181
        """Initialize a new bzrdir in the base directory of a Transport."""
1854
1191
            # metadir1
1855
1192
            if type(self) != BzrDirMetaFormat1:
1856
1193
                return self._initialize_on_transport_vfs(transport)
 
1194
            from bzrlib.remote import RemoteBzrDirFormat
1857
1195
            remote_format = RemoteBzrDirFormat()
1858
1196
            self._supply_sub_formats_to(remote_format)
1859
1197
            return remote_format.initialize_on_transport(transport)
1897
1235
            except errors.NoSmartMedium:
1898
1236
                pass
1899
1237
            else:
 
1238
                from bzrlib.remote import RemoteBzrDirFormat
1900
1239
                # TODO: lookup the local format from a server hint.
1901
1240
                remote_dir_format = RemoteBzrDirFormat()
1902
1241
                remote_dir_format._network_name = self.network_name()
1977
1316
        utf8_files = [('README',
1978
1317
                       "This is a Bazaar control directory.\n"
1979
1318
                       "Do not change any files in this directory.\n"
1980
 
                       "See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
 
1319
                       "See http://bazaar.canonical.com/ for more information about Bazaar.\n"),
1981
1320
                      ('branch-format', self.get_format_string()),
1982
1321
                      ]
1983
1322
        # NB: no need to escape relative paths that are url safe.
1993
1332
            control_files.unlock()
1994
1333
        return self.open(transport, _found=True)
1995
1334
 
1996
 
    def is_supported(self):
1997
 
        """Is this format supported?
1998
 
 
1999
 
        Supported formats must be initializable and openable.
2000
 
        Unsupported formats may not support initialization or committing or
2001
 
        some other features depending on the reason for not being supported.
2002
 
        """
2003
 
        return True
2004
 
 
2005
 
    def network_name(self):
2006
 
        """A simple byte string uniquely identifying this format for RPC calls.
2007
 
 
2008
 
        Bzr control formats use thir disk format string to identify the format
2009
 
        over the wire. Its possible that other control formats have more
2010
 
        complex detection requirements, so we permit them to use any unique and
2011
 
        immutable string they desire.
2012
 
        """
2013
 
        raise NotImplementedError(self.network_name)
2014
 
 
2015
 
    def same_model(self, target_format):
2016
 
        return (self.repository_format.rich_root_data ==
2017
 
            target_format.rich_root_data)
2018
 
 
2019
 
    @classmethod
2020
 
    def known_formats(klass):
2021
 
        """Return all the known formats.
2022
 
 
2023
 
        Concrete formats should override _known_formats.
2024
 
        """
2025
 
        # There is double indirection here to make sure that control
2026
 
        # formats used by more than one dir format will only be probed
2027
 
        # once. This can otherwise be quite expensive for remote connections.
2028
 
        result = set()
2029
 
        for format in klass._control_formats:
2030
 
            result.update(format._known_formats())
2031
 
        return result
2032
 
 
2033
 
    @classmethod
2034
 
    def _known_formats(klass):
2035
 
        """Return the known format instances for this control format."""
2036
 
        return set(klass._formats.values())
2037
 
 
2038
1335
    def open(self, transport, _found=False):
2039
1336
        """Return an instance of this format for the dir transport points at.
2040
1337
 
2041
1338
        _found is a private parameter, do not use it.
2042
1339
        """
2043
1340
        if not _found:
2044
 
            found_format = BzrDirFormat.find_format(transport)
 
1341
            found_format = controldir.ControlDirFormat.find_format(transport)
2045
1342
            if not isinstance(found_format, self.__class__):
2046
1343
                raise AssertionError("%s was asked to open %s, but it seems to need "
2047
1344
                        "format %s"
2059
1356
        """
2060
1357
        raise NotImplementedError(self._open)
2061
1358
 
2062
 
    @classmethod
2063
 
    def register_format(klass, format):
2064
 
        klass._formats[format.get_format_string()] = format
2065
 
        # bzr native formats have a network name of their format string.
2066
 
        network_format_registry.register(format.get_format_string(), format.__class__)
2067
 
 
2068
 
    @classmethod
2069
 
    def register_control_format(klass, format):
2070
 
        """Register a format that does not use '.bzr' for its control dir.
2071
 
 
2072
 
        TODO: This should be pulled up into a 'ControlDirFormat' base class
2073
 
        which BzrDirFormat can inherit from, and renamed to register_format
2074
 
        there. It has been done without that for now for simplicity of
2075
 
        implementation.
2076
 
        """
2077
 
        klass._control_formats.append(format)
2078
 
 
2079
 
    @classmethod
2080
 
    def register_control_server_format(klass, format):
2081
 
        """Register a control format for client-server environments.
2082
 
 
2083
 
        These formats will be tried before ones registered with
2084
 
        register_control_format.  This gives implementations that decide to the
2085
 
        chance to grab it before anything looks at the contents of the format
2086
 
        file.
2087
 
        """
2088
 
        klass._control_server_formats.append(format)
2089
 
 
2090
 
    @classmethod
2091
 
    def _set_default_format(klass, format):
2092
 
        """Set default format (for testing behavior of defaults only)"""
2093
 
        klass._default_format = format
2094
 
 
2095
 
    def __str__(self):
2096
 
        # Trim the newline
2097
 
        return self.get_format_description().rstrip()
2098
 
 
2099
1359
    def _supply_sub_formats_to(self, other_format):
2100
1360
        """Give other_format the same values for sub formats as this has.
2101
1361
 
2108
1368
        :return: None.
2109
1369
        """
2110
1370
 
2111
 
    @classmethod
2112
 
    def unregister_format(klass, format):
2113
 
        del klass._formats[format.get_format_string()]
2114
 
 
2115
 
    @classmethod
2116
 
    def unregister_control_format(klass, format):
2117
 
        klass._control_formats.remove(format)
2118
 
 
2119
 
 
2120
 
class BzrDirFormat4(BzrDirFormat):
2121
 
    """Bzr dir format 4.
2122
 
 
2123
 
    This format is a combined format for working tree, branch and repository.
2124
 
    It has:
2125
 
     - Format 1 working trees [always]
2126
 
     - Format 4 branches [always]
2127
 
     - Format 4 repositories [always]
2128
 
 
2129
 
    This format is deprecated: it indexes texts using a text it which is
2130
 
    removed in format 5; write support for this format has been removed.
2131
 
    """
2132
 
 
2133
 
    _lock_class = lockable_files.TransportLock
2134
 
 
2135
 
    def get_format_string(self):
2136
 
        """See BzrDirFormat.get_format_string()."""
2137
 
        return "Bazaar-NG branch, format 0.0.4\n"
2138
 
 
2139
 
    def get_format_description(self):
2140
 
        """See BzrDirFormat.get_format_description()."""
2141
 
        return "All-in-one format 4"
2142
 
 
2143
 
    def get_converter(self, format=None):
2144
 
        """See BzrDirFormat.get_converter()."""
2145
 
        # there is one and only one upgrade path here.
2146
 
        return ConvertBzrDir4To5()
2147
 
 
2148
 
    def initialize_on_transport(self, transport):
2149
 
        """Format 4 branches cannot be created."""
2150
 
        raise errors.UninitializableFormat(self)
2151
 
 
2152
 
    def is_supported(self):
2153
 
        """Format 4 is not supported.
2154
 
 
2155
 
        It is not supported because the model changed from 4 to 5 and the
2156
 
        conversion logic is expensive - so doing it on the fly was not
2157
 
        feasible.
2158
 
        """
2159
 
        return False
2160
 
 
2161
 
    def network_name(self):
2162
 
        return self.get_format_string()
2163
 
 
2164
 
    def _open(self, transport):
2165
 
        """See BzrDirFormat._open."""
2166
 
        return BzrDir4(transport, self)
2167
 
 
2168
 
    def __return_repository_format(self):
2169
 
        """Circular import protection."""
2170
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
2171
 
        return RepositoryFormat4()
2172
 
    repository_format = property(__return_repository_format)
2173
 
 
2174
 
 
2175
 
class BzrDirFormatAllInOne(BzrDirFormat):
2176
 
    """Common class for formats before meta-dirs."""
2177
 
 
2178
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2179
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
2180
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2181
 
        shared_repo=False):
2182
 
        """See BzrDirFormat.initialize_on_transport_ex."""
2183
 
        require_stacking = (stacked_on is not None)
2184
 
        # Format 5 cannot stack, but we've been asked to - actually init
2185
 
        # a Meta1Dir
2186
 
        if require_stacking:
2187
 
            format = BzrDirMetaFormat1()
2188
 
            return format.initialize_on_transport_ex(transport,
2189
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2190
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
2191
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2192
 
                make_working_trees=make_working_trees, shared_repo=shared_repo)
2193
 
        return BzrDirFormat.initialize_on_transport_ex(self, transport,
2194
 
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2195
 
            force_new_repo=force_new_repo, stacked_on=stacked_on,
2196
 
            stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2197
 
            make_working_trees=make_working_trees, shared_repo=shared_repo)
2198
 
 
2199
 
 
2200
 
class BzrDirFormat5(BzrDirFormatAllInOne):
2201
 
    """Bzr control format 5.
2202
 
 
2203
 
    This format is a combined format for working tree, branch and repository.
2204
 
    It has:
2205
 
     - Format 2 working trees [always]
2206
 
     - Format 4 branches [always]
2207
 
     - Format 5 repositories [always]
2208
 
       Unhashed stores in the repository.
2209
 
    """
2210
 
 
2211
 
    _lock_class = lockable_files.TransportLock
2212
 
 
2213
 
    def get_format_string(self):
2214
 
        """See BzrDirFormat.get_format_string()."""
2215
 
        return "Bazaar-NG branch, format 5\n"
2216
 
 
2217
 
    def get_branch_format(self):
2218
 
        from bzrlib import branch
2219
 
        return branch.BzrBranchFormat4()
2220
 
 
2221
 
    def get_format_description(self):
2222
 
        """See BzrDirFormat.get_format_description()."""
2223
 
        return "All-in-one format 5"
2224
 
 
2225
 
    def get_converter(self, format=None):
2226
 
        """See BzrDirFormat.get_converter()."""
2227
 
        # there is one and only one upgrade path here.
2228
 
        return ConvertBzrDir5To6()
2229
 
 
2230
 
    def _initialize_for_clone(self, url):
2231
 
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2232
 
 
2233
 
    def initialize_on_transport(self, transport, _cloning=False):
2234
 
        """Format 5 dirs always have working tree, branch and repository.
2235
 
 
2236
 
        Except when they are being cloned.
2237
 
        """
2238
 
        from bzrlib.branch import BzrBranchFormat4
2239
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
2240
 
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2241
 
        RepositoryFormat5().initialize(result, _internal=True)
2242
 
        if not _cloning:
2243
 
            branch = BzrBranchFormat4().initialize(result)
2244
 
            result._init_workingtree()
2245
 
        return result
2246
 
 
2247
 
    def network_name(self):
2248
 
        return self.get_format_string()
2249
 
 
2250
 
    def _open(self, transport):
2251
 
        """See BzrDirFormat._open."""
2252
 
        return BzrDir5(transport, self)
2253
 
 
2254
 
    def __return_repository_format(self):
2255
 
        """Circular import protection."""
2256
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
2257
 
        return RepositoryFormat5()
2258
 
    repository_format = property(__return_repository_format)
2259
 
 
2260
 
 
2261
 
class BzrDirFormat6(BzrDirFormatAllInOne):
2262
 
    """Bzr control format 6.
2263
 
 
2264
 
    This format is a combined format for working tree, branch and repository.
2265
 
    It has:
2266
 
     - Format 2 working trees [always]
2267
 
     - Format 4 branches [always]
2268
 
     - Format 6 repositories [always]
2269
 
    """
2270
 
 
2271
 
    _lock_class = lockable_files.TransportLock
2272
 
 
2273
 
    def get_format_string(self):
2274
 
        """See BzrDirFormat.get_format_string()."""
2275
 
        return "Bazaar-NG branch, format 6\n"
2276
 
 
2277
 
    def get_format_description(self):
2278
 
        """See BzrDirFormat.get_format_description()."""
2279
 
        return "All-in-one format 6"
2280
 
 
2281
 
    def get_branch_format(self):
2282
 
        from bzrlib import branch
2283
 
        return branch.BzrBranchFormat4()
2284
 
 
2285
 
    def get_converter(self, format=None):
2286
 
        """See BzrDirFormat.get_converter()."""
2287
 
        # there is one and only one upgrade path here.
2288
 
        return ConvertBzrDir6ToMeta()
2289
 
 
2290
 
    def _initialize_for_clone(self, url):
2291
 
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2292
 
 
2293
 
    def initialize_on_transport(self, transport, _cloning=False):
2294
 
        """Format 6 dirs always have working tree, branch and repository.
2295
 
 
2296
 
        Except when they are being cloned.
2297
 
        """
2298
 
        from bzrlib.branch import BzrBranchFormat4
2299
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
2300
 
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2301
 
        RepositoryFormat6().initialize(result, _internal=True)
2302
 
        if not _cloning:
2303
 
            branch = BzrBranchFormat4().initialize(result)
2304
 
            result._init_workingtree()
2305
 
        return result
2306
 
 
2307
 
    def network_name(self):
2308
 
        return self.get_format_string()
2309
 
 
2310
 
    def _open(self, transport):
2311
 
        """See BzrDirFormat._open."""
2312
 
        return BzrDir6(transport, self)
2313
 
 
2314
 
    def __return_repository_format(self):
2315
 
        """Circular import protection."""
2316
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
2317
 
        return RepositoryFormat6()
2318
 
    repository_format = property(__return_repository_format)
 
1371
    def supports_transport(self, transport):
 
1372
        # bzr formats can be opened over all known transports
 
1373
        return True
2319
1374
 
2320
1375
 
2321
1376
class BzrDirMetaFormat1(BzrDirFormat):
2323
1378
 
2324
1379
    This is the first format with split out working tree, branch and repository
2325
1380
    disk storage.
 
1381
 
2326
1382
    It has:
2327
 
     - Format 3 working trees [optional]
2328
 
     - Format 5 branches [optional]
2329
 
     - Format 7 repositories [optional]
 
1383
 
 
1384
    - Format 3 working trees [optional]
 
1385
    - Format 5 branches [optional]
 
1386
    - Format 7 repositories [optional]
2330
1387
    """
2331
1388
 
2332
1389
    _lock_class = lockdir.LockDir
2333
1390
 
 
1391
    fixed_components = False
 
1392
 
 
1393
    colocated_branches = False
 
1394
 
2334
1395
    def __init__(self):
2335
1396
        self._workingtree_format = None
2336
1397
        self._branch_format = None
2350
1411
 
2351
1412
    def get_branch_format(self):
2352
1413
        if self._branch_format is None:
2353
 
            from bzrlib.branch import BranchFormat
2354
 
            self._branch_format = BranchFormat.get_default_format()
 
1414
            from bzrlib.branch import format_registry as branch_format_registry
 
1415
            self._branch_format = branch_format_registry.get_default()
2355
1416
        return self._branch_format
2356
1417
 
2357
1418
    def set_branch_format(self, format):
2412
1473
                    # stack_on is inaccessible, JFDI.
2413
1474
                    # TODO: bad monkey, hard-coded formats...
2414
1475
                    if self.repository_format.rich_root_data:
2415
 
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
 
1476
                        new_repo_format = knitpack_repo.RepositoryFormatKnitPack5RichRoot()
2416
1477
                    else:
2417
 
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5()
 
1478
                        new_repo_format = knitpack_repo.RepositoryFormatKnitPack5()
2418
1479
            else:
2419
1480
                # If the target already supports stacking, then we know the
2420
1481
                # project is already able to use stacking, so auto-upgrade
2426
1487
                    new_repo_format = None
2427
1488
            if new_repo_format is not None:
2428
1489
                self.repository_format = new_repo_format
2429
 
                note('Source repository format does not support stacking,'
2430
 
                     ' using format:\n  %s',
 
1490
                note(gettext('Source repository format does not support stacking,'
 
1491
                     ' using format:\n  %s'),
2431
1492
                     new_repo_format.get_format_description())
2432
1493
 
2433
1494
        if not self.get_branch_format().supports_stacking():
2437
1498
            if target_branch is None:
2438
1499
                if do_upgrade:
2439
1500
                    # TODO: bad monkey, hard-coded formats...
2440
 
                    new_branch_format = branch.BzrBranchFormat7()
 
1501
                    from bzrlib.branch import BzrBranchFormat7
 
1502
                    new_branch_format = BzrBranchFormat7()
2441
1503
            else:
2442
1504
                new_branch_format = target_branch._format
2443
1505
                if not new_branch_format.supports_stacking():
2445
1507
            if new_branch_format is not None:
2446
1508
                # Does support stacking, use its format.
2447
1509
                self.set_branch_format(new_branch_format)
2448
 
                note('Source branch format does not support stacking,'
2449
 
                     ' using format:\n  %s',
 
1510
                note(gettext('Source branch format does not support stacking,'
 
1511
                     ' using format:\n  %s'),
2450
1512
                     new_branch_format.get_format_description())
2451
1513
 
2452
1514
    def get_converter(self, format=None):
2453
1515
        """See BzrDirFormat.get_converter()."""
2454
1516
        if format is None:
2455
1517
            format = BzrDirFormat.get_default_format()
 
1518
        if (type(self) is BzrDirMetaFormat1 and
 
1519
            type(format) is BzrDirMetaFormat1Colo):
 
1520
            return ConvertMetaToColo(format)
 
1521
        if (type(self) is BzrDirMetaFormat1Colo and
 
1522
            type(format) is BzrDirMetaFormat1):
 
1523
            return ConvertMetaRemoveColo(format)
2456
1524
        if not isinstance(self, format.__class__):
2457
1525
            # converting away from metadir is not implemented
2458
1526
            raise NotImplementedError(self.get_converter)
2459
1527
        return ConvertMetaToMeta(format)
2460
1528
 
2461
 
    def get_format_string(self):
 
1529
    @classmethod
 
1530
    def get_format_string(cls):
2462
1531
        """See BzrDirFormat.get_format_string()."""
2463
1532
        return "Bazaar-NG meta directory, format 1\n"
2464
1533
 
2482
1551
        """Circular import protection."""
2483
1552
        if self._repository_format:
2484
1553
            return self._repository_format
2485
 
        from bzrlib.repository import RepositoryFormat
2486
 
        return RepositoryFormat.get_default_format()
 
1554
        from bzrlib.repository import format_registry
 
1555
        return format_registry.get_default()
2487
1556
 
2488
1557
    def _set_repository_format(self, value):
2489
1558
        """Allow changing the repository format for metadir formats."""
2512
1581
 
2513
1582
    def __get_workingtree_format(self):
2514
1583
        if self._workingtree_format is None:
2515
 
            from bzrlib.workingtree import WorkingTreeFormat
2516
 
            self._workingtree_format = WorkingTreeFormat.get_default_format()
 
1584
            from bzrlib.workingtree import (
 
1585
                format_registry as wt_format_registry,
 
1586
                )
 
1587
            self._workingtree_format = wt_format_registry.get_default()
2517
1588
        return self._workingtree_format
2518
1589
 
2519
1590
    def __set_workingtree_format(self, wt_format):
2523
1594
                                  __set_workingtree_format)
2524
1595
 
2525
1596
 
2526
 
network_format_registry = registry.FormatRegistry()
2527
 
"""Registry of formats indexed by their network name.
2528
 
 
2529
 
The network name for a BzrDirFormat is an identifier that can be used when
2530
 
referring to formats with smart server operations. See
2531
 
BzrDirFormat.network_name() for more detail.
2532
 
"""
2533
 
 
2534
 
 
2535
 
# Register bzr control format
2536
 
BzrDirFormat.register_control_format(BzrDirFormat)
2537
 
 
2538
1597
# Register bzr formats
2539
 
BzrDirFormat.register_format(BzrDirFormat4())
2540
 
BzrDirFormat.register_format(BzrDirFormat5())
2541
 
BzrDirFormat.register_format(BzrDirFormat6())
2542
 
__default_format = BzrDirMetaFormat1()
2543
 
BzrDirFormat.register_format(__default_format)
2544
 
BzrDirFormat._default_format = __default_format
2545
 
 
2546
 
 
2547
 
class Converter(object):
2548
 
    """Converts a disk format object from one format to another."""
2549
 
 
2550
 
    def convert(self, to_convert, pb):
2551
 
        """Perform the conversion of to_convert, giving feedback via pb.
2552
 
 
2553
 
        :param to_convert: The disk object to convert.
2554
 
        :param pb: a progress bar to use for progress information.
2555
 
        """
2556
 
 
2557
 
    def step(self, message):
2558
 
        """Update the pb by a step."""
2559
 
        self.count +=1
2560
 
        self.pb.update(message, self.count, self.total)
2561
 
 
2562
 
 
2563
 
class ConvertBzrDir4To5(Converter):
2564
 
    """Converts format 4 bzr dirs to format 5."""
2565
 
 
2566
 
    def __init__(self):
2567
 
        super(ConvertBzrDir4To5, self).__init__()
2568
 
        self.converted_revs = set()
2569
 
        self.absent_revisions = set()
2570
 
        self.text_count = 0
2571
 
        self.revisions = {}
2572
 
 
2573
 
    def convert(self, to_convert, pb):
2574
 
        """See Converter.convert()."""
2575
 
        self.bzrdir = to_convert
2576
 
        self.pb = pb
2577
 
        self.pb.note('starting upgrade from format 4 to 5')
2578
 
        if isinstance(self.bzrdir.transport, local.LocalTransport):
2579
 
            self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2580
 
        self._convert_to_weaves()
2581
 
        return BzrDir.open(self.bzrdir.root_transport.base)
2582
 
 
2583
 
    def _convert_to_weaves(self):
2584
 
        self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2585
 
        try:
2586
 
            # TODO permissions
2587
 
            stat = self.bzrdir.transport.stat('weaves')
2588
 
            if not S_ISDIR(stat.st_mode):
2589
 
                self.bzrdir.transport.delete('weaves')
2590
 
                self.bzrdir.transport.mkdir('weaves')
2591
 
        except errors.NoSuchFile:
2592
 
            self.bzrdir.transport.mkdir('weaves')
2593
 
        # deliberately not a WeaveFile as we want to build it up slowly.
2594
 
        self.inv_weave = Weave('inventory')
2595
 
        # holds in-memory weaves for all files
2596
 
        self.text_weaves = {}
2597
 
        self.bzrdir.transport.delete('branch-format')
2598
 
        self.branch = self.bzrdir.open_branch()
2599
 
        self._convert_working_inv()
2600
 
        rev_history = self.branch.revision_history()
2601
 
        # to_read is a stack holding the revisions we still need to process;
2602
 
        # appending to it adds new highest-priority revisions
2603
 
        self.known_revisions = set(rev_history)
2604
 
        self.to_read = rev_history[-1:]
2605
 
        while self.to_read:
2606
 
            rev_id = self.to_read.pop()
2607
 
            if (rev_id not in self.revisions
2608
 
                and rev_id not in self.absent_revisions):
2609
 
                self._load_one_rev(rev_id)
2610
 
        self.pb.clear()
2611
 
        to_import = self._make_order()
2612
 
        for i, rev_id in enumerate(to_import):
2613
 
            self.pb.update('converting revision', i, len(to_import))
2614
 
            self._convert_one_rev(rev_id)
2615
 
        self.pb.clear()
2616
 
        self._write_all_weaves()
2617
 
        self._write_all_revs()
2618
 
        self.pb.note('upgraded to weaves:')
2619
 
        self.pb.note('  %6d revisions and inventories', len(self.revisions))
2620
 
        self.pb.note('  %6d revisions not present', len(self.absent_revisions))
2621
 
        self.pb.note('  %6d texts', self.text_count)
2622
 
        self._cleanup_spare_files_after_format4()
2623
 
        self.branch._transport.put_bytes(
2624
 
            'branch-format',
2625
 
            BzrDirFormat5().get_format_string(),
2626
 
            mode=self.bzrdir._get_file_mode())
2627
 
 
2628
 
    def _cleanup_spare_files_after_format4(self):
2629
 
        # FIXME working tree upgrade foo.
2630
 
        for n in 'merged-patches', 'pending-merged-patches':
2631
 
            try:
2632
 
                ## assert os.path.getsize(p) == 0
2633
 
                self.bzrdir.transport.delete(n)
2634
 
            except errors.NoSuchFile:
2635
 
                pass
2636
 
        self.bzrdir.transport.delete_tree('inventory-store')
2637
 
        self.bzrdir.transport.delete_tree('text-store')
2638
 
 
2639
 
    def _convert_working_inv(self):
2640
 
        inv = xml4.serializer_v4.read_inventory(
2641
 
                self.branch._transport.get('inventory'))
2642
 
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2643
 
        self.branch._transport.put_bytes('inventory', new_inv_xml,
2644
 
            mode=self.bzrdir._get_file_mode())
2645
 
 
2646
 
    def _write_all_weaves(self):
2647
 
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2648
 
        weave_transport = self.bzrdir.transport.clone('weaves')
2649
 
        weaves = WeaveStore(weave_transport, prefixed=False)
2650
 
        transaction = WriteTransaction()
2651
 
 
2652
 
        try:
2653
 
            i = 0
2654
 
            for file_id, file_weave in self.text_weaves.items():
2655
 
                self.pb.update('writing weave', i, len(self.text_weaves))
2656
 
                weaves._put_weave(file_id, file_weave, transaction)
2657
 
                i += 1
2658
 
            self.pb.update('inventory', 0, 1)
2659
 
            controlweaves._put_weave('inventory', self.inv_weave, transaction)
2660
 
            self.pb.update('inventory', 1, 1)
2661
 
        finally:
2662
 
            self.pb.clear()
2663
 
 
2664
 
    def _write_all_revs(self):
2665
 
        """Write all revisions out in new form."""
2666
 
        self.bzrdir.transport.delete_tree('revision-store')
2667
 
        self.bzrdir.transport.mkdir('revision-store')
2668
 
        revision_transport = self.bzrdir.transport.clone('revision-store')
2669
 
        # TODO permissions
2670
 
        from bzrlib.xml5 import serializer_v5
2671
 
        from bzrlib.repofmt.weaverepo import RevisionTextStore
2672
 
        revision_store = RevisionTextStore(revision_transport,
2673
 
            serializer_v5, False, versionedfile.PrefixMapper(),
2674
 
            lambda:True, lambda:True)
2675
 
        try:
2676
 
            for i, rev_id in enumerate(self.converted_revs):
2677
 
                self.pb.update('write revision', i, len(self.converted_revs))
2678
 
                text = serializer_v5.write_revision_to_string(
2679
 
                    self.revisions[rev_id])
2680
 
                key = (rev_id,)
2681
 
                revision_store.add_lines(key, None, osutils.split_lines(text))
2682
 
        finally:
2683
 
            self.pb.clear()
2684
 
 
2685
 
    def _load_one_rev(self, rev_id):
2686
 
        """Load a revision object into memory.
2687
 
 
2688
 
        Any parents not either loaded or abandoned get queued to be
2689
 
        loaded."""
2690
 
        self.pb.update('loading revision',
2691
 
                       len(self.revisions),
2692
 
                       len(self.known_revisions))
2693
 
        if not self.branch.repository.has_revision(rev_id):
2694
 
            self.pb.clear()
2695
 
            self.pb.note('revision {%s} not present in branch; '
2696
 
                         'will be converted as a ghost',
2697
 
                         rev_id)
2698
 
            self.absent_revisions.add(rev_id)
2699
 
        else:
2700
 
            rev = self.branch.repository.get_revision(rev_id)
2701
 
            for parent_id in rev.parent_ids:
2702
 
                self.known_revisions.add(parent_id)
2703
 
                self.to_read.append(parent_id)
2704
 
            self.revisions[rev_id] = rev
2705
 
 
2706
 
    def _load_old_inventory(self, rev_id):
2707
 
        old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2708
 
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2709
 
        inv.revision_id = rev_id
2710
 
        rev = self.revisions[rev_id]
2711
 
        return inv
2712
 
 
2713
 
    def _load_updated_inventory(self, rev_id):
2714
 
        inv_xml = self.inv_weave.get_text(rev_id)
2715
 
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2716
 
        return inv
2717
 
 
2718
 
    def _convert_one_rev(self, rev_id):
2719
 
        """Convert revision and all referenced objects to new format."""
2720
 
        rev = self.revisions[rev_id]
2721
 
        inv = self._load_old_inventory(rev_id)
2722
 
        present_parents = [p for p in rev.parent_ids
2723
 
                           if p not in self.absent_revisions]
2724
 
        self._convert_revision_contents(rev, inv, present_parents)
2725
 
        self._store_new_inv(rev, inv, present_parents)
2726
 
        self.converted_revs.add(rev_id)
2727
 
 
2728
 
    def _store_new_inv(self, rev, inv, present_parents):
2729
 
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2730
 
        new_inv_sha1 = sha_string(new_inv_xml)
2731
 
        self.inv_weave.add_lines(rev.revision_id,
2732
 
                                 present_parents,
2733
 
                                 new_inv_xml.splitlines(True))
2734
 
        rev.inventory_sha1 = new_inv_sha1
2735
 
 
2736
 
    def _convert_revision_contents(self, rev, inv, present_parents):
2737
 
        """Convert all the files within a revision.
2738
 
 
2739
 
        Also upgrade the inventory to refer to the text revision ids."""
2740
 
        rev_id = rev.revision_id
2741
 
        mutter('converting texts of revision {%s}',
2742
 
               rev_id)
2743
 
        parent_invs = map(self._load_updated_inventory, present_parents)
2744
 
        entries = inv.iter_entries()
2745
 
        entries.next()
2746
 
        for path, ie in entries:
2747
 
            self._convert_file_version(rev, ie, parent_invs)
2748
 
 
2749
 
    def _convert_file_version(self, rev, ie, parent_invs):
2750
 
        """Convert one version of one file.
2751
 
 
2752
 
        The file needs to be added into the weave if it is a merge
2753
 
        of >=2 parents or if it's changed from its parent.
2754
 
        """
2755
 
        file_id = ie.file_id
2756
 
        rev_id = rev.revision_id
2757
 
        w = self.text_weaves.get(file_id)
2758
 
        if w is None:
2759
 
            w = Weave(file_id)
2760
 
            self.text_weaves[file_id] = w
2761
 
        text_changed = False
2762
 
        parent_candiate_entries = ie.parent_candidates(parent_invs)
2763
 
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2764
 
        # XXX: Note that this is unordered - and this is tolerable because
2765
 
        # the previous code was also unordered.
2766
 
        previous_entries = dict((head, parent_candiate_entries[head]) for head
2767
 
            in heads)
2768
 
        self.snapshot_ie(previous_entries, ie, w, rev_id)
2769
 
        del ie.text_id
2770
 
 
2771
 
    def get_parent_map(self, revision_ids):
2772
 
        """See graph.StackedParentsProvider.get_parent_map"""
2773
 
        return dict((revision_id, self.revisions[revision_id])
2774
 
                    for revision_id in revision_ids
2775
 
                     if revision_id in self.revisions)
2776
 
 
2777
 
    def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2778
 
        # TODO: convert this logic, which is ~= snapshot to
2779
 
        # a call to:. This needs the path figured out. rather than a work_tree
2780
 
        # a v4 revision_tree can be given, or something that looks enough like
2781
 
        # one to give the file content to the entry if it needs it.
2782
 
        # and we need something that looks like a weave store for snapshot to
2783
 
        # save against.
2784
 
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2785
 
        if len(previous_revisions) == 1:
2786
 
            previous_ie = previous_revisions.values()[0]
2787
 
            if ie._unchanged(previous_ie):
2788
 
                ie.revision = previous_ie.revision
2789
 
                return
2790
 
        if ie.has_text():
2791
 
            text = self.branch.repository._text_store.get(ie.text_id)
2792
 
            file_lines = text.readlines()
2793
 
            w.add_lines(rev_id, previous_revisions, file_lines)
2794
 
            self.text_count += 1
2795
 
        else:
2796
 
            w.add_lines(rev_id, previous_revisions, [])
2797
 
        ie.revision = rev_id
2798
 
 
2799
 
    def _make_order(self):
2800
 
        """Return a suitable order for importing revisions.
2801
 
 
2802
 
        The order must be such that an revision is imported after all
2803
 
        its (present) parents.
2804
 
        """
2805
 
        todo = set(self.revisions.keys())
2806
 
        done = self.absent_revisions.copy()
2807
 
        order = []
2808
 
        while todo:
2809
 
            # scan through looking for a revision whose parents
2810
 
            # are all done
2811
 
            for rev_id in sorted(list(todo)):
2812
 
                rev = self.revisions[rev_id]
2813
 
                parent_ids = set(rev.parent_ids)
2814
 
                if parent_ids.issubset(done):
2815
 
                    # can take this one now
2816
 
                    order.append(rev_id)
2817
 
                    todo.remove(rev_id)
2818
 
                    done.add(rev_id)
2819
 
        return order
2820
 
 
2821
 
 
2822
 
class ConvertBzrDir5To6(Converter):
2823
 
    """Converts format 5 bzr dirs to format 6."""
2824
 
 
2825
 
    def convert(self, to_convert, pb):
2826
 
        """See Converter.convert()."""
2827
 
        self.bzrdir = to_convert
2828
 
        self.pb = pb
2829
 
        self.pb.note('starting upgrade from format 5 to 6')
2830
 
        self._convert_to_prefixed()
2831
 
        return BzrDir.open(self.bzrdir.root_transport.base)
2832
 
 
2833
 
    def _convert_to_prefixed(self):
2834
 
        from bzrlib.store import TransportStore
2835
 
        self.bzrdir.transport.delete('branch-format')
2836
 
        for store_name in ["weaves", "revision-store"]:
2837
 
            self.pb.note("adding prefixes to %s" % store_name)
2838
 
            store_transport = self.bzrdir.transport.clone(store_name)
2839
 
            store = TransportStore(store_transport, prefixed=True)
2840
 
            for urlfilename in store_transport.list_dir('.'):
2841
 
                filename = urlutils.unescape(urlfilename)
2842
 
                if (filename.endswith(".weave") or
2843
 
                    filename.endswith(".gz") or
2844
 
                    filename.endswith(".sig")):
2845
 
                    file_id, suffix = os.path.splitext(filename)
2846
 
                else:
2847
 
                    file_id = filename
2848
 
                    suffix = ''
2849
 
                new_name = store._mapper.map((file_id,)) + suffix
2850
 
                # FIXME keep track of the dirs made RBC 20060121
2851
 
                try:
2852
 
                    store_transport.move(filename, new_name)
2853
 
                except errors.NoSuchFile: # catches missing dirs strangely enough
2854
 
                    store_transport.mkdir(osutils.dirname(new_name))
2855
 
                    store_transport.move(filename, new_name)
2856
 
        self.bzrdir.transport.put_bytes(
2857
 
            'branch-format',
2858
 
            BzrDirFormat6().get_format_string(),
2859
 
            mode=self.bzrdir._get_file_mode())
2860
 
 
2861
 
 
2862
 
class ConvertBzrDir6ToMeta(Converter):
2863
 
    """Converts format 6 bzr dirs to metadirs."""
2864
 
 
2865
 
    def convert(self, to_convert, pb):
2866
 
        """See Converter.convert()."""
2867
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
2868
 
        from bzrlib.branch import BzrBranchFormat5
2869
 
        self.bzrdir = to_convert
2870
 
        self.pb = pb
2871
 
        self.count = 0
2872
 
        self.total = 20 # the steps we know about
2873
 
        self.garbage_inventories = []
2874
 
        self.dir_mode = self.bzrdir._get_dir_mode()
2875
 
        self.file_mode = self.bzrdir._get_file_mode()
2876
 
 
2877
 
        self.pb.note('starting upgrade from format 6 to metadir')
2878
 
        self.bzrdir.transport.put_bytes(
2879
 
                'branch-format',
2880
 
                "Converting to format 6",
2881
 
                mode=self.file_mode)
2882
 
        # its faster to move specific files around than to open and use the apis...
2883
 
        # first off, nuke ancestry.weave, it was never used.
2884
 
        try:
2885
 
            self.step('Removing ancestry.weave')
2886
 
            self.bzrdir.transport.delete('ancestry.weave')
2887
 
        except errors.NoSuchFile:
2888
 
            pass
2889
 
        # find out whats there
2890
 
        self.step('Finding branch files')
2891
 
        last_revision = self.bzrdir.open_branch().last_revision()
2892
 
        bzrcontents = self.bzrdir.transport.list_dir('.')
2893
 
        for name in bzrcontents:
2894
 
            if name.startswith('basis-inventory.'):
2895
 
                self.garbage_inventories.append(name)
2896
 
        # create new directories for repository, working tree and branch
2897
 
        repository_names = [('inventory.weave', True),
2898
 
                            ('revision-store', True),
2899
 
                            ('weaves', True)]
2900
 
        self.step('Upgrading repository  ')
2901
 
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2902
 
        self.make_lock('repository')
2903
 
        # we hard code the formats here because we are converting into
2904
 
        # the meta format. The meta format upgrader can take this to a
2905
 
        # future format within each component.
2906
 
        self.put_format('repository', RepositoryFormat7())
2907
 
        for entry in repository_names:
2908
 
            self.move_entry('repository', entry)
2909
 
 
2910
 
        self.step('Upgrading branch      ')
2911
 
        self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2912
 
        self.make_lock('branch')
2913
 
        self.put_format('branch', BzrBranchFormat5())
2914
 
        branch_files = [('revision-history', True),
2915
 
                        ('branch-name', True),
2916
 
                        ('parent', False)]
2917
 
        for entry in branch_files:
2918
 
            self.move_entry('branch', entry)
2919
 
 
2920
 
        checkout_files = [('pending-merges', True),
2921
 
                          ('inventory', True),
2922
 
                          ('stat-cache', False)]
2923
 
        # If a mandatory checkout file is not present, the branch does not have
2924
 
        # a functional checkout. Do not create a checkout in the converted
2925
 
        # branch.
2926
 
        for name, mandatory in checkout_files:
2927
 
            if mandatory and name not in bzrcontents:
2928
 
                has_checkout = False
2929
 
                break
2930
 
        else:
2931
 
            has_checkout = True
2932
 
        if not has_checkout:
2933
 
            self.pb.note('No working tree.')
2934
 
            # If some checkout files are there, we may as well get rid of them.
2935
 
            for name, mandatory in checkout_files:
2936
 
                if name in bzrcontents:
2937
 
                    self.bzrdir.transport.delete(name)
2938
 
        else:
2939
 
            from bzrlib.workingtree import WorkingTreeFormat3
2940
 
            self.step('Upgrading working tree')
2941
 
            self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2942
 
            self.make_lock('checkout')
2943
 
            self.put_format(
2944
 
                'checkout', WorkingTreeFormat3())
2945
 
            self.bzrdir.transport.delete_multi(
2946
 
                self.garbage_inventories, self.pb)
2947
 
            for entry in checkout_files:
2948
 
                self.move_entry('checkout', entry)
2949
 
            if last_revision is not None:
2950
 
                self.bzrdir.transport.put_bytes(
2951
 
                    'checkout/last-revision', last_revision)
2952
 
        self.bzrdir.transport.put_bytes(
2953
 
            'branch-format',
2954
 
            BzrDirMetaFormat1().get_format_string(),
2955
 
            mode=self.file_mode)
2956
 
        return BzrDir.open(self.bzrdir.root_transport.base)
2957
 
 
2958
 
    def make_lock(self, name):
2959
 
        """Make a lock for the new control dir name."""
2960
 
        self.step('Make %s lock' % name)
2961
 
        ld = lockdir.LockDir(self.bzrdir.transport,
2962
 
                             '%s/lock' % name,
2963
 
                             file_modebits=self.file_mode,
2964
 
                             dir_modebits=self.dir_mode)
2965
 
        ld.create()
2966
 
 
2967
 
    def move_entry(self, new_dir, entry):
2968
 
        """Move then entry name into new_dir."""
2969
 
        name = entry[0]
2970
 
        mandatory = entry[1]
2971
 
        self.step('Moving %s' % name)
2972
 
        try:
2973
 
            self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2974
 
        except errors.NoSuchFile:
2975
 
            if mandatory:
2976
 
                raise
2977
 
 
2978
 
    def put_format(self, dirname, format):
2979
 
        self.bzrdir.transport.put_bytes('%s/format' % dirname,
2980
 
            format.get_format_string(),
2981
 
            self.file_mode)
2982
 
 
2983
 
 
2984
 
class ConvertMetaToMeta(Converter):
 
1598
BzrProber.formats.register(BzrDirMetaFormat1.get_format_string(),
 
1599
    BzrDirMetaFormat1)
 
1600
controldir.ControlDirFormat._default_format = BzrDirMetaFormat1()
 
1601
 
 
1602
 
 
1603
class BzrDirMetaFormat1Colo(BzrDirMetaFormat1):
 
1604
    """BzrDirMeta1 format with support for colocated branches."""
 
1605
 
 
1606
    colocated_branches = True
 
1607
 
 
1608
    @classmethod
 
1609
    def get_format_string(cls):
 
1610
        """See BzrDirFormat.get_format_string()."""
 
1611
        return "Bazaar meta directory, format 1 (with colocated branches)\n"
 
1612
 
 
1613
    def get_format_description(self):
 
1614
        """See BzrDirFormat.get_format_description()."""
 
1615
        return "Meta directory format 1 with support for colocated branches"
 
1616
 
 
1617
    def _open(self, transport):
 
1618
        """See BzrDirFormat._open."""
 
1619
        # Create a new format instance because otherwise initialisation of new
 
1620
        # metadirs share the global default format object leading to alias
 
1621
        # problems.
 
1622
        format = BzrDirMetaFormat1Colo()
 
1623
        self._supply_sub_formats_to(format)
 
1624
        return BzrDirMeta1Colo(transport, format)
 
1625
 
 
1626
 
 
1627
BzrProber.formats.register(BzrDirMetaFormat1Colo.get_format_string(),
 
1628
    BzrDirMetaFormat1Colo)
 
1629
 
 
1630
 
 
1631
class ConvertMetaToMeta(controldir.Converter):
2985
1632
    """Converts the components of metadirs."""
2986
1633
 
2987
1634
    def __init__(self, target_format):
2994
1641
    def convert(self, to_convert, pb):
2995
1642
        """See Converter.convert()."""
2996
1643
        self.bzrdir = to_convert
2997
 
        self.pb = pb
 
1644
        self.pb = ui.ui_factory.nested_progress_bar()
2998
1645
        self.count = 0
2999
1646
        self.total = 1
3000
1647
        self.step('checking repository format')
3005
1652
        else:
3006
1653
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
3007
1654
                from bzrlib.repository import CopyConverter
3008
 
                self.pb.note('starting repository conversion')
 
1655
                ui.ui_factory.note(gettext('starting repository conversion'))
3009
1656
                converter = CopyConverter(self.target_format.repository_format)
3010
1657
                converter.convert(repo, pb)
3011
 
        try:
3012
 
            branch = self.bzrdir.open_branch()
3013
 
        except errors.NotBranchError:
3014
 
            pass
3015
 
        else:
 
1658
        for branch in self.bzrdir.list_branches():
3016
1659
            # TODO: conversions of Branch and Tree should be done by
3017
1660
            # InterXFormat lookups/some sort of registry.
3018
1661
            # Avoid circular imports
3019
 
            from bzrlib import branch as _mod_branch
3020
1662
            old = branch._format.__class__
3021
1663
            new = self.target_format.get_branch_format().__class__
3022
1664
            while old != new:
3033
1675
                      new is _mod_branch.BzrBranchFormat8):
3034
1676
                    branch_converter = _mod_branch.Converter7to8()
3035
1677
                else:
3036
 
                    raise errors.BadConversionTarget("No converter", new)
 
1678
                    raise errors.BadConversionTarget("No converter", new,
 
1679
                        branch._format)
3037
1680
                branch_converter.convert(branch)
3038
1681
                branch = self.bzrdir.open_branch()
3039
1682
                old = branch._format.__class__
3044
1687
        else:
3045
1688
            # TODO: conversions of Branch and Tree should be done by
3046
1689
            # InterXFormat lookups
3047
 
            if (isinstance(tree, workingtree.WorkingTree3) and
 
1690
            if (isinstance(tree, workingtree_3.WorkingTree3) and
3048
1691
                not isinstance(tree, workingtree_4.DirStateWorkingTree) and
3049
1692
                isinstance(self.target_format.workingtree_format,
3050
1693
                    workingtree_4.DirStateWorkingTreeFormat)):
3059
1702
                isinstance(self.target_format.workingtree_format,
3060
1703
                    workingtree_4.WorkingTreeFormat6)):
3061
1704
                workingtree_4.Converter4or5to6().convert(tree)
 
1705
        self.pb.finished()
3062
1706
        return to_convert
3063
1707
 
3064
1708
 
3065
 
# This is not in remote.py because it's relatively small, and needs to be
3066
 
# registered. Putting it in remote.py creates a circular import problem.
3067
 
# we can make it a lazy object if the control formats is turned into something
3068
 
# like a registry.
3069
 
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3070
 
    """Format representing bzrdirs accessed via a smart server"""
3071
 
 
3072
 
    def __init__(self):
3073
 
        BzrDirMetaFormat1.__init__(self)
3074
 
        self._network_name = None
3075
 
 
3076
 
    def get_format_description(self):
3077
 
        return 'bzr remote bzrdir'
3078
 
 
3079
 
    def get_format_string(self):
3080
 
        raise NotImplementedError(self.get_format_string)
3081
 
 
3082
 
    def network_name(self):
3083
 
        if self._network_name:
3084
 
            return self._network_name
3085
 
        else:
3086
 
            raise AssertionError("No network name set.")
3087
 
 
3088
 
    @classmethod
3089
 
    def probe_transport(klass, transport):
3090
 
        """Return a RemoteBzrDirFormat object if it looks possible."""
3091
 
        try:
3092
 
            medium = transport.get_smart_medium()
3093
 
        except (NotImplementedError, AttributeError,
3094
 
                errors.TransportNotPossible, errors.NoSmartMedium,
3095
 
                errors.SmartProtocolError):
3096
 
            # no smart server, so not a branch for this format type.
3097
 
            raise errors.NotBranchError(path=transport.base)
3098
 
        else:
3099
 
            # Decline to open it if the server doesn't support our required
3100
 
            # version (3) so that the VFS-based transport will do it.
3101
 
            if medium.should_probe():
3102
 
                try:
3103
 
                    server_version = medium.protocol_version()
3104
 
                except errors.SmartProtocolError:
3105
 
                    # Apparently there's no usable smart server there, even though
3106
 
                    # the medium supports the smart protocol.
3107
 
                    raise errors.NotBranchError(path=transport.base)
3108
 
                if server_version != '2':
3109
 
                    raise errors.NotBranchError(path=transport.base)
3110
 
            return klass()
3111
 
 
3112
 
    def initialize_on_transport(self, transport):
3113
 
        try:
3114
 
            # hand off the request to the smart server
3115
 
            client_medium = transport.get_smart_medium()
3116
 
        except errors.NoSmartMedium:
3117
 
            # TODO: lookup the local format from a server hint.
3118
 
            local_dir_format = BzrDirMetaFormat1()
3119
 
            return local_dir_format.initialize_on_transport(transport)
3120
 
        client = _SmartClient(client_medium)
3121
 
        path = client.remote_path_from_transport(transport)
3122
 
        try:
3123
 
            response = client.call('BzrDirFormat.initialize', path)
3124
 
        except errors.ErrorFromSmartServer, err:
3125
 
            remote._translate_error(err, path=path)
3126
 
        if response[0] != 'ok':
3127
 
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3128
 
        format = RemoteBzrDirFormat()
3129
 
        self._supply_sub_formats_to(format)
3130
 
        return remote.RemoteBzrDir(transport, format)
3131
 
 
3132
 
    def parse_NoneTrueFalse(self, arg):
3133
 
        if not arg:
3134
 
            return None
3135
 
        if arg == 'False':
3136
 
            return False
3137
 
        if arg == 'True':
3138
 
            return True
3139
 
        raise AssertionError("invalid arg %r" % arg)
3140
 
 
3141
 
    def _serialize_NoneTrueFalse(self, arg):
3142
 
        if arg is False:
3143
 
            return 'False'
3144
 
        if arg:
3145
 
            return 'True'
3146
 
        return ''
3147
 
 
3148
 
    def _serialize_NoneString(self, arg):
3149
 
        return arg or ''
3150
 
 
3151
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3152
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
3153
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3154
 
        shared_repo=False):
3155
 
        try:
3156
 
            # hand off the request to the smart server
3157
 
            client_medium = transport.get_smart_medium()
3158
 
        except errors.NoSmartMedium:
3159
 
            do_vfs = True
3160
 
        else:
3161
 
            # Decline to open it if the server doesn't support our required
3162
 
            # version (3) so that the VFS-based transport will do it.
3163
 
            if client_medium.should_probe():
3164
 
                try:
3165
 
                    server_version = client_medium.protocol_version()
3166
 
                    if server_version != '2':
3167
 
                        do_vfs = True
3168
 
                    else:
3169
 
                        do_vfs = False
3170
 
                except errors.SmartProtocolError:
3171
 
                    # Apparently there's no usable smart server there, even though
3172
 
                    # the medium supports the smart protocol.
3173
 
                    do_vfs = True
3174
 
            else:
3175
 
                do_vfs = False
3176
 
        if not do_vfs:
3177
 
            client = _SmartClient(client_medium)
3178
 
            path = client.remote_path_from_transport(transport)
3179
 
            if client_medium._is_remote_before((1, 16)):
3180
 
                do_vfs = True
3181
 
        if do_vfs:
3182
 
            # TODO: lookup the local format from a server hint.
3183
 
            local_dir_format = BzrDirMetaFormat1()
3184
 
            self._supply_sub_formats_to(local_dir_format)
3185
 
            return local_dir_format.initialize_on_transport_ex(transport,
3186
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3187
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3188
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3189
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3190
 
                vfs_only=True)
3191
 
        return self._initialize_on_transport_ex_rpc(client, path, transport,
3192
 
            use_existing_dir, create_prefix, force_new_repo, stacked_on,
3193
 
            stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3194
 
 
3195
 
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
3196
 
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
3197
 
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3198
 
        args = []
3199
 
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3200
 
        args.append(self._serialize_NoneTrueFalse(create_prefix))
3201
 
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
3202
 
        args.append(self._serialize_NoneString(stacked_on))
3203
 
        # stack_on_pwd is often/usually our transport
3204
 
        if stack_on_pwd:
3205
 
            try:
3206
 
                stack_on_pwd = transport.relpath(stack_on_pwd)
3207
 
                if not stack_on_pwd:
3208
 
                    stack_on_pwd = '.'
3209
 
            except errors.PathNotChild:
3210
 
                pass
3211
 
        args.append(self._serialize_NoneString(stack_on_pwd))
3212
 
        args.append(self._serialize_NoneString(repo_format_name))
3213
 
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
3214
 
        args.append(self._serialize_NoneTrueFalse(shared_repo))
3215
 
        if self._network_name is None:
3216
 
            self._network_name = \
3217
 
            BzrDirFormat.get_default_format().network_name()
3218
 
        try:
3219
 
            response = client.call('BzrDirFormat.initialize_ex_1.16',
3220
 
                self.network_name(), path, *args)
3221
 
        except errors.UnknownSmartMethod:
3222
 
            client._medium._remember_remote_is_before((1,16))
3223
 
            local_dir_format = BzrDirMetaFormat1()
3224
 
            self._supply_sub_formats_to(local_dir_format)
3225
 
            return local_dir_format.initialize_on_transport_ex(transport,
3226
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3227
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3228
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3229
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3230
 
                vfs_only=True)
3231
 
        except errors.ErrorFromSmartServer, err:
3232
 
            remote._translate_error(err, path=path)
3233
 
        repo_path = response[0]
3234
 
        bzrdir_name = response[6]
3235
 
        require_stacking = response[7]
3236
 
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
3237
 
        format = RemoteBzrDirFormat()
3238
 
        format._network_name = bzrdir_name
3239
 
        self._supply_sub_formats_to(format)
3240
 
        bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3241
 
        if repo_path:
3242
 
            repo_format = remote.response_tuple_to_repo_format(response[1:])
3243
 
            if repo_path == '.':
3244
 
                repo_path = ''
3245
 
            if repo_path:
3246
 
                repo_bzrdir_format = RemoteBzrDirFormat()
3247
 
                repo_bzrdir_format._network_name = response[5]
3248
 
                repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3249
 
                    repo_bzrdir_format)
3250
 
            else:
3251
 
                repo_bzr = bzrdir
3252
 
            final_stack = response[8] or None
3253
 
            final_stack_pwd = response[9] or None
3254
 
            if final_stack_pwd:
3255
 
                final_stack_pwd = urlutils.join(
3256
 
                    transport.base, final_stack_pwd)
3257
 
            remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3258
 
            if len(response) > 10:
3259
 
                # Updated server verb that locks remotely.
3260
 
                repo_lock_token = response[10] or None
3261
 
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3262
 
                if repo_lock_token:
3263
 
                    remote_repo.dont_leave_lock_in_place()
3264
 
            else:
3265
 
                remote_repo.lock_write()
3266
 
            policy = UseExistingRepository(remote_repo, final_stack,
3267
 
                final_stack_pwd, require_stacking)
3268
 
            policy.acquire_repository()
3269
 
        else:
3270
 
            remote_repo = None
3271
 
            policy = None
3272
 
        bzrdir._format.set_branch_format(self.get_branch_format())
3273
 
        if require_stacking:
3274
 
            # The repo has already been created, but we need to make sure that
3275
 
            # we'll make a stackable branch.
3276
 
            bzrdir._format.require_stacking(_skip_repo=True)
3277
 
        return remote_repo, bzrdir, require_stacking, policy
3278
 
 
3279
 
    def _open(self, transport):
3280
 
        return remote.RemoteBzrDir(transport, self)
3281
 
 
3282
 
    def __eq__(self, other):
3283
 
        if not isinstance(other, RemoteBzrDirFormat):
3284
 
            return False
3285
 
        return self.get_format_description() == other.get_format_description()
3286
 
 
3287
 
    def __return_repository_format(self):
3288
 
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
3289
 
        # repository format has been asked for, tell the RemoteRepositoryFormat
3290
 
        # that it should use that for init() etc.
3291
 
        result = remote.RemoteRepositoryFormat()
3292
 
        custom_format = getattr(self, '_repository_format', None)
3293
 
        if custom_format:
3294
 
            if isinstance(custom_format, remote.RemoteRepositoryFormat):
3295
 
                return custom_format
3296
 
            else:
3297
 
                # We will use the custom format to create repositories over the
3298
 
                # wire; expose its details like rich_root_data for code to
3299
 
                # query
3300
 
                result._custom_format = custom_format
3301
 
        return result
3302
 
 
3303
 
    def get_branch_format(self):
3304
 
        result = BzrDirMetaFormat1.get_branch_format(self)
3305
 
        if not isinstance(result, remote.RemoteBranchFormat):
3306
 
            new_result = remote.RemoteBranchFormat()
3307
 
            new_result._custom_format = result
3308
 
            # cache the result
3309
 
            self.set_branch_format(new_result)
3310
 
            result = new_result
3311
 
        return result
3312
 
 
3313
 
    repository_format = property(__return_repository_format,
3314
 
        BzrDirMetaFormat1._set_repository_format) #.im_func)
3315
 
 
3316
 
 
3317
 
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3318
 
 
3319
 
 
3320
 
class BzrDirFormatInfo(object):
3321
 
 
3322
 
    def __init__(self, native, deprecated, hidden, experimental):
3323
 
        self.deprecated = deprecated
3324
 
        self.native = native
3325
 
        self.hidden = hidden
3326
 
        self.experimental = experimental
3327
 
 
3328
 
 
3329
 
class BzrDirFormatRegistry(registry.Registry):
3330
 
    """Registry of user-selectable BzrDir subformats.
3331
 
 
3332
 
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3333
 
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
3334
 
    """
3335
 
 
3336
 
    def __init__(self):
3337
 
        """Create a BzrDirFormatRegistry."""
3338
 
        self._aliases = set()
3339
 
        self._registration_order = list()
3340
 
        super(BzrDirFormatRegistry, self).__init__()
3341
 
 
3342
 
    def aliases(self):
3343
 
        """Return a set of the format names which are aliases."""
3344
 
        return frozenset(self._aliases)
3345
 
 
3346
 
    def register_metadir(self, key,
3347
 
             repository_format, help, native=True, deprecated=False,
3348
 
             branch_format=None,
3349
 
             tree_format=None,
3350
 
             hidden=False,
3351
 
             experimental=False,
3352
 
             alias=False):
3353
 
        """Register a metadir subformat.
3354
 
 
3355
 
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3356
 
        by the Repository/Branch/WorkingTreeformats.
3357
 
 
3358
 
        :param repository_format: The fully-qualified repository format class
3359
 
            name as a string.
3360
 
        :param branch_format: Fully-qualified branch format class name as
3361
 
            a string.
3362
 
        :param tree_format: Fully-qualified tree format class name as
3363
 
            a string.
3364
 
        """
3365
 
        # This should be expanded to support setting WorkingTree and Branch
3366
 
        # formats, once BzrDirMetaFormat1 supports that.
3367
 
        def _load(full_name):
3368
 
            mod_name, factory_name = full_name.rsplit('.', 1)
3369
 
            try:
3370
 
                mod = __import__(mod_name, globals(), locals(),
3371
 
                        [factory_name])
3372
 
            except ImportError, e:
3373
 
                raise ImportError('failed to load %s: %s' % (full_name, e))
3374
 
            try:
3375
 
                factory = getattr(mod, factory_name)
3376
 
            except AttributeError:
3377
 
                raise AttributeError('no factory %s in module %r'
3378
 
                    % (full_name, mod))
3379
 
            return factory()
3380
 
 
3381
 
        def helper():
3382
 
            bd = BzrDirMetaFormat1()
3383
 
            if branch_format is not None:
3384
 
                bd.set_branch_format(_load(branch_format))
3385
 
            if tree_format is not None:
3386
 
                bd.workingtree_format = _load(tree_format)
3387
 
            if repository_format is not None:
3388
 
                bd.repository_format = _load(repository_format)
3389
 
            return bd
3390
 
        self.register(key, helper, help, native, deprecated, hidden,
3391
 
            experimental, alias)
3392
 
 
3393
 
    def register(self, key, factory, help, native=True, deprecated=False,
3394
 
                 hidden=False, experimental=False, alias=False):
3395
 
        """Register a BzrDirFormat factory.
3396
 
 
3397
 
        The factory must be a callable that takes one parameter: the key.
3398
 
        It must produce an instance of the BzrDirFormat when called.
3399
 
 
3400
 
        This function mainly exists to prevent the info object from being
3401
 
        supplied directly.
3402
 
        """
3403
 
        registry.Registry.register(self, key, factory, help,
3404
 
            BzrDirFormatInfo(native, deprecated, hidden, experimental))
3405
 
        if alias:
3406
 
            self._aliases.add(key)
3407
 
        self._registration_order.append(key)
3408
 
 
3409
 
    def register_lazy(self, key, module_name, member_name, help, native=True,
3410
 
        deprecated=False, hidden=False, experimental=False, alias=False):
3411
 
        registry.Registry.register_lazy(self, key, module_name, member_name,
3412
 
            help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3413
 
        if alias:
3414
 
            self._aliases.add(key)
3415
 
        self._registration_order.append(key)
3416
 
 
3417
 
    def set_default(self, key):
3418
 
        """Set the 'default' key to be a clone of the supplied key.
3419
 
 
3420
 
        This method must be called once and only once.
3421
 
        """
3422
 
        registry.Registry.register(self, 'default', self.get(key),
3423
 
            self.get_help(key), info=self.get_info(key))
3424
 
        self._aliases.add('default')
3425
 
 
3426
 
    def set_default_repository(self, key):
3427
 
        """Set the FormatRegistry default and Repository default.
3428
 
 
3429
 
        This is a transitional method while Repository.set_default_format
3430
 
        is deprecated.
3431
 
        """
3432
 
        if 'default' in self:
3433
 
            self.remove('default')
3434
 
        self.set_default(key)
3435
 
        format = self.get('default')()
3436
 
 
3437
 
    def make_bzrdir(self, key):
3438
 
        return self.get(key)()
3439
 
 
3440
 
    def help_topic(self, topic):
3441
 
        output = ""
3442
 
        default_realkey = None
3443
 
        default_help = self.get_help('default')
3444
 
        help_pairs = []
3445
 
        for key in self._registration_order:
3446
 
            if key == 'default':
3447
 
                continue
3448
 
            help = self.get_help(key)
3449
 
            if help == default_help:
3450
 
                default_realkey = key
3451
 
            else:
3452
 
                help_pairs.append((key, help))
3453
 
 
3454
 
        def wrapped(key, help, info):
3455
 
            if info.native:
3456
 
                help = '(native) ' + help
3457
 
            return ':%s:\n%s\n\n' % (key,
3458
 
                textwrap.fill(help, initial_indent='    ',
3459
 
                    subsequent_indent='    ',
3460
 
                    break_long_words=False))
3461
 
        if default_realkey is not None:
3462
 
            output += wrapped(default_realkey, '(default) %s' % default_help,
3463
 
                              self.get_info('default'))
3464
 
        deprecated_pairs = []
3465
 
        experimental_pairs = []
3466
 
        for key, help in help_pairs:
3467
 
            info = self.get_info(key)
3468
 
            if info.hidden:
3469
 
                continue
3470
 
            elif info.deprecated:
3471
 
                deprecated_pairs.append((key, help))
3472
 
            elif info.experimental:
3473
 
                experimental_pairs.append((key, help))
3474
 
            else:
3475
 
                output += wrapped(key, help, info)
3476
 
        output += "\nSee ``bzr help formats`` for more about storage formats."
3477
 
        other_output = ""
3478
 
        if len(experimental_pairs) > 0:
3479
 
            other_output += "Experimental formats are shown below.\n\n"
3480
 
            for key, help in experimental_pairs:
3481
 
                info = self.get_info(key)
3482
 
                other_output += wrapped(key, help, info)
3483
 
        else:
3484
 
            other_output += \
3485
 
                "No experimental formats are available.\n\n"
3486
 
        if len(deprecated_pairs) > 0:
3487
 
            other_output += "\nDeprecated formats are shown below.\n\n"
3488
 
            for key, help in deprecated_pairs:
3489
 
                info = self.get_info(key)
3490
 
                other_output += wrapped(key, help, info)
3491
 
        else:
3492
 
            other_output += \
3493
 
                "\nNo deprecated formats are available.\n\n"
3494
 
        other_output += \
3495
 
            "\nSee ``bzr help formats`` for more about storage formats."
3496
 
 
3497
 
        if topic == 'other-formats':
3498
 
            return other_output
3499
 
        else:
3500
 
            return output
 
1709
class ConvertMetaToColo(controldir.Converter):
 
1710
    """Add colocated branch support."""
 
1711
 
 
1712
    def __init__(self, target_format):
 
1713
        """Create a converter.that upgrades a metadir to the colo format.
 
1714
 
 
1715
        :param target_format: The final metadir format that is desired.
 
1716
        """
 
1717
        self.target_format = target_format
 
1718
 
 
1719
    def convert(self, to_convert, pb):
 
1720
        """See Converter.convert()."""
 
1721
        to_convert.transport.put_bytes('branch-format',
 
1722
            self.target_format.get_format_string())
 
1723
        return BzrDir.open_from_transport(to_convert.root_transport)
 
1724
 
 
1725
 
 
1726
class ConvertMetaRemoveColo(controldir.Converter):
 
1727
    """Remove colocated branch support from a bzrdir."""
 
1728
 
 
1729
    def __init__(self, target_format):
 
1730
        """Create a converter.that downgrades a colocated branch metadir
 
1731
        to a regular metadir.
 
1732
 
 
1733
        :param target_format: The final metadir format that is desired.
 
1734
        """
 
1735
        self.target_format = target_format
 
1736
 
 
1737
    def convert(self, to_convert, pb):
 
1738
        """See Converter.convert()."""
 
1739
        to_convert.control_files.lock_write()
 
1740
        try:
 
1741
            branches = to_convert.list_branches()
 
1742
            if len(branches) > 1:
 
1743
                raise errors.BzrError("remove all but a single "
 
1744
                    "colocated branch when downgrading")
 
1745
        finally:
 
1746
            to_convert.control_files.unlock()
 
1747
        to_convert.transport.put_bytes('branch-format',
 
1748
            self.target_format.get_format_string())
 
1749
        return BzrDir.open_from_transport(to_convert.root_transport)
 
1750
 
 
1751
 
 
1752
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
3501
1753
 
3502
1754
 
3503
1755
class RepositoryAcquisitionPolicy(object):
3532
1784
            try:
3533
1785
                stack_on = urlutils.rebase_url(self._stack_on,
3534
1786
                    self._stack_on_pwd,
3535
 
                    branch.bzrdir.root_transport.base)
 
1787
                    branch.user_url)
3536
1788
            except errors.InvalidRebaseURLs:
3537
1789
                stack_on = self._get_full_stack_on()
3538
1790
        try:
3542
1794
            if self._require_stacking:
3543
1795
                raise
3544
1796
 
 
1797
    def requires_stacking(self):
 
1798
        """Return True if this policy requires stacking."""
 
1799
        return self._stack_on is not None and self._require_stacking
 
1800
 
3545
1801
    def _get_full_stack_on(self):
3546
1802
        """Get a fully-qualified URL for the stack_on location."""
3547
1803
        if self._stack_on is None:
3580
1836
 
3581
1837
        Implementations may create a new repository or use a pre-exising
3582
1838
        repository.
 
1839
 
3583
1840
        :param make_working_trees: If creating a repository, set
3584
1841
            make_working_trees to this value (if non-None)
3585
1842
        :param shared: If creating a repository, make it shared if True
3594
1851
 
3595
1852
    def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3596
1853
                 require_stacking=False):
3597
 
        """
3598
 
        Constructor.
 
1854
        """Constructor.
 
1855
 
3599
1856
        :param bzrdir: The bzrdir to create the repository on.
3600
1857
        :param stack_on: A location to stack on
3601
1858
        :param stack_on_pwd: If stack_on is relative, the location it is
3617
1874
                                    possible_transports=[self._bzrdir.root_transport])
3618
1875
            if not self._require_stacking:
3619
1876
                # We have picked up automatic stacking somewhere.
3620
 
                note('Using default stacking branch %s at %s', self._stack_on,
3621
 
                    self._stack_on_pwd)
 
1877
                note(gettext('Using default stacking branch {0} at {1}').format(
 
1878
                    self._stack_on, self._stack_on_pwd))
3622
1879
        repository = self._bzrdir.create_repository(shared=shared)
3623
1880
        self._add_fallback(repository,
3624
1881
                           possible_transports=[self._bzrdir.transport])
3653
1910
        return self._repository, False
3654
1911
 
3655
1912
 
3656
 
# Please register new formats after old formats so that formats
3657
 
# appear in chronological order and format descriptions can build
3658
 
# on previous ones.
3659
 
format_registry = BzrDirFormatRegistry()
3660
 
# The pre-0.8 formats have their repository format network name registered in
3661
 
# repository.py. MetaDir formats have their repository format network name
3662
 
# inferred from their disk format string.
3663
 
format_registry.register('weave', BzrDirFormat6,
3664
 
    'Pre-0.8 format.  Slower than knit and does not'
3665
 
    ' support checkouts or shared repositories.',
3666
 
    deprecated=True)
3667
 
format_registry.register_metadir('metaweave',
3668
 
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3669
 
    'Transitional format in 0.8.  Slower than knit.',
3670
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
3671
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3672
 
    deprecated=True)
3673
 
format_registry.register_metadir('knit',
 
1913
def register_metadir(registry, key,
 
1914
         repository_format, help, native=True, deprecated=False,
 
1915
         branch_format=None,
 
1916
         tree_format=None,
 
1917
         hidden=False,
 
1918
         experimental=False,
 
1919
         alias=False, bzrdir_format=None):
 
1920
    """Register a metadir subformat.
 
1921
 
 
1922
    These all use a meta bzrdir, but can be parameterized by the
 
1923
    Repository/Branch/WorkingTreeformats.
 
1924
 
 
1925
    :param repository_format: The fully-qualified repository format class
 
1926
        name as a string.
 
1927
    :param branch_format: Fully-qualified branch format class name as
 
1928
        a string.
 
1929
    :param tree_format: Fully-qualified tree format class name as
 
1930
        a string.
 
1931
    """
 
1932
    if bzrdir_format is None:
 
1933
        bzrdir_format = BzrDirMetaFormat1
 
1934
    # This should be expanded to support setting WorkingTree and Branch
 
1935
    # formats, once the API supports that.
 
1936
    def _load(full_name):
 
1937
        mod_name, factory_name = full_name.rsplit('.', 1)
 
1938
        try:
 
1939
            factory = pyutils.get_named_object(mod_name, factory_name)
 
1940
        except ImportError, e:
 
1941
            raise ImportError('failed to load %s: %s' % (full_name, e))
 
1942
        except AttributeError:
 
1943
            raise AttributeError('no factory %s in module %r'
 
1944
                % (full_name, sys.modules[mod_name]))
 
1945
        return factory()
 
1946
 
 
1947
    def helper():
 
1948
        bd = bzrdir_format()
 
1949
        if branch_format is not None:
 
1950
            bd.set_branch_format(_load(branch_format))
 
1951
        if tree_format is not None:
 
1952
            bd.workingtree_format = _load(tree_format)
 
1953
        if repository_format is not None:
 
1954
            bd.repository_format = _load(repository_format)
 
1955
        return bd
 
1956
    registry.register(key, helper, help, native, deprecated, hidden,
 
1957
        experimental, alias)
 
1958
 
 
1959
register_metadir(controldir.format_registry, 'knit',
3674
1960
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3675
1961
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
3676
1962
    branch_format='bzrlib.branch.BzrBranchFormat5',
3677
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
 
1963
    tree_format='bzrlib.workingtree_3.WorkingTreeFormat3',
 
1964
    hidden=True,
3678
1965
    deprecated=True)
3679
 
format_registry.register_metadir('dirstate',
 
1966
register_metadir(controldir.format_registry, 'dirstate',
3680
1967
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3681
1968
    help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3682
1969
        'above when accessed over the network.',
3683
1970
    branch_format='bzrlib.branch.BzrBranchFormat5',
3684
 
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3685
 
    # directly from workingtree_4 triggers a circular import.
3686
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
1971
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
1972
    hidden=True,
3687
1973
    deprecated=True)
3688
 
format_registry.register_metadir('dirstate-tags',
 
1974
register_metadir(controldir.format_registry, 'dirstate-tags',
3689
1975
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3690
1976
    help='New in 0.15: Fast local operations and improved scaling for '
3691
1977
        'network operations. Additionally adds support for tags.'
3692
1978
        ' Incompatible with bzr < 0.15.',
3693
1979
    branch_format='bzrlib.branch.BzrBranchFormat6',
3694
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
1980
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
1981
    hidden=True,
3695
1982
    deprecated=True)
3696
 
format_registry.register_metadir('rich-root',
 
1983
register_metadir(controldir.format_registry, 'rich-root',
3697
1984
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3698
1985
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
3699
1986
        ' bzr < 1.0.',
3700
1987
    branch_format='bzrlib.branch.BzrBranchFormat6',
3701
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
1988
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
1989
    hidden=True,
3702
1990
    deprecated=True)
3703
 
format_registry.register_metadir('dirstate-with-subtree',
 
1991
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
3704
1992
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3705
1993
    help='New in 0.15: Fast local operations and improved scaling for '
3706
1994
        'network operations. Additionally adds support for versioning nested '
3707
1995
        'bzr branches. Incompatible with bzr < 0.15.',
3708
1996
    branch_format='bzrlib.branch.BzrBranchFormat6',
3709
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
1997
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3710
1998
    experimental=True,
3711
1999
    hidden=True,
3712
2000
    )
3713
 
format_registry.register_metadir('pack-0.92',
3714
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
 
2001
register_metadir(controldir.format_registry, 'pack-0.92',
 
2002
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack1',
3715
2003
    help='New in 0.92: Pack-based format with data compatible with '
3716
2004
        'dirstate-tags format repositories. Interoperates with '
3717
2005
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3718
 
        'Previously called knitpack-experimental.  '
3719
 
        'For more information, see '
3720
 
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
 
2006
        ,
3721
2007
    branch_format='bzrlib.branch.BzrBranchFormat6',
3722
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2008
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3723
2009
    )
3724
 
format_registry.register_metadir('pack-0.92-subtree',
3725
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
 
2010
register_metadir(controldir.format_registry, 'pack-0.92-subtree',
 
2011
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack3',
3726
2012
    help='New in 0.92: Pack-based format with data compatible with '
3727
2013
        'dirstate-with-subtree format repositories. Interoperates with '
3728
2014
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3729
 
        'Previously called knitpack-experimental.  '
3730
 
        'For more information, see '
3731
 
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
 
2015
        ,
3732
2016
    branch_format='bzrlib.branch.BzrBranchFormat6',
3733
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2017
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3734
2018
    hidden=True,
3735
2019
    experimental=True,
3736
2020
    )
3737
 
format_registry.register_metadir('rich-root-pack',
3738
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
 
2021
register_metadir(controldir.format_registry, 'rich-root-pack',
 
2022
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack4',
3739
2023
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3740
2024
         '(needed for bzr-svn and bzr-git).',
3741
2025
    branch_format='bzrlib.branch.BzrBranchFormat6',
3742
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2026
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2027
    hidden=True,
3743
2028
    )
3744
 
format_registry.register_metadir('1.6',
3745
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
 
2029
register_metadir(controldir.format_registry, '1.6',
 
2030
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5',
3746
2031
    help='A format that allows a branch to indicate that there is another '
3747
2032
         '(stacked) repository that should be used to access data that is '
3748
2033
         'not present locally.',
3749
2034
    branch_format='bzrlib.branch.BzrBranchFormat7',
3750
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2035
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2036
    hidden=True,
3751
2037
    )
3752
 
format_registry.register_metadir('1.6.1-rich-root',
3753
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
 
2038
register_metadir(controldir.format_registry, '1.6.1-rich-root',
 
2039
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5RichRoot',
3754
2040
    help='A variant of 1.6 that supports rich-root data '
3755
2041
         '(needed for bzr-svn and bzr-git).',
3756
2042
    branch_format='bzrlib.branch.BzrBranchFormat7',
3757
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2043
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2044
    hidden=True,
3758
2045
    )
3759
 
format_registry.register_metadir('1.9',
3760
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
 
2046
register_metadir(controldir.format_registry, '1.9',
 
2047
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
3761
2048
    help='A repository format using B+tree indexes. These indexes '
3762
2049
         'are smaller in size, have smarter caching and provide faster '
3763
2050
         'performance for most operations.',
3764
2051
    branch_format='bzrlib.branch.BzrBranchFormat7',
3765
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2052
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2053
    hidden=True,
3766
2054
    )
3767
 
format_registry.register_metadir('1.9-rich-root',
3768
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
 
2055
register_metadir(controldir.format_registry, '1.9-rich-root',
 
2056
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
3769
2057
    help='A variant of 1.9 that supports rich-root data '
3770
2058
         '(needed for bzr-svn and bzr-git).',
3771
2059
    branch_format='bzrlib.branch.BzrBranchFormat7',
3772
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2060
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2061
    hidden=True,
3773
2062
    )
3774
 
format_registry.register_metadir('1.14',
3775
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
 
2063
register_metadir(controldir.format_registry, '1.14',
 
2064
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
3776
2065
    help='A working-tree format that supports content filtering.',
3777
2066
    branch_format='bzrlib.branch.BzrBranchFormat7',
3778
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
 
2067
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
3779
2068
    )
3780
 
format_registry.register_metadir('1.14-rich-root',
3781
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
 
2069
register_metadir(controldir.format_registry, '1.14-rich-root',
 
2070
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
3782
2071
    help='A variant of 1.14 that supports rich-root data '
3783
2072
         '(needed for bzr-svn and bzr-git).',
3784
2073
    branch_format='bzrlib.branch.BzrBranchFormat7',
3785
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
 
2074
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
3786
2075
    )
3787
2076
# The following un-numbered 'development' formats should always just be aliases.
3788
 
format_registry.register_metadir('development-rich-root',
3789
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3790
 
    help='Current development format. Supports rich roots. Can convert data '
3791
 
        'to and from rich-root-pack (and anything compatible with '
3792
 
        'rich-root-pack) format repositories. Repositories and branches in '
3793
 
        'this format can only be read by bzr.dev. Please read '
3794
 
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3795
 
        'before use.',
3796
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3797
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3798
 
    experimental=True,
3799
 
    alias=True,
3800
 
    )
3801
 
format_registry.register_metadir('development-subtree',
3802
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
 
2077
register_metadir(controldir.format_registry, 'development-subtree',
 
2078
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2aSubtree',
3803
2079
    help='Current development format, subtree variant. Can convert data to and '
3804
2080
        'from pack-0.92-subtree (and anything compatible with '
3805
2081
        'pack-0.92-subtree) format repositories. Repositories and branches in '
3806
2082
        'this format can only be read by bzr.dev. Please read '
3807
 
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
2083
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3808
2084
        'before use.',
3809
2085
    branch_format='bzrlib.branch.BzrBranchFormat7',
3810
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
2086
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
3811
2087
    experimental=True,
 
2088
    hidden=True,
3812
2089
    alias=False, # Restore to being an alias when an actual development subtree format is added
3813
2090
                 # This current non-alias status is simply because we did not introduce a
3814
2091
                 # chk based subtree format.
3815
2092
    )
 
2093
register_metadir(controldir.format_registry, 'development5-subtree',
 
2094
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatPackDevelopment2Subtree',
 
2095
    help='Development format, subtree variant. Can convert data to and '
 
2096
        'from pack-0.92-subtree (and anything compatible with '
 
2097
        'pack-0.92-subtree) format repositories. Repositories and branches in '
 
2098
        'this format can only be read by bzr.dev. Please read '
 
2099
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
2100
        'before use.',
 
2101
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2102
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
2103
    experimental=True,
 
2104
    hidden=True,
 
2105
    alias=False,
 
2106
    )
 
2107
 
 
2108
register_metadir(controldir.format_registry, 'development-colo',
 
2109
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
 
2110
    help='The 2a format with experimental support for colocated branches.\n',
 
2111
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2112
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
2113
    experimental=False,
 
2114
    bzrdir_format=BzrDirMetaFormat1Colo,
 
2115
    )
 
2116
 
3816
2117
 
3817
2118
# And the development formats above will have aliased one of the following:
3818
 
format_registry.register_metadir('development6-rich-root',
3819
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3820
 
    help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
3821
 
        'Please read '
3822
 
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3823
 
        'before use.',
3824
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3825
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3826
 
    hidden=True,
3827
 
    experimental=True,
3828
 
    )
3829
 
 
3830
 
format_registry.register_metadir('development7-rich-root',
3831
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
3832
 
    help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
3833
 
        'rich roots. Please read '
3834
 
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3835
 
        'before use.',
3836
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3837
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3838
 
    hidden=True,
3839
 
    experimental=True,
3840
 
    )
3841
 
 
3842
 
format_registry.register_metadir('2a',
 
2119
 
 
2120
# Finally, the current format.
 
2121
register_metadir(controldir.format_registry, '2a',
3843
2122
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3844
2123
    help='First format for bzr 2.0 series.\n'
3845
2124
        'Uses group-compress storage.\n'
3847
2126
        # 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
3848
2127
        # 'rich roots. Supported by bzr 1.16 and later.',
3849
2128
    branch_format='bzrlib.branch.BzrBranchFormat7',
3850
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3851
 
    experimental=True,
 
2129
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
2130
    experimental=False,
3852
2131
    )
3853
2132
 
3854
2133
# The following format should be an alias for the rich root equivalent 
3855
2134
# of the default format
3856
 
format_registry.register_metadir('default-rich-root',
3857
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3858
 
    help='Default format, rich root variant. (needed for bzr-svn and bzr-git).',
3859
 
    branch_format='bzrlib.branch.BzrBranchFormat6',
3860
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
2135
register_metadir(controldir.format_registry, 'default-rich-root',
 
2136
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
 
2137
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2138
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
3861
2139
    alias=True,
3862
 
    )
 
2140
    hidden=True,
 
2141
    help='Same as 2a.')
 
2142
 
3863
2143
# The current format that is made on 'bzr init'.
3864
 
format_registry.set_default('pack-0.92')
 
2144
format_name = config.GlobalStack().get('default_format')
 
2145
controldir.format_registry.set_default(format_name)
 
2146
 
 
2147
# XXX 2010-08-20 JRV: There is still a lot of code relying on
 
2148
# bzrlib.bzrdir.format_registry existing. When BzrDir.create/BzrDir.open/etc
 
2149
# get changed to ControlDir.create/ControlDir.open/etc this should be removed.
 
2150
format_registry = controldir.format_registry