/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: 2011-02-04 18:12:44 UTC
  • mto: (5582.10.39 weave-fmt-plugin)
  • mto: This revision was merged to the branch mainline in revision 5651.
  • Revision ID: jelmer@samba.org-20110204181244-d3jfr901l7ve2pw0
Add WorkingTreeFormat.register_extra_format and friends.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
25
25
        bzrdir,
26
26
        cache_utf8,
27
27
        config as _mod_config,
 
28
        controldir,
28
29
        debug,
29
30
        errors,
30
31
        lockdir,
31
32
        lockable_files,
 
33
        remote,
32
34
        repository,
33
35
        revision as _mod_revision,
34
36
        rio,
49
51
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
52
from bzrlib.hooks import HookPoint, Hooks
51
53
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
 
54
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
55
from bzrlib import registry
54
56
from bzrlib.symbol_versioning import (
55
57
    deprecated_in,
63
65
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
66
 
65
67
 
66
 
class Branch(bzrdir.ControlComponent):
 
68
class Branch(controldir.ControlComponent):
67
69
    """Branch holding a history of revisions.
68
70
 
69
71
    :ivar base:
90
92
        self._revision_id_to_revno_cache = None
91
93
        self._partial_revision_id_to_revno_cache = {}
92
94
        self._partial_revision_history_cache = []
 
95
        self._tags_bytes = None
93
96
        self._last_revision_info_cache = None
94
97
        self._merge_sorted_revisions_cache = None
95
98
        self._open_hook()
102
105
 
103
106
    def _activate_fallback_location(self, url):
104
107
        """Activate the branch/repository from url as a fallback repository."""
 
108
        for existing_fallback_repo in self.repository._fallback_repositories:
 
109
            if existing_fallback_repo.user_url == url:
 
110
                # This fallback is already configured.  This probably only
 
111
                # happens because BzrDir.sprout is a horrible mess.  To avoid
 
112
                # confusing _unstack we don't add this a second time.
 
113
                mutter('duplicate activation of fallback %r on %r', url, self)
 
114
                return
105
115
        repo = self._get_fallback_repository(url)
106
116
        if repo.has_same_location(self.repository):
107
117
            raise errors.UnstackableLocationError(self.user_url, url)
197
207
        return self.supports_tags() and self.tags.get_tag_dict()
198
208
 
199
209
    def get_config(self):
 
210
        """Get a bzrlib.config.BranchConfig for this Branch.
 
211
 
 
212
        This can then be used to get and set configuration options for the
 
213
        branch.
 
214
 
 
215
        :return: A bzrlib.config.BranchConfig.
 
216
        """
200
217
        return BranchConfig(self)
201
218
 
202
219
    def _get_config(self):
218
235
            possible_transports=[self.bzrdir.root_transport])
219
236
        return a_branch.repository
220
237
 
 
238
    @needs_read_lock
221
239
    def _get_tags_bytes(self):
222
240
        """Get the bytes of a serialised tags dict.
223
241
 
230
248
        :return: The bytes of the tags file.
231
249
        :seealso: Branch._set_tags_bytes.
232
250
        """
233
 
        return self._transport.get_bytes('tags')
 
251
        if self._tags_bytes is None:
 
252
            self._tags_bytes = self._transport.get_bytes('tags')
 
253
        return self._tags_bytes
234
254
 
235
255
    def _get_nick(self, local=False, possible_transports=None):
236
256
        config = self.get_config()
238
258
        if not local and not config.has_explicit_nickname():
239
259
            try:
240
260
                master = self.get_master_branch(possible_transports)
 
261
                if master and self.user_url == master.user_url:
 
262
                    raise errors.RecursiveBind(self.user_url)
241
263
                if master is not None:
242
264
                    # return the master branch value
243
265
                    return master.nick
 
266
            except errors.RecursiveBind, e:
 
267
                raise e
244
268
            except errors.BzrError, e:
245
269
                # Silently fall back to local implicit nick if the master is
246
270
                # unavailable
283
307
        new_history.reverse()
284
308
        return new_history
285
309
 
286
 
    def lock_write(self):
 
310
    def lock_write(self, token=None):
 
311
        """Lock the branch for write operations.
 
312
 
 
313
        :param token: A token to permit reacquiring a previously held and
 
314
            preserved lock.
 
315
        :return: A BranchWriteLockResult.
 
316
        """
287
317
        raise NotImplementedError(self.lock_write)
288
318
 
289
319
    def lock_read(self):
 
320
        """Lock the branch for read operations.
 
321
 
 
322
        :return: A bzrlib.lock.LogicalLockResult.
 
323
        """
290
324
        raise NotImplementedError(self.lock_read)
291
325
 
292
326
    def unlock(self):
782
816
            old_repository = self.repository
783
817
            if len(old_repository._fallback_repositories) != 1:
784
818
                raise AssertionError("can't cope with fallback repositories "
785
 
                    "of %r" % (self.repository,))
786
 
            # unlock it, including unlocking the fallback
 
819
                    "of %r (fallbacks: %r)" % (old_repository,
 
820
                        old_repository._fallback_repositories))
 
821
            # Open the new repository object.
 
822
            # Repositories don't offer an interface to remove fallback
 
823
            # repositories today; take the conceptually simpler option and just
 
824
            # reopen it.  We reopen it starting from the URL so that we
 
825
            # get a separate connection for RemoteRepositories and can
 
826
            # stream from one of them to the other.  This does mean doing
 
827
            # separate SSH connection setup, but unstacking is not a
 
828
            # common operation so it's tolerable.
 
829
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
830
            new_repository = new_bzrdir.find_repository()
 
831
            if new_repository._fallback_repositories:
 
832
                raise AssertionError("didn't expect %r to have "
 
833
                    "fallback_repositories"
 
834
                    % (self.repository,))
 
835
            # Replace self.repository with the new repository.
 
836
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
837
            # lock count) of self.repository to the new repository.
 
838
            lock_token = old_repository.lock_write().repository_token
 
839
            self.repository = new_repository
 
840
            if isinstance(self, remote.RemoteBranch):
 
841
                # Remote branches can have a second reference to the old
 
842
                # repository that need to be replaced.
 
843
                if self._real_branch is not None:
 
844
                    self._real_branch.repository = new_repository
 
845
            self.repository.lock_write(token=lock_token)
 
846
            if lock_token is not None:
 
847
                old_repository.leave_lock_in_place()
787
848
            old_repository.unlock()
 
849
            if lock_token is not None:
 
850
                # XXX: self.repository.leave_lock_in_place() before this
 
851
                # function will not be preserved.  Fortunately that doesn't
 
852
                # affect the current default format (2a), and would be a
 
853
                # corner-case anyway.
 
854
                #  - Andrew Bennetts, 2010/06/30
 
855
                self.repository.dont_leave_lock_in_place()
 
856
            old_lock_count = 0
 
857
            while True:
 
858
                try:
 
859
                    old_repository.unlock()
 
860
                except errors.LockNotHeld:
 
861
                    break
 
862
                old_lock_count += 1
 
863
            if old_lock_count == 0:
 
864
                raise AssertionError(
 
865
                    'old_repository should have been locked at least once.')
 
866
            for i in range(old_lock_count-1):
 
867
                self.repository.lock_write()
 
868
            # Fetch from the old repository into the new.
788
869
            old_repository.lock_read()
789
870
            try:
790
 
                # Repositories don't offer an interface to remove fallback
791
 
                # repositories today; take the conceptually simpler option and just
792
 
                # reopen it.  We reopen it starting from the URL so that we
793
 
                # get a separate connection for RemoteRepositories and can
794
 
                # stream from one of them to the other.  This does mean doing
795
 
                # separate SSH connection setup, but unstacking is not a
796
 
                # common operation so it's tolerable.
797
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
798
 
                new_repository = new_bzrdir.find_repository()
799
 
                self.repository = new_repository
800
 
                if self.repository._fallback_repositories:
801
 
                    raise AssertionError("didn't expect %r to have "
802
 
                        "fallback_repositories"
803
 
                        % (self.repository,))
804
 
                # this is not paired with an unlock because it's just restoring
805
 
                # the previous state; the lock's released when set_stacked_on_url
806
 
                # returns
807
 
                self.repository.lock_write()
808
871
                # XXX: If you unstack a branch while it has a working tree
809
872
                # with a pending merge, the pending-merged revisions will no
810
873
                # longer be present.  You can (probably) revert and remerge.
825
888
 
826
889
        :seealso: Branch._get_tags_bytes.
827
890
        """
828
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
829
 
            'tags', bytes)
 
891
        return _run_with_write_locked_target(self, self._set_tags_bytes_locked,
 
892
                bytes)
 
893
 
 
894
    def _set_tags_bytes_locked(self, bytes):
 
895
        self._tags_bytes = bytes
 
896
        return self._transport.put_bytes('tags', bytes)
830
897
 
831
898
    def _cache_revision_history(self, rev_history):
832
899
        """Set the cached revision history to rev_history.
862
929
        self._merge_sorted_revisions_cache = None
863
930
        self._partial_revision_history_cache = []
864
931
        self._partial_revision_id_to_revno_cache = {}
 
932
        self._tags_bytes = None
865
933
 
866
934
    def _gen_revision_history(self):
867
935
        """Return sequence of revision hashes on to this branch.
951
1019
                raise errors.NoSuchRevision(self, stop_revision)
952
1020
        return other_history[self_len:stop_revision]
953
1021
 
954
 
    @needs_write_lock
955
1022
    def update_revisions(self, other, stop_revision=None, overwrite=False,
956
1023
                         graph=None):
957
1024
        """Pull in new perfect-fit revisions.
1006
1073
            self._extend_partial_history(distance_from_last)
1007
1074
        return self._partial_revision_history_cache[distance_from_last]
1008
1075
 
1009
 
    @needs_write_lock
1010
1076
    def pull(self, source, overwrite=False, stop_revision=None,
1011
1077
             possible_transports=None, *args, **kwargs):
1012
1078
        """Mirror source into this branch.
1208
1274
        return result
1209
1275
 
1210
1276
    @needs_read_lock
1211
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
1277
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
 
1278
            repository=None):
1212
1279
        """Create a new line of development from the branch, into to_bzrdir.
1213
1280
 
1214
1281
        to_bzrdir controls the branch format.
1219
1286
        if (repository_policy is not None and
1220
1287
            repository_policy.requires_stacking()):
1221
1288
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
 
        result = to_bzrdir.create_branch()
 
1289
        result = to_bzrdir.create_branch(repository=repository)
1223
1290
        result.lock_write()
1224
1291
        try:
1225
1292
            if repository_policy is not None:
1255
1322
                revno = 1
1256
1323
        destination.set_last_revision_info(revno, revision_id)
1257
1324
 
1258
 
    @needs_read_lock
1259
1325
    def copy_content_into(self, destination, revision_id=None):
1260
1326
        """Copy the content of self into destination.
1261
1327
 
1262
1328
        revision_id: if not None, the revision history in the new branch will
1263
1329
                     be truncated to end with revision_id.
1264
1330
        """
1265
 
        self.update_references(destination)
1266
 
        self._synchronize_history(destination, revision_id)
1267
 
        try:
1268
 
            parent = self.get_parent()
1269
 
        except errors.InaccessibleParent, e:
1270
 
            mutter('parent was not accessible to copy: %s', e)
1271
 
        else:
1272
 
            if parent:
1273
 
                destination.set_parent(parent)
1274
 
        if self._push_should_merge_tags():
1275
 
            self.tags.merge_to(destination.tags)
 
1331
        return InterBranch.get(self, destination).copy_content_into(
 
1332
            revision_id=revision_id)
1276
1333
 
1277
1334
    def update_references(self, target):
1278
1335
        if not getattr(self._format, 'supports_reference_locations', False):
1323
1380
        """Return the most suitable metadir for a checkout of this branch.
1324
1381
        Weaves are used if this branch's repository uses weaves.
1325
1382
        """
1326
 
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1327
 
            from bzrlib.repofmt import weaverepo
1328
 
            format = bzrdir.BzrDirMetaFormat1()
1329
 
            format.repository_format = weaverepo.RepositoryFormat7()
1330
 
        else:
1331
 
            format = self.repository.bzrdir.checkout_metadir()
1332
 
            format.set_branch_format(self._format)
 
1383
        format = self.repository.bzrdir.checkout_metadir()
 
1384
        format.set_branch_format(self._format)
1333
1385
        return format
1334
1386
 
1335
1387
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1388
        stacked_on=None, create_prefix=False, use_existing_dir=False,
 
1389
        no_tree=None):
1337
1390
        """Create a clone of this branch and its bzrdir.
1338
1391
 
1339
1392
        :param to_transport: The transport to clone onto.
1346
1399
        """
1347
1400
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1401
        # clone call. Or something. 20090224 RBC/spiv.
 
1402
        # XXX: Should this perhaps clone colocated branches as well, 
 
1403
        # rather than just the default branch? 20100319 JRV
1349
1404
        if revision_id is None:
1350
1405
            revision_id = self.last_revision()
1351
1406
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
1407
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1408
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
 
1409
            no_tree=no_tree)
1354
1410
        return dir_to.open_branch()
1355
1411
 
1356
1412
    def create_checkout(self, to_location, revision_id=None,
1481
1537
     * an open routine.
1482
1538
 
1483
1539
    Formats are placed in an dict by their format string for reference
1484
 
    during branch opening. Its not required that these be instances, they
 
1540
    during branch opening. It's not required that these be instances, they
1485
1541
    can be classes themselves with class methods - it simply depends on
1486
1542
    whether state is needed for a given format or not.
1487
1543
 
1496
1552
    _formats = {}
1497
1553
    """The known formats."""
1498
1554
 
 
1555
    _extra_formats = []
 
1556
    """Extra formats that can not be part of a metadir."""
 
1557
 
1499
1558
    can_set_append_revisions_only = True
1500
1559
 
1501
1560
    def __eq__(self, other):
1510
1569
        try:
1511
1570
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
1571
            format_string = transport.get_bytes("format")
1513
 
            return klass._formats[format_string]
 
1572
            format = klass._formats[format_string]
 
1573
            if isinstance(format, MetaDirBranchFormatFactory):
 
1574
                return format()
 
1575
            return format
1514
1576
        except errors.NoSuchFile:
1515
1577
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1516
1578
        except KeyError:
1521
1583
        """Return the current default format."""
1522
1584
        return klass._default_format
1523
1585
 
1524
 
    def get_reference(self, a_bzrdir):
 
1586
    @classmethod
 
1587
    def get_formats(klass):
 
1588
        """Get all the known formats.
 
1589
 
 
1590
        Warning: This triggers a load of all lazy registered formats: do not
 
1591
        use except when that is desireed.
 
1592
        """
 
1593
        result = []
 
1594
        for fmt in klass._formats.values():
 
1595
            if isinstance(fmt, MetaDirBranchFormatFactory):
 
1596
                fmt = fmt()
 
1597
            result.append(fmt)
 
1598
        return result + klass._extra_formats
 
1599
 
 
1600
    def get_reference(self, a_bzrdir, name=None):
1525
1601
        """Get the target reference of the branch in a_bzrdir.
1526
1602
 
1527
1603
        format probing must have been completed before calling
1529
1605
        in a_bzrdir is correct.
1530
1606
 
1531
1607
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1608
        :param name: Name of the colocated branch to fetch
1532
1609
        :return: None if the branch is not a reference branch.
1533
1610
        """
1534
1611
        return None
1535
1612
 
1536
1613
    @classmethod
1537
 
    def set_reference(self, a_bzrdir, to_branch):
 
1614
    def set_reference(self, a_bzrdir, name, to_branch):
1538
1615
        """Set the target reference of the branch in a_bzrdir.
1539
1616
 
1540
1617
        format probing must have been completed before calling
1542
1619
        in a_bzrdir is correct.
1543
1620
 
1544
1621
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1622
        :param name: Name of colocated branch to set, None for default
1545
1623
        :param to_branch: branch that the checkout is to reference
1546
1624
        """
1547
1625
        raise NotImplementedError(self.set_reference)
1563
1641
            hook(params)
1564
1642
 
1565
1643
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1566
 
                           lock_type='metadir', set_format=True):
 
1644
                           repository=None, lock_type='metadir',
 
1645
                           set_format=True):
1567
1646
        """Initialize a branch in a bzrdir, with specified files
1568
1647
 
1569
1648
        :param a_bzrdir: The bzrdir to initialize the branch in
1603
1682
        finally:
1604
1683
            if lock_taken:
1605
1684
                control_files.unlock()
1606
 
        branch = self.open(a_bzrdir, name, _found=True)
 
1685
        branch = self.open(a_bzrdir, name, _found=True,
 
1686
                found_repository=repository)
1607
1687
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1608
1688
        return branch
1609
1689
 
1610
 
    def initialize(self, a_bzrdir, name=None):
 
1690
    def initialize(self, a_bzrdir, name=None, repository=None):
1611
1691
        """Create a branch of this format in a_bzrdir.
1612
1692
        
1613
1693
        :param name: Name of the colocated branch to create.
1647
1727
        """
1648
1728
        raise NotImplementedError(self.network_name)
1649
1729
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1730
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
1731
            found_repository=None):
1651
1732
        """Return the branch object for a_bzrdir
1652
1733
 
1653
1734
        :param a_bzrdir: A BzrDir that contains a branch.
1660
1741
        raise NotImplementedError(self.open)
1661
1742
 
1662
1743
    @classmethod
 
1744
    def register_extra_format(klass, format):
 
1745
        """Register a branch format that can not be part of a metadir.
 
1746
 
 
1747
        This is mainly useful to allow custom branch formats, such as
 
1748
        older Bazaar formats and foreign formats, to be tested
 
1749
        """
 
1750
        klass._extra_formats.append(format)
 
1751
        network_format_registry.register(
 
1752
            format.network_name(), format.__class__)
 
1753
 
 
1754
    @classmethod
1663
1755
    def register_format(klass, format):
1664
 
        """Register a metadir format."""
 
1756
        """Register a metadir format.
 
1757
        
 
1758
        See MetaDirBranchFormatFactory for the ability to register a format
 
1759
        without loading the code the format needs until it is actually used.
 
1760
        """
1665
1761
        klass._formats[format.get_format_string()] = format
1666
1762
        # Metadir formats have a network name of their format string, and get
1667
 
        # registered as class factories.
1668
 
        network_format_registry.register(format.get_format_string(), format.__class__)
 
1763
        # registered as factories.
 
1764
        if isinstance(format, MetaDirBranchFormatFactory):
 
1765
            network_format_registry.register(format.get_format_string(), format)
 
1766
        else:
 
1767
            network_format_registry.register(format.get_format_string(),
 
1768
                format.__class__)
1669
1769
 
1670
1770
    @classmethod
1671
1771
    def set_default_format(klass, format):
1683
1783
    def unregister_format(klass, format):
1684
1784
        del klass._formats[format.get_format_string()]
1685
1785
 
 
1786
    @classmethod
 
1787
    def unregister_extra_format(klass, format):
 
1788
        klass._extra_formats.remove(format)
 
1789
 
1686
1790
    def __str__(self):
1687
1791
        return self.get_format_description().rstrip()
1688
1792
 
1691
1795
        return False  # by default
1692
1796
 
1693
1797
 
 
1798
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1799
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1800
    
 
1801
    While none of the built in BranchFormats are lazy registered yet,
 
1802
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1803
    use it, and the bzr-loom plugin uses it as well (see
 
1804
    bzrlib.plugins.loom.formats).
 
1805
    """
 
1806
 
 
1807
    def __init__(self, format_string, module_name, member_name):
 
1808
        """Create a MetaDirBranchFormatFactory.
 
1809
 
 
1810
        :param format_string: The format string the format has.
 
1811
        :param module_name: Module to load the format class from.
 
1812
        :param member_name: Attribute name within the module for the format class.
 
1813
        """
 
1814
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1815
        self._format_string = format_string
 
1816
        
 
1817
    def get_format_string(self):
 
1818
        """See BranchFormat.get_format_string."""
 
1819
        return self._format_string
 
1820
 
 
1821
    def __call__(self):
 
1822
        """Used for network_format_registry support."""
 
1823
        return self.get_obj()()
 
1824
 
 
1825
 
1694
1826
class BranchHooks(Hooks):
1695
1827
    """A dictionary mapping hook name to a list of callables for branch hooks.
1696
1828
 
1723
1855
            "with a bzrlib.branch.PullResult object and only runs in the "
1724
1856
            "bzr client.", (0, 15), None))
1725
1857
        self.create_hook(HookPoint('pre_commit',
1726
 
            "Called after a commit is calculated but before it is is "
 
1858
            "Called after a commit is calculated but before it is "
1727
1859
            "completed. pre_commit is called with (local, master, old_revno, "
1728
1860
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
1861
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1766
1898
            "all are called with the url returned from the previous hook."
1767
1899
            "The order is however undefined.", (1, 9), None))
1768
1900
        self.create_hook(HookPoint('automatic_tag_name',
1769
 
            "Called to determine an automatic tag name for a revision."
 
1901
            "Called to determine an automatic tag name for a revision. "
1770
1902
            "automatic_tag_name is called with (branch, revision_id) and "
1771
1903
            "should return a tag name or None if no tag name could be "
1772
1904
            "determined. The first non-None tag name returned will be used.",
1863
1995
        return self.__dict__ == other.__dict__
1864
1996
 
1865
1997
    def __repr__(self):
1866
 
        if self.branch:
1867
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1868
 
        else:
1869
 
            return "<%s of format:%s bzrdir:%s>" % (
1870
 
                self.__class__.__name__, self.branch,
1871
 
                self.format, self.bzrdir)
 
1998
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1872
1999
 
1873
2000
 
1874
2001
class SwitchHookParams(object):
1916
2043
        """See BranchFormat.get_format_description()."""
1917
2044
        return "Branch format 4"
1918
2045
 
1919
 
    def initialize(self, a_bzrdir, name=None):
 
2046
    def initialize(self, a_bzrdir, name=None, repository=None):
1920
2047
        """Create a branch of this format in a_bzrdir."""
 
2048
        if repository is not None:
 
2049
            raise NotImplementedError(
 
2050
                "initialize(repository=<not None>) on %r" % (self,))
1921
2051
        utf8_files = [('revision-history', ''),
1922
2052
                      ('branch-name', ''),
1923
2053
                      ]
1932
2062
        """The network name for this format is the control dirs disk label."""
1933
2063
        return self._matchingbzrdir.get_format_string()
1934
2064
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
2065
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2066
            found_repository=None):
1936
2067
        """See BranchFormat.open()."""
1937
2068
        if not _found:
1938
2069
            # we are being called directly and must probe.
1939
2070
            raise NotImplementedError
1940
 
        return BzrBranch(_format=self,
 
2071
        if found_repository is None:
 
2072
            found_repository = a_bzrdir.open_repository()
 
2073
        return BzrBranchPreSplitOut(_format=self,
1941
2074
                         _control_files=a_bzrdir._control_files,
1942
2075
                         a_bzrdir=a_bzrdir,
1943
2076
                         name=name,
1944
 
                         _repository=a_bzrdir.open_repository())
 
2077
                         _repository=found_repository)
1945
2078
 
1946
2079
    def __str__(self):
1947
2080
        return "Bazaar-NG branch format 4"
1961
2094
        """
1962
2095
        return self.get_format_string()
1963
2096
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
2097
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2098
            found_repository=None):
1965
2099
        """See BranchFormat.open()."""
1966
2100
        if not _found:
1967
2101
            format = BranchFormat.find_format(a_bzrdir, name=name)
1972
2106
        try:
1973
2107
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
2108
                                                         lockdir.LockDir)
 
2109
            if found_repository is None:
 
2110
                found_repository = a_bzrdir.find_repository()
1975
2111
            return self._branch_class()(_format=self,
1976
2112
                              _control_files=control_files,
1977
2113
                              name=name,
1978
2114
                              a_bzrdir=a_bzrdir,
1979
 
                              _repository=a_bzrdir.find_repository(),
 
2115
                              _repository=found_repository,
1980
2116
                              ignore_fallbacks=ignore_fallbacks)
1981
2117
        except errors.NoSuchFile:
1982
2118
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2014
2150
        """See BranchFormat.get_format_description()."""
2015
2151
        return "Branch format 5"
2016
2152
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
2153
    def initialize(self, a_bzrdir, name=None, repository=None):
2018
2154
        """Create a branch of this format in a_bzrdir."""
2019
2155
        utf8_files = [('revision-history', ''),
2020
2156
                      ('branch-name', ''),
2021
2157
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2158
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2023
2159
 
2024
2160
    def supports_tags(self):
2025
2161
        return False
2047
2183
        """See BranchFormat.get_format_description()."""
2048
2184
        return "Branch format 6"
2049
2185
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
2186
    def initialize(self, a_bzrdir, name=None, repository=None):
2051
2187
        """Create a branch of this format in a_bzrdir."""
2052
2188
        utf8_files = [('last-revision', '0 null:\n'),
2053
2189
                      ('branch.conf', ''),
2054
2190
                      ('tags', ''),
2055
2191
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2192
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2057
2193
 
2058
2194
    def make_tags(self, branch):
2059
2195
        """See bzrlib.branch.BranchFormat.make_tags()."""
2077
2213
        """See BranchFormat.get_format_description()."""
2078
2214
        return "Branch format 8"
2079
2215
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
2216
    def initialize(self, a_bzrdir, name=None, repository=None):
2081
2217
        """Create a branch of this format in a_bzrdir."""
2082
2218
        utf8_files = [('last-revision', '0 null:\n'),
2083
2219
                      ('branch.conf', ''),
2084
2220
                      ('tags', ''),
2085
2221
                      ('references', '')
2086
2222
                      ]
2087
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2223
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2088
2224
 
2089
2225
    def __init__(self):
2090
2226
        super(BzrBranchFormat8, self).__init__()
2113
2249
    This format was introduced in bzr 1.6.
2114
2250
    """
2115
2251
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
2252
    def initialize(self, a_bzrdir, name=None, repository=None):
2117
2253
        """Create a branch of this format in a_bzrdir."""
2118
2254
        utf8_files = [('last-revision', '0 null:\n'),
2119
2255
                      ('branch.conf', ''),
2120
2256
                      ('tags', ''),
2121
2257
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2258
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2123
2259
 
2124
2260
    def _branch_class(self):
2125
2261
        return BzrBranch7
2157
2293
        """See BranchFormat.get_format_description()."""
2158
2294
        return "Checkout reference format 1"
2159
2295
 
2160
 
    def get_reference(self, a_bzrdir):
 
2296
    def get_reference(self, a_bzrdir, name=None):
2161
2297
        """See BranchFormat.get_reference()."""
2162
 
        transport = a_bzrdir.get_branch_transport(None)
 
2298
        transport = a_bzrdir.get_branch_transport(None, name=name)
2163
2299
        return transport.get_bytes('location')
2164
2300
 
2165
 
    def set_reference(self, a_bzrdir, to_branch):
 
2301
    def set_reference(self, a_bzrdir, name, to_branch):
2166
2302
        """See BranchFormat.set_reference()."""
2167
 
        transport = a_bzrdir.get_branch_transport(None)
 
2303
        transport = a_bzrdir.get_branch_transport(None, name=name)
2168
2304
        location = transport.put_bytes('location', to_branch.base)
2169
2305
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
2306
    def initialize(self, a_bzrdir, name=None, target_branch=None,
 
2307
            repository=None):
2171
2308
        """Create a branch of this format in a_bzrdir."""
2172
2309
        if target_branch is None:
2173
2310
            # this format does not implement branch itself, thus the implicit
2201
2338
        return clone
2202
2339
 
2203
2340
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
 
             possible_transports=None, ignore_fallbacks=False):
 
2341
             possible_transports=None, ignore_fallbacks=False,
 
2342
             found_repository=None):
2205
2343
        """Return the branch that the branch reference in a_bzrdir points at.
2206
2344
 
2207
2345
        :param a_bzrdir: A BzrDir that contains a branch.
2221
2359
                raise AssertionError("wrong format %r found for %r" %
2222
2360
                    (format, self))
2223
2361
        if location is None:
2224
 
            location = self.get_reference(a_bzrdir)
 
2362
            location = self.get_reference(a_bzrdir, name)
2225
2363
        real_bzrdir = bzrdir.BzrDir.open(
2226
2364
            location, possible_transports=possible_transports)
2227
2365
        result = real_bzrdir.open_branch(name=name, 
2259
2397
BranchFormat.register_format(__format7)
2260
2398
BranchFormat.register_format(__format8)
2261
2399
BranchFormat.set_default_format(__format7)
2262
 
_legacy_formats = [BzrBranchFormat4(),
2263
 
    ]
2264
 
network_format_registry.register(
2265
 
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
 
2400
BranchFormat.register_extra_format(BzrBranchFormat4())
 
2401
 
 
2402
 
 
2403
class BranchWriteLockResult(LogicalLockResult):
 
2404
    """The result of write locking a branch.
 
2405
 
 
2406
    :ivar branch_token: The token obtained from the underlying branch lock, or
 
2407
        None.
 
2408
    :ivar unlock: A callable which will unlock the lock.
 
2409
    """
 
2410
 
 
2411
    def __init__(self, unlock, branch_token):
 
2412
        LogicalLockResult.__init__(self, unlock)
 
2413
        self.branch_token = branch_token
 
2414
 
 
2415
    def __repr__(self):
 
2416
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
 
2417
            self.unlock)
2266
2418
 
2267
2419
 
2268
2420
class BzrBranch(Branch, _RelockDebugMixin):
2324
2476
        return self.control_files.is_locked()
2325
2477
 
2326
2478
    def lock_write(self, token=None):
 
2479
        """Lock the branch for write operations.
 
2480
 
 
2481
        :param token: A token to permit reacquiring a previously held and
 
2482
            preserved lock.
 
2483
        :return: A BranchWriteLockResult.
 
2484
        """
2327
2485
        if not self.is_locked():
2328
2486
            self._note_lock('w')
2329
2487
        # All-in-one needs to always unlock/lock.
2335
2493
        else:
2336
2494
            took_lock = False
2337
2495
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
2496
            return BranchWriteLockResult(self.unlock,
 
2497
                self.control_files.lock_write(token=token))
2339
2498
        except:
2340
2499
            if took_lock:
2341
2500
                self.repository.unlock()
2342
2501
            raise
2343
2502
 
2344
2503
    def lock_read(self):
 
2504
        """Lock the branch for read operations.
 
2505
 
 
2506
        :return: A bzrlib.lock.LogicalLockResult.
 
2507
        """
2345
2508
        if not self.is_locked():
2346
2509
            self._note_lock('r')
2347
2510
        # All-in-one needs to always unlock/lock.
2354
2517
            took_lock = False
2355
2518
        try:
2356
2519
            self.control_files.lock_read()
 
2520
            return LogicalLockResult(self.unlock)
2357
2521
        except:
2358
2522
            if took_lock:
2359
2523
                self.repository.unlock()
2515
2679
        result.target_branch = target
2516
2680
        result.old_revno, result.old_revid = target.last_revision_info()
2517
2681
        self.update_references(target)
2518
 
        if result.old_revid != self.last_revision():
 
2682
        if result.old_revid != stop_revision:
2519
2683
            # We assume that during 'push' this repository is closer than
2520
2684
            # the target.
2521
2685
            graph = self.repository.get_graph(target.repository)
2544
2708
                mode=self.bzrdir._get_file_mode())
2545
2709
 
2546
2710
 
 
2711
class BzrBranchPreSplitOut(BzrBranch):
 
2712
 
 
2713
    def _get_checkout_format(self):
 
2714
        """Return the most suitable metadir for a checkout of this branch.
 
2715
        Weaves are used if this branch's repository uses weaves.
 
2716
        """
 
2717
        from bzrlib.repofmt.weaverepo import RepositoryFormat7
 
2718
        from bzrlib.bzrdir import BzrDirMetaFormat1
 
2719
        format = BzrDirMetaFormat1()
 
2720
        format.repository_format = RepositoryFormat7()
 
2721
        return format
 
2722
 
 
2723
 
2547
2724
class BzrBranch5(BzrBranch):
2548
2725
    """A format 5 branch. This supports new features over plain branches.
2549
2726
 
2983
3160
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2984
3161
    """
2985
3162
 
 
3163
    @deprecated_method(deprecated_in((2, 3, 0)))
2986
3164
    def __int__(self):
2987
 
        # DEPRECATED: pull used to return the change in revno
 
3165
        """Return the relative change in revno.
 
3166
 
 
3167
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3168
        """
2988
3169
        return self.new_revno - self.old_revno
2989
3170
 
2990
3171
    def report(self, to_file):
3015
3196
        target, otherwise it will be None.
3016
3197
    """
3017
3198
 
 
3199
    @deprecated_method(deprecated_in((2, 3, 0)))
3018
3200
    def __int__(self):
3019
 
        # DEPRECATED: push used to return the change in revno
 
3201
        """Return the relative change in revno.
 
3202
 
 
3203
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3204
        """
3020
3205
        return self.new_revno - self.old_revno
3021
3206
 
3022
3207
    def report(self, to_file):
3145
3330
    _optimisers = []
3146
3331
    """The available optimised InterBranch types."""
3147
3332
 
3148
 
    @staticmethod
3149
 
    def _get_branch_formats_to_test():
3150
 
        """Return a tuple with the Branch formats to use when testing."""
3151
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
3333
    @classmethod
 
3334
    def _get_branch_formats_to_test(klass):
 
3335
        """Return an iterable of format tuples for testing.
 
3336
        
 
3337
        :return: An iterable of (from_format, to_format) to use when testing
 
3338
            this InterBranch class. Each InterBranch class should define this
 
3339
            method itself.
 
3340
        """
 
3341
        raise NotImplementedError(klass._get_branch_formats_to_test)
3152
3342
 
 
3343
    @needs_write_lock
3153
3344
    def pull(self, overwrite=False, stop_revision=None,
3154
3345
             possible_transports=None, local=False):
3155
3346
        """Mirror source into target branch.
3160
3351
        """
3161
3352
        raise NotImplementedError(self.pull)
3162
3353
 
 
3354
    @needs_write_lock
3163
3355
    def update_revisions(self, stop_revision=None, overwrite=False,
3164
3356
                         graph=None):
3165
3357
        """Pull in new perfect-fit revisions.
3173
3365
        """
3174
3366
        raise NotImplementedError(self.update_revisions)
3175
3367
 
 
3368
    @needs_write_lock
3176
3369
    def push(self, overwrite=False, stop_revision=None,
3177
3370
             _override_hook_source_branch=None):
3178
3371
        """Mirror the source branch into the target branch.
3181
3374
        """
3182
3375
        raise NotImplementedError(self.push)
3183
3376
 
 
3377
    @needs_write_lock
 
3378
    def copy_content_into(self, revision_id=None):
 
3379
        """Copy the content of source into target
 
3380
 
 
3381
        revision_id: if not None, the revision history in the new branch will
 
3382
                     be truncated to end with revision_id.
 
3383
        """
 
3384
        raise NotImplementedError(self.copy_content_into)
 
3385
 
3184
3386
 
3185
3387
class GenericInterBranch(InterBranch):
3186
 
    """InterBranch implementation that uses public Branch functions.
3187
 
    """
3188
 
 
3189
 
    @staticmethod
3190
 
    def _get_branch_formats_to_test():
3191
 
        return BranchFormat._default_format, BranchFormat._default_format
3192
 
 
 
3388
    """InterBranch implementation that uses public Branch functions."""
 
3389
 
 
3390
    @classmethod
 
3391
    def is_compatible(klass, source, target):
 
3392
        # GenericBranch uses the public API, so always compatible
 
3393
        return True
 
3394
 
 
3395
    @classmethod
 
3396
    def _get_branch_formats_to_test(klass):
 
3397
        return [(BranchFormat._default_format, BranchFormat._default_format)]
 
3398
 
 
3399
    @classmethod
 
3400
    def unwrap_format(klass, format):
 
3401
        if isinstance(format, remote.RemoteBranchFormat):
 
3402
            format._ensure_real()
 
3403
            return format._custom_format
 
3404
        return format
 
3405
 
 
3406
    @needs_write_lock
 
3407
    def copy_content_into(self, revision_id=None):
 
3408
        """Copy the content of source into target
 
3409
 
 
3410
        revision_id: if not None, the revision history in the new branch will
 
3411
                     be truncated to end with revision_id.
 
3412
        """
 
3413
        self.source.update_references(self.target)
 
3414
        self.source._synchronize_history(self.target, revision_id)
 
3415
        try:
 
3416
            parent = self.source.get_parent()
 
3417
        except errors.InaccessibleParent, e:
 
3418
            mutter('parent was not accessible to copy: %s', e)
 
3419
        else:
 
3420
            if parent:
 
3421
                self.target.set_parent(parent)
 
3422
        if self.source._push_should_merge_tags():
 
3423
            self.source.tags.merge_to(self.target.tags)
 
3424
 
 
3425
    @needs_write_lock
3193
3426
    def update_revisions(self, stop_revision=None, overwrite=False,
3194
3427
        graph=None):
3195
3428
        """See InterBranch.update_revisions()."""
3196
 
        self.source.lock_read()
3197
 
        try:
3198
 
            other_revno, other_last_revision = self.source.last_revision_info()
3199
 
            stop_revno = None # unknown
3200
 
            if stop_revision is None:
3201
 
                stop_revision = other_last_revision
3202
 
                if _mod_revision.is_null(stop_revision):
3203
 
                    # if there are no commits, we're done.
3204
 
                    return
3205
 
                stop_revno = other_revno
3206
 
 
3207
 
            # what's the current last revision, before we fetch [and change it
3208
 
            # possibly]
3209
 
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
3210
 
            # we fetch here so that we don't process data twice in the common
3211
 
            # case of having something to pull, and so that the check for
3212
 
            # already merged can operate on the just fetched graph, which will
3213
 
            # be cached in memory.
3214
 
            self.target.fetch(self.source, stop_revision)
3215
 
            # Check to see if one is an ancestor of the other
3216
 
            if not overwrite:
3217
 
                if graph is None:
3218
 
                    graph = self.target.repository.get_graph()
3219
 
                if self.target._check_if_descendant_or_diverged(
3220
 
                        stop_revision, last_rev, graph, self.source):
3221
 
                    # stop_revision is a descendant of last_rev, but we aren't
3222
 
                    # overwriting, so we're done.
3223
 
                    return
3224
 
            if stop_revno is None:
3225
 
                if graph is None:
3226
 
                    graph = self.target.repository.get_graph()
3227
 
                this_revno, this_last_revision = \
3228
 
                        self.target.last_revision_info()
3229
 
                stop_revno = graph.find_distance_to_null(stop_revision,
3230
 
                                [(other_last_revision, other_revno),
3231
 
                                 (this_last_revision, this_revno)])
3232
 
            self.target.set_last_revision_info(stop_revno, stop_revision)
3233
 
        finally:
3234
 
            self.source.unlock()
3235
 
 
 
3429
        other_revno, other_last_revision = self.source.last_revision_info()
 
3430
        stop_revno = None # unknown
 
3431
        if stop_revision is None:
 
3432
            stop_revision = other_last_revision
 
3433
            if _mod_revision.is_null(stop_revision):
 
3434
                # if there are no commits, we're done.
 
3435
                return
 
3436
            stop_revno = other_revno
 
3437
 
 
3438
        # what's the current last revision, before we fetch [and change it
 
3439
        # possibly]
 
3440
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3441
        # we fetch here so that we don't process data twice in the common
 
3442
        # case of having something to pull, and so that the check for
 
3443
        # already merged can operate on the just fetched graph, which will
 
3444
        # be cached in memory.
 
3445
        self.target.fetch(self.source, stop_revision)
 
3446
        # Check to see if one is an ancestor of the other
 
3447
        if not overwrite:
 
3448
            if graph is None:
 
3449
                graph = self.target.repository.get_graph()
 
3450
            if self.target._check_if_descendant_or_diverged(
 
3451
                    stop_revision, last_rev, graph, self.source):
 
3452
                # stop_revision is a descendant of last_rev, but we aren't
 
3453
                # overwriting, so we're done.
 
3454
                return
 
3455
        if stop_revno is None:
 
3456
            if graph is None:
 
3457
                graph = self.target.repository.get_graph()
 
3458
            this_revno, this_last_revision = \
 
3459
                    self.target.last_revision_info()
 
3460
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3461
                            [(other_last_revision, other_revno),
 
3462
                             (this_last_revision, this_revno)])
 
3463
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3464
 
 
3465
    @needs_write_lock
3236
3466
    def pull(self, overwrite=False, stop_revision=None,
3237
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3467
             possible_transports=None, run_hooks=True,
3238
3468
             _override_hook_target=None, local=False):
3239
 
        """See Branch.pull.
 
3469
        """Pull from source into self, updating my master if any.
3240
3470
 
3241
 
        :param _hook_master: Private parameter - set the branch to
3242
 
            be supplied as the master to pull hooks.
3243
3471
        :param run_hooks: Private parameter - if false, this branch
3244
3472
            is being called because it's the master of the primary branch,
3245
3473
            so it should not run its hooks.
3246
 
        :param _override_hook_target: Private parameter - set the branch to be
3247
 
            supplied as the target_branch to pull hooks.
3248
 
        :param local: Only update the local branch, and not the bound branch.
3249
3474
        """
3250
 
        # This type of branch can't be bound.
3251
 
        if local:
 
3475
        bound_location = self.target.get_bound_location()
 
3476
        if local and not bound_location:
3252
3477
            raise errors.LocalRequiresBoundBranch()
3253
 
        result = PullResult()
3254
 
        result.source_branch = self.source
3255
 
        if _override_hook_target is None:
3256
 
            result.target_branch = self.target
3257
 
        else:
3258
 
            result.target_branch = _override_hook_target
3259
 
        self.source.lock_read()
 
3478
        master_branch = None
 
3479
        source_is_master = (self.source.user_url == bound_location)
 
3480
        if not local and bound_location and not source_is_master:
 
3481
            # not pulling from master, so we need to update master.
 
3482
            master_branch = self.target.get_master_branch(possible_transports)
 
3483
            master_branch.lock_write()
3260
3484
        try:
3261
 
            # We assume that during 'pull' the target repository is closer than
3262
 
            # the source one.
3263
 
            self.source.update_references(self.target)
3264
 
            graph = self.target.repository.get_graph(self.source.repository)
3265
 
            # TODO: Branch formats should have a flag that indicates 
3266
 
            # that revno's are expensive, and pull() should honor that flag.
3267
 
            # -- JRV20090506
3268
 
            result.old_revno, result.old_revid = \
3269
 
                self.target.last_revision_info()
3270
 
            self.target.update_revisions(self.source, stop_revision,
3271
 
                overwrite=overwrite, graph=graph)
3272
 
            # TODO: The old revid should be specified when merging tags, 
3273
 
            # so a tags implementation that versions tags can only 
3274
 
            # pull in the most recent changes. -- JRV20090506
3275
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3276
 
                overwrite)
3277
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3278
 
            if _hook_master:
3279
 
                result.master_branch = _hook_master
3280
 
                result.local_branch = result.target_branch
3281
 
            else:
3282
 
                result.master_branch = result.target_branch
3283
 
                result.local_branch = None
3284
 
            if run_hooks:
3285
 
                for hook in Branch.hooks['post_pull']:
3286
 
                    hook(result)
 
3485
            if master_branch:
 
3486
                # pull from source into master.
 
3487
                master_branch.pull(self.source, overwrite, stop_revision,
 
3488
                    run_hooks=False)
 
3489
            return self._pull(overwrite,
 
3490
                stop_revision, _hook_master=master_branch,
 
3491
                run_hooks=run_hooks,
 
3492
                _override_hook_target=_override_hook_target,
 
3493
                merge_tags_to_master=not source_is_master)
3287
3494
        finally:
3288
 
            self.source.unlock()
3289
 
        return result
 
3495
            if master_branch:
 
3496
                master_branch.unlock()
3290
3497
 
3291
3498
    def push(self, overwrite=False, stop_revision=None,
3292
3499
             _override_hook_source_branch=None):
3332
3539
                # push into the master from the source branch.
3333
3540
                self.source._basic_push(master_branch, overwrite, stop_revision)
3334
3541
                # and push into the target branch from the source. Note that we
3335
 
                # push from the source branch again, because its considered the
 
3542
                # push from the source branch again, because it's considered the
3336
3543
                # highest bandwidth repository.
3337
3544
                result = self.source._basic_push(self.target, overwrite,
3338
3545
                    stop_revision)
3354
3561
            _run_hooks()
3355
3562
            return result
3356
3563
 
3357
 
    @classmethod
3358
 
    def is_compatible(self, source, target):
3359
 
        # GenericBranch uses the public API, so always compatible
3360
 
        return True
3361
 
 
3362
 
 
3363
 
class InterToBranch5(GenericInterBranch):
3364
 
 
3365
 
    @staticmethod
3366
 
    def _get_branch_formats_to_test():
3367
 
        return BranchFormat._default_format, BzrBranchFormat5()
3368
 
 
3369
 
    def pull(self, overwrite=False, stop_revision=None,
3370
 
             possible_transports=None, run_hooks=True,
3371
 
             _override_hook_target=None, local=False):
3372
 
        """Pull from source into self, updating my master if any.
3373
 
 
 
3564
    def _pull(self, overwrite=False, stop_revision=None,
 
3565
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3566
             _override_hook_target=None, local=False,
 
3567
             merge_tags_to_master=True):
 
3568
        """See Branch.pull.
 
3569
 
 
3570
        This function is the core worker, used by GenericInterBranch.pull to
 
3571
        avoid duplication when pulling source->master and source->local.
 
3572
 
 
3573
        :param _hook_master: Private parameter - set the branch to
 
3574
            be supplied as the master to pull hooks.
3374
3575
        :param run_hooks: Private parameter - if false, this branch
3375
3576
            is being called because it's the master of the primary branch,
3376
3577
            so it should not run its hooks.
 
3578
        :param _override_hook_target: Private parameter - set the branch to be
 
3579
            supplied as the target_branch to pull hooks.
 
3580
        :param local: Only update the local branch, and not the bound branch.
3377
3581
        """
3378
 
        bound_location = self.target.get_bound_location()
3379
 
        if local and not bound_location:
 
3582
        # This type of branch can't be bound.
 
3583
        if local:
3380
3584
            raise errors.LocalRequiresBoundBranch()
3381
 
        master_branch = None
3382
 
        if not local and bound_location and self.source.user_url != bound_location:
3383
 
            # not pulling from master, so we need to update master.
3384
 
            master_branch = self.target.get_master_branch(possible_transports)
3385
 
            master_branch.lock_write()
 
3585
        result = PullResult()
 
3586
        result.source_branch = self.source
 
3587
        if _override_hook_target is None:
 
3588
            result.target_branch = self.target
 
3589
        else:
 
3590
            result.target_branch = _override_hook_target
 
3591
        self.source.lock_read()
3386
3592
        try:
3387
 
            if master_branch:
3388
 
                # pull from source into master.
3389
 
                master_branch.pull(self.source, overwrite, stop_revision,
3390
 
                    run_hooks=False)
3391
 
            return super(InterToBranch5, self).pull(overwrite,
3392
 
                stop_revision, _hook_master=master_branch,
3393
 
                run_hooks=run_hooks,
3394
 
                _override_hook_target=_override_hook_target)
 
3593
            # We assume that during 'pull' the target repository is closer than
 
3594
            # the source one.
 
3595
            self.source.update_references(self.target)
 
3596
            graph = self.target.repository.get_graph(self.source.repository)
 
3597
            # TODO: Branch formats should have a flag that indicates 
 
3598
            # that revno's are expensive, and pull() should honor that flag.
 
3599
            # -- JRV20090506
 
3600
            result.old_revno, result.old_revid = \
 
3601
                self.target.last_revision_info()
 
3602
            self.target.update_revisions(self.source, stop_revision,
 
3603
                overwrite=overwrite, graph=graph)
 
3604
            # TODO: The old revid should be specified when merging tags, 
 
3605
            # so a tags implementation that versions tags can only 
 
3606
            # pull in the most recent changes. -- JRV20090506
 
3607
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3608
                overwrite, ignore_master=not merge_tags_to_master)
 
3609
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3610
            if _hook_master:
 
3611
                result.master_branch = _hook_master
 
3612
                result.local_branch = result.target_branch
 
3613
            else:
 
3614
                result.master_branch = result.target_branch
 
3615
                result.local_branch = None
 
3616
            if run_hooks:
 
3617
                for hook in Branch.hooks['post_pull']:
 
3618
                    hook(result)
3395
3619
        finally:
3396
 
            if master_branch:
3397
 
                master_branch.unlock()
 
3620
            self.source.unlock()
 
3621
        return result
3398
3622
 
3399
3623
 
3400
3624
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)