~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

Show diffs side-by-side

added added

removed removed

Lines of Context:
25
25
objects returned.
26
26
"""
27
27
 
 
28
from __future__ import absolute_import
 
29
 
28
30
import sys
29
31
 
30
32
from bzrlib.lazy_import import lazy_import
46
48
    transport as _mod_transport,
47
49
    ui,
48
50
    urlutils,
 
51
    vf_search,
49
52
    win32utils,
50
53
    workingtree_3,
51
54
    workingtree_4,
52
55
    )
 
56
from bzrlib.branchfmt import fullhistory as fullhistorybranch
53
57
from bzrlib.repofmt import knitpack_repo
54
58
from bzrlib.transport import (
55
59
    do_catching_redirections,
66
70
from bzrlib import (
67
71
    config,
68
72
    controldir,
69
 
    hooks,
70
73
    registry,
71
74
    )
72
75
from bzrlib.symbol_versioning import (
201
204
                if (result_repo.user_url == result.user_url
202
205
                    and not require_stacking and
203
206
                    revision_id is not None):
204
 
                    fetch_spec = graph.PendingAncestryResult(
 
207
                    fetch_spec = vf_search.PendingAncestryResult(
205
208
                        [revision_id], local_repo)
206
209
                    result_repo.fetch(local_repo, fetch_spec=fetch_spec)
207
210
                else:
222
225
            # the tree and fail.
223
226
            result.root_transport.local_abspath('.')
224
227
            if result_repo is None or result_repo.make_working_trees():
225
 
                self.open_workingtree().clone(result)
 
228
                self.open_workingtree().clone(result, revision_id=revision_id)
226
229
        except (errors.NoWorkingTree, errors.NotLocalUrl):
227
230
            pass
228
231
        return result
233
236
        t = _mod_transport.get_transport(url)
234
237
        t.ensure_base()
235
238
 
236
 
    @staticmethod
237
 
    def find_bzrdirs(transport, evaluate=None, list_current=None):
238
 
        """Find bzrdirs recursively from current location.
239
 
 
240
 
        This is intended primarily as a building block for more sophisticated
241
 
        functionality, like finding trees under a directory, or finding
242
 
        branches that use a given repository.
243
 
 
244
 
        :param evaluate: An optional callable that yields recurse, value,
245
 
            where recurse controls whether this bzrdir is recursed into
246
 
            and value is the value to yield.  By default, all bzrdirs
247
 
            are recursed into, and the return value is the bzrdir.
248
 
        :param list_current: if supplied, use this function to list the current
249
 
            directory, instead of Transport.list_dir
250
 
        :return: a generator of found bzrdirs, or whatever evaluate returns.
251
 
        """
252
 
        if list_current is None:
253
 
            def list_current(transport):
254
 
                return transport.list_dir('')
255
 
        if evaluate is None:
256
 
            def evaluate(bzrdir):
257
 
                return True, bzrdir
258
 
 
259
 
        pending = [transport]
260
 
        while len(pending) > 0:
261
 
            current_transport = pending.pop()
262
 
            recurse = True
263
 
            try:
264
 
                bzrdir = BzrDir.open_from_transport(current_transport)
265
 
            except (errors.NotBranchError, errors.PermissionDenied):
266
 
                pass
267
 
            else:
268
 
                recurse, value = evaluate(bzrdir)
269
 
                yield value
270
 
            try:
271
 
                subdirs = list_current(current_transport)
272
 
            except (errors.NoSuchFile, errors.PermissionDenied):
273
 
                continue
274
 
            if recurse:
275
 
                for subdir in sorted(subdirs, reverse=True):
276
 
                    pending.append(current_transport.clone(subdir))
277
 
 
278
 
    @staticmethod
279
 
    def find_branches(transport):
280
 
        """Find all branches under a transport.
281
 
 
282
 
        This will find all branches below the transport, including branches
283
 
        inside other branches.  Where possible, it will use
284
 
        Repository.find_branches.
285
 
 
286
 
        To list all the branches that use a particular Repository, see
287
 
        Repository.find_branches
288
 
        """
289
 
        def evaluate(bzrdir):
290
 
            try:
291
 
                repository = bzrdir.open_repository()
292
 
            except errors.NoRepositoryPresent:
293
 
                pass
294
 
            else:
295
 
                return False, ([], repository)
296
 
            return True, (bzrdir.list_branches(), None)
297
 
        ret = []
298
 
        for branches, repo in BzrDir.find_bzrdirs(transport,
299
 
                                                  evaluate=evaluate):
300
 
            if repo is not None:
301
 
                ret.extend(repo.find_branches())
302
 
            if branches is not None:
303
 
                ret.extend(branches)
304
 
        return ret
305
 
 
306
 
    @staticmethod
307
 
    def create_branch_and_repo(base, force_new_repo=False, format=None):
308
 
        """Create a new BzrDir, Branch and Repository at the url 'base'.
309
 
 
310
 
        This will use the current default BzrDirFormat unless one is
311
 
        specified, and use whatever
312
 
        repository format that that uses via bzrdir.create_branch and
313
 
        create_repository. If a shared repository is available that is used
314
 
        preferentially.
315
 
 
316
 
        The created Branch object is returned.
317
 
 
318
 
        :param base: The URL to create the branch at.
319
 
        :param force_new_repo: If True a new repository is always created.
320
 
        :param format: If supplied, the format of branch to create.  If not
321
 
            supplied, the default is used.
322
 
        """
323
 
        bzrdir = BzrDir.create(base, format)
324
 
        bzrdir._find_or_create_repository(force_new_repo)
325
 
        return bzrdir.create_branch()
326
 
 
327
239
    def determine_repository_policy(self, force_new_repo=False, stack_on=None,
328
240
                                    stack_on_pwd=None, require_stacking=False):
329
241
        """Return an object representing a policy to use.
444
356
            location of this control directory.
445
357
        :param create_tree_if_local: If true, a working-tree will be created
446
358
            when working locally.
 
359
        :return: The created control directory
447
360
        """
448
361
        operation = cleanup.OperationWithCleanups(self._sprout)
449
362
        return operation.run(url, revision_id=revision_id,
462
375
        if revision_id is not None:
463
376
            fetch_spec_factory.add_revision_ids([revision_id])
464
377
            fetch_spec_factory.source_branch_stop_revision_id = revision_id
 
378
        if possible_transports is None:
 
379
            possible_transports = []
 
380
        else:
 
381
            possible_transports = list(possible_transports) + [
 
382
                self.root_transport]
465
383
        target_transport = _mod_transport.get_transport(url,
466
384
            possible_transports)
467
385
        target_transport.ensure_base()
468
386
        cloning_format = self.cloning_metadir(stacked)
469
387
        # Create/update the result branch
470
 
        result = cloning_format.initialize_on_transport(target_transport)
 
388
        try:
 
389
            result = controldir.ControlDir.open_from_transport(target_transport)
 
390
        except errors.NotBranchError:
 
391
            result = cloning_format.initialize_on_transport(target_transport)
471
392
        source_branch, source_repository = self._find_source_repo(
472
393
            add_cleanup, source_branch)
473
394
        fetch_spec_factory.source_branch = source_branch
479
400
            stacked_branch_url = None
480
401
        repository_policy = result.determine_repository_policy(
481
402
            force_new_repo, stacked_branch_url, require_stacking=stacked)
482
 
        result_repo, is_new_repo = repository_policy.acquire_repository()
 
403
        result_repo, is_new_repo = repository_policy.acquire_repository(
 
404
            possible_transports=possible_transports)
483
405
        add_cleanup(result_repo.lock_write().unlock)
484
406
        fetch_spec_factory.source_repo = source_repository
485
407
        fetch_spec_factory.target_repo = result_repo
506
428
        mutter("created new branch %r" % (result_branch,))
507
429
 
508
430
        # Create/update the result working tree
509
 
        if (create_tree_if_local and
 
431
        if (create_tree_if_local and not result.has_workingtree() and
510
432
            isinstance(target_transport, local.LocalTransport) and
511
433
            (result_repo is None or result_repo.make_working_trees())):
512
434
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
544
466
                    stacked=stacked)
545
467
        return result
546
468
 
547
 
    @staticmethod
548
 
    def create_branch_convenience(base, force_new_repo=False,
549
 
                                  force_new_tree=None, format=None,
550
 
                                  possible_transports=None):
551
 
        """Create a new BzrDir, Branch and Repository at the url 'base'.
