~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:39:38 UTC
  • mto: This revision was merged to the branch mainline in revision 5347.
  • Revision ID: v.ladeuil+lp@free.fr-20100715133938-ig82bitvdfonfu6w
Delete bzrlib.transform.create_by_entry (no deprecation tests).

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):
295
303
    def lock_read(self):
296
304
        """Lock the branch for read operations.
297
305
 
298
 
        :return: An object with an unlock method which will release the lock
299
 
            obtained.
 
306
        :return: A bzrlib.lock.LogicalLockResult.
300
307
        """
301
308
        raise NotImplementedError(self.lock_read)
302
309
 
794
801
            if len(old_repository._fallback_repositories) != 1:
795
802
                raise AssertionError("can't cope with fallback repositories "
796
803
                    "of %r" % (self.repository,))
797
 
            # 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()
798
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.
799
852
            old_repository.lock_read()
800
853
            try:
801
 
                # Repositories don't offer an interface to remove fallback
802
 
                # repositories today; take the conceptually simpler option and just
803
 
                # reopen it.  We reopen it starting from the URL so that we
804
 
                # get a separate connection for RemoteRepositories and can
805
 
                # stream from one of them to the other.  This does mean doing
806
 
                # separate SSH connection setup, but unstacking is not a
807
 
                # common operation so it's tolerable.
808
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
809
 
                new_repository = new_bzrdir.find_repository()
810
 
                self.repository = new_repository
811
 
                if self.repository._fallback_repositories:
812
 
                    raise AssertionError("didn't expect %r to have "
813
 
                        "fallback_repositories"
814
 
                        % (self.repository,))
815
 
                # this is not paired with an unlock because it's just restoring
816
 
                # the previous state; the lock's released when set_stacked_on_url
817
 
                # returns
818
 
                self.repository.lock_write()
819
854
                # XXX: If you unstack a branch while it has a working tree
820
855
                # with a pending merge, the pending-merged revisions will no
821
856
                # longer be present.  You can (probably) revert and remerge.
962
997
                raise errors.NoSuchRevision(self, stop_revision)
963
998
        return other_history[self_len:stop_revision]
964
999
 
965
 
    @needs_write_lock
966
1000
    def update_revisions(self, other, stop_revision=None, overwrite=False,
967
1001
                         graph=None):
968
1002
        """Pull in new perfect-fit revisions.
1017
1051
            self._extend_partial_history(distance_from_last)
1018
1052
        return self._partial_revision_history_cache[distance_from_last]
1019
1053
 
1020
 
    @needs_write_lock
1021
1054
    def pull(self, source, overwrite=False, stop_revision=None,
1022
1055
             possible_transports=None, *args, **kwargs):
1023
1056
        """Mirror source into this branch.
1266
1299
                revno = 1
1267
1300
        destination.set_last_revision_info(revno, revision_id)
1268
1301
 
1269
 
    @needs_read_lock
1270
1302
    def copy_content_into(self, destination, revision_id=None):
1271
1303
        """Copy the content of self into destination.
1272
1304
 
1273
1305
        revision_id: if not None, the revision history in the new branch will
1274
1306
                     be truncated to end with revision_id.
1275
1307
        """
1276
 
        self.update_references(destination)
1277
 
        self._synchronize_history(destination, revision_id)
1278
 
        try:
1279
 
            parent = self.get_parent()
1280
 
        except errors.InaccessibleParent, e:
1281
 
            mutter('parent was not accessible to copy: %s', e)
1282
 
        else:
1283
 
            if parent:
1284
 
                destination.set_parent(parent)
1285
 
        if self._push_should_merge_tags():
1286
 
            self.tags.merge_to(destination.tags)
 
1308
        return InterBranch.get(self, destination).copy_content_into(
 
1309
            revision_id=revision_id)
1287
1310
 
1288
1311
    def update_references(self, target):
1289
1312
        if not getattr(self._format, 'supports_reference_locations', False):
1357
1380
        """
1358
1381
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1359
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
1360
1385
        if revision_id is None:
1361
1386
            revision_id = self.last_revision()
1362
1387
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1521
1546
        try:
1522
1547
            transport = a_bzrdir.get_branch_transport(None, name=name)
1523
1548
            format_string = transport.get_bytes("format")
1524
 
            return klass._formats[format_string]
 
1549
            format = klass._formats[format_string]
 
1550
            if isinstance(format, MetaDirBranchFormatFactory):
 
1551
                return format()
 
1552
            return format
1525
1553
        except errors.NoSuchFile:
1526
1554
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1527
1555
        except KeyError:
1532
1560
        """Return the current default format."""
1533
1561
        return klass._default_format
1534
1562
 
1535
 
    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):
1536
1578
        """Get the target reference of the branch in a_bzrdir.
1537
1579
 
1538
1580
        format probing must have been completed before calling
1540
1582
        in a_bzrdir is correct.
1541
1583
 
1542
1584
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1585
        :param name: Name of the colocated branch to fetch
1543
1586
        :return: None if the branch is not a reference branch.
1544
1587
        """
1545
1588
        return None
1546
1589
 
1547
1590
    @classmethod
1548
 
    def set_reference(self, a_bzrdir, to_branch):
 
1591
    def set_reference(self, a_bzrdir, name, to_branch):
1549
1592
        """Set the target reference of the branch in a_bzrdir.
1550
1593
 
1551
1594
        format probing must have been completed before calling
1553
1596
        in a_bzrdir is correct.
1554
1597
 
1555
1598
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1599
        :param name: Name of colocated branch to set, None for default
1556
1600
        :param to_branch: branch that the checkout is to reference
1557
1601
        """
1558
1602
        raise NotImplementedError(self.set_reference)
1672
1716
 
1673
1717
    @classmethod
1674
1718
    def register_format(klass, format):
1675
 
        """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
        """
1676
1724
        klass._formats[format.get_format_string()] = format
1677
1725
        # Metadir formats have a network name of their format string, and get
1678
 
        # registered as class factories.
1679
 
        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__)
1680
1732
 
1681
1733
    @classmethod
1682
1734
    def set_default_format(klass, format):
1702
1754
        return False  # by default
1703
1755
 
1704
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
 
1705
1785
class BranchHooks(Hooks):
1706
1786
    """A dictionary mapping hook name to a list of callables for branch hooks.
1707
1787
 
2168
2248
        """See BranchFormat.get_format_description()."""
2169
2249
        return "Checkout reference format 1"
2170
2250
 
2171
 
    def get_reference(self, a_bzrdir):
 
2251
    def get_reference(self, a_bzrdir, name=None):
2172
2252
        """See BranchFormat.get_reference()."""
2173
 
        transport = a_bzrdir.get_branch_transport(None)
 
2253
        transport = a_bzrdir.get_branch_transport(None, name=name)
2174
2254
        return transport.get_bytes('location')
2175
2255
 
2176
 
    def set_reference(self, a_bzrdir, to_branch):
 
2256
    def set_reference(self, a_bzrdir, name, to_branch):
2177
2257
        """See BranchFormat.set_reference()."""
2178
 
        transport = a_bzrdir.get_branch_transport(None)
 
2258
        transport = a_bzrdir.get_branch_transport(None, name=name)
2179
2259
        location = transport.put_bytes('location', to_branch.base)
2180
2260
 
2181
2261
    def initialize(self, a_bzrdir, name=None, target_branch=None):
2232
2312
                raise AssertionError("wrong format %r found for %r" %
2233
2313
                    (format, self))
2234
2314
        if location is None:
2235
 
            location = self.get_reference(a_bzrdir)
 
2315
            location = self.get_reference(a_bzrdir, name)
2236
2316
        real_bzrdir = bzrdir.BzrDir.open(
2237
2317
            location, possible_transports=possible_transports)
2238
2318
        result = real_bzrdir.open_branch(name=name, 
2276
2356
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2277
2357
 
2278
2358
 
2279
 
class BranchWriteLockResult(object):
 
2359
class BranchWriteLockResult(LogicalLockResult):
2280
2360
    """The result of write locking a branch.
2281
2361
 
2282
2362
    :ivar branch_token: The token obtained from the underlying branch lock, or
2285
2365
    """
2286
2366
 
2287
2367
    def __init__(self, unlock, branch_token):
 
2368
        LogicalLockResult.__init__(self, unlock)
2288
2369
        self.branch_token = branch_token
2289
 
        self.unlock = unlock
2290
2370
 
2291
 
    def __str__(self):
 
2371
    def __repr__(self):
2292
2372
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2293
2373
            self.unlock)
2294
2374
 
2379
2459
    def lock_read(self):
2380
2460
        """Lock the branch for read operations.
2381
2461
 
2382
 
        :return: An object with an unlock method which will release the lock
2383
 
            obtained.
 
2462
        :return: A bzrlib.lock.LogicalLockResult.
2384
2463
        """
2385
2464
        if not self.is_locked():
2386
2465
            self._note_lock('r')
2394
2473
            took_lock = False
2395
2474
        try:
2396
2475
            self.control_files.lock_read()
2397
 
            return self
 
2476
            return LogicalLockResult(self.unlock)
2398
2477
        except:
2399
2478
            if took_lock:
2400
2479
                self.repository.unlock()
3186
3265
    _optimisers = []
3187
3266
    """The available optimised InterBranch types."""
3188
3267
 
3189
 
    @staticmethod
3190
 
    def _get_branch_formats_to_test():
3191
 
        """Return a tuple with the Branch formats to use when testing."""
3192
 
        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)
3193
3277
 
 
3278
    @needs_write_lock
3194
3279
    def pull(self, overwrite=False, stop_revision=None,
3195
3280
             possible_transports=None, local=False):
3196
3281
        """Mirror source into target branch.
3201
3286
        """
3202
3287
        raise NotImplementedError(self.pull)
3203
3288
 
 
3289
    @needs_write_lock
3204
3290
    def update_revisions(self, stop_revision=None, overwrite=False,
3205
3291
                         graph=None):
3206
3292
        """Pull in new perfect-fit revisions.
3214
3300
        """
3215
3301
        raise NotImplementedError(self.update_revisions)
3216
3302
 
 
3303
    @needs_write_lock
3217
3304
    def push(self, overwrite=False, stop_revision=None,
3218
3305
             _override_hook_source_branch=None):
3219
3306
        """Mirror the source branch into the target branch.
3224
3311
 
3225
3312
 
3226
3313
class GenericInterBranch(InterBranch):
3227
 
    """InterBranch implementation that uses public Branch functions.
3228
 
    """
3229
 
 
3230
 
    @staticmethod
3231
 
    def _get_branch_formats_to_test():
3232
 
        return BranchFormat._default_format, BranchFormat._default_format
3233
 
 
 
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
3234
3352
    def update_revisions(self, stop_revision=None, overwrite=False,
3235
3353
        graph=None):
3236
3354
        """See InterBranch.update_revisions()."""
3237
 
        self.source.lock_read()
3238
 
        try:
3239
 
            other_revno, other_last_revision = self.source.last_revision_info()
3240
 
            stop_revno = None # unknown
3241
 
            if stop_revision is None:
3242
 
                stop_revision = other_last_revision
3243
 
                if _mod_revision.is_null(stop_revision):
3244
 
                    # if there are no commits, we're done.
3245
 
                    return
3246
 
                stop_revno = other_revno
3247
 
 
3248
 
            # what's the current last revision, before we fetch [and change it
3249
 
            # possibly]
3250
 
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
3251
 
            # we fetch here so that we don't process data twice in the common
3252
 
            # case of having something to pull, and so that the check for
3253
 
            # already merged can operate on the just fetched graph, which will
3254
 
            # be cached in memory.
3255
 
            self.target.fetch(self.source, stop_revision)
3256
 
            # Check to see if one is an ancestor of the other
3257
 
            if not overwrite:
3258
 
                if graph is None:
3259
 
                    graph = self.target.repository.get_graph()
3260
 
                if self.target._check_if_descendant_or_diverged(
3261
 
                        stop_revision, last_rev, graph, self.source):
3262
 
                    # stop_revision is a descendant of last_rev, but we aren't
3263
 
                    # overwriting, so we're done.
3264
 
                    return
3265
 
            if stop_revno is None:
3266
 
                if graph is None:
3267
 
                    graph = self.target.repository.get_graph()
3268
 
                this_revno, this_last_revision = \
3269
 
                        self.target.last_revision_info()
3270
 
                stop_revno = graph.find_distance_to_null(stop_revision,
3271
 
                                [(other_last_revision, other_revno),
3272
 
                                 (this_last_revision, this_revno)])
3273
 
            self.target.set_last_revision_info(stop_revno, stop_revision)
3274
 
        finally:
3275
 
            self.source.unlock()
3276
 
 
 
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
3277
3392
    def pull(self, overwrite=False, stop_revision=None,
3278
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3393
             possible_transports=None, run_hooks=True,
3279
3394
             _override_hook_target=None, local=False):
3280
 
        """See Branch.pull.
 
3395
        """Pull from source into self, updating my master if any.
3281
3396
 
3282
 
        :param _hook_master: Private parameter - set the branch to
3283
 
            be supplied as the master to pull hooks.
3284
3397
        :param run_hooks: Private parameter - if false, this branch
3285
3398
            is being called because it's the master of the primary branch,
3286
3399
            so it should not run its hooks.
3287
 
        :param _override_hook_target: Private parameter - set the branch to be
3288
 
            supplied as the target_branch to pull hooks.
3289
 
        :param local: Only update the local branch, and not the bound branch.
3290
3400
        """
3291
 
        # This type of branch can't be bound.
3292
 
        if local:
 
3401
        bound_location = self.target.get_bound_location()
 
3402
        if local and not bound_location:
3293
3403
            raise errors.LocalRequiresBoundBranch()
3294
 
        result = PullResult()
3295
 
        result.source_branch = self.source
3296
 
        if _override_hook_target is None:
3297
 
            result.target_branch = self.target
3298
 
        else:
3299
 
            result.target_branch = _override_hook_target
3300
 
        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()
3301
3409
        try:
3302
 
            # We assume that during 'pull' the target repository is closer than
3303
 
            # the source one.
3304
 
            self.source.update_references(self.target)
3305
 
            graph = self.target.repository.get_graph(self.source.repository)
3306
 
            # TODO: Branch formats should have a flag that indicates 
3307
 
            # that revno's are expensive, and pull() should honor that flag.
3308
 
            # -- JRV20090506
3309
 
            result.old_revno, result.old_revid = \
3310
 
                self.target.last_revision_info()
3311
 
            self.target.update_revisions(self.source, stop_revision,
3312
 
                overwrite=overwrite, graph=graph)
3313
 
            # TODO: The old revid should be specified when merging tags, 
3314
 
            # so a tags implementation that versions tags can only 
3315
 
            # pull in the most recent changes. -- JRV20090506
3316
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3317
 
                overwrite)
3318
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3319
 
            if _hook_master:
3320
 
                result.master_branch = _hook_master
3321
 
                result.local_branch = result.target_branch
3322
 
            else:
3323
 
                result.master_branch = result.target_branch
3324
 
                result.local_branch = None
3325
 
            if run_hooks:
3326
 
                for hook in Branch.hooks['post_pull']:
3327
 
                    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)
3328
3418
        finally:
3329
 
            self.source.unlock()
3330
 
        return result
 
3419
            if master_branch:
 
3420
                master_branch.unlock()
3331
3421
 
3332
3422
    def push(self, overwrite=False, stop_revision=None,
3333
3423
             _override_hook_source_branch=None):
3395
3485
            _run_hooks()
3396
3486
            return result
3397
3487
 
3398
 
    @classmethod
3399
 
    def is_compatible(self, source, target):
3400
 
        # GenericBranch uses the public API, so always compatible
3401
 
        return True
3402
 
 
3403
 
 
3404
 
class InterToBranch5(GenericInterBranch):
3405
 
 
3406
 
    @staticmethod
3407
 
    def _get_branch_formats_to_test():
3408
 
        return BranchFormat._default_format, BzrBranchFormat5()
3409
 
 
3410
 
    def pull(self, overwrite=False, stop_revision=None,
3411
 
             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,
3412
3490
             _override_hook_target=None, local=False):
3413
 
        """Pull from source into self, updating my master if any.
3414
 
 
 
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.
3415
3498
        :param run_hooks: Private parameter - if false, this branch
3416
3499
            is being called because it's the master of the primary branch,
3417
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.
3418
3504
        """
3419
 
        bound_location = self.target.get_bound_location()
3420
 
        if local and not bound_location:
 
3505
        # This type of branch can't be bound.
 
3506
        if local:
3421
3507
            raise errors.LocalRequiresBoundBranch()
3422
 
        master_branch = None
3423
 
        if not local and bound_location and self.source.user_url != bound_location:
3424
 
            # not pulling from master, so we need to update master.
3425
 
            master_branch = self.target.get_master_branch(possible_transports)
3426
 
            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()
3427
3515
        try:
3428
 
            if master_branch:
3429
 
                # pull from source into master.
3430
 
                master_branch.pull(self.source, overwrite, stop_revision,
3431
 
                    run_hooks=False)
3432
 
            return super(InterToBranch5, self).pull(overwrite,
3433
 
                stop_revision, _hook_master=master_branch,
3434
 
                run_hooks=run_hooks,
3435
 
                _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)
3436
3542
        finally:
3437
 
            if master_branch:
3438
 
                master_branch.unlock()
 
3543
            self.source.unlock()
 
3544
        return result
3439
3545
 
3440
3546
 
3441
3547
InterBranch.register_optimiser(GenericInterBranch)
3442
 
InterBranch.register_optimiser(InterToBranch5)