/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Jelmer Vernooij
  • Date: 2012-01-30 14:12:36 UTC
  • mfrom: (6437.3.28 2.5)
  • mto: This revision was merged to the branch mainline in revision 6522.
  • Revision ID: jelmer@samba.org-20120130141236-66k8qj1he6q2nq3r
Merge 2.5 branch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
22
 
21
24
lazy_import(globals(), """
22
25
import itertools
23
26
from bzrlib import (
24
 
        bzrdir,
25
 
        cache_utf8,
26
 
        cleanup,
27
 
        config as _mod_config,
28
 
        debug,
29
 
        errors,
30
 
        fetch,
31
 
        graph as _mod_graph,
32
 
        lockdir,
33
 
        lockable_files,
34
 
        remote,
35
 
        repository,
36
 
        revision as _mod_revision,
37
 
        rio,
38
 
        tag as _mod_tag,
39
 
        transport,
40
 
        ui,
41
 
        urlutils,
42
 
        )
 
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
    tag as _mod_tag,
 
43
    transport,
 
44
    ui,
 
45
    urlutils,
 
46
    vf_search,
 
47
    )
43
48
from bzrlib.i18n import gettext, ngettext
44
49
""")
45
50
 
 
51
# Explicitly import bzrlib.bzrdir so that the BzrProber
 
52
# is guaranteed to be registered.
 
53
import bzrlib.bzrdir
 
54
 
46
55
from bzrlib import (
 
56
    bzrdir,
47
57
    controldir,
48
58
    )
49
59
from bzrlib.decorators import (
84
94
    def user_transport(self):
85
95
        return self.bzrdir.user_transport
86
96
 
87
 
    def __init__(self, *ignored, **ignored_too):
 
97
    def __init__(self, possible_transports=None):
88
98
        self.tags = self._format.make_tags(self)
89
99
        self._revision_history_cache = None
90
100
        self._revision_id_to_revno_cache = None
94
104
        self._last_revision_info_cache = None
95
105
        self._master_branch_cache = None
96
106
        self._merge_sorted_revisions_cache = None
97
 
        self._open_hook()
 
107
        self._open_hook(possible_transports)
98
108
        hooks = Branch.hooks['open']
99
109
        for hook in hooks:
100
110
            hook(self)
101
111
 
102
 
    def _open_hook(self):
 
112
    def _open_hook(self, possible_transports):
103
113
        """Called by init to allow simpler extension of the base class."""
104
114
 
105
 
    def _activate_fallback_location(self, url):
 
115
    def _activate_fallback_location(self, url, possible_transports):
106
116
        """Activate the branch/repository from url as a fallback repository."""
107
117
        for existing_fallback_repo in self.repository._fallback_repositories:
108
118
            if existing_fallback_repo.user_url == url:
109
119
                # This fallback is already configured.  This probably only
110
 
                # happens because BzrDir.sprout is a horrible mess.  To avoid
 
120
                # happens because ControlDir.sprout is a horrible mess.  To avoid
111
121
                # confusing _unstack we don't add this a second time.
112
122
                mutter('duplicate activation of fallback %r on %r', url, self)
113
123
                return
114
 
        repo = self._get_fallback_repository(url)
 
124
        repo = self._get_fallback_repository(url, possible_transports)
115
125
        if repo.has_same_location(self.repository):
116
126
            raise errors.UnstackableLocationError(self.user_url, url)
117
127
        self.repository.add_fallback_repository(repo)
171
181
        For instance, if the branch is at URL/.bzr/branch,
172
182
        Branch.open(URL) -> a Branch instance.
173
183
        """
174
 
        control = bzrdir.BzrDir.open(base, _unsupported,
175
 
                                     possible_transports=possible_transports)
176
 
        return control.open_branch(unsupported=_unsupported)
 
184
        control = controldir.ControlDir.open(base,
 
185
            possible_transports=possible_transports, _unsupported=_unsupported)
 
186
        return control.open_branch(unsupported=_unsupported,
 
187
            possible_transports=possible_transports)
177
188
 
178
189
    @staticmethod
179
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
190
    def open_from_transport(transport, name=None, _unsupported=False,
 
191
            possible_transports=None):
180
192
        """Open the branch rooted at transport"""
181
 
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
182
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
193
        control = controldir.ControlDir.open_from_transport(transport, _unsupported)
 
194
        return control.open_branch(name=name, unsupported=_unsupported,
 
195
            possible_transports=possible_transports)
183
196
 
184
197
    @staticmethod
185
198
    def open_containing(url, possible_transports=None):
193
206
        format, UnknownFormatError or UnsupportedFormatError are raised.
194
207
        If there is one, it is returned, along with the unused portion of url.
195
208
        """
196
 
        control, relpath = bzrdir.BzrDir.open_containing(url,
 
209
        control, relpath = controldir.ControlDir.open_containing(url,
197
210
                                                         possible_transports)
198
 
        return control.open_branch(), relpath
 
211
        branch = control.open_branch(possible_transports=possible_transports)
 
212
        return (branch, relpath)
199
213
 
200
214
    def _push_should_merge_tags(self):
201
215
        """Should _basic_push merge this branch's tags into the target?
237
251
        """
238
252
        raise NotImplementedError(self._get_config)
239
253
 
240
 
    def _get_fallback_repository(self, url):
 
254
    def _get_fallback_repository(self, url, possible_transports):
241
255
        """Get the repository we fallback to at url."""
242
256
        url = urlutils.join(self.base, url)
243
 
        a_branch = Branch.open(url,
244
 
            possible_transports=[self.bzrdir.root_transport])
 
257
        a_branch = Branch.open(url, possible_transports=possible_transports)
245
258
        return a_branch.repository
246
259
 
247
260
    @needs_read_lock
657
670
        """
658
671
        if not self._format.supports_set_append_revisions_only():
659
672
            return False
660
 
        return self.get_config(
661
 
            ).get_user_option_as_bool('append_revisions_only')
 
673
        return self.get_config_stack().get('append_revisions_only')
662
674
 
663
675
    def set_append_revisions_only(self, enabled):
664
676
        if not self._format.supports_set_append_revisions_only():
665
677
            raise errors.UpgradeRequired(self.user_url)
666
 
        if enabled:
667
 
            value = 'True'
668
 
        else:
669
 
            value = 'False'
670
 
        self.get_config().set_user_option('append_revisions_only', value,
671
 
            warn_masked=True)
 
678
        self.get_config_stack().set('append_revisions_only', enabled)
672
679
 
673
680
    def set_reference_info(self, file_id, tree_path, branch_location):
674
681
        """Set the branch location to use for a tree reference."""
703
710
        """
704
711
        raise errors.UpgradeRequired(self.user_url)
705
712
 
706
 
    def get_commit_builder(self, parents, config=None, timestamp=None,
 
713
    def get_commit_builder(self, parents, config_stack=None, timestamp=None,
707
714
                           timezone=None, committer=None, revprops=None,
708
715
                           revision_id=None, lossy=False):
709
716
        """Obtain a CommitBuilder for this branch.
719
726
            represented, when pushing to a foreign VCS 
720
727
        """
721
728
 
722
 
        if config is None:
723
 
            config = self.get_config()
 
729
        if config_stack is None:
 
730
            config_stack = self.get_config_stack()
724
731
 
725
 
        return self.repository.get_commit_builder(self, parents, config,
 
732
        return self.repository.get_commit_builder(self, parents, config_stack,
726
733
            timestamp, timezone, committer, revprops, revision_id,
727
734
            lossy)
728
735
 
733
740
        """
734
741
        return None
735
742
 
 
743
    @deprecated_method(deprecated_in((2, 5, 0)))
736
744
    def get_revision_delta(self, revno):
737
745
        """Return the delta for one revision.
738
746
 
739
747
        The delta is relative to its mainline predecessor, or the
740
748
        empty tree for revision 1.
741
749
        """
742
 
        rh = self.revision_history()
743
 
        if not (1 <= revno <= len(rh)):
 
750
        try:
 
751
            revid = self.get_rev_id(revno)
 
752
        except errors.NoSuchRevision:
744
753
            raise errors.InvalidRevisionNumber(revno)
745
 
        return self.repository.get_revision_delta(rh[revno-1])
 
754
        return self.repository.get_revision_delta(revid)
746
755
 
747
756
    def get_stacked_on_url(self):
748
757
        """Get the URL this branch is stacked against.
847
856
                return
848
857
            self._unstack()
849
858
        else:
850
 
            self._activate_fallback_location(url)
 
859
            self._activate_fallback_location(url,
 
860
                possible_transports=[self.bzrdir.root_transport])
851
861
        # write this out after the repository is stacked to avoid setting a
852
862
        # stacked config that doesn't work.
853
863
        self._set_config_location('stacked_on_location', url)
879
889
            # stream from one of them to the other.  This does mean doing
880
890
            # separate SSH connection setup, but unstacking is not a
881
891
            # common operation so it's tolerable.
882
 
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
892
            new_bzrdir = controldir.ControlDir.open(
 
893
                self.bzrdir.root_transport.base)
883
894
            new_repository = new_bzrdir.find_repository()
884
895
            if new_repository._fallback_repositories:
885
896
                raise AssertionError("didn't expect %r to have "
928
939
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
929
940
                except errors.TagsNotSupported:
930
941
                    tags_to_fetch = set()
931
 
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
942
                fetch_spec = vf_search.NotInOtherForRevs(self.repository,
932
943
                    old_repository, required_ids=[self.last_revision()],
933
944
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
934
945
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
1002
1013
        """
1003
1014
        raise NotImplementedError(self._gen_revision_history)
1004
1015
 
 
1016
    @deprecated_method(deprecated_in((2, 5, 0)))
1005
1017
    @needs_read_lock
1006
1018
    def revision_history(self):
1007
1019
        """Return sequence of revision ids on this branch.
1009
1021
        This method will cache the revision history for as long as it is safe to
1010
1022
        do so.
1011
1023
        """
 
1024
        return self._revision_history()
 
1025
 
 
1026
    def _revision_history(self):
1012
1027
        if 'evil' in debug.debug_flags:
1013
1028
            mutter_callsite(3, "revision_history scales with history.")
1014
1029
        if self._revision_history_cache is not None:
1084
1099
        """Given a revision id, return its revno"""
1085
1100
        if _mod_revision.is_null(revision_id):
1086
1101
            return 0
1087
 
        history = self.revision_history()
 
1102
        history = self._revision_history()
1088
1103
        try:
1089
1104
            return history.index(revision_id) + 1
1090
1105
        except ValueError:
1155
1170
    def _set_config_location(self, name, url, config=None,
1156
1171
                             make_relative=False):
1157
1172
        if config is None:
1158
 
            config = self.get_config()
 
1173
            config = self.get_config_stack()
1159
1174
        if url is None:
1160
1175
            url = ''
1161
1176
        elif make_relative:
1162
1177
            url = urlutils.relative_url(self.base, url)
1163
 
        config.set_user_option(name, url, warn_masked=True)
 
1178
        config.set(name, url)
1164
1179
 
1165
1180
    def _get_config_location(self, name, config=None):
1166
1181
        if config is None:
1167
 
            config = self.get_config()
1168
 
        location = config.get_user_option(name)
 
1182
            config = self.get_config_stack()
 
1183
        location = config.get(name)
1169
1184
        if location == '':
1170
1185
            location = None
1171
1186
        return location
1172
1187
 
1173
1188
    def get_child_submit_format(self):
1174
1189
        """Return the preferred format of submissions to this branch."""
1175
 
        return self.get_config().get_user_option("child_submit_format")
 
1190
        return self.get_config_stack().get('child_submit_format')
1176
1191
 
1177
1192
    def get_submit_branch(self):
1178
1193
        """Return the submit location of the branch.
1181
1196
        pattern is that the user can override it by specifying a
1182
1197
        location.
1183
1198
        """
1184
 
        return self.get_config().get_user_option('submit_branch')
 
1199
        return self.get_config_stack().get('submit_branch')
1185
1200
 
1186
1201
    def set_submit_branch(self, location):
1187
1202
        """Return the submit location of the branch.
1190
1205
        pattern is that the user can override it by specifying a
1191
1206
        location.
1192
1207
        """
1193
 
        self.get_config().set_user_option('submit_branch', location,
1194
 
            warn_masked=True)
 
1208
        self.get_config_stack().set('submit_branch', location)
1195
1209
 
1196
1210
    def get_public_branch(self):
1197
1211
        """Return the public location of the branch.
1210
1224
        self._set_config_location('public_branch', location)
1211
1225
 
1212
1226
    def get_push_location(self):
1213
 
        """Return the None or the location to push this branch to."""
1214
 
        push_loc = self.get_config().get_user_option('push_location')
1215
 
        return push_loc
 
1227
        """Return None or the location to push this branch to."""
 
1228
        return self.get_config_stack().get('push_location')
1216
1229
 
1217
1230
    def set_push_location(self, location):
1218
1231
        """Set a new push location for this branch."""
1387
1400
        # TODO: We should probably also check that self.revision_history
1388
1401
        # matches the repository for older branch formats.
1389
1402
        # If looking for the code that cross-checks repository parents against
1390
 
        # the iter_reverse_revision_history output, that is now a repository
 
1403
        # the Graph.iter_lefthand_ancestry output, that is now a repository
1391
1404
        # specific check.
1392
1405
        return result
1393
1406
 
1444
1457
        t = transport.get_transport(to_location)
1445
1458
        t.ensure_base()
1446
1459
        format = self._get_checkout_format(lightweight=lightweight)
 
1460
        try:
 
1461
            checkout = format.initialize_on_transport(t)
 
1462
        except errors.AlreadyControlDirError:
 
1463
            # It's fine if the control directory already exists,
 
1464
            # as long as there is no existing branch and working tree.
 
1465
            checkout = controldir.ControlDir.open_from_transport(t)
 
1466
            try:
 
1467
                checkout.open_branch()
 
1468
            except errors.NotBranchError:
 
1469
                pass
 
1470
            else:
 
1471
                raise errors.AlreadyControlDirError(t.base)
 
1472
            if checkout.control_transport.base == self.bzrdir.control_transport.base:
 
1473
                # When checking out to the same control directory,
 
1474
                # always create a lightweight checkout
 
1475
                lightweight = True
 
1476
 
1447
1477
        if lightweight:
1448
 
            checkout = format.initialize_on_transport(t)
1449
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1450
 
                target_branch=self)
 
1478
            from_branch = checkout.set_branch_reference(target_branch=self)
1451
1479
        else:
1452
 
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1453
 
                to_location, force_new_tree=False, format=format)
1454
 
            checkout = checkout_branch.bzrdir
 
1480
            policy = checkout.determine_repository_policy()
 
1481
            repo = policy.acquire_repository()[0]
 
1482
            checkout_branch = checkout.create_branch()
1455
1483
            checkout_branch.bind(self)
1456
1484
            # pull up to the specified revision_id to set the initial
1457
1485
            # branch tip correctly, and seed it with history.
1458
1486
            checkout_branch.pull(self, stop_revision=revision_id)
1459
 
            from_branch=None
 
1487
            from_branch = None
1460
1488
        tree = checkout.create_workingtree(revision_id,
1461
1489
                                           from_branch=from_branch,
1462
1490
                                           accelerator_tree=accelerator_tree,
1551
1579
            heads that must be fetched if present, but no error is necessary if
1552
1580
            they are not present.
1553
1581
        """
1554
 
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
1555
 
        # are the tags.
 
1582
        # For bzr native formats must_fetch is just the tip, and
 
1583
        # if_present_fetch are the tags.
1556
1584
        must_fetch = set([self.last_revision()])
1557
1585
        if_present_fetch = set()
1558
 
        c = self.get_config()
1559
 
        include_tags = c.get_user_option_as_bool('branch.fetch_tags',
1560
 
                                                 default=False)
1561
 
        if include_tags:
 
1586
        if self.get_config_stack().get('branch.fetch_tags'):
1562
1587
            try:
1563
1588
                if_present_fetch = set(self.tags.get_reverse_tag_dict())
1564
1589
            except errors.TagsNotSupported:
1573
1598
 
1574
1599
    Formats provide three things:
1575
1600
     * An initialization routine,
1576
 
     * a format string,
 
1601
     * a format description
1577
1602
     * an open routine.
1578
1603
 
1579
1604
    Formats are placed in an dict by their format string for reference
1593
1618
        return not (self == other)
1594
1619
 
1595
1620
    @classmethod
1596
 
    def find_format(klass, a_bzrdir, name=None):
1597
 
        """Return the format for the branch object in a_bzrdir."""
1598
 
        try:
1599
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1600
 
            format_string = transport.get_bytes("format")
1601
 
            return format_registry.get(format_string)
1602
 
        except errors.NoSuchFile:
1603
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1604
 
        except KeyError:
1605
 
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1606
 
 
1607
 
    @classmethod
1608
1621
    @deprecated_method(deprecated_in((2, 4, 0)))
1609
1622
    def get_default_format(klass):
1610
1623
        """Return the current default format."""
1620
1633
        """
1621
1634
        return format_registry._get_all()
1622
1635
 
1623
 
    def get_reference(self, a_bzrdir, name=None):
1624
 
        """Get the target reference of the branch in a_bzrdir.
 
1636
    def get_reference(self, controldir, name=None):
 
1637
        """Get the target reference of the branch in controldir.
1625
1638
 
1626
1639
        format probing must have been completed before calling
1627
1640
        this method - it is assumed that the format of the branch
1628
 
        in a_bzrdir is correct.
 
1641
        in controldir is correct.
1629
1642
 
1630
 
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1643
        :param controldir: The controldir to get the branch data from.
1631
1644
        :param name: Name of the colocated branch to fetch
1632
1645
        :return: None if the branch is not a reference branch.
1633
1646
        """
1634
1647
        return None
1635
1648
 
1636
1649
    @classmethod
1637
 
    def set_reference(self, a_bzrdir, name, to_branch):
1638
 
        """Set the target reference of the branch in a_bzrdir.
 
1650
    def set_reference(self, controldir, name, to_branch):
 
1651
        """Set the target reference of the branch in controldir.
1639
1652
 
1640
1653
        format probing must have been completed before calling
1641
1654
        this method - it is assumed that the format of the branch
1642
 
        in a_bzrdir is correct.
 
1655
        in controldir is correct.
1643
1656
 
1644
 
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1657
        :param controldir: The controldir to set the branch reference for.
1645
1658
        :param name: Name of colocated branch to set, None for default
1646
1659
        :param to_branch: branch that the checkout is to reference
1647
1660
        """
1648
1661
        raise NotImplementedError(self.set_reference)
1649
1662
 
1650
 
    def get_format_string(self):
1651
 
        """Return the ASCII format string that identifies this format."""
1652
 
        raise NotImplementedError(self.get_format_string)
1653
 
 
1654
1663
    def get_format_description(self):
1655
1664
        """Return the short format description for this format."""
1656
1665
        raise NotImplementedError(self.get_format_description)
1657
1666
 
1658
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
 
1667
    def _run_post_branch_init_hooks(self, controldir, name, branch):
1659
1668
        hooks = Branch.hooks['post_branch_init']
1660
1669
        if not hooks:
1661
1670
            return
1662
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
 
1671
        params = BranchInitHookParams(self, controldir, name, branch)
1663
1672
        for hook in hooks:
1664
1673
            hook(params)
1665
1674
 
1666
 
    def initialize(self, a_bzrdir, name=None, repository=None,
 
1675
    def initialize(self, controldir, name=None, repository=None,
1667
1676
                   append_revisions_only=None):
1668
 
        """Create a branch of this format in a_bzrdir.
1669
 
        
 
1677
        """Create a branch of this format in controldir.
 
1678
 
1670
1679
        :param name: Name of the colocated branch to create.
1671
1680
        """
1672
1681
        raise NotImplementedError(self.initialize)
1704
1713
        """
1705
1714
        raise NotImplementedError(self.network_name)
1706
1715
 
1707
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
1708
 
            found_repository=None):
1709
 
        """Return the branch object for a_bzrdir
 
1716
    def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
 
1717
            found_repository=None, possible_transports=None):
 
1718
        """Return the branch object for controldir.
1710
1719
 
1711
 
        :param a_bzrdir: A BzrDir that contains a branch.
 
1720
        :param controldir: A ControlDir that contains a branch.
1712
1721
        :param name: Name of colocated branch to open
1713
1722
        :param _found: a private parameter, do not use it. It is used to
1714
1723
            indicate if format probing has already be done.
1783
1792
        """
1784
1793
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
1785
1794
        self._format_string = format_string
1786
 
        
 
1795
 
1787
1796
    def get_format_string(self):
1788
1797
        """See BranchFormat.get_format_string."""
1789
1798
        return self._format_string
1934
1943
    There are 4 fields that hooks may wish to access:
1935
1944
 
1936
1945
    :ivar format: the branch format
1937
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
 
1946
    :ivar bzrdir: the ControlDir where the branch will be/has been initialized
1938
1947
    :ivar name: name of colocated branch, if any (or None)
1939
1948
    :ivar branch: the branch created
1940
1949
 
1943
1952
    branch, which refer to the original branch.
1944
1953
    """
1945
1954
 
1946
 
    def __init__(self, format, a_bzrdir, name, branch):
 
1955
    def __init__(self, format, controldir, name, branch):
1947
1956
        """Create a group of BranchInitHook parameters.
1948
1957
 
1949
1958
        :param format: the branch format
1950
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
 
1959
        :param controldir: the ControlDir where the branch will be/has been
1951
1960
            initialized
1952
1961
        :param name: name of colocated branch, if any (or None)
1953
1962
        :param branch: the branch created
1957
1966
        in branch, which refer to the original branch.
1958
1967
        """
1959
1968
        self.format = format
1960
 
        self.bzrdir = a_bzrdir
 
1969
        self.bzrdir = controldir
1961
1970
        self.name = name
1962
1971
        self.branch = branch
1963
1972
 
1973
1982
 
1974
1983
    There are 4 fields that hooks may wish to access:
1975
1984
 
1976
 
    :ivar control_dir: BzrDir of the checkout to change
 
1985
    :ivar control_dir: ControlDir of the checkout to change
1977
1986
    :ivar to_branch: branch that the checkout is to reference
1978
1987
    :ivar force: skip the check for local commits in a heavy checkout
1979
1988
    :ivar revision_id: revision ID to switch to (or None)
1982
1991
    def __init__(self, control_dir, to_branch, force, revision_id):
1983
1992
        """Create a group of SwitchHook parameters.
1984
1993
 
1985
 
        :param control_dir: BzrDir of the checkout to change
 
1994
        :param control_dir: ControlDir of the checkout to change
1986
1995
        :param to_branch: branch that the checkout is to reference
1987
1996
        :param force: skip the check for local commits in a heavy checkout
1988
1997
        :param revision_id: revision ID to switch to (or None)
2001
2010
            self.revision_id)
2002
2011
 
2003
2012
 
2004
 
class BranchFormatMetadir(BranchFormat):
2005
 
    """Common logic for meta-dir based branch formats."""
 
2013
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
 
2014
    """Base class for branch formats that live in meta directories.
 
2015
    """
 
2016
 
 
2017
    def __init__(self):
 
2018
        BranchFormat.__init__(self)
 
2019
        bzrdir.BzrFormat.__init__(self)
 
2020
 
 
2021
    @classmethod
 
2022
    def find_format(klass, controldir, name=None):
 
2023
        """Return the format for the branch object in controldir."""
 
2024
        try:
 
2025
            transport = controldir.get_branch_transport(None, name=name)
 
2026
        except errors.NoSuchFile:
 
2027
            raise errors.NotBranchError(path=name, bzrdir=controldir)
 
2028
        try:
 
2029
            format_string = transport.get_bytes("format")
 
2030
        except errors.NoSuchFile:
 
2031
            raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
 
2032
        return klass._find_format(format_registry, 'branch', format_string)
2006
2033
 
2007
2034
    def _branch_class(self):
2008
2035
        """What class to instantiate on open calls."""
2026
2053
        :param name: Name of colocated branch to create, if any
2027
2054
        :return: a branch in this format
2028
2055
        """
 
2056
        if name is None:
 
2057
            name = a_bzrdir._get_selected_branch()
2029
2058
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2030
2059
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2031
2060
        control_files = lockable_files.LockableFiles(branch_transport,
2033
2062
        control_files.create_lock()
2034
2063
        control_files.lock_write()
2035
2064
        try:
2036
 
            utf8_files += [('format', self.get_format_string())]
 
2065
            utf8_files += [('format', self.as_string())]
2037
2066
            for (filename, content) in utf8_files:
2038
2067
                branch_transport.put_bytes(
2039
2068
                    filename, content,
2045
2074
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2046
2075
        return branch
2047
2076
 
2048
 
    def network_name(self):
2049
 
        """A simple byte string uniquely identifying this format for RPC calls.
2050
 
 
2051
 
        Metadir branch formats use their format string.
2052
 
        """
2053
 
        return self.get_format_string()
2054
 
 
2055
2077
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2056
 
            found_repository=None):
 
2078
            found_repository=None, possible_transports=None):
2057
2079
        """See BranchFormat.open()."""
 
2080
        if name is None:
 
2081
            name = a_bzrdir._get_selected_branch()
2058
2082
        if not _found:
2059
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2083
            format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2060
2084
            if format.__class__ != self.__class__:
2061
2085
                raise AssertionError("wrong format %r found for %r" %
2062
2086
                    (format, self))
2071
2095
                              name=name,
2072
2096
                              a_bzrdir=a_bzrdir,
2073
2097
                              _repository=found_repository,
2074
 
                              ignore_fallbacks=ignore_fallbacks)
 
2098
                              ignore_fallbacks=ignore_fallbacks,
 
2099
                              possible_transports=possible_transports)
2075
2100
        except errors.NoSuchFile:
2076
2101
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2077
2102
 
2078
 
    def __init__(self):
2079
 
        super(BranchFormatMetadir, self).__init__()
2080
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2081
 
        self._matchingbzrdir.set_branch_format(self)
 
2103
    @property
 
2104
    def _matchingbzrdir(self):
 
2105
        ret = bzrdir.BzrDirMetaFormat1()
 
2106
        ret.set_branch_format(self)
 
2107
        return ret
2082
2108
 
2083
2109
    def supports_tags(self):
2084
2110
        return True
2086
2112
    def supports_leaving_lock(self):
2087
2113
        return True
2088
2114
 
 
2115
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
2116
            basedir=None):
 
2117
        BranchFormat.check_support_status(self,
 
2118
            allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
 
2119
            basedir=basedir)
 
2120
        bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
 
2121
            recommend_upgrade=recommend_upgrade, basedir=basedir)
 
2122
 
2089
2123
 
2090
2124
class BzrBranchFormat5(BranchFormatMetadir):
2091
2125
    """Bzr branch format 5.
2103
2137
    def _branch_class(self):
2104
2138
        return BzrBranch5
2105
2139
 
2106
 
    def get_format_string(self):
 
2140
    @classmethod
 
2141
    def get_format_string(cls):
2107
2142
        """See BranchFormat.get_format_string()."""
2108
2143
        return "Bazaar-NG branch format 5\n"
2109
2144
 
2139
2174
    def _branch_class(self):
2140
2175
        return BzrBranch6
2141
2176
 
2142
 
    def get_format_string(self):
 
2177
    @classmethod
 
2178
    def get_format_string(cls):
2143
2179
        """See BranchFormat.get_format_string()."""
2144
2180
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
2145
2181
 
2171
2207
    def _branch_class(self):
2172
2208
        return BzrBranch8
2173
2209
 
2174
 
    def get_format_string(self):
 
2210
    @classmethod
 
2211
    def get_format_string(cls):
2175
2212
        """See BranchFormat.get_format_string()."""
2176
2213
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2177
2214
 
2225
2262
    def _branch_class(self):
2226
2263
        return BzrBranch7
2227
2264
 
2228
 
    def get_format_string(self):
 
2265
    @classmethod
 
2266
    def get_format_string(cls):
2229
2267
        """See BranchFormat.get_format_string()."""
2230
2268
        return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2231
2269
 
2246
2284
    supports_reference_locations = False
2247
2285
 
2248
2286
 
2249
 
class BranchReferenceFormat(BranchFormat):
 
2287
class BranchReferenceFormat(BranchFormatMetadir):
2250
2288
    """Bzr branch reference format.
2251
2289
 
2252
2290
    Branch references are used in implementing checkouts, they
2257
2295
     - a format string
2258
2296
    """
2259
2297
 
2260
 
    def get_format_string(self):
 
2298
    @classmethod
 
2299
    def get_format_string(cls):
2261
2300
        """See BranchFormat.get_format_string()."""
2262
2301
        return "Bazaar-NG Branch Reference Format 1\n"
2263
2302
 
2285
2324
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2286
2325
        if a_bzrdir._format.fixed_components:
2287
2326
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
 
2327
        if name is None:
 
2328
            name = a_bzrdir._get_selected_branch()
2288
2329
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2289
2330
        branch_transport.put_bytes('location',
2290
 
            target_branch.bzrdir.user_url)
2291
 
        branch_transport.put_bytes('format', self.get_format_string())
2292
 
        branch = self.open(
2293
 
            a_bzrdir, name, _found=True,
 
2331
            target_branch.user_url)
 
2332
        branch_transport.put_bytes('format', self.as_string())
 
2333
        branch = self.open(a_bzrdir, name, _found=True,
2294
2334
            possible_transports=[target_branch.bzrdir.root_transport])
2295
2335
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2296
2336
        return branch
2297
2337
 
2298
 
    def __init__(self):
2299
 
        super(BranchReferenceFormat, self).__init__()
2300
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2301
 
        self._matchingbzrdir.set_branch_format(self)
2302
 
 
2303
2338
    def _make_reference_clone_function(format, a_branch):
2304
2339
        """Create a clone() routine for a branch dynamically."""
2305
2340
        def clone(to_bzrdir, revision_id=None,
2327
2362
            a_bzrdir.
2328
2363
        :param possible_transports: An optional reusable transports list.
2329
2364
        """
 
2365
        if name is None:
 
2366
            name = a_bzrdir._get_selected_branch()
2330
2367
        if not _found:
2331
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2368
            format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2332
2369
            if format.__class__ != self.__class__:
2333
2370
                raise AssertionError("wrong format %r found for %r" %
2334
2371
                    (format, self))
2335
2372
        if location is None:
2336
2373
            location = self.get_reference(a_bzrdir, name)
2337
 
        real_bzrdir = bzrdir.BzrDir.open(
 
2374
        real_bzrdir = controldir.ControlDir.open(
2338
2375
            location, possible_transports=possible_transports)
2339
 
        result = real_bzrdir.open_branch(name=name, 
2340
 
            ignore_fallbacks=ignore_fallbacks)
 
2376
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks,
 
2377
            possible_transports=possible_transports)
2341
2378
        # this changes the behaviour of result.clone to create a new reference
2342
2379
        # rather than a copy of the content of the branch.
2343
2380
        # I did not use a proxy object because that needs much more extensive
2424
2461
 
2425
2462
    def __init__(self, _format=None,
2426
2463
                 _control_files=None, a_bzrdir=None, name=None,
2427
 
                 _repository=None, ignore_fallbacks=False):
 
2464
                 _repository=None, ignore_fallbacks=False,
 
2465
                 possible_transports=None):
