~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

(gz) Change minimum required testtools version for selftest to 0.9.5 for
 unicode fixes (Martin [gz])

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
25
25
objects returned.
26
26
"""
27
27
 
 
28
# TODO: Move old formats into a plugin to make this file smaller.
 
29
 
 
30
import os
28
31
import sys
 
32
import warnings
29
33
 
30
34
from bzrlib.lazy_import import lazy_import
31
35
lazy_import(globals(), """
 
36
from stat import S_ISDIR
 
37
 
32
38
import bzrlib
33
39
from bzrlib import (
34
 
    branch as _mod_branch,
35
 
    cleanup,
 
40
    branch,
36
41
    config,
37
42
    controldir,
38
43
    errors,
39
 
    fetch,
40
44
    graph,
41
45
    lockable_files,
42
46
    lockdir,
45
49
    remote,
46
50
    repository,
47
51
    revision as _mod_revision,
48
 
    transport as _mod_transport,
49
52
    ui,
50
53
    urlutils,
 
54
    versionedfile,
51
55
    win32utils,
52
56
    workingtree,
53
57
    workingtree_4,
54
 
    )
55
 
from bzrlib.repofmt import knitpack_repo
 
58
    xml4,
 
59
    xml5,
 
60
    )
 
61
from bzrlib.osutils import (
 
62
    sha_string,
 
63
    )
 
64
from bzrlib.push import (
 
65
    PushResult,
 
66
    )
 
67
from bzrlib.repofmt import pack_repo
 
68
from bzrlib.smart.client import _SmartClient
 
69
from bzrlib.store.versioned import WeaveStore
 
70
from bzrlib.transactions import WriteTransaction
56
71
from bzrlib.transport import (
57
72
    do_catching_redirections,
 
73
    get_transport,
58
74
    local,
59
75
    )
 
76
from bzrlib.weave import Weave
60
77
""")
61
78
 
62
79
from bzrlib.trace import (
63
80
    mutter,
64
81
    note,
 
82
    warning,
65
83
    )
66
84
 
67
85
from bzrlib import (
68
86
    hooks,
69
87
    registry,
 
88
    symbol_versioning,
70
89
    )
71
90
from bzrlib.symbol_versioning import (
72
91
    deprecated_in,
123
142
            # No repo, no problem.
124
143
            pass
125
144
 
 
145
    @staticmethod
 
146
    def _check_supported(format, allow_unsupported,
 
147
        recommend_upgrade=True,
 
148
        basedir=None):
 
149
        """Give an error or warning on old formats.
 
150
 
 
151
        :param format: may be any kind of format - workingtree, branch,
 
152
        or repository.
 
153
 
 
154
        :param allow_unsupported: If true, allow opening
 
155
        formats that are strongly deprecated, and which may
 
156
        have limited functionality.
 
157
 
 
158
        :param recommend_upgrade: If true (default), warn
 
159
        the user through the ui object that they may wish
 
160
        to upgrade the object.
 
161
        """
 
162
        # TODO: perhaps move this into a base Format class; it's not BzrDir
 
163
        # specific. mbp 20070323
 
164
        if not allow_unsupported and not format.is_supported():
 
165
            # see open_downlevel to open legacy branches.
 
166
            raise errors.UnsupportedFormatError(format=format)
 
167
        if recommend_upgrade \
 
168
            and getattr(format, 'upgrade_recommended', False):
 
169
            ui.ui_factory.recommend_upgrade(
 
170
                format.get_format_description(),
 
171
                basedir)
 
172
 
126
173
    def clone_on_transport(self, transport, revision_id=None,
127
174
        force_new_repo=False, preserve_stacking=False, stacked_on=None,
128
175
        create_prefix=False, use_existing_dir=True, no_tree=False):
140
187
        :param create_prefix: Create any missing directories leading up to
141
188
            to_transport.
142
189
        :param use_existing_dir: Use an existing directory if one exists.
143
 
        :param no_tree: If set to true prevents creation of a working tree.
144
190
        """
145
191
        # Overview: put together a broad description of what we want to end up
146
192
        # with; then make as few api calls as possible to do it.
229
275
    # TODO: This should be given a Transport, and should chdir up; otherwise
230
276
    # this will open a new connection.
231
277
    def _make_tail(self, url):
232
 
        t = _mod_transport.get_transport(url)
 
278
        t = get_transport(url)
233
279
        t.ensure_base()
234
280
 
235
281
    @staticmethod
388
434
        policy = self.determine_repository_policy(force_new_repo)
389
435
        return policy.acquire_repository()[0]
390
436
 
391
 
    def _find_source_repo(self, add_cleanup, source_branch):
392
 
        """Find the source branch and repo for a sprout operation.
393
 
        
394
 
        This is helper intended for use by _sprout.
395
 
 
396
 
        :returns: (source_branch, source_repository).  Either or both may be
397
 
            None.  If not None, they will be read-locked (and their unlock(s)
398
 
            scheduled via the add_cleanup param).
399
 
        """
400
 
        if source_branch is not None:
401
 
            add_cleanup(source_branch.lock_read().unlock)
402
 
            return source_branch, source_branch.repository
403
 
        try:
404
 
            source_branch = self.open_branch()
405
 
            source_repository = source_branch.repository
406
 
        except errors.NotBranchError:
407
 
            source_branch = None
408
 
            try:
409
 
                source_repository = self.open_repository()
410
 
            except errors.NoRepositoryPresent:
411
 
                source_repository = None
412
 
            else:
413
 
                add_cleanup(source_repository.lock_read().unlock)
414
 
        else:
415
 
            add_cleanup(source_branch.lock_read().unlock)
416
 
        return source_branch, source_repository
417
 
 
418
 
    def sprout(self, url, revision_id=None, force_new_repo=False,
419
 
               recurse='down', possible_transports=None,
420
 
               accelerator_tree=None, hardlink=False, stacked=False,
421
 
               source_branch=None, create_tree_if_local=True):
422
 
        """Create a copy of this controldir prepared for use as a new line of
423
 
        development.
424
 
 
425
 
        If url's last component does not exist, it will be created.
426
 
 
427
 
        Attributes related to the identity of the source branch like
428
 
        branch nickname will be cleaned, a working tree is created
429
 
        whether one existed before or not; and a local branch is always
430
 
        created.
431
 
 
432
 
        if revision_id is not None, then the clone operation may tune
433
 
            itself to download less data.
434
 
        :param accelerator_tree: A tree which can be used for retrieving file
435
 
            contents more quickly than the revision tree, i.e. a workingtree.
436
 
            The revision tree will be used for cases where accelerator_tree's
437
 
            content is different.
438
 
        :param hardlink: If true, hard-link files from accelerator_tree,
439
 
            where possible.
440
 
        :param stacked: If true, create a stacked branch referring to the
441
 
            location of this control directory.
442
 
        :param create_tree_if_local: If true, a working-tree will be created
443
 
            when working locally.
444
 
        """
445
 
        operation = cleanup.OperationWithCleanups(self._sprout)
446
 
        return operation.run(url, revision_id=revision_id,
447
 
            force_new_repo=force_new_repo, recurse=recurse,
448
 
            possible_transports=possible_transports,
449
 
            accelerator_tree=accelerator_tree, hardlink=hardlink,
450
 
            stacked=stacked, source_branch=source_branch,
451
 
            create_tree_if_local=create_tree_if_local)
452
 
 
453
 
    def _sprout(self, op, url, revision_id=None, force_new_repo=False,
454
 
               recurse='down', possible_transports=None,
455
 
               accelerator_tree=None, hardlink=False, stacked=False,
456
 
               source_branch=None, create_tree_if_local=True):
457
 
        add_cleanup = op.add_cleanup
458
 
        fetch_spec_factory = fetch.FetchSpecFactory()
459
 
        if revision_id is not None:
460
 
            fetch_spec_factory.add_revision_ids([revision_id])
461
 
            fetch_spec_factory.source_branch_stop_revision_id = revision_id
462
 
        target_transport = _mod_transport.get_transport(url,
463
 
            possible_transports)
464
 
        target_transport.ensure_base()
465
 
        cloning_format = self.cloning_metadir(stacked)
466
 
        # Create/update the result branch
467
 
        result = cloning_format.initialize_on_transport(target_transport)
468
 
        source_branch, source_repository = self._find_source_repo(
469
 
            add_cleanup, source_branch)
470
 
        fetch_spec_factory.source_branch = source_branch
471
 
        # if a stacked branch wasn't requested, we don't create one
472
 
        # even if the origin was stacked
473
 
        if stacked and source_branch is not None:
474
 
            stacked_branch_url = self.root_transport.base
475
 
        else:
476
 
            stacked_branch_url = None
477
 
        repository_policy = result.determine_repository_policy(
478
 
            force_new_repo, stacked_branch_url, require_stacking=stacked)
479
 
        result_repo, is_new_repo = repository_policy.acquire_repository()
480
 
        add_cleanup(result_repo.lock_write().unlock)
481
 
        fetch_spec_factory.source_repo = source_repository
482
 
        fetch_spec_factory.target_repo = result_repo
483
 
        if stacked or (len(result_repo._fallback_repositories) != 0):
484
 
            target_repo_kind = fetch.TargetRepoKinds.STACKED
485
 
        elif is_new_repo:
486
 
            target_repo_kind = fetch.TargetRepoKinds.EMPTY
487
 
        else:
488
 
            target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
489
 
        fetch_spec_factory.target_repo_kind = target_repo_kind
490
 
        if source_repository is not None:
491
 
            fetch_spec = fetch_spec_factory.make_fetch_spec()
492
 
            result_repo.fetch(source_repository, fetch_spec=fetch_spec)
493
 
 
494
 
        if source_branch is None:
495
 
            # this is for sprouting a controldir without a branch; is that
496
 
            # actually useful?
497
 
            # Not especially, but it's part of the contract.
498
 
            result_branch = result.create_branch()
499
 
        else:
500
 
            result_branch = source_branch.sprout(result,
501
 
                revision_id=revision_id, repository_policy=repository_policy,
502
 
                repository=result_repo)
503
 
        mutter("created new branch %r" % (result_branch,))
504
 
 
505
 
        # Create/update the result working tree
506
 
        if (create_tree_if_local and
507
 
            isinstance(target_transport, local.LocalTransport) and
508
 
            (result_repo is None or result_repo.make_working_trees())):
509
 
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
510
 
                hardlink=hardlink, from_branch=result_branch)
511
 
            wt.lock_write()
512
 
            try:
513
 
                if wt.path2id('') is None:
514
 
                    try:
515
 
                        wt.set_root_id(self.open_workingtree.get_root_id())
516
 
                    except errors.NoWorkingTree:
517
 
                        pass
518
 
            finally:
519
 
                wt.unlock()
520
 
        else:
521
 
            wt = None
522
 
        if recurse == 'down':
523
 
            basis = None
