~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-08-17 18:13:57 UTC
  • mfrom: (5268.7.29 transport-segments)
  • Revision ID: pqm@pqm.ubuntu.com-20110817181357-y5q5eth1hk8bl3om
(jelmer) Allow specifying the colocated branch to use in the branch URL,
 and retrieving the branch name using ControlDir._get_selected_branch.
 (Jelmer Vernooij)

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
 
 
30
28
import sys
31
29
 
32
30
from bzrlib.lazy_import import lazy_import
48
46
    transport as _mod_transport,
49
47
    ui,
50
48
    urlutils,
51
 
    vf_search,
52
49
    win32utils,
53
50
    workingtree_3,
54
51
    workingtree_4,
55
52
    )
56
 
from bzrlib.branchfmt import fullhistory as fullhistorybranch
57
53
from bzrlib.repofmt import knitpack_repo
58
54
from bzrlib.transport import (
59
55
    do_catching_redirections,
60
56
    local,
61
57
    )
62
 
from bzrlib.i18n import gettext
63
58
""")
64
59
 
65
60
from bzrlib.trace import (
70
65
from bzrlib import (
71
66
    config,
72
67
    controldir,
 
68
    hooks,
73
69
    registry,
74
70
    )
75
71
from bzrlib.symbol_versioning import (
204
200
                if (result_repo.user_url == result.user_url
205
201
                    and not require_stacking and
206
202
                    revision_id is not None):
207
 
                    fetch_spec = vf_search.PendingAncestryResult(
 
203
                    fetch_spec = graph.PendingAncestryResult(
208
204
                        [revision_id], local_repo)
209
205
                    result_repo.fetch(local_repo, fetch_spec=fetch_spec)
210
206
                else:
225
221
            # the tree and fail.
226
222
            result.root_transport.local_abspath('.')
227
223
            if result_repo is None or result_repo.make_working_trees():
228
 
                self.open_workingtree().clone(result, revision_id=revision_id)
 
224
                self.open_workingtree().clone(result)
229
225
        except (errors.NoWorkingTree, errors.NotLocalUrl):
230
226
            pass
231
227
        return result
236
232
        t = _mod_transport.get_transport(url)
237
233
        t.ensure_base()
238
234
 
 
235
    @staticmethod
 
236
    def find_bzrdirs(transport, evaluate=None, list_current=None):
 
237
        """Find bzrdirs recursively from current location.
 
238
 
 
239
        This is intended primarily as a building block for more sophisticated
 
240
        functionality, like finding trees under a directory, or finding
 
241
        branches that use a given repository.
 
242
 
 
243
        :param evaluate: An optional callable that yields recurse, value,
 
244
            where recurse controls whether this bzrdir is recursed into
 
245
            and value is the value to yield.  By default, all bzrdirs
 
246
            are recursed into, and the return value is the bzrdir.
 
247
        :param list_current: if supplied, use this function to list the current
 
248
            directory, instead of Transport.list_dir
 
249
        :return: a generator of found bzrdirs, or whatever evaluate returns.
 
250
        """
 
251
        if list_current is None:
 
252
            def list_current(transport):
 
253
                return transport.list_dir('')
 
254
        if evaluate is None:
 
255
            def evaluate(bzrdir):
 
256
                return True, bzrdir
 
257
 
 
258
        pending = [transport]
 
259
        while len(pending) > 0:
 
260
            current_transport = pending.pop()
 
261
            recurse = True
 
262
            try:
 
263
                bzrdir = BzrDir.open_from_transport(current_transport)
 
264
            except (errors.NotBranchError, errors.PermissionDenied):
 
265
                pass
 
266
            else:
 
267
                recurse, value = evaluate(bzrdir)
 
268
                yield value
 
269
            try:
 
270
                subdirs = list_current(current_transport)
 
271
            except (errors.NoSuchFile, errors.PermissionDenied):
 
272
                continue
 
273
            if recurse:
 
274
                for subdir in sorted(subdirs, reverse=True):
 
275
                    pending.append(current_transport.clone(subdir))
 
276
 
 
277
    @staticmethod
 
278
    def find_branches(transport):
 
279
        """Find all branches under a transport.
 
280
 
 
281
        This will find all branches below the transport, including branches
 
282
        inside other branches.  Where possible, it will use
 
283
        Repository.find_branches.
 
284
 
 
285
        To list all the branches that use a particular Repository, see
 
286
        Repository.find_branches
 
287
        """
 
288
        def evaluate(bzrdir):
 
289
            try:
 
290
                repository = bzrdir.open_repository()
 
291
            except errors.NoRepositoryPresent:
 
292
                pass
 
293
            else:
 
294
                return False, ([], repository)
 
295
            return True, (bzrdir.list_branches(), None)
 
296
        ret = []
 
297
        for branches, repo in BzrDir.find_bzrdirs(transport,
 
298
                                                  evaluate=evaluate):
 
299
            if repo is not None:
 
300
                ret.extend(repo.find_branches())
 
301
            if branches is not None:
 
302
                ret.extend(branches)
 
303
        return ret
 
304
 
 
305
    @staticmethod
 
306
    def create_branch_and_repo(base, force_new_repo=False, format=None):
 
307
        """Create a new BzrDir, Branch and Repository at the url 'base'.
 