2428
2466
        """Create new branch object at a particular location."""
2429
2467
        if a_bzrdir is None:
2430
2468
            raise ValueError('a_bzrdir must be supplied')
2431
 
        else:
2432
 
            self.bzrdir = a_bzrdir
2433
 
        self._base = self.bzrdir.transport.clone('..').base
 
2469
        if name is None:
 
2470
            raise ValueError('name must be supplied')
 
2471
        self.bzrdir = a_bzrdir
 
2472
        self._user_transport = self.bzrdir.transport.clone('..')
 
2473
        if name != "":
 
2474
            self._user_transport.set_segment_parameter(
 
2475
                "branch", urlutils.escape(name))
 
2476
        self._base = self._user_transport.base
2434
2477
        self.name = name
2435
 
        # XXX: We should be able to just do
2436
 
        #   self.base = self.bzrdir.root_transport.base
2437
 
        # but this does not quite work yet -- mbp 20080522
2438
2478
        self._format = _format
2439
2479
        if _control_files is None:
2440
2480
            raise ValueError('BzrBranch _control_files is None')
2441
2481
        self.control_files = _control_files
2442
2482
        self._transport = _control_files._transport
2443
2483
        self.repository = _repository
2444
 
        Branch.__init__(self)
 
2484
        Branch.__init__(self, possible_transports)
