/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Jelmer Vernooij
  • Date: 2011-03-10 17:27:04 UTC
  • mto: (5712.4.8 bzrdir-weave)
  • mto: This revision was merged to the branch mainline in revision 5716.
  • Revision ID: jelmer@samba.org-20110310172704-y54silj998q0wiji
more fixes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/bzrdir.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
34
34
from bzrlib.lazy_import import lazy_import
35
35
lazy_import(globals(), """
36
36
from stat import S_ISDIR
37
 
import textwrap
38
37
 
39
38
import bzrlib
40
39
from bzrlib import (
41
 
    branch,
42
40
    config,
 
41
    controldir,
43
42
    errors,
44
43
    graph,
45
44
    lockable_files,
46
45
    lockdir,
47
46
    osutils,
 
47
    pyutils,
48
48
    remote,
49
49
    repository,
50
50
    revision as _mod_revision,
 
51
    transport as _mod_transport,
51
52
    ui,
52
53
    urlutils,
53
54
    versionedfile,
57
58
    xml4,
58
59
    xml5,
59
60
    )
60
 
from bzrlib.osutils import (
61
 
    sha_string,
62
 
    )
63
 
from bzrlib.push import (
64
 
    PushResult,
65
 
    )
66
61
from bzrlib.repofmt import pack_repo
67
 
from bzrlib.smart.client import _SmartClient
68
 
from bzrlib.store.versioned import WeaveStore
 
62
from bzrlib.store.versioned import VersionedFileStore
69
63
from bzrlib.transactions import WriteTransaction
70
64
from bzrlib.transport import (
71
65
    do_catching_redirections,
72
 
    get_transport,
73
66
    local,
74
67
    )
75
 
from bzrlib.weave import Weave
 
68
from bzrlib.weave import (
 
69
    WeaveFile,
 
70
    Weave,
 
71
    )
76
72
""")
77
73
 
78
74
from bzrlib.trace import (
84
80
from bzrlib import (
85
81
    hooks,
86
82
    registry,
87
 
    symbol_versioning,
88
 
    )
89
 
    
90
 
    
91
 
class ControlComponent(object):
92
 
    """Abstract base class for control directory components.
93
 
    
94
 
    This provides interfaces that are common across bzrdirs, 
95
 
    repositories, branches, and workingtree control directories.
96
 
    
97
 
    They all expose two urls and transports: the *user* URL is the 
98
 
    one that stops above the control directory (eg .bzr) and that 
99
 
    should normally be used in messages, and the *control* URL is
100
 
    under that in eg .bzr/checkout and is used to read the control
101
 
    files.
102
 
    
103
 
    This can be used as a mixin and is intended to fit with 
104
 
    foreign formats.
105
 
    """
106
 
    
107
 
    @property
108
 
    def control_transport(self):
109
 
        raise NotImplementedError
110
 
   
111
 
    @property
112
 
    def control_url(self):
113
 
        return self.control_transport.base
114
 
    
115
 
    @property
116
 
    def user_transport(self):
117
 
        raise NotImplementedError
118
 
        
119
 
    @property
120
 
    def user_url(self):
121
 
        return self.user_transport.base
122
 
    
123
 
 
124
 
class BzrDir(ControlComponent):
 
83
    )
 
84
from bzrlib.symbol_versioning import (
 
85
    deprecated_in,
 
86
    deprecated_method,
 
87
    )
 
88
 
 
89
 
 
90
class BzrDir(controldir.ControlDir):
125
91
    """A .bzr control diretory.
126
92
 
127
93
    BzrDir instances let you create or open any of the things that can be
158
124
                    return
159
125
        thing_to_unlock.break_lock()
160
126
 
161
 
    def can_convert_format(self):
162
 
        """Return true if this bzrdir is one whose format we can convert from."""
163
 
        return True
164
 
 
165
127
    def check_conversion_target(self, target_format):
166
128
        """Check that a bzrdir as a whole can be converted to a new format."""
167
129
        # The only current restriction is that the repository content can be 
202
164
                format.get_format_description(),
203
165
                basedir)
204
166
 
205
 
    def clone(self, url, revision_id=None, force_new_repo=False,
206
 
              preserve_stacking=False):
207
 
        """Clone this bzrdir and its contents to url verbatim.
208
 
 
209
 
        :param url: The url create the clone at.  If url's last component does
210
 
            not exist, it will be created.
211
 
        :param revision_id: The tip revision-id to use for any branch or
212
 
            working tree.  If not None, then the clone operation may tune
213
 
            itself to download less data.
214
 
        :param force_new_repo: Do not use a shared repository for the target
215
 
                               even if one is available.
216
 
        :param preserve_stacking: When cloning a stacked branch, stack the
217
 
            new branch on top of the other branch's stacked-on branch.
218
 
        """
219
 
        return self.clone_on_transport(get_transport(url),
220
 
                                       revision_id=revision_id,
221
 
                                       force_new_repo=force_new_repo,
222
 
                                       preserve_stacking=preserve_stacking)
223
 
 
224
167
    def clone_on_transport(self, transport, revision_id=None,
225
168
        force_new_repo=False, preserve_stacking=False, stacked_on=None,
226
 
        create_prefix=False, use_existing_dir=True):
 
169
        create_prefix=False, use_existing_dir=True, no_tree=False):
227
170
        """Clone this bzrdir and its contents to transport verbatim.
228
171
 
229
172
        :param transport: The transport for the location to produce the clone
238
181
        :param create_prefix: Create any missing directories leading up to
239
182
            to_transport.
240
183
        :param use_existing_dir: Use an existing directory if one exists.
 
184
        :param no_tree: If set to true prevents creation of a working tree.
241
185
        """
242
186
        # Overview: put together a broad description of what we want to end up
243
187
        # with; then make as few api calls as possible to do it.
244
 
        
 
188
 
245
189
        # We may want to create a repo/branch/tree, if we do so what format
246
190
        # would we want for each:
247
191
        require_stacking = (stacked_on is not None)
248
192
        format = self.cloning_metadir(require_stacking)
249
 
        
 
193
 
250
194
        # Figure out what objects we want:
251
195
        try:
252
196
            local_repo = self.find_repository()
271
215
        # we should look up the policy needs first, or just use it as a hint,
272
216
        # or something.
273
217
        if local_repo:
274
 
            make_working_trees = local_repo.make_working_trees()
 
218
            make_working_trees = local_repo.make_working_trees() and not no_tree
275
219
            want_shared = local_repo.is_shared()
276
220
            repo_format_name = format.repository_format.network_name()
277
221
        else:
326
270
    # TODO: This should be given a Transport, and should chdir up; otherwise
327
271
    # this will open a new connection.
328
272
    def _make_tail(self, url):
329
 
        t = get_transport(url)
330
 
        t.ensure_base()
331
 
 
332
 
    @classmethod
333
 
    def create(cls, base, format=None, possible_transports=None):
334
 
        """Create a new BzrDir at the url 'base'.
335
 
 
336
 
        :param format: If supplied, the format of branch to create.  If not
337
 
            supplied, the default is used.
338
 
        :param possible_transports: If supplied, a list of transports that
339
 
            can be reused to share a remote connection.
340
 
        """
341
 
        if cls is not BzrDir:
342
 
            raise AssertionError("BzrDir.create always creates the default"
343
 
                " format, not one of %r" % cls)
344
 
        t = get_transport(base, possible_transports)
345
 
        t.ensure_base()
346
 
        if format is None:
347
 
            format = BzrDirFormat.get_default_format()
348
 
        return format.initialize_on_transport(t)
 
273
        t = _mod_transport.get_transport(url)
 
274
        t.ensure_base()
349
275
 
350
276
    @staticmethod
351
277
    def find_bzrdirs(transport, evaluate=None, list_current=None):
375
301
            recurse = True
376
302
            try:
377
303
                bzrdir = BzrDir.open_from_transport(current_transport)
378
 
            except errors.NotBranchError:
 
304
            except (errors.NotBranchError, errors.PermissionDenied):
379
305
                pass
380
306
            else:
381
307
                recurse, value = evaluate(bzrdir)
382
308
                yield value
383
309
            try:
384
310
                subdirs = list_current(current_transport)
385
 
            except errors.NoSuchFile:
 
311
            except (errors.NoSuchFile, errors.PermissionDenied):
386
312
                continue
387
313
            if recurse:
388
314
                for subdir in sorted(subdirs, reverse=True):
389
315
                    pending.append(current_transport.clone(subdir))
390
316
 
391
 
    def list_branches(self):
392
 
        """Return a sequence of all branches local to this control directory.
393
 
 
394
 
        """
395
 
        try:
396
 
            return [self.open_branch()]
397
 
        except errors.NotBranchError:
398
 
            return []
399
 
 
400
317
    @staticmethod
401
318
    def find_branches(transport):
402
319
        """Find all branches under a transport.
425
342
                ret.extend(branches)
426
343
        return ret
427
344
 
428
 
    def destroy_repository(self):
429
 
        """Destroy the repository in this BzrDir"""
430
 
        raise NotImplementedError(self.destroy_repository)
431
 
 
432
 
    def create_branch(self, name=None):
433
 
        """Create a branch in this BzrDir.
434
 
 
435
 
        :param name: Name of the colocated branch to create, None for
436
 
            the default branch.
437
 
 
438
 
        The bzrdir's format will control what branch format is created.
439
 
        For more control see BranchFormatXX.create(a_bzrdir).
440
 
        """
441
 
        raise NotImplementedError(self.create_branch)
442
 
 
443
 
    def destroy_branch(self, name=None):
444
 
        """Destroy a branch in this BzrDir.
445
 
        
446
 
        :param name: Name of the branch to destroy, None for the default 
447
 
            branch.
448
 
        """
449
 
        raise NotImplementedError(self.destroy_branch)
450
 
 
451
345
    @staticmethod
452
346
    def create_branch_and_repo(base, force_new_repo=False, format=None):
453
347
        """Create a new BzrDir, Branch and Repository at the url 'base'.
566
460
        """
567
461
        if force_new_tree:
568
462
            # check for non local urls
569
 
            t = get_transport(base, possible_transports)
 
463
            t = _mod_transport.get_transport(base, possible_transports)
570
464
            if not isinstance(t, local.LocalTransport):
571
465
                raise errors.NotLocalUrl(base)
572
466
        bzrdir = BzrDir.create(base, format, possible_transports)
594
488
        :param format: Override for the bzrdir format to create.
595
489
        :return: The WorkingTree object.
596
490
        """
597
 
        t = get_transport(base)
 
491
        t = _mod_transport.get_transport(base)
598
492
        if not isinstance(t, local.LocalTransport):
599
493
            raise errors.NotLocalUrl(base)
600
494
        bzrdir = BzrDir.create_branch_and_repo(base,
602
496
                                               format=format).bzrdir
603
497
        return bzrdir.create_workingtree()
604
498
 
605
 
    def create_workingtree(self, revision_id=None, from_branch=None,
606
 
        accelerator_tree=None, hardlink=False):
607
 
        """Create a working tree at this BzrDir.
608
 
 
609
 
        :param revision_id: create it as of this revision id.
610
 
        :param from_branch: override bzrdir branch (for lightweight checkouts)
611
 
        :param accelerator_tree: A tree which can be used for retrieving file
612
 
            contents more quickly than the revision tree, i.e. a workingtree.
613
 
            The revision tree will be used for cases where accelerator_tree's
614
 
            content is different.
 
499
    @deprecated_method(deprecated_in((2, 3, 0)))
 
500
    def generate_backup_name(self, base):
 
501
        return self._available_backup_name(base)
 
502
 
 
503
    def _available_backup_name(self, base):
 
504
        """Find a non-existing backup file name based on base.
 
505
 
 
506
        See bzrlib.osutils.available_backup_name about race conditions.
615
507
        """
616
 
        raise NotImplementedError(self.create_workingtree)
 
508
        return osutils.available_backup_name(base, self.root_transport.has)
617
509
 
618
510
    def backup_bzrdir(self):
619
511
        """Backup this bzr control directory.
620
512
 
621
513
        :return: Tuple with old path name and new path name
622
514
        """
623
 
        def name_gen(base='backup.bzr'):
624
 
            counter = 1
625
 
            name = "%s.~%d~" % (base, counter)
626
 
            while self.root_transport.has(name):
627
 
                counter += 1
628
 
                name = "%s.~%d~" % (base, counter)
629
 
            return name
630
515
 
631
 
        backup_dir=name_gen()
632
516
        pb = ui.ui_factory.nested_progress_bar()
