~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2012 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
import bzrlib.bzrdir
17
20
 
18
21
from cStringIO import StringIO
19
 
import sys
20
22
 
21
23
from bzrlib.lazy_import import lazy_import
22
24
lazy_import(globals(), """
23
 
from itertools import chain
 
25
import itertools
24
26
from bzrlib import (
25
 
        bzrdir,
26
 
        cache_utf8,
27
 
        cleanup,
28
 
        config as _mod_config,
29
 
        debug,
30
 
        errors,
31
 
        fetch,
32
 
        graph as _mod_graph,
33
 
        lockdir,
34
 
        lockable_files,
35
 
        remote,
36
 
        repository,
37
 
        revision as _mod_revision,
38
 
        rio,
39
 
        transport,
40
 
        ui,
41
 
        urlutils,
42
 
        )
43
 
from bzrlib.config import BranchConfig, TransportConfig
44
 
from bzrlib.tag import (
45
 
    BasicTags,
46
 
    DisabledTags,
 
27
    bzrdir,
 
28
    controldir,
 
29
    cache_utf8,
 
30
    cleanup,
 
31
    config as _mod_config,
 
32
    debug,
 
33
    errors,
 
34
    fetch,
 
35
    graph as _mod_graph,
 
36
    lockdir,
 
37
    lockable_files,
 
38
    remote,
 
39
    repository,
 
40
    revision as _mod_revision,
 
41
    rio,
 
42
    shelf,
 
43
    tag as _mod_tag,
 
44
    transport,
 
45
    ui,
 
46
    urlutils,
 
47
    vf_search,
47
48
    )
 
49
from bzrlib.i18n import gettext, ngettext
48
50
""")
49
51
 
 
52
# Explicitly import bzrlib.bzrdir so that the BzrProber
 
53
# is guaranteed to be registered.
 
54
import bzrlib.bzrdir
 
55
 
50
56
from bzrlib import (
 
57
    bzrdir,
51
58
    controldir,
52
59
    )
53
60
from bzrlib.decorators import (
66
73
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
67
74
 
68
75
 
69
 
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
70
 
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
71
 
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
72
 
 
73
 
 
74
76
class Branch(controldir.ControlComponent):
75
77
    """Branch holding a history of revisions.
76
78
 
93
95
    def user_transport(self):
94
96
        return self.bzrdir.user_transport
95
97
 
96
 
    def __init__(self, *ignored, **ignored_too):
 
98
    def __init__(self, possible_transports=None):
97
99
        self.tags = self._format.make_tags(self)
98
100
        self._revision_history_cache = None
99
101
        self._revision_id_to_revno_cache = None
103
105
        self._last_revision_info_cache = None
104
106
        self._master_branch_cache = None
105
107
        self._merge_sorted_revisions_cache = None
106
 
        self._open_hook()
 
108
        self._open_hook(possible_transports)
107
109
        hooks = Branch.hooks['open']
108
110
        for hook in hooks:
109
111
            hook(self)
110
112
 
111
 
    def _open_hook(self):
 
113
    def _open_hook(self, possible_transports):
112
114
        """Called by init to allow simpler extension of the base class."""
113
115
 
114
 
    def _activate_fallback_location(self, url):
 
116
    def _activate_fallback_location(self, url, possible_transports):
115
117
        """Activate the branch/repository from url as a fallback repository."""
116
118
        for existing_fallback_repo in self.repository._fallback_repositories:
117
119
            if existing_fallback_repo.user_url == url:
118
120
                # This fallback is already configured.  This probably only
119
 
                # happens because BzrDir.sprout is a horrible mess.  To avoid
 
121
                # happens because ControlDir.sprout is a horrible mess.  To avoid
120
122
                # confusing _unstack we don't add this a second time.
121
123
                mutter('duplicate activation of fallback %r on %r', url, self)
122
124
                return
123
 
        repo = self._get_fallback_repository(url)
 
125
        repo = self._get_fallback_repository(url, possible_transports)
124
126
        if repo.has_same_location(self.repository):
125
127
            raise errors.UnstackableLocationError(self.user_url, url)
126
128
        self.repository.add_fallback_repository(repo)
180
182
        For instance, if the branch is at URL/.bzr/branch,
181
183
        Branch.open(URL) -> a Branch instance.
182
184
        """
183
 
        control = bzrdir.BzrDir.open(base, _unsupported,
184
 
                                     possible_transports=possible_transports)
185
 
        return control.open_branch(unsupported=_unsupported)
 
185
        control = controldir.ControlDir.open(base,
 
186
            possible_transports=possible_transports, _unsupported=_unsupported)
 
187
        return control.open_branch(unsupported=_unsupported,
 
188
            possible_transports=possible_transports)
186
189
 
187
190
    @staticmethod
188
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
191
    def open_from_transport(transport, name=None, _unsupported=False,
 
192
            possible_transports=None):
189
193
        """Open the branch rooted at transport"""
190
 
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
191
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
194
        control = controldir.ControlDir.open_from_transport(transport, _unsupported)
 
195
        return control.open_branch(name=name, unsupported=_unsupported,
 
196
            possible_transports=possible_transports)
192
197
 
193
198
    @staticmethod
194
199
    def open_containing(url, possible_transports=None):
202
207
        format, UnknownFormatError or UnsupportedFormatError are raised.
203
208
        If there is one, it is returned, along with the unused portion of url.
204
209
        """
205
 
        control, relpath = bzrdir.BzrDir.open_containing(url,
 
210
        control, relpath = controldir.ControlDir.open_containing(url,
206
211
                                                         possible_transports)
207
 
        return control.open_branch(), relpath
 
212
        branch = control.open_branch(possible_transports=possible_transports)
 
213
        return (branch, relpath)
208
214
 
209
215
    def _push_should_merge_tags(self):
210
216
        """Should _basic_push merge this branch's tags into the target?
222
228
 
223
229
        :return: A bzrlib.config.BranchConfig.
224
230
        """
225
 
        return BranchConfig(self)
 
231
        return _mod_config.BranchConfig(self)
 
232
 
 
233
    def get_config_stack(self):
 
234
        """Get a bzrlib.config.BranchStack for this Branch.
 
235
 
 
236
        This can then be used to get and set configuration options for the
 
237
        branch.
 
238
 
 
239
        :return: A bzrlib.config.BranchStack.
 
240
        """
 
241
        return _mod_config.BranchStack(self)
226
242
 
227
243
    def _get_config(self):
228
244
        """Get the concrete config for just the config in this branch.
236
252
        """
237
253
        raise NotImplementedError(self._get_config)
238
254
 
239
 
    def _get_fallback_repository(self, url):
 
255
    def store_uncommitted(self, creator):
 
256
        """Store uncommitted changes from a ShelfCreator.
 
257
 
 
258
        :param creator: The ShelfCreator containing uncommitted changes, or
 
259
            None to delete any stored changes.
 
260
        :raises: ChangesAlreadyStored if the branch already has changes.
 
261
        """
 
262
        raise NotImplementedError(self.store_uncommitted)
 
263
 
 
264
    def get_unshelver(self, tree):
 
265
        """Return a shelf.Unshelver for this branch and tree.
 
266
 
 
267
        :param tree: The tree to use to construct the Unshelver.
 
268
        :return: an Unshelver or None if no changes are stored.
 
269
        """
 
270
        raise NotImplementedError(self.get_unshelver)
 
271
 
 
272
    def _get_fallback_repository(self, url, possible_transports):
240
273
        """Get the repository we fallback to at url."""
241
274
        url = urlutils.join(self.base, url)
242
 
        a_branch = Branch.open(url,
243
 
            possible_transports=[self.bzrdir.root_transport])
 
275
        a_branch = Branch.open(url, possible_transports=possible_transports)
244
276
        return a_branch.repository
245
277
 
246
278
    @needs_read_lock
520
552
                    # The decision to include the start or not
521
553
                    # depends on the stop_rule if a stop is provided
522
554
                    # so pop this node back into the iterator
523
 
                    rev_iter = chain(iter([node]), rev_iter)
 
555
                    rev_iter = itertools.chain(iter([node]), rev_iter)
524
556
                    break
525
557
        if stop_revision_id is None:
526
558
            # Yield everything
651
683
        """
652
684
        raise errors.UpgradeRequired(self.user_url)
653
685
 
 
686
    def get_append_revisions_only(self):
 
687
        """Whether it is only possible to append revisions to the history.
 
688
        """
 
689
        if not self._format.supports_set_append_revisions_only():
 
690
            return False
 
691
        return self.get_config_stack().get('append_revisions_only')
 
692
 
654
693
    def set_append_revisions_only(self, enabled):
655
694
        if not self._format.supports_set_append_revisions_only():
656
695
            raise errors.UpgradeRequired(self.user_url)
657
 
        if enabled:
658
 
            value = 'True'
659
 
        else:
660
 
            value = 'False'
661
 
        self.get_config().set_user_option('append_revisions_only', value,
662
 
            warn_masked=True)
 
696
        self.get_config_stack().set('append_revisions_only', enabled)
663
697
 
664
698
    def set_reference_info(self, file_id, tree_path, branch_location):
665
699
        """Set the branch location to use for a tree reference."""
694
728
        """
695
729
        raise errors.UpgradeRequired(self.user_url)
696
730
 
697
 
    def get_commit_builder(self, parents, config=None, timestamp=None,
 
731
    def get_commit_builder(self, parents, config_stack=None, timestamp=None,
698
732
                           timezone=None, committer=None, revprops=None,
699
733
                           revision_id=None, lossy=False):
700
734
        """Obtain a CommitBuilder for this branch.
710
744
            represented, when pushing to a foreign VCS 
711
745
        """
712
746
 
713
 
        if config is None:
714
 
            config = self.get_config()
 
747
        if config_stack is None:
 
748
            config_stack = self.get_config_stack()
715
749
 
716
 
        return self.repository.get_commit_builder(self, parents, config,
 
750
        return self.repository.get_commit_builder(self, parents, config_stack,
717
751
            timestamp, timezone, committer, revprops, revision_id,
718
752
            lossy)
719
753
 
724
758
        """
725
759
        return None
726
760
 
 
761
    @deprecated_method(deprecated_in((2, 5, 0)))
727
762
    def get_revision_delta(self, revno):
728
763
        """Return the delta for one revision.
729
764
 
730
765
        The delta is relative to its mainline predecessor, or the
731
766
        empty tree for revision 1.
732
767
        """
733
 
        rh = self.revision_history()
734
 
        if not (1 <= revno <= len(rh)):
 
768
        try:
 
769
            revid = self.get_rev_id(revno)
 
770
        except errors.NoSuchRevision:
735
771
            raise errors.InvalidRevisionNumber(revno)
736
 
        return self.repository.get_revision_delta(rh[revno-1])
 
772
        return self.repository.get_revision_delta(revid)
737
773
 
738
774
    def get_stacked_on_url(self):
739
775
        """Get the URL this branch is stacked against.
748
784
        """Print `file` to stdout."""
749
785
        raise NotImplementedError(self.print_file)
750
786
 
751
 
    @deprecated_method(deprecated_in((2, 4, 0)))
752
 
    def set_revision_history(self, rev_history):
753
 
        """See Branch.set_revision_history."""
754
 
        self._set_revision_history(rev_history)
755
 
 
756
 
    @needs_write_lock
757
 
    def _set_revision_history(self, rev_history):
758
 
        if len(rev_history) == 0:
759
 
            revid = _mod_revision.NULL_REVISION
760
 
        else:
761
 
            revid = rev_history[-1]
762
 
        if rev_history != self._lefthand_history(revid):
763
 
            raise errors.NotLefthandHistory(rev_history)
764
 
        self.set_last_revision_info(len(rev_history), revid)
765
 
        self._cache_revision_history(rev_history)
766
 
        for hook in Branch.hooks['set_rh']:
767
 
            hook(self, rev_history)
768
 
 
769
787
    @needs_write_lock
770
788
    def set_last_revision_info(self, revno, revision_id):
771
789
        """Set the last revision of this branch.
785
803
                                  other_branch=None):
