~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Martin Packman
  • Date: 2012-01-05 09:50:04 UTC
  • mfrom: (6424 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6426.
  • Revision ID: martin.packman@canonical.com-20120105095004-mia9xb7y0efmto0v
Merge bzr.dev to resolve conflicts in bzrlib.builtins

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,
55
58
    do_catching_redirections,
56
59
    local,
57
60
    )
 
61
from bzrlib.i18n import gettext
58
62
""")
59
63
 
60
64
from bzrlib.trace import (
65
69
from bzrlib import (
66
70
    config,
67
71
    controldir,
68
 
    hooks,
69
72
    registry,
70
73
    )
71
74
from bzrlib.symbol_versioning import (
200
203
                if (result_repo.user_url == result.user_url
201
204
                    and not require_stacking and
202
205
                    revision_id is not None):
203
 
                    fetch_spec = graph.PendingAncestryResult(
 
206
                    fetch_spec = vf_search.PendingAncestryResult(
204
207
                        [revision_id], local_repo)
205
208
                    result_repo.fetch(local_repo, fetch_spec=fetch_spec)
206
209
                else:
221
224
            # the tree and fail.
222
225
            result.root_transport.local_abspath('.')
223
226
            if result_repo is None or result_repo.make_working_trees():
224
 
                self.open_workingtree().clone(result)
 
227
                self.open_workingtree().clone(result, revision_id=revision_id)
225
228
        except (errors.NoWorkingTree, errors.NotLocalUrl):
226
229
            pass
227
230
        return result
232
235
        t = _mod_transport.get_transport(url)
233
236
        t.ensure_base()
234
237
 
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
 
 
326
238
    def determine_repository_policy(self, force_new_repo=False, stack_on=None,
327
239
                                    stack_on_pwd=None, require_stacking=False):
328
240
        """Return an object representing a policy to use.
461
373
        if revision_id is not None:
462
374
            fetch_spec_factory.add_revision_ids([revision_id])
463
375
            fetch_spec_factory.source_branch_stop_revision_id = revision_id
 
376
        if possible_transports is None:
 
377
            possible_transports = []
 
378
        else:
 
379
            possible_transports = list(possible_transports) + [
 
380
                self.root_transport]
464
381
        target_transport = _mod_transport.get_transport(url,
465
382
            possible_transports)
466
383
        target_transport.ensure_base()
467
384
        cloning_format = self.cloning_metadir(stacked)
468
385
        # Create/update the result branch
469
 
        result = cloning_format.initialize_on_transport(target_transport)
 
386
        try:
 
387
            result = controldir.ControlDir.open_from_transport(target_transport)
 
388
        except errors.NotBranchError:
 
389
            result = cloning_format.initialize_on_transport(target_transport)
470
390
        source_branch, source_repository = self._find_source_repo(
471
391
            add_cleanup, source_branch)
472
392
        fetch_spec_factory.source_branch = source_branch
478
398
            stacked_branch_url = None
479
399
        repository_policy = result.determine_repository_policy(
480
400
            force_new_repo, stacked_branch_url, require_stacking=stacked)
481
 
        result_repo, is_new_repo = repository_policy.acquire_repository()
 
401
        result_repo, is_new_repo = repository_policy.acquire_repository(
 
402
            possible_transports=possible_transports)
482
403
        add_cleanup(result_repo.lock_write().unlock)
483
404
        fetch_spec_factory.source_repo = source_repository
484
405
        fetch_spec_factory.target_repo = result_repo
505
426
        mutter("created new branch %r" % (result_branch,))
506
427
 
507
428
        # Create/update the result working tree
508
 
        if (create_tree_if_local and
 
429
        if (create_tree_if_local and not result.has_workingtree() and
509
430
            isinstance(target_transport, local.LocalTransport) and
510
431
            (result_repo is None or result_repo.make_working_trees())):
511
432
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
543
464
                    stacked=stacked)
544
465
        return result
545
466
 
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
467
    @deprecated_method(deprecated_in((2, 3, 0)))
616
468
    def generate_backup_name(self, base):
617
469
        return self._available_backup_name(base)
634
486
            old_path = self.root_transport.abspath('.bzr')
635
487
            backup_dir = self._available_backup_name('backup.bzr')
636
488
            new_path = self.root_transport.abspath(backup_dir)