524
 
            if wt is not None:
525
 
                basis = wt.basis_tree()
526
 
            elif result_branch is not None:
527
 
                basis = result_branch.basis_tree()
528
 
            elif source_branch is not None:
529
 
                basis = source_branch.basis_tree()
530
 
            if basis is not None:
531
 
                add_cleanup(basis.lock_read().unlock)
532
 
                subtrees = basis.iter_references()
533
 
            else:
534
 
                subtrees = []
535
 
            for path, file_id in subtrees:
536
 
                target = urlutils.join(url, urlutils.escape(path))
537
 
                sublocation = source_branch.reference_parent(file_id, path)
538
 
                sublocation.bzrdir.sprout(target,
539
 
                    basis.get_reference_revision(file_id, path),
540
 
                    force_new_repo=force_new_repo, recurse=recurse,
541
 
                    stacked=stacked)
542
 
        return result
543
 
 
544
 
 
545
 
 
546
437
    @staticmethod
547
438
    def create_branch_convenience(base, force_new_repo=False,
548
439
                                  force_new_tree=None, format=None,
574
465
        """
575
466
        if force_new_tree:
576
467
            # check for non local urls
577
 
            t = _mod_transport.get_transport(base, possible_transports)
 
468
            t = get_transport(base, possible_transports)
578
469
            if not isinstance(t, local.LocalTransport):
579
470
                raise errors.NotLocalUrl(base)
580
471
        bzrdir = BzrDir.create(base, format, possible_transports)
602
493
        :param format: Override for the bzrdir format to create.
603
494
        :return: The WorkingTree object.
604
495
        """
605
 
        t = _mod_transport.get_transport(base)
 
496
        t = get_transport(base)
606
497
        if not isinstance(t, local.LocalTransport):
607
498
            raise errors.NotLocalUrl(base)
608
499
        bzrdir = BzrDir.create_branch_and_repo(base,
822
713
 
823
714
        :param _unsupported: a private parameter to the BzrDir class.
824
715
        """
825
 
        t = _mod_transport.get_transport(base, possible_transports)
 
716
        t = get_transport(base, possible_transports=possible_transports)
826
717
        return BzrDir.open_from_transport(t, _unsupported=_unsupported)
827
718
 
828
719
    @staticmethod
857
748
        except errors.TooManyRedirections:
858
749
            raise errors.NotBranchError(base)
859
750
 
860
 
        format.check_support_status(_unsupported)
 
751
        BzrDir._check_supported(format, _unsupported)
861
752
        return format.open(transport, _found=True)
862
753
 
863
754
    @staticmethod
867
758
        :param url: url to search from.
868
759
        See open_containing_from_transport for more detail.
869
760
        """
870
 
        transport = _mod_transport.get_transport(url, possible_transports)
 
761
        transport = get_transport(url, possible_transports)
871
762
        return BzrDir.open_containing_from_transport(transport)
872
763
 
873
764
    @staticmethod
1029
920
        if cls is not BzrDir:
1030
921
            raise AssertionError("BzrDir.create always creates the"
1031
922
                "default format, not one of %r" % cls)
1032
 
        t = _mod_transport.get_transport(base, possible_transports)
 
923
        t = get_transport(base, possible_transports)
1033
924
        t.ensure_base()
1034
925
        if format is None:
1035
926
            format = controldir.ControlDirFormat.get_default_format()
1036
927
        return format.initialize_on_transport(t)
1037
928
 
1038
 
    def get_branch_transport(self, branch_format, name=None):
1039
 
        """Get the transport for use by branch format in this BzrDir.
1040
 
 
1041
 
        Note that bzr dirs that do not support format strings will raise
1042
 
        IncompatibleFormat if the branch format they are given has
1043
 
        a format string, and vice versa.
1044
 
 
1045
 
        If branch_format is None, the transport is returned with no
1046
 
        checking. If it is not None, then the returned transport is
1047
 
        guaranteed to point to an existing directory ready for use.
1048
 
        """
1049
 
        raise NotImplementedError(self.get_branch_transport)
1050
 
 
1051
 
    def get_repository_transport(self, repository_format):
1052
 
        """Get the transport for use by repository format in this BzrDir.
1053
 
 
1054
 
        Note that bzr dirs that do not support format strings will raise
1055
 
        IncompatibleFormat if the repository format they are given has
1056
 
        a format string, and vice versa.
1057
 
 
1058
 
        If repository_format is None, the transport is returned with no
1059
 
        checking. If it is not None, then the returned transport is
1060
 
        guaranteed to point to an existing directory ready for use.
1061
 
        """
1062
 
        raise NotImplementedError(self.get_repository_transport)
1063
 
 
1064
 
    def get_workingtree_transport(self, tree_format):
1065
 
        """Get the transport for use by workingtree format in this BzrDir.
1066
 
 
1067
 
        Note that bzr dirs that do not support format strings will raise
1068
 
        IncompatibleFormat if the workingtree format they are given has a
1069
 
        format string, and vice versa.
1070
 
 
1071
 
        If workingtree_format is None, the transport is returned with no
1072
 
        checking. If it is not None, then the returned transport is
1073
 
        guaranteed to point to an existing directory ready for use.
1074
 
        """
1075
 
        raise NotImplementedError(self.get_workingtree_transport)
1076
929
 
1077
930
 
1078
931
class BzrDirHooks(hooks.Hooks):
1080
933
 
1081
934
    def __init__(self):
1082
935
        """Create the default hooks."""
1083
 
        hooks.Hooks.__init__(self, "bzrlib.bzrdir", "BzrDir.hooks")
1084
 
        self.add_hook('pre_open',
 
936
        hooks.Hooks.__init__(self)
 
937
        self.create_hook(hooks.HookPoint('pre_open',
1085
938
            "Invoked before attempting to open a BzrDir with the transport "
1086
 
            "that the open will use.", (1, 14))
1087
 
        self.add_hook('post_repo_init',
 
939
            "that the open will use.", (1, 14), None))
 
940
        self.create_hook(hooks.HookPoint('post_repo_init',
1088
941
            "Invoked after a repository has been initialized. "
1089
942
            "post_repo_init is called with a "
1090
943
            "bzrlib.bzrdir.RepoInitHookParams.",
1091
 
            (2, 2))
 
944
            (2, 2), None))
1092
945
 
1093
946
# install the default hooks
1094
947
BzrDir.hooks = BzrDirHooks()
1130
983
                self.bzrdir)
1131
984
 
1132
985
 
 
986
class BzrDirPreSplitOut(BzrDir):
 
987
    """A common class for the all-in-one formats."""
 
988
 
 
989
    def __init__(self, _transport, _format):
 
990
        """See BzrDir.__init__."""
 
991
        super(BzrDirPreSplitOut, self).__init__(_transport, _format)
 
992
        self._control_files = lockable_files.LockableFiles(
 
993
                                            self.get_branch_transport(None),
 
994
                                            self._format._lock_file_name,
 
995
                                            self._format._lock_class)
 
996
 
 
997
    def break_lock(self):
 
998
        """Pre-splitout bzrdirs do not suffer from stale locks."""
 
999
        raise NotImplementedError(self.break_lock)
 
1000
 
 
1001
    def cloning_metadir(self, require_stacking=False):
 
1002
        """Produce a metadir suitable for cloning with."""
 
1003
        if require_stacking:
 
1004
            return controldir.format_registry.make_bzrdir('1.6')
 
1005
        return self._format.__class__()
 
1006
 
 
1007
    def clone(self, url, revision_id=None, force_new_repo=False,
 
1008
              preserve_stacking=False):
 
1009
        """See BzrDir.clone().
 
1010
 
 
1011
        force_new_repo has no effect, since this family of formats always
 
1012
        require a new repository.
 
1013
        preserve_stacking has no effect, since no source branch using this
 
1014
        family of formats can be stacked, so there is no stacking to preserve.
 
1015
        """
 
1016
        self._make_tail(url)
 
1017
        result = self._format._initialize_for_clone(url)
 
1018
        self.open_repository().clone(result, revision_id=revision_id)
 
1019
        from_branch = self.open_branch()
 
1020
        from_branch.clone(result, revision_id=revision_id)
 
1021
        try:
 
1022
            tree = self.open_workingtree()
 
1023
        except errors.NotLocalUrl:
 
1024
            # make a new one, this format always has to have one.
 
1025
            result._init_workingtree()
 
1026
        else:
 
1027
            tree.clone(result)
 
1028
        return result
 
1029
 
 
1030
    def create_branch(self, name=None):
 
1031
        """See BzrDir.create_branch."""
 
1032
        return self._format.get_branch_format().initialize(self, name=name)
 
1033
 
 
1034
    def destroy_branch(self, name=None):
 
1035
        """See BzrDir.destroy_branch."""
 
1036
        raise errors.UnsupportedOperation(self.destroy_branch, self)
 
1037
 
 
1038
    def create_repository(self, shared=False):
 
1039
        """See BzrDir.create_repository."""
 
1040
        if shared:
 
1041
            raise errors.IncompatibleFormat('shared repository', self._format)
 
1042
        return self.open_repository()
 
1043
 
 
1044
    def destroy_repository(self):
 
1045
        """See BzrDir.destroy_repository."""
 
1046
        raise errors.UnsupportedOperation(self.destroy_repository, self)
 
1047
 
 
1048
    def create_workingtree(self, revision_id=None, from_branch=None,
 
1049
                           accelerator_tree=None, hardlink=False):
 
1050
        """See BzrDir.create_workingtree."""
 
1051
        # The workingtree is sometimes created when the bzrdir is created,
 
1052
        # but not when cloning.
 
1053
 
 
1054
        # this looks buggy but is not -really-
 
1055
        # because this format creates the workingtree when the bzrdir is
 
1056
        # created
 
1057
        # clone and sprout will have set the revision_id
 
1058
        # and that will have set it for us, its only
 
1059
        # specific uses of create_workingtree in isolation
 
1060
        # that can do wonky stuff here, and that only
 
1061
        # happens for creating checkouts, which cannot be
 
1062
        # done on this format anyway. So - acceptable wart.
 
1063
        if hardlink:
 
1064
            warning("can't support hardlinked working trees in %r"
 
1065
                % (self,))
 
1066
        try:
 
1067
            result = self.open_workingtree(recommend_upgrade=False)
 
1068
        except errors.NoSuchFile:
 
1069
            result = self._init_workingtree()
 
1070
        if revision_id is not None:
 
1071
            if revision_id == _mod_revision.NULL_REVISION:
 
1072
                result.set_parent_ids([])
 
1073
            else:
 
1074
                result.set_parent_ids([revision_id])
 
1075
        return result
 
1076
 
 
1077
    def _init_workingtree(self):
 
1078
        from bzrlib.workingtree import WorkingTreeFormat2
 
1079
        try:
 
1080
            return WorkingTreeFormat2().initialize(self)
 
1081
        except errors.NotLocalUrl:
 
1082
            # Even though we can't access the working tree, we need to
 
1083
            # create its control files.
 
1084
            return WorkingTreeFormat2()._stub_initialize_on_transport(
 
1085
                self.transport, self._control_files._file_mode)
 
1086
 
 
1087
    def destroy_workingtree(self):
 
1088
        """See BzrDir.destroy_workingtree."""
 
1089
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
 
1090
 
 
1091
    def destroy_workingtree_metadata(self):
 
1092
        """See BzrDir.destroy_workingtree_metadata."""
 
1093
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
 
1094
                                          self)
 
1095
 
 
1096
    def get_branch_transport(self, branch_format, name=None):
 
1097
        """See BzrDir.get_branch_transport()."""
 
1098
        if name is not None:
 
1099
            raise errors.NoColocatedBranchSupport(self)
 
1100
        if branch_format is None:
 
1101
            return self.transport
 
1102
        try:
 
1103
            branch_format.get_format_string()
 
1104
        except NotImplementedError:
 
1105
            return self.transport
 
1106
        raise errors.IncompatibleFormat(branch_format, self._format)
 
1107
 
 
1108
    def get_repository_transport(self, repository_format):
 
1109
        """See BzrDir.get_repository_transport()."""
 
1110
        if repository_format is None:
 
1111
            return self.transport
 
1112
        try:
 
1113
            repository_format.get_format_string()
 
1114
        except NotImplementedError:
 
1115
            return self.transport
 
1116
        raise errors.IncompatibleFormat(repository_format, self._format)
 
1117
 
 
1118
    def get_workingtree_transport(self, workingtree_format):
 
1119
        """See BzrDir.get_workingtree_transport()."""
 
1120
        if workingtree_format is None:
 
1121
            return self.transport
 
1122
        try:
 
1123
            workingtree_format.get_format_string()
 
1124
        except NotImplementedError:
 
1125
            return self.transport
 
1126
        raise errors.IncompatibleFormat(workingtree_format, self._format)
 
1127
 
 
1128
    def needs_format_conversion(self, format=None):
 
1129
        """See BzrDir.needs_format_conversion()."""
 
1130
        # if the format is not the same as the system default,
 
1131
        # an upgrade is needed.
 
1132
        if format is None:
 
1133
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
 
1134
                % 'needs_format_conversion(format=None)')
 
1135
            format = BzrDirFormat.get_default_format()
 
1136
        return not isinstance(self._format, format.__class__)
 
1137
 
 
1138
    def open_branch(self, name=None, unsupported=False,
 
1139
                    ignore_fallbacks=False):
 
1140
        """See BzrDir.open_branch."""
 
1141
        from bzrlib.branch import BzrBranchFormat4
 
1142
        format = BzrBranchFormat4()
 
1143
        self._check_supported(format, unsupported)
 
1144
        return format.open(self, name, _found=True)
 
1145
 
 
1146
    def sprout(self, url, revision_id=None, force_new_repo=False,
 
1147
               possible_transports=None, accelerator_tree=None,
 
1148
               hardlink=False, stacked=False, create_tree_if_local=True,
 
1149
               source_branch=None):
 
1150
        """See BzrDir.sprout()."""
 
1151
        if source_branch is not None:
 
1152
            my_branch = self.open_branch()
 
1153
            if source_branch.base != my_branch.base:
 
1154
                raise AssertionError(
 
1155
                    "source branch %r is not within %r with branch %r" %
 
1156
                    (source_branch, self, my_branch))
 
1157
        if stacked:
 
1158
            raise errors.UnstackableBranchFormat(
 
1159
                self._format, self.root_transport.base)
 
1160
        if not create_tree_if_local:
 
1161
            raise errors.MustHaveWorkingTree(
 
1162
                self._format, self.root_transport.base)
 
1163
        from bzrlib.workingtree import WorkingTreeFormat2
 
1164
        self._make_tail(url)
 
1165
        result = self._format._initialize_for_clone(url)
 
1166
        try:
 
1167
            self.open_repository().clone(result, revision_id=revision_id)
 
1168
        except errors.NoRepositoryPresent:
 
1169
            pass
 
1170
        try:
 
1171
            self.open_branch().sprout(result, revision_id=revision_id)
 
1172
        except errors.NotBranchError:
 
1173
            pass
 
1174
 
 
1175
        # we always want a working tree
 
1176
        WorkingTreeFormat2().initialize(result,
 
1177
                                        accelerator_tree=accelerator_tree,
 
1178
                                        hardlink=hardlink)
 
1179
        return result
 
1180
 
 
1181
 
 
1182
class BzrDir4(BzrDirPreSplitOut):
 
1183
    """A .bzr version 4 control object.
 
1184
 
 
1185
    This is a deprecated format and may be removed after sept 2006.
 
1186
    """
 
1187
 
 
1188
    def create_repository(self, shared=False):
 
1189
        """See BzrDir.create_repository."""
 
1190
        return self._format.repository_format.initialize(self, shared)
 
1191
 
 
1192
    def needs_format_conversion(self, format=None):
 
1193
        """Format 4 dirs are always in need of conversion."""
 
1194
        if format is None:
 
1195
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
 
1196
                % 'needs_format_conversion(format=None)')
 
1197
        return True
 
1198
 
 
1199
    def open_repository(self):
 
1200
        """See BzrDir.open_repository."""
 
1201
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
1202
        return RepositoryFormat4().open(self, _found=True)
 
1203
 
 
1204
 
 
1205
class BzrDir5(BzrDirPreSplitOut):
 
1206
    """A .bzr version 5 control object.
 
1207
 
 
1208
    This is a deprecated format and may be removed after sept 2006.
 
1209
    """
 
1210
 
 
1211
    def has_workingtree(self):
 
1212
        """See BzrDir.has_workingtree."""
 
1213
        return True
 
1214
    
 
1215
    def open_repository(self):
 
1216
        """See BzrDir.open_repository."""
 
1217
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1218
        return RepositoryFormat5().open(self, _found=True)
 
1219
 
 
1220
    def open_workingtree(self, _unsupported=False,
 
1221
            recommend_upgrade=True):
 
1222
        """See BzrDir.create_workingtree."""
 
1223
        from bzrlib.workingtree import WorkingTreeFormat2
 
1224
        wt_format = WorkingTreeFormat2()
 
1225
        # we don't warn here about upgrades; that ought to be handled for the
 
1226
        # bzrdir as a whole
 
1227
        return wt_format.open(self, _found=True)
 
1228
 
 
1229
 
 
1230
class BzrDir6(BzrDirPreSplitOut):
 
1231
    """A .bzr version 6 control object.
 
1232
 
 
1233
    This is a deprecated format and may be removed after sept 2006.
 
1234
    """
 
1235
 
 
1236
    def has_workingtree(self):
 
1237
        """See BzrDir.has_workingtree."""
 
1238
        return True
 
1239
    
 
1240
    def open_repository(self):
 
1241
        """See BzrDir.open_repository."""
 
1242
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1243
        return RepositoryFormat6().open(self, _found=True)
 
1244
 
 
1245
    def open_workingtree(self, _unsupported=False,
 
1246
        recommend_upgrade=True):
 
1247
        """See BzrDir.create_workingtree."""
 
1248
        # we don't warn here about upgrades; that ought to be handled for the
 
1249
        # bzrdir as a whole
 
1250
        from bzrlib.workingtree import WorkingTreeFormat2
 
1251
        return WorkingTreeFormat2().open(self, _found=True)
 
1252
 
 
1253
 
1133
1254
class BzrDirMeta1(BzrDir):
1134
1255
    """A .bzr meta version 1 control object.
1135
1256
 
1143
1264
        """See BzrDir.can_convert_format()."""
1144
1265
        return True
1145
1266
 
1146
 
    def create_branch(self, name=None, repository=None):
 
1267
    def create_branch(self, name=None):
1147
1268
        """See BzrDir.create_branch."""
1148
 
        return self._format.get_branch_format().initialize(self, name=name,
1149
 
                repository=repository)
 
1269
        return self._format.get_branch_format().initialize(self, name=name)
1150
1270
 
1151
1271
    def destroy_branch(self, name=None):
1152
1272
        """See BzrDir.create_branch."""
1265
1385
            return False
1266
1386
        return True
1267
1387
 
1268
 
    def needs_format_conversion(self, format):
 
1388
    def needs_format_conversion(self, format=None):
1269
1389
        """See BzrDir.needs_format_conversion()."""
 
1390
        if format is None:
 
1391
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
 
1392
                % 'needs_format_conversion(format=None)')
 
1393
        if format is None:
 
1394
            format = BzrDirFormat.get_default_format()
1270
1395
        if not isinstance(self._format, format.__class__):
1271
1396
            # it is not a meta dir format, conversion is needed.
1272
1397
            return True
1297
1422
                    ignore_fallbacks=False):
1298
1423
        """See BzrDir.open_branch."""
1299
1424
        format = self.find_branch_format(name=name)
1300
 
        format.check_support_status(unsupported)
 
1425
        self._check_supported(format, unsupported)
1301
1426
        return format.open(self, name=name,
1302
1427
            _found=True, ignore_fallbacks=ignore_fallbacks)
1303
1428
 
1305
1430
        """See BzrDir.open_repository."""
1306
1431
        from bzrlib.repository import RepositoryFormat
1307
1432
        format = RepositoryFormat.find_format(self)
1308
 
        format.check_support_status(unsupported)
 
1433
        self._check_supported(format, unsupported)
1309
1434
        return format.open(self, _found=True)
1310
1435
 
1311
1436
    def open_workingtree(self, unsupported=False,
1313
1438
        """See BzrDir.open_workingtree."""
1314
1439
        from bzrlib.workingtree import WorkingTreeFormat
1315
1440
        format = WorkingTreeFormat.find_format(self)
1316
 
        format.check_support_status(unsupported, recommend_upgrade,
 
1441
        self._check_supported(format, unsupported,
 
1442
            recommend_upgrade,
1317
1443
            basedir=self.root_transport.base)
1318
1444
        return format.open(self, _found=True)
1319
1445
 
1324
1450
class BzrProber(controldir.Prober):
1325
1451
    """Prober for formats that use a .bzr/ control directory."""
1326
1452
 
1327
 
    formats = registry.FormatRegistry(controldir.network_format_registry)
 
1453
    _formats = {}
1328
1454
    """The known .bzr formats."""
1329
1455
 
1330
1456
    @classmethod
1331
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1332
1457
    def register_bzrdir_format(klass, format):
1333
 
        klass.formats.register(format.get_format_string(), format)
 
1458
        klass._formats[format.get_format_string()] = format
1334
1459
 
1335
1460
    @classmethod
1336
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1337
1461
    def unregister_bzrdir_format(klass, format):
1338
 
        klass.formats.remove(format.get_format_string())
 
1462
        del klass._formats[format.get_format_string()]
1339
1463
 
1340
1464
    @classmethod
1341
1465
    def probe_transport(klass, transport):
1345
1469
        except errors.NoSuchFile:
1346
1470
            raise errors.NotBranchError(path=transport.base)
1347
1471
        try:
1348
 
            return klass.formats.get(format_string)
 
1472
            return klass._formats[format_string]
1349
1473
        except KeyError:
1350
1474
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1351
1475
 
1352
 
    @classmethod
1353
 
    def known_formats(cls):
1354
 
        result = set()
1355
 
        for name, format in cls.formats.iteritems():
1356
 
            if callable(format):
1357
 
                format = format()
1358
 
            result.add(format)
1359
 
        return result
1360
 
 
1361
1476
 
1362
1477
controldir.ControlDirFormat.register_prober(BzrProber)
1363
1478
 
1387
1502
                    raise errors.NotBranchError(path=transport.base)
1388
1503
                if server_version != '2':
1389
1504
                    raise errors.NotBranchError(path=transport.base)
1390
 
            from bzrlib.remote import RemoteBzrDirFormat
1391
1505
            return RemoteBzrDirFormat()
1392
1506
 
1393
 
    @classmethod
1394
 
    def known_formats(cls):
1395
 
        from bzrlib.remote import RemoteBzrDirFormat
1396
 
        return set([RemoteBzrDirFormat()])
1397
 
 
1398
1507
 
1399
1508
class BzrDirFormat(controldir.ControlDirFormat):
1400
1509
    """ControlDirFormat base class for .bzr/ directories.