552
 
 
553
 
        This is a convenience function - it will use an existing repository
554
 
        if possible, can be told explicitly whether to create a working tree or
555
 
        not.
556
 
 
557
 
        This will use the current default BzrDirFormat unless one is
558
 
        specified, and use whatever
559
 
        repository format that that uses via bzrdir.create_branch and
560
 
        create_repository. If a shared repository is available that is used
561
 
        preferentially. Whatever repository is used, its tree creation policy
562
 
        is followed.
563
 
 
564
 
        The created Branch object is returned.
565
 
        If a working tree cannot be made due to base not being a file:// url,
566
 
        no error is raised unless force_new_tree is True, in which case no
567
 
        data is created on disk and NotLocalUrl is raised.
568
 
 
569
 
        :param base: The URL to create the branch at.
570
 
        :param force_new_repo: If True a new repository is always created.
571
 
        :param force_new_tree: If True or False force creation of a tree or
572
 
                               prevent such creation respectively.
573
 
        :param format: Override for the bzrdir format to create.
574
 
        :param possible_transports: An optional reusable transports list.
575
 
        """
576
 
        if force_new_tree:
577
 
            # check for non local urls
578
 
            t = _mod_transport.get_transport(base, possible_transports)
579
 
            if not isinstance(t, local.LocalTransport):
580
 
                raise errors.NotLocalUrl(base)
581
 
        bzrdir = BzrDir.create(base, format, possible_transports)
582
 
        repo = bzrdir._find_or_create_repository(force_new_repo)
583
 
        result = bzrdir.create_branch()
584
 
        if force_new_tree or (repo.make_working_trees() and
585
 
                              force_new_tree is None):
586
 
            try:
587
 
                bzrdir.create_workingtree()
588
 
            except errors.NotLocalUrl:
589
 
                pass
590
 
        return result
591
 
 
592
 
    @staticmethod
593
 
    def create_standalone_workingtree(base, format=None):
594
 
        """Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
595
 
 
596
 
        'base' must be a local path or a file:// url.
597
 
 
598
 
        This will use the current default BzrDirFormat unless one is
599
 
        specified, and use whatever
600
 
        repository format that that uses for bzrdirformat.create_workingtree,
601
 
        create_branch and create_repository.
602
 
 
603
 
        :param format: Override for the bzrdir format to create.
604
 
        :return: The WorkingTree object.
605
 
        """
606
 
        t = _mod_transport.get_transport(base)
607
 
        if not isinstance(t, local.LocalTransport):
608
 
            raise errors.NotLocalUrl(base)
609
 
        bzrdir = BzrDir.create_branch_and_repo(base,
610
 
                                               force_new_repo=True,
611
 
                                               format=format).bzrdir
612
 
        return bzrdir.create_workingtree()
613
 
 
614
 
    @deprecated_method(deprecated_in((2, 3, 0)))
615
 
    def generate_backup_name(self, base):
616
 
        return self._available_backup_name(base)
617
 
 
618
469
    def _available_backup_name(self, base):
619
470
        """Find a non-existing backup file name based on base.
620
471
 
690
541
                return None
691
542
            # find the next containing bzrdir
692
543
            try:
