← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: John Arbash Meinel
  • Date: 2010-09-21 19:30:33 UTC
  • mto: This revision was merged to the branch mainline in revision 5451.
  • Revision ID: john@arbash-meinel.com-20100921193033-9ftw56og72mhlwo4
Change GroupCompressBlock to work in self._z_compress_chunks

This pushes down one of the peak memory locations. We still have a requirement
during commit of 1 fulltext + 2 compressed texts, but at least this code
path is now better about only using 1 fulltext and 1 compressed text.
We need to push this into more apis to get a bigger benefit.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
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
295
308
    def lock_read(self):
296
309
        """Lock the branch for read operations.
297
310
 
298
 
        :return: An object with an unlock method which will release the lock
299
 
            obtained.
 
311
        :return: A bzrlib.lock.LogicalLockResult.
300
312
        """
301
313
        raise NotImplementedError(self.lock_read)
302
314
 
794
806
            if len(old_repository._fallback_repositories) != 1:
795
807
                raise AssertionError("can't cope with fallback repositories "
796
808
                    "of %r" % (self.repository,))
797
 
            # 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()
798
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.
799
857
            old_repository.lock_read()
800
858
            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
859
                # XXX: If you unstack a branch while it has a working tree
820
860
                # with a pending merge, the pending-merged revisions will no
821
861
                # longer be present.  You can (probably) revert and remerge.
962
1002
                raise errors.NoSuchRevision(self, stop_revision)
963
1003
        return other_history[self_len:stop_revision]
964
1004
 
965
 
    @needs_write_lock
966
1005
    def update_revisions(self, other, stop_revision=None, overwrite=False,
967
1006
                         graph=None):
968
1007
        """Pull in new perfect-fit revisions.
1017
1056
            self._extend_partial_history(distance_from_last)
1018
1057
        return self._partial_revision_history_cache[distance_from_last]
1019
1058
 
1020
 
    @needs_write_lock
1021
1059
    def pull(self, source, overwrite=False, stop_revision=None,
1022
1060
             possible_transports=None, *args, **kwargs):
1023
1061
        """Mirror source into this branch.
1266
1304
                revno = 1
1267
1305
        destination.set_last_revision_info(revno, revision_id)
1268
1306
 
1269
 
    @needs_read_lock
1270
1307
    def copy_content_into(self, destination, revision_id=None):
1271
1308
        """Copy the content of self into destination.
1272
1309
 
1273
1310
        revision_id: if not None, the revision history in the new branch will
1274
1311
                     be truncated to end with revision_id.
1275
1312
        """
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)
 
1313
        return InterBranch.get(self, destination).copy_content_into(
 
1314
            revision_id=revision_id)
1287
1315
 
1288
1316
    def update_references(self, target):
1289
1317
        if not getattr(self._format, 'supports_reference_locations', False):
1357
1385
        """
1358
1386
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1359
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
1360
1390
        if revision_id is None:
1361
1391
            revision_id = self.last_revision()
1362
1392
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1521
1551
        try:
1522
1552
            transport = a_bzrdir.get_branch_transport(None, name=name)
1523
1553
            format_string = transport.get_bytes("format")
1524
 
            return klass._formats[format_string]
 
1554
            format = klass._formats[format_string]
 
1555
            if isinstance(format, MetaDirBranchFormatFactory):
 
1556
                return format()
 
1557
            return format
1525
1558
        except errors.NoSuchFile:
1526
1559
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1527
1560
        except KeyError:
1532
1565
        """Return the current default format."""
1533
1566
        return klass._default_format
1534
1567
 
1535
 
    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):
1536
1583
        """Get the target reference of the branch in a_bzrdir.
1537
1584
 
1538
1585
        format probing must have been completed before calling
1540
1587
        in a_bzrdir is correct.
1541
1588
 
1542
1589
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1590
        :param name: Name of the colocated branch to fetch
1543
1591
        :return: None if the branch is not a reference branch.
1544
1592
        """
1545
1593
        return None
1546
1594
 
1547
1595
    @classmethod
1548
 
    def set_reference(self, a_bzrdir, to_branch):
 
1596
    def set_reference(self, a_bzrdir, name, to_branch):
1549
1597
        """Set the target reference of the branch in a_bzrdir.
1550
1598
 
1551
1599
        format probing must have been completed before calling
1553
1601
        in a_bzrdir is correct.
1554
1602
 
1555
1603
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1604
        :param name: Name of colocated branch to set, None for default
1556
1605
        :param to_branch: branch that the checkout is to reference
1557
1606
        """
1558
1607
        raise NotImplementedError(self.set_reference)
1672
1721
 
1673
1722
    @classmethod
1674
1723
    def register_format(klass, format):
1675
 
        """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
        """
1676
1729
        klass._formats[format.get_format_string()] = format
1677
1730
        # 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__)
 
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__)
1680
1737
 
1681
1738
    @classmethod
1682
1739
    def set_default_format(klass, format):
1702
1759
        return False  # by default
1703
1760
 
1704
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
 
1705
1790
class BranchHooks(Hooks):
1706
1791
    """A dictionary mapping hook name to a list of callables for branch hooks.
1707
1792
 
1777
1862
            "all are called with the url returned from the previous hook."
1778
1863
            "The order is however undefined.", (1, 9), None))
1779
1864
        self.create_hook(HookPoint('automatic_tag_name',
1780
 
            "Called to determine an automatic tag name for a revision."
 
1865
            "Called to determine an automatic tag name for a revision. "
1781
1866
            "automatic_tag_name is called with (branch, revision_id) and "
1782
1867
            "should return a tag name or None if no tag name could be "
1783
1868
            "determined. The first non-None tag name returned will be used.",
1874
1959
        return self.__dict__ == other.__dict__
1875
1960
 
1876
1961
    def __repr__(self):
1877
 
        if self.branch:
1878
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1879
 
        else:
1880
 
            return "<%s of format:%s bzrdir:%s>" % (
1881
 
                self.__class__.__name__, self.branch,
1882
 
                self.format, self.bzrdir)
 
1962
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1883
1963
 
1884
1964
 
1885
1965
class SwitchHookParams(object):
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()
3024
3103
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3025
3104
    """
3026
3105
 
 
3106
    @deprecated_method(deprecated_in((2, 3, 0)))
3027
3107
    def __int__(self):
3028
 
        # 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
        """
3029
3112
        return self.new_revno - self.old_revno
3030
3113
 
3031
3114
    def report(self, to_file):
3056
3139
        target, otherwise it will be None.
3057
3140
    """
3058
3141
 
 
3142
    @deprecated_method(deprecated_in((2, 3, 0)))
3059
3143
    def __int__(self):
3060
 
        # 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
        """
3061
3148
        return self.new_revno - self.old_revno
3062
3149
 
3063
3150
    def report(self, to_file):
3186
3273
    _optimisers = []
3187
3274
    """The available optimised InterBranch types."""
3188
3275
 
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)
 
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)
3193
3285
 
 
3286
    @needs_write_lock
3194
3287
    def pull(self, overwrite=False, stop_revision=None,
3195
3288
             possible_transports=None, local=False):
3196
3289
        """Mirror source into target branch.
3201
3294
        """
3202
3295
        raise NotImplementedError(self.pull)
3203
3296
 
 
3297
    @needs_write_lock
3204
3298
    def update_revisions(self, stop_revision=None, overwrite=False,
3205
3299
                         graph=None):
3206
3300
        """Pull in new perfect-fit revisions.
3214
3308
        """
3215
3309
        raise NotImplementedError(self.update_revisions)
3216
3310
 
 
3311
    @needs_write_lock
3217
3312
    def push(self, overwrite=False, stop_revision=None,
3218
3313
             _override_hook_source_branch=None):
3219
3314
        """Mirror the source branch into the target branch.
3222
3317
        """
3223
3318
        raise NotImplementedError(self.push)
3224
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
 
3225
3329
 
3226
3330
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
 
 
 
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
3234
3369
    def update_revisions(self, stop_revision=None, overwrite=False,
3235
3370
        graph=None):
3236
3371
        """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
 
 
 
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
3277
3409
    def pull(self, overwrite=False, stop_revision=None,
3278
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3410
             possible_transports=None, run_hooks=True,
3279
3411
             _override_hook_target=None, local=False):
3280
 
        """See Branch.pull.
 
3412
        """Pull from source into self, updating my master if any.
3281
3413
 
3282
 
        :param _hook_master: Private parameter - set the branch to
3283
 
            be supplied as the master to pull hooks.
3284
3414
        :param run_hooks: Private parameter - if false, this branch
3285
3415
            is being called because it's the master of the primary branch,
3286
3416
            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
3417
        """
3291
 
        # This type of branch can't be bound.
3292
 
        if local:
 
3418
        bound_location = self.target.get_bound_location()
 
3419
        if local and not bound_location:
3293
3420
            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()
 
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()
3301
3426
        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)
 
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)
3328
3435
        finally:
3329
 
            self.source.unlock()
3330
 
        return result
 
3436
            if master_branch:
 
3437
                master_branch.unlock()
3331
3438
 
3332
3439
    def push(self, overwrite=False, stop_revision=None,
3333
3440
             _override_hook_source_branch=None):
3395
3502
            _run_hooks()
3396
3503
            return result
3397
3504
 
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,
 
3505
    def _pull(self, overwrite=False, stop_revision=None,
 
3506
             possible_transports=None, _hook_master=None, run_hooks=True,
3412
3507
             _override_hook_target=None, local=False):
3413
 
        """Pull from source into self, updating my master if any.
3414
 
 
 
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.
3415
3515
        :param run_hooks: Private parameter - if false, this branch
3416
3516
            is being called because it's the master of the primary branch,
3417
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.
3418
3521
        """
3419
 
        bound_location = self.target.get_bound_location()
3420
 
        if local and not bound_location:
 
3522
        # This type of branch can't be bound.
 
3523
        if local:
3421
3524
            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()
 
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()
3427
3532
        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)
 
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)
3436
3559
        finally:
3437
 
            if master_branch:
3438
 
                master_branch.unlock()
 
3560
            self.source.unlock()
 
3561
        return result
3439
3562
 
3440
3563
 
3441
3564
InterBranch.register_optimiser(GenericInterBranch)
3442
 
InterBranch.register_optimiser(InterToBranch5)