1413
1522
    # _lock_class must be set in subclasses to the lock type, typ.
1414
1523
    # TransportLock or LockDir
1415
1524
 
1416
 
    @classmethod
1417
 
    def get_format_string(cls):
 
1525
    def get_format_string(self):
1418
1526
        """Return the ASCII format string that identifies this format."""
1419
1527
        raise NotImplementedError(self.get_format_string)
1420
1528
 
1432
1540
            # metadir1
1433
1541
            if type(self) != BzrDirMetaFormat1:
1434
1542
                return self._initialize_on_transport_vfs(transport)
1435
 
            from bzrlib.remote import RemoteBzrDirFormat
1436
1543
            remote_format = RemoteBzrDirFormat()
1437
1544
            self._supply_sub_formats_to(remote_format)
1438
1545
            return remote_format.initialize_on_transport(transport)
1476
1583
            except errors.NoSmartMedium:
1477
1584
                pass
1478
1585
            else:
1479
 
                from bzrlib.remote import RemoteBzrDirFormat
1480
1586
                # TODO: lookup the local format from a server hint.
1481
1587
                remote_dir_format = RemoteBzrDirFormat()
1482
1588
                remote_dir_format._network_name = self.network_name()
1557
1663
        utf8_files = [('README',
1558
1664
                       "This is a Bazaar control directory.\n"
1559
1665
                       "Do not change any files in this directory.\n"
1560
 
                       "See http://bazaar.canonical.com/ for more information about Bazaar.\n"),
 
1666
                       "See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
1561
1667
                      ('branch-format', self.get_format_string()),
1562
1668
                      ]
1563
1669
        # NB: no need to escape relative paths that are url safe.
1597
1703
        """
1598
1704
        raise NotImplementedError(self._open)
1599
1705
 
 
1706
    @classmethod
 
1707
    def register_format(klass, format):
 
1708
        BzrProber.register_bzrdir_format(format)
 
1709
        # bzr native formats have a network name of their format string.
 
1710
        controldir.network_format_registry.register(format.get_format_string(), format.__class__)
 
1711
        controldir.ControlDirFormat.register_format(format)
 
1712
 
1600
1713
    def _supply_sub_formats_to(self, other_format):
1601
1714
        """Give other_format the same values for sub formats as this has.
1602
1715
 
1609
1722
        :return: None.
1610
1723
        """
1611
1724
 
 
1725
    @classmethod
 
1726
    def unregister_format(klass, format):
 
1727
        BzrProber.unregister_bzrdir_format(format)
 
1728
        controldir.ControlDirFormat.unregister_format(format)
 
1729
        controldir.network_format_registry.remove(format.get_format_string())
 
1730
 
 
1731
 
 
1732
class BzrDirFormat4(BzrDirFormat):
 
1733
    """Bzr dir format 4.
 
1734
 
 
1735
    This format is a combined format for working tree, branch and repository.
 
1736
    It has:
 
1737
     - Format 1 working trees [always]
 
1738
     - Format 4 branches [always]
 
1739
     - Format 4 repositories [always]
 
1740
 
 
1741
    This format is deprecated: it indexes texts using a text it which is
 
1742
    removed in format 5; write support for this format has been removed.
 
1743
    """
 
1744
 
 
1745
    _lock_class = lockable_files.TransportLock
 
1746
 
 
1747
    def get_format_string(self):
 
1748
        """See BzrDirFormat.get_format_string()."""
 
1749
        return "Bazaar-NG branch, format 0.0.4\n"
 
1750
 
 
1751
    def get_format_description(self):
 
1752
        """See BzrDirFormat.get_format_description()."""
 
1753
        return "All-in-one format 4"
 
1754
 
 
1755
    def get_converter(self, format=None):
 
1756
        """See BzrDirFormat.get_converter()."""
 
1757
        # there is one and only one upgrade path here.
 
1758
        return ConvertBzrDir4To5()
 
1759
 
 
1760
    def initialize_on_transport(self, transport):
 
1761
        """Format 4 branches cannot be created."""
 
1762
        raise errors.UninitializableFormat(self)
 
1763
 
 
1764
    def is_supported(self):
 
1765
        """Format 4 is not supported.
 
1766
 
 
1767
        It is not supported because the model changed from 4 to 5 and the
 
1768
        conversion logic is expensive - so doing it on the fly was not
 
1769
        feasible.
 
1770
        """
 
1771
        return False
 
1772
 
 
1773
    def network_name(self):
 
1774
        return self.get_format_string()
 
1775
 
 
1776
    def _open(self, transport):
 
1777
        """See BzrDirFormat._open."""
 
1778
        return BzrDir4(transport, self)
 
1779
 
 
1780
    def __return_repository_format(self):
 
1781
        """Circular import protection."""
 
1782
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
 
1783
        return RepositoryFormat4()
 
1784
    repository_format = property(__return_repository_format)
 
1785
 
 
1786
 
 
1787
class BzrDirFormatAllInOne(BzrDirFormat):
 
1788
    """Common class for formats before meta-dirs."""
 
1789
 
 
1790
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
 
1791
        create_prefix=False, force_new_repo=False, stacked_on=None,
 
1792
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
 
1793
        shared_repo=False):
 
1794
        """See BzrDirFormat.initialize_on_transport_ex."""
 
1795
        require_stacking = (stacked_on is not None)
 
1796
        # Format 5 cannot stack, but we've been asked to - actually init
 
1797
        # a Meta1Dir
 
1798
        if require_stacking:
 
1799
            format = BzrDirMetaFormat1()
 
1800
            return format.initialize_on_transport_ex(transport,
 
1801
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
1802
                force_new_repo=force_new_repo, stacked_on=stacked_on,
 
1803
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
1804
                make_working_trees=make_working_trees, shared_repo=shared_repo)
 
1805
        return BzrDirFormat.initialize_on_transport_ex(self, transport,
 
1806
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
1807
            force_new_repo=force_new_repo, stacked_on=stacked_on,
 
1808
            stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
1809
            make_working_trees=make_working_trees, shared_repo=shared_repo)
 
1810
 
 
1811
 
 
1812
class BzrDirFormat5(BzrDirFormatAllInOne):
 
1813
    """Bzr control format 5.
 
1814
 
 
1815
    This format is a combined format for working tree, branch and repository.
 
1816
    It has:
 
1817
     - Format 2 working trees [always]
 
1818
     - Format 4 branches [always]
 
1819
     - Format 5 repositories [always]
 
1820
       Unhashed stores in the repository.
 
1821
    """
 
1822
 
 
1823
    _lock_class = lockable_files.TransportLock
 
1824
 
 
1825
    def get_format_string(self):
 
1826
        """See BzrDirFormat.get_format_string()."""
 
1827
        return "Bazaar-NG branch, format 5\n"
 
1828
 
 
1829
    def get_branch_format(self):
 
1830
        from bzrlib import branch
 
1831
        return branch.BzrBranchFormat4()
 
1832
 
 
1833
    def get_format_description(self):
 
1834
        """See BzrDirFormat.get_format_description()."""
 
1835
        return "All-in-one format 5"
 
1836
 
 
1837
    def get_converter(self, format=None):
 
1838
        """See BzrDirFormat.get_converter()."""
 
1839
        # there is one and only one upgrade path here.
 
1840
        return ConvertBzrDir5To6()
 
1841
 
 
1842
    def _initialize_for_clone(self, url):
 
1843
        return self.initialize_on_transport(get_transport(url), _cloning=True)
 
1844
 
 
1845
    def initialize_on_transport(self, transport, _cloning=False):
 
1846
        """Format 5 dirs always have working tree, branch and repository.
 
1847
 
 
1848
        Except when they are being cloned.
 
1849
        """
 
1850
        from bzrlib.branch import BzrBranchFormat4
 
1851
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1852
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
 
1853
        RepositoryFormat5().initialize(result, _internal=True)
 
1854
        if not _cloning:
 
1855
            branch = BzrBranchFormat4().initialize(result)
 
1856
            result._init_workingtree()
 
1857
        return result
 
1858
 
 
1859
    def network_name(self):
 
1860
        return self.get_format_string()
 
1861
 
 
1862
    def _open(self, transport):
 
1863
        """See BzrDirFormat._open."""
 
1864
        return BzrDir5(transport, self)
 
1865
 
 
1866
    def __return_repository_format(self):
 
1867
        """Circular import protection."""
 
1868
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
 
1869
        return RepositoryFormat5()
 
1870
    repository_format = property(__return_repository_format)
 
1871
 
 
1872
 
 
1873
class BzrDirFormat6(BzrDirFormatAllInOne):
 
1874
    """Bzr control format 6.
 
1875
 
 
1876
    This format is a combined format for working tree, branch and repository.
 
1877
    It has:
 
1878
     - Format 2 working trees [always]
 
1879
     - Format 4 branches [always]
 
1880
     - Format 6 repositories [always]
 
