~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2010-04-21 11:27:04 UTC
  • mto: This revision was merged to the branch mainline in revision 5189.
  • Revision ID: mbp@canonical.com-20100421112704-zijso22b6pdevrxy
Simplify various code to use user_url

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,
29
28
        debug,
30
29
        errors,
31
30
        lockdir,
32
31
        lockable_files,
33
 
        remote,
34
32
        repository,
35
33
        revision as _mod_revision,
36
34
        rio,
51
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
52
50
from bzrlib.hooks import HookPoint, Hooks
53
51
from bzrlib.inter import InterObject
54
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
 
52
from bzrlib.lock import _RelockDebugMixin
55
53
from bzrlib import registry
56
54
from bzrlib.symbol_versioning import (
57
55
    deprecated_in,
65
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
66
64
 
67
65
 
68
 
class Branch(controldir.ControlComponent):
 
66
class Branch(bzrdir.ControlComponent):
69
67
    """Branch holding a history of revisions.
70
68
 
71
69
    :ivar base:
199
197
        return self.supports_tags() and self.tags.get_tag_dict()
200
198
 
201
199
    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
 
        """
209
200
        return BranchConfig(self)
210
201
 
211
202
    def _get_config(self):
247
238
        if not local and not config.has_explicit_nickname():
248
239
            try:
249
240
                master = self.get_master_branch(possible_transports)
250
 
                if master and self.user_url == master.user_url:
251
 
                    raise errors.RecursiveBind(self.user_url)
252
241
                if master is not None:
253
242
                    # return the master branch value
254
243
                    return master.nick
255
 
            except errors.RecursiveBind, e:
256
 
                raise e
257
244
            except errors.BzrError, e:
258
245
                # Silently fall back to local implicit nick if the master is
259
246
                # unavailable
296
283
        new_history.reverse()
297
284
        return new_history
298
285
 
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
 
        """
 
286
    def lock_write(self):
306
287
        raise NotImplementedError(self.lock_write)
307
288
 
308
289
    def lock_read(self):
309
 
        """Lock the branch for read operations.
310
 
 
311
 
        :return: A bzrlib.lock.LogicalLockResult.
312
 
        """
313
290
        raise NotImplementedError(self.lock_read)
314
291
 
315
292
    def unlock(self):
440
417
            * 'include' - the stop revision is the last item in the result
441
418
            * 'with-merges' - include the stop revision and all of its
442
419
              merged revisions in the result
443
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
444
 
              that are in both ancestries
445
420
        :param direction: either 'reverse' or 'forward':
446
421
            * reverse means return the start_revision_id first, i.e.
447
422
              start at the most recent revision and go backwards in history
478
453
            stop_revision_id, stop_rule)
479
454
        # Make sure we don't return revisions that are not part of the
480
455
        # start_revision_id ancestry.
481
 
        filtered = self._filter_start_non_ancestors(filtered)
 
456
        filtered = self._filter_non_ancestors(filtered)
482
457
        if direction == 'reverse':
483
458
            return filtered
484
459
        if direction == 'forward':
521
496
                       node.end_of_merge)
522
497
                if rev_id == stop_revision_id:
523
498
                    return
524
 
        elif stop_rule == 'with-merges-without-common-ancestry':
525
 
            # We want to exclude all revisions that are already part of the
526
 
            # stop_revision_id ancestry.
527
 
            graph = self.repository.get_graph()
528
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
529
 
                                                    [stop_revision_id])
530
 
            for node in rev_iter:
531
 
                rev_id = node.key[-1]
532
 
                if rev_id not in ancestors:
533
 
                    continue
534
 
                yield (rev_id, node.merge_depth, node.revno,
535
 
                       node.end_of_merge)
536
499
        elif stop_rule == 'with-merges':
537
500
            stop_rev = self.repository.get_revision(stop_revision_id)
538
501
            if stop_rev.parent_ids:
561
524
        else:
562
525
            raise ValueError('invalid stop_rule %r' % stop_rule)
563
526
 
564
 
    def _filter_start_non_ancestors(self, rev_iter):
 
527
    def _filter_non_ancestors(self, rev_iter):
565
528
        # If we started from a dotted revno, we want to consider it as a tip
566
529
        # and don't want to yield revisions that are not part of its
567
530
        # ancestry. Given the order guaranteed by the merge sort, we will see
658
621
        :param pb: An optional progress bar to use.
659
622
        :return: None
660
623
        """
661
 
        if self.base == from_branch.base:
 
624
        if self.control_url == from_branch.control_url:
662
625
            return (0, [])
663
626
        if pb is not None:
664
627
            symbol_versioning.warn(
806
769
            if len(old_repository._fallback_repositories) != 1:
807
770
                raise AssertionError("can't cope with fallback repositories "
808
771
                    "of %r" % (self.repository,))
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()
 
772
            # unlock it, including unlocking the fallback
836
773
            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):
 
774
            old_repository.lock_read()
 
775
            try:
 
776
                # Repositories don't offer an interface to remove fallback
 
777
                # repositories today; take the conceptually simpler option and just
 
778
                # reopen it.  We reopen it starting from the URL so that we
 
779
                # get a separate connection for RemoteRepositories and can
 
780
                # stream from one of them to the other.  This does mean doing
 
781
                # separate SSH connection setup, but unstacking is not a
 
782
                # common operation so it's tolerable.
 
783
                new_bzrdir = bzrdir.BzrDir.open_from_transport(
 
784
                    self.bzrdir.user_transport)
 
785
                new_repository = new_bzrdir.find_repository()
 
786
                self.repository = new_repository
 
787
                if self.repository._fallback_repositories:
 
788
                    raise AssertionError("didn't expect %r to have "
 
789
                        "fallback_repositories"
 
790
                        % (self.repository,))
 
791
                # this is not paired with an unlock because it's just restoring
 
792
                # the previous state; the lock's released when set_stacked_on_url
 
793
                # returns
855
794
                self.repository.lock_write()
856
 
            # Fetch from the old repository into the new.
857
 
            old_repository.lock_read()
858
 
            try:
859
795
                # XXX: If you unstack a branch while it has a working tree
860
796
                # with a pending merge, the pending-merged revisions will no
861
797
                # longer be present.  You can (probably) revert and remerge.
1002
938
                raise errors.NoSuchRevision(self, stop_revision)
1003
939
        return other_history[self_len:stop_revision]
1004
940
 
 
941
    @needs_write_lock
1005
942
    def update_revisions(self, other, stop_revision=None, overwrite=False,
1006
943
                         graph=None):
1007
944
        """Pull in new perfect-fit revisions.
1056
993
            self._extend_partial_history(distance_from_last)
1057
994
        return self._partial_revision_history_cache[distance_from_last]
1058
995
 
 
996
    @needs_write_lock
1059
997
    def pull(self, source, overwrite=False, stop_revision=None,
1060
998
             possible_transports=None, *args, **kwargs):
1061
999
        """Mirror source into this branch.
1274
1212
            if repository_policy is not None:
1275
1213
                repository_policy.configure_branch(result)
1276
1214
            self.copy_content_into(result, revision_id=revision_id)
1277
 
            result.set_parent(self.bzrdir.root_transport.base)
 
1215
            result.set_parent(self.bzrdir.user_url)
1278
1216
        finally:
1279
1217
            result.unlock()
1280
1218
        return result
1304
1242
                revno = 1
1305
1243
        destination.set_last_revision_info(revno, revision_id)
1306
1244
 
 
1245
    @needs_read_lock
1307
1246
    def copy_content_into(self, destination, revision_id=None):
1308
1247
        """Copy the content of self into destination.
1309
1248
 
1310
1249
        revision_id: if not None, the revision history in the new branch will
1311
1250
                     be truncated to end with revision_id.
1312
1251
        """
1313
 
        return InterBranch.get(self, destination).copy_content_into(
1314
 
            revision_id=revision_id)
 
1252
        self.update_references(destination)
 
1253
        self._synchronize_history(destination, revision_id)
 
1254
        try:
 
1255
            parent = self.get_parent()
 
1256
        except errors.InaccessibleParent, e:
 
1257
            mutter('parent was not accessible to copy: %s', e)
 
1258
        else:
 
1259
            if parent:
 
1260
                destination.set_parent(parent)
 
1261
        if self._push_should_merge_tags():
 
1262
            self.tags.merge_to(destination.tags)
1315
1263
 
1316
1264
    def update_references(self, target):
1317
1265
        if not getattr(self._format, 'supports_reference_locations', False):
1385
1333
        """
1386
1334
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1387
1335
        # 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
1390
1336
        if revision_id is None:
1391
1337
            revision_id = self.last_revision()
1392
1338
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1459
1405
        :return: A branch associated with the file_id
1460
1406
        """
1461
1407
        # FIXME should provide multiple branches, based on config
1462
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
 
1408
        return Branch.open(self.user_transport.clone(path).base,
1463
1409
                           possible_transports=possible_transports)
1464
1410
 
1465
1411
    def supports_tags(self):
1551
1497
        try:
1552
1498
            transport = a_bzrdir.get_branch_transport(None, name=name)
1553
1499
            format_string = transport.get_bytes("format")
1554
 
            format = klass._formats[format_string]
1555
 
            if isinstance(format, MetaDirBranchFormatFactory):
1556
 
                return format()
1557
 
            return format
 
1500
            return klass._formats[format_string]
1558
1501
        except errors.NoSuchFile:
1559
1502
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1560
1503
        except KeyError:
1565
1508
        """Return the current default format."""
1566
1509
        return klass._default_format
1567
1510
 
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):
 
1511
    def get_reference(self, a_bzrdir):
1583
1512
        """Get the target reference of the branch in a_bzrdir.
1584
1513
 
1585
1514
        format probing must have been completed before calling
1587
1516
        in a_bzrdir is correct.
1588
1517
 
1589
1518
        :param a_bzrdir: The bzrdir to get the branch data from.
1590
 
        :param name: Name of the colocated branch to fetch
1591
1519
        :return: None if the branch is not a reference branch.
1592
1520
        """
1593
1521
        return None
1594
1522
 
1595
1523
    @classmethod
1596
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1524
    def set_reference(self, a_bzrdir, to_branch):
1597
1525
        """Set the target reference of the branch in a_bzrdir.
1598
1526
 
1599
1527
        format probing must have been completed before calling
1601
1529
        in a_bzrdir is correct.
1602
1530
 
1603
1531
        :param a_bzrdir: The bzrdir to set the branch reference for.
1604
 
        :param name: Name of colocated branch to set, None for default
1605
1532
        :param to_branch: branch that the checkout is to reference
1606
1533
        """
1607
1534
        raise NotImplementedError(self.set_reference)
1614
1541
        """Return the short format description for this format."""
1615
1542
        raise NotImplementedError(self.get_format_description)
1616
1543
 
1617
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1618
 
        hooks = Branch.hooks['post_branch_init']
1619
 
        if not hooks:
1620
 
            return
1621
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1622
 
        for hook in hooks:
1623
 
            hook(params)
1624
 
 
1625
1544
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1626
1545
                           lock_type='metadir', set_format=True):
1627
1546
        """Initialize a branch in a bzrdir, with specified files
1663
1582
        finally:
1664
1583
            if lock_taken:
1665
1584
                control_files.unlock()
1666
 
        branch = self.open(a_bzrdir, name, _found=True)
1667
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1668
 
        return branch
 
1585
        return self.open(a_bzrdir, name, _found=True)
1669
1586
 
1670
1587
    def initialize(self, a_bzrdir, name=None):
1671
1588
        """Create a branch of this format in a_bzrdir.
1721
1638
 
1722
1639
    @classmethod
1723
1640
    def register_format(klass, 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
 
        """
 
1641
        """Register a metadir format."""
1729
1642
        klass._formats[format.get_format_string()] = format
1730
1643
        # Metadir formats have a network name of their format string, and get
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__)
 
1644
        # registered as class factories.
 
1645
        network_format_registry.register(format.get_format_string(), format.__class__)
1737
1646
 
1738
1647
    @classmethod
1739
1648
    def set_default_format(klass, format):
1759
1668
        return False  # by default
1760
1669
 
1761
1670
 
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
 
 
1790
1671
class BranchHooks(Hooks):
1791
1672
    """A dictionary mapping hook name to a list of callables for branch hooks.
1792
1673
 
1862
1743
            "all are called with the url returned from the previous hook."
1863
1744
            "The order is however undefined.", (1, 9), None))
1864
1745
        self.create_hook(HookPoint('automatic_tag_name',
1865
 
            "Called to determine an automatic tag name for a revision. "
 
1746
            "Called to determine an automatic tag name for a revision."
1866
1747
            "automatic_tag_name is called with (branch, revision_id) and "
1867
1748
            "should return a tag name or None if no tag name could be "
1868
1749
            "determined. The first non-None tag name returned will be used.",
1869
1750
            (2, 2), None))
1870
 
        self.create_hook(HookPoint('post_branch_init',
1871
 
            "Called after new branch initialization completes. "
1872
 
            "post_branch_init is called with a "
1873
 
            "bzrlib.branch.BranchInitHookParams. "
1874
 
            "Note that init, branch and checkout (both heavyweight and "
1875
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1876
 
        self.create_hook(HookPoint('post_switch',
1877
 
            "Called after a checkout switches branch. "
1878
 
            "post_switch is called with a "
1879
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1880
1751
 
1881
1752
 
1882
1753
 
1922
1793
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1923
1794
 
1924
1795
 
1925
 
class BranchInitHookParams(object):
1926
 
    """Object holding parameters passed to *_branch_init hooks.
1927
 
 
1928
 
    There are 4 fields that hooks may wish to access:
1929
 
 
1930
 
    :ivar format: the branch format
1931
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1932
 
    :ivar name: name of colocated branch, if any (or None)
1933
 
    :ivar branch: the branch created
1934
 
 
1935
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1936
 
    the checkout, hence they are different from the corresponding fields in
1937
 
    branch, which refer to the original branch.
1938
 
    """
1939
 
 
1940
 
    def __init__(self, format, a_bzrdir, name, branch):
1941
 
        """Create a group of BranchInitHook parameters.
1942
 
 
1943
 
        :param format: the branch format
1944
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1945
 
            initialized
1946
 
        :param name: name of colocated branch, if any (or None)
1947
 
        :param branch: the branch created
1948
 
 
1949
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1950
 
        to the checkout, hence they are different from the corresponding fields
1951
 
        in branch, which refer to the original branch.
1952
 
        """
1953
 
        self.format = format
1954
 
        self.bzrdir = a_bzrdir
1955
 
        self.name = name
1956
 
        self.branch = branch
1957
 
 
1958
 
    def __eq__(self, other):
1959
 
        return self.__dict__ == other.__dict__
1960
 
 
1961
 
    def __repr__(self):
1962
 
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1963
 
 
1964
 
 
1965
 
class SwitchHookParams(object):
1966
 
    """Object holding parameters passed to *_switch hooks.
1967
 
 
1968
 
    There are 4 fields that hooks may wish to access:
1969
 
 
1970
 
    :ivar control_dir: BzrDir of the checkout to change
1971
 
    :ivar to_branch: branch that the checkout is to reference
1972
 
    :ivar force: skip the check for local commits in a heavy checkout
1973
 
    :ivar revision_id: revision ID to switch to (or None)
1974
 
    """
1975
 
 
1976
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1977
 
        """Create a group of SwitchHook parameters.
1978
 
 
1979
 
        :param control_dir: BzrDir of the checkout to change
1980
 
        :param to_branch: branch that the checkout is to reference
1981
 
        :param force: skip the check for local commits in a heavy checkout
1982
 
        :param revision_id: revision ID to switch to (or None)
1983
 
        """
1984
 
        self.control_dir = control_dir
1985
 
        self.to_branch = to_branch
1986
 
        self.force = force
1987
 
        self.revision_id = revision_id
1988
 
 
1989
 
    def __eq__(self, other):
1990
 
        return self.__dict__ == other.__dict__
1991
 
 
1992
 
    def __repr__(self):
1993
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1994
 
            self.control_dir, self.to_branch,
1995
 
            self.revision_id)
1996
 
 
1997
 
 
1998
1796
class BzrBranchFormat4(BranchFormat):
1999
1797
    """Bzr branch format 4.
2000
1798
 
2248
2046
        """See BranchFormat.get_format_description()."""
2249
2047
        return "Checkout reference format 1"
2250
2048
 
2251
 
    def get_reference(self, a_bzrdir, name=None):
 
2049
    def get_reference(self, a_bzrdir):
2252
2050
        """See BranchFormat.get_reference()."""
2253
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
2051
        transport = a_bzrdir.get_branch_transport(None)
2254
2052
        return transport.get_bytes('location')
2255
2053
 
2256
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
2054
    def set_reference(self, a_bzrdir, to_branch):
2257
2055
        """See BranchFormat.set_reference()."""
2258
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
2056
        transport = a_bzrdir.get_branch_transport(None)
2259
2057
        location = transport.put_bytes('location', to_branch.base)
2260
2058
 
2261
2059
    def initialize(self, a_bzrdir, name=None, target_branch=None):
2269
2067
        branch_transport.put_bytes('location',
2270
2068
            target_branch.bzrdir.user_url)
2271
2069
        branch_transport.put_bytes('format', self.get_format_string())
2272
 
        branch = self.open(
 
2070
        return self.open(
2273
2071
            a_bzrdir, name, _found=True,
2274
2072
            possible_transports=[target_branch.bzrdir.root_transport])
2275
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2276
 
        return branch
2277
2073
 
2278
2074
    def __init__(self):
2279
2075
        super(BranchReferenceFormat, self).__init__()
2312
2108
                raise AssertionError("wrong format %r found for %r" %
2313
2109
                    (format, self))
2314
2110
        if location is None:
2315
 
            location = self.get_reference(a_bzrdir, name)
 
2111
            location = self.get_reference(a_bzrdir)
2316
2112
        real_bzrdir = bzrdir.BzrDir.open(
2317
2113
            location, possible_transports=possible_transports)
2318
2114
        result = real_bzrdir.open_branch(name=name, 
2356
2152
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2357
2153
 
2358
2154
 
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
 
 
2376
2155
class BzrBranch(Branch, _RelockDebugMixin):
2377
2156
    """A branch stored in the actual filesystem.
2378
2157
 
2432
2211
        return self.control_files.is_locked()
2433
2212
 
2434
2213
    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
 
        """
2441
2214
        if not self.is_locked():
2442
2215
            self._note_lock('w')
2443
2216
        # All-in-one needs to always unlock/lock.
2449
2222
        else:
2450
2223
            took_lock = False
2451
2224
        try:
2452
 
            return BranchWriteLockResult(self.unlock,
2453
 
                self.control_files.lock_write(token=token))
 
2225
            return self.control_files.lock_write(token=token)
2454
2226
        except:
2455
2227
            if took_lock:
2456
2228
                self.repository.unlock()
2457
2229
            raise
2458
2230
 
2459
2231
    def lock_read(self):
2460
 
        """Lock the branch for read operations.
2461
 
 
2462
 
        :return: A bzrlib.lock.LogicalLockResult.
2463
 
        """
2464
2232
        if not self.is_locked():
2465
2233
            self._note_lock('r')
2466
2234
        # All-in-one needs to always unlock/lock.
2473
2241
            took_lock = False
2474
2242
        try:
2475
2243
            self.control_files.lock_read()
2476
 
            return LogicalLockResult(self.unlock)
2477
2244
        except:
2478
2245
            if took_lock:
2479
2246
                self.repository.unlock()
3002
2769
        return stacked_url
3003
2770
 
3004
2771
    def _get_append_revisions_only(self):
3005
 
        return self.get_config(
3006
 
            ).get_user_option_as_bool('append_revisions_only')
 
2772
        value = self.get_config().get_user_option('append_revisions_only')
 
2773
        return value == 'True'
3007
2774
 
3008
2775
    @needs_write_lock
3009
2776
    def generate_revision_history(self, revision_id, last_rev=None,
3265
3032
    _optimisers = []
3266
3033
    """The available optimised InterBranch types."""
3267
3034
 
3268
 
    @classmethod
3269
 
    def _get_branch_formats_to_test(klass):
3270
 
        """Return an iterable of format tuples for testing.
3271
 
        
3272
 
        :return: An iterable of (from_format, to_format) to use when testing
3273
 
            this InterBranch class. Each InterBranch class should define this
3274
 
            method itself.
3275
 
        """
3276
 
        raise NotImplementedError(klass._get_branch_formats_to_test)
 
3035
    @staticmethod
 
3036
    def _get_branch_formats_to_test():
 
3037
        """Return a tuple with the Branch formats to use when testing."""
 
3038
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3277
3039
 
3278
 
    @needs_write_lock
3279
3040
    def pull(self, overwrite=False, stop_revision=None,
3280
3041
             possible_transports=None, local=False):
3281
3042
        """Mirror source into target branch.
3286
3047
        """
3287
3048
        raise NotImplementedError(self.pull)
3288
3049
 
3289
 
    @needs_write_lock
3290
3050
    def update_revisions(self, stop_revision=None, overwrite=False,
3291
3051
                         graph=None):
3292
3052
        """Pull in new perfect-fit revisions.
3300
3060
        """
3301
3061
        raise NotImplementedError(self.update_revisions)
3302
3062
 
3303
 
    @needs_write_lock
3304
3063
    def push(self, overwrite=False, stop_revision=None,
3305
3064
             _override_hook_source_branch=None):
3306
3065
        """Mirror the source branch into the target branch.
3309
3068
        """
3310
3069
        raise NotImplementedError(self.push)
3311
3070
 
3312
 
    @needs_write_lock
3313
 
    def copy_content_into(self, revision_id=None):
3314
 
        """Copy the content of source into target
3315
 
 
3316
 
        revision_id: if not None, the revision history in the new branch will
3317
 
                     be truncated to end with revision_id.
3318
 
        """
3319
 
        raise NotImplementedError(self.copy_content_into)
3320
 
 
3321
3071
 
3322
3072
class GenericInterBranch(InterBranch):
3323
 
    """InterBranch implementation that uses public Branch functions."""
3324
 
 
3325
 
    @classmethod
3326
 
    def is_compatible(klass, source, target):
3327
 
        # GenericBranch uses the public API, so always compatible
3328
 
        return True
3329
 
 
3330
 
    @classmethod
3331
 
    def _get_branch_formats_to_test(klass):
3332
 
        return [(BranchFormat._default_format, BranchFormat._default_format)]
3333
 
 
3334
 
    @classmethod
3335
 
    def unwrap_format(klass, format):
3336
 
        if isinstance(format, remote.RemoteBranchFormat):
3337
 
            format._ensure_real()
3338
 
            return format._custom_format
3339
 
        return format                                                                                                  
3340
 
 
3341
 
    @needs_write_lock
3342
 
    def copy_content_into(self, revision_id=None):
3343
 
        """Copy the content of source into target
3344
 
 
3345
 
        revision_id: if not None, the revision history in the new branch will
3346
 
                     be truncated to end with revision_id.
3347
 
        """
3348
 
        self.source.update_references(self.target)
3349
 
        self.source._synchronize_history(self.target, revision_id)
3350
 
        try:
3351
 
            parent = self.source.get_parent()
3352
 
        except errors.InaccessibleParent, e:
3353
 
            mutter('parent was not accessible to copy: %s', e)
3354
 
        else:
3355
 
            if parent:
3356
 
                self.target.set_parent(parent)
3357
 
        if self.source._push_should_merge_tags():
3358
 
            self.source.tags.merge_to(self.target.tags)
3359
 
 
3360
 
    @needs_write_lock
 
3073
    """InterBranch implementation that uses public Branch functions.
 
3074
    """
 
3075
 
 
3076
    @staticmethod
 
3077
    def _get_branch_formats_to_test():
 
3078
        return BranchFormat._default_format, BranchFormat._default_format
 
3079
 
3361
3080
    def update_revisions(self, stop_revision=None, overwrite=False,
3362
3081
        graph=None):
3363
3082
        """See InterBranch.update_revisions()."""
3364
 
        other_revno, other_last_revision = self.source.last_revision_info()
3365
 
        stop_revno = None # unknown
3366
 
        if stop_revision is None:
3367
 
            stop_revision = other_last_revision
3368
 
            if _mod_revision.is_null(stop_revision):
3369
 
                # if there are no commits, we're done.
3370
 
                return
3371
 
            stop_revno = other_revno
3372
 
 
3373
 
        # what's the current last revision, before we fetch [and change it
3374
 
        # possibly]
3375
 
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
3376
 
        # we fetch here so that we don't process data twice in the common
3377
 
        # case of having something to pull, and so that the check for
3378
 
        # already merged can operate on the just fetched graph, which will
3379
 
        # be cached in memory.
3380
 
        self.target.fetch(self.source, stop_revision)
3381
 
        # Check to see if one is an ancestor of the other
3382
 
        if not overwrite:
3383
 
            if graph is None:
3384
 
                graph = self.target.repository.get_graph()
3385
 
            if self.target._check_if_descendant_or_diverged(
3386
 
                    stop_revision, last_rev, graph, self.source):
3387
 
                # stop_revision is a descendant of last_rev, but we aren't
3388
 
                # overwriting, so we're done.
3389
 
                return
3390
 
        if stop_revno is None:
3391
 
            if graph is None:
3392
 
                graph = self.target.repository.get_graph()
3393
 
            this_revno, this_last_revision = \
3394
 
                    self.target.last_revision_info()
3395
 
            stop_revno = graph.find_distance_to_null(stop_revision,
3396
 
                            [(other_last_revision, other_revno),
3397
 
                             (this_last_revision, this_revno)])
3398
 
        self.target.set_last_revision_info(stop_revno, stop_revision)
3399
 
 
3400
 
    @needs_write_lock
 
3083
        self.source.lock_read()
 
3084
        try:
 
3085
            other_revno, other_last_revision = self.source.last_revision_info()
 
3086
            stop_revno = None # unknown
 
3087
            if stop_revision is None:
 
3088
                stop_revision = other_last_revision
 
3089
                if _mod_revision.is_null(stop_revision):
 
3090
                    # if there are no commits, we're done.
 
3091
                    return
 
3092
                stop_revno = other_revno
 
3093
 
 
3094
            # what's the current last revision, before we fetch [and change it
 
3095
            # possibly]
 
3096
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3097
            # we fetch here so that we don't process data twice in the common
 
3098
            # case of having something to pull, and so that the check for
 
3099
            # already merged can operate on the just fetched graph, which will
 
3100
            # be cached in memory.
 
3101
            self.target.fetch(self.source, stop_revision)
 
3102
            # Check to see if one is an ancestor of the other
 
3103
            if not overwrite:
 
3104
                if graph is None:
 
3105
                    graph = self.target.repository.get_graph()
 
3106
                if self.target._check_if_descendant_or_diverged(
 
3107
                        stop_revision, last_rev, graph, self.source):
 
3108
                    # stop_revision is a descendant of last_rev, but we aren't
 
3109
                    # overwriting, so we're done.
 
3110
                    return
 
3111
            if stop_revno is None:
 
3112
                if graph is None:
 
3113
                    graph = self.target.repository.get_graph()
 
3114
                this_revno, this_last_revision = \
 
3115
                        self.target.last_revision_info()
 
3116
                stop_revno = graph.find_distance_to_null(stop_revision,
 
3117
                                [(other_last_revision, other_revno),
 
3118
                                 (this_last_revision, this_revno)])
 
3119
            self.target.set_last_revision_info(stop_revno, stop_revision)
 
3120
        finally:
 
3121
            self.source.unlock()
 
3122
 
3401
3123
    def pull(self, overwrite=False, stop_revision=None,
3402
 
             possible_transports=None, run_hooks=True,
 
3124
             possible_transports=None, _hook_master=None, run_hooks=True,
3403
3125
             _override_hook_target=None, local=False):
3404
 
        """Pull from source into self, updating my master if any.
 
3126
        """See Branch.pull.
3405
3127
 
 
3128
        :param _hook_master: Private parameter - set the branch to
 
3129
            be supplied as the master to pull hooks.
3406
3130
        :param run_hooks: Private parameter - if false, this branch
3407
3131
            is being called because it's the master of the primary branch,
3408
3132
            so it should not run its hooks.
 
3133
        :param _override_hook_target: Private parameter - set the branch to be
 
3134
            supplied as the target_branch to pull hooks.
 
3135
        :param local: Only update the local branch, and not the bound branch.
3409
3136
        """
3410
 
        bound_location = self.target.get_bound_location()
3411
 
        if local and not bound_location:
 
3137
        # This type of branch can't be bound.
 
3138
        if local:
3412
3139
            raise errors.LocalRequiresBoundBranch()
3413
 
        master_branch = None
3414
 
        if not local and bound_location and self.source.user_url != bound_location:
3415
 
            # not pulling from master, so we need to update master.
3416
 
            master_branch = self.target.get_master_branch(possible_transports)
3417
 
            master_branch.lock_write()
 
3140
        result = PullResult()
 
3141
        result.source_branch = self.source
 
3142
        if _override_hook_target is None:
 
3143
            result.target_branch = self.target
 
3144
        else:
 
3145
            result.target_branch = _override_hook_target
 
3146
        self.source.lock_read()
3418
3147
        try:
3419
 
            if master_branch:
3420
 
                # pull from source into master.
3421
 
                master_branch.pull(self.source, overwrite, stop_revision,
3422
 
                    run_hooks=False)
3423
 
            return self._pull(overwrite,
3424
 
                stop_revision, _hook_master=master_branch,
3425
 
                run_hooks=run_hooks,
3426
 
                _override_hook_target=_override_hook_target)
 
3148
            # We assume that during 'pull' the target repository is closer than
 
3149
            # the source one.
 
3150
            self.source.update_references(self.target)
 
3151
            graph = self.target.repository.get_graph(self.source.repository)
 
3152
            # TODO: Branch formats should have a flag that indicates 
 
3153
            # that revno's are expensive, and pull() should honor that flag.
 
3154
            # -- JRV20090506
 
3155
            result.old_revno, result.old_revid = \
 
3156
                self.target.last_revision_info()
 
3157
            self.target.update_revisions(self.source, stop_revision,
 
3158
                overwrite=overwrite, graph=graph)
 
3159
            # TODO: The old revid should be specified when merging tags, 
 
3160
            # so a tags implementation that versions tags can only 
 
3161
            # pull in the most recent changes. -- JRV20090506
 
3162
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3163
                overwrite)
 
3164
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3165
            if _hook_master:
 
3166
                result.master_branch = _hook_master
 
3167
                result.local_branch = result.target_branch
 
3168
            else:
 
3169
                result.master_branch = result.target_branch
 
3170
                result.local_branch = None
 
3171
            if run_hooks:
 
3172
                for hook in Branch.hooks['post_pull']:
 
3173
                    hook(result)
3427
3174
        finally:
3428
 
            if master_branch:
3429
 
                master_branch.unlock()
 
3175
            self.source.unlock()
 
3176
        return result
3430
3177
 
3431
3178
    def push(self, overwrite=False, stop_revision=None,
3432
3179
             _override_hook_source_branch=None):
3494
3241
            _run_hooks()
3495
3242
            return result
3496
3243
 
3497
 
    def _pull(self, overwrite=False, stop_revision=None,
3498
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3244
    @classmethod
 
3245
    def is_compatible(self, source, target):
 
3246
        # GenericBranch uses the public API, so always compatible
 
3247
        return True
 
3248
 
 
3249
 
 
3250
class InterToBranch5(GenericInterBranch):
 
3251
 
 
3252
    @staticmethod
 
3253
    def _get_branch_formats_to_test():
 
3254
        return BranchFormat._default_format, BzrBranchFormat5()
 
3255
 
 
3256
    def pull(self, overwrite=False, stop_revision=None,
 
3257
             possible_transports=None, run_hooks=True,
3499
3258
             _override_hook_target=None, local=False):
3500
 
        """See Branch.pull.
3501
 
 
3502
 
        This function is the core worker, used by GenericInterBranch.pull to
3503
 
        avoid duplication when pulling source->master and source->local.
3504
 
 
3505
 
        :param _hook_master: Private parameter - set the branch to
3506
 
            be supplied as the master to pull hooks.
 
3259
        """Pull from source into self, updating my master if any.
 
3260
 
3507
3261
        :param run_hooks: Private parameter - if false, this branch
3508
3262
            is being called because it's the master of the primary branch,
3509
3263
            so it should not run its hooks.
3510
 
        :param _override_hook_target: Private parameter - set the branch to be
3511
 
            supplied as the target_branch to pull hooks.
3512
 
        :param local: Only update the local branch, and not the bound branch.
3513
3264
        """
3514
 
        # This type of branch can't be bound.
3515
 
        if local:
 
3265
        bound_location = self.target.get_bound_location()
 
3266
        if local and not bound_location:
3516
3267
            raise errors.LocalRequiresBoundBranch()
3517
 
        result = PullResult()
3518
 
        result.source_branch = self.source
3519
 
        if _override_hook_target is None:
3520
 
            result.target_branch = self.target
3521
 
        else:
3522
 
            result.target_branch = _override_hook_target
3523
 
        self.source.lock_read()
 
3268
        master_branch = None
 
3269
        if not local and bound_location and self.source.user_url != bound_location:
 
3270
            # not pulling from master, so we need to update master.
 
3271
            master_branch = self.target.get_master_branch(possible_transports)
 
3272
            master_branch.lock_write()
3524
3273
        try:
3525
 
            # We assume that during 'pull' the target repository is closer than
3526
 
            # the source one.
3527
 
            self.source.update_references(self.target)
3528
 
            graph = self.target.repository.get_graph(self.source.repository)
3529
 
            # TODO: Branch formats should have a flag that indicates 
3530
 
            # that revno's are expensive, and pull() should honor that flag.
3531
 
            # -- JRV20090506
3532
 
            result.old_revno, result.old_revid = \
3533
 
                self.target.last_revision_info()
3534
 
            self.target.update_revisions(self.source, stop_revision,
3535
 
                overwrite=overwrite, graph=graph)
3536
 
            # TODO: The old revid should be specified when merging tags, 
3537
 
            # so a tags implementation that versions tags can only 
3538
 
            # pull in the most recent changes. -- JRV20090506
3539
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3540
 
                overwrite)
3541
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3542
 
            if _hook_master:
3543
 
                result.master_branch = _hook_master
3544
 
                result.local_branch = result.target_branch
3545
 
            else:
3546
 
                result.master_branch = result.target_branch
3547
 
                result.local_branch = None
3548
 
            if run_hooks:
3549
 
                for hook in Branch.hooks['post_pull']:
3550
 
                    hook(result)
 
3274
            if master_branch:
 
3275
                # pull from source into master.
 
3276
                master_branch.pull(self.source, overwrite, stop_revision,
 
3277
                    run_hooks=False)
 
3278
            return super(InterToBranch5, self).pull(overwrite,
 
3279
                stop_revision, _hook_master=master_branch,
 
3280
                run_hooks=run_hooks,
 
3281
                _override_hook_target=_override_hook_target)
3551
3282
        finally:
3552
 
            self.source.unlock()
3553
 
        return result
 
3283
            if master_branch:
 
3284
                master_branch.unlock()
3554
3285
 
3555
3286
 
3556
3287
InterBranch.register_optimiser(GenericInterBranch)
 
3288
InterBranch.register_optimiser(InterToBranch5)