~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bzrdir.py

merge trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
25
25
objects returned.
26
26
"""
27
27
 
28
 
# TODO: Move old formats into a plugin to make this file smaller.
29
 
 
30
 
import os
31
28
import sys
32
 
import warnings
33
29
 
34
30
from bzrlib.lazy_import import lazy_import
35
31
lazy_import(globals(), """
37
33
 
38
34
import bzrlib
39
35
from bzrlib import (
40
 
    branch,
 
36
    cleanup,
41
37
    config,
42
38
    controldir,
43
39
    errors,
 
40
    fetch,
44
41
    graph,
45
42
    lockable_files,
46
43
    lockdir,
47
44
    osutils,
 
45
    pyutils,
48
46
    remote,
49
47
    repository,
50
48
    revision as _mod_revision,
 
49
    transport as _mod_transport,
51
50
    ui,
52
51
    urlutils,
53
52
    versionedfile,
54
53
    win32utils,
55
54
    workingtree,
56
55
    workingtree_4,
57
 
    xml4,
58
 
    xml5,
59
 
    )
60
 
from bzrlib.osutils import (
61
 
    sha_string,
62
 
    )
63
 
from bzrlib.push import (
64
 
    PushResult,
65
56
    )
66
57
from bzrlib.repofmt import pack_repo
67
 
from bzrlib.smart.client import _SmartClient
68
 
from bzrlib.store.versioned import WeaveStore
69
 
from bzrlib.transactions import WriteTransaction
70
58
from bzrlib.transport import (
71
59
    do_catching_redirections,
72
 
    get_transport,
73
60
    local,
74
61
    )
75
 
from bzrlib.weave import Weave
76
62
""")
77
63
 
78
64
from bzrlib.trace import (
79
65
    mutter,
80
66
    note,
81
 
    warning,
82
67
    )
83
68
 
84
69
from bzrlib import (
85
70
    hooks,
86
71
    registry,
87
 
    symbol_versioning,
 
72
    )
 
73
from bzrlib.symbol_versioning import (
 
74
    deprecated_in,
 
75
    deprecated_method,
88
76
    )
89
77
 
90
78
 
137
125
            # No repo, no problem.
138
126
            pass
139
127
 
140
 
    @staticmethod
141
 
    def _check_supported(format, allow_unsupported,
142
 
        recommend_upgrade=True,
143
 
        basedir=None):
144
 
        """Give an error or warning on old formats.
145
 
 
146
 
        :param format: may be any kind of format - workingtree, branch,
147
 
        or repository.
148
 
 
149
 
        :param allow_unsupported: If true, allow opening
150
 
        formats that are strongly deprecated, and which may
151
 
        have limited functionality.
152
 
 
153
 
        :param recommend_upgrade: If true (default), warn
154
 
        the user through the ui object that they may wish
155
 
        to upgrade the object.
156
 
        """
157
 
        # TODO: perhaps move this into a base Format class; it's not BzrDir
158
 
        # specific. mbp 20070323
159
 
        if not allow_unsupported and not format.is_supported():
160
 
            # see open_downlevel to open legacy branches.
161
 
            raise errors.UnsupportedFormatError(format=format)
162
 
        if recommend_upgrade \
163
 
            and getattr(format, 'upgrade_recommended', False):
164
 
            ui.ui_factory.recommend_upgrade(
165
 
                format.get_format_description(),
166
 
                basedir)
167
 
 
168
128
    def clone_on_transport(self, transport, revision_id=None,
169
129
        force_new_repo=False, preserve_stacking=False, stacked_on=None,
170
 
        create_prefix=False, use_existing_dir=True):
 
130
        create_prefix=False, use_existing_dir=True, no_tree=False):
171
131
        """Clone this bzrdir and its contents to transport verbatim.
172
132
 
173
133
        :param transport: The transport for the location to produce the clone
182
142
        :param create_prefix: Create any missing directories leading up to
183
143
            to_transport.
184
144
        :param use_existing_dir: Use an existing directory if one exists.
 
145
        :param no_tree: If set to true prevents creation of a working tree.
185
146
        """
186
147
        # Overview: put together a broad description of what we want to end up
187
148
        # with; then make as few api calls as possible to do it.
215
176
        # we should look up the policy needs first, or just use it as a hint,
216
177
        # or something.
217
178
        if local_repo:
218
 
            make_working_trees = local_repo.make_working_trees()
 
179
            make_working_trees = local_repo.make_working_trees() and not no_tree
219
180
            want_shared = local_repo.is_shared()
220
181
            repo_format_name = format.repository_format.network_name()
221
182
        else:
270
231
    # TODO: This should be given a Transport, and should chdir up; otherwise
271
232
    # this will open a new connection.
272
233
    def _make_tail(self, url):
273
 
        t = get_transport(url)
 
234
        t = _mod_transport.get_transport(url)
274
235
        t.ensure_base()
275
236
 
276
237
    @staticmethod
429
390
        policy = self.determine_repository_policy(force_new_repo)
430
391
        return policy.acquire_repository()[0]
431
392
 
 
393
    def _find_source_repo(self, add_cleanup, source_branch):
 
394
        """Find the source branch and repo for a sprout operation.
 
395
        
 
396
        This is helper intended for use by _sprout.
 
397
 
 
398
        :returns: (source_branch, source_repository).  Either or both may be
 
399
            None.  If not None, they will be read-locked (and their unlock(s)
 
400
            scheduled via the add_cleanup param).
 
401
        """
 
402
        if source_branch is not None:
 
403
            add_cleanup(source_branch.lock_read().unlock)
 
404
            return source_branch, source_branch.repository
 
405
        try:
 
406
            source_branch = self.open_branch()
 
407
            source_repository = source_branch.repository
 
408
        except errors.NotBranchError:
 
409
            source_branch = None
 
410
            try:
 
411
                source_repository = self.open_repository()
 
412
            except errors.NoRepositoryPresent:
 
413
                source_repository = None
 
414
            else:
 
415
                add_cleanup(source_repository.lock_read().unlock)
 
416
        else:
 
417
            add_cleanup(source_branch.lock_read().unlock)
 
418
        return source_branch, source_repository
 
419
 
 
420
    def sprout(self, url, revision_id=None, force_new_repo=False,
 
421
               recurse='down', possible_transports=None,
 
422
               accelerator_tree=None, hardlink=False, stacked=False,
 
423
               source_branch=None, create_tree_if_local=True):
 
424
        """Create a copy of this controldir prepared for use as a new line of
 
425
        development.
 
426
 
 
427
        If url's last component does not exist, it will be created.
 
428
 
 
429
        Attributes related to the identity of the source branch like
 
430
        branch nickname will be cleaned, a working tree is created
 
431
        whether one existed before or not; and a local branch is always
 
432
        created.
 
433
 
 
434
        if revision_id is not None, then the clone operation may tune
 
435
            itself to download less data.
 
436
        :param accelerator_tree: A tree which can be used for retrieving file
 
437
            contents more quickly than the revision tree, i.e. a workingtree.
 
438
            The revision tree will be used for cases where accelerator_tree's
 
439
            content is different.
 
440
        :param hardlink: If true, hard-link files from accelerator_tree,
 
441
            where possible.
 
442
        :param stacked: If true, create a stacked branch referring to the
 
443
            location of this control directory.
 
444
        :param create_tree_if_local: If true, a working-tree will be created
 
445
            when working locally.
 
446
        """
 
447
        operation = cleanup.OperationWithCleanups(self._sprout)
 
448
        return operation.run(url, revision_id=revision_id,
 
449
            force_new_repo=force_new_repo, recurse=recurse,
 
450
            possible_transports=possible_transports,
 
451
            accelerator_tree=accelerator_tree, hardlink=hardlink,
 
452
            stacked=stacked, source_branch=source_branch,
 
453
            create_tree_if_local=create_tree_if_local)
 
454
 
 
455
    def _sprout(self, op, url, revision_id=None, force_new_repo=False,
 
456
               recurse='down', possible_transports=None,
 
457
               accelerator_tree=None, hardlink=False, stacked=False,
 
458
               source_branch=None, create_tree_if_local=True):
 
459
        add_cleanup = op.add_cleanup
 
460
        fetch_spec_factory = fetch.FetchSpecFactory()
 
461
        if revision_id is not None:
 
462
            fetch_spec_factory.add_revision_ids([revision_id])
 
463
            fetch_spec_factory.source_branch_stop_revision_id = revision_id
 
464
        target_transport = _mod_transport.get_transport(url,
 
465
            possible_transports)
 
466
        target_transport.ensure_base()
 
467
        cloning_format = self.cloning_metadir(stacked)
 
468
        # Create/update the result branch
 
469
        result = cloning_format.initialize_on_transport(target_transport)
 
470
        source_branch, source_repository = self._find_source_repo(
 
471
            add_cleanup, source_branch)
 
472
        fetch_spec_factory.source_branch = source_branch
 
473
        # if a stacked branch wasn't requested, we don't create one
 
474
        # even if the origin was stacked
 
475
        if stacked and source_branch is not None:
 
476
            stacked_branch_url = self.root_transport.base
 
477
        else:
 
478
            stacked_branch_url = None
 
479
        repository_policy = result.determine_repository_policy(
 
480
            force_new_repo, stacked_branch_url, require_stacking=stacked)
 
481
        result_repo, is_new_repo = repository_policy.acquire_repository()
 
482
        add_cleanup(result_repo.lock_write().unlock)
 
483
        fetch_spec_factory.source_repo = source_repository
 
484
        fetch_spec_factory.target_repo = result_repo
 
485
        if stacked or (len(result_repo._fallback_repositories) != 0):
 
486
            target_repo_kind = fetch.TargetRepoKinds.STACKED
 
487
        elif is_new_repo:
 
488
            target_repo_kind = fetch.TargetRepoKinds.EMPTY
 
489
        else:
 
490
            target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
491
        fetch_spec_factory.target_repo_kind = target_repo_kind
 
492
        if source_repository is not None:
 
493
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
494
            result_repo.fetch(source_repository, fetch_spec=fetch_spec)
 
495
 
 
496
        if source_branch is None:
 
497
            # this is for sprouting a controldir without a branch; is that
 
498
            # actually useful?
 
499
            # Not especially, but it's part of the contract.
 
500
            result_branch = result.create_branch()
 
501
        else:
 
502
            result_branch = source_branch.sprout(result,
 
503
                revision_id=revision_id, repository_policy=repository_policy,
 
504
                repository=result_repo)
 
505
        mutter("created new branch %r" % (result_branch,))
 
506
 
 
507
        # Create/update the result working tree
 
508
        if (create_tree_if_local and
 
509
            isinstance(target_transport, local.LocalTransport) and
 
510
            (result_repo is None or result_repo.make_working_trees())):
 
511
            wt = result.create_workingtree(accelerator_tree=accelerator_tree,
 
512
                hardlink=hardlink, from_branch=result_branch)
 
513
            wt.lock_write()
 
514
            try:
 
515
                if wt.path2id('') is None:
 
516
                    try:
 
517
                        wt.set_root_id(self.open_workingtree.get_root_id())
 
518
                    except errors.NoWorkingTree:
 
519
                        pass
 
520
            finally:
 
521
                wt.unlock()
 
522
        else:
 
523
            wt = None
 
524
        if recurse == 'down':
 
525
            basis = None
 
526
            if wt is not None:
 
527
                basis = wt.basis_tree()
 
528
            elif result_branch is not None:
 
529
                basis = result_branch.basis_tree()
 
530
            elif source_branch is not None:
 
531
                basis = source_branch.basis_tree()
 
532
            if basis is not None:
 
533
                add_cleanup(basis.lock_read().unlock)
 
534
                subtrees = basis.iter_references()
 
535
            else:
 
536
                subtrees = []
 
537
            for path, file_id in subtrees:
 
538
                target = urlutils.join(url, urlutils.escape(path))
 
539
                sublocation = source_branch.reference_parent(file_id, path)
 
540
                sublocation.bzrdir.sprout(target,
 
541
                    basis.get_reference_revision(file_id, path),
 
542
                    force_new_repo=force_new_repo, recurse=recurse,
 
543
                    stacked=stacked)
 
544
        return result
 
545
 
 
546
 
 
547
 
432
548
    @staticmethod
433
549
    def create_branch_convenience(base, force_new_repo=False,
434
550
                                  force_new_tree=None, format=None,
460
576
        """