1881
    """
 
1882
 
 
1883
    _lock_class = lockable_files.TransportLock
 
1884
 
 
1885
    def get_format_string(self):
 
1886
        """See BzrDirFormat.get_format_string()."""
 
1887
        return "Bazaar-NG branch, format 6\n"
 
1888
 
 
1889
    def get_format_description(self):
 
1890
        """See BzrDirFormat.get_format_description()."""
 
1891
        return "All-in-one format 6"
 
1892
 
 
1893
    def get_branch_format(self):
 
1894
        from bzrlib import branch
 
1895
        return branch.BzrBranchFormat4()
 
1896
 
 
1897
    def get_converter(self, format=None):
 
1898
        """See BzrDirFormat.get_converter()."""
 
1899
        # there is one and only one upgrade path here.
 
1900
        return ConvertBzrDir6ToMeta()
 
1901
 
 
1902
    def _initialize_for_clone(self, url):
 
1903
        return self.initialize_on_transport(get_transport(url), _cloning=True)
 
1904
 
 
1905
    def initialize_on_transport(self, transport, _cloning=False):
 
1906
        """Format 6 dirs always have working tree, branch and repository.
 
1907
 
 
1908
        Except when they are being cloned.
 
1909
        """
 
1910
        from bzrlib.branch import BzrBranchFormat4
 
1911
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1912
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
 
1913
        RepositoryFormat6().initialize(result, _internal=True)
 
1914
        if not _cloning:
 
1915
            branch = BzrBranchFormat4().initialize(result)
 
1916
            result._init_workingtree()
 
1917
        return result
 
1918
 
 
1919
    def network_name(self):
 
1920
        return self.get_format_string()
 
1921
 
 
1922
    def _open(self, transport):
 
1923
        """See BzrDirFormat._open."""
 
1924
        return BzrDir6(transport, self)
 
1925
 
 
1926
    def __return_repository_format(self):
 
1927
        """Circular import protection."""
 
1928
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
 
1929
        return RepositoryFormat6()
 
1930
    repository_format = property(__return_repository_format)
 
1931
 
1612
1932
 
1613
1933
class BzrDirMetaFormat1(BzrDirFormat):
1614
1934
    """Bzr meta control format 1
1623
1943
 
1624
1944
    _lock_class = lockdir.LockDir
1625
1945
 
1626
 
    fixed_components = False
1627
 
 
1628
1946
    def __init__(self):
1629
1947
        self._workingtree_format = None
1630
1948
        self._branch_format = None
1644
1962
 
1645
1963
    def get_branch_format(self):
1646
1964
        if self._branch_format is None:
1647
 
            from bzrlib.branch import format_registry as branch_format_registry
1648
 
            self._branch_format = branch_format_registry.get_default()
 
1965
            from bzrlib.branch import BranchFormat
 
1966
            self._branch_format = BranchFormat.get_default_format()
1649
1967
        return self._branch_format
1650
1968
 
1651
1969
    def set_branch_format(self, format):
1706
2024
                    # stack_on is inaccessible, JFDI.
1707
2025
                    # TODO: bad monkey, hard-coded formats...
1708
2026
                    if self.repository_format.rich_root_data:
1709
 
                        new_repo_format = knitpack_repo.RepositoryFormatKnitPack5RichRoot()
 
2027
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
1710
2028
                    else:
1711
 
                        new_repo_format = knitpack_repo.RepositoryFormatKnitPack5()
 
2029
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5()
1712
2030
            else:
1713
2031
                # If the target already supports stacking, then we know the
1714
2032
                # project is already able to use stacking, so auto-upgrade
1731
2049
            if target_branch is None:
1732
2050
                if do_upgrade:
1733
2051
                    # TODO: bad monkey, hard-coded formats...
1734
 
                    from bzrlib.branch import BzrBranchFormat7
1735
 
                    new_branch_format = BzrBranchFormat7()
 
2052
                    new_branch_format = branch.BzrBranchFormat7()
1736
2053
            else:
1737
2054
                new_branch_format = target_branch._format
1738
2055
                if not new_branch_format.supports_stacking():
1753
2070
            raise NotImplementedError(self.get_converter)
1754
2071
        return ConvertMetaToMeta(format)
1755
2072
 
1756
 
    @classmethod
1757
 
    def get_format_string(cls):
 
2073
    def get_format_string(self):
1758
2074
        """See BzrDirFormat.get_format_string()."""
1759
2075
        return "Bazaar-NG meta directory, format 1\n"
1760
2076
 
1778
2094
        """Circular import protection."""
1779
2095
        if self._repository_format:
1780
2096
            return self._repository_format
1781
 
        from bzrlib.repository import format_registry
1782
 
        return format_registry.get_default()
 
2097
        from bzrlib.repository import RepositoryFormat
 
2098
        return RepositoryFormat.get_default_format()
1783
2099
 
1784
2100
    def _set_repository_format(self, value):
1785
2101
        """Allow changing the repository format for metadir formats."""
1808
2124
 
1809
2125
    def __get_workingtree_format(self):
1810
2126
        if self._workingtree_format is None:
1811
 
            from bzrlib.workingtree import (
1812
 
                format_registry as wt_format_registry,
1813
 
                )
1814
 
            self._workingtree_format = wt_format_registry.get_default()
 
2127
            from bzrlib.workingtree import WorkingTreeFormat
 
2128
            self._workingtree_format = WorkingTreeFormat.get_default_format()
1815
2129
        return self._workingtree_format
1816
2130
 
1817
2131
    def __set_workingtree_format(self, wt_format):
1822
2136
 
1823
2137
 
1824
2138
# Register bzr formats
1825
 
BzrProber.formats.register(BzrDirMetaFormat1.get_format_string(),
1826
 
    BzrDirMetaFormat1)
1827
 
controldir.ControlDirFormat._default_format = BzrDirMetaFormat1()
1828
 
 
1829
 
 
1830
 
class ConvertMetaToMeta(controldir.Converter):
 
2139
BzrDirFormat.register_format(BzrDirFormat4())
 
2140
BzrDirFormat.register_format(BzrDirFormat5())
 
2141
BzrDirFormat.register_format(BzrDirFormat6())
 
2142
__default_format = BzrDirMetaFormat1()
 
2143
BzrDirFormat.register_format(__default_format)
 
2144
controldir.ControlDirFormat._default_format = __default_format
 
2145
 
 
2146
 
 
2147
class Converter(object):
 
2148
    """Converts a disk format object from one format to another."""
 
2149
 
 
2150
    def convert(self, to_convert, pb):
 
2151
        """Perform the conversion of to_convert, giving feedback via pb.
 
2152
 
 
2153
        :param to_convert: The disk object to convert.
 
2154
        :param pb: a progress bar to use for progress information.
 
2155
        """
 
2156
 
 
2157
    def step(self, message):
 
2158
        """Update the pb by a step."""
 
2159
        self.count +=1
 
2160
        self.pb.update(message, self.count, self.total)
 
2161
 
 
2162
 
 
2163
class ConvertBzrDir4To5(Converter):
 
2164
    """Converts format 4 bzr dirs to format 5."""
 
2165
 
 
2166
    def __init__(self):
 
2167
        super(ConvertBzrDir4To5, self).__init__()
 
2168
        self.converted_revs = set()
 
2169
        self.absent_revisions = set()
 
2170
        self.text_count = 0
 
2171
        self.revisions = {}
 
2172
 
 
2173
    def convert(self, to_convert, pb):
 
2174
        """See Converter.convert()."""
 
2175
        self.bzrdir = to_convert
 
2176
        if pb is not None:
 
2177
            warnings.warn("pb parameter to convert() is deprecated")
 
2178
        self.pb = ui.ui_factory.nested_progress_bar()
 
2179
        try:
 
2180
            ui.ui_factory.note('starting upgrade from format 4 to 5')
 
2181
            if isinstance(self.bzrdir.transport, local.LocalTransport):
 
2182
                self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
 
2183
            self._convert_to_weaves()
 
2184
            return BzrDir.open(self.bzrdir.user_url)
 
2185
        finally:
 
2186
            self.pb.finished()
 
2187
 
 
2188
    def _convert_to_weaves(self):
 
2189
        ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
 
2190
        try:
 
2191
            # TODO permissions
 
2192
            stat = self.bzrdir.transport.stat('weaves')
 
2193
            if not S_ISDIR(stat.st_mode):
 
2194
                self.bzrdir.transport.delete('weaves')
 
2195
                self.bzrdir.transport.mkdir('weaves')
 
2196
        except errors.NoSuchFile:
 
2197
            self.bzrdir.transport.mkdir('weaves')
 
2198
        # deliberately not a WeaveFile as we want to build it up slowly.
 
2199
        self.inv_weave = Weave('inventory')
 
2200
        # holds in-memory weaves for all files
 
2201
        self.text_weaves = {}
 
2202
        self.bzrdir.transport.delete('branch-format')
 
2203
        self.branch = self.bzrdir.open_branch()
 
2204
        self._convert_working_inv()
 
2205
        rev_history = self.branch.revision_history()
 
2206
        # to_read is a stack holding the revisions we still need to process;
 
2207
        # appending to it adds new highest-priority revisions
 
2208
        self.known_revisions = set(rev_history)
 
2209
        self.to_read = rev_history[-1:]
 
2210
        while self.to_read:
 
2211
            rev_id = self.to_read.pop()
 
2212
            if (rev_id not in self.revisions
 
2213
                and rev_id not in self.absent_revisions):
 
2214
                self._load_one_rev(rev_id)
 
2215
        self.pb.clear()
 
2216
        to_import = self._make_order()
 
2217
        for i, rev_id in enumerate(to_import):
 
2218
            self.pb.update('converting revision', i, len(to_import))
 
2219
            self._convert_one_rev(rev_id)
 
2220
        self.pb.clear()
 
2221
        self._write_all_weaves()
 
2222
        self._write_all_revs()
 
2223
        ui.ui_factory.note('upgraded to weaves:')
 
2224
        ui.ui_factory.note('  %6d revisions and inventories' % len(self.revisions))
 
2225
        ui.ui_factory.note('  %6d revisions not present' % len(self.absent_revisions))
 
2226
        ui.ui_factory.note('  %6d texts' % self.text_count)
 
2227
        self._cleanup_spare_files_after_format4()
 
2228
        self.branch._transport.put_bytes(
 
2229
            'branch-format',
 
2230
            BzrDirFormat5().get_format_string(),
 
2231
            mode=self.bzrdir._get_file_mode())
 
2232
 
 
2233
    def _cleanup_spare_files_after_format4(self):
 
2234
        # FIXME working tree upgrade foo.
 
2235
        for n in 'merged-patches', 'pending-merged-patches':
 
2236
            try:
 
2237
                ## assert os.path.getsize(p) == 0
 
2238
                self.bzrdir.transport.delete(n)
 
2239
            except errors.NoSuchFile:
 
2240
                pass
 
2241
        self.bzrdir.transport.delete_tree('inventory-store')
 
2242
        self.bzrdir.transport.delete_tree('text-store')
 
2243
 
 
2244
    def _convert_working_inv(self):
 
2245
        inv = xml4.serializer_v4.read_inventory(
 
2246
                self.branch._transport.get('inventory'))
 
2247
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
 
2248
        self.branch._transport.put_bytes('inventory', new_inv_xml,
 
2249
            mode=self.bzrdir._get_file_mode())
 
