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.
167
170
return control.open_branch(unsupported=_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=_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: An object with an unlock method which will release the lock
301
293
raise NotImplementedError(self.lock_read)
303
295
def unlock(self):
428
420
* 'include' - the stop revision is the last item in the result
429
421
* 'with-merges' - include the stop revision and all of its
430
422
merged revisions in the result
431
* 'with-merges-without-common-ancestry' - filter out revisions
432
that are in both ancestries
433
423
:param direction: either 'reverse' or 'forward':
434
424
* reverse means return the start_revision_id first, i.e.
435
425
start at the most recent revision and go backwards in history
457
447
# start_revision_id.
458
448
if self._merge_sorted_revisions_cache is None:
459
449
last_revision = self.last_revision()
460
known_graph = self.repository.get_known_graph_ancestry(
450
last_key = (last_revision,)
451
known_graph = self.repository.revisions.get_known_graph_ancestry(
462
453
self._merge_sorted_revisions_cache = known_graph.merge_sort(
464
455
filtered = self._filter_merge_sorted_revisions(
465
456
self._merge_sorted_revisions_cache, start_revision_id,
466
457
stop_revision_id, stop_rule)
467
# Make sure we don't return revisions that are not part of the
468
# start_revision_id ancestry.
469
filtered = self._filter_start_non_ancestors(filtered)
470
458
if direction == 'reverse':
472
460
if direction == 'forward':
509
497
node.end_of_merge)
510
498
if rev_id == stop_revision_id:
512
elif stop_rule == 'with-merges-without-common-ancestry':
513
# We want to exclude all revisions that are already part of the
514
# stop_revision_id ancestry.
515
graph = self.repository.get_graph()
516
ancestors = graph.find_unique_ancestors(start_revision_id,
518
for node in rev_iter:
519
rev_id = node.key[-1]
520
if rev_id not in ancestors:
522
yield (rev_id, node.merge_depth, node.revno,
524
500
elif stop_rule == 'with-merges':
525
501
stop_rev = self.repository.get_revision(stop_revision_id)
526
502
if stop_rev.parent_ids:
550
526
raise ValueError('invalid stop_rule %r' % stop_rule)
552
def _filter_start_non_ancestors(self, rev_iter):
553
# If we started from a dotted revno, we want to consider it as a tip
554
# and don't want to yield revisions that are not part of its
555
# ancestry. Given the order guaranteed by the merge sort, we will see
556
# uninteresting descendants of the first parent of our tip before the
558
first = rev_iter.next()
559
(rev_id, merge_depth, revno, end_of_merge) = first
562
# We start at a mainline revision so by definition, all others
563
# revisions in rev_iter are ancestors
564
for node in rev_iter:
569
pmap = self.repository.get_parent_map([rev_id])
570
parents = pmap.get(rev_id, [])
572
whitelist.update(parents)
574
# If there is no parents, there is nothing of interest left
576
# FIXME: It's hard to test this scenario here as this code is never
577
# called in that case. -- vila 20100322
580
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
582
if rev_id in whitelist:
583
pmap = self.repository.get_parent_map([rev_id])
584
parents = pmap.get(rev_id, [])
585
whitelist.remove(rev_id)
586
whitelist.update(parents)
588
# We've reached the mainline, there is nothing left to
592
# A revision that is not part of the ancestry of our
595
yield (rev_id, merge_depth, revno, end_of_merge)
597
528
def leave_lock_in_place(self):
598
529
"""Tell this branch object not to release the physical lock when this
599
530
object is unlocked.
674
605
def get_old_bound_location(self):
675
606
"""Return the URL of the branch we used to be bound to
677
raise errors.UpgradeRequired(self.user_url)
608
raise errors.UpgradeRequired(self.base)
679
610
def get_commit_builder(self, parents, config=None, timestamp=None,
680
611
timezone=None, committer=None, revprops=None,
1435
1365
def supports_tags(self):
1436
1366
return self._format.supports_tags()
1438
def automatic_tag_name(self, revision_id):
1439
"""Try to automatically find the tag name for a revision.
1441
:param revision_id: Revision id of the revision.
1442
:return: A tag name or None if no tag name could be determined.
1444
for hook in Branch.hooks['automatic_tag_name']:
1445
ret = hook(self, revision_id)
1450
1368
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1452
1370
"""Ensure that revision_b is a descendant of revision_a.
1516
1434
return not (self == other)
1519
def find_format(klass, a_bzrdir, name=None):
1437
def find_format(klass, a_bzrdir):
1520
1438
"""Return the format for the branch object in a_bzrdir."""
1522
transport = a_bzrdir.get_branch_transport(None, name=name)
1440
transport = a_bzrdir.get_branch_transport(None)
1523
1441
format_string = transport.get_bytes("format")
1524
1442
return klass._formats[format_string]
1525
1443
except errors.NoSuchFile:
1565
1483
"""Return the short format description for this format."""
1566
1484
raise NotImplementedError(self.get_format_description)
1568
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1569
hooks = Branch.hooks['post_branch_init']
1572
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1576
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1577
lock_type='metadir', set_format=True):
1486
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1578
1488
"""Initialize a branch in a bzrdir, with specified files
1580
1490
:param a_bzrdir: The bzrdir to initialize the branch in
1581
1491
:param utf8_files: The files to create as a list of
1582
1492
(filename, content) tuples
1583
:param name: Name of colocated branch to create, if any
1584
1493
:param set_format: If True, set the format with
1585
1494
self.get_format_string. (BzrBranch4 has its format set
1587
1496
:return: a branch in this format
1589
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1590
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)
1592
1501
'metadir': ('lock', lockdir.LockDir),
1593
1502
'branch4': ('branch-lock', lockable_files.TransportLock),
1616
1525
control_files.unlock()
1617
branch = self.open(a_bzrdir, name, _found=True)
1618
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1526
return self.open(a_bzrdir, _found=True)
1621
def initialize(self, a_bzrdir, name=None):
1622
"""Create a branch of this format in a_bzrdir.
1624
: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."""
1626
1530
raise NotImplementedError(self.initialize)
1628
1532
def is_supported(self):
1659
1563
raise NotImplementedError(self.network_name)
1661
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1565
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1662
1566
"""Return the branch object for a_bzrdir
1664
1568
:param a_bzrdir: A BzrDir that contains a branch.
1665
:param name: Name of colocated branch to open
1666
1569
:param _found: a private parameter, do not use it. It is used to
1667
1570
indicate if format probing has already be done.
1668
1571
:param ignore_fallbacks: when set, no fallback branches will be opened
1776
1679
"multiple hooks installed for transform_fallback_location, "
1777
1680
"all are called with the url returned from the previous hook."
1778
1681
"The order is however undefined.", (1, 9), None))
1779
self.create_hook(HookPoint('automatic_tag_name',
1780
"Called to determine an automatic tag name for a revision."
1781
"automatic_tag_name is called with (branch, revision_id) and "
1782
"should return a tag name or None if no tag name could be "
1783
"determined. The first non-None tag name returned will be used.",
1785
self.create_hook(HookPoint('post_branch_init',
1786
"Called after new branch initialization completes. "
1787
"post_branch_init is called with a "
1788
"bzrlib.branch.BranchInitHookParams. "
1789
"Note that init, branch and checkout (both heavyweight and "
1790
"lightweight) will all trigger this hook.", (2, 2), None))
1791
self.create_hook(HookPoint('post_switch',
1792
"Called after a checkout switches branch. "
1793
"post_switch is called with a "
1794
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1798
1684
# install the default hooks into the Branch class.
1837
1723
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1840
class BranchInitHookParams(object):
1841
"""Object holding parameters passed to *_branch_init hooks.
1843
There are 4 fields that hooks may wish to access:
1845
:ivar format: the branch format
1846
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1847
:ivar name: name of colocated branch, if any (or None)
1848
:ivar branch: the branch created
1850
Note that for lightweight checkouts, the bzrdir and format fields refer to
1851
the checkout, hence they are different from the corresponding fields in
1852
branch, which refer to the original branch.
1855
def __init__(self, format, a_bzrdir, name, branch):
1856
"""Create a group of BranchInitHook parameters.
1858
:param format: the branch format
1859
:param a_bzrdir: the BzrDir where the branch will be/has been
1861
:param name: name of colocated branch, if any (or None)
1862
:param branch: the branch created
1864
Note that for lightweight checkouts, the bzrdir and format fields refer
1865
to the checkout, hence they are different from the corresponding fields
1866
in branch, which refer to the original branch.
1868
self.format = format
1869
self.bzrdir = a_bzrdir
1871
self.branch = branch
1873
def __eq__(self, other):
1874
return self.__dict__ == other.__dict__
1878
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1880
return "<%s of format:%s bzrdir:%s>" % (
1881
self.__class__.__name__, self.branch,
1882
self.format, self.bzrdir)
1885
class SwitchHookParams(object):
1886
"""Object holding parameters passed to *_switch hooks.
1888
There are 4 fields that hooks may wish to access:
1890
:ivar control_dir: BzrDir of the checkout to change
1891
:ivar to_branch: branch that the checkout is to reference
1892
:ivar force: skip the check for local commits in a heavy checkout
1893
:ivar revision_id: revision ID to switch to (or None)
1896
def __init__(self, control_dir, to_branch, force, revision_id):
1897
"""Create a group of SwitchHook parameters.
1899
:param control_dir: BzrDir of the checkout to change
1900
:param to_branch: branch that the checkout is to reference
1901
:param force: skip the check for local commits in a heavy checkout
1902
:param revision_id: revision ID to switch to (or None)
1904
self.control_dir = control_dir
1905
self.to_branch = to_branch
1907
self.revision_id = revision_id
1909
def __eq__(self, other):
1910
return self.__dict__ == other.__dict__
1913
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1914
self.control_dir, self.to_branch,
1918
1726
class BzrBranchFormat4(BranchFormat):
1919
1727
"""Bzr branch format 4.
1927
1735
"""See BranchFormat.get_format_description()."""
1928
1736
return "Branch format 4"
1930
def initialize(self, a_bzrdir, name=None):
1738
def initialize(self, a_bzrdir):
1931
1739
"""Create a branch of this format in a_bzrdir."""
1932
1740
utf8_files = [('revision-history', ''),
1933
1741
('branch-name', ''),
1935
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1743
return self._initialize_helper(a_bzrdir, utf8_files,
1936
1744
lock_type='branch4', set_format=False)
1938
1746
def __init__(self):
1943
1751
"""The network name for this format is the control dirs disk label."""
1944
1752
return self._matchingbzrdir.get_format_string()
1946
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1754
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1947
1755
"""See BranchFormat.open()."""
1949
1757
# we are being called directly and must probe.
1973
1780
return self.get_format_string()
1975
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1782
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1976
1783
"""See BranchFormat.open()."""
1978
format = BranchFormat.find_format(a_bzrdir, name=name)
1785
format = BranchFormat.find_format(a_bzrdir)
1979
1786
if format.__class__ != self.__class__:
1980
1787
raise AssertionError("wrong format %r found for %r" %
1981
1788
(format, self))
1982
transport = a_bzrdir.get_branch_transport(None, name=name)
1790
transport = a_bzrdir.get_branch_transport(None)
1984
1791
control_files = lockable_files.LockableFiles(transport, 'lock',
1985
1792
lockdir.LockDir)
1986
1793
return self._branch_class()(_format=self,
1987
1794
_control_files=control_files,
1989
1795
a_bzrdir=a_bzrdir,
1990
1796
_repository=a_bzrdir.find_repository(),
1991
1797
ignore_fallbacks=ignore_fallbacks)
2025
1831
"""See BranchFormat.get_format_description()."""
2026
1832
return "Branch format 5"
2028
def initialize(self, a_bzrdir, name=None):
1834
def initialize(self, a_bzrdir):
2029
1835
"""Create a branch of this format in a_bzrdir."""
2030
1836
utf8_files = [('revision-history', ''),
2031
1837
('branch-name', ''),
2033
return self._initialize_helper(a_bzrdir, utf8_files, name)
1839
return self._initialize_helper(a_bzrdir, utf8_files)
2035
1841
def supports_tags(self):
2058
1864
"""See BranchFormat.get_format_description()."""
2059
1865
return "Branch format 6"
2061
def initialize(self, a_bzrdir, name=None):
1867
def initialize(self, a_bzrdir):
2062
1868
"""Create a branch of this format in a_bzrdir."""
2063
1869
utf8_files = [('last-revision', '0 null:\n'),
2064
1870
('branch.conf', ''),
2067
return self._initialize_helper(a_bzrdir, utf8_files, name)
1873
return self._initialize_helper(a_bzrdir, utf8_files)
2069
1875
def make_tags(self, branch):
2070
1876
"""See bzrlib.branch.BranchFormat.make_tags()."""
2088
1894
"""See BranchFormat.get_format_description()."""
2089
1895
return "Branch format 8"
2091
def initialize(self, a_bzrdir, name=None):
1897
def initialize(self, a_bzrdir):
2092
1898
"""Create a branch of this format in a_bzrdir."""
2093
1899
utf8_files = [('last-revision', '0 null:\n'),
2094
1900
('branch.conf', ''),
2096
1902
('references', '')
2098
return self._initialize_helper(a_bzrdir, utf8_files, name)
1904
return self._initialize_helper(a_bzrdir, utf8_files)
2100
1906
def __init__(self):
2101
1907
super(BzrBranchFormat8, self).__init__()
2124
1930
This format was introduced in bzr 1.6.
2127
def initialize(self, a_bzrdir, name=None):
1933
def initialize(self, a_bzrdir):
2128
1934
"""Create a branch of this format in a_bzrdir."""
2129
1935
utf8_files = [('last-revision', '0 null:\n'),
2130
1936
('branch.conf', ''),
2133
return self._initialize_helper(a_bzrdir, utf8_files, name)
1939
return self._initialize_helper(a_bzrdir, utf8_files)
2135
1941
def _branch_class(self):
2136
1942
return BzrBranch7
2178
1984
transport = a_bzrdir.get_branch_transport(None)
2179
1985
location = transport.put_bytes('location', to_branch.base)
2181
def initialize(self, a_bzrdir, name=None, target_branch=None):
1987
def initialize(self, a_bzrdir, target_branch=None):
2182
1988
"""Create a branch of this format in a_bzrdir."""
2183
1989
if target_branch is None:
2184
1990
# this format does not implement branch itself, thus the implicit
2185
1991
# creation contract must see it as uninitializable
2186
1992
raise errors.UninitializableFormat(self)
2187
mutter('creating branch reference in %s', a_bzrdir.user_url)
2188
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)
2189
1995
branch_transport.put_bytes('location',
2190
target_branch.bzrdir.user_url)
1996
target_branch.bzrdir.root_transport.base)
2191
1997
branch_transport.put_bytes('format', self.get_format_string())
2193
a_bzrdir, name, _found=True,
1999
a_bzrdir, _found=True,
2194
2000
possible_transports=[target_branch.bzrdir.root_transport])
2195
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2198
2002
def __init__(self):
2199
2003
super(BranchReferenceFormat, self).__init__()
2205
2009
def clone(to_bzrdir, revision_id=None,
2206
2010
repository_policy=None):
2207
2011
"""See Branch.clone()."""
2208
return format.initialize(to_bzrdir, target_branch=a_branch)
2012
return format.initialize(to_bzrdir, a_branch)
2209
2013
# cannot obey revision_id limits when cloning a reference ...
2210
2014
# FIXME RBC 20060210 either nuke revision_id for clone, or
2211
2015
# emit some sort of warning/error to the caller ?!
2214
def open(self, a_bzrdir, name=None, _found=False, location=None,
2018
def open(self, a_bzrdir, _found=False, location=None,
2215
2019
possible_transports=None, ignore_fallbacks=False):
2216
2020
"""Return the branch that the branch reference in a_bzrdir points at.
2218
2022
:param a_bzrdir: A BzrDir that contains a branch.
2219
:param name: Name of colocated branch to open, if any
2220
2023
:param _found: a private parameter, do not use it. It is used to
2221
2024
indicate if format probing has already be done.
2222
2025
:param ignore_fallbacks: when set, no fallback branches will be opened
2235
2038
location = self.get_reference(a_bzrdir)
2236
2039
real_bzrdir = bzrdir.BzrDir.open(
2237
2040
location, possible_transports=possible_transports)
2238
result = real_bzrdir.open_branch(name=name,
2239
ignore_fallbacks=ignore_fallbacks)
2041
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2240
2042
# this changes the behaviour of result.clone to create a new reference
2241
2043
# rather than a copy of the content of the branch.
2242
2044
# I did not use a proxy object because that needs much more extensive
2276
2078
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2279
class BranchWriteLockResult(object):
2280
"""The result of write locking a branch.
2282
:ivar branch_token: The token obtained from the underlying branch lock, or
2284
:ivar unlock: A callable which will unlock the lock.
2287
def __init__(self, unlock, branch_token):
2288
self.branch_token = branch_token
2289
self.unlock = unlock
2292
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2296
2081
class BzrBranch(Branch, _RelockDebugMixin):
2297
2082
"""A branch stored in the actual filesystem.
2305
2090
:ivar repository: Repository for this branch.
2306
2091
:ivar base: The url of the base directory for this branch; the one
2307
2092
containing the .bzr directory.
2308
:ivar name: Optional colocated branch name as it exists in the control
2312
2095
def __init__(self, _format=None,
2313
_control_files=None, a_bzrdir=None, name=None,
2314
_repository=None, ignore_fallbacks=False):
2096
_control_files=None, a_bzrdir=None, _repository=None,
2097
ignore_fallbacks=False):
2315
2098
"""Create new branch object at a particular location."""
2316
2099
if a_bzrdir is None:
2317
2100
raise ValueError('a_bzrdir must be supplied')
2319
2102
self.bzrdir = a_bzrdir
2320
2103
self._base = self.bzrdir.transport.clone('..').base
2322
2104
# XXX: We should be able to just do
2323
2105
# self.base = self.bzrdir.root_transport.base
2324
2106
# but this does not quite work yet -- mbp 20080522
2871
2636
if branch_location is None:
2872
2637
return Branch.reference_parent(self, file_id, path,
2873
2638
possible_transports)
2874
branch_location = urlutils.join(self.user_url, branch_location)
2639
branch_location = urlutils.join(self.base, branch_location)
2875
2640
return Branch.open(branch_location,
2876
2641
possible_transports=possible_transports)
added
removed
bzrlib/branch.py