786
804
        """See Branch.generate_revision_history"""
787
805
        graph = self.repository.get_graph()
 
806
        (last_revno, last_revid) = self.last_revision_info()
788
807
        known_revision_ids = [
789
 
            self.last_revision_info(),
 
808
            (last_revid, last_revno),
790
809
            (_mod_revision.NULL_REVISION, 0),
791
810
            ]
792
811
        if last_rev is not None:
837
856
                return
838
857
            self._unstack()
839
858
        else:
840
 
            self._activate_fallback_location(url)
 
859
            self._activate_fallback_location(url,
 
860
                possible_transports=[self.bzrdir.root_transport])
841
861
        # write this out after the repository is stacked to avoid setting a
842
862
        # stacked config that doesn't work.
843
863
        self._set_config_location('stacked_on_location', url)
849
869
        """
850
870
        pb = ui.ui_factory.nested_progress_bar()
851
871
        try:
852
 
            pb.update("Unstacking")
 
872
            pb.update(gettext("Unstacking"))
853
873
            # The basic approach here is to fetch the tip of the branch,
854
874
            # including all available ghosts, from the existing stacked
855
875
            # repository into a new repository object without the fallbacks. 
869
889
            # stream from one of them to the other.  This does mean doing
870
890
            # separate SSH connection setup, but unstacking is not a
871
891
            # common operation so it's tolerable.
872
 
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
892
            new_bzrdir = controldir.ControlDir.open(
 
893
                self.bzrdir.root_transport.base)
873
894
            new_repository = new_bzrdir.find_repository()
874
895
            if new_repository._fallback_repositories:
875
896
                raise AssertionError("didn't expect %r to have "
918
939
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
919
940
                except errors.TagsNotSupported:
920
941
                    tags_to_fetch = set()
921
 
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
942
                fetch_spec = vf_search.NotInOtherForRevs(self.repository,
922
943
                    old_repository, required_ids=[self.last_revision()],
923
944
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
924
945
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
965
986
        This means the next call to revision_history will need to call
966
987
        _gen_revision_history.
967
988
 
968
 
        This API is semi-public; it only for use by subclasses, all other code
969
 
        should consider it to be private.
 
989
        This API is semi-public; it is only for use by subclasses, all other
 
990
        code should consider it to be private.
970
991
        """
971
992
        self._revision_history_cache = None
972
993
        self._revision_id_to_revno_cache = None
992
1013
        """
993
1014
        raise NotImplementedError(self._gen_revision_history)
994
1015
 
995
 
    @needs_read_lock
996
 
    def revision_history(self):
997
 
        """Return sequence of revision ids on this branch.
998
 
 
999
 
        This method will cache the revision history for as long as it is safe to
1000
 
        do so.
1001
 
        """
 
1016
    def _revision_history(self):
1002
1017
        if 'evil' in debug.debug_flags:
1003
1018
            mutter_callsite(3, "revision_history scales with history.")
1004
1019
        if self._revision_history_cache is not None:
1037
1052
    def _read_last_revision_info(self):
1038
1053
        raise NotImplementedError(self._read_last_revision_info)
1039
1054
 
1040
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1041
 
    def import_last_revision_info(self, source_repo, revno, revid):
1042
 
        """Set the last revision info, importing from another repo if necessary.
1043
 
 
1044
 
        :param source_repo: Source repository to optionally fetch from
1045
 
        :param revno: Revision number of the new tip
1046
 
        :param revid: Revision id of the new tip
1047
 
        """
1048
 
        if not self.repository.has_same_location(source_repo):
1049
 
            self.repository.fetch(source_repo, revision_id=revid)
1050
 
        self.set_last_revision_info(revno, revid)
1051
 
 
1052
1055
    def import_last_revision_info_and_tags(self, source, revno, revid,
1053
1056
                                           lossy=False):
1054
1057
        """Set the last revision info, importing from another repo if necessary.
1074
1077
        """Given a revision id, return its revno"""
1075
1078
        if _mod_revision.is_null(revision_id):
1076
1079
            return 0
1077
 
        history = self.revision_history()
 
1080
        history = self._revision_history()
1078
1081
        try:
1079
1082
            return history.index(revision_id) + 1
1080
1083
        except ValueError:
1145
1148
    def _set_config_location(self, name, url, config=None,
1146
1149
                             make_relative=False):
1147
1150
        if config is None:
1148
 
            config = self.get_config()
 
1151
            config = self.get_config_stack()
1149
1152
        if url is None:
1150
1153
            url = ''
1151
1154
        elif make_relative:
1152
1155
            url = urlutils.relative_url(self.base, url)
1153
 
        config.set_user_option(name, url, warn_masked=True)
 
1156
        config.set(name, url)
1154
1157
 
1155
1158
    def _get_config_location(self, name, config=None):
1156
1159
        if config is None:
1157
 
            config = self.get_config()
1158
 
        location = config.get_user_option(name)
 
1160
            config = self.get_config_stack()
 
1161
        location = config.get(name)
1159
1162
        if location == '':
1160
1163
            location = None
1161
1164
        return location
1162
1165
 
1163
1166
    def get_child_submit_format(self):
1164
1167
        """Return the preferred format of submissions to this branch."""
1165
 
        return self.get_config().get_user_option("child_submit_format")
 
1168
        return self.get_config_stack().get('child_submit_format')
1166
1169
 
1167
1170
    def get_submit_branch(self):
1168
1171
        """Return the submit location of the branch.
1171
1174
        pattern is that the user can override it by specifying a
1172
1175
        location.
1173
1176
        """
1174
 
        return self.get_config().get_user_option('submit_branch')
 
1177
        return self.get_config_stack().get('submit_branch')
1175
1178
 
1176
1179
    def set_submit_branch(self, location):
1177
1180
        """Return the submit location of the branch.
1180
1183
        pattern is that the user can override it by specifying a
1181
1184
        location.
1182
1185
        """
1183
 
        self.get_config().set_user_option('submit_branch', location,
1184
 
            warn_masked=True)
 
1186
        self.get_config_stack().set('submit_branch', location)
1185
1187
 
1186
1188
    def get_public_branch(self):
1187
1189
        """Return the public location of the branch.
1200
1202
        self._set_config_location('public_branch', location)
1201
1203
 
1202
1204
    def get_push_location(self):
1203
 
        """Return the None or the location to push this branch to."""
1204
 
        push_loc = self.get_config().get_user_option('push_location')
1205
 
        return push_loc
 
1205
        """Return None or the location to push this branch to."""
 
1206
        return self.get_config_stack().get('push_location')
1206
1207
 
1207
1208
    def set_push_location(self, location):
1208
1209
        """Set a new push location for this branch."""
1293
1294
            if repository_policy is not None:
1294
1295
                repository_policy.configure_branch(result)
1295
1296
            self.copy_content_into(result, revision_id=revision_id)
1296
 
            master_branch = self.get_master_branch()
1297
 
            if master_branch is None:
 
1297
            master_url = self.get_bound_location()
 
1298
            if master_url is None:
1298
1299
                result.set_parent(self.bzrdir.root_transport.base)
1299
1300
            else:
1300
 
                result.set_parent(master_branch.bzrdir.root_transport.base)
 
1301
                result.set_parent(master_url)
1301
1302
        finally:
1302
1303
            result.unlock()
1303
1304
        return result
1377
1378
        # TODO: We should probably also check that self.revision_history
1378
1379
        # matches the repository for older branch formats.
1379
1380
        # If looking for the code that cross-checks repository parents against
1380
 
        # the iter_reverse_revision_history output, that is now a repository
 
1381
        # the Graph.iter_lefthand_ancestry output, that is now a repository
1381
1382
        # specific check.
1382
1383
        return result
1383
1384
 
1384
 
    def _get_checkout_format(self):
 
1385
    def _get_checkout_format(self, lightweight=False):
1385
1386
        """Return the most suitable metadir for a checkout of this branch.
1386
1387
        Weaves are used if this branch's repository uses weaves.
1387
1388
        """
1433
1434
        """
1434
1435
        t = transport.get_transport(to_location)
1435
1436
        t.ensure_base()
 
1437
        format = self._get_checkout_format(lightweight=lightweight)
 
1438
        try:
 
1439
            checkout = format.initialize_on_transport(t)
 
1440
        except errors.AlreadyControlDirError:
 
1441
            # It's fine if the control directory already exists,
 
1442
            # as long as there is no existing branch and working tree.
 
1443
            checkout = controldir.ControlDir.open_from_transport(t)
 
1444
            try:
 
1445
                checkout.open_branch()
 
1446
            except errors.NotBranchError:
 
1447
                pass
 
1448
            else:
 
1449
                raise errors.AlreadyControlDirError(t.base)
 
1450
            if checkout.control_transport.base == self.bzrdir.control_transport.base:
 
1451
                # When checking out to the same control directory,
 
1452
                # always create a lightweight checkout
 
1453
                lightweight = True
 
1454
 
1436
1455
        if lightweight:
1437
 
            format = self._get_checkout_format()
1438
 
            checkout = format.initialize_on_transport(t)
1439
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1440
 
                target_branch=self)
 
1456
            from_branch = checkout.set_branch_reference(target_branch=self)
1441
1457
        else:
1442
 
            format = self._get_checkout_format()
1443
 
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1444
 
                to_location, force_new_tree=False, format=format)
1445
 
            checkout = checkout_branch.bzrdir
 
1458
            policy = checkout.determine_repository_policy()
 
1459
            repo = policy.acquire_repository()[0]
 
1460
            checkout_branch = checkout.create_branch()
1446
1461
            checkout_branch.bind(self)
1447
1462
            # pull up to the specified revision_id to set the initial
1448
1463
            # branch tip correctly, and seed it with history.
1449
1464
            checkout_branch.pull(self, stop_revision=revision_id)
1450
 
            from_branch=None
 
1465
            from_branch = None
1451
1466
        tree = checkout.create_workingtree(revision_id,
1452
1467
                                           from_branch=from_branch,
1453
1468
                                           accelerator_tree=accelerator_tree,
1542
1557
            heads that must be fetched if present, but no error is necessary if
1543
1558
            they are not present.
1544
1559
        """
1545
 
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
1546
 
        # are the tags.
 
1560
        # For bzr native formats must_fetch is just the tip, and
 
1561
        # if_present_fetch are the tags.
1547
1562
        must_fetch = set([self.last_revision()])
1548
 
        try:
1549
 
            if_present_fetch = set(self.tags.get_reverse_tag_dict())
1550
 
        except errors.TagsNotSupported:
1551
 
            if_present_fetch = set()
 
1563
        if_present_fetch = set()
 
1564
        if self.get_config_stack().get('branch.fetch_tags'):
 
1565
            try:
 
1566
                if_present_fetch = set(self.tags.get_reverse_tag_dict())
 
1567
            except errors.TagsNotSupported:
 
1568
                pass
1552
1569
        must_fetch.discard(_mod_revision.NULL_REVISION)
1553
1570
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
1554
1571
        return must_fetch, if_present_fetch
1559
1576
 
1560
1577
    Formats provide three things:
1561
1578
     * An initialization routine,
1562
 
     * a format string,
 
1579
     * a format description
1563
1580
     * an open routine.
1564
1581
 
1565
1582
    Formats are placed in an dict by their format string for reference
1572
1589
    object will be created every time regardless.
1573
1590
    """
1574
1591
 
1575
 
    can_set_append_revisions_only = True
1576
 
 
1577
1592
    def __eq__(self, other):
1578
1593
        return self.__class__ is other.__class__
1579
1594
 
1580
1595
    def __ne__(self, other):
1581
1596
        return not (self == other)
1582
1597
 
1583
 
    @classmethod
1584
 
    def find_format(klass, a_bzrdir, name=None):
1585
 
        """Return the format for the branch object in a_bzrdir."""
1586
 
        try:
1587
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1588
 
            format_string = transport.get_bytes("format")
1589
 
            return format_registry.get(format_string)
1590
 
        except errors.NoSuchFile:
1591
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1592
 
        except KeyError:
1593
 
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1594
 
 
1595
 
    @classmethod
1596
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1597
 
    def get_default_format(klass):
1598
 
        """Return the current default format."""
1599
 
        return format_registry.get_default()
1600
 
 
1601
 
    @classmethod
1602
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1603
 
    def get_formats(klass):
1604
 
        """Get all the known formats.
1605
 
 
1606
 
        Warning: This triggers a load of all lazy registered formats: do not
1607
 
        use except when that is desireed.
1608
 
        """
1609
 
        return format_registry._get_all()
1610
 
 
1611
 
    def get_reference(self, a_bzrdir, name=None):
1612
 
        """Get the target reference of the branch in a_bzrdir.
 
1598
    def get_reference(self, controldir, name=None):
 
1599
        """Get the target reference of the branch in controldir.
1613
1600
 
1614
1601
        format probing must have been completed before calling
1615
1602
        this method - it is assumed that the format of the branch
1616
 
        in a_bzrdir is correct.
 
1603
        in controldir is correct.
1617
1604
 
1618
 
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1605
        :param controldir: The controldir to get the branch data from.
1619
1606
        :param name: Name of the colocated branch to fetch
1620
1607
        :return: None if the branch is not a reference branch.
1621
1608
        """
1622
1609
        return None
1623
1610
 
1624
1611
    @classmethod
1625
 
    def set_reference(self, a_bzrdir, name, to_branch):
1626
 
        """Set the target reference of the branch in a_bzrdir.
 
1612
    def set_reference(self, controldir, name, to_branch):
 
1613
        """Set the target reference of the branch in controldir.
1627
1614
 
1628
1615
        format probing must have been completed before calling
1629
1616
        this method - it is assumed that the format of the branch
1630
 
        in a_bzrdir is correct.
 
1617
        in controldir is correct.
1631
1618
 
1632
 
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1619
        :param controldir: The controldir to set the branch reference for.
1633
1620
        :param name: Name of colocated branch to set, None for default
1634
1621
        :param to_branch: branch that the checkout is to reference
1635
1622
        """
1636
1623
        raise NotImplementedError(self.set_reference)
1637
1624
 
1638
 
    def get_format_string(self):
1639
 
        """Return the ASCII format string that identifies this format."""
1640
 
        raise NotImplementedError(self.get_format_string)
1641
 
 
1642
1625
    def get_format_description(self):
1643
1626
        """Return the short format description for this format."""
1644
1627
        raise NotImplementedError(self.get_format_description)
1645
1628
 
1646
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
 
1629
    def _run_post_branch_init_hooks(self, controldir, name, branch):
1647
1630
        hooks = Branch.hooks['post_branch_init']
1648
1631
        if not hooks:
1649
1632
            return
1650
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
 
1633
        params = BranchInitHookParams(self, controldir, name, branch)
1651
1634
        for hook in hooks:
1652
1635
            hook(params)
1653
1636
 
1654
 
    def initialize(self, a_bzrdir, name=None, repository=None):
1655
 
        """Create a branch of this format in a_bzrdir.
1656
 
        
 
1637
    def initialize(self, controldir, name=None, repository=None,
 
1638
                   append_revisions_only=None):
 
1639
        """Create a branch of this format in controldir.
 
1640
 
1657
1641
        :param name: Name of the colocated branch to create.
1658
1642
        """
1659
1643
        raise NotImplementedError(self.initialize)
1679
1663
        Note that it is normal for branch to be a RemoteBranch when using tags
1680
1664
        on a RemoteBranch.
1681
1665
        """
1682
 
        return DisabledTags(branch)
 
1666
        return _mod_tag.DisabledTags(branch)
1683
1667
 
1684
1668
    def network_name(self):
1685
1669
        """A simple byte string uniquely identifying this format for RPC calls.
1691
1675
        """
1692
1676
        raise NotImplementedError(self.network_name)
1693
1677
 
1694
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
1695
 
            found_repository=None):
1696
 
        """Return the branch object for a_bzrdir
 
1678
    def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
 
1679
            found_repository=None, possible_transports=None):
 
1680
        """Return the branch object for controldir.
1697
1681
 
1698
 
        :param a_bzrdir: A BzrDir that contains a branch.
 
1682
        :param controldir: A ControlDir that contains a branch.
1699
1683
        :param name: Name of colocated branch to open
1700
1684
        :param _found: a private parameter, do not use it. It is used to
1701
1685
            indicate if format probing has already be done.
1704
1688
        """
1705
1689
        raise NotImplementedError(self.open)
1706
1690
 
1707
 
    @classmethod
1708
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1709
 
    def register_format(klass, format):
1710
 
        """Register a metadir format.
1711
 
 
1712
 
        See MetaDirBranchFormatFactory for the ability to register a format
1713
 
        without loading the code the format needs until it is actually used.
1714
 
        """
1715
 
        format_registry.register(format)
1716
 
 
1717
 
    @classmethod
1718
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1719
 
    def set_default_format(klass, format):
1720
 
        format_registry.set_default(format)
1721
 
 
1722
1691
    def supports_set_append_revisions_only(self):
1723
1692
        """True if this format supports set_append_revisions_only."""
1724
1693
        return False
1731
1700
        """True if this format supports leaving locks in place."""
1732
1701
        return False # by default
1733
1702
 
1734
 
    @classmethod
1735
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1736
 
    def unregister_format(klass, format):
1737
 
        format_registry.remove(format)
1738
 
 
1739
1703
    def __str__(self):
1740
1704
        return self.get_format_description().rstrip()
1741
1705
 
1743
1707
        """True if this format supports tags stored in the branch"""
1744
1708
        return False  # by default
1745
1709
 
 
1710
    def tags_are_versioned(self):
 
1711
        """Whether the tag container for this branch versions tags."""
 
1712
        return False
 
1713
 
 
1714
    def supports_tags_referencing_ghosts(self):
 
1715
        """True if tags can reference ghost revisions."""
 
1716
        return True
 
1717
 
1746
1718
 
1747
1719
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1748
1720
    """A factory for a BranchFormat object, permitting simple lazy registration.
1762
1734
        """
1763
1735
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
1764
1736
        self._format_string = format_string
1765
 
        
 
1737
 
1766
1738
    def get_format_string(self):
1767
1739
        """See BranchFormat.get_format_string."""
1768
1740
        return self._format_string
1775
1747
class BranchHooks(Hooks):
1776
1748
    """A dictionary mapping hook name to a list of callables for branch hooks.
1777
1749
 
1778
 
    e.g. ['set_rh'] Is the list of items to be called when the
1779
 
    set_revision_history function is invoked.
 
1750
    e.g. ['post_push'] Is the list of items to be called when the
 
1751
    push function is invoked.
1780
1752
    """
1781
1753
 
1782
1754
    def __init__(self):
1786
1758
        notified.
1787
1759
        """
1788
1760
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1789
 
        self.add_hook('set_rh',
1790
 
            "Invoked whenever the revision history has been set via "
1791
 
            "set_revision_history. The api signature is (branch, "
1792
 
            "revision_history), and the branch will be write-locked. "
1793
 
            "The set_rh hook can be expensive for bzr to trigger, a better "
1794
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
1795
1761
        self.add_hook('open',
1796
1762
            "Called with the Branch object that has been opened after a "
1797
1763
            "branch is opened.", (1, 8))
1913
1879
    There are 4 fields that hooks may wish to access:
1914
1880
 
1915
1881
    :ivar format: the branch format
1916
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
 
1882
    :ivar bzrdir: the ControlDir where the branch will be/has been initialized
1917
1883
    :ivar name: name of colocated branch, if any (or None)
1918
1884
    :ivar branch: the branch created
1919
1885
 
1922
1888
    branch, which refer to the original branch.
1923
1889
    """
1924
1890
 
1925
 
    def __init__(self, format, a_bzrdir, name, branch):
 
1891
    def __init__(self, format, controldir, name, branch):
1926
1892
        """Create a group of BranchInitHook parameters.
1927
1893
 
1928
1894
        :param format: the branch format
1929
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
 
1895
        :param controldir: the ControlDir where the branch will be/has been
1930
1896
            initialized
1931
1897
        :param name: name of colocated branch, if any (or None)
1932
1898
        :param branch: the branch created
1936
1902
        in branch, which refer to the original branch.
1937
1903
        """
1938
1904
        self.format = format
1939
 
        self.bzrdir = a_bzrdir
 
1905
        self.bzrdir = controldir
1940
1906
        self.name = name
1941
1907
        self.branch = branch
1942
1908
 
1952
1918
 
1953
1919
    There are 4 fields that hooks may wish to access:
1954
1920
 
1955
 
    :ivar control_dir: BzrDir of the checkout to change
 
1921
    :ivar control_dir: ControlDir of the checkout to change
1956
1922
    :ivar to_branch: branch that the checkout is to reference
1957
1923
    :ivar force: skip the check for local commits in a heavy checkout
1958
1924
    :ivar revision_id: revision ID to switch to (or None)
1961
1927
    def __init__(self, control_dir, to_branch, force, revision_id):
1962
1928
        """Create a group of SwitchHook parameters.
1963
1929
 
1964
 
        :param control_dir: BzrDir of the checkout to change
 
1930
        :param control_dir: ControlDir of the checkout to change
1965
1931
        :param to_branch: branch that the checkout is to reference
1966
1932
        :param force: skip the check for local commits in a heavy checkout
1967
1933
        :param revision_id: revision ID to switch to (or None)
1980
1946
            self.revision_id)
1981
1947
 
1982
1948
 
1983
 
class BranchFormatMetadir(BranchFormat):
1984
 
    """Common logic for meta-dir based branch formats."""
 
1949
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
 
1950
    """Base class for branch formats that live in meta directories.
 
1951
    """
 
1952
 
 
1953
    def __init__(self):
 
1954
        BranchFormat.__init__(self)
 
1955
        bzrdir.BzrFormat.__init__(self)
 
1956
 
 
1957
    @classmethod
 
1958
    def find_format(klass, controldir, name=None):
 
1959
        """Return the format for the branch object in controldir."""
 
1960
        try:
 
1961
            transport = controldir.get_branch_transport(None, name=name)
 
1962
        except errors.NoSuchFile:
 
1963
            raise errors.NotBranchError(path=name, bzrdir=controldir)
 
1964
        try:
 
1965
            format_string = transport.get_bytes("format")
 
1966
        except errors.NoSuchFile:
 
1967
            raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
 
1968
        return klass._find_format(format_registry, 'branch', format_string)
1985
1969
 
1986
1970
    def _branch_class(self):
1987
1971
        """What class to instantiate on open calls."""
1988
1972
        raise NotImplementedError(self._branch_class)
1989
1973
 
 
1974
    def _get_initial_config(self, append_revisions_only=None):
 
1975
        if append_revisions_only:
 
1976
            return "append_revisions_only = True\n"
 
1977
        else:
 
1978
            # Avoid writing anything if append_revisions_only is disabled,
 
1979
            # as that is the default.
 
1980
            return ""
 
1981
 
1990
1982
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1991
1983
                           repository=None):
1992
 
        """Initialize a branch in a bzrdir, with specified files
 
1984
        """Initialize a branch in a control dir, with specified files
1993
1985
 
1994
1986
        :param a_bzrdir: The bzrdir to initialize the branch in
1995
1987
        :param utf8_files: The files to create as a list of
1997
1989
        :param name: Name of colocated branch to create, if any
1998
1990
        :return: a branch in this format
1999
1991
        """
 
1992
        if name is None:
 
1993
            name = a_bzrdir._get_selected_branch()
2000
1994
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2001
1995
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2002
1996
        control_files = lockable_files.LockableFiles(branch_transport,
2004
1998
        control_files.create_lock()
2005
1999
        control_files.lock_write()
2006
2000
        try:
2007
 
            utf8_files += [('format', self.get_format_string())]
 
2001
            utf8_files += [('format', self.as_string())]
2008
2002
            for (filename, content) in utf8_files:
2009
2003
                branch_transport.put_bytes(
2010
2004
                    filename, content,
2016
2010
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2017
2011
        return branch
2018
2012
 
2019
 
    def network_name(self):
2020
 
        """A simple byte string uniquely identifying this format for RPC calls.
2021
 
 
2022
 
        Metadir branch formats use their format string.
