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.
417
420
* 'include' - the stop revision is the last item in the result
418
421
* 'with-merges' - include the stop revision and all of its
419
422
merged revisions in the result
420
* 'with-merges-without-common-ancestry' - filter out revisions
421
that are in both ancestries
422
423
:param direction: either 'reverse' or 'forward':
423
424
* reverse means return the start_revision_id first, i.e.
424
425
start at the most recent revision and go backwards in history
446
447
# start_revision_id.
447
448
if self._merge_sorted_revisions_cache is None:
448
449
last_revision = self.last_revision()
449
known_graph = self.repository.get_known_graph_ancestry(
450
last_key = (last_revision,)
451
known_graph = self.repository.revisions.get_known_graph_ancestry(
451
453
self._merge_sorted_revisions_cache = known_graph.merge_sort(
453
455
filtered = self._filter_merge_sorted_revisions(
454
456
self._merge_sorted_revisions_cache, start_revision_id,
455
457
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)
459
458
if direction == 'reverse':
461
460
if direction == 'forward':
498
497
node.end_of_merge)
499
498
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,
513
500
elif stop_rule == 'with-merges':
514
501
stop_rev = self.repository.get_revision(stop_revision_id)
515
502
if stop_rev.parent_ids:
539
526
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)
586
528
def leave_lock_in_place(self):
587
529
"""Tell this branch object not to release the physical lock when this
588
530
object is unlocked.
663
605
def get_old_bound_location(self):
664
606
"""Return the URL of the branch we used to be bound to
666
raise errors.UpgradeRequired(self.user_url)
608
raise errors.UpgradeRequired(self.base)
668
610
def get_commit_builder(self, parents, config=None, timestamp=None,
669
611
timezone=None, committer=None, revprops=None,
1424
1365
def supports_tags(self):
1425
1366
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)
1439
1368
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1441
1370
"""Ensure that revision_b is a descendant of revision_a.
1505
1434
return not (self == other)
1508
def find_format(klass, a_bzrdir, name=None):
1437
def find_format(klass, a_bzrdir):
1509
1438
"""Return the format for the branch object in a_bzrdir."""
1511
transport = a_bzrdir.get_branch_transport(None, name=name)
1440
transport = a_bzrdir.get_branch_transport(None)
1512
1441
format_string = transport.get_bytes("format")
1513
1442
return klass._formats[format_string]
1514
1443
except errors.NoSuchFile:
1554
1483
"""Return the short format description for this format."""
1555
1484
raise NotImplementedError(self.get_format_description)
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):
1486
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1567
1488
"""Initialize a branch in a bzrdir, with specified files
1569
1490
:param a_bzrdir: The bzrdir to initialize the branch in
1570
1491
:param utf8_files: The files to create as a list of
1571
1492
(filename, content) tuples
1572
:param name: Name of colocated branch to create, if any
1573
1493
:param set_format: If True, set the format with
1574
1494
self.get_format_string. (BzrBranch4 has its format set
1576
1496
:return: a branch in this format
1578
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
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)
1581
1501
'metadir': ('lock', lockdir.LockDir),
1582
1502
'branch4': ('branch-lock', lockable_files.TransportLock),
1605
1525
control_files.unlock()
1606
branch = self.open(a_bzrdir, name, _found=True)
1607
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1526
return self.open(a_bzrdir, _found=True)
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.
1528
def initialize(self, a_bzrdir):
1529
"""Create a branch of this format in a_bzrdir."""
1615
1530
raise NotImplementedError(self.initialize)
1617
1532
def is_supported(self):
1648
1563
raise NotImplementedError(self.network_name)
1650
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1565
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1651
1566
"""Return the branch object for a_bzrdir
1653
1568
:param a_bzrdir: A BzrDir that contains a branch.
1654
:param name: Name of colocated branch to open
1655
1569
:param _found: a private parameter, do not use it. It is used to
1656
1570
indicate if format probing has already be done.
1657
1571
:param ignore_fallbacks: when set, no fallback branches will be opened
1765
1679
"multiple hooks installed for transform_fallback_location, "
1766
1680
"all are called with the url returned from the previous hook."
1767
1681
"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))
1787
1684
# install the default hooks into the Branch class.
1826
1723
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,
1907
1726
class BzrBranchFormat4(BranchFormat):
1908
1727
"""Bzr branch format 4.
1916
1735
"""See BranchFormat.get_format_description()."""
1917
1736
return "Branch format 4"
1919
def initialize(self, a_bzrdir, name=None):
1738
def initialize(self, a_bzrdir):
1920
1739
"""Create a branch of this format in a_bzrdir."""
1921
1740
utf8_files = [('revision-history', ''),
1922
1741
('branch-name', ''),
1924
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1743
return self._initialize_helper(a_bzrdir, utf8_files,
1925
1744
lock_type='branch4', set_format=False)
1927
1746
def __init__(self):
1932
1751
"""The network name for this format is the control dirs disk label."""
1933
1752
return self._matchingbzrdir.get_format_string()
1935
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1754
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1936
1755
"""See BranchFormat.open()."""
1938
1757
# we are being called directly and must probe.
1962
1780
return self.get_format_string()
1964
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1782
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1965
1783
"""See BranchFormat.open()."""
1967
format = BranchFormat.find_format(a_bzrdir, name=name)
1785
format = BranchFormat.find_format(a_bzrdir)
1968
1786
if format.__class__ != self.__class__:
1969
1787
raise AssertionError("wrong format %r found for %r" %
1970
1788
(format, self))
1971
transport = a_bzrdir.get_branch_transport(None, name=name)
1790
transport = a_bzrdir.get_branch_transport(None)
1973
1791
control_files = lockable_files.LockableFiles(transport, 'lock',
1974
1792
lockdir.LockDir)
1975
1793
return self._branch_class()(_format=self,
1976
1794
_control_files=control_files,
1978
1795
a_bzrdir=a_bzrdir,
1979
1796
_repository=a_bzrdir.find_repository(),
1980
1797
ignore_fallbacks=ignore_fallbacks)
2014
1831
"""See BranchFormat.get_format_description()."""
2015
1832
return "Branch format 5"
2017
def initialize(self, a_bzrdir, name=None):
1834
def initialize(self, a_bzrdir):
2018
1835
"""Create a branch of this format in a_bzrdir."""
2019
1836
utf8_files = [('revision-history', ''),
2020
1837
('branch-name', ''),
2022
return self._initialize_helper(a_bzrdir, utf8_files, name)
1839
return self._initialize_helper(a_bzrdir, utf8_files)
2024
1841
def supports_tags(self):
2047
1864
"""See BranchFormat.get_format_description()."""
2048
1865
return "Branch format 6"
2050
def initialize(self, a_bzrdir, name=None):
1867
def initialize(self, a_bzrdir):
2051
1868
"""Create a branch of this format in a_bzrdir."""
2052
1869
utf8_files = [('last-revision', '0 null:\n'),
2053
1870
('branch.conf', ''),
2056
return self._initialize_helper(a_bzrdir, utf8_files, name)
1873
return self._initialize_helper(a_bzrdir, utf8_files)
2058
1875
def make_tags(self, branch):
2059
1876
"""See bzrlib.branch.BranchFormat.make_tags()."""
2077
1894
"""See BranchFormat.get_format_description()."""
2078
1895
return "Branch format 8"
2080
def initialize(self, a_bzrdir, name=None):
1897
def initialize(self, a_bzrdir):
2081
1898
"""Create a branch of this format in a_bzrdir."""
2082
1899
utf8_files = [('last-revision', '0 null:\n'),
2083
1900
('branch.conf', ''),
2085
1902
('references', '')
2087
return self._initialize_helper(a_bzrdir, utf8_files, name)
1904
return self._initialize_helper(a_bzrdir, utf8_files)
2089
1906
def __init__(self):
2090
1907
super(BzrBranchFormat8, self).__init__()
2113
1930
This format was introduced in bzr 1.6.
2116
def initialize(self, a_bzrdir, name=None):
1933
def initialize(self, a_bzrdir):
2117
1934
"""Create a branch of this format in a_bzrdir."""
2118
1935
utf8_files = [('last-revision', '0 null:\n'),
2119
1936
('branch.conf', ''),
2122
return self._initialize_helper(a_bzrdir, utf8_files, name)
1939
return self._initialize_helper(a_bzrdir, utf8_files)
2124
1941
def _branch_class(self):
2125
1942
return BzrBranch7
2167
1984
transport = a_bzrdir.get_branch_transport(None)
2168
1985
location = transport.put_bytes('location', to_branch.base)
2170
def initialize(self, a_bzrdir, name=None, target_branch=None):
1987
def initialize(self, a_bzrdir, target_branch=None):
2171
1988
"""Create a branch of this format in a_bzrdir."""
2172
1989
if target_branch is None:
2173
1990
# this format does not implement branch itself, thus the implicit
2174
1991
# creation contract must see it as uninitializable
2175
1992
raise errors.UninitializableFormat(self)
2176
mutter('creating branch reference in %s', a_bzrdir.user_url)
2177
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)
2178
1995
branch_transport.put_bytes('location',
2179
target_branch.bzrdir.user_url)
1996
target_branch.bzrdir.root_transport.base)
2180
1997
branch_transport.put_bytes('format', self.get_format_string())
2182
a_bzrdir, name, _found=True,
1999
a_bzrdir, _found=True,
2183
2000
possible_transports=[target_branch.bzrdir.root_transport])
2184
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2187
2002
def __init__(self):
2188
2003
super(BranchReferenceFormat, self).__init__()
2194
2009
def clone(to_bzrdir, revision_id=None,
2195
2010
repository_policy=None):
2196
2011
"""See Branch.clone()."""
2197
return format.initialize(to_bzrdir, target_branch=a_branch)
2012
return format.initialize(to_bzrdir, a_branch)
2198
2013
# cannot obey revision_id limits when cloning a reference ...
2199
2014
# FIXME RBC 20060210 either nuke revision_id for clone, or
2200
2015
# emit some sort of warning/error to the caller ?!
2203
def open(self, a_bzrdir, name=None, _found=False, location=None,
2018
def open(self, a_bzrdir, _found=False, location=None,
2204
2019
possible_transports=None, ignore_fallbacks=False):
2205
2020
"""Return the branch that the branch reference in a_bzrdir points at.
2207
2022
:param a_bzrdir: A BzrDir that contains a branch.
2208
:param name: Name of colocated branch to open, if any
2209
2023
:param _found: a private parameter, do not use it. It is used to
2210
2024
indicate if format probing has already be done.
2211
2025
:param ignore_fallbacks: when set, no fallback branches will be opened
2224
2038
location = self.get_reference(a_bzrdir)
2225
2039
real_bzrdir = bzrdir.BzrDir.open(
2226
2040
location, possible_transports=possible_transports)
2227
result = real_bzrdir.open_branch(name=name,
2228
ignore_fallbacks=ignore_fallbacks)
2041
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2229
2042
# this changes the behaviour of result.clone to create a new reference
2230
2043
# rather than a copy of the content of the branch.
2231
2044
# I did not use a proxy object because that needs much more extensive
2277
2090
:ivar repository: Repository for this branch.
2278
2091
:ivar base: The url of the base directory for this branch; the one
2279
2092
containing the .bzr directory.
2280
:ivar name: Optional colocated branch name as it exists in the control
2284
2095
def __init__(self, _format=None,
2285
_control_files=None, a_bzrdir=None, name=None,
2286
_repository=None, ignore_fallbacks=False):
2096
_control_files=None, a_bzrdir=None, _repository=None,
2097
ignore_fallbacks=False):
2287
2098
"""Create new branch object at a particular location."""
2288
2099
if a_bzrdir is None:
2289
2100
raise ValueError('a_bzrdir must be supplied')
2291
2102
self.bzrdir = a_bzrdir
2292
2103
self._base = self.bzrdir.transport.clone('..').base
2294
2104
# XXX: We should be able to just do
2295
2105
# self.base = self.bzrdir.root_transport.base
2296
2106
# but this does not quite work yet -- mbp 20080522
2830
2636
if branch_location is None:
2831
2637
return Branch.reference_parent(self, file_id, path,
2832
2638
possible_transports)
2833
branch_location = urlutils.join(self.user_url, branch_location)
2639
branch_location = urlutils.join(self.base, branch_location)
2834
2640
return Branch.open(branch_location,
2835
2641
possible_transports=possible_transports)
added
removed
bzrlib/branch.py
