~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Andrew Bennetts
  • Date: 2010-09-17 04:35:23 UTC
  • mfrom: (5050.17.20 2.2)
  • mto: This revision was merged to the branch mainline in revision 5431.
  • Revision ID: andrew.bennetts@canonical.com-20100917043523-c5t63gmvxqxmqh5j
Merge lp:bzr/2.2, including fixes for #625574, #636930, #254278.

Show diffs side-by-side

added added

removed removed

Lines of Context:
25
25
        bzrdir,
26
26
        cache_utf8,
27
27
        config as _mod_config,
 
28
        controldir,
28
29
        debug,
29
30
        errors,
30
31
        lockdir,
31
32
        lockable_files,
 
33
        remote,
32
34
        repository,
33
35
        revision as _mod_revision,
34
36
        rio,
49
51
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
52
from bzrlib.hooks import HookPoint, Hooks
51
53
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
 
54
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
55
from bzrlib import registry
54
56
from bzrlib.symbol_versioning import (
55
57
    deprecated_in,
63
65
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
66
 
65
67
 
66
 
class Branch(bzrdir.ControlComponent):
 
68
class Branch(controldir.ControlComponent):
67
69
    """Branch holding a history of revisions.
68
70
 
69
71
    :ivar base:
197
199
        return self.supports_tags() and self.tags.get_tag_dict()
198
200
 
199
201
    def get_config(self):
 
202
        """Get a bzrlib.config.BranchConfig for this Branch.
 
203
 
 
204
        This can then be used to get and set configuration options for the
 
205
        branch.
 
206
 
 
207
        :return: A bzrlib.config.BranchConfig.
 
208
        """
200
209
        return BranchConfig(self)
201
210
 
202
211
    def _get_config(self):
238
247
        if not local and not config.has_explicit_nickname():
239
248
            try:
240
249
                master = self.get_master_branch(possible_transports)
 
250
                if master and self.user_url == master.user_url:
 
251
                    raise errors.RecursiveBind(self.user_url)
241
252
                if master is not None:
242
253
                    # return the master branch value
243
254
                    return master.nick
 
255
            except errors.RecursiveBind, e:
 
256
                raise e
244
257
            except errors.BzrError, e:
245
258
                # Silently fall back to local implicit nick if the master is
246
259
                # unavailable
283
296
        new_history.reverse()
284
297
        return new_history
285
298
 
286
 
    def lock_write(self):
 
299
    def lock_write(self, token=None):
 
300
        """Lock the branch for write operations.
 
301
 
 
302
        :param token: A token to permit reacquiring a previously held and
 
303
            preserved lock.
 
304
        :return: A BranchWriteLockResult.
 
305
        """
287
306
        raise NotImplementedError(self.lock_write)
288
307
 
289
308
    def lock_read(self):
 
309
        """Lock the branch for read operations.
 
310
 
 
311
        :return: A bzrlib.lock.LogicalLockResult.
 
312
        """
290
313
        raise NotImplementedError(self.lock_read)
291
314
 
292
315
    def unlock(self):
783
806
            if len(old_repository._fallback_repositories) != 1:
784
807
                raise AssertionError("can't cope with fallback repositories "
785
808
                    "of %r" % (self.repository,))
786
 
            # unlock it, including unlocking the fallback
 
809
            # Open the new repository object.
 
810
            # Repositories don't offer an interface to remove fallback
 
811
            # repositories today; take the conceptually simpler option and just
 
812
            # reopen it.  We reopen it starting from the URL so that we
 
813
            # get a separate connection for RemoteRepositories and can
 
814
            # stream from one of them to the other.  This does mean doing
 
815
            # separate SSH connection setup, but unstacking is not a
 
816
            # common operation so it's tolerable.
 
817
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
818
            new_repository = new_bzrdir.find_repository()
 
819
            if new_repository._fallback_repositories:
 
820
                raise AssertionError("didn't expect %r to have "
 
821
                    "fallback_repositories"
 
822
                    % (self.repository,))
 
823
            # Replace self.repository with the new repository.
 
824
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
825
            # lock count) of self.repository to the new repository.
 
826
            lock_token = old_repository.lock_write().repository_token
 
827
            self.repository = new_repository
 
828
            if isinstance(self, remote.RemoteBranch):
 
829
                # Remote branches can have a second reference to the old
 
830
                # repository that need to be replaced.
 
831
                if self._real_branch is not None:
 
832
                    self._real_branch.repository = new_repository
 
833
            self.repository.lock_write(token=lock_token)
 
834
            if lock_token is not None:
 
835
                old_repository.leave_lock_in_place()
787
836
            old_repository.unlock()
 
837
            if lock_token is not None:
 
838
                # XXX: self.repository.leave_lock_in_place() before this
 
839
                # function will not be preserved.  Fortunately that doesn't
 
840
                # affect the current default format (2a), and would be a
 
841
                # corner-case anyway.
 
842
                #  - Andrew Bennetts, 2010/06/30
 
843
                self.repository.dont_leave_lock_in_place()
 
844
            old_lock_count = 0
 
845
            while True:
 
846
                try:
 
847
                    old_repository.unlock()
 
848
                except errors.LockNotHeld:
 
849
                    break
 
850
                old_lock_count += 1
 
851
            if old_lock_count == 0:
 
852
                raise AssertionError(
 
853
                    'old_repository should have been locked at least once.')
 
854
            for i in range(old_lock_count-1):
 
855
                self.repository.lock_write()
 
856
            # Fetch from the old repository into the new.
788
857
            old_repository.lock_read()
789
858
            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
859
                # XXX: If you unstack a branch while it has a working tree
809
860
                # with a pending merge, the pending-merged revisions will no
810
861
                # longer be present.  You can (probably) revert and remerge.
951
1002
                raise errors.NoSuchRevision(self, stop_revision)
952
1003
        return other_history[self_len:stop_revision]
953
1004
 
954
 
    @needs_write_lock
955
1005
    def update_revisions(self, other, stop_revision=None, overwrite=False,
956
1006
                         graph=None):
957
1007
        """Pull in new perfect-fit revisions.
1006
1056
            self._extend_partial_history(distance_from_last)
1007
1057
        return self._partial_revision_history_cache[distance_from_last]
1008
1058
 
1009
 
    @needs_write_lock
1010
1059
    def pull(self, source, overwrite=False, stop_revision=None,
1011
1060
             possible_transports=None, *args, **kwargs):
1012
1061
        """Mirror source into this branch.
1255
1304
                revno = 1
1256
1305
        destination.set_last_revision_info(revno, revision_id)
1257
1306
 
1258
 
    @needs_read_lock
1259
1307
    def copy_content_into(self, destination, revision_id=None):
1260
1308
        """Copy the content of self into destination.
1261
1309
 
1262
1310
        revision_id: if not None, the revision history in the new branch will
1263
1311
                     be truncated to end with revision_id.
1264
1312
        """
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)
 
1313
        return InterBranch.get(self, destination).copy_content_into(
 
1314
            revision_id=revision_id)
1276
1315
 
1277
1316
    def update_references(self, target):
1278
1317
        if not getattr(self._format, 'supports_reference_locations', False):
1346
1385
        """
1347
1386
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1387
        # clone call. Or something. 20090224 RBC/spiv.
 
1388
        # XXX: Should this perhaps clone colocated branches as well, 
 
1389
        # rather than just the default branch? 20100319 JRV
1349
1390
        if revision_id is None:
1350
1391
            revision_id = self.last_revision()
1351
1392
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1510
1551
        try:
1511
1552
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
1553
            format_string = transport.get_bytes("format")
1513
 
            return klass._formats[format_string]
 
1554
            format = klass._formats[format_string]
 
1555
            if isinstance(format, MetaDirBranchFormatFactory):
 
1556
                return format()
 
1557
            return format
1514
1558
        except errors.NoSuchFile:
1515
1559
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1516
1560
        except KeyError:
1521
1565
        """Return the current default format."""
1522
1566
        return klass._default_format
1523
1567
 
1524
 
    def get_reference(self, a_bzrdir):
 
1568
    @classmethod
 
1569
    def get_formats(klass):
 
1570
        """Get all the known formats.
 
1571
 
 
1572
        Warning: This triggers a load of all lazy registered formats: do not
 
1573
        use except when that is desireed.
 
1574
        """
 
1575
        result = []
 
1576
        for fmt in klass._formats.values():
 
1577
            if isinstance(fmt, MetaDirBranchFormatFactory):
 
1578
                fmt = fmt()
 
1579
            result.append(fmt)
 
1580
        return result
 
1581
 
 
1582
    def get_reference(self, a_bzrdir, name=None):
1525
1583
        """Get the target reference of the branch in a_bzrdir.
1526
1584
 
1527
1585
        format probing must have been completed before calling
1529
1587
        in a_bzrdir is correct.
1530
1588
 
1531
1589
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1590
        :param name: Name of the colocated branch to fetch
1532
1591
        :return: None if the branch is not a reference branch.
1533
1592
        """
1534
1593
        return None
1535
1594
 
1536
1595
    @classmethod
1537
 
    def set_reference(self, a_bzrdir, to_branch):
 
1596
    def set_reference(self, a_bzrdir, name, to_branch):
1538
1597
        """Set the target reference of the branch in a_bzrdir.
1539
1598
 
1540
1599
        format probing must have been completed before calling
1542
1601
        in a_bzrdir is correct.
1543
1602
 
1544
1603
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1604
        :param name: Name of colocated branch to set, None for default
1545
1605
        :param to_branch: branch that the checkout is to reference
1546
1606
        """
1547
1607
        raise NotImplementedError(self.set_reference)
1661
1721
 
1662
1722
    @classmethod
1663
1723
    def register_format(klass, format):
1664
 
        """Register a metadir format."""
 
1724
        """Register a metadir format.
 
1725
        
 
1726
        See MetaDirBranchFormatFactory for the ability to register a format
 
1727
        without loading the code the format needs until it is actually used.
 
1728
        """
1665
1729
        klass._formats[format.get_format_string()] = format
1666
1730
        # 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__)
 
1731
        # registered as factories.
 
1732
        if isinstance(format, MetaDirBranchFormatFactory):
 
1733
            network_format_registry.register(format.get_format_string(), format)
 
1734
        else:
 
1735
            network_format_registry.register(format.get_format_string(),
 
1736
                format.__class__)
1669
1737
 
1670
1738
    @classmethod
1671
1739
    def set_default_format(klass, format):
1691
1759
        return False  # by default
1692
1760
 
1693
1761
 
 
1762
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1763
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1764
    
 
1765
    While none of the built in BranchFormats are lazy registered yet,
 
1766
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1767
    use it, and the bzr-loom plugin uses it as well (see
 
1768
    bzrlib.plugins.loom.formats).
 
1769
    """
 
1770
 
 
1771
    def __init__(self, format_string, module_name, member_name):
 
1772
        """Create a MetaDirBranchFormatFactory.
 
1773
 
 
1774
        :param format_string: The format string the format has.
 
1775
        :param module_name: Module to load the format class from.
 
1776
        :param member_name: Attribute name within the module for the format class.
 
1777
        """
 
1778
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1779
        self._format_string = format_string
 
1780
        
 
1781
    def get_format_string(self):
 
1782
        """See BranchFormat.get_format_string."""
 
1783
        return self._format_string
 
1784
 
 
1785
    def __call__(self):
 
1786
        """Used for network_format_registry support."""
 
1787
        return self.get_obj()()
 
1788
 
 
1789
 
1694
1790
class BranchHooks(Hooks):
1695
1791
    """A dictionary mapping hook name to a list of callables for branch hooks.
1696
1792
 
1766
1862
            "all are called with the url returned from the previous hook."
1767
1863
            "The order is however undefined.", (1, 9), None))
1768
1864
        self.create_hook(HookPoint('automatic_tag_name',
1769
 
            "Called to determine an automatic tag name for a revision."
 
1865
            "Called to determine an automatic tag name for a revision. "
1770
1866
            "automatic_tag_name is called with (branch, revision_id) and "
1771
1867
            "should return a tag name or None if no tag name could be "
1772
1868
            "determined. The first non-None tag name returned will be used.",
1863
1959
        return self.__dict__ == other.__dict__
1864
1960
 
1865
1961
    def __repr__(self):
1866
 
        if self.branch:
1867
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1868
 
        else:
1869
 
            return "<%s of format:%s bzrdir:%s>" % (
1870
 
                self.__class__.__name__, self.branch,
1871
 
                self.format, self.bzrdir)
 
1962
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1872
1963
 
1873
1964
 
1874
1965
class SwitchHookParams(object):
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()
2983
3103
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2984
3104
    """
2985
3105
 
 
3106
    @deprecated_method(deprecated_in((2, 3, 0)))
2986
3107
    def __int__(self):
2987
 
        # DEPRECATED: pull used to return the change in revno
 
3108
        """Return the relative change in revno.
 
3109
 
 
3110
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3111
        """
2988
3112
        return self.new_revno - self.old_revno
2989
3113
 
2990
3114
    def report(self, to_file):
3015
3139
        target, otherwise it will be None.
3016
3140
    """
3017
3141
 
 
3142
    @deprecated_method(deprecated_in((2, 3, 0)))
3018
3143
    def __int__(self):
3019
 
        # DEPRECATED: push used to return the change in revno
 
3144
        """Return the relative change in revno.
 
3145
 
 
3146
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3147
        """
3020
3148
        return self.new_revno - self.old_revno
3021
3149
 
3022
3150
    def report(self, to_file):
3145
3273
    _optimisers = []
3146
3274
    """The available optimised InterBranch types."""
3147
3275
 
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)
 
3276
    @classmethod
 
3277
    def _get_branch_formats_to_test(klass):
 
3278
        """Return an iterable of format tuples for testing.
 
3279
        
 
3280
        :return: An iterable of (from_format, to_format) to use when testing
 
3281
            this InterBranch class. Each InterBranch class should define this
 
3282
            method itself.
 
3283
        """
 
3284
        raise NotImplementedError(klass._get_branch_formats_to_test)
3152
3285
 
 
3286
    @needs_write_lock
3153
3287
    def pull(self, overwrite=False, stop_revision=None,
3154
3288
             possible_transports=None, local=False):
3155
3289
        """Mirror source into target branch.
3160
3294
        """
3161
3295
        raise NotImplementedError(self.pull)
3162
3296
 
 
3297
    @needs_write_lock
3163
3298
    def update_revisions(self, stop_revision=None, overwrite=False,
3164
3299
                         graph=None):
3165
3300
        """Pull in new perfect-fit revisions.
3173
3308
        """
3174
3309
        raise NotImplementedError(self.update_revisions)
3175
3310
 
 
3311
    @needs_write_lock
3176
3312
    def push(self, overwrite=False, stop_revision=None,
3177
3313
             _override_hook_source_branch=None):
3178
3314
        """Mirror the source branch into the target branch.
3181
3317
        """
3182
3318
        raise NotImplementedError(self.push)
3183
3319
 
 
3320
    @needs_write_lock
 
3321
    def copy_content_into(self, revision_id=None):
 
3322
        """Copy the content of source into target
 
3323
 
 
3324
        revision_id: if not None, the revision history in the new branch will
 
3325
                     be truncated to end with revision_id.
 
3326
        """
 
3327
        raise NotImplementedError(self.copy_content_into)
 
3328
 
3184
3329
 
3185
3330
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
 
 
 
3331
    """InterBranch implementation that uses public Branch functions."""
 
3332
 
 
3333
    @classmethod
 
3334
    def is_compatible(klass, source, target):
 
3335
        # GenericBranch uses the public API, so always compatible
 
3336
        return True
 
3337
 
 
3338
    @classmethod
 
3339
    def _get_branch_formats_to_test(klass):
 
3340
        return [(BranchFormat._default_format, BranchFormat._default_format)]
 
3341
 
 
3342
    @classmethod
 
3343
    def unwrap_format(klass, format):
 
3344
        if isinstance(format, remote.RemoteBranchFormat):
 
3345
            format._ensure_real()
 
3346
            return format._custom_format
 
3347
        return format                                                                                                  
 
3348
 
 
3349
    @needs_write_lock
 
3350
    def copy_content_into(self, revision_id=None):
 
3351
        """Copy the content of source into target
 
3352
 
 
3353
        revision_id: if not None, the revision history in the new branch will
 
3354
                     be truncated to end with revision_id.
 
3355
        """
 
3356
        self.source.update_references(self.target)
 
3357
        self.source._synchronize_history(self.target, revision_id)
 
3358
        try:
 
3359
            parent = self.source.get_parent()
 
3360
        except errors.InaccessibleParent, e:
 
3361
            mutter('parent was not accessible to copy: %s', e)
 
3362
        else:
 
3363
            if parent:
 
3364
                self.target.set_parent(parent)
 
3365
        if self.source._push_should_merge_tags():
 
3366
            self.source.tags.merge_to(self.target.tags)
 
3367
 
 
3368
    @needs_write_lock
3193
3369
    def update_revisions(self, stop_revision=None, overwrite=False,
3194
3370
        graph=None):
3195
3371
        """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
 
 
 
3372
        other_revno, other_last_revision = self.source.last_revision_info()
 
3373
        stop_revno = None # unknown
 
3374
        if stop_revision is None:
 
3375
            stop_revision = other_last_revision
 
3376
            if _mod_revision.is_null(stop_revision):
 
3377
                # if there are no commits, we're done.
 
3378
                return
 
3379
            stop_revno = other_revno
 
3380
 
 
3381
        # what's the current last revision, before we fetch [and change it
 
3382
        # possibly]
 
3383
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3384
        # we fetch here so that we don't process data twice in the common
 
3385
        # case of having something to pull, and so that the check for
 
3386
        # already merged can operate on the just fetched graph, which will
 
3387
        # be cached in memory.
 
3388
        self.target.fetch(self.source, stop_revision)
 
3389
        # Check to see if one is an ancestor of the other
 
3390
        if not overwrite:
 
3391
            if graph is None:
 
3392
                graph = self.target.repository.get_graph()
 
3393
            if self.target._check_if_descendant_or_diverged(
 
3394
                    stop_revision, last_rev, graph, self.source):
 
3395
                # stop_revision is a descendant of last_rev, but we aren't
 
3396
                # overwriting, so we're done.
 
3397
                return
 
3398
        if stop_revno is None:
 
3399
            if graph is None:
 
3400
                graph = self.target.repository.get_graph()
 
3401
            this_revno, this_last_revision = \
 
3402
                    self.target.last_revision_info()
 
3403
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3404
                            [(other_last_revision, other_revno),
 
3405
                             (this_last_revision, this_revno)])
 
3406
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3407
 
 
3408
    @needs_write_lock
3236
3409
    def pull(self, overwrite=False, stop_revision=None,
3237
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3410
             possible_transports=None, run_hooks=True,
3238
3411
             _override_hook_target=None, local=False):
3239
 
        """See Branch.pull.
 
3412
        """Pull from source into self, updating my master if any.
3240
3413
 
3241
 
        :param _hook_master: Private parameter - set the branch to
3242
 
            be supplied as the master to pull hooks.
3243
3414
        :param run_hooks: Private parameter - if false, this branch
3244
3415
            is being called because it's the master of the primary branch,
3245
3416
            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
3417
        """
3250
 
        # This type of branch can't be bound.
3251
 
        if local:
 
3418
        bound_location = self.target.get_bound_location()
 
3419
        if local and not bound_location:
3252
3420
            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()
 
3421
        master_branch = None
 
3422
        if not local and bound_location and self.source.user_url != bound_location:
 
3423
            # not pulling from master, so we need to update master.
 
3424
            master_branch = self.target.get_master_branch(possible_transports)
 
3425
            master_branch.lock_write()
3260
3426
        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)
 
3427
            if master_branch:
 
3428
                # pull from source into master.
 
3429
                master_branch.pull(self.source, overwrite, stop_revision,
 
3430
                    run_hooks=False)
 
3431
            return self._pull(overwrite,
 
3432
                stop_revision, _hook_master=master_branch,
 
3433
                run_hooks=run_hooks,
 
3434
                _override_hook_target=_override_hook_target)
3287
3435
        finally:
3288
 
            self.source.unlock()
3289
 
        return result
 
3436
            if master_branch:
 
3437
                master_branch.unlock()
3290
3438
 
3291
3439
    def push(self, overwrite=False, stop_revision=None,
3292
3440
             _override_hook_source_branch=None):
3354
3502
            _run_hooks()
3355
3503
            return result
3356
3504
 
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,
 
3505
    def _pull(self, overwrite=False, stop_revision=None,
 
3506
             possible_transports=None, _hook_master=None, run_hooks=True,
3371
3507
             _override_hook_target=None, local=False):
3372
 
        """Pull from source into self, updating my master if any.
3373
 
 
 
3508
        """See Branch.pull.
 
3509
 
 
3510
        This function is the core worker, used by GenericInterBranch.pull to
 
3511
        avoid duplication when pulling source->master and source->local.
 
3512
 
 
3513
        :param _hook_master: Private parameter - set the branch to
 
3514
            be supplied as the master to pull hooks.
3374
3515
        :param run_hooks: Private parameter - if false, this branch
3375
3516
            is being called because it's the master of the primary branch,
3376
3517
            so it should not run its hooks.
 
3518
        :param _override_hook_target: Private parameter - set the branch to be
 
3519
            supplied as the target_branch to pull hooks.
 
3520
        :param local: Only update the local branch, and not the bound branch.
3377
3521
        """
3378
 
        bound_location = self.target.get_bound_location()
3379
 
        if local and not bound_location:
 
3522
        # This type of branch can't be bound.
 
3523
        if local:
3380
3524
            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()
 
3525
        result = PullResult()
 
3526
        result.source_branch = self.source
 
3527
        if _override_hook_target is None:
 
3528
            result.target_branch = self.target
 
3529
        else:
 
3530
            result.target_branch = _override_hook_target
 
3531
        self.source.lock_read()
3386
3532
        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)
 
3533
            # We assume that during 'pull' the target repository is closer than
 
3534
            # the source one.
 
3535
            self.source.update_references(self.target)
 
3536
            graph = self.target.repository.get_graph(self.source.repository)
 
3537
            # TODO: Branch formats should have a flag that indicates 
 
3538
            # that revno's are expensive, and pull() should honor that flag.
 
3539
            # -- JRV20090506
 
3540
            result.old_revno, result.old_revid = \
 
3541
                self.target.last_revision_info()
 
3542
            self.target.update_revisions(self.source, stop_revision,
 
3543
                overwrite=overwrite, graph=graph)
 
3544
            # TODO: The old revid should be specified when merging tags, 
 
3545
            # so a tags implementation that versions tags can only 
 
3546
            # pull in the most recent changes. -- JRV20090506
 
3547
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3548
                overwrite)
 
3549
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3550
            if _hook_master:
 
3551
                result.master_branch = _hook_master
 
3552
                result.local_branch = result.target_branch
 
3553
            else:
 
3554
                result.master_branch = result.target_branch
 
3555
                result.local_branch = None
 
3556
            if run_hooks:
 
3557
                for hook in Branch.hooks['post_pull']:
 
3558
                    hook(result)
3395
3559
        finally:
3396
 
            if master_branch:
3397
 
                master_branch.unlock()
 
3560
            self.source.unlock()
 
3561
        return result
3398
3562
 
3399
3563
 
3400
3564
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)