~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Vincent Ladeuil
  • Date: 2010-07-15 13:41:31 UTC
  • mto: This revision was merged to the branch mainline in revision 5347.
  • Revision ID: v.ladeuil+lp@free.fr-20100715134131-i2q34l1er6pt17op
Cleanup import in bzrlib.version_info_formats (no deprecations left there).

Show diffs side-by-side

added added

removed removed

Lines of Context:
29
29
        errors,
30
30
        lockdir,
31
31
        lockable_files,
 
32
        remote,
32
33
        repository,
33
34
        revision as _mod_revision,
34
35
        rio,
49
50
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
51
from bzrlib.hooks import HookPoint, Hooks
51
52
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
 
53
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
54
from bzrlib import registry
54
55
from bzrlib.symbol_versioning import (
55
56
    deprecated_in,
197
198
        return self.supports_tags() and self.tags.get_tag_dict()
198
199
 
199
200
    def get_config(self):
 
201
        """Get a bzrlib.config.BranchConfig for this Branch.
 
202
 
 
203
        This can then be used to get and set configuration options for the
 
204
        branch.
 
205
 
 
206
        :return: A bzrlib.config.BranchConfig.
 
207
        """
200
208
        return BranchConfig(self)
201
209
 
202
210
    def _get_config(self):
283
291
        new_history.reverse()
284
292
        return new_history
285
293
 
286
 
    def lock_write(self):
 
294
    def lock_write(self, token=None):
 
295
        """Lock the branch for write operations.
 
296
 
 
297
        :param token: A token to permit reacquiring a previously held and
 
298
            preserved lock.
 
299
        :return: A BranchWriteLockResult.
 
300
        """
287
301
        raise NotImplementedError(self.lock_write)
288
302
 
289
303
    def lock_read(self):
 
304
        """Lock the branch for read operations.
 
305
 
 
306
        :return: A bzrlib.lock.LogicalLockResult.
 
307
        """
290
308
        raise NotImplementedError(self.lock_read)
291
309
 
292
310
    def unlock(self):
783
801
            if len(old_repository._fallback_repositories) != 1:
784
802
                raise AssertionError("can't cope with fallback repositories "
785
803
                    "of %r" % (self.repository,))
786
 
            # unlock it, including unlocking the fallback
 
804
            # Open the new repository object.
 
805
            # Repositories don't offer an interface to remove fallback
 
806
            # repositories today; take the conceptually simpler option and just
 
807
            # reopen it.  We reopen it starting from the URL so that we
 
808
            # get a separate connection for RemoteRepositories and can
 
809
            # stream from one of them to the other.  This does mean doing
 
810
            # separate SSH connection setup, but unstacking is not a
 
811
            # common operation so it's tolerable.
 
812
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
813
            new_repository = new_bzrdir.find_repository()
 
814
            if new_repository._fallback_repositories:
 
815
                raise AssertionError("didn't expect %r to have "
 
816
                    "fallback_repositories"
 
817
                    % (self.repository,))
 
818
            # Replace self.repository with the new repository.
 
819
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
820
            # lock count) of self.repository to the new repository.
 
821
            lock_token = old_repository.lock_write().repository_token
 
822
            self.repository = new_repository
 
823
            if isinstance(self, remote.RemoteBranch):
 
824
                # Remote branches can have a second reference to the old
 
825
                # repository that need to be replaced.
 
826
                if self._real_branch is not None:
 
827
                    self._real_branch.repository = new_repository
 
828
            self.repository.lock_write(token=lock_token)
 
829
            if lock_token is not None:
 
830
                old_repository.leave_lock_in_place()
787
831
            old_repository.unlock()
 
832
            if lock_token is not None:
 
833
                # XXX: self.repository.leave_lock_in_place() before this
 
834
                # function will not be preserved.  Fortunately that doesn't
 
835
                # affect the current default format (2a), and would be a
 
836
                # corner-case anyway.
 
837
                #  - Andrew Bennetts, 2010/06/30
 
838
                self.repository.dont_leave_lock_in_place()
 
839
            old_lock_count = 0
 
840
            while True:
 
841
                try:
 
842
                    old_repository.unlock()
 
843
                except errors.LockNotHeld:
 
844
                    break
 
845
                old_lock_count += 1
 
846
            if old_lock_count == 0:
 
847
                raise AssertionError(
 
848
                    'old_repository should have been locked at least once.')
 
849
            for i in range(old_lock_count-1):
 
850
                self.repository.lock_write()
 
851
            # Fetch from the old repository into the new.
788
852
            old_repository.lock_read()
789
853
            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
854
                # XXX: If you unstack a branch while it has a working tree
809
855
                # with a pending merge, the pending-merged revisions will no
810
856
                # longer be present.  You can (probably) revert and remerge.
951
997
                raise errors.NoSuchRevision(self, stop_revision)
952
998
        return other_history[self_len:stop_revision]
953
999
 
954
 
    @needs_write_lock
955
1000
    def update_revisions(self, other, stop_revision=None, overwrite=False,
956
1001
                         graph=None):
957
1002
        """Pull in new perfect-fit revisions.
1006
1051
            self._extend_partial_history(distance_from_last)
1007
1052
        return self._partial_revision_history_cache[distance_from_last]
1008
1053
 
1009
 
    @needs_write_lock
1010
1054
    def pull(self, source, overwrite=False, stop_revision=None,
1011
1055
             possible_transports=None, *args, **kwargs):
1012
1056
        """Mirror source into this branch.
1255
1299
                revno = 1
1256
1300
        destination.set_last_revision_info(revno, revision_id)
1257
1301
 
1258
 
    @needs_read_lock
1259
1302
    def copy_content_into(self, destination, revision_id=None):
1260
1303
        """Copy the content of self into destination.
1261
1304
 
1262
1305
        revision_id: if not None, the revision history in the new branch will
1263
1306
                     be truncated to end with revision_id.
1264
1307
        """
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)
 
1308
        return InterBranch.get(self, destination).copy_content_into(
 
1309
            revision_id=revision_id)
1276
1310
 
1277
1311
    def update_references(self, target):
1278
1312
        if not getattr(self._format, 'supports_reference_locations', False):
1346
1380
        """
1347
1381
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1382
        # clone call. Or something. 20090224 RBC/spiv.
 
1383
        # XXX: Should this perhaps clone colocated branches as well, 
 
1384
        # rather than just the default branch? 20100319 JRV
1349
1385
        if revision_id is None:
1350
1386
            revision_id = self.last_revision()
1351
1387
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1510
1546
        try:
1511
1547
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
1548
            format_string = transport.get_bytes("format")
1513
 
            return klass._formats[format_string]
 
1549
            format = klass._formats[format_string]
 
1550
            if isinstance(format, MetaDirBranchFormatFactory):
 
1551
                return format()
 
1552
            return format
1514
1553
        except errors.NoSuchFile:
1515
1554
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1516
1555
        except KeyError:
1521
1560
        """Return the current default format."""
1522
1561
        return klass._default_format
1523
1562
 
1524
 
    def get_reference(self, a_bzrdir):
 
1563
    @classmethod
 
1564
    def get_formats(klass):
 
1565
        """Get all the known formats.
 
1566
 
 
1567
        Warning: This triggers a load of all lazy registered formats: do not
 
1568
        use except when that is desireed.
 
1569
        """
 
1570
        result = []
 
1571
        for fmt in klass._formats.values():
 
1572
            if isinstance(fmt, MetaDirBranchFormatFactory):
 
1573
                fmt = fmt()
 
1574
            result.append(fmt)
 
1575
        return result
 
1576
 
 
1577
    def get_reference(self, a_bzrdir, name=None):
1525
1578
        """Get the target reference of the branch in a_bzrdir.
1526
1579
 
1527
1580
        format probing must have been completed before calling
1529
1582
        in a_bzrdir is correct.
1530
1583
 
1531
1584
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1585
        :param name: Name of the colocated branch to fetch
1532
1586
        :return: None if the branch is not a reference branch.
1533
1587
        """
1534
1588
        return None
1535
1589
 
1536
1590
    @classmethod
1537
 
    def set_reference(self, a_bzrdir, to_branch):
 
1591
    def set_reference(self, a_bzrdir, name, to_branch):
1538
1592
        """Set the target reference of the branch in a_bzrdir.
1539
1593
 
1540
1594
        format probing must have been completed before calling
1542
1596
        in a_bzrdir is correct.
1543
1597
 
1544
1598
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1599
        :param name: Name of colocated branch to set, None for default
1545
1600
        :param to_branch: branch that the checkout is to reference
1546
1601
        """
1547
1602
        raise NotImplementedError(self.set_reference)
1661
1716
 
1662
1717
    @classmethod
1663
1718
    def register_format(klass, format):
1664
 
        """Register a metadir format."""
 
1719
        """Register a metadir format.
 
1720
        
 
1721
        See MetaDirBranchFormatFactory for the ability to register a format
 
1722
        without loading the code the format needs until it is actually used.
 
1723
        """
1665
1724
        klass._formats[format.get_format_string()] = format
1666
1725
        # 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__)
 
1726
        # registered as factories.
 
1727
        if isinstance(format, MetaDirBranchFormatFactory):
 
1728
            network_format_registry.register(format.get_format_string(), format)
 
1729
        else:
 
1730
            network_format_registry.register(format.get_format_string(),
 
1731
                format.__class__)
1669
1732
 
1670
1733
    @classmethod
1671
1734
    def set_default_format(klass, format):
1691
1754
        return False  # by default
1692
1755
 
1693
1756
 
 
1757
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1758
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1759
    
 
1760
    While none of the built in BranchFormats are lazy registered yet,
 
1761
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1762
    use it, and the bzr-loom plugin uses it as well (see
 
1763
    bzrlib.plugins.loom.formats).
 
1764
    """
 
1765
 
 
1766
    def __init__(self, format_string, module_name, member_name):
 
1767
        """Create a MetaDirBranchFormatFactory.
 
1768
 
 
1769
        :param format_string: The format string the format has.
 
1770
        :param module_name: Module to load the format class from.
 
1771
        :param member_name: Attribute name within the module for the format class.
 
1772
        """
 
1773
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1774
        self._format_string = format_string
 
1775
        
 
1776
    def get_format_string(self):
 
1777
        """See BranchFormat.get_format_string."""
 
1778
        return self._format_string
 
1779
 
 
1780
    def __call__(self):
 
1781
        """Used for network_format_registry support."""
 
1782
        return self.get_obj()()
 
1783
 
 
1784
 
1694
1785
class BranchHooks(Hooks):
1695
1786
    """A dictionary mapping hook name to a list of callables for branch hooks.
1696
1787
 
2157
2248
        """See BranchFormat.get_format_description()."""
2158
2249
        return "Checkout reference format 1"
2159
2250
 
2160
 
    def get_reference(self, a_bzrdir):
 
2251
    def get_reference(self, a_bzrdir, name=None):
2161
2252
        """See BranchFormat.get_reference()."""
2162
 
        transport = a_bzrdir.get_branch_transport(None)
 
2253
        transport = a_bzrdir.get_branch_transport(None, name=name)
2163
2254
        return transport.get_bytes('location')
2164
2255
 
2165
 
    def set_reference(self, a_bzrdir, to_branch):
 
2256
    def set_reference(self, a_bzrdir, name, to_branch):
2166
2257
        """See BranchFormat.set_reference()."""
2167
 
        transport = a_bzrdir.get_branch_transport(None)
 
2258
        transport = a_bzrdir.get_branch_transport(None, name=name)
2168
2259
        location = transport.put_bytes('location', to_branch.base)
2169
2260
 
2170
2261
    def initialize(self, a_bzrdir, name=None, target_branch=None):
2221
2312
                raise AssertionError("wrong format %r found for %r" %
2222
2313
                    (format, self))
2223
2314
        if location is None:
2224
 
            location = self.get_reference(a_bzrdir)
 
2315
            location = self.get_reference(a_bzrdir, name)
2225
2316
        real_bzrdir = bzrdir.BzrDir.open(
2226
2317
            location, possible_transports=possible_transports)
2227
2318
        result = real_bzrdir.open_branch(name=name, 
2265
2356
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2266
2357
 
2267
2358
 
 
2359
class BranchWriteLockResult(LogicalLockResult):
 
2360
    """The result of write locking a branch.
 
2361
 
 
2362
    :ivar branch_token: The token obtained from the underlying branch lock, or
 
2363
        None.
 
2364
    :ivar unlock: A callable which will unlock the lock.
 
2365
    """
 
2366
 
 
2367
    def __init__(self, unlock, branch_token):
 
2368
        LogicalLockResult.__init__(self, unlock)
 
2369
        self.branch_token = branch_token
 
2370
 
 
2371
    def __repr__(self):
 
2372
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
 
2373
            self.unlock)
 
2374
 
 
2375
 
2268
2376
class BzrBranch(Branch, _RelockDebugMixin):
2269
2377
    """A branch stored in the actual filesystem.
2270
2378
 
2324
2432
        return self.control_files.is_locked()
2325
2433
 
2326
2434
    def lock_write(self, token=None):
 
2435
        """Lock the branch for write operations.
 
2436
 
 
2437
        :param token: A token to permit reacquiring a previously held and
 
2438
            preserved lock.
 
2439
        :return: A BranchWriteLockResult.
 
2440
        """
2327
2441
        if not self.is_locked():
2328
2442
            self._note_lock('w')
2329
2443
        # All-in-one needs to always unlock/lock.
2335
2449
        else:
2336
2450
            took_lock = False
2337
2451
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
2452
            return BranchWriteLockResult(self.unlock,
 
2453
                self.control_files.lock_write(token=token))
2339
2454
        except:
2340
2455
            if took_lock:
2341
2456
                self.repository.unlock()
2342
2457
            raise
2343
2458
 
2344
2459
    def lock_read(self):
 
2460
        """Lock the branch for read operations.
 
2461
 
 
2462
        :return: A bzrlib.lock.LogicalLockResult.
 
2463
        """
2345
2464
        if not self.is_locked():
2346
2465
            self._note_lock('r')
2347
2466
        # All-in-one needs to always unlock/lock.
2354
2473
            took_lock = False
2355
2474
        try:
2356
2475
            self.control_files.lock_read()
 
2476
            return LogicalLockResult(self.unlock)
2357
2477
        except:
2358
2478
            if took_lock:
2359
2479
                self.repository.unlock()
3145
3265
    _optimisers = []
3146
3266
    """The available optimised InterBranch types."""
3147
3267
 
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)
 
3268
    @classmethod
 
3269
    def _get_branch_formats_to_test(klass):
 
3270
        """Return an iterable of format tuples for testing.
 
3271
        
 
3272
        :return: An iterable of (from_format, to_format) to use when testing
 
3273
            this InterBranch class. Each InterBranch class should define this
 
3274
            method itself.
 
3275
        """
 
3276
        raise NotImplementedError(klass._get_branch_formats_to_test)
3152
3277
 
 
3278
    @needs_write_lock
3153
3279
    def pull(self, overwrite=False, stop_revision=None,
3154
3280
             possible_transports=None, local=False):
3155
3281
        """Mirror source into target branch.
3160
3286
        """
3161
3287
        raise NotImplementedError(self.pull)
3162
3288
 
 
3289
    @needs_write_lock
3163
3290
    def update_revisions(self, stop_revision=None, overwrite=False,
3164
3291
                         graph=None):
3165
3292
        """Pull in new perfect-fit revisions.
3173
3300
        """
3174
3301
        raise NotImplementedError(self.update_revisions)
3175
3302
 
 
3303
    @needs_write_lock
3176
3304
    def push(self, overwrite=False, stop_revision=None,
3177
3305
             _override_hook_source_branch=None):
3178
3306
        """Mirror the source branch into the target branch.
3183
3311
 
3184
3312
 
3185
3313
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
 
 
 
3314
    """InterBranch implementation that uses public Branch functions."""
 
3315
 
 
3316
    @classmethod
 
3317
    def is_compatible(klass, source, target):
 
3318
        # GenericBranch uses the public API, so always compatible
 
3319
        return True
 
3320
 
 
3321
    @classmethod
 
3322
    def _get_branch_formats_to_test(klass):
 
3323
        return [(BranchFormat._default_format, BranchFormat._default_format)]
 
3324
 
 
3325
    @classmethod
 
3326
    def unwrap_format(klass, format):
 
3327
        if isinstance(format, remote.RemoteBranchFormat):
 
3328
            format._ensure_real()
 
3329
            return format._custom_format
 
3330
        return format                                                                                                  
 
3331
 
 
3332
    @needs_write_lock
 
3333
    def copy_content_into(self, revision_id=None):
 
3334
        """Copy the content of source into target
 
3335
 
 
3336
        revision_id: if not None, the revision history in the new branch will
 
3337
                     be truncated to end with revision_id.
 
3338
        """
 
3339
        self.source.update_references(self.target)
 
3340
        self.source._synchronize_history(self.target, revision_id)
 
3341
        try:
 
3342
            parent = self.source.get_parent()
 
3343
        except errors.InaccessibleParent, e:
 
3344
            mutter('parent was not accessible to copy: %s', e)
 
3345
        else:
 
3346
            if parent:
 
3347
                self.target.set_parent(parent)
 
3348
        if self.source._push_should_merge_tags():
 
3349
            self.source.tags.merge_to(self.target.tags)
 
3350
 
 
3351
    @needs_write_lock
3193
3352
    def update_revisions(self, stop_revision=None, overwrite=False,
3194
3353
        graph=None):
3195
3354
        """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
 
 
 
3355
        other_revno, other_last_revision = self.source.last_revision_info()
 
3356
        stop_revno = None # unknown
 
3357
        if stop_revision is None:
 
3358
            stop_revision = other_last_revision
 
3359
            if _mod_revision.is_null(stop_revision):
 
3360
                # if there are no commits, we're done.
 
3361
                return
 
3362
            stop_revno = other_revno
 
3363
 
 
3364
        # what's the current last revision, before we fetch [and change it
 
3365
        # possibly]
 
3366
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3367
        # we fetch here so that we don't process data twice in the common
 
3368
        # case of having something to pull, and so that the check for
 
3369
        # already merged can operate on the just fetched graph, which will
 
3370
        # be cached in memory.
 
3371
        self.target.fetch(self.source, stop_revision)
 
3372
        # Check to see if one is an ancestor of the other
 
3373
        if not overwrite:
 
3374
            if graph is None:
 
3375
                graph = self.target.repository.get_graph()
 
3376
            if self.target._check_if_descendant_or_diverged(
 
3377
                    stop_revision, last_rev, graph, self.source):
 
3378
                # stop_revision is a descendant of last_rev, but we aren't
 
3379
                # overwriting, so we're done.
 
3380
                return
 
3381
        if stop_revno is None:
 
3382
            if graph is None:
 
3383
                graph = self.target.repository.get_graph()
 
3384
            this_revno, this_last_revision = \
 
3385
                    self.target.last_revision_info()
 
3386
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3387
                            [(other_last_revision, other_revno),
 
3388
                             (this_last_revision, this_revno)])
 
3389
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3390
 
 
3391
    @needs_write_lock
3236
3392
    def pull(self, overwrite=False, stop_revision=None,
3237
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3393
             possible_transports=None, run_hooks=True,
3238
3394
             _override_hook_target=None, local=False):
3239
 
        """See Branch.pull.
 
3395
        """Pull from source into self, updating my master if any.
3240
3396
 
3241
 
        :param _hook_master: Private parameter - set the branch to
3242
 
            be supplied as the master to pull hooks.
3243
3397
        :param run_hooks: Private parameter - if false, this branch
3244
3398
            is being called because it's the master of the primary branch,
3245
3399
            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
3400
        """
3250
 
        # This type of branch can't be bound.
3251
 
        if local:
 
3401
        bound_location = self.target.get_bound_location()
 
3402
        if local and not bound_location:
3252
3403
            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()
 
3404
        master_branch = None
 
3405
        if not local and bound_location and self.source.user_url != bound_location:
 
3406
            # not pulling from master, so we need to update master.
 
3407
            master_branch = self.target.get_master_branch(possible_transports)
 
3408
            master_branch.lock_write()
3260
3409
        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)
 
3410
            if master_branch:
 
3411
                # pull from source into master.
 
3412
                master_branch.pull(self.source, overwrite, stop_revision,
 
3413
                    run_hooks=False)
 
3414
            return self._pull(overwrite,
 
3415
                stop_revision, _hook_master=master_branch,
 
3416
                run_hooks=run_hooks,
 
3417
                _override_hook_target=_override_hook_target)
3287
3418
        finally:
3288
 
            self.source.unlock()
3289
 
        return result
 
3419
            if master_branch:
 
3420
                master_branch.unlock()
3290
3421
 
3291
3422
    def push(self, overwrite=False, stop_revision=None,
3292
3423
             _override_hook_source_branch=None):
3354
3485
            _run_hooks()
3355
3486
            return result
3356
3487
 
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,
 
3488
    def _pull(self, overwrite=False, stop_revision=None,
 
3489
             possible_transports=None, _hook_master=None, run_hooks=True,
3371
3490
             _override_hook_target=None, local=False):
3372
 
        """Pull from source into self, updating my master if any.
3373
 
 
 
3491
        """See Branch.pull.
 
3492
 
 
3493
        This function is the core worker, used by GenericInterBranch.pull to
 
3494
        avoid duplication when pulling source->master and source->local.
 
3495
 
 
3496
        :param _hook_master: Private parameter - set the branch to
 
3497
            be supplied as the master to pull hooks.
3374
3498
        :param run_hooks: Private parameter - if false, this branch
3375
3499
            is being called because it's the master of the primary branch,
3376
3500
            so it should not run its hooks.
 
3501
        :param _override_hook_target: Private parameter - set the branch to be
 
3502
            supplied as the target_branch to pull hooks.
 
3503
        :param local: Only update the local branch, and not the bound branch.
3377
3504
        """
3378
 
        bound_location = self.target.get_bound_location()
3379
 
        if local and not bound_location:
 
3505
        # This type of branch can't be bound.
 
3506
        if local:
3380
3507
            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()
 
3508
        result = PullResult()
 
3509
        result.source_branch = self.source
 
3510
        if _override_hook_target is None:
 
3511
            result.target_branch = self.target
 
3512
        else:
 
3513
            result.target_branch = _override_hook_target
 
3514
        self.source.lock_read()
3386
3515
        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)
 
3516
            # We assume that during 'pull' the target repository is closer than
 
3517
            # the source one.
 
3518
            self.source.update_references(self.target)
 
3519
            graph = self.target.repository.get_graph(self.source.repository)
 
3520
            # TODO: Branch formats should have a flag that indicates 
 
3521
            # that revno's are expensive, and pull() should honor that flag.
 
3522
            # -- JRV20090506
 
3523
            result.old_revno, result.old_revid = \
 
3524
                self.target.last_revision_info()
 
3525
            self.target.update_revisions(self.source, stop_revision,
 
3526
                overwrite=overwrite, graph=graph)
 
3527
            # TODO: The old revid should be specified when merging tags, 
 
3528
            # so a tags implementation that versions tags can only 
 
3529
            # pull in the most recent changes. -- JRV20090506
 
3530
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3531
                overwrite)
 
3532
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3533
            if _hook_master:
 
3534
                result.master_branch = _hook_master
 
3535
                result.local_branch = result.target_branch
 
3536
            else:
 
3537
                result.master_branch = result.target_branch
 
3538
                result.local_branch = None
 
3539
            if run_hooks:
 
3540
                for hook in Branch.hooks['post_pull']:
 
3541
                    hook(result)
3395
3542
        finally:
3396
 
            if master_branch:
3397
 
                master_branch.unlock()
 
3543
            self.source.unlock()
 
3544
        return result
3398
3545
 
3399
3546
 
3400
3547
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)