2023
 
        """
2024
 
        return self.get_format_string()
2025
 
 
2026
2013
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2027
 
            found_repository=None):
 
2014
            found_repository=None, possible_transports=None):
2028
2015
        """See BranchFormat.open()."""
 
2016
        if name is None:
 
2017
            name = a_bzrdir._get_selected_branch()
2029
2018
        if not _found:
2030
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2019
            format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2031
2020
            if format.__class__ != self.__class__:
2032
2021
                raise AssertionError("wrong format %r found for %r" %
2033
2022
                    (format, self))
2042
2031
                              name=name,
2043
2032
                              a_bzrdir=a_bzrdir,
2044
2033
                              _repository=found_repository,
2045
 
                              ignore_fallbacks=ignore_fallbacks)
 
2034
                              ignore_fallbacks=ignore_fallbacks,
 
2035
                              possible_transports=possible_transports)
2046
2036
        except errors.NoSuchFile:
2047
2037
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2048
2038
 
2049
 
    def __init__(self):
2050
 
        super(BranchFormatMetadir, self).__init__()
2051
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2052
 
        self._matchingbzrdir.set_branch_format(self)
 
2039
    @property
 
2040
    def _matchingbzrdir(self):
 
2041
        ret = bzrdir.BzrDirMetaFormat1()
 
2042
        ret.set_branch_format(self)
 
2043
        return ret
2053
2044
 
2054
2045
    def supports_tags(self):
2055
2046
        return True
2057
2048
    def supports_leaving_lock(self):
2058
2049
        return True
2059
2050
 
2060
 
 
2061
 
class BzrBranchFormat5(BranchFormatMetadir):
2062
 
    """Bzr branch format 5.
2063
 
 
2064
 
    This format has:
2065
 
     - a revision-history file.
2066
 
     - a format string
2067
 
     - a lock dir guarding the branch itself
2068
 
     - all of this stored in a branch/ subdirectory
2069
 
     - works with shared repositories.
2070
 
 
2071
 
    This format is new in bzr 0.8.
2072
 
    """
2073
 
 
2074
 
    def _branch_class(self):
2075
 
        return BzrBranch5
2076
 
 
2077
 
    def get_format_string(self):
2078
 
        """See BranchFormat.get_format_string()."""
2079
 
        return "Bazaar-NG branch format 5\n"
2080
 
 
2081
 
    def get_format_description(self):
2082
 
        """See BranchFormat.get_format_description()."""
2083
 
        return "Branch format 5"
2084
 
 
2085
 
    def initialize(self, a_bzrdir, name=None, repository=None):
2086
 
        """Create a branch of this format in a_bzrdir."""
2087
 
        utf8_files = [('revision-history', ''),
2088
 
                      ('branch-name', ''),
2089
 
                      ]
2090
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2091
 
 
2092
 
    def supports_tags(self):
2093
 
        return False
 
2051
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
2052
            basedir=None):
 
2053
        BranchFormat.check_support_status(self,
 
2054
            allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
 
2055
            basedir=basedir)
 
2056
        bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
 
2057
            recommend_upgrade=recommend_upgrade, basedir=basedir)
2094
2058
 
2095
2059
 
2096
2060
class BzrBranchFormat6(BranchFormatMetadir):
2107
2071
    def _branch_class(self):
2108
2072
        return BzrBranch6
2109
2073
 
2110
 
    def get_format_string(self):
 
2074
    @classmethod
 
2075
    def get_format_string(cls):
2111
2076
        """See BranchFormat.get_format_string()."""
2112
2077
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
2113
2078
 
2115
2080
        """See BranchFormat.get_format_description()."""
2116
2081
        return "Branch format 6"
2117
2082
 
2118
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
2083
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2084
                   append_revisions_only=None):
2119
2085
        """Create a branch of this format in a_bzrdir."""
2120
2086
        utf8_files = [('last-revision', '0 null:\n'),
2121
 
                      ('branch.conf', ''),
 
2087
                      ('branch.conf',
 
2088
                          self._get_initial_config(append_revisions_only)),
2122
2089
                      ('tags', ''),
2123
2090
                      ]
2124
2091
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2125
2092
 
2126
2093
    def make_tags(self, branch):
2127
2094
        """See bzrlib.branch.BranchFormat.make_tags()."""
2128
 
        return BasicTags(branch)
 
2095
        return _mod_tag.BasicTags(branch)
2129
2096
 
2130
2097
    def supports_set_append_revisions_only(self):
2131
2098
        return True
2137
2104
    def _branch_class(self):
2138
2105
        return BzrBranch8
2139
2106
 
2140
 
    def get_format_string(self):
 
2107
    @classmethod
 
2108
    def get_format_string(cls):
2141
2109
        """See BranchFormat.get_format_string()."""
2142
2110
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2143
2111
 
2145
2113
        """See BranchFormat.get_format_description()."""
2146
2114
        return "Branch format 8"
2147
2115
 
2148
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
2116
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2117
                   append_revisions_only=None):
2149
2118
        """Create a branch of this format in a_bzrdir."""
2150
2119
        utf8_files = [('last-revision', '0 null:\n'),
2151
 
                      ('branch.conf', ''),
 
2120
                      ('branch.conf',
 
2121
                          self._get_initial_config(append_revisions_only)),
2152
2122
                      ('tags', ''),
2153
2123
                      ('references', '')
2154
2124
                      ]
2156
2126
 
2157
2127
    def make_tags(self, branch):
2158
2128
        """See bzrlib.branch.BranchFormat.make_tags()."""
2159
 
        return BasicTags(branch)
 
2129
        return _mod_tag.BasicTags(branch)
2160
2130
 
2161
2131
    def supports_set_append_revisions_only(self):
2162
2132
        return True
2176
2146
    This format was introduced in bzr 1.6.
2177
2147
    """
2178
2148
 
2179
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
2149
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2150
                   append_revisions_only=None):
2180
2151
        """Create a branch of this format in a_bzrdir."""
2181
2152
        utf8_files = [('last-revision', '0 null:\n'),
2182
 
                      ('branch.conf', ''),
 
2153
                      ('branch.conf',
 
2154
                          self._get_initial_config(append_revisions_only)),
2183
2155
                      ('tags', ''),
2184
2156
                      ]
2185
2157
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2187
2159
    def _branch_class(self):
2188
2160
        return BzrBranch7
2189
2161
 
2190
 
    def get_format_string(self):
 
2162
    @classmethod
 
2163
    def get_format_string(cls):
2191
2164
        """See BranchFormat.get_format_string()."""
2192
2165
        return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2193
2166
 
2203
2176
 
2204
2177
    def make_tags(self, branch):
2205
2178
        """See bzrlib.branch.BranchFormat.make_tags()."""
2206
 
        return BasicTags(branch)
 
2179
        return _mod_tag.BasicTags(branch)
2207
2180
 
2208
2181
    supports_reference_locations = False
2209
2182
 
2210
2183
 
2211
 
class BranchReferenceFormat(BranchFormat):
 
2184
class BranchReferenceFormat(BranchFormatMetadir):
2212
2185
    """Bzr branch reference format.
2213
2186
 
2214
2187
    Branch references are used in implementing checkouts, they
2219
2192
     - a format string
2220
2193
    """
2221
2194
 
2222
 
    def get_format_string(self):
 
2195
    @classmethod
 
2196
    def get_format_string(cls):
2223
2197
        """See BranchFormat.get_format_string()."""
2224
2198
        return "Bazaar-NG Branch Reference Format 1\n"
2225
2199
 
2238
2212
        location = transport.put_bytes('location', to_branch.base)
2239
2213
 
2240
2214
    def initialize(self, a_bzrdir, name=None, target_branch=None,
2241
 
            repository=None):
 
2215
            repository=None, append_revisions_only=None):
2242
2216
        """Create a branch of this format in a_bzrdir."""
2243
2217
        if target_branch is None:
2244
2218
            # this format does not implement branch itself, thus the implicit
2245
2219
            # creation contract must see it as uninitializable
2246
2220
            raise errors.UninitializableFormat(self)
2247
2221
        mutter('creating branch reference in %s', a_bzrdir.user_url)
 
2222
        if a_bzrdir._format.fixed_components:
 
2223
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
 
2224
        if name is None:
 
2225
            name = a_bzrdir._get_selected_branch()
2248
2226
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2249
2227
        branch_transport.put_bytes('location',
2250
 
            target_branch.bzrdir.user_url)
2251
 
        branch_transport.put_bytes('format', self.get_format_string())
2252
 
        branch = self.open(
2253
 
            a_bzrdir, name, _found=True,
 
2228
            target_branch.user_url)
 
2229
        branch_transport.put_bytes('format', self.as_string())
 
2230
        branch = self.open(a_bzrdir, name, _found=True,
2254
2231
            possible_transports=[target_branch.bzrdir.root_transport])
2255
2232
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2256
2233
        return branch
2257
2234
 
2258
 
    def __init__(self):
2259
 
        super(BranchReferenceFormat, self).__init__()
2260
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2261
 
        self._matchingbzrdir.set_branch_format(self)
2262
 
 
2263
2235
    def _make_reference_clone_function(format, a_branch):
2264
2236
        """Create a clone() routine for a branch dynamically."""