308
 
 
309
        This will use the current default BzrDirFormat unless one is
 
310
        specified, and use whatever
 
311
        repository format that that uses via bzrdir.create_branch and
 
312
        create_repository. If a shared repository is available that is used
 
313
        preferentially.
 
314
 
 
315
        The created Branch object is returned.
 
316
 
 
317
        :param base: The URL to create the branch at.
 
318
        :param force_new_repo: If True a new repository is always created.
 
319
        :param format: If supplied, the format of branch to create.  If not
 
320
            supplied, the default is used.
 
321
        """
 
322
        bzrdir = BzrDir.create(base, format)
 
323
        bzrdir._find_or_create_repository(force_new_repo)
 
324
        return bzrdir.create_branch()
 
325
 
239
326
    def determine_repository_policy(self, force_new_repo=False, stack_on=None,
240
327
                                    stack_on_pwd=None, require_stacking=False):
241
328
        """Return an object representing a policy to use.
356
443
            location of this control directory.
357
444
        :param create_tree_if_local: If true, a working-tree will be created
358
445
            when working locally.
359
 
        :return: The created control directory
360
446
        """
361
447
        operation = cleanup.OperationWithCleanups(self._sprout)
362
448
        return operation.run(url, revision_id=revision_id,
375
461
        if revision_id is not None:
376
462
            fetch_spec_factory.add_revision_ids([revision_id])
377
463
            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]
383
464
        target_transport = _mod_transport.get_transport(url,
384
465
            possible_transports)
385
466
        target_transport.ensure_base()
386
467
        cloning_format = self.cloning_metadir(stacked)
387
468
        # Create/update the result branch
388
 
        try:
389
 
            result = controldir.ControlDir.open_from_transport(target_transport)
390
 
        except errors.NotBranchError:
391
 
            result = cloning_format.initialize_on_transport(target_transport)
 
469
        result = cloning_format.initialize_on_transport(target_transport)
392
470
        source_branch, source_repository = self._find_source_repo(
393
471
            add_cleanup, source_branch)
394
472
        fetch_spec_factory.source_branch = source_branch
400
478
            stacked_branch_url = None
401
479
        repository_policy = result.determine_repository_policy(
402
480
            force_new_repo, stacked_branch_url, require_stacking=stacked)
403
 
        result_repo, is_new_repo = repository_policy.acquire_repository(
404
 
            possible_transports=possible_transports)
 
481
        result_repo, is_new_repo = repository_policy.acquire_repository()
405
482
        add_cleanup(result_repo.lock_write().unlock)
406
483
        fetch_spec_factory.source_repo = source_repository
407
484
        fetch_spec_factory.target_repo = result_repo
428
505
        mutter("created new branch %r" % (result_branch,))
429
506
 
430
507
        # Create/update the result working tree
431
 
        if (create_tree_if_local and not result.has_workingtree() and
 
508
        if (create_tree_if_local and
432
509
            isinstance(target_transport, local.LocalTransport) and
433
510
            (result_repo is None or result_repo.make_working_trees())):
434
511
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
466
543
                    stacked=stacked)
467
544
        return result
468
545
 
 
546
 
 
547
 
 
548
    @staticmethod
 
549
    def create_branch_convenience(base, force_new_repo=False,
 
550
                                  force_new_tree=None, format=None,
 
551
                                  possible_transports=None):
 
552
        """Create a new BzrDir, Branch and Repository at the url 'base'.
 
553
 
 
554
        This is a convenience function - it will use an existing repository
 
555
        if possible, can be told explicitly whether to create a working tree or
 
556
        not.
 
557
 
 
558
        This will use the current default BzrDirFormat unless one is
 
559
        specified, and use whatever
 
560
        repository format that that uses via bzrdir.create_branch and
 
561
        create_repository. If a shared repository is available that is used
 
562
        preferentially. Whatever repository is used, its tree creation policy
 
563
        is followed.
 
564
 
 
565
        The created Branch object is returned.
 
566
        If a working tree cannot be made due to base not being a file:// url,
 
567
        no error is raised unless force_new_tree is True, in which case no
 
568
        data is created on disk and NotLocalUrl is raised.
 
569
 
 
570
        :param base: The URL to create the branch at.
 
571
        :param force_new_repo: If True a new repository is always created.
 
572
        :param force_new_tree: If True or False force creation of a tree or
 
573
                               prevent such creation respectively.
 
574
        :param format: Override for the bzrdir format to create.
 
575
        :param possible_transports: An optional reusable transports list.
 
576
        """
 
577
        if force_new_tree:
 
578
            # check for non local urls
 
579
            t = _mod_transport.get_transport(base, possible_transports)
 
580
            if not isinstance(t, local.LocalTransport):
 
581
                raise errors.NotLocalUrl(base)
 
582
        bzrdir = BzrDir.create(base, format, possible_transports)
 
583
        repo = bzrdir._find_or_create_repository(force_new_repo)
 
584
        result = bzrdir.create_branch()
 
585
        if force_new_tree or (repo.make_working_trees() and
 
586
                              force_new_tree is None):
 
587
            try:
 
588
                bzrdir.create_workingtree()
 
589
            except errors.NotLocalUrl:
 
590
                pass
 
591
        return result
 
592
 
 
593
    @staticmethod
 
594
    def create_standalone_workingtree(base, format=None):
 
595
        """Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
 