2250
 
 
2251
    def _write_all_weaves(self):
 
2252
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
 
2253
        weave_transport = self.bzrdir.transport.clone('weaves')
 
2254
        weaves = WeaveStore(weave_transport, prefixed=False)
 
2255
        transaction = WriteTransaction()
 
2256
 
 
2257
        try:
 
2258
            i = 0
 
2259
            for file_id, file_weave in self.text_weaves.items():
 
2260
                self.pb.update('writing weave', i, len(self.text_weaves))
 
2261
                weaves._put_weave(file_id, file_weave, transaction)
 
2262
                i += 1
 
2263
            self.pb.update('inventory', 0, 1)
 
2264
            controlweaves._put_weave('inventory', self.inv_weave, transaction)
 
2265
            self.pb.update('inventory', 1, 1)
 
2266
        finally:
 
2267
            self.pb.clear()
 
2268
 
 
2269
    def _write_all_revs(self):
 
2270
        """Write all revisions out in new form."""
 
2271
        self.bzrdir.transport.delete_tree('revision-store')
 
2272
        self.bzrdir.transport.mkdir('revision-store')
 
2273
        revision_transport = self.bzrdir.transport.clone('revision-store')
 
2274
        # TODO permissions
 
2275
        from bzrlib.xml5 import serializer_v5
 
2276
        from bzrlib.repofmt.weaverepo import RevisionTextStore
 
2277
        revision_store = RevisionTextStore(revision_transport,
 
2278
            serializer_v5, False, versionedfile.PrefixMapper(),
 
2279
            lambda:True, lambda:True)
 
2280
        try:
 
2281
            for i, rev_id in enumerate(self.converted_revs):
 
2282
                self.pb.update('write revision', i, len(self.converted_revs))
 
2283
                text = serializer_v5.write_revision_to_string(
 
2284
                    self.revisions[rev_id])
 
2285
                key = (rev_id,)
 
2286
                revision_store.add_lines(key, None, osutils.split_lines(text))
 
2287
        finally:
 
2288
            self.pb.clear()
 
2289
 
 
2290
    def _load_one_rev(self, rev_id):
 
2291
        """Load a revision object into memory.
 
2292
 
 
2293
        Any parents not either loaded or abandoned get queued to be
 
2294
        loaded."""
 
2295
        self.pb.update('loading revision',
 
2296
                       len(self.revisions),
 
2297
                       len(self.known_revisions))
 
2298
        if not self.branch.repository.has_revision(rev_id):
 
2299
            self.pb.clear()
 
2300
            ui.ui_factory.note('revision {%s} not present in branch; '
 
2301
                         'will be converted as a ghost' %
 
2302
                         rev_id)
 
2303
            self.absent_revisions.add(rev_id)
 
2304
        else:
 
2305
            rev = self.branch.repository.get_revision(rev_id)
 
2306
            for parent_id in rev.parent_ids:
 
2307
                self.known_revisions.add(parent_id)
 
2308
                self.to_read.append(parent_id)
 
2309
            self.revisions[rev_id] = rev
 
2310
 
 
2311
    def _load_old_inventory(self, rev_id):
 
2312
        f = self.branch.repository.inventory_store.get(rev_id)
 
2313
        try:
 
2314
            old_inv_xml = f.read()
 
2315
        finally:
 
2316
            f.close()
 
2317
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
 
2318
        inv.revision_id = rev_id
 
2319
        rev = self.revisions[rev_id]
 
2320
        return inv
 
2321
 
 
2322
    def _load_updated_inventory(self, rev_id):
 
2323
        inv_xml = self.inv_weave.get_text(rev_id)
 
2324
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
 
2325
        return inv
 
2326
 
 
2327
    def _convert_one_rev(self, rev_id):
 
2328
        """Convert revision and all referenced objects to new format."""
 
2329
        rev = self.revisions[rev_id]
 
2330
        inv = self._load_old_inventory(rev_id)
 
2331
        present_parents = [p for p in rev.parent_ids
 
2332
                           if p not in self.absent_revisions]
 
2333
        self._convert_revision_contents(rev, inv, present_parents)
 
2334
        self._store_new_inv(rev, inv, present_parents)
 
2335
        self.converted_revs.add(rev_id)
 
2336
 
 
2337
    def _store_new_inv(self, rev, inv, present_parents):
 
2338
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
 
2339
        new_inv_sha1 = sha_string(new_inv_xml)
 
2340
        self.inv_weave.add_lines(rev.revision_id,
 
2341
                                 present_parents,
 
2342
                                 new_inv_xml.splitlines(True))
 
2343
        rev.inventory_sha1 = new_inv_sha1
 
2344
 
 
2345
    def _convert_revision_contents(self, rev, inv, present_parents):
 
2346
        """Convert all the files within a revision.
 
2347
 
 
2348
        Also upgrade the inventory to refer to the text revision ids."""
 
2349
        rev_id = rev.revision_id
 
2350
        mutter('converting texts of revision {%s}',
 
2351
               rev_id)
 
2352
        parent_invs = map(self._load_updated_inventory, present_parents)
 
2353
        entries = inv.iter_entries()
 
2354
        entries.next()
 
2355
        for path, ie in entries:
 
2356
            self._convert_file_version(rev, ie, parent_invs)
 
2357
 
 
2358
    def _convert_file_version(self, rev, ie, parent_invs):
 
2359
        """Convert one version of one file.
 
2360
 
 
2361
        The file needs to be added into the weave if it is a merge
 
2362
        of >=2 parents or if it's changed from its parent.
 
2363
        """
 
2364
        file_id = ie.file_id
 
2365
        rev_id = rev.revision_id
 
2366
        w = self.text_weaves.get(file_id)
 
2367
        if w is None:
 
2368
            w = Weave(file_id)
 
2369
            self.text_weaves[file_id] = w
 
2370
        text_changed = False
 
2371
        parent_candiate_entries = ie.parent_candidates(parent_invs)
 
2372
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
 
2373
        # XXX: Note that this is unordered - and this is tolerable because
 
2374
        # the previous code was also unordered.
 
2375
        previous_entries = dict((head, parent_candiate_entries[head]) for head
 
2376
            in heads)
 
2377
        self.snapshot_ie(previous_entries, ie, w, rev_id)
 
2378
 
 
2379
    def get_parent_map(self, revision_ids):
 
2380
        """See graph.StackedParentsProvider.get_parent_map"""
 
2381
        return dict((revision_id, self.revisions[revision_id])
 
2382
                    for revision_id in revision_ids
 
2383
                     if revision_id in self.revisions)
 
2384
 
 
2385
    def snapshot_ie(self, previous_revisions, ie, w, rev_id):
 
2386
        # TODO: convert this logic, which is ~= snapshot to
 
2387
        # a call to:. This needs the path figured out. rather than a work_tree
 
2388
        # a v4 revision_tree can be given, or something that looks enough like
 
2389
        # one to give the file content to the entry if it needs it.
 
2390
        # and we need something that looks like a weave store for snapshot to
 
2391
        # save against.
 
2392
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
 
2393
        if len(previous_revisions) == 1:
 
2394
            previous_ie = previous_revisions.values()[0]
 
2395
            if ie._unchanged(previous_ie):
 
2396
                ie.revision = previous_ie.revision
 
2397
                return
 
2398
        if ie.has_text():
 
2399
            f = self.branch.repository._text_store.get(ie.text_id)
 
2400
            try:
 
2401
                file_lines = f.readlines()
 
2402
            finally:
 
2403
                f.close()
 
2404
            w.add_lines(rev_id, previous_revisions, file_lines)
 
2405
            self.text_count += 1
 
2406
        else:
 
2407
            w.add_lines(rev_id, previous_revisions, [])
 
2408
        ie.revision = rev_id
 
2409
 
 
2410
    def _make_order(self):
 
2411
        """Return a suitable order for importing revisions.
 
2412
 
 
2413
        The order must be such that an revision is imported after all
 
2414
        its (present) parents.
 
2415
        """
 
2416
        todo = set(self.revisions.keys())
 
2417
        done = self.absent_revisions.copy()
 
2418
        order = []
 
2419
        while todo:
 
2420
            # scan through looking for a revision whose parents
 
2421
            # are all done
 
2422
            for rev_id in sorted(list(todo)):
 
2423
                rev = self.revisions[rev_id]
 
2424
                parent_ids = set(rev.parent_ids)
 
2425
                if parent_ids.issubset(done):
 
2426
                    # can take this one now
 
2427
                    order.append(rev_id)
 
2428
                    todo.remove(rev_id)
 
2429
                    done.add(rev_id)
 
2430
        return order
 
2431
 
 
2432
 
 
2433
class ConvertBzrDir5To6(Converter):
 
2434
    """Converts format 5 bzr dirs to format 6."""
 
2435
 
 
2436
    def convert(self, to_convert, pb):
 
2437
        """See Converter.convert()."""
 
2438
        self.bzrdir = to_convert
 
2439
        pb = ui.ui_factory.nested_progress_bar()
 
2440
        try:
 
2441
            ui.ui_factory.note('starting upgrade from format 5 to 6')
 
2442
            self._convert_to_prefixed()
 
2443
            return BzrDir.open(self.bzrdir.user_url)
 
2444
        finally:
 
2445
            pb.finished()
 
2446
 
 
2447
    def _convert_to_prefixed(self):
 
2448
        from bzrlib.store import TransportStore
 
2449
        self.bzrdir.transport.delete('branch-format')
 
2450
        for store_name in ["weaves", "revision-store"]:
 
2451
            ui.ui_factory.note("adding prefixes to %s" % store_name)
 
2452
            store_transport = self.bzrdir.transport.clone(store_name)
 
2453
            store = TransportStore(store_transport, prefixed=True)
 
2454
            for urlfilename in store_transport.list_dir('.'):
 
2455
                filename = urlutils.unescape(urlfilename)
 
2456
                if (filename.endswith(".weave") or
 
2457
                    filename.endswith(".gz") or
 
2458
                    filename.endswith(".sig")):
 
2459
                    file_id, suffix = os.path.splitext(filename)
 
2460
                else:
 
2461
                    file_id = filename
 
2462
                    suffix = ''
 
2463
                new_name = store._mapper.map((file_id,)) + suffix
 
2464
                # FIXME keep track of the dirs made RBC 20060121
 
2465
                try:
 
2466
                    store_transport.move(filename, new_name)
 
2467
                except errors.NoSuchFile: # catches missing dirs strangely enough
 
2468
                    store_transport.mkdir(osutils.dirname(new_name))
 
2469
                    store_transport.move(filename, new_name)
 
2470
        self.bzrdir.transport.put_bytes(
 
2471
            'branch-format',
 
2472
            BzrDirFormat6().get_format_string(),
 
2473
            mode=self.bzrdir._get_file_mode())
 
2474
 
 
2475
 
 
2476
class ConvertBzrDir6ToMeta(Converter):
 
2477
    """Converts format 6 bzr dirs to metadirs."""
 
2478
 
 
2479
    def convert(self, to_convert, pb):
 
2480
        """See Converter.convert()."""
 
2481
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
 
2482
        from bzrlib.branch import BzrBranchFormat5
 
2483
        self.bzrdir = to_convert
 
2484
        self.pb = ui.ui_factory.nested_progress_bar()
 
2485
        self.count = 0
 
2486
        self.total = 20 # the steps we know about
 
2487
        self.garbage_inventories = []
 
2488
        self.dir_mode = self.bzrdir._get_dir_mode()
 
2489
        self.file_mode = self.bzrdir._get_file_mode()
 
2490
 
 
2491
        ui.ui_factory.note('starting upgrade from format 6 to metadir')
 
2492
        self.bzrdir.transport.put_bytes(
 
2493
                'branch-format',
 
2494
                "Converting to format 6",
 
2495
                mode=self.file_mode)
 
2496
        # its faster to move specific files around than to open and use the apis...
 
2497
        # first off, nuke ancestry.weave, it was never used.
 
2498
        try:
 
2499
            self.step('Removing ancestry.weave')
 
2500
            self.bzrdir.transport.delete('ancestry.weave')
 
2501
        except errors.NoSuchFile:
 
2502
            pass
 
2503
        # find out whats there
 
2504
        self.step('Finding branch files')
 
2505
        last_revision = self.bzrdir.open_branch().last_revision()
 
2506
        bzrcontents = self.bzrdir.transport.list_dir('.')
 
2507
        for name in bzrcontents:
 
2508
            if name.startswith('basis-inventory.'):
 
2509
                self.garbage_inventories.append(name)
 
2510
        # create new directories for repository, working tree and branch
 
2511
        repository_names = [('inventory.weave', True),
 
2512
                            ('revision-store', True),
 
2513
                            ('weaves', True)]
 
2514
        self.step('Upgrading repository  ')
 
2515
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
 
2516
        self.make_lock('repository')
 
2517
        # we hard code the formats here because we are converting into
 
2518
        # the meta format. The meta format upgrader can take this to a
 
2519
        # future format within each component.
 
2520
        self.put_format('repository', RepositoryFormat7())
 
2521
        for entry in repository_names:
 
2522
            self.move_entry('repository', entry)
 
2523
 
 
2524
        self.step('Upgrading branch      ')
 
2525
        self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
 
2526
        self.make_lock('branch')
 
2527
        self.put_format('branch', BzrBranchFormat5())
 
2528
        branch_files = [('revision-history', True),
 
2529
                        ('branch-name', True),
 
2530
                        ('parent', False)]
 
2531
        for entry in branch_files:
 
2532
            self.move_entry('branch', entry)
 
2533
 
 
2534
        checkout_files = [('pending-merges', True),
 
2535
                          ('inventory', True),
 
2536
                          ('stat-cache', False)]
 
2537
        # If a mandatory checkout file is not present, the branch does not have
 
2538
        # a functional checkout. Do not create a checkout in the converted
 
2539
        # branch.
 
2540
        for name, mandatory in checkout_files:
 
2541
            if mandatory and name not in bzrcontents:
 
2542
                has_checkout = False
 
2543
                break
 
2544
        else:
 
2545
            has_checkout = True
 
2546
        if not has_checkout:
 
2547
            ui.ui_factory.note('No working tree.')
 
2548
            # If some checkout files are there, we may as well get rid of them.
 
2549
            for name, mandatory in checkout_files:
 
2550
                if name in bzrcontents:
 
2551
                    self.bzrdir.transport.delete(name)
 
2552
        else:
 
2553
            from bzrlib.workingtree import WorkingTreeFormat3
 
2554
            self.step('Upgrading working tree')
 
2555
            self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
 
2556
            self.make_lock('checkout')
 
2557
            self.put_format(
 
2558
                'checkout', WorkingTreeFormat3())
 
2559
            self.bzrdir.transport.delete_multi(
 
2560
                self.garbage_inventories, self.pb)
 
2561
            for entry in checkout_files:
 
2562
                self.move_entry('checkout', entry)
 
2563
            if last_revision is not None:
 
2564
                self.bzrdir.transport.put_bytes(
 
2565
                    'checkout/last-revision', last_revision)
 
2566
        self.bzrdir.transport.put_bytes(
 
2567
            'branch-format',
 
2568
            BzrDirMetaFormat1().get_format_string(),
 
2569
            mode=self.file_mode)
 
2570
        self.pb.finished()
 
2571
        return BzrDir.open(self.bzrdir.user_url)
 
2572
 
 
2573
    def make_lock(self, name):
 
2574
        """Make a lock for the new control dir name."""
 
2575
        self.step('Make %s lock' % name)
 
2576
        ld = lockdir.LockDir(self.bzrdir.transport,
 
2577
                             '%s/lock' % name,
 
2578
                             file_modebits=self.file_mode,
 
2579
                             dir_modebits=self.dir_mode)
 
2580
        ld.create()
 
2581
 
 
2582
    def move_entry(self, new_dir, entry):
 
2583
        """Move then entry name into new_dir."""
 
2584
        name = entry[0]
 
2585
        mandatory = entry[1]
 
2586
        self.step('Moving %s' % name)
 
2587
        try:
 
2588
            self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
 
2589
        except errors.NoSuchFile:
 
2590
            if mandatory:
 
2591
                raise
 
2592
 
 
2593
    def put_format(self, dirname, format):
 
2594
        self.bzrdir.transport.put_bytes('%s/format' % dirname,
 
2595
            format.get_format_string(),
 
2596
            self.file_mode)
 
2597
 
 
2598
 
 
2599
class ConvertMetaToMeta(Converter):
1831
2600
    """Converts the components of metadirs."""
1832
2601
 
1833
2602
    def __init__(self, target_format):
1858
2627
            # TODO: conversions of Branch and Tree should be done by
1859
2628
            # InterXFormat lookups/some sort of registry.
1860
2629
            # Avoid circular imports
 
2630
            from bzrlib import branch as _mod_branch
1861
2631
            old = branch._format.__class__
1862
2632
            new = self.target_format.get_branch_format().__class__
1863
2633
            while old != new:
1905
2675
        return to_convert
1906
2676
 
1907
2677
 
 
2678
# This is not in remote.py because it's relatively small, and needs to be
 
2679
# registered. Putting it in remote.py creates a circular import problem.
 
2680
# we can make it a lazy object if the control formats is turned into something
 
2681
# like a registry.
 
2682
class RemoteBzrDirFormat(BzrDirMetaFormat1):
 
2683
    """Format representing bzrdirs accessed via a smart server"""
 
2684
 
 
2685
    supports_workingtrees = False
 
2686
 
 
2687
    def __init__(self):
 
2688
        BzrDirMetaFormat1.__init__(self)
 
2689
        # XXX: It's a bit ugly that the network name is here, because we'd
 
2690
        # like to believe that format objects are stateless or at least
 
2691
        # immutable,  However, we do at least avoid mutating the name after
 
2692
        # it's returned.  See <https://bugs.launchpad.net/bzr/+bug/504102>
 
2693
        self._network_name = None
 
2694
 
 
2695
    def __repr__(self):
 
2696
        return "%s(_network_name=%r)" % (self.__class__.__name__,
 
2697
            self._network_name)
 
2698
 
 
2699
    def get_format_description(self):
 
2700
        if self._network_name:
 
2701
            real_format = controldir.network_format_registry.get(self._network_name)
 
2702
            return 'Remote: ' + real_format.get_format_description()
 
2703
        return 'bzr remote bzrdir'
 
2704
 
 
2705
    def get_format_string(self):
 
2706
        raise NotImplementedError(self.get_format_string)
 
2707
 
 
2708
    def network_name(self):
 
2709
        if self._network_name:
 
2710
            return self._network_name
 
2711
        else:
 
2712
            raise AssertionError("No network name set.")
 
2713
 
 
2714
    def initialize_on_transport(self, transport):
 
2715
        try:
 
2716
            # hand off the request to the smart server
 
2717
            client_medium = transport.get_smart_medium()
 
2718
        except errors.NoSmartMedium:
 
2719
            # TODO: lookup the local format from a server hint.
 
2720
            local_dir_format = BzrDirMetaFormat1()
 
2721
            return local_dir_format.initialize_on_transport(transport)
 
2722
        client = _SmartClient(client_medium)
 
2723
        path = client.remote_path_from_transport(transport)
 
2724
        try:
 
2725
            response = client.call('BzrDirFormat.initialize', path)
 
2726
        except errors.ErrorFromSmartServer, err:
 
2727
            remote._translate_error(err, path=path)
 
2728
        if response[0] != 'ok':
 
2729
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
 
2730
        format = RemoteBzrDirFormat()
 
2731
        self._supply_sub_formats_to(format)
 
2732
        return remote.RemoteBzrDir(transport, format)
 
2733
 
 
2734
    def parse_NoneTrueFalse(self, arg):
 
2735
        if not arg:
 
2736
            return None
 
2737
        if arg == 'False':
 
2738
            return False
 
2739
        if arg == 'True':
 
2740
            return True
 
2741
        raise AssertionError("invalid arg %r" % arg)
 
2742
 
 
2743
    def _serialize_NoneTrueFalse(self, arg):
 
2744
        if arg is False:
 
2745
            return 'False'
 
2746
        if arg:
 
2747
            return 'True'
 
2748
        return ''
 
2749
 
 
2750
    def _serialize_NoneString(self, arg):
 
2751
        return arg or ''
 
2752
 
 
2753
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
 
2754
        create_prefix=False, force_new_repo=False, stacked_on=None,
 
2755
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
 
2756
        shared_repo=False):
 
2757
        try:
 
2758
            # hand off the request to the smart server
 
2759
            client_medium = transport.get_smart_medium()
 
2760
        except errors.NoSmartMedium:
 
2761
            do_vfs = True
 
2762
        else:
 
2763
            # Decline to open it if the server doesn't support our required
 
2764
            # version (3) so that the VFS-based transport will do it.
 
2765
            if client_medium.should_probe():
 
2766
                try:
 
2767
                    server_version = client_medium.protocol_version()
 
2768
                    if server_version != '2':
 
2769
                        do_vfs = True
 
2770
                    else:
 
2771
                        do_vfs = False
 
2772
                except errors.SmartProtocolError:
 
2773
                    # Apparently there's no usable smart server there, even though
 
2774
                    # the medium supports the smart protocol.
 
2775
                    do_vfs = True
 
2776
            else:
 
2777
                do_vfs = False
 
2778
        if not do_vfs:
 
2779
            client = _SmartClient(client_medium)
 
2780
            path = client.remote_path_from_transport(transport)
 
2781
            if client_medium._is_remote_before((1, 16)):
 
