/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

  • Committer: Andrew Bennetts
  • Date: 2008-10-30 01:05:59 UTC
  • mto: This revision was merged to the branch mainline in revision 3813.
  • Revision ID: andrew.bennetts@canonical.com-20081030010559-tumoefnsmhg4snxo
Add contrib/bzr_ssh_path_limiter.

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 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
78
71
from bzrlib.trace import (
79
72
    mutter,
80
73
    note,
81
 
    warning,
82
74
    )
83
75
 
84
76
from bzrlib import (
85
 
    hooks,
86
77
    registry,
87
78
    symbol_versioning,
88
79
    )
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):
 
80
 
 
81
 
 
82
class BzrDir(object):
125
83
    """A .bzr control diretory.
126
 
 
 
84
    
127
85
    BzrDir instances let you create or open any of the things that can be
128
86
    found within .bzr - checkouts, branches and repositories.
129
 
 
 
87
    
130
88
    :ivar transport:
131
89
        the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
132
90
    :ivar root_transport:
134
92
        (i.e. the parent directory holding the .bzr directory).
135
93
 
136
94
    Everything in the bzrdir should have the same file permissions.
137
 
 
138
 
    :cvar hooks: An instance of BzrDirHooks.
139
95
    """
140
96
 
141
97
    def break_lock(self):
163
119
        return True
164
120
 
165
121
    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
122
        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
 
123
        source_repo_format = self._format.repository_format
 
124
        source_repo_format.check_conversion_target(target_repo_format)
176
125
 
177
126
    @staticmethod
178
127
    def _check_supported(format, allow_unsupported,
180
129
        basedir=None):
181
130
        """Give an error or warning on old formats.
182
131
 
183
 
        :param format: may be any kind of format - workingtree, branch,
 
132
        :param format: may be any kind of format - workingtree, branch, 
184
133
        or repository.
185
134
 
186
 
        :param allow_unsupported: If true, allow opening
187
 
        formats that are strongly deprecated, and which may
 
135
        :param allow_unsupported: If true, allow opening 
 
136
        formats that are strongly deprecated, and which may 
188
137
        have limited functionality.
189
138
 
190
139
        :param recommend_upgrade: If true (default), warn
222
171
                                       preserve_stacking=preserve_stacking)
223
172
 
224
173
    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):
 
174
                           force_new_repo=False, preserve_stacking=False,
 
175
                           stacked_on=None):
227
176
        """Clone this bzrdir and its contents to transport verbatim.
228
177
 
229
178
        :param transport: The transport for the location to produce the clone
235
184
                               even if one is available.
236
185
        :param preserve_stacking: When cloning a stacked branch, stack the
237
186
            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
187
        """
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:
 
188
        transport.ensure_base()
247
189
        require_stacking = (stacked_on is not None)
248
 
        format = self.cloning_metadir(require_stacking)
249
 
        
250
 
        # Figure out what objects we want:
 
190
        metadir = self.cloning_metadir(require_stacking)
 
191
        result = metadir.initialize_on_transport(transport)
 
192
        repository_policy = None
251
193
        try:
252
194
            local_repo = self.find_repository()
253
195
        except errors.NoRepositoryPresent:
267
209
                        errors.UnstackableRepositoryFormat,
268
210
                        errors.NotStacked):
269
211
                    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.
 
212
 
273
213
        if local_repo:
 
214
            # may need to copy content in
 
215
            repository_policy = result.determine_repository_policy(
 
216
                force_new_repo, stacked_on, self.root_transport.base,
 
217
                require_stacking=require_stacking)
274
218
            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)
 
219
            result_repo = repository_policy.acquire_repository(
 
220
                make_working_trees, local_repo.is_shared())
 
221
            result_repo.fetch(local_repo, revision_id=revision_id)
 
222
        else:
 
223
            result_repo = None
310
224
        # 1 if there is a branch present
311
225
        #   make sure its content is available in the target repository
312
226
        #   clone it.
313
227
        if local_branch is not None:
314
 
            result_branch = local_branch.clone(result, revision_id=revision_id,
315
 
                repository_policy=repository_policy)
316
 
        try:
317
 
            # Cheaper to check if the target is not local, than to try making
318
 
            # the tree and fail.
319
 
            result.root_transport.local_abspath('.')
320
 
            if result_repo is None or result_repo.make_working_trees():
 
228
            result_branch = local_branch.clone(result, revision_id=revision_id)
 
229
            if repository_policy is not None:
 
230
                repository_policy.configure_branch(result_branch)
 
231
        if result_repo is None or result_repo.make_working_trees():
 
232
            try:
321
233
                self.open_workingtree().clone(result)
322
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
323
 
            pass
 
234
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
235
                pass
324
236
        return result
325
237
 
326
238
    # TODO: This should be given a Transport, and should chdir up; otherwise
332
244
    @classmethod
333
245
    def create(cls, base, format=None, possible_transports=None):
334
246
        """Create a new BzrDir at the url 'base'.
335
 
 
 
247
        
336
248
        :param format: If supplied, the format of branch to create.  If not
337
249
            supplied, the default is used.
338
 
        :param possible_transports: If supplied, a list of transports that
 
250
        :param possible_transports: If supplied, a list of transports that 
339
251
            can be reused to share a remote connection.
340
252
        """
341
253
        if cls is not BzrDir:
388
300
                for subdir in sorted(subdirs, reverse=True):
389
301
                    pending.append(current_transport.clone(subdir))
390
302
 
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
303
    @staticmethod
401
304
    def find_branches(transport):
402
305
        """Find all branches under a transport.
414
317
            except errors.NoRepositoryPresent:
415
318
                pass
416
319
            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):
 
320
                return False, (None, repository)
 
321
            try:
 
322
                branch = bzrdir.open_branch()
 
323
            except errors.NotBranchError:
 
324
                return True, (None, None)
 
325
            else:
 
326
                return True, (branch, None)
 
327
        branches = []
 
328
        for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
422
329
            if repo is not None:
423
 
                ret.extend(repo.find_branches())
424
 
            if branches is not None:
425
 
                ret.extend(branches)
426
 
        return ret
 
330
                branches.extend(repo.find_branches())
 
331
            if branch is not None:
 
332
                branches.append(branch)
 
333
        return branches
427
334
 
428
335
    def destroy_repository(self):
429
336
        """Destroy the repository in this BzrDir"""
430
337
        raise NotImplementedError(self.destroy_repository)
431
338
 
432
 
    def create_branch(self, name=None):
 
339
    def create_branch(self):
433
340
        """Create a branch in this BzrDir.
434
341
 
435
 
        :param name: Name of the colocated branch to create, None for
436
 
            the default branch.
437
 
 
438
342
        The bzrdir's format will control what branch format is created.
439
343
        For more control see BranchFormatXX.create(a_bzrdir).
440
344
        """
441
345
        raise NotImplementedError(self.create_branch)
442
346
 
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
 
        """
 
347
    def destroy_branch(self):
 
348
        """Destroy the branch in this BzrDir"""
449
349
        raise NotImplementedError(self.destroy_branch)
450
350
 
451
351
    @staticmethod
453
353
        """Create a new BzrDir, Branch and Repository at the url 'base'.
454
354
 
455
355
        This will use the current default BzrDirFormat unless one is
456
 
        specified, and use whatever
 
356
        specified, and use whatever 
457
357
        repository format that that uses via bzrdir.create_branch and
458
358
        create_repository. If a shared repository is available that is used
459
359
        preferentially.
473
373
                                    stack_on_pwd=None, require_stacking=False):
474
374
        """Return an object representing a policy to use.
475
375
 
476
 
        This controls whether a new repository is created, and the format of
477
 
        that repository, or some existing shared repository used instead.
 
376
        This controls whether a new repository is created, or a shared
 
377
        repository used instead.
478
378
 
479
379
        If stack_on is supplied, will not seek a containing shared repo.
480
380
 
489
389
            stack_on_pwd = None
490
390
            config = found_bzrdir.get_config()
491
391
            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
 
392
            if config is not None:
 
393
                stack_on = config.get_default_stack_on()
 
394
                if stack_on is not None:
 
395
                    stack_on_pwd = found_bzrdir.root_transport.base
 
396
                    stop = True
 
397
                    note('Using default stacking branch %s at %s', stack_on,
 
398
                         stack_on_pwd)
496
399
            # does it have a repository ?
497
400
            try:
498
401
                repository = found_bzrdir.open_repository()
499
402
            except errors.NoRepositoryPresent:
500
403
                repository = None
501
404
            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.
 
405
                if ((found_bzrdir.root_transport.base !=
 
406
                     self.root_transport.base) and not repository.is_shared()):
505
407
                    repository = None
506
 
                    stop = True
507
408
                else:
508
409
                    stop = True
509
410
            if not stop:
533
434
    def _find_or_create_repository(self, force_new_repo):
534
435
        """Create a new repository if needed, returning the repository."""
535
436
        policy = self.determine_repository_policy(force_new_repo)
536
 
        return policy.acquire_repository()[0]
 
437
        return policy.acquire_repository()
537
438
 
538
439
    @staticmethod
539
440
    def create_branch_convenience(base, force_new_repo=False,
546
447
        not.
547
448
 
548
449
        This will use the current default BzrDirFormat unless one is
549
 
        specified, and use whatever
 
450
        specified, and use whatever 
550
451
        repository format that that uses via bzrdir.create_branch and
551
452
        create_repository. If a shared repository is available that is used
552
453
        preferentially. Whatever repository is used, its tree creation policy
554
455
 
555
456
        The created Branch object is returned.
556
457
        If a working tree cannot be made due to base not being a file:// url,
557
 
        no error is raised unless force_new_tree is True, in which case no
 
458
        no error is raised unless force_new_tree is True, in which case no 
558
459
        data is created on disk and NotLocalUrl is raised.
559
460
 
560
461
        :param base: The URL to create the branch at.
561
462
        :param force_new_repo: If True a new repository is always created.
562
 
        :param force_new_tree: If True or False force creation of a tree or
 
463
        :param force_new_tree: If True or False force creation of a tree or 
563
464
                               prevent such creation respectively.
564
465
        :param format: Override for the bzrdir format to create.
565
466
        :param possible_transports: An optional reusable transports list.
587
488
        'base' must be a local path or a file:// url.
588
489
 
589
490
        This will use the current default BzrDirFormat unless one is
590
 
        specified, and use whatever
 
491
        specified, and use whatever 
591
492
        repository format that that uses for bzrdirformat.create_workingtree,
592
493
        create_branch and create_repository.
593
494
 
605
506
    def create_workingtree(self, revision_id=None, from_branch=None,
606
507
        accelerator_tree=None, hardlink=False):
607
508
        """Create a working tree at this BzrDir.
608
 
 
 
509
        
609
510
        :param revision_id: create it as of this revision id.
610
511
        :param from_branch: override bzrdir branch (for lightweight checkouts)
611
512
        :param accelerator_tree: A tree which can be used for retrieving file
615
516
        """
616
517
        raise NotImplementedError(self.create_workingtree)
617
518
 
618
 
    def backup_bzrdir(self):
619
 
        """Backup this bzr control directory.
620
 
 
621
 
        :return: Tuple with old path name and new path name
622
 
        """
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
 
        pb = ui.ui_factory.nested_progress_bar()
633
 
        try:
634
 
            # FIXME: bug 300001 -- the backup fails if the backup directory
635
 
            # already exists, but it should instead either remove it or make
636
 
            # a new backup directory.
637
 
            #
638
 
            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)
642
 
            return (old_path, new_path)
643
 
        finally:
644
 
            pb.finished()
645
 
 
646
519
    def retire_bzrdir(self, limit=10000):
647
520
        """Permanently disable the bzrdir.
648
521
 
702
575
            if stop:
703
576
                return result
704
577
            next_transport = found_bzrdir.root_transport.clone('..')
705
 
            if (found_bzrdir.user_url == next_transport.base):
 
578
            if (found_bzrdir.root_transport.base == next_transport.base):
706
579
                # top of the file system
707
580
                return None
708
581
            # find the next containing bzrdir
725
598
                repository = found_bzrdir.open_repository()
726
599
            except errors.NoRepositoryPresent:
727
600
                return None, False
728
 
            if found_bzrdir.user_url == self.user_url:
 
601
            if found_bzrdir.root_transport.base == self.root_transport.base:
729
602
                return repository, True
730
603
            elif repository.is_shared():
731
604
                return repository, True
737
610
            raise errors.NoRepositoryPresent(self)
738
611
        return found_repo
739
612
 
740
 
    def get_branch_reference(self, name=None):
 
613
    def get_branch_reference(self):
741
614
        """Return the referenced URL for the branch in this bzrdir.
742
615
 
743
 
        :param name: Optional colocated branch name
744
616
        :raises NotBranchError: If there is no Branch.
745
 
        :raises NoColocatedBranchSupport: If a branch name was specified
746
 
            but colocated branches are not supported.
747
617
        :return: The URL the branch in this bzrdir references if it is a
748
618
            reference branch, or None for regular branches.
749
619
        """
750
 
        if name is not None:
751
 
            raise errors.NoColocatedBranchSupport(self)
752
620
        return None
753
621
 
754
 
    def get_branch_transport(self, branch_format, name=None):
 
622
    def get_branch_transport(self, branch_format):
755
623
        """Get the transport for use by branch format in this BzrDir.
756
624
 
757
625
        Note that bzr dirs that do not support format strings will raise
758
626
        IncompatibleFormat if the branch format they are given has
759
627
        a format string, and vice versa.
760
628
 
761
 
        If branch_format is None, the transport is returned with no
 
629
        If branch_format is None, the transport is returned with no 
762
630
        checking. If it is not None, then the returned transport is
763
631
        guaranteed to point to an existing directory ready for use.
764
632
        """
807
675
        if not self._mode_check_done:
808
676
            self._find_creation_modes()
809
677
        return self._dir_mode
810
 
 
 
678
        
811
679
    def get_repository_transport(self, repository_format):
812
680
        """Get the transport for use by repository format in this BzrDir.
813
681
 
815
683
        IncompatibleFormat if the repository format they are given has
816
684
        a format string, and vice versa.
817
685
 
818
 
        If repository_format is None, the transport is returned with no
 
686
        If repository_format is None, the transport is returned with no 
819
687
        checking. If it is not None, then the returned transport is
820
688
        guaranteed to point to an existing directory ready for use.
821
689
        """
822
690
        raise NotImplementedError(self.get_repository_transport)
823
 
 
 
691
        
824
692
    def get_workingtree_transport(self, tree_format):
