← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

Merge prerequisite branch and tweak test to be more compact and faster.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
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):
951
969
                raise errors.NoSuchRevision(self, stop_revision)
952
970
        return other_history[self_len:stop_revision]
953
971
 
954
 
    @needs_write_lock
955
972
    def update_revisions(self, other, stop_revision=None, overwrite=False,
956
973
                         graph=None):
957
974
        """Pull in new perfect-fit revisions.
1006
1023
            self._extend_partial_history(distance_from_last)
1007
1024
        return self._partial_revision_history_cache[distance_from_last]
1008
1025
 
1009
 
    @needs_write_lock
1010
1026
    def pull(self, source, overwrite=False, stop_revision=None,
1011
1027
             possible_transports=None, *args, **kwargs):
1012
1028
        """Mirror source into this branch.
1255
1271
                revno = 1
1256
1272
        destination.set_last_revision_info(revno, revision_id)
1257
1273
 
1258
 
    @needs_read_lock
1259
1274
    def copy_content_into(self, destination, revision_id=None):
1260
1275
        """Copy the content of self into destination.
1261
1276
 
1262
1277
        revision_id: if not None, the revision history in the new branch will
1263
1278
                     be truncated to end with revision_id.
1264
1279
        """
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)
 
1280
        return InterBranch.get(self, destination).copy_content_into(
 
1281
            revision_id=revision_id)
1276
1282
 
1277
1283
    def update_references(self, target):
1278
1284
        if not getattr(self._format, 'supports_reference_locations', False):
1346
1352
        """
1347
1353
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1354
        # clone call. Or something. 20090224 RBC/spiv.
 
1355
        # XXX: Should this perhaps clone colocated branches as well, 
 
1356
        # rather than just the default branch? 20100319 JRV
1349
1357
        if revision_id is None:
1350
1358
            revision_id = self.last_revision()
1351
1359
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1510
1518
        try:
1511
1519
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
1520
            format_string = transport.get_bytes("format")
1513
 
            return klass._formats[format_string]
 
1521
            format = klass._formats[format_string]
 
1522
            if isinstance(format, MetaDirBranchFormatFactory):
 
1523
                return format()
 
1524
            return format
1514
1525
        except errors.NoSuchFile:
1515
1526
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1516
1527
        except KeyError:
1521
1532
        """Return the current default format."""
1522
1533
        return klass._default_format
1523
1534
 
1524
 
    def get_reference(self, a_bzrdir):
 
1535
    @classmethod
 
1536
    def get_formats(klass):
 
1537
        """Get all the known formats.
 
1538
 
 
1539
        Warning: This triggers a load of all lazy registered formats: do not
 
1540
        use except when that is desireed.
 
1541
        """
 
1542
        result = []
 
1543
        for fmt in klass._formats.values():
 
1544
            if isinstance(fmt, MetaDirBranchFormatFactory):
 
1545
                fmt = fmt()
 
1546
            result.append(fmt)
 
1547
        return result
 
1548
 
 
1549
    def get_reference(self, a_bzrdir, name=None):
1525
1550
        """Get the target reference of the branch in a_bzrdir.
1526
1551
 
1527
1552
        format probing must have been completed before calling
1529
1554
        in a_bzrdir is correct.
1530
1555
 
1531
1556
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1557
        :param name: Name of the colocated branch to fetch
1532
1558
        :return: None if the branch is not a reference branch.
1533
1559
        """
1534
1560
        return None
1535
1561
 
1536
1562
    @classmethod
1537
 
    def set_reference(self, a_bzrdir, to_branch):
 
1563
    def set_reference(self, a_bzrdir, name, to_branch):
1538
1564
        """Set the target reference of the branch in a_bzrdir.
1539
1565
 
1540
1566
        format probing must have been completed before calling
1542
1568
        in a_bzrdir is correct.
1543
1569
 
1544
1570
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1571
        :param name: Name of colocated branch to set, None for default
1545
1572
        :param to_branch: branch that the checkout is to reference
1546
1573
        """
1547
1574
        raise NotImplementedError(self.set_reference)
1661
1688
 
1662
1689
    @classmethod
1663
1690
    def register_format(klass, format):
1664
 
        """Register a metadir format."""
 
1691
        """Register a metadir format.
 
1692
        
 
1693
        See MetaDirBranchFormatFactory for the ability to register a format
 
1694
        without loading the code the format needs until it is actually used.
 
1695
        """
1665
1696
        klass._formats[format.get_format_string()] = format
1666
1697
        # 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__)
 
1698
        # registered as factories.
 
1699
        if isinstance(format, MetaDirBranchFormatFactory):
 
1700
            network_format_registry.register(format.get_format_string(), format)
 
1701
        else:
 
1702
            network_format_registry.register(format.get_format_string(),
 
1703
                format.__class__)
1669
1704
 
1670
1705
    @classmethod
1671
1706
    def set_default_format(klass, format):
1691
1726
        return False  # by default
1692
1727
 
1693
1728
 
 
1729
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1730
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1731
    
 
1732
    While none of the built in BranchFormats are lazy registered yet,
 
1733
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1734
    use it, and the bzr-loom plugin uses it as well (see
 
1735
    bzrlib.plugins.loom.formats).
 
1736
    """
 
1737
 
 
1738
    def __init__(self, format_string, module_name, member_name):
 
1739
        """Create a MetaDirBranchFormatFactory.
 
1740
 
 
1741
        :param format_string: The format string the format has.
 
1742
        :param module_name: Module to load the format class from.
 
1743
        :param member_name: Attribute name within the module for the format class.
 
1744
        """
 
1745
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1746
        self._format_string = format_string
 
1747
        
 
1748
    def get_format_string(self):
 
1749
        """See BranchFormat.get_format_string."""
 
1750
        return self._format_string
 
1751
 
 
1752
    def __call__(self):
 
1753
        """Used for network_format_registry support."""
 
1754
        return self.get_obj()()
 
1755
 
 
1756
 
1694
1757
class BranchHooks(Hooks):
1695
1758
    """A dictionary mapping hook name to a list of callables for branch hooks.
1696
1759
 
2157
2220
        """See BranchFormat.get_format_description()."""
2158
2221
        return "Checkout reference format 1"
2159
2222
 
2160
 
    def get_reference(self, a_bzrdir):
 
2223
    def get_reference(self, a_bzrdir, name=None):
2161
2224
        """See BranchFormat.get_reference()."""
2162
 
        transport = a_bzrdir.get_branch_transport(None)
 
2225
        transport = a_bzrdir.get_branch_transport(None, name=name)
2163
2226
        return transport.get_bytes('location')
2164
2227
 
2165
 
    def set_reference(self, a_bzrdir, to_branch):
 
2228
    def set_reference(self, a_bzrdir, name, to_branch):
2166
2229
        """See BranchFormat.set_reference()."""
2167
 
        transport = a_bzrdir.get_branch_transport(None)
 
2230
        transport = a_bzrdir.get_branch_transport(None, name=name)
2168
2231
        location = transport.put_bytes('location', to_branch.base)
2169
2232
 
2170
2233
    def initialize(self, a_bzrdir, name=None, target_branch=None):
2221
2284
                raise AssertionError("wrong format %r found for %r" %
2222
2285
                    (format, self))
2223
2286
        if location is None:
2224
 
            location = self.get_reference(a_bzrdir)
 
2287
            location = self.get_reference(a_bzrdir, name)
2225
2288
        real_bzrdir = bzrdir.BzrDir.open(
2226
2289
            location, possible_transports=possible_transports)
2227
2290
        result = real_bzrdir.open_branch(name=name, 
2265
2328
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2266
2329
 
2267
2330
 
 
2331
class BranchWriteLockResult(LogicalLockResult):
 
2332
    """The result of write locking a branch.
 
2333
 
 
2334
    :ivar branch_token: The token obtained from the underlying branch lock, or
 
2335
        None.
 
2336
    :ivar unlock: A callable which will unlock the lock.
 
2337
    """
 
2338
 
 
2339
    def __init__(self, unlock, branch_token):
 
2340
        LogicalLockResult.__init__(self, unlock)
 
2341
        self.branch_token = branch_token
 
2342
 
 
2343
    def __repr__(self):
 
2344
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
 
2345
            self.unlock)
 
2346
 
 
2347
 
2268
2348
class BzrBranch(Branch, _RelockDebugMixin):
2269
2349
    """A branch stored in the actual filesystem.
2270
2350
 
2324
2404
        return self.control_files.is_locked()
2325
2405
 
2326
2406
    def lock_write(self, token=None):
 
2407
        """Lock the branch for write operations.
 
2408
 
 
2409
        :param token: A token to permit reacquiring a previously held and
 
2410
            preserved lock.
 
2411
        :return: A BranchWriteLockResult.
 
2412
        """
2327
2413
        if not self.is_locked():
2328
2414
            self._note_lock('w')
2329
2415
        # All-in-one needs to always unlock/lock.
2335
2421
        else:
2336
2422
            took_lock = False
2337
2423
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
2424
            return BranchWriteLockResult(self.unlock,
 
2425
                self.control_files.lock_write(token=token))
2339
2426
        except:
2340
2427
            if took_lock:
2341
2428
                self.repository.unlock()
2342
2429
            raise
2343
2430
 
2344
2431
    def lock_read(self):
 
2432
        """Lock the branch for read operations.
 
2433
 
 
2434
        :return: A bzrlib.lock.LogicalLockResult.
 
2435
        """
2345
2436
        if not self.is_locked():
2346
2437
            self._note_lock('r')
2347
2438
        # All-in-one needs to always unlock/lock.
2354
2445
            took_lock = False
2355
2446
        try:
2356
2447
            self.control_files.lock_read()
 
2448
            return LogicalLockResult(self.unlock)
2357
2449
        except:
2358
2450
            if took_lock:
2359
2451
                self.repository.unlock()
3145
3237
    _optimisers = []
3146
3238
    """The available optimised InterBranch types."""
3147
3239
 
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)
 
3240
    @classmethod
 
3241
    def _get_branch_formats_to_test(klass):
 
3242
        """Return an iterable of format tuples for testing.
 
3243
        
 
3244
        :return: An iterable of (from_format, to_format) to use when testing
 
3245
            this InterBranch class. Each InterBranch class should define this
 
3246
            method itself.
 
3247
        """
 
3248
        raise NotImplementedError(klass._get_branch_formats_to_test)
3152
3249
 
 
3250
    @needs_write_lock
3153
3251
    def pull(self, overwrite=False, stop_revision=None,
3154
3252
             possible_transports=None, local=False):
3155
3253
        """Mirror source into target branch.
3160
3258
        """
3161
3259
        raise NotImplementedError(self.pull)
3162
3260
 
 
3261
    @needs_write_lock
3163
3262
    def update_revisions(self, stop_revision=None, overwrite=False,
3164
3263
                         graph=None):
3165
3264
        """Pull in new perfect-fit revisions.
3173
3272
        """
3174
3273
        raise NotImplementedError(self.update_revisions)
3175
3274
 
 
3275
    @needs_write_lock
3176
3276
    def push(self, overwrite=False, stop_revision=None,
3177
3277
             _override_hook_source_branch=None):
3178
3278
        """Mirror the source branch into the target branch.
3183
3283
 
3184
3284
 
3185
3285
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
 
 
 
3286
    """InterBranch implementation that uses public Branch functions."""
 
3287
 
 
3288
    @classmethod
 
3289
    def is_compatible(klass, source, target):
 
3290
        # GenericBranch uses the public API, so always compatible
 
3291
        return True
 
3292
 
 
3293
    @classmethod
 
3294
    def _get_branch_formats_to_test(klass):
 
3295
        return [(BranchFormat._default_format, BranchFormat._default_format)]
 
3296
 
 
3297
    @classmethod
 
3298
    def unwrap_format(klass, format):
 
3299
        if isinstance(format, remote.RemoteBranchFormat):
 
3300
            format._ensure_real()
 
3301
            return format._custom_format
 
3302
        return format                                                                                                  
 
3303
 
 
3304
    @needs_write_lock
 
3305
    def copy_content_into(self, revision_id=None):
 
3306
        """Copy the content of source into target
 
3307
 
 
3308
        revision_id: if not None, the revision history in the new branch will
 
3309
                     be truncated to end with revision_id.
 
3310
        """
 
3311
        self.source.update_references(self.target)
 
3312
        self.source._synchronize_history(self.target, revision_id)
 
3313
        try:
 
3314
            parent = self.source.get_parent()
 
3315
        except errors.InaccessibleParent, e:
 
3316
            mutter('parent was not accessible to copy: %s', e)
 
3317
        else:
 
3318
            if parent:
 
3319
                self.target.set_parent(parent)
 
3320
        if self.source._push_should_merge_tags():
 
3321
            self.source.tags.merge_to(self.target.tags)
 
3322
 
 
3323
    @needs_write_lock
3193
3324
    def update_revisions(self, stop_revision=None, overwrite=False,
3194
3325
        graph=None):
3195
3326
        """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
 
 
 
3327
        other_revno, other_last_revision = self.source.last_revision_info()
 
3328
        stop_revno = None # unknown
 
3329
        if stop_revision is None:
 
3330
            stop_revision = other_last_revision
 
3331
            if _mod_revision.is_null(stop_revision):
 
3332
                # if there are no commits, we're done.
 
3333
                return
 
3334
            stop_revno = other_revno
 
3335
 
 
3336
        # what's the current last revision, before we fetch [and change it
 
3337
        # possibly]
 
3338
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3339
        # we fetch here so that we don't process data twice in the common
 
3340
        # case of having something to pull, and so that the check for
 
3341
        # already merged can operate on the just fetched graph, which will
 
3342
        # be cached in memory.
 
3343
        self.target.fetch(self.source, stop_revision)
 
3344
        # Check to see if one is an ancestor of the other
 
3345
        if not overwrite:
 
3346
            if graph is None:
 
3347
                graph = self.target.repository.get_graph()
 
3348
            if self.target._check_if_descendant_or_diverged(
 
3349
                    stop_revision, last_rev, graph, self.source):
 
3350
                # stop_revision is a descendant of last_rev, but we aren't
 
3351
                # overwriting, so we're done.
 
3352
                return
 
3353
        if stop_revno is None:
 
3354
            if graph is None:
 
3355
                graph = self.target.repository.get_graph()
 
3356
            this_revno, this_last_revision = \
 
3357
                    self.target.last_revision_info()
 
3358
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3359
                            [(other_last_revision, other_revno),
 
3360
                             (this_last_revision, this_revno)])
 
3361
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3362
 
 
3363
    @needs_write_lock
3236
3364
    def pull(self, overwrite=False, stop_revision=None,
3237
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3365
             possible_transports=None, run_hooks=True,
3238
3366
             _override_hook_target=None, local=False):
3239
 
        """See Branch.pull.
 
3367
        """Pull from source into self, updating my master if any.
3240
3368
 
3241
 
        :param _hook_master: Private parameter - set the branch to
3242
 
            be supplied as the master to pull hooks.
3243
3369
        :param run_hooks: Private parameter - if false, this branch
3244
3370
            is being called because it's the master of the primary branch,
3245
3371
            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
3372
        """
3250
 
        # This type of branch can't be bound.
3251
 
        if local:
 
3373
        bound_location = self.target.get_bound_location()
 
3374
        if local and not bound_location:
3252
3375
            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()
 
3376
        master_branch = None
 
3377
        if not local and bound_location and self.source.user_url != bound_location:
 
3378
            # not pulling from master, so we need to update master.
 
3379
            master_branch = self.target.get_master_branch(possible_transports)
 
3380
            master_branch.lock_write()
3260
3381
        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)
 
3382
            if master_branch:
 
3383
                # pull from source into master.
 
3384
                master_branch.pull(self.source, overwrite, stop_revision,
 
3385
                    run_hooks=False)
 
3386
            return self._pull(overwrite,
 
3387
                stop_revision, _hook_master=master_branch,
 
3388
                run_hooks=run_hooks,
 
3389
                _override_hook_target=_override_hook_target)
3287
3390
        finally:
3288
 
            self.source.unlock()
3289
 
        return result
 
3391
            if master_branch:
 
3392
                master_branch.unlock()
3290
3393
 
3291
3394
    def push(self, overwrite=False, stop_revision=None,
3292
3395
             _override_hook_source_branch=None):
3354
3457
            _run_hooks()
3355
3458
            return result
3356
3459
 
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,
 
3460
    def _pull(self, overwrite=False, stop_revision=None,
 
3461
             possible_transports=None, _hook_master=None, run_hooks=True,
3371
3462
             _override_hook_target=None, local=False):
3372
 
        """Pull from source into self, updating my master if any.
3373
 
 
 
3463
        """See Branch.pull.
 
3464
 
 
3465
        This function is the core worker, used by GenericInterBranch.pull to
 
3466
        avoid duplication when pulling source->master and source->local.
 
3467
 
 
3468
        :param _hook_master: Private parameter - set the branch to
 
3469
            be supplied as the master to pull hooks.
3374
3470
        :param run_hooks: Private parameter - if false, this branch
3375
3471
            is being called because it's the master of the primary branch,
3376
3472
            so it should not run its hooks.
 
3473
        :param _override_hook_target: Private parameter - set the branch to be
 
3474
            supplied as the target_branch to pull hooks.
 
3475
        :param local: Only update the local branch, and not the bound branch.
3377
3476
        """
3378
 
        bound_location = self.target.get_bound_location()
3379
 
        if local and not bound_location:
 
3477
        # This type of branch can't be bound.
 
3478
        if local:
3380
3479
            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()
 
3480
        result = PullResult()
 
3481
        result.source_branch = self.source
 
3482
        if _override_hook_target is None:
 
3483
            result.target_branch = self.target
 
3484
        else:
 
3485
            result.target_branch = _override_hook_target
 
3486
        self.source.lock_read()
3386
3487
        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)
 
3488
            # We assume that during 'pull' the target repository is closer than
 
3489
            # the source one.
 
3490
            self.source.update_references(self.target)
 
3491
            graph = self.target.repository.get_graph(self.source.repository)
 
3492
            # TODO: Branch formats should have a flag that indicates 
 
3493
            # that revno's are expensive, and pull() should honor that flag.
 
3494
            # -- JRV20090506
 
3495
            result.old_revno, result.old_revid = \
 
3496
                self.target.last_revision_info()
 
3497
            self.target.update_revisions(self.source, stop_revision,
 
3498
                overwrite=overwrite, graph=graph)
 
3499
            # TODO: The old revid should be specified when merging tags, 
 
3500
            # so a tags implementation that versions tags can only 
 
3501
            # pull in the most recent changes. -- JRV20090506
 
3502
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3503
                overwrite)
 
3504
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3505
            if _hook_master:
 
3506
                result.master_branch = _hook_master
 
3507
                result.local_branch = result.target_branch
 
3508
            else:
 
3509
                result.master_branch = result.target_branch
 
3510
                result.local_branch = None
 
3511
            if run_hooks:
 
3512
                for hook in Branch.hooks['post_pull']:
 
3513
                    hook(result)
3395
3514
        finally:
3396
 
            if master_branch:
3397
 
                master_branch.unlock()
 
3515
            self.source.unlock()
 
3516
        return result
3398
3517
 
3399
3518
 
3400
3519
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)