2782
                do_vfs = True
 
2783
        if do_vfs:
 
2784
            # TODO: lookup the local format from a server hint.
 
2785
            local_dir_format = BzrDirMetaFormat1()
 
2786
            self._supply_sub_formats_to(local_dir_format)
 
2787
            return local_dir_format.initialize_on_transport_ex(transport,
 
2788
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
2789
                force_new_repo=force_new_repo, stacked_on=stacked_on,
 
2790
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
2791
                make_working_trees=make_working_trees, shared_repo=shared_repo,
 
2792
                vfs_only=True)
 
2793
        return self._initialize_on_transport_ex_rpc(client, path, transport,
 
2794
            use_existing_dir, create_prefix, force_new_repo, stacked_on,
 
2795
            stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
 
2796
 
 
2797
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
 
2798
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
 
2799
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
 
2800
        args = []
 
2801
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
 
2802
        args.append(self._serialize_NoneTrueFalse(create_prefix))
 
2803
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
 
2804
        args.append(self._serialize_NoneString(stacked_on))
 
2805
        # stack_on_pwd is often/usually our transport
 
2806
        if stack_on_pwd:
 
2807
            try:
 
2808
                stack_on_pwd = transport.relpath(stack_on_pwd)
 
2809
                if not stack_on_pwd:
 
2810
                    stack_on_pwd = '.'
 
2811
            except errors.PathNotChild:
 
2812
                pass
 
2813
        args.append(self._serialize_NoneString(stack_on_pwd))
 
2814
        args.append(self._serialize_NoneString(repo_format_name))
 
2815
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
 
2816
        args.append(self._serialize_NoneTrueFalse(shared_repo))
 
2817
        request_network_name = self._network_name or \
 
2818
            BzrDirFormat.get_default_format().network_name()
 
2819
        try:
 
2820
            response = client.call('BzrDirFormat.initialize_ex_1.16',
 
2821
                request_network_name, path, *args)
 
2822
        except errors.UnknownSmartMethod:
 
2823
            client._medium._remember_remote_is_before((1,16))
 
2824
            local_dir_format = BzrDirMetaFormat1()
 
2825
            self._supply_sub_formats_to(local_dir_format)
 
2826
            return local_dir_format.initialize_on_transport_ex(transport,
 
2827
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
2828
                force_new_repo=force_new_repo, stacked_on=stacked_on,
 
2829
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
2830
                make_working_trees=make_working_trees, shared_repo=shared_repo,
 
2831
                vfs_only=True)
 
2832
        except errors.ErrorFromSmartServer, err:
 
2833
            remote._translate_error(err, path=path)
 
2834
        repo_path = response[0]
 
2835
        bzrdir_name = response[6]
 
2836
        require_stacking = response[7]
 
2837
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
 
2838
        format = RemoteBzrDirFormat()
 
2839
        format._network_name = bzrdir_name
 
2840
        self._supply_sub_formats_to(format)
 
2841
        bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
 
2842
        if repo_path:
 
2843
            repo_format = remote.response_tuple_to_repo_format(response[1:])
 
2844
            if repo_path == '.':
 
2845
                repo_path = ''
 
2846
            if repo_path:
 
2847
                repo_bzrdir_format = RemoteBzrDirFormat()
 
2848
                repo_bzrdir_format._network_name = response[5]
 
2849
                repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
 
2850
                    repo_bzrdir_format)
 
2851
            else:
 
2852
                repo_bzr = bzrdir
 
2853
            final_stack = response[8] or None
 
2854
            final_stack_pwd = response[9] or None
 
2855
            if final_stack_pwd:
 
2856
                final_stack_pwd = urlutils.join(
 
2857
                    transport.base, final_stack_pwd)
 
2858
            remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
 
2859
            if len(response) > 10:
 
2860
                # Updated server verb that locks remotely.
 
2861
                repo_lock_token = response[10] or None
 
2862
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
 
2863
                if repo_lock_token:
 
2864
                    remote_repo.dont_leave_lock_in_place()
 
2865
            else:
 
2866
                remote_repo.lock_write()
 
2867
            policy = UseExistingRepository(remote_repo, final_stack,
 
2868
                final_stack_pwd, require_stacking)
 
2869
            policy.acquire_repository()
 
2870
        else:
 
2871
            remote_repo = None
 
2872
            policy = None
 
2873
        bzrdir._format.set_branch_format(self.get_branch_format())
 
2874
        if require_stacking:
 
2875
            # The repo has already been created, but we need to make sure that
 
2876
            # we'll make a stackable branch.
 
2877
            bzrdir._format.require_stacking(_skip_repo=True)
 
2878
        return remote_repo, bzrdir, require_stacking, policy
 
2879
 
 
2880
    def _open(self, transport):
 
2881
        return remote.RemoteBzrDir(transport, self)
 
2882
 
 
2883
    def __eq__(self, other):
 
2884
        if not isinstance(other, RemoteBzrDirFormat):
 
2885
            return False
 
2886
        return self.get_format_description() == other.get_format_description()
 
2887
 
 
2888
    def __return_repository_format(self):
 
2889
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
 
2890
        # repository format has been asked for, tell the RemoteRepositoryFormat
 
2891
        # that it should use that for init() etc.
 
2892
        result = remote.RemoteRepositoryFormat()
 
2893
        custom_format = getattr(self, '_repository_format', None)
 
2894
        if custom_format:
 
2895
            if isinstance(custom_format, remote.RemoteRepositoryFormat):
 
2896
                return custom_format
 
2897
            else:
 
2898
                # We will use the custom format to create repositories over the
 
2899
                # wire; expose its details like rich_root_data for code to
 
2900
                # query
 
2901
                result._custom_format = custom_format
 
2902
        return result
 
2903
 
 
2904
    def get_branch_format(self):
 
2905
        result = BzrDirMetaFormat1.get_branch_format(self)
 
2906
        if not isinstance(result, remote.RemoteBranchFormat):
 
2907
            new_result = remote.RemoteBranchFormat()
 
2908
            new_result._custom_format = result
 
2909
            # cache the result
 
2910
            self.set_branch_format(new_result)
 
2911
            result = new_result
 
2912
        return result
 
2913
 
 
2914
    repository_format = property(__return_repository_format,
 
2915
        BzrDirMetaFormat1._set_repository_format) #.im_func)
 
2916
 
 
2917
 
1908
2918
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
1909
2919
 
1910
2920
 
2109
3119
    registry.register(key, helper, help, native, deprecated, hidden,
2110
3120
        experimental, alias)
2111
3121
 
 
3122
# The pre-0.8 formats have their repository format network name registered in
 
3123
# repository.py. MetaDir formats have their repository format network name
 
3124
# inferred from their disk format string.
 
3125
controldir.format_registry.register('weave', BzrDirFormat6,
 
3126
    'Pre-0.8 format.  Slower than knit and does not'
 
3127
    ' support checkouts or shared repositories.',
 
3128
    hidden=True,
 
3129
    deprecated=True)
 
3130
register_metadir(controldir.format_registry, 'metaweave',
 
3131
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
 
3132
    'Transitional format in 0.8.  Slower than knit.',
 
3133
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
3134
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
 
3135
    hidden=True,
 
3136
    deprecated=True)
2112
3137
register_metadir(controldir.format_registry, 'knit',
2113
3138
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2114
3139
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
2154
3179
    hidden=True,
2155
3180
    )
2156
3181
register_metadir(controldir.format_registry, 'pack-0.92',
2157
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack1',
 
3182
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
2158
3183
    help='New in 0.92: Pack-based format with data compatible with '
2159
3184
        'dirstate-tags format repositories. Interoperates with '
2160
3185
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2163
3188
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2164
3189
    )
2165
3190
register_metadir(controldir.format_registry, 'pack-0.92-subtree',
2166
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack3',
 
3191
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
2167
3192
    help='New in 0.92: Pack-based format with data compatible with '
2168
3193
        'dirstate-with-subtree format repositories. Interoperates with '
2169
3194
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2174
3199
    experimental=True,
2175
3200
    )
2176
3201
register_metadir(controldir.format_registry, 'rich-root-pack',
2177
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack4',
 
3202
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
2178
3203
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
2179
3204
         '(needed for bzr-svn and bzr-git).',
2180
3205
    branch_format='bzrlib.branch.BzrBranchFormat6',
2182
3207
    hidden=True,
2183
3208
    )
2184
3209
register_metadir(controldir.format_registry, '1.6',
2185
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5',
 
3210
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
2186
3211
    help='A format that allows a branch to indicate that there is another '
2187
3212
         '(stacked) repository that should be used to access data that is '
2188
3213
         'not present locally.',
2191
3216
    hidden=True,
2192
3217
    )
2193
3218
register_metadir(controldir.format_registry, '1.6.1-rich-root',
2194
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5RichRoot',
 
3219
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
2195
3220
    help='A variant of 1.6 that supports rich-root data '
2196
3221
         '(needed for bzr-svn and bzr-git).',
2197
3222
    branch_format='bzrlib.branch.BzrBranchFormat7',
2199
3224
    hidden=True,
2200
3225
    )
2201
3226
register_metadir(controldir.format_registry, '1.9',
2202
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
 
3227
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
2203
3228
    help='A repository format using B+tree indexes. These indexes '
2204
3229
         'are smaller in size, have smarter caching and provide faster '
2205
3230
         'performance for most operations.',
2208
3233
    hidden=True,
2209
3234
    )
2210
3235
register_metadir(controldir.format_registry, '1.9-rich-root',
2211
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
 
3236
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
2212
3237
    help='A variant of 1.9 that supports rich-root data '
2213
3238
         '(needed for bzr-svn and bzr-git).',
2214
3239
    branch_format='bzrlib.branch.BzrBranchFormat7',
2216
3241
    hidden=True,
2217
3242
    )
2218
3243
register_metadir(controldir.format_registry, '1.14',
2219
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
 
3244
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
2220
3245
    help='A working-tree format that supports content filtering.',
2221
3246
    branch_format='bzrlib.branch.BzrBranchFormat7',
2222
3247
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
2223
3248
    )
2224
3249
register_metadir(controldir.format_registry, '1.14-rich-root',
2225
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
 
3250
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
2226
3251
    help='A variant of 1.14 that supports rich-root data '
2227
3252
         '(needed for bzr-svn and bzr-git).',
2228
3253
    branch_format='bzrlib.branch.BzrBranchFormat7',
2246
3271
                 # chk based subtree format.
2247
3272
    )
2248
3273
register_metadir(controldir.format_registry, 'development5-subtree',
2249
 
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatPackDevelopment2Subtree',
 
3274
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
2250
3275
    help='Development format, subtree variant. Can convert data to and '
2251
3276
        'from pack-0.92-subtree (and anything compatible with '
2252
3277
        'pack-0.92-subtree) format repositories. Repositories and branches in '