63
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
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
######################################################################
66
class Branch(bzrdir.ControlComponent):
79
67
"""Branch holding a history of revisions.
82
Base directory/url of the branch.
70
Base directory/url of the branch; using control_url and
71
control_transport is more standardized.
84
73
hooks: An instance of BranchHooks.
168
165
control = bzrdir.BzrDir.open(base, _unsupported,
169
166
possible_transports=possible_transports)
170
return control.open_branch(_unsupported)
167
return control.open_branch(unsupported=_unsupported)
173
def open_from_transport(transport, _unsupported=False):
170
def open_from_transport(transport, name=None, _unsupported=False):
174
171
"""Open the branch rooted at transport"""
175
172
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
176
return control.open_branch(_unsupported)
173
return control.open_branch(name=name, unsupported=_unsupported)
179
176
def open_containing(url, possible_transports=None):
217
214
def _get_fallback_repository(self, url):
218
215
"""Get the repository we fallback to at url."""
219
216
url = urlutils.join(self.base, url)
220
a_bzrdir = bzrdir.BzrDir.open(url,
217
a_branch = Branch.open(url,
221
218
possible_transports=[self.bzrdir.root_transport])
222
return a_bzrdir.open_branch().repository
219
return a_branch.repository
224
221
def _get_tags_bytes(self):
225
222
"""Get the bytes of a serialised tags dict.
420
417
* 'include' - the stop revision is the last item in the result
421
418
* 'with-merges' - include the stop revision and all of its
422
419
merged revisions in the result
420
* 'with-merges-without-common-ancestry' - filter out revisions
421
that are in both ancestries
423
422
:param direction: either 'reverse' or 'forward':
424
423
* reverse means return the start_revision_id first, i.e.
425
424
start at the most recent revision and go backwards in history
447
446
# start_revision_id.
448
447
if self._merge_sorted_revisions_cache is None:
449
448
last_revision = self.last_revision()
450
last_key = (last_revision,)
451
known_graph = self.repository.revisions.get_known_graph_ancestry(
449
known_graph = self.repository.get_known_graph_ancestry(
453
451
self._merge_sorted_revisions_cache = known_graph.merge_sort(
455
453
filtered = self._filter_merge_sorted_revisions(
456
454
self._merge_sorted_revisions_cache, start_revision_id,
457
455
stop_revision_id, stop_rule)
456
# Make sure we don't return revisions that are not part of the
457
# start_revision_id ancestry.
458
filtered = self._filter_start_non_ancestors(filtered)
458
459
if direction == 'reverse':
460
461
if direction == 'forward':
497
498
node.end_of_merge)
498
499
if rev_id == stop_revision_id:
501
elif stop_rule == 'with-merges-without-common-ancestry':
502
# We want to exclude all revisions that are already part of the
503
# stop_revision_id ancestry.
504
graph = self.repository.get_graph()
505
ancestors = graph.find_unique_ancestors(start_revision_id,
507
for node in rev_iter:
508
rev_id = node.key[-1]
509
if rev_id not in ancestors:
511
yield (rev_id, node.merge_depth, node.revno,
500
513
elif stop_rule == 'with-merges':
501
514
stop_rev = self.repository.get_revision(stop_revision_id)
502
515
if stop_rev.parent_ids:
526
539
raise ValueError('invalid stop_rule %r' % stop_rule)
541
def _filter_start_non_ancestors(self, rev_iter):
542
# If we started from a dotted revno, we want to consider it as a tip
543
# and don't want to yield revisions that are not part of its
544
# ancestry. Given the order guaranteed by the merge sort, we will see
545
# uninteresting descendants of the first parent of our tip before the
547
first = rev_iter.next()
548
(rev_id, merge_depth, revno, end_of_merge) = first
551
# We start at a mainline revision so by definition, all others
552
# revisions in rev_iter are ancestors
553
for node in rev_iter:
558
pmap = self.repository.get_parent_map([rev_id])
559
parents = pmap.get(rev_id, [])
561
whitelist.update(parents)
563
# If there is no parents, there is nothing of interest left
565
# FIXME: It's hard to test this scenario here as this code is never
566
# called in that case. -- vila 20100322
569
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
571
if rev_id in whitelist:
572
pmap = self.repository.get_parent_map([rev_id])
573
parents = pmap.get(rev_id, [])
574
whitelist.remove(rev_id)
575
whitelist.update(parents)
577
# We've reached the mainline, there is nothing left to
581
# A revision that is not part of the ancestry of our
584
yield (rev_id, merge_depth, revno, end_of_merge)
528
586
def leave_lock_in_place(self):
529
587
"""Tell this branch object not to release the physical lock when this
530
588
object is unlocked.
605
663
def get_old_bound_location(self):
606
664
"""Return the URL of the branch we used to be bound to
608
raise errors.UpgradeRequired(self.base)
666
raise errors.UpgradeRequired(self.user_url)
610
668
def get_commit_builder(self, parents, config=None, timestamp=None,
611
669
timezone=None, committer=None, revprops=None,
1103
1161
params = ChangeBranchTipParams(
1104
1162
self, old_revno, new_revno, old_revid, new_revid)
1105
1163
for hook in hooks:
1108
except errors.TipChangeRejected:
1111
exc_info = sys.exc_info()
1112
hook_name = Branch.hooks.get_hook_name(hook)
1113
raise errors.HookFailed(
1114
'pre_change_branch_tip', hook_name, exc_info)
1116
1166
@needs_write_lock
1117
1167
def update(self):
1373
1424
def supports_tags(self):
1374
1425
return self._format.supports_tags()
1427
def automatic_tag_name(self, revision_id):
1428
"""Try to automatically find the tag name for a revision.
1430
:param revision_id: Revision id of the revision.
1431
:return: A tag name or None if no tag name could be determined.
1433
for hook in Branch.hooks['automatic_tag_name']:
1434
ret = hook(self, revision_id)
1376
1439
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1378
1441
"""Ensure that revision_b is a descendant of revision_a.
1442
1505
return not (self == other)
1445
def find_format(klass, a_bzrdir):
1508
def find_format(klass, a_bzrdir, name=None):
1446
1509
"""Return the format for the branch object in a_bzrdir."""
1448
transport = a_bzrdir.get_branch_transport(None)
1511
transport = a_bzrdir.get_branch_transport(None, name=name)
1449
1512
format_string = transport.get_bytes("format")
1450
1513
return klass._formats[format_string]
1451
1514
except errors.NoSuchFile:
1452
raise errors.NotBranchError(path=transport.base)
1515
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1453
1516
except KeyError:
1454
1517
raise errors.UnknownFormatError(format=format_string, kind='branch')
1491
1554
"""Return the short format description for this format."""
1492
1555
raise NotImplementedError(self.get_format_description)
1494
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1557
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1558
hooks = Branch.hooks['post_branch_init']
1561
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1565
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1566
lock_type='metadir', set_format=True):
1496
1567
"""Initialize a branch in a bzrdir, with specified files
1498
1569
:param a_bzrdir: The bzrdir to initialize the branch in
1499
1570
:param utf8_files: The files to create as a list of
1500
1571
(filename, content) tuples
1572
:param name: Name of colocated branch to create, if any
1501
1573
:param set_format: If True, set the format with
1502
1574
self.get_format_string. (BzrBranch4 has its format set
1504
1576
:return: a branch in this format
1506
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1507
branch_transport = a_bzrdir.get_branch_transport(self)
1578
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1509
1581
'metadir': ('lock', lockdir.LockDir),
1510
1582
'branch4': ('branch-lock', lockable_files.TransportLock),
1533
1605
control_files.unlock()
1534
return self.open(a_bzrdir, _found=True)
1606
branch = self.open(a_bzrdir, name, _found=True)
1607
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1536
def initialize(self, a_bzrdir):
1537
"""Create a branch of this format in a_bzrdir."""
1610
def initialize(self, a_bzrdir, name=None):
1611
"""Create a branch of this format in a_bzrdir.
1613
:param name: Name of the colocated branch to create.
1538
1615
raise NotImplementedError(self.initialize)
1540
1617
def is_supported(self):
1571
1648
raise NotImplementedError(self.network_name)
1573
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1650
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1574
1651
"""Return the branch object for a_bzrdir
1576
1653
:param a_bzrdir: A BzrDir that contains a branch.
1654
:param name: Name of colocated branch to open
1577
1655
:param _found: a private parameter, do not use it. It is used to
1578
1656
indicate if format probing has already be done.
1579
1657
:param ignore_fallbacks: when set, no fallback branches will be opened
1687
1765
"multiple hooks installed for transform_fallback_location, "
1688
1766
"all are called with the url returned from the previous hook."
1689
1767
"The order is however undefined.", (1, 9), None))
1768
self.create_hook(HookPoint('automatic_tag_name',
1769
"Called to determine an automatic tag name for a revision."
1770
"automatic_tag_name is called with (branch, revision_id) and "
1771
"should return a tag name or None if no tag name could be "
1772
"determined. The first non-None tag name returned will be used.",
1774
self.create_hook(HookPoint('post_branch_init',
1775
"Called after new branch initialization completes. "
1776
"post_branch_init is called with a "
1777
"bzrlib.branch.BranchInitHookParams. "
1778
"Note that init, branch and checkout (both heavyweight and "
1779
"lightweight) will all trigger this hook.", (2, 2), None))
1780
self.create_hook(HookPoint('post_switch',
1781
"Called after a checkout switches branch. "
1782
"post_switch is called with a "
1783
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1692
1787
# install the default hooks into the Branch class.
1731
1826
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1829
class BranchInitHookParams(object):
1830
"""Object holding parameters passed to *_branch_init hooks.
1832
There are 4 fields that hooks may wish to access:
1834
:ivar format: the branch format
1835
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1836
:ivar name: name of colocated branch, if any (or None)
1837
:ivar branch: the branch created
1839
Note that for lightweight checkouts, the bzrdir and format fields refer to
1840
the checkout, hence they are different from the corresponding fields in
1841
branch, which refer to the original branch.
1844
def __init__(self, format, a_bzrdir, name, branch):
1845
"""Create a group of BranchInitHook parameters.
1847
:param format: the branch format
1848
:param a_bzrdir: the BzrDir where the branch will be/has been
1850
:param name: name of colocated branch, if any (or None)
1851
:param branch: the branch created
1853
Note that for lightweight checkouts, the bzrdir and format fields refer
1854
to the checkout, hence they are different from the corresponding fields
1855
in branch, which refer to the original branch.
1857
self.format = format
1858
self.bzrdir = a_bzrdir
1860
self.branch = branch
1862
def __eq__(self, other):
1863
return self.__dict__ == other.__dict__
1867
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1869
return "<%s of format:%s bzrdir:%s>" % (
1870
self.__class__.__name__, self.branch,
1871
self.format, self.bzrdir)
1874
class SwitchHookParams(object):
1875
"""Object holding parameters passed to *_switch hooks.
1877
There are 4 fields that hooks may wish to access:
1879
:ivar control_dir: BzrDir of the checkout to change
1880
:ivar to_branch: branch that the checkout is to reference
1881
:ivar force: skip the check for local commits in a heavy checkout
1882
:ivar revision_id: revision ID to switch to (or None)
1885
def __init__(self, control_dir, to_branch, force, revision_id):
1886
"""Create a group of SwitchHook parameters.
1888
:param control_dir: BzrDir of the checkout to change
1889
:param to_branch: branch that the checkout is to reference
1890
:param force: skip the check for local commits in a heavy checkout
1891
:param revision_id: revision ID to switch to (or None)
1893
self.control_dir = control_dir
1894
self.to_branch = to_branch
1896
self.revision_id = revision_id
1898
def __eq__(self, other):
1899
return self.__dict__ == other.__dict__
1902
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1903
self.control_dir, self.to_branch,
1734
1907
class BzrBranchFormat4(BranchFormat):
1735
1908
"""Bzr branch format 4.
1743
1916
"""See BranchFormat.get_format_description()."""
1744
1917
return "Branch format 4"
1746
def initialize(self, a_bzrdir):
1919
def initialize(self, a_bzrdir, name=None):
1747
1920
"""Create a branch of this format in a_bzrdir."""
1748
1921
utf8_files = [('revision-history', ''),
1749
1922
('branch-name', ''),
1751
return self._initialize_helper(a_bzrdir, utf8_files,
1924
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1752
1925
lock_type='branch4', set_format=False)
1754
1927
def __init__(self):
1759
1932
"""The network name for this format is the control dirs disk label."""
1760
1933
return self._matchingbzrdir.get_format_string()
1762
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1935
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1763
1936
"""See BranchFormat.open()."""
1765
1938
# we are being called directly and must probe.
1788
1962
return self.get_format_string()
1790
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1964
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1791
1965
"""See BranchFormat.open()."""
1793
format = BranchFormat.find_format(a_bzrdir)
1967
format = BranchFormat.find_format(a_bzrdir, name=name)
1794
1968
if format.__class__ != self.__class__:
1795
1969
raise AssertionError("wrong format %r found for %r" %
1796
1970
(format, self))
1971
transport = a_bzrdir.get_branch_transport(None, name=name)
1798
transport = a_bzrdir.get_branch_transport(None)
1799
1973
control_files = lockable_files.LockableFiles(transport, 'lock',
1800
1974
lockdir.LockDir)
1801
1975
return self._branch_class()(_format=self,
1802
1976
_control_files=control_files,
1803
1978
a_bzrdir=a_bzrdir,
1804
1979
_repository=a_bzrdir.find_repository(),
1805
1980
ignore_fallbacks=ignore_fallbacks)
1806
1981
except errors.NoSuchFile:
1807
raise errors.NotBranchError(path=transport.base)
1982
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1809
1984
def __init__(self):
1810
1985
super(BranchFormatMetadir, self).__init__()
1839
2014
"""See BranchFormat.get_format_description()."""
1840
2015
return "Branch format 5"
1842
def initialize(self, a_bzrdir):
2017
def initialize(self, a_bzrdir, name=None):
1843
2018
"""Create a branch of this format in a_bzrdir."""
1844
2019
utf8_files = [('revision-history', ''),
1845
2020
('branch-name', ''),
1847
return self._initialize_helper(a_bzrdir, utf8_files)
2022
return self._initialize_helper(a_bzrdir, utf8_files, name)
1849
2024
def supports_tags(self):
1872
2047
"""See BranchFormat.get_format_description()."""
1873
2048
return "Branch format 6"
1875
def initialize(self, a_bzrdir):
2050
def initialize(self, a_bzrdir, name=None):
1876
2051
"""Create a branch of this format in a_bzrdir."""
1877
2052
utf8_files = [('last-revision', '0 null:\n'),
1878
2053
('branch.conf', ''),
1881
return self._initialize_helper(a_bzrdir, utf8_files)
2056
return self._initialize_helper(a_bzrdir, utf8_files, name)
1883
2058
def make_tags(self, branch):
1884
2059
"""See bzrlib.branch.BranchFormat.make_tags()."""
1902
2077
"""See BranchFormat.get_format_description()."""
1903
2078
return "Branch format 8"
1905
def initialize(self, a_bzrdir):
2080
def initialize(self, a_bzrdir, name=None):
1906
2081
"""Create a branch of this format in a_bzrdir."""
1907
2082
utf8_files = [('last-revision', '0 null:\n'),
1908
2083
('branch.conf', ''),
1910
2085
('references', '')
1912
return self._initialize_helper(a_bzrdir, utf8_files)
2087
return self._initialize_helper(a_bzrdir, utf8_files, name)
1914
2089
def __init__(self):
1915
2090
super(BzrBranchFormat8, self).__init__()
1938
2113
This format was introduced in bzr 1.6.
1941
def initialize(self, a_bzrdir):
2116
def initialize(self, a_bzrdir, name=None):
1942
2117
"""Create a branch of this format in a_bzrdir."""
1943
2118
utf8_files = [('last-revision', '0 null:\n'),
1944
2119
('branch.conf', ''),
1947
return self._initialize_helper(a_bzrdir, utf8_files)
2122
return self._initialize_helper(a_bzrdir, utf8_files, name)
1949
2124
def _branch_class(self):
1950
2125
return BzrBranch7
1992
2167
transport = a_bzrdir.get_branch_transport(None)
1993
2168
location = transport.put_bytes('location', to_branch.base)
1995
def initialize(self, a_bzrdir, target_branch=None):
2170
def initialize(self, a_bzrdir, name=None, target_branch=None):
1996
2171
"""Create a branch of this format in a_bzrdir."""
1997
2172
if target_branch is None:
1998
2173
# this format does not implement branch itself, thus the implicit
1999
2174
# creation contract must see it as uninitializable
2000
2175
raise errors.UninitializableFormat(self)
2001
mutter('creating branch reference in %s', a_bzrdir.transport.base)
2002
branch_transport = a_bzrdir.get_branch_transport(self)
2176
mutter('creating branch reference in %s', a_bzrdir.user_url)
2177
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2003
2178
branch_transport.put_bytes('location',
2004
target_branch.bzrdir.root_transport.base)
2179
target_branch.bzrdir.user_url)
2005
2180
branch_transport.put_bytes('format', self.get_format_string())
2007
a_bzrdir, _found=True,
2182
a_bzrdir, name, _found=True,
2008
2183
possible_transports=[target_branch.bzrdir.root_transport])
2184
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2010
2187
def __init__(self):
2011
2188
super(BranchReferenceFormat, self).__init__()
2017
2194
def clone(to_bzrdir, revision_id=None,
2018
2195
repository_policy=None):
2019
2196
"""See Branch.clone()."""
2020
return format.initialize(to_bzrdir, a_branch)
2197
return format.initialize(to_bzrdir, target_branch=a_branch)
2021
2198
# cannot obey revision_id limits when cloning a reference ...
2022
2199
# FIXME RBC 20060210 either nuke revision_id for clone, or
2023
2200
# emit some sort of warning/error to the caller ?!
2026
def open(self, a_bzrdir, _found=False, location=None,
2203
def open(self, a_bzrdir, name=None, _found=False, location=None,
2027
2204
possible_transports=None, ignore_fallbacks=False):
2028
2205
"""Return the branch that the branch reference in a_bzrdir points at.
2030
2207
:param a_bzrdir: A BzrDir that contains a branch.
2208
:param name: Name of colocated branch to open, if any
2031
2209
:param _found: a private parameter, do not use it. It is used to
2032
2210
indicate if format probing has already be done.
2033
2211
:param ignore_fallbacks: when set, no fallback branches will be opened
2046
2224
location = self.get_reference(a_bzrdir)
2047
2225
real_bzrdir = bzrdir.BzrDir.open(
2048
2226
location, possible_transports=possible_transports)
2049
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2227
result = real_bzrdir.open_branch(name=name,
2228
ignore_fallbacks=ignore_fallbacks)
2050
2229
# this changes the behaviour of result.clone to create a new reference
2051
2230
# rather than a copy of the content of the branch.
2052
2231
# I did not use a proxy object because that needs much more extensive
2098
2277
:ivar repository: Repository for this branch.
2099
2278
:ivar base: The url of the base directory for this branch; the one
2100
2279
containing the .bzr directory.
2280
:ivar name: Optional colocated branch name as it exists in the control
2103
2284
def __init__(self, _format=None,
2104
_control_files=None, a_bzrdir=None, _repository=None,
2105
ignore_fallbacks=False):
2285
_control_files=None, a_bzrdir=None, name=None,
2286
_repository=None, ignore_fallbacks=False):
2106
2287
"""Create new branch object at a particular location."""
2107
2288
if a_bzrdir is None:
2108
2289
raise ValueError('a_bzrdir must be supplied')
2110
2291
self.bzrdir = a_bzrdir
2111
2292
self._base = self.bzrdir.transport.clone('..').base
2112
2294
# XXX: We should be able to just do
2113
2295
# self.base = self.bzrdir.root_transport.base
2114
2296
# but this does not quite work yet -- mbp 20080522
2642
2830
if branch_location is None:
2643
2831
return Branch.reference_parent(self, file_id, path,
2644
2832
possible_transports)
2645
branch_location = urlutils.join(self.base, branch_location)
2833
branch_location = urlutils.join(self.user_url, branch_location)
2646
2834
return Branch.open(branch_location,
2647
2835
possible_transports=possible_transports)
added
removed
bzrlib/branch.py