637
 
            ui.ui_factory.note('making backup of %s\n  to %s' % (
 
489
            ui.ui_factory.note(gettext('making backup of {0}\n  to {1}').format(
638
490
                urlutils.unescape_for_display(old_path, 'utf-8'),
639
491
                urlutils.unescape_for_display(new_path, 'utf-8')))
640
492
            self.root_transport.copy_tree('.bzr', backup_dir)
657
509
            try:
658
510
                to_path = '.bzr.retired.%d' % i
659
511
                self.root_transport.rename('.bzr', to_path)
660
 
                note("renamed %s to %s"
661
 
                    % (self.root_transport.abspath('.bzr'), to_path))
 
512
                note(gettext("renamed {0} to {1}").format(
 
513
                    self.root_transport.abspath('.bzr'), to_path))
662
514
                return
663
515
            except (errors.TransportError, IOError, errors.PathError):
664
516
                i += 1
691
543
                return None
692
544
            # find the next containing bzrdir
693
545
            try:
694
 
                found_bzrdir = BzrDir.open_containing_from_transport(
 
546
                found_bzrdir = self.open_containing_from_transport(
695
547
                    next_transport)[0]
696
548
            except errors.NotBranchError:
697
549
                return None
814
666
        # add new tests for it to the appropriate place.
815
667
        return filename == '.bzr' or filename.startswith('.bzr/')
816
668
 
817
 
    @staticmethod
818
 
    def open_unsupported(base):
819
 
        """Open a branch which is not supported."""
820
 
        return BzrDir.open(base, _unsupported=True)
821
 
 
822
 
    @staticmethod
823
 
    def open(base, _unsupported=False, possible_transports=None):
824
 
        """Open an existing bzrdir, rooted at 'base' (url).
825
 
 
826
 
        :param _unsupported: a private parameter to the BzrDir class.
827
 
        """
828
 
        t = _mod_transport.get_transport(base, possible_transports)
829
 
        return BzrDir.open_from_transport(t, _unsupported=_unsupported)
830
 
 
831
 
    @staticmethod
832
 
    def open_from_transport(transport, _unsupported=False,
833
 
                            _server_formats=True):
834
 
        """Open a bzrdir within a particular directory.
835
 
 
836
 
        :param transport: Transport containing the bzrdir.
837
 
        :param _unsupported: private.
838
 
        """
839
 
        for hook in BzrDir.hooks['pre_open']:
840
 
            hook(transport)
841
 
        # Keep initial base since 'transport' may be modified while following
842
 
        # the redirections.
843
 
        base = transport.base
844
 
        def find_format(transport):
845
 
            return transport, controldir.ControlDirFormat.find_format(
846
 
                transport, _server_formats=_server_formats)
847
 
 
848
 
        def redirected(transport, e, redirection_notice):
849
 
            redirected_transport = transport._redirected_to(e.source, e.target)
850
 
            if redirected_transport is None:
851
 
                raise errors.NotBranchError(base)
852
 
            note('%s is%s redirected to %s',
853
 
                 transport.base, e.permanently, redirected_transport.base)
854
 
            return redirected_transport
855
 
 
856
 
        try:
857
 
            transport, format = do_catching_redirections(find_format,
858
 
                                                         transport,
859
 
                                                         redirected)
860
 
        except errors.TooManyRedirections:
861
 
            raise errors.NotBranchError(base)
862
 
 
863
 
        format.check_support_status(_unsupported)
864
 
        return format.open(transport, _found=True)
865
 
 
866
 
    @staticmethod
867
 
    def open_containing(url, possible_transports=None):
868
 
        """Open an existing branch which contains url.
869
 
 
870
 
        :param url: url to search from.
871
 
 
872
 
        See open_containing_from_transport for more detail.
873
 
        """
874
 
        transport = _mod_transport.get_transport(url, possible_transports)
875
 
        return BzrDir.open_containing_from_transport(transport)
876
 
 
877
 
    @staticmethod
878
 
    def open_containing_from_transport(a_transport):
879
 
        """Open an existing branch which contains a_transport.base.
880
 
 
881
 
        This probes for a branch at a_transport, and searches upwards from there.
882
 
 
883
 
        Basically we keep looking up until we find the control directory or
884
 
        run into the root.  If there isn't one, raises NotBranchError.
885
 
        If there is one and it is either an unrecognised format or an unsupported
886
 
        format, UnknownFormatError or UnsupportedFormatError are raised.
887
 
        If there is one, it is returned, along with the unused portion of url.
888
 
 
889
 
        :return: The BzrDir that contains the path, and a Unicode path
890
 
                for the rest of the URL.
891
 
        """
892
 
        # this gets the normalised url back. I.e. '.' -> the full path.
893
 
        url = a_transport.base
894
 
        while True:
895
 
            try:
896
 
                result = BzrDir.open_from_transport(a_transport)
897
 
                return result, urlutils.unescape(a_transport.relpath(url))
898
 
            except errors.NotBranchError, e:
899
 
                pass
900
 
            try:
901
 
                new_t = a_transport.clone('..')
902
 
            except errors.InvalidURLJoin:
903
 
                # reached the root, whatever that may be
904
 
                raise errors.NotBranchError(path=url)
905
 
            if new_t.base == a_transport.base:
906
 
                # reached the root, whatever that may be
907
 
                raise errors.NotBranchError(path=url)
908
 
            a_transport = new_t
909
 
 
910
 
    @classmethod
911
 
    def open_tree_or_branch(klass, location):
912
 
        """Return the branch and working tree at a location.
913
 
 
914
 
        If there is no tree at the location, tree will be None.
915
 
        If there is no branch at the location, an exception will be
916
 
        raised
917
 
        :return: (tree, branch)
918
 
        """
919
 
        bzrdir = klass.open(location)
920
 
        return bzrdir._get_tree_branch()
921
 
 
922
 
    @classmethod
923
 
    def open_containing_tree_or_branch(klass, location):
924
 
        """Return the branch and working tree contained by a location.
925
 
 
926
 
        Returns (tree, branch, relpath).
927
 
        If there is no tree at containing the location, tree will be None.
928
 
        If there is no branch containing the location, an exception will be
929
 
        raised
930
 
        relpath is the portion of the path that is contained by the branch.
931
 
        """
932
 
        bzrdir, relpath = klass.open_containing(location)
933
 
        tree, branch = bzrdir._get_tree_branch()
934
 
        return tree, branch, relpath
935
 
 
936
 
    @classmethod
937
 
    def open_containing_tree_branch_or_repository(klass, location):
938
 
        """Return the working tree, branch and repo contained by a location.
939
 
 
940
 
        Returns (tree, branch, repository, relpath).
941
 
        If there is no tree containing the location, tree will be None.
942
 
        If there is no branch containing the location, branch will be None.
943
 
        If there is no repository containing the location, repository will be
944
 
        None.
945
 
        relpath is the portion of the path that is contained by the innermost
946
 
        BzrDir.
947
 
 
948
 
        If no tree, branch or repository is found, a NotBranchError is raised.
949
 
        """
950
 
        bzrdir, relpath = klass.open_containing(location)
951
 
        try:
952
 
            tree, branch = bzrdir._get_tree_branch()
953
 
        except errors.NotBranchError:
954
 
            try:
955
 
                repo = bzrdir.find_repository()
956
 
                return None, None, repo, relpath
957
 
            except (errors.NoRepositoryPresent):
958
 
                raise errors.NotBranchError(location)
959
 
        return tree, branch, branch.repository, relpath
960
 
 
961
669
    def _cloning_metadir(self):
962
670
        """Produce a metadir suitable for cloning with.
963
671
 
1003
711
 
1004
712
        :require_stacking: If True, non-stackable formats will be upgraded
1005
713
            to similar stackable formats.
1006
 
        :returns: a BzrDirFormat with all component formats either set
 
714
        :returns: a ControlDirFormat with all component formats either set
1007
715
            appropriately or set to None if that component should not be
1008
716
            created.
1009
717
        """
1021
729
            format.require_stacking()
1022
730
        return format
1023
731
 
1024
 
    @classmethod
1025
 
    def create(cls, base, format=None, possible_transports=None):
1026
 
        """Create a new BzrDir at the url 'base'.
1027
 
 
1028
 
        :param format: If supplied, the format of branch to create.  If not
1029
 
            supplied, the default is used.
1030
 
        :param possible_transports: If supplied, a list of transports that
1031
 
            can be reused to share a remote connection.
1032
 
        """
1033
 
        if cls is not BzrDir:
1034
 
            raise AssertionError("BzrDir.create always creates the"
1035
 
                "default format, not one of %r" % cls)
1036
 
        t = _mod_transport.get_transport(base, possible_transports)
1037
 
        t.ensure_base()
1038
 
        if format is None:
1039
 
            format = controldir.ControlDirFormat.get_default_format()
1040
 
        return format.initialize_on_transport(t)
1041
 
 
1042
732
    def get_branch_transport(self, branch_format, name=None):
1043
733
        """Get the transport for use by branch format in this BzrDir.
1044
734
 
1078
768
        """
1079
769
        raise NotImplementedError(self.get_workingtree_transport)
1080
770
 
1081
 
 
1082
 
class BzrDirHooks(hooks.Hooks):
1083
 
    """Hooks for BzrDir operations."""
1084
 
 
1085
 
    def __init__(self):
1086
 
        """Create the default hooks."""
1087
 
        hooks.Hooks.__init__(self, "bzrlib.bzrdir", "BzrDir.hooks")
1088
 
        self.add_hook('pre_open',
1089
 
            "Invoked before attempting to open a BzrDir with the transport "
1090
 
            "that the open will use.", (1, 14))
1091
 
        self.add_hook('post_repo_init',
1092
 
            "Invoked after a repository has been initialized. "
1093
 
            "post_repo_init is called with a "
1094
 
            "bzrlib.bzrdir.RepoInitHookParams.",
1095
 
            (2, 2))
1096
 
 
1097
 
# install the default hooks
1098
 
BzrDir.hooks = BzrDirHooks()
1099
 
 
1100
 
 
1101
 
class RepoInitHookParams(object):
1102
 
    """Object holding parameters passed to `*_repo_init` hooks.
1103
 
 
1104
 
    There are 4 fields that hooks may wish to access:
1105
 
 
1106
 
    :ivar repository: Repository created
1107
 
    :ivar format: Repository format
1108
 
    :ivar bzrdir: The bzrdir for the repository
1109
 
    :ivar shared: The repository is shared
1110
 
    """
1111
 
 
1112
 
    def __init__(self, repository, format, a_bzrdir, shared):
1113
 
        """Create a group of RepoInitHook parameters.
1114
 
 
1115
 
        :param repository: Repository created
1116
 
        :param format: Repository format
1117
 
        :param bzrdir: The bzrdir for the repository
1118
 
        :param shared: The repository is shared
 
771
    @classmethod
 
772
    def create(cls, base, format=None, possible_transports=None):
 
773
        """Create a new BzrDir at the url 'base'.
 
774
 
 
775
        :param format: If supplied, the format of branch to create.  If not
 
776
            supplied, the default is used.
 
777
        :param possible_transports: If supplied, a list of transports that
 
778
            can be reused to share a remote connection.
1119
779
        """
1120
 
        self.repository = repository
1121
 
        self.format = format
1122
 
        self.bzrdir = a_bzrdir
1123
 
        self.shared = shared
1124
 
 
1125
 
    def __eq__(self, other):
1126
 
        return self.__dict__ == other.__dict__
 
780
        if cls is not BzrDir:
 
781
            raise AssertionError("BzrDir.create always creates the "
 
782
                "default format, not one of %r" % cls)
 
783
        return controldir.ControlDir.create(base, format=format,
 
784
                possible_transports=possible_transports)
1127
785
 
1128
786
    def __repr__(self):
1129
 
        if self.repository:
1130
 
            return "<%s for %s>" % (self.__class__.__name__,
1131
 
                self.repository)
1132
 
        else:
1133
 
            return "<%s for %s>" % (self.__class__.__name__,
1134
 
                self.bzrdir)
 
787
        return "<%s at %r>" % (self.__class__.__name__, self.user_url)
 
788
 
 
789
    def update_feature_flags(self, updated_flags):
 
790
        """Update the features required by this bzrdir.
 
791
 
 
792
        :param updated_flags: Dictionary mapping feature names to necessities
 
793
            A necessity can be None to indicate the feature should be removed
 
794
        """
 
795
        self.control_files.lock_write()
 
796
        try:
 
797
            self._format._update_feature_flags(updated_flags)
 
798
            self.transport.put_bytes('branch-format', self._format.as_string())
 
799
        finally:
 
800
            self.control_files.unlock()
1135
801
 
1136
802
 
1137
803
class BzrDirMeta1(BzrDir):
1143
809
    present within a BzrDir.
1144
810
    """
1145
811
 
 
812
    def __init__(self, _transport, _format):
 
813
        super(BzrDirMeta1, self).__init__(_transport, _format)
 
814
        self.control_files = lockable_files.LockableFiles(self.control_transport,
 
815
            self._format._lock_file_name, self._format._lock_class)
 
816
 
1146
817
    def can_convert_format(self):
1147
818
        """See BzrDir.can_convert_format()."""
1148
819
        return True
1149
820
 
1150
 
    def create_branch(self, name=None, repository=None):
 
821
    def create_branch(self, name=None, repository=None,
 
822
            append_revisions_only=None):
1151
823
        """See BzrDir.create_branch."""
 
824
        if name is None:
 
825
            name = self._get_selected_branch()
1152
826
        return self._format.get_branch_format().initialize(self, name=name,
1153
 
                repository=repository)
 
827
                repository=repository,
 
828
                append_revisions_only=append_revisions_only)
1154
829
 
1155
830
    def destroy_branch(self, name=None):
1156
831
        """See BzrDir.create_branch."""
1164
839
 
1165
840
    def destroy_repository(self):
1166
841
        """See BzrDir.destroy_repository."""
1167
 
        self.transport.delete_tree('repository')
 
842
        try:
 
843
            self.transport.delete_tree('repository')
 
844
        except errors.NoSuchFile:
 
845
            raise errors.NoRepositoryPresent(self)
1168
846
 
1169
847
    def create_workingtree(self, revision_id=None, from_branch=None,
1170
848
                           accelerator_tree=None, hardlink=False):
1192
870
 
1193
871
        This might be a synthetic object for e.g. RemoteBranch and SVN.
1194
872
        """
1195
 
        from bzrlib.branch import BranchFormat
1196
 
        return BranchFormat.find_format(self, name=name)
 
873
        from bzrlib.branch import BranchFormatMetadir
 
874
        return BranchFormatMetadir.find_format(self, name=name)
1197
875
 
1198
876
    def _get_mkdir_mode(self):
1199
877
        """Figure out the mode to use when creating a bzrdir subdir."""
1203
881
 
1204
882
    def get_branch_reference(self, name=None):
1205
883
        """See BzrDir.get_branch_reference()."""
1206
 
        from bzrlib.branch import BranchFormat
1207
 
        format = BranchFormat.find_format(self, name=name)
 
884
        from bzrlib.branch import BranchFormatMetadir
 
885
        format = BranchFormatMetadir.find_format(self, name=name)
1208
886
        return format.get_reference(self, name=name)
1209
887
 
1210
888
    def get_branch_transport(self, branch_format, name=None):
1259
937
        Note: if you're going to open the working tree, you should just go
1260
938
        ahead and try, and not ask permission first.
1261
939
        """
1262
 
        from bzrlib.workingtree import WorkingTreeFormat
 
940
        from bzrlib.workingtree import WorkingTreeFormatMetaDir
1263
941
        try:
1264
 
            WorkingTreeFormat.find_format_string(self)
 
942
            WorkingTreeFormatMetaDir.find_format_string(self)
1265
943
        except errors.NoWorkingTree:
1266
944
            return False
1267
945
        return True
1268
946
 
1269
947
    def needs_format_conversion(self, format):
1270
948
        """See BzrDir.needs_format_conversion()."""
1271
 
        if not isinstance(self._format, format.__class__):
 
949
        if (not isinstance(self._format, format.__class__) or
 
950
            self._format.get_format_string() != format.get_format_string()):
1272
951
            # it is not a meta dir format, conversion is needed.
1273
952
            return True
1274
953
        # we might want to push this down to the repository?
1295
974
        return False
1296
975
 
1297
976
    def open_branch(self, name=None, unsupported=False,
1298
 
                    ignore_fallbacks=False):
1299
 
        """See BzrDir.open_branch."""
 
977
                    ignore_fallbacks=False, possible_transports=None):
 
978
        """See ControlDir.open_branch."""
 
979
        if name is None:
 
980
            name = self._get_selected_branch()
1300
981
        format = self.find_branch_format(name=name)
1301
982
        format.check_support_status(unsupported)
1302
983
        return format.open(self, name=name,
1303
 
            _found=True, ignore_fallbacks=ignore_fallbacks)
 
984
            _found=True, ignore_fallbacks=ignore_fallbacks,
 
985
            possible_transports=possible_transports)
1304
986
 
1305
987
    def open_repository(self, unsupported=False):
1306
988
        """See BzrDir.open_repository."""
1307
 
        from bzrlib.repository import RepositoryFormat
1308
 
        format = RepositoryFormat.find_format(self)
 
989
        from bzrlib.repository import RepositoryFormatMetaDir
 
990
        format = RepositoryFormatMetaDir.find_format(self)
1309
991
        format.check_support_status(unsupported)
1310
992
        return format.open(self, _found=True)
1311
993
 
1312
994
    def open_workingtree(self, unsupported=False,
1313
995
            recommend_upgrade=True):
1314
996
        """See BzrDir.open_workingtree."""
1315
 
        from bzrlib.workingtree import WorkingTreeFormat
1316
 
        format = WorkingTreeFormat.find_format(self)
 
997
        from bzrlib.workingtree import WorkingTreeFormatMetaDir
 
998
        format = WorkingTreeFormatMetaDir.find_format(self)
1317
999
        format.check_support_status(unsupported, recommend_upgrade,
1318
1000
            basedir=self.root_transport.base)
1319
1001
        return format.open(self, _found=True)
1322
1004
        return config.TransportConfig(self.transport, 'control.conf')
1323
1005
 
1324
1006
 
 
1007
class BzrDirMeta1Colo(BzrDirMeta1):
 
1008
    """BzrDirMeta1 with support for colocated branches.
 
1009
 
 
1010
    This format is experimental, and will eventually be merged back into
 
1011
    BzrDirMeta1.
 
1012
    """
 
1013
 
 
1014
    def _get_branch_path(self, name):
 
1015
        """Obtain the branch path to use.
 
1016
 
 
1017
        This uses the API specified branch name first, and then falls back to
 
1018
        the branch name specified in the URL. If neither of those is specified,
 
1019
        it uses the default branch.
 
1020
 
 
1021
        :param name: Optional branch name to use
 
1022
        :return: Relative path to branch
 
1023
        """
 
1024
        if name is None:
 
1025
            return 'branch'
 
1026
        return urlutils.join('branches', name.encode("utf-8"))
 
1027
 
 
1028
    def _read_branch_list(self):
 
1029
        """Read the branch list.
 
1030
 
 
1031
        :return: List of utf-8 encoded branch names.
 
1032
        """
 
1033
        try:
 
1034
            f = self.control_transport.get('branch-list')
 
1035
        except errors.NoSuchFile:
 
1036
            return []
 
1037
 
 
1038
        ret = []
 
1039
        try:
 
1040
            for name in f:
 
1041
                ret.append(name.rstrip("\n"))
 
1042
        finally:
 
1043
            f.close()
 
1044
        return ret
 
1045
 
 
1046
    def _write_branch_list(self, branches):
 
1047
        """Write out the branch list.
 
1048
 
 
1049
        :param branches: List of utf-8 branch names to write
 
1050
        """
 
1051
        self.transport.put_bytes('branch-list',
 
1052
            "".join([name+"\n" for name in branches]))
 
1053
 
 
1054
    def destroy_branch(self, name=None):
 
1055
        """See BzrDir.create_branch."""
 
1056
        if name is None:
 
1057
            name = self._get_selected_branch()
 
1058
        path = self._get_branch_path(name)
 
1059
        if name is not None:
 
1060
            self.control_files.lock_write()
 
1061
            try:
 
1062
                branches = self._read_branch_list()
 
1063
                try:
 
1064
                    branches.remove(name.encode("utf-8"))
 
1065
                except ValueError:
 
1066
                    raise errors.NotBranchError(name)
 
1067
                self._write_branch_list(branches)
 
1068
            finally:
 
1069
                self.control_files.unlock()
 
1070
        self.transport.delete_tree(path)
 
1071
 
 
1072
    def get_branches(self):
 
1073
        """See ControlDir.get_branches."""
 
1074
        ret = {}
 
1075
        try:
 
1076
            ret[None] = self.open_branch()
 
1077
        except (errors.NotBranchError, errors.NoRepositoryPresent):
 
1078
            pass
 
1079
 
 
1080
        for name in self._read_branch_list():
 
1081
            ret[name] = self.open_branch(name.decode('utf-8'))
 
1082
 
 
1083
        return ret
 
1084
 
 
1085
    def get_branch_transport(self, branch_format, name=None):
 
1086
        """See BzrDir.get_branch_transport()."""
 
1087
        path = self._get_branch_path(name)
 
1088
        # XXX: this shouldn't implicitly create the directory if it's just
 
1089
        # promising to get a transport -- mbp 20090727
 
1090
        if branch_format is None:
 
1091
            return self.transport.clone(path)
 
1092
        try:
 
1093
            branch_format.get_format_string()
 
1094
        except NotImplementedError:
 
1095
            raise errors.IncompatibleFormat(branch_format, self._format)
 
1096
        if name is not None:
 
1097
            try:
 
1098
                self.transport.mkdir('branches', mode=self._get_mkdir_mode())
 
1099
            except errors.FileExists:
 
1100
                pass
 
1101
            branches = self._read_branch_list()
 
1102
            utf8_name = name.encode("utf-8")
 
1103
            if not utf8_name in branches:
 
1104
                self.control_files.lock_write()
 
1105
                try:
 
1106
                    branches = self._read_branch_list()
 
1107
                    branches.append(utf8_name)
 
1108
                    self._write_branch_list(branches)
 
1109
                finally:
 
1110
                    self.control_files.unlock()
 
1111
        try:
 
1112
            self.transport.mkdir(path, mode=self._get_mkdir_mode())
 
1113
        except errors.FileExists:
 
1114
            pass
 
1115
        return self.transport.clone(path)
 
1116
 
 
1117
 
 
1118
class BzrFormat(object):
 
1119
    """Base class for all formats of things living in metadirs.
 
1120
 
 
1121
    This class manages the format string that is stored in the 'format'
 
1122
    or 'branch-format' file.
 
1123
 
 
1124
    All classes for (branch-, repository-, workingtree-) formats that
 
1125
    live in meta directories and have their own 'format' file
 
1126
    (i.e. different from .bzr/branch-format) derive from this class,
 
1127
    as well as the relevant base class for their kind
 
1128
    (BranchFormat, WorkingTreeFormat, RepositoryFormat).
 
1129
 
 
1130
    Each format is identified by a "format" or "branch-format" file with a
 
1131
    single line containing the base format name and then an optional list of
 
1132
    feature flags.
 
1133
 
 
1134
    Feature flags are supported as of bzr 2.5. Setting feature flags on formats
 
1135
    will render them inaccessible to older versions of bzr.
 
1136
 
 
1137
    :ivar features: Dictionary mapping feature names to their necessity
 
1138
    """
 
1139
 
 
1140
    _present_features = set()
 
1141
 
 
1142
    def __init__(self):
 
1143
        self.features = {}
 
1144
 
 
1145
    @classmethod
 
1146
    def register_feature(cls, name):
 
1147
        """Register a feature as being present.
 
1148
 
 
1149
        :param name: Name of the feature
 
1150
        """
 
1151
        if " " in name:
 
1152
            raise ValueError("spaces are not allowed in feature names")
 
1153
        if name in cls._present_features:
 
1154
            raise errors.FeatureAlreadyRegistered(name)
 
1155
        cls._present_features.add(name)
 
1156
 
 
1157
    @classmethod
 
1158
    def unregister_feature(cls, name):
 
1159
        """Unregister a feature."""
 
1160
        cls._present_features.remove(name)
 
1161
 
 
1162
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
1163
            basedir=None):
 
1164
        for name, necessity in self.features.iteritems():
 
1165
            if name in self._present_features:
 
1166
                continue
 
1167
            if necessity == "optional":
 
1168
                mutter("ignoring optional missing feature %s", name)
 
1169
                continue
 
1170
            elif necessity == "required":
 
1171
                raise errors.MissingFeature(name)
 
1172
            else:
 
1173
                mutter("treating unknown necessity as require for %s",
 
1174
                       name)
 
1175
                raise errors.MissingFeature(name)
 
1176
 
 
1177
    @classmethod
 
1178
    def get_format_string(cls):
 
1179
        """Return the ASCII format string that identifies this format."""
 
1180
        raise NotImplementedError(cls.get_format_string)
 
1181
 
 
1182
    @classmethod
 
1183
    def from_string(cls, text):
 
1184
        format_string = cls.get_format_string()
 
1185
        if not text.startswith(format_string):
 
1186
            raise AssertionError("Invalid format header %r for %r" % (text, cls))
 
1187
        lines = text[len(format_string):].splitlines()
 
1188
        ret = cls()
 
1189
        for lineno, line in enumerate(lines):
 
1190
            try:
 
1191
                (necessity, feature) = line.split(" ", 1)
 
1192
            except ValueError:
 
1193
                raise errors.ParseFormatError(format=cls, lineno=lineno+2,
 
1194
                    line=line, text=text)
 
1195
            ret.features[feature] = necessity
 
1196
        return ret
 
1197
 
 
1198
    def as_string(self):
 
1199
        """Return the string representation of this format.
 
1200
        """
 
1201
        lines = [self.get_format_string()]
 
1202
        lines.extend([("%s %s\n" % (item[1], item[0])) for item in
 
1203
            self.features.iteritems()])
 
1204
        return "".join(lines)
 
1205
 
 
1206
    @classmethod
 
1207
    def _find_format(klass, registry, kind, format_string):
 
1208
        try:
 
1209
            first_line = format_string[:format_string.index("\n")+1]
 
1210
        except ValueError:
 
1211
            first_line = format_string
 
1212
        try:
 
1213
            cls = registry.get(first_line)
 
1214
        except KeyError:
 
1215
            raise errors.UnknownFormatError(format=first_line, kind=kind)
 
1216
        return cls.from_string(format_string)
 
1217
 
 
1218
    def network_name(self):
 
1219
        """A simple byte string uniquely identifying this format for RPC calls.
 
1220
 
 
1221
        Metadir branch formats use their format string.
 
1222
        """
 
1223
        return self.as_string()
 
1224
 
 
1225
    def __eq__(self, other):
 
1226
        return (self.__class__ is other.__class__ and
 
1227
                self.features == other.features)
 
1228
 
 
1229
    def _update_feature_flags(self, updated_flags):
 
1230
        """Update the feature flags in this format.
 
1231
 
 
1232
        :param updated_flags: Updated feature flags
 
1233
        """
 
1234
        for name, necessity in updated_flags.iteritems():
 
1235
            if necessity is None:
 
1236
                try:
 
1237
                    del self.features[name]
 
1238
                except KeyError:
 
1239
                    pass
 
1240
            else:
 
1241
                self.features[name] = necessity
 
1242
 
 
1243
 
1325
1244
class BzrProber(controldir.Prober):
1326
1245
    """Prober for formats that use a .bzr/ control directory."""
1327
1246
 
1346
1265
        except errors.NoSuchFile:
1347
1266
            raise errors.NotBranchError(path=transport.base)
1348
1267
        try:
1349
 
            return klass.formats.get(format_string)
 
1268
            first_line = format_string[:format_string.index("\n")+1]
 
1269
        except ValueError:
 
1270
            first_line = format_string
 
1271
        try:
 
1272
            cls = klass.formats.get(first_line)
1350
1273
        except KeyError:
1351
 
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
 
1274
            raise errors.UnknownFormatError(format=first_line, kind='bzrdir')
 
1275
        return cls.from_string(format_string)
1352
1276
 
1353
1277
    @classmethod
1354
1278
    def known_formats(cls):
1397
1321
        return set([RemoteBzrDirFormat()])
1398
1322
 
1399
1323
 
1400
 
class BzrDirFormat(controldir.ControlDirFormat):
 
1324
class BzrDirFormat(BzrFormat, controldir.ControlDirFormat):
1401
1325
    """ControlDirFormat base class for .bzr/ directories.
1402
1326
 
1403
1327
    Formats are placed in a dict by their format string for reference
1414
1338
    # _lock_class must be set in subclasses to the lock type, typ.
1415
1339
    # TransportLock or LockDir
1416
1340
 
1417
 
    @classmethod
1418
 
    def get_format_string(cls):
1419
 
        """Return the ASCII format string that identifies this format."""
1420
 
        raise NotImplementedError(cls.get_format_string)
1421
 
 
1422
1341
    def initialize_on_transport(self, transport):
1423
1342
        """Initialize a new bzrdir in the base directory of a Transport."""
1424
1343
        try:
1559
1478
                       "This is a Bazaar control directory.\n"
1560
1479
                       "Do not change any files in this directory.\n"
1561
1480
                       "See http://bazaar.canonical.com/ for more information about Bazaar.\n"),
1562
 
                      ('branch-format', self.get_format_string()),
 
1481
                      ('branch-format', self.as_string()),
1563
1482
                      ]
1564
1483
        # NB: no need to escape relative paths that are url safe.
1565
1484
        control_files = lockable_files.LockableFiles(bzrdir_transport,
1609
1528
            compatible with whatever sub formats are supported by self.
1610
1529
        :return: None.
1611
1530
        """
 
1531
        other_format.features = dict(self.features)
 
1532
 
 
1533
    def supports_transport(self, transport):
 
1534
        # bzr formats can be opened over all known transports
 
1535
        return True
 
1536
 
 
1537
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
1538
            basedir=None):
 
1539
        controldir.ControlDirFormat.check_support_status(self,
 
1540
            allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
 
1541
            basedir=basedir)
 
1542
        BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
 
1543
            recommend_upgrade=recommend_upgrade, basedir=basedir)
1612
1544
 
1613
1545
 
1614
1546
class BzrDirMetaFormat1(BzrDirFormat):
1628
1560
 
1629
1561
    fixed_components = False
1630
1562
 
 
1563
    colocated_branches = False
 
1564
 
1631
1565
    def __init__(self):
 
1566
        BzrDirFormat.__init__(self)
1632
1567
        self._workingtree_format = None
1633
1568
        self._branch_format = None
1634
1569
        self._repository_format = None
1640
1575
            return False
1641
1576
        if other.workingtree_format != self.workingtree_format:
1642
1577
            return False
 
1578
        if other.features != self.features:
 
1579
            return False
1643
1580
        return True
1644
1581
 
1645
1582
    def __ne__(self, other):
1723
1660
                    new_repo_format = None
1724
1661
            if new_repo_format is not None:
1725
1662
                self.repository_format = new_repo_format
1726
 
                note('Source repository format does not support stacking,'
1727
 
                     ' using format:\n  %s',
 
1663
                note(gettext('Source repository format does not support stacking,'
 
1664
                     ' using format:\n  %s'),
1728
1665
                     new_repo_format.get_format_description())
1729
1666
 
1730
1667
        if not self.get_branch_format().supports_stacking():
1743
1680
            if new_branch_format is not None:
1744
1681
                # Does support stacking, use its format.
1745
1682
                self.set_branch_format(new_branch_format)
1746
 
                note('Source branch format does not support stacking,'
1747
 
                     ' using format:\n  %s',
 
1683
                note(gettext('Source branch format does not support stacking,'
 
1684
                     ' using format:\n  %s'),
1748
1685
                     new_branch_format.get_format_description())
1749
1686
 
1750
1687
    def get_converter(self, format=None):
1751
1688
        """See BzrDirFormat.get_converter()."""
1752
1689
        if format is None:
1753
1690
            format = BzrDirFormat.get_default_format()
 
1691
        if (type(self) is BzrDirMetaFormat1 and
 
1692
            type(format) is BzrDirMetaFormat1Colo):
 
1693
            return ConvertMetaToColo(format)
 
1694
        if (type(self) is BzrDirMetaFormat1Colo and
 
1695
            type(format) is BzrDirMetaFormat1):
 
1696
            return ConvertMetaRemoveColo(format)
1754
1697
        if not isinstance(self, format.__class__):
1755
1698
            # converting away from metadir is not implemented
1756
1699
            raise NotImplementedError(self.get_converter)
1765
1708
        """See BzrDirFormat.get_format_description()."""
1766
1709
        return "Meta directory format 1"
1767
1710
 
1768
 
    def network_name(self):
1769
 
        return self.get_format_string()
1770
 
 
1771
1711
    def _open(self, transport):
1772
1712
        """See BzrDirFormat._open."""
1773
1713
        # Create a new format instance because otherwise initialisation of new
1802
1742
            compatible with whatever sub formats are supported by self.
1803
1743
        :return: None.
1804
1744
        """
 
1745
        super(BzrDirMetaFormat1, self)._supply_sub_formats_to(other_format)
1805
1746
        if getattr(self, '_repository_format', None) is not None:
1806
1747
            other_format.repository_format = self.repository_format
1807
1748
        if self._branch_format is not None:
1820
1761
    def __set_workingtree_format(self, wt_format):
1821
1762
        self._workingtree_format = wt_format
1822
1763
 
 
1764
    def __repr__(self):
 
1765
        return "<%r>" % (self.__class__.__name__,)
 
1766
 
1823
1767
    workingtree_format = property(__get_workingtree_format,
1824
1768
                                  __set_workingtree_format)
1825
1769
 
1830
1774
controldir.ControlDirFormat._default_format = BzrDirMetaFormat1()
1831
1775
 
1832
1776
 
 
1777
class BzrDirMetaFormat1Colo(BzrDirMetaFormat1):
 
1778
    """BzrDirMeta1 format with support for colocated branches."""
 
1779
 
 
1780
    colocated_branches = True
 
1781
 
 
1782
    @classmethod
 
1783
    def get_format_string(cls):
 
1784
        """See BzrDirFormat.get_format_string()."""
 
1785
        return "Bazaar meta directory, format 1 (with colocated branches)\n"
 
1786
 
 
1787
    def get_format_description(self):
 
1788
        """See BzrDirFormat.get_format_description()."""
 
1789
        return "Meta directory format 1 with support for colocated branches"
 
1790
 
 
1791
    def _open(self, transport):
 
1792
        """See BzrDirFormat._open."""
 
1793
        # Create a new format instance because otherwise initialisation of new
 
1794
        # metadirs share the global default format object leading to alias
 
1795
        # problems.
 
1796
        format = BzrDirMetaFormat1Colo()
 
1797
        self._supply_sub_formats_to(format)
 
1798
        return BzrDirMeta1Colo(transport, format)
 
1799
 
 
1800
 
 
1801
BzrProber.formats.register(BzrDirMetaFormat1Colo.get_format_string(),
 
1802
    BzrDirMetaFormat1Colo)
 
1803
 
 
1804
 
1833
1805
class ConvertMetaToMeta(controldir.Converter):
1834
1806
    """Converts the components of metadirs."""
1835
1807
 
1854
1826
        else:
1855
1827
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
1856
1828
                from bzrlib.repository import CopyConverter
1857
 
                ui.ui_factory.note('starting repository conversion')
 
1829
                ui.ui_factory.note(gettext('starting repository conversion'))
1858
1830
                converter = CopyConverter(self.target_format.repository_format)
1859
1831
                converter.convert(repo, pb)
1860
1832
        for branch in self.bzrdir.list_branches():
1908
1880
        return to_convert
1909
1881
 
1910
1882
 
 
1883
class ConvertMetaToColo(controldir.Converter):
 
1884
    """Add colocated branch support."""
 
1885
 
 
1886
    def __init__(self, target_format):
 
1887
        """Create a converter.that upgrades a metadir to the colo format.
 
1888
 
 
1889
        :param target_format: The final metadir format that is desired.
 
1890
        """
 
1891
        self.target_format = target_format
 
1892
 
 
1893
    def convert(self, to_convert, pb):
 
1894
        """See Converter.convert()."""
 
1895
        to_convert.transport.put_bytes('branch-format',
 
1896
            self.target_format.as_string())
 
1897
        return BzrDir.open_from_transport(to_convert.root_transport)
 
1898
 
 
1899
 
 
1900
class ConvertMetaRemoveColo(controldir.Converter):
 
1901
    """Remove colocated branch support from a bzrdir."""
 
1902
 
 
1903
    def __init__(self, target_format):
 
1904
        """Create a converter.that downgrades a colocated branch metadir
 
1905
        to a regular metadir.
 
1906
 
 
1907
        :param target_format: The final metadir format that is desired.
 
1908
        """
 
1909
        self.target_format = target_format
 
1910
 
 
1911
    def convert(self, to_convert, pb):
 
1912
        """See Converter.convert()."""
 
1913
        to_convert.control_files.lock_write()
 
1914
        try:
 
1915
            branches = to_convert.list_branches()
 
1916
            if len(branches) > 1:
 
1917
                raise errors.BzrError("remove all but a single "
 
1918
                    "colocated branch when downgrading")
 
1919
        finally:
 
1920
            to_convert.control_files.unlock()
 
1921
        to_convert.transport.put_bytes('branch-format',
 
1922
            self.target_format.as_string())
 
1923
        return BzrDir.open_from_transport(to_convert.root_transport)
 
1924
 
 
1925
 
1911
1926
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
1912
1927
 
1913
1928
 
1990
2005
        else:
1991
2006
            self._require_stacking = True
1992
2007
 
1993
 
    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):
1994
2010
        """Acquire a repository for this bzrdir.
1995
2011
 
1996
2012
        Implementations may create a new repository or use a pre-exising
2002
2018
        :return: A repository, is_new_flag (True if the repository was
2003
2019
            created).
2004
2020
        """
2005
 
        raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
 
2021
        raise NotImplementedError(RepositoryAcquisitionPolicy.acquire_repository)
2006
2022
 
2007
2023
 
2008
2024
class CreateRepository(RepositoryAcquisitionPolicy):
2021
2037
                                             require_stacking)
2022
2038
        self._bzrdir = bzrdir
2023
2039
 
2024
 
    def acquire_repository(self, make_working_trees=None, shared=False):
 
2040
    def acquire_repository(self, make_working_trees=None, shared=False,
 
2041
            possible_transports=None):
2025
2042
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
2026
2043
 
2027
2044
        Creates the desired repository in the bzrdir we already have.
2028
2045
        """
 
2046
        if possible_transports is None:
 
2047
            possible_transports = []
 
2048
        else:
 
2049
            possible_transports = list(possible_transports)
 
2050
        possible_transports.append(self._bzrdir.root_transport)
2029
2051
        stack_on = self._get_full_stack_on()
2030
2052
        if stack_on:
2031
2053
            format = self._bzrdir._format
2032
2054
            format.require_stacking(stack_on=stack_on,
2033
 
                                    possible_transports=[self._bzrdir.root_transport])
 
2055
                                    possible_transports=possible_transports)
2034
2056
            if not self._require_stacking:
2035
2057
                # We have picked up automatic stacking somewhere.
2036
 
                note('Using default stacking branch %s at %s', self._stack_on,
2037
 
                    self._stack_on_pwd)
 
2058
                note(gettext('Using default stacking branch {0} at {1}').format(
 
2059
                    self._stack_on, self._stack_on_pwd))
2038
2060
        repository = self._bzrdir.create_repository(shared=shared)
2039
2061
        self._add_fallback(repository,
2040
 
                           possible_transports=[self._bzrdir.transport])
 
2062
                           possible_transports=possible_transports)
2041
2063
        if make_working_trees is not None:
2042
2064
            repository.set_make_working_trees(make_working_trees)
2043
2065
        return repository, True
2059
2081
                                             require_stacking)
2060
2082
        self._repository = repository
2061
2083
 
2062
 
    def acquire_repository(self, make_working_trees=None, shared=False):
 
2084
    def acquire_repository(self, make_working_trees=None, shared=False,
 
2085
            possible_transports=None):
2063
2086
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
2064
2087
 
2065
2088
        Returns an existing repository to use.
2066
2089
        """
 
2090
        if possible_transports is None:
 
2091
            possible_transports = []
 
2092
        else:
 
2093
            possible_transports = list(possible_transports)
 
2094
        possible_transports.append(self._repository.bzrdir.transport)
2067
2095
        self._add_fallback(self._repository,
2068
 
                       possible_transports=[self._repository.bzrdir.transport])
 
2096
                       possible_transports=possible_transports)
2069
2097
        return self._repository, False
2070
2098
 
2071
2099
 
2075
2103
         tree_format=None,
2076
2104
         hidden=False,
2077
2105
         experimental=False,
2078
 
         alias=False):
 
2106
         alias=False, bzrdir_format=None):
2079
2107
    """Register a metadir subformat.
2080
2108
 
2081
 
    These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2082
 
    by the Repository/Branch/WorkingTreeformats.
 
2109
    These all use a meta bzrdir, but can be parameterized by the
 
2110
    Repository/Branch/WorkingTreeformats.
2083
2111
 
2084
2112
    :param repository_format: The fully-qualified repository format class
2085
2113
        name as a string.
2088
2116
    :param tree_format: Fully-qualified tree format class name as
2089
2117
        a string.
2090
2118
    """
 
2119
    if bzrdir_format is None:
 
2120
        bzrdir_format = BzrDirMetaFormat1
2091
2121
    # This should be expanded to support setting WorkingTree and Branch
2092
 
    # formats, once BzrDirMetaFormat1 supports that.
 
2122
    # formats, once the API supports that.
2093
2123
    def _load(full_name):
2094
2124
        mod_name, factory_name = full_name.rsplit('.', 1)
2095
2125
        try:
2102
2132
        return factory()
2103
2133
 
2104
2134
    def helper():
2105
 
        bd = BzrDirMetaFormat1()
 
2135
        bd = bzrdir_format()
2106
2136
        if branch_format is not None:
2107
2137
            bd.set_branch_format(_load(branch_format))
2108
2138
        if tree_format is not None:
2122
2152
    deprecated=True)
2123
2153
register_metadir(controldir.format_registry, 'dirstate',
2124
2154
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2125
 
    help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2126
 
        'above when accessed over the network.',
 
2155
    help='Format using dirstate for working trees. '
 
2156
        'Compatible with bzr 0.8 and '
 
2157
        'above when accessed over the network. Introduced in bzr 0.15.',
2127
2158
    branch_format='bzrlib.branch.BzrBranchFormat5',
2128
2159
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2129
2160
    hidden=True,
2130
2161
    deprecated=True)
2131
2162
register_metadir(controldir.format_registry, 'dirstate-tags',
2132
2163
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2133
 
    help='New in 0.15: Fast local operations and improved scaling for '
2134
 
        'network operations. Additionally adds support for tags.'
2135
 
        ' Incompatible with bzr < 0.15.',
 
2164
    help='Variant of dirstate with support for tags. '
 
2165
        'Introduced in bzr 0.15.',
2136
2166
    branch_format='bzrlib.branch.BzrBranchFormat6',
2137
2167
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2138
2168
    hidden=True,
2139
2169
    deprecated=True)
2140
2170
register_metadir(controldir.format_registry, 'rich-root',
2141
2171
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2142
 
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
2143
 
        ' bzr < 1.0.',
 
2172
    help='Variant of dirstate with better handling of tree roots. '
 
2173
        'Introduced in bzr 1.0',
2144
2174
    branch_format='bzrlib.branch.BzrBranchFormat6',
2145
2175
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2146
2176
    hidden=True,
2147
2177
    deprecated=True)
2148
2178
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
2149
2179
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2150
 
    help='New in 0.15: Fast local operations and improved scaling for '
2151
 
        'network operations. Additionally adds support for versioning nested '
2152
 
        'bzr branches. Incompatible with bzr < 0.15.',
 
2180
    help='Variant of dirstate with support for nested trees. '
 
2181
         'Introduced in 0.15.',
2153
2182
    branch_format='bzrlib.branch.BzrBranchFormat6',
2154
2183
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2155
2184
    experimental=True,
2157
2186
    )
2158
2187
register_metadir(controldir.format_registry, 'pack-0.92',
2159
2188
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack1',
2160
 
    help='New in 0.92: Pack-based format with data compatible with '
2161
 
        'dirstate-tags format repositories. Interoperates with '
2162
 
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
 
2189
    help='Pack-based format used in 1.x series. Introduced in 0.92. '
 
2190
        'Interoperates with bzr repositories before 0.92 but cannot be '
 
2191
        'read by bzr < 0.92. '
2163
2192
        ,
2164
2193
    branch_format='bzrlib.branch.BzrBranchFormat6',
2165
2194
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2195
    deprecated=True,
2166
2196
    )
2167
2197
register_metadir(controldir.format_registry, 'pack-0.92-subtree',
2168
2198
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack3',
2169
 
    help='New in 0.92: Pack-based format with data compatible with '
2170
 
        'dirstate-with-subtree format repositories. Interoperates with '
 
2199
    help='Pack-based format used in 1.x series, with subtree support. '
 
2200
        'Introduced in 0.92. Interoperates with '
2171
2201
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2172
2202
        ,
2173
2203
    branch_format='bzrlib.branch.BzrBranchFormat6',
2174
2204
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2175
2205
    hidden=True,
 
2206
    deprecated=True,
2176
2207
    experimental=True,
2177
2208
    )
2178
2209
register_metadir(controldir.format_registry, 'rich-root-pack',
2179
2210
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack4',
2180
 
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
2181
 
         '(needed for bzr-svn and bzr-git).',
 
2211
    help='A variant of pack-0.92 that supports rich-root data '
 
2212
         '(needed for bzr-svn and bzr-git). Introduced in 1.0.',
2182
2213
    branch_format='bzrlib.branch.BzrBranchFormat6',
2183
2214
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2184
2215
    hidden=True,
 
2216
    deprecated=True,
2185
2217
    )
2186
2218
register_metadir(controldir.format_registry, '1.6',
2187
2219
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5',
2191
2223
    branch_format='bzrlib.branch.BzrBranchFormat7',
2192
2224
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2193
2225
    hidden=True,
 
2226
    deprecated=True,
2194
2227
    )
2195
2228
register_metadir(controldir.format_registry, '1.6.1-rich-root',
2196
2229
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5RichRoot',
2199
2232
    branch_format='bzrlib.branch.BzrBranchFormat7',
2200
2233
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2201
2234
    hidden=True,
 
2235
    deprecated=True,
2202
2236
    )
2203
2237
register_metadir(controldir.format_registry, '1.9',
2204
2238
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
2208
2242
    branch_format='bzrlib.branch.BzrBranchFormat7',
2209
2243
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2210
2244
    hidden=True,
 
2245
    deprecated=True,
2211
2246
    )
2212
2247
register_metadir(controldir.format_registry, '1.9-rich-root',
2213
2248
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
2216
2251
    branch_format='bzrlib.branch.BzrBranchFormat7',
2217
2252
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2218
2253
    hidden=True,
 
2254
    deprecated=True,
2219
2255
    )
2220
2256
register_metadir(controldir.format_registry, '1.14',
2221
2257
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
2222
2258
    help='A working-tree format that supports content filtering.',
2223
2259
    branch_format='bzrlib.branch.BzrBranchFormat7',
2224
2260
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
 
2261
    hidden=True,
 
2262
    deprecated=True,
2225
2263
    )
2226
2264
register_metadir(controldir.format_registry, '1.14-rich-root',
2227
2265
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
2229
2267
         '(needed for bzr-svn and bzr-git).',
2230
2268
    branch_format='bzrlib.branch.BzrBranchFormat7',
2231
2269
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
 
2270
    hidden=True,
 
2271
    deprecated=True,
2232
2272
    )
2233
2273
# The following un-numbered 'development' formats should always just be aliases.
2234
2274
register_metadir(controldir.format_registry, 'development-subtree',
2262
2302
    alias=False,
2263
2303
    )
2264
2304
 
 
2305
register_metadir(controldir.format_registry, 'development-colo',
 
2306
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
 
2307
    help='The 2a format with experimental support for colocated branches.\n',
 
2308
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2309
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
2310
    experimental=True,
 
2311
    bzrdir_format=BzrDirMetaFormat1Colo,
 
2312
    )
 
2313
 
 
2314
 
2265
2315
# And the development formats above will have aliased one of the following:
2266
2316
 
2267
2317
# Finally, the current format.
2268
2318
register_metadir(controldir.format_registry, '2a',
2269
2319
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2270
 
    help='First format for bzr 2.0 series.\n'
 
2320
    help='Format for the bzr 2.0 series.\n'
2271
2321
        'Uses group-compress storage.\n'
2272
2322
        'Provides rich roots which are a one-way transition.\n',
2273
2323
        # 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '