← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Ian Clatworthy
  • Date: 2009-03-17 06:18:30 UTC
  • mto: (4157.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 4158.
  • Revision ID: ian.clatworthy@canonical.com-20090317061830-9glppr51ggivnrgl
Show usage on --usage, not -h

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) 2005, 2006, 2007, 2008, 2009 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""BzrDir logic. The BzrDir is the basic control directory used by bzr.
18
18
 
29
29
 
30
30
import os
31
31
import sys
32
 
import warnings
33
32
 
34
33
from bzrlib.lazy_import import lazy_import
35
34
lazy_import(globals(), """
38
37
 
39
38
import bzrlib
40
39
from bzrlib import (
41
 
    branch,
42
40
    config,
43
41
    errors,
44
42
    graph,
46
44
    lockdir,
47
45
    osutils,
48
46
    remote,
49
 
    repository,
50
47
    revision as _mod_revision,
51
48
    ui,
52
49
    urlutils,
60
57
from bzrlib.osutils import (
61
58
    sha_string,
62
59
    )
63
 
from bzrlib.push import (
64
 
    PushResult,
65
 
    )
66
 
from bzrlib.repofmt import pack_repo
67
60
from bzrlib.smart.client import _SmartClient
68
61
from bzrlib.store.versioned import WeaveStore
69
62
from bzrlib.transactions import WriteTransaction
71
64
    do_catching_redirections,
72
65
    get_transport,
73
66
    local,
 
67
    remote as remote_transport,
74
68
    )
75
69
from bzrlib.weave import Weave
76
70
""")
78
72
from bzrlib.trace import (
79
73
    mutter,
80
74
    note,
81
 
    warning,
82
75
    )
83
76
 
84
77
from bzrlib import (
85
 
    hooks,
86
78
    registry,
87
79
    symbol_versioning,
88
80
    )
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):
 
81
 
 
82
 
 
83
class BzrDir(object):
125
84
    """A .bzr control diretory.
126
85
 
127
86
    BzrDir instances let you create or open any of the things that can be
134
93
        (i.e. the parent directory holding the .bzr directory).
135
94
 
136
95
    Everything in the bzrdir should have the same file permissions.
137
 
 
138
 
    :cvar hooks: An instance of BzrDirHooks.
139
96
    """
140
97
 
141
98
    def break_lock(self):
163
120
        return True
164
121
 
165
122
    def check_conversion_target(self, target_format):
166
 
        """Check that a bzrdir as a whole can be converted to a new format."""
167
 
        # The only current restriction is that the repository content can be 
168
 
        # fetched compatibly with the target.
169
123
        target_repo_format = target_format.repository_format
170
 
        try:
171
 
            self.open_repository()._format.check_conversion_target(
172
 
                target_repo_format)
173
 
        except errors.NoRepositoryPresent:
174
 
            # No repo, no problem.
175
 
            pass
 
124
        source_repo_format = self._format.repository_format
 
125
        source_repo_format.check_conversion_target(target_repo_format)
176
126
 
177
127
    @staticmethod
178
128
    def _check_supported(format, allow_unsupported,
222
172
                                       preserve_stacking=preserve_stacking)
223
173
 
224
174
    def clone_on_transport(self, transport, revision_id=None,
225
 
        force_new_repo=False, preserve_stacking=False, stacked_on=None,
226
 
        create_prefix=False, use_existing_dir=True):
 
175
                           force_new_repo=False, preserve_stacking=False,
 
176
                           stacked_on=None):
227
177
        """Clone this bzrdir and its contents to transport verbatim.
228
178
 
229
179
        :param transport: The transport for the location to produce the clone
235
185
                               even if one is available.
236
186
        :param preserve_stacking: When cloning a stacked branch, stack the
237
187
            new branch on top of the other branch's stacked-on branch.
238
 
        :param create_prefix: Create any missing directories leading up to
239
 
            to_transport.
240
 
        :param use_existing_dir: Use an existing directory if one exists.
241
188
        """
242
 
        # Overview: put together a broad description of what we want to end up
243
 
        # with; then make as few api calls as possible to do it.
244
 
        
245
 
        # We may want to create a repo/branch/tree, if we do so what format
246
 
        # would we want for each:
 
189
        transport.ensure_base()
247
190
        require_stacking = (stacked_on is not None)
248
191
        format = self.cloning_metadir(require_stacking)
249
 
        
250
 
        # Figure out what objects we want:
 
192
        result = format.initialize_on_transport(transport)
 
193
        repository_policy = None
251
194
        try:
252
195
            local_repo = self.find_repository()
253
196
        except errors.NoRepositoryPresent:
267
210
                        errors.UnstackableRepositoryFormat,
268
211
                        errors.NotStacked):
269
212
                    pass
270
 
        # Bug: We create a metadir without knowing if it can support stacking,
271
 
        # we should look up the policy needs first, or just use it as a hint,
272
 
        # or something.
 
213
 
273
214
        if local_repo:
 
215
            # may need to copy content in
 
216
            repository_policy = result.determine_repository_policy(
 
217
                force_new_repo, stacked_on, self.root_transport.base,
 
218
                require_stacking=require_stacking)
274
219
            make_working_trees = local_repo.make_working_trees()
275
 
            want_shared = local_repo.is_shared()
276
 
            repo_format_name = format.repository_format.network_name()
277
 
        else:
278
 
            make_working_trees = False
279
 
            want_shared = False
280
 
            repo_format_name = None
281
 
 
282
 
        result_repo, result, require_stacking, repository_policy = \
283
 
            format.initialize_on_transport_ex(transport,
284
 
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
285
 
            force_new_repo=force_new_repo, stacked_on=stacked_on,
286
 
            stack_on_pwd=self.root_transport.base,
287
 
            repo_format_name=repo_format_name,
288
 
            make_working_trees=make_working_trees, shared_repo=want_shared)
289
 
        if repo_format_name:
290
 
            try:
291
 
                # If the result repository is in the same place as the
292
 
                # resulting bzr dir, it will have no content, further if the
293
 
                # result is not stacked then we know all content should be
294
 
                # copied, and finally if we are copying up to a specific
295
 
                # revision_id then we can use the pending-ancestry-result which
296
 
                # does not require traversing all of history to describe it.
297
 
                if (result_repo.user_url == result.user_url
298
 
                    and not require_stacking and
299
 
                    revision_id is not None):
300
 
                    fetch_spec = graph.PendingAncestryResult(
301
 
                        [revision_id], local_repo)
302
 
                    result_repo.fetch(local_repo, fetch_spec=fetch_spec)
303
 
                else:
304
 
                    result_repo.fetch(local_repo, revision_id=revision_id)
305
 
            finally:
306
 
                result_repo.unlock()
307
 
        else:
308
 
            if result_repo is not None:
309
 
                raise AssertionError('result_repo not None(%r)' % result_repo)
 
220
            result_repo = repository_policy.acquire_repository(
 
221
                make_working_trees, local_repo.is_shared())
 
222
            if not require_stacking and repository_policy._require_stacking:
 
223
                require_stacking = True
 
224
                result._format.require_stacking()
 
225
            result_repo.fetch(local_repo, revision_id=revision_id)
 
226
        else:
 
227
            result_repo = None
310
228
        # 1 if there is a branch present
311
229
        #   make sure its content is available in the target repository
312
230
        #   clone it.
388
306
                for subdir in sorted(subdirs, reverse=True):
389
307
                    pending.append(current_transport.clone(subdir))
390
308
 
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
309
    @staticmethod
401
310
    def find_branches(transport):
402
311
        """Find all branches under a transport.
414
323
            except errors.NoRepositoryPresent:
415
324
                pass
416
325
            else:
417
 
                return False, ([], repository)
418
 
            return True, (bzrdir.list_branches(), None)
419
 
        ret = []
420
 
        for branches, repo in BzrDir.find_bzrdirs(transport,
421
 
                                                  evaluate=evaluate):
 
326
                return False, (None, repository)
 
327
            try:
 
328
                branch = bzrdir.open_branch()
 
329
            except errors.NotBranchError:
 
330
                return True, (None, None)
 
331
            else:
 
332
                return True, (branch, None)
 
333
        branches = []
 
334
        for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
422
335
            if repo is not None:
423
 
                ret.extend(repo.find_branches())
424
 
            if branches is not None:
425
 
                ret.extend(branches)
426
 
        return ret
 
336
                branches.extend(repo.find_branches())
 
337
            if branch is not None:
 
338
                branches.append(branch)
 
339
        return branches
427
340
 
428
341
    def destroy_repository(self):
429
342
        """Destroy the repository in this BzrDir"""
430
343
        raise NotImplementedError(self.destroy_repository)
431
344
 
432
 
    def create_branch(self, name=None):
 
345
    def create_branch(self):
433
346
        """Create a branch in this BzrDir.
434
347
 
435
 
        :param name: Name of the colocated branch to create, None for
436
 
            the default branch.
437
 
 
438
348
        The bzrdir's format will control what branch format is created.
439
349
        For more control see BranchFormatXX.create(a_bzrdir).
440
350
        """
441
351
        raise NotImplementedError(self.create_branch)
442
352
 
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
 
        """
 
353
    def destroy_branch(self):
 
354
        """Destroy the branch in this BzrDir"""
449
355
        raise NotImplementedError(self.destroy_branch)
450
356
 
451
357
    @staticmethod
473
379
                                    stack_on_pwd=None, require_stacking=False):
474
380
        """Return an object representing a policy to use.
475
381
 
476
 
        This controls whether a new repository is created, and the format of
477
 
        that repository, or some existing shared repository used instead.
 
382
        This controls whether a new repository is created, or a shared
 
383
        repository used instead.
478
384
 
479
385
        If stack_on is supplied, will not seek a containing shared repo.
480
386
 
489
395
            stack_on_pwd = None
490
396
            config = found_bzrdir.get_config()
491
397
            stop = False
492
 
            stack_on = config.get_default_stack_on()
493
 
            if stack_on is not None:
494
 
                stack_on_pwd = found_bzrdir.user_url
495
 
                stop = True
 
398
            if config is not None:
 
399
                stack_on = config.get_default_stack_on()
 
400
                if stack_on is not None:
 
401
                    stack_on_pwd = found_bzrdir.root_transport.base
 
402
                    stop = True
 
403
                    note('Using default stacking branch %s at %s', stack_on,
 
404
                         stack_on_pwd)
496
405
            # does it have a repository ?
497
406
            try:
498
407
                repository = found_bzrdir.open_repository()
499
408
            except errors.NoRepositoryPresent:
500
409
                repository = None
501
410
            else:
502
 
                if (found_bzrdir.user_url != self.user_url 
503
 
                    and not repository.is_shared()):
504
 
                    # Don't look higher, can't use a higher shared repo.
 
411
                if ((found_bzrdir.root_transport.base !=
 
412
                     self.root_transport.base) and not repository.is_shared()):
505
413
                    repository = None
506
 
                    stop = True
507
414
                else:
508
415
                    stop = True
509
416
            if not stop:
533
440
    def _find_or_create_repository(self, force_new_repo):
534
441
        """Create a new repository if needed, returning the repository."""
535
442
        policy = self.determine_repository_policy(force_new_repo)
536
 
        return policy.acquire_repository()[0]
 
443
        return policy.acquire_repository()
537
444
 
538
445
    @staticmethod
539
446
    def create_branch_convenience(base, force_new_repo=False,
620
527
 
621
528
        :return: Tuple with old path name and new path name
622
529
        """
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
 
 
631
 
        backup_dir=name_gen()
632
530
        pb = ui.ui_factory.nested_progress_bar()
633
531
        try:
634
532
            # FIXME: bug 300001 -- the backup fails if the backup directory
635
533
            # already exists, but it should instead either remove it or make
636
534
            # a new backup directory.
637
535
            #
 
536
            # FIXME: bug 262450 -- the backup directory should have the same
 
537
            # permissions as the .bzr directory (probably a bug in copy_tree)
638
538
            old_path = self.root_transport.abspath('.bzr')
639
 
            new_path = self.root_transport.abspath(backup_dir)
640
 
            ui.ui_factory.note('making backup of %s\n  to %s' % (old_path, new_path,))
641
 
            self.root_transport.copy_tree('.bzr', backup_dir)
 
539
            new_path = self.root_transport.abspath('backup.bzr')
 
540
            pb.note('making backup of %s' % (old_path,))
 
541
            pb.note('  to %s' % (new_path,))
 
542
            self.root_transport.copy_tree('.bzr', 'backup.bzr')
642
543
            return (old_path, new_path)
643
544
        finally:
644
545
            pb.finished()
702
603
            if stop:
703
604
                return result
704
605
            next_transport = found_bzrdir.root_transport.clone('..')
705
 
            if (found_bzrdir.user_url == next_transport.base):
 
606
            if (found_bzrdir.root_transport.base == next_transport.base):
706
607
                # top of the file system
707
608
                return None
708
609
            # find the next containing bzrdir
725
626
                repository = found_bzrdir.open_repository()
726
627
            except errors.NoRepositoryPresent:
727
628
                return None, False
728
 
            if found_bzrdir.user_url == self.user_url:
 
629
            if found_bzrdir.root_transport.base == self.root_transport.base:
729
630
                return repository, True
730
631
            elif repository.is_shared():
731
632
                return repository, True
746
647
        """
747
648
        return None
748
649
 
749
 
    def get_branch_transport(self, branch_format, name=None):
 
650
    def get_branch_transport(self, branch_format):
750
651
        """Get the transport for use by branch format in this BzrDir.
751
652
 
752
653
        Note that bzr dirs that do not support format strings will raise
830
731
        raise NotImplementedError(self.get_workingtree_transport)
831
732
 
832
733
    def get_config(self):
833
 
        """Get configuration for this BzrDir."""
834
 
        return config.BzrDirConfig(self)
835
 
 
836
 
    def _get_config(self):
837
 
        """By default, no configuration is available."""
838
 
        return None
 
734
        if getattr(self, '_get_config', None) is None:
 
735
            return None
 
736
        return self._get_config()
839
737
 
840
738
    def __init__(self, _transport, _format):
841
739
        """Initialize a Bzr control dir object.
847
745
        :param _transport: the transport this dir is based at.
848
746
        """
849
747
        self._format = _format
850
 
        # these are also under the more standard names of 
851
 
        # control_transport and user_transport
852
748
        self.transport = _transport.clone('.bzr')
853
749
        self.root_transport = _transport
854
750
        self._mode_check_done = False
855
 
        
856
 
    @property 
857
 
    def user_transport(self):
858
 
        return self.root_transport
859
 
        
860
 
    @property
861
 
    def control_transport(self):
862
 
        return self.transport
863
751
 
864
752
    def is_control_filename(self, filename):
865
753
        """True if filename is the name of a path which is reserved for bzrdir's.
913
801
        :param transport: Transport containing the bzrdir.
914
802
        :param _unsupported: private.
915
803
        """
916
 
        for hook in BzrDir.hooks['pre_open']:
917
 
            hook(transport)
918
804
        # Keep initial base since 'transport' may be modified while following
919
805
        # the redirections.
920
806
        base = transport.base
940
826
        BzrDir._check_supported(format, _unsupported)
941
827
        return format.open(transport, _found=True)
942
828
 
943
 
    def open_branch(self, name=None, unsupported=False,
944
 
                    ignore_fallbacks=False):
 
829
    def open_branch(self, unsupported=False):
945
830
        """Open the branch object at this BzrDir if one is present.
946
831
 
947
832
        If unsupported is True, then no longer supported branch formats can
1085
970
        """
1086
971
        raise NotImplementedError(self.open_workingtree)
1087
972
 
1088
 
    def has_branch(self, name=None):
 
973
    def has_branch(self):
1089
974
        """Tell if this bzrdir contains a branch.
1090
975
 
1091
976
        Note: if you're going to open the branch, you should just go ahead
1093
978
        branch and discards it, and that's somewhat expensive.)
1094
979
        """
1095
980
        try:
1096
 
            self.open_branch(name)
 
981
            self.open_branch()
1097
982
            return True
1098
983
        except errors.NotBranchError:
1099
984
            return False
1122
1007
        result_format = self._format.__class__()
1123
1008
        try:
1124
1009
            try:
1125
 
                branch = self.open_branch(ignore_fallbacks=True)
 
1010
                branch = self.open_branch()
1126
1011
                source_repository = branch.repository
1127
1012
                result_format._branch_format = branch._format
1128
1013
            except errors.NotBranchError:
1165
1050
        """
1166
1051
        format, repository = self._cloning_metadir()
1167
1052
        if format._workingtree_format is None:
1168
 
            # No tree in self.
1169
1053
            if repository is None:
1170
 
                # No repository either
1171
1054
                return format
1172
 
            # We have a repository, so set a working tree? (Why? This seems to
1173
 
            # contradict the stated return value in the docstring).
1174
1055
            tree_format = repository._format._matchingbzrdir.workingtree_format
1175
1056
            format.workingtree_format = tree_format.__class__()
1176
1057
        if require_stacking:
1233
1114
                    source_repository = None
1234
1115
        repository_policy = result.determine_repository_policy(
1235
1116
            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
 
1117
        result_repo = repository_policy.acquire_repository()
1242
1118
        if source_repository is not None:
1243
1119
            # Fetch while stacked to prevent unstacked fetch from
1244
1120
            # 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)
 
1121
            result_repo.fetch(source_repository, revision_id=revision_id)
1249
1122
 
1250
1123
        if source_branch is None:
1251
1124
            # this is for sprouting a bzrdir without a branch; is that
1253
1126
            # Not especially, but it's part of the contract.
1254
1127
            result_branch = result.create_branch()
1255
1128
        else:
1256
 
            result_branch = source_branch.sprout(result,
1257
 
                revision_id=revision_id, repository_policy=repository_policy)
 
1129
            # Force NULL revision to avoid using repository before stacking
 
1130
            # is configured.
 
1131
            result_branch = source_branch.sprout(
 
1132
                result, revision_id=_mod_revision.NULL_REVISION)
 
1133
            parent_location = result_branch.get_parent()
1258
1134
        mutter("created new branch %r" % (result_branch,))
 
1135
        repository_policy.configure_branch(result_branch)
 
1136
        if source_branch is not None:
 
1137
            source_branch.copy_content_into(result_branch, revision_id)
 
1138
            # Override copy_content_into
 
1139
            result_branch.set_parent(parent_location)
1259
1140
 
1260
1141
        # Create/update the result working tree
1261
1142
        if (create_tree_if_local and
1303
1184
                    basis.unlock()
1304
1185
        return result
1305
1186
 
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
1365
 
 
1366
 
 
1367
 
class BzrDirHooks(hooks.Hooks):
1368
 
    """Hooks for BzrDir operations."""
1369
 
 
1370
 
    def __init__(self):
1371
 
        """Create the default hooks."""
1372
 
        hooks.Hooks.__init__(self)
1373
 
        self.create_hook(hooks.HookPoint('pre_open',
1374
 
            "Invoked before attempting to open a BzrDir with the transport "
1375
 
            "that the open will use.", (1, 14), None))
1376
 
        self.create_hook(hooks.HookPoint('post_repo_init',
1377
 
            "Invoked after a repository has been initialized. "
1378
 
            "post_repo_init is called with a "
1379
 
            "bzrlib.bzrdir.RepoInitHookParams.",
1380
 
            (2, 2), None))
1381
 
 
1382
 
# install the default hooks
1383
 
BzrDir.hooks = BzrDirHooks()
1384
 
 
1385
 
 
1386
 
class RepoInitHookParams(object):
1387
 
    """Object holding parameters passed to *_repo_init hooks.
1388
 
 
1389
 
    There are 4 fields that hooks may wish to access:
1390
 
 
1391
 
    :ivar repository: Repository created
1392
 
    :ivar format: Repository format
1393
 
    :ivar bzrdir: The bzrdir for the repository
1394
 
    :ivar shared: The repository is shared
1395
 
    """
1396
 
 
1397
 
    def __init__(self, repository, format, a_bzrdir, shared):
1398
 
        """Create a group of RepoInitHook parameters.
1399
 
 
1400
 
        :param repository: Repository created
1401
 
        :param format: Repository format
1402
 
        :param bzrdir: The bzrdir for the repository
1403
 
        :param shared: The repository is shared
1404
 
        """
1405
 
        self.repository = repository
1406
 
        self.format = format
1407
 
        self.bzrdir = a_bzrdir
1408
 
        self.shared = shared
1409
 
 
1410
 
    def __eq__(self, other):
1411
 
        return self.__dict__ == other.__dict__
1412
 
 
1413
 
    def __repr__(self):
1414
 
        if self.repository:
1415
 
            return "<%s for %s>" % (self.__class__.__name__,
1416
 
                self.repository)
1417
 
        else:
1418
 
            return "<%s for %s>" % (self.__class__.__name__,
1419
 
                self.bzrdir)
1420
 
 
1421
1187
 
1422
1188
class BzrDirPreSplitOut(BzrDir):
1423
1189
    """A common class for the all-in-one formats."""
1463
1229
            tree.clone(result)
1464
1230
        return result
1465
1231
 
1466
 
    def create_branch(self, name=None):
 
1232
    def create_branch(self):
1467
1233
        """See BzrDir.create_branch."""
1468
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1234
        return self._format.get_branch_format().initialize(self)
1469
1235
 
1470
 
    def destroy_branch(self, name=None):
 
1236
    def destroy_branch(self):
1471
1237
        """See BzrDir.destroy_branch."""
1472
1238
        raise errors.UnsupportedOperation(self.destroy_branch, self)
1473
1239
 
1496
1262
        # that can do wonky stuff here, and that only
1497
1263
        # happens for creating checkouts, which cannot be
1498
1264
        # done on this format anyway. So - acceptable wart.
1499
 
        if hardlink:
1500
 
            warning("can't support hardlinked working trees in %r"
1501
 
                % (self,))
1502
1265
        try:
1503
1266
            result = self.open_workingtree(recommend_upgrade=False)
1504
1267
        except errors.NoSuchFile:
1529
1292
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1530
1293
                                          self)
1531
1294
 
1532
 
    def get_branch_transport(self, branch_format, name=None):
 
1295
    def get_branch_transport(self, branch_format):
1533
1296
        """See BzrDir.get_branch_transport()."""
1534
 
        if name is not None:
1535
 
            raise errors.NoColocatedBranchSupport(self)
1536
1297
        if branch_format is None:
1537
1298
            return self.transport
1538
1299
        try:
1571
1332
            format = BzrDirFormat.get_default_format()
1572
1333
        return not isinstance(self._format, format.__class__)
1573
1334
 
1574
 
    def open_branch(self, name=None, unsupported=False,
1575
 
                    ignore_fallbacks=False):
 
1335
    def open_branch(self, unsupported=False):
1576
1336
        """See BzrDir.open_branch."""
1577
1337
        from bzrlib.branch import BzrBranchFormat4
1578
1338
        format = BzrBranchFormat4()
1579
1339
        self._check_supported(format, unsupported)
1580
 
        return format.open(self, name, _found=True)
 
1340
        return format.open(self, _found=True)
1581
1341
 
1582
1342
    def sprout(self, url, revision_id=None, force_new_repo=False,
1583
1343
               possible_transports=None, accelerator_tree=None,
1584
 
               hardlink=False, stacked=False, create_tree_if_local=True,
1585
 
               source_branch=None):
 
1344
               hardlink=False, stacked=False, create_tree_if_local=True):
1586
1345
        """See BzrDir.sprout()."""
1587
 
        if source_branch is not None:
1588
 
            my_branch = self.open_branch()
1589
 
            if source_branch.base != my_branch.base:
1590
 
                raise AssertionError(
1591
 
                    "source branch %r is not within %r with branch %r" %
1592
 
                    (source_branch, self, my_branch))
1593
1346
        if stacked:
1594
1347
            raise errors.UnstackableBranchFormat(
1595
1348
                self._format, self.root_transport.base)
1644
1397
    This is a deprecated format and may be removed after sept 2006.
1645
1398
    """
1646
1399
 
1647
 
    def has_workingtree(self):
1648
 
        """See BzrDir.has_workingtree."""
1649
 
        return True
1650
 
    
1651
1400
    def open_repository(self):
1652
1401
        """See BzrDir.open_repository."""
1653
1402
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1669
1418
    This is a deprecated format and may be removed after sept 2006.
1670
1419
    """
1671
1420
 
1672
 
    def has_workingtree(self):
1673
 
        """See BzrDir.has_workingtree."""
1674
 
        return True
1675
 
    
1676
1421
    def open_repository(self):
1677
1422
        """See BzrDir.open_repository."""
1678
1423
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1700
1445
        """See BzrDir.can_convert_format()."""
1701
1446
        return True
1702
1447
 
1703
 
    def create_branch(self, name=None):
 
1448
    def create_branch(self):
1704
1449
        """See BzrDir.create_branch."""
1705
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1450
        return self._format.get_branch_format().initialize(self)
1706
1451
 
1707
 
    def destroy_branch(self, name=None):
 
1452
    def destroy_branch(self):
1708
1453
        """See BzrDir.create_branch."""
1709
 
        if name is not None:
1710
 
            raise errors.NoColocatedBranchSupport(self)
1711
1454
        self.transport.delete_tree('branch')
1712
1455
 
1713
1456
    def create_repository(self, shared=False):
1756
1499
        format = BranchFormat.find_format(self)
1757
1500
        return format.get_reference(self)
1758
1501
 
1759
 
    def get_branch_transport(self, branch_format, name=None):
 
1502
    def get_branch_transport(self, branch_format):
1760
1503
        """See BzrDir.get_branch_transport()."""
1761
 
        if name is not None:
1762
 
            raise errors.NoColocatedBranchSupport(self)
1763
 
        # XXX: this shouldn't implicitly create the directory if it's just
1764
 
        # promising to get a transport -- mbp 20090727
1765
1504
        if branch_format is None:
1766
1505
            return self.transport.clone('branch')
1767
1506
        try:
1802
1541
            pass
1803
1542
        return self.transport.clone('checkout')
1804
1543
 
1805
 
    def has_workingtree(self):
1806
 
        """Tell if this bzrdir contains a working tree.
1807
 
 
1808
 
        This will still raise an exception if the bzrdir has a workingtree that
1809
 
        is remote & inaccessible.
1810
 
 
1811
 
        Note: if you're going to open the working tree, you should just go
1812
 
        ahead and try, and not ask permission first.
1813
 
        """
1814
 
        from bzrlib.workingtree import WorkingTreeFormat
1815
 
        try:
1816
 
            WorkingTreeFormat.find_format(self)
1817
 
        except errors.NoWorkingTree:
1818
 
            return False
1819
 
        return True
1820
 
 
1821
1544
    def needs_format_conversion(self, format=None):
1822
1545
        """See BzrDir.needs_format_conversion()."""
1823
1546
        if format is None:
1836
1559
                return True
1837
1560
        except errors.NoRepositoryPresent:
1838
1561
            pass
1839
 
        for branch in self.list_branches():
1840
 
            if not isinstance(branch._format,
 
1562
        try:
 
1563
            if not isinstance(self.open_branch()._format,
1841
1564
                              format.get_branch_format().__class__):
1842
1565
                # the branch needs an upgrade.
1843
1566
                return True
 
1567
        except errors.NotBranchError:
 
1568
            pass
1844
1569
        try:
1845
1570
            my_wt = self.open_workingtree(recommend_upgrade=False)
1846
1571
            if not isinstance(my_wt._format,
1851
1576
            pass
1852
1577
        return False
1853
1578
 
1854
 
    def open_branch(self, name=None, unsupported=False,
1855
 
                    ignore_fallbacks=False):
 
1579
    def open_branch(self, unsupported=False):
1856
1580
        """See BzrDir.open_branch."""
1857
1581
        format = self.find_branch_format()
1858
1582
        self._check_supported(format, unsupported)
1859
 
        return format.open(self, name=name,
1860
 
            _found=True, ignore_fallbacks=ignore_fallbacks)
 
1583
        return format.open(self, _found=True)
1861
1584
 
1862
1585
    def open_repository(self, unsupported=False):
1863
1586
        """See BzrDir.open_repository."""
1877
1600
        return format.open(self, _found=True)
1878
1601
 
1879
1602
    def _get_config(self):
1880
 
        return config.TransportConfig(self.transport, 'control.conf')
 
1603
        return config.BzrDirConfig(self.transport)
1881
1604
 
1882
1605
 
1883
1606
class BzrDirFormat(object):
1895
1618
    Once a format is deprecated, just deprecate the initialize and open
1896
1619
    methods on the format class. Do not deprecate the object, as the
1897
1620
    object will be created every system load.
1898
 
 
1899
 
    :cvar colocated_branches: Whether this formats supports colocated branches.
1900
1621
    """
1901
1622
 
1902
1623
    _default_format = None
1919
1640
 
1920
1641
    _lock_file_name = 'branch-lock'
1921
1642
 
1922
 
    colocated_branches = False
1923
 
    """Whether co-located branches are supported for this control dir format.
1924
 
    """
1925
 
 
1926
1643
    # _lock_class must be set in subclasses to the lock type, typ.
1927
1644
    # TransportLock or LockDir
1928
1645
 
1945
1662
    def probe_transport(klass, transport):
1946
1663
        """Return the .bzrdir style format present in a directory."""
1947
1664
        try:
1948
 
            format_string = transport.get_bytes(".bzr/branch-format")
 
1665
            format_string = transport.get(".bzr/branch-format").read()
1949
1666
        except errors.NoSuchFile:
1950
1667
            raise errors.NotBranchError(path=transport.base)
1951
1668
 
1984
1701
    def initialize(self, url, possible_transports=None):
1985
1702
        """Create a bzr control dir at this url and return an opened copy.
1986
1703
 
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
1704
        Subclasses should typically override initialize_on_transport
1992
1705
        instead of this method.
1993
1706
        """
2012
1725
            self._supply_sub_formats_to(remote_format)
2013
1726
            return remote_format.initialize_on_transport(transport)
2014
1727
 
2015
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2016
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
2017
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2018
 
        shared_repo=False, vfs_only=False):
2019
 
        """Create this format on transport.
2020
 
 
2021
 
        The directory to initialize will be created.
2022
 
 
2023
 
        :param force_new_repo: Do not use a shared repository for the target,
2024
 
                               even if one is available.
2025
 
        :param create_prefix: Create any missing directories leading up to
2026
 
            to_transport.
2027
 
        :param use_existing_dir: Use an existing directory if one exists.
2028
 
        :param stacked_on: A url to stack any created branch on, None to follow
2029
 
            any target stacking policy.
2030
 
        :param stack_on_pwd: If stack_on is relative, the location it is
2031
 
            relative to.
2032
 
        :param repo_format_name: If non-None, a repository will be
2033
 
            made-or-found. Should none be found, or if force_new_repo is True
2034
 
            the repo_format_name is used to select the format of repository to
2035
 
            create.
2036
 
        :param make_working_trees: Control the setting of make_working_trees
2037
 
            for a new shared repository when one is made. None to use whatever
2038
 
            default the format has.
2039
 
        :param shared_repo: Control whether made repositories are shared or
2040
 
            not.
2041
 
        :param vfs_only: If True do not attempt to use a smart server
2042
 
        :return: repo, bzrdir, require_stacking, repository_policy. repo is
2043
 
            None if none was created or found, bzrdir is always valid.
2044
 
            require_stacking is the result of examining the stacked_on
2045
 
            parameter and any stacking policy found for the target.
2046
 
        """
2047
 
        if not vfs_only:
2048
 
            # Try to hand off to a smart server 
2049
 
            try:
2050
 
                client_medium = transport.get_smart_medium()
2051
 
            except errors.NoSmartMedium:
2052
 
                pass
2053
 
            else:
2054
 
                # TODO: lookup the local format from a server hint.
2055
 
                remote_dir_format = RemoteBzrDirFormat()
2056
 
                remote_dir_format._network_name = self.network_name()
2057
 
                self._supply_sub_formats_to(remote_dir_format)
2058
 
                return remote_dir_format.initialize_on_transport_ex(transport,
2059
 
                    use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2060
 
                    force_new_repo=force_new_repo, stacked_on=stacked_on,
2061
 
                    stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2062
 
                    make_working_trees=make_working_trees, shared_repo=shared_repo)
2063
 
        # XXX: Refactor the create_prefix/no_create_prefix code into a
2064
 
        #      common helper function
2065
 
        # The destination may not exist - if so make it according to policy.
2066
 
        def make_directory(transport):
2067
 
            transport.mkdir('.')
2068
 
            return transport
2069
 
        def redirected(transport, e, redirection_notice):
2070
 
            note(redirection_notice)
2071
 
            return transport._redirected_to(e.source, e.target)
2072
 
        try:
2073
 
            transport = do_catching_redirections(make_directory, transport,
2074
 
                redirected)
2075
 
        except errors.FileExists:
2076
 
            if not use_existing_dir:
2077
 
                raise
2078
 
        except errors.NoSuchFile:
2079
 
            if not create_prefix:
2080
 
                raise
2081
 
            transport.create_prefix()
2082
 
 
2083
 
        require_stacking = (stacked_on is not None)
2084
 
        # Now the target directory exists, but doesn't have a .bzr
2085
 
        # directory. So we need to create it, along with any work to create
2086
 
        # all of the dependent branches, etc.
2087
 
 
2088
 
        result = self.initialize_on_transport(transport)
2089
 
        if repo_format_name:
2090
 
            try:
2091
 
                # use a custom format
2092
 
                result._format.repository_format = \
2093
 
                    repository.network_format_registry.get(repo_format_name)
2094
 
            except AttributeError:
2095
 
                # The format didn't permit it to be set.
2096
 
                pass
2097
 
            # A repository is desired, either in-place or shared.
2098
 
            repository_policy = result.determine_repository_policy(
2099
 
                force_new_repo, stacked_on, stack_on_pwd,
2100
 
                require_stacking=require_stacking)
2101
 
            result_repo, is_new_repo = repository_policy.acquire_repository(
2102
 
                make_working_trees, shared_repo)
2103
 
            if not require_stacking and repository_policy._require_stacking:
2104
 
                require_stacking = True
2105
 
                result._format.require_stacking()
2106
 
            result_repo.lock_write()
2107
 
        else:
2108
 
            result_repo = None
2109
 
            repository_policy = None
2110
 
        return result_repo, result, require_stacking, repository_policy
2111
 
 
2112
1728
    def _initialize_on_transport_vfs(self, transport):
2113
1729
        """Initialize a new bzrdir using VFS calls.
2114
1730
 
2156
1772
        """
2157
1773
        return True
2158
1774
 
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
1775
    def same_model(self, target_format):
2170
1776
        return (self.repository_format.rich_root_data ==
2171
1777
            target_format.rich_root_data)
2216
1822
    @classmethod
2217
1823
    def register_format(klass, format):
2218
1824
        klass._formats[format.get_format_string()] = format
2219
 
        # bzr native formats have a network name of their format string.
2220
 
        network_format_registry.register(format.get_format_string(), format.__class__)
2221
1825
 
2222
1826
    @classmethod
2223
1827
    def register_control_format(klass, format):
2312
1916
        """
2313
1917
        return False
2314
1918
 
2315
 
    def network_name(self):
2316
 
        return self.get_format_string()
2317
 
 
2318
1919
    def _open(self, transport):
2319
1920
        """See BzrDirFormat._open."""
2320
1921
        return BzrDir4(transport, self)
2326
1927
    repository_format = property(__return_repository_format)
2327
1928
 
2328
1929
 
2329
 
class BzrDirFormatAllInOne(BzrDirFormat):
2330
 
    """Common class for formats before meta-dirs."""
2331
 
 
2332
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2333
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
2334
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2335
 
        shared_repo=False):
2336
 
        """See BzrDirFormat.initialize_on_transport_ex."""
2337
 
        require_stacking = (stacked_on is not None)
2338
 
        # Format 5 cannot stack, but we've been asked to - actually init
2339
 
        # a Meta1Dir
2340
 
        if require_stacking:
2341
 
            format = BzrDirMetaFormat1()
2342
 
            return format.initialize_on_transport_ex(transport,
2343
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2344
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
2345
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2346
 
                make_working_trees=make_working_trees, shared_repo=shared_repo)
2347
 
        return BzrDirFormat.initialize_on_transport_ex(self, transport,
2348
 
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2349
 
            force_new_repo=force_new_repo, stacked_on=stacked_on,
2350
 
            stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2351
 
            make_working_trees=make_working_trees, shared_repo=shared_repo)
2352
 
 
2353
 
 
2354
 
class BzrDirFormat5(BzrDirFormatAllInOne):
 
1930
class BzrDirFormat5(BzrDirFormat):
2355
1931
    """Bzr control format 5.
2356
1932
 
2357
1933
    This format is a combined format for working tree, branch and repository.
2398
1974
            result._init_workingtree()
2399
1975
        return result
2400
1976
 
2401
 
    def network_name(self):
2402
 
        return self.get_format_string()
2403
 
 
2404
1977
    def _open(self, transport):
2405
1978
        """See BzrDirFormat._open."""
2406
1979
        return BzrDir5(transport, self)
2412
1985
    repository_format = property(__return_repository_format)
2413
1986
 
2414
1987
 
2415
 
class BzrDirFormat6(BzrDirFormatAllInOne):
 
1988
class BzrDirFormat6(BzrDirFormat):
2416
1989
    """Bzr control format 6.
2417
1990
 
2418
1991
    This format is a combined format for working tree, branch and repository.
2458
2031
            result._init_workingtree()
2459
2032
        return result
2460
2033
 
2461
 
    def network_name(self):
2462
 
        return self.get_format_string()
2463
 
 
2464
2034
    def _open(self, transport):
2465
2035
        """See BzrDirFormat._open."""
2466
2036
        return BzrDir6(transport, self)
2488
2058
    def __init__(self):
2489
2059
        self._workingtree_format = None
2490
2060
        self._branch_format = None
2491
 
        self._repository_format = None
2492
2061
 
2493
2062
    def __eq__(self, other):
2494
2063
        if other.__class__ is not self.__class__:
2511
2080
    def set_branch_format(self, format):
2512
2081
        self._branch_format = format
2513
2082
 
2514
 
    def require_stacking(self, stack_on=None, possible_transports=None,
2515
 
            _skip_repo=False):
2516
 
        """We have a request to stack, try to ensure the formats support it.
2517
 
 
2518
 
        :param stack_on: If supplied, it is the URL to a branch that we want to
2519
 
            stack on. Check to see if that format supports stacking before
2520
 
            forcing an upgrade.
2521
 
        """
2522
 
        # Stacking is desired. requested by the target, but does the place it
2523
 
        # points at support stacking? If it doesn't then we should
2524
 
        # not implicitly upgrade. We check this here.
2525
 
        new_repo_format = None
2526
 
        new_branch_format = None
2527
 
 
2528
 
        # a bit of state for get_target_branch so that we don't try to open it
2529
 
        # 2 times, for both repo *and* branch
2530
 
        target = [None, False, None] # target_branch, checked, upgrade anyway
2531
 
        def get_target_branch():
2532
 
            if target[1]:
2533
 
                # We've checked, don't check again
2534
 
                return target
2535
 
            if stack_on is None:
2536
 
                # No target format, that means we want to force upgrading
2537
 
                target[:] = [None, True, True]
2538
 
                return target
2539
 
            try:
2540
 
                target_dir = BzrDir.open(stack_on,
2541
 
                    possible_transports=possible_transports)
2542
 
            except errors.NotBranchError:
2543
 
                # Nothing there, don't change formats
2544
 
                target[:] = [None, True, False]
2545
 
                return target
2546
 
            except errors.JailBreak:
2547
 
                # JailBreak, JFDI and upgrade anyway
2548
 
                target[:] = [None, True, True]
2549
 
                return target
2550
 
            try:
2551
 
                target_branch = target_dir.open_branch()
2552
 
            except errors.NotBranchError:
2553
 
                # No branch, don't upgrade formats
2554
 
                target[:] = [None, True, False]
2555
 
                return target
2556
 
            target[:] = [target_branch, True, False]
2557
 
            return target
2558
 
 
2559
 
        if (not _skip_repo and
2560
 
                 not self.repository_format.supports_external_lookups):
2561
 
            # We need to upgrade the Repository.
2562
 
            target_branch, _, do_upgrade = get_target_branch()
2563
 
            if target_branch is None:
2564
 
                # We don't have a target branch, should we upgrade anyway?
2565
 
                if do_upgrade:
2566
 
                    # stack_on is inaccessible, JFDI.
2567
 
                    # TODO: bad monkey, hard-coded formats...
2568
 
                    if self.repository_format.rich_root_data:
2569
 
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2570
 
                    else:
2571
 
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5()
2572
 
            else:
2573
 
                # If the target already supports stacking, then we know the
2574
 
                # project is already able to use stacking, so auto-upgrade
2575
 
                # for them
2576
 
                new_repo_format = target_branch.repository._format
2577
 
                if not new_repo_format.supports_external_lookups:
2578
 
                    # target doesn't, source doesn't, so don't auto upgrade
2579
 
                    # repo
2580
 
                    new_repo_format = None
2581
 
            if new_repo_format is not None:
2582
 
                self.repository_format = new_repo_format
2583
 
                note('Source repository format does not support stacking,'
2584
 
                     ' using format:\n  %s',
2585
 
                     new_repo_format.get_format_description())
2586
 
 
 
2083
    def require_stacking(self):
2587
2084
        if not self.get_branch_format().supports_stacking():
2588
 
            # We just checked the repo, now lets check if we need to
2589
 
            # upgrade the branch format
2590
 
            target_branch, _, do_upgrade = get_target_branch()
2591
 
            if target_branch is None:
2592
 
                if do_upgrade:
2593
 
                    # TODO: bad monkey, hard-coded formats...
2594
 
                    new_branch_format = branch.BzrBranchFormat7()
 
2085
            # We need to make a stacked branch, but the default format for the
 
2086
            # target doesn't support stacking.  So force a branch that *can*
 
2087
            # support stacking.
 
2088
            from bzrlib.branch import BzrBranchFormat7
 
2089
            branch_format = BzrBranchFormat7()
 
2090
            self.set_branch_format(branch_format)
 
2091
            mutter("using %r for stacking" % (branch_format,))
 
2092
            from bzrlib.repofmt import pack_repo
 
2093
            if self.repository_format.rich_root_data:
 
2094
                bzrdir_format_name = '1.6.1-rich-root'
 
2095
                repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2595
2096
            else:
2596
 
                new_branch_format = target_branch._format
2597
 
                if not new_branch_format.supports_stacking():
2598
 
                    new_branch_format = None
2599
 
            if new_branch_format is not None:
2600
 
                # Does support stacking, use its format.
2601
 
                self.set_branch_format(new_branch_format)
2602
 
                note('Source branch format does not support stacking,'
2603
 
                     ' using format:\n  %s',
2604
 
                     new_branch_format.get_format_description())
 
2097
                bzrdir_format_name = '1.6'
 
2098
                repo_format = pack_repo.RepositoryFormatKnitPack5()
 
2099
            note('Source format does not support stacking, using format:'
 
2100
                 ' \'%s\'\n  %s\n',
 
2101
                 bzrdir_format_name, repo_format.get_format_description())
 
2102
            self.repository_format = repo_format
2605
2103
 
2606
2104
    def get_converter(self, format=None):
2607
2105
        """See BzrDirFormat.get_converter()."""
2620
2118
        """See BzrDirFormat.get_format_description()."""
2621
2119
        return "Meta directory format 1"
2622
2120
 
2623
 
    def network_name(self):
2624
 
        return self.get_format_string()
2625
 
 
2626
2121
    def _open(self, transport):
2627
2122
        """See BzrDirFormat._open."""
2628
 
        # Create a new format instance because otherwise initialisation of new
2629
 
        # metadirs share the global default format object leading to alias
2630
 
        # problems.
2631
 
        format = BzrDirMetaFormat1()
2632
 
        self._supply_sub_formats_to(format)
2633
 
        return BzrDirMeta1(transport, format)
 
2123
        return BzrDirMeta1(transport, self)
2634
2124
 
2635
2125
    def __return_repository_format(self):
2636
2126
        """Circular import protection."""
2637
 
        if self._repository_format:
 
2127
        if getattr(self, '_repository_format', None):
2638
2128
            return self._repository_format
2639
2129
        from bzrlib.repository import RepositoryFormat
2640
2130
        return RepositoryFormat.get_default_format()
2677
2167
                                  __set_workingtree_format)
2678
2168
 
2679
2169
 
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
2170
# Register bzr control format
2690
2171
BzrDirFormat.register_control_format(BzrDirFormat)
2691
2172
 
2727
2208
    def convert(self, to_convert, pb):
2728
2209
        """See Converter.convert()."""
2729
2210
        self.bzrdir = to_convert
2730
 
        if pb is not None:
2731
 
            warnings.warn("pb parameter to convert() is deprecated")
2732
 
        self.pb = ui.ui_factory.nested_progress_bar()
2733
 
        try:
2734
 
            ui.ui_factory.note('starting upgrade from format 4 to 5')
2735
 
            if isinstance(self.bzrdir.transport, local.LocalTransport):
2736
 
                self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2737
 
            self._convert_to_weaves()
2738
 
            return BzrDir.open(self.bzrdir.user_url)
2739
 
        finally:
2740
 
            self.pb.finished()
 
2211
        self.pb = pb
 
2212
        self.pb.note('starting upgrade from format 4 to 5')
 
2213
        if isinstance(self.bzrdir.transport, local.LocalTransport):
 
2214
            self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
 
2215
        self._convert_to_weaves()
 
2216
        return BzrDir.open(self.bzrdir.root_transport.base)
2741
2217
 
2742
2218
    def _convert_to_weaves(self):
2743
 
        ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
 
2219
        self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2744
2220
        try:
2745
2221
            # TODO permissions
2746
2222
            stat = self.bzrdir.transport.stat('weaves')
2774
2250
        self.pb.clear()
2775
2251
        self._write_all_weaves()
2776
2252
        self._write_all_revs()
2777
 
        ui.ui_factory.note('upgraded to weaves:')
2778
 
        ui.ui_factory.note('  %6d revisions and inventories' % len(self.revisions))
2779
 
        ui.ui_factory.note('  %6d revisions not present' % len(self.absent_revisions))
2780
 
        ui.ui_factory.note('  %6d texts' % self.text_count)
 
2253
        self.pb.note('upgraded to weaves:')
 
2254
        self.pb.note('  %6d revisions and inventories', len(self.revisions))
 
2255
        self.pb.note('  %6d revisions not present', len(self.absent_revisions))
 
2256
        self.pb.note('  %6d texts', self.text_count)
2781
2257
        self._cleanup_spare_files_after_format4()
2782
2258
        self.branch._transport.put_bytes(
2783
2259
            'branch-format',
2851
2327
                       len(self.known_revisions))
2852
2328
        if not self.branch.repository.has_revision(rev_id):
2853
2329
            self.pb.clear()
2854
 
            ui.ui_factory.note('revision {%s} not present in branch; '
2855
 
                         'will be converted as a ghost' %
 
2330
            self.pb.note('revision {%s} not present in branch; '
 
2331
                         'will be converted as a ghost',
2856
2332
                         rev_id)
2857
2333
            self.absent_revisions.add(rev_id)
2858
2334
        else:
2927
2403
        self.snapshot_ie(previous_entries, ie, w, rev_id)
2928
2404
        del ie.text_id
2929
2405
 
 
2406
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
 
2407
    def get_parents(self, revision_ids):
 
2408
        for revision_id in revision_ids:
 
2409
            yield self.revisions[revision_id].parent_ids
 
2410
 
2930
2411
    def get_parent_map(self, revision_ids):
2931
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
2412
        """See graph._StackedParentsProvider.get_parent_map"""
2932
2413
        return dict((revision_id, self.revisions[revision_id])
2933
2414
                    for revision_id in revision_ids
2934
2415
                     if revision_id in self.revisions)
2984
2465
    def convert(self, to_convert, pb):
2985
2466
        """See Converter.convert()."""
2986
2467
        self.bzrdir = to_convert
2987
 
        pb = ui.ui_factory.nested_progress_bar()
2988
 
        try:
2989
 
            ui.ui_factory.note('starting upgrade from format 5 to 6')
2990
 
            self._convert_to_prefixed()
2991
 
            return BzrDir.open(self.bzrdir.user_url)
2992
 
        finally:
2993
 
            pb.finished()
 
2468
        self.pb = pb
 
2469
        self.pb.note('starting upgrade from format 5 to 6')
 
2470
        self._convert_to_prefixed()
 
2471
        return BzrDir.open(self.bzrdir.root_transport.base)
2994
2472
 
2995
2473
    def _convert_to_prefixed(self):
2996
2474
        from bzrlib.store import TransportStore
2997
2475
        self.bzrdir.transport.delete('branch-format')
2998
2476
        for store_name in ["weaves", "revision-store"]:
2999
 
            ui.ui_factory.note("adding prefixes to %s" % store_name)
 
2477
            self.pb.note("adding prefixes to %s" % store_name)
3000
2478
            store_transport = self.bzrdir.transport.clone(store_name)
3001
2479
            store = TransportStore(store_transport, prefixed=True)
3002
2480
            for urlfilename in store_transport.list_dir('.'):
3029
2507
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
3030
2508
        from bzrlib.branch import BzrBranchFormat5
3031
2509
        self.bzrdir = to_convert
3032
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2510
        self.pb = pb
3033
2511
        self.count = 0
3034
2512
        self.total = 20 # the steps we know about
3035
2513
        self.garbage_inventories = []
3036
2514
        self.dir_mode = self.bzrdir._get_dir_mode()
3037
2515
        self.file_mode = self.bzrdir._get_file_mode()
3038
2516
 
3039
 
        ui.ui_factory.note('starting upgrade from format 6 to metadir')
 
2517
        self.pb.note('starting upgrade from format 6 to metadir')
3040
2518
        self.bzrdir.transport.put_bytes(
3041
2519
                'branch-format',
3042
2520
                "Converting to format 6",
3092
2570
        else:
3093
2571
            has_checkout = True
3094
2572
        if not has_checkout:
3095
 
            ui.ui_factory.note('No working tree.')
 
2573
            self.pb.note('No working tree.')
3096
2574
            # If some checkout files are there, we may as well get rid of them.
3097
2575
            for name, mandatory in checkout_files:
3098
2576
                if name in bzrcontents:
3115
2593
            'branch-format',
3116
2594
            BzrDirMetaFormat1().get_format_string(),
3117
2595
            mode=self.file_mode)
3118
 
        self.pb.finished()
3119
 
        return BzrDir.open(self.bzrdir.user_url)
 
2596
        return BzrDir.open(self.bzrdir.root_transport.base)
3120
2597
 
3121
2598
    def make_lock(self, name):
3122
2599
        """Make a lock for the new control dir name."""
3157
2634
    def convert(self, to_convert, pb):
3158
2635
        """See Converter.convert()."""
3159
2636
        self.bzrdir = to_convert
3160
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2637
        self.pb = pb
3161
2638
        self.count = 0
3162
2639
        self.total = 1
3163
2640
        self.step('checking repository format')
3168
2645
        else:
3169
2646
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
3170
2647
                from bzrlib.repository import CopyConverter
3171
 
                ui.ui_factory.note('starting repository conversion')
 
2648
                self.pb.note('starting repository conversion')
3172
2649
                converter = CopyConverter(self.target_format.repository_format)
3173
2650
                converter.convert(repo, pb)
3174
 
        for branch in self.bzrdir.list_branches():
 
2651
        try:
 
2652
            branch = self.bzrdir.open_branch()
 
2653
        except errors.NotBranchError:
 
2654
            pass
 
2655
        else:
3175
2656
            # TODO: conversions of Branch and Tree should be done by
3176
2657
            # InterXFormat lookups/some sort of registry.
3177
2658
            # Avoid circular imports
3181
2662
            while old != new:
3182
2663
                if (old == _mod_branch.BzrBranchFormat5 and
3183
2664
                    new in (_mod_branch.BzrBranchFormat6,
3184
 
                        _mod_branch.BzrBranchFormat7,
3185
 
                        _mod_branch.BzrBranchFormat8)):
 
2665
                        _mod_branch.BzrBranchFormat7)):
3186
2666
                    branch_converter = _mod_branch.Converter5to6()
3187
2667
                elif (old == _mod_branch.BzrBranchFormat6 and
3188
 
                    new in (_mod_branch.BzrBranchFormat7,
3189
 
                            _mod_branch.BzrBranchFormat8)):
 
2668
                    new == _mod_branch.BzrBranchFormat7):
3190
2669
                    branch_converter = _mod_branch.Converter6to7()
3191
 
                elif (old == _mod_branch.BzrBranchFormat7 and
3192
 
                      new is _mod_branch.BzrBranchFormat8):
3193
 
                    branch_converter = _mod_branch.Converter7to8()
3194
2670
                else:
3195
 
                    raise errors.BadConversionTarget("No converter", new,
3196
 
                        branch._format)
 
2671
                    raise errors.BadConversionTarget("No converter", new)
3197
2672
                branch_converter.convert(branch)
3198
2673
                branch = self.bzrdir.open_branch()
3199
2674
                old = branch._format.__class__
3214
2689
                isinstance(self.target_format.workingtree_format,
3215
2690
                    workingtree_4.WorkingTreeFormat5)):
3216
2691
                workingtree_4.Converter4to5().convert(tree)
3217
 
            if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3218
 
                not isinstance(tree, workingtree_4.WorkingTree6) and
3219
 
                isinstance(self.target_format.workingtree_format,
3220
 
                    workingtree_4.WorkingTreeFormat6)):
3221
 
                workingtree_4.Converter4or5to6().convert(tree)
3222
 
        self.pb.finished()
3223
2692
        return to_convert
3224
2693
 
3225
2694
 
3226
 
# This is not in remote.py because it's relatively small, and needs to be
3227
 
# registered. Putting it in remote.py creates a circular import problem.
 
2695
# This is not in remote.py because it's small, and needs to be registered.
 
2696
# Putting it in remote.py creates a circular import problem.
3228
2697
# we can make it a lazy object if the control formats is turned into something
3229
2698
# like a registry.
3230
2699
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3231
2700
    """Format representing bzrdirs accessed via a smart server"""
3232
2701
 
3233
 
    def __init__(self):
3234
 
        BzrDirMetaFormat1.__init__(self)
3235
 
        # XXX: It's a bit ugly that the network name is here, because we'd
3236
 
        # like to believe that format objects are stateless or at least
3237
 
        # immutable,  However, we do at least avoid mutating the name after
3238
 
        # it's returned.  See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
3239
 
        self._network_name = None
3240
 
 
3241
 
    def __repr__(self):
3242
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
3243
 
            self._network_name)
3244
 
 
3245
2702
    def get_format_description(self):
3246
 
        if self._network_name:
3247
 
            real_format = network_format_registry.get(self._network_name)
3248
 
            return 'Remote: ' + real_format.get_format_description()
3249
2703
        return 'bzr remote bzrdir'
3250
2704
 
3251
2705
    def get_format_string(self):
3252
2706
        raise NotImplementedError(self.get_format_string)
3253
2707
 
3254
 
    def network_name(self):
3255
 
        if self._network_name:
3256
 
            return self._network_name
3257
 
        else:
3258
 
            raise AssertionError("No network name set.")
3259
 
 
3260
2708
    @classmethod
3261
2709
    def probe_transport(klass, transport):
3262
2710
        """Return a RemoteBzrDirFormat object if it looks possible."""
3291
2739
            return local_dir_format.initialize_on_transport(transport)
3292
2740
        client = _SmartClient(client_medium)
3293
2741
        path = client.remote_path_from_transport(transport)
3294
 
        try:
3295
 
            response = client.call('BzrDirFormat.initialize', path)
3296
 
        except errors.ErrorFromSmartServer, err:
3297
 
            remote._translate_error(err, path=path)
 
2742
        response = client.call('BzrDirFormat.initialize', path)
3298
2743
        if response[0] != 'ok':
3299
2744
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3300
2745
        format = RemoteBzrDirFormat()
3301
2746
        self._supply_sub_formats_to(format)
3302
2747
        return remote.RemoteBzrDir(transport, format)
3303
2748
 
3304
 
    def parse_NoneTrueFalse(self, arg):
3305
 
        if not arg:
3306
 
            return None
3307
 
        if arg == 'False':
3308
 
            return False
3309
 
        if arg == 'True':
3310
 
            return True
3311
 
        raise AssertionError("invalid arg %r" % arg)
3312
 
 
3313
 
    def _serialize_NoneTrueFalse(self, arg):
3314
 
        if arg is False:
3315
 
            return 'False'
3316
 
        if arg:
3317
 
            return 'True'
3318
 
        return ''
3319
 
 
3320
 
    def _serialize_NoneString(self, arg):
3321
 
        return arg or ''
3322
 
 
3323
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3324
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
3325
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3326
 
        shared_repo=False):
3327
 
        try:
3328
 
            # hand off the request to the smart server
3329
 
            client_medium = transport.get_smart_medium()
3330
 
        except errors.NoSmartMedium:
3331
 
            do_vfs = True
3332
 
        else:
3333
 
            # Decline to open it if the server doesn't support our required
3334
 
            # version (3) so that the VFS-based transport will do it.
3335
 
            if client_medium.should_probe():
3336
 
                try:
3337
 
                    server_version = client_medium.protocol_version()
3338
 
                    if server_version != '2':
3339
 
                        do_vfs = True
3340
 
                    else:
3341
 
                        do_vfs = False
3342
 
                except errors.SmartProtocolError:
3343
 
                    # Apparently there's no usable smart server there, even though
3344
 
                    # the medium supports the smart protocol.
3345
 
                    do_vfs = True
3346
 
            else:
3347
 
                do_vfs = False
3348
 
        if not do_vfs:
3349
 
            client = _SmartClient(client_medium)
3350
 
            path = client.remote_path_from_transport(transport)
3351
 
            if client_medium._is_remote_before((1, 16)):
3352
 
                do_vfs = True
3353
 
        if do_vfs:
3354
 
            # TODO: lookup the local format from a server hint.
3355
 
            local_dir_format = BzrDirMetaFormat1()
3356
 
            self._supply_sub_formats_to(local_dir_format)
3357
 
            return local_dir_format.initialize_on_transport_ex(transport,
3358
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3359
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3360
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3361
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3362
 
                vfs_only=True)
3363
 
        return self._initialize_on_transport_ex_rpc(client, path, transport,
3364
 
            use_existing_dir, create_prefix, force_new_repo, stacked_on,
3365
 
            stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3366
 
 
3367
 
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
3368
 
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
3369
 
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3370
 
        args = []
3371
 
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3372
 
        args.append(self._serialize_NoneTrueFalse(create_prefix))
3373
 
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
3374
 
        args.append(self._serialize_NoneString(stacked_on))
3375
 
        # stack_on_pwd is often/usually our transport
3376
 
        if stack_on_pwd:
3377
 
            try:
3378
 
                stack_on_pwd = transport.relpath(stack_on_pwd)
3379
 
                if not stack_on_pwd:
3380
 
                    stack_on_pwd = '.'
3381
 
            except errors.PathNotChild:
3382
 
                pass
3383
 
        args.append(self._serialize_NoneString(stack_on_pwd))
3384
 
        args.append(self._serialize_NoneString(repo_format_name))
3385
 
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
3386
 
        args.append(self._serialize_NoneTrueFalse(shared_repo))
3387
 
        request_network_name = self._network_name or \
3388
 
            BzrDirFormat.get_default_format().network_name()
3389
 
        try:
3390
 
            response = client.call('BzrDirFormat.initialize_ex_1.16',
3391
 
                request_network_name, path, *args)
3392
 
        except errors.UnknownSmartMethod:
3393
 
            client._medium._remember_remote_is_before((1,16))
3394
 
            local_dir_format = BzrDirMetaFormat1()
3395
 
            self._supply_sub_formats_to(local_dir_format)
3396
 
            return local_dir_format.initialize_on_transport_ex(transport,
3397
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3398
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3399
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3400
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3401
 
                vfs_only=True)
3402
 
        except errors.ErrorFromSmartServer, err:
3403
 
            remote._translate_error(err, path=path)
3404
 
        repo_path = response[0]
3405
 
        bzrdir_name = response[6]
3406
 
        require_stacking = response[7]
3407
 
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
3408
 
        format = RemoteBzrDirFormat()
3409
 
        format._network_name = bzrdir_name
3410
 
        self._supply_sub_formats_to(format)
3411
 
        bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3412
 
        if repo_path:
3413
 
            repo_format = remote.response_tuple_to_repo_format(response[1:])
3414
 
            if repo_path == '.':
3415
 
                repo_path = ''
3416
 
            if repo_path:
3417
 
                repo_bzrdir_format = RemoteBzrDirFormat()
3418
 
                repo_bzrdir_format._network_name = response[5]
3419
 
                repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3420
 
                    repo_bzrdir_format)
3421
 
            else:
3422
 
                repo_bzr = bzrdir
3423
 
            final_stack = response[8] or None
3424
 
            final_stack_pwd = response[9] or None
3425
 
            if final_stack_pwd:
3426
 
                final_stack_pwd = urlutils.join(
3427
 
                    transport.base, final_stack_pwd)
3428
 
            remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3429
 
            if len(response) > 10:
3430
 
                # Updated server verb that locks remotely.
3431
 
                repo_lock_token = response[10] or None
3432
 
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3433
 
                if repo_lock_token:
3434
 
                    remote_repo.dont_leave_lock_in_place()
3435
 
            else:
3436
 
                remote_repo.lock_write()
3437
 
            policy = UseExistingRepository(remote_repo, final_stack,
3438
 
                final_stack_pwd, require_stacking)
3439
 
            policy.acquire_repository()
3440
 
        else:
3441
 
            remote_repo = None
3442
 
            policy = None
3443
 
        bzrdir._format.set_branch_format(self.get_branch_format())
3444
 
        if require_stacking:
3445
 
            # The repo has already been created, but we need to make sure that
3446
 
            # we'll make a stackable branch.
3447
 
            bzrdir._format.require_stacking(_skip_repo=True)
3448
 
        return remote_repo, bzrdir, require_stacking, policy
3449
 
 
3450
2749
    def _open(self, transport):
3451
2750
        return remote.RemoteBzrDir(transport, self)
3452
2751
 
3459
2758
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
3460
2759
        # repository format has been asked for, tell the RemoteRepositoryFormat
3461
2760
        # that it should use that for init() etc.
3462
 
        result = remote.RemoteRepositoryFormat()
 
2761
        result =  remote.RemoteRepositoryFormat()
3463
2762
        custom_format = getattr(self, '_repository_format', None)
3464
2763
        if custom_format:
 
2764
            # We will use the custom format to create repositories over the
 
2765
            # wire; expose its details like rich_root_data for code to query
3465
2766
            if isinstance(custom_format, remote.RemoteRepositoryFormat):
3466
 
                return custom_format
 
2767
                result._custom_format = custom_format._custom_format
3467
2768
            else:
3468
 
                # We will use the custom format to create repositories over the
3469
 
                # wire; expose its details like rich_root_data for code to
3470
 
                # query
3471
2769
                result._custom_format = custom_format
 
2770
            result.rich_root_data = custom_format.rich_root_data
3472
2771
        return result
3473
2772
 
3474
2773
    def get_branch_format(self):
3524
2823
        """Register a metadir subformat.
3525
2824
 
3526
2825
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3527
 
        by the Repository/Branch/WorkingTreeformats.
 
2826
        by the Repository format.
3528
2827
 
3529
2828
        :param repository_format: The fully-qualified repository format class
3530
2829
            name as a string.
3626
2925
            if info.native:
3627
2926
                help = '(native) ' + help
3628
2927
            return ':%s:\n%s\n\n' % (key,
3629
 
                textwrap.fill(help, initial_indent='    ',
3630
 
                    subsequent_indent='    ',
3631
 
                    break_long_words=False))
 
2928
                    textwrap.fill(help, initial_indent='    ',
 
2929
                    subsequent_indent='    '))
3632
2930
        if default_realkey is not None:
3633
2931
            output += wrapped(default_realkey, '(default) %s' % default_help,
3634
2932
                              self.get_info('default'))
3644
2942
                experimental_pairs.append((key, help))
3645
2943
            else:
3646
2944
                output += wrapped(key, help, info)
3647
 
        output += "\nSee :doc:`formats-help` for more about storage formats."
 
2945
        output += "\nSee ``bzr help formats`` for more about storage formats."
3648
2946
        other_output = ""
3649
2947
        if len(experimental_pairs) > 0:
3650
2948
            other_output += "Experimental formats are shown below.\n\n"
3663
2961
            other_output += \
3664
2962
                "\nNo deprecated formats are available.\n\n"
3665
2963
        other_output += \
3666
 
                "\nSee :doc:`formats-help` for more about storage formats."
 
2964
            "\nSee ``bzr help formats`` for more about storage formats."
3667
2965
 
3668
2966
        if topic == 'other-formats':
3669
2967
            return other_output
3703
3001
            try:
3704
3002
                stack_on = urlutils.rebase_url(self._stack_on,
3705
3003
                    self._stack_on_pwd,
3706
 
                    branch.user_url)
 
3004
                    branch.bzrdir.root_transport.base)
3707
3005
            except errors.InvalidRebaseURLs:
3708
3006
                stack_on = self._get_full_stack_on()
3709
3007
        try:
3710
3008
            branch.set_stacked_on_url(stack_on)
3711
 
        except (errors.UnstackableBranchFormat,
3712
 
                errors.UnstackableRepositoryFormat):
 
3009
        except errors.UnstackableBranchFormat:
3713
3010
            if self._require_stacking:
3714
3011
                raise
3715
3012
 
3716
 
    def requires_stacking(self):
3717
 
        """Return True if this policy requires stacking."""
3718
 
        return self._stack_on is not None and self._require_stacking
3719
 
 
3720
3013
    def _get_full_stack_on(self):
3721
3014
        """Get a fully-qualified URL for the stack_on location."""
3722
3015
        if self._stack_on is None:
3731
3024
        stack_on = self._get_full_stack_on()
3732
3025
        if stack_on is None:
3733
3026
            return
3734
 
        try:
3735
 
            stacked_dir = BzrDir.open(stack_on,
3736
 
                                      possible_transports=possible_transports)
3737
 
        except errors.JailBreak:
3738
 
            # We keep the stacking details, but we are in the server code so
3739
 
            # actually stacking is not needed.
3740
 
            return
 
3027
        stacked_dir = BzrDir.open(stack_on,
 
3028
                                  possible_transports=possible_transports)
3741
3029
        try:
3742
3030
            stacked_repo = stacked_dir.open_branch().repository
3743
3031
        except errors.NotBranchError:
3758
3046
        :param make_working_trees: If creating a repository, set
3759
3047
            make_working_trees to this value (if non-None)
3760
3048
        :param shared: If creating a repository, make it shared if True
3761
 
        :return: A repository, is_new_flag (True if the repository was
3762
 
            created).
 
3049
        :return: A repository
3763
3050
        """
3764
3051
        raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3765
3052
 
3785
3072
 
3786
3073
        Creates the desired repository in the bzrdir we already have.
3787
3074
        """
3788
 
        stack_on = self._get_full_stack_on()
3789
 
        if stack_on:
3790
 
            format = self._bzrdir._format
3791
 
            format.require_stacking(stack_on=stack_on,
3792
 
                                    possible_transports=[self._bzrdir.root_transport])
3793
 
            if not self._require_stacking:
3794
 
                # We have picked up automatic stacking somewhere.
3795
 
                note('Using default stacking branch %s at %s', self._stack_on,
3796
 
                    self._stack_on_pwd)
3797
3075
        repository = self._bzrdir.create_repository(shared=shared)
3798
3076
        self._add_fallback(repository,
3799
3077
                           possible_transports=[self._bzrdir.transport])
3800
3078
        if make_working_trees is not None:
3801
3079
            repository.set_make_working_trees(make_working_trees)
3802
 
        return repository, True
 
3080
        return repository
3803
3081
 
3804
3082
 
3805
3083
class UseExistingRepository(RepositoryAcquisitionPolicy):
3821
3099
    def acquire_repository(self, make_working_trees=None, shared=False):
3822
3100
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
3823
3101
 
3824
 
        Returns an existing repository to use.
 
3102
        Returns an existing repository to use
3825
3103
        """
3826
3104
        self._add_fallback(self._repository,
3827
3105
                       possible_transports=[self._repository.bzrdir.transport])
3828
 
        return self._repository, False
 
3106
        return self._repository
3829
3107
 
3830
3108
 
3831
3109
# Please register new formats after old formats so that formats
3838
3116
format_registry.register('weave', BzrDirFormat6,
3839
3117
    'Pre-0.8 format.  Slower than knit and does not'
3840
3118
    ' support checkouts or shared repositories.',
3841
 
    hidden=True,
3842
3119
    deprecated=True)
3843
3120
format_registry.register_metadir('metaweave',
3844
3121
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3845
3122
    'Transitional format in 0.8.  Slower than knit.',
3846
3123
    branch_format='bzrlib.branch.BzrBranchFormat5',
3847
3124
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3848
 
    hidden=True,
3849
3125
    deprecated=True)
3850
3126
format_registry.register_metadir('knit',
3851
3127
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3852
3128
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
3853
3129
    branch_format='bzrlib.branch.BzrBranchFormat5',
3854
3130
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3855
 
    hidden=True,
3856
3131
    deprecated=True)
3857
3132
format_registry.register_metadir('dirstate',
3858
3133
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3862
3137
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3863
3138
    # directly from workingtree_4 triggers a circular import.
3864
3139
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3865
 
    hidden=True,
3866
3140
    deprecated=True)
3867
3141
format_registry.register_metadir('dirstate-tags',
3868
3142
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3871
3145
        ' Incompatible with bzr < 0.15.',
3872
3146
    branch_format='bzrlib.branch.BzrBranchFormat6',
3873
3147
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3874
 
    hidden=True,
3875
3148
    deprecated=True)
3876
3149
format_registry.register_metadir('rich-root',
3877
3150
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3879
3152
        ' bzr < 1.0.',
3880
3153
    branch_format='bzrlib.branch.BzrBranchFormat6',
3881
3154
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3882
 
    hidden=True,
3883
3155
    deprecated=True)
3884
3156
format_registry.register_metadir('dirstate-with-subtree',
3885
3157
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3896
3168
    help='New in 0.92: Pack-based format with data compatible with '
3897
3169
        'dirstate-tags format repositories. Interoperates with '
3898
3170
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3899
 
        ,
 
3171
        'Previously called knitpack-experimental.  '
 
3172
        'For more information, see '
 
3173
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3900
3174
    branch_format='bzrlib.branch.BzrBranchFormat6',
3901
3175
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3902
3176
    )
3905
3179
    help='New in 0.92: Pack-based format with data compatible with '
3906
3180
        'dirstate-with-subtree format repositories. Interoperates with '
3907
3181
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3908
 
        ,
 
3182
        'Previously called knitpack-experimental.  '
 
3183
        'For more information, see '
 
3184
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3909
3185
    branch_format='bzrlib.branch.BzrBranchFormat6',
3910
3186
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3911
3187
    hidden=True,
3914
3190
format_registry.register_metadir('rich-root-pack',
3915
3191
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3916
3192
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3917
 
         '(needed for bzr-svn and bzr-git).',
 
3193
         '(needed for bzr-svn).',
3918
3194
    branch_format='bzrlib.branch.BzrBranchFormat6',
3919
3195
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3920
 
    hidden=True,
3921
3196
    )
3922
3197
format_registry.register_metadir('1.6',
3923
3198
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3926
3201
         'not present locally.',
3927
3202
    branch_format='bzrlib.branch.BzrBranchFormat7',
3928
3203
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3929
 
    hidden=True,
3930
3204
    )
3931
3205
format_registry.register_metadir('1.6.1-rich-root',
3932
3206
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3933
3207
    help='A variant of 1.6 that supports rich-root data '
3934
 
         '(needed for bzr-svn and bzr-git).',
 
3208
         '(needed for bzr-svn).',
3935
3209
    branch_format='bzrlib.branch.BzrBranchFormat7',
3936
3210
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3937
 
    hidden=True,
3938
3211
    )
3939
3212
format_registry.register_metadir('1.9',
3940
3213
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3943
3216
         'performance for most operations.',
3944
3217
    branch_format='bzrlib.branch.BzrBranchFormat7',
3945
3218
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3946
 
    hidden=True,
3947
3219
    )
3948
3220
format_registry.register_metadir('1.9-rich-root',
3949
3221
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3950
3222
    help='A variant of 1.9 that supports rich-root data '
3951
 
         '(needed for bzr-svn and bzr-git).',
 
3223
         '(needed for bzr-svn).',
3952
3224
    branch_format='bzrlib.branch.BzrBranchFormat7',
3953
3225
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3954
 
    hidden=True,
3955
3226
    )
3956
 
format_registry.register_metadir('1.14',
 
3227
format_registry.register_metadir('development-wt5',
3957
3228
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3958
 
    help='A working-tree format that supports content filtering.',
 
3229
    help='A working-tree format that supports views and content filtering.',
3959
3230
    branch_format='bzrlib.branch.BzrBranchFormat7',
3960
3231
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
 
3232
    experimental=True,
3961
3233
    )
3962
 
format_registry.register_metadir('1.14-rich-root',
 
3234
format_registry.register_metadir('development-wt5-rich-root',
3963
3235
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3964
 
    help='A variant of 1.14 that supports rich-root data '
3965
 
         '(needed for bzr-svn and bzr-git).',
 
3236
    help='A variant of development-wt5 that supports rich-root data '
 
3237
         '(needed for bzr-svn).',
3966
3238
    branch_format='bzrlib.branch.BzrBranchFormat7',
3967
3239
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
 
3240
    experimental=True,
3968
3241
    )
3969
 
# 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 '
 
3242
# The following two formats should always just be aliases.
 
3243
format_registry.register_metadir('development',
 
3244
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2',
 
3245
    help='Current development format. Can convert data to and from pack-0.92 '
 
3246
        '(and anything compatible with pack-0.92) format repositories. '
 
3247
        'Repositories and branches in this format can only be read by bzr.dev. '
 
3248
        'Please read '
 
3249
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3977
3250
        'before use.',
3978
3251
    branch_format='bzrlib.branch.BzrBranchFormat7',
3979
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3252
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3980
3253
    experimental=True,
3981
3254
    alias=True,
3982
 
    hidden=True,
3983
3255
    )
3984
3256
format_registry.register_metadir('development-subtree',
3985
3257
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3987
3259
        'from pack-0.92-subtree (and anything compatible with '
3988
3260
        'pack-0.92-subtree) format repositories. Repositories and branches in '
3989
3261
        'this format can only be read by bzr.dev. Please read '
3990
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
3262
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3991
3263
        'before use.',
3992
3264
    branch_format='bzrlib.branch.BzrBranchFormat7',
3993
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3265
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3994
3266
    experimental=True,
3995
 
    hidden=True,
3996
 
    alias=False, # Restore to being an alias when an actual development subtree format is added
3997
 
                 # This current non-alias status is simply because we did not introduce a
3998
 
                 # chk based subtree format.
 
3267
    alias=True,
3999
3268
    )
4000
 
 
4001
3269
# 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',
4027
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4028
 
    help='First format for bzr 2.0 series.\n'
4029
 
        'Uses group-compress storage.\n'
4030
 
        'Provides rich roots which are a one-way transition.\n',
4031
 
        # 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
4032
 
        # 'rich roots. Supported by bzr 1.16 and later.',
4033
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4034
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4035
 
    experimental=True,
4036
 
    )
4037
 
 
4038
 
# The following format should be an alias for the rich root equivalent 
4039
 
# of the default format
4040
 
format_registry.register_metadir('default-rich-root',
4041
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4042
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4043
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4044
 
    alias=True,
4045
 
    hidden=True,
4046
 
    help='Same as 2a.')
4047
 
 
 
3270
format_registry.register_metadir('development2',
 
3271
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2',
 
3272
    help='1.6.1 with B+Tree based index. '
 
3273
        'Please read '
 
3274
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3275
        'before use.',
 
3276
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3277
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3278
    hidden=True,
 
3279
    experimental=True,
 
3280
    )
 
3281
format_registry.register_metadir('development2-subtree',
 
3282
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
 
3283
    help='1.6.1-subtree with B+Tree based index. '
 
3284
        'Please read '
 
3285
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3286
        'before use.',
 
3287
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3288
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3289
    hidden=True,
 
3290
    experimental=True,
 
3291
    )
4048
3292
# The current format that is made on 'bzr init'.
4049
 
format_registry.set_default('2a')
 
3293
format_registry.set_default('pack-0.92')