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.
165
168
control = bzrdir.BzrDir.open(base, _unsupported,
166
169
possible_transports=possible_transports)
167
return control.open_branch(unsupported=_unsupported)
170
return control.open_branch(_unsupported)
170
def open_from_transport(transport, name=None, _unsupported=False):
173
def open_from_transport(transport, _unsupported=False):
171
174
"""Open the branch rooted at transport"""
172
175
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
return control.open_branch(name=name, unsupported=_unsupported)
176
return control.open_branch(_unsupported)
176
179
def open_containing(url, possible_transports=None):
214
217
def _get_fallback_repository(self, url):
215
218
"""Get the repository we fallback to at url."""
216
219
url = urlutils.join(self.base, url)
217
a_branch = Branch.open(url,
220
a_bzrdir = bzrdir.BzrDir.open(url,
218
221
possible_transports=[self.bzrdir.root_transport])
219
return a_branch.repository
222
return a_bzrdir.open_branch().repository
221
224
def _get_tags_bytes(self):
222
225
"""Get the bytes of a serialised tags dict.
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,
1434
1365
def supports_tags(self):
1435
1366
return self._format.supports_tags()
1437
def automatic_tag_name(self, revision_id):
1438
"""Try to automatically find the tag name for a revision.
1440
:param revision_id: Revision id of the revision.
1441
:return: A tag name or None if no tag name could be determined.
1443
for hook in Branch.hooks['automatic_tag_name']:
1444
ret = hook(self, revision_id)
1449
1368
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1451
1370
"""Ensure that revision_b is a descendant of revision_a.
1515
1434
return not (self == other)
1518
def find_format(klass, a_bzrdir, name=None):
1437
def find_format(klass, a_bzrdir):
1519
1438
"""Return the format for the branch object in a_bzrdir."""
1521
transport = a_bzrdir.get_branch_transport(None, name=name)
1440
transport = a_bzrdir.get_branch_transport(None)
1522
1441
format_string = transport.get_bytes("format")
1523
1442
return klass._formats[format_string]
1524
1443
except errors.NoSuchFile:
1564
1483
"""Return the short format description for this format."""
1565
1484
raise NotImplementedError(self.get_format_description)
1567
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1568
hooks = Branch.hooks['post_branch_init']
1571
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1575
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1576
lock_type='metadir', set_format=True):
1486
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1577
1488
"""Initialize a branch in a bzrdir, with specified files
1579
1490
:param a_bzrdir: The bzrdir to initialize the branch in
1580
1491
:param utf8_files: The files to create as a list of
1581
1492
(filename, content) tuples
1582
:param name: Name of colocated branch to create, if any
1583
1493
:param set_format: If True, set the format with
1584
1494
self.get_format_string. (BzrBranch4 has its format set
1586
1496
:return: a branch in this format
1588
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1589
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1498
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1499
branch_transport = a_bzrdir.get_branch_transport(self)
1591
1501
'metadir': ('lock', lockdir.LockDir),
1592
1502
'branch4': ('branch-lock', lockable_files.TransportLock),
1615
1525
control_files.unlock()
1616
branch = self.open(a_bzrdir, name, _found=True)
1617
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1526
return self.open(a_bzrdir, _found=True)
1620
def initialize(self, a_bzrdir, name=None):
1621
"""Create a branch of this format in a_bzrdir.
1623
:param name: Name of the colocated branch to create.
1528
def initialize(self, a_bzrdir):
1529
"""Create a branch of this format in a_bzrdir."""
1625
1530
raise NotImplementedError(self.initialize)
1627
1532
def is_supported(self):
1658
1563
raise NotImplementedError(self.network_name)
1660
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1565
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1661
1566
"""Return the branch object for a_bzrdir
1663
1568
:param a_bzrdir: A BzrDir that contains a branch.
1664
:param name: Name of colocated branch to open
1665
1569
:param _found: a private parameter, do not use it. It is used to
1666
1570
indicate if format probing has already be done.
1667
1571
:param ignore_fallbacks: when set, no fallback branches will be opened
1775
1679
"multiple hooks installed for transform_fallback_location, "
1776
1680
"all are called with the url returned from the previous hook."
1777
1681
"The order is however undefined.", (1, 9), None))
1778
self.create_hook(HookPoint('automatic_tag_name',
1779
"Called to determine an automatic tag name for a revision."
1780
"automatic_tag_name is called with (branch, revision_id) and "
1781
"should return a tag name or None if no tag name could be "
1782
"determined. The first non-None tag name returned will be used.",
1784
self.create_hook(HookPoint('post_branch_init',
1785
"Called after new branch initialization completes. "
1786
"post_branch_init is called with a "
1787
"bzrlib.branch.BranchInitHookParams. "
1788
"Note that init, branch and checkout (both heavyweight and "
1789
"lightweight) will all trigger this hook.", (2, 2), None))
1790
self.create_hook(HookPoint('post_switch',
1791
"Called after a checkout switches branch. "
1792
"post_switch is called with a "
1793
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1797
1684
# install the default hooks into the Branch class.
1836
1723
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1839
class BranchInitHookParams(object):
1840
"""Object holding parameters passed to *_branch_init hooks.
1842
There are 4 fields that hooks may wish to access:
1844
:ivar format: the branch format
1845
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1846
:ivar name: name of colocated branch, if any (or None)
1847
:ivar branch: the branch created
1849
Note that for lightweight checkouts, the bzrdir and format fields refer to
1850
the checkout, hence they are different from the corresponding fields in
1851
branch, which refer to the original branch.
1854
def __init__(self, format, a_bzrdir, name, branch):
1855
"""Create a group of BranchInitHook parameters.
1857
:param format: the branch format
1858
:param a_bzrdir: the BzrDir where the branch will be/has been
1860
:param name: name of colocated branch, if any (or None)
1861
:param branch: the branch created
1863
Note that for lightweight checkouts, the bzrdir and format fields refer
1864
to the checkout, hence they are different from the corresponding fields
1865
in branch, which refer to the original branch.
1867
self.format = format
1868
self.bzrdir = a_bzrdir
1870
self.branch = branch
1872
def __eq__(self, other):
1873
return self.__dict__ == other.__dict__
1877
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1879
return "<%s of format:%s bzrdir:%s>" % (
1880
self.__class__.__name__, self.branch,
1881
self.format, self.bzrdir)
1884
class SwitchHookParams(object):
1885
"""Object holding parameters passed to *_switch hooks.
1887
There are 4 fields that hooks may wish to access:
1889
:ivar control_dir: BzrDir of the checkout to change
1890
:ivar to_branch: branch that the checkout is to reference
1891
:ivar force: skip the check for local commits in a heavy checkout
1892
:ivar revision_id: revision ID to switch to (or None)
1895
def __init__(self, control_dir, to_branch, force, revision_id):
1896
"""Create a group of SwitchHook parameters.
1898
:param control_dir: BzrDir of the checkout to change
1899
:param to_branch: branch that the checkout is to reference
1900
:param force: skip the check for local commits in a heavy checkout
1901
:param revision_id: revision ID to switch to (or None)
1903
self.control_dir = control_dir
1904
self.to_branch = to_branch
1906
self.revision_id = revision_id
1908
def __eq__(self, other):
1909
return self.__dict__ == other.__dict__
1912
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1913
self.control_dir, self.to_branch,
1917
1726
class BzrBranchFormat4(BranchFormat):
1918
1727
"""Bzr branch format 4.
1926
1735
"""See BranchFormat.get_format_description()."""
1927
1736
return "Branch format 4"
1929
def initialize(self, a_bzrdir, name=None):
1738
def initialize(self, a_bzrdir):
1930
1739
"""Create a branch of this format in a_bzrdir."""
1931
1740
utf8_files = [('revision-history', ''),
1932
1741
('branch-name', ''),
1934
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1743
return self._initialize_helper(a_bzrdir, utf8_files,
1935
1744
lock_type='branch4', set_format=False)
1937
1746
def __init__(self):
1942
1751
"""The network name for this format is the control dirs disk label."""
1943
1752
return self._matchingbzrdir.get_format_string()
1945
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1754
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1946
1755
"""See BranchFormat.open()."""
1948
1757
# we are being called directly and must probe.
1972
1780
return self.get_format_string()
1974
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1782
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1975
1783
"""See BranchFormat.open()."""
1977
format = BranchFormat.find_format(a_bzrdir, name=name)
1785
format = BranchFormat.find_format(a_bzrdir)
1978
1786
if format.__class__ != self.__class__:
1979
1787
raise AssertionError("wrong format %r found for %r" %
1980
1788
(format, self))
1981
transport = a_bzrdir.get_branch_transport(None, name=name)
1790
transport = a_bzrdir.get_branch_transport(None)
1983
1791
control_files = lockable_files.LockableFiles(transport, 'lock',
1984
1792
lockdir.LockDir)
1985
1793
return self._branch_class()(_format=self,
1986
1794
_control_files=control_files,
1988
1795
a_bzrdir=a_bzrdir,
1989
1796
_repository=a_bzrdir.find_repository(),
1990
1797
ignore_fallbacks=ignore_fallbacks)
2024
1831
"""See BranchFormat.get_format_description()."""
2025
1832
return "Branch format 5"
2027
def initialize(self, a_bzrdir, name=None):
1834
def initialize(self, a_bzrdir):
2028
1835
"""Create a branch of this format in a_bzrdir."""
2029
1836
utf8_files = [('revision-history', ''),
2030
1837
('branch-name', ''),
2032
return self._initialize_helper(a_bzrdir, utf8_files, name)
1839
return self._initialize_helper(a_bzrdir, utf8_files)
2034
1841
def supports_tags(self):
2057
1864
"""See BranchFormat.get_format_description()."""
2058
1865
return "Branch format 6"
2060
def initialize(self, a_bzrdir, name=None):
1867
def initialize(self, a_bzrdir):
2061
1868
"""Create a branch of this format in a_bzrdir."""
2062
1869
utf8_files = [('last-revision', '0 null:\n'),
2063
1870
('branch.conf', ''),
2066
return self._initialize_helper(a_bzrdir, utf8_files, name)
1873
return self._initialize_helper(a_bzrdir, utf8_files)
2068
1875
def make_tags(self, branch):
2069
1876
"""See bzrlib.branch.BranchFormat.make_tags()."""
2087
1894
"""See BranchFormat.get_format_description()."""
2088
1895
return "Branch format 8"
2090
def initialize(self, a_bzrdir, name=None):
1897
def initialize(self, a_bzrdir):
2091
1898
"""Create a branch of this format in a_bzrdir."""
2092
1899
utf8_files = [('last-revision', '0 null:\n'),
2093
1900
('branch.conf', ''),
2095
1902
('references', '')
2097
return self._initialize_helper(a_bzrdir, utf8_files, name)
1904
return self._initialize_helper(a_bzrdir, utf8_files)
2099
1906
def __init__(self):
2100
1907
super(BzrBranchFormat8, self).__init__()
2123
1930
This format was introduced in bzr 1.6.
2126
def initialize(self, a_bzrdir, name=None):
1933
def initialize(self, a_bzrdir):
2127
1934
"""Create a branch of this format in a_bzrdir."""
2128
1935
utf8_files = [('last-revision', '0 null:\n'),
2129
1936
('branch.conf', ''),
2132
return self._initialize_helper(a_bzrdir, utf8_files, name)
1939
return self._initialize_helper(a_bzrdir, utf8_files)
2134
1941
def _branch_class(self):
2135
1942
return BzrBranch7
2177
1984
transport = a_bzrdir.get_branch_transport(None)
2178
1985
location = transport.put_bytes('location', to_branch.base)
2180
def initialize(self, a_bzrdir, name=None, target_branch=None):
1987
def initialize(self, a_bzrdir, target_branch=None):
2181
1988
"""Create a branch of this format in a_bzrdir."""
2182
1989
if target_branch is None:
2183
1990
# this format does not implement branch itself, thus the implicit
2184
1991
# creation contract must see it as uninitializable
2185
1992
raise errors.UninitializableFormat(self)
2186
mutter('creating branch reference in %s', a_bzrdir.user_url)
2187
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1993
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1994
branch_transport = a_bzrdir.get_branch_transport(self)
2188
1995
branch_transport.put_bytes('location',
2189
target_branch.bzrdir.user_url)
1996
target_branch.bzrdir.root_transport.base)
2190
1997
branch_transport.put_bytes('format', self.get_format_string())
2192
a_bzrdir, name, _found=True,
1999
a_bzrdir, _found=True,
2193
2000
possible_transports=[target_branch.bzrdir.root_transport])
2194
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2197
2002
def __init__(self):
2198
2003
super(BranchReferenceFormat, self).__init__()
2204
2009
def clone(to_bzrdir, revision_id=None,
2205
2010
repository_policy=None):
2206
2011
"""See Branch.clone()."""
2207
return format.initialize(to_bzrdir, target_branch=a_branch)
2012
return format.initialize(to_bzrdir, a_branch)
2208
2013
# cannot obey revision_id limits when cloning a reference ...
2209
2014
# FIXME RBC 20060210 either nuke revision_id for clone, or
2210
2015
# emit some sort of warning/error to the caller ?!
2213
def open(self, a_bzrdir, name=None, _found=False, location=None,
2018
def open(self, a_bzrdir, _found=False, location=None,
2214
2019
possible_transports=None, ignore_fallbacks=False):
2215
2020
"""Return the branch that the branch reference in a_bzrdir points at.
2217
2022
:param a_bzrdir: A BzrDir that contains a branch.
2218
:param name: Name of colocated branch to open, if any
2219
2023
:param _found: a private parameter, do not use it. It is used to
2220
2024
indicate if format probing has already be done.
2221
2025
:param ignore_fallbacks: when set, no fallback branches will be opened
2234
2038
location = self.get_reference(a_bzrdir)
2235
2039
real_bzrdir = bzrdir.BzrDir.open(
2236
2040
location, possible_transports=possible_transports)
2237
result = real_bzrdir.open_branch(name=name,
2238
ignore_fallbacks=ignore_fallbacks)
2041
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2239
2042
# this changes the behaviour of result.clone to create a new reference
2240
2043
# rather than a copy of the content of the branch.
2241
2044
# I did not use a proxy object because that needs much more extensive
2275
2078
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2278
class BranchWriteLockResult(LogicalLockResult):
2279
"""The result of write locking a branch.
2281
:ivar branch_token: The token obtained from the underlying branch lock, or
2283
:ivar unlock: A callable which will unlock the lock.
2286
def __init__(self, unlock, branch_token):
2287
LogicalLockResult.__init__(self, unlock)
2288
self.branch_token = branch_token
2291
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2295
2081
class BzrBranch(Branch, _RelockDebugMixin):
2296
2082
"""A branch stored in the actual filesystem.
2304
2090
:ivar repository: Repository for this branch.
2305
2091
:ivar base: The url of the base directory for this branch; the one
2306
2092
containing the .bzr directory.
2307
:ivar name: Optional colocated branch name as it exists in the control
2311
2095
def __init__(self, _format=None,
2312
_control_files=None, a_bzrdir=None, name=None,
2313
_repository=None, ignore_fallbacks=False):
2096
_control_files=None, a_bzrdir=None, _repository=None,
2097
ignore_fallbacks=False):
2314
2098
"""Create new branch object at a particular location."""
2315
2099
if a_bzrdir is None:
2316
2100
raise ValueError('a_bzrdir must be supplied')
2318
2102
self.bzrdir = a_bzrdir
2319
2103
self._base = self.bzrdir.transport.clone('..').base
2321
2104
# XXX: We should be able to just do
2322
2105
# self.base = self.bzrdir.root_transport.base
2323
2106
# but this does not quite work yet -- mbp 20080522
2869
2636
if branch_location is None:
2870
2637
return Branch.reference_parent(self, file_id, path,
2871
2638
possible_transports)
2872
branch_location = urlutils.join(self.user_url, branch_location)
2639
branch_location = urlutils.join(self.base, branch_location)
2873
2640
return Branch.open(branch_location,
2874
2641
possible_transports=possible_transports)
added
removed
bzrlib/branch.py