633
517
        try:
634
 
            # FIXME: bug 300001 -- the backup fails if the backup directory
635
 
            # already exists, but it should instead either remove it or make
636
 
            # a new backup directory.
637
 
            #
638
518
            old_path = self.root_transport.abspath('.bzr')
 
519
            backup_dir = self._available_backup_name('backup.bzr')
639
520
            new_path = self.root_transport.abspath(backup_dir)
640
 
            ui.ui_factory.note('making backup of %s\n  to %s' % (old_path, new_path,))
 
521
            ui.ui_factory.note('making backup of %s\n  to %s'
 
522
                               % (old_path, new_path,))
641
523
            self.root_transport.copy_tree('.bzr', backup_dir)
642
524
            return (old_path, new_path)
643
525
        finally:
668
550
                else:
669
551
                    pass
670
552
 
671
 
    def destroy_workingtree(self):
672
 
        """Destroy the working tree at this BzrDir.
673
 
 
674
 
        Formats that do not support this may raise UnsupportedOperation.
675
 
        """
676
 
        raise NotImplementedError(self.destroy_workingtree)
677
 
 
678
 
    def destroy_workingtree_metadata(self):
679
 
        """Destroy the control files for the working tree at this BzrDir.
680
 
 
681
 
        The contents of working tree files are not affected.
682
 
        Formats that do not support this may raise UnsupportedOperation.
683
 
        """
684
 
        raise NotImplementedError(self.destroy_workingtree_metadata)
685
 
 
686
553
    def _find_containing(self, evaluate):
687
554
        """Find something in a containing control directory.
688
555
 
737
604
            raise errors.NoRepositoryPresent(self)
738
605
        return found_repo
739
606
 
740
 
    def get_branch_reference(self):
741
 
        """Return the referenced URL for the branch in this bzrdir.
742
 
 
743
 
        :raises NotBranchError: If there is no Branch.
744
 
        :return: The URL the branch in this bzrdir references if it is a
745
 
            reference branch, or None for regular branches.
746
 
        """
747
 
        return None
748
 
 
749
 
    def get_branch_transport(self, branch_format, name=None):
750
 
        """Get the transport for use by branch format in this BzrDir.
751
 
 
752
 
        Note that bzr dirs that do not support format strings will raise
753
 
        IncompatibleFormat if the branch format they are given has
754
 
        a format string, and vice versa.
755
 
 
756
 
        If branch_format is None, the transport is returned with no
757
 
        checking. If it is not None, then the returned transport is
758
 
        guaranteed to point to an existing directory ready for use.
759
 
        """
760
 
        raise NotImplementedError(self.get_branch_transport)
761
 
 
762
607
    def _find_creation_modes(self):
763
608
        """Determine the appropriate modes for files and directories.
764
609
 
803
648
            self._find_creation_modes()
804
649
        return self._dir_mode
805
650
 
806
 
    def get_repository_transport(self, repository_format):
807
 
        """Get the transport for use by repository format in this BzrDir.
808
 
 
809
 
        Note that bzr dirs that do not support format strings will raise
810
 
        IncompatibleFormat if the repository format they are given has
811
 
        a format string, and vice versa.
812
 
 
813
 
        If repository_format is None, the transport is returned with no
814
 
        checking. If it is not None, then the returned transport is
815
 
        guaranteed to point to an existing directory ready for use.
816
 
        """
817
 
        raise NotImplementedError(self.get_repository_transport)
818
 
 
819
 
    def get_workingtree_transport(self, tree_format):
820
 
        """Get the transport for use by workingtree format in this BzrDir.
821
 
 
822
 
        Note that bzr dirs that do not support format strings will raise
823
 
        IncompatibleFormat if the workingtree format they are given has a
824
 
        format string, and vice versa.
825
 
 
826
 
        If workingtree_format is None, the transport is returned with no
827
 
        checking. If it is not None, then the returned transport is
828
 
        guaranteed to point to an existing directory ready for use.
829
 
        """
830
 
        raise NotImplementedError(self.get_workingtree_transport)
831
 
 
832
651
    def get_config(self):
833
652
        """Get configuration for this BzrDir."""
834
653
        return config.BzrDirConfig(self)
852
671
        self.transport = _transport.clone('.bzr')
853
672
        self.root_transport = _transport
854
673
        self._mode_check_done = False
855
 
        
 
674
 
856
675
    @property 
857
676
    def user_transport(self):
858
677
        return self.root_transport
859
 
        
 
678
 
860
679
    @property
861
680
    def control_transport(self):
862
681
        return self.transport
868
687
 
869
688
        This is true IF and ONLY IF the filename is part of the namespace reserved
870
689
        for bzr control dirs. Currently this is the '.bzr' directory in the root
871
 
        of the root_transport. it is expected that plugins will need to extend
872
 
        this in the future - for instance to make bzr talk with svn working
873
 
        trees.
 
690
        of the root_transport. 
874
691
        """
875
692
        # this might be better on the BzrDirFormat class because it refers to
876
693
        # all the possible bzrdir disk formats.
880
697
        # add new tests for it to the appropriate place.
881
698
        return filename == '.bzr' or filename.startswith('.bzr/')
882
699
 
883
 
    def needs_format_conversion(self, format=None):
884
 
        """Return true if this bzrdir needs convert_format run on it.
885
 
 
886
 
        For instance, if the repository format is out of date but the
887
 
        branch and working tree are not, this should return True.
888
 
 
889
 
        :param format: Optional parameter indicating a specific desired
890
 
                       format we plan to arrive at.
891
 
        """
892
 
        raise NotImplementedError(self.needs_format_conversion)
893
 
 
894
700
    @staticmethod
895
701
    def open_unsupported(base):
896
702
        """Open a branch which is not supported."""
902
708
 
903
709
        :param _unsupported: a private parameter to the BzrDir class.
904
710
        """
905
 
        t = get_transport(base, possible_transports=possible_transports)
 
711
        t = _mod_transport.get_transport(base, possible_transports)
906
712
        return BzrDir.open_from_transport(t, _unsupported=_unsupported)
907
713
 
908
714
    @staticmethod
919
725
        # the redirections.
920
726
        base = transport.base
921
727
        def find_format(transport):
922
 
            return transport, BzrDirFormat.find_format(
 
728
            return transport, controldir.ControlDirFormat.find_format(
923
729
                transport, _server_formats=_server_formats)
924
730
 
925
731
        def redirected(transport, e, redirection_notice):
940
746
        BzrDir._check_supported(format, _unsupported)
941
747
        return format.open(transport, _found=True)
942
748
 
943
 
    def open_branch(self, name=None, unsupported=False,
944
 
                    ignore_fallbacks=False):
945
 
        """Open the branch object at this BzrDir if one is present.
946
 
 
947
 
        If unsupported is True, then no longer supported branch formats can
948
 
        still be opened.
949
 
 
950
 
        TODO: static convenience version of this?
951
 
        """
952
 
        raise NotImplementedError(self.open_branch)
953
 
 
954
749
    @staticmethod
955
750
    def open_containing(url, possible_transports=None):
956
751
        """Open an existing branch which contains url.
958
753
        :param url: url to search from.
959
754
        See open_containing_from_transport for more detail.
960
755
        """
961
 
        transport = get_transport(url, possible_transports)
 
756
        transport = _mod_transport.get_transport(url, possible_transports)
962
757
        return BzrDir.open_containing_from_transport(transport)
963
758
 
964
759
    @staticmethod
994
789
                raise errors.NotBranchError(path=url)
995
790
            a_transport = new_t
996
791
 
997
 
    def _get_tree_branch(self):
998
 
        """Return the branch and tree, if any, for this bzrdir.
999
 
 
1000
 
        Return None for tree if not present or inaccessible.
1001
 
        Raise NotBranchError if no branch is present.
1002
 
        :return: (tree, branch)
1003
 
        """
1004
 
        try:
1005
 
            tree = self.open_workingtree()
1006
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
1007
 
            tree = None
1008
 
            branch = self.open_branch()
1009
 
        else:
1010
 
            branch = tree.branch
1011
 
        return tree, branch
1012
 
 
1013
792
    @classmethod
1014
793
    def open_tree_or_branch(klass, location):
1015
794
        """Return the branch and working tree at a location.
1061
840
                raise errors.NotBranchError(location)
1062
841
        return tree, branch, branch.repository, relpath
1063
842
 
1064
 
    def open_repository(self, _unsupported=False):
1065
 
        """Open the repository object at this BzrDir if one is present.
1066
 
 
1067
 
        This will not follow the Branch object pointer - it's strictly a direct
1068
 
        open facility. Most client code should use open_branch().repository to
1069
 
        get at a repository.
1070
 
 
1071
 
        :param _unsupported: a private parameter, not part of the api.
1072
 
        TODO: static convenience version of this?
1073
 
        """
1074
 
        raise NotImplementedError(self.open_repository)
1075
 
 
1076
 
    def open_workingtree(self, _unsupported=False,
1077
 
                         recommend_upgrade=True, from_branch=None):
1078
 
        """Open the workingtree object at this BzrDir if one is present.
1079
 
 
1080
 
        :param recommend_upgrade: Optional keyword parameter, when True (the
1081
 
            default), emit through the ui module a recommendation that the user
1082
 
            upgrade the working tree when the workingtree being opened is old
1083
 
            (but still fully supported).
1084
 
        :param from_branch: override bzrdir branch (for lightweight checkouts)
1085
 
        """
1086
 
        raise NotImplementedError(self.open_workingtree)
1087
 
 
1088
 
    def has_branch(self, name=None):
1089
 
        """Tell if this bzrdir contains a branch.
1090
 
 
1091
 
        Note: if you're going to open the branch, you should just go ahead
1092
 
        and try, and not ask permission first.  (This method just opens the
1093
 
        branch and discards it, and that's somewhat expensive.)
1094
 
        """
1095
 
        try:
1096
 
            self.open_branch(name)
1097
 
            return True
1098
 
        except errors.NotBranchError:
1099
 
            return False
1100
 
 
1101
 
    def has_workingtree(self):
1102
 
        """Tell if this bzrdir contains a working tree.
1103
 
 
1104
 
        This will still raise an exception if the bzrdir has a workingtree that
1105
 
        is remote & inaccessible.
1106
 
 
1107
 
        Note: if you're going to open the working tree, you should just go ahead
1108
 
        and try, and not ask permission first.  (This method just opens the
1109
 
        workingtree and discards it, and that's somewhat expensive.)
1110
 
        """
1111
 
        try:
1112
 
            self.open_workingtree(recommend_upgrade=False)
1113
 
            return True
1114
 
        except errors.NoWorkingTree:
1115
 
            return False
1116
 
 
1117
843
    def _cloning_metadir(self):
1118
844
        """Produce a metadir suitable for cloning with.
1119
845
 
1177
903
            format.require_stacking()
1178
904
        return format
1179
905
 
1180
 
    def checkout_metadir(self):
1181
 
        return self.cloning_metadir()
1182
 
 
1183
 
    def sprout(self, url, revision_id=None, force_new_repo=False,
1184
 
               recurse='down', possible_transports=None,
1185
 
               accelerator_tree=None, hardlink=False, stacked=False,
1186
 
               source_branch=None, create_tree_if_local=True):
1187
 
        """Create a copy of this bzrdir prepared for use as a new line of
1188
 
        development.
1189
 
 
1190
 
        If url's last component does not exist, it will be created.
1191
 
 
1192
 
        Attributes related to the identity of the source branch like
1193
 
        branch nickname will be cleaned, a working tree is created
1194
 
        whether one existed before or not; and a local branch is always
1195
 
        created.
1196
 
 
1197
 
        if revision_id is not None, then the clone operation may tune
1198
 
            itself to download less data.
1199
 
        :param accelerator_tree: A tree which can be used for retrieving file
1200
 
            contents more quickly than the revision tree, i.e. a workingtree.
1201
 
            The revision tree will be used for cases where accelerator_tree's
1202
 
            content is different.
1203
 
        :param hardlink: If true, hard-link files from accelerator_tree,
1204
 
            where possible.
1205
 
        :param stacked: If true, create a stacked branch referring to the
1206
 
            location of this control directory.
1207
 
        :param create_tree_if_local: If true, a working-tree will be created
1208
 
            when working locally.
1209
 
        """
1210
 
        target_transport = get_transport(url, possible_transports)
1211
 
        target_transport.ensure_base()
1212
 
        cloning_format = self.cloning_metadir(stacked)
1213
 
        # Create/update the result branch
1214
 
        result = cloning_format.initialize_on_transport(target_transport)
1215
 
        # if a stacked branch wasn't requested, we don't create one
1216
 
        # even if the origin was stacked
1217
 
        stacked_branch_url = None
1218
 
        if source_branch is not None:
1219
 
            if stacked:
1220
 
                stacked_branch_url = self.root_transport.base
1221
 
            source_repository = source_branch.repository
1222
 
        else:
1223
 
            try:
1224
 
                source_branch = self.open_branch()
1225
 
                source_repository = source_branch.repository
1226
 
                if stacked:
1227
 
                    stacked_branch_url = self.root_transport.base
1228
 
            except errors.NotBranchError:
1229
 
                source_branch = None
1230
 
                try:
1231
 
                    source_repository = self.open_repository()
1232
 
                except errors.NoRepositoryPresent:
1233
 
                    source_repository = None
1234
 
        repository_policy = result.determine_repository_policy(
1235
 
            force_new_repo, stacked_branch_url, require_stacking=stacked)
1236
 
        result_repo, is_new_repo = repository_policy.acquire_repository()
1237
 
        if is_new_repo and revision_id is not None and not stacked:
1238
 
            fetch_spec = graph.PendingAncestryResult(
1239
 
                [revision_id], source_repository)
1240
 
        else:
1241
 
            fetch_spec = None
1242
 
        if source_repository is not None:
1243
 
            # Fetch while stacked to prevent unstacked fetch from
1244
 
            # Branch.sprout.
1245
 
            if fetch_spec is None:
1246
 
                result_repo.fetch(source_repository, revision_id=revision_id)
1247
 
            else:
1248
 
                result_repo.fetch(source_repository, fetch_spec=fetch_spec)
1249
 
 
1250
 
        if source_branch is None:
1251
 
            # this is for sprouting a bzrdir without a branch; is that
1252
 
            # actually useful?
1253
 
            # Not especially, but it's part of the contract.
1254
 
            result_branch = result.create_branch()
1255
 
        else:
1256
 
            result_branch = source_branch.sprout(result,
1257
 
                revision_id=revision_id, repository_policy=repository_policy)
1258
 
        mutter("created new branch %r" % (result_branch,))
1259
 
 
1260
 
        # Create/update the result working tree
1261
 
        if (create_tree_if_local and
1262
 
            isinstance(target_transport, local.LocalTransport) and
1263
 
            (result_repo is None or result_repo.make_working_trees())):
1264
 
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1265
 
                hardlink=hardlink)
1266
 
            wt.lock_write()
1267
 
            try:
1268
 
                if wt.path2id('') is None:
1269
 
                    try:
1270
 
                        wt.set_root_id(self.open_workingtree.get_root_id())
1271
 
                    except errors.NoWorkingTree:
1272
 
                        pass
1273
 
            finally:
1274
 
                wt.unlock()
1275
 
        else:
1276
 
            wt = None
1277
 
        if recurse == 'down':
1278
 
            if wt is not None:
1279
 
                basis = wt.basis_tree()
1280
 
                basis.lock_read()
1281
 
                subtrees = basis.iter_references()
1282
 
            elif result_branch is not None:
1283
 
                basis = result_branch.basis_tree()
1284
 
                basis.lock_read()
1285
 
                subtrees = basis.iter_references()
1286
 
            elif source_branch is not None:
1287
 
                basis = source_branch.basis_tree()
1288
 
                basis.lock_read()
1289
 
                subtrees = basis.iter_references()
1290
 
            else:
1291
 
                subtrees = []
1292
 
                basis = None
1293
 
            try:
1294
 
                for path, file_id in subtrees:
1295
 
                    target = urlutils.join(url, urlutils.escape(path))
1296
 
                    sublocation = source_branch.reference_parent(file_id, path)
1297
 
                    sublocation.bzrdir.sprout(target,
1298
 
                        basis.get_reference_revision(file_id, path),
1299
 
                        force_new_repo=force_new_repo, recurse=recurse,
1300
 
                        stacked=stacked)
1301
 
            finally:
1302
 
                if basis is not None:
1303
 
                    basis.unlock()
1304
 
        return result
1305
 
 
1306
 
    def push_branch(self, source, revision_id=None, overwrite=False, 
1307
 
        remember=False, create_prefix=False):
1308
 
        """Push the source branch into this BzrDir."""
1309
 
        br_to = None
1310
 
        # If we can open a branch, use its direct repository, otherwise see
1311
 
        # if there is a repository without a branch.
1312
 
        try:
1313
 
            br_to = self.open_branch()
1314
 
        except errors.NotBranchError:
1315
 
            # Didn't find a branch, can we find a repository?
1316
 
            repository_to = self.find_repository()
1317
 
        else:
1318
 
            # Found a branch, so we must have found a repository
1319
 
            repository_to = br_to.repository
1320
 
 
1321
 
        push_result = PushResult()
1322
 
        push_result.source_branch = source
1323
 
        if br_to is None:
1324
 
            # We have a repository but no branch, copy the revisions, and then
1325
 
            # create a branch.
1326
 
            repository_to.fetch(source.repository, revision_id=revision_id)
1327
 
            br_to = source.clone(self, revision_id=revision_id)
1328
 
            if source.get_push_location() is None or remember:
1329
 
                source.set_push_location(br_to.base)
1330
 
            push_result.stacked_on = None
1331
 
            push_result.branch_push_result = None
1332
 
            push_result.old_revno = None
1333
 
            push_result.old_revid = _mod_revision.NULL_REVISION
1334
 
            push_result.target_branch = br_to
1335
 
            push_result.master_branch = None
1336
 
            push_result.workingtree_updated = False
1337
 
        else:
1338
 
            # We have successfully opened the branch, remember if necessary:
1339
 
            if source.get_push_location() is None or remember:
1340
 
                source.set_push_location(br_to.base)
1341
 
            try:
1342
 
                tree_to = self.open_workingtree()
1343
 
            except errors.NotLocalUrl:
1344
 
                push_result.branch_push_result = source.push(br_to, 
1345
 
                    overwrite, stop_revision=revision_id)
1346
 
                push_result.workingtree_updated = False
1347
 
            except errors.NoWorkingTree:
1348
 
                push_result.branch_push_result = source.push(br_to,
1349
 
                    overwrite, stop_revision=revision_id)
1350
 
                push_result.workingtree_updated = None # Not applicable
1351
 
            else:
1352
 
                tree_to.lock_write()
1353
 
                try:
1354
 
                    push_result.branch_push_result = source.push(
1355
 
                        tree_to.branch, overwrite, stop_revision=revision_id)
1356
 
                    tree_to.update()
1357
 
                finally:
1358
 
                    tree_to.unlock()
1359
 
                push_result.workingtree_updated = True
1360
 
            push_result.old_revno = push_result.branch_push_result.old_revno
1361
 
            push_result.old_revid = push_result.branch_push_result.old_revid
1362
 
            push_result.target_branch = \
1363
 
                push_result.branch_push_result.target_branch
1364
 
        return push_result
 
906
    @classmethod
 
907
    def create(cls, base, format=None, possible_transports=None):
 
908
        """Create a new BzrDir at the url 'base'.
 
909
 
 
910
        :param format: If supplied, the format of branch to create.  If not
 
911
            supplied, the default is used.
 
912
        :param possible_transports: If supplied, a list of transports that
 
913
            can be reused to share a remote connection.
 
914
        """
 
915
        if cls is not BzrDir:
 
916
            raise AssertionError("BzrDir.create always creates the"
 
917
                "default format, not one of %r" % cls)
 
918
        t = _mod_transport.get_transport(base, possible_transports)
 
919
        t.ensure_base()
 
920
        if format is None:
 
921
            format = controldir.ControlDirFormat.get_default_format()
 
922
        return format.initialize_on_transport(t)
 
923
 
 
924
    def get_branch_transport(self, branch_format, name=None):
 
925
        """Get the transport for use by branch format in this BzrDir.
 
926
 
 
927
        Note that bzr dirs that do not support format strings will raise
 
928
        IncompatibleFormat if the branch format they are given has
 
929
        a format string, and vice versa.
 
930
 
 
931
        If branch_format is None, the transport is returned with no
 
932
        checking. If it is not None, then the returned transport is
 
933
        guaranteed to point to an existing directory ready for use.
 
934
        """
 
935
        raise NotImplementedError(self.get_branch_transport)
 
936
 
 
937
    def get_repository_transport(self, repository_format):
 
938
        """Get the transport for use by repository format in this BzrDir.
 
939
 
 
940
        Note that bzr dirs that do not support format strings will raise
 
941
        IncompatibleFormat if the repository format they are given has
 
942
        a format string, and vice versa.
 
943
 
 
944
        If repository_format is None, the transport is returned with no
 
945
        checking. If it is not None, then the returned transport is
 
946
        guaranteed to point to an existing directory ready for use.
 
947
        """
 
948
        raise NotImplementedError(self.get_repository_transport)
 
949
 
 
950
    def get_workingtree_transport(self, tree_format):
 
951
        """Get the transport for use by workingtree format in this BzrDir.
 
952
 
 
953
        Note that bzr dirs that do not support format strings will raise
 
954
        IncompatibleFormat if the workingtree format they are given has a
 
955
        format string, and vice versa.
 
956
 
 
957
        If workingtree_format is None, the transport is returned with no
 
958
        checking. If it is not None, then the returned transport is
 
959
        guaranteed to point to an existing directory ready for use.
 
960
        """
 
961
        raise NotImplementedError(self.get_workingtree_transport)
1365
962
 
1366
963
 
1367
964
class BzrDirHooks(hooks.Hooks):
1437
1034
    def cloning_metadir(self, require_stacking=False):
1438
1035
        """Produce a metadir suitable for cloning with."""
1439
1036
        if require_stacking:
1440
 
            return format_registry.make_bzrdir('1.6')
 
1037
            return controldir.format_registry.make_bzrdir('1.6')
1441
1038
        return self._format.__class__()
1442
1039
 
1443
1040
    def clone(self, url, revision_id=None, force_new_repo=False,
1463
1060
            tree.clone(result)
1464
1061
        return result
1465
1062
 
1466
 
    def create_branch(self, name=None):
 
1063
    def create_branch(self, name=None, repository=None):
1467
1064
        """See BzrDir.create_branch."""
 
1065
        if repository is not None:
 
1066
            raise NotImplementedError(
 
1067
                "create_branch(repository=<not None>) on %r" % (self,))
1468
1068
        return self._format.get_branch_format().initialize(self, name=name)
1469
1069
 
1470
1070
    def destroy_branch(self, name=None):
1511
1111
        return result
1512
1112
 
1513
1113
    def _init_workingtree(self):
1514
 
        from bzrlib.workingtree import WorkingTreeFormat2
 
1114
        from bzrlib.workingtree_2 import WorkingTreeFormat2
1515
1115
        try:
1516
1116
            return WorkingTreeFormat2().initialize(self)
1517
1117
        except errors.NotLocalUrl:
1561
1161
            return self.transport
1562
1162
        raise errors.IncompatibleFormat(workingtree_format, self._format)
1563
1163
 
1564
 
    def needs_format_conversion(self, format=None):
 
1164
    def needs_format_conversion(self, format):
1565
1165
        """See BzrDir.needs_format_conversion()."""
1566
 
        # if the format is not the same as the system default,
1567
 
        # an upgrade is needed.
1568
 
        if format is None:
1569
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1570
 
                % 'needs_format_conversion(format=None)')
1571
 
            format = BzrDirFormat.get_default_format()
1572
1166
        return not isinstance(self._format, format.__class__)
1573
1167
 
1574
1168
    def open_branch(self, name=None, unsupported=False,
1575
1169
                    ignore_fallbacks=False):
1576
1170
        """See BzrDir.open_branch."""
1577
 
        from bzrlib.branch import BzrBranchFormat4
 
1171
        from bzrlib.branch_weave import BzrBranchFormat4
1578
1172
        format = BzrBranchFormat4()
1579
1173
        self._check_supported(format, unsupported)
1580
1174
        return format.open(self, name, _found=True)
1596
1190
        if not create_tree_if_local:
1597
1191
            raise errors.MustHaveWorkingTree(
1598
1192
                self._format, self.root_transport.base)
1599
 
        from bzrlib.workingtree import WorkingTreeFormat2
 
1193
        from bzrlib.workingtree_2 import WorkingTreeFormat2
1600
1194
        self._make_tail(url)
1601
1195
        result = self._format._initialize_for_clone(url)
1602
1196
        try:
1625
1219
        """See BzrDir.create_repository."""
1626
1220
        return self._format.repository_format.initialize(self, shared)
1627
1221
 
1628
 
    def needs_format_conversion(self, format=None):
 
1222
    def needs_format_conversion(self, format):
1629
1223
        """Format 4 dirs are always in need of conversion."""
1630
 
        if format is None:
1631
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1632
 
                % 'needs_format_conversion(format=None)')
1633
1224
        return True
1634
1225
 
1635
1226
    def open_repository(self):
1656
1247
    def open_workingtree(self, _unsupported=False,
1657
1248
            recommend_upgrade=True):
1658
1249
        """See BzrDir.create_workingtree."""
1659
 
        from bzrlib.workingtree import WorkingTreeFormat2
 
1250
        from bzrlib.workingtree_2 import WorkingTreeFormat2
1660
1251
        wt_format = WorkingTreeFormat2()
1661
1252
        # we don't warn here about upgrades; that ought to be handled for the
1662
1253
        # bzrdir as a whole
1683
1274
        """See BzrDir.create_workingtree."""
1684
1275
        # we don't warn here about upgrades; that ought to be handled for the
1685
1276
        # bzrdir as a whole
1686
 
        from bzrlib.workingtree import WorkingTreeFormat2
 
1277
        from bzrlib.workingtree_2 import WorkingTreeFormat2
1687
1278
        return WorkingTreeFormat2().open(self, _found=True)
1688
1279
 
1689
1280
 
1700
1291
        """See BzrDir.can_convert_format()."""
1701
1292
        return True
1702
1293
 
1703
 
    def create_branch(self, name=None):
 
1294
    def create_branch(self, name=None, repository=None):
1704
1295
        """See BzrDir.create_branch."""
1705
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1296
        return self._format.get_branch_format().initialize(self, name=name,
 
1297
                repository=repository)
1706
1298
 
1707
1299
    def destroy_branch(self, name=None):
1708
1300
        """See BzrDir.create_branch."""
1730
1322
        wt = self.open_workingtree(recommend_upgrade=False)
1731
1323
        repository = wt.branch.repository
1732
1324
        empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1733
 
        wt.revert(old_tree=empty)
 
1325
        # We ignore the conflicts returned by wt.revert since we're about to
 
1326
        # delete the wt metadata anyway, all that should be left here are
 
1327
        # detritus. But see bug #634470 about subtree .bzr dirs.
 
1328
        conflicts = wt.revert(old_tree=empty)
1734
1329
        self.destroy_workingtree_metadata()
1735
1330
 
1736
1331
    def destroy_workingtree_metadata(self):
1737
1332
        self.transport.delete_tree('checkout')
1738
1333
 
1739
 
    def find_branch_format(self):
 
1334
    def find_branch_format(self, name=None):
1740
1335
        """Find the branch 'format' for this bzrdir.
1741
1336
 
1742
1337
        This might be a synthetic object for e.g. RemoteBranch and SVN.
1743
1338
        """
1744
1339
        from bzrlib.branch import BranchFormat
1745
 
        return BranchFormat.find_format(self)
 
1340
        return BranchFormat.find_format(self, name=name)
1746
1341
 
1747
1342
    def _get_mkdir_mode(self):
1748
1343
        """Figure out the mode to use when creating a bzrdir subdir."""
1750
1345
                                     lockable_files.TransportLock)
1751
1346
        return temp_control._dir_mode
1752
1347
 
1753
 
    def get_branch_reference(self):
 
1348
    def get_branch_reference(self, name=None):
1754
1349
        """See BzrDir.get_branch_reference()."""
1755
1350
        from bzrlib.branch import BranchFormat
1756
 
        format = BranchFormat.find_format(self)
1757
 
        return format.get_reference(self)
 
1351
        format = BranchFormat.find_format(self, name=name)
 
1352
        return format.get_reference(self, name=name)
1758
1353
 
1759
1354
    def get_branch_transport(self, branch_format, name=None):
1760
1355
        """See BzrDir.get_branch_transport()."""
1818
1413
            return False
1819
1414
        return True
1820
1415
 
1821
 
    def needs_format_conversion(self, format=None):
 
1416
    def needs_format_conversion(self, format):
1822
1417
        """See BzrDir.needs_format_conversion()."""
1823
 
        if format is None:
1824
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1825
 
                % 'needs_format_conversion(format=None)')
1826
 
        if format is None:
1827
 
            format = BzrDirFormat.get_default_format()
1828
1418
        if not isinstance(self._format, format.__class__):
1829
1419
            # it is not a meta dir format, conversion is needed.
1830
1420
            return True
1854
1444
    def open_branch(self, name=None, unsupported=False,
1855
1445
                    ignore_fallbacks=False):
1856
1446
        """See BzrDir.open_branch."""
1857
 
        format = self.find_branch_format()
 
1447
        format = self.find_branch_format(name=name)
1858
1448
        self._check_supported(format, unsupported)
1859
1449
        return format.open(self, name=name,
1860
1450
            _found=True, ignore_fallbacks=ignore_fallbacks)
1880
1470
        return config.TransportConfig(self.transport, 'control.conf')
1881
1471
 
1882
1472
 
1883
 
class BzrDirFormat(object):
1884
 
    """An encapsulation of the initialization and open routines for a format.
1885
 
 
1886
 
    Formats provide three things:
1887
 
     * An initialization routine,
1888
 
     * a format string,
1889
 
     * an open routine.
 
1473
class BzrProber(controldir.Prober):
 
1474
    """Prober for formats that use a .bzr/ control directory."""
 
1475
 
 
1476
    formats = registry.FormatRegistry(controldir.network_format_registry)
 
1477
    """The known .bzr formats."""
 
1478
 
 
1479
    @classmethod
 
1480
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1481
    def register_bzrdir_format(klass, format):
 
1482
        klass.formats.register(format.get_format_string(), format)
 
1483
 
 
1484
    @classmethod
 
1485
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1486
    def unregister_bzrdir_format(klass, format):
 
1487
        klass.formats.remove(format.get_format_string())
 
1488
 
 
1489
    @classmethod
 
1490
    def probe_transport(klass, transport):
 
1491
        """Return the .bzrdir style format present in a directory."""
 
1492
        try:
 
1493
            format_string = transport.get_bytes(".bzr/branch-format")
 
1494
        except errors.NoSuchFile:
 
1495
            raise errors.NotBranchError(path=transport.base)
 
1496
        try:
 
1497
            return klass.formats.get(format_string)
 
1498
        except KeyError:
 
1499
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
 
1500
 
 
1501
    @classmethod
 
1502
    def known_formats(cls):
 
1503
        result = set()
 
1504
        for name, format in cls.formats.iteritems():
 
1505
            result.add(format)
 
1506
        return result
 
1507
 
 
1508
 
 
1509
controldir.ControlDirFormat.register_prober(BzrProber)
 
1510
 
 
1511
 
 
1512
class RemoteBzrProber(controldir.Prober):
 
1513
    """Prober for remote servers that provide a Bazaar smart server."""
 
1514
 
 
1515
    @classmethod
 
1516
    def probe_transport(klass, transport):
 
1517
        """Return a RemoteBzrDirFormat object if it looks possible."""
 
1518
        try:
 
1519
            medium = transport.get_smart_medium()
 
1520
        except (NotImplementedError, AttributeError,
 
1521
                errors.TransportNotPossible, errors.NoSmartMedium,
 
1522
                errors.SmartProtocolError):
 
1523
            # no smart server, so not a branch for this format type.
 
1524
            raise errors.NotBranchError(path=transport.base)
 
1525
        else:
 
1526
            # Decline to open it if the server doesn't support our required
 
1527
            # version (3) so that the VFS-based transport will do it.
 
1528
            if medium.should_probe():
 
1529
                try:
 
1530
                    server_version = medium.protocol_version()
 
1531
                except errors.SmartProtocolError:
 
1532
                    # Apparently there's no usable smart server there, even though
 
1533
                    # the medium supports the smart protocol.
 
1534
                    raise errors.NotBranchError(path=transport.base)
 
1535
                if server_version != '2':
 
1536
                    raise errors.NotBranchError(path=transport.base)
 
1537
            from bzrlib.remote import RemoteBzrDirFormat
 
1538
            return RemoteBzrDirFormat()
 
1539
 
 
1540
    @classmethod
 
1541
    def known_formats(cls):
 
1542
        from bzrlib.remote import RemoteBzrDirFormat
 
1543
        return set([RemoteBzrDirFormat()])
 
1544
 
 
1545
 
 
1546
class BzrDirFormat(controldir.ControlDirFormat):
 
1547
    """ControlDirFormat base class for .bzr/ directories.
1890
1548
 
1891
1549
    Formats are placed in a dict by their format string for reference
1892
1550
    during bzrdir opening. These should be subclasses of BzrDirFormat
1895
1553
    Once a format is deprecated, just deprecate the initialize and open
1896
1554
    methods on the format class. Do not deprecate the object, as the
1897
1555
    object will be created every system load.
1898
 
 
1899
 
    :cvar colocated_branches: Whether this formats supports colocated branches.
1900
 
    """
1901
 
 
1902
 
    _default_format = None
1903
 
    """The default format used for new .bzr dirs."""
1904
 
 
1905
 
    _formats = {}
1906
 
    """The known formats."""
1907
 
 
1908
 
    _control_formats = []
1909
 
    """The registered control formats - .bzr, ....
1910
 
 
1911
 
    This is a list of BzrDirFormat objects.
1912
 
    """
1913
 
 
1914
 
    _control_server_formats = []
1915
 
    """The registered control server formats, e.g. RemoteBzrDirs.
1916
 
 
1917
 
    This is a list of BzrDirFormat objects.
1918
1556
    """
1919
1557
 
1920
1558
    _lock_file_name = 'branch-lock'
1921
1559
 
1922
 
    colocated_branches = False
1923
 
    """Whether co-located branches are supported for this control dir format.
1924
 
    """
1925
 
 
1926
1560
    # _lock_class must be set in subclasses to the lock type, typ.
1927
1561
    # TransportLock or LockDir
1928
1562
 
1929
1563
    @classmethod
1930
 
    def find_format(klass, transport, _server_formats=True):
1931
 
        """Return the format present at transport."""
1932
 
        if _server_formats:
1933
 
            formats = klass._control_server_formats + klass._control_formats
1934
 
        else:
1935
 
            formats = klass._control_formats
1936
 
        for format in formats:
1937
 
            try:
1938
 
                return format.probe_transport(transport)
1939
 
            except errors.NotBranchError:
1940
 
                # this format does not find a control dir here.
1941
 
                pass
1942
 
        raise errors.NotBranchError(path=transport.base)
1943
 
 
1944
 
    @classmethod
1945
 
    def probe_transport(klass, transport):
1946
 
        """Return the .bzrdir style format present in a directory."""
1947
 
        try:
1948
 
            format_string = transport.get_bytes(".bzr/branch-format")
1949
 
        except errors.NoSuchFile:
1950
 
            raise errors.NotBranchError(path=transport.base)
1951
 
 
1952
 
        try:
1953
 
            return klass._formats[format_string]
1954
 
        except KeyError:
1955
 
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1956
 
 
1957
 
    @classmethod
1958
 
    def get_default_format(klass):
1959
 
        """Return the current default format."""
1960
 
        return klass._default_format
1961
 
 
1962
 
    def get_format_string(self):
 
1564
    def get_format_string(cls):
1963
1565
        """Return the ASCII format string that identifies this format."""
1964
1566
        raise NotImplementedError(self.get_format_string)
1965
1567
 
1966
 
    def get_format_description(self):
1967
 
        """Return the short description for this format."""
1968
 
        raise NotImplementedError(self.get_format_description)
1969
 
 
1970
 
    def get_converter(self, format=None):
1971
 
        """Return the converter to use to convert bzrdirs needing converts.
1972
 
 
1973
 
        This returns a bzrlib.bzrdir.Converter object.
1974
 
 
1975
 
        This should return the best upgrader to step this format towards the
1976
 
        current default format. In the case of plugins we can/should provide
1977
 
        some means for them to extend the range of returnable converters.
1978
 
 
1979
 
        :param format: Optional format to override the default format of the
1980
 
                       library.
1981
 
        """
1982
 
        raise NotImplementedError(self.get_converter)
1983
 
 
1984
 
    def initialize(self, url, possible_transports=None):
1985
 
        """Create a bzr control dir at this url and return an opened copy.
1986
 
 
1987
 
        While not deprecated, this method is very specific and its use will
1988
 
        lead to many round trips to setup a working environment. See
1989
 
        initialize_on_transport_ex for a [nearly] all-in-one method.
1990
 
 
1991
 
        Subclasses should typically override initialize_on_transport
1992
 
        instead of this method.
1993
 
        """
1994
 
        return self.initialize_on_transport(get_transport(url,
1995
 
                                                          possible_transports))
1996
 
 
1997
1568
    def initialize_on_transport(self, transport):
1998
1569
        """Initialize a new bzrdir in the base directory of a Transport."""
1999
1570
        try:
2008
1579
            # metadir1
2009
1580
            if type(self) != BzrDirMetaFormat1:
2010
1581
                return self._initialize_on_transport_vfs(transport)
 
1582
            from bzrlib.remote import RemoteBzrDirFormat
2011
1583
            remote_format = RemoteBzrDirFormat()
2012
1584
            self._supply_sub_formats_to(remote_format)
2013
1585
            return remote_format.initialize_on_transport(transport)
2051
1623
            except errors.NoSmartMedium:
2052
1624
                pass
2053
1625
            else:
 
1626
                from bzrlib.remote import RemoteBzrDirFormat
2054
1627
                # TODO: lookup the local format from a server hint.
2055
1628
                remote_dir_format = RemoteBzrDirFormat()
2056
1629
                remote_dir_format._network_name = self.network_name()
2131
1704
        utf8_files = [('README',
2132
1705
                       "This is a Bazaar control directory.\n"
2133
1706
                       "Do not change any files in this directory.\n"
2134
 
                       "See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
 
1707
                       "See http://bazaar.canonical.com/ for more information about Bazaar.\n"),
2135
1708
                      ('branch-format', self.get_format_string()),
2136
1709
                      ]
2137
1710
        # NB: no need to escape relative paths that are url safe.
2147
1720
            control_files.unlock()
2148
1721
        return self.open(transport, _found=True)
2149
1722
 
2150
 
    def is_supported(self):
2151
 
        """Is this format supported?
2152
 
 
2153
 
        Supported formats must be initializable and openable.
2154
 
        Unsupported formats may not support initialization or committing or
2155
 
        some other features depending on the reason for not being supported.
2156
 
        """
2157
 
        return True
2158
 
 
2159
 
    def network_name(self):
2160
 
        """A simple byte string uniquely identifying this format for RPC calls.
2161
 
 
2162
 
        Bzr control formats use thir disk format string to identify the format
2163
 
        over the wire. Its possible that other control formats have more
2164
 
        complex detection requirements, so we permit them to use any unique and
2165
 
        immutable string they desire.
2166
 
        """
2167
 
        raise NotImplementedError(self.network_name)
2168
 
 
2169
 
    def same_model(self, target_format):
2170
 
        return (self.repository_format.rich_root_data ==
2171
 
            target_format.rich_root_data)
2172
 
 
2173
 
    @classmethod
2174
 
    def known_formats(klass):
2175
 
        """Return all the known formats.
2176
 
 
2177
 
        Concrete formats should override _known_formats.
2178
 
        """
2179
 
        # There is double indirection here to make sure that control
2180
 
        # formats used by more than one dir format will only be probed
2181
 
        # once. This can otherwise be quite expensive for remote connections.
2182
 
        result = set()
2183
 
        for format in klass._control_formats:
2184
 
            result.update(format._known_formats())
2185
 
        return result
2186
 
 
2187
 
    @classmethod
2188
 
    def _known_formats(klass):
2189
 
        """Return the known format instances for this control format."""
2190
 
        return set(klass._formats.values())
2191
 
 
2192
1723
    def open(self, transport, _found=False):
2193
1724
        """Return an instance of this format for the dir transport points at.
2194
1725
 
2195
1726
        _found is a private parameter, do not use it.
2196
1727
        """
2197
1728
        if not _found:
2198
 
            found_format = BzrDirFormat.find_format(transport)
 
1729
            found_format = controldir.ControlDirFormat.find_format(transport)
2199
1730
            if not isinstance(found_format, self.__class__):
2200
1731
                raise AssertionError("%s was asked to open %s, but it seems to need "
2201
1732
                        "format %s"
2213
1744
        """
2214
1745
        raise NotImplementedError(self._open)
2215
1746
 
2216
 
    @classmethod
2217
 
    def register_format(klass, format):
2218
 
        klass._formats[format.get_format_string()] = format
2219
 
        # bzr native formats have a network name of their format string.
2220
 
        network_format_registry.register(format.get_format_string(), format.__class__)
2221
 
 
2222
 
    @classmethod
2223
 
    def register_control_format(klass, format):
2224
 
        """Register a format that does not use '.bzr' for its control dir.
2225
 
 
2226
 
        TODO: This should be pulled up into a 'ControlDirFormat' base class
2227
 
        which BzrDirFormat can inherit from, and renamed to register_format
2228
 
        there. It has been done without that for now for simplicity of
2229
 
        implementation.
2230
 
        """
2231
 
        klass._control_formats.append(format)
2232
 
 
2233
 
    @classmethod
2234
 
    def register_control_server_format(klass, format):
2235
 
        """Register a control format for client-server environments.
2236
 
 
2237
 
        These formats will be tried before ones registered with
2238
 
        register_control_format.  This gives implementations that decide to the
2239
 
        chance to grab it before anything looks at the contents of the format
2240
 
        file.
2241
 
        """
2242
 
        klass._control_server_formats.append(format)
2243
 
 
2244
 
    @classmethod
2245
 
    def _set_default_format(klass, format):
2246
 
        """Set default format (for testing behavior of defaults only)"""
2247
 
        klass._default_format = format
2248
 
 
2249
 
    def __str__(self):
2250
 
        # Trim the newline
2251
 
        return self.get_format_description().rstrip()
2252
 
 
2253
1747
    def _supply_sub_formats_to(self, other_format):
2254
1748
        """Give other_format the same values for sub formats as this has.
2255
1749
 
2262
1756
        :return: None.
2263
1757
        """
2264
1758
 
2265
 
    @classmethod
2266
 
    def unregister_format(klass, format):
2267
 
        del klass._formats[format.get_format_string()]
2268
 
 
2269
 
    @classmethod
2270
 
    def unregister_control_format(klass, format):
2271
 
        klass._control_formats.remove(format)
2272
 
 
2273
1759
 
2274
1760
class BzrDirFormat4(BzrDirFormat):
2275
1761
    """Bzr dir format 4.
2286
1772
 
2287
1773
    _lock_class = lockable_files.TransportLock
2288
1774
 
2289
 
    def get_format_string(self):
 
1775
    fixed_components = True
 
1776
 
 
1777
    @classmethod
 
1778
    def get_format_string(cls):
2290
1779
        """See BzrDirFormat.get_format_string()."""
2291
1780
        return "Bazaar-NG branch, format 0.0.4\n"
2292
1781
 
2329
1818
class BzrDirFormatAllInOne(BzrDirFormat):
2330
1819
    """Common class for formats before meta-dirs."""
2331
1820
 
 
1821
    fixed_components = True
 
1822
 
2332
1823
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2333
1824
        create_prefix=False, force_new_repo=False, stacked_on=None,
2334
1825
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2364
1855
 
2365
1856
    _lock_class = lockable_files.TransportLock
2366
1857
 
2367
 
    def get_format_string(self):
 
1858
    @classmethod
 
1859
    def get_format_string(cls):
2368
1860
        """See BzrDirFormat.get_format_string()."""
2369
1861
        return "Bazaar-NG branch, format 5\n"
2370
1862
 
2371
1863
    def get_branch_format(self):
2372
 
        from bzrlib import branch
2373
 
        return branch.BzrBranchFormat4()
 
1864
        from bzrlib import branch_weave
 
1865
        return branch_weave.BzrBranchFormat4()
2374
1866
 
2375
1867
    def get_format_description(self):
2376
1868
        """See BzrDirFormat.get_format_description()."""
2382
1874
        return ConvertBzrDir5To6()
2383
1875
 
2384
1876
    def _initialize_for_clone(self, url):
2385
 
        return self.initialize_on_transport(get_transport(url), _cloning=True)
 
1877
        return self.initialize_on_transport(
 
1878
            _mod_transport.get_transport(url), _cloning=True)
2386
1879
 
2387
1880
    def initialize_on_transport(self, transport, _cloning=False):
2388
1881
        """Format 5 dirs always have working tree, branch and repository.
2389
1882
 
2390
1883
        Except when they are being cloned.
2391
1884
        """
2392
 
        from bzrlib.branch import BzrBranchFormat4
 
1885
        from bzrlib.branch_weave import BzrBranchFormat4
2393
1886
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
2394
1887
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
2395
1888
        RepositoryFormat5().initialize(result, _internal=True)
2424
1917
 
2425
1918
    _lock_class = lockable_files.TransportLock
2426
1919
 
2427
 
    def get_format_string(self):
 
1920
    @classmethod
 
1921
    def get_format_string(cls):
2428
1922
        """See BzrDirFormat.get_format_string()."""
2429
1923
        return "Bazaar-NG branch, format 6\n"
2430
1924
 
2433
1927
        return "All-in-one format 6"
2434
1928
 
2435
1929
    def get_branch_format(self):
2436
 
        from bzrlib import branch
2437
 
        return branch.BzrBranchFormat4()
 
1930
        from bzrlib import branch_weave
 
1931
        return branch_weave.BzrBranchFormat4()
2438
1932
 
2439
1933
    def get_converter(self, format=None):
2440
1934
        """See BzrDirFormat.get_converter()."""
2442
1936
        return ConvertBzrDir6ToMeta()
2443
1937
 
2444
1938
    def _initialize_for_clone(self, url):
2445
 
        return self.initialize_on_transport(get_transport(url), _cloning=True)
 
1939
        return self.initialize_on_transport(
 
1940
            _mod_transport.get_transport(url), _cloning=True)
2446
1941
 
2447
1942
    def initialize_on_transport(self, transport, _cloning=False):
2448
1943
        """Format 6 dirs always have working tree, branch and repository.
2449
1944
 
2450
1945
        Except when they are being cloned.
2451
1946
        """
2452
 
        from bzrlib.branch import BzrBranchFormat4
 
1947
        from bzrlib.branch_weave import BzrBranchFormat4
2453
1948
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
2454
1949
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2455
1950
        RepositoryFormat6().initialize(result, _internal=True)
2485
1980
 
2486
1981
    _lock_class = lockdir.LockDir
2487
1982
 
 
1983
    fixed_components = False
 
1984
 
2488
1985
    def __init__(self):
2489
1986
        self._workingtree_format = None
2490
1987
        self._branch_format = None
2504
2001
 
2505
2002
    def get_branch_format(self):
2506
2003
        if self._branch_format is None:
2507
 
            from bzrlib.branch import BranchFormat
2508
 
            self._branch_format = BranchFormat.get_default_format()
 
2004
            from bzrlib.branch import format_registry as branch_format_registry
 
2005
            self._branch_format = branch_format_registry.get_default()
2509
2006
        return self._branch_format
2510
2007
 
2511
2008
    def set_branch_format(self, format):
2591
2088
            if target_branch is None:
2592
2089
                if do_upgrade:
2593
2090
                    # TODO: bad monkey, hard-coded formats...
2594
 
                    new_branch_format = branch.BzrBranchFormat7()
 
2091
                    from bzrlib.branch import BzrBranchFormat7
 
2092
                    new_branch_format = BzrBranchFormat7()
2595
2093
            else:
2596
2094
                new_branch_format = target_branch._format
2597
2095
                if not new_branch_format.supports_stacking():
2612
2110
            raise NotImplementedError(self.get_converter)
2613
2111
        return ConvertMetaToMeta(format)
2614
2112
 
2615
 
    def get_format_string(self):
 
2113
    @classmethod
 
2114
    def get_format_string(cls):
2616
2115
        """See BzrDirFormat.get_format_string()."""
2617
2116
        return "Bazaar-NG meta directory, format 1\n"
2618
2117
 
2636
2135
        """Circular import protection."""
2637
2136
        if self._repository_format:
2638
2137
            return self._repository_format
2639
 
        from bzrlib.repository import RepositoryFormat
2640
 
        return RepositoryFormat.get_default_format()
 
2138
        from bzrlib.repository import format_registry
 
2139
        return format_registry.get_default()
2641
2140
 
2642
2141
    def _set_repository_format(self, value):
2643
2142
        """Allow changing the repository format for metadir formats."""
2666
2165
 
2667
2166
    def __get_workingtree_format(self):
2668
2167
        if self._workingtree_format is None:
2669
 
            from bzrlib.workingtree import WorkingTreeFormat
2670
 
            self._workingtree_format = WorkingTreeFormat.get_default_format()
 
2168
            from bzrlib.workingtree import (
 
2169
                format_registry as wt_format_registry,
 
2170
                )
 
2171
            self._workingtree_format = wt_format_registry.get_default()
2671
2172
        return self._workingtree_format
2672
2173
 
2673
2174
    def __set_workingtree_format(self, wt_format):
2677
2178
                                  __set_workingtree_format)
2678
2179
 
2679
2180
 
2680
 
network_format_registry = registry.FormatRegistry()
2681
 
"""Registry of formats indexed by their network name.
2682
 
 
2683
 
The network name for a BzrDirFormat is an identifier that can be used when
2684
 
referring to formats with smart server operations. See
2685
 
BzrDirFormat.network_name() for more detail.
2686
 
"""
2687
 
 
2688
 
 
2689
 
# Register bzr control format
2690
 
BzrDirFormat.register_control_format(BzrDirFormat)
2691
 
 
2692
2181
# Register bzr formats
2693
 
BzrDirFormat.register_format(BzrDirFormat4())
2694
 
BzrDirFormat.register_format(BzrDirFormat5())
2695
 
BzrDirFormat.register_format(BzrDirFormat6())
 
2182
BzrProber.formats.register(BzrDirFormat4.get_format_string(), BzrDirFormat4())
 
2183
BzrProber.formats.register(BzrDirFormat5.get_format_string(), BzrDirFormat5())
 
2184
BzrProber.formats.register(BzrDirFormat6.get_format_string(), BzrDirFormat6())
2696
2185
__default_format = BzrDirMetaFormat1()
2697
 
BzrDirFormat.register_format(__default_format)
2698
 
BzrDirFormat._default_format = __default_format
2699
 
 
2700
 
 
2701
 
class Converter(object):
2702
 
    """Converts a disk format object from one format to another."""
2703
 
 
2704
 
    def convert(self, to_convert, pb):
2705
 
        """Perform the conversion of to_convert, giving feedback via pb.
2706
 
 
2707
 
        :param to_convert: The disk object to convert.
2708
 
        :param pb: a progress bar to use for progress information.
2709
 
        """
2710
 
 
2711
 
    def step(self, message):
2712
 
        """Update the pb by a step."""
2713
 
        self.count +=1
2714
 
        self.pb.update(message, self.count, self.total)
2715
 
 
2716
 
 
2717
 
class ConvertBzrDir4To5(Converter):
 
2186
BzrProber.formats.register(__default_format.get_format_string(), __default_format)
 
2187
controldir.ControlDirFormat._default_format = __default_format
 
2188
 
 
2189
 
 
2190
class ConvertBzrDir4To5(controldir.Converter):
2718
2191
    """Converts format 4 bzr dirs to format 5."""
2719
2192
 
2720
2193
    def __init__(self):
2803
2276
            mode=self.bzrdir._get_file_mode())
2804
2277
 
2805
2278
    def _write_all_weaves(self):
2806
 
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
 
2279
        controlweaves = VersionedFileStore(self.bzrdir.transport, prefixed=False,
 
2280
                                           versionedfile_class=WeaveFile)
2807
2281
        weave_transport = self.bzrdir.transport.clone('weaves')
2808
 
        weaves = WeaveStore(weave_transport, prefixed=False)
 
2282
        weaves = VersionedFileStore(weave_transport, prefixed=False,
 
2283
                            versionedfile_class=WeaveFile)
2809
2284
        transaction = WriteTransaction()
2810
2285
 
2811
2286
        try:
2863
2338
            self.revisions[rev_id] = rev
2864
2339
 
2865
2340
    def _load_old_inventory(self, rev_id):
2866
 
        old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
 
2341
        f = self.branch.repository.inventory_store.get(rev_id)
 
2342
        try:
 
2343
            old_inv_xml = f.read()
 
2344
        finally:
 
2345
            f.close()
2867
2346
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2868
2347
        inv.revision_id = rev_id
2869
2348
        rev = self.revisions[rev_id]
2886
2365
 
2887
2366
    def _store_new_inv(self, rev, inv, present_parents):
2888
2367
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2889
 
        new_inv_sha1 = sha_string(new_inv_xml)
 
2368
        new_inv_sha1 = osutils.sha_string(new_inv_xml)
2890
2369
        self.inv_weave.add_lines(rev.revision_id,
2891
2370
                                 present_parents,
2892
2371
                                 new_inv_xml.splitlines(True))
2925
2404
        previous_entries = dict((head, parent_candiate_entries[head]) for head
2926
2405
            in heads)
2927
2406
        self.snapshot_ie(previous_entries, ie, w, rev_id)
2928
 
        del ie.text_id
2929
2407
 
2930
2408
    def get_parent_map(self, revision_ids):
2931
2409
        """See graph.StackedParentsProvider.get_parent_map"""
2947
2425
                ie.revision = previous_ie.revision
2948
2426
                return
2949
2427
        if ie.has_text():
2950
 
            text = self.branch.repository._text_store.get(ie.text_id)
2951
 
            file_lines = text.readlines()
 
2428
            f = self.branch.repository._text_store.get(ie.text_id)
 
2429
            try:
 
2430
                file_lines = f.readlines()
 
2431
            finally:
 
2432
                f.close()
2952
2433
            w.add_lines(rev_id, previous_revisions, file_lines)
2953
2434
            self.text_count += 1
2954
2435
        else:
2978
2459
        return order
2979
2460
 
2980
2461
 
2981
 
class ConvertBzrDir5To6(Converter):
 
2462
class ConvertBzrDir5To6(controldir.Converter):
2982
2463
    """Converts format 5 bzr dirs to format 6."""
2983
2464
 
2984
2465
    def convert(self, to_convert, pb):
3021
2502
            mode=self.bzrdir._get_file_mode())
3022
2503
 
3023
2504
 
3024
 
class ConvertBzrDir6ToMeta(Converter):
 
2505
class ConvertBzrDir6ToMeta(controldir.Converter):
3025
2506
    """Converts format 6 bzr dirs to metadirs."""
3026
2507
 
3027
2508
    def convert(self, to_convert, pb):
3144
2625
            self.file_mode)
3145
2626
 
3146
2627
 
3147
 
class ConvertMetaToMeta(Converter):
 
2628
class ConvertMetaToMeta(controldir.Converter):
3148
2629
    """Converts the components of metadirs."""
3149
2630
 
3150
2631
    def __init__(self, target_format):
3223
2704
        return to_convert
3224
2705
 
3225
2706
 
3226
 
# This is not in remote.py because it's relatively small, and needs to be
3227
 
# registered. Putting it in remote.py creates a circular import problem.
3228
 
# we can make it a lazy object if the control formats is turned into something
3229
 
# like a registry.
3230
 
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3231
 
    """Format representing bzrdirs accessed via a smart server"""
3232
 
 
3233
 
    def __init__(self):
3234
 
        BzrDirMetaFormat1.__init__(self)
3235
 
        # XXX: It's a bit ugly that the network name is here, because we'd
3236
 
        # like to believe that format objects are stateless or at least
3237
 
        # immutable,  However, we do at least avoid mutating the name after
3238
 
        # it's returned.  See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
3239
 
        self._network_name = None
3240
 
 
3241
 
    def __repr__(self):
3242
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
3243
 
            self._network_name)
3244
 
 
3245
 
    def get_format_description(self):
3246
 
        if self._network_name:
3247
 
            real_format = network_format_registry.get(self._network_name)
3248
 
            return 'Remote: ' + real_format.get_format_description()
3249
 
        return 'bzr remote bzrdir'
3250
 
 
3251
 
    def get_format_string(self):
3252
 
        raise NotImplementedError(self.get_format_string)
3253
 
 
3254
 
    def network_name(self):
3255
 
        if self._network_name:
3256
 
            return self._network_name
3257
 
        else:
3258
 
            raise AssertionError("No network name set.")
3259
 
 
3260
 
    @classmethod
3261
 
    def probe_transport(klass, transport):
3262
 
        """Return a RemoteBzrDirFormat object if it looks possible."""
3263
 
        try:
3264
 
            medium = transport.get_smart_medium()
3265
 
        except (NotImplementedError, AttributeError,
3266
 
                errors.TransportNotPossible, errors.NoSmartMedium,
3267
 
                errors.SmartProtocolError):
3268
 
            # no smart server, so not a branch for this format type.
3269
 
            raise errors.NotBranchError(path=transport.base)
3270
 
        else:
3271
 
            # Decline to open it if the server doesn't support our required
3272
 
            # version (3) so that the VFS-based transport will do it.
3273
 
            if medium.should_probe():
3274
 
                try:
3275
 
                    server_version = medium.protocol_version()
3276
 
                except errors.SmartProtocolError:
3277
 
                    # Apparently there's no usable smart server there, even though
3278
 
                    # the medium supports the smart protocol.
3279
 
                    raise errors.NotBranchError(path=transport.base)
3280
 
                if server_version != '2':
3281
 
                    raise errors.NotBranchError(path=transport.base)
3282
 
            return klass()
3283
 
 
3284
 
    def initialize_on_transport(self, transport):
3285
 
        try:
3286
 
            # hand off the request to the smart server
3287
 
            client_medium = transport.get_smart_medium()
3288
 
        except errors.NoSmartMedium:
3289
 
            # TODO: lookup the local format from a server hint.
3290
 
            local_dir_format = BzrDirMetaFormat1()
3291
 
            return local_dir_format.initialize_on_transport(transport)
3292
 
        client = _SmartClient(client_medium)
3293
 
        path = client.remote_path_from_transport(transport)
3294
 
        try:
3295
 
            response = client.call('BzrDirFormat.initialize', path)
3296
 
        except errors.ErrorFromSmartServer, err:
3297
 
            remote._translate_error(err, path=path)
3298
 
        if response[0] != 'ok':
3299
 
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3300
 
        format = RemoteBzrDirFormat()
3301
 
        self._supply_sub_formats_to(format)
3302
 
        return remote.RemoteBzrDir(transport, format)
3303
 
 
3304
 
    def parse_NoneTrueFalse(self, arg):
3305
 
        if not arg:
3306
 
            return None
3307
 
        if arg == 'False':
3308
 
            return False
3309
 
        if arg == 'True':
3310
 
            return True
3311
 
        raise AssertionError("invalid arg %r" % arg)
3312
 
 
3313
 
    def _serialize_NoneTrueFalse(self, arg):
3314
 
        if arg is False:
3315
 
            return 'False'
3316
 
        if arg:
3317
 
            return 'True'
3318
 
        return ''
3319
 
 
3320
 
    def _serialize_NoneString(self, arg):
3321
 
        return arg or ''
3322
 
 
3323
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3324
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
3325
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3326
 
        shared_repo=False):
3327
 
        try:
3328
 
            # hand off the request to the smart server
3329
 
            client_medium = transport.get_smart_medium()
3330
 
        except errors.NoSmartMedium:
3331
 
            do_vfs = True
3332
 
        else:
3333
 
            # Decline to open it if the server doesn't support our required
3334
 
            # version (3) so that the VFS-based transport will do it.
3335
 
            if client_medium.should_probe():
3336
 
                try:
3337
 
                    server_version = client_medium.protocol_version()
3338
 
                    if server_version != '2':
3339
 
                        do_vfs = True
3340
 
                    else:
3341
 
                        do_vfs = False
3342
 
                except errors.SmartProtocolError:
3343
 
                    # Apparently there's no usable smart server there, even though
3344
 
                    # the medium supports the smart protocol.
3345
 
                    do_vfs = True
3346
 
            else:
3347
 
                do_vfs = False
3348
 
        if not do_vfs:
3349
 
            client = _SmartClient(client_medium)
3350
 
            path = client.remote_path_from_transport(transport)
3351
 
            if client_medium._is_remote_before((1, 16)):
3352
 
                do_vfs = True
3353
 
        if do_vfs:
3354
 
            # TODO: lookup the local format from a server hint.
3355
 
            local_dir_format = BzrDirMetaFormat1()
3356
 
            self._supply_sub_formats_to(local_dir_format)
3357
 
            return local_dir_format.initialize_on_transport_ex(transport,
3358
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3359
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3360
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3361
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3362
 
                vfs_only=True)
3363
 
        return self._initialize_on_transport_ex_rpc(client, path, transport,
3364
 
            use_existing_dir, create_prefix, force_new_repo, stacked_on,
3365
 
            stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3366
 
 
3367
 
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
3368
 
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
3369
 
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3370
 
        args = []
3371
 
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3372
 
        args.append(self._serialize_NoneTrueFalse(create_prefix))
3373
 
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
3374
 
        args.append(self._serialize_NoneString(stacked_on))
3375
 
        # stack_on_pwd is often/usually our transport
3376
 
        if stack_on_pwd:
3377
 
            try:
3378
 
                stack_on_pwd = transport.relpath(stack_on_pwd)
3379
 
                if not stack_on_pwd:
3380
 
                    stack_on_pwd = '.'
3381
 
            except errors.PathNotChild:
3382
 
                pass
3383
 
        args.append(self._serialize_NoneString(stack_on_pwd))
3384
 
        args.append(self._serialize_NoneString(repo_format_name))
3385
 
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
3386
 
        args.append(self._serialize_NoneTrueFalse(shared_repo))
3387
 
        request_network_name = self._network_name or \
3388
 
            BzrDirFormat.get_default_format().network_name()
3389
 
        try:
3390
 
            response = client.call('BzrDirFormat.initialize_ex_1.16',
3391
 
                request_network_name, path, *args)
3392
 
        except errors.UnknownSmartMethod:
3393
 
            client._medium._remember_remote_is_before((1,16))
3394
 
            local_dir_format = BzrDirMetaFormat1()
3395
 
            self._supply_sub_formats_to(local_dir_format)
3396
 
            return local_dir_format.initialize_on_transport_ex(transport,
3397
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3398
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3399
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3400
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3401
 
                vfs_only=True)
3402
 
        except errors.ErrorFromSmartServer, err:
3403
 
            remote._translate_error(err, path=path)
3404
 
        repo_path = response[0]
3405
 
        bzrdir_name = response[6]
3406
 
        require_stacking = response[7]
3407
 
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
3408
 
        format = RemoteBzrDirFormat()
3409
 
        format._network_name = bzrdir_name
3410
 
        self._supply_sub_formats_to(format)
3411
 
        bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3412
 
        if repo_path:
3413
 
            repo_format = remote.response_tuple_to_repo_format(response[1:])
3414
 
            if repo_path == '.':
3415
 
                repo_path = ''
3416
 
            if repo_path:
3417
 
                repo_bzrdir_format = RemoteBzrDirFormat()
3418
 
                repo_bzrdir_format._network_name = response[5]
3419
 
                repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3420
 
                    repo_bzrdir_format)
3421
 
            else:
3422
 
                repo_bzr = bzrdir
3423
 
            final_stack = response[8] or None
3424
 
            final_stack_pwd = response[9] or None
3425
 
            if final_stack_pwd:
3426
 
                final_stack_pwd = urlutils.join(
3427
 
                    transport.base, final_stack_pwd)
3428
 
            remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3429
 
            if len(response) > 10:
3430
 
                # Updated server verb that locks remotely.
3431
 
                repo_lock_token = response[10] or None
3432
 
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3433
 
                if repo_lock_token:
3434
 
                    remote_repo.dont_leave_lock_in_place()
3435
 
            else:
3436
 
                remote_repo.lock_write()
3437
 
            policy = UseExistingRepository(remote_repo, final_stack,
3438
 
                final_stack_pwd, require_stacking)
3439
 
            policy.acquire_repository()
3440
 
        else:
3441
 
            remote_repo = None
3442
 
            policy = None
3443
 
        bzrdir._format.set_branch_format(self.get_branch_format())
3444
 
        if require_stacking:
3445
 
            # The repo has already been created, but we need to make sure that
3446
 
            # we'll make a stackable branch.
3447
 
            bzrdir._format.require_stacking(_skip_repo=True)
3448
 
        return remote_repo, bzrdir, require_stacking, policy
3449
 
 
3450
 
    def _open(self, transport):
3451
 
        return remote.RemoteBzrDir(transport, self)
3452
 
 
3453
 
    def __eq__(self, other):
3454
 
        if not isinstance(other, RemoteBzrDirFormat):
3455
 
            return False
3456
 
        return self.get_format_description() == other.get_format_description()
3457
 
 
3458
 
    def __return_repository_format(self):
3459
 
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
3460
 
        # repository format has been asked for, tell the RemoteRepositoryFormat
3461
 
        # that it should use that for init() etc.
3462
 
        result = remote.RemoteRepositoryFormat()
3463
 
        custom_format = getattr(self, '_repository_format', None)
3464
 
        if custom_format:
3465
 
            if isinstance(custom_format, remote.RemoteRepositoryFormat):
3466
 
                return custom_format
3467
 
            else:
3468
 
                # We will use the custom format to create repositories over the
3469
 
                # wire; expose its details like rich_root_data for code to
3470
 
                # query
3471
 
                result._custom_format = custom_format
3472
 
        return result
3473
 
 
3474
 
    def get_branch_format(self):
3475
 
        result = BzrDirMetaFormat1.get_branch_format(self)
3476
 
        if not isinstance(result, remote.RemoteBranchFormat):
3477
 
            new_result = remote.RemoteBranchFormat()
3478
 
            new_result._custom_format = result
3479
 
            # cache the result
3480
 
            self.set_branch_format(new_result)
3481
 
            result = new_result
3482
 
        return result
3483
 
 
3484
 
    repository_format = property(__return_repository_format,
3485
 
        BzrDirMetaFormat1._set_repository_format) #.im_func)
3486
 
 
3487
 
 
3488
 
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3489
 
 
3490
 
 
3491
 
class BzrDirFormatInfo(object):
3492
 
 
3493
 
    def __init__(self, native, deprecated, hidden, experimental):
3494
 
        self.deprecated = deprecated
3495
 
        self.native = native
3496
 
        self.hidden = hidden
3497
 
        self.experimental = experimental
3498
 
 
3499
 
 
3500
 
class BzrDirFormatRegistry(registry.Registry):
3501
 
    """Registry of user-selectable BzrDir subformats.
3502
 
 
3503
 
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3504
 
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
3505
 
    """
3506
 
 
3507
 
    def __init__(self):
3508
 
        """Create a BzrDirFormatRegistry."""
3509
 
        self._aliases = set()
3510
 
        self._registration_order = list()
3511
 
        super(BzrDirFormatRegistry, self).__init__()
3512
 
 
3513
 
    def aliases(self):
3514
 
        """Return a set of the format names which are aliases."""
3515
 
        return frozenset(self._aliases)
3516
 
 
3517
 
    def register_metadir(self, key,
3518
 
             repository_format, help, native=True, deprecated=False,
3519
 
             branch_format=None,
3520
 
             tree_format=None,
3521
 
             hidden=False,
3522
 
             experimental=False,
3523
 
             alias=False):
3524
 
        """Register a metadir subformat.
3525
 
 
3526
 
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3527
 
        by the Repository/Branch/WorkingTreeformats.
3528
 
 
3529
 
        :param repository_format: The fully-qualified repository format class
3530
 
            name as a string.
3531
 
        :param branch_format: Fully-qualified branch format class name as
3532
 
            a string.
3533
 
        :param tree_format: Fully-qualified tree format class name as
3534
 
            a string.
3535
 
        """
3536
 
        # This should be expanded to support setting WorkingTree and Branch
3537
 
        # formats, once BzrDirMetaFormat1 supports that.
3538
 
        def _load(full_name):
3539
 
            mod_name, factory_name = full_name.rsplit('.', 1)
3540
 
            try:
3541
 
                mod = __import__(mod_name, globals(), locals(),
3542
 
                        [factory_name])
3543
 
            except ImportError, e:
3544
 
                raise ImportError('failed to load %s: %s' % (full_name, e))
3545
 
            try:
3546
 
                factory = getattr(mod, factory_name)
3547
 
            except AttributeError:
3548
 
                raise AttributeError('no factory %s in module %r'
3549
 
                    % (full_name, mod))
3550
 
            return factory()
3551
 
 
3552
 
        def helper():
3553
 
            bd = BzrDirMetaFormat1()
3554
 
            if branch_format is not None:
3555
 
                bd.set_branch_format(_load(branch_format))
3556
 
            if tree_format is not None:
3557
 
                bd.workingtree_format = _load(tree_format)
3558
 
            if repository_format is not None:
3559
 
                bd.repository_format = _load(repository_format)
3560
 
            return bd
3561
 
        self.register(key, helper, help, native, deprecated, hidden,
3562
 
            experimental, alias)
3563
 
 
3564
 
    def register(self, key, factory, help, native=True, deprecated=False,
3565
 
                 hidden=False, experimental=False, alias=False):
3566
 
        """Register a BzrDirFormat factory.
3567
 
 
3568
 
        The factory must be a callable that takes one parameter: the key.
3569
 
        It must produce an instance of the BzrDirFormat when called.
3570
 
 
3571
 
        This function mainly exists to prevent the info object from being
3572
 
        supplied directly.
3573
 
        """
3574
 
        registry.Registry.register(self, key, factory, help,
3575
 
            BzrDirFormatInfo(native, deprecated, hidden, experimental))
3576
 
        if alias:
3577
 
            self._aliases.add(key)
3578
 
        self._registration_order.append(key)
3579
 
 
3580
 
    def register_lazy(self, key, module_name, member_name, help, native=True,
3581
 
        deprecated=False, hidden=False, experimental=False, alias=False):
3582
 
        registry.Registry.register_lazy(self, key, module_name, member_name,
3583
 
            help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3584
 
        if alias:
3585
 
            self._aliases.add(key)
3586
 
        self._registration_order.append(key)
3587
 
 
3588
 
    def set_default(self, key):
3589
 
        """Set the 'default' key to be a clone of the supplied key.
3590
 
 
3591
 
        This method must be called once and only once.
3592
 
        """
3593
 
        registry.Registry.register(self, 'default', self.get(key),
3594
 
            self.get_help(key), info=self.get_info(key))
3595
 
        self._aliases.add('default')
3596
 
 
3597
 
    def set_default_repository(self, key):
3598
 
        """Set the FormatRegistry default and Repository default.
3599
 
 
3600
 
        This is a transitional method while Repository.set_default_format
3601
 
        is deprecated.
3602
 
        """
3603
 
        if 'default' in self:
3604
 
            self.remove('default')
3605
 
        self.set_default(key)
3606
 
        format = self.get('default')()
3607
 
 
3608
 
    def make_bzrdir(self, key):
3609
 
        return self.get(key)()
3610
 
 
3611
 
    def help_topic(self, topic):
3612
 
        output = ""
3613
 
        default_realkey = None
3614
 
        default_help = self.get_help('default')
3615
 
        help_pairs = []
3616
 
        for key in self._registration_order:
3617
 
            if key == 'default':
3618
 
                continue
3619
 
            help = self.get_help(key)
3620
 
            if help == default_help:
3621
 
                default_realkey = key
3622
 
            else:
3623
 
                help_pairs.append((key, help))
3624
 
 
3625
 
        def wrapped(key, help, info):
3626
 
            if info.native:
3627
 
                help = '(native) ' + help
3628
 
            return ':%s:\n%s\n\n' % (key,
3629
 
                textwrap.fill(help, initial_indent='    ',
3630
 
                    subsequent_indent='    ',
3631
 
                    break_long_words=False))
3632
 
        if default_realkey is not None:
3633
 
            output += wrapped(default_realkey, '(default) %s' % default_help,
3634
 
                              self.get_info('default'))
3635
 
        deprecated_pairs = []
3636
 
        experimental_pairs = []
3637
 
        for key, help in help_pairs:
3638
 
            info = self.get_info(key)
3639
 
            if info.hidden:
3640
 
                continue
3641
 
            elif info.deprecated:
3642
 
                deprecated_pairs.append((key, help))
3643
 
            elif info.experimental:
3644
 
                experimental_pairs.append((key, help))
3645
 
            else:
3646
 
                output += wrapped(key, help, info)
3647
 
        output += "\nSee :doc:`formats-help` for more about storage formats."
3648
 
        other_output = ""
3649
 
        if len(experimental_pairs) > 0:
3650
 
            other_output += "Experimental formats are shown below.\n\n"
3651
 
            for key, help in experimental_pairs:
3652
 
                info = self.get_info(key)
3653
 
                other_output += wrapped(key, help, info)
3654
 
        else:
3655
 
            other_output += \
3656
 
                "No experimental formats are available.\n\n"
3657
 
        if len(deprecated_pairs) > 0:
3658
 
            other_output += "\nDeprecated formats are shown below.\n\n"
3659
 
            for key, help in deprecated_pairs:
3660
 
                info = self.get_info(key)
3661
 
                other_output += wrapped(key, help, info)
3662
 
        else:
3663
 
            other_output += \
3664
 
                "\nNo deprecated formats are available.\n\n"
3665
 
        other_output += \
3666
 
                "\nSee :doc:`formats-help` for more about storage formats."
3667
 
 
3668
 
        if topic == 'other-formats':
3669
 
            return other_output
3670
 
        else:
3671
 
            return output
 
2707
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
3672
2708
 
3673
2709
 
3674
2710
class RepositoryAcquisitionPolicy(object):
3828
2864
        return self._repository, False
3829
2865
 
3830
2866
 
3831
 
# Please register new formats after old formats so that formats
3832
 
# appear in chronological order and format descriptions can build
3833
 
# on previous ones.
3834
 
format_registry = BzrDirFormatRegistry()
 
2867
def register_metadir(registry, key,
 
2868
         repository_format, help, native=True, deprecated=False,
 
2869
         branch_format=None,
 
2870
         tree_format=None,
 
2871
         hidden=False,
 
2872
         experimental=False,
 
2873
         alias=False):
 
2874
    """Register a metadir subformat.
 
2875
 
 
2876
    These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
 
2877
    by the Repository/Branch/WorkingTreeformats.
 
2878
 
 
2879
    :param repository_format: The fully-qualified repository format class
 
2880
        name as a string.
 
2881
    :param branch_format: Fully-qualified branch format class name as
 
2882
        a string.
 
2883
    :param tree_format: Fully-qualified tree format class name as
 
2884
        a string.
 
2885
    """
 
2886
    # This should be expanded to support setting WorkingTree and Branch
 
2887
    # formats, once BzrDirMetaFormat1 supports that.
 
2888
    def _load(full_name):
 
2889
        mod_name, factory_name = full_name.rsplit('.', 1)
 
2890
        try:
 
2891
            factory = pyutils.get_named_object(mod_name, factory_name)
 
2892
        except ImportError, e:
 
2893
            raise ImportError('failed to load %s: %s' % (full_name, e))
 
2894
        except AttributeError:
 
2895
            raise AttributeError('no factory %s in module %r'
 
2896
                % (full_name, sys.modules[mod_name]))
 
2897
        return factory()
 
2898
 
 
2899
    def helper():
 
2900
        bd = BzrDirMetaFormat1()
 
2901
        if branch_format is not None:
 
2902
            bd.set_branch_format(_load(branch_format))
 
2903
        if tree_format is not None:
 
2904
            bd.workingtree_format = _load(tree_format)
 
2905
        if repository_format is not None:
 
2906
            bd.repository_format = _load(repository_format)
 
2907
        return bd
 
2908
    registry.register(key, helper, help, native, deprecated, hidden,
 
2909
        experimental, alias)
 
2910
 
3835
2911
# The pre-0.8 formats have their repository format network name registered in
3836
2912
# repository.py. MetaDir formats have their repository format network name
3837
2913
# inferred from their disk format string.
3838
 
format_registry.register('weave', BzrDirFormat6,
 
2914
controldir.format_registry.register('weave', BzrDirFormat6,
3839
2915
    'Pre-0.8 format.  Slower than knit and does not'
3840
2916
    ' support checkouts or shared repositories.',
3841
2917
    hidden=True,
3842
2918
    deprecated=True)
3843
 
format_registry.register_metadir('metaweave',
 
2919
register_metadir(controldir.format_registry, 'metaweave',
3844
2920
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3845
2921
    'Transitional format in 0.8.  Slower than knit.',
3846
2922
    branch_format='bzrlib.branch.BzrBranchFormat5',
3847
2923
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3848
2924
    hidden=True,
3849
2925
    deprecated=True)
3850
 
format_registry.register_metadir('knit',
 
2926
register_metadir(controldir.format_registry, 'knit',
3851
2927
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3852
2928
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
3853
2929
    branch_format='bzrlib.branch.BzrBranchFormat5',
3854
2930
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3855
2931
    hidden=True,
3856
2932
    deprecated=True)
3857
 
format_registry.register_metadir('dirstate',
 
2933
register_metadir(controldir.format_registry, 'dirstate',
3858
2934
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3859
2935
    help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3860
2936
        'above when accessed over the network.',
3864
2940
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3865
2941
    hidden=True,
3866
2942
    deprecated=True)
3867
 
format_registry.register_metadir('dirstate-tags',
 
2943
register_metadir(controldir.format_registry, 'dirstate-tags',
3868
2944
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3869
2945
    help='New in 0.15: Fast local operations and improved scaling for '
3870
2946
        'network operations. Additionally adds support for tags.'
3873
2949
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3874
2950
    hidden=True,
3875
2951
    deprecated=True)
3876
 
format_registry.register_metadir('rich-root',
 
2952
register_metadir(controldir.format_registry, 'rich-root',
3877
2953
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3878
2954
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
3879
2955
        ' bzr < 1.0.',
3881
2957
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3882
2958
    hidden=True,
3883
2959
    deprecated=True)
3884
 
format_registry.register_metadir('dirstate-with-subtree',
 
2960
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
3885
2961
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3886
2962
    help='New in 0.15: Fast local operations and improved scaling for '
3887
2963
        'network operations. Additionally adds support for versioning nested '
3891
2967
    experimental=True,
3892
2968
    hidden=True,
3893
2969
    )
3894
 
format_registry.register_metadir('pack-0.92',
 
2970
register_metadir(controldir.format_registry, 'pack-0.92',
3895
2971
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3896
2972
    help='New in 0.92: Pack-based format with data compatible with '
3897
2973
        'dirstate-tags format repositories. Interoperates with '
3900
2976
    branch_format='bzrlib.branch.BzrBranchFormat6',
3901
2977
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3902
2978
    )
3903
 
format_registry.register_metadir('pack-0.92-subtree',
 
2979
register_metadir(controldir.format_registry, 'pack-0.92-subtree',
3904
2980
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3905
2981
    help='New in 0.92: Pack-based format with data compatible with '
3906
2982
        'dirstate-with-subtree format repositories. Interoperates with '
3911
2987
    hidden=True,
3912
2988
    experimental=True,
3913
2989
    )
3914
 
format_registry.register_metadir('rich-root-pack',
 
2990
register_metadir(controldir.format_registry, 'rich-root-pack',
3915
2991
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3916
2992
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3917
2993
         '(needed for bzr-svn and bzr-git).',
3919
2995
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3920
2996
    hidden=True,
3921
2997
    )
3922
 
format_registry.register_metadir('1.6',
 
2998
register_metadir(controldir.format_registry, '1.6',
3923
2999
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3924
3000
    help='A format that allows a branch to indicate that there is another '
3925
3001
         '(stacked) repository that should be used to access data that is '
3928
3004
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3929
3005
    hidden=True,
3930
3006
    )
3931
 
format_registry.register_metadir('1.6.1-rich-root',
 
3007
register_metadir(controldir.format_registry, '1.6.1-rich-root',
3932
3008
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3933
3009
    help='A variant of 1.6 that supports rich-root data '
3934
3010
         '(needed for bzr-svn and bzr-git).',
3936
3012
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3937
3013
    hidden=True,
3938
3014
    )
3939
 
format_registry.register_metadir('1.9',
 
3015
register_metadir(controldir.format_registry, '1.9',
3940
3016
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3941
3017
    help='A repository format using B+tree indexes. These indexes '
3942
3018
         'are smaller in size, have smarter caching and provide faster '
3945
3021
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3946
3022
    hidden=True,
3947
3023
    )
3948
 
format_registry.register_metadir('1.9-rich-root',
 
3024
register_metadir(controldir.format_registry, '1.9-rich-root',
3949
3025
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3950
3026
    help='A variant of 1.9 that supports rich-root data '
3951
3027
         '(needed for bzr-svn and bzr-git).',
3953
3029
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3954
3030
    hidden=True,
3955
3031
    )
3956
 
format_registry.register_metadir('1.14',
 
3032
register_metadir(controldir.format_registry, '1.14',
3957
3033
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3958
3034
    help='A working-tree format that supports content filtering.',
3959
3035
    branch_format='bzrlib.branch.BzrBranchFormat7',
3960
3036
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3961
3037
    )
3962
 
format_registry.register_metadir('1.14-rich-root',
 
3038
register_metadir(controldir.format_registry, '1.14-rich-root',
3963
3039
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3964
3040
    help='A variant of 1.14 that supports rich-root data '
3965
3041
         '(needed for bzr-svn and bzr-git).',
3967
3043
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3968
3044
    )
3969
3045
# The following un-numbered 'development' formats should always just be aliases.
3970
 
format_registry.register_metadir('development-rich-root',
3971
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3972
 
    help='Current development format. Supports rich roots. Can convert data '
3973
 
        'to and from rich-root-pack (and anything compatible with '
3974
 
        'rich-root-pack) format repositories. Repositories and branches in '
3975
 
        'this format can only be read by bzr.dev. Please read '
3976
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3977
 
        'before use.',
3978
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3979
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3980
 
    experimental=True,
3981
 
    alias=True,
3982
 
    hidden=True,
3983
 
    )
3984
 
format_registry.register_metadir('development-subtree',
3985
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
 
3046
register_metadir(controldir.format_registry, 'development-subtree',
 
3047
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2aSubtree',
3986
3048
    help='Current development format, subtree variant. Can convert data to and '
3987
3049
        'from pack-0.92-subtree (and anything compatible with '
3988
3050
        'pack-0.92-subtree) format repositories. Repositories and branches in '
3997
3059
                 # This current non-alias status is simply because we did not introduce a
3998
3060
                 # chk based subtree format.
3999
3061
    )
 
3062
register_metadir(controldir.format_registry, 'development5-subtree',
 
3063
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
 
3064
    help='Development format, subtree variant. Can convert data to and '
 
3065
        'from pack-0.92-subtree (and anything compatible with '
 
3066
        'pack-0.92-subtree) format repositories. Repositories and branches in '
 
3067
        'this format can only be read by bzr.dev. Please read '
 
3068
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
3069
        'before use.',
 
3070
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3071
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3072
    experimental=True,
 
3073
    hidden=True,
 
3074
    alias=False,
 
3075
    )
4000
3076
 
4001
3077
# And the development formats above will have aliased one of the following:
4002
 
format_registry.register_metadir('development6-rich-root',
4003
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
4004
 
    help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
4005
 
        'Please read '
4006
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4007
 
        'before use.',
4008
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4009
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4010
 
    hidden=True,
4011
 
    experimental=True,
4012
 
    )
4013
 
 
4014
 
format_registry.register_metadir('development7-rich-root',
4015
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
4016
 
    help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
4017
 
        'rich roots. Please read '
4018
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4019
 
        'before use.',
4020
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4021
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4022
 
    hidden=True,
4023
 
    experimental=True,
4024
 
    )
4025
 
 
4026
 
format_registry.register_metadir('2a',
 
3078
 
 
3079
# Finally, the current format.
 
3080
register_metadir(controldir.format_registry, '2a',
4027
3081
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4028
3082
    help='First format for bzr 2.0 series.\n'
4029
3083
        'Uses group-compress storage.\n'
4032
3086
        # 'rich roots. Supported by bzr 1.16 and later.',
4033
3087
    branch_format='bzrlib.branch.BzrBranchFormat7',
4034
3088
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4035
 
    experimental=True,
 
3089
    experimental=False,
4036
3090
    )
4037
3091
 
4038
3092
# The following format should be an alias for the rich root equivalent 
4039
3093
# of the default format
4040
 
format_registry.register_metadir('default-rich-root',
 
3094
register_metadir(controldir.format_registry, 'default-rich-root',
4041
3095
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4042
3096
    branch_format='bzrlib.branch.BzrBranchFormat7',
4043
3097
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4046
3100
    help='Same as 2a.')
4047
3101
 
4048
3102
# The current format that is made on 'bzr init'.
4049
 
format_registry.set_default('2a')
 
3103
format_name = config.GlobalConfig().get_user_option('default_format')
 
3104
if format_name is None:
 
3105
    controldir.format_registry.set_default('2a')
 
3106
else:
 
3107
    controldir.format_registry.set_default(format_name)
 
3108
 
 
3109
# XXX 2010-08-20 JRV: There is still a lot of code relying on
 
3110
# bzrlib.bzrdir.format_registry existing. When BzrDir.create/BzrDir.open/etc
 
3111
# get changed to ControlDir.create/ControlDir.open/etc this should be removed.
 
3112
format_registry = controldir.format_registry