825
693
        """Get the transport for use by workingtree format in this BzrDir.
826
694
 
828
696
        IncompatibleFormat if the workingtree format they are given has a
829
697
        format string, and vice versa.
830
698
 
831
 
        If workingtree_format is None, the transport is returned with no
 
699
        If workingtree_format is None, the transport is returned with no 
832
700
        checking. If it is not None, then the returned transport is
833
701
        guaranteed to point to an existing directory ready for use.
834
702
        """
835
703
        raise NotImplementedError(self.get_workingtree_transport)
836
704
 
837
705
    def get_config(self):
838
 
        """Get configuration for this BzrDir."""
839
 
        return config.BzrDirConfig(self)
840
 
 
841
 
    def _get_config(self):
842
 
        """By default, no configuration is available."""
843
 
        return None
 
706
        if getattr(self, '_get_config', None) is None:
 
707
            return None
 
708
        return self._get_config()
844
709
 
845
710
    def __init__(self, _transport, _format):
846
711
        """Initialize a Bzr control dir object.
847
 
 
 
712
        
848
713
        Only really common logic should reside here, concrete classes should be
849
714
        made with varying behaviours.
850
715
 
852
717
        :param _transport: the transport this dir is based at.
853
718
        """
854
719
        self._format = _format
855
 
        # these are also under the more standard names of 
856
 
        # control_transport and user_transport
857
720
        self.transport = _transport.clone('.bzr')
858
721
        self.root_transport = _transport
859
722
        self._mode_check_done = False
860
 
        
861
 
    @property 
862
 
    def user_transport(self):
863
 
        return self.root_transport
864
 
        
865
 
    @property
866
 
    def control_transport(self):
867
 
        return self.transport
868
723
 
869
724
    def is_control_filename(self, filename):
870
725
        """True if filename is the name of a path which is reserved for bzrdir's.
871
 
 
 
726
        
872
727
        :param filename: A filename within the root transport of this bzrdir.
873
728
 
874
729
        This is true IF and ONLY IF the filename is part of the namespace reserved
877
732
        this in the future - for instance to make bzr talk with svn working
878
733
        trees.
879
734
        """
880
 
        # this might be better on the BzrDirFormat class because it refers to
881
 
        # all the possible bzrdir disk formats.
882
 
        # This method is tested via the workingtree is_control_filename tests-
 
735
        # this might be better on the BzrDirFormat class because it refers to 
 
736
        # all the possible bzrdir disk formats. 
 
737
        # This method is tested via the workingtree is_control_filename tests- 
883
738
        # it was extracted from WorkingTree.is_control_filename. If the method's
884
739
        # contract is extended beyond the current trivial implementation, please
885
740
        # add new tests for it to the appropriate place.
887
742
 
888
743
    def needs_format_conversion(self, format=None):
889
744
        """Return true if this bzrdir needs convert_format run on it.
890
 
 
891
 
        For instance, if the repository format is out of date but the
 
745
        
 
746
        For instance, if the repository format is out of date but the 
892
747
        branch and working tree are not, this should return True.
893
748
 
894
749
        :param format: Optional parameter indicating a specific desired
900
755
    def open_unsupported(base):
901
756
        """Open a branch which is not supported."""
902
757
        return BzrDir.open(base, _unsupported=True)
903
 
 
 
758
        
904
759
    @staticmethod
905
760
    def open(base, _unsupported=False, possible_transports=None):
906
761
        """Open an existing bzrdir, rooted at 'base' (url).
907
 
 
 
762
        
908
763
        :param _unsupported: a private parameter to the BzrDir class.
909
764
        """
910
765
        t = get_transport(base, possible_transports=possible_transports)
918
773
        :param transport: Transport containing the bzrdir.
919
774
        :param _unsupported: private.
920
775
        """
921
 
        for hook in BzrDir.hooks['pre_open']:
922
 
            hook(transport)
923
 
        # Keep initial base since 'transport' may be modified while following
924
 
        # the redirections.
925
776
        base = transport.base
 
777
 
926
778
        def find_format(transport):
927
779
            return transport, BzrDirFormat.find_format(
928
780
                transport, _server_formats=_server_formats)
929
781
 
930
782
        def redirected(transport, e, redirection_notice):
931
 
            redirected_transport = transport._redirected_to(e.source, e.target)
932
 
            if redirected_transport is None:
933
 
                raise errors.NotBranchError(base)
 
783
            qualified_source = e.get_source_url()
 
784
            relpath = transport.relpath(qualified_source)
 
785
            if not e.target.endswith(relpath):
 
786
                # Not redirected to a branch-format, not a branch
 
787
                raise errors.NotBranchError(path=e.target)
 
788
            target = e.target[:-len(relpath)]
934
789
            note('%s is%s redirected to %s',
935
 
                 transport.base, e.permanently, redirected_transport.base)
936
 
            return redirected_transport
 
790
                 transport.base, e.permanently, target)
 
791
            # Let's try with a new transport
 
792
            # FIXME: If 'transport' has a qualifier, this should
 
793
            # be applied again to the new transport *iff* the
 
794
            # schemes used are the same. Uncomment this code
 
795
            # once the function (and tests) exist.
 
796
            # -- vila20070212
 
797
            #target = urlutils.copy_url_qualifiers(original, target)
 
798
            return get_transport(target)
937
799
 
938
800
        try:
939
801
            transport, format = do_catching_redirections(find_format,
945
807
        BzrDir._check_supported(format, _unsupported)
946
808
        return format.open(transport, _found=True)
947
809
 
948
 
    def open_branch(self, name=None, unsupported=False,
949
 
                    ignore_fallbacks=False):
 
810
    def open_branch(self, unsupported=False):
950
811
        """Open the branch object at this BzrDir if one is present.
951
812
 
952
813
        If unsupported is True, then no longer supported branch formats can
953
814
        still be opened.
954
 
 
 
815
        
955
816
        TODO: static convenience version of this?
956
817
        """
957
818
        raise NotImplementedError(self.open_branch)
959
820
    @staticmethod
960
821
    def open_containing(url, possible_transports=None):
961
822
        """Open an existing branch which contains url.
962
 
 
 
823
        
963
824
        :param url: url to search from.
964
825
        See open_containing_from_transport for more detail.
965
826
        """
966
827
        transport = get_transport(url, possible_transports)
967
828
        return BzrDir.open_containing_from_transport(transport)
968
 
 
 
829
    
969
830
    @staticmethod
970
831
    def open_containing_from_transport(a_transport):
971
832
        """Open an existing branch which contains a_transport.base.
974
835
 
975
836
        Basically we keep looking up until we find the control directory or
976
837
        run into the root.  If there isn't one, raises NotBranchError.
977
 
        If there is one and it is either an unrecognised format or an unsupported
 
838
        If there is one and it is either an unrecognised format or an unsupported 
978
839
        format, UnknownFormatError or UnsupportedFormatError are raised.
979
840
        If there is one, it is returned, along with the unused portion of url.
980
841
 
981
 
        :return: The BzrDir that contains the path, and a Unicode path
 
842
        :return: The BzrDir that contains the path, and a Unicode path 
982
843
                for the rest of the URL.
983
844
        """
984
845
        # this gets the normalised url back. I.e. '.' -> the full path.
999
860
                raise errors.NotBranchError(path=url)
1000
861
            a_transport = new_t
1001
862
 
1002
 
    def _get_tree_branch(self, name=None):
 
863
    def _get_tree_branch(self):
1003
864
        """Return the branch and tree, if any, for this bzrdir.
1004
865
 
1005
 
        :param name: Name of colocated branch to open.
1006
 
 
1007
866
        Return None for tree if not present or inaccessible.
1008
867
        Raise NotBranchError if no branch is present.
1009
868
        :return: (tree, branch)
1012
871
            tree = self.open_workingtree()
1013
872
        except (errors.NoWorkingTree, errors.NotLocalUrl):
1014
873
            tree = None
1015
 
            branch = self.open_branch(name=name)
 
874
            branch = self.open_branch()
1016
875
        else:
1017
 
            if name is not None:
1018
 
                branch = self.open_branch(name=name)
1019
 
            else:
1020
 
                branch = tree.branch
 
876
            branch = tree.branch
1021
877
        return tree, branch
1022
878
 
1023
879
    @classmethod
1095
951
        """
1096
952
        raise NotImplementedError(self.open_workingtree)
1097
953
 
1098
 
    def has_branch(self, name=None):
 
954
    def has_branch(self):
1099
955
        """Tell if this bzrdir contains a branch.
1100
 
 
 
956
        
1101
957
        Note: if you're going to open the branch, you should just go ahead
1102
 
        and try, and not ask permission first.  (This method just opens the
1103
 
        branch and discards it, and that's somewhat expensive.)
 
958
        and try, and not ask permission first.  (This method just opens the 
 
959
        branch and discards it, and that's somewhat expensive.) 
1104
960
        """
1105
961
        try:
1106
 
            self.open_branch(name)
 
962
            self.open_branch()
1107
963
            return True
1108
964
        except errors.NotBranchError:
1109
965
            return False
1113
969
 
1114
970
        This will still raise an exception if the bzrdir has a workingtree that
1115
971
        is remote & inaccessible.
1116
 
 
 
972
        
1117
973
        Note: if you're going to open the working tree, you should just go ahead
1118
 
        and try, and not ask permission first.  (This method just opens the
1119
 
        workingtree and discards it, and that's somewhat expensive.)
 
974
        and try, and not ask permission first.  (This method just opens the 
 
975
        workingtree and discards it, and that's somewhat expensive.) 
1120
976
        """
1121
977
        try:
1122
978
            self.open_workingtree(recommend_upgrade=False)
1126
982
 
1127
983
    def _cloning_metadir(self):
1128
984
        """Produce a metadir suitable for cloning with.
1129
 
 
 
985
        
1130
986
        :returns: (destination_bzrdir_format, source_repository)
1131
987
        """
1132
988
        result_format = self._format.__class__()
1133
989
        try:
1134
990
            try:
1135
 
                branch = self.open_branch(ignore_fallbacks=True)
 
991
                branch = self.open_branch()
1136
992
                source_repository = branch.repository
1137
993
                result_format._branch_format = branch._format
1138
994
            except errors.NotBranchError:
1175
1031
        """
1176
1032
        format, repository = self._cloning_metadir()
1177
1033
        if format._workingtree_format is None:
1178
 
            # No tree in self.
1179
1034
            if repository is None:
1180
 
                # No repository either
1181
1035
                return format
1182
 
            # We have a repository, so set a working tree? (Why? This seems to
1183
 
            # contradict the stated return value in the docstring).
1184
1036
            tree_format = repository._format._matchingbzrdir.workingtree_format
1185
1037
            format.workingtree_format = tree_format.__class__()
1186
 
        if require_stacking:
1187
 
            format.require_stacking()
 
1038
        if (require_stacking and not
 
1039
            format.get_branch_format().supports_stacking()):
 
1040
            # We need to make a stacked branch, but the default format for the
 
1041
            # target doesn't support stacking.  So force a branch that *can*
 
1042
            # support stacking.
 
1043
            from bzrlib.branch import BzrBranchFormat7
 
1044
            format._branch_format = BzrBranchFormat7()
 
1045
            mutter("using %r for stacking" % (format._branch_format,))
 
1046
            from bzrlib.repofmt import pack_repo
 
1047
            if format.repository_format.rich_root_data:
 
1048
                bzrdir_format_name = '1.6.1-rich-root'
 
1049
                repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
 
1050
            else:
 
1051
                bzrdir_format_name = '1.6'
 
1052
                repo_format = pack_repo.RepositoryFormatKnitPack5()
 
1053
            note('Source format does not support stacking, using format:'
 
1054
                 ' \'%s\'\n  %s\n',
 
1055
                 bzrdir_format_name, repo_format.get_format_description())
 
1056
            format.repository_format = repo_format
1188
1057
        return format
1189
1058
 
1190
1059
    def checkout_metadir(self):
1192
1061
 
1193
1062
    def sprout(self, url, revision_id=None, force_new_repo=False,
1194
1063
               recurse='down', possible_transports=None,
1195
 
               accelerator_tree=None, hardlink=False, stacked=False,
1196
 
               source_branch=None, create_tree_if_local=True):
 
1064
               accelerator_tree=None, hardlink=False, stacked=False):
1197
1065
        """Create a copy of this bzrdir prepared for use as a new line of
1198
1066
        development.
1199
1067
 
1214
1082
            where possible.
1215
1083
        :param stacked: If true, create a stacked branch referring to the
1216
1084
            location of this control directory.
1217
 
        :param create_tree_if_local: If true, a working-tree will be created
1218
 
            when working locally.
1219
1085
        """
1220
1086
        target_transport = get_transport(url, possible_transports)
1221
1087
        target_transport.ensure_base()
1222
1088
        cloning_format = self.cloning_metadir(stacked)
1223
1089
        # Create/update the result branch
1224
1090
        result = cloning_format.initialize_on_transport(target_transport)
1225
 
        # if a stacked branch wasn't requested, we don't create one
1226
 
        # even if the origin was stacked
1227
 
        stacked_branch_url = None
1228
 
        if source_branch is not None:
 
1091
        try:
 
1092
            source_branch = self.open_branch()
 
1093
            source_repository = source_branch.repository
1229
1094
            if stacked:
1230
1095
                stacked_branch_url = self.root_transport.base
1231
 
            source_repository = source_branch.repository
1232
 
        else:
 
1096
            else:
 
1097
                # if a stacked branch wasn't requested, we don't create one
 
1098
                # even if the origin was stacked
 
1099
                stacked_branch_url = None
 
1100
        except errors.NotBranchError:
 
1101
            source_branch = None
1233
1102
            try:
1234
 
                source_branch = self.open_branch()
1235
 
                source_repository = source_branch.repository
1236
 
                if stacked:
1237
 
                    stacked_branch_url = self.root_transport.base
1238
 
            except errors.NotBranchError:
1239
 
                source_branch = None
1240
 
                try:
1241
 
                    source_repository = self.open_repository()
1242
 
                except errors.NoRepositoryPresent:
1243
 
                    source_repository = None
 
1103
                source_repository = self.open_repository()
 
1104
            except errors.NoRepositoryPresent:
 
1105
                source_repository = None
 
1106
            stacked_branch_url = None
1244
1107
        repository_policy = result.determine_repository_policy(
1245
1108
            force_new_repo, stacked_branch_url, require_stacking=stacked)
1246
 
        result_repo, is_new_repo = repository_policy.acquire_repository()
1247
 
        if is_new_repo and revision_id is not None and not stacked:
1248
 
            fetch_spec = graph.PendingAncestryResult(
1249
 
                [revision_id], source_repository)
1250
 
        else:
1251
 
            fetch_spec = None
 
1109
        result_repo = repository_policy.acquire_repository()
1252
1110
        if source_repository is not None:
1253
1111
            # Fetch while stacked to prevent unstacked fetch from
1254
1112
            # Branch.sprout.
1255
 
            if fetch_spec is None:
1256
 
                result_repo.fetch(source_repository, revision_id=revision_id)
1257
 
            else:
1258
 
                result_repo.fetch(source_repository, fetch_spec=fetch_spec)
 
1113
            result_repo.fetch(source_repository, revision_id=revision_id)
1259
1114
 
1260
1115
        if source_branch is None:
1261
1116
            # this is for sprouting a bzrdir without a branch; is that
1263
1118
            # Not especially, but it's part of the contract.
1264
1119
            result_branch = result.create_branch()
1265
1120
        else:
1266
 
            result_branch = source_branch.sprout(result,
1267
 
                revision_id=revision_id, repository_policy=repository_policy)
 
1121
            # Force NULL revision to avoid using repository before stacking
 
1122
            # is configured.
 
1123
            result_branch = source_branch.sprout(
 
1124
                result, revision_id=_mod_revision.NULL_REVISION)
 
1125
            parent_location = result_branch.get_parent()
1268
1126
        mutter("created new branch %r" % (result_branch,))
 
1127
        repository_policy.configure_branch(result_branch)
 
1128
        if source_branch is not None:
 
1129
            source_branch.copy_content_into(result_branch, revision_id)
 
1130
            # Override copy_content_into
 
1131
            result_branch.set_parent(parent_location)
1269
1132
 
1270
1133
        # Create/update the result working tree
1271
 
        if (create_tree_if_local and
1272
 
            isinstance(target_transport, local.LocalTransport) and
1273
 
            (result_repo is None or result_repo.make_working_trees())):
 
1134
        if isinstance(target_transport, local.LocalTransport) and (
 
1135
            result_repo is None or result_repo.make_working_trees()):
1274
1136
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1275
1137
                hardlink=hardlink)
1276
1138
            wt.lock_write()
1313
1175
                    basis.unlock()
1314
1176
        return result
1315
1177
 
1316
 
    def push_branch(self, source, revision_id=None, overwrite=False, 
1317
 
        remember=False, create_prefix=False):
1318
 
        """Push the source branch into this BzrDir."""
1319
 
        br_to = None
1320
 
        # If we can open a branch, use its direct repository, otherwise see
1321
 
        # if there is a repository without a branch.
1322
 
        try:
1323
 
            br_to = self.open_branch()
1324
 
        except errors.NotBranchError:
1325
 
            # Didn't find a branch, can we find a repository?
1326
 
            repository_to = self.find_repository()
1327
 
        else:
1328
 
            # Found a branch, so we must have found a repository
1329
 
            repository_to = br_to.repository
1330
 
 
1331
 
        push_result = PushResult()
1332
 
        push_result.source_branch = source
1333
 
        if br_to is None:
1334
 
            # We have a repository but no branch, copy the revisions, and then
1335
 
            # create a branch.
1336
 
            repository_to.fetch(source.repository, revision_id=revision_id)
1337
 
            br_to = source.clone(self, revision_id=revision_id)
1338
 
            if source.get_push_location() is None or remember:
1339
 
                source.set_push_location(br_to.base)
1340
 
            push_result.stacked_on = None
1341
 
            push_result.branch_push_result = None
1342
 
            push_result.old_revno = None
1343
 
            push_result.old_revid = _mod_revision.NULL_REVISION
1344
 
            push_result.target_branch = br_to
1345
 
            push_result.master_branch = None
1346
 
            push_result.workingtree_updated = False
1347
 
        else:
1348
 
            # We have successfully opened the branch, remember if necessary:
1349
 
            if source.get_push_location() is None or remember:
1350
 
                source.set_push_location(br_to.base)
1351
 
            try:
1352
 
                tree_to = self.open_workingtree()
1353
 
            except errors.NotLocalUrl:
1354
 
                push_result.branch_push_result = source.push(br_to, 
1355
 
                    overwrite, stop_revision=revision_id)
1356
 
                push_result.workingtree_updated = False
1357
 
            except errors.NoWorkingTree:
1358
 
                push_result.branch_push_result = source.push(br_to,
1359
 
                    overwrite, stop_revision=revision_id)
1360
 
                push_result.workingtree_updated = None # Not applicable
1361
 
            else:
1362
 
                tree_to.lock_write()
1363
 
                try:
1364
 
                    push_result.branch_push_result = source.push(
1365
 
                        tree_to.branch, overwrite, stop_revision=revision_id)
1366
 
                    tree_to.update()
1367
 
                finally:
1368
 
                    tree_to.unlock()
1369
 
                push_result.workingtree_updated = True
1370
 
            push_result.old_revno = push_result.branch_push_result.old_revno
1371
 
            push_result.old_revid = push_result.branch_push_result.old_revid
1372
 
            push_result.target_branch = \
1373
 
                push_result.branch_push_result.target_branch
1374
 
        return push_result
1375
 
 
1376
 
 
1377
 
class BzrDirHooks(hooks.Hooks):
1378
 
    """Hooks for BzrDir operations."""
1379
 
 
1380
 
    def __init__(self):
1381
 
        """Create the default hooks."""
1382
 
        hooks.Hooks.__init__(self)
1383
 
        self.create_hook(hooks.HookPoint('pre_open',
1384
 
            "Invoked before attempting to open a BzrDir with the transport "
1385
 
            "that the open will use.", (1, 14), None))
1386
 
        self.create_hook(hooks.HookPoint('post_repo_init',
1387
 
            "Invoked after a repository has been initialized. "
1388
 
            "post_repo_init is called with a "
1389
 
            "bzrlib.bzrdir.RepoInitHookParams.",
1390
 
            (2, 2), None))
1391
 
 
1392
 
# install the default hooks
1393
 
BzrDir.hooks = BzrDirHooks()
1394
 
 
1395
 
 
1396
 
class RepoInitHookParams(object):
1397
 
    """Object holding parameters passed to *_repo_init hooks.
1398
 
 
1399
 
    There are 4 fields that hooks may wish to access:
1400
 
 
1401
 
    :ivar repository: Repository created
1402
 
    :ivar format: Repository format
1403
 
    :ivar bzrdir: The bzrdir for the repository
1404
 
    :ivar shared: The repository is shared
1405
 
    """
1406
 
 
1407
 
    def __init__(self, repository, format, a_bzrdir, shared):
1408
 
        """Create a group of RepoInitHook parameters.
1409
 
 
1410
 
        :param repository: Repository created
1411
 
        :param format: Repository format
1412
 
        :param bzrdir: The bzrdir for the repository
1413
 
        :param shared: The repository is shared
1414
 
        """
1415
 
        self.repository = repository
1416
 
        self.format = format
1417
 
        self.bzrdir = a_bzrdir
1418
 
        self.shared = shared
1419
 
 
1420
 
    def __eq__(self, other):
1421
 
        return self.__dict__ == other.__dict__
1422
 
 
1423
 
    def __repr__(self):
1424
 
        if self.repository:
1425
 
            return "<%s for %s>" % (self.__class__.__name__,
1426
 
                self.repository)
1427
 
        else:
1428
 
            return "<%s for %s>" % (self.__class__.__name__,
1429
 
                self.bzrdir)
1430
 
 
1431
1178
 
1432
1179
class BzrDirPreSplitOut(BzrDir):
1433
1180
    """A common class for the all-in-one formats."""
1473
1220
            tree.clone(result)
1474
1221
        return result
1475
1222
 
1476
 
    def create_branch(self, name=None):
 
1223
    def create_branch(self):
1477
1224
        """See BzrDir.create_branch."""
1478
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1225
        return self._format.get_branch_format().initialize(self)
1479
1226
 
1480
 
    def destroy_branch(self, name=None):
 
1227
    def destroy_branch(self):
1481
1228
        """See BzrDir.destroy_branch."""
1482
1229
        raise errors.UnsupportedOperation(self.destroy_branch, self)
1483
1230
 
1504
1251
        # and that will have set it for us, its only
1505
1252
        # specific uses of create_workingtree in isolation
1506
1253
        # that can do wonky stuff here, and that only
1507
 
        # happens for creating checkouts, which cannot be
 
1254
        # happens for creating checkouts, which cannot be 
1508
1255
        # done on this format anyway. So - acceptable wart.
1509
 
        if hardlink:
1510
 
            warning("can't support hardlinked working trees in %r"
1511
 
                % (self,))
1512
1256
        try:
1513
1257
            result = self.open_workingtree(recommend_upgrade=False)
1514
1258
        except errors.NoSuchFile:
1536
1280
 
1537
1281
    def destroy_workingtree_metadata(self):
1538
1282
        """See BzrDir.destroy_workingtree_metadata."""
1539
 
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
 
1283
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata, 
1540
1284
                                          self)
1541
1285
 
1542
 
    def get_branch_transport(self, branch_format, name=None):
 
1286
    def get_branch_transport(self, branch_format):
1543
1287
        """See BzrDir.get_branch_transport()."""
1544
 
        if name is not None:
1545
 
            raise errors.NoColocatedBranchSupport(self)
1546
1288
        if branch_format is None:
1547
1289
            return self.transport
1548
1290
        try:
1576
1318
        # if the format is not the same as the system default,
1577
1319
        # an upgrade is needed.
1578
1320
        if format is None:
1579
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1580
 
                % 'needs_format_conversion(format=None)')
1581
1321
            format = BzrDirFormat.get_default_format()
1582
1322
        return not isinstance(self._format, format.__class__)
1583
1323
 
1584
 
    def open_branch(self, name=None, unsupported=False,
1585
 
                    ignore_fallbacks=False):
 
1324
    def open_branch(self, unsupported=False):
1586
1325
        """See BzrDir.open_branch."""
1587
1326
        from bzrlib.branch import BzrBranchFormat4
1588
1327
        format = BzrBranchFormat4()
1589
1328
        self._check_supported(format, unsupported)
1590
 
        return format.open(self, name, _found=True)
 
1329
        return format.open(self, _found=True)
1591
1330
 
1592
1331
    def sprout(self, url, revision_id=None, force_new_repo=False,
1593
1332
               possible_transports=None, accelerator_tree=None,
1594
 
               hardlink=False, stacked=False, create_tree_if_local=True,
1595
 
               source_branch=None):
 
1333
               hardlink=False, stacked=False):
1596
1334
        """See BzrDir.sprout()."""
1597
 
        if source_branch is not None:
1598
 
            my_branch = self.open_branch()
1599
 
            if source_branch.base != my_branch.base:
1600
 
                raise AssertionError(
1601
 
                    "source branch %r is not within %r with branch %r" %
1602
 
                    (source_branch, self, my_branch))
1603
1335
        if stacked:
1604
1336
            raise errors.UnstackableBranchFormat(
1605
1337
                self._format, self.root_transport.base)
1606
 
        if not create_tree_if_local:
1607
 
            raise errors.MustHaveWorkingTree(
1608
 
                self._format, self.root_transport.base)
1609
1338
        from bzrlib.workingtree import WorkingTreeFormat2
1610
1339
        self._make_tail(url)
1611
1340
        result = self._format._initialize_for_clone(url)
1617
1346
            self.open_branch().sprout(result, revision_id=revision_id)
1618
1347
        except errors.NotBranchError:
1619
1348
            pass
1620
 
 
1621
1349
        # we always want a working tree
1622
1350
        WorkingTreeFormat2().initialize(result,
1623
1351
                                        accelerator_tree=accelerator_tree,
1627
1355
 
1628
1356
class BzrDir4(BzrDirPreSplitOut):
1629
1357
    """A .bzr version 4 control object.
1630
 
 
 
1358
    
1631
1359
    This is a deprecated format and may be removed after sept 2006.
1632
1360
    """
1633
1361
 
1637
1365
 
1638
1366
    def needs_format_conversion(self, format=None):
1639
1367
        """Format 4 dirs are always in need of conversion."""
1640
 
        if format is None:
1641
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1642
 
                % 'needs_format_conversion(format=None)')
1643
1368
        return True
1644
1369
 
1645
1370
    def open_repository(self):
1654
1379
    This is a deprecated format and may be removed after sept 2006.
1655
1380
    """
1656
1381
 
1657
 
    def has_workingtree(self):
1658
 
        """See BzrDir.has_workingtree."""
1659
 
        return True
1660
 
    
1661
1382
    def open_repository(self):
1662
1383
        """See BzrDir.open_repository."""
1663
1384
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1679
1400
    This is a deprecated format and may be removed after sept 2006.
1680
1401
    """
1681
1402
 
1682
 
    def has_workingtree(self):
1683
 
        """See BzrDir.has_workingtree."""
1684
 
        return True
1685
 
    
1686
1403
    def open_repository(self):
1687
1404
        """See BzrDir.open_repository."""
1688
1405
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1699
1416
 
1700
1417
class BzrDirMeta1(BzrDir):
1701
1418
    """A .bzr meta version 1 control object.
1702
 
 
1703
 
    This is the first control object where the
 
1419
    
 
1420
    This is the first control object where the 
1704
1421
    individual aspects are really split out: there are separate repository,
1705
1422
    workingtree and branch subdirectories and any subset of the three can be
1706
1423
    present within a BzrDir.
1710
1427
        """See BzrDir.can_convert_format()."""
1711
1428
        return True
1712
1429
 
1713
 
    def create_branch(self, name=None):
 
1430
    def create_branch(self):
1714
1431
        """See BzrDir.create_branch."""
1715
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1432
        return self._format.get_branch_format().initialize(self)
1716
1433
 
1717
 
    def destroy_branch(self, name=None):
 
1434
    def destroy_branch(self):
1718
1435
        """See BzrDir.create_branch."""
1719
 
        if name is not None:
1720
 
            raise errors.NoColocatedBranchSupport(self)
1721
1436
        self.transport.delete_tree('branch')
1722
1437
 
1723
1438
    def create_repository(self, shared=False):
1746
1461
    def destroy_workingtree_metadata(self):
1747
1462
        self.transport.delete_tree('checkout')
1748
1463
 
1749
 
    def find_branch_format(self, name=None):
 
1464
    def find_branch_format(self):
1750
1465
        """Find the branch 'format' for this bzrdir.
1751
1466
 
1752
1467
        This might be a synthetic object for e.g. RemoteBranch and SVN.
1753
1468
        """
1754
1469
        from bzrlib.branch import BranchFormat
1755
 
        return BranchFormat.find_format(self, name=name)
 
1470
        return BranchFormat.find_format(self)
1756
1471
 
1757
1472
    def _get_mkdir_mode(self):
1758
1473
        """Figure out the mode to use when creating a bzrdir subdir."""
1760
1475
                                     lockable_files.TransportLock)
1761
1476
        return temp_control._dir_mode
1762
1477
 
1763
 
    def get_branch_reference(self, name=None):
 
1478
    def get_branch_reference(self):
1764
1479
        """See BzrDir.get_branch_reference()."""
1765
1480
        from bzrlib.branch import BranchFormat
1766
 
        format = BranchFormat.find_format(self, name=name)
1767
 
        return format.get_reference(self, name=name)
 
1481
        format = BranchFormat.find_format(self)
 
1482
        return format.get_reference(self)
1768
1483
 
1769
 
    def get_branch_transport(self, branch_format, name=None):
 
1484
    def get_branch_transport(self, branch_format):
1770
1485
        """See BzrDir.get_branch_transport()."""
1771
 
        if name is not None:
1772
 
            raise errors.NoColocatedBranchSupport(self)
1773
 
        # XXX: this shouldn't implicitly create the directory if it's just
1774
 
        # promising to get a transport -- mbp 20090727
1775
1486
        if branch_format is None:
1776
1487
            return self.transport.clone('branch')
1777
1488
        try:
1812
1523
            pass
1813
1524
        return self.transport.clone('checkout')
1814
1525
 
1815
 
    def has_workingtree(self):
1816
 
        """Tell if this bzrdir contains a working tree.
1817
 
 
1818
 
        This will still raise an exception if the bzrdir has a workingtree that
1819
 
        is remote & inaccessible.
1820
 
 
1821
 
        Note: if you're going to open the working tree, you should just go
1822
 
        ahead and try, and not ask permission first.
1823
 
        """
1824
 
        from bzrlib.workingtree import WorkingTreeFormat
1825
 
        try:
1826
 
            WorkingTreeFormat.find_format(self)
1827
 
        except errors.NoWorkingTree:
1828
 
            return False
1829
 
        return True
1830
 
 
1831
1526
    def needs_format_conversion(self, format=None):
1832
1527
        """See BzrDir.needs_format_conversion()."""
1833
1528
        if format is None:
1834
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1835
 
                % 'needs_format_conversion(format=None)')
1836
 
        if format is None:
1837
1529
            format = BzrDirFormat.get_default_format()
1838
1530
        if not isinstance(self._format, format.__class__):
1839
1531
            # it is not a meta dir format, conversion is needed.
1846
1538
                return True
1847
1539
        except errors.NoRepositoryPresent:
1848
1540
            pass
1849
 
        for branch in self.list_branches():
1850
 
            if not isinstance(branch._format,
 
1541
        try:
 
1542
            if not isinstance(self.open_branch()._format,
1851
1543
                              format.get_branch_format().__class__):
1852
1544
                # the branch needs an upgrade.
1853
1545
                return True
 
1546
        except errors.NotBranchError:
 
1547
            pass
1854
1548
        try:
1855
1549
            my_wt = self.open_workingtree(recommend_upgrade=False)
1856
1550
            if not isinstance(my_wt._format,
1861
1555
            pass
1862
1556
        return False
1863
1557
 
1864
 
    def open_branch(self, name=None, unsupported=False,
1865
 
                    ignore_fallbacks=False):
 
1558
    def open_branch(self, unsupported=False):
1866
1559
        """See BzrDir.open_branch."""
1867
 
        format = self.find_branch_format(name=name)
 
1560
        format = self.find_branch_format()
1868
1561
        self._check_supported(format, unsupported)
1869
 
        return format.open(self, name=name,
1870
 
            _found=True, ignore_fallbacks=ignore_fallbacks)
 
1562
        return format.open(self, _found=True)
1871
1563
 
1872
1564
    def open_repository(self, unsupported=False):
1873
1565
        """See BzrDir.open_repository."""
1887
1579
        return format.open(self, _found=True)
1888
1580
 
1889
1581
    def _get_config(self):
1890
 
        return config.TransportConfig(self.transport, 'control.conf')
 
1582
        return config.BzrDirConfig(self.transport)
1891
1583
 
1892
1584
 
1893
1585
class BzrDirFormat(object):
1898
1590
     * a format string,
1899
1591
     * an open routine.
1900
1592
 
1901
 
    Formats are placed in a dict by their format string for reference
 
1593
    Formats are placed in a dict by their format string for reference 
1902
1594
    during bzrdir opening. These should be subclasses of BzrDirFormat
1903
1595
    for consistency.
1904
1596
 
1905
1597
    Once a format is deprecated, just deprecate the initialize and open
1906
 
    methods on the format class. Do not deprecate the object, as the
 
1598
    methods on the format class. Do not deprecate the object, as the 
1907
1599
    object will be created every system load.
1908
 
 
1909
 
    :cvar colocated_branches: Whether this formats supports colocated branches.
1910
1600
    """
1911
1601
 
1912
1602
    _default_format = None
1917
1607
 
1918
1608
    _control_formats = []
1919
1609
    """The registered control formats - .bzr, ....
1920
 
 
 
1610
    
1921
1611
    This is a list of BzrDirFormat objects.
1922
1612
    """
1923
1613
 
1929
1619
 
1930
1620
    _lock_file_name = 'branch-lock'
1931
1621
 
1932
 
    colocated_branches = False
1933
 
    """Whether co-located branches are supported for this control dir format.
1934
 
    """
1935
 
 
1936
1622
    # _lock_class must be set in subclasses to the lock type, typ.
1937
1623
    # TransportLock or LockDir
1938
1624
 
1955
1641
    def probe_transport(klass, transport):
1956
1642
        """Return the .bzrdir style format present in a directory."""
1957
1643
        try:
1958
 
            format_string = transport.get_bytes(".bzr/branch-format")
 
1644
            format_string = transport.get(".bzr/branch-format").read()
1959
1645
        except errors.NoSuchFile:
1960
1646
            raise errors.NotBranchError(path=transport.base)
1961
1647
 
1986
1672
        current default format. In the case of plugins we can/should provide
1987
1673
        some means for them to extend the range of returnable converters.
1988
1674
 
1989
 
        :param format: Optional format to override the default format of the
 
1675
        :param format: Optional format to override the default format of the 
1990
1676
                       library.
1991
1677
        """
1992
1678
        raise NotImplementedError(self.get_converter)
1993
1679
 
1994
1680
    def initialize(self, url, possible_transports=None):
1995
1681
        """Create a bzr control dir at this url and return an opened copy.
1996
 
 
1997
 
        While not deprecated, this method is very specific and its use will
1998
 
        lead to many round trips to setup a working environment. See
1999
 
        initialize_on_transport_ex for a [nearly] all-in-one method.
2000
 
 
 
1682
        
2001
1683
        Subclasses should typically override initialize_on_transport
2002
1684
        instead of this method.
2003
1685
        """
2006
1688
 
2007
1689
    def initialize_on_transport(self, transport):
2008
1690
        """Initialize a new bzrdir in the base directory of a Transport."""
2009
 
        try:
2010
 
            # can we hand off the request to the smart server rather than using
2011
 
            # vfs calls?
2012
 
            client_medium = transport.get_smart_medium()
2013
 
        except errors.NoSmartMedium:
2014
 
            return self._initialize_on_transport_vfs(transport)
2015
 
        else:
2016
 
            # Current RPC's only know how to create bzr metadir1 instances, so
2017
 
            # we still delegate to vfs methods if the requested format is not a
2018
 
            # metadir1
2019
 
            if type(self) != BzrDirMetaFormat1:
2020
 
                return self._initialize_on_transport_vfs(transport)
2021
 
            remote_format = RemoteBzrDirFormat()
2022
 
            self._supply_sub_formats_to(remote_format)
2023
 
            return remote_format.initialize_on_transport(transport)
2024
 
 
2025
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2026
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
2027
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2028
 
        shared_repo=False, vfs_only=False):
2029
 
        """Create this format on transport.
2030
 
 
2031
 
        The directory to initialize will be created.
2032
 
 
2033
 
        :param force_new_repo: Do not use a shared repository for the target,
2034
 
                               even if one is available.
2035
 
        :param create_prefix: Create any missing directories leading up to
2036
 
            to_transport.
2037
 
        :param use_existing_dir: Use an existing directory if one exists.
2038
 
        :param stacked_on: A url to stack any created branch on, None to follow
2039
 
            any target stacking policy.
2040
 
        :param stack_on_pwd: If stack_on is relative, the location it is
2041
 
            relative to.
2042
 
        :param repo_format_name: If non-None, a repository will be
2043
 
            made-or-found. Should none be found, or if force_new_repo is True
2044
 
            the repo_format_name is used to select the format of repository to
2045
 
            create.
2046
 
        :param make_working_trees: Control the setting of make_working_trees
2047
 
            for a new shared repository when one is made. None to use whatever
2048
 
            default the format has.
2049
 
        :param shared_repo: Control whether made repositories are shared or
2050
 
            not.
2051
 
        :param vfs_only: If True do not attempt to use a smart server
2052
 
        :return: repo, bzrdir, require_stacking, repository_policy. repo is
2053
 
            None if none was created or found, bzrdir is always valid.
2054
 
            require_stacking is the result of examining the stacked_on
2055
 
            parameter and any stacking policy found for the target.
2056
 
        """
2057
 
        if not vfs_only:
2058
 
            # Try to hand off to a smart server 
2059
 
            try:
2060
 
                client_medium = transport.get_smart_medium()
2061
 
            except errors.NoSmartMedium:
2062
 
                pass
2063
 
            else:
2064
 
                # TODO: lookup the local format from a server hint.
2065
 
                remote_dir_format = RemoteBzrDirFormat()
2066
 
                remote_dir_format._network_name = self.network_name()
2067
 
                self._supply_sub_formats_to(remote_dir_format)
2068
 
                return remote_dir_format.initialize_on_transport_ex(transport,
2069
 
                    use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2070
 
                    force_new_repo=force_new_repo, stacked_on=stacked_on,
2071
 
                    stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2072
 
                    make_working_trees=make_working_trees, shared_repo=shared_repo)
2073
 
        # XXX: Refactor the create_prefix/no_create_prefix code into a
2074
 
        #      common helper function
2075
 
        # The destination may not exist - if so make it according to policy.
2076
 
        def make_directory(transport):
2077
 
            transport.mkdir('.')
2078
 
            return transport
2079
 
        def redirected(transport, e, redirection_notice):
2080
 
            note(redirection_notice)
2081
 
            return transport._redirected_to(e.source, e.target)
2082
 
        try:
2083
 
            transport = do_catching_redirections(make_directory, transport,
2084
 
                redirected)
2085
 
        except errors.FileExists:
2086
 
            if not use_existing_dir:
2087
 
                raise
2088
 
        except errors.NoSuchFile:
2089
 
            if not create_prefix:
2090
 
                raise
2091
 
            transport.create_prefix()
2092
 
 
2093
 
        require_stacking = (stacked_on is not None)
2094
 
        # Now the target directory exists, but doesn't have a .bzr
2095
 
        # directory. So we need to create it, along with any work to create
2096
 
        # all of the dependent branches, etc.
2097
 
 
2098
 
        result = self.initialize_on_transport(transport)
2099
 
        if repo_format_name:
2100
 
            try:
2101
 
                # use a custom format
2102
 
                result._format.repository_format = \
2103
 
                    repository.network_format_registry.get(repo_format_name)
2104
 
            except AttributeError:
2105
 
                # The format didn't permit it to be set.
2106
 
                pass
2107
 
            # A repository is desired, either in-place or shared.
2108
 
            repository_policy = result.determine_repository_policy(
2109
 
                force_new_repo, stacked_on, stack_on_pwd,
2110
 
                require_stacking=require_stacking)
2111
 
            result_repo, is_new_repo = repository_policy.acquire_repository(
2112
 
                make_working_trees, shared_repo)
2113
 
            if not require_stacking and repository_policy._require_stacking:
2114
 
                require_stacking = True
2115
 
                result._format.require_stacking()
2116
 
            result_repo.lock_write()
2117
 
        else:
2118
 
            result_repo = None
2119
 
            repository_policy = None
2120
 
        return result_repo, result, require_stacking, repository_policy
2121
 
 
2122
 
    def _initialize_on_transport_vfs(self, transport):
2123
 
        """Initialize a new bzrdir using VFS calls.
2124
 
 
2125
 
        :param transport: The transport to create the .bzr directory in.
2126
 
        :return: A
2127
 
        """
2128
 
        # Since we are creating a .bzr directory, inherit the
 
1691
        # Since we don't have a .bzr directory, inherit the
2129
1692
        # mode from the root directory
2130
1693
        temp_control = lockable_files.LockableFiles(transport,
2131
1694
                            '', lockable_files.TransportLock)
2161
1724
        """Is this format supported?
2162
1725
 
2163
1726
        Supported formats must be initializable and openable.
2164
 
        Unsupported formats may not support initialization or committing or
 
1727
        Unsupported formats may not support initialization or committing or 
2165
1728
        some other features depending on the reason for not being supported.
2166
1729
        """
2167
1730
        return True
2168
1731
 
2169
 
    def network_name(self):
2170
 
        """A simple byte string uniquely identifying this format for RPC calls.
2171
 
 
2172
 
        Bzr control formats use thir disk format string to identify the format
2173
 
        over the wire. Its possible that other control formats have more
2174
 
        complex detection requirements, so we permit them to use any unique and
2175
 
        immutable string they desire.
2176
 
        """
2177
 
        raise NotImplementedError(self.network_name)
2178
 
 
2179
1732
    def same_model(self, target_format):
2180
 
        return (self.repository_format.rich_root_data ==
 
1733
        return (self.repository_format.rich_root_data == 
2181
1734
            target_format.rich_root_data)
2182
1735
 
2183
1736
    @classmethod
2184
1737
    def known_formats(klass):
2185
1738
        """Return all the known formats.
2186
 
 
 
1739
        
2187
1740
        Concrete formats should override _known_formats.
2188
1741
        """
2189
 
        # There is double indirection here to make sure that control
2190
 
        # formats used by more than one dir format will only be probed
 
1742
        # There is double indirection here to make sure that control 
 
1743
        # formats used by more than one dir format will only be probed 
2191
1744
        # once. This can otherwise be quite expensive for remote connections.
2192
1745
        result = set()
2193
1746
        for format in klass._control_formats:
2194
1747
            result.update(format._known_formats())
2195
1748
        return result
2196
 
 
 
1749
    
2197
1750
    @classmethod
2198
1751
    def _known_formats(klass):
2199
1752
        """Return the known format instances for this control format."""
2201
1754
 
2202
1755
    def open(self, transport, _found=False):
2203
1756
        """Return an instance of this format for the dir transport points at.
2204
 
 
 
1757
        
2205
1758
        _found is a private parameter, do not use it.
2206
1759
        """
2207
1760
        if not _found:
2208
1761
            found_format = BzrDirFormat.find_format(transport)
2209
1762
            if not isinstance(found_format, self.__class__):
2210
1763
                raise AssertionError("%s was asked to open %s, but it seems to need "
2211
 
                        "format %s"
 
1764
                        "format %s" 
2212
1765
                        % (self, transport, found_format))
2213
 
            # Allow subclasses - use the found format.
2214
 
            self._supply_sub_formats_to(found_format)
2215
 
            return found_format._open(transport)
2216
1766
        return self._open(transport)
2217
1767
 
2218
1768
    def _open(self, transport):
2226
1776
    @classmethod
2227
1777
    def register_format(klass, format):
2228
1778
        klass._formats[format.get_format_string()] = format
2229
 
        # bzr native formats have a network name of their format string.
2230
 
        network_format_registry.register(format.get_format_string(), format.__class__)
2231
1779
 
2232
1780
    @classmethod
2233
1781
    def register_control_format(klass, format):
2234
1782
        """Register a format that does not use '.bzr' for its control dir.
2235
1783
 
2236
1784
        TODO: This should be pulled up into a 'ControlDirFormat' base class
2237
 
        which BzrDirFormat can inherit from, and renamed to register_format
 
1785
        which BzrDirFormat can inherit from, and renamed to register_format 
2238
1786
        there. It has been done without that for now for simplicity of
2239
1787
        implementation.
2240
1788
        """
2258
1806
 
2259
1807
    def __str__(self):
2260
1808
        # Trim the newline
2261
 
        return self.get_format_description().rstrip()
2262
 
 
2263
 
    def _supply_sub_formats_to(self, other_format):
2264
 
        """Give other_format the same values for sub formats as this has.
2265
 
 
2266
 
        This method is expected to be used when parameterising a
2267
 
        RemoteBzrDirFormat instance with the parameters from a
2268
 
        BzrDirMetaFormat1 instance.
2269
 
 
2270
 
        :param other_format: other_format is a format which should be
2271
 
            compatible with whatever sub formats are supported by self.
2272
 
        :return: None.
2273
 
        """
 
1809
        return self.get_format_string().rstrip()
2274
1810
 
2275
1811
    @classmethod
2276
1812
    def unregister_format(klass, format):
2308
1844
        """See BzrDirFormat.get_converter()."""
2309
1845
        # there is one and only one upgrade path here.
2310
1846
        return ConvertBzrDir4To5()
2311
 
 
 
1847
        
2312
1848
    def initialize_on_transport(self, transport):
2313
1849
        """Format 4 branches cannot be created."""
2314
1850
        raise errors.UninitializableFormat(self)
2317
1853
        """Format 4 is not supported.
2318
1854
 
2319
1855
        It is not supported because the model changed from 4 to 5 and the
2320
 
        conversion logic is expensive - so doing it on the fly was not
 
1856
        conversion logic is expensive - so doing it on the fly was not 
2321
1857
        feasible.
2322
1858
        """
2323
1859
        return False
2324
1860
 
2325
 
    def network_name(self):
2326
 
        return self.get_format_string()
2327
 
 
2328
1861
    def _open(self, transport):
2329
1862
        """See BzrDirFormat._open."""
2330
1863
        return BzrDir4(transport, self)
2336
1869
    repository_format = property(__return_repository_format)
2337
1870
 
2338
1871
 
2339
 
class BzrDirFormatAllInOne(BzrDirFormat):
2340
 
    """Common class for formats before meta-dirs."""
2341
 
 
2342
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2343
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
2344
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2345
 
        shared_repo=False):
2346
 
        """See BzrDirFormat.initialize_on_transport_ex."""
2347
 
        require_stacking = (stacked_on is not None)
2348
 
        # Format 5 cannot stack, but we've been asked to - actually init
2349
 
        # a Meta1Dir
2350
 
        if require_stacking:
2351
 
            format = BzrDirMetaFormat1()
2352
 
            return format.initialize_on_transport_ex(transport,
2353
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2354
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
2355
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2356
 
                make_working_trees=make_working_trees, shared_repo=shared_repo)
2357
 
        return BzrDirFormat.initialize_on_transport_ex(self, transport,
2358
 
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2359
 
            force_new_repo=force_new_repo, stacked_on=stacked_on,
2360
 
            stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2361
 
            make_working_trees=make_working_trees, shared_repo=shared_repo)
2362
 
 
2363
 
 
2364
 
class BzrDirFormat5(BzrDirFormatAllInOne):
 
1872
class BzrDirFormat5(BzrDirFormat):
2365
1873
    """Bzr control format 5.
2366
1874
 
2367
1875
    This format is a combined format for working tree, branch and repository.
2368
1876
    It has:
2369
 
     - Format 2 working trees [always]
2370
 
     - Format 4 branches [always]
 
1877
     - Format 2 working trees [always] 
 
1878
     - Format 4 branches [always] 
2371
1879
     - Format 5 repositories [always]
2372
1880
       Unhashed stores in the repository.
2373
1881
    """
2393
1901
 
2394
1902
    def _initialize_for_clone(self, url):
2395
1903
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2396
 
 
 
1904
        
2397
1905
    def initialize_on_transport(self, transport, _cloning=False):
2398
1906
        """Format 5 dirs always have working tree, branch and repository.
2399
 
 
 
1907
        
2400
1908
        Except when they are being cloned.
2401
1909
        """
2402
1910
        from bzrlib.branch import BzrBranchFormat4
2408
1916
            result._init_workingtree()
2409
1917
        return result
2410
1918
 
2411
 
    def network_name(self):
2412
 
        return self.get_format_string()
2413
 
 
2414
1919
    def _open(self, transport):
2415
1920
        """See BzrDirFormat._open."""
2416
1921
        return BzrDir5(transport, self)
2422
1927
    repository_format = property(__return_repository_format)
2423
1928
 
2424
1929
 
2425
 
class BzrDirFormat6(BzrDirFormatAllInOne):
 
1930
class BzrDirFormat6(BzrDirFormat):
2426
1931
    """Bzr control format 6.
2427
1932
 
2428
1933
    This format is a combined format for working tree, branch and repository.
2429
1934
    It has:
2430
 
     - Format 2 working trees [always]
2431
 
     - Format 4 branches [always]
 
1935
     - Format 2 working trees [always] 
 
1936
     - Format 4 branches [always] 
2432
1937
     - Format 6 repositories [always]
2433
1938
    """
2434
1939
 
2450
1955
        """See BzrDirFormat.get_converter()."""
2451
1956
        # there is one and only one upgrade path here.
2452
1957
        return ConvertBzrDir6ToMeta()
2453
 
 
 
1958
        
2454
1959
    def _initialize_for_clone(self, url):
2455
1960
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2456
1961
 
2457
1962
    def initialize_on_transport(self, transport, _cloning=False):
2458
1963
        """Format 6 dirs always have working tree, branch and repository.
2459
 
 
 
1964
        
2460
1965
        Except when they are being cloned.
2461
1966
        """
2462
1967
        from bzrlib.branch import BzrBranchFormat4
2468
1973
            result._init_workingtree()
2469
1974
        return result
2470
1975
 
2471
 
    def network_name(self):
2472
 
        return self.get_format_string()
2473
 
 
2474
1976
    def _open(self, transport):
2475
1977
        """See BzrDirFormat._open."""
2476
1978
        return BzrDir6(transport, self)
2498
2000
    def __init__(self):
2499
2001
        self._workingtree_format = None
2500
2002
        self._branch_format = None
2501
 
        self._repository_format = None
2502
2003
 
2503
2004
    def __eq__(self, other):
2504
2005
        if other.__class__ is not self.__class__:
2521
2022
    def set_branch_format(self, format):
2522
2023
        self._branch_format = format
2523
2024
 
2524
 
    def require_stacking(self, stack_on=None, possible_transports=None,
2525
 
            _skip_repo=False):
2526
 
        """We have a request to stack, try to ensure the formats support it.
2527
 
 
2528
 
        :param stack_on: If supplied, it is the URL to a branch that we want to
2529
 
            stack on. Check to see if that format supports stacking before
2530
 
            forcing an upgrade.
2531
 
        """
2532
 
        # Stacking is desired. requested by the target, but does the place it
2533
 
        # points at support stacking? If it doesn't then we should
2534
 
        # not implicitly upgrade. We check this here.
2535
 
        new_repo_format = None
2536
 
        new_branch_format = None
2537
 
 
2538
 
        # a bit of state for get_target_branch so that we don't try to open it
2539
 
        # 2 times, for both repo *and* branch
2540
 
        target = [None, False, None] # target_branch, checked, upgrade anyway
2541
 
        def get_target_branch():
2542
 
            if target[1]:
2543
 
                # We've checked, don't check again
2544
 
                return target
2545
 
            if stack_on is None:
2546
 
                # No target format, that means we want to force upgrading
2547
 
                target[:] = [None, True, True]
2548
 
                return target
2549
 
            try:
2550
 
                target_dir = BzrDir.open(stack_on,
2551
 
                    possible_transports=possible_transports)
2552
 
            except errors.NotBranchError:
2553
 
                # Nothing there, don't change formats
2554
 
                target[:] = [None, True, False]
2555
 
                return target
2556
 
            except errors.JailBreak:
2557
 
                # JailBreak, JFDI and upgrade anyway
2558
 
                target[:] = [None, True, True]
2559
 
                return target
2560
 
            try:
2561
 
                target_branch = target_dir.open_branch()
2562
 
            except errors.NotBranchError:
2563
 
                # No branch, don't upgrade formats
2564
 
                target[:] = [None, True, False]
2565
 
                return target
2566
 
            target[:] = [target_branch, True, False]
2567
 
            return target
2568
 
 
2569
 
        if (not _skip_repo and
2570
 
                 not self.repository_format.supports_external_lookups):
2571
 
            # We need to upgrade the Repository.
2572
 
            target_branch, _, do_upgrade = get_target_branch()
2573
 
            if target_branch is None:
2574
 
                # We don't have a target branch, should we upgrade anyway?
2575
 
                if do_upgrade:
2576
 
                    # stack_on is inaccessible, JFDI.
2577
 
                    # TODO: bad monkey, hard-coded formats...
2578
 
                    if self.repository_format.rich_root_data:
2579
 
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2580
 
                    else:
2581
 
                        new_repo_format = pack_repo.RepositoryFormatKnitPack5()
2582
 
            else:
2583
 
                # If the target already supports stacking, then we know the
2584
 
                # project is already able to use stacking, so auto-upgrade
2585
 
                # for them
2586
 
                new_repo_format = target_branch.repository._format
2587
 
                if not new_repo_format.supports_external_lookups:
2588
 
                    # target doesn't, source doesn't, so don't auto upgrade
2589
 
                    # repo
2590
 
                    new_repo_format = None
2591
 
            if new_repo_format is not None:
2592
 
                self.repository_format = new_repo_format
2593
 
                note('Source repository format does not support stacking,'
2594
 
                     ' using format:\n  %s',
2595
 
                     new_repo_format.get_format_description())
2596
 
 
2597
 
        if not self.get_branch_format().supports_stacking():
2598
 
            # We just checked the repo, now lets check if we need to
2599
 
            # upgrade the branch format
2600
 
            target_branch, _, do_upgrade = get_target_branch()
2601
 
            if target_branch is None:
2602
 
                if do_upgrade:
2603
 
                    # TODO: bad monkey, hard-coded formats...
2604
 
                    new_branch_format = branch.BzrBranchFormat7()
2605
 
            else:
2606
 
                new_branch_format = target_branch._format
2607
 
                if not new_branch_format.supports_stacking():
2608
 
                    new_branch_format = None
2609
 
            if new_branch_format is not None:
2610
 
                # Does support stacking, use its format.
2611
 
                self.set_branch_format(new_branch_format)
2612
 
                note('Source branch format does not support stacking,'
2613
 
                     ' using format:\n  %s',
2614
 
                     new_branch_format.get_format_description())
2615
 
 
2616
2025
    def get_converter(self, format=None):
2617
2026
        """See BzrDirFormat.get_converter()."""
2618
2027
        if format is None:
2630
2039
        """See BzrDirFormat.get_format_description()."""
2631
2040
        return "Meta directory format 1"
2632
2041
 
2633
 
    def network_name(self):
2634
 
        return self.get_format_string()
2635
 
 
2636
2042
    def _open(self, transport):
2637
2043
        """See BzrDirFormat._open."""
2638
 
        # Create a new format instance because otherwise initialisation of new
2639
 
        # metadirs share the global default format object leading to alias
2640
 
        # problems.
2641
 
        format = BzrDirMetaFormat1()
2642
 
        self._supply_sub_formats_to(format)
2643
 
        return BzrDirMeta1(transport, format)
 
2044
        return BzrDirMeta1(transport, self)
2644
2045
 
2645
2046
    def __return_repository_format(self):
2646
2047
        """Circular import protection."""
2647
 
        if self._repository_format:
 
2048
        if getattr(self, '_repository_format', None):
2648
2049
            return self._repository_format
2649
2050
        from bzrlib.repository import RepositoryFormat
2650
2051
        return RepositoryFormat.get_default_format()
2651
2052
 
2652
 
    def _set_repository_format(self, value):
 
2053
    def __set_repository_format(self, value):
2653
2054
        """Allow changing the repository format for metadir formats."""
2654
2055
        self._repository_format = value
2655
2056
 
2656
 
    repository_format = property(__return_repository_format,
2657
 
        _set_repository_format)
2658
 
 
2659
 
    def _supply_sub_formats_to(self, other_format):
2660
 
        """Give other_format the same values for sub formats as this has.
2661
 
 
2662
 
        This method is expected to be used when parameterising a
2663
 
        RemoteBzrDirFormat instance with the parameters from a
2664
 
        BzrDirMetaFormat1 instance.
2665
 
 
2666
 
        :param other_format: other_format is a format which should be
2667
 
            compatible with whatever sub formats are supported by self.
2668
 
        :return: None.
2669
 
        """
2670
 
        if getattr(self, '_repository_format', None) is not None:
2671
 
            other_format.repository_format = self.repository_format
2672
 
        if self._branch_format is not None:
2673
 
            other_format._branch_format = self._branch_format
2674
 
        if self._workingtree_format is not None:
2675
 
            other_format.workingtree_format = self.workingtree_format
 
2057
    repository_format = property(__return_repository_format, __set_repository_format)
2676
2058
 
2677
2059
    def __get_workingtree_format(self):
2678
2060
        if self._workingtree_format is None:
2687
2069
                                  __set_workingtree_format)
2688
2070
 
2689
2071
 
2690
 
network_format_registry = registry.FormatRegistry()
2691
 
"""Registry of formats indexed by their network name.
2692
 
 
2693
 
The network name for a BzrDirFormat is an identifier that can be used when
2694
 
referring to formats with smart server operations. See
2695
 
BzrDirFormat.network_name() for more detail.
2696
 
"""
2697
 
 
2698
 
 
2699
2072
# Register bzr control format
2700
2073
BzrDirFormat.register_control_format(BzrDirFormat)
2701
2074
 
2733
2106
        self.absent_revisions = set()
2734
2107
        self.text_count = 0
2735
2108
        self.revisions = {}
2736
 
 
 
2109
        
2737
2110
    def convert(self, to_convert, pb):
2738
2111
        """See Converter.convert()."""
2739
2112
        self.bzrdir = to_convert
2740
 
        if pb is not None:
2741
 
            warnings.warn("pb parameter to convert() is deprecated")
2742
 
        self.pb = ui.ui_factory.nested_progress_bar()
2743
 
        try:
2744
 
            ui.ui_factory.note('starting upgrade from format 4 to 5')
2745
 
            if isinstance(self.bzrdir.transport, local.LocalTransport):
2746
 
                self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2747
 
            self._convert_to_weaves()
2748
 
            return BzrDir.open(self.bzrdir.user_url)
2749
 
        finally:
2750
 
            self.pb.finished()
 
2113
        self.pb = pb
 
2114
        self.pb.note('starting upgrade from format 4 to 5')
 
2115
        if isinstance(self.bzrdir.transport, local.LocalTransport):
 
2116
            self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
 
2117
        self._convert_to_weaves()
 
2118
        return BzrDir.open(self.bzrdir.root_transport.base)
2751
2119
 
2752
2120
    def _convert_to_weaves(self):
2753
 
        ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
 
2121
        self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2754
2122
        try:
2755
2123
            # TODO permissions
2756
2124
            stat = self.bzrdir.transport.stat('weaves')
2784
2152
        self.pb.clear()
2785
2153
        self._write_all_weaves()
2786
2154
        self._write_all_revs()
2787
 
        ui.ui_factory.note('upgraded to weaves:')
2788
 
        ui.ui_factory.note('  %6d revisions and inventories' % len(self.revisions))
2789
 
        ui.ui_factory.note('  %6d revisions not present' % len(self.absent_revisions))
2790
 
        ui.ui_factory.note('  %6d texts' % self.text_count)
 
2155
        self.pb.note('upgraded to weaves:')
 
2156
        self.pb.note('  %6d revisions and inventories', len(self.revisions))
 
2157
        self.pb.note('  %6d revisions not present', len(self.absent_revisions))
 
2158
        self.pb.note('  %6d texts', self.text_count)
2791
2159
        self._cleanup_spare_files_after_format4()
2792
2160
        self.branch._transport.put_bytes(
2793
2161
            'branch-format',
2850
2218
                revision_store.add_lines(key, None, osutils.split_lines(text))
2851
2219
        finally:
2852
2220
            self.pb.clear()
2853
 
 
 
2221
            
2854
2222
    def _load_one_rev(self, rev_id):
2855
2223
        """Load a revision object into memory.
2856
2224
 
2861
2229
                       len(self.known_revisions))
2862
2230
        if not self.branch.repository.has_revision(rev_id):
2863
2231
            self.pb.clear()
2864
 
            ui.ui_factory.note('revision {%s} not present in branch; '
2865
 
                         'will be converted as a ghost' %
 
2232
            self.pb.note('revision {%s} not present in branch; '
 
2233
                         'will be converted as a ghost',
2866
2234
                         rev_id)
2867
2235
            self.absent_revisions.add(rev_id)
2868
2236
        else:
2873
2241
            self.revisions[rev_id] = rev
2874
2242
 
2875
2243
    def _load_old_inventory(self, rev_id):
2876
 
        f = self.branch.repository.inventory_store.get(rev_id)
2877
 
        try:
2878
 
            old_inv_xml = f.read()
2879
 
        finally:
2880
 
            f.close()
 
2244
        old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2881
2245
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2882
2246
        inv.revision_id = rev_id
2883
2247
        rev = self.revisions[rev_id]
2934
2298
        text_changed = False
2935
2299
        parent_candiate_entries = ie.parent_candidates(parent_invs)
2936
2300
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2937
 
        # XXX: Note that this is unordered - and this is tolerable because
 
2301
        # XXX: Note that this is unordered - and this is tolerable because 
2938
2302
        # the previous code was also unordered.
2939
2303
        previous_entries = dict((head, parent_candiate_entries[head]) for head
2940
2304
            in heads)
2941
2305
        self.snapshot_ie(previous_entries, ie, w, rev_id)
2942
2306
        del ie.text_id
2943
2307
 
 
2308
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
 
2309
    def get_parents(self, revision_ids):
 
2310
        for revision_id in revision_ids:
 
2311
            yield self.revisions[revision_id].parent_ids
 
2312
 
2944
2313
    def get_parent_map(self, revision_ids):
2945
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
2314
        """See graph._StackedParentsProvider.get_parent_map"""
2946
2315
        return dict((revision_id, self.revisions[revision_id])
2947
2316
                    for revision_id in revision_ids
2948
2317
                     if revision_id in self.revisions)
2952
2321
        # a call to:. This needs the path figured out. rather than a work_tree
2953
2322
        # a v4 revision_tree can be given, or something that looks enough like
2954
2323
        # one to give the file content to the entry if it needs it.
2955
 
        # and we need something that looks like a weave store for snapshot to
 
2324
        # and we need something that looks like a weave store for snapshot to 
2956
2325
        # save against.
2957
2326
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2958
2327
        if len(previous_revisions) == 1:
2961
2330
                ie.revision = previous_ie.revision
2962
2331
                return
2963
2332
        if ie.has_text():
2964
 
            f = self.branch.repository._text_store.get(ie.text_id)
2965
 
            try:
2966
 
                file_lines = f.readlines()
2967
 
            finally:
2968
 
                f.close()
 
2333
            text = self.branch.repository._text_store.get(ie.text_id)
 
2334
            file_lines = text.readlines()
2969
2335
            w.add_lines(rev_id, previous_revisions, file_lines)
2970
2336
            self.text_count += 1
2971
2337
        else:
3001
2367
    def convert(self, to_convert, pb):
3002
2368
        """See Converter.convert()."""
3003
2369
        self.bzrdir = to_convert
3004
 
        pb = ui.ui_factory.nested_progress_bar()
3005
 
        try:
3006
 
            ui.ui_factory.note('starting upgrade from format 5 to 6')
3007
 
            self._convert_to_prefixed()
3008
 
            return BzrDir.open(self.bzrdir.user_url)
3009
 
        finally:
3010
 
            pb.finished()
 
2370
        self.pb = pb
 
2371
        self.pb.note('starting upgrade from format 5 to 6')
 
2372
        self._convert_to_prefixed()
 
2373
        return BzrDir.open(self.bzrdir.root_transport.base)
3011
2374
 
3012
2375
    def _convert_to_prefixed(self):
3013
2376
        from bzrlib.store import TransportStore
3014
2377
        self.bzrdir.transport.delete('branch-format')
3015
2378
        for store_name in ["weaves", "revision-store"]:
3016
 
            ui.ui_factory.note("adding prefixes to %s" % store_name)
 
2379
            self.pb.note("adding prefixes to %s" % store_name)
3017
2380
            store_transport = self.bzrdir.transport.clone(store_name)
3018
2381
            store = TransportStore(store_transport, prefixed=True)
3019
2382
            for urlfilename in store_transport.list_dir('.'):
3046
2409
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
3047
2410
        from bzrlib.branch import BzrBranchFormat5
3048
2411
        self.bzrdir = to_convert
3049
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2412
        self.pb = pb
3050
2413
        self.count = 0
3051
2414
        self.total = 20 # the steps we know about
3052
2415
        self.garbage_inventories = []
3053
2416
        self.dir_mode = self.bzrdir._get_dir_mode()
3054
2417
        self.file_mode = self.bzrdir._get_file_mode()
3055
2418
 
3056
 
        ui.ui_factory.note('starting upgrade from format 6 to metadir')
 
2419
        self.pb.note('starting upgrade from format 6 to metadir')
3057
2420
        self.bzrdir.transport.put_bytes(
3058
2421
                'branch-format',
3059
2422
                "Converting to format 6",
3080
2443
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
3081
2444
        self.make_lock('repository')
3082
2445
        # we hard code the formats here because we are converting into
3083
 
        # the meta format. The meta format upgrader can take this to a
 
2446
        # the meta format. The meta format upgrader can take this to a 
3084
2447
        # future format within each component.
3085
2448
        self.put_format('repository', RepositoryFormat7())
3086
2449
        for entry in repository_names:
3109
2472
        else:
3110
2473
            has_checkout = True
3111
2474
        if not has_checkout:
3112
 
            ui.ui_factory.note('No working tree.')
 
2475
            self.pb.note('No working tree.')
3113
2476
            # If some checkout files are there, we may as well get rid of them.
3114
2477
            for name, mandatory in checkout_files:
3115
2478
                if name in bzrcontents:
3132
2495
            'branch-format',
3133
2496
            BzrDirMetaFormat1().get_format_string(),
3134
2497
            mode=self.file_mode)
3135
 
        self.pb.finished()
3136
 
        return BzrDir.open(self.bzrdir.user_url)
 
2498
        return BzrDir.open(self.bzrdir.root_transport.base)
3137
2499
 
3138
2500
    def make_lock(self, name):
3139
2501
        """Make a lock for the new control dir name."""
3174
2536
    def convert(self, to_convert, pb):
3175
2537
        """See Converter.convert()."""
3176
2538
        self.bzrdir = to_convert
3177
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2539
        self.pb = pb
3178
2540
        self.count = 0
3179
2541
        self.total = 1
3180
2542
        self.step('checking repository format')
3185
2547
        else:
3186
2548
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
3187
2549
                from bzrlib.repository import CopyConverter
3188
 
                ui.ui_factory.note('starting repository conversion')
 
2550
                self.pb.note('starting repository conversion')
3189
2551
                converter = CopyConverter(self.target_format.repository_format)
3190
2552
                converter.convert(repo, pb)
3191
 
        for branch in self.bzrdir.list_branches():
 
2553
        try:
 
2554
            branch = self.bzrdir.open_branch()
 
2555
        except errors.NotBranchError:
 
2556
            pass
 
2557
        else:
3192
2558
            # TODO: conversions of Branch and Tree should be done by
3193
2559
            # InterXFormat lookups/some sort of registry.
3194
2560
            # Avoid circular imports
3198
2564
            while old != new:
3199
2565
                if (old == _mod_branch.BzrBranchFormat5 and
3200
2566
                    new in (_mod_branch.BzrBranchFormat6,
3201
 
                        _mod_branch.BzrBranchFormat7,
3202
 
                        _mod_branch.BzrBranchFormat8)):
 
2567
                        _mod_branch.BzrBranchFormat7)):
3203
2568
                    branch_converter = _mod_branch.Converter5to6()
3204
2569
                elif (old == _mod_branch.BzrBranchFormat6 and
3205
 
                    new in (_mod_branch.BzrBranchFormat7,
3206
 
                            _mod_branch.BzrBranchFormat8)):
 
2570
                    new == _mod_branch.BzrBranchFormat7):
3207
2571
                    branch_converter = _mod_branch.Converter6to7()
3208
 
                elif (old == _mod_branch.BzrBranchFormat7 and
3209
 
                      new is _mod_branch.BzrBranchFormat8):
3210
 
                    branch_converter = _mod_branch.Converter7to8()
3211
2572
                else:
3212
 
                    raise errors.BadConversionTarget("No converter", new,
3213
 
                        branch._format)
 
2573
                    raise errors.BadConversionTarget("No converter", new)
3214
2574
                branch_converter.convert(branch)
3215
2575
                branch = self.bzrdir.open_branch()
3216
2576
                old = branch._format.__class__
3222
2582
            # TODO: conversions of Branch and Tree should be done by
3223
2583
            # InterXFormat lookups
3224
2584
            if (isinstance(tree, workingtree.WorkingTree3) and
3225
 
                not isinstance(tree, workingtree_4.DirStateWorkingTree) and
 
2585
                not isinstance(tree, workingtree_4.WorkingTree4) and
3226
2586
                isinstance(self.target_format.workingtree_format,
3227
 
                    workingtree_4.DirStateWorkingTreeFormat)):
 
2587
                    workingtree_4.WorkingTreeFormat4)):
3228
2588
                workingtree_4.Converter3to4().convert(tree)
3229
 
            if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3230
 
                not isinstance(tree, workingtree_4.WorkingTree5) and
3231
 
                isinstance(self.target_format.workingtree_format,
3232
 
                    workingtree_4.WorkingTreeFormat5)):
3233
 
                workingtree_4.Converter4to5().convert(tree)
3234
 
            if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3235
 
                not isinstance(tree, workingtree_4.WorkingTree6) and
3236
 
                isinstance(self.target_format.workingtree_format,
3237
 
                    workingtree_4.WorkingTreeFormat6)):
3238
 
                workingtree_4.Converter4or5to6().convert(tree)
3239
 
        self.pb.finished()
3240
2589
        return to_convert
3241
2590
 
3242
2591
 
3243
 
# This is not in remote.py because it's relatively small, and needs to be
3244
 
# registered. Putting it in remote.py creates a circular import problem.
 
2592
# This is not in remote.py because it's small, and needs to be registered.
 
2593
# Putting it in remote.py creates a circular import problem.
3245
2594
# we can make it a lazy object if the control formats is turned into something
3246
2595
# like a registry.
3247
2596
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3248
2597
    """Format representing bzrdirs accessed via a smart server"""
3249
2598
 
3250
 
    def __init__(self):
3251
 
        BzrDirMetaFormat1.__init__(self)
3252
 
        # XXX: It's a bit ugly that the network name is here, because we'd
3253
 
        # like to believe that format objects are stateless or at least
3254
 
        # immutable,  However, we do at least avoid mutating the name after
3255
 
        # it's returned.  See <https://bugs.launchpad.net/bzr/+bug/504102>
3256
 
        self._network_name = None
3257
 
 
3258
 
    def __repr__(self):
3259
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
3260
 
            self._network_name)
3261
 
 
3262
2599
    def get_format_description(self):
3263
 
        if self._network_name:
3264
 
            real_format = network_format_registry.get(self._network_name)
3265
 
            return 'Remote: ' + real_format.get_format_description()
3266
2600
        return 'bzr remote bzrdir'
3267
 
 
3268
 
    def get_format_string(self):
3269
 
        raise NotImplementedError(self.get_format_string)
3270
 
 
3271
 
    def network_name(self):
3272
 
        if self._network_name:
3273
 
            return self._network_name
3274
 
        else:
3275
 
            raise AssertionError("No network name set.")
3276
 
 
 
2601
    
3277
2602
    @classmethod
3278
2603
    def probe_transport(klass, transport):
3279
2604
        """Return a RemoteBzrDirFormat object if it looks possible."""
3308
2633
            return local_dir_format.initialize_on_transport(transport)
3309
2634
        client = _SmartClient(client_medium)
3310
2635
        path = client.remote_path_from_transport(transport)
3311
 
        try:
3312
 
            response = client.call('BzrDirFormat.initialize', path)
3313
 
        except errors.ErrorFromSmartServer, err:
3314
 
            remote._translate_error(err, path=path)
 
2636
        response = client.call('BzrDirFormat.initialize', path)
3315
2637
        if response[0] != 'ok':
3316
2638
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3317
 
        format = RemoteBzrDirFormat()
3318
 
        self._supply_sub_formats_to(format)
3319
 
        return remote.RemoteBzrDir(transport, format)
3320
 
 
3321
 
    def parse_NoneTrueFalse(self, arg):
3322
 
        if not arg:
3323
 
            return None
3324
 
        if arg == 'False':
3325
 
            return False
3326
 
        if arg == 'True':
3327
 
            return True
3328
 
        raise AssertionError("invalid arg %r" % arg)
3329
 
 
3330
 
    def _serialize_NoneTrueFalse(self, arg):
3331
 
        if arg is False:
3332
 
            return 'False'
3333
 
        if arg:
3334
 
            return 'True'
3335
 
        return ''
3336
 
 
3337
 
    def _serialize_NoneString(self, arg):
3338
 
        return arg or ''
3339
 
 
3340
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3341
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
3342
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3343
 
        shared_repo=False):
3344
 
        try:
3345
 
            # hand off the request to the smart server
3346
 
            client_medium = transport.get_smart_medium()
3347
 
        except errors.NoSmartMedium:
3348
 
            do_vfs = True
3349
 
        else:
3350
 
            # Decline to open it if the server doesn't support our required
3351
 
            # version (3) so that the VFS-based transport will do it.
3352
 
            if client_medium.should_probe():
3353
 
                try:
3354
 
                    server_version = client_medium.protocol_version()
3355
 
                    if server_version != '2':
3356
 
                        do_vfs = True
3357
 
                    else:
3358
 
                        do_vfs = False
3359
 
                except errors.SmartProtocolError:
3360
 
                    # Apparently there's no usable smart server there, even though
3361
 
                    # the medium supports the smart protocol.
3362
 
                    do_vfs = True
3363
 
            else:
3364
 
                do_vfs = False
3365
 
        if not do_vfs:
3366
 
            client = _SmartClient(client_medium)
3367
 
            path = client.remote_path_from_transport(transport)
3368
 
            if client_medium._is_remote_before((1, 16)):
3369
 
                do_vfs = True
3370
 
        if do_vfs:
3371
 
            # TODO: lookup the local format from a server hint.
3372
 
            local_dir_format = BzrDirMetaFormat1()
3373
 
            self._supply_sub_formats_to(local_dir_format)
3374
 
            return local_dir_format.initialize_on_transport_ex(transport,
3375
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3376
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3377
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3378
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3379
 
                vfs_only=True)
3380
 
        return self._initialize_on_transport_ex_rpc(client, path, transport,
3381
 
            use_existing_dir, create_prefix, force_new_repo, stacked_on,
3382
 
            stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3383
 
 
3384
 
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
3385
 
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
3386
 
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3387
 
        args = []
3388
 
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3389
 
        args.append(self._serialize_NoneTrueFalse(create_prefix))
3390
 
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
3391
 
        args.append(self._serialize_NoneString(stacked_on))
3392
 
        # stack_on_pwd is often/usually our transport
3393
 
        if stack_on_pwd:
3394
 
            try:
3395
 
                stack_on_pwd = transport.relpath(stack_on_pwd)
3396
 
                if not stack_on_pwd:
3397
 
                    stack_on_pwd = '.'
3398
 
            except errors.PathNotChild:
3399
 
                pass
3400
 
        args.append(self._serialize_NoneString(stack_on_pwd))
3401
 
        args.append(self._serialize_NoneString(repo_format_name))
3402
 
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
3403
 
        args.append(self._serialize_NoneTrueFalse(shared_repo))
3404
 
        request_network_name = self._network_name or \
3405
 
            BzrDirFormat.get_default_format().network_name()
3406
 
        try:
3407
 
            response = client.call('BzrDirFormat.initialize_ex_1.16',
3408
 
                request_network_name, path, *args)
3409
 
        except errors.UnknownSmartMethod:
3410
 
            client._medium._remember_remote_is_before((1,16))
3411
 
            local_dir_format = BzrDirMetaFormat1()
3412
 
            self._supply_sub_formats_to(local_dir_format)
3413
 
            return local_dir_format.initialize_on_transport_ex(transport,
3414
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3415
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3416
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3417
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3418
 
                vfs_only=True)
3419
 
        except errors.ErrorFromSmartServer, err:
3420
 
            remote._translate_error(err, path=path)
3421
 
        repo_path = response[0]
3422
 
        bzrdir_name = response[6]
3423
 
        require_stacking = response[7]
3424
 
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
3425
 
        format = RemoteBzrDirFormat()
3426
 
        format._network_name = bzrdir_name
3427
 
        self._supply_sub_formats_to(format)
3428
 
        bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3429
 
        if repo_path:
3430
 
            repo_format = remote.response_tuple_to_repo_format(response[1:])
3431
 
            if repo_path == '.':
3432
 
                repo_path = ''
3433
 
            if repo_path:
3434
 
                repo_bzrdir_format = RemoteBzrDirFormat()
3435
 
                repo_bzrdir_format._network_name = response[5]
3436
 
                repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3437
 
                    repo_bzrdir_format)
3438
 
            else:
3439
 
                repo_bzr = bzrdir
3440
 
            final_stack = response[8] or None
3441
 
            final_stack_pwd = response[9] or None
3442
 
            if final_stack_pwd:
3443
 
                final_stack_pwd = urlutils.join(
3444
 
                    transport.base, final_stack_pwd)
3445
 
            remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3446
 
            if len(response) > 10:
3447
 
                # Updated server verb that locks remotely.
3448
 
                repo_lock_token = response[10] or None
3449
 
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3450
 
                if repo_lock_token:
3451
 
                    remote_repo.dont_leave_lock_in_place()
3452
 
            else:
3453
 
                remote_repo.lock_write()
3454
 
            policy = UseExistingRepository(remote_repo, final_stack,
3455
 
                final_stack_pwd, require_stacking)
3456
 
            policy.acquire_repository()
3457
 
        else:
3458
 
            remote_repo = None
3459
 
            policy = None
3460
 
        bzrdir._format.set_branch_format(self.get_branch_format())
3461
 
        if require_stacking:
3462
 
            # The repo has already been created, but we need to make sure that
3463
 
            # we'll make a stackable branch.
3464
 
            bzrdir._format.require_stacking(_skip_repo=True)
3465
 
        return remote_repo, bzrdir, require_stacking, policy
 
2639
        return remote.RemoteBzrDir(transport)
3466
2640
 
3467
2641
    def _open(self, transport):
3468
 
        return remote.RemoteBzrDir(transport, self)
 
2642
        return remote.RemoteBzrDir(transport)
3469
2643
 
3470
2644
    def __eq__(self, other):
3471
2645
        if not isinstance(other, RemoteBzrDirFormat):
3472
2646
            return False
3473
2647
        return self.get_format_description() == other.get_format_description()
3474
2648
 
3475
 
    def __return_repository_format(self):
3476
 
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
3477
 
        # repository format has been asked for, tell the RemoteRepositoryFormat
3478
 
        # that it should use that for init() etc.
3479
 
        result = remote.RemoteRepositoryFormat()
3480
 
        custom_format = getattr(self, '_repository_format', None)
3481
 
        if custom_format:
3482
 
            if isinstance(custom_format, remote.RemoteRepositoryFormat):
3483
 
                return custom_format
3484
 
            else:
3485
 
                # We will use the custom format to create repositories over the
3486
 
                # wire; expose its details like rich_root_data for code to
3487
 
                # query
3488
 
                result._custom_format = custom_format
3489
 
        return result
3490
 
 
3491
 
    def get_branch_format(self):
3492
 
        result = BzrDirMetaFormat1.get_branch_format(self)
3493
 
        if not isinstance(result, remote.RemoteBranchFormat):
3494
 
            new_result = remote.RemoteBranchFormat()
3495
 
            new_result._custom_format = result
3496
 
            # cache the result
3497
 
            self.set_branch_format(new_result)
3498
 
            result = new_result
3499
 
        return result
3500
 
 
3501
 
    repository_format = property(__return_repository_format,
3502
 
        BzrDirMetaFormat1._set_repository_format) #.im_func)
3503
 
 
3504
2649
 
3505
2650
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3506
2651
 
3516
2661
 
3517
2662
class BzrDirFormatRegistry(registry.Registry):
3518
2663
    """Registry of user-selectable BzrDir subformats.
3519
 
 
 
2664
    
3520
2665
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3521
2666
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
3522
2667
    """
3524
2669
    def __init__(self):
3525
2670
        """Create a BzrDirFormatRegistry."""
3526
2671
        self._aliases = set()
3527
 
        self._registration_order = list()
3528
2672
        super(BzrDirFormatRegistry, self).__init__()
3529
2673
 
3530
2674
    def aliases(self):
3541
2685
        """Register a metadir subformat.
3542
2686
 
3543
2687
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3544
 
        by the Repository/Branch/WorkingTreeformats.
 
2688
        by the Repository format.
3545
2689
 
3546
2690
        :param repository_format: The fully-qualified repository format class
3547
2691
            name as a string.
3581
2725
    def register(self, key, factory, help, native=True, deprecated=False,
3582
2726
                 hidden=False, experimental=False, alias=False):
3583
2727
        """Register a BzrDirFormat factory.
3584
 
 
 
2728
        
3585
2729
        The factory must be a callable that takes one parameter: the key.
3586
2730
        It must produce an instance of the BzrDirFormat when called.
3587
2731
 
3592
2736
            BzrDirFormatInfo(native, deprecated, hidden, experimental))
3593
2737
        if alias:
3594
2738
            self._aliases.add(key)
3595
 
        self._registration_order.append(key)
3596
2739
 
3597
2740
    def register_lazy(self, key, module_name, member_name, help, native=True,
3598
2741
        deprecated=False, hidden=False, experimental=False, alias=False):
3600
2743
            help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3601
2744
        if alias:
3602
2745
            self._aliases.add(key)
3603
 
        self._registration_order.append(key)
3604
2746
 
3605
2747
    def set_default(self, key):
3606
2748
        """Set the 'default' key to be a clone of the supplied key.
3607
 
 
 
2749
        
3608
2750
        This method must be called once and only once.
3609
2751
        """
3610
2752
        registry.Registry.register(self, 'default', self.get(key),
3613
2755
 
3614
2756
    def set_default_repository(self, key):
3615
2757
        """Set the FormatRegistry default and Repository default.
3616
 
 
 
2758
        
3617
2759
        This is a transitional method while Repository.set_default_format
3618
2760
        is deprecated.
3619
2761
        """
3626
2768
        return self.get(key)()
3627
2769
 
3628
2770
    def help_topic(self, topic):
3629
 
        output = ""
 
2771
        output = textwrap.dedent("""\
 
2772
            These formats can be used for creating branches, working trees, and
 
2773
            repositories.
 
2774
 
 
2775
            """)
3630
2776
        default_realkey = None
3631
2777
        default_help = self.get_help('default')
3632
2778
        help_pairs = []
3633
 
        for key in self._registration_order:
 
2779
        for key in self.keys():
3634
2780
            if key == 'default':
3635
2781
                continue
3636
2782
            help = self.get_help(key)
3642
2788
        def wrapped(key, help, info):
3643
2789
            if info.native:
3644
2790
                help = '(native) ' + help
3645
 
            return ':%s:\n%s\n\n' % (key,
3646
 
                textwrap.fill(help, initial_indent='    ',
3647
 
                    subsequent_indent='    ',
3648
 
                    break_long_words=False))
 
2791
            return ':%s:\n%s\n\n' % (key, 
 
2792
                    textwrap.fill(help, initial_indent='    ', 
 
2793
                    subsequent_indent='    '))
3649
2794
        if default_realkey is not None:
3650
2795
            output += wrapped(default_realkey, '(default) %s' % default_help,
3651
2796
                              self.get_info('default'))
3661
2806
                experimental_pairs.append((key, help))
3662
2807
            else:
3663
2808
                output += wrapped(key, help, info)
3664
 
        output += "\nSee :doc:`formats-help` for more about storage formats."
3665
 
        other_output = ""
3666
2809
        if len(experimental_pairs) > 0:
3667
 
            other_output += "Experimental formats are shown below.\n\n"
 
2810
            output += "Experimental formats are shown below.\n\n"
3668
2811
            for key, help in experimental_pairs:
3669
2812
                info = self.get_info(key)
3670
 
                other_output += wrapped(key, help, info)
3671
 
        else:
3672
 
            other_output += \
3673
 
                "No experimental formats are available.\n\n"
 
2813
                output += wrapped(key, help, info)
3674
2814
        if len(deprecated_pairs) > 0:
3675
 
            other_output += "\nDeprecated formats are shown below.\n\n"
 
2815
            output += "Deprecated formats are shown below.\n\n"
3676
2816
            for key, help in deprecated_pairs:
3677
2817
                info = self.get_info(key)
3678
 
                other_output += wrapped(key, help, info)
3679
 
        else:
3680
 
            other_output += \
3681
 
                "\nNo deprecated formats are available.\n\n"
3682
 
        other_output += \
3683
 
                "\nSee :doc:`formats-help` for more about storage formats."
 
2818
                output += wrapped(key, help, info)
3684
2819
 
3685
 
        if topic == 'other-formats':
3686
 
            return other_output
3687
 
        else:
3688
 
            return output
 
2820
        return output
3689
2821
 
3690
2822
 
3691
2823
class RepositoryAcquisitionPolicy(object):
3720
2852
            try:
3721
2853
                stack_on = urlutils.rebase_url(self._stack_on,
3722
2854
                    self._stack_on_pwd,
3723
 
                    branch.user_url)
 
2855
                    branch.bzrdir.root_transport.base)
3724
2856
            except errors.InvalidRebaseURLs:
3725
2857
                stack_on = self._get_full_stack_on()
3726
2858
        try:
3727
2859
            branch.set_stacked_on_url(stack_on)
3728
 
        except (errors.UnstackableBranchFormat,
3729
 
                errors.UnstackableRepositoryFormat):
 
2860
        except errors.UnstackableBranchFormat:
3730
2861
            if self._require_stacking:
3731
2862
                raise
3732
2863
 
3733
 
    def requires_stacking(self):
3734
 
        """Return True if this policy requires stacking."""
3735
 
        return self._stack_on is not None and self._require_stacking
3736
 
 
3737
2864
    def _get_full_stack_on(self):
3738
2865
        """Get a fully-qualified URL for the stack_on location."""
3739
2866
        if self._stack_on is None:
3743
2870
        else:
3744
2871
            return urlutils.join(self._stack_on_pwd, self._stack_on)
3745
2872
 
3746
 
    def _add_fallback(self, repository, possible_transports=None):
 
2873
    def _add_fallback(self, repository):
3747
2874
        """Add a fallback to the supplied repository, if stacking is set."""
3748
2875
        stack_on = self._get_full_stack_on()
3749
2876
        if stack_on is None:
3750
2877
            return
3751
 
        try:
3752
 
            stacked_dir = BzrDir.open(stack_on,
3753
 
                                      possible_transports=possible_transports)
3754
 
        except errors.JailBreak:
3755
 
            # We keep the stacking details, but we are in the server code so
3756
 
            # actually stacking is not needed.
3757
 
            return
 
2878
        stacked_dir = BzrDir.open(stack_on)
3758
2879
        try:
3759
2880
            stacked_repo = stacked_dir.open_branch().repository
3760
2881
        except errors.NotBranchError:
3764
2885
        except errors.UnstackableRepositoryFormat:
3765
2886
            if self._require_stacking:
3766
2887
                raise
3767
 
        else:
3768
 
            self._require_stacking = True
3769
2888
 
3770
2889
    def acquire_repository(self, make_working_trees=None, shared=False):
3771
2890
        """Acquire a repository for this bzrdir.
3775
2894
        :param make_working_trees: If creating a repository, set
3776
2895
            make_working_trees to this value (if non-None)
3777
2896
        :param shared: If creating a repository, make it shared if True
3778
 
        :return: A repository, is_new_flag (True if the repository was
3779
 
            created).
 
2897
        :return: A repository
3780
2898
        """
3781
2899
        raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3782
2900
 
3802
2920
 
3803
2921
        Creates the desired repository in the bzrdir we already have.
3804
2922
        """
3805
 
        stack_on = self._get_full_stack_on()
3806
 
        if stack_on:
3807
 
            format = self._bzrdir._format
3808
 
            format.require_stacking(stack_on=stack_on,
3809
 
                                    possible_transports=[self._bzrdir.root_transport])
3810
 
            if not self._require_stacking:
3811
 
                # We have picked up automatic stacking somewhere.
3812
 
                note('Using default stacking branch %s at %s', self._stack_on,
3813
 
                    self._stack_on_pwd)
3814
2923
        repository = self._bzrdir.create_repository(shared=shared)
3815
 
        self._add_fallback(repository,
3816
 
                           possible_transports=[self._bzrdir.transport])
 
2924
        self._add_fallback(repository)
3817
2925
        if make_working_trees is not None:
3818
2926
            repository.set_make_working_trees(make_working_trees)
3819
 
        return repository, True
 
2927
        return repository
3820
2928
 
3821
2929
 
3822
2930
class UseExistingRepository(RepositoryAcquisitionPolicy):
3838
2946
    def acquire_repository(self, make_working_trees=None, shared=False):
3839
2947
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
3840
2948
 
3841
 
        Returns an existing repository to use.
 
2949
        Returns an existing repository to use
3842
2950
        """
3843
 
        self._add_fallback(self._repository,
3844
 
                       possible_transports=[self._repository.bzrdir.transport])
3845
 
        return self._repository, False
3846
 
 
3847
 
 
3848
 
# Please register new formats after old formats so that formats
3849
 
# appear in chronological order and format descriptions can build
3850
 
# on previous ones.
 
2951
        self._add_fallback(self._repository)
 
2952
        return self._repository
 
2953
 
 
2954
 
3851
2955
format_registry = BzrDirFormatRegistry()
3852
 
# The pre-0.8 formats have their repository format network name registered in
3853
 
# repository.py. MetaDir formats have their repository format network name
3854
 
# inferred from their disk format string.
3855
2956
format_registry.register('weave', BzrDirFormat6,
3856
2957
    'Pre-0.8 format.  Slower than knit and does not'
3857
2958
    ' support checkouts or shared repositories.',
3858
 
    hidden=True,
3859
2959
    deprecated=True)
 
2960
format_registry.register_metadir('knit',
 
2961
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
2962
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
 
2963
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
2964
    tree_format='bzrlib.workingtree.WorkingTreeFormat3')
3860
2965
format_registry.register_metadir('metaweave',
3861
2966
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3862
2967
    'Transitional format in 0.8.  Slower than knit.',
3863
2968
    branch_format='bzrlib.branch.BzrBranchFormat5',
3864
2969
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3865
 
    hidden=True,
3866
 
    deprecated=True)
3867
 
format_registry.register_metadir('knit',
3868
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3869
 
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
3870
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
3871
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3872
 
    hidden=True,
3873
2970
    deprecated=True)
3874
2971
format_registry.register_metadir('dirstate',
3875
2972
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3879
2976
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3880
2977
    # directly from workingtree_4 triggers a circular import.
3881
2978
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3882
 
    hidden=True,
3883
 
    deprecated=True)
 
2979
    )
3884
2980
format_registry.register_metadir('dirstate-tags',
3885
2981
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3886
2982
    help='New in 0.15: Fast local operations and improved scaling for '
3888
2984
        ' Incompatible with bzr < 0.15.',
3889
2985
    branch_format='bzrlib.branch.BzrBranchFormat6',
3890
2986
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3891
 
    hidden=True,
3892
 
    deprecated=True)
 
2987
    )
3893
2988
format_registry.register_metadir('rich-root',
3894
2989
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3895
2990
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
3896
 
        ' bzr < 1.0.',
 
2991
        ' bzr < 1.0',
3897
2992
    branch_format='bzrlib.branch.BzrBranchFormat6',
3898
2993
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3899
 
    hidden=True,
3900
 
    deprecated=True)
 
2994
    )
3901
2995
format_registry.register_metadir('dirstate-with-subtree',
3902
2996
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3903
2997
    help='New in 0.15: Fast local operations and improved scaling for '
3913
3007
    help='New in 0.92: Pack-based format with data compatible with '
3914
3008
        'dirstate-tags format repositories. Interoperates with '
3915
3009
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3916
 
        ,
 
3010
        'Previously called knitpack-experimental.  '
 
3011
        'For more information, see '
 
3012
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3917
3013
    branch_format='bzrlib.branch.BzrBranchFormat6',
3918
3014
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3919
3015
    )
3922
3018
    help='New in 0.92: Pack-based format with data compatible with '
3923
3019
        'dirstate-with-subtree format repositories. Interoperates with '
3924
3020
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3925
 
        ,
 
3021
        'Previously called knitpack-experimental.  '
 
3022
        'For more information, see '
 
3023
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3926
3024
    branch_format='bzrlib.branch.BzrBranchFormat6',
3927
3025
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3928
3026
    hidden=True,
3930
3028
    )
3931
3029
format_registry.register_metadir('rich-root-pack',
3932
3030
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3933
 
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3934
 
         '(needed for bzr-svn and bzr-git).',
 
3031
    help='New in 1.0: Pack-based format with data compatible with '
 
3032
        'rich-root format repositories. Incompatible with'
 
3033
        ' bzr < 1.0',
3935
3034
    branch_format='bzrlib.branch.BzrBranchFormat6',
3936
3035
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3937
 
    hidden=True,
3938
3036
    )
3939
3037
format_registry.register_metadir('1.6',
3940
3038
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3941
 
    help='A format that allows a branch to indicate that there is another '
3942
 
         '(stacked) repository that should be used to access data that is '
3943
 
         'not present locally.',
 
3039
    help='A branch and pack based repository that supports stacking. ',
3944
3040
    branch_format='bzrlib.branch.BzrBranchFormat7',
3945
3041
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3946
 
    hidden=True,
3947
3042
    )
3948
3043
format_registry.register_metadir('1.6.1-rich-root',
3949
3044
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3950
 
    help='A variant of 1.6 that supports rich-root data '
3951
 
         '(needed for bzr-svn and bzr-git).',
3952
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3953
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3954
 
    hidden=True,
3955
 
    )
3956
 
format_registry.register_metadir('1.9',
3957
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3958
 
    help='A repository format using B+tree indexes. These indexes '
3959
 
         'are smaller in size, have smarter caching and provide faster '
3960
 
         'performance for most operations.',
3961
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3962
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3963
 
    hidden=True,
3964
 
    )
3965
 
format_registry.register_metadir('1.9-rich-root',
3966
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3967
 
    help='A variant of 1.9 that supports rich-root data '
3968
 
         '(needed for bzr-svn and bzr-git).',
3969
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3970
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3971
 
    hidden=True,
3972
 
    )
3973
 
format_registry.register_metadir('1.14',
3974
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3975
 
    help='A working-tree format that supports content filtering.',
3976
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3977
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3978
 
    )
3979
 
format_registry.register_metadir('1.14-rich-root',
3980
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3981
 
    help='A variant of 1.14 that supports rich-root data '
3982
 
         '(needed for bzr-svn and bzr-git).',
3983
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3984
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3985
 
    )
3986
 
# The following un-numbered 'development' formats should always just be aliases.
3987
 
format_registry.register_metadir('development-rich-root',
3988
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3989
 
    help='Current development format. Supports rich roots. Can convert data '
3990
 
        'to and from rich-root-pack (and anything compatible with '
3991
 
        'rich-root-pack) format repositories. Repositories and branches in '
3992
 
        'this format can only be read by bzr.dev. Please read '
3993
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
3045
    help='A branch and pack based repository that supports stacking '
 
3046
         'and rich root data (needed for bzr-svn). ',
 
3047
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3048
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3049
    )
 
3050
# The following two formats should always just be aliases.
 
3051
format_registry.register_metadir('development',
 
3052
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2',
 
3053
    help='Current development format. Can convert data to and from pack-0.92 '
 
3054
        '(and anything compatible with pack-0.92) format repositories. '
 
3055
        'Repositories and branches in this format can only be read by bzr.dev. '
 
3056
        'Please read '
 
3057
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3994
3058
        'before use.',
3995
3059
    branch_format='bzrlib.branch.BzrBranchFormat7',
3996
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3060
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3997
3061
    experimental=True,
3998
3062
    alias=True,
3999
 
    hidden=True,
4000
3063
    )
4001
3064
format_registry.register_metadir('development-subtree',
4002
3065
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
4004
3067
        'from pack-0.92-subtree (and anything compatible with '
4005
3068
        'pack-0.92-subtree) format repositories. Repositories and branches in '
4006
3069
        'this format can only be read by bzr.dev. Please read '
4007
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
3070
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
4008
3071
        'before use.',
4009
3072
    branch_format='bzrlib.branch.BzrBranchFormat7',
4010
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3073
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
4011
3074
    experimental=True,
4012
 
    hidden=True,
4013
 
    alias=False, # Restore to being an alias when an actual development subtree format is added
4014
 
                 # This current non-alias status is simply because we did not introduce a
4015
 
                 # chk based subtree format.
 
3075
    alias=True,
4016
3076
    )
4017
 
 
4018
3077
# And the development formats above will have aliased one of the following:
4019
 
format_registry.register_metadir('development6-rich-root',
4020
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
4021
 
    help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
4022
 
        'Please read '
4023
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4024
 
        'before use.',
4025
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4026
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4027
 
    hidden=True,
4028
 
    experimental=True,
4029
 
    )
4030
 
 
4031
 
format_registry.register_metadir('development7-rich-root',
4032
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
4033
 
    help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
4034
 
        'rich roots. Please read '
4035
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4036
 
        'before use.',
4037
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4038
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4039
 
    hidden=True,
4040
 
    experimental=True,
4041
 
    )
4042
 
 
4043
 
format_registry.register_metadir('2a',
4044
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4045
 
    help='First format for bzr 2.0 series.\n'
4046
 
        'Uses group-compress storage.\n'
4047
 
        'Provides rich roots which are a one-way transition.\n',
4048
 
        # 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
4049
 
        # 'rich roots. Supported by bzr 1.16 and later.',
4050
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4051
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4052
 
    experimental=True,
4053
 
    )
4054
 
 
4055
 
# The following format should be an alias for the rich root equivalent 
4056
 
# of the default format
4057
 
format_registry.register_metadir('default-rich-root',
4058
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4059
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4060
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4061
 
    alias=True,
4062
 
    hidden=True,
4063
 
    help='Same as 2a.')
4064
 
 
 
3078
format_registry.register_metadir('development2',
 
3079
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2',
 
3080
    help='1.6.1 with B+Tree based index. '
 
3081
        'Please read '
 
3082
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3083
        'before use.',
 
3084
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3085
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3086
    hidden=True,
 
3087
    experimental=True,
 
3088
    )
 
3089
format_registry.register_metadir('development2-subtree',
 
3090
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
 
3091
    help='1.6.1-subtree with B+Tree based index. '
 
3092
        'Please read '
 
3093
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3094
        'before use.',
 
3095
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3096
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3097
    hidden=True,
 
3098
    experimental=True,
 
3099
    )
4065
3100
# The current format that is made on 'bzr init'.
4066
 
format_registry.set_default('2a')
 
3101
format_registry.set_default('pack-0.92')