/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-02-24 12:08:37 UTC
  • mto: (5676.1.5 per_interrepo-extra)
  • mto: This revision was merged to the branch mainline in revision 5686.
  • Revision ID: jelmer@samba.org-20110224120837-73x5dp7h8w6fusfz
Refactor, move to bzrlib.controldir.

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
40
    branch,
42
41
    config,
 
42
    controldir,
43
43
    errors,
44
44
    graph,
45
45
    lockable_files,
46
46
    lockdir,
47
47
    osutils,
 
48
    pyutils,
48
49
    remote,
49
50
    repository,
50
51
    revision as _mod_revision,
 
52
    transport as _mod_transport,
51
53
    ui,
52
54
    urlutils,
53
55
    versionedfile,
65
67
    )
66
68
from bzrlib.repofmt import pack_repo
67
69
from bzrlib.smart.client import _SmartClient
68
 
from bzrlib.store.versioned import WeaveStore
 
70
from bzrlib.store.versioned import VersionedFileStore
69
71
from bzrlib.transactions import WriteTransaction
70
72
from bzrlib.transport import (
71
73
    do_catching_redirections,
72
 
    get_transport,
73
74
    local,
74
75
    )
75
 
from bzrlib.weave import Weave
 
76
from bzrlib.weave import (
 
77
    WeaveFile,
 
78
    Weave,
 
79
    )
76
80
""")
77
81
 
78
82
from bzrlib.trace import (
86
90
    registry,
87
91
    symbol_versioning,
88
92
    )
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):
 
93
from bzrlib.symbol_versioning import (
 
94
    deprecated_in,
 
95
    deprecated_method,
 
96
    )
 
97
 
 
98
 
 
99
class BzrDir(controldir.ControlDir):
125
100
    """A .bzr control diretory.
126
101
 
127
102
    BzrDir instances let you create or open any of the things that can be
158
133
                    return
159
134
        thing_to_unlock.break_lock()
160
135
 
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
136
    def check_conversion_target(self, target_format):
166
137
        """Check that a bzrdir as a whole can be converted to a new format."""
167
138
        # The only current restriction is that the repository content can be 
202
173
                format.get_format_description(),
203
174
                basedir)
204
175
 
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
176
    def clone_on_transport(self, transport, revision_id=None,
225
177
        force_new_repo=False, preserve_stacking=False, stacked_on=None,
226
 
        create_prefix=False, use_existing_dir=True):
 
178
        create_prefix=False, use_existing_dir=True, no_tree=False):
227
179
        """Clone this bzrdir and its contents to transport verbatim.
228
180
 
229
181
        :param transport: The transport for the location to produce the clone
238
190
        :param create_prefix: Create any missing directories leading up to
239
191
            to_transport.
240
192
        :param use_existing_dir: Use an existing directory if one exists.
 
193
        :param no_tree: If set to true prevents creation of a working tree.
241
194
        """
242
195
        # Overview: put together a broad description of what we want to end up
243
196
        # with; then make as few api calls as possible to do it.
244
 
        
 
197
 
245
198
        # We may want to create a repo/branch/tree, if we do so what format
246
199
        # would we want for each:
247
200
        require_stacking = (stacked_on is not None)
248
201
        format = self.cloning_metadir(require_stacking)
249
 
        
 
202
 
250
203
        # Figure out what objects we want:
251
204
        try:
252
205
            local_repo = self.find_repository()
271
224
        # we should look up the policy needs first, or just use it as a hint,
272
225
        # or something.
273
226
        if local_repo:
274
 
            make_working_trees = local_repo.make_working_trees()
 
227
            make_working_trees = local_repo.make_working_trees() and not no_tree
275
228
            want_shared = local_repo.is_shared()
276
229
            repo_format_name = format.repository_format.network_name()
277
230
        else:
326
279
    # TODO: This should be given a Transport, and should chdir up; otherwise
327
280
    # this will open a new connection.
328
281
    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)
 
282
        t = _mod_transport.get_transport(url)
 
283
        t.ensure_base()
349
284
 
350
285
    @staticmethod
351
286
    def find_bzrdirs(transport, evaluate=None, list_current=None):
375
310
            recurse = True
376
311
            try:
377
312
                bzrdir = BzrDir.open_from_transport(current_transport)
378
 
            except errors.NotBranchError:
 
313
            except (errors.NotBranchError, errors.PermissionDenied):
379
314
                pass
380
315
            else:
381
316
                recurse, value = evaluate(bzrdir)
382
317
                yield value
383
318
            try:
384
319
                subdirs = list_current(current_transport)
385
 
            except errors.NoSuchFile:
 
320
            except (errors.NoSuchFile, errors.PermissionDenied):
386
321
                continue
387
322
            if recurse:
388
323
                for subdir in sorted(subdirs, reverse=True):
389
324
                    pending.append(current_transport.clone(subdir))
390
325
 
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
326
    @staticmethod
401
327
    def find_branches(transport):
402
328
        """Find all branches under a transport.
425
351
                ret.extend(branches)
426
352
        return ret
427
353
 
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
354
    @staticmethod
452
355
    def create_branch_and_repo(base, force_new_repo=False, format=None):
453
356
        """Create a new BzrDir, Branch and Repository at the url 'base'.
566
469
        """
567
470
        if force_new_tree:
568
471
            # check for non local urls
569
 
            t = get_transport(base, possible_transports)
 
472
            t = _mod_transport.get_transport(base, possible_transports)
570
473
            if not isinstance(t, local.LocalTransport):
571
474
                raise errors.NotLocalUrl(base)
572
475
        bzrdir = BzrDir.create(base, format, possible_transports)
594
497
        :param format: Override for the bzrdir format to create.
595
498
        :return: The WorkingTree object.
596
499
        """
597
 
        t = get_transport(base)
 
500
        t = _mod_transport.get_transport(base)
598
501
        if not isinstance(t, local.LocalTransport):
599
502
            raise errors.NotLocalUrl(base)
600
503
        bzrdir = BzrDir.create_branch_and_repo(base,
602
505
                                               format=format).bzrdir
603
506
        return bzrdir.create_workingtree()
604
507
 
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.
 
508
    @deprecated_method(deprecated_in((2, 3, 0)))
 
509
    def generate_backup_name(self, base):
 
510
        return self._available_backup_name(base)
 
511
 
 
512
    def _available_backup_name(self, base):
 
513
        """Find a non-existing backup file name based on base.
 
514
 
 
515
        See bzrlib.osutils.available_backup_name about race conditions.
615
516
        """
616
 
        raise NotImplementedError(self.create_workingtree)
 
517
        return osutils.available_backup_name(base, self.root_transport.has)
617
518
 
618
519
    def backup_bzrdir(self):
619
520
        """Backup this bzr control directory.
620
521
 
621
522
        :return: Tuple with old path name and new path name
622
523
        """
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
524
 
631
 
        backup_dir=name_gen()
632
525
        pb = ui.ui_factory.nested_progress_bar()
633
526
        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
527
            old_path = self.root_transport.abspath('.bzr')
 
528
            backup_dir = self._available_backup_name('backup.bzr')
639
529
            new_path = self.root_transport.abspath(backup_dir)
640
 
            ui.ui_factory.note('making backup of %s\n  to %s' % (old_path, new_path,))
 
530
            ui.ui_factory.note('making backup of %s\n  to %s'
 
531
                               % (old_path, new_path,))
641
532
            self.root_transport.copy_tree('.bzr', backup_dir)
642
533
            return (old_path, new_path)
643
534
        finally:
668
559
                else:
669
560
                    pass
670
561
 
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
562
    def _find_containing(self, evaluate):
687
563
        """Find something in a containing control directory.
688
564
 
737
613
            raise errors.NoRepositoryPresent(self)
738
614
        return found_repo
739
615
 
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
616
    def _find_creation_modes(self):
763
617
        """Determine the appropriate modes for files and directories.
764
618
 
803
657
            self._find_creation_modes()
804
658
        return self._dir_mode
805
659
 
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
660
    def get_config(self):
833
661
        """Get configuration for this BzrDir."""
834
662
        return config.BzrDirConfig(self)
852
680
        self.transport = _transport.clone('.bzr')
853
681
        self.root_transport = _transport
854
682
        self._mode_check_done = False
855
 
        
 
683
 
856
684
    @property 
857
685
    def user_transport(self):
858
686
        return self.root_transport
859
 
        
 
687
 
860
688
    @property
861
689
    def control_transport(self):
862
690
        return self.transport
868
696
 
869
697
        This is true IF and ONLY IF the filename is part of the namespace reserved
870
698
        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.
 
699
        of the root_transport. 
874
700
        """
875
701
        # this might be better on the BzrDirFormat class because it refers to
876
702
        # all the possible bzrdir disk formats.
880
706
        # add new tests for it to the appropriate place.
881
707
        return filename == '.bzr' or filename.startswith('.bzr/')
882
708
 
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
709
    @staticmethod
895
710
    def open_unsupported(base):
896
711
        """Open a branch which is not supported."""
902
717
 
903
718
        :param _unsupported: a private parameter to the BzrDir class.
904
719
        """
905
 
        t = get_transport(base, possible_transports=possible_transports)
 
720
        t = _mod_transport.get_transport(base, possible_transports)
906
721
        return BzrDir.open_from_transport(t, _unsupported=_unsupported)
907
722
 
908
723
    @staticmethod
919
734
        # the redirections.
920
735
        base = transport.base
921
736
        def find_format(transport):
922
 
            return transport, BzrDirFormat.find_format(
 
737
            return transport, controldir.ControlDirFormat.find_format(
923
738
                transport, _server_formats=_server_formats)
924
739
 
925
740
        def redirected(transport, e, redirection_notice):
940
755
        BzrDir._check_supported(format, _unsupported)
941
756
        return format.open(transport, _found=True)
942
757
 
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
758
    @staticmethod
955
759
    def open_containing(url, possible_transports=None):
956
760
        """Open an existing branch which contains url.
958
762
        :param url: url to search from.
959
763
        See open_containing_from_transport for more detail.
960
764
        """
961
 
        transport = get_transport(url, possible_transports)
 
765
        transport = _mod_transport.get_transport(url, possible_transports)
962
766
        return BzrDir.open_containing_from_transport(transport)
963
767
 
964
768
    @staticmethod
994
798
                raise errors.NotBranchError(path=url)
995
799
            a_transport = new_t
996
800
 
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
801
    @classmethod
1014
802
    def open_tree_or_branch(klass, location):
1015
803
        """Return the branch and working tree at a location.
1061
849
                raise errors.NotBranchError(location)
1062
850
        return tree, branch, branch.repository, relpath
1063
851
 
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
852
    def _cloning_metadir(self):
1118
853
        """Produce a metadir suitable for cloning with.
1119
854
 
1177
912
            format.require_stacking()
1178
913
        return format
1179
914
 
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.
 
915
    @classmethod
 
916
    def create(cls, base, format=None, possible_transports=None):
 
917
        """Create a new BzrDir at the url 'base'.
 
918
 
 
919
        :param format: If supplied, the format of branch to create.  If not
 
920
            supplied, the default is used.
 
921
        :param possible_transports: If supplied, a list of transports that
 
922
            can be reused to share a remote connection.
1209
923
        """
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
 
924
        if cls is not BzrDir:
 
925
            raise AssertionError("BzrDir.create always creates the"
 
926
                "default format, not one of %r" % cls)
 
927
        t = _mod_transport.get_transport(base, possible_transports)
 
928
        t.ensure_base()
 
929
        if format is None:
 
930
            format = controldir.ControlDirFormat.get_default_format()
 
931
        return format.initialize_on_transport(t)
1365
932
 
1366
933
 
1367
934
class BzrDirHooks(hooks.Hooks):
1437
1004
    def cloning_metadir(self, require_stacking=False):
1438
1005
        """Produce a metadir suitable for cloning with."""
1439
1006
        if require_stacking:
1440
 
            return format_registry.make_bzrdir('1.6')
 
1007
            return controldir.format_registry.make_bzrdir('1.6')
1441
1008
        return self._format.__class__()
1442
1009
 
1443
1010
    def clone(self, url, revision_id=None, force_new_repo=False,
1463
1030
            tree.clone(result)
1464
1031
        return result
1465
1032
 
1466
 
    def create_branch(self, name=None):
 
1033
    def create_branch(self, name=None, repository=None):
1467
1034
        """See BzrDir.create_branch."""
 
1035
        if repository is not None:
 
1036
            raise NotImplementedError(
 
1037
                "create_branch(repository=<not None>) on %r" % (self,))
1468
1038
        return self._format.get_branch_format().initialize(self, name=name)
1469
1039
 
1470
1040
    def destroy_branch(self, name=None):
1561
1131
            return self.transport
1562
1132
        raise errors.IncompatibleFormat(workingtree_format, self._format)
1563
1133
 
1564
 
    def needs_format_conversion(self, format=None):
 
1134
    def needs_format_conversion(self, format):
1565
1135
        """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
1136
        return not isinstance(self._format, format.__class__)
1573
1137
 
1574
1138
    def open_branch(self, name=None, unsupported=False,
1625
1189
        """See BzrDir.create_repository."""
1626
1190
        return self._format.repository_format.initialize(self, shared)
1627
1191
 
1628
 
    def needs_format_conversion(self, format=None):
 
1192
    def needs_format_conversion(self, format):
1629
1193
        """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
1194
        return True
1634
1195
 
1635
1196
    def open_repository(self):
1700
1261
        """See BzrDir.can_convert_format()."""
1701
1262
        return True
1702
1263
 
1703
 
    def create_branch(self, name=None):
 
1264
    def create_branch(self, name=None, repository=None):
1704
1265
        """See BzrDir.create_branch."""
1705
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1266
        return self._format.get_branch_format().initialize(self, name=name,
 
1267
                repository=repository)
1706
1268
 
1707
1269
    def destroy_branch(self, name=None):
1708
1270
        """See BzrDir.create_branch."""
1730
1292
        wt = self.open_workingtree(recommend_upgrade=False)
1731
1293
        repository = wt.branch.repository
1732
1294
        empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1733
 
        wt.revert(old_tree=empty)
 
1295
        # We ignore the conflicts returned by wt.revert since we're about to
 
1296
        # delete the wt metadata anyway, all that should be left here are
 
1297
        # detritus. But see bug #634470 about subtree .bzr dirs.
 
1298
        conflicts = wt.revert(old_tree=empty)
1734
1299
        self.destroy_workingtree_metadata()
1735
1300
 
1736
1301
    def destroy_workingtree_metadata(self):
1737
1302
        self.transport.delete_tree('checkout')
1738
1303
 
1739
 
    def find_branch_format(self):
 
1304
    def find_branch_format(self, name=None):
1740
1305
        """Find the branch 'format' for this bzrdir.
1741
1306
 
1742
1307
        This might be a synthetic object for e.g. RemoteBranch and SVN.
1743
1308
        """
1744
1309
        from bzrlib.branch import BranchFormat
1745
 
        return BranchFormat.find_format(self)
 
1310
        return BranchFormat.find_format(self, name=name)
1746
1311
 
1747
1312
    def _get_mkdir_mode(self):
1748
1313
        """Figure out the mode to use when creating a bzrdir subdir."""
1750
1315
                                     lockable_files.TransportLock)
1751
1316
        return temp_control._dir_mode
1752
1317
 
1753
 
    def get_branch_reference(self):
 
1318
    def get_branch_reference(self, name=None):
1754
1319
        """See BzrDir.get_branch_reference()."""
1755
1320
        from bzrlib.branch import BranchFormat
1756
 
        format = BranchFormat.find_format(self)
1757
 
        return format.get_reference(self)
 
1321
        format = BranchFormat.find_format(self, name=name)
 
1322
        return format.get_reference(self, name=name)
1758
1323
 
1759
1324
    def get_branch_transport(self, branch_format, name=None):
1760
1325
        """See BzrDir.get_branch_transport()."""
1818
1383
            return False
1819
1384
        return True
1820
1385
 
1821
 
    def needs_format_conversion(self, format=None):
 
1386
    def needs_format_conversion(self, format):
1822
1387
        """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
1388
        if not isinstance(self._format, format.__class__):
1829
1389
            # it is not a meta dir format, conversion is needed.
1830
1390
            return True
1854
1414
    def open_branch(self, name=None, unsupported=False,
1855
1415
                    ignore_fallbacks=False):
1856
1416
        """See BzrDir.open_branch."""
1857
 
        format = self.find_branch_format()
 
1417
        format = self.find_branch_format(name=name)
1858
1418
        self._check_supported(format, unsupported)
1859
1419
        return format.open(self, name=name,
1860
1420
            _found=True, ignore_fallbacks=ignore_fallbacks)
1880
1440
        return config.TransportConfig(self.transport, 'control.conf')
1881
1441
 
1882
1442
 
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.
 
1443
class BzrProber(controldir.Prober):
 
1444
    """Prober for formats that use a .bzr/ control directory."""
 
1445
 
 
1446
    _formats = {}
 
1447
    """The known .bzr formats."""
 
1448
 
 
1449
    @classmethod
 
1450
    def register_bzrdir_format(klass, format):
 
1451
        klass._formats[format.get_format_string()] = format
 
1452
 
 
1453
    @classmethod
 
1454
    def unregister_bzrdir_format(klass, format):
 
1455
        del klass._formats[format.get_format_string()]
 
1456
 
 
1457
    @classmethod
 
1458
    def probe_transport(klass, transport):
 
1459
        """Return the .bzrdir style format present in a directory."""
 
1460
        try:
 
1461
            format_string = transport.get_bytes(".bzr/branch-format")
 
1462
        except errors.NoSuchFile:
 
1463
            raise errors.NotBranchError(path=transport.base)
 
1464
        try:
 
1465
            return klass._formats[format_string]
 
1466
        except KeyError:
 
1467
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
 
1468
 
 
1469
 
 
1470
controldir.ControlDirFormat.register_prober(BzrProber)
 
1471
 
 
1472
 
 
1473
class RemoteBzrProber(controldir.Prober):
 
1474
    """Prober for remote servers that provide a Bazaar smart server."""
 
1475
 
 
1476
    @classmethod
 
1477
    def probe_transport(klass, transport):
 
1478
        """Return a RemoteBzrDirFormat object if it looks possible."""
 
1479
        try:
 
1480
            medium = transport.get_smart_medium()
 
1481
        except (NotImplementedError, AttributeError,
 
1482
                errors.TransportNotPossible, errors.NoSmartMedium,
 
1483
                errors.SmartProtocolError):
 
1484
            # no smart server, so not a branch for this format type.
 
1485
            raise errors.NotBranchError(path=transport.base)
 
1486
        else:
 
1487
            # Decline to open it if the server doesn't support our required
 
1488
            # version (3) so that the VFS-based transport will do it.
 
1489
            if medium.should_probe():
 
1490
                try:
 
1491
                    server_version = medium.protocol_version()
 
1492
                except errors.SmartProtocolError:
 
1493
                    # Apparently there's no usable smart server there, even though
 
1494
                    # the medium supports the smart protocol.
 
1495
                    raise errors.NotBranchError(path=transport.base)
 
1496
                if server_version != '2':
 
1497
                    raise errors.NotBranchError(path=transport.base)
 
1498
            return RemoteBzrDirFormat()
 
1499
 
 
1500
 
 
1501
class BzrDirFormat(controldir.ControlDirFormat):
 
1502
    """ControlDirFormat base class for .bzr/ directories.
1890
1503
 
1891
1504
    Formats are placed in a dict by their format string for reference
1892
1505
    during bzrdir opening. These should be subclasses of BzrDirFormat
1895
1508
    Once a format is deprecated, just deprecate the initialize and open
1896
1509
    methods on the format class. Do not deprecate the object, as the
1897
1510
    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
1511
    """
1919
1512
 
1920
1513
    _lock_file_name = 'branch-lock'
1921
1514
 
1922
 
    colocated_branches = False
1923
 
    """Whether co-located branches are supported for this control dir format.
1924
 
    """
1925
 
 
1926
1515
    # _lock_class must be set in subclasses to the lock type, typ.
1927
1516
    # TransportLock or LockDir
1928
1517
 
1929
 
    @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
1518
    def get_format_string(self):
1963
1519
        """Return the ASCII format string that identifies this format."""
1964
1520
        raise NotImplementedError(self.get_format_string)
1965
1521
 
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
1522
    def initialize_on_transport(self, transport):
1998
1523
        """Initialize a new bzrdir in the base directory of a Transport."""
1999
1524
        try:
2131
1656
        utf8_files = [('README',
2132
1657
                       "This is a Bazaar control directory.\n"
2133
1658
                       "Do not change any files in this directory.\n"
2134
 
                       "See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
 
1659
                       "See http://bazaar.canonical.com/ for more information about Bazaar.\n"),
2135
1660
                      ('branch-format', self.get_format_string()),
2136
1661
                      ]
2137
1662
        # NB: no need to escape relative paths that are url safe.
2147
1672
            control_files.unlock()
2148
1673
        return self.open(transport, _found=True)
2149
1674
 
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
1675
    def open(self, transport, _found=False):
2193
1676
        """Return an instance of this format for the dir transport points at.
2194
1677
 
2195
1678
        _found is a private parameter, do not use it.
2196
1679
        """
2197
1680
        if not _found:
2198
 
            found_format = BzrDirFormat.find_format(transport)
 
1681
            found_format = controldir.ControlDirFormat.find_format(transport)
2199
1682
            if not isinstance(found_format, self.__class__):
2200
1683
                raise AssertionError("%s was asked to open %s, but it seems to need "
2201
1684
                        "format %s"
2215
1698
 
2216
1699
    @classmethod
2217
1700
    def register_format(klass, format):
2218
 
        klass._formats[format.get_format_string()] = format
 
1701
        BzrProber.register_bzrdir_format(format)
2219
1702
        # 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()
 
1703
        controldir.network_format_registry.register(format.get_format_string(), format.__class__)
 
1704
        controldir.ControlDirFormat.register_format(format)
2252
1705
 
2253
1706
    def _supply_sub_formats_to(self, other_format):
2254
1707
        """Give other_format the same values for sub formats as this has.
2264
1717
 
2265
1718
    @classmethod
2266
1719
    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)
 
1720
        BzrProber.unregister_bzrdir_format(format)
 
1721
        controldir.ControlDirFormat.unregister_format(format)
 
1722
        controldir.network_format_registry.remove(format.get_format_string())
2272
1723
 
2273
1724
 
2274
1725
class BzrDirFormat4(BzrDirFormat):
2286
1737
 
2287
1738
    _lock_class = lockable_files.TransportLock
2288
1739
 
 
1740
    fixed_components = True
 
1741
 
2289
1742
    def get_format_string(self):
2290
1743
        """See BzrDirFormat.get_format_string()."""
2291
1744
        return "Bazaar-NG branch, format 0.0.4\n"
2329
1782
class BzrDirFormatAllInOne(BzrDirFormat):
2330
1783
    """Common class for formats before meta-dirs."""
2331
1784
 
 
1785
    fixed_components = True
 
1786
 
2332
1787
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2333
1788
        create_prefix=False, force_new_repo=False, stacked_on=None,
2334
1789
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2382
1837
        return ConvertBzrDir5To6()
2383
1838
 
2384
1839
    def _initialize_for_clone(self, url):
2385
 
        return self.initialize_on_transport(get_transport(url), _cloning=True)
 
1840
        return self.initialize_on_transport(
 
1841
            _mod_transport.get_transport(url), _cloning=True)
2386
1842
 
2387
1843
    def initialize_on_transport(self, transport, _cloning=False):
2388
1844
        """Format 5 dirs always have working tree, branch and repository.
2442
1898
        return ConvertBzrDir6ToMeta()
2443
1899
 
2444
1900
    def _initialize_for_clone(self, url):
2445
 
        return self.initialize_on_transport(get_transport(url), _cloning=True)
 
1901
        return self.initialize_on_transport(
 
1902
            _mod_transport.get_transport(url), _cloning=True)
2446
1903
 
2447
1904
    def initialize_on_transport(self, transport, _cloning=False):
2448
1905
        """Format 6 dirs always have working tree, branch and repository.
2485
1942
 
2486
1943
    _lock_class = lockdir.LockDir
2487
1944
 
 
1945
    fixed_components = False
 
1946
 
2488
1947
    def __init__(self):
2489
1948
        self._workingtree_format = None
2490
1949
        self._branch_format = None
2504
1963
 
2505
1964
    def get_branch_format(self):
2506
1965
        if self._branch_format is None:
2507
 
            from bzrlib.branch import BranchFormat
2508
 
            self._branch_format = BranchFormat.get_default_format()
 
1966
            from bzrlib.branch import format_registry as branch_format_registry
 
1967
            self._branch_format = branch_format_registry.get_default()
2509
1968
        return self._branch_format
2510
1969
 
2511
1970
    def set_branch_format(self, format):
2636
2095
        """Circular import protection."""
2637
2096
        if self._repository_format:
2638
2097
            return self._repository_format
2639
 
        from bzrlib.repository import RepositoryFormat
2640
 
        return RepositoryFormat.get_default_format()
 
2098
        from bzrlib.repository import format_registry
 
2099
        return format_registry.get_default()
2641
2100
 
2642
2101
    def _set_repository_format(self, value):
2643
2102
        """Allow changing the repository format for metadir formats."""
2666
2125
 
2667
2126
    def __get_workingtree_format(self):
2668
2127
        if self._workingtree_format is None:
2669
 
            from bzrlib.workingtree import WorkingTreeFormat
2670
 
            self._workingtree_format = WorkingTreeFormat.get_default_format()
 
2128
            from bzrlib.workingtree import (
 
2129
                format_registry as wt_format_registry,
 
2130
                )
 
2131
            self._workingtree_format = wt_format_registry.get_default()
2671
2132
        return self._workingtree_format
2672
2133
 
2673
2134
    def __set_workingtree_format(self, wt_format):
2677
2138
                                  __set_workingtree_format)
2678
2139
 
2679
2140
 
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
2141
# Register bzr formats
2693
2142
BzrDirFormat.register_format(BzrDirFormat4())
2694
2143
BzrDirFormat.register_format(BzrDirFormat5())
2695
2144
BzrDirFormat.register_format(BzrDirFormat6())
2696
2145
__default_format = BzrDirMetaFormat1()
2697
2146
BzrDirFormat.register_format(__default_format)
2698
 
BzrDirFormat._default_format = __default_format
 
2147
controldir.ControlDirFormat._default_format = __default_format
2699
2148
 
2700
2149
 
2701
2150
class Converter(object):
2803
2252
            mode=self.bzrdir._get_file_mode())
2804
2253
 
2805
2254
    def _write_all_weaves(self):
2806
 
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
 
2255
        controlweaves = VersionedFileStore(self.bzrdir.transport, prefixed=False,
 
2256
                                           versionedfile_class=WeaveFile)
2807
2257
        weave_transport = self.bzrdir.transport.clone('weaves')
2808
 
        weaves = WeaveStore(weave_transport, prefixed=False)
 
2258
        weaves = VersionedFileStore(weave_transport, prefixed=False,
 
2259
                            versionedfile_class=WeaveFile)
2809
2260
        transaction = WriteTransaction()
2810
2261
 
2811
2262
        try:
2863
2314
            self.revisions[rev_id] = rev
2864
2315
 
2865
2316
    def _load_old_inventory(self, rev_id):
2866
 
        old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
 
2317
        f = self.branch.repository.inventory_store.get(rev_id)
 
2318
        try:
 
2319
            old_inv_xml = f.read()
 
2320
        finally:
 
2321
            f.close()
2867
2322
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2868
2323
        inv.revision_id = rev_id
2869
2324
        rev = self.revisions[rev_id]
2925
2380
        previous_entries = dict((head, parent_candiate_entries[head]) for head
2926
2381
            in heads)
2927
2382
        self.snapshot_ie(previous_entries, ie, w, rev_id)
2928
 
        del ie.text_id
2929
2383
 
2930
2384
    def get_parent_map(self, revision_ids):
2931
2385
        """See graph.StackedParentsProvider.get_parent_map"""
2947
2401
                ie.revision = previous_ie.revision
2948
2402
                return
2949
2403
        if ie.has_text():
2950
 
            text = self.branch.repository._text_store.get(ie.text_id)
2951
 
            file_lines = text.readlines()
 
2404
            f = self.branch.repository._text_store.get(ie.text_id)
 
2405
            try:
 
2406
                file_lines = f.readlines()
 
2407
            finally:
 
2408
                f.close()
2952
2409
            w.add_lines(rev_id, previous_revisions, file_lines)
2953
2410
            self.text_count += 1
2954
2411
        else:
3230
2687
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3231
2688
    """Format representing bzrdirs accessed via a smart server"""
3232
2689
 
 
2690
    supports_workingtrees = False
 
2691
 
3233
2692
    def __init__(self):
3234
2693
        BzrDirMetaFormat1.__init__(self)
3235
2694
        # XXX: It's a bit ugly that the network name is here, because we'd
3236
2695
        # like to believe that format objects are stateless or at least
3237
2696
        # immutable,  However, we do at least avoid mutating the name after
3238
 
        # it's returned.  See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
 
2697
        # it's returned.  See <https://bugs.launchpad.net/bzr/+bug/504102>
3239
2698
        self._network_name = None
3240
2699
 
3241
2700
    def __repr__(self):
3244
2703
 
3245
2704
    def get_format_description(self):
3246
2705
        if self._network_name:
3247
 
            real_format = network_format_registry.get(self._network_name)
 
2706
            real_format = controldir.network_format_registry.get(self._network_name)
3248
2707
            return 'Remote: ' + real_format.get_format_description()
3249
2708
        return 'bzr remote bzrdir'
3250
2709
 
3257
2716
        else:
3258
2717
            raise AssertionError("No network name set.")
3259
2718
 
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
2719
    def initialize_on_transport(self, transport):
3285
2720
        try:
3286
2721
            # hand off the request to the smart server
3485
2920
        BzrDirMetaFormat1._set_repository_format) #.im_func)
3486
2921
 
3487
2922
 
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
 
2923
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
3672
2924
 
3673
2925
 
3674
2926
class RepositoryAcquisitionPolicy(object):
3828
3080
        return self._repository, False
3829
3081
 
3830
3082
 
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()
 
3083
def register_metadir(registry, key,
 
3084
         repository_format, help, native=True, deprecated=False,
 
3085
         branch_format=None,
 
3086
         tree_format=None,
 
3087
         hidden=False,
 
3088
         experimental=False,
 
3089
         alias=False):
 
3090
    """Register a metadir subformat.
 
3091
 
 
3092
    These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
 
3093
    by the Repository/Branch/WorkingTreeformats.
 
3094
 
 
3095
    :param repository_format: The fully-qualified repository format class
 
3096
        name as a string.
 
3097
    :param branch_format: Fully-qualified branch format class name as
 
3098
        a string.
 
3099
    :param tree_format: Fully-qualified tree format class name as
 
3100
        a string.
 
3101
    """
 
3102
    # This should be expanded to support setting WorkingTree and Branch
 
3103
    # formats, once BzrDirMetaFormat1 supports that.
 
3104
    def _load(full_name):
 
3105
        mod_name, factory_name = full_name.rsplit('.', 1)
 
3106
        try:
 
3107
            factory = pyutils.get_named_object(mod_name, factory_name)
 
3108
        except ImportError, e:
 
3109
            raise ImportError('failed to load %s: %s' % (full_name, e))
 
3110
        except AttributeError:
 
3111
            raise AttributeError('no factory %s in module %r'
 
3112
                % (full_name, sys.modules[mod_name]))
 
3113
        return factory()
 
3114
 
 
3115
    def helper():
 
3116
        bd = BzrDirMetaFormat1()
 
3117
        if branch_format is not None:
 
3118
            bd.set_branch_format(_load(branch_format))
 
3119
        if tree_format is not None:
 
3120
            bd.workingtree_format = _load(tree_format)
 
3121
        if repository_format is not None:
 
3122
            bd.repository_format = _load(repository_format)
 
3123
        return bd
 
3124
    registry.register(key, helper, help, native, deprecated, hidden,
 
3125
        experimental, alias)
 
3126
 
3835
3127
# The pre-0.8 formats have their repository format network name registered in
3836
3128
# repository.py. MetaDir formats have their repository format network name
3837
3129
# inferred from their disk format string.
3838
 
format_registry.register('weave', BzrDirFormat6,
 
3130
controldir.format_registry.register('weave', BzrDirFormat6,
3839
3131
    'Pre-0.8 format.  Slower than knit and does not'
3840
3132
    ' support checkouts or shared repositories.',
3841
3133
    hidden=True,
3842
3134
    deprecated=True)
3843
 
format_registry.register_metadir('metaweave',
 
3135
register_metadir(controldir.format_registry, 'metaweave',
3844
3136
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3845
3137
    'Transitional format in 0.8.  Slower than knit.',
3846
3138
    branch_format='bzrlib.branch.BzrBranchFormat5',
3847
3139
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3848
3140
    hidden=True,
3849
3141
    deprecated=True)
3850
 
format_registry.register_metadir('knit',
 
3142
register_metadir(controldir.format_registry, 'knit',
3851
3143
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3852
3144
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
3853
3145
    branch_format='bzrlib.branch.BzrBranchFormat5',
3854
3146
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3855
3147
    hidden=True,
3856
3148
    deprecated=True)
3857
 
format_registry.register_metadir('dirstate',
 
3149
register_metadir(controldir.format_registry, 'dirstate',
3858
3150
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3859
3151
    help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3860
3152
        'above when accessed over the network.',
3861
3153
    branch_format='bzrlib.branch.BzrBranchFormat5',
3862
3154
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3863
3155
    # directly from workingtree_4 triggers a circular import.
3864
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3156
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3865
3157
    hidden=True,
3866
3158
    deprecated=True)
3867
 
format_registry.register_metadir('dirstate-tags',
 
3159
register_metadir(controldir.format_registry, 'dirstate-tags',
3868
3160
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3869
3161
    help='New in 0.15: Fast local operations and improved scaling for '
3870
3162
        'network operations. Additionally adds support for tags.'
3871
3163
        ' Incompatible with bzr < 0.15.',
3872
3164
    branch_format='bzrlib.branch.BzrBranchFormat6',
3873
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3165
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3874
3166
    hidden=True,
3875
3167
    deprecated=True)
3876
 
format_registry.register_metadir('rich-root',
 
3168
register_metadir(controldir.format_registry, 'rich-root',
3877
3169
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3878
3170
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
3879
3171
        ' bzr < 1.0.',
3880
3172
    branch_format='bzrlib.branch.BzrBranchFormat6',
3881
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3173
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3882
3174
    hidden=True,
3883
3175
    deprecated=True)
3884
 
format_registry.register_metadir('dirstate-with-subtree',
 
3176
register_metadir(controldir.format_registry, 'dirstate-with-subtree',
3885
3177
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3886
3178
    help='New in 0.15: Fast local operations and improved scaling for '
3887
3179
        'network operations. Additionally adds support for versioning nested '
3888
3180
        'bzr branches. Incompatible with bzr < 0.15.',
3889
3181
    branch_format='bzrlib.branch.BzrBranchFormat6',
3890
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3182
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3891
3183
    experimental=True,
3892
3184
    hidden=True,
3893
3185
    )
3894
 
format_registry.register_metadir('pack-0.92',
 
3186
register_metadir(controldir.format_registry, 'pack-0.92',
3895
3187
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3896
3188
    help='New in 0.92: Pack-based format with data compatible with '
3897
3189
        'dirstate-tags format repositories. Interoperates with '
3898
3190
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3899
3191
        ,
3900
3192
    branch_format='bzrlib.branch.BzrBranchFormat6',
3901
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3193
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3902
3194
    )
3903
 
format_registry.register_metadir('pack-0.92-subtree',
 
3195
register_metadir(controldir.format_registry, 'pack-0.92-subtree',
3904
3196
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3905
3197
    help='New in 0.92: Pack-based format with data compatible with '
3906
3198
        'dirstate-with-subtree format repositories. Interoperates with '
3907
3199
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3908
3200
        ,
3909
3201
    branch_format='bzrlib.branch.BzrBranchFormat6',
3910
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3202
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3911
3203
    hidden=True,
3912
3204
    experimental=True,
3913
3205
    )
3914
 
format_registry.register_metadir('rich-root-pack',
 
3206
register_metadir(controldir.format_registry, 'rich-root-pack',
3915
3207
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3916
3208
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3917
3209
         '(needed for bzr-svn and bzr-git).',
3918
3210
    branch_format='bzrlib.branch.BzrBranchFormat6',
3919
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3211
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3920
3212
    hidden=True,
3921
3213
    )
3922
 
format_registry.register_metadir('1.6',
 
3214
register_metadir(controldir.format_registry, '1.6',
3923
3215
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3924
3216
    help='A format that allows a branch to indicate that there is another '
3925
3217
         '(stacked) repository that should be used to access data that is '
3926
3218
         'not present locally.',
3927
3219
    branch_format='bzrlib.branch.BzrBranchFormat7',
3928
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3220
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3929
3221
    hidden=True,
3930
3222
    )
3931
 
format_registry.register_metadir('1.6.1-rich-root',
 
3223
register_metadir(controldir.format_registry, '1.6.1-rich-root',
3932
3224
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3933
3225
    help='A variant of 1.6 that supports rich-root data '
3934
3226
         '(needed for bzr-svn and bzr-git).',
3935
3227
    branch_format='bzrlib.branch.BzrBranchFormat7',
3936
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3228
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3937
3229
    hidden=True,
3938
3230
    )
3939
 
format_registry.register_metadir('1.9',
 
3231
register_metadir(controldir.format_registry, '1.9',
3940
3232
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3941
3233
    help='A repository format using B+tree indexes. These indexes '
3942
3234
         'are smaller in size, have smarter caching and provide faster '
3943
3235
         'performance for most operations.',
3944
3236
    branch_format='bzrlib.branch.BzrBranchFormat7',
3945
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3237
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3946
3238
    hidden=True,
3947
3239
    )
3948
 
format_registry.register_metadir('1.9-rich-root',
 
3240
register_metadir(controldir.format_registry, '1.9-rich-root',
3949
3241
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3950
3242
    help='A variant of 1.9 that supports rich-root data '
3951
3243
         '(needed for bzr-svn and bzr-git).',
3952
3244
    branch_format='bzrlib.branch.BzrBranchFormat7',
3953
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3245
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat4',
3954
3246
    hidden=True,
3955
3247
    )
3956
 
format_registry.register_metadir('1.14',
 
3248
register_metadir(controldir.format_registry, '1.14',
3957
3249
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3958
3250
    help='A working-tree format that supports content filtering.',
3959
3251
    branch_format='bzrlib.branch.BzrBranchFormat7',
3960
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
 
3252
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
3961
3253
    )
3962
 
format_registry.register_metadir('1.14-rich-root',
 
3254
register_metadir(controldir.format_registry, '1.14-rich-root',
3963
3255
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3964
3256
    help='A variant of 1.14 that supports rich-root data '
3965
3257
         '(needed for bzr-svn and bzr-git).',
3966
3258
    branch_format='bzrlib.branch.BzrBranchFormat7',
3967
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
 
3259
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat5',
3968
3260
    )
3969
3261
# 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',
 
3262
register_metadir(controldir.format_registry, 'development-subtree',
 
3263
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2aSubtree',
3986
3264
    help='Current development format, subtree variant. Can convert data to and '
3987
3265
        'from pack-0.92-subtree (and anything compatible with '
3988
3266
        'pack-0.92-subtree) format repositories. Repositories and branches in '
3990
3268
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3991
3269
        'before use.',
3992
3270
    branch_format='bzrlib.branch.BzrBranchFormat7',
3993
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3271
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
3994
3272
    experimental=True,
3995
3273
    hidden=True,
3996
3274
    alias=False, # Restore to being an alias when an actual development subtree format is added
3997
3275
                 # This current non-alias status is simply because we did not introduce a
3998
3276
                 # chk based subtree format.
3999
3277
    )
 
3278
register_metadir(controldir.format_registry, 'development5-subtree',
 
3279
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
 
3280
    help='Development format, subtree variant. Can convert data to and '
 
3281
        'from pack-0.92-subtree (and anything compatible with '
 
3282
        'pack-0.92-subtree) format repositories. Repositories and branches in '
 
3283
        'this format can only be read by bzr.dev. Please read '
 
3284
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
3285
        'before use.',
 
3286
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3287
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
3288
    experimental=True,
 
3289
    hidden=True,
 
3290
    alias=False,
 
3291
    )
4000
3292
 
4001
3293
# 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',
 
3294
 
 
3295
# Finally, the current format.
 
3296
register_metadir(controldir.format_registry, '2a',
4027
3297
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4028
3298
    help='First format for bzr 2.0 series.\n'
4029
3299
        'Uses group-compress storage.\n'
4031
3301
        # 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
4032
3302
        # 'rich roots. Supported by bzr 1.16 and later.',
4033
3303
    branch_format='bzrlib.branch.BzrBranchFormat7',
4034
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4035
 
    experimental=True,
 
3304
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
 
3305
    experimental=False,
4036
3306
    )
4037
3307
 
4038
3308
# The following format should be an alias for the rich root equivalent 
4039
3309
# of the default format
4040
 
format_registry.register_metadir('default-rich-root',
 
3310
register_metadir(controldir.format_registry, 'default-rich-root',
4041
3311
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4042
3312
    branch_format='bzrlib.branch.BzrBranchFormat7',
4043
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3313
    tree_format='bzrlib.workingtree_4.WorkingTreeFormat6',
4044
3314
    alias=True,
4045
3315
    hidden=True,
4046
3316
    help='Same as 2a.')
4047
3317
 
4048
3318
# The current format that is made on 'bzr init'.
4049
 
format_registry.set_default('2a')
 
3319
format_name = config.GlobalConfig().get_user_option('default_format')
 
3320
if format_name is None:
 
3321
    controldir.format_registry.set_default('2a')
 
3322
else:
 
3323
    controldir.format_registry.set_default(format_name)
 
3324
 
 
3325
# XXX 2010-08-20 JRV: There is still a lot of code relying on
 
3326
# bzrlib.bzrdir.format_registry existing. When BzrDir.create/BzrDir.open/etc
 
3327
# get changed to ControlDir.create/ControlDir.open/etc this should be removed.
 
3328
format_registry = controldir.format_registry