2445
2485
 
2446
2486
    def __str__(self):
2447
 
        if self.name is None:
2448
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2449
 
        else:
2450
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2451
 
                self.name)
 
2487
        return '%s(%s)' % (self.__class__.__name__, self.user_url)
2452
2488
 
2453
2489
    __repr__ = __str__
2454
2490
 
2458
2494
 
2459
2495
    base = property(_get_base, doc="The URL for the root of this branch.")
2460
2496
 
 
2497
    @property
 
2498
    def user_transport(self):
 
2499
        return self._user_transport
 
2500
 
2461
2501
    def _get_config(self):
2462
2502
        return _mod_config.TransportConfig(self._transport, 'branch.conf')
2463
2503
 
 
2504
    def _get_config_store(self):
 
2505
        return _mod_config.BranchStore(self)
 
2506
 
2464
2507
    def is_locked(self):
2465
2508
        return self.control_files.is_locked()
2466
2509
 
2695
2738
        self._transport.put_bytes('last-revision', out_string,
2696
2739
            mode=self.bzrdir._get_file_mode())
2697
2740
 
 
2741
    @needs_write_lock
 
2742
    def update_feature_flags(self, updated_flags):
 
2743
        """Update the feature flags for this branch.
 
2744
 
 
2745
        :param updated_flags: Dictionary mapping feature names to necessities
 
2746
            A necessity can be None to indicate the feature should be removed
 
2747
        """
 
2748
        self._format._update_feature_flags(updated_flags)
 
2749
        self.control_transport.put_bytes('format', self._format.as_string())
 
2750
 
2698
2751
 
2699
2752
class FullHistoryBzrBranch(BzrBranch):
2700
2753
    """Bzr branch which contains the full revision history."""
2713
2766
        self._set_revision_history(history)
2714
2767
 
2715
2768
    def _read_last_revision_info(self):
2716
 
        rh = self.revision_history()
 
2769
        rh = self._revision_history()
2717
2770
        revno = len(rh)
2718
2771
        if revno:
2719
2772
            return (revno, rh[-1])
2773
2826
        if revision_id == _mod_revision.NULL_REVISION:
2774
2827
            new_history = []
2775
2828
        else:
2776
 
            new_history = self.revision_history()
 
2829
            new_history = self._revision_history()
2777
2830
        if revision_id is not None and new_history != []:
2778
2831
            try:
2779
2832
                new_history = new_history[:new_history.index(revision_id) + 1]
2807
2860
class BzrBranch8(BzrBranch):
2808
2861
    """A branch that stores tree-reference locations."""
2809
2862
 
2810
 
    def _open_hook(self):
 
2863
    def _open_hook(self, possible_transports=None):
2811
2864
        if self._ignore_fallbacks:
2812
2865
            return
 
2866
        if possible_transports is None:
 
2867
            possible_transports = [self.bzrdir.root_transport]
2813
2868
        try:
2814
2869
            url = self.get_stacked_on_url()
2815
2870
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2823
2878
                    raise AssertionError(
2824
2879
                        "'transform_fallback_location' hook %s returned "
2825
2880
                        "None, not a URL." % hook_name)
2826
 
            self._activate_fallback_location(url)
 
2881
            self._activate_fallback_location(url,
 
2882
                possible_transports=possible_transports)
2827
2883
 
2828
2884
    def __init__(self, *args, **kwargs):
2829
2885
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2947
3003
        """See Branch.set_push_location."""
2948
3004
        self._master_branch_cache = None
2949
3005
        result = None
2950
 
        config = self.get_config()
 
3006
        conf = self.get_config_stack()
2951
3007
        if location is None:
2952
 
            if config.get_user_option('bound') != 'True':
 
3008
            if not conf.get('bound'):
2953
3009
                return False
2954
3010
            else:
2955
 
                config.set_user_option('bound', 'False', warn_masked=True)
 
3011
                conf.set('bound', 'False')
2956
3012
                return True
2957
3013
        else:
2958
3014
            self._set_config_location('bound_location', location,
2959
 
                                      config=config)
2960
 
            config.set_user_option('bound', 'True', warn_masked=True)
 
3015
                                      config=conf)
 
3016
            conf.set('bound', 'True')
2961
3017
        return True
2962
3018
 
2963
3019
    def _get_bound_location(self, bound):
2964
3020
        """Return the bound location in the config file.
2965
3021
 
2966
3022
        Return None if the bound parameter does not match"""
2967
 
        config = self.get_config()
2968
 
        config_bound = (config.get_user_option('bound') == 'True')
2969
 
        if config_bound != bound:
 
3023
        conf = self.get_config_stack()
 
3024
        if conf.get('bound') != bound:
2970
3025
            return None
2971
 
        return self._get_config_location('bound_location', config=config)
 
3026
        return self._get_config_location('bound_location', config=conf)
2972
3027
 
2973
3028
    def get_bound_location(self):
2974
 
        """See Branch.set_push_location."""
 
3029
        """See Branch.get_bound_location."""
2975
3030
        return self._get_bound_location(True)
2976
3031
 
2977
3032
    def get_old_bound_location(self):
2984
3039
        ## self._check_stackable_repo()
2985
3040
        # stacked_on_location is only ever defined in branch.conf, so don't
2986
3041
        # waste effort reading the whole stack of config files.
2987
 
        config = self.get_config()._get_branch_data_config()
 
3042
        conf = _mod_config.BranchOnlyStack(self)
2988
3043
        stacked_url = self._get_config_location('stacked_on_location',
2989
 
            config=config)
 
3044
                                                config=conf)
2990
3045
        if stacked_url is None:
2991
3046
            raise errors.NotStacked(self)
2992
 
        return stacked_url
 
3047
        return stacked_url.encode('utf-8')
2993
3048
 
2994
3049
    @needs_read_lock
2995
3050
    def get_rev_id(self, revno, history=None):
3025
3080
            except errors.RevisionNotPresent, e:
3026
3081
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
3027
3082
            index = len(self._partial_revision_history_cache) - 1
 
3083
            if index < 0:
 
3084
                raise errors.NoSuchRevision(self, revision_id)
3028
3085
            if self._partial_revision_history_cache[index] != revision_id:
3029
3086
                raise errors.NoSuchRevision(self, revision_id)
3030
3087
        return self.revno() - index
3197
3254
 
3198
3255
        # Copying done; now update target format
3199
3256
        new_branch._transport.put_bytes('format',
3200
 
            format.get_format_string(),
 
3257
            format.as_string(),
3201
3258
            mode=new_branch.bzrdir._get_file_mode())
3202
3259
 
3203
3260
        # Clean up old files
3216
3273
        format = BzrBranchFormat7()
3217
3274
        branch._set_config_location('stacked_on_location', '')
3218
3275
        # update target format
3219
 
        branch._transport.put_bytes('format', format.get_format_string())
 
3276
        branch._transport.put_bytes('format', format.as_string())
3220
3277
 
3221
3278
 
3222
3279
class Converter7to8(object):
3226
3283
        format = BzrBranchFormat8()
3227
3284
        branch._transport.put_bytes('references', '')
3228
3285
        # update target format
3229
 
        branch._transport.put_bytes('format', format.get_format_string())
 
3286
        branch._transport.put_bytes('format', format.as_string())
3230
3287
 
3231
3288
 
3232
3289
class InterBranch(InterObject):