461
577
        if force_new_tree:
462
578
            # check for non local urls
463
 
            t = get_transport(base, possible_transports)
 
579
            t = _mod_transport.get_transport(base, possible_transports)
464
580
            if not isinstance(t, local.LocalTransport):
465
581
                raise errors.NotLocalUrl(base)
466
582
        bzrdir = BzrDir.create(base, format, possible_transports)
488
604
        :param format: Override for the bzrdir format to create.
489
605
        :return: The WorkingTree object.
490
606
        """
491
 
        t = get_transport(base)
 
607
        t = _mod_transport.get_transport(base)
492
608
        if not isinstance(t, local.LocalTransport):
493
609
            raise errors.NotLocalUrl(base)
494
610
        bzrdir = BzrDir.create_branch_and_repo(base,
496
612
                                               format=format).bzrdir
497
613
        return bzrdir.create_workingtree()
498
614
 
 
615
    @deprecated_method(deprecated_in((2, 3, 0)))
499
616
    def generate_backup_name(self, base):
500
 
        """Generate a non-existing backup file name based on base."""
501
 
        counter = 1
502
 
        name = "%s.~%d~" % (base, counter)
503
 
        while self.root_transport.has(name):
504
 
            counter += 1
505
 
            name = "%s.~%d~" % (base, counter)
506
 
        return name
 
617
        return self._available_backup_name(base)
 
618
 
 
619
    def _available_backup_name(self, base):
 
620
        """Find a non-existing backup file name based on base.
 
621
 
 
622
        See bzrlib.osutils.available_backup_name about race conditions.
 
623
        """
 
624
        return osutils.available_backup_name(base, self.root_transport.has)
507
625
 
508
626
    def backup_bzrdir(self):
509
627
        """Backup this bzr control directory.
511
629
        :return: Tuple with old path name and new path name
512
630
        """
513
631
 
514
 
        backup_dir=self.generate_backup_name('backup.bzr')
515
632
        pb = ui.ui_factory.nested_progress_bar()
516
633
        try:
517
 
            # FIXME: bug 300001 -- the backup fails if the backup directory
518
 
            # already exists, but it should instead either remove it or make
519
 
            # a new backup directory.
520
 
            #
521
634
            old_path = self.root_transport.abspath('.bzr')
 
635
            backup_dir = self._available_backup_name('backup.bzr')
522
636
            new_path = self.root_transport.abspath(backup_dir)
523
 
            ui.ui_factory.note('making backup of %s\n  to %s' % (old_path, new_path,))
 
637
            ui.ui_factory.note('making backup of %s\n  to %s'
 
638
                               % (old_path, new_path,))
524
639
            self.root_transport.copy_tree('.bzr', backup_dir)
525
640
            return (old_path, new_path)
526
641
        finally:
709
824
 
710
825
        :param _unsupported: a private parameter to the BzrDir class.
711
826
        """
712
 
        t = get_transport(base, possible_transports=possible_transports)
 
827
        t = _mod_transport.get_transport(base, possible_transports)
713
828
        return BzrDir.open_from_transport(t, _unsupported=_unsupported)
714
829
 
715
830
    @staticmethod
744
859
        except errors.TooManyRedirections:
745
860
            raise errors.NotBranchError(base)
746
861
 
747
 
        BzrDir._check_supported(format, _unsupported)
 
862
        format.check_support_status(_unsupported)
748
863
        return format.open(transport, _found=True)
749
864
 
750
865
    @staticmethod
754
869
        :param url: url to search from.
755
870
        See open_containing_from_transport for more detail.
756
871
        """
757
 
        transport = get_transport(url, possible_transports)
 
872
        transport = _mod_transport.get_transport(url, possible_transports)
758
873
        return BzrDir.open_containing_from_transport(transport)
759
874
 
760
875
    @staticmethod
916
1031
        if cls is not BzrDir:
917
1032
            raise AssertionError("BzrDir.create always creates the"
918
1033
                "default format, not one of %r" % cls)
919
 
        t = get_transport(base, possible_transports)
 
1034
        t = _mod_transport.get_transport(base, possible_transports)
920
1035
        t.ensure_base()
921
1036
        if format is None:
922
1037
            format = controldir.ControlDirFormat.get_default_format()
923
1038
        return format.initialize_on_transport(t)
924
1039
 
 
1040
    def get_branch_transport(self, branch_format, name=None):
 
1041
        """Get the transport for use by branch format in this BzrDir.
 
1042
 
 
1043
        Note that bzr dirs that do not support format strings will raise
 
1044
        IncompatibleFormat if the branch format they are given has
 
1045
        a format string, and vice versa.
 
1046
 
 
1047
        If branch_format is None, the transport is returned with no
 
1048
        checking. If it is not None, then the returned transport is
 
1049
        guaranteed to point to an existing directory ready for use.
 
1050
        """
 
1051
        raise NotImplementedError(self.get_branch_transport)
 
1052
 
 
1053
    def get_repository_transport(self, repository_format):
 
1054
        """Get the transport for use by repository format in this BzrDir.
 
1055
 
 
1056
        Note that bzr dirs that do not support format strings will raise
 
1057
        IncompatibleFormat if the repository format they are given has
 
1058
        a format string, and vice versa.
 
1059
 
 
1060
        If repository_format is None, the transport is returned with no
 
1061
        checking. If it is not None, then the returned transport is
 
1062
        guaranteed to point to an existing directory ready for use.
 
1063
        """
 
1064
        raise NotImplementedError(self.get_repository_transport)
 
1065
 
 
1066
    def get_workingtree_transport(self, tree_format):
 
1067
        """Get the transport for use by workingtree format in this BzrDir.
 
1068
 
 
1069
        Note that bzr dirs that do not support format strings will raise
 
1070
        IncompatibleFormat if the workingtree format they are given has a
 
1071
        format string, and vice versa.
 
1072
 
 
1073
        If workingtree_format is None, the transport is returned with no
 
1074
        checking. If it is not None, then the returned transport is
 
1075
        guaranteed to point to an existing directory ready for use.
 
1076
        """
 
1077
        raise NotImplementedError(self.get_workingtree_transport)
925
1078
 
926
1079
 
927
1080
class BzrDirHooks(hooks.Hooks):
979
1132
                self.bzrdir)
980
1133
 
981
1134
 
982
 
class BzrDirPreSplitOut(BzrDir):
983
 
    """A common class for the all-in-one formats."""
984
 
 
985
 
    def __init__(self, _transport, _format):
986
 
        """See BzrDir.__init__."""
987
 
        super(BzrDirPreSplitOut, self).__init__(_transport, _format)
988
 
        self._control_files = lockable_files.LockableFiles(
989
 
                                            self.get_branch_transport(None),
990
 
                                            self._format._lock_file_name,
991
 
                                            self._format._lock_class)
992
 
 
993
 
    def break_lock(self):
994
 
        """Pre-splitout bzrdirs do not suffer from stale locks."""
995
 
        raise NotImplementedError(self.break_lock)
996
 
 
997
 
    def cloning_metadir(self, require_stacking=False):
998
 
        """Produce a metadir suitable for cloning with."""
999
 
        if require_stacking:
1000
 
            return controldir.format_registry.make_bzrdir('1.6')
1001
 
        return self._format.__class__()
1002
 
 
1003
 
    def clone(self, url, revision_id=None, force_new_repo=False,
1004
 
              preserve_stacking=False):
1005
 
        """See BzrDir.clone().
1006
 
 
1007
 
        force_new_repo has no effect, since this family of formats always
1008
 
        require a new repository.
1009
 
        preserve_stacking has no effect, since no source branch using this
1010
 
        family of formats can be stacked, so there is no stacking to preserve.
1011
 
        """
1012
 
        self._make_tail(url)
1013
 
        result = self._format._initialize_for_clone(url)
1014
 
        self.open_repository().clone(result, revision_id=revision_id)
1015
 
        from_branch = self.open_branch()
1016
 
        from_branch.clone(result, revision_id=revision_id)
1017
 
        try:
1018
 
            tree = self.open_workingtree()
1019
 
        except errors.NotLocalUrl:
1020
 
            # make a new one, this format always has to have one.
1021
 
            result._init_workingtree()
1022
 
        else:
1023
 
            tree.clone(result)
1024
 
        return result
1025
 
 
1026
 
    def create_branch(self, name=None):
1027
 
        """See BzrDir.create_branch."""
1028
 
        return self._format.get_branch_format().initialize(self, name=name)
1029
 
 
1030
 
    def destroy_branch(self, name=None):
1031
 
        """See BzrDir.destroy_branch."""
1032
 
        raise errors.UnsupportedOperation(self.destroy_branch, self)
1033
 
 
1034
 
    def create_repository(self, shared=False):
1035
 
        """See BzrDir.create_repository."""
1036
 
        if shared:
1037
 
            raise errors.IncompatibleFormat('shared repository', self._format)
1038
 
        return self.open_repository()
1039
 
 
1040
 
    def destroy_repository(self):
1041
 
        """See BzrDir.destroy_repository."""
1042
 
        raise errors.UnsupportedOperation(self.destroy_repository, self)
1043
 
 
1044
 
    def create_workingtree(self, revision_id=None, from_branch=None,
1045
 
                           accelerator_tree=None, hardlink=False):
1046
 
        """See BzrDir.create_workingtree."""
1047
 
        # The workingtree is sometimes created when the bzrdir is created,
1048
 
        # but not when cloning.
1049
 
 
1050
 
        # this looks buggy but is not -really-
1051
 
        # because this format creates the workingtree when the bzrdir is
1052
 
        # created
1053
 
        # clone and sprout will have set the revision_id
1054
 
        # and that will have set it for us, its only
1055
 
        # specific uses of create_workingtree in isolation
1056
 
        # that can do wonky stuff here, and that only
1057
 
        # happens for creating checkouts, which cannot be
1058
 
        # done on this format anyway. So - acceptable wart.
1059
 
        if hardlink:
1060
 
            warning("can't support hardlinked working trees in %r"
1061
 
                % (self,))
1062
 
        try:
1063
 
            result = self.open_workingtree(recommend_upgrade=False)
1064
 
        except errors.NoSuchFile:
1065
 
            result = self._init_workingtree()
1066
 
        if revision_id is not None:
1067
 
            if revision_id == _mod_revision.NULL_REVISION:
1068
 
                result.set_parent_ids([])
1069
 
            else:
1070
 
                result.set_parent_ids([revision_id])
1071
 
        return result
1072
 
 
1073
 
    def _init_workingtree(self):
1074
 
        from bzrlib.workingtree import WorkingTreeFormat2
1075
 
        try:
1076
 
            return WorkingTreeFormat2().initialize(self)
1077
 
        except errors.NotLocalUrl:
1078
 
            # Even though we can't access the working tree, we need to
1079
 
            # create its control files.
1080
 
            return WorkingTreeFormat2()._stub_initialize_on_transport(
1081
 
                self.transport, self._control_files._file_mode)
1082
 
 
1083
 
    def destroy_workingtree(self):
1084
 
        """See BzrDir.destroy_workingtree."""
1085
 
        raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1086
 
 
1087
 
    def destroy_workingtree_metadata(self):
1088
 
        """See BzrDir.destroy_workingtree_metadata."""
1089
 
        raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1090
 
                                          self)
1091
 
 
1092
 
    def get_branch_transport(self, branch_format, name=None):
1093
 
        """See BzrDir.get_branch_transport()."""
1094
 
        if name is not None:
1095
 
            raise errors.NoColocatedBranchSupport(self)
1096
 
        if branch_format is None:
1097
 
            return self.transport
1098
 
        try:
1099
 
            branch_format.get_format_string()
1100
 
        except NotImplementedError:
1101
 
            return self.transport
1102
 
        raise errors.IncompatibleFormat(branch_format, self._format)
1103
 
 
1104
 
    def get_repository_transport(self, repository_format):
1105
 
        """See BzrDir.get_repository_transport()."""
1106
 
        if repository_format is None:
1107
 
            return self.transport
1108
 
        try:
1109
 
            repository_format.get_format_string()
1110
 
        except NotImplementedError:
1111
 
            return self.transport
1112
 
        raise errors.IncompatibleFormat(repository_format, self._format)
1113
 
 
1114
 
    def get_workingtree_transport(self, workingtree_format):
1115
 
        """See BzrDir.get_workingtree_transport()."""
1116
 
        if workingtree_format is None:
1117
 
            return self.transport
1118
 
        try:
1119
 
            workingtree_format.get_format_string()
1120
 
        except NotImplementedError:
1121
 
            return self.transport
1122
 
        raise errors.IncompatibleFormat(workingtree_format, self._format)
1123
 
 
1124
 
    def needs_format_conversion(self, format=None):
1125
 
        """See BzrDir.needs_format_conversion()."""
1126
 
        # if the format is not the same as the system default,
1127
 
        # an upgrade is needed.
1128
 
        if format is None:
1129
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1130
 
                % 'needs_format_conversion(format=None)')
1131
 
            format = BzrDirFormat.get_default_format()
1132
 
        return not isinstance(self._format, format.__class__)
1133
 
 
1134
 
    def open_branch(self, name=None, unsupported=False,
1135
 
                    ignore_fallbacks=False):
1136
 
        """See BzrDir.open_branch."""
1137
 
        from bzrlib.branch import BzrBranchFormat4
1138
 
        format = BzrBranchFormat4()
1139
 
        self._check_supported(format, unsupported)
1140
 
        return format.open(self, name, _found=True)
1141
 
 
1142
 
    def sprout(self, url, revision_id=None, force_new_repo=False,
1143
 
               possible_transports=None, accelerator_tree=None,
1144
 
               hardlink=False, stacked=False, create_tree_if_local=True,
1145
 
               source_branch=None):
1146
 
        """See BzrDir.sprout()."""
1147
 
        if source_branch is not None:
1148
 
            my_branch = self.open_branch()
1149
 
            if source_branch.base != my_branch.base:
1150
 
                raise AssertionError(
1151
 
                    "source branch %r is not within %r with branch %r" %
1152
 
                    (source_branch, self, my_branch))
1153
 
        if stacked:
1154
 
            raise errors.UnstackableBranchFormat(
1155
 
                self._format, self.root_transport.base)
1156
 
        if not create_tree_if_local:
1157
 
            raise errors.MustHaveWorkingTree(
1158
 
                self._format, self.root_transport.base)
1159
 
        from bzrlib.workingtree import WorkingTreeFormat2
1160
 
        self._make_tail(url)
1161
 
        result = self._format._initialize_for_clone(url)
1162
 
        try:
1163
 
            self.open_repository().clone(result, revision_id=revision_id)
1164
 
        except errors.NoRepositoryPresent:
1165
 
            pass
1166
 
        try:
1167
 
            self.open_branch().sprout(result, revision_id=revision_id)
1168
 
        except errors.NotBranchError:
1169
 
            pass
1170
 
 
1171
 
        # we always want a working tree
1172
 
        WorkingTreeFormat2().initialize(result,
1173
 
                                        accelerator_tree=accelerator_tree,
1174
 
                                        hardlink=hardlink)
1175
 
        return result
1176
 
 
1177
 
 
1178
 
class BzrDir4(BzrDirPreSplitOut):
1179
 
    """A .bzr version 4 control object.
1180
 
 
1181
 
    This is a deprecated format and may be removed after sept 2006.
1182
 
    """
1183
 
 
1184
 
    def create_repository(self, shared=False):
1185
 
        """See BzrDir.create_repository."""
1186
 
        return self._format.repository_format.initialize(self, shared)
1187
 
 
1188
 
    def needs_format_conversion(self, format=None):
1189
 
        """Format 4 dirs are always in need of conversion."""
1190
 
        if format is None:
1191
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1192
 
                % 'needs_format_conversion(format=None)')
1193
 
        return True
1194
 
 
1195
 
    def open_repository(self):
1196
 
        """See BzrDir.open_repository."""
1197
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
1198
 
        return RepositoryFormat4().open(self, _found=True)
1199
 
 
1200
 
 
1201
 
class BzrDir5(BzrDirPreSplitOut):
1202
 
    """A .bzr version 5 control object.
1203
 
 
1204
 
    This is a deprecated format and may be removed after sept 2006.
1205
 
    """
1206
 
 
1207
 
    def has_workingtree(self):
1208
 
        """See BzrDir.has_workingtree."""
1209
 
        return True
1210
 
    
1211
 
    def open_repository(self):
1212
 
        """See BzrDir.open_repository."""
1213
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1214
 
        return RepositoryFormat5().open(self, _found=True)
1215
 
 
1216
 
    def open_workingtree(self, _unsupported=False,
1217
 
            recommend_upgrade=True):
1218
 
        """See BzrDir.create_workingtree."""
1219
 
        from bzrlib.workingtree import WorkingTreeFormat2
1220
 
        wt_format = WorkingTreeFormat2()
1221
 
        # we don't warn here about upgrades; that ought to be handled for the
1222
 
        # bzrdir as a whole
1223
 
        return wt_format.open(self, _found=True)
1224
 
 
1225
 
 
1226
 
class BzrDir6(BzrDirPreSplitOut):
1227
 
    """A .bzr version 6 control object.
1228
 
 
1229
 
    This is a deprecated format and may be removed after sept 2006.
1230
 
    """
1231
 
 
1232
 
    def has_workingtree(self):
1233
 
        """See BzrDir.has_workingtree."""
1234
 
        return True
1235
 
    
1236
 
    def open_repository(self):
1237
 
        """See BzrDir.open_repository."""
1238
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1239
 
        return RepositoryFormat6().open(self, _found=True)
1240
 
 
1241
 
    def open_workingtree(self, _unsupported=False,
1242
 
        recommend_upgrade=True):
1243
 
        """See BzrDir.create_workingtree."""
1244
 
        # we don't warn here about upgrades; that ought to be handled for the
1245
 
        # bzrdir as a whole
1246
 
        from bzrlib.workingtree import WorkingTreeFormat2
1247
 
        return WorkingTreeFormat2().open(self, _found=True)
1248
 
 
1249
 
 
1250
1135
class BzrDirMeta1(BzrDir):
1251
1136
    """A .bzr meta version 1 control object.
1252
1137
 
1260
1145
        """See BzrDir.can_convert_format()."""
1261
1146
        return True
1262
1147
 
1263
 
    def create_branch(self, name=None):
 
1148
    def create_branch(self, name=None, repository=None):
1264
1149
        """See BzrDir.create_branch."""
1265
 
        return self._format.get_branch_format().initialize(self, name=name)
 
1150
        return self._format.get_branch_format().initialize(self, name=name,
 
1151
                repository=repository)
1266
1152
 
1267
1153
    def destroy_branch(self, name=None):
1268
1154
        """See BzrDir.create_branch."""
1290
1176
        wt = self.open_workingtree(recommend_upgrade=False)
1291
1177
        repository = wt.branch.repository
1292
1178
        empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1293
 
        wt.revert(old_tree=empty)
 
1179
        # We ignore the conflicts returned by wt.revert since we're about to
 
1180
        # delete the wt metadata anyway, all that should be left here are
 
1181
        # detritus. But see bug #634470 about subtree .bzr dirs.
 
1182
        conflicts = wt.revert(old_tree=empty)
1294
1183
        self.destroy_workingtree_metadata()
1295
1184
 
1296
1185
    def destroy_workingtree_metadata(self):
1378
1267
            return False
1379
1268
        return True
1380
1269
 
1381
 
    def needs_format_conversion(self, format=None):
 
1270
    def needs_format_conversion(self, format):
1382
1271
        """See BzrDir.needs_format_conversion()."""
1383
 
        if format is None:
1384
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1385
 
                % 'needs_format_conversion(format=None)')
1386
 
        if format is None:
1387
 
            format = BzrDirFormat.get_default_format()
1388
1272
        if not isinstance(self._format, format.__class__):
1389
1273
            # it is not a meta dir format, conversion is needed.
1390
1274
            return True
1415
1299
                    ignore_fallbacks=False):
1416
1300
        """See BzrDir.open_branch."""
1417
1301
        format = self.find_branch_format(name=name)
1418
 
        self._check_supported(format, unsupported)
 
1302
        format.check_support_status(unsupported)
1419
1303
        return format.open(self, name=name,
1420
1304
            _found=True, ignore_fallbacks=ignore_fallbacks)
1421
1305
 
1423
1307
        """See BzrDir.open_repository."""
1424
1308
        from bzrlib.repository import RepositoryFormat
1425
1309
        format = RepositoryFormat.find_format(self)
1426
 
        self._check_supported(format, unsupported)
 
1310
        format.check_support_status(unsupported)
1427
1311
        return format.open(self, _found=True)
1428
1312
 
1429
1313
    def open_workingtree(self, unsupported=False,
1431
1315
        """See BzrDir.open_workingtree."""
1432
1316
        from bzrlib.workingtree import WorkingTreeFormat
1433
1317
        format = WorkingTreeFormat.find_format(self)
1434
 
        self._check_supported(format, unsupported,
1435
 
            recommend_upgrade,
 
1318
        format.check_support_status(unsupported, recommend_upgrade,
1436
1319
            basedir=self.root_transport.base)
1437
1320
        return format.open(self, _found=True)
1438
1321
 
1443
1326
class BzrProber(controldir.Prober):
1444
1327
    """Prober for formats that use a .bzr/ control directory."""
1445
1328
 
1446
 
    _formats = {}
 
1329
    formats = registry.FormatRegistry(controldir.network_format_registry)
1447
1330
    """The known .bzr formats."""
1448
1331
 
1449
1332
    @classmethod
 
1333
    @deprecated_method(deprecated_in((2, 4, 0)))
1450
1334
    def register_bzrdir_format(klass, format):
1451
 
        klass._formats[format.get_format_string()] = format
 
1335
        klass.formats.register(format.get_format_string(), format)
1452
1336
 
1453
1337
    @classmethod
 
1338
    @deprecated_method(deprecated_in((2, 4, 0)))
1454
1339
    def unregister_bzrdir_format(klass, format):
1455
 
        del klass._formats[format.get_format_string()]
 
1340
        klass.formats.remove(format.get_format_string())
1456
1341
 
1457
1342
    @classmethod
1458
1343
    def probe_transport(klass, transport):
1462
1347
        except errors.NoSuchFile:
1463
1348
            raise errors.NotBranchError(path=transport.base)
1464
1349
        try:
1465
 
            return klass._formats[format_string]
 
1350
            return klass.formats.get(format_string)
1466
1351
        except KeyError:
1467
1352
            raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1468
1353
 
 
1354
    @classmethod
 
1355
    def known_formats(cls):
 
1356
        result = set()
 
1357
        for name, format in cls.formats.iteritems():
 
1358
            if callable(format):
 
1359
                format = format()
 
1360
            result.add(format)
 
1361
        return result
 
1362
 
1469
1363
 
1470
1364
controldir.ControlDirFormat.register_prober(BzrProber)
1471
1365
 
1495
1389
                    raise errors.NotBranchError(path=transport.base)
1496
1390
                if server_version != '2':
1497
1391
                    raise errors.NotBranchError(path=transport.base)
 
1392
            from bzrlib.remote import RemoteBzrDirFormat
1498
1393
            return RemoteBzrDirFormat()
1499
1394
 
 
1395
    @classmethod
 
1396
    def known_formats(cls):
 
1397
        from bzrlib.remote import RemoteBzrDirFormat
 
1398
        return set([RemoteBzrDirFormat()])
 
1399
 
1500
1400
 
1501
1401
class BzrDirFormat(controldir.ControlDirFormat):
1502
1402
    """ControlDirFormat base class for .bzr/ directories.
1515
1415
    # _lock_class must be set in subclasses to the lock type, typ.
1516
1416
    # TransportLock or LockDir
1517
1417
 
1518
 
    def get_format_string(self):
 
1418
    @classmethod
 
1419
    def get_format_string(cls):
1519
1420
        """Return the ASCII format string that identifies this format."""
1520
1421
        raise NotImplementedError(self.get_format_string)
1521
1422
 
1533
1434
            # metadir1
1534
1435
            if type(self) != BzrDirMetaFormat1:
1535
1436
                return self._initialize_on_transport_vfs(transport)
 
1437
            from bzrlib.remote import RemoteBzrDirFormat
1536
1438
            remote_format = RemoteBzrDirFormat()
1537
1439
            self._supply_sub_formats_to(remote_format)
1538
1440
            return remote_format.initialize_on_transport(transport)
1576
1478
            except errors.NoSmartMedium:
1577
1479
                pass
1578
1480
            else:
 
1481
                from bzrlib.remote import RemoteBzrDirFormat
1579
1482
                # TODO: lookup the local format from a server hint.
1580
1483
                remote_dir_format = RemoteBzrDirFormat()
1581
1484
                remote_dir_format._network_name = self.network_name()
1656
1559
        utf8_files = [('README',
1657
1560
                       "This is a Bazaar control directory.\n"
1658
1561
                       "Do not change any files in this directory.\n"
1659
 
                       "See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
 
1562
                       "See http://bazaar.canonical.com/ for more information about Bazaar.\n"),
1660
1563
                      ('branch-format', self.get_format_string()),
1661
1564
                      ]
1662
1565
        # NB: no need to escape relative paths that are url safe.
1696
1599
        """
1697
1600
        raise NotImplementedError(self._open)
1698
1601
 
1699
 
    @classmethod
1700
 
    def register_format(klass, format):
1701
 
        BzrProber.register_bzrdir_format(format)
1702
 
        # bzr native formats have a network name of their format string.
1703
 
        controldir.network_format_registry.register(format.get_format_string(), format.__class__)
1704
 
        controldir.ControlDirFormat.register_format(format)
1705
 
 
1706
1602
    def _supply_sub_formats_to(self, other_format):
1707
1603
        """Give other_format the same values for sub formats as this has.
1708
1604
 
1715
1611
        :return: None.
1716
1612
        """
1717
1613
 
1718
 
    @classmethod
1719
 
    def unregister_format(klass, format):
1720
 
        BzrProber.unregister_bzrdir_format(format)
1721
 
        controldir.ControlDirFormat.unregister_format(format)
1722
 
        controldir.network_format_registry.remove(format.get_format_string())
1723
 
 
1724
 
 
1725
 
class BzrDirFormat4(BzrDirFormat):
1726
 
    """Bzr dir format 4.
1727
 
 
1728
 
    This format is a combined format for working tree, branch and repository.
1729
 
    It has:
1730
 
     - Format 1 working trees [always]
1731
 
     - Format 4 branches [always]
1732
 
     - Format 4 repositories [always]
1733
 
 
1734
 
    This format is deprecated: it indexes texts using a text it which is
1735
 
    removed in format 5; write support for this format has been removed.
1736
 
    """
1737
 
 
1738
 
    _lock_class = lockable_files.TransportLock
1739
 
 
1740
 
    def get_format_string(self):
1741
 
        """See BzrDirFormat.get_format_string()."""
1742
 
        return "Bazaar-NG branch, format 0.0.4\n"
1743
 
 
1744
 
    def get_format_description(self):
1745
 
        """See BzrDirFormat.get_format_description()."""
1746
 
        return "All-in-one format 4"
1747
 
 
1748
 
    def get_converter(self, format=None):
1749
 
        """See BzrDirFormat.get_converter()."""
1750
 
        # there is one and only one upgrade path here.
1751
 
        return ConvertBzrDir4To5()
1752
 
 
1753
 
    def initialize_on_transport(self, transport):
1754
 
        """Format 4 branches cannot be created."""
1755
 
        raise errors.UninitializableFormat(self)
1756
 
 
1757
 
    def is_supported(self):
1758
 
        """Format 4 is not supported.
1759
 
 
1760
 
        It is not supported because the model changed from 4 to 5 and the
1761
 
        conversion logic is expensive - so doing it on the fly was not
1762
 
        feasible.
1763
 
        """
1764
 
        return False
1765
 
 
1766
 
    def network_name(self):
1767
 
        return self.get_format_string()
1768
 
 
1769
 
    def _open(self, transport):
1770
 
        """See BzrDirFormat._open."""
1771
 
        return BzrDir4(transport, self)
1772
 
 
1773
 
    def __return_repository_format(self):
1774
 
        """Circular import protection."""
1775
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat4
1776
 
        return RepositoryFormat4()
1777
 
    repository_format = property(__return_repository_format)
1778
 
 
1779
 
 
1780
 
class BzrDirFormatAllInOne(BzrDirFormat):
1781
 
    """Common class for formats before meta-dirs."""
1782
 
 
1783
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
1784
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
1785
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
1786
 
        shared_repo=False):
1787
 
        """See BzrDirFormat.initialize_on_transport_ex."""
1788
 
        require_stacking = (stacked_on is not None)
1789
 
        # Format 5 cannot stack, but we've been asked to - actually init
1790
 
        # a Meta1Dir
1791
 
        if require_stacking:
1792
 
            format = BzrDirMetaFormat1()
1793
 
            return format.initialize_on_transport_ex(transport,
1794
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
1795
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
1796
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
1797
 
                make_working_trees=make_working_trees, shared_repo=shared_repo)
1798
 
        return BzrDirFormat.initialize_on_transport_ex(self, transport,
1799
 
            use_existing_dir=use_existing_dir, create_prefix=create_prefix,
1800
 
            force_new_repo=force_new_repo, stacked_on=stacked_on,
1801
 
            stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
1802
 
            make_working_trees=make_working_trees, shared_repo=shared_repo)
1803
 
 
1804
 
 
1805
 
class BzrDirFormat5(BzrDirFormatAllInOne):
1806
 
    """Bzr control format 5.
1807
 
 
1808
 
    This format is a combined format for working tree, branch and repository.
1809
 
    It has:
1810
 
     - Format 2 working trees [always]
1811
 
     - Format 4 branches [always]
1812
 
     - Format 5 repositories [always]
1813
 
       Unhashed stores in the repository.
1814
 
    """
1815
 
 
1816
 
    _lock_class = lockable_files.TransportLock
1817
 
 
1818
 
    def get_format_string(self):
1819
 
        """See BzrDirFormat.get_format_string()."""
1820
 
        return "Bazaar-NG branch, format 5\n"
1821
 
 
1822
 
    def get_branch_format(self):
1823
 
        from bzrlib import branch
1824
 
        return branch.BzrBranchFormat4()
1825
 
 
1826
 
    def get_format_description(self):
1827
 
        """See BzrDirFormat.get_format_description()."""
1828
 
        return "All-in-one format 5"
1829
 
 
1830
 
    def get_converter(self, format=None):
1831
 
        """See BzrDirFormat.get_converter()."""
1832
 
        # there is one and only one upgrade path here.
1833
 
        return ConvertBzrDir5To6()
1834
 
 
1835
 
    def _initialize_for_clone(self, url):
1836
 
        return self.initialize_on_transport(get_transport(url), _cloning=True)
1837
 
 
1838
 
    def initialize_on_transport(self, transport, _cloning=False):
1839
 
        """Format 5 dirs always have working tree, branch and repository.
1840
 
 
1841
 
        Except when they are being cloned.
1842
 
        """
1843
 
        from bzrlib.branch import BzrBranchFormat4
1844
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1845
 
        result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1846
 
        RepositoryFormat5().initialize(result, _internal=True)
1847
 
        if not _cloning:
1848
 
            branch = BzrBranchFormat4().initialize(result)
1849
 
            result._init_workingtree()
1850
 
        return result
1851
 
 
1852
 
    def network_name(self):
1853
 
        return self.get_format_string()
1854
 
 
1855
 
    def _open(self, transport):
1856
 
        """See BzrDirFormat._open."""
1857
 
        return BzrDir5(transport, self)
1858
 
 
1859
 
    def __return_repository_format(self):
1860
 
        """Circular import protection."""
1861
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat5
1862
 
        return RepositoryFormat5()
1863
 
    repository_format = property(__return_repository_format)
1864
 
 
1865
 
 
1866
 
class BzrDirFormat6(BzrDirFormatAllInOne):
1867
 
    """Bzr control format 6.
1868
 
 
1869
 
    This format is a combined format for working tree, branch and repository.
1870
 
    It has:
1871
 
     - Format 2 working trees [always]
1872
 
     - Format 4 branches [always]
1873
 
     - Format 6 repositories [always]
1874
 
    """
1875
 
 
1876
 
    _lock_class = lockable_files.TransportLock
1877
 
 
1878
 
    def get_format_string(self):
1879
 
        """See BzrDirFormat.get_format_string()."""
1880
 
        return "Bazaar-NG branch, format 6\n"
1881
 
 
1882
 
    def get_format_description(self):
1883
 
        """See BzrDirFormat.get_format_description()."""
1884
 
        return "All-in-one format 6"
1885
 
 
1886
 
    def get_branch_format(self):
1887
 
        from bzrlib import branch
1888
 
        return branch.BzrBranchFormat4()
1889
 
 
1890
 
    def get_converter(self, format=None):
1891
 
        """See BzrDirFormat.get_converter()."""
1892
 
        # there is one and only one upgrade path here.
1893
 
        return ConvertBzrDir6ToMeta()
1894
 
 
1895
 
    def _initialize_for_clone(self, url):
1896
 
        return self.initialize_on_transport(get_transport(url), _cloning=True)
1897
 
 
1898
 
    def initialize_on_transport(self, transport, _cloning=False):
1899
 
        """Format 6 dirs always have working tree, branch and repository.
1900
 
 
1901
 
        Except when they are being cloned.
1902
 
        """
1903
 
        from bzrlib.branch import BzrBranchFormat4
1904
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1905
 
        result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1906
 
        RepositoryFormat6().initialize(result, _internal=True)
1907
 
        if not _cloning:
1908
 
            branch = BzrBranchFormat4().initialize(result)
1909
 
            result._init_workingtree()
1910
 
        return result
1911
 
 
1912
 
    def network_name(self):
1913
 
        return self.get_format_string()
1914
 
 
1915
 
    def _open(self, transport):
1916
 
        """See BzrDirFormat._open."""
1917
 
        return BzrDir6(transport, self)
1918
 
 
1919
 
    def __return_repository_format(self):
1920
 
        """Circular import protection."""
1921
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat6
1922
 
        return RepositoryFormat6()
1923
 
    repository_format = property(__return_repository_format)
1924
 
 
1925
1614
 
1926
1615
class BzrDirMetaFormat1(BzrDirFormat):
1927
1616
    """Bzr meta control format 1
1936
1625
 
1937
1626
    _lock_class = lockdir.LockDir
1938
1627
 
 
1628
    fixed_components = False
 
1629
 
1939
1630
    def __init__(self):
1940
1631
        self._workingtree_format = None
1941
1632
        self._branch_format = None
1955
1646
 
1956
1647
    def get_branch_format(self):
1957
1648
        if self._branch_format is None:
1958
 
            from bzrlib.branch import BranchFormat
1959
 
            self._branch_format = BranchFormat.get_default_format()
 
1649
            from bzrlib.branch import format_registry as branch_format_registry
 
1650
            self._branch_format = branch_format_registry.get_default()
1960
1651
        return self._branch_format
1961
1652
 
1962
1653
    def set_branch_format(self, format):
2042
1733
            if target_branch is None:
2043
1734
                if do_upgrade:
2044
1735
                    # TODO: bad monkey, hard-coded formats...
2045
 
                    new_branch_format = branch.BzrBranchFormat7()
 
1736
                    from bzrlib.branch import BzrBranchFormat7
 
1737
                    new_branch_format = BzrBranchFormat7()
2046
1738
            else:
2047
1739
                new_branch_format = target_branch._format
2048
1740
                if not new_branch_format.supports_stacking():
2063
1755
            raise NotImplementedError(self.get_converter)
2064
1756
        return ConvertMetaToMeta(format)
2065
1757
 
2066
 
    def get_format_string(self):
 
1758
    @classmethod
 
1759
    def get_format_string(cls):
2067
1760
        """See BzrDirFormat.get_format_string()."""
2068
1761
        return "Bazaar-NG meta directory, format 1\n"
2069
1762
 
2087
1780
        """Circular import protection."""
2088
1781
        if self._repository_format:
2089
1782
            return self._repository_format
2090
 
        from bzrlib.repository import RepositoryFormat
2091
 
        return RepositoryFormat.get_default_format()
 
1783
        from bzrlib.repository import format_registry
 
1784
        return format_registry.get_default()
2092
1785
 
2093
1786
    def _set_repository_format(self, value):
2094
1787
        """Allow changing the repository format for metadir formats."""
2117
1810
 
2118
1811
    def __get_workingtree_format(self):
2119
1812
        if self._workingtree_format is None:
2120
 
            from bzrlib.workingtree import WorkingTreeFormat
2121
 
            self._workingtree_format = WorkingTreeFormat.get_default_format()
 
1813
            from bzrlib.workingtree import (
 
1814
                format_registry as wt_format_registry,
 
1815
                )
 
1816
            self._workingtree_format = wt_format_registry.get_default()
2122
1817
        return self._workingtree_format
2123
1818
 
2124
1819
    def __set_workingtree_format(self, wt_format):
2129
1824
 
2130
1825
 
2131
1826
# Register bzr formats
2132
 
BzrDirFormat.register_format(BzrDirFormat4())
2133
 
BzrDirFormat.register_format(BzrDirFormat5())
2134
 
BzrDirFormat.register_format(BzrDirFormat6())
2135
 
__default_format = BzrDirMetaFormat1()
2136
 
BzrDirFormat.register_format(__default_format)
2137
 
controldir.ControlDirFormat._default_format = __default_format
2138
 
 
2139
 
 
2140
 
class Converter(object):
2141
 
    """Converts a disk format object from one format to another."""
2142
 
 
2143
 
    def convert(self, to_convert, pb):
2144
 
        """Perform the conversion of to_convert, giving feedback via pb.
2145
 
 
2146
 
        :param to_convert: The disk object to convert.
2147
 
        :param pb: a progress bar to use for progress information.
2148
 
        """
2149
 
 
2150
 
    def step(self, message):
2151
 
        """Update the pb by a step."""
2152
 
        self.count +=1
2153
 
        self.pb.update(message, self.count, self.total)
2154
 
 
2155
 
 
2156
 
class ConvertBzrDir4To5(Converter):
2157
 
    """Converts format 4 bzr dirs to format 5."""
2158
 
 
2159
 
    def __init__(self):
2160
 
        super(ConvertBzrDir4To5, self).__init__()
2161
 
        self.converted_revs = set()
2162
 
        self.absent_revisions = set()
2163
 
        self.text_count = 0
2164
 
        self.revisions = {}
2165
 
 
2166
 
    def convert(self, to_convert, pb):
2167
 
        """See Converter.convert()."""
2168
 
        self.bzrdir = to_convert
2169
 
        if pb is not None:
2170
 
            warnings.warn("pb parameter to convert() is deprecated")
2171
 
        self.pb = ui.ui_factory.nested_progress_bar()
2172
 
        try:
2173
 
            ui.ui_factory.note('starting upgrade from format 4 to 5')
2174
 
            if isinstance(self.bzrdir.transport, local.LocalTransport):
2175
 
                self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2176
 
            self._convert_to_weaves()
2177
 
            return BzrDir.open(self.bzrdir.user_url)
2178
 
        finally:
2179
 
            self.pb.finished()
2180
 
 
2181
 
    def _convert_to_weaves(self):
2182
 
        ui.ui_factory.note('note: upgrade may be faster if all store files are ungzipped first')
2183
 
        try:
2184
 
            # TODO permissions
2185
 
            stat = self.bzrdir.transport.stat('weaves')
2186
 
            if not S_ISDIR(stat.st_mode):
2187
 
                self.bzrdir.transport.delete('weaves')
2188
 
                self.bzrdir.transport.mkdir('weaves')
2189
 
        except errors.NoSuchFile:
2190
 
            self.bzrdir.transport.mkdir('weaves')
2191
 
        # deliberately not a WeaveFile as we want to build it up slowly.
2192
 
        self.inv_weave = Weave('inventory')
2193
 
        # holds in-memory weaves for all files
2194
 
        self.text_weaves = {}
2195
 
        self.bzrdir.transport.delete('branch-format')
2196
 
        self.branch = self.bzrdir.open_branch()
2197
 
        self._convert_working_inv()
2198
 
        rev_history = self.branch.revision_history()
2199
 
        # to_read is a stack holding the revisions we still need to process;
2200
 
        # appending to it adds new highest-priority revisions
2201
 
        self.known_revisions = set(rev_history)
2202
 
        self.to_read = rev_history[-1:]
2203
 
        while self.to_read:
2204
 
            rev_id = self.to_read.pop()
2205
 
            if (rev_id not in self.revisions
2206
 
                and rev_id not in self.absent_revisions):
2207
 
                self._load_one_rev(rev_id)
2208
 
        self.pb.clear()
2209
 
        to_import = self._make_order()
2210
 
        for i, rev_id in enumerate(to_import):
2211
 
            self.pb.update('converting revision', i, len(to_import))
2212
 
            self._convert_one_rev(rev_id)
2213
 
        self.pb.clear()
2214
 
        self._write_all_weaves()
2215
 
        self._write_all_revs()
2216
 
        ui.ui_factory.note('upgraded to weaves:')
2217
 
        ui.ui_factory.note('  %6d revisions and inventories' % len(self.revisions))
2218
 
        ui.ui_factory.note('  %6d revisions not present' % len(self.absent_revisions))
2219
 
        ui.ui_factory.note('  %6d texts' % self.text_count)
2220
 
        self._cleanup_spare_files_after_format4()
2221
 
        self.branch._transport.put_bytes(
2222
 
            'branch-format',
2223
 
            BzrDirFormat5().get_format_string(),
2224
 
            mode=self.bzrdir._get_file_mode())
2225
 
 
2226
 
    def _cleanup_spare_files_after_format4(self):
2227
 
        # FIXME working tree upgrade foo.
2228
 
        for n in 'merged-patches', 'pending-merged-patches':
2229
 
            try:
2230
 
                ## assert os.path.getsize(p) == 0
2231
 
                self.bzrdir.transport.delete(n)
2232
 
            except errors.NoSuchFile:
2233
 
                pass
2234
 
        self.bzrdir.transport.delete_tree('inventory-store')
2235
 
        self.bzrdir.transport.delete_tree('text-store')
2236
 
 
2237
 
    def _convert_working_inv(self):
2238
 
        inv = xml4.serializer_v4.read_inventory(
2239
 
                self.branch._transport.get('inventory'))
2240
 
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2241
 
        self.branch._transport.put_bytes('inventory', new_inv_xml,
2242
 
            mode=self.bzrdir._get_file_mode())
2243
 
 
2244
 
    def _write_all_weaves(self):
2245
 
        controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2246
 
        weave_transport = self.bzrdir.transport.clone('weaves')
2247
 
        weaves = WeaveStore(weave_transport, prefixed=False)
2248
 
        transaction = WriteTransaction()
2249
 
 
2250
 
        try:
2251
 
            i = 0
2252
 
            for file_id, file_weave in self.text_weaves.items():
2253
 
                self.pb.update('writing weave', i, len(self.text_weaves))
2254
 
                weaves._put_weave(file_id, file_weave, transaction)
2255
 
                i += 1
2256
 
            self.pb.update('inventory', 0, 1)
2257
 
            controlweaves._put_weave('inventory', self.inv_weave, transaction)
2258
 
            self.pb.update('inventory', 1, 1)
2259
 
        finally:
2260
 
            self.pb.clear()
2261
 
 
2262
 
    def _write_all_revs(self):
2263
 
        """Write all revisions out in new form."""
2264
 
        self.bzrdir.transport.delete_tree('revision-store')
2265
 
        self.bzrdir.transport.mkdir('revision-store')
2266
 
        revision_transport = self.bzrdir.transport.clone('revision-store')
2267
 
        # TODO permissions
2268
 
        from bzrlib.xml5 import serializer_v5
2269
 
        from bzrlib.repofmt.weaverepo import RevisionTextStore
2270
 
        revision_store = RevisionTextStore(revision_transport,
2271
 
            serializer_v5, False, versionedfile.PrefixMapper(),
2272
 
            lambda:True, lambda:True)
2273
 
        try:
2274
 
            for i, rev_id in enumerate(self.converted_revs):
2275
 
                self.pb.update('write revision', i, len(self.converted_revs))
2276
 
                text = serializer_v5.write_revision_to_string(
2277
 
                    self.revisions[rev_id])
2278
 
                key = (rev_id,)
2279
 
                revision_store.add_lines(key, None, osutils.split_lines(text))
2280
 
        finally:
2281
 
            self.pb.clear()
2282
 
 
2283
 
    def _load_one_rev(self, rev_id):
2284
 
        """Load a revision object into memory.
2285
 
 
2286
 
        Any parents not either loaded or abandoned get queued to be
2287
 
        loaded."""
2288
 
        self.pb.update('loading revision',
2289
 
                       len(self.revisions),
2290
 
                       len(self.known_revisions))
2291
 
        if not self.branch.repository.has_revision(rev_id):
2292
 
            self.pb.clear()
2293
 
            ui.ui_factory.note('revision {%s} not present in branch; '
2294
 
                         'will be converted as a ghost' %
2295
 
                         rev_id)
2296
 
            self.absent_revisions.add(rev_id)
2297
 
        else:
2298
 
            rev = self.branch.repository.get_revision(rev_id)
2299
 
            for parent_id in rev.parent_ids:
2300
 
                self.known_revisions.add(parent_id)
2301
 
                self.to_read.append(parent_id)
2302
 
            self.revisions[rev_id] = rev
2303
 
 
2304
 
    def _load_old_inventory(self, rev_id):
2305
 
        f = self.branch.repository.inventory_store.get(rev_id)
2306
 
        try:
2307
 
            old_inv_xml = f.read()
2308
 
        finally:
2309
 
            f.close()
2310
 
        inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2311
 
        inv.revision_id = rev_id
2312
 
        rev = self.revisions[rev_id]
2313
 
        return inv
2314
 
 
2315
 
    def _load_updated_inventory(self, rev_id):
2316
 
        inv_xml = self.inv_weave.get_text(rev_id)
2317
 
        inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2318
 
        return inv
2319
 
 
2320
 
    def _convert_one_rev(self, rev_id):
2321
 
        """Convert revision and all referenced objects to new format."""
2322
 
        rev = self.revisions[rev_id]
2323
 
        inv = self._load_old_inventory(rev_id)
2324
 
        present_parents = [p for p in rev.parent_ids
2325
 
                           if p not in self.absent_revisions]
2326
 
        self._convert_revision_contents(rev, inv, present_parents)
2327
 
        self._store_new_inv(rev, inv, present_parents)
2328
 
        self.converted_revs.add(rev_id)
2329
 
 
2330
 
    def _store_new_inv(self, rev, inv, present_parents):
2331
 
        new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2332
 
        new_inv_sha1 = sha_string(new_inv_xml)
2333
 
        self.inv_weave.add_lines(rev.revision_id,
2334
 
                                 present_parents,
2335
 
                                 new_inv_xml.splitlines(True))
2336
 
        rev.inventory_sha1 = new_inv_sha1
2337
 
 
2338
 
    def _convert_revision_contents(self, rev, inv, present_parents):
2339
 
        """Convert all the files within a revision.
2340
 
 
2341
 
        Also upgrade the inventory to refer to the text revision ids."""
2342
 
        rev_id = rev.revision_id
2343
 
        mutter('converting texts of revision {%s}',
2344
 
               rev_id)
2345
 
        parent_invs = map(self._load_updated_inventory, present_parents)
2346
 
        entries = inv.iter_entries()
2347
 
        entries.next()
2348
 
        for path, ie in entries:
2349
 
            self._convert_file_version(rev, ie, parent_invs)
2350
 
 
2351
 
    def _convert_file_version(self, rev, ie, parent_invs):
2352
 
        """Convert one version of one file.
2353
 
 
2354
 
        The file needs to be added into the weave if it is a merge
2355
 
        of >=2 parents or if it's changed from its parent.
2356
 
        """
2357
 
        file_id = ie.file_id
2358
 
        rev_id = rev.revision_id
2359
 
        w = self.text_weaves.get(file_id)
2360
 
        if w is None:
2361
 
            w = Weave(file_id)
2362
 
            self.text_weaves[file_id] = w
2363
 
        text_changed = False
2364
 
        parent_candiate_entries = ie.parent_candidates(parent_invs)
2365
 
        heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2366
 
        # XXX: Note that this is unordered - and this is tolerable because
2367
 
        # the previous code was also unordered.
2368
 
        previous_entries = dict((head, parent_candiate_entries[head]) for head
2369
 
            in heads)
2370
 
        self.snapshot_ie(previous_entries, ie, w, rev_id)
2371
 
 
2372
 
    def get_parent_map(self, revision_ids):
2373
 
        """See graph.StackedParentsProvider.get_parent_map"""
2374
 
        return dict((revision_id, self.revisions[revision_id])
2375
 
                    for revision_id in revision_ids
2376
 
                     if revision_id in self.revisions)
2377
 
 
2378
 
    def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2379
 
        # TODO: convert this logic, which is ~= snapshot to
2380
 
        # a call to:. This needs the path figured out. rather than a work_tree
2381
 
        # a v4 revision_tree can be given, or something that looks enough like
2382
 
        # one to give the file content to the entry if it needs it.
2383
 
        # and we need something that looks like a weave store for snapshot to
2384
 
        # save against.
2385
 
        #ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2386
 
        if len(previous_revisions) == 1:
2387
 
            previous_ie = previous_revisions.values()[0]
2388
 
            if ie._unchanged(previous_ie):
2389
 
                ie.revision = previous_ie.revision
2390
 
                return
2391
 
        if ie.has_text():
2392
 
            f = self.branch.repository._text_store.get(ie.text_id)
2393
 
            try:
2394
 
                file_lines = f.readlines()
2395
 
            finally:
2396
 
                f.close()
2397
 
            w.add_lines(rev_id, previous_revisions, file_lines)
2398
 
            self.text_count += 1
2399
 
        else:
2400
 
            w.add_lines(rev_id, previous_revisions, [])
2401
 
        ie.revision = rev_id
2402
 
 
2403
 
    def _make_order(self):
2404
 
        """Return a suitable order for importing revisions.
2405
 
 
2406
 
        The order must be such that an revision is imported after all
2407
 
        its (present) parents.
2408
 
        """
2409
 
        todo = set(self.revisions.keys())
2410
 
        done = self.absent_revisions.copy()
2411
 
        order = []
2412
 
        while todo:
2413
 
            # scan through looking for a revision whose parents
2414
 
            # are all done
2415
 
            for rev_id in sorted(list(todo)):
2416
 
                rev = self.revisions[rev_id]
2417
 
                parent_ids = set(rev.parent_ids)
2418
 
                if parent_ids.issubset(done):
2419
 
                    # can take this one now
2420
 
                    order.append(rev_id)
2421
 
                    todo.remove(rev_id)
2422
 
                    done.add(rev_id)
2423
 
        return order
2424
 
 
2425
 
 
2426
 
class ConvertBzrDir5To6(Converter):
2427
 
    """Converts format 5 bzr dirs to format 6."""
2428
 
 
2429
 
    def convert(self, to_convert, pb):
2430
 
        """See Converter.convert()."""
2431
 
        self.bzrdir = to_convert
2432
 
        pb = ui.ui_factory.nested_progress_bar()
2433
 
        try:
2434
 
            ui.ui_factory.note('starting upgrade from format 5 to 6')
2435
 
            self._convert_to_prefixed()
2436
 
            return BzrDir.open(self.bzrdir.user_url)
2437
 
        finally:
2438
 
            pb.finished()
2439
 
 
2440
 
    def _convert_to_prefixed(self):
2441
 
        from bzrlib.store import TransportStore
2442
 
        self.bzrdir.transport.delete('branch-format')
2443
 
        for store_name in ["weaves", "revision-store"]:
2444
 
            ui.ui_factory.note("adding prefixes to %s" % store_name)
2445
 
            store_transport = self.bzrdir.transport.clone(store_name)
2446
 
            store = TransportStore(store_transport, prefixed=True)
2447
 
            for urlfilename in store_transport.list_dir('.'):
2448
 
                filename = urlutils.unescape(urlfilename)
2449
 
                if (filename.endswith(".weave") or
2450
 
                    filename.endswith(".gz") or
2451
 
                    filename.endswith(".sig")):
2452
 
                    file_id, suffix = os.path.splitext(filename)
2453
 
                else:
2454
 
                    file_id = filename
2455
 
                    suffix = ''
2456
 
                new_name = store._mapper.map((file_id,)) + suffix
2457
 
                # FIXME keep track of the dirs made RBC 20060121
2458
 
                try:
2459
 
                    store_transport.move(filename, new_name)
2460
 
                except errors.NoSuchFile: # catches missing dirs strangely enough
2461
 
                    store_transport.mkdir(osutils.dirname(new_name))
2462
 
                    store_transport.move(filename, new_name)
2463
 
        self.bzrdir.transport.put_bytes(
2464
 
            'branch-format',
2465
 
            BzrDirFormat6().get_format_string(),
2466
 
            mode=self.bzrdir._get_file_mode())
2467
 
 
2468
 
 
2469
 
class ConvertBzrDir6ToMeta(Converter):
2470
 
    """Converts format 6 bzr dirs to metadirs."""
2471
 
 
2472
 
    def convert(self, to_convert, pb):
2473
 
        """See Converter.convert()."""
2474
 
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
2475
 
        from bzrlib.branch import BzrBranchFormat5
2476
 
        self.bzrdir = to_convert
2477
 
        self.pb = ui.ui_factory.nested_progress_bar()
2478
 
        self.count = 0
2479
 
        self.total = 20 # the steps we know about
2480
 
        self.garbage_inventories = []
2481
 
        self.dir_mode = self.bzrdir._get_dir_mode()
2482
 
        self.file_mode = self.bzrdir._get_file_mode()
2483
 
 
2484
 
        ui.ui_factory.note('starting upgrade from format 6 to metadir')
2485
 
        self.bzrdir.transport.put_bytes(
2486
 
                'branch-format',
2487
 
                "Converting to format 6",
2488
 
                mode=self.file_mode)
2489
 
        # its faster to move specific files around than to open and use the apis...
2490
 
        # first off, nuke ancestry.weave, it was never used.
2491
 
        try:
2492
 
            self.step('Removing ancestry.weave')
2493
 
            self.bzrdir.transport.delete('ancestry.weave')
2494
 
        except errors.NoSuchFile:
2495
 
            pass
2496
 
        # find out whats there
2497
 
        self.step('Finding branch files')
2498
 
        last_revision = self.bzrdir.open_branch().last_revision()
2499
 
        bzrcontents = self.bzrdir.transport.list_dir('.')
2500
 
        for name in bzrcontents:
2501
 
            if name.startswith('basis-inventory.'):
2502
 
                self.garbage_inventories.append(name)
2503
 
        # create new directories for repository, working tree and branch
2504
 
        repository_names = [('inventory.weave', True),
2505
 
                            ('revision-store', True),
2506
 
                            ('weaves', True)]
2507
 
        self.step('Upgrading repository  ')
2508
 
        self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2509
 
        self.make_lock('repository')
2510
 
        # we hard code the formats here because we are converting into
2511
 
        # the meta format. The meta format upgrader can take this to a
2512
 
        # future format within each component.
2513
 
        self.put_format('repository', RepositoryFormat7())
2514
 
        for entry in repository_names:
2515
 
            self.move_entry('repository', entry)
2516
 
 
2517
 
        self.step('Upgrading branch      ')
2518
 
        self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2519
 
        self.make_lock('branch')
2520
 
        self.put_format('branch', BzrBranchFormat5())
2521
 
        branch_files = [('revision-history', True),
2522
 
                        ('branch-name', True),
2523
 
                        ('parent', False)]
2524
 
        for entry in branch_files:
2525
 
            self.move_entry('branch', entry)
2526
 
 
2527
 
        checkout_files = [('pending-merges', True),
2528
 
                          ('inventory', True),
2529
 
                          ('stat-cache', False)]
2530
 
        # If a mandatory checkout file is not present, the branch does not have
2531
 
        # a functional checkout. Do not create a checkout in the converted
2532
 
        # branch.
2533
 
        for name, mandatory in checkout_files:
2534
 
            if mandatory and name not in bzrcontents:
2535
 
                has_checkout = False
2536
 
                break
2537
 
        else:
2538
 
            has_checkout = True
2539
 
        if not has_checkout:
2540
 
            ui.ui_factory.note('No working tree.')
2541
 
            # If some checkout files are there, we may as well get rid of them.
2542
 
            for name, mandatory in checkout_files:
2543
 
                if name in bzrcontents:
2544
 
                    self.bzrdir.transport.delete(name)
2545
 
        else:
2546
 
            from bzrlib.workingtree import WorkingTreeFormat3
2547
 
            self.step('Upgrading working tree')
2548
 
            self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2549
 
            self.make_lock('checkout')
2550
 
            self.put_format(
2551
 
                'checkout', WorkingTreeFormat3())
2552
 
            self.bzrdir.transport.delete_multi(
2553
 
                self.garbage_inventories, self.pb)
2554
 
            for entry in checkout_files:
2555
 
                self.move_entry('checkout', entry)
2556
 
            if last_revision is not None:
2557
 
                self.bzrdir.transport.put_bytes(
2558
 
                    'checkout/last-revision', last_revision)
2559
 
        self.bzrdir.transport.put_bytes(
2560
 
            'branch-format',
2561
 
            BzrDirMetaFormat1().get_format_string(),
2562
 
            mode=self.file_mode)
2563
 
        self.pb.finished()
2564
 
        return BzrDir.open(self.bzrdir.user_url)
2565
 
 
2566
 
    def make_lock(self, name):
2567
 
        """Make a lock for the new control dir name."""
2568
 
        self.step('Make %s lock' % name)
2569
 
        ld = lockdir.LockDir(self.bzrdir.transport,
2570
 
                             '%s/lock' % name,
2571
 
                             file_modebits=self.file_mode,
2572
 
                             dir_modebits=self.dir_mode)
2573
 
        ld.create()
2574
 
 
2575
 
    def move_entry(self, new_dir, entry):
2576
 
        """Move then entry name into new_dir."""
2577
 
        name = entry[0]
2578
 
        mandatory = entry[1]
2579
 
        self.step('Moving %s' % name)
2580
 
        try:
2581
 
            self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2582
 
        except errors.NoSuchFile:
2583
 
            if mandatory:
2584
 
                raise
2585
 
 
2586
 
    def put_format(self, dirname, format):
2587
 
        self.bzrdir.transport.put_bytes('%s/format' % dirname,
2588
 
            format.get_format_string(),
2589
 
            self.file_mode)
2590
 
 
2591
 
 
2592
 
class ConvertMetaToMeta(Converter):
 
1827
BzrProber.formats.register(BzrDirMetaFormat1.get_format_string(),
 
1828
    BzrDirMetaFormat1)
 
1829
controldir.ControlDirFormat._default_format = BzrDirMetaFormat1()
 
1830
 
 
1831
 
 
1832
class ConvertMetaToMeta(controldir.Converter):
2593
1833
    """Converts the components of metadirs."""
2594
1834
 
2595
1835
    def __init__(self, target_format):
2668
1908
        return to_convert
2669
1909
 
2670
1910
 
2671
 
# This is not in remote.py because it's relatively small, and needs to be
2672
 
# registered. Putting it in remote.py creates a circular import problem.
2673
 
# we can make it a lazy object if the control formats is turned into something
2674
 
# like a registry.
2675
 
class RemoteBzrDirFormat(BzrDirMetaFormat1):
2676
 
    """Format representing bzrdirs accessed via a smart server"""
2677
 
 
2678
 
    supports_workingtrees = False
2679
 
 
2680
 
    def __init__(self):
2681
 
        BzrDirMetaFormat1.__init__(self)
2682
 
        # XXX: It's a bit ugly that the network name is here, because we'd
2683
 
        # like to believe that format objects are stateless or at least
2684
 
        # immutable,  However, we do at least avoid mutating the name after
2685
 
        # it's returned.  See <https://bugs.launchpad.net/bzr/+bug/504102>
2686
 
        self._network_name = None
2687
 
 
2688
 
    def __repr__(self):
2689
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
2690
 
            self._network_name)
2691
 
 
2692
 
    def get_format_description(self):
2693
 
        if self._network_name:
2694
 
            real_format = controldir.network_format_registry.get(self._network_name)
2695
 
            return 'Remote: ' + real_format.get_format_description()
2696
 
        return 'bzr remote bzrdir'
2697
 
 
2698
 
    def get_format_string(self):
2699
 
        raise NotImplementedError(self.get_format_string)
2700
 
 
2701
 
    def network_name(self):
2702
 
        if self._network_name:
2703
 
            return self._network_name
2704
 
        else:
2705
 
            raise AssertionError("No network name set.")
2706
 
 
2707
 
    def initialize_on_transport(self, transport):
2708
 
        try:
2709
 
            # hand off the request to the smart server
2710
 
            client_medium = transport.get_smart_medium()
2711
 
        except errors.NoSmartMedium:
2712
 
            # TODO: lookup the local format from a server hint.
2713
 
            local_dir_format = BzrDirMetaFormat1()
2714
 
            return local_dir_format.initialize_on_transport(transport)
2715
 
        client = _SmartClient(client_medium)
2716
 
        path = client.remote_path_from_transport(transport)
2717
 
        try:
2718
 
            response = client.call('BzrDirFormat.initialize', path)
2719
 
        except errors.ErrorFromSmartServer, err:
2720
 
            remote._translate_error(err, path=path)
2721
 
        if response[0] != 'ok':
2722
 
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
2723
 
        format = RemoteBzrDirFormat()
2724
 
        self._supply_sub_formats_to(format)
2725
 
        return remote.RemoteBzrDir(transport, format)
2726
 
 
2727
 
    def parse_NoneTrueFalse(self, arg):
2728
 
        if not arg:
2729
 
            return None
2730
 
        if arg == 'False':
2731
 
            return False
2732
 
        if arg == 'True':
2733
 
            return True
2734
 
        raise AssertionError("invalid arg %r" % arg)
2735
 
 
2736
 
    def _serialize_NoneTrueFalse(self, arg):
2737
 
        if arg is False:
2738
 
            return 'False'
2739
 
        if arg:
2740
 
            return 'True'
2741
 
        return ''
2742
 
 
2743
 
    def _serialize_NoneString(self, arg):
2744
 
        return arg or ''
2745
 
 
2746
 
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
2747
 
        create_prefix=False, force_new_repo=False, stacked_on=None,
2748
 
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
2749
 
        shared_repo=False):
2750
 
        try:
2751
 
            # hand off the request to the smart server
2752
 
            client_medium = transport.get_smart_medium()
2753
 
        except errors.NoSmartMedium:
2754
 
            do_vfs = True
2755
 
        else:
2756
 
            # Decline to open it if the server doesn't support our required
2757
 
            # version (3) so that the VFS-based transport will do it.
2758
 
            if client_medium.should_probe():
2759
 
                try:
2760
 
                    server_version = client_medium.protocol_version()
2761
 
                    if server_version != '2':
2762
 
                        do_vfs = True
2763
 
                    else:
2764
 
                        do_vfs = False
2765
 
                except errors.SmartProtocolError:
2766
 
                    # Apparently there's no usable smart server there, even though
2767
 
                    # the medium supports the smart protocol.
2768
 
                    do_vfs = True
2769
 
            else:
2770
 
                do_vfs = False
2771
 
        if not do_vfs:
2772
 
            client = _SmartClient(client_medium)
2773
 
            path = client.remote_path_from_transport(transport)
2774
 
            if client_medium._is_remote_before((1, 16)):
2775
 
                do_vfs = True
2776
 
        if do_vfs:
2777
 
            # TODO: lookup the local format from a server hint.
2778
 
            local_dir_format = BzrDirMetaFormat1()
2779
 
            self._supply_sub_formats_to(local_dir_format)
2780
 
            return local_dir_format.initialize_on_transport_ex(transport,
2781
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2782
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
2783
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2784
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
2785
 
                vfs_only=True)
2786
 
        return self._initialize_on_transport_ex_rpc(client, path, transport,
2787
 
            use_existing_dir, create_prefix, force_new_repo, stacked_on,
2788
 
            stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
2789
 
 
2790
 
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
2791
 
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
2792
 
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
2793
 
        args = []
2794
 
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
2795
 
        args.append(self._serialize_NoneTrueFalse(create_prefix))
2796
 
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
2797
 
        args.append(self._serialize_NoneString(stacked_on))
2798
 
        # stack_on_pwd is often/usually our transport
2799
 
        if stack_on_pwd:
2800
 
            try:
2801
 
                stack_on_pwd = transport.relpath(stack_on_pwd)
2802
 
                if not stack_on_pwd:
2803
 
                    stack_on_pwd = '.'
2804
 
            except errors.PathNotChild:
2805
 
                pass
2806
 
        args.append(self._serialize_NoneString(stack_on_pwd))
2807
 
        args.append(self._serialize_NoneString(repo_format_name))
2808
 
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
2809
 
        args.append(self._serialize_NoneTrueFalse(shared_repo))
2810
 
        request_network_name = self._network_name or \
2811
 
            BzrDirFormat.get_default_format().network_name()
2812
 
        try:
2813
 
            response = client.call('BzrDirFormat.initialize_ex_1.16',
2814
 
                request_network_name, path, *args)
2815
 
        except errors.UnknownSmartMethod:
2816
 
            client._medium._remember_remote_is_before((1,16))
2817
 
            local_dir_format = BzrDirMetaFormat1()
2818
 
            self._supply_sub_formats_to(local_dir_format)
2819
 
            return local_dir_format.initialize_on_transport_ex(transport,
2820
 
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
2821
 
                force_new_repo=force_new_repo, stacked_on=stacked_on,
2822
 
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
2823
 
                make_working_trees=make_working_trees, shared_repo=shared_repo,
2824
 
                vfs_only=True)
2825
 
        except errors.ErrorFromSmartServer, err:
2826
 
            remote._translate_error(err, path=path)
2827
 
        repo_path = response[0]
2828
 
        bzrdir_name = response[6]
2829
 
        require_stacking = response[7]
2830
 
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
2831
 
        format = RemoteBzrDirFormat()
2832
 
        format._network_name = bzrdir_name
2833
 
        self._supply_sub_formats_to(format)
2834
 
        bzrdir = remote.RemoteBzrDir(transport, format, _client=client)
2835
 
        if repo_path:
2836
 
            repo_format = remote.response_tuple_to_repo_format(response[1:])
2837
 
            if repo_path == '.':
2838
 
                repo_path = ''
2839
 
            if repo_path:
2840
 
                repo_bzrdir_format = RemoteBzrDirFormat()
2841
 
                repo_bzrdir_format._network_name = response[5]
2842
 
                repo_bzr = remote.RemoteBzrDir(transport.clone(repo_path),
2843
 
                    repo_bzrdir_format)
2844
 
            else:
2845
 
                repo_bzr = bzrdir
2846
 
            final_stack = response[8] or None
2847
 
            final_stack_pwd = response[9] or None
2848
 
            if final_stack_pwd:
2849
 
                final_stack_pwd = urlutils.join(
2850
 
                    transport.base, final_stack_pwd)
2851
 
            remote_repo = remote.RemoteRepository(repo_bzr, repo_format)
2852
 
            if len(response) > 10:
2853
 
                # Updated server verb that locks remotely.
2854
 
                repo_lock_token = response[10] or None
2855
 
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
2856
 
                if repo_lock_token:
2857
 
                    remote_repo.dont_leave_lock_in_place()
2858
 
            else:
2859
 
                remote_repo.lock_write()
2860
 
            policy = UseExistingRepository(remote_repo, final_stack,
2861
 
                final_stack_pwd, require_stacking)
2862
 
            policy.acquire_repository()
2863
 
        else:
2864
 
            remote_repo = None
2865
 
            policy = None
2866
 
        bzrdir._format.set_branch_format(self.get_branch_format())
2867
 
        if require_stacking:
2868
 
            # The repo has already been created, but we need to make sure that
2869
 
            # we'll make a stackable branch.
2870
 
            bzrdir._format.require_stacking(_skip_repo=True)
2871
 
        return remote_repo, bzrdir, require_stacking, policy
2872
 
 
2873
 
    def _open(self, transport):
2874
 
        return remote.RemoteBzrDir(transport, self)
2875
 
 
2876
 
    def __eq__(self, other):
2877
 
        if not isinstance(other, RemoteBzrDirFormat):
2878
 
            return False
2879
 
        return self.get_format_description() == other.get_format_description()
2880
 
 
2881
 
    def __return_repository_format(self):
2882
 
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
2883
 
        # repository format has been asked for, tell the RemoteRepositoryFormat
2884
 
        # that it should use that for init() etc.
2885
 
        result = remote.RemoteRepositoryFormat()
2886
 
        custom_format = getattr(self, '_repository_format', None)
2887
 
        if custom_format:
2888
 
            if isinstance(custom_format, remote.RemoteRepositoryFormat):
2889
 
                return custom_format
2890
 
            else:
2891
 
                # We will use the custom format to create repositories over the
2892
 
                # wire; expose its details like rich_root_data for code to
2893
 
                # query
2894
 
                result._custom_format = custom_format
2895
 
        return result
2896
 
 
2897
 
    def get_branch_format(self):
2898
 
        result = BzrDirMetaFormat1.get_branch_format(self)
2899
 
        if not isinstance(result, remote.RemoteBranchFormat):
2900
 
            new_result = remote.RemoteBranchFormat()
2901
 
            new_result._custom_format = result
2902
 
            # cache the result
2903
 
            self.set_branch_format(new_result)
2904
 
            result = new_result
2905
 
        return result
2906
 
 
2907
 
    repository_format = property(__return_repository_format,
2908
 
        BzrDirMetaFormat1._set_repository_format) #.im_func)
2909
 
 
2910
 
 
2911
1911
controldir.ControlDirFormat.register_server_prober(RemoteBzrProber)
2912
1912
 
2913
1913
 
3092
2092
    def _load(full_name):
3093
2093
        mod_name, factory_name = full_name.rsplit('.', 1)
3094
2094
        try:
3095
 
            mod = __import__(mod_name, globals(), locals(),
3096
 
                    [factory_name])
 
2095
            factory = pyutils.get_named_object(mod_name, factory_name)
3097
2096
        except ImportError, e:
3098
2097
            raise ImportError('failed to load %s: %s' % (full_name, e))
3099
 
        try:
3100
 
            factory = getattr(mod, factory_name)
3101
2098
        except AttributeError:
3102
2099
            raise AttributeError('no factory %s in module %r'
3103
 
                % (full_name, mod))
 
2100
                % (full_name, sys.modules[mod_name]))
3104
2101
        return factory()
3105
2102
 
3106
2103
    def helper():
3115
2112
    registry.register(key, helper, help, native, deprecated, hidden,
3116
2113
        experimental, alias)
3117
2114
 
3118
 
# The pre-0.8 formats have their repository format network name registered in
3119
 
# repository.py. MetaDir formats have their repository format network name
3120
 
# inferred from their disk format string.
3121
 
controldir.format_registry.register('weave', BzrDirFormat6,
3122
 
    'Pre-0.8 format.  Slower than knit and does not'
3123
 
    ' support checkouts or shared repositories.',
3124
 
    hidden=True,
3125
 
    deprecated=True)
3126
 
register_metadir(controldir.format_registry, 'metaweave',
3127
 
    'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3128
 
    'Transitional format in 0.8.  Slower than knit.',
3129
 
    branch_format='bzrlib.branch.BzrBranchFormat5',
3130
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3131
 
    hidden=True,
3132
 
    deprecated=True)
3133
2115
register_metadir(controldir.format_registry, 'knit',
3134
2116
    'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3135
2117
    'Format using knits.  Recommended for interoperation with bzr <= 0.14.',
3250
2232
    tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3251
2233
    )
3252
2234
# The following un-numbered 'development' formats should always just be aliases.
3253
 
register_metadir(controldir.format_registry, 'development-rich-root',
3254
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3255
 
    help='Current development format. Supports rich roots. Can convert data '
3256
 
        'to and from rich-root-pack (and anything compatible with '
3257
 
        'rich-root-pack) format repositories. Repositories and branches in '
3258
 
        'this format can only be read by bzr.dev. Please read '
3259
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3260
 
        'before use.',
3261
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3262
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3263
 
    experimental=True,
3264
 
    alias=True,
3265
 
    hidden=True,
3266
 
    )
3267
 
register_metadir(controldir.format_registry, 'development5-subtree',
3268
 
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3269
 
    help='Development format, subtree variant. Can convert data to and '
3270
 
        'from pack-0.92-subtree (and anything compatible with '
3271
 
        'pack-0.92-subtree) format repositories. Repositories and branches in '
3272
 
        'this format can only be read by bzr.dev. Please read '
3273
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3274
 
        'before use.',
3275
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3276
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3277
 
    experimental=True,
3278
 
    hidden=True,
3279
 
    alias=False,
3280
 
    )
3281
 
 
3282
 
 
3283
2235
register_metadir(controldir.format_registry, 'development-subtree',
3284
2236
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2aSubtree',
3285
2237
    help='Current development format, subtree variant. Can convert data to and '
3296
2248
                 # This current non-alias status is simply because we did not introduce a
3297
2249
                 # chk based subtree format.
3298
2250
    )
 
2251
register_metadir(controldir.format_registry, 'development5-subtree',
 
2252
    'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
 
2253
    help='Development format, subtree variant. Can convert data to and '
 
2254
        'from pack-0.92-subtree (and anything compatible with '
 
2255
        'pack-0.92-subtree) format repositories. Repositories and branches in '
 
2256
        'this format can only be read by bzr.dev. Please read '
 
2257
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
 
2258
        'before use.',
 
2259
    branch_format='bzrlib.branch.BzrBranchFormat7',
 
2260
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
 
2261
    experimental=True,
 
2262
    hidden=True,
 
2263
    alias=False,
 
2264
    )
3299
2265
 
3300
2266
# And the development formats above will have aliased one of the following:
3301
 
register_metadir(controldir.format_registry, 'development6-rich-root',
3302
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK1',
3303
 
    help='pack-1.9 with 255-way hashed CHK inv, group compress, rich roots '
3304
 
        'Please read '
3305
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3306
 
        'before use.',
3307
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3308
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3309
 
    hidden=True,
3310
 
    experimental=True,
3311
 
    )
3312
 
 
3313
 
register_metadir(controldir.format_registry, 'development7-rich-root',
3314
 
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormatCHK2',
3315
 
    help='pack-1.9 with 255-way hashed CHK inv, bencode revision, group compress, '
3316
 
        'rich roots. Please read '
3317
 
        'http://doc.bazaar.canonical.com/latest/developers/development-repo.html '
3318
 
        'before use.',
3319
 
    branch_format='bzrlib.branch.BzrBranchFormat7',
3320
 
    tree_format='bzrlib.workingtree.WorkingTreeFormat6',
3321
 
    hidden=True,
3322
 
    experimental=True,
3323
 
    )
3324
 
 
 
2267
 
 
2268
# Finally, the current format.
3325
2269
register_metadir(controldir.format_registry, '2a',
3326
2270
    'bzrlib.repofmt.groupcompress_repo.RepositoryFormat2a',
3327
2271
    help='First format for bzr 2.0 series.\n'
3345
2289
    help='Same as 2a.')
3346
2290
 
3347
2291
# The current format that is made on 'bzr init'.
3348
 
controldir.format_registry.set_default('2a')
 
2292
format_name = config.GlobalConfig().get_user_option('default_format')
 
2293
if format_name is None:
 
2294
    controldir.format_registry.set_default('2a')
 
2295
else:
 
2296
    controldir.format_registry.set_default(format_name)
3349
2297
 
3350
2298
# XXX 2010-08-20 JRV: There is still a lot of code relying on
3351
2299
# bzrlib.bzrdir.format_registry existing. When BzrDir.create/BzrDir.open/etc