2265
2237
        def clone(to_bzrdir, revision_id=None,
2287
2259
            a_bzrdir.
2288
2260
        :param possible_transports: An optional reusable transports list.
2289
2261
        """
 
2262
        if name is None:
 
2263
            name = a_bzrdir._get_selected_branch()
2290
2264
        if not _found:
2291
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2265
            format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2292
2266
            if format.__class__ != self.__class__:
2293
2267
                raise AssertionError("wrong format %r found for %r" %
2294
2268
                    (format, self))
2295
2269
        if location is None:
2296
2270
            location = self.get_reference(a_bzrdir, name)
2297
 
        real_bzrdir = bzrdir.BzrDir.open(
 
2271
        real_bzrdir = controldir.ControlDir.open(
2298
2272
            location, possible_transports=possible_transports)
2299
 
        result = real_bzrdir.open_branch(name=name, 
2300
 
            ignore_fallbacks=ignore_fallbacks)
 
2273
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks,
 
2274
            possible_transports=possible_transports)
2301
2275
        # this changes the behaviour of result.clone to create a new reference
2302
2276
        # rather than a copy of the content of the branch.
2303
2277
        # I did not use a proxy object because that needs much more extensive
2337
2311
 
2338
2312
# formats which have no format string are not discoverable
2339
2313
# and not independently creatable, so are not registered.
2340
 
__format5 = BzrBranchFormat5()
2341
2314
__format6 = BzrBranchFormat6()
2342
2315
__format7 = BzrBranchFormat7()
2343
2316
__format8 = BzrBranchFormat8()
2344
 
format_registry.register(__format5)
 
2317
format_registry.register_lazy(
 
2318
    "Bazaar-NG branch format 5\n", "bzrlib.branchfmt.fullhistory", "BzrBranchFormat5")
2345
2319
format_registry.register(BranchReferenceFormat())
2346
2320
format_registry.register(__format6)
2347
2321
format_registry.register(__format7)
2384
2358
 
2385
2359
    def __init__(self, _format=None,
2386
2360
                 _control_files=None, a_bzrdir=None, name=None,
2387
 
                 _repository=None, ignore_fallbacks=False):
 
2361
                 _repository=None, ignore_fallbacks=False,
 
2362
                 possible_transports=None):
2388
2363
        """Create new branch object at a particular location."""
2389
2364
        if a_bzrdir is None:
2390
2365
            raise ValueError('a_bzrdir must be supplied')
2391
 
        else:
2392
 
            self.bzrdir = a_bzrdir
2393
 
        self._base = self.bzrdir.transport.clone('..').base
 
2366
        if name is None:
 
2367
            raise ValueError('name must be supplied')
 
2368
        self.bzrdir = a_bzrdir
 
2369
        self._user_transport = self.bzrdir.transport.clone('..')
 
2370
        if name != "":
 
2371
            self._user_transport.set_segment_parameter(
 
2372
                "branch", urlutils.escape(name))
 
2373
        self._base = self._user_transport.base
2394
2374
        self.name = name
2395
 
        # XXX: We should be able to just do
2396
 
        #   self.base = self.bzrdir.root_transport.base
2397
 
        # but this does not quite work yet -- mbp 20080522
2398
2375
        self._format = _format
2399
2376
        if _control_files is None:
2400
2377
            raise ValueError('BzrBranch _control_files is None')
2401
2378
        self.control_files = _control_files
2402
2379
        self._transport = _control_files._transport
2403
2380
        self.repository = _repository
2404
 
        Branch.__init__(self)
 
2381
        self.conf_store = None
 
2382
        Branch.__init__(self, possible_transports)
2405
2383
 
2406
2384
    def __str__(self):
2407
 
        if self.name is None:
2408
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2409
 
        else:
2410
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2411
 
                self.name)
 
2385
        return '%s(%s)' % (self.__class__.__name__, self.user_url)
2412
2386
 
2413
2387
    __repr__ = __str__
2414
2388
 
2418
2392
 
2419
2393
    base = property(_get_base, doc="The URL for the root of this branch.")
2420
2394
 
 
2395
    @property
 
2396
    def user_transport(self):
 
2397
        return self._user_transport
 
2398
 
2421
2399
    def _get_config(self):
2422
 
        return TransportConfig(self._transport, 'branch.conf')
 
2400
        return _mod_config.TransportConfig(self._transport, 'branch.conf')
 
2401
 
 
2402
    def _get_config_store(self):
 
2403
        if self.conf_store is None:
 
2404
            self.conf_store =  _mod_config.BranchStore(self)
 
2405
        return self.conf_store
 
2406
 
 
2407
    def _uncommitted_branch(self):
 
2408
        """Return the branch that may contain uncommitted changes."""
 
2409
        master = self.get_master_branch()
 
2410
        if master is not None:
 
2411
            return master
 
2412
        else:
 
2413
            return self
 
2414
 
 
2415
    def store_uncommitted(self, creator):
 
2416
        """Store uncommitted changes from a ShelfCreator.
 
2417
 
 
2418
        :param creator: The ShelfCreator containing uncommitted changes, or
 
2419
            None to delete any stored changes.
 
2420
        :raises: ChangesAlreadyStored if the branch already has changes.
 
2421
        """
 
2422
        branch = self._uncommitted_branch()
 
2423
        if creator is None:
 
2424
            branch._transport.delete('stored-transform')
 
2425
            return
 
2426
        if branch._transport.has('stored-transform'):
 
2427
            raise errors.ChangesAlreadyStored
 
2428
        transform = StringIO()
 
2429
        creator.write_shelf(transform)
 
2430
        transform.seek(0)
 
2431
        branch._transport.put_file('stored-transform', transform)
 
2432
 
 
2433
    def get_unshelver(self, tree):
 
2434
        """Return a shelf.Unshelver for this branch and tree.
 
2435
 
 
2436
        :param tree: The tree to use to construct the Unshelver.
 
2437
        :return: an Unshelver or None if no changes are stored.
 
2438
        """
 
2439
        branch = self._uncommitted_branch()
 
2440
        try:
 
2441
            transform = branch._transport.get('stored-transform')
 
2442
        except errors.NoSuchFile:
 
2443
            return None
 
2444
        return shelf.Unshelver.from_tree_and_shelf(tree, transform)
2423
2445
 
2424
2446
    def is_locked(self):
2425
2447
        return self.control_files.is_locked()
2433
2455
        """
2434
2456
        if not self.is_locked():
2435
2457
            self._note_lock('w')
2436
 
        # All-in-one needs to always unlock/lock.
2437
 
        repo_control = getattr(self.repository, 'control_files', None)
2438
 
        if self.control_files == repo_control or not self.is_locked():
2439
2458
            self.repository._warn_if_deprecated(self)
2440
2459
            self.repository.lock_write()
2441
2460
            took_lock = True
2456
2475
        """
2457
2476
        if not self.is_locked():
2458
2477
            self._note_lock('r')
2459
 
        # All-in-one needs to always unlock/lock.
2460
 
        repo_control = getattr(self.repository, 'control_files', None)
2461
 
        if self.control_files == repo_control or not self.is_locked():
2462
2478
            self.repository._warn_if_deprecated(self)
2463
2479
            self.repository.lock_read()
2464
2480
            took_lock = True
2474
2490
 
2475
2491
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2476
2492
    def unlock(self):
 
2493
        if self.control_files._lock_count == 1 and self.conf_store is not None:
 
2494
            self.conf_store.save_changes()
2477
2495
        try:
2478
2496
            self.control_files.unlock()
2479
2497
        finally:
2480
 
            # All-in-one needs to always unlock/lock.
2481
 
            repo_control = getattr(self.repository, 'control_files', None)
2482
 
            if (self.control_files == repo_control or
2483
 
                not self.control_files.is_locked()):
2484
 
                self.repository.unlock()
2485
2498
            if not self.control_files.is_locked():
 
2499
                self.repository.unlock()
2486
2500
                # we just released the lock
2487
2501
                self._clear_cached_state()
2488
2502
 
2506
2520
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2507
2521
        revision_id = _mod_revision.ensure_null(revision_id)
2508
2522
        old_revno, old_revid = self.last_revision_info()
2509
 
        if self._get_append_revisions_only():
 
2523
        if self.get_append_revisions_only():
2510
2524
            self._check_history_violation(revision_id)
2511
2525
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2512
2526
        self._write_last_revision_info(revno, revision_id)
2655
2669
        self._transport.put_bytes('last-revision', out_string,
2656
2670
            mode=self.bzrdir._get_file_mode())
2657
2671
 
2658
 
 
2659
 
class FullHistoryBzrBranch(BzrBranch):
2660
 
    """Bzr branch which contains the full revision history."""
2661
 
 
2662
 
    @needs_write_lock
2663
 
    def set_last_revision_info(self, revno, revision_id):
2664
 
        if not revision_id or not isinstance(revision_id, basestring):
2665
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2666
 
        revision_id = _mod_revision.ensure_null(revision_id)
2667
 
        # this old format stores the full history, but this api doesn't
2668
 
        # provide it, so we must generate, and might as well check it's
2669
 
        # correct
2670
 
        history = self._lefthand_history(revision_id)
2671
 
        if len(history) != revno:
2672
 
            raise AssertionError('%d != %d' % (len(history), revno))
2673
 
        self._set_revision_history(history)
2674
 
 
2675
 
    def _read_last_revision_info(self):
2676
 
        rh = self.revision_history()
2677
 
        revno = len(rh)
2678
 
        if revno:
2679
 
            return (revno, rh[-1])
2680
 
        else:
2681
 
            return (0, _mod_revision.NULL_REVISION)
2682
 
 
2683
 
    @deprecated_method(deprecated_in((2, 4, 0)))
2684
 
    @needs_write_lock
2685
 
    def set_revision_history(self, rev_history):
2686
 
        """See Branch.set_revision_history."""
2687
 
        self._set_revision_history(rev_history)
2688
 
 
2689
 
    def _set_revision_history(self, rev_history):
2690
 
        if 'evil' in debug.debug_flags:
2691
 
            mutter_callsite(3, "set_revision_history scales with history.")
2692
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
2693
 
        for rev_id in rev_history:
2694
 
            check_not_reserved_id(rev_id)
2695
 
        if Branch.hooks['post_change_branch_tip']:
2696
 
            # Don't calculate the last_revision_info() if there are no hooks
2697
 
            # that will use it.
2698
 
            old_revno, old_revid = self.last_revision_info()
2699
 
        if len(rev_history) == 0:
2700
 
            revid = _mod_revision.NULL_REVISION
2701
 
        else:
2702
 
            revid = rev_history[-1]
2703
 
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2704
 
        self._write_revision_history(rev_history)
2705
 
        self._clear_cached_state()
2706
 
        self._cache_revision_history(rev_history)
2707
 
        for hook in Branch.hooks['set_rh']:
2708
 
            hook(self, rev_history)
2709
 
        if Branch.hooks['post_change_branch_tip']:
2710
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2711
 
 
2712
 
    def _write_revision_history(self, history):
2713
 
        """Factored out of set_revision_history.
2714
 
 
2715
 
        This performs the actual writing to disk.
2716
 
        It is intended to be called by set_revision_history."""
2717
 
        self._transport.put_bytes(
2718
 
            'revision-history', '\n'.join(history),
2719
 
            mode=self.bzrdir._get_file_mode())
2720
 
 
2721
 
    def _gen_revision_history(self):
2722
 
        history = self._transport.get_bytes('revision-history').split('\n')
2723
 
        if history[-1:] == ['']:
2724
 
            # There shouldn't be a trailing newline, but just in case.
2725
 
            history.pop()
2726
 
        return history
2727
 
 
2728
 
    def _synchronize_history(self, destination, revision_id):
2729
 
        if not isinstance(destination, FullHistoryBzrBranch):
2730
 
            super(BzrBranch, self)._synchronize_history(
2731
 
                destination, revision_id)
2732
 
            return
2733
 
        if revision_id == _mod_revision.NULL_REVISION:
2734
 
            new_history = []
2735
 
        else:
2736
 
            new_history = self.revision_history()
2737
 
        if revision_id is not None and new_history != []:
2738
 
            try:
2739
 
                new_history = new_history[:new_history.index(revision_id) + 1]
2740
 
            except ValueError:
2741
 
                rev = self.repository.get_revision(revision_id)
2742
 
                new_history = rev.get_history(self.repository)[1:]
2743
 
        destination._set_revision_history(new_history)
2744
 
 
2745
 
    @needs_write_lock
2746
 
    def generate_revision_history(self, revision_id, last_rev=None,
2747
 
        other_branch=None):
2748
 
        """Create a new revision history that will finish with revision_id.
2749
 
 
2750
 
        :param revision_id: the new tip to use.
2751
 
        :param last_rev: The previous last_revision. If not None, then this
2752
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
2753
 
        :param other_branch: The other branch that DivergedBranches should
2754
 
            raise with respect to.
 
2672
    @needs_write_lock
 
2673
    def update_feature_flags(self, updated_flags):
 
2674
        """Update the feature flags for this branch.
 
2675
 
 
2676
        :param updated_flags: Dictionary mapping feature names to necessities
 
2677
            A necessity can be None to indicate the feature should be removed
2755
2678
        """
2756
 
        self._set_revision_history(self._lefthand_history(revision_id,
2757
 
            last_rev, other_branch))
2758
 
 
2759
 
 
2760
 
class BzrBranch5(FullHistoryBzrBranch):
2761
 
    """A format 5 branch. This supports new features over plain branches.
2762
 
 
2763
 
    It has support for a master_branch which is the data for bound branches.
2764
 
    """
 
2679
        self._format._update_feature_flags(updated_flags)
 
2680
        self.control_transport.put_bytes('format', self._format.as_string())
2765
2681
 
2766
2682
 
2767
2683
class BzrBranch8(BzrBranch):
2768
2684
    """A branch that stores tree-reference locations."""
2769
2685
 
2770
 
    def _open_hook(self):
 
2686
    def _open_hook(self, possible_transports=None):
2771
2687
        if self._ignore_fallbacks:
2772
2688
            return
 
2689
        if possible_transports is None:
 
2690
            possible_transports = [self.bzrdir.root_transport]
2773
2691
        try:
2774
2692
            url = self.get_stacked_on_url()
2775
2693
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2783
2701
                    raise AssertionError(
2784
2702
                        "'transform_fallback_location' hook %s returned "
2785
2703
                        "None, not a URL." % hook_name)
2786
 
            self._activate_fallback_location(url)
 
2704
            self._activate_fallback_location(url,
 
2705
                possible_transports=possible_transports)
2787
2706
 
2788
2707
    def __init__(self, *args, **kwargs):
2789
2708
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2907
2826
        """See Branch.set_push_location."""
2908
2827
        self._master_branch_cache = None
2909
2828
        result = None
2910
 
        config = self.get_config()
 
2829
        conf = self.get_config_stack()
2911
2830
        if location is None:
2912
 
            if config.get_user_option('bound') != 'True':
 
2831
            if not conf.get('bound'):
2913
2832
                return False
2914
2833
            else:
2915
 
                config.set_user_option('bound', 'False', warn_masked=True)
 
2834
                conf.set('bound', 'False')
2916
2835
                return True
2917
2836
        else:
2918
2837
            self._set_config_location('bound_location', location,
2919
 
                                      config=config)
2920
 
            config.set_user_option('bound', 'True', warn_masked=True)
 
2838
                                      config=conf)
 
2839
            conf.set('bound', 'True')
2921
2840
        return True
2922
2841
 
2923
2842
    def _get_bound_location(self, bound):
2924
2843
        """Return the bound location in the config file.
2925
2844
 
2926
2845
        Return None if the bound parameter does not match"""
2927
 
        config = self.get_config()
2928
 
        config_bound = (config.get_user_option('bound') == 'True')
2929
 
        if config_bound != bound:
 
2846
        conf = self.get_config_stack()
 
2847
        if conf.get('bound') != bound:
2930
2848
            return None
2931
 
        return self._get_config_location('bound_location', config=config)
 
2849
        return self._get_config_location('bound_location', config=conf)
2932
2850
 
2933
2851
    def get_bound_location(self):
2934
 
        """See Branch.set_push_location."""
 
2852
        """See Branch.get_bound_location."""
2935
2853
        return self._get_bound_location(True)
2936
2854
 
2937
2855
    def get_old_bound_location(self):
2944
2862
        ## self._check_stackable_repo()
2945
2863
        # stacked_on_location is only ever defined in branch.conf, so don't
2946
2864
        # waste effort reading the whole stack of config files.
2947
 
        config = self.get_config()._get_branch_data_config()
 
2865
        conf = _mod_config.BranchOnlyStack(self)
2948
2866
        stacked_url = self._get_config_location('stacked_on_location',
2949
 
            config=config)
 
2867
                                                config=conf)
2950
2868
        if stacked_url is None:
2951
2869
            raise errors.NotStacked(self)
2952
 
        return stacked_url
2953
 
 
2954
 
    def _get_append_revisions_only(self):
2955
 
        return self.get_config(
2956
 
            ).get_user_option_as_bool('append_revisions_only')
 
2870
        return stacked_url.encode('utf-8')
2957
2871
 
2958
2872
    @needs_read_lock
2959
2873
    def get_rev_id(self, revno, history=None):
2989
2903
            except errors.RevisionNotPresent, e:
2990
2904
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2991
2905
            index = len(self._partial_revision_history_cache) - 1
 
2906
            if index < 0:
 
2907
                raise errors.NoSuchRevision(self, revision_id)
2992
2908
            if self._partial_revision_history_cache[index] != revision_id:
2993
2909
                raise errors.NoSuchRevision(self, revision_id)
2994
2910
        return self.revno() - index
3046
2962
    :ivar local_branch: target branch if there is a Master, else None
3047
2963
    :ivar target_branch: Target/destination branch object. (write locked)
3048
2964
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
 
2965
    :ivar tag_updates: A dict with new tags, see BasicTags.merge_to
3049
2966
    """
3050
2967
 
3051
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3052
 
    def __int__(self):
3053
 
        """Return the relative change in revno.
3054
 
 
3055
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3056
 
        """
3057
 
        return self.new_revno - self.old_revno
3058
 
 
3059
2968
    def report(self, to_file):
 
2969
        tag_conflicts = getattr(self, "tag_conflicts", None)
 
2970
        tag_updates = getattr(self, "tag_updates", None)
3060
2971
        if not is_quiet():
3061
 
            if self.old_revid == self.new_revid:
3062
 
                to_file.write('No revisions to pull.\n')
3063
 
            else:
 
2972
            if self.old_revid != self.new_revid:
3064
2973
                to_file.write('Now on revision %d.\n' % self.new_revno)
 
2974
            if tag_updates:
 
2975
                to_file.write('%d tag(s) updated.\n' % len(tag_updates))
 
2976
            if self.old_revid == self.new_revid and not tag_updates:
 
2977
                if not tag_conflicts:
 
2978
                    to_file.write('No revisions or tags to pull.\n')
 
2979
                else:
 
2980
                    to_file.write('No revisions to pull.\n')
3065
2981
        self._show_tag_conficts(to_file)
3066
2982
 
3067
2983
 
3084
3000
        target, otherwise it will be None.
3085
3001
    """
3086
3002
 
3087
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3088
 
    def __int__(self):
3089
 
        """Return the relative change in revno.
3090
 
 
3091
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3092
 
        """
3093
 
        return self.new_revno - self.old_revno
3094
 
 
3095
3003
    def report(self, to_file):
3096
 
        """Write a human-readable description of the result."""
3097
 
        if self.old_revid == self.new_revid:
3098
 
            note('No new revisions to push.')
3099
 
        else:
3100
 
            note('Pushed up to revision %d.' % self.new_revno)
 
3004
        # TODO: This function gets passed a to_file, but then
 
3005
        # ignores it and calls note() instead. This is also
 
3006
        # inconsistent with PullResult(), which writes to stdout.
 
3007
        # -- JRV20110901, bug #838853
 
3008
        tag_conflicts = getattr(self, "tag_conflicts", None)
 
3009
        tag_updates = getattr(self, "tag_updates", None)
 
3010
        if not is_quiet():
 
3011
            if self.old_revid != self.new_revid:
 
3012
                note(gettext('Pushed up to revision %d.') % self.new_revno)
 
3013
            if tag_updates:
 
3014
                note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
 
3015
            if self.old_revid == self.new_revid and not tag_updates:
 
3016
                if not tag_conflicts:
 
3017
                    note(gettext('No new revisions or tags to push.'))
 
3018
                else:
 
3019
                    note(gettext('No new revisions to push.'))
3101
3020
        self._show_tag_conficts(to_file)
3102
3021
 
3103
3022
 
3117
3036
        :param verbose: Requests more detailed display of what was checked,
3118
3037
            if any.
3119
3038
        """
3120
 
        note('checked branch %s format %s', self.branch.user_url,
3121
 
            self.branch._format)
 
3039
        note(gettext('checked branch {0} format {1}').format(
 
3040
                                self.branch.user_url, self.branch._format))
3122
3041
        for error in self.errors:
3123
 
            note('found error:%s', error)
 
3042
            note(gettext('found error:%s'), error)
3124
3043
 
3125
3044
 
3126
3045
class Converter5to6(object):
3133
3052
 
3134
3053
        # Copy source data into target
3135
3054
        new_branch._write_last_revision_info(*branch.last_revision_info())
3136
 
        new_branch.set_parent(branch.get_parent())
3137
 
        new_branch.set_bound_location(branch.get_bound_location())
3138
 
        new_branch.set_push_location(branch.get_push_location())
 
3055
        new_branch.lock_write()
 
3056
        try:
 
3057
            new_branch.set_parent(branch.get_parent())
 
3058
            new_branch.set_bound_location(branch.get_bound_location())
 
3059
            new_branch.set_push_location(branch.get_push_location())
 
3060
        finally:
 
3061
            new_branch.unlock()
3139
3062
 
3140
3063
        # New branch has no tags by default
3141
3064
        new_branch.tags._set_tag_dict({})
3142
3065
 
3143
3066
        # Copying done; now update target format
3144
3067
        new_branch._transport.put_bytes('format',
3145
 
            format.get_format_string(),
 
3068
            format.as_string(),
3146
3069
            mode=new_branch.bzrdir._get_file_mode())
3147
3070
 
3148
3071
        # Clean up old files
3149
3072
        new_branch._transport.delete('revision-history')
 
3073
        branch.lock_write()
3150
3074
        try:
3151
 
            branch.set_parent(None)
3152
 
        except errors.NoSuchFile:
3153
 
            pass
3154
 
        branch.set_bound_location(None)
 
3075
            try:
 
3076
                branch.set_parent(None)
 
3077
            except errors.NoSuchFile:
 
3078
                pass
 
3079
            branch.set_bound_location(None)
 
3080
        finally:
 
3081
            branch.unlock()
3155
3082
 
3156
3083
 
3157
3084
class Converter6to7(object):
3161
3088
        format = BzrBranchFormat7()
3162
3089
        branch._set_config_location('stacked_on_location', '')
3163
3090
        # update target format
3164
 
        branch._transport.put_bytes('format', format.get_format_string())
 
3091
        branch._transport.put_bytes('format', format.as_string())
3165
3092
 
3166
3093
 
3167
3094
class Converter7to8(object):
3168
 
    """Perform an in-place upgrade of format 6 to format 7"""
 
3095
    """Perform an in-place upgrade of format 7 to format 8"""
3169
3096
 
3170
3097
    def convert(self, branch):
3171
3098
        format = BzrBranchFormat8()
3172
3099
        branch._transport.put_bytes('references', '')
3173
3100
        # update target format
3174
 
        branch._transport.put_bytes('format', format.get_format_string())
 
3101
        branch._transport.put_bytes('format', format.as_string())
3175
3102
 
3176
3103
 
3177
3104
class InterBranch(InterObject):
3234
3161
        raise NotImplementedError(self.fetch)
3235
3162
 
3236
3163
 
 
3164
def _fix_overwrite_type(overwrite):
 
3165
    if isinstance(overwrite, bool):
 
3166
        if overwrite:
 
3167
            return ["history", "tags"]
 
3168
        else:
 
3169
            return []
 
3170
    return overwrite
 
3171
 
 
3172
 
3237
3173
class GenericInterBranch(InterBranch):
3238
3174
    """InterBranch implementation that uses public Branch functions."""
3239
3175
 
3344
3280
        if local and not bound_location:
3345
3281
            raise errors.LocalRequiresBoundBranch()
3346
3282
        master_branch = None
3347
 
        source_is_master = (self.source.user_url == bound_location)
 
3283
        source_is_master = False
 
3284
        if bound_location:
 
3285
            # bound_location comes from a config file, some care has to be
 
3286
            # taken to relate it to source.user_url
 
3287
            normalized = urlutils.normalize_url(bound_location)
 
3288
            try:
 
3289
                relpath = self.source.user_transport.relpath(normalized)
 
3290
                source_is_master = (relpath == '')
 
3291
            except (errors.PathNotChild, errors.InvalidURL):
 
3292
                source_is_master = False
3348
3293
        if not local and bound_location and not source_is_master:
3349
3294
            # not pulling from master, so we need to update master.
3350
3295
            master_branch = self.target.get_master_branch(possible_transports)
3395
3340
        result.target_branch = self.target
3396
3341
        result.old_revno, result.old_revid = self.target.last_revision_info()
3397
3342
        self.source.update_references(self.target)
 
3343
        overwrite = _fix_overwrite_type(overwrite)
3398
3344
        if result.old_revid != stop_revision:
3399
3345
            # We assume that during 'push' this repository is closer than
3400
3346
            # the target.
3401
3347
            graph = self.source.repository.get_graph(self.target.repository)
3402
 
            self._update_revisions(stop_revision, overwrite=overwrite,
3403
 
                    graph=graph)
 
3348
            self._update_revisions(stop_revision,
 
3349
                overwrite=("history" in overwrite),
 
3350
                graph=graph)
3404
3351
        if self.source._push_should_merge_tags():
3405
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3406
 
                overwrite)
 
3352
            result.tag_updates, result.tag_conflicts = (
 
3353
                self.source.tags.merge_to(
 
3354
                self.target.tags, "tags" in overwrite))
3407
3355
        result.new_revno, result.new_revid = self.target.last_revision_info()
3408
3356
        return result
3409
3357
 
3487
3435
            # -- JRV20090506
3488
3436
            result.old_revno, result.old_revid = \
3489
3437
                self.target.last_revision_info()
3490
 
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3438
            overwrite = _fix_overwrite_type(overwrite)
 
3439
            self._update_revisions(stop_revision,
 
3440
                overwrite=("history" in overwrite),
3491
3441
                graph=graph)
3492
3442
            # TODO: The old revid should be specified when merging tags, 
3493
3443
            # so a tags implementation that versions tags can only 
3494
3444
            # pull in the most recent changes. -- JRV20090506
3495
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3496
 
                overwrite, ignore_master=not merge_tags_to_master)
 
3445
            result.tag_updates, result.tag_conflicts = (
 
3446
                self.source.tags.merge_to(self.target.tags,
 
3447
                    "tags" in overwrite,
 
3448
                    ignore_master=not merge_tags_to_master))
3497
3449
            result.new_revno, result.new_revid = self.target.last_revision_info()
3498
3450
            if _hook_master:
3499
3451
                result.master_branch = _hook_master