693
 
                found_bzrdir = BzrDir.open_containing_from_transport(
 
544
                found_bzrdir = self.open_containing_from_transport(
694
545
                    next_transport)[0]
695
546
            except errors.NotBranchError:
696
547
                return None
813
664
        # add new tests for it to the appropriate place.
814
665
        return filename == '.bzr' or filename.startswith('.bzr/')
815
666
 
816
 
    @staticmethod
817
 
    def open_unsupported(base):
818
 
        """Open a branch which is not supported."""
819
 
        return BzrDir.open(base, _unsupported=True)
820
 
 
821
 
    @staticmethod
822
 
    def open(base, _unsupported=False, possible_transports=None):
823
 
        """Open an existing bzrdir, rooted at 'base' (url).
824
 
 
825
 
        :param _unsupported: a private parameter to the BzrDir class.
826
 
        """
827
 
        t = _mod_transport.get_transport(base, possible_transports)
828
 
        return BzrDir.open_from_transport(t, _unsupported=_unsupported)
829
 
 
830
 
    @staticmethod
831
 
    def open_from_transport(transport, _unsupported=False,
832
 
                            _server_formats=True):
833
 
        """Open a bzrdir within a particular directory.
834
 
 
835
 
        :param transport: Transport containing the bzrdir.
836
 
        :param _unsupported: private.
837
 
        """
838
 
        for hook in BzrDir.hooks['pre_open']:
839
 
            hook(transport)
840
 
        # Keep initial base since 'transport' may be modified while following
841
 
        # the redirections.
842
 
        base = transport.base
843
 
        def find_format(transport):
844
 
            return transport, controldir.ControlDirFormat.find_format(
845
 
                transport, _server_formats=_server_formats)
846
 
 
847
 
        def redirected(transport, e, redirection_notice):
848
 
            redirected_transport = transport._redirected_to(e.source, e.target)
849
 
            if redirected_transport is None:
850
 
                raise errors.NotBranchError(base)
851
 
            note(gettext('{0} is{1} redirected to {2}').format(
852
 
                 transport.base, e.permanently, redirected_transport.base))
853
 
            return redirected_transport
854
 
 
855
 
        try:
856
 
            transport, format = do_catching_redirections(find_format,
857
 
                                                         transport,
858
 
                                                         redirected)
859
 
        except errors.TooManyRedirections:
860
 
            raise errors.NotBranchError(base)
861
 
 
862
 
        format.check_support_status(_unsupported)
863
 
        return format.open(transport, _found=True)
864
 
 
865
 
    @staticmethod
866
 
    def open_containing(url, possible_transports=None):
867
 
        """Open an existing branch which contains url.
868
 
 
869
 
        :param url: url to search from.
870
 
 
871
 
        See open_containing_from_transport for more detail.
872
 
        """
873
 
        transport = _mod_transport.get_transport(url, possible_transports)
874
 
        return BzrDir.open_containing_from_transport(transport)
875
 
 
876
 
    @staticmethod
877
 
    def open_containing_from_transport(a_transport):
878
 
        """Open an existing branch which contains a_transport.base.
879
 
 
880
 
        This probes for a branch at a_transport, and searches upwards from there.
881
 
 
882
 
        Basically we keep looking up until we find the control directory or
883
 
        run into the root.  If there isn't one, raises NotBranchError.
884
 
        If there is one and it is either an unrecognised format or an unsupported
885
 
        format, UnknownFormatError or UnsupportedFormatError are raised.
886
 
        If there is one, it is returned, along with the unused portion of url.
887
 
 
888
 
        :return: The BzrDir that contains the path, and a Unicode path
889
 
                for the rest of the URL.
890
 
        """
891
 
        # this gets the normalised url back. I.e. '.' -> the full path.
892
 
        url = a_transport.base
893
 
        while True:
894
 
            try:
895
 
                result = BzrDir.open_from_transport(a_transport)
896
 
                return result, urlutils.unescape(a_transport.relpath(url))
897
 
            except errors.NotBranchError, e:
898
 
                pass
899
 
            try:
900
 
                new_t = a_transport.clone('..')
901
 
            except errors.InvalidURLJoin:
902
 
                # reached the root, whatever that may be
903
 
                raise errors.NotBranchError(path=url)
904
 
            if new_t.base == a_transport.base:
905
 
                # reached the root, whatever that may be
906
 
                raise errors.NotBranchError(path=url)
907
 
            a_transport = new_t
908
 
 
909
 
    @classmethod
910
 
    def open_tree_or_branch(klass, location):
911
 
        """Return the branch and working tree at a location.
912
 
 
913
 
        If there is no tree at the location, tree will be None.
914
 
        If there is no branch at the location, an exception will be
915
 
        raised
916
 
        :return: (tree, branch)
917
 
        """
918
 
        bzrdir = klass.open(location)
919
 
        return bzrdir._get_tree_branch()
920
 
 
921
 
    @classmethod
922
 
    def open_containing_tree_or_branch(klass, location):
923
 
        """Return the branch and working tree contained by a location.
924
 
 
925
 
        Returns (tree, branch, relpath).
926
 
        If there is no tree at containing the location, tree will be None.
927
 
        If there is no branch containing the location, an exception will be
928
 
        raised
929
 
        relpath is the portion of the path that is contained by the branch.
930
 
        """
931
 
        bzrdir, relpath = klass.open_containing(location)
932
 
        tree, branch = bzrdir._get_tree_branch()
933
 
        return tree, branch, relpath
934
 
 
935
 
    @classmethod
936
 
    def open_containing_tree_branch_or_repository(klass, location):
937
 
        """Return the working tree, branch and repo contained by a location.
938
 
 
939
 
        Returns (tree, branch, repository, relpath).
940
 
        If there is no tree containing the location, tree will be None.
941
 
        If there is no branch containing the location, branch will be None.
942
 
        If there is no repository containing the location, repository will be
943
 
        None.
944
 
        relpath is the portion of the path that is contained by the innermost
945
 
        BzrDir.
946
 
 
947
 
        If no tree, branch or repository is found, a NotBranchError is raised.
948
 
        """
949
 
        bzrdir, relpath = klass.open_containing(location)
950
 
        try:
951
 
            tree, branch = bzrdir._get_tree_branch()
952
 
        except errors.NotBranchError:
953
 
            try:
954
 
                repo = bzrdir.find_repository()
955
 
                return None, None, repo, relpath
956
 
            except (errors.NoRepositoryPresent):
957
 
                raise errors.NotBranchError(location)
958
 
        return tree, branch, branch.repository, relpath
959
 
 
960
667
    def _cloning_metadir(self):
961
668
        """Produce a metadir suitable for cloning with.
962
669
 
1002
709
 
1003
710
        :require_stacking: If True, non-stackable formats will be upgraded
1004
711
            to similar stackable formats.
1005
 
        :returns: a BzrDirFormat with all component formats either set
 
712
        :returns: a ControlDirFormat with all component formats either set
1006
713
            appropriately or set to None if that component should not be
1007
714
            created.
1008
715
        """
1020
727
            format.require_stacking()
1021
728
        return format
1022
729
 
1023
 
    @classmethod
1024
 
    def create(cls, base, format=None, possible_transports=None):
1025
 
        """Create a new BzrDir at the url 'base'.
1026
 
 
1027
 
        :param format: If supplied, the format of branch to create.  If not
1028
 
            supplied, the default is used.
1029
 
        :param possible_transports: If supplied, a list of transports that
1030
 
            can be reused to share a remote connection.
1031
 
        """
1032
 
        if cls is not BzrDir:
1033
 
            raise AssertionError("BzrDir.create always creates the"
1034
 
                "default format, not one of %r" % cls)
1035
 
        t = _mod_transport.get_transport(base, possible_transports)
1036
 
        t.ensure_base()
1037
 
        if format is None:
1038
 
            format = controldir.ControlDirFormat.get_default_format()
1039
 
        return format.initialize_on_transport(t)
1040
 
 
1041
730
    def get_branch_transport(self, branch_format, name=None):
1042
731
        """Get the transport for use by branch format in this BzrDir.
1043
732
 
1077
766
        """
1078
767
        raise NotImplementedError(self.get_workingtree_transport)
1079
768
 
1080
 
 
1081
 
class BzrDirHooks(hooks.Hooks):
1082
 
    """Hooks for BzrDir operations."""
1083
 
 
1084
 
    def __init__(self):
1085
 
        """Create the default hooks."""
1086
 
        hooks.Hooks.__init__(self, "bzrlib.bzrdir", "BzrDir.hooks")
1087
 
        self.add_hook('pre_open',
1088
 
            "Invoked before attempting to open a BzrDir with the transport "
1089
 
            "that the open will use.", (1, 14))
1090
 
        self.add_hook('post_repo_init',
1091
 
            "Invoked after a repository has been initialized. "
1092
 
            "post_repo_init is called with a "
1093
 
            "bzrlib.bzrdir.RepoInitHookParams.",
1094
 
            (2, 2))
1095
 
 
1096
 
# install the default hooks
1097
 
BzrDir.hooks = BzrDirHooks()
1098
 
 
1099
 
 
1100
 
class RepoInitHookParams(object):
1101
 
    """Object holding parameters passed to `*_repo_init` hooks.
1102
 
 
1103
 
    There are 4 fields that hooks may wish to access:
1104
 
 
1105
 
    :ivar repository: Repository created
1106
 
    :ivar format: Repository format
1107
 
    :ivar bzrdir: The bzrdir for the repository
1108
 
    :ivar shared: The repository is shared
1109
 
    """
1110
 
 
1111
 
    def __init__(self, repository, format, a_bzrdir, shared):
1112
 
        """Create a group of RepoInitHook parameters.
1113
 
 
1114
 
        :param repository: Repository created
1115
 
        :param format: Repository format
1116
 
        :param bzrdir: The bzrdir for the repository
1117
 
        :param shared: The repository is shared
 
769
    @classmethod
 
770
    def create(cls, base, format=None, possible_transports=None):
 
771
        """Create a new BzrDir at the url 'base'.
 
772
 
 
773
        :param format: If supplied, the format of branch to create.  If not
 
774
            supplied, the default is used.
 
775
        :param possible_transports: If supplied, a list of transports that
 
776
            can be reused to share a remote connection.
1118
777
        """
1119
 
        self.repository = repository
1120
 
        self.format = format
1121
 
        self.bzrdir = a_bzrdir
1122
 
        self.shared = shared
1123
 
 
1124
 
    def __eq__(self, other):
1125
 
        return self.__dict__ == other.__dict__
 
778
        if cls is not BzrDir:
 
779
            raise AssertionError("BzrDir.create always creates the "
 
780
                "default format, not one of %r" % cls)
 
781
        return controldir.ControlDir.create(base, format=format,
 
782
                possible_transports=possible_transports)
1126
783
 
1127
784
    def __repr__(self):
1128
 
        if self.repository:
1129
 
            return "<%s for %s>" % (self.__class__.__name__,
1130
 
                self.repository)
1131
 
        else:
1132
 
            return "<%s for %s>" % (self.__class__.__name__,
1133
 
                self.bzrdir)
 
785
        return "<%s at %r>" % (self.__class__.__name__, self.user_url)
 
786
 
 
787
    def update_feature_flags(self, updated_flags):
 
788
        """Update the features required by this bzrdir.
 
789
 
 
790
        :param updated_flags: Dictionary mapping feature names to necessities
 
791
            A necessity can be None to indicate the feature should be removed
 
792
        """
 
793
        self.control_files.lock_write()
 
794
        try:
 
795
            self._format._update_feature_flags(updated_flags)
 
796
            self.transport.put_bytes('branch-format', self._format.as_string())
 
797
        finally:
 
798
            self.control_files.unlock()
1134
799
 
1135
800
 
1136
801
class BzrDirMeta1(BzrDir):
1142
807
    present within a BzrDir.
1143
808
    """
1144
809
 
 
810
    def _get_branch_path(self, name):
 
811
        """Obtain the branch path to use.
 
812
 
 
813
        This uses the API specified branch name first, and then falls back to
 
814
        the branch name specified in the URL. If neither of those is specified,
 
815
        it uses the default branch.
 
816
 
 
817
        :param name: Optional branch name to use
 
818
        :return: Relative path to branch
 
819
        """
 
820
        if name == "":
 
821
            return 'branch'
 
822
        return urlutils.join('branches', name.encode("utf-8"))
 
823
 
 
824
    def _read_branch_list(self):
 
825
        """Read the branch list.
 
826
 
 
827
        :return: List of utf-8 encoded branch names.
 
828
        """
 
829
        try:
 
830
            f = self.control_transport.get('branch-list')
 
831
        except errors.NoSuchFile:
 
832
            return []
 
833
 
 
834
        ret = []
 
835
        try:
 
836
            for name in f:
 
837
                ret.append(name.rstrip("\n"))
 
838
        finally:
 
839
            f.close()
 
840
        return ret
 
841
 
 
842
    def _write_branch_list(self, branches):
 
843
        """Write out the branch list.
 
844
 
 
845
        :param branches: List of utf-8 branch names to write
 
846
        """
 
847
        self.transport.put_bytes('branch-list',
 
848
            "".join([name+"\n" for name in branches]))
 
849
 
 
850
    def __init__(self, _transport, _format):
 
851
        super(BzrDirMeta1, self).__init__(_transport, _format)
 
852
        self.control_files = lockable_files.LockableFiles(
 
853
            self.control_transport, self._format._lock_file_name,
 
854
            self._format._lock_class)
 
855
 
1145
856
    def can_convert_format(self):
1146
857
        """See BzrDir.can_convert_format()."""
1147
858
        return True
1148
859
 
1149
860
    def create_branch(self, name=None, repository=None,
1150
861
            append_revisions_only=None):
1151
 
        """See BzrDir.create_branch."""
 
862
        """See ControlDir.create_branch."""
 
863
        if name is None:
 
864
            name = self._get_selected_branch()
1152
865
        return self._format.get_branch_format().initialize(self, name=name,
1153
866
                repository=repository,
1154
867
                append_revisions_only=append_revisions_only)
1155
868
 
1156
869
    def destroy_branch(self, name=None):
1157
 
        """See BzrDir.create_branch."""
1158
 
        if name is not None:
1159
 
            raise errors.NoColocatedBranchSupport(self)
1160
 
        self.transport.delete_tree('branch')
 
870
        """See ControlDir.destroy_branch."""
 
871
        if name is None:
 
872
            name = self._get_selected_branch()
 
873
        path = self._get_branch_path(name)
 
874
        if name != "":
 
875
            self.control_files.lock_write()
 
876
            try:
 
877
                branches = self._read_branch_list()
 
878
                try:
 
879
                    branches.remove(name.encode("utf-8"))
 
880
                except ValueError:
 
881
                    raise errors.NotBranchError(name)
 
882
                self._write_branch_list(branches)
 
883
            finally:
 
884
                self.control_files.unlock()
 
885
        try:
 
886
            self.transport.delete_tree(path)
 
887
        except errors.NoSuchFile:
 
888
            raise errors.NotBranchError(path=urlutils.join(self.transport.base,
 
889
                path), bzrdir=self)
1161
890
 
1162
891
    def create_repository(self, shared=False):
1163
892
        """See BzrDir.create_repository."""
1165
894
 
1166
895
    def destroy_repository(self):
1167
896
        """See BzrDir.destroy_repository."""
1168
 
        self.transport.delete_tree('repository')
 
897
        try:
 
898
            self.transport.delete_tree('repository')
 
899
        except errors.NoSuchFile:
 
900
            raise errors.NoRepositoryPresent(self)
1169
901
 
1170
902
    def create_workingtree(self, revision_id=None, from_branch=None,
1171
903
                           accelerator_tree=None, hardlink=False):
1193
925
 
1194
926
        This might be a synthetic object for e.g. RemoteBranch and SVN.
1195
927
        """
1196
 
        from bzrlib.branch import BranchFormat
1197
 
        return BranchFormat.find_format(self, name=name)
 
928
        from bzrlib.branch import BranchFormatMetadir
 
929
        return BranchFormatMetadir.find_format(self, name=name)
1198
930
 
1199
931
    def _get_mkdir_mode(self):
1200
932
        """Figure out the mode to use when creating a bzrdir subdir."""
1204
936
 
1205
937
    def get_branch_reference(self, name=None):
1206
938
        """See BzrDir.get_branch_reference()."""
1207
 
        from bzrlib.branch import BranchFormat
1208
 
        format = BranchFormat.find_format(self, name=name)
 
939
        from bzrlib.branch import BranchFormatMetadir
 
940
        format = BranchFormatMetadir.find_format(self, name=name)
1209
941
        return format.get_reference(self, name=name)
1210
942
 
 
943
    def set_branch_reference(self, target_branch, name=None):
 
944
        format = _mod_branch.BranchReferenceFormat()
 
945
        return format.initialize(self, target_branch=target_branch, name=name)
 
946
 
1211
947
    def get_branch_transport(self, branch_format, name=None):
1212
948
        """See BzrDir.get_branch_transport()."""
1213
 
        if name is not None:
1214
 
            raise errors.NoColocatedBranchSupport(self)
 
949
        if name is None:
 
950
            name = self._get_selected_branch()
 
951
        path = self._get_branch_path(name)
1215
952
        # XXX: this shouldn't implicitly create the directory if it's just
1216
953
        # promising to get a transport -- mbp 20090727
1217
954
        if branch_format is None:
1218
 
            return self.transport.clone('branch')
 
955
            return self.transport.clone(path)
1219
956
        try:
1220
957
            branch_format.get_format_string()
1221
958
        except NotImplementedError:
1222
959
            raise errors.IncompatibleFormat(branch_format, self._format)
 
960
        if name != "":
 
961
            branches = self._read_branch_list()
 
962
            utf8_name = name.encode("utf-8")
 
963
            if not utf8_name in branches:
 
964
                self.control_files.lock_write()
 
965
                try:
 
966
                    branches = self._read_branch_list()
 
967
                    dirname = urlutils.dirname(utf8_name)
 
968
                    if dirname != "" and dirname in branches:
 
969
                        raise errors.ParentBranchExists(name)
 
970
                    child_branches = [
 
971
                        b.startswith(utf8_name+"/") for b in branches]
 
972
                    if any(child_branches):
 
973
                        raise errors.AlreadyBranchError(name)
 
974
                    branches.append(utf8_name)
 
975
                    self._write_branch_list(branches)
 
976
                finally:
 
977
                    self.control_files.unlock()
 
978
        branch_transport = self.transport.clone(path)
 
979
        mode = self._get_mkdir_mode()
 
980
        branch_transport.create_prefix(mode=mode)
1223
981
        try:
1224
 
            self.transport.mkdir('branch', mode=self._get_mkdir_mode())
 
982
            self.transport.mkdir(path, mode=mode)
1225
983
        except errors.FileExists:
1226
984
            pass
1227
 
        return self.transport.clone('branch')
 
985
        return self.transport.clone(path)
1228
986
 
1229
987
    def get_repository_transport(self, repository_format):
1230
988
        """See BzrDir.get_repository_transport()."""
1254
1012
            pass
1255
1013
        return self.transport.clone('checkout')
1256
1014
 
 
1015
    def get_branches(self):
 
1016
        """See ControlDir.get_branches."""
 
1017
        ret = {}
 
1018
        try:
 
1019
            ret[""] = self.open_branch(name="")
 
1020
        except (errors.NotBranchError, errors.NoRepositoryPresent):
 
1021
            pass
 
1022
 
 
1023
        for name in self._read_branch_list():
 
1024
            ret[name] = self.open_branch(name=name.decode('utf-8'))
 
1025
 
 
1026
        return ret
 
1027
 
1257
1028
    def has_workingtree(self):
1258
1029
        """Tell if this bzrdir contains a working tree.
1259
1030
 
1260
1031
        Note: if you're going to open the working tree, you should just go
1261
1032
        ahead and try, and not ask permission first.
1262
1033
        """
1263
 
        from bzrlib.workingtree import WorkingTreeFormat
 
1034
        from bzrlib.workingtree import WorkingTreeFormatMetaDir
1264
1035
        try:
1265
 
            WorkingTreeFormat.find_format_string(self)
 
1036
            WorkingTreeFormatMetaDir.find_format_string(self)
1266
1037
        except errors.NoWorkingTree:
1267
1038
            return False
1268
1039
        return True
1269
1040
 
1270
1041
    def needs_format_conversion(self, format):
1271
1042
        """See BzrDir.needs_format_conversion()."""
1272
 
        if not isinstance(self._format, format.__class__):
 
1043
        if (not isinstance(self._format, format.__class__) or
 
1044
            self._format.get_format_string() != format.get_format_string()):
1273
1045
            # it is not a meta dir format, conversion is needed.
1274
1046
            return True
1275
1047
        # we might want to push this down to the repository?
1296
1068
        return False
1297
1069
 
1298
1070
    def open_branch(self, name=None, unsupported=False,
1299
 
                    ignore_fallbacks=False):
1300
 
        """See BzrDir.open_branch."""
 
1071
                    ignore_fallbacks=False, possible_transports=None):
 
1072
        """See ControlDir.open_branch."""
 
1073
        if name is None:
 
1074
            name = self._get_selected_branch()
1301
1075
        format = self.find_branch_format(name=name)
1302
1076
        format.check_support_status(unsupported)
1303
1077
        return format.open(self, name=name,
1304
 
            _found=True, ignore_fallbacks=ignore_fallbacks)
 
1078
            _found=True, ignore_fallbacks=ignore_fallbacks,
 
1079
            possible_transports=possible_transports)
1305
1080
 
1306
1081
    def open_repository(self, unsupported=False):
1307
1082
        """See BzrDir.open_repository."""
1308
 
        from bzrlib.repository import RepositoryFormat
1309
 
        format = RepositoryFormat.find_format(self)
 
1083
        from bzrlib.repository import RepositoryFormatMetaDir
 
1084
        format = RepositoryFormatMetaDir.find_format(self)
1310
1085
        format.check_support_status(unsupported)
1311
1086
        return format.open(self, _found=True)
1312
1087
 
1313
1088
    def open_workingtree(self, unsupported=False,
1314
1089
            recommend_upgrade=True):
1315
1090
        """See BzrDir.open_workingtree."""
1316
 
        from bzrlib.workingtree import WorkingTreeFormat
1317
 
        format = WorkingTreeFormat.find_format(self)
 
1091
        from bzrlib.workingtree import WorkingTreeFormatMetaDir
 
1092
        format = WorkingTreeFormatMetaDir.find_format(self)
1318
1093
        format.check_support_status(unsupported, recommend_upgrade,
1319
1094
            basedir=self.root_transport.base)
1320
1095
        return format.open(self, _found=True)
1323
1098
        return config.TransportConfig(self.transport, 'control.conf')
1324
1099
 
1325
1100
 
 
1101
class BzrFormat(object):
 
1102
    """Base class for all formats of things living in metadirs.
 
1103
 
 
1104
    This class manages the format string that is stored in the 'format'
 
1105
    or 'branch-format' file.
 
1106
 
 
1107
    All classes for (branch-, repository-, workingtree-) formats that
 
1108
    live in meta directories and have their own 'format' file
 
1109
    (i.e. different from .bzr/branch-format) derive from this class,
 
1110
    as well as the relevant base class for their kind
 
1111
    (BranchFormat, WorkingTreeFormat, RepositoryFormat).
 
1112
 
 
1113
    Each format is identified by a "format" or "branch-format" file with a
 
1114
    single line containing the base format name and then an optional list of
 
1115
    feature flags.
 
1116
 
 
1117
    Feature flags are supported as of bzr 2.5. Setting feature flags on formats
 
1118
    will render them inaccessible to older versions of bzr.
 
1119
 
 
1120
    :ivar features: Dictionary mapping feature names to their necessity
 
1121
    """
 
1122
 
 
1123
    _present_features = set()
 
1124
 
 
1125
    def __init__(self):
 
1126
        self.features = {}
 
1127
 
 
1128
    @classmethod
 
1129
    def register_feature(cls, name):
 
1130
        """Register a feature as being present.
 
1131
 
 
1132
        :param name: Name of the feature
 
1133
        """
 
1134
        if " " in name:
 
1135
            raise ValueError("spaces are not allowed in feature names")
 
1136
        if name in cls._present_features:
 
1137
            raise errors.FeatureAlreadyRegistered(name)
 
1138
        cls._present_features.add(name)
 
1139
 
 
1140
    @classmethod
 
1141
    def unregister_feature(cls, name):
 
1142
        """Unregister a feature."""
 
1143
        cls._present_features.remove(name)
 
1144
 
 
1145
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
1146
            basedir=None):
 
1147
        for name, necessity in self.features.iteritems():
 
1148
            if name in self._present_features:
 
1149
                continue
 
1150
            if necessity == "optional":
 
1151
                mutter("ignoring optional missing feature %s", name)
 
1152
                continue
 
1153
            elif necessity == "required":
 
1154
                raise errors.MissingFeature(name)
 
1155
            else:
 
1156
                mutter("treating unknown necessity as require for %s",
 
1157
                       name)
 
1158
                raise errors.MissingFeature(name)
 
1159
 
 
1160
    @classmethod
 
1161
    def get_format_string(cls):
 
1162
        """Return the ASCII format string that identifies this format."""
 
1163
        raise NotImplementedError(cls.get_format_string)
 
1164
 
 
1165
    @classmethod
 
1166
    def from_string(cls, text):
 
1167
        format_string = cls.get_format_string()
 
1168
        if not text.startswith(format_string):
 
1169
            raise AssertionError("Invalid format header %r for %r" % (text, cls))
 
1170
        lines = text[len(format_string):].splitlines()
 
1171
        ret = cls()
 
1172
        for lineno, line in enumerate(lines):
 
1173
            try:
 
1174
                (necessity, feature) = line.split(" ", 1)
 
1175
            except ValueError:
 
1176
                raise errors.ParseFormatError(format=cls, lineno=lineno+2,
 
1177
                    line=line, text=text)
 
1178
            ret.features[feature] = necessity
 
1179
        return ret
 
1180
 
 
1181
    def as_string(self):
 
1182
        """Return the string representation of this format.
 
1183
        """
 
1184
        lines = [self.get_format_string()]
 
1185
        lines.extend([("%s %s\n" % (item[1], item[0])) for item in
 
1186
            self.features.iteritems()])
 
1187
        return "".join(lines)
 
1188
 
 
1189
    @classmethod
 
1190
    def _find_format(klass, registry, kind, format_string):
 
1191
        try:
 
1192
            first_line = format_string[:format_string.index("\n")+1]
 
1193
        except ValueError:
 
1194
            first_line = format_string
 
1195
        try:
 
1196
            cls = registry.get(first_line)
 
1197
        except KeyError:
 
1198
            raise errors.UnknownFormatError(format=first_line, kind=kind)
 
1199
        return cls.from_string(format_string)
 
1200
 
 
1201
    def network_name(self):
 
1202
        """A simple byte string uniquely identifying this format for RPC calls.
 
1203
 
 
1204
        Metadir branch formats use their format string.
 
1205
        """
 
1206
        return self.as_string()
 
1207
 
 
1208
    def __eq__(self, other):
 
1209
        return (self.__class__ is other.__class__ and
 
1210
                self.features == other.features)
 
1211
 
 
1212
    def _update_feature_flags(self, updated_flags):
 
1213
        """Update the feature flags in this format.
 
1214
 
 
1215
        :param updated_flags: Updated feature flags
 
1216
        """
 
1217
        for name, necessity in updated_flags.iteritems():
 
1218
            if necessity is None:
 
1219
                try:
 
1220
                    del self.features[name]
 
1221
                except KeyError:
 
1222
                    pass
 
1223
            else:
 
1224
                self.features[name] = necessity
 
1225
 
 
1226
 
1326
1227
class BzrProber(controldir.Prober):
1327
1228
    """Prober for formats that use a .bzr/ control directory."""
1328
1229
 
1330
1231
    """The known .bzr formats."""
1331
1232
 
1332
1233
    @classmethod
1333
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1334
 
    def register_bzrdir_format(klass, format):
1335
 
        klass.formats.register(format.get_format_string(), format)
1336
 
 
1337
 
    @classmethod
1338
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1339
 
    def unregister_bzrdir_format(klass, format):
1340
 
        klass.formats.remove(format.get_format_string())
1341
 
 
1342
 
    @classmethod
1343
1234
    def probe_transport(klass, transport):
1344
1235
        """Return the .bzrdir style format present in a directory."""
1345
1236
        try:
1347
1238
        except errors.NoSuchFile:
1348
1239
            raise errors.NotBranchError(path=transport.base)
1349
1240
        try:
1350
 
            return klass.formats.get(format_string)
 
1241
            first_line = format_string[:format_string.index("\n")+1]
 
1242
        except ValueError:
 
1243
            first_line = format_string
 
1244
        try:
 
1245
            cls = klass.formats.get(first_line)
1351
1246
        except KeyError:
1352
 
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
 
1247
            raise errors.UnknownFormatError(format=first_line, kind='bzrdir')
 
1248
        return cls.from_string(format_string)
1353
1249
 
1354
1250
    @classmethod
1355
1251
    def known_formats(cls):
1398
1294
        return set([RemoteBzrDirFormat()])
1399
1295
 
1400
1296
 
1401
 
class BzrDirFormat(controldir.ControlDirFormat):
 
1297
class BzrDirFormat(BzrFormat, controldir.ControlDirFormat):
1402
1298
    """ControlDirFormat base class for .bzr/ directories.
1403
1299
 
1404
1300
    Formats are placed in a dict by their format string for reference
1415
1311
    # _lock_class must be set in subclasses to the lock type, typ.
1416
1312
    # TransportLock or LockDir
1417
1313
 
1418
 
    @classmethod
1419
 
    def get_format_string(cls):
1420
 
        """Return the ASCII format string that identifies this format."""
1421
 
        raise NotImplementedError(cls.get_format_string)
1422
 
 
1423
1314
    def initialize_on_transport(self, transport):
1424
1315
        """Initialize a new bzrdir in the base directory of a Transport."""
1425
1316
        try:
1466
1357
        :param shared_repo: Control whether made repositories are shared or
1467
1358
            not.
1468
1359
        :param vfs_only: If True do not attempt to use a smart server
1469
 
        :return: repo, bzrdir, require_stacking, repository_policy. repo is
 
1360
        :return: repo, controldir, require_stacking, repository_policy. repo is
1470
1361
            None if none was created or found, bzrdir is always valid.
1471
1362
            require_stacking is the result of examining the stacked_on
1472
1363
            parameter and any stacking policy found for the target.
1547
1438
        # mode from the root directory
1548
1439
        temp_control = lockable_files.LockableFiles(transport,
1549
1440
                            '', lockable_files.TransportLock)
1550
 
        temp_control._transport.mkdir('.bzr',
1551
 
                                      # FIXME: RBC 20060121 don't peek under
1552
 
                                      # the covers
1553
 
                                      mode=temp_control._dir_mode)
 
1441
        try:
 
1442
            temp_control._transport.mkdir('.bzr',
 
1443
                # FIXME: RBC 20060121 don't peek under
 
1444
                # the covers
 
1445
                mode=temp_control._dir_mode)
 
1446
        except errors.FileExists:
 
1447
            raise errors.AlreadyControlDirError(transport.base)
1554
1448
        if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
1555
1449
            win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1556
1450
        file_mode = temp_control._file_mode
1560
1454
                       "This is a Bazaar control directory.\n"
1561
1455
                       "Do not change any files in this directory.\n"
1562
1456
                       "See http://bazaar.canonical.com/ for more information about Bazaar.\n"),