596
 
 
597
        'base' must be a local path or a file:// url.
 
598
 
 
599
        This will use the current default BzrDirFormat unless one is
 
600
        specified, and use whatever
 
601
        repository format that that uses for bzrdirformat.create_workingtree,
 
602
        create_branch and create_repository.
 
603
 
 
604
        :param format: Override for the bzrdir format to create.
 
605
        :return: The WorkingTree object.
 
606
        """
 
607
        t = _mod_transport.get_transport(base)
 
608
        if not isinstance(t, local.LocalTransport):
 
609
            raise errors.NotLocalUrl(base)
 
610
        bzrdir = BzrDir.create_branch_and_repo(base,
 
611
                                               force_new_repo=True,
 
612
                                               format=format).bzrdir
 
613
        return bzrdir.create_workingtree()
 
614
 
 
615
    @deprecated_method(deprecated_in((2, 3, 0)))
 
616
    def generate_backup_name(self, base):
 
617
        return self._available_backup_name(base)
 
618
 
469
619
    def _available_backup_name(self, base):
470
620
        """Find a non-existing backup file name based on base.
471
621
 
484
634
            old_path = self.root_transport.abspath('.bzr')
485
635
            backup_dir = self._available_backup_name('backup.bzr')
486
636
            new_path = self.root_transport.abspath(backup_dir)
487
 
            ui.ui_factory.note(gettext('making backup of {0}\n  to {1}').format(
488
 
                urlutils.unescape_for_display(old_path, 'utf-8'),
489
 
                urlutils.unescape_for_display(new_path, 'utf-8')))
 
637
            ui.ui_factory.note('making backup of %s\n  to %s'
 
638
                               % (old_path, new_path,))
490
639
            self.root_transport.copy_tree('.bzr', backup_dir)
491
640
            return (old_path, new_path)
492
641
        finally:
507
656
            try:
508
657
                to_path = '.bzr.retired.%d' % i
509
658
                self.root_transport.rename('.bzr', to_path)
510
 
                note(gettext("renamed {0} to {1}").format(
511
 
                    self.root_transport.abspath('.bzr'), to_path))
 
659
                note("renamed %s to %s"
 
660
                    % (self.root_transport.abspath('.bzr'), to_path))
512
661
                return
513
662
            except (errors.TransportError, IOError, errors.PathError):
514
663
                i += 1
541
690
                return None
542
691
            # find the next containing bzrdir
543
692
            try:
544
 
                found_bzrdir = self.open_containing_from_transport(
 
693
                found_bzrdir = BzrDir.open_containing_from_transport(
545
694
                    next_transport)[0]
546
695
            except errors.NotBranchError:
547
696
                return None
664
813
        # add new tests for it to the appropriate place.
665
814
        return filename == '.bzr' or filename.startswith('.bzr/')
666
815
 
 
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('%s is%s redirected to %s',
 
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
 
667
960
    def _cloning_metadir(self):
668
961
        """Produce a metadir suitable for cloning with.
669
962
 
709
1002
 
710
1003
        :require_stacking: If True, non-stackable formats will be upgraded
711
1004
            to similar stackable formats.
712
 
        :returns: a ControlDirFormat with all component formats either set
 
1005
        :returns: a BzrDirFormat with all component formats either set
713
1006
            appropriately or set to None if that component should not be
714
1007
            created.
715
1008
        """
727
1020
            format.require_stacking()
728
1021
        return format
729
1022
 
 
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
 
730
1041
    def get_branch_transport(self, branch_format, name=None):
731
1042
        """Get the transport for use by branch format in this BzrDir.
732
1043
 
766
1077
        """
767
1078
        raise NotImplementedError(self.get_workingtree_transport)
768
1079
 
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.
 
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
777
1118
        """
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)
 
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__
783
1126
 
784
1127
    def __repr__(self):
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()
 
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)
799
1134
 
800
1135
 
801
1136
class BzrDirMeta1(BzrDir):
807
1142
    present within a BzrDir.
808
1143
    """
809
1144
 
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
 
 
856
1145
    def can_convert_format(self):
857
1146
        """See BzrDir.can_convert_format()."""
858
1147
        return True
859
1148
 
860
 
    def create_branch(self, name=None, repository=None,
861
 
            append_revisions_only=None):
862
 
        """See ControlDir.create_branch."""
863
 
        if name is None:
864
 
            name = self._get_selected_branch()
 
1149
    def create_branch(self, name=None, repository=None):
 
1150
        """See BzrDir.create_branch."""
865
1151
        return self._format.get_branch_format().initialize(self, name=name,
866
 
                repository=repository,
867
 
                append_revisions_only=append_revisions_only)
 
1152
                repository=repository)
868
1153
 
869
1154
    def destroy_branch(self, name=None):
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)
 
1155
        """See BzrDir.create_branch."""
 
1156
        if name is not None:
 
1157
            raise errors.NoColocatedBranchSupport(self)
 
1158
        self.transport.delete_tree('branch')
890
1159
 
891
1160
    def create_repository(self, shared=False):
892
1161
        """See BzrDir.create_repository."""
894
1163
 
895
1164
    def destroy_repository(self):
896
1165
        """See BzrDir.destroy_repository."""
897
 
        try:
898
 
            self.transport.delete_tree('repository')
899
 
        except errors.NoSuchFile:
900
 
            raise errors.NoRepositoryPresent(self)
 
1166
        self.transport.delete_tree('repository')
901
1167
 
902
1168
    def create_workingtree(self, revision_id=None, from_branch=None,
903
1169
                           accelerator_tree=None, hardlink=False):
925
1191
 
926
1192
        This might be a synthetic object for e.g. RemoteBranch and SVN.
927
1193
        """
928
 
        from bzrlib.branch import BranchFormatMetadir
929
 
        return BranchFormatMetadir.find_format(self, name=name)
 
1194
        from bzrlib.branch import BranchFormat
 
1195
        return BranchFormat.find_format(self, name=name)
930
1196
 
931
1197
    def _get_mkdir_mode(self):
932
1198
        """Figure out the mode to use when creating a bzrdir subdir."""
936
1202
 
937
1203
    def get_branch_reference(self, name=None):
938
1204
        """See BzrDir.get_branch_reference()."""
939
 
        from bzrlib.branch import BranchFormatMetadir
940
 
        format = BranchFormatMetadir.find_format(self, name=name)
 
1205
        from bzrlib.branch import BranchFormat
 
1206
        format = BranchFormat.find_format(self, name=name)
941
1207
        return format.get_reference(self, name=name)
942
1208
 
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
 
 
947
1209
    def get_branch_transport(self, branch_format, name=None):
948
1210
        """See BzrDir.get_branch_transport()."""
949
 
        if name is None:
950
 
            name = self._get_selected_branch()
951
 
        path = self._get_branch_path(name)
 
1211
        if name is not None:
 
1212
            raise errors.NoColocatedBranchSupport(self)
952
1213
        # XXX: this shouldn't implicitly create the directory if it's just
953
1214
        # promising to get a transport -- mbp 20090727
954
1215
        if branch_format is None:
955
 
            return self.transport.clone(path)
 
1216
            return self.transport.clone('branch')
956
1217
        try:
957
1218
            branch_format.get_format_string()
958
1219
        except NotImplementedError:
959
1220
            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)
981
1221
        try:
982
 
            self.transport.mkdir(path, mode=mode)
 
1222
            self.transport.mkdir('branch', mode=self._get_mkdir_mode())
983
1223
        except errors.FileExists:
984
1224
            pass
985
 
        return self.transport.clone(path)
 
1225
        return self.transport.clone('branch')
986
1226
 
987
1227
    def get_repository_transport(self, repository_format):
988
1228
        """See BzrDir.get_repository_transport()."""
1012
1252
            pass
1013
1253
        return self.transport.clone('checkout')
1014
1254
 
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
 
 
1028
1255
    def has_workingtree(self):
1029
1256
        """Tell if this bzrdir contains a working tree.
1030
1257
 
1031
1258
        Note: if you're going to open the working tree, you should just go
1032
1259
        ahead and try, and not ask permission first.
1033
1260
        """
1034
 
        from bzrlib.workingtree import WorkingTreeFormatMetaDir
 
1261
        from bzrlib.workingtree import WorkingTreeFormat
1035
1262
        try:
1036
 
            WorkingTreeFormatMetaDir.find_format_string(self)
 
1263
            WorkingTreeFormat.find_format_string(self)
1037
1264
        except errors.NoWorkingTree:
1038
1265
            return False
1039
1266
        return True
1040
1267
 
1041
1268
    def needs_format_conversion(self, format):
1042
1269
        """See BzrDir.needs_format_conversion()."""
1043
 
        if (not isinstance(self._format, format.__class__) or
1044
 
            self._format.get_format_string() != format.get_format_string()):
 
1270
        if not isinstance(self._format, format.__class__):
1045
1271
            # it is not a meta dir format, conversion is needed.
1046
1272
            return True
1047
1273
        # we might want to push this down to the repository?
1068
1294
        return False
1069
1295
 
1070
1296
    def open_branch(self, name=None, unsupported=False,
1071
 
                    ignore_fallbacks=False, possible_transports=None):
1072
 
        """See ControlDir.open_branch."""
1073
 
        if name is None:
1074
 
            name = self._get_selected_branch()
 
1297
                    ignore_fallbacks=False):
 
1298
        """See BzrDir.open_branch."""
1075
1299
        format = self.find_branch_format(name=name)
1076
1300
        format.check_support_status(unsupported)
1077
1301
        return format.open(self, name=name,
1078
 
            _found=True, ignore_fallbacks=ignore_fallbacks,
1079
 
            possible_transports=possible_transports)
 
1302
            _found=True, ignore_fallbacks=ignore_fallbacks)
1080
1303
 
1081
1304
    def open_repository(self, unsupported=False):
1082
1305
        """See BzrDir.open_repository."""
1083
 
        from bzrlib.repository import RepositoryFormatMetaDir
1084
 
        format = RepositoryFormatMetaDir.find_format(self)
 
1306
        from bzrlib.repository import RepositoryFormat
 
1307
        format = RepositoryFormat.find_format(self)
1085
1308
        format.check_support_status(unsupported)
1086
1309
        return format.open(self, _found=True)
1087
1310
 
1088
1311
    def open_workingtree(self, unsupported=False,
1089
1312
            recommend_upgrade=True):
1090
1313
        """See BzrDir.open_workingtree."""
1091
 
        from bzrlib.workingtree import WorkingTreeFormatMetaDir
1092
 
        format = WorkingTreeFormatMetaDir.find_format(self)
 
1314
        from bzrlib.workingtree import WorkingTreeFormat
 
1315
        format = WorkingTreeFormat.find_format(self)
1093
1316
        format.check_support_status(unsupported, recommend_upgrade,
1094
1317
            basedir=self.root_transport.base)
1095
1318
        return format.open(self, _found=True)
1098
1321
        return config.TransportConfig(self.transport, 'control.conf')
1099
1322
 
1100
1323
 
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
 
 
1227
1324
class BzrProber(controldir.Prober):
1228
1325
    """Prober for formats that use a .bzr/ control directory."""
1229
1326
 
1231
1328
    """The known .bzr formats."""
1232
1329
 
1233
1330
    @classmethod
 
1331
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1332
    def register_bzrdir_format(klass, format):
 
1333
        klass.formats.register(format.get_format_string(), format)
 
1334
 
 
1335
    @classmethod
 
1336
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1337
    def unregister_bzrdir_format(klass, format):
 
1338
        klass.formats.remove(format.get_format_string())
 
1339
 
 
1340
    @classmethod
1234
1341
    def probe_transport(klass, transport):
1235
1342
        """Return the .bzrdir style format present in a directory."""
1236
1343
        try:
1238
1345
        except errors.NoSuchFile:
1239
1346
            raise errors.NotBranchError(path=transport.base)
1240
1347
        try:
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)
 
1348
            return klass.formats.get(format_string)
1246
1349
        except KeyError:
1247
 
            raise errors.UnknownFormatError(format=first_line, kind='bzrdir')
1248
 
        return cls.from_string(format_string)
 
1350
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1249
1351
 
1250
1352
    @classmethod
1251
1353
    def known_formats(cls):
1294
1396
        return set([RemoteBzrDirFormat()])
1295
1397
 
1296
1398
 
1297
 
class BzrDirFormat(BzrFormat, controldir.ControlDirFormat):
 
1399
class BzrDirFormat(controldir.ControlDirFormat):
1298
1400
    """ControlDirFormat base class for .bzr/ directories.
1299
1401
 
1300
1402
    Formats are placed in a dict by their format string for reference
1311
1413
    # _lock_class must be set in subclasses to the lock type, typ.
1312
1414
    # TransportLock or LockDir
1313
1415
 
 
1416
    @classmethod
 
1417
    def get_format_string(cls):
 
1418
        """Return the ASCII format string that identifies this format."""
 
1419
        raise NotImplementedError(cls.get_format_string)
 
1420
 
1314
1421
    def initialize_on_transport(self, transport):
1315
1422
        """Initialize a new bzrdir in the base directory of a Transport."""
1316
1423
        try:
1357
1464
        :param shared_repo: Control whether made repositories are shared or
1358
1465
            not.
1359
1466
        :param vfs_only: If True do not attempt to use a smart server
1360
 
        :return: repo, controldir, require_stacking, repository_policy. repo is
 
1467
        :return: repo, bzrdir, require_stacking, repository_policy. repo is
1361
1468
            None if none was created or found, bzrdir is always valid.
1362
1469
            require_stacking is the result of examining the stacked_on
1363
1470
            parameter and any stacking policy found for the target.
1438
1545
        # mode from the root directory
1439
1546
        temp_control = lockable_files.LockableFiles(transport,
1440
1547
                            '', lockable_files.TransportLock)
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)
 
1548
        temp_control._transport.mkdir('.bzr',
 
1549
                                      # FIXME: RBC 20060121 don't peek under
 
1550
                                      # the covers
 
1551
                                      mode=temp_control._dir_mode)
1448
1552
        if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
1449
1553
            win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1450
1554
        file_mode = temp_control._file_mode
1454
1558
                       "This is a Bazaar control directory.\n"
1455
1559
                       "Do not change any files in this directory.\n"
1456
1560
                       "See http://bazaar.canonical.com/ for more information about Bazaar.\n"),
1457
 
                      ('branch-format', self.as_string()),
 
1561
                      ('branch-format', self.get_format_string()),
1458
1562
                      ]
1459
1563
        # NB: no need to escape relative paths that are url safe.
1460
1564
        control_files = lockable_files.LockableFiles(bzrdir_transport,
1504
1608
            compatible with whatever sub formats are supported by self.
1505
1609
        :return: None.
1506
1610
        """
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)
1520
1611
 
1521
1612
 
1522
1613
class BzrDirMetaFormat1(BzrDirFormat):
1536
1627
 
1537
1628
    fixed_components = False
1538
1629
 
1539
 
    colocated_branches = True
1540
 
 
1541
1630
    def __init__(self):
1542
 
        BzrDirFormat.__init__(self)
1543
1631
        self._workingtree_format = None
1544
1632
        self._branch_format = None
1545
1633
        self._repository_format = None
1551
1639
            return False
1552
1640
        if other.workingtree_format != self.workingtree_format:
1553
1641
            return False
1554
 
        if other.features != self.features:
1555
 
            return False
1556
1642
        return True
1557
1643
 
1558
1644
    def __ne__(self, other):
1636
1722
                    new_repo_format = None
1637
1723
            if new_repo_format is not None:
1638
1724
                self.repository_format = new_repo_format
1639
 
                note(gettext('Source repository format does not support stacking,'
1640
 
                     ' using format:\n  %s'),
 
1725
                note('Source repository format does not support stacking,'
 
1726
                     ' using format:\n  %s',
1641
1727
                     new_repo_format.get_format_description())
1642
1728
 
1643
1729
        if not self.get_branch_format().supports_stacking():
1656
1742
            if new_branch_format is not None:
1657
1743
                # Does support stacking, use its format.
1658
1744
                self.set_branch_format(new_branch_format)
1659
 
                note(gettext('Source branch format does not support stacking,'
1660
 
                     ' using format:\n  %s'),
 
1745
                note('Source branch format does not support stacking,'
 
1746
                     ' using format:\n  %s',
1661
1747
                     new_branch_format.get_format_description())
1662
1748
 
1663
1749
    def get_converter(self, format=None):
1664
1750
        """See BzrDirFormat.get_converter()."""
1665
1751
        if format is None:
1666
1752
            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)
1673
1753
        if not isinstance(self, format.__class__):
1674
1754
            # converting away from metadir is not implemented
1675
1755
            raise NotImplementedError(self.get_converter)
1684
1764
        """See BzrDirFormat.get_format_description()."""
1685
1765
        return "Meta directory format 1"
1686
1766
 
 
1767
    def network_name(self):
 
1768
        return self.get_format_string()
 
1769
 
1687
1770
    def _open(self, transport):
1688
1771
        """See BzrDirFormat._open."""
1689
1772
        # Create a new format instance because otherwise initialisation of new
1718
1801
            compatible with whatever sub formats are supported by self.
1719
1802
        :return: None.
1720
1803
        """
1721
 
        super(BzrDirMetaFormat1, self)._supply_sub_formats_to(other_format)
1722
1804
        if getattr(self, '_repository_format', None) is not None:
1723
1805
            other_format.repository_format = self.repository_format
1724
1806
        if self._branch_format is not None:
1737
1819
    def __set_workingtree_format(self, wt_format):
1738
1820
        self._workingtree_format = wt_format
1739
1821
 
1740
 
    def __repr__(self):
1741
 
        return "<%r>" % (self.__class__.__name__,)
1742
 
 
1743
1822
    workingtree_format = property(__get_workingtree_format,
1744
1823
                                  __set_workingtree_format)
1745
1824
 
1750
1829
controldir.ControlDirFormat._default_format = BzrDirMetaFormat1()
1751
1830
 
1752
1831
 
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
 
 
1781
1832
class ConvertMetaToMeta(controldir.Converter):
1782
1833
    """Converts the components of metadirs."""
1783
1834
 
1802
1853
        else:
1803
1854
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
1804
1855
                from bzrlib.repository import CopyConverter
1805
 
                ui.ui_factory.note(gettext('starting repository conversion'))
 
1856
                ui.ui_factory.note('starting repository conversion')
1806
1857
                converter = CopyConverter(self.target_format.repository_format)
1807
1858
                converter.convert(repo, pb)
1808
1859
        for branch in self.bzrdir.list_branches():
1812
1863
            old = branch._format.__class__
1813
1864
            new = self.target_format.get_branch_format().__class__
1814
1865
            while old != new:
1815
 
                if (old == fullhistorybranch.BzrBranchFormat5 and
 
1866
                if (old == _mod_branch.BzrBranchFormat5 and
1816
1867
                    new in (_mod_branch.BzrBranchFormat6,
1817
1868
                        _mod_branch.BzrBranchFormat7,
1818
1869
                        _mod_branch.BzrBranchFormat8)):
1856
1907
        return to_convert
1857
1908
 
1858
1909
 
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
 
 
1894
1910
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
1895
1911
 
1896
1912
 
1973
1989
        else:
1974
1990
            self._require_stacking = True
1975
1991
 
1976
 
    def acquire_repository(self, make_working_trees=None, shared=False,
1977
 
            possible_transports=None):
 
1992
    def acquire_repository(self, make_working_trees=None, shared=False):
1978
1993
        """Acquire a repository for this bzrdir.
1979
1994
 
1980
1995
        Implementations may create a new repository or use a pre-exising
1986
2001
        :return: A repository, is_new_flag (True if the repository was
1987
2002
            created).
1988
2003
        """
1989
 
        raise NotImplementedError(RepositoryAcquisitionPolicy.acquire_repository)
 
2004
        raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
1990
2005
 
1991
2006
 
1992
2007
class CreateRepository(RepositoryAcquisitionPolicy):
2005
2020
                                             require_stacking)
2006
2021
        self._bzrdir = bzrdir
2007
2022
 
2008
 
    def acquire_repository(self, make_working_trees=None, shared=False,
2009
 
            possible_transports=None):
 
2023
    def acquire_repository(self, make_working_trees=None, shared=False):
2010
2024
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
2011
2025
 
2012
2026
        Creates the desired repository in the bzrdir we already have.
2013
2027
        """
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)
2019
2028
        stack_on = self._get_full_stack_on()
2020
2029
        if stack_on:
2021
2030
            format = self._bzrdir._format
2022
2031
            format.require_stacking(stack_on=stack_on,
2023
 
                                    possible_transports=possible_transports)
 
2032
                                    possible_transports=[self._bzrdir.root_transport])
2024
2033
            if not self._require_stacking:
2025
2034
                # We have picked up automatic stacking somewhere.
2026
 
                note(gettext('Using default stacking branch {0} at {1}').format(
2027
 
                    self._stack_on, self._stack_on_pwd))
 
2035
                note('Using default stacking branch %s at %s', self._stack_on,
 
2036
                    self._stack_on_pwd)
2028
2037
        repository = self._bzrdir.create_repository(shared=shared)
2029
2038
        self._add_fallback(repository,
2030
 
                           possible_transports=possible_transports)
 
2039
                           possible_transports=[self._bzrdir.transport])
2031
2040
        if make_working_trees is not None:
2032
2041
            repository.set_make_working_trees(make_working_trees)
2033
2042
        return repository, True
2049
2058
                                             require_stacking)
2050
2059
        self._repository = repository
2051
2060
 
2052
 
    def acquire_repository(self, make_working_trees=None, shared=False,
2053
 
            possible_transports=None):
 
2061
    def acquire_repository(self, make_working_trees=None, shared=False):
2054
2062
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
2055
2063
 
2056
2064
        Returns an existing repository to use.
2057
2065
        """
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)
2063
2066
        self._add_fallback(self._repository,
2064
 
                       possible_transports=possible_transports)
 
2067
                       possible_transports=[self._repository.bzrdir.transport])
2065
2068
        return self._repository, False
2066
2069
 
2067
2070
 
2071
2074
         tree_format=None,
2072
2075
         hidden=False,
2073
2076
         experimental=False,
2074
 
         alias=False, bzrdir_format=None):
 
2077
         alias=False):
2075
2078
    """Register a metadir subformat.
2076
2079
 
2077
 
    These all use a meta bzrdir, but can be parameterized by the
2078
 
    Repository/Branch/WorkingTreeformats.
 
2080
    These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
 
2081
    by the Repository/Branch/WorkingTreeformats.
2079
2082
 
2080
2083
    :param repository_format: The fully-qualified repository format class
2081
2084
        name as a string.
2084
2087
    :param tree_format: Fully-qualified tree format class name as
2085
2088
        a string.
2086
2089
    """
2087
 
    if bzrdir_format is None:
2088
 
        bzrdir_format = BzrDirMetaFormat1
2089
2090
    # This should be expanded to support setting WorkingTree and Branch
2090
 
    # formats, once the API supports that.
 
2091
    # formats, once BzrDirMetaFormat1 supports that.
2091
2092
    def _load(full_name):
2092
2093
        mod_name, factory_name = full_name.rsplit('.', 1)
2093
2094
        try:
2100
2101
        return factory()
2101
2102
 
2102
2103
    def helper():
2103
 
        bd = bzrdir_format()
 
2104
        bd = BzrDirMetaFormat1()
2104
2105
        if branch_format is not None:
2105
2106
            bd.set_branch_format(_load(branch_format))
2106
2107
        if tree_format is not None:
2114
2115
register_metadir(controldir.format_registry, 'knit',
2115
2116
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2116
2117
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
2117
 
    branch_format='bzrlib.branchfmt.fullhistory.BzrBranchFormat5',
 
2118
    branch_format='bzrlib.branch.BzrBranchFormat5',
2118
2119
    tree_format='bzrlib.workingtree_3.WorkingTreeFormat3',
2119
2120
    hidden=True,
2120
2121
    deprecated=True)
2121
2122
register_metadir(controldir.format_registry, 'dirstate',
2122
2123
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
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',
 
2124
    help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
 
2125
        'above when accessed over the network.',
 
2126
    branch_format='bzrlib.branch.BzrBranchFormat5',
2127
2127
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2128
2128
    hidden=True,
2129
2129
    deprecated=True)
2130
2130
register_metadir(controldir.format_registry, 'dirstate-tags',
2131
2131
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2132
 
    help='Variant of dirstate with support for tags. '
2133
 
        'Introduced in bzr 0.15.',
 
2132
    help='New in 0.15: Fast local operations and improved scaling for '
 
2133
        'network operations. Additionally adds support for tags.'
 
2134
        ' Incompatible with bzr < 0.15.',
2134
2135
    branch_format='bzrlib.branch.BzrBranchFormat6',
2135
2136
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2136
2137
    hidden=True,
2137
2138
    deprecated=True)
2138
2139
register_metadir(controldir.format_registry, 'rich-root',
2139
2140
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2140
 
    help='Variant of dirstate with better handling of tree roots. '
2141
 
        'Introduced in bzr 1.0',
 
2141
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
 
2142
        ' bzr < 1.0.',
2142
2143
    branch_format='bzrlib.branch.BzrBranchFormat6',
2143
2144
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2144
2145
    hidden=True,
2145
2146
    deprecated=True)
2146
2147
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
2147
2148
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2148
 
    help='Variant of dirstate with support for nested trees. '
2149
 
         'Introduced in 0.15.',
 
2149
    help='New in 0.15: Fast local operations and improved scaling for '
 
2150
        'network operations. Additionally adds support for versioning nested '
 
2151
        'bzr branches. Incompatible with bzr < 0.15.',
2150
2152
    branch_format='bzrlib.branch.BzrBranchFormat6',
2151
2153
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2152
2154
    experimental=True,
2154
2156
    )
2155
2157
register_metadir(controldir.format_registry, 'pack-0.92',
2156
2158
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack1',
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. '
 
2159
    help='New in 0.92: Pack-based format with data compatible with '
 
2160
        'dirstate-tags format repositories. Interoperates with '
 
2161
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2160
2162
        ,
2161
2163
    branch_format='bzrlib.branch.BzrBranchFormat6',
2162
2164
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2163
 
    deprecated=True,
2164
2165
    )
2165
2166
register_metadir(controldir.format_registry, 'pack-0.92-subtree',
2166
2167
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack3',
2167
 
    help='Pack-based format used in 1.x series, with subtree support. '
2168
 
        'Introduced in 0.92. Interoperates with '
 
2168
    help='New in 0.92: Pack-based format with data compatible with '
 
2169
        'dirstate-with-subtree format repositories. Interoperates with '
2169
2170
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2170
2171
        ,
2171
2172
    branch_format='bzrlib.branch.BzrBranchFormat6',
2172
2173
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2173
2174
    hidden=True,
2174
 
    deprecated=True,
2175
2175
    experimental=True,
2176
2176
    )
2177
2177
register_metadir(controldir.format_registry, 'rich-root-pack',
2178
2178
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack4',
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.',
 
2179
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
 
2180
         '(needed for bzr-svn and bzr-git).',
2181
2181
    branch_format='bzrlib.branch.BzrBranchFormat6',
2182
2182
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2183
2183
    hidden=True,
2184
 
    deprecated=True,
2185
2184
    )
2186
2185
register_metadir(controldir.format_registry, '1.6',
2187
2186
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5',
2191
2190
    branch_format='bzrlib.branch.BzrBranchFormat7',
2192
2191
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2193
2192
    hidden=True,
2194
 
    deprecated=True,
2195
2193
    )
2196
2194
register_metadir(controldir.format_registry, '1.6.1-rich-root',
2197
2195
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5RichRoot',
2200
2198
    branch_format='bzrlib.branch.BzrBranchFormat7',
2201
2199
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2202
2200
    hidden=True,
2203
 
    deprecated=True,
2204
2201
    )
2205
2202
register_metadir(controldir.format_registry, '1.9',
2206
2203
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
2210
2207
    branch_format='bzrlib.branch.BzrBranchFormat7',
2211
2208
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2212
2209
    hidden=True,
2213
 
    deprecated=True,
2214
2210
    )
2215
2211
register_metadir(controldir.format_registry, '1.9-rich-root',
2216
2212
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
2219
2215
    branch_format='bzrlib.branch.BzrBranchFormat7',
2220
2216
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2221
2217
    hidden=True,
2222
 
    deprecated=True,
2223
2218
    )
2224
2219
register_metadir(controldir.format_registry, '1.14',
2225
2220
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
2226
2221
    help='A working-tree format that supports content filtering.',
2227
2222
    branch_format='bzrlib.branch.BzrBranchFormat7',
2228
2223
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
2229
 
    hidden=True,
2230
 
    deprecated=True,
2231
2224
    )
2232
2225
register_metadir(controldir.format_registry, '1.14-rich-root',
2233
2226
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
2235
2228
         '(needed for bzr-svn and bzr-git).',
2236
2229
    branch_format='bzrlib.branch.BzrBranchFormat7',
2237
2230
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
2238
 
    hidden=True,
2239
 
    deprecated=True,
2240
2231
    )
2241
2232
# The following un-numbered 'development' formats should always just be aliases.
2242
2233
register_metadir(controldir.format_registry, 'development-subtree',
2270
2261
    alias=False,
2271
2262
    )
2272
2263
 
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
 
 
2283
2264
# And the development formats above will have aliased one of the following:
2284
2265
 
2285
2266
# Finally, the current format.
2286
2267
register_metadir(controldir.format_registry, '2a',
2287
2268
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2288
 
    help='Format for the bzr 2.0 series.\n'
 
2269
    help='First format for bzr 2.0 series.\n'
2289
2270
        'Uses group-compress storage.\n'
2290
2271
        'Provides rich roots which are a one-way transition.\n',
2291
2272
        # 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '