/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: Canonical.com Patch Queue Manager
  • Date: 2008-09-26 05:14:51 UTC
  • mfrom: (3737.1.3 trivial_python_compat)
  • Revision ID: pqm@pqm.ubuntu.com-20080926051451-dvc1qg5inn7msjvr
(jam) Some win32 tweaks for the faster iter_changes code.

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
 
27
27
 
28
28
# TODO: Move old formats into a plugin to make this file smaller.
29
29
 
 
30
from cStringIO import StringIO
30
31
import os
31
32
import sys
32
 
import warnings
33
33
 
34
34
from bzrlib.lazy_import import lazy_import
35
35
lazy_import(globals(), """
36
36
from stat import S_ISDIR
37
37
import textwrap
 
38
from warnings import warn
38
39
 
39
40
import bzrlib
40
41
from bzrlib import (
41
 
    branch,
42
42
    config,
43
43
    errors,
44
44
    graph,
45
45
    lockable_files,
46
46
    lockdir,
47
47
    osutils,
 
48
    registry,
48
49
    remote,
49
 
    repository,
50
50
    revision as _mod_revision,
 
51
    symbol_versioning,
51
52
    ui,
52
53
    urlutils,
53
54
    versionedfile,
58
59
    xml5,
59
60
    )
60
61
from bzrlib.osutils import (
 
62
    sha_strings,
61
63
    sha_string,
62
64
    )
63
 
from bzrlib.push import (
64
 
    PushResult,
65
 
    )
66
 
from bzrlib.repofmt import pack_repo
 
65
from bzrlib.repository import Repository
67
66
from bzrlib.smart.client import _SmartClient
 
67
from bzrlib.smart import protocol
68
68
from bzrlib.store.versioned import WeaveStore
69
69
from bzrlib.transactions import WriteTransaction
70
70
from bzrlib.transport import (
71
71
    do_catching_redirections,
72
72
    get_transport,
73
 
    local,
74
73
    )
75
74
from bzrlib.weave import Weave
76
75
""")
78
77
from bzrlib.trace import (
79
78
    mutter,
80
79
    note,
81
 
    warning,
82
 
    )
83
 
 
84
 
from bzrlib import (
85
 
    hooks,
86
 
    registry,
87
 
    symbol_versioning,
88
 
    )
89
 
    
90
 
    
91
 
class ControlComponent(object):
92
 
    """Abstract base class for control directory components.
93
 
    
94
 
    This provides interfaces that are common across bzrdirs, 
95
 
    repositories, branches, and workingtree control directories.
96
 
    
97
 
    They all expose two urls and transports: the *user* URL is the 
98
 
    one that stops above the control directory (eg .bzr) and that 
99
 
    should normally be used in messages, and the *control* URL is
100
 
    under that in eg .bzr/checkout and is used to read the control
101
 
    files.
102
 
    
103
 
    This can be used as a mixin and is intended to fit with 
104
 
    foreign formats.
105
 
    """
106
 
    
107
 
    @property
108
 
    def control_transport(self):
109
 
        raise NotImplementedError
110
 
   
111
 
    @property
112
 
    def control_url(self):
113
 
        return self.control_transport.base
114
 
    
115
 
    @property
116
 
    def user_transport(self):
117
 
        raise NotImplementedError
118
 
        
119
 
    @property
120
 
    def user_url(self):
121
 
        return self.user_transport.base
122
 
    
123
 
 
124
 
class BzrDir(ControlComponent):
 
80
    )
 
81
from bzrlib.transport.local import LocalTransport
 
82
from bzrlib.symbol_versioning import (
 
83
    deprecated_function,
 
84
    deprecated_method,
 
85
    )
 
86
 
 
87
 
 
88
class BzrDir(object):
125
89
    """A .bzr control diretory.
126
 
 
 
90
    
127
91
    BzrDir instances let you create or open any of the things that can be
128
92
    found within .bzr - checkouts, branches and repositories.
129
 
 
 
93
    
130
94
    :ivar transport:
131
95
        the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
132
96
    :ivar root_transport:
134
98
        (i.e. the parent directory holding the .bzr directory).
135
99
 
136
100
    Everything in the bzrdir should have the same file permissions.
137
 
 
138
 
    :cvar hooks: An instance of BzrDirHooks.
139
101
    """
140
102
 
141
103
    def break_lock(self):
163
125
        return True
164
126
 
165
127
    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
128
        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
 
129
        source_repo_format = self._format.repository_format
 
130
        source_repo_format.check_conversion_target(target_repo_format)
176
131
 
177
132
    @staticmethod
178
133
    def _check_supported(format, allow_unsupported,
180
135
        basedir=None):
181
136
        """Give an error or warning on old formats.
182
137
 
183
 
        :param format: may be any kind of format - workingtree, branch,
 
138
        :param format: may be any kind of format - workingtree, branch, 
184
139
        or repository.
185
140
 
186
 
        :param allow_unsupported: If true, allow opening
187
 
        formats that are strongly deprecated, and which may
 
141
        :param allow_unsupported: If true, allow opening 
 
142
        formats that are strongly deprecated, and which may 
188
143
        have limited functionality.
189
144
 
190
145
        :param recommend_upgrade: If true (default), warn
222
177
                                       preserve_stacking=preserve_stacking)
223
178
 
224
179
    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):
 
180
                           force_new_repo=False, preserve_stacking=False,
 
181
                           stacked_on=None):
227
182
        """Clone this bzrdir and its contents to transport verbatim.
228
183
 
229
184
        :param transport: The transport for the location to produce the clone
235
190
                               even if one is available.
236
191
        :param preserve_stacking: When cloning a stacked branch, stack the
237
192
            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
193
        """
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:
 
194
        transport.ensure_base()
247
195
        require_stacking = (stacked_on is not None)
248
 
        format = self.cloning_metadir(require_stacking)
249
 
        
250
 
        # Figure out what objects we want:
 
196
        metadir = self.cloning_metadir(require_stacking)
 
197
        result = metadir.initialize_on_transport(transport)
 
198
        repository_policy = None
251
199
        try:
252
200
            local_repo = self.find_repository()
253
201
        except errors.NoRepositoryPresent:
267
215
                        errors.UnstackableRepositoryFormat,
268
216
                        errors.NotStacked):
269
217
                    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.
 
218
 
273
219
        if local_repo:
 
220
            # may need to copy content in
 
221
            repository_policy = result.determine_repository_policy(
 
222
                force_new_repo, stacked_on, self.root_transport.base,
 
223
                require_stacking=require_stacking)
274
224
            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)
 
225
            result_repo = repository_policy.acquire_repository(
 
226
                make_working_trees, local_repo.is_shared())
 
227
            result_repo.fetch(local_repo, revision_id=revision_id)
 
228
        else:
 
229
            result_repo = None
310
230
        # 1 if there is a branch present
311
231
        #   make sure its content is available in the target repository
312
232
        #   clone it.
313
233
        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():
 
234
            result_branch = local_branch.clone(result, revision_id=revision_id)
 
235
            if repository_policy is not None:
 
236
                repository_policy.configure_branch(result_branch)
 
237
        if result_repo is None or result_repo.make_working_trees():
 
238
            try:
321
239
                self.open_workingtree().clone(result)
322
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
323
 
            pass
 
240
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
241
                pass
324
242
        return result
325
243
 
326
244
    # TODO: This should be given a Transport, and should chdir up; otherwise
332
250
    @classmethod
333
251
    def create(cls, base, format=None, possible_transports=None):
334
252
        """Create a new BzrDir at the url 'base'.
335
 
 
 
253
        
336
254
        :param format: If supplied, the format of branch to create.  If not
337
255
            supplied, the default is used.
338
 
        :param possible_transports: If supplied, a list of transports that
 
256
        :param possible_transports: If supplied, a list of transports that 
339
257
            can be reused to share a remote connection.
340
258
        """
341
259
        if cls is not BzrDir:
388
306
                for subdir in sorted(subdirs, reverse=True):
389
307
                    pending.append(current_transport.clone(subdir))
390
308
 
391
 
    def list_branches(self):
392
 
        """Return a sequence of all branches local to this control directory.
393
 
 
394
 
        """
395
 
        try:
396
 
            return [self.open_branch()]
397
 
        except errors.NotBranchError:
398
 
            return []
399
 
 
400
309
    @staticmethod
401
310
    def find_branches(transport):
402
311
        """Find all branches under a transport.
414
323
            except errors.NoRepositoryPresent:
415
324
                pass
416
325
            else:
417
 
                return False, ([], repository)
418
 
            return True, (bzrdir.list_branches(), None)
419
 
        ret = []
420
 
        for branches, repo in BzrDir.find_bzrdirs(transport,
421
 
                                                  evaluate=evaluate):
 
326
                return False, (None, repository)
 
327
            try:
 
328
                branch = bzrdir.open_branch()
 
329
            except errors.NotBranchError:
 
330
                return True, (None, None)
 
331
            else:
 
332
                return True, (branch, None)
 
333
        branches = []
 
334
        for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
422
335
            if repo is not None:
423
 
                ret.extend(repo.find_branches())
424
 
            if branches is not None:
425
 
                ret.extend(branches)
426
 
        return ret
 
336
                branches.extend(repo.find_branches())
 
337
            if branch is not None:
 
338
                branches.append(branch)
 
339
        return branches
427
340
 
428
341
    def destroy_repository(self):
429
342
        """Destroy the repository in this BzrDir"""
430
343
        raise NotImplementedError(self.destroy_repository)
431
344
 
432
 
    def create_branch(self, name=None):
 
345
    def create_branch(self):
433
346
        """Create a branch in this BzrDir.
434
347
 
435
 
        :param name: Name of the colocated branch to create, None for
436
 
            the default branch.
437
 
 
438
348
        The bzrdir's format will control what branch format is created.
439
349
        For more control see BranchFormatXX.create(a_bzrdir).
440
350
        """
441
351
        raise NotImplementedError(self.create_branch)
442
352
 
443
 
    def destroy_branch(self, name=None):
444
 
        """Destroy a branch in this BzrDir.
445
 
        
446
 
        :param name: Name of the branch to destroy, None for the default 
447
 
            branch.
448
 
        """
 
353
    def destroy_branch(self):
 
354
        """Destroy the branch in this BzrDir"""
449
355
        raise NotImplementedError(self.destroy_branch)
450
356
 
451
357
    @staticmethod
453
359
        """Create a new BzrDir, Branch and Repository at the url 'base'.
454
360
 
455
361
        This will use the current default BzrDirFormat unless one is
456
 
        specified, and use whatever
 
362
        specified, and use whatever 
457
363
        repository format that that uses via bzrdir.create_branch and
458
364
        create_repository. If a shared repository is available that is used
459
365
        preferentially.
473
379
                                    stack_on_pwd=None, require_stacking=False):
474
380
        """Return an object representing a policy to use.
475
381
 
476
 
        This controls whether a new repository is created, and the format of
477
 
        that repository, or some existing shared repository used instead.
 
382
        This controls whether a new repository is created, or a shared
 
383
        repository used instead.
478
384
 
479
385
        If stack_on is supplied, will not seek a containing shared repo.
480
386
 
489
395
            stack_on_pwd = None
490
396
            config = found_bzrdir.get_config()
491
397
            stop = False
492
 
            stack_on = config.get_default_stack_on()
493
 
            if stack_on is not None:
494
 
                stack_on_pwd = found_bzrdir.user_url
495
 
                stop = True
 
398
            if config is not None:
 
399
                stack_on = config.get_default_stack_on()
 
400
                if stack_on is not None:
 
401
                    stack_on_pwd = found_bzrdir.root_transport.base
 
402
                    stop = True
 
403
                    note('Using default stacking branch %s at %s', stack_on,
 
404
                         stack_on_pwd)
496
405
            # does it have a repository ?
497
406
            try:
498
407
                repository = found_bzrdir.open_repository()
499
408
            except errors.NoRepositoryPresent:
500
409
                repository = None
501
410
            else:
502
 
                if (found_bzrdir.user_url != self.user_url 
503
 
                    and not repository.is_shared()):
504
 
                    # Don't look higher, can't use a higher shared repo.
 
411
                if ((found_bzrdir.root_transport.base !=
 
412
                     self.root_transport.base) and not repository.is_shared()):
505
413
                    repository = None
506
 
                    stop = True
507
414
                else:
508
415
                    stop = True
509
416
            if not stop:
533
440
    def _find_or_create_repository(self, force_new_repo):
534
441
        """Create a new repository if needed, returning the repository."""
535
442
        policy = self.determine_repository_policy(force_new_repo)
536
 
        return policy.acquire_repository()[0]
 
443
        return policy.acquire_repository()
537
444
 
538
445
    @staticmethod
539
446
    def create_branch_convenience(base, force_new_repo=False,
546
453
        not.
547
454
 
548
455
        This will use the current default BzrDirFormat unless one is
549
 
        specified, and use whatever
 
456
        specified, and use whatever 
550
457
        repository format that that uses via bzrdir.create_branch and
551
458
        create_repository. If a shared repository is available that is used
552
459
        preferentially. Whatever repository is used, its tree creation policy
554
461
 
555
462
        The created Branch object is returned.
556
463
        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
 
464
        no error is raised unless force_new_tree is True, in which case no 
558
465
        data is created on disk and NotLocalUrl is raised.
559
466
 
560
467
        :param base: The URL to create the branch at.
561
468
        :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
 
469
        :param force_new_tree: If True or False force creation of a tree or 
563
470
                               prevent such creation respectively.
564
471
        :param format: Override for the bzrdir format to create.
565
472
        :param possible_transports: An optional reusable transports list.
567
474
        if force_new_tree:
568
475
            # check for non local urls
569
476
            t = get_transport(base, possible_transports)
570
 
            if not isinstance(t, local.LocalTransport):
 
477
            if not isinstance(t, LocalTransport):
571
478
                raise errors.NotLocalUrl(base)
572
479
        bzrdir = BzrDir.create(base, format, possible_transports)
573
480
        repo = bzrdir._find_or_create_repository(force_new_repo)
587
494
        'base' must be a local path or a file:// url.
588
495
 
589
496
        This will use the current default BzrDirFormat unless one is
590
 
        specified, and use whatever
 
497
        specified, and use whatever 
591
498
        repository format that that uses for bzrdirformat.create_workingtree,
592
499
        create_branch and create_repository.
593
500
 
595
502
        :return: The WorkingTree object.
596
503
        """
597
504
        t = get_transport(base)
598
 
        if not isinstance(t, local.LocalTransport):
 
505
        if not isinstance(t, LocalTransport):
599
506
            raise errors.NotLocalUrl(base)
600
507
        bzrdir = BzrDir.create_branch_and_repo(base,
601
508
                                               force_new_repo=True,
605
512
    def create_workingtree(self, revision_id=None, from_branch=None,
606
513
        accelerator_tree=None, hardlink=False):
607
514
        """Create a working tree at this BzrDir.
608
 
 
 
515
        
609
516
        :param revision_id: create it as of this revision id.
610
517
        :param from_branch: override bzrdir branch (for lightweight checkouts)
611
518
        :param accelerator_tree: A tree which can be used for retrieving file
615
522
        """
616
523
        raise NotImplementedError(self.create_workingtree)
617
524
 
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
525
    def retire_bzrdir(self, limit=10000):
647
526
        """Permanently disable the bzrdir.
648
527
 
702
581
            if stop:
703
582
                return result
704
583
            next_transport = found_bzrdir.root_transport.clone('..')
705
 
            if (found_bzrdir.user_url == next_transport.base):
 
584
            if (found_bzrdir.root_transport.base == next_transport.base):
706
585
                # top of the file system
707
586
                return None
708
587
            # find the next containing bzrdir
725
604
                repository = found_bzrdir.open_repository()
726
605
            except errors.NoRepositoryPresent:
727
606
                return None, False
728
 
            if found_bzrdir.user_url == self.user_url:
 
607
            if found_bzrdir.root_transport.base == self.root_transport.base:
729
608
                return repository, True
730
609
            elif repository.is_shared():
731
610
                return repository, True
737
616
            raise errors.NoRepositoryPresent(self)
738
617
        return found_repo
739
618
 
740
 
    def get_branch_reference(self, name=None):
 
619
    def get_branch_reference(self):
741
620
        """Return the referenced URL for the branch in this bzrdir.
742
621
 
743
 
        :param name: Optional colocated branch name
744
622
        :raises NotBranchError: If there is no Branch.
745
 
        :raises NoColocatedBranchSupport: If a branch name was specified
746
 
            but colocated branches are not supported.
747
623
        :return: The URL the branch in this bzrdir references if it is a
748
624
            reference branch, or None for regular branches.
749
625
        """
750
 
        if name is not None:
751
 
            raise errors.NoColocatedBranchSupport(self)
752
626
        return None
753
627
 
754
 
    def get_branch_transport(self, branch_format, name=None):
 
628
    def get_branch_transport(self, branch_format):
755
629
        """Get the transport for use by branch format in this BzrDir.
756
630
 
757
631
        Note that bzr dirs that do not support format strings will raise
758
632
        IncompatibleFormat if the branch format they are given has
759
633
        a format string, and vice versa.
760
634
 
761
 
        If branch_format is None, the transport is returned with no
 
635
        If branch_format is None, the transport is returned with no 
762
636
        checking. If it is not None, then the returned transport is
763
637
        guaranteed to point to an existing directory ready for use.
764
638
        """
807
681
        if not self._mode_check_done:
808
682
            self._find_creation_modes()
809
683
        return self._dir_mode
810
 
 
 
684
        
811
685
    def get_repository_transport(self, repository_format):
812
686
        """Get the transport for use by repository format in this BzrDir.
813
687
 
815
689
        IncompatibleFormat if the repository format they are given has
816
690
        a format string, and vice versa.
817
691
 
818
 
        If repository_format is None, the transport is returned with no
 
692
        If repository_format is None, the transport is returned with no 
819
693
        checking. If it is not None, then the returned transport is
820
694
        guaranteed to point to an existing directory ready for use.
821
695
        """
822
696
        raise NotImplementedError(self.get_repository_transport)
823
 
 
 
697
        
824
698
    def get_workingtree_transport(self, tree_format):
825
699
        """Get the transport for use by workingtree format in this BzrDir.
826
700
 
828
702
        IncompatibleFormat if the workingtree format they are given has a
829
703
        format string, and vice versa.
830
704
 
831
 
        If workingtree_format is None, the transport is returned with no
 
705
        If workingtree_format is None, the transport is returned with no 
832
706
        checking. If it is not None, then the returned transport is
833
707
        guaranteed to point to an existing directory ready for use.
834
708
        """
835
709
        raise NotImplementedError(self.get_workingtree_transport)
836
710
 
837
711
    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
 
712
        if getattr(self, '_get_config', None) is None:
 
713
            return None
 
714
        return self._get_config()
844
715
 
845
716
    def __init__(self, _transport, _format):
846
717
        """Initialize a Bzr control dir object.
847
 
 
 
718
        
848
719
        Only really common logic should reside here, concrete classes should be
849
720
        made with varying behaviours.
850
721
 
852
723
        :param _transport: the transport this dir is based at.
853
724
        """
854
725
        self._format = _format
855
 
        # these are also under the more standard names of 
856
 
        # control_transport and user_transport
857
726
        self.transport = _transport.clone('.bzr')
858
727
        self.root_transport = _transport
859
728
        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
729
 
869
730
    def is_control_filename(self, filename):
870
731
        """True if filename is the name of a path which is reserved for bzrdir's.
871
 
 
 
732
        
872
733
        :param filename: A filename within the root transport of this bzrdir.
873
734
 
874
735
        This is true IF and ONLY IF the filename is part of the namespace reserved
877
738
        this in the future - for instance to make bzr talk with svn working
878
739
        trees.
879
740
        """
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-
 
741
        # this might be better on the BzrDirFormat class because it refers to 
 
742
        # all the possible bzrdir disk formats. 
 
743
        # This method is tested via the workingtree is_control_filename tests- 
883
744
        # it was extracted from WorkingTree.is_control_filename. If the method's
884
745
        # contract is extended beyond the current trivial implementation, please
885
746
        # add new tests for it to the appropriate place.
887
748
 
888
749
    def needs_format_conversion(self, format=None):
889
750
        """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
 
751
        
 
752
        For instance, if the repository format is out of date but the 
892
753
        branch and working tree are not, this should return True.
893
754
 
894
755
        :param format: Optional parameter indicating a specific desired
900
761
    def open_unsupported(base):
901
762
        """Open a branch which is not supported."""
902
763
        return BzrDir.open(base, _unsupported=True)
903
 
 
 
764
        
904
765
    @staticmethod
905
766
    def open(base, _unsupported=False, possible_transports=None):
906
767
        """Open an existing bzrdir, rooted at 'base' (url).
907
 
 
 
768
        
908
769
        :param _unsupported: a private parameter to the BzrDir class.
909
770
        """
910
771
        t = get_transport(base, possible_transports=possible_transports)
918
779
        :param transport: Transport containing the bzrdir.
919
780
        :param _unsupported: private.
920
781
        """
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
782
        base = transport.base
 
783
 
926
784
        def find_format(transport):
927
785
            return transport, BzrDirFormat.find_format(
928
786
                transport, _server_formats=_server_formats)
929
787
 
930
788
        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)
 
789
            qualified_source = e.get_source_url()
 
790
            relpath = transport.relpath(qualified_source)
 
791
            if not e.target.endswith(relpath):
 
792
                # Not redirected to a branch-format, not a branch
 
793
                raise errors.NotBranchError(path=e.target)
 
794
            target = e.target[:-len(relpath)]
934
795
            note('%s is%s redirected to %s',
935
 
                 transport.base, e.permanently, redirected_transport.base)
936
 
            return redirected_transport
 
796
                 transport.base, e.permanently, target)
 
797
            # Let's try with a new transport
 
798
            # FIXME: If 'transport' has a qualifier, this should
 
799
            # be applied again to the new transport *iff* the
 
800
            # schemes used are the same. Uncomment this code
 
801
            # once the function (and tests) exist.
 
802
            # -- vila20070212
 
803
            #target = urlutils.copy_url_qualifiers(original, target)
 
804
            return get_transport(target)
937
805
 
938
806
        try:
939
807
            transport, format = do_catching_redirections(find_format,
945
813
        BzrDir._check_supported(format, _unsupported)
946
814
        return format.open(transport, _found=True)
947
815
 
948
 
    def open_branch(self, name=None, unsupported=False,
949
 
                    ignore_fallbacks=False):
 
816
    def open_branch(self, unsupported=False):
950
817
        """Open the branch object at this BzrDir if one is present.
951
818
 
952
819
        If unsupported is True, then no longer supported branch formats can
953
820
        still be opened.
954
 
 
 
821
        
955
822
        TODO: static convenience version of this?
956
823
        """
957
824
        raise NotImplementedError(self.open_branch)
959
826
    @staticmethod
960
827
    def open_containing(url, possible_transports=None):
961
828
        """Open an existing branch which contains url.
962
 
 
 
829
        
963
830
        :param url: url to search from.
964
831
        See open_containing_from_transport for more detail.
965
832
        """
966
833
        transport = get_transport(url, possible_transports)
967
834
        return BzrDir.open_containing_from_transport(transport)
968
 
 
 
835
    
969
836
    @staticmethod
970
837
    def open_containing_from_transport(a_transport):
971
838
        """Open an existing branch which contains a_transport.base.
974
841
 
975
842
        Basically we keep looking up until we find the control directory or
976
843
        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
 
844
        If there is one and it is either an unrecognised format or an unsupported 
978
845
        format, UnknownFormatError or UnsupportedFormatError are raised.
979
846
        If there is one, it is returned, along with the unused portion of url.
980
847
 
981
 
        :return: The BzrDir that contains the path, and a Unicode path
 
848
        :return: The BzrDir that contains the path, and a Unicode path 
982
849
                for the rest of the URL.
983
850
        """
984
851
        # this gets the normalised url back. I.e. '.' -> the full path.
999
866
                raise errors.NotBranchError(path=url)
1000
867
            a_transport = new_t
1001
868
 
1002
 
    def _get_tree_branch(self, name=None):
 
869
    def _get_tree_branch(self):
1003
870
        """Return the branch and tree, if any, for this bzrdir.
1004
871
 
1005
 
        :param name: Name of colocated branch to open.
1006
 
 
1007
872
        Return None for tree if not present or inaccessible.
1008
873
        Raise NotBranchError if no branch is present.
1009
874
        :return: (tree, branch)
1012
877
            tree = self.open_workingtree()
1013
878
        except (errors.NoWorkingTree, errors.NotLocalUrl):
1014
879
            tree = None
1015
 
            branch = self.open_branch(name=name)
 
880
            branch = self.open_branch()
1016
881
        else:
1017
 
            if name is not None:
1018
 
                branch = self.open_branch(name=name)
1019
 
            else:
1020
 
                branch = tree.branch
 
882
            branch = tree.branch
1021
883
        return tree, branch
1022
884
 
1023
885
    @classmethod
1095
957
        """
1096
958
        raise NotImplementedError(self.open_workingtree)
1097
959
 
1098
 
    def has_branch(self, name=None):
 
960
    def has_branch(self):
1099
961
        """Tell if this bzrdir contains a branch.
1100
 
 
 
962
        
1101
963
        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.)
 
964
        and try, and not ask permission first.  (This method just opens the 
 
965
        branch and discards it, and that's somewhat expensive.) 
1104
966
        """
1105
967
        try:
1106
 
            self.open_branch(name)
 
968
            self.open_branch()
1107
969
            return True
1108
970
        except errors.NotBranchError:
1109
971
            return False
1113
975
 
1114
976
        This will still raise an exception if the bzrdir has a workingtree that
1115
977
        is remote & inaccessible.
1116
 
 
 
978
        
1117
979
        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.)
 
980
        and try, and not ask permission first.  (This method just opens the 
 
981
        workingtree and discards it, and that's somewhat expensive.) 
1120
982
        """
1121
983
        try:
1122
984
            self.open_workingtree(recommend_upgrade=False)
1126
988
 
1127
989
    def _cloning_metadir(self):
1128
990
        """Produce a metadir suitable for cloning with.
1129
 
 
 
991
        
1130
992
        :returns: (destination_bzrdir_format, source_repository)
1131
993
        """
1132
994
        result_format = self._format.__class__()
1133
995
        try:
1134
996
            try:
1135
 
                branch = self.open_branch(ignore_fallbacks=True)
 
997
                branch = self.open_branch()
1136
998
                source_repository = branch.repository
1137
999
                result_format._branch_format = branch._format
1138
1000
            except errors.NotBranchError:
1175
1037
        """
1176
1038
        format, repository = self._cloning_metadir()
1177
1039
        if format._workingtree_format is None:
1178
 
            # No tree in self.
1179
1040
            if repository is None:
1180
 
                # No repository either
1181
1041
                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
1042
            tree_format = repository._format._matchingbzrdir.workingtree_format
1185
1043
            format.workingtree_format = tree_format.__class__()
1186
 
        if require_stacking:
1187
 
            format.require_stacking()
 
1044
        if (require_stacking and not
 
1045
            format.get_branch_format().supports_stacking()):
 
1046
            # We need to make a stacked branch, but the default format for the
 
1047
            # target doesn't support stacking.  So force a branch that *can*
 
1048
            # support stacking.
 
1049
            from bzrlib.branch import BzrBranchFormat7
 
1050
            format._branch_format = BzrBranchFormat7()
 
1051
            mutter("using %r for stacking" % (format._branch_format,))
 
1052
            from bzrlib.repofmt import pack_repo
 
1053
            if format.repository_format.rich_root_data:
 
1054
                bzrdir_format_name = '1.6.1-rich-root'
 
1055
                repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
 
1056
            else:
 
1057
                bzrdir_format_name = '1.6'
 
1058
                repo_format = pack_repo.RepositoryFormatKnitPack5()
 
1059
            note('Source format does not support stacking, using format:'
 
1060
                 ' \'%s\'\n  %s\n',
 
1061
                 bzrdir_format_name, repo_format.get_format_description())
 
1062
            format.repository_format = repo_format
1188
1063
        return format
1189
1064
 
1190
1065
    def checkout_metadir(self):
1192
1067
 
1193
1068
    def sprout(self, url, revision_id=None, force_new_repo=False,
1194
1069
               recurse='down', possible_transports=None,
1195
 
               accelerator_tree=None, hardlink=False, stacked=False,
1196
 
               source_branch=None, create_tree_if_local=True):
 
1070
               accelerator_tree=None, hardlink=False, stacked=False):
1197
1071
        """Create a copy of this bzrdir prepared for use as a new line of
1198
1072
        development.
1199
1073
 
1214
1088
            where possible.
1215
1089
        :param stacked: If true, create a stacked branch referring to the
1216
1090
            location of this control directory.
1217
 
        :param create_tree_if_local: If true, a working-tree will be created
1218
 
            when working locally.
1219
1091
        """
1220
1092
        target_transport = get_transport(url, possible_transports)
1221
1093
        target_transport.ensure_base()
1222
1094
        cloning_format = self.cloning_metadir(stacked)
1223
1095
        # Create/update the result branch
1224
1096
        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:
 
1097
        try:
 
1098
            source_branch = self.open_branch()
 
1099
            source_repository = source_branch.repository
1229
1100
            if stacked:
1230
1101
                stacked_branch_url = self.root_transport.base
1231
 
            source_repository = source_branch.repository
1232
 
        else:
 
1102
            else:
 
1103
                # if a stacked branch wasn't requested, we don't create one
 
1104
                # even if the origin was stacked
 
1105
                stacked_branch_url = None
 
1106
        except errors.NotBranchError:
 
1107
            source_branch = None
1233
1108
            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
 
1109
                source_repository = self.open_repository()
 
1110
            except errors.NoRepositoryPresent:
 
1111
                source_repository = None
 
1112
            stacked_branch_url = None
1244
1113
        repository_policy = result.determine_repository_policy(
1245
1114
            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
 
1115
        result_repo = repository_policy.acquire_repository()
1252
1116
        if source_repository is not None:
1253
1117
            # Fetch while stacked to prevent unstacked fetch from
1254
1118
            # 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)
 
1119
            result_repo.fetch(source_repository, revision_id=revision_id)
1259
1120
 
1260
1121
        if source_branch is None:
1261
1122
            # this is for sprouting a bzrdir without a branch; is that
1263
1124
            # Not especially, but it's part of the contract.
1264
1125
            result_branch = result.create_branch()
1265
1126
        else:
1266
 
            result_branch = source_branch.sprout(result,
1267
 
                revision_id=revision_id, repository_policy=repository_policy)
 
1127
            # Force NULL revision to avoid using repository before stacking
 
1128
            # is configured.
 
1129
            result_branch = source_branch.sprout(
 
1130
                result, revision_id=_mod_revision.NULL_REVISION)
 
1131
            parent_location = result_branch.get_parent()
1268
1132
        mutter("created new branch %r" % (result_branch,))
 
1133
        repository_policy.configure_branch(result_branch)
 
1134
        if source_branch is not None:
 
1135
            source_branch.copy_content_into(result_branch, revision_id)
 
1136
            # Override copy_content_into
 
1137
            result_branch.set_parent(parent_location)
1269
1138
 
1270
1139
        # 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())):
 
1140
        if isinstance(target_transport, LocalTransport) and (
 
1141
            result_repo is None or result_repo.make_working_trees()):
1274
1142
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1275
1143
                hardlink=hardlink)
1276
1144
            wt.lock_write()
1289
1157
                basis = wt.basis_tree()
1290
1158
                basis.lock_read()
1291
1159
                subtrees = basis.iter_references()
1292
 
            elif result_branch is not None:
1293
 
                basis = result_branch.basis_tree()
1294
 
                basis.lock_read()
1295
 
                subtrees = basis.iter_references()
1296
1160
            elif source_branch is not None:
1297
1161
                basis = source_branch.basis_tree()
1298
1162
                basis.lock_read()
1313
1177
                    basis.unlock()
1314
1178
        return result
1315
1179
 
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
1180
 
1432
1181
class BzrDirPreSplitOut(BzrDir):
1433
1182
    """A common class for the all-in-one formats."""
1473
1222
            tree.clone(result)
1474
1223
        return result
1475
1224
 
1476
 
    def create_branch(self, name=None):
 
1225
    def create_branch(self):
1477
1226
        """See BzrDir.create_branch."""
1478
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1227
        return self._format.get_branch_format().initialize(self)
1479
1228
 
1480
 
    def destroy_branch(self, name=None):
 
1229
    def destroy_branch(self):
1481
1230
        """See BzrDir.destroy_branch."""
1482
1231
        raise errors.UnsupportedOperation(self.destroy_branch, self)
1483
1232
 
1504
1253
        # and that will have set it for us, its only
1505
1254
        # specific uses of create_workingtree in isolation
1506
1255
        # that can do wonky stuff here, and that only
1507
 
        # happens for creating checkouts, which cannot be
 
1256
        # happens for creating checkouts, which cannot be 
1508
1257
        # done on this format anyway. So - acceptable wart.
1509
 
        if hardlink:
1510
 
            warning("can't support hardlinked working trees in %r"
1511
 
                % (self,))
1512
1258
        try:
1513
1259
            result = self.open_workingtree(recommend_upgrade=False)
1514
1260
        except errors.NoSuchFile:
1536
1282
 
1537
1283
    def destroy_workingtree_metadata(self):
1538
1284
        """See BzrDir.destroy_workingtree_metadata."""
1539
 
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
 
1285
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata, 
1540
1286
                                          self)
1541
1287
 
1542
 
    def get_branch_transport(self, branch_format, name=None):
 
1288
    def get_branch_transport(self, branch_format):
1543
1289
        """See BzrDir.get_branch_transport()."""
1544
 
        if name is not None:
1545
 
            raise errors.NoColocatedBranchSupport(self)
1546
1290
        if branch_format is None:
1547
1291
            return self.transport
1548
1292
        try:
1576
1320
        # if the format is not the same as the system default,
1577
1321
        # an upgrade is needed.
1578
1322
        if format is None:
1579
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1580
 
                % 'needs_format_conversion(format=None)')
1581
1323
            format = BzrDirFormat.get_default_format()
1582
1324
        return not isinstance(self._format, format.__class__)
1583
1325
 
1584
 
    def open_branch(self, name=None, unsupported=False,
1585
 
                    ignore_fallbacks=False):
 
1326
    def open_branch(self, unsupported=False):
1586
1327
        """See BzrDir.open_branch."""
1587
1328
        from bzrlib.branch import BzrBranchFormat4
1588
1329
        format = BzrBranchFormat4()
1589
1330
        self._check_supported(format, unsupported)
1590
 
        return format.open(self, name, _found=True)
 
1331
        return format.open(self, _found=True)
1591
1332
 
1592
1333
    def sprout(self, url, revision_id=None, force_new_repo=False,
1593
1334
               possible_transports=None, accelerator_tree=None,
1594
 
               hardlink=False, stacked=False, create_tree_if_local=True,
1595
 
               source_branch=None):
 
1335
               hardlink=False, stacked=False):
1596
1336
        """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
1337
        if stacked:
1604
1338
            raise errors.UnstackableBranchFormat(
1605
1339
                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
1340
        from bzrlib.workingtree import WorkingTreeFormat2
1610
1341
        self._make_tail(url)
1611
1342
        result = self._format._initialize_for_clone(url)
1617
1348
            self.open_branch().sprout(result, revision_id=revision_id)
1618
1349
        except errors.NotBranchError:
1619
1350
            pass
1620
 
 
1621
1351
        # we always want a working tree
1622
1352
        WorkingTreeFormat2().initialize(result,
1623
1353
                                        accelerator_tree=accelerator_tree,
1627
1357
 
1628
1358
class BzrDir4(BzrDirPreSplitOut):
1629
1359
    """A .bzr version 4 control object.
1630
 
 
 
1360
    
1631
1361
    This is a deprecated format and may be removed after sept 2006.
1632
1362
    """
1633
1363
 
1637
1367
 
1638
1368
    def needs_format_conversion(self, format=None):
1639
1369
        """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
1370
        return True
1644
1371
 
1645
1372
    def open_repository(self):
1654
1381
    This is a deprecated format and may be removed after sept 2006.
1655
1382
    """
1656
1383
 
1657
 
    def has_workingtree(self):
1658
 
        """See BzrDir.has_workingtree."""
1659
 
        return True
1660
 
    
1661
1384
    def open_repository(self):
1662
1385
        """See BzrDir.open_repository."""
1663
1386
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1679
1402
    This is a deprecated format and may be removed after sept 2006.
1680
1403
    """
1681
1404
 
1682
 
    def has_workingtree(self):
1683
 
        """See BzrDir.has_workingtree."""
1684
 
        return True
1685
 
    
1686
1405
    def open_repository(self):
1687
1406
        """See BzrDir.open_repository."""
1688
1407
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1699
1418
 
1700
1419
class BzrDirMeta1(BzrDir):
1701
1420
    """A .bzr meta version 1 control object.
1702
 
 
1703
 
    This is the first control object where the
 
1421
    
 
1422
    This is the first control object where the 
1704
1423
    individual aspects are really split out: there are separate repository,
1705
1424
    workingtree and branch subdirectories and any subset of the three can be
1706
1425
    present within a BzrDir.
1710
1429
        """See BzrDir.can_convert_format()."""
1711
1430
        return True
1712
1431
 
1713
 
    def create_branch(self, name=None):
 
1432
    def create_branch(self):
1714
1433
        """See BzrDir.create_branch."""
1715
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1434
        return self._format.get_branch_format().initialize(self)
1716
1435
 
1717
 
    def destroy_branch(self, name=None):
 
1436
    def destroy_branch(self):
1718
1437
        """See BzrDir.create_branch."""
1719
 
        if name is not None:
1720
 
            raise errors.NoColocatedBranchSupport(self)
1721
1438
        self.transport.delete_tree('branch')
1722
1439
 
1723
1440
    def create_repository(self, shared=False):
1746
1463
    def destroy_workingtree_metadata(self):
1747
1464
        self.transport.delete_tree('checkout')
1748
1465
 
1749
 
    def find_branch_format(self, name=None):
 
1466
    def find_branch_format(self):
1750
1467
        """Find the branch 'format' for this bzrdir.
1751
1468
 
1752
1469
        This might be a synthetic object for e.g. RemoteBranch and SVN.
1753
1470
        """
1754
1471
        from bzrlib.branch import BranchFormat
1755
 
        return BranchFormat.find_format(self, name=name)
 
1472
        return BranchFormat.find_format(self)
1756
1473
 
1757
1474
    def _get_mkdir_mode(self):
1758
1475
        """Figure out the mode to use when creating a bzrdir subdir."""
1760
1477
                                     lockable_files.TransportLock)
1761
1478
        return temp_control._dir_mode
1762
1479
 
1763
 
    def get_branch_reference(self, name=None):
 
1480
    def get_branch_reference(self):
1764
1481
        """See BzrDir.get_branch_reference()."""
1765
1482
        from bzrlib.branch import BranchFormat
1766
 
        format = BranchFormat.find_format(self, name=name)
1767
 
        return format.get_reference(self, name=name)
 
1483
        format = BranchFormat.find_format(self)
 
1484
        return format.get_reference(self)
1768
1485
 
1769
 
    def get_branch_transport(self, branch_format, name=None):
 
1486
    def get_branch_transport(self, branch_format):
1770
1487
        """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
1488
        if branch_format is None:
1776
1489
            return self.transport.clone('branch')
1777
1490
        try:
1812
1525
            pass
1813
1526
        return self.transport.clone('checkout')
1814
1527
 
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
1528
    def needs_format_conversion(self, format=None):
1832
1529
        """See BzrDir.needs_format_conversion()."""
1833
1530
        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
1531
            format = BzrDirFormat.get_default_format()
1838
1532
        if not isinstance(self._format, format.__class__):
1839
1533
            # it is not a meta dir format, conversion is needed.
1846
1540
                return True
1847
1541
        except errors.NoRepositoryPresent:
1848
1542
            pass
1849
 
        for branch in self.list_branches():
1850
 
            if not isinstance(branch._format,
 
1543
        try:
 
1544
            if not isinstance(self.open_branch()._format,
1851
1545
                              format.get_branch_format().__class__):
1852
1546
                # the branch needs an upgrade.
1853
1547
                return True
 
1548
        except errors.NotBranchError:
 
1549
            pass
1854
1550
        try:
1855
1551
            my_wt = self.open_workingtree(recommend_upgrade=False)
1856
1552
            if not isinstance(my_wt._format,
1861
1557
            pass
1862
1558
        return False
1863
1559
 
1864
 
    def open_branch(self, name=None, unsupported=False,
1865
 
                    ignore_fallbacks=False):
 
1560
    def open_branch(self, unsupported=False):
1866
1561
        """See BzrDir.open_branch."""
1867
 
        format = self.find_branch_format(name=name)
 
1562
        format = self.find_branch_format()
1868
1563
        self._check_supported(format, unsupported)
1869
 
        return format.open(self, name=name,
1870
 
            _found=True, ignore_fallbacks=ignore_fallbacks)
 
1564
        return format.open(self, _found=True)
1871
1565
 
1872
1566
    def open_repository(self, unsupported=False):
1873
1567
        """See BzrDir.open_repository."""
1887
1581
        return format.open(self, _found=True)
1888
1582
 
1889
1583
    def _get_config(self):
1890
 
        return config.TransportConfig(self.transport, 'control.conf')
 
1584
        return config.BzrDirConfig(self.transport)
1891
1585
 
1892
1586
 
1893
1587
class BzrDirFormat(object):
1898
1592
     * a format string,
1899
1593
     * an open routine.
1900
1594
 
1901
 
    Formats are placed in a dict by their format string for reference
 
1595
    Formats are placed in a dict by their format string for reference 
1902
1596
    during bzrdir opening. These should be subclasses of BzrDirFormat
1903
1597
    for consistency.
1904
1598
 
1905
1599
    Once a format is deprecated, just deprecate the initialize and open
1906
 
    methods on the format class. Do not deprecate the object, as the
 
1600
    methods on the format class. Do not deprecate the object, as the 
1907
1601
    object will be created every system load.
1908
 
 
1909
 
    :cvar colocated_branches: Whether this formats supports colocated branches.
1910
1602
    """
1911
1603
 
1912
1604
    _default_format = None
1917
1609
 
1918
1610
    _control_formats = []
1919
1611
    """The registered control formats - .bzr, ....
1920
 
 
 
1612
    
1921
1613
    This is a list of BzrDirFormat objects.
1922
1614
    """
1923
1615
 
1929
1621
 
1930
1622
    _lock_file_name = 'branch-lock'
1931
1623
 
1932
 
    colocated_branches = False
1933
 
    """Whether co-located branches are supported for this control dir format.
1934
 
    """
1935
 
 
1936
1624
    # _lock_class must be set in subclasses to the lock type, typ.
1937
1625
    # TransportLock or LockDir
1938
1626
 
1955
1643
    def probe_transport(klass, transport):
1956
1644
        """Return the .bzrdir style format present in a directory."""
1957
1645
        try:
1958
 
            format_string = transport.get_bytes(".bzr/branch-format")
 
1646
            format_string = transport.get(".bzr/branch-format").read()
1959
1647
        except errors.NoSuchFile:
1960
1648
            raise errors.NotBranchError(path=transport.base)
1961
1649
 
1986
1674
        current default format. In the case of plugins we can/should provide
1987
1675
        some means for them to extend the range of returnable converters.
1988
1676
 
1989
 
        :param format: Optional format to override the default format of the
 
1677
        :param format: Optional format to override the default format of the 
1990
1678
                       library.
1991
1679
        """
1992
1680
        raise NotImplementedError(self.get_converter)
1993
1681
 
1994
1682
    def initialize(self, url, possible_transports=None):
1995
1683
        """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
 
 
 
1684
        
2001
1685
        Subclasses should typically override initialize_on_transport
2002
1686
        instead of this method.
2003
1687
        """
2006
1690
 
2007
1691
    def initialize_on_transport(self, transport):
2008
1692
        """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
 
1693
        # Since we don't have a .bzr directory, inherit the
2129
1694
        # mode from the root directory
2130
1695
        temp_control = lockable_files.LockableFiles(transport,
2131
1696
                            '', lockable_files.TransportLock)
2133
1698
                                      # FIXME: RBC 20060121 don't peek under
2134
1699
                                      # the covers
2135
1700
                                      mode=temp_control._dir_mode)
2136
 
        if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
 
1701
        if sys.platform == 'win32' and isinstance(transport, LocalTransport):
2137
1702
            win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
2138
1703
        file_mode = temp_control._file_mode
2139
1704
        del temp_control
2161
1726
        """Is this format supported?
2162
1727
 
2163
1728
        Supported formats must be initializable and openable.
2164
 
        Unsupported formats may not support initialization or committing or
 
1729
        Unsupported formats may not support initialization or committing or 
2165
1730
        some other features depending on the reason for not being supported.
2166
1731
        """
2167
1732
        return True
2168
1733
 
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
1734
    def same_model(self, target_format):
2180
 
        return (self.repository_format.rich_root_data ==
 
1735
        return (self.repository_format.rich_root_data == 
2181
1736
            target_format.rich_root_data)
2182
1737
 
2183
1738
    @classmethod
2184
1739
    def known_formats(klass):
2185
1740
        """Return all the known formats.
2186
 
 
 
1741
        
2187
1742
        Concrete formats should override _known_formats.
2188
1743
        """
2189
 
        # There is double indirection here to make sure that control
2190
 
        # formats used by more than one dir format will only be probed
 
1744
        # There is double indirection here to make sure that control 
 
1745
        # formats used by more than one dir format will only be probed 
2191
1746
        # once. This can otherwise be quite expensive for remote connections.
2192
1747
        result = set()
2193
1748
        for format in klass._control_formats:
2194
1749
            result.update(format._known_formats())
2195
1750
        return result
2196
 
 
 
1751
    
2197
1752
    @classmethod
2198
1753
    def _known_formats(klass):
2199
1754
        """Return the known format instances for this control format."""
2201
1756
 
2202
1757
    def open(self, transport, _found=False):
2203
1758
        """Return an instance of this format for the dir transport points at.
2204
 
 
 
1759
        
2205
1760
        _found is a private parameter, do not use it.
2206
1761
        """
2207
1762
        if not _found:
2208
1763
            found_format = BzrDirFormat.find_format(transport)
2209
1764
            if not isinstance(found_format, self.__class__):
2210
1765
                raise AssertionError("%s was asked to open %s, but it seems to need "
2211
 
                        "format %s"
 
1766
                        "format %s" 
2212
1767
                        % (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
1768
        return self._open(transport)
2217
1769
 
2218
1770
    def _open(self, transport):
2226
1778
    @classmethod
2227
1779
    def register_format(klass, format):
2228
1780
        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
1781
 
2232
1782
    @classmethod
2233
1783
    def register_control_format(klass, format):
2234
1784
        """Register a format that does not use '.bzr' for its control dir.
2235
1785
 
2236
1786
        TODO: This should be pulled up into a 'ControlDirFormat' base class
2237
 
        which BzrDirFormat can inherit from, and renamed to register_format
 
1787
        which BzrDirFormat can inherit from, and renamed to register_format 
2238
1788
        there. It has been done without that for now for simplicity of
2239
1789
        implementation.
2240
1790
        """
2258
1808
 
2259
1809
    def __str__(self):
2260
1810
        # 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
 
        """
 
1811
        return self.get_format_string().rstrip()
2274
1812
 
2275
1813
    @classmethod
2276
1814
    def unregister_format(klass, format):
2308
1846
        """See BzrDirFormat.get_converter()."""
2309
1847
        # there is one and only one upgrade path here.
2310
1848
        return ConvertBzrDir4To5()
2311
 
 
 
1849
        
2312
1850
    def initialize_on_transport(self, transport):
2313
1851
        """Format 4 branches cannot be created."""
2314
1852
        raise errors.UninitializableFormat(self)
2317
1855
        """Format 4 is not supported.
2318
1856
 
2319
1857
        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
 
1858
        conversion logic is expensive - so doing it on the fly was not 
2321
1859
        feasible.
2322
1860
        """
2323
1861
        return False
2324
1862
 
2325
 
    def network_name(self):
2326
 
        return self.get_format_string()
2327
 
 
2328
1863
    def _open(self, transport):
2329
1864
        """See BzrDirFormat._open."""
2330
1865
        return BzrDir4(transport, self)
2336
1871
    repository_format = property(__return_repository_format)
2337
1872
 
2338
1873
 
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):
 
1874
class BzrDirFormat5(BzrDirFormat):
2365
1875
    """Bzr control format 5.
2366
1876
 
2367
1877
    This format is a combined format for working tree, branch and repository.
2368
1878
    It has:
2369
 
     - Format 2 working trees [always]
2370
 
     - Format 4 branches [always]
 
1879
     - Format 2 working trees [always] 
 
1880
     - Format 4 branches [always] 
2371
1881
     - Format 5 repositories [always]
2372
1882
       Unhashed stores in the repository.
2373
1883
    """
2393
1903
 
2394
1904
    def _initialize_for_clone(self, url):
2395
1905
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2396
 
 
 
1906
        
2397
1907
    def initialize_on_transport(self, transport, _cloning=False):
2398
1908
        """Format 5 dirs always have working tree, branch and repository.
2399
 
 
 
1909
        
2400
1910
        Except when they are being cloned.
2401
1911
        """
2402
1912
        from bzrlib.branch import BzrBranchFormat4
2408
1918
            result._init_workingtree()
2409
1919
        return result
2410
1920
 
2411
 
    def network_name(self):
2412
 
        return self.get_format_string()
2413
 
 
2414
1921
    def _open(self, transport):
2415
1922
        """See BzrDirFormat._open."""
2416
1923
        return BzrDir5(transport, self)
2422
1929
    repository_format = property(__return_repository_format)
2423
1930
 
2424
1931
 
2425
 
class BzrDirFormat6(BzrDirFormatAllInOne):
 
1932
class BzrDirFormat6(BzrDirFormat):
2426
1933
    """Bzr control format 6.
2427
1934
 
2428
1935
    This format is a combined format for working tree, branch and repository.
2429
1936
    It has:
2430
 
     - Format 2 working trees [always]
2431
 
     - Format 4 branches [always]
 
1937
     - Format 2 working trees [always] 
 
1938
     - Format 4 branches [always] 
2432
1939
     - Format 6 repositories [always]
2433
1940
    """
2434
1941
 
2450
1957
        """See BzrDirFormat.get_converter()."""
2451
1958
        # there is one and only one upgrade path here.
2452
1959
        return ConvertBzrDir6ToMeta()
2453
 
 
 
1960
        
2454
1961
    def _initialize_for_clone(self, url):
2455
1962
        return self.initialize_on_transport(get_transport(url), _cloning=True)
2456
1963
 
2457
1964
    def initialize_on_transport(self, transport, _cloning=False):
2458
1965
        """Format 6 dirs always have working tree, branch and repository.
2459
 
 
 
1966
        
2460
1967
        Except when they are being cloned.
2461
1968
        """
2462
1969
        from bzrlib.branch import BzrBranchFormat4
2468
1975
            result._init_workingtree()
2469
1976
        return result
2470
1977
 
2471
 
    def network_name(self):
2472
 
        return self.get_format_string()
2473
 
 
2474
1978
    def _open(self, transport):
2475
1979
        """See BzrDirFormat._open."""
2476
1980
        return BzrDir6(transport, self)
2498
2002
    def __init__(self):
2499
2003
        self._workingtree_format = None
2500
2004
        self._branch_format = None
2501
 
        self._repository_format = None
2502
2005
 
2503
2006
    def __eq__(self, other):
2504
2007
        if other.__class__ is not self.__class__:
2521
2024
    def set_branch_format(self, format):
2522
2025
        self._branch_format = format
2523
2026
 
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
2027
    def get_converter(self, format=None):
2617
2028
        """See BzrDirFormat.get_converter()."""
2618
2029
        if format is None:
2630
2041
        """See BzrDirFormat.get_format_description()."""
2631
2042
        return "Meta directory format 1"
2632
2043
 
2633
 
    def network_name(self):
2634
 
        return self.get_format_string()
2635
 
 
2636
2044
    def _open(self, transport):
2637
2045
        """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)
 
2046
        return BzrDirMeta1(transport, self)
2644
2047
 
2645
2048
    def __return_repository_format(self):
2646
2049
        """Circular import protection."""
2647
 
        if self._repository_format:
 
2050
        if getattr(self, '_repository_format', None):
2648
2051
            return self._repository_format
2649
2052
        from bzrlib.repository import RepositoryFormat
2650
2053
        return RepositoryFormat.get_default_format()
2651
2054
 
2652
 
    def _set_repository_format(self, value):
 
2055
    def __set_repository_format(self, value):
2653
2056
        """Allow changing the repository format for metadir formats."""
2654
2057
        self._repository_format = value
2655
2058
 
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
 
2059
    repository_format = property(__return_repository_format, __set_repository_format)
2676
2060
 
2677
2061
    def __get_workingtree_format(self):
2678
2062
        if self._workingtree_format is None:
2687
2071
                                  __set_workingtree_format)
2688
2072
 
2689
2073
 
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
2074
# Register bzr control format
2700
2075
BzrDirFormat.register_control_format(BzrDirFormat)
2701
2076
 
2733
2108
        self.absent_revisions = set()
2734
2109
        self.text_count = 0
2735
2110
        self.revisions = {}
2736
 
 
 
2111
        
2737
2112
    def convert(self, to_convert, pb):
2738
2113
        """See Converter.convert()."""
2739
2114
        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()
 
2115
        self.pb = pb
 
2116
        self.pb.note('starting upgrade from format 4 to 5')
 
2117
        if isinstance(self.bzrdir.transport, LocalTransport):
 
2118
            self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
 
2119
        self._convert_to_weaves()
 
2120
        return BzrDir.open(self.bzrdir.root_transport.base)
2751
2121
 
2752
2122
    def _convert_to_weaves(self):
2753
 
        ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
 
2123
        self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2754
2124
        try:
2755
2125
            # TODO permissions
2756
2126
            stat = self.bzrdir.transport.stat('weaves')
2784
2154
        self.pb.clear()
2785
2155
        self._write_all_weaves()
2786
2156
        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)
 
2157
        self.pb.note('upgraded to weaves:')
 
2158
        self.pb.note('  %6d revisions and inventories', len(self.revisions))
 
2159
        self.pb.note('  %6d revisions not present', len(self.absent_revisions))
 
2160
        self.pb.note('  %6d texts', self.text_count)
2791
2161
        self._cleanup_spare_files_after_format4()
2792
2162
        self.branch._transport.put_bytes(
2793
2163
            'branch-format',
2850
2220
                revision_store.add_lines(key, None, osutils.split_lines(text))
2851
2221
        finally:
2852
2222
            self.pb.clear()
2853
 
 
 
2223
            
2854
2224
    def _load_one_rev(self, rev_id):
2855
2225
        """Load a revision object into memory.
2856
2226
 
2861
2231
                       len(self.known_revisions))
2862
2232
        if not self.branch.repository.has_revision(rev_id):
2863
2233
            self.pb.clear()
2864
 
            ui.ui_factory.note('revision {%s} not present in branch; '
2865
 
                         'will be converted as a ghost' %
 
2234
            self.pb.note('revision {%s} not present in branch; '
 
2235
                         'will be converted as a ghost',
2866
2236
                         rev_id)
2867
2237
            self.absent_revisions.add(rev_id)
2868
2238
        else:
2930
2300
        text_changed = False
2931
2301
        parent_candiate_entries = ie.parent_candidates(parent_invs)
2932
2302
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2933
 
        # XXX: Note that this is unordered - and this is tolerable because
 
2303
        # XXX: Note that this is unordered - and this is tolerable because 
2934
2304
        # the previous code was also unordered.
2935
2305
        previous_entries = dict((head, parent_candiate_entries[head]) for head
2936
2306
            in heads)
2937
2307
        self.snapshot_ie(previous_entries, ie, w, rev_id)
2938
2308
        del ie.text_id
2939
2309
 
 
2310
    @symbol_versioning.deprecated_method(symbol_versioning.one_one)
 
2311
    def get_parents(self, revision_ids):
 
2312
        for revision_id in revision_ids:
 
2313
            yield self.revisions[revision_id].parent_ids
 
2314
 
2940
2315
    def get_parent_map(self, revision_ids):
2941
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
2316
        """See graph._StackedParentsProvider.get_parent_map"""
2942
2317
        return dict((revision_id, self.revisions[revision_id])
2943
2318
                    for revision_id in revision_ids
2944
2319
                     if revision_id in self.revisions)
2948
2323
        # a call to:. This needs the path figured out. rather than a work_tree
2949
2324
        # a v4 revision_tree can be given, or something that looks enough like
2950
2325
        # one to give the file content to the entry if it needs it.
2951
 
        # and we need something that looks like a weave store for snapshot to
 
2326
        # and we need something that looks like a weave store for snapshot to 
2952
2327
        # save against.
2953
2328
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2954
2329
        if len(previous_revisions) == 1:
2994
2369
    def convert(self, to_convert, pb):
2995
2370
        """See Converter.convert()."""
2996
2371
        self.bzrdir = to_convert
2997
 
        pb = ui.ui_factory.nested_progress_bar()
2998
 
        try:
2999
 
            ui.ui_factory.note('starting upgrade from format 5 to 6')
3000
 
            self._convert_to_prefixed()
3001
 
            return BzrDir.open(self.bzrdir.user_url)
3002
 
        finally:
3003
 
            pb.finished()
 
2372
        self.pb = pb
 
2373
        self.pb.note('starting upgrade from format 5 to 6')
 
2374
        self._convert_to_prefixed()
 
2375
        return BzrDir.open(self.bzrdir.root_transport.base)
3004
2376
 
3005
2377
    def _convert_to_prefixed(self):
3006
2378
        from bzrlib.store import TransportStore
3007
2379
        self.bzrdir.transport.delete('branch-format')
3008
2380
        for store_name in ["weaves", "revision-store"]:
3009
 
            ui.ui_factory.note("adding prefixes to %s" % store_name)
 
2381
            self.pb.note("adding prefixes to %s" % store_name)
3010
2382
            store_transport = self.bzrdir.transport.clone(store_name)
3011
2383
            store = TransportStore(store_transport, prefixed=True)
3012
2384
            for urlfilename in store_transport.list_dir('.'):
3039
2411
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
3040
2412
        from bzrlib.branch import BzrBranchFormat5
3041
2413
        self.bzrdir = to_convert
3042
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2414
        self.pb = pb
3043
2415
        self.count = 0
3044
2416
        self.total = 20 # the steps we know about
3045
2417
        self.garbage_inventories = []
3046
2418
        self.dir_mode = self.bzrdir._get_dir_mode()
3047
2419
        self.file_mode = self.bzrdir._get_file_mode()
3048
2420
 
3049
 
        ui.ui_factory.note('starting upgrade from format 6 to metadir')
 
2421
        self.pb.note('starting upgrade from format 6 to metadir')
3050
2422
        self.bzrdir.transport.put_bytes(
3051
2423
                'branch-format',
3052
2424
                "Converting to format 6",
3073
2445
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
3074
2446
        self.make_lock('repository')
3075
2447
        # we hard code the formats here because we are converting into
3076
 
        # the meta format. The meta format upgrader can take this to a
 
2448
        # the meta format. The meta format upgrader can take this to a 
3077
2449
        # future format within each component.
3078
2450
        self.put_format('repository', RepositoryFormat7())
3079
2451
        for entry in repository_names:
3102
2474
        else:
3103
2475
            has_checkout = True
3104
2476
        if not has_checkout:
3105
 
            ui.ui_factory.note('No working tree.')
 
2477
            self.pb.note('No working tree.')
3106
2478
            # If some checkout files are there, we may as well get rid of them.
3107
2479
            for name, mandatory in checkout_files:
3108
2480
                if name in bzrcontents:
3125
2497
            'branch-format',
3126
2498
            BzrDirMetaFormat1().get_format_string(),
3127
2499
            mode=self.file_mode)
3128
 
        self.pb.finished()
3129
 
        return BzrDir.open(self.bzrdir.user_url)
 
2500
        return BzrDir.open(self.bzrdir.root_transport.base)
3130
2501
 
3131
2502
    def make_lock(self, name):
3132
2503
        """Make a lock for the new control dir name."""
3167
2538
    def convert(self, to_convert, pb):
3168
2539
        """See Converter.convert()."""
3169
2540
        self.bzrdir = to_convert
3170
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
2541
        self.pb = pb
3171
2542
        self.count = 0
3172
2543
        self.total = 1
3173
2544
        self.step('checking repository format')
3178
2549
        else:
3179
2550
            if not isinstance(repo._format, self.target_format.repository_format.__class__):
3180
2551
                from bzrlib.repository import CopyConverter
3181
 
                ui.ui_factory.note('starting repository conversion')
 
2552
                self.pb.note('starting repository conversion')
3182
2553
                converter = CopyConverter(self.target_format.repository_format)
3183
2554
                converter.convert(repo, pb)
3184
 
        for branch in self.bzrdir.list_branches():
 
2555
        try:
 
2556
            branch = self.bzrdir.open_branch()
 
2557
        except errors.NotBranchError:
 
2558
            pass
 
2559
        else:
3185
2560
            # TODO: conversions of Branch and Tree should be done by
3186
2561
            # InterXFormat lookups/some sort of registry.
3187
2562
            # Avoid circular imports
3191
2566
            while old != new:
3192
2567
                if (old == _mod_branch.BzrBranchFormat5 and
3193
2568
                    new in (_mod_branch.BzrBranchFormat6,
3194
 
                        _mod_branch.BzrBranchFormat7,
3195
 
                        _mod_branch.BzrBranchFormat8)):
 
2569
                        _mod_branch.BzrBranchFormat7)):
3196
2570
                    branch_converter = _mod_branch.Converter5to6()
3197
2571
                elif (old == _mod_branch.BzrBranchFormat6 and
3198
 
                    new in (_mod_branch.BzrBranchFormat7,
3199
 
                            _mod_branch.BzrBranchFormat8)):
 
2572
                    new == _mod_branch.BzrBranchFormat7):
3200
2573
                    branch_converter = _mod_branch.Converter6to7()
3201
 
                elif (old == _mod_branch.BzrBranchFormat7 and
3202
 
                      new is _mod_branch.BzrBranchFormat8):
3203
 
                    branch_converter = _mod_branch.Converter7to8()
3204
2574
                else:
3205
 
                    raise errors.BadConversionTarget("No converter", new,
3206
 
                        branch._format)
 
2575
                    raise errors.BadConversionTarget("No converter", new)
3207
2576
                branch_converter.convert(branch)
3208
2577
                branch = self.bzrdir.open_branch()
3209
2578
                old = branch._format.__class__
3215
2584
            # TODO: conversions of Branch and Tree should be done by
3216
2585
            # InterXFormat lookups
3217
2586
            if (isinstance(tree, workingtree.WorkingTree3) and
3218
 
                not isinstance(tree, workingtree_4.DirStateWorkingTree) and
 
2587
                not isinstance(tree, workingtree_4.WorkingTree4) and
3219
2588
                isinstance(self.target_format.workingtree_format,
3220
 
                    workingtree_4.DirStateWorkingTreeFormat)):
 
2589
                    workingtree_4.WorkingTreeFormat4)):
3221
2590
                workingtree_4.Converter3to4().convert(tree)
3222
 
            if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3223
 
                not isinstance(tree, workingtree_4.WorkingTree5) and
3224
 
                isinstance(self.target_format.workingtree_format,
3225
 
                    workingtree_4.WorkingTreeFormat5)):
3226
 
                workingtree_4.Converter4to5().convert(tree)
3227
 
            if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
3228
 
                not isinstance(tree, workingtree_4.WorkingTree6) and
3229
 
                isinstance(self.target_format.workingtree_format,
3230
 
                    workingtree_4.WorkingTreeFormat6)):
3231
 
                workingtree_4.Converter4or5to6().convert(tree)
3232
 
        self.pb.finished()
3233
2591
        return to_convert
3234
2592
 
3235
2593
 
3236
 
# This is not in remote.py because it's relatively small, and needs to be
3237
 
# registered. Putting it in remote.py creates a circular import problem.
 
2594
# This is not in remote.py because it's small, and needs to be registered.
 
2595
# Putting it in remote.py creates a circular import problem.
3238
2596
# we can make it a lazy object if the control formats is turned into something
3239
2597
# like a registry.
3240
2598
class RemoteBzrDirFormat(BzrDirMetaFormat1):
3241
2599
    """Format representing bzrdirs accessed via a smart server"""
3242
2600
 
3243
 
    def __init__(self):
3244
 
        BzrDirMetaFormat1.__init__(self)
3245
 
        # XXX: It's a bit ugly that the network name is here, because we'd
3246
 
        # like to believe that format objects are stateless or at least
3247
 
        # immutable,  However, we do at least avoid mutating the name after
3248
 
        # it's returned.  See <https://bugs.edge.launchpad.net/bzr/+bug/504102>
3249
 
        self._network_name = None
3250
 
 
3251
 
    def __repr__(self):
3252
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
3253
 
            self._network_name)
3254
 
 
3255
2601
    def get_format_description(self):
3256
 
        if self._network_name:
3257
 
            real_format = network_format_registry.get(self._network_name)
3258
 
            return 'Remote: ' + real_format.get_format_description()
3259
2602
        return 'bzr remote bzrdir'
3260
 
 
3261
 
    def get_format_string(self):
3262
 
        raise NotImplementedError(self.get_format_string)
3263
 
 
3264
 
    def network_name(self):
3265
 
        if self._network_name:
3266
 
            return self._network_name
3267
 
        else:
3268
 
            raise AssertionError("No network name set.")
3269
 
 
 
2603
    
3270
2604
    @classmethod
3271
2605
    def probe_transport(klass, transport):
3272
2606
        """Return a RemoteBzrDirFormat object if it looks possible."""
3301
2635
            return local_dir_format.initialize_on_transport(transport)
3302
2636
        client = _SmartClient(client_medium)
3303
2637
        path = client.remote_path_from_transport(transport)
3304
 
        try:
3305
 
            response = client.call('BzrDirFormat.initialize', path)
3306
 
        except errors.ErrorFromSmartServer, err:
3307
 
            remote._translate_error(err, path=path)
 
2638
        response = client.call('BzrDirFormat.initialize', path)
3308
2639
        if response[0] != 'ok':
3309
2640
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
3310
 
        format = RemoteBzrDirFormat()
3311
 
        self._supply_sub_formats_to(format)
3312
 
        return remote.RemoteBzrDir(transport, format)
3313
 
 
3314
 
    def parse_NoneTrueFalse(self, arg):
3315
 
        if not arg:
3316
 
            return None
3317
 
        if arg == 'False':
3318
 
            return False
3319
 
        if arg == 'True':
3320
 
            return True
3321
 
        raise AssertionError("invalid arg %r" % arg)
3322
 
 
3323
 
    def _serialize_NoneTrueFalse(self, arg):
3324
 
        if arg is False:
3325
 
            return 'False'
3326
 
        if arg:
3327
 
            return 'True'
3328
 
        return ''
3329
 
 
3330
 
    def _serialize_NoneString(self, arg):
3331
 
        return arg or ''
3332
 
 
3333
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
3334
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
3335
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
3336
 
        shared_repo=False):
3337
 
        try:
3338
 
            # hand off the request to the smart server
3339
 
            client_medium = transport.get_smart_medium()
3340
 
        except errors.NoSmartMedium:
3341
 
            do_vfs = True
3342
 
        else:
3343
 
            # Decline to open it if the server doesn't support our required
3344
 
            # version (3) so that the VFS-based transport will do it.
3345
 
            if client_medium.should_probe():
3346
 
                try:
3347
 
                    server_version = client_medium.protocol_version()
3348
 
                    if server_version != '2':
3349
 
                        do_vfs = True
3350
 
                    else:
3351
 
                        do_vfs = False
3352
 
                except errors.SmartProtocolError:
3353
 
                    # Apparently there's no usable smart server there, even though
3354
 
                    # the medium supports the smart protocol.
3355
 
                    do_vfs = True
3356
 
            else:
3357
 
                do_vfs = False
3358
 
        if not do_vfs:
3359
 
            client = _SmartClient(client_medium)
3360
 
            path = client.remote_path_from_transport(transport)
3361
 
            if client_medium._is_remote_before((1, 16)):
3362
 
                do_vfs = True
3363
 
        if do_vfs:
3364
 
            # TODO: lookup the local format from a server hint.
3365
 
            local_dir_format = BzrDirMetaFormat1()
3366
 
            self._supply_sub_formats_to(local_dir_format)
3367
 
            return local_dir_format.initialize_on_transport_ex(transport,
3368
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3369
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3370
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3371
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3372
 
                vfs_only=True)
3373
 
        return self._initialize_on_transport_ex_rpc(client, path, transport,
3374
 
            use_existing_dir, create_prefix, force_new_repo, stacked_on,
3375
 
            stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
3376
 
 
3377
 
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
3378
 
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
3379
 
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
3380
 
        args = []
3381
 
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
3382
 
        args.append(self._serialize_NoneTrueFalse(create_prefix))
3383
 
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
3384
 
        args.append(self._serialize_NoneString(stacked_on))
3385
 
        # stack_on_pwd is often/usually our transport
3386
 
        if stack_on_pwd:
3387
 
            try:
3388
 
                stack_on_pwd = transport.relpath(stack_on_pwd)
3389
 
                if not stack_on_pwd:
3390
 
                    stack_on_pwd = '.'
3391
 
            except errors.PathNotChild:
3392
 
                pass
3393
 
        args.append(self._serialize_NoneString(stack_on_pwd))
3394
 
        args.append(self._serialize_NoneString(repo_format_name))
3395
 
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
3396
 
        args.append(self._serialize_NoneTrueFalse(shared_repo))
3397
 
        request_network_name = self._network_name or \
3398
 
            BzrDirFormat.get_default_format().network_name()
3399
 
        try:
3400
 
            response = client.call('BzrDirFormat.initialize_ex_1.16',
3401
 
                request_network_name, path, *args)
3402
 
        except errors.UnknownSmartMethod:
3403
 
            client._medium._remember_remote_is_before((1,16))
3404
 
            local_dir_format = BzrDirMetaFormat1()
3405
 
            self._supply_sub_formats_to(local_dir_format)
3406
 
            return local_dir_format.initialize_on_transport_ex(transport,
3407
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
3408
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
3409
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
3410
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
3411
 
                vfs_only=True)
3412
 
        except errors.ErrorFromSmartServer, err:
3413
 
            remote._translate_error(err, path=path)
3414
 
        repo_path = response[0]
3415
 
        bzrdir_name = response[6]
3416
 
        require_stacking = response[7]
3417
 
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
3418
 
        format = RemoteBzrDirFormat()
3419
 
        format._network_name = bzrdir_name
3420
 
        self._supply_sub_formats_to(format)
3421
 
        bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
3422
 
        if repo_path:
3423
 
            repo_format = remote.response_tuple_to_repo_format(response[1:])
3424
 
            if repo_path == '.':
3425
 
                repo_path = ''
3426
 
            if repo_path:
3427
 
                repo_bzrdir_format = RemoteBzrDirFormat()
3428
 
                repo_bzrdir_format._network_name = response[5]
3429
 
                repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
3430
 
                    repo_bzrdir_format)
3431
 
            else:
3432
 
                repo_bzr = bzrdir
3433
 
            final_stack = response[8] or None
3434
 
            final_stack_pwd = response[9] or None
3435
 
            if final_stack_pwd:
3436
 
                final_stack_pwd = urlutils.join(
3437
 
                    transport.base, final_stack_pwd)
3438
 
            remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
3439
 
            if len(response) > 10:
3440
 
                # Updated server verb that locks remotely.
3441
 
                repo_lock_token = response[10] or None
3442
 
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
3443
 
                if repo_lock_token:
3444
 
                    remote_repo.dont_leave_lock_in_place()
3445
 
            else:
3446
 
                remote_repo.lock_write()
3447
 
            policy = UseExistingRepository(remote_repo, final_stack,
3448
 
                final_stack_pwd, require_stacking)
3449
 
            policy.acquire_repository()
3450
 
        else:
3451
 
            remote_repo = None
3452
 
            policy = None
3453
 
        bzrdir._format.set_branch_format(self.get_branch_format())
3454
 
        if require_stacking:
3455
 
            # The repo has already been created, but we need to make sure that
3456
 
            # we'll make a stackable branch.
3457
 
            bzrdir._format.require_stacking(_skip_repo=True)
3458
 
        return remote_repo, bzrdir, require_stacking, policy
 
2641
        return remote.RemoteBzrDir(transport)
3459
2642
 
3460
2643
    def _open(self, transport):
3461
 
        return remote.RemoteBzrDir(transport, self)
 
2644
        return remote.RemoteBzrDir(transport)
3462
2645
 
3463
2646
    def __eq__(self, other):
3464
2647
        if not isinstance(other, RemoteBzrDirFormat):
3465
2648
            return False
3466
2649
        return self.get_format_description() == other.get_format_description()
3467
2650
 
3468
 
    def __return_repository_format(self):
3469
 
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
3470
 
        # repository format has been asked for, tell the RemoteRepositoryFormat
3471
 
        # that it should use that for init() etc.
3472
 
        result = remote.RemoteRepositoryFormat()
3473
 
        custom_format = getattr(self, '_repository_format', None)
3474
 
        if custom_format:
3475
 
            if isinstance(custom_format, remote.RemoteRepositoryFormat):
3476
 
                return custom_format
3477
 
            else:
3478
 
                # We will use the custom format to create repositories over the
3479
 
                # wire; expose its details like rich_root_data for code to
3480
 
                # query
3481
 
                result._custom_format = custom_format
3482
 
        return result
3483
 
 
3484
 
    def get_branch_format(self):
3485
 
        result = BzrDirMetaFormat1.get_branch_format(self)
3486
 
        if not isinstance(result, remote.RemoteBranchFormat):
3487
 
            new_result = remote.RemoteBranchFormat()
3488
 
            new_result._custom_format = result
3489
 
            # cache the result
3490
 
            self.set_branch_format(new_result)
3491
 
            result = new_result
3492
 
        return result
3493
 
 
3494
 
    repository_format = property(__return_repository_format,
3495
 
        BzrDirMetaFormat1._set_repository_format) #.im_func)
3496
 
 
3497
2651
 
3498
2652
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
3499
2653
 
3509
2663
 
3510
2664
class BzrDirFormatRegistry(registry.Registry):
3511
2665
    """Registry of user-selectable BzrDir subformats.
3512
 
 
 
2666
    
3513
2667
    Differs from BzrDirFormat._control_formats in that it provides sub-formats,
3514
2668
    e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
3515
2669
    """
3517
2671
    def __init__(self):
3518
2672
        """Create a BzrDirFormatRegistry."""
3519
2673
        self._aliases = set()
3520
 
        self._registration_order = list()
3521
2674
        super(BzrDirFormatRegistry, self).__init__()
3522
2675
 
3523
2676
    def aliases(self):
3534
2687
        """Register a metadir subformat.
3535
2688
 
3536
2689
        These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
3537
 
        by the Repository/Branch/WorkingTreeformats.
 
2690
        by the Repository format.
3538
2691
 
3539
2692
        :param repository_format: The fully-qualified repository format class
3540
2693
            name as a string.
3574
2727
    def register(self, key, factory, help, native=True, deprecated=False,
3575
2728
                 hidden=False, experimental=False, alias=False):
3576
2729
        """Register a BzrDirFormat factory.
3577
 
 
 
2730
        
3578
2731
        The factory must be a callable that takes one parameter: the key.
3579
2732
        It must produce an instance of the BzrDirFormat when called.
3580
2733
 
3585
2738
            BzrDirFormatInfo(native, deprecated, hidden, experimental))
3586
2739
        if alias:
3587
2740
            self._aliases.add(key)
3588
 
        self._registration_order.append(key)
3589
2741
 
3590
2742
    def register_lazy(self, key, module_name, member_name, help, native=True,
3591
2743
        deprecated=False, hidden=False, experimental=False, alias=False):
3593
2745
            help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
3594
2746
        if alias:
3595
2747
            self._aliases.add(key)
3596
 
        self._registration_order.append(key)
3597
2748
 
3598
2749
    def set_default(self, key):
3599
2750
        """Set the 'default' key to be a clone of the supplied key.
3600
 
 
 
2751
        
3601
2752
        This method must be called once and only once.
3602
2753
        """
3603
2754
        registry.Registry.register(self, 'default', self.get(key),
3606
2757
 
3607
2758
    def set_default_repository(self, key):
3608
2759
        """Set the FormatRegistry default and Repository default.
3609
 
 
 
2760
        
3610
2761
        This is a transitional method while Repository.set_default_format
3611
2762
        is deprecated.
3612
2763
        """
3619
2770
        return self.get(key)()
3620
2771
 
3621
2772
    def help_topic(self, topic):
3622
 
        output = ""
 
2773
        output = textwrap.dedent("""\
 
2774
            These formats can be used for creating branches, working trees, and
 
2775
            repositories.
 
2776
 
 
2777
            """)
3623
2778
        default_realkey = None
3624
2779
        default_help = self.get_help('default')
3625
2780
        help_pairs = []
3626
 
        for key in self._registration_order:
 
2781
        for key in self.keys():
3627
2782
            if key == 'default':
3628
2783
                continue
3629
2784
            help = self.get_help(key)
3635
2790
        def wrapped(key, help, info):
3636
2791
            if info.native:
3637
2792
                help = '(native) ' + help
3638
 
            return ':%s:\n%s\n\n' % (key,
3639
 
                textwrap.fill(help, initial_indent='    ',
3640
 
                    subsequent_indent='    ',
3641
 
                    break_long_words=False))
 
2793
            return ':%s:\n%s\n\n' % (key, 
 
2794
                    textwrap.fill(help, initial_indent='    ', 
 
2795
                    subsequent_indent='    '))
3642
2796
        if default_realkey is not None:
3643
2797
            output += wrapped(default_realkey, '(default) %s' % default_help,
3644
2798
                              self.get_info('default'))
3654
2808
                experimental_pairs.append((key, help))
3655
2809
            else:
3656
2810
                output += wrapped(key, help, info)
3657
 
        output += "\nSee :doc:`formats-help` for more about storage formats."
3658
 
        other_output = ""
3659
2811
        if len(experimental_pairs) > 0:
3660
 
            other_output += "Experimental formats are shown below.\n\n"
 
2812
            output += "Experimental formats are shown below.\n\n"
3661
2813
            for key, help in experimental_pairs:
3662
2814
                info = self.get_info(key)
3663
 
                other_output += wrapped(key, help, info)
3664
 
        else:
3665
 
            other_output += \
3666
 
                "No experimental formats are available.\n\n"
 
2815
                output += wrapped(key, help, info)
3667
2816
        if len(deprecated_pairs) > 0:
3668
 
            other_output += "\nDeprecated formats are shown below.\n\n"
 
2817
            output += "Deprecated formats are shown below.\n\n"
3669
2818
            for key, help in deprecated_pairs:
3670
2819
                info = self.get_info(key)
3671
 
                other_output += wrapped(key, help, info)
3672
 
        else:
3673
 
            other_output += \
3674
 
                "\nNo deprecated formats are available.\n\n"
3675
 
        other_output += \
3676
 
                "\nSee :doc:`formats-help` for more about storage formats."
 
2820
                output += wrapped(key, help, info)
3677
2821
 
3678
 
        if topic == 'other-formats':
3679
 
            return other_output
3680
 
        else:
3681
 
            return output
 
2822
        return output
3682
2823
 
3683
2824
 
3684
2825
class RepositoryAcquisitionPolicy(object):
3713
2854
            try:
3714
2855
                stack_on = urlutils.rebase_url(self._stack_on,
3715
2856
                    self._stack_on_pwd,
3716
 
                    branch.user_url)
 
2857
                    branch.bzrdir.root_transport.base)
3717
2858
            except errors.InvalidRebaseURLs:
3718
2859
                stack_on = self._get_full_stack_on()
3719
2860
        try:
3720
2861
            branch.set_stacked_on_url(stack_on)
3721
 
        except (errors.UnstackableBranchFormat,
3722
 
                errors.UnstackableRepositoryFormat):
 
2862
        except errors.UnstackableBranchFormat:
3723
2863
            if self._require_stacking:
3724
2864
                raise
3725
2865
 
3726
 
    def requires_stacking(self):
3727
 
        """Return True if this policy requires stacking."""
3728
 
        return self._stack_on is not None and self._require_stacking
3729
 
 
3730
2866
    def _get_full_stack_on(self):
3731
2867
        """Get a fully-qualified URL for the stack_on location."""
3732
2868
        if self._stack_on is None:
3736
2872
        else:
3737
2873
            return urlutils.join(self._stack_on_pwd, self._stack_on)
3738
2874
 
3739
 
    def _add_fallback(self, repository, possible_transports=None):
 
2875
    def _add_fallback(self, repository):
3740
2876
        """Add a fallback to the supplied repository, if stacking is set."""
3741
2877
        stack_on = self._get_full_stack_on()
3742
2878
        if stack_on is None:
3743
2879
            return
3744
 
        try:
3745
 
            stacked_dir = BzrDir.open(stack_on,
3746
 
                                      possible_transports=possible_transports)
3747
 
        except errors.JailBreak:
3748
 
            # We keep the stacking details, but we are in the server code so
3749
 
            # actually stacking is not needed.
3750
 
            return
 
2880
        stacked_dir = BzrDir.open(stack_on)
3751
2881
        try:
3752
2882
            stacked_repo = stacked_dir.open_branch().repository
3753
2883
        except errors.NotBranchError:
3757
2887
        except errors.UnstackableRepositoryFormat:
3758
2888
            if self._require_stacking:
3759
2889
                raise
3760
 
        else:
3761
 
            self._require_stacking = True
3762
2890
 
3763
2891
    def acquire_repository(self, make_working_trees=None, shared=False):
3764
2892
        """Acquire a repository for this bzrdir.
3768
2896
        :param make_working_trees: If creating a repository, set
3769
2897
            make_working_trees to this value (if non-None)
3770
2898
        :param shared: If creating a repository, make it shared if True
3771
 
        :return: A repository, is_new_flag (True if the repository was
3772
 
            created).
 
2899
        :return: A repository
3773
2900
        """
3774
2901
        raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3775
2902
 
3795
2922
 
3796
2923
        Creates the desired repository in the bzrdir we already have.
3797
2924
        """
3798
 
        stack_on = self._get_full_stack_on()
3799
 
        if stack_on:
3800
 
            format = self._bzrdir._format
3801
 
            format.require_stacking(stack_on=stack_on,
3802
 
                                    possible_transports=[self._bzrdir.root_transport])
3803
 
            if not self._require_stacking:
3804
 
                # We have picked up automatic stacking somewhere.
3805
 
                note('Using default stacking branch %s at %s', self._stack_on,
3806
 
                    self._stack_on_pwd)
3807
2925
        repository = self._bzrdir.create_repository(shared=shared)
3808
 
        self._add_fallback(repository,
3809
 
                           possible_transports=[self._bzrdir.transport])
 
2926
        self._add_fallback(repository)
3810
2927
        if make_working_trees is not None:
3811
2928
            repository.set_make_working_trees(make_working_trees)
3812
 
        return repository, True
 
2929
        return repository
3813
2930
 
3814
2931
 
3815
2932
class UseExistingRepository(RepositoryAcquisitionPolicy):
3831
2948
    def acquire_repository(self, make_working_trees=None, shared=False):
3832
2949
        """Implementation of RepositoryAcquisitionPolicy.acquire_repository
3833
2950
 
3834
 
        Returns an existing repository to use.
 
2951
        Returns an existing repository to use
3835
2952
        """
3836
 
        self._add_fallback(self._repository,
3837
 
                       possible_transports=[self._repository.bzrdir.transport])
3838
 
        return self._repository, False
3839
 
 
3840
 
 
3841
 
# Please register new formats after old formats so that formats
3842
 
# appear in chronological order and format descriptions can build
3843
 
# on previous ones.
 
2953
        self._add_fallback(self._repository)
 
2954
        return self._repository
 
2955
 
 
2956
 
3844
2957
format_registry = BzrDirFormatRegistry()
3845
 
# The pre-0.8 formats have their repository format network name registered in
3846
 
# repository.py. MetaDir formats have their repository format network name
3847
 
# inferred from their disk format string.
3848
2958
format_registry.register('weave', BzrDirFormat6,
3849
2959
    'Pre-0.8 format.  Slower than knit and does not'
3850
2960
    ' support checkouts or shared repositories.',
3851
 
    hidden=True,
3852
2961
    deprecated=True)
 
2962
format_registry.register_metadir('knit',
 
2963
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
 
2964
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
 
2965
    branch_format='bzrlib.branch.BzrBranchFormat5',
 
2966
    tree_format='bzrlib.workingtree.WorkingTreeFormat3')
3853
2967
format_registry.register_metadir('metaweave',
3854
2968
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3855
2969
    'Transitional format in 0.8.  Slower than knit.',
3856
2970
    branch_format='bzrlib.branch.BzrBranchFormat5',
3857
2971
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3858
 
    hidden=True,
3859
 
    deprecated=True)
3860
 
format_registry.register_metadir('knit',
3861
 
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3862
 
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
3863
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
3864
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3865
 
    hidden=True,
3866
2972
    deprecated=True)
3867
2973
format_registry.register_metadir('dirstate',
3868
2974
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3872
2978
    # this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3873
2979
    # directly from workingtree_4 triggers a circular import.
3874
2980
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3875
 
    hidden=True,
3876
 
    deprecated=True)
 
2981
    )
3877
2982
format_registry.register_metadir('dirstate-tags',
3878
2983
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3879
2984
    help='New in 0.15: Fast local operations and improved scaling for '
3881
2986
        ' Incompatible with bzr < 0.15.',
3882
2987
    branch_format='bzrlib.branch.BzrBranchFormat6',
3883
2988
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3884
 
    hidden=True,
3885
 
    deprecated=True)
 
2989
    )
3886
2990
format_registry.register_metadir('rich-root',
3887
2991
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3888
2992
    help='New in 1.0.  Better handling of tree roots.  Incompatible with'
3889
 
        ' bzr < 1.0.',
 
2993
        ' bzr < 1.0',
3890
2994
    branch_format='bzrlib.branch.BzrBranchFormat6',
3891
2995
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3892
 
    hidden=True,
3893
 
    deprecated=True)
 
2996
    )
3894
2997
format_registry.register_metadir('dirstate-with-subtree',
3895
2998
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3896
2999
    help='New in 0.15: Fast local operations and improved scaling for '
3906
3009
    help='New in 0.92: Pack-based format with data compatible with '
3907
3010
        'dirstate-tags format repositories. Interoperates with '
3908
3011
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3909
 
        ,
 
3012
        'Previously called knitpack-experimental.  '
 
3013
        'For more information, see '
 
3014
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3910
3015
    branch_format='bzrlib.branch.BzrBranchFormat6',
3911
3016
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3912
3017
    )
3915
3020
    help='New in 0.92: Pack-based format with data compatible with '
3916
3021
        'dirstate-with-subtree format repositories. Interoperates with '
3917
3022
        'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3918
 
        ,
 
3023
        'Previously called knitpack-experimental.  '
 
3024
        'For more information, see '
 
3025
        'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3919
3026
    branch_format='bzrlib.branch.BzrBranchFormat6',
3920
3027
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3921
3028
    hidden=True,
3923
3030
    )
3924
3031
format_registry.register_metadir('rich-root-pack',
3925
3032
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3926
 
    help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3927
 
         '(needed for bzr-svn and bzr-git).',
 
3033
    help='New in 1.0: Pack-based format with data compatible with '
 
3034
        'rich-root format repositories. Incompatible with'
 
3035
        ' bzr < 1.0',
3928
3036
    branch_format='bzrlib.branch.BzrBranchFormat6',
3929
3037
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3930
 
    hidden=True,
3931
3038
    )
3932
3039
format_registry.register_metadir('1.6',
3933
3040
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3934
 
    help='A format that allows a branch to indicate that there is another '
3935
 
         '(stacked) repository that should be used to access data that is '
3936
 
         'not present locally.',
 
3041
    help='A branch and pack based repository that supports stacking. ',
3937
3042
    branch_format='bzrlib.branch.BzrBranchFormat7',
3938
3043
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3939
 
    hidden=True,
3940
3044
    )
3941
3045
format_registry.register_metadir('1.6.1-rich-root',
3942
3046
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3943
 
    help='A variant of 1.6 that supports rich-root data '
3944
 
         '(needed for bzr-svn and bzr-git).',
3945
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3946
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3947
 
    hidden=True,
3948
 
    )
3949
 
format_registry.register_metadir('1.9',
3950
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3951
 
    help='A repository format using B+tree indexes. These indexes '
3952
 
         'are smaller in size, have smarter caching and provide faster '
3953
 
         'performance for most operations.',
3954
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3955
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3956
 
    hidden=True,
3957
 
    )
3958
 
format_registry.register_metadir('1.9-rich-root',
3959
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3960
 
    help='A variant of 1.9 that supports rich-root data '
3961
 
         '(needed for bzr-svn and bzr-git).',
3962
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3963
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3964
 
    hidden=True,
3965
 
    )
3966
 
format_registry.register_metadir('1.14',
3967
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3968
 
    help='A working-tree format that supports content filtering.',
3969
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3970
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3971
 
    )
3972
 
format_registry.register_metadir('1.14-rich-root',
3973
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3974
 
    help='A variant of 1.14 that supports rich-root data '
3975
 
         '(needed for bzr-svn and bzr-git).',
3976
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3977
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3978
 
    )
3979
 
# The following un-numbered 'development' formats should always just be aliases.
3980
 
format_registry.register_metadir('development-rich-root',
3981
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3982
 
    help='Current development format. Supports rich roots. Can convert data '
3983
 
        'to and from rich-root-pack (and anything compatible with '
3984
 
        'rich-root-pack) format repositories. Repositories and branches in '
3985
 
        'this format can only be read by bzr.dev. Please read '
3986
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
3047
    help='A branch and pack based repository that supports stacking '
 
3048
         'and rich root data (needed for bzr-svn). ',
 
3049
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3050
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3051
    )
 
3052
# The following two formats should always just be aliases.
 
3053
format_registry.register_metadir('development',
 
3054
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1',
 
3055
    help='Current development format. Can convert data to and from pack-0.92 '
 
3056
        '(and anything compatible with pack-0.92) format repositories. '
 
3057
        'Repositories and branches in this format can only be read by bzr.dev. '
 
3058
        'Please read '
 
3059
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3987
3060
        'before use.',
3988
3061
    branch_format='bzrlib.branch.BzrBranchFormat7',
3989
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3062
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3990
3063
    experimental=True,
3991
3064
    alias=True,
3992
 
    hidden=True,
3993
3065
    )
3994
3066
format_registry.register_metadir('development-subtree',
3995
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
 
3067
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1Subtree',
3996
3068
    help='Current development format, subtree variant. Can convert data to and '
3997
3069
        'from pack-0.92-subtree (and anything compatible with '
3998
3070
        'pack-0.92-subtree) format repositories. Repositories and branches in '
3999
3071
        'this format can only be read by bzr.dev. Please read '
4000
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4001
 
        'before use.',
4002
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4003
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4004
 
    experimental=True,
4005
 
    hidden=True,
4006
 
    alias=False, # Restore to being an alias when an actual development subtree format is added
4007
 
                 # This current non-alias status is simply because we did not introduce a
4008
 
                 # chk based subtree format.
4009
 
    )
4010
 
 
4011
 
# And the development formats above will have aliased one of the following:
4012
 
format_registry.register_metadir('development6-rich-root',
4013
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
4014
 
    help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
4015
 
        'Please read '
4016
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4017
 
        'before use.',
4018
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4019
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4020
 
    hidden=True,
4021
 
    experimental=True,
4022
 
    )
4023
 
 
4024
 
format_registry.register_metadir('development7-rich-root',
4025
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
4026
 
    help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
4027
 
        'rich roots. Please read '
4028
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
4029
 
        'before use.',
4030
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4031
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4032
 
    hidden=True,
4033
 
    experimental=True,
4034
 
    )
4035
 
 
4036
 
format_registry.register_metadir('2a',
4037
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4038
 
    help='First format for bzr 2.0 series.\n'
4039
 
        'Uses group-compress storage.\n'
4040
 
        'Provides rich roots which are a one-way transition.\n',
4041
 
        # 'storage in packs, 255-way hashed CHK inventory, bencode revision, group compress, '
4042
 
        # 'rich roots. Supported by bzr 1.16 and later.',
4043
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4044
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
4045
 
    experimental=True,
4046
 
    )
4047
 
 
4048
 
# The following format should be an alias for the rich root equivalent 
4049
 
# of the default format
4050
 
format_registry.register_metadir('default-rich-root',
4051
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
4052
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
4053
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
3072
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3073
        'before use.',
 
3074
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3075
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3076
    experimental=True,
4054
3077
    alias=True,
4055
 
    hidden=True,
4056
 
    help='Same as 2a.')
4057
 
 
 
3078
    )
 
3079
# And the development formats which the will have aliased one of follow:
 
3080
format_registry.register_metadir('development1',
 
3081
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1',
 
3082
    help='A branch and pack based repository that supports stacking. '
 
3083
        'Please read '
 
3084
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3085
        'before use.',
 
3086
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3087
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3088
    hidden=True,
 
3089
    experimental=True,
 
3090
    )
 
3091
format_registry.register_metadir('development1-subtree',
 
3092
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1Subtree',
 
3093
    help='A branch and pack based repository that supports stacking. '
 
3094
        'Please read '
 
3095
        'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
 
3096
        'before use.',
 
3097
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
3098
    tree_format='bzrlib.workingtree.WorkingTreeFormat4',
 
3099
    hidden=True,
 
3100
    experimental=True,
 
3101
    )
4058
3102
# The current format that is made on 'bzr init'.
4059
 
format_registry.set_default('2a')
 
3103
format_registry.set_default('pack-0.92')