49
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
50
from bzrlib.hooks import HookPoint, Hooks
51
51
from bzrlib.inter import InterObject
52
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
52
from bzrlib.lock import _RelockDebugMixin
53
53
from bzrlib import registry
54
54
from bzrlib.symbol_versioning import (
63
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
66
class Branch(bzrdir.ControlComponent):
66
# TODO: Maybe include checks for common corruption of newlines, etc?
68
# TODO: Some operations like log might retrieve the same revisions
69
# repeatedly to calculate deltas. We could perhaps have a weakref
70
# cache in memory to make this faster. In general anything can be
71
# cached in memory between lock and unlock operations. .. nb thats
72
# what the transaction identity map provides
75
######################################################################
67
79
"""Branch holding a history of revisions.
70
Base directory/url of the branch; using control_url and
71
control_transport is more standardized.
82
Base directory/url of the branch.
73
84
hooks: An instance of BranchHooks.
283
286
new_history.reverse()
284
287
return new_history
286
def lock_write(self, token=None):
287
"""Lock the branch for write operations.
289
:param token: A token to permit reacquiring a previously held and
291
:return: A BranchWriteLockResult.
289
def lock_write(self):
293
290
raise NotImplementedError(self.lock_write)
295
292
def lock_read(self):
296
"""Lock the branch for read operations.
298
:return: A bzrlib.lock.LogicalLockResult.
300
293
raise NotImplementedError(self.lock_read)
302
295
def unlock(self):
427
420
* 'include' - the stop revision is the last item in the result
428
421
* 'with-merges' - include the stop revision and all of its
429
422
merged revisions in the result
430
* 'with-merges-without-common-ancestry' - filter out revisions
431
that are in both ancestries
432
423
:param direction: either 'reverse' or 'forward':
433
424
* reverse means return the start_revision_id first, i.e.
434
425
start at the most recent revision and go backwards in history
456
447
# start_revision_id.
457
448
if self._merge_sorted_revisions_cache is None:
458
449
last_revision = self.last_revision()
459
known_graph = self.repository.get_known_graph_ancestry(
450
last_key = (last_revision,)
451
known_graph = self.repository.revisions.get_known_graph_ancestry(
461
453
self._merge_sorted_revisions_cache = known_graph.merge_sort(
463
455
filtered = self._filter_merge_sorted_revisions(
464
456
self._merge_sorted_revisions_cache, start_revision_id,
465
457
stop_revision_id, stop_rule)
466
# Make sure we don't return revisions that are not part of the
467
# start_revision_id ancestry.
468
filtered = self._filter_start_non_ancestors(filtered)
469
458
if direction == 'reverse':
471
460
if direction == 'forward':
508
497
node.end_of_merge)
509
498
if rev_id == stop_revision_id:
511
elif stop_rule == 'with-merges-without-common-ancestry':
512
# We want to exclude all revisions that are already part of the
513
# stop_revision_id ancestry.
514
graph = self.repository.get_graph()
515
ancestors = graph.find_unique_ancestors(start_revision_id,
517
for node in rev_iter:
518
rev_id = node.key[-1]
519
if rev_id not in ancestors:
521
yield (rev_id, node.merge_depth, node.revno,
523
500
elif stop_rule == 'with-merges':
524
501
stop_rev = self.repository.get_revision(stop_revision_id)
525
502
if stop_rev.parent_ids:
549
526
raise ValueError('invalid stop_rule %r' % stop_rule)
551
def _filter_start_non_ancestors(self, rev_iter):
552
# If we started from a dotted revno, we want to consider it as a tip
553
# and don't want to yield revisions that are not part of its
554
# ancestry. Given the order guaranteed by the merge sort, we will see
555
# uninteresting descendants of the first parent of our tip before the
557
first = rev_iter.next()
558
(rev_id, merge_depth, revno, end_of_merge) = first
561
# We start at a mainline revision so by definition, all others
562
# revisions in rev_iter are ancestors
563
for node in rev_iter:
568
pmap = self.repository.get_parent_map([rev_id])
569
parents = pmap.get(rev_id, [])
571
whitelist.update(parents)
573
# If there is no parents, there is nothing of interest left
575
# FIXME: It's hard to test this scenario here as this code is never
576
# called in that case. -- vila 20100322
579
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
581
if rev_id in whitelist:
582
pmap = self.repository.get_parent_map([rev_id])
583
parents = pmap.get(rev_id, [])
584
whitelist.remove(rev_id)
585
whitelist.update(parents)
587
# We've reached the mainline, there is nothing left to
591
# A revision that is not part of the ancestry of our
594
yield (rev_id, merge_depth, revno, end_of_merge)
596
528
def leave_lock_in_place(self):
597
529
"""Tell this branch object not to release the physical lock when this
598
530
object is unlocked.
673
605
def get_old_bound_location(self):
674
606
"""Return the URL of the branch we used to be bound to
676
raise errors.UpgradeRequired(self.user_url)
608
raise errors.UpgradeRequired(self.base)
678
610
def get_commit_builder(self, parents, config=None, timestamp=None,
679
611
timezone=None, committer=None, revprops=None,
1436
1366
def supports_tags(self):
1437
1367
return self._format.supports_tags()
1439
def automatic_tag_name(self, revision_id):
1440
"""Try to automatically find the tag name for a revision.
1442
:param revision_id: Revision id of the revision.
1443
:return: A tag name or None if no tag name could be determined.
1445
for hook in Branch.hooks['automatic_tag_name']:
1446
ret = hook(self, revision_id)
1451
1369
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1453
1371
"""Ensure that revision_b is a descendant of revision_a.
1541
1459
in a_bzrdir is correct.
1543
1461
:param a_bzrdir: The bzrdir to get the branch data from.
1544
:param name: Name of the colocated branch to fetch
1545
1462
:return: None if the branch is not a reference branch.
1550
def set_reference(self, a_bzrdir, name, to_branch):
1467
def set_reference(self, a_bzrdir, to_branch):
1551
1468
"""Set the target reference of the branch in a_bzrdir.
1553
1470
format probing must have been completed before calling
1568
1484
"""Return the short format description for this format."""
1569
1485
raise NotImplementedError(self.get_format_description)
1571
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1572
hooks = Branch.hooks['post_branch_init']
1575
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1579
1487
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1580
1488
lock_type='metadir', set_format=True):
1581
1489
"""Initialize a branch in a bzrdir, with specified files
1619
1527
control_files.unlock()
1620
branch = self.open(a_bzrdir, name, _found=True)
1621
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1528
return self.open(a_bzrdir, name, _found=True)
1624
1530
def initialize(self, a_bzrdir, name=None):
1625
1531
"""Create a branch of this format in a_bzrdir.
1779
1685
"multiple hooks installed for transform_fallback_location, "
1780
1686
"all are called with the url returned from the previous hook."
1781
1687
"The order is however undefined.", (1, 9), None))
1782
self.create_hook(HookPoint('automatic_tag_name',
1783
"Called to determine an automatic tag name for a revision."
1784
"automatic_tag_name is called with (branch, revision_id) and "
1785
"should return a tag name or None if no tag name could be "
1786
"determined. The first non-None tag name returned will be used.",
1788
self.create_hook(HookPoint('post_branch_init',
1789
"Called after new branch initialization completes. "
1790
"post_branch_init is called with a "
1791
"bzrlib.branch.BranchInitHookParams. "
1792
"Note that init, branch and checkout (both heavyweight and "
1793
"lightweight) will all trigger this hook.", (2, 2), None))
1794
self.create_hook(HookPoint('post_switch',
1795
"Called after a checkout switches branch. "
1796
"post_switch is called with a "
1797
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1801
1690
# install the default hooks into the Branch class.
1840
1729
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1843
class BranchInitHookParams(object):
1844
"""Object holding parameters passed to *_branch_init hooks.
1846
There are 4 fields that hooks may wish to access:
1848
:ivar format: the branch format
1849
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1850
:ivar name: name of colocated branch, if any (or None)
1851
:ivar branch: the branch created
1853
Note that for lightweight checkouts, the bzrdir and format fields refer to
1854
the checkout, hence they are different from the corresponding fields in
1855
branch, which refer to the original branch.
1858
def __init__(self, format, a_bzrdir, name, branch):
1859
"""Create a group of BranchInitHook parameters.
1861
:param format: the branch format
1862
:param a_bzrdir: the BzrDir where the branch will be/has been
1864
:param name: name of colocated branch, if any (or None)
1865
:param branch: the branch created
1867
Note that for lightweight checkouts, the bzrdir and format fields refer
1868
to the checkout, hence they are different from the corresponding fields
1869
in branch, which refer to the original branch.
1871
self.format = format
1872
self.bzrdir = a_bzrdir
1874
self.branch = branch
1876
def __eq__(self, other):
1877
return self.__dict__ == other.__dict__
1881
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1883
return "<%s of format:%s bzrdir:%s>" % (
1884
self.__class__.__name__, self.branch,
1885
self.format, self.bzrdir)
1888
class SwitchHookParams(object):
1889
"""Object holding parameters passed to *_switch hooks.
1891
There are 4 fields that hooks may wish to access:
1893
:ivar control_dir: BzrDir of the checkout to change
1894
:ivar to_branch: branch that the checkout is to reference
1895
:ivar force: skip the check for local commits in a heavy checkout
1896
:ivar revision_id: revision ID to switch to (or None)
1899
def __init__(self, control_dir, to_branch, force, revision_id):
1900
"""Create a group of SwitchHook parameters.
1902
:param control_dir: BzrDir of the checkout to change
1903
:param to_branch: branch that the checkout is to reference
1904
:param force: skip the check for local commits in a heavy checkout
1905
:param revision_id: revision ID to switch to (or None)
1907
self.control_dir = control_dir
1908
self.to_branch = to_branch
1910
self.revision_id = revision_id
1912
def __eq__(self, other):
1913
return self.__dict__ == other.__dict__
1916
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1917
self.control_dir, self.to_branch,
1921
1732
class BzrBranchFormat4(BranchFormat):
1922
1733
"""Bzr branch format 4.
1949
1760
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1950
1761
"""See BranchFormat.open()."""
1762
if name is not None:
1763
raise errors.NoColocatedBranchSupport(a_bzrdir)
1952
1765
# we are being called directly and must probe.
1953
1766
raise NotImplementedError
1954
1767
return BzrBranch(_format=self,
1955
1768
_control_files=a_bzrdir._control_files,
1956
1769
a_bzrdir=a_bzrdir,
1958
1770
_repository=a_bzrdir.open_repository())
1960
1772
def __str__(self):
1982
1794
if format.__class__ != self.__class__:
1983
1795
raise AssertionError("wrong format %r found for %r" %
1984
1796
(format, self))
1985
transport = a_bzrdir.get_branch_transport(None, name=name)
1798
transport = a_bzrdir.get_branch_transport(None, name=name)
1987
1799
control_files = lockable_files.LockableFiles(transport, 'lock',
1988
1800
lockdir.LockDir)
1989
1801
return self._branch_class()(_format=self,
1990
1802
_control_files=control_files,
1992
1803
a_bzrdir=a_bzrdir,
1993
1804
_repository=a_bzrdir.find_repository(),
1994
1805
ignore_fallbacks=ignore_fallbacks)
2171
1982
"""See BranchFormat.get_format_description()."""
2172
1983
return "Checkout reference format 1"
2174
def get_reference(self, a_bzrdir, name=None):
1985
def get_reference(self, a_bzrdir):
2175
1986
"""See BranchFormat.get_reference()."""
2176
transport = a_bzrdir.get_branch_transport(None, name=name)
1987
transport = a_bzrdir.get_branch_transport(None)
2177
1988
return transport.get_bytes('location')
2179
def set_reference(self, a_bzrdir, name, to_branch):
1990
def set_reference(self, a_bzrdir, to_branch):
2180
1991
"""See BranchFormat.set_reference()."""
2181
transport = a_bzrdir.get_branch_transport(None, name=name)
1992
transport = a_bzrdir.get_branch_transport(None)
2182
1993
location = transport.put_bytes('location', to_branch.base)
2184
1995
def initialize(self, a_bzrdir, name=None, target_branch=None):
2187
1998
# this format does not implement branch itself, thus the implicit
2188
1999
# creation contract must see it as uninitializable
2189
2000
raise errors.UninitializableFormat(self)
2190
mutter('creating branch reference in %s', a_bzrdir.user_url)
2001
mutter('creating branch reference in %s', a_bzrdir.transport.base)
2191
2002
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2192
2003
branch_transport.put_bytes('location',
2193
target_branch.bzrdir.user_url)
2004
target_branch.bzrdir.root_transport.base)
2194
2005
branch_transport.put_bytes('format', self.get_format_string())
2196
2007
a_bzrdir, name, _found=True,
2197
2008
possible_transports=[target_branch.bzrdir.root_transport])
2198
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2201
2010
def __init__(self):
2202
2011
super(BranchReferenceFormat, self).__init__()
2279
2088
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2282
class BranchWriteLockResult(LogicalLockResult):
2283
"""The result of write locking a branch.
2285
:ivar branch_token: The token obtained from the underlying branch lock, or
2287
:ivar unlock: A callable which will unlock the lock.
2290
def __init__(self, unlock, branch_token):
2291
LogicalLockResult.__init__(self, unlock)
2292
self.branch_token = branch_token
2295
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2299
2091
class BzrBranch(Branch, _RelockDebugMixin):
2300
2092
"""A branch stored in the actual filesystem.
2308
2100
:ivar repository: Repository for this branch.
2309
2101
:ivar base: The url of the base directory for this branch; the one
2310
2102
containing the .bzr directory.
2311
:ivar name: Optional colocated branch name as it exists in the control
2315
2105
def __init__(self, _format=None,
2316
_control_files=None, a_bzrdir=None, name=None,
2317
_repository=None, ignore_fallbacks=False):
2106
_control_files=None, a_bzrdir=None, _repository=None,
2107
ignore_fallbacks=False):
2318
2108
"""Create new branch object at a particular location."""
2319
2109
if a_bzrdir is None:
2320
2110
raise ValueError('a_bzrdir must be supplied')
2322
2112
self.bzrdir = a_bzrdir
2323
2113
self._base = self.bzrdir.transport.clone('..').base
2325
2114
# XXX: We should be able to just do
2326
2115
# self.base = self.bzrdir.root_transport.base
2327
2116
# but this does not quite work yet -- mbp 20080522
2873
2646
if branch_location is None:
2874
2647
return Branch.reference_parent(self, file_id, path,
2875
2648
possible_transports)
2876
branch_location = urlutils.join(self.user_url, branch_location)
2649
branch_location = urlutils.join(self.base, branch_location)
2877
2650
return Branch.open(branch_location,
2878
2651
possible_transports=possible_transports)