~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Jelmer Vernooij
  • Date: 2016-04-03 16:32:31 UTC
  • mto: This revision was merged to the branch mainline in revision 6617.
  • Revision ID: jelmer@jelmer.uk-20160403163231-h72bo0uyek2gikw0
Don't put French text in doc/en/user-reference when LANGUAGE=fr_CH.UTF_8.

Show diffs side-by-side

added added

removed removed

Lines of Context:
25
25
objects returned.
26
26
"""
27
27
 
 
28
from __future__ import absolute_import
 
29
 
28
30
import sys
29
31
 
30
32
from bzrlib.lazy_import import lazy_import
46
48
    transport as _mod_transport,
47
49
    ui,
48
50
    urlutils,
 
51
    vf_search,
49
52
    win32utils,
50
53
    workingtree_3,
51
54
    workingtree_4,
52
55
    )
 
56
from bzrlib.branchfmt import fullhistory as fullhistorybranch
53
57
from bzrlib.repofmt import knitpack_repo
54
58
from bzrlib.transport import (
55
59
    do_catching_redirections,
56
60
    local,
57
61
    )
 
62
from bzrlib.i18n import gettext
58
63
""")
59
64
 
60
65
from bzrlib.trace import (
65
70
from bzrlib import (
66
71
    config,
67
72
    controldir,
68
 
    hooks,
69
73
    registry,
70
74
    )
71
75
from bzrlib.symbol_versioning import (
74
78
    )
75
79
 
76
80
 
77
 
def extract_format_string(text):
78
 
    """Read a format string from a file.
79
 
 
80
 
    The first line is returned. The other lines can contain
81
 
    optional features. An exception is raised when a
82
 
    required feature is present.
83
 
    """
84
 
    lines = text.splitlines(True)
85
 
    try:
86
 
        firstline = lines.pop(0)
87
 
    except IndexError:
88
 
        raise errors.UnknownFormatError(format=text, kind='')
89
 
    for lineno, line in enumerate(lines):
90
 
        try:
91
 
            (necessity, feature) = line.split(" ", 1)
92
 
        except ValueError:
93
 
            raise errors.ParseFormatError(lineno=lineno+2,
94
 
                line=line, text=text)
95
 
        else:
96
 
            if necessity == "optional":
97
 
                mutter("Ignoring optional feature %s", feature)
98
 
            else:
99
 
                raise errors.MissingFeature(feature)
100
 
    return firstline
101
 
 
102
 
 
103
81
class BzrDir(controldir.ControlDir):
104
82
    """A .bzr control diretory.
105
83
 
226
204
                if (result_repo.user_url == result.user_url
227
205
                    and not require_stacking and
228
206
                    revision_id is not None):
229
 
                    fetch_spec = graph.PendingAncestryResult(
 
207
                    fetch_spec = vf_search.PendingAncestryResult(
230
208
                        [revision_id], local_repo)
231
209
                    result_repo.fetch(local_repo, fetch_spec=fetch_spec)
232
210
                else:
247
225
            # the tree and fail.
248
226
            result.root_transport.local_abspath('.')
249
227
            if result_repo is None or result_repo.make_working_trees():
250
 
                self.open_workingtree().clone(result)
 
228
                self.open_workingtree().clone(result, revision_id=revision_id)
251
229
        except (errors.NoWorkingTree, errors.NotLocalUrl):
252
230
            pass
253
231
        return result
258
236
        t = _mod_transport.get_transport(url)
259
237
        t.ensure_base()
260
238
 
261
 
    @staticmethod
262
 
    def find_bzrdirs(transport, evaluate=None, list_current=None):
263
 
        """Find bzrdirs recursively from current location.
264
 
 
265
 
        This is intended primarily as a building block for more sophisticated
266
 
        functionality, like finding trees under a directory, or finding
267
 
        branches that use a given repository.
268
 
 
269
 
        :param evaluate: An optional callable that yields recurse, value,
270
 
            where recurse controls whether this bzrdir is recursed into
271
 
            and value is the value to yield.  By default, all bzrdirs
272
 
            are recursed into, and the return value is the bzrdir.
273
 
        :param list_current: if supplied, use this function to list the current
274
 
            directory, instead of Transport.list_dir
275
 
        :return: a generator of found bzrdirs, or whatever evaluate returns.
276
 
        """
277
 
        if list_current is None:
278
 
            def list_current(transport):
279
 
                return transport.list_dir('')
280
 
        if evaluate is None:
281
 
            def evaluate(bzrdir):
282
 
                return True, bzrdir
283
 
 
284
 
        pending = [transport]
285
 
        while len(pending) > 0:
286
 
            current_transport = pending.pop()
287
 
            recurse = True
288
 
            try:
289
 
                bzrdir = BzrDir.open_from_transport(current_transport)
290
 
            except (errors.NotBranchError, errors.PermissionDenied):
291
 
                pass
292
 
            else:
293
 
                recurse, value = evaluate(bzrdir)
294
 
                yield value
295
 
            try:
296
 
                subdirs = list_current(current_transport)
297
 
            except (errors.NoSuchFile, errors.PermissionDenied):
298
 
                continue
299
 
            if recurse:
300
 
                for subdir in sorted(subdirs, reverse=True):
301
 
                    pending.append(current_transport.clone(subdir))
302
 
 
303
 
    @staticmethod
304
 
    def find_branches(transport):
305
 
        """Find all branches under a transport.
306
 
 
307
 
        This will find all branches below the transport, including branches
308
 
        inside other branches.  Where possible, it will use
309
 
        Repository.find_branches.
310
 
 
311
 
        To list all the branches that use a particular Repository, see
312
 
        Repository.find_branches
313
 
        """
314
 
        def evaluate(bzrdir):
315
 
            try:
316
 
                repository = bzrdir.open_repository()
317
 
            except errors.NoRepositoryPresent:
318
 
                pass
319
 
            else:
320
 
                return False, ([], repository)
321
 
            return True, (bzrdir.list_branches(), None)
322
 
        ret = []
323
 
        for branches, repo in BzrDir.find_bzrdirs(transport,
324
 
                                                  evaluate=evaluate):
325
 
            if repo is not None:
326
 
                ret.extend(repo.find_branches())
327
 
            if branches is not None:
328
 
                ret.extend(branches)
329
 
        return ret
330
 
 
331
 
    @staticmethod
332
 
    def create_branch_and_repo(base, force_new_repo=False, format=None):
333
 
        """Create a new BzrDir, Branch and Repository at the url 'base'.
334
 
 
335
 
        This will use the current default BzrDirFormat unless one is
336
 
        specified, and use whatever
337
 
        repository format that that uses via bzrdir.create_branch and
338
 
        create_repository. If a shared repository is available that is used
339
 
        preferentially.
340
 
 
341
 
        The created Branch object is returned.
342
 
 
343
 
        :param base: The URL to create the branch at.
344
 
        :param force_new_repo: If True a new repository is always created.
345
 
        :param format: If supplied, the format of branch to create.  If not
346
 
            supplied, the default is used.
347
 
        """
348
 
        bzrdir = BzrDir.create(base, format)
349
 
        bzrdir._find_or_create_repository(force_new_repo)
350
 
        return bzrdir.create_branch()
351
 
 
352
239
    def determine_repository_policy(self, force_new_repo=False, stack_on=None,
353
240
                                    stack_on_pwd=None, require_stacking=False):
354
241
        """Return an object representing a policy to use.
469
356
            location of this control directory.
470
357
        :param create_tree_if_local: If true, a working-tree will be created
471
358
            when working locally.
 
359
        :return: The created control directory
472
360
        """
473
361
        operation = cleanup.OperationWithCleanups(self._sprout)
474
362
        return operation.run(url, revision_id=revision_id,
487
375
        if revision_id is not None:
488
376
            fetch_spec_factory.add_revision_ids([revision_id])
489
377
            fetch_spec_factory.source_branch_stop_revision_id = revision_id
 
378
        if possible_transports is None:
 
379
            possible_transports = []
 
380
        else:
 
381
            possible_transports = list(possible_transports) + [
 
382
                self.root_transport]
490
383
        target_transport = _mod_transport.get_transport(url,
491
384
            possible_transports)
492
385
        target_transport.ensure_base()
493
386
        cloning_format = self.cloning_metadir(stacked)
494
387
        # Create/update the result branch
495
 
        result = cloning_format.initialize_on_transport(target_transport)
 
388
        try:
 
389
            result = controldir.ControlDir.open_from_transport(target_transport)
 
390
        except errors.NotBranchError:
 
391
            result = cloning_format.initialize_on_transport(target_transport)
496
392
        source_branch, source_repository = self._find_source_repo(
497
393
            add_cleanup, source_branch)
498
394
        fetch_spec_factory.source_branch = source_branch
504
400
            stacked_branch_url = None
505
401
        repository_policy = result.determine_repository_policy(
506
402
            force_new_repo, stacked_branch_url, require_stacking=stacked)
507
 
        result_repo, is_new_repo = repository_policy.acquire_repository()
 
403
        result_repo, is_new_repo = repository_policy.acquire_repository(
 
404
            possible_transports=possible_transports)
508
405
        add_cleanup(result_repo.lock_write().unlock)
509
406
        fetch_spec_factory.source_repo = source_repository
510
407
        fetch_spec_factory.target_repo = result_repo
531
428
        mutter("created new branch %r" % (result_branch,))
532
429
 
533
430
        # Create/update the result working tree
534
 
        if (create_tree_if_local and
 
431
        if (create_tree_if_local and not result.has_workingtree() and
535
432
            isinstance(target_transport, local.LocalTransport) and
536
433
            (result_repo is None or result_repo.make_working_trees())):
537
434
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
569
466
                    stacked=stacked)
570
467
        return result
571
468
 
572
 
 
573
 
 
574
 
    @staticmethod
575
 
    def create_branch_convenience(base, force_new_repo=False,
576
 
                                  force_new_tree=None, format=None,
577
 
                                  possible_transports=None):
578
 
        """Create a new BzrDir, Branch and Repository at the url 'base'.
579
 
 
580
 
        This is a convenience function - it will use an existing repository
581
 
        if possible, can be told explicitly whether to create a working tree or
582
 
        not.
583
 
 
584
 
        This will use the current default BzrDirFormat unless one is
585
 
        specified, and use whatever
586
 
        repository format that that uses via bzrdir.create_branch and
587
 
        create_repository. If a shared repository is available that is used
588
 
        preferentially. Whatever repository is used, its tree creation policy
589
 
        is followed.
590
 
 
591
 
        The created Branch object is returned.
592
 
        If a working tree cannot be made due to base not being a file:// url,
593
 
        no error is raised unless force_new_tree is True, in which case no
594
 
        data is created on disk and NotLocalUrl is raised.
595
 
 
596
 
        :param base: The URL to create the branch at.
597
 
        :param force_new_repo: If True a new repository is always created.
598
 
        :param force_new_tree: If True or False force creation of a tree or
599
 
                               prevent such creation respectively.
600
 
        :param format: Override for the bzrdir format to create.
601
 
        :param possible_transports: An optional reusable transports list.
602
 
        """
603
 
        if force_new_tree:
604
 
            # check for non local urls
605
 
            t = _mod_transport.get_transport(base, possible_transports)
606
 
            if not isinstance(t, local.LocalTransport):
607
 
                raise errors.NotLocalUrl(base)
608
 
        bzrdir = BzrDir.create(base, format, possible_transports)
609
 
        repo = bzrdir._find_or_create_repository(force_new_repo)
610
 
        result = bzrdir.create_branch()
611
 
        if force_new_tree or (repo.make_working_trees() and
612
 
                              force_new_tree is None):
613
 
            try:
614
 
                bzrdir.create_workingtree()
615
 
            except errors.NotLocalUrl:
616
 
                pass
617
 
        return result
618
 
 
619
 
    @staticmethod
620
 
    def create_standalone_workingtree(base, format=None):
621
 
        """Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
622
 
 
623
 
        'base' must be a local path or a file:// url.
624
 
 
625
 
        This will use the current default BzrDirFormat unless one is
626
 
        specified, and use whatever
627
 
        repository format that that uses for bzrdirformat.create_workingtree,
628
 
        create_branch and create_repository.
629
 
 
630
 
        :param format: Override for the bzrdir format to create.
631
 
        :return: The WorkingTree object.
632
 
        """
633
 
        t = _mod_transport.get_transport(base)
634
 
        if not isinstance(t, local.LocalTransport):
635
 
            raise errors.NotLocalUrl(base)
636
 
        bzrdir = BzrDir.create_branch_and_repo(base,
637
 
                                               force_new_repo=True,
638
 
                                               format=format).bzrdir
639
 
        return bzrdir.create_workingtree()
640
 
 
641
 
    @deprecated_method(deprecated_in((2, 3, 0)))
642
 
    def generate_backup_name(self, base):
643
 
        return self._available_backup_name(base)
644
 
 
645
469
    def _available_backup_name(self, base):
646
470
        """Find a non-existing backup file name based on base.
647
471
 
660
484
            old_path = self.root_transport.abspath('.bzr')
661
485
            backup_dir = self._available_backup_name('backup.bzr')
662
486
            new_path = self.root_transport.abspath(backup_dir)
663
 
            ui.ui_factory.note('making backup of %s\n  to %s'
664
 
                               % (old_path, new_path,))
 
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')))
665
490
            self.root_transport.copy_tree('.bzr', backup_dir)
666
491
            return (old_path, new_path)
667
492
        finally:
682
507
            try:
683
508
                to_path = '.bzr.retired.%d' % i
684
509
                self.root_transport.rename('.bzr', to_path)
685
 
                note("renamed %s to %s"
686
 
                    % (self.root_transport.abspath('.bzr'), to_path))
 
510
                note(gettext("renamed {0} to {1}").format(
 
511
                    self.root_transport.abspath('.bzr'), to_path))
687
512
                return
688
513
            except (errors.TransportError, IOError, errors.PathError):
689
514
                i += 1
716
541
                return None
717
542
            # find the next containing bzrdir
718
543
            try:
719
 
                found_bzrdir = BzrDir.open_containing_from_transport(
 
544
                found_bzrdir = self.open_containing_from_transport(
720
545
                    next_transport)[0]
721
546
            except errors.NotBranchError:
722
547
                return None
839
664
        # add new tests for it to the appropriate place.
840
665
        return filename == '.bzr' or filename.startswith('.bzr/')
841
666
 
842
 
    @staticmethod
843
 
    def open_unsupported(base):
844
 
        """Open a branch which is not supported."""
845
 
        return BzrDir.open(base, _unsupported=True)
846
 
 
847
 
    @staticmethod
848
 
    def open(base, _unsupported=False, possible_transports=None):
849
 
        """Open an existing bzrdir, rooted at 'base' (url).
850
 
 
851
 
        :param _unsupported: a private parameter to the BzrDir class.
852
 
        """
853
 
        t = _mod_transport.get_transport(base, possible_transports)
854
 
        return BzrDir.open_from_transport(t, _unsupported=_unsupported)
855
 
 
856
 
    @staticmethod
857
 
    def open_from_transport(transport, _unsupported=False,
858
 
                            _server_formats=True):
859
 
        """Open a bzrdir within a particular directory.
860
 
 
861
 
        :param transport: Transport containing the bzrdir.
862
 
        :param _unsupported: private.
863
 
        """
864
 
        for hook in BzrDir.hooks['pre_open']:
865
 
            hook(transport)
866
 
        # Keep initial base since 'transport' may be modified while following
867
 
        # the redirections.
868
 
        base = transport.base
869
 
        def find_format(transport):
870
 
            return transport, controldir.ControlDirFormat.find_format(
871
 
                transport, _server_formats=_server_formats)
872
 
 
873
 
        def redirected(transport, e, redirection_notice):
874
 
            redirected_transport = transport._redirected_to(e.source, e.target)
875
 
            if redirected_transport is None:
876
 
                raise errors.NotBranchError(base)
877
 
            note('%s is%s redirected to %s',
878
 
                 transport.base, e.permanently, redirected_transport.base)
879
 
            return redirected_transport
880
 
 
881
 
        try:
882
 
            transport, format = do_catching_redirections(find_format,
883
 
                                                         transport,
884
 
                                                         redirected)
885
 
        except errors.TooManyRedirections:
886
 
            raise errors.NotBranchError(base)
887
 
 
888
 
        format.check_support_status(_unsupported)
889
 
        return format.open(transport, _found=True)
890
 
 
891
 
    @staticmethod
892
 
    def open_containing(url, possible_transports=None):
893
 
        """Open an existing branch which contains url.
894
 
 
895
 
        :param url: url to search from.
896
 
 
897
 
        See open_containing_from_transport for more detail.
898
 
        """
899
 
        transport = _mod_transport.get_transport(url, possible_transports)
900
 
        return BzrDir.open_containing_from_transport(transport)
901
 
 
902
 
    @staticmethod
903
 
    def open_containing_from_transport(a_transport):
904
 
        """Open an existing branch which contains a_transport.base.
905
 
 
906
 
        This probes for a branch at a_transport, and searches upwards from there.
907
 
 
908
 
        Basically we keep looking up until we find the control directory or
909
 
        run into the root.  If there isn't one, raises NotBranchError.
910
 
        If there is one and it is either an unrecognised format or an unsupported
911
 
        format, UnknownFormatError or UnsupportedFormatError are raised.
912
 
        If there is one, it is returned, along with the unused portion of url.
913
 
 
914
 
        :return: The BzrDir that contains the path, and a Unicode path
915
 
                for the rest of the URL.
916
 
        """
917
 
        # this gets the normalised url back. I.e. '.' -> the full path.
918
 
        url = a_transport.base
919
 
        while True:
920
 
            try:
921
 
                result = BzrDir.open_from_transport(a_transport)
922
 
                return result, urlutils.unescape(a_transport.relpath(url))
923
 
            except errors.NotBranchError, e:
924
 
                pass
925
 
            try:
926
 
                new_t = a_transport.clone('..')
927
 
            except errors.InvalidURLJoin:
928
 
                # reached the root, whatever that may be
929
 
                raise errors.NotBranchError(path=url)
930
 
            if new_t.base == a_transport.base:
931
 
                # reached the root, whatever that may be
932
 
                raise errors.NotBranchError(path=url)
933
 
            a_transport = new_t
934
 
 
935
 
    @classmethod
936
 
    def open_tree_or_branch(klass, location):
937
 
        """Return the branch and working tree at a location.
938
 
 
939
 
        If there is no tree at the location, tree will be None.
940
 
        If there is no branch at the location, an exception will be
941
 
        raised
942
 
        :return: (tree, branch)
943
 
        """
944
 
        bzrdir = klass.open(location)
945
 
        return bzrdir._get_tree_branch()
946
 
 
947
 
    @classmethod
948
 
    def open_containing_tree_or_branch(klass, location):
949
 
        """Return the branch and working tree contained by a location.
950
 
 
951
 
        Returns (tree, branch, relpath).
952
 
        If there is no tree at containing the location, tree will be None.
953
 
        If there is no branch containing the location, an exception will be
954
 
        raised
955
 
        relpath is the portion of the path that is contained by the branch.
956
 
        """
957
 
        bzrdir, relpath = klass.open_containing(location)
958
 
        tree, branch = bzrdir._get_tree_branch()
959
 
        return tree, branch, relpath
960
 
 
961
 
    @classmethod
962
 
    def open_containing_tree_branch_or_repository(klass, location):
963
 
        """Return the working tree, branch and repo contained by a location.
964
 
 
965
 
        Returns (tree, branch, repository, relpath).
966
 
        If there is no tree containing the location, tree will be None.
967
 
        If there is no branch containing the location, branch will be None.
968
 
        If there is no repository containing the location, repository will be
969
 
        None.
970
 
        relpath is the portion of the path that is contained by the innermost
971
 
        BzrDir.
972
 
 
973
 
        If no tree, branch or repository is found, a NotBranchError is raised.
974
 
        """
975
 
        bzrdir, relpath = klass.open_containing(location)
976
 
        try:
977
 
            tree, branch = bzrdir._get_tree_branch()
978
 
        except errors.NotBranchError:
979
 
            try:
980
 
                repo = bzrdir.find_repository()
981
 
                return None, None, repo, relpath
982
 
            except (errors.NoRepositoryPresent):
983
 
                raise errors.NotBranchError(location)
984
 
        return tree, branch, branch.repository, relpath
985
 
 
986
667
    def _cloning_metadir(self):
987
668
        """Produce a metadir suitable for cloning with.
988
669
 
1028
709
 
1029
710
        :require_stacking: If True, non-stackable formats will be upgraded
1030
711
            to similar stackable formats.
1031
 
        :returns: a BzrDirFormat with all component formats either set
 
712
        :returns: a ControlDirFormat with all component formats either set
1032
713
            appropriately or set to None if that component should not be
1033
714
            created.
1034
715
        """
1046
727
            format.require_stacking()
1047
728
        return format
1048
729
 
1049
 
    @classmethod
1050
 
    def create(cls, base, format=None, possible_transports=None):
1051
 
        """Create a new BzrDir at the url 'base'.
1052
 
 
1053
 
        :param format: If supplied, the format of branch to create.  If not
1054
 
            supplied, the default is used.
1055
 
        :param possible_transports: If supplied, a list of transports that
1056
 
            can be reused to share a remote connection.
1057
 
        """
1058
 
        if cls is not BzrDir:
1059
 
            raise AssertionError("BzrDir.create always creates the"
1060
 
                "default format, not one of %r" % cls)
1061
 
        t = _mod_transport.get_transport(base, possible_transports)
1062
 
        t.ensure_base()
1063
 
        if format is None:
1064
 
            format = controldir.ControlDirFormat.get_default_format()
1065
 
        return format.initialize_on_transport(t)
1066
 
 
1067
730
    def get_branch_transport(self, branch_format, name=None):
1068
731
        """Get the transport for use by branch format in this BzrDir.
1069
732
 
1103
766
        """
1104
767
        raise NotImplementedError(self.get_workingtree_transport)
1105
768
 
1106
 
 
1107
 
class BzrDirHooks(hooks.Hooks):
1108
 
    """Hooks for BzrDir operations."""
1109
 
 
1110
 
    def __init__(self):
1111
 
        """Create the default hooks."""
1112
 
        hooks.Hooks.__init__(self, "bzrlib.bzrdir", "BzrDir.hooks")
1113
 
        self.add_hook('pre_open',
1114
 
            "Invoked before attempting to open a BzrDir with the transport "
1115
 
            "that the open will use.", (1, 14))
1116
 
        self.add_hook('post_repo_init',
1117
 
            "Invoked after a repository has been initialized. "
1118
 
            "post_repo_init is called with a "
1119
 
            "bzrlib.bzrdir.RepoInitHookParams.",
1120
 
            (2, 2))
1121
 
 
1122
 
# install the default hooks
1123
 
BzrDir.hooks = BzrDirHooks()
1124
 
 
1125
 
 
1126
 
class RepoInitHookParams(object):
1127
 
    """Object holding parameters passed to `*_repo_init` hooks.
1128
 
 
1129
 
    There are 4 fields that hooks may wish to access:
1130
 
 
1131
 
    :ivar repository: Repository created
1132
 
    :ivar format: Repository format
1133
 
    :ivar bzrdir: The bzrdir for the repository
1134
 
    :ivar shared: The repository is shared
1135
 
    """
1136
 
 
1137
 
    def __init__(self, repository, format, a_bzrdir, shared):
1138
 
        """Create a group of RepoInitHook parameters.
1139
 
 
1140
 
        :param repository: Repository created
1141
 
        :param format: Repository format
1142
 
        :param bzrdir: The bzrdir for the repository
1143
 
        :param shared: The repository is shared
 
769
    @classmethod
 
770
    def create(cls, base, format=None, possible_transports=None):
 
771
        """Create a new BzrDir at the url 'base'.
 
772
 
 
773
        :param format: If supplied, the format of branch to create.  If not
 
774
            supplied, the default is used.
 
775
        :param possible_transports: If supplied, a list of transports that
 
776
            can be reused to share a remote connection.
1144
777
        """
1145
 
        self.repository = repository
1146
 
        self.format = format
1147
 
        self.bzrdir = a_bzrdir
1148
 
        self.shared = shared
1149
 
 
1150
 
    def __eq__(self, other):
1151
 
        return self.__dict__ == other.__dict__
 
778
        if cls is not BzrDir:
 
779
            raise AssertionError("BzrDir.create always creates the "
 
780
                "default format, not one of %r" % cls)
 
781
        return controldir.ControlDir.create(base, format=format,
 
782
                possible_transports=possible_transports)
1152
783
 
1153
784
    def __repr__(self):
1154
 
        if self.repository:
1155
 
            return "<%s for %s>" % (self.__class__.__name__,
1156
 
                self.repository)
1157
 
        else:
1158
 
            return "<%s for %s>" % (self.__class__.__name__,
1159
 
                self.bzrdir)
 
785
        return "<%s at %r>" % (self.__class__.__name__, self.user_url)
 
786
 
 
787
    def update_feature_flags(self, updated_flags):
 
788
        """Update the features required by this bzrdir.
 
789
 
 
790
        :param updated_flags: Dictionary mapping feature names to necessities
 
791
            A necessity can be None to indicate the feature should be removed
 
792
        """
 
793
        self.control_files.lock_write()
 
794
        try:
 
795
            self._format._update_feature_flags(updated_flags)
 
796
            self.transport.put_bytes('branch-format', self._format.as_string())
 
797
        finally:
 
798
            self.control_files.unlock()
1160
799
 
1161
800
 
1162
801
class BzrDirMeta1(BzrDir):
1168
807
    present within a BzrDir.
1169
808
    """
1170
809
 
 
810
    def _get_branch_path(self, name):
 
811
        """Obtain the branch path to use.
 
812
 
 
813
        This uses the API specified branch name first, and then falls back to
 
814
        the branch name specified in the URL. If neither of those is specified,
 
815
        it uses the default branch.
 
816
 
 
817
        :param name: Optional branch name to use
 
818
        :return: Relative path to branch
 
819
        """
 
820
        if name == "":
 
821
            return 'branch'
 
822
        return urlutils.join('branches', name.encode("utf-8"))
 
823
 
 
824
    def _read_branch_list(self):
 
825
        """Read the branch list.
 
826
 
 
827
        :return: List of utf-8 encoded branch names.
 
828
        """
 
829
        try:
 
830
            f = self.control_transport.get('branch-list')
 
831
        except errors.NoSuchFile:
 
832
            return []
 
833
 
 
834
        ret = []
 
835
        try:
 
836
            for name in f:
 
837
                ret.append(name.rstrip("\n"))
 
838
        finally:
 
839
            f.close()
 
840
        return ret
 
841
 
 
842
    def _write_branch_list(self, branches):
 
843
        """Write out the branch list.
 
844
 
 
845
        :param branches: List of utf-8 branch names to write
 
846
        """
 
847
        self.transport.put_bytes('branch-list',
 
848
            "".join([name+"\n" for name in branches]))
 
849
 
 
850
    def __init__(self, _transport, _format):
 
851
        super(BzrDirMeta1, self).__init__(_transport, _format)
 
852
        self.control_files = lockable_files.LockableFiles(
 
853
            self.control_transport, self._format._lock_file_name,
 
854
            self._format._lock_class)
 
855
 
1171
856
    def can_convert_format(self):
1172
857
        """See BzrDir.can_convert_format()."""
1173
858
        return True
1174
859
 
1175
 
    def create_branch(self, name=None, repository=None):
1176
 
        """See BzrDir.create_branch."""
 
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()
1177
865
        return self._format.get_branch_format().initialize(self, name=name,
1178
 
                repository=repository)
 
866
                repository=repository,
 
867
                append_revisions_only=append_revisions_only)
1179
868
 
1180
869
    def destroy_branch(self, name=None):
1181
 
        """See BzrDir.create_branch."""
1182
 
        if name is not None:
1183
 
            raise errors.NoColocatedBranchSupport(self)
1184
 
        self.transport.delete_tree('branch')
 
870
        """See ControlDir.destroy_branch."""
 
871
        if name is None:
 
872
            name = self._get_selected_branch()
 
873
        path = self._get_branch_path(name)
 
874
        if name != "":
 
875
            self.control_files.lock_write()
 
876
            try:
 
877
                branches = self._read_branch_list()
 
878
                try:
 
879
                    branches.remove(name.encode("utf-8"))
 
880
                except ValueError:
 
881
                    raise errors.NotBranchError(name)
 
882
                self._write_branch_list(branches)
 
883
            finally:
 
884
                self.control_files.unlock()
 
885
        try:
 
886
            self.transport.delete_tree(path)
 
887
        except errors.NoSuchFile:
 
888
            raise errors.NotBranchError(path=urlutils.join(self.transport.base,
 
889
                path), bzrdir=self)
1185
890
 
1186
891
    def create_repository(self, shared=False):
1187
892
        """See BzrDir.create_repository."""
1189
894
 
1190
895
    def destroy_repository(self):
1191
896
        """See BzrDir.destroy_repository."""
1192
 
        self.transport.delete_tree('repository')
 
897
        try:
 
898
            self.transport.delete_tree('repository')
 
899
        except errors.NoSuchFile:
 
900
            raise errors.NoRepositoryPresent(self)
1193
901
 
1194
902
    def create_workingtree(self, revision_id=None, from_branch=None,
1195
903
                           accelerator_tree=None, hardlink=False):
1217
925
 
1218
926
        This might be a synthetic object for e.g. RemoteBranch and SVN.
1219
927
        """
1220
 
        from bzrlib.branch import BranchFormat
1221
 
        return BranchFormat.find_format(self, name=name)
 
928
        from bzrlib.branch import BranchFormatMetadir
 
929
        return BranchFormatMetadir.find_format(self, name=name)
1222
930
 
1223
931
    def _get_mkdir_mode(self):
1224
932
        """Figure out the mode to use when creating a bzrdir subdir."""
1228
936
 
1229
937
    def get_branch_reference(self, name=None):
1230
938
        """See BzrDir.get_branch_reference()."""
1231
 
        from bzrlib.branch import BranchFormat
1232
 
        format = BranchFormat.find_format(self, name=name)
 
939
        from bzrlib.branch import BranchFormatMetadir
 
940
        format = BranchFormatMetadir.find_format(self, name=name)
1233
941
        return format.get_reference(self, name=name)
1234
942
 
 
943
    def set_branch_reference(self, target_branch, name=None):
 
944
        format = _mod_branch.BranchReferenceFormat()
 
945
        return format.initialize(self, target_branch=target_branch, name=name)
 
946
 
1235
947
    def get_branch_transport(self, branch_format, name=None):
1236
948
        """See BzrDir.get_branch_transport()."""
1237
 
        if name is not None:
1238
 
            raise errors.NoColocatedBranchSupport(self)
 
949
        if name is None:
 
950
            name = self._get_selected_branch()
 
951
        path = self._get_branch_path(name)
1239
952
        # XXX: this shouldn't implicitly create the directory if it's just
1240
953
        # promising to get a transport -- mbp 20090727
1241
954
        if branch_format is None:
1242
 
            return self.transport.clone('branch')
 
955
            return self.transport.clone(path)
1243
956
        try:
1244
957
            branch_format.get_format_string()
1245
958
        except NotImplementedError:
1246
959
            raise errors.IncompatibleFormat(branch_format, self._format)
 
960
        if name != "":
 
961
            branches = self._read_branch_list()
 
962
            utf8_name = name.encode("utf-8")
 
963
            if not utf8_name in branches:
 
964
                self.control_files.lock_write()
 
965
                try:
 
966
                    branches = self._read_branch_list()
 
967
                    dirname = urlutils.dirname(utf8_name)
 
968
                    if dirname != "" and dirname in branches:
 
969
                        raise errors.ParentBranchExists(name)
 
970
                    child_branches = [
 
971
                        b.startswith(utf8_name+"/") for b in branches]
 
972
                    if any(child_branches):
 
973
                        raise errors.AlreadyBranchError(name)
 
974
                    branches.append(utf8_name)
 
975
                    self._write_branch_list(branches)
 
976
                finally:
 
977
                    self.control_files.unlock()
 
978
        branch_transport = self.transport.clone(path)
 
979
        mode = self._get_mkdir_mode()
 
980
        branch_transport.create_prefix(mode=mode)
1247
981
        try:
1248
 
            self.transport.mkdir('branch', mode=self._get_mkdir_mode())
 
982
            self.transport.mkdir(path, mode=mode)
1249
983
        except errors.FileExists:
1250
984
            pass
1251
 
        return self.transport.clone('branch')
 
985
        return self.transport.clone(path)
1252
986
 
1253
987
    def get_repository_transport(self, repository_format):
1254
988
        """See BzrDir.get_repository_transport()."""
1278
1012
            pass
1279
1013
        return self.transport.clone('checkout')
1280
1014
 
 
1015
    def get_branches(self):
 
1016
        """See ControlDir.get_branches."""
 
1017
        ret = {}
 
1018
        try:
 
1019
            ret[""] = self.open_branch(name="")
 
1020
        except (errors.NotBranchError, errors.NoRepositoryPresent):
 
1021
            pass
 
1022
 
 
1023
        for name in self._read_branch_list():
 
1024
            ret[name] = self.open_branch(name=name.decode('utf-8'))
 
1025
 
 
1026
        return ret
 
1027
 
1281
1028
    def has_workingtree(self):
1282
1029
        """Tell if this bzrdir contains a working tree.
1283
1030
 
1284
1031
        Note: if you're going to open the working tree, you should just go
1285
1032
        ahead and try, and not ask permission first.
1286
1033
        """
1287
 
        from bzrlib.workingtree import WorkingTreeFormat
 
1034
        from bzrlib.workingtree import WorkingTreeFormatMetaDir
1288
1035
        try:
1289
 
            WorkingTreeFormat.find_format_string(self)
 
1036
            WorkingTreeFormatMetaDir.find_format_string(self)
1290
1037
        except errors.NoWorkingTree:
1291
1038
            return False
1292
1039
        return True
1293
1040
 
1294
1041
    def needs_format_conversion(self, format):
1295
1042
        """See BzrDir.needs_format_conversion()."""
1296
 
        if not isinstance(self._format, format.__class__):
 
1043
        if (not isinstance(self._format, format.__class__) or
 
1044
            self._format.get_format_string() != format.get_format_string()):
1297
1045
            # it is not a meta dir format, conversion is needed.
1298
1046
            return True
1299
1047
        # we might want to push this down to the repository?
1320
1068
        return False
1321
1069
 
1322
1070
    def open_branch(self, name=None, unsupported=False,
1323
 
                    ignore_fallbacks=False):
1324
 
        """See BzrDir.open_branch."""
 
1071
                    ignore_fallbacks=False, possible_transports=None):
 
1072
        """See ControlDir.open_branch."""
 
1073
        if name is None:
 
1074
            name = self._get_selected_branch()
1325
1075
        format = self.find_branch_format(name=name)
1326
1076
        format.check_support_status(unsupported)
1327
1077
        return format.open(self, name=name,
1328
 
            _found=True, ignore_fallbacks=ignore_fallbacks)
 
1078
            _found=True, ignore_fallbacks=ignore_fallbacks,
 
1079
            possible_transports=possible_transports)
1329
1080
 
1330
1081
    def open_repository(self, unsupported=False):
1331
1082
        """See BzrDir.open_repository."""
1332
 
        from bzrlib.repository import RepositoryFormat
1333
 
        format = RepositoryFormat.find_format(self)
 
1083
        from bzrlib.repository import RepositoryFormatMetaDir
 
1084
        format = RepositoryFormatMetaDir.find_format(self)
1334
1085
        format.check_support_status(unsupported)
1335
1086
        return format.open(self, _found=True)
1336
1087
 
1337
1088
    def open_workingtree(self, unsupported=False,
1338
1089
            recommend_upgrade=True):
1339
1090
        """See BzrDir.open_workingtree."""
1340
 
        from bzrlib.workingtree import WorkingTreeFormat
1341
 
        format = WorkingTreeFormat.find_format(self)
 
1091
        from bzrlib.workingtree import WorkingTreeFormatMetaDir
 
1092
        format = WorkingTreeFormatMetaDir.find_format(self)
1342
1093
        format.check_support_status(unsupported, recommend_upgrade,
1343
1094
            basedir=self.root_transport.base)
1344
1095
        return format.open(self, _found=True)
1347
1098
        return config.TransportConfig(self.transport, 'control.conf')
1348
1099
 
1349
1100
 
 
1101
class BzrFormat(object):
 
1102
    """Base class for all formats of things living in metadirs.
 
1103
 
 
1104
    This class manages the format string that is stored in the 'format'
 
1105
    or 'branch-format' file.
 
1106
 
 
1107
    All classes for (branch-, repository-, workingtree-) formats that
 
1108
    live in meta directories and have their own 'format' file
 
1109
    (i.e. different from .bzr/branch-format) derive from this class,
 
1110
    as well as the relevant base class for their kind
 
1111
    (BranchFormat, WorkingTreeFormat, RepositoryFormat).
 
1112
 
 
1113
    Each format is identified by a "format" or "branch-format" file with a
 
1114
    single line containing the base format name and then an optional list of
 
1115
    feature flags.
 
1116
 
 
1117
    Feature flags are supported as of bzr 2.5. Setting feature flags on formats
 
1118
    will render them inaccessible to older versions of bzr.
 
1119
 
 
1120
    :ivar features: Dictionary mapping feature names to their necessity
 
1121
    """
 
1122
 
 
1123
    _present_features = set()
 
1124
 
 
1125
    def __init__(self):
 
1126
        self.features = {}
 
1127
 
 
1128
    @classmethod
 
1129
    def register_feature(cls, name):
 
1130
        """Register a feature as being present.
 
1131
 
 
1132
        :param name: Name of the feature
 
1133
        """
 
1134
        if " " in name:
 
1135
            raise ValueError("spaces are not allowed in feature names")
 
1136
        if name in cls._present_features:
 
1137
            raise errors.FeatureAlreadyRegistered(name)
 
1138
        cls._present_features.add(name)
 
1139
 
 
1140
    @classmethod
 
1141
    def unregister_feature(cls, name):
 
1142
        """Unregister a feature."""
 
1143
        cls._present_features.remove(name)
 
1144
 
 
1145
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
1146
            basedir=None):
 
1147
        for name, necessity in self.features.iteritems():
 
1148
            if name in self._present_features:
 
1149
                continue
 
1150
            if necessity == "optional":
 
1151
                mutter("ignoring optional missing feature %s", name)
 
1152
                continue
 
1153
            elif necessity == "required":
 
1154
                raise errors.MissingFeature(name)
 
1155
            else:
 
1156
                mutter("treating unknown necessity as require for %s",
 
1157
                       name)
 
1158
                raise errors.MissingFeature(name)
 
1159
 
 
1160
    @classmethod
 
1161
    def get_format_string(cls):
 
1162
        """Return the ASCII format string that identifies this format."""
 
1163
        raise NotImplementedError(cls.get_format_string)
 
1164
 
 
1165
    @classmethod
 
1166
    def from_string(cls, text):
 
1167
        format_string = cls.get_format_string()
 
1168
        if not text.startswith(format_string):
 
1169
            raise AssertionError("Invalid format header %r for %r" % (text, cls))
 
1170
        lines = text[len(format_string):].splitlines()
 
1171
        ret = cls()
 
1172
        for lineno, line in enumerate(lines):
 
1173
            try:
 
1174
                (necessity, feature) = line.split(" ", 1)
 
1175
            except ValueError:
 
1176
                raise errors.ParseFormatError(format=cls, lineno=lineno+2,
 
1177
                    line=line, text=text)
 
1178
            ret.features[feature] = necessity
 
1179
        return ret
 
1180
 
 
1181
    def as_string(self):
 
1182
        """Return the string representation of this format.
 
1183
        """
 
1184
        lines = [self.get_format_string()]
 
1185
        lines.extend([("%s %s\n" % (item[1], item[0])) for item in
 
1186
            self.features.iteritems()])
 
1187
        return "".join(lines)
 
1188
 
 
1189
    @classmethod
 
1190
    def _find_format(klass, registry, kind, format_string):
 
1191
        try:
 
1192
            first_line = format_string[:format_string.index("\n")+1]
 
1193
        except ValueError:
 
1194
            first_line = format_string
 
1195
        try:
 
1196
            cls = registry.get(first_line)
 
1197
        except KeyError:
 
1198
            raise errors.UnknownFormatError(format=first_line, kind=kind)
 
1199
        return cls.from_string(format_string)
 
1200
 
 
1201
    def network_name(self):
 
1202
        """A simple byte string uniquely identifying this format for RPC calls.
 
1203
 
 
1204
        Metadir branch formats use their format string.
 
1205
        """
 
1206
        return self.as_string()
 
1207
 
 
1208
    def __eq__(self, other):
 
1209
        return (self.__class__ is other.__class__ and
 
1210
                self.features == other.features)
 
1211
 
 
1212
    def _update_feature_flags(self, updated_flags):
 
1213
        """Update the feature flags in this format.
 
1214
 
 
1215
        :param updated_flags: Updated feature flags
 
1216
        """
 
1217
        for name, necessity in updated_flags.iteritems():
 
1218
            if necessity is None:
 
1219
                try:
 
1220
                    del self.features[name]
 
1221
                except KeyError:
 
1222
                    pass
 
1223
            else:
 
1224
                self.features[name] = necessity
 
1225
 
 
1226
 
1350
1227
class BzrProber(controldir.Prober):
1351
1228
    """Prober for formats that use a .bzr/ control directory."""
1352
1229
 
1354
1231
    """The known .bzr formats."""
1355
1232
 
1356
1233
    @classmethod
1357
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1358
 
    def register_bzrdir_format(klass, format):
1359
 
        klass.formats.register(format.get_format_string(), format)
1360
 
 
1361
 
    @classmethod
1362
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1363
 
    def unregister_bzrdir_format(klass, format):
1364
 
        klass.formats.remove(format.get_format_string())
1365
 
 
1366
 
    @classmethod
1367
1234
    def probe_transport(klass, transport):
1368
1235
        """Return the .bzrdir style format present in a directory."""
1369
1236
        try:
1370
1237
            format_string = transport.get_bytes(".bzr/branch-format")
1371
1238
        except errors.NoSuchFile:
1372
1239
            raise errors.NotBranchError(path=transport.base)
1373
 
        format_string = extract_format_string(format_string)
1374
 
        try:
1375
 
            return klass.formats.get(format_string)
 
1240
        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)
1376
1246
        except KeyError:
1377
 
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
 
1247
            raise errors.UnknownFormatError(format=first_line, kind='bzrdir')
 
1248
        return cls.from_string(format_string)
1378
1249
 
1379
1250
    @classmethod
1380
1251
    def known_formats(cls):
1423
1294
        return set([RemoteBzrDirFormat()])
1424
1295
 
1425
1296
 
1426
 
class BzrDirFormat(controldir.ControlDirFormat):
 
1297
class BzrDirFormat(BzrFormat, controldir.ControlDirFormat):
1427
1298
    """ControlDirFormat base class for .bzr/ directories.
1428
1299
 
1429
1300
    Formats are placed in a dict by their format string for reference
1440
1311
    # _lock_class must be set in subclasses to the lock type, typ.
1441
1312
    # TransportLock or LockDir
1442
1313
 
1443
 
    @classmethod
1444
 
    def get_format_string(cls):
1445
 
        """Return the ASCII format string that identifies this format."""
1446
 
        raise NotImplementedError(cls.get_format_string)
1447
 
 
1448
1314
    def initialize_on_transport(self, transport):
1449
1315
        """Initialize a new bzrdir in the base directory of a Transport."""
1450
1316
        try:
1491
1357
        :param shared_repo: Control whether made repositories are shared or
1492
1358
            not.
1493
1359
        :param vfs_only: If True do not attempt to use a smart server
1494
 
        :return: repo, bzrdir, require_stacking, repository_policy. repo is
 
1360
        :return: repo, controldir, require_stacking, repository_policy. repo is
1495
1361
            None if none was created or found, bzrdir is always valid.
1496
1362
            require_stacking is the result of examining the stacked_on
1497
1363
            parameter and any stacking policy found for the target.
1572
1438
        # mode from the root directory
1573
1439
        temp_control = lockable_files.LockableFiles(transport,
1574
1440
                            '', lockable_files.TransportLock)
1575
 
        temp_control._transport.mkdir('.bzr',
1576
 
                                      # FIXME: RBC 20060121 don't peek under
1577
 
                                      # the covers
1578
 
                                      mode=temp_control._dir_mode)
 
1441
        try:
 
1442
            temp_control._transport.mkdir('.bzr',
 
1443
                # FIXME: RBC 20060121 don't peek under
 
1444
                # the covers
 
1445
                mode=temp_control._dir_mode)
 
1446
        except errors.FileExists:
 
1447
            raise errors.AlreadyControlDirError(transport.base)
1579
1448
        if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
1580
1449
            win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1581
1450
        file_mode = temp_control._file_mode
1585
1454
                       "This is a Bazaar control directory.\n"
1586
1455
                       "Do not change any files in this directory.\n"
1587
1456
                       "See http://bazaar.canonical.com/ for more information about Bazaar.\n"),
1588
 
                      ('branch-format', self.get_format_string()),
 
1457
                      ('branch-format', self.as_string()),
1589
1458
                      ]
1590
1459
        # NB: no need to escape relative paths that are url safe.
1591
1460
        control_files = lockable_files.LockableFiles(bzrdir_transport,
1635
1504
            compatible with whatever sub formats are supported by self.
1636
1505
        :return: None.
1637
1506
        """
 
1507
        other_format.features = dict(self.features)
 
1508
 
 
1509
    def supports_transport(self, transport):
 
1510
        # bzr formats can be opened over all known transports
 
1511
        return True
 
1512
 
 
1513
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
1514
            basedir=None):
 
1515
        controldir.ControlDirFormat.check_support_status(self,
 
1516
            allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
 
1517
            basedir=basedir)
 
1518
        BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
 
1519
            recommend_upgrade=recommend_upgrade, basedir=basedir)
1638
1520
 
1639
1521
 
1640
1522
class BzrDirMetaFormat1(BzrDirFormat):
1654
1536
 
1655
1537
    fixed_components = False
1656
1538
 
 
1539
    colocated_branches = True
 
1540
 
1657
1541
    def __init__(self):
 
1542
        BzrDirFormat.__init__(self)
1658
1543
        self._workingtree_format = None
1659
1544
        self._branch_format = None
1660
1545
        self._repository_format = None
1666
1551
            return False
1667
1552
        if other.workingtree_format != self.workingtree_format:
1668
1553
            return False
 
1554
        if other.features != self.features:
 
1555
            return False
1669
1556
        return True
1670
1557
 
1671
1558
    def __ne__(self, other):
1749
1636
                    new_repo_format = None
1750
1637
            if new_repo_format is not None:
1751
1638
                self.repository_format = new_repo_format
1752
 
                note('Source repository format does not support stacking,'
1753
 
                     ' using format:\n  %s',
 
1639
                note(gettext('Source repository format does not support stacking,'
 
1640
                     ' using format:\n  %s'),
1754
1641
                     new_repo_format.get_format_description())
1755
1642
 
1756
1643
        if not self.get_branch_format().supports_stacking():
1769
1656
            if new_branch_format is not None:
1770
1657
                # Does support stacking, use its format.
1771
1658
                self.set_branch_format(new_branch_format)
1772
 
                note('Source branch format does not support stacking,'
1773
 
                     ' using format:\n  %s',
 
1659
                note(gettext('Source branch format does not support stacking,'
 
1660
                     ' using format:\n  %s'),
1774
1661
                     new_branch_format.get_format_description())
1775
1662
 
1776
1663
    def get_converter(self, format=None):
1777
1664
        """See BzrDirFormat.get_converter()."""
1778
1665
        if format is None:
1779
1666
            format = BzrDirFormat.get_default_format()
 
1667
        if (type(self) is BzrDirMetaFormat1 and
 
1668
            type(format) is BzrDirMetaFormat1Colo):
 
1669
            return ConvertMetaToColo(format)
 
1670
        if (type(self) is BzrDirMetaFormat1Colo and
 
1671
            type(format) is BzrDirMetaFormat1):
 
1672
            return ConvertMetaToColo(format)
1780
1673
        if not isinstance(self, format.__class__):
1781
1674
            # converting away from metadir is not implemented
1782
1675
            raise NotImplementedError(self.get_converter)
1791
1684
        """See BzrDirFormat.get_format_description()."""
1792
1685
        return "Meta directory format 1"
1793
1686
 
1794
 
    def network_name(self):
1795
 
        return self.get_format_string()
1796
 
 
1797
1687
    def _open(self, transport):
1798
1688
        """See BzrDirFormat._open."""
1799
1689
        # Create a new format instance because otherwise initialisation of new
1828
1718
            compatible with whatever sub formats are supported by self.
1829
1719
        :return: None.
1830
1720
        """
 
1721
        super(BzrDirMetaFormat1, self)._supply_sub_formats_to(other_format)
1831
1722
        if getattr(self, '_repository_format', None) is not None:
1832
1723
            other_format.repository_format = self.repository_format
1833
1724
        if self._branch_format is not None:
1846
1737
    def __set_workingtree_format(self, wt_format):
1847
1738
        self._workingtree_format = wt_format
1848
1739
 
 
1740
    def __repr__(self):
 
1741
        return "<%r>" % (self.__class__.__name__,)
 
1742
 
1849
1743
    workingtree_format = property(__get_workingtree_format,
1850
1744
                                  __set_workingtree_format)
1851
1745
 
1856
1750
controldir.ControlDirFormat._default_format = BzrDirMetaFormat1()
1857
1751
 
1858
1752
 
 
1753
class BzrDirMetaFormat1Colo(BzrDirMetaFormat1):
 
1754
    """BzrDirMeta1 format with support for colocated branches."""
 
1755
 
 
1756
    colocated_branches = True
 
1757
 
 
1758
    @classmethod
 
1759
    def get_format_string(cls):
 
1760
        """See BzrDirFormat.get_format_string()."""
 
1761
        return "Bazaar meta directory, format 1 (with colocated branches)\n"
 
1762
 
 
1763
    def get_format_description(self):
 
1764
        """See BzrDirFormat.get_format_description()."""
 
1765
        return "Meta directory format 1 with support for colocated branches"
 
1766
 
 
1767
    def _open(self, transport):
 
1768
        """See BzrDirFormat._open."""
 
1769
        # Create a new format instance because otherwise initialisation of new
 
1770
        # metadirs share the global default format object leading to alias
 
1771
        # problems.
 
1772
        format = BzrDirMetaFormat1Colo()
 
1773
        self._supply_sub_formats_to(format)
 
1774
        return BzrDirMeta1(transport, format)
 
1775
 
 
1776
 
 
1777
BzrProber.formats.register(BzrDirMetaFormat1Colo.get_format_string(),
 
1778
    BzrDirMetaFormat1Colo)
 
1779
 
 
1780
 
1859
1781
class ConvertMetaToMeta(controldir.Converter):
1860
1782
    """Converts the components of metadirs."""
1861
1783
 
1880
1802
        else:
1881
1803
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
1882
1804
                from bzrlib.repository import CopyConverter
1883
 
                ui.ui_factory.note('starting repository conversion')
 
1805
                ui.ui_factory.note(gettext('starting repository conversion'))
1884
1806
                converter = CopyConverter(self.target_format.repository_format)
1885
1807
                converter.convert(repo, pb)
1886
1808
        for branch in self.bzrdir.list_branches():
1890
1812
            old = branch._format.__class__
1891
1813
            new = self.target_format.get_branch_format().__class__
1892
1814
            while old != new:
1893
 
                if (old == _mod_branch.BzrBranchFormat5 and
 
1815
                if (old == fullhistorybranch.BzrBranchFormat5 and
1894
1816
                    new in (_mod_branch.BzrBranchFormat6,
1895
1817
                        _mod_branch.BzrBranchFormat7,
1896
1818
                        _mod_branch.BzrBranchFormat8)):
1934
1856
        return to_convert
1935
1857
 
1936
1858
 
 
1859
class ConvertMetaToColo(controldir.Converter):
 
1860
    """Add colocated branch support."""
 
1861
 
 
1862
    def __init__(self, target_format):
 
1863
        """Create a converter.that upgrades a metadir to the colo format.
 
1864
 
 
1865
        :param target_format: The final metadir format that is desired.
 
1866
        """
 
1867
        self.target_format = target_format
 
1868
 
 
1869
    def convert(self, to_convert, pb):
 
1870
        """See Converter.convert()."""
 
1871
        to_convert.transport.put_bytes('branch-format',
 
1872
            self.target_format.as_string())
 
1873
        return BzrDir.open_from_transport(to_convert.root_transport)
 
1874
 
 
1875
 
 
1876
class ConvertMetaToColo(controldir.Converter):
 
1877
    """Convert a 'development-colo' bzrdir to a '2a' bzrdir."""
 
1878
 
 
1879
    def __init__(self, target_format):
 
1880
        """Create a converter that converts a 'development-colo' metadir
 
1881
        to a '2a' metadir.
 
1882
 
 
1883
        :param target_format: The final metadir format that is desired.
 
1884
        """
 
1885
        self.target_format = target_format
 
1886
 
 
1887
    def convert(self, to_convert, pb):
 
1888
        """See Converter.convert()."""
 
1889
        to_convert.transport.put_bytes('branch-format',
 
1890
            self.target_format.as_string())
 
1891
        return BzrDir.open_from_transport(to_convert.root_transport)
 
1892
 
 
1893
 
1937
1894
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
1938
1895
 
1939
1896
 
2016
1973
        else:
2017
1974
            self._require_stacking = True
2018
1975
 
2019
 
    def acquire_repository(self, make_working_trees=None, shared=False):
 
1976
    def acquire_repository(self, make_working_trees=None, shared=False,
 
1977
            possible_transports=None):
2020
1978
        """Acquire a repository for this bzrdir.
2021
1979
 
2022
1980
        Implementations may create a new repository or use a pre-exising
2028
1986
        :return: A repository, is_new_flag (True if the repository was
2029
1987
            created).
2030
1988
        """
2031
 
        raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
 
1989
        raise NotImplementedError(RepositoryAcquisitionPolicy.acquire_repository)
2032
1990
 
2033
1991
 
2034
1992
class CreateRepository(RepositoryAcquisitionPolicy):
2047
2005
                                             require_stacking)
2048
2006
        self._bzrdir = bzrdir
2049
2007
 
2050
 
    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):
2051
2010
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
2052
2011
 
2053
2012
        Creates the desired repository in the bzrdir we already have.
2054
2013
        """
 
2014
        if possible_transports is None:
 
2015
            possible_transports = []
 
2016
        else:
 
2017
            possible_transports = list(possible_transports)
 
2018
        possible_transports.append(self._bzrdir.root_transport)
2055
2019
        stack_on = self._get_full_stack_on()
2056
2020
        if stack_on:
2057
2021
            format = self._bzrdir._format
2058
2022
            format.require_stacking(stack_on=stack_on,
2059
 
                                    possible_transports=[self._bzrdir.root_transport])
 
2023
                                    possible_transports=possible_transports)
2060
2024
            if not self._require_stacking:
2061
2025
                # We have picked up automatic stacking somewhere.
2062
 
                note('Using default stacking branch %s at %s', self._stack_on,
2063
 
                    self._stack_on_pwd)
 
2026
                note(gettext('Using default stacking branch {0} at {1}').format(
 
2027
                    self._stack_on, self._stack_on_pwd))
2064
2028
        repository = self._bzrdir.create_repository(shared=shared)
2065
2029
        self._add_fallback(repository,
2066
 
                           possible_transports=[self._bzrdir.transport])
 
2030
                           possible_transports=possible_transports)
2067
2031
        if make_working_trees is not None:
2068
2032
            repository.set_make_working_trees(make_working_trees)
2069
2033
        return repository, True
2085
2049
                                             require_stacking)
2086
2050
        self._repository = repository
2087
2051
 
2088
 
    def acquire_repository(self, make_working_trees=None, shared=False):
 
2052
    def acquire_repository(self, make_working_trees=None, shared=False,
 
2053
            possible_transports=None):
2089
2054
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
2090
2055
 
2091
2056
        Returns an existing repository to use.
2092
2057
        """
 
2058
        if possible_transports is None:
 
2059
            possible_transports = []
 
2060
        else:
 
2061
            possible_transports = list(possible_transports)
 
2062
        possible_transports.append(self._repository.bzrdir.transport)
2093
2063
        self._add_fallback(self._repository,
2094
 
                       possible_transports=[self._repository.bzrdir.transport])
 
2064
                       possible_transports=possible_transports)
2095
2065
        return self._repository, False
2096
2066
 
2097
2067
 
2101
2071
         tree_format=None,
2102
2072
         hidden=False,
2103
2073
         experimental=False,
2104
 
         alias=False):
 
2074
         alias=False, bzrdir_format=None):
2105
2075
    """Register a metadir subformat.
2106
2076
 
2107
 
    These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2108
 
    by the Repository/Branch/WorkingTreeformats.
 
2077
    These all use a meta bzrdir, but can be parameterized by the
 
2078
    Repository/Branch/WorkingTreeformats.
2109
2079
 
2110
2080
    :param repository_format: The fully-qualified repository format class
2111
2081
        name as a string.
2114
2084
    :param tree_format: Fully-qualified tree format class name as
2115
2085
        a string.
2116
2086
    """
 
2087
    if bzrdir_format is None:
 
2088
        bzrdir_format = BzrDirMetaFormat1
2117
2089
    # This should be expanded to support setting WorkingTree and Branch
2118
 
    # formats, once BzrDirMetaFormat1 supports that.
 
2090
    # formats, once the API supports that.
2119
2091
    def _load(full_name):
2120
2092
        mod_name, factory_name = full_name.rsplit('.', 1)
2121
2093
        try:
2128
2100
        return factory()
2129
2101
 
2130
2102
    def helper():
2131
 
        bd = BzrDirMetaFormat1()
 
2103
        bd = bzrdir_format()
2132
2104
        if branch_format is not None:
2133
2105
            bd.set_branch_format(_load(branch_format))
2134
2106
        if tree_format is not None:
2142
2114
register_metadir(controldir.format_registry, 'knit',
2143
2115
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2144
2116
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
2145
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
2117
    branch_format='bzrlib.branchfmt.fullhistory.BzrBranchFormat5',
2146
2118
    tree_format='bzrlib.workingtree_3.WorkingTreeFormat3',
2147
2119
    hidden=True,
2148
2120
    deprecated=True)
2149
2121
register_metadir(controldir.format_registry, 'dirstate',
2150
2122
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2151
 
    help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2152
 
        'above when accessed over the network.',
2153
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
2123
    help='Format using dirstate for working trees. '
 
2124
        'Compatible with bzr 0.8 and '
 
2125
        'above when accessed over the network. Introduced in bzr 0.15.',
 
2126
    branch_format='bzrlib.branchfmt.fullhistory.BzrBranchFormat5',
2154
2127
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2155
2128
    hidden=True,
2156
2129
    deprecated=True)
2157
2130
register_metadir(controldir.format_registry, 'dirstate-tags',
2158
2131
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2159
 
    help='New in 0.15: Fast local operations and improved scaling for '
2160
 
        'network operations. Additionally adds support for tags.'
2161
 
        ' Incompatible with bzr < 0.15.',
 
2132
    help='Variant of dirstate with support for tags. '
 
2133
        'Introduced in bzr 0.15.',
2162
2134
    branch_format='bzrlib.branch.BzrBranchFormat6',
2163
2135
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2164
2136
    hidden=True,
2165
2137
    deprecated=True)
2166
2138
register_metadir(controldir.format_registry, 'rich-root',
2167
2139
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2168
 
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
2169
 
        ' bzr < 1.0.',
 
2140
    help='Variant of dirstate with better handling of tree roots. '
 
2141
        'Introduced in bzr 1.0',
2170
2142
    branch_format='bzrlib.branch.BzrBranchFormat6',
2171
2143
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2172
2144
    hidden=True,
2173
2145
    deprecated=True)
2174
2146
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
2175
2147
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2176
 
    help='New in 0.15: Fast local operations and improved scaling for '
2177
 
        'network operations. Additionally adds support for versioning nested '
2178
 
        'bzr branches. Incompatible with bzr < 0.15.',
 
2148
    help='Variant of dirstate with support for nested trees. '
 
2149
         'Introduced in 0.15.',
2179
2150
    branch_format='bzrlib.branch.BzrBranchFormat6',
2180
2151
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2181
2152
    experimental=True,
2183
2154
    )
2184
2155
register_metadir(controldir.format_registry, 'pack-0.92',
2185
2156
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack1',
2186
 
    help='New in 0.92: Pack-based format with data compatible with '
2187
 
        'dirstate-tags format repositories. Interoperates with '
2188
 
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
 
2157
    help='Pack-based format used in 1.x series. Introduced in 0.92. '
 
2158
        'Interoperates with bzr repositories before 0.92 but cannot be '
 
2159
        'read by bzr < 0.92. '
2189
2160
        ,
2190
2161
    branch_format='bzrlib.branch.BzrBranchFormat6',
2191
2162
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
 
2163
    deprecated=True,
2192
2164
    )
2193
2165
register_metadir(controldir.format_registry, 'pack-0.92-subtree',
2194
2166
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack3',
2195
 
    help='New in 0.92: Pack-based format with data compatible with '
2196
 
        'dirstate-with-subtree format repositories. Interoperates with '
 
2167
    help='Pack-based format used in 1.x series, with subtree support. '
 
2168
        'Introduced in 0.92. Interoperates with '
2197
2169
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2198
2170
        ,
2199
2171
    branch_format='bzrlib.branch.BzrBranchFormat6',
2200
2172
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2201
2173
    hidden=True,
 
2174
    deprecated=True,
2202
2175
    experimental=True,
2203
2176
    )
2204
2177
register_metadir(controldir.format_registry, 'rich-root-pack',
2205
2178
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack4',
2206
 
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
2207
 
         '(needed for bzr-svn and bzr-git).',
 
2179
    help='A variant of pack-0.92 that supports rich-root data '
 
2180
         '(needed for bzr-svn and bzr-git). Introduced in 1.0.',
2208
2181
    branch_format='bzrlib.branch.BzrBranchFormat6',
2209
2182
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2210
2183
    hidden=True,
 
2184
    deprecated=True,
2211
2185
    )
2212
2186
register_metadir(controldir.format_registry, '1.6',
2213
2187
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5',
2217
2191
    branch_format='bzrlib.branch.BzrBranchFormat7',
2218
2192
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2219
2193
    hidden=True,
 
2194
    deprecated=True,
2220
2195
    )
2221
2196
register_metadir(controldir.format_registry, '1.6.1-rich-root',
2222
2197
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack5RichRoot',
2225
2200
    branch_format='bzrlib.branch.BzrBranchFormat7',
2226
2201
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2227
2202
    hidden=True,
 
2203
    deprecated=True,
2228
2204
    )
2229
2205
register_metadir(controldir.format_registry, '1.9',
2230
2206
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
2234
2210
    branch_format='bzrlib.branch.BzrBranchFormat7',
2235
2211
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2236
2212
    hidden=True,
 
2213
    deprecated=True,
2237
2214
    )
2238
2215
register_metadir(controldir.format_registry, '1.9-rich-root',
2239
2216
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
2242
2219
    branch_format='bzrlib.branch.BzrBranchFormat7',
2243
2220
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
2244
2221
    hidden=True,
 
2222
    deprecated=True,
2245
2223
    )
2246
2224
register_metadir(controldir.format_registry, '1.14',
2247
2225
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6',
2248
2226
    help='A working-tree format that supports content filtering.',
2249
2227
    branch_format='bzrlib.branch.BzrBranchFormat7',
2250
2228
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
 
2229
    hidden=True,
 
2230
    deprecated=True,
2251
2231
    )
2252
2232
register_metadir(controldir.format_registry, '1.14-rich-root',
2253
2233
    'bzrlib.repofmt.knitpack_repo.RepositoryFormatKnitPack6RichRoot',
2255
2235
         '(needed for bzr-svn and bzr-git).',
2256
2236
    branch_format='bzrlib.branch.BzrBranchFormat7',
2257
2237
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
 
2238
    hidden=True,
 
2239
    deprecated=True,
2258
2240
    )
2259
2241
# The following un-numbered 'development' formats should always just be aliases.
2260
2242
register_metadir(controldir.format_registry, 'development-subtree',
2288
2270
    alias=False,
2289
2271
    )
2290
2272
 
 
2273
register_metadir(controldir.format_registry, 'development-colo',
 
2274
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
 
2275
    help='The 2a format with experimental support for colocated branches.\n',
 
2276
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2277
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
2278
    experimental=True,
 
2279
    bzrdir_format=BzrDirMetaFormat1Colo,
 
2280
    )
 
2281
 
 
2282
 
2291
2283
# And the development formats above will have aliased one of the following:
2292
2284
 
2293
2285
# Finally, the current format.
2294
2286
register_metadir(controldir.format_registry, '2a',
2295
2287
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
2296
 
    help='First format for bzr 2.0 series.\n'
 
2288
    help='Format for the bzr 2.0 series.\n'
2297
2289
        'Uses group-compress storage.\n'
2298
2290
        'Provides rich roots which are a one-way transition.\n',
2299
2291
        # 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
2314
2306
    help='Same as 2a.')
2315
2307
 
2316
2308
# The current format that is made on 'bzr init'.
2317
 
format_name = config.GlobalConfig().get_user_option('default_format')
2318
 
if format_name is None:
2319
 
    controldir.format_registry.set_default('2a')
2320
 
else:
2321
 
    controldir.format_registry.set_default(format_name)
 
2309
format_name = config.GlobalStack().get('default_format')
 
2310
controldir.format_registry.set_default(format_name)
2322
2311
 
2323
2312
# XXX 2010-08-20 JRV: There is still a lot of code relying on
2324
2313
# bzrlib.bzrdir.format_registry existing. When BzrDir.create/BzrDir.open/etc