1563
 
                      ('branch-format', self.get_format_string()),
 
1457
                      ('branch-format', self.as_string()),
1564
1458
                      ]
1565
1459
        # NB: no need to escape relative paths that are url safe.
1566
1460
        control_files = lockable_files.LockableFiles(bzrdir_transport,
1610
1504
            compatible with whatever sub formats are supported by self.
1611
1505
        :return: None.
1612
1506
        """
 
1507
        other_format.features = dict(self.features)
 
1508
 
 
1509
    def supports_transport(self, transport):
 
1510
        # bzr formats can be opened over all known transports
 
1511
        return True
 
1512
 
 
1513
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
1514
            basedir=None):
 
1515
        controldir.ControlDirFormat.check_support_status(self,
 
1516
            allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
 
1517
            basedir=basedir)
 
1518
        BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
 
1519
            recommend_upgrade=recommend_upgrade, basedir=basedir)
1613
1520
 
1614
1521
 
1615
1522
class BzrDirMetaFormat1(BzrDirFormat):
1629
1536
 
1630
1537
    fixed_components = False
1631
1538
 
 
1539
    colocated_branches = True
 
1540
 
1632
1541
    def __init__(self):
 
1542
        BzrDirFormat.__init__(self)
1633
1543
        self._workingtree_format = None
1634
1544
        self._branch_format = None
1635
1545
        self._repository_format = None
1641
1551
            return False
1642
1552
        if other.workingtree_format != self.workingtree_format:
1643
1553
            return False
 
1554
        if other.features != self.features:
 
1555
            return False
1644
1556
        return True
1645
1557
 
1646
1558
    def __ne__(self, other):
1752
1664
        """See BzrDirFormat.get_converter()."""
1753
1665
        if format is None:
1754
1666
            format = BzrDirFormat.get_default_format()
 
1667
        if (type(self) is BzrDirMetaFormat1 and
 
1668
            type(format) is BzrDirMetaFormat1Colo):
 
1669
            return ConvertMetaToColo(format)
 
1670
        if (type(self) is BzrDirMetaFormat1Colo and
 
1671
            type(format) is BzrDirMetaFormat1):
 
1672
            return ConvertMetaToColo(format)
1755
1673
        if not isinstance(self, format.__class__):
1756
1674
            # converting away from metadir is not implemented
1757
1675
            raise NotImplementedError(self.get_converter)
1766
1684
        """See BzrDirFormat.get_format_description()."""
1767
1685
        return "Meta directory format 1"
1768
1686
 
1769
 
    def network_name(self):
1770
 
        return self.get_format_string()
1771
 
 
1772
1687
    def _open(self, transport):
1773
1688
        """See BzrDirFormat._open."""
1774
1689
        # Create a new format instance because otherwise initialisation of new
1803
1718
            compatible with whatever sub formats are supported by self.
1804
1719
        :return: None.
1805
1720
        """
 
1721
        super(BzrDirMetaFormat1, self)._supply_sub_formats_to(other_format)
1806
1722
        if getattr(self, '_repository_format', None) is not None:
1807
1723
            other_format.repository_format = self.repository_format
1808
1724
        if self._branch_format is not None:
1821
1737
    def __set_workingtree_format(self, wt_format):
1822
1738
        self._workingtree_format = wt_format
1823
1739
 
 
1740
    def __repr__(self):
 
1741
        return "<%r>" % (self.__class__.__name__,)
 
1742
 
1824
1743
    workingtree_format = property(__get_workingtree_format,
1825
1744
                                  __set_workingtree_format)
1826
1745
 
1831
1750
controldir.ControlDirFormat._default_format = BzrDirMetaFormat1()
1832
1751
 
1833
1752
 
 
1753
class BzrDirMetaFormat1Colo(BzrDirMetaFormat1):
 
1754
    """BzrDirMeta1 format with support for colocated branches."""
 
1755
 
 
1756
    colocated_branches = True
 
1757
 
 
1758
    @classmethod
 
1759
    def get_format_string(cls):
 
1760
        """See BzrDirFormat.get_format_string()."""
 
1761
        return "Bazaar meta directory, format 1 (with colocated branches)\n"
 
1762
 
 
1763
    def get_format_description(self):
 
1764
        """See BzrDirFormat.get_format_description()."""
 
1765
        return "Meta directory format 1 with support for colocated branches"
 
1766
 
 
1767
    def _open(self, transport):
 
1768
        """See BzrDirFormat._open."""
 
1769
        # Create a new format instance because otherwise initialisation of new
 
1770
        # metadirs share the global default format object leading to alias
 
1771
        # problems.
 
1772
        format = BzrDirMetaFormat1Colo()
 
1773
        self._supply_sub_formats_to(format)
 
1774
        return BzrDirMeta1(transport, format)
 
1775
 
 
1776
 
 
1777
BzrProber.formats.register(BzrDirMetaFormat1Colo.get_format_string(),
 
1778
    BzrDirMetaFormat1Colo)
 
1779
 
 
1780
 
1834
1781
class ConvertMetaToMeta(controldir.Converter):
1835
1782
    """Converts the components of metadirs."""
1836
1783
 
1865
1812
            old = branch._format.__class__
1866
1813
            new = self.target_format.get_branch_format().__class__
1867
1814
            while old != new:
1868
 
                if (old == _mod_branch.BzrBranchFormat5 and
 
1815
                if (old == fullhistorybranch.BzrBranchFormat5 and
1869
1816
                    new in (_mod_branch.BzrBranchFormat6,
1870
1817
                        _mod_branch.BzrBranchFormat7,
1871
1818
                        _mod_branch.BzrBranchFormat8)):
1909
1856
        return to_convert
1910
1857
 
1911
1858
 
 
1859
class ConvertMetaToColo(controldir.Converter):
 
1860
    """Add colocated branch support."""
 
1861
 
 
1862
    def __init__(self, target_format):
 
1863
        """Create a converter.that upgrades a metadir to the colo format.
 
1864
 
 
1865
        :param target_format: The final metadir format that is desired.
 
1866
        """
 
1867
        self.target_format = target_format
 
1868
 
 
1869
    def convert(self, to_convert, pb):
 
1870
        """See Converter.convert()."""
 
1871
        to_convert.transport.put_bytes('branch-format',
 
1872
            self.target_format.as_string())
 
1873
        return BzrDir.open_from_transport(to_convert.root_transport)
 
1874
 
 
1875
 
 
1876
class ConvertMetaToColo(controldir.Converter):
 
1877
    """Convert a 'development-colo' bzrdir to a '2a' bzrdir."""
 
1878
 
 
1879
    def __init__(self, target_format):
 
1880
        """Create a converter that converts a 'development-colo' metadir
 
1881
        to a '2a' metadir.
 
1882
 
 
1883
        :param target_format: The final metadir format that is desired.
 
1884
        """
 
1885
        self.target_format = target_format
 
1886
 
 
1887
    def convert(self, to_convert, pb):
 
1888
        """See Converter.convert()."""
 
1889
        to_convert.transport.put_bytes('branch-format',
 
1890
            self.target_format.as_string())
 
1891
        return BzrDir.open_from_transport(to_convert.root_transport)
 
1892
 
 
1893
 
1912
1894
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
1913
1895
 
1914
1896
 
1991
1973
        else:
1992
1974
            self._require_stacking = True
1993
1975
 
1994
 
    def acquire_repository(self, make_working_trees=None, shared=False):
 
1976
    def acquire_repository(self, make_working_trees=None, shared=False,
 
1977
            possible_transports=None):
1995
1978
        """Acquire a repository for this bzrdir.
1996
1979
 
1997
1980
        Implementations may create a new repository or use a pre-exising
2003
1986
        :return: A repository, is_new_flag (True if the repository was
2004
1987
            created).
2005
1988
        """
2006
 
        raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
 
1989
        raise NotImplementedError(RepositoryAcquisitionPolicy.acquire_repository)
2007
1990
 
2008
1991
 
2009
1992
class CreateRepository(RepositoryAcquisitionPolicy):
2022
2005
                                             require_stacking)
2023
2006
        self._bzrdir = bzrdir
2024
2007
 
2025
 
    def acquire_repository(self, make_working_trees=None, shared=False):
 
2008
    def acquire_repository(self, make_working_trees=None, shared=False,
 
2009
            possible_transports=None):
2026
2010
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
2027
2011
 
2028
2012
        Creates the desired repository in the bzrdir we already have.
2029
2013
        """
 
2014
        if possible_transports is None:
 
2015
            possible_transports = []
 
2016
        else:
 
2017
            possible_transports = list(possible_transports)
 
2018
        possible_transports.append(self._bzrdir.root_transport)
2030
2019
        stack_on = self._get_full_stack_on()
2031
2020
        if stack_on:
2032
2021
            format = self._bzrdir._format
2033
2022
            format.require_stacking(stack_on=stack_on,
2034
 
                                    possible_transports=[self._bzrdir.root_transport])
 
2023
                                    possible_transports=possible_transports)
2035
2024
            if not self._require_stacking:
2036
2025
                # We have picked up automatic stacking somewhere.
2037
2026
                note(gettext('Using default stacking branch {0} at {1}').format(
2038
2027
                    self._stack_on, self._stack_on_pwd))
2039
2028
        repository = self._bzrdir.create_repository(shared=shared)
2040
2029
        self._add_fallback(repository,
2041
 
                           possible_transports=[self._bzrdir.transport])
 
2030
                           possible_transports=possible_transports)
2042
2031
        if make_working_trees is not None:
2043
2032
            repository.set_make_working_trees(make_working_trees)
2044
2033
        return repository, True
2060
2049
                                             require_stacking)
2061
2050
        self._repository = repository
2062
2051
 
2063
 
    def acquire_repository(self, make_working_trees=None, shared=False):
 
2052
    def acquire_repository(self, make_working_trees=None, shared=False,
 
2053
            possible_transports=None):
2064
2054
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
2065
2055
 
2066
2056
        Returns an existing repository to use.
2067
2057
        """
 
2058
        if possible_transports is None:
 
2059
            possible_transports = []
 
2060
        else:
 
2061
            possible_transports = list(possible_transports)
 
2062
        possible_transports.append(self._repository.bzrdir.transport)
2068
2063
        self._add_fallback(self._repository,
2069
 
                       possible_transports=[self._repository.bzrdir.transport])
 
2064
                       possible_transports=possible_transports)
2070
2065
        return self._repository, False
2071
2066
 
2072
2067
 
2076
2071
         tree_format=None,
2077
2072
         hidden=False,
2078
2073
         experimental=False,
2079
 
         alias=False):
 
2074
         alias=False, bzrdir_format=None):
2080
2075
    """Register a metadir subformat.
2081
2076
 
2082
 
    These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2083
 
    by the Repository/Branch/WorkingTreeformats.
 
2077
    These all use a meta bzrdir, but can be parameterized by the
 
2078
    Repository/Branch/WorkingTreeformats.
2084
2079
 
2085
2080
    :param repository_format: The fully-qualified repository format class
2086
2081
        name as a string.
2089
2084
    :param tree_format: Fully-qualified tree format class name as
2090
2085
        a string.
2091
2086
    """
 
2087
    if bzrdir_format is None:
 
2088
        bzrdir_format = BzrDirMetaFormat1
2092
2089
    # This should be expanded to support setting WorkingTree and Branch
2093
 
    # formats, once BzrDirMetaFormat1 supports that.
 
2090
    # formats, once the API supports that.
2094
2091
    def _load(full_name):
2095
2092
        mod_name, factory_name = full_name.rsplit('.', 1)
2096
2093
        try:
2103
2100
        return factory()
2104
2101
 
2105
2102
    def helper():
2106
 
        bd = BzrDirMetaFormat1()
 
2103
        bd = bzrdir_format()
2107
2104
        if branch_format is not None:
2108
2105
            bd.set_branch_format(_load(branch_format))
2109
2106
        if tree_format is not None:
2117
2114
register_metadir(controldir.format_registry, 'knit',
2118
2115
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2119
2116
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
2120
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
2117
    branch_format='bzrlib.branchfmt.fullhistory.BzrBranchFormat5',
2121
2118
    tree_format='bzrlib.workingtree_3.WorkingTreeFormat3',
2122
2119
    hidden=True,
2123
2120
    deprecated=True)
2124
2121
register_metadir(controldir.format_registry, 'dirstate',
2125
2122
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2126
 
    help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2127
 
        'above when accessed over the network.',
2128
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
2123
    help='Format using dirstate for working trees. '
 
2124
        'Compatible with bzr 0.8 and '
 
2125
        'above when accessed over the network. Introduced in bzr 0.15.',
 
2126
    branch_format='bzrlib.branchfmt.fullhistory.BzrBranchFormat5',
2129
2127
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2130
2128
    hidden=True,
2131
2129
    deprecated=True)
2132
2130
register_metadir(controldir.format_registry, 'dirstate-tags',
2133
2131
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2134
 
    help='New in 0.15: Fast local operations and improved scaling for '
2135
 
        'network operations. Additionally adds support for tags.'
2136
 
        ' Incompatible with bzr < 0.15.',
 
2132
    help='Variant of dirstate with support for tags. '
 
2133
        'Introduced in bzr 0.15.',
2137
2134
    branch_format='bzrlib.branch.BzrBranchFormat6',
2138
2135
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2139
2136
    hidden=True,
2140
2137
    deprecated=True)
2141
2138
register_metadir(controldir.format_registry, 'rich-root',
2142
2139
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2143
 
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
2144
 
        ' bzr < 1.0.',
 
2140
    help='Variant of dirstate with better handling of tree roots. '
 
2141
        'Introduced in bzr 1.0',
2145
2142
    branch_format='bzrlib.branch.BzrBranchFormat6',
2146
2143
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2147
2144
    hidden=True,
2148
2145
    deprecated=True)
2149
2146
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
2150
2147
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2151
 
    help='New in 0.15: Fast local operations and improved scaling for '
2152
 
        'network operations. Additionally adds support for versioning nested '
2153
 
        'bzr branches. Incompatible with bzr < 0.15.',
 
2148
    help='Variant of dirstate with support for nested trees. '
 
2149
         'Introduced in 0.15.',
2154
2150
    branch_format='bzrlib.branch.BzrBranchFormat6',
2155
2151
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2156
2152
    experimental=True,
2158
2154
    )
2159
2155
register_metadir(controldir.format_registry, 'pack-0.92',
2160
2156
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack1',
2161
 
    help='New in 0.92: Pack-based format with data compatible with '
2162
 
        'dirstate-tags format repositories. Interoperates with '
2163
 
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
 
2157
    help='Pack-based format used in 1.x series. Introduced in 0.92. '
 
2158
        'Interoperates with bzr repositories before 0.92 but cannot be '
 
2159
        'read by bzr < 0.92. '
2164
2160
        ,
2165
2161
    branch_format='bzrlib.branch.BzrBranchFormat6',
2166
2162
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2163
    deprecated=True,
2167
2164
    )
2168
2165
register_metadir(controldir.format_registry, 'pack-0.92-subtree',
2169
2166
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack3',
2170
 
    help='New in 0.92: Pack-based format with data compatible with '
2171
 
        'dirstate-with-subtree format repositories. Interoperates with '
 
2167
    help='Pack-based format used in 1.x series, with subtree support. '
 
2168
        'Introduced in 0.92. Interoperates with '
2172
2169
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2173
2170
        ,
2174
2171
    branch_format='bzrlib.branch.BzrBranchFormat6',
2175
2172
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2176
2173
    hidden=True,
 
2174
    deprecated=True,
2177
2175
    experimental=True,
2178
2176
    )
2179
2177
register_metadir(controldir.format_registry, 'rich-root-pack',
2180
2178
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack4',
2181
 
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
2182
 
         '(needed for bzr-svn and bzr-git).',
 
2179
    help='A variant of pack-0.92 that supports rich-root data '
 
2180
         '(needed for bzr-svn and bzr-git). Introduced in 1.0.',
2183
2181
    branch_format='bzrlib.branch.BzrBranchFormat6',
2184
2182
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2185
2183
    hidden=True,
 
2184
    deprecated=True,
2186
2185
    )
2187
2186
register_metadir(controldir.format_registry, '1.6',
2188
2187
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5',
2192
2191
    branch_format='bzrlib.branch.BzrBranchFormat7',
2193
2192
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2194
2193
    hidden=True,
 
2194
    deprecated=True,
2195
2195
    )
2196
2196
register_metadir(controldir.format_registry, '1.6.1-rich-root',
2197
2197
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5RichRoot',
2200
2200
    branch_format='bzrlib.branch.BzrBranchFormat7',
2201
2201
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2202
2202
    hidden=True,
 
2203
    deprecated=True,
2203
2204
    )
2204
2205
register_metadir(controldir.format_registry, '1.9',
2205
2206
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
2209
2210
    branch_format='bzrlib.branch.BzrBranchFormat7',
2210
2211
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2211
2212
    hidden=True,
 
2213
    deprecated=True,
2212
2214
    )
2213
2215
register_metadir(controldir.format_registry, '1.9-rich-root',
2214
2216
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
2217
2219
    branch_format='bzrlib.branch.BzrBranchFormat7',
2218
2220
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2219
2221
    hidden=True,
 
2222
    deprecated=True,
2220
2223
    )
2221
2224
register_metadir(controldir.format_registry, '1.14',
2222
2225
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
2223
2226
    help='A working-tree format that supports content filtering.',
2224
2227
    branch_format='bzrlib.branch.BzrBranchFormat7',
2225
2228
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
 
2229
    hidden=True,
 
2230
    deprecated=True,
2226
2231
    )
2227
2232
register_metadir(controldir.format_registry, '1.14-rich-root',
2228
2233
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
2230
2235
         '(needed for bzr-svn and bzr-git).',
2231
2236
    branch_format='bzrlib.branch.BzrBranchFormat7',
2232
2237
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
 
2238
    hidden=True,
 
2239
    deprecated=True,
2233
2240
    )
2234
2241
# The following un-numbered 'development' formats should always just be aliases.
2235
2242
register_metadir(controldir.format_registry, 'development-subtree',
2263
2270
    alias=False,
2264
2271
    )
2265
2272
 
 
2273
register_metadir(controldir.format_registry, 'development-colo',
 
2274
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
 
2275
    help='The 2a format with experimental support for colocated branches.\n',
 
2276
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2277
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
2278
    experimental=True,
 
2279
    bzrdir_format=BzrDirMetaFormat1Colo,
 
2280
    )
 
2281
 
 
2282
 
2266
2283
# And the development formats above will have aliased one of the following:
2267
2284
 
2268
2285
# Finally, the current format.
2269
2286
register_metadir(controldir.format_registry, '2a',
2270
2287
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2271
 
    help='First format for bzr 2.0 series.\n'
 
2288
    help='Format for the bzr 2.0 series.\n'
2272
2289
        'Uses group-compress storage.\n'
2273
2290
        'Provides rich roots which are a one-way transition.\n',
2274
2291
        # 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '