63
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
66
class Branch(bzrdir.ControlComponent):
65
# TODO: Maybe include checks for common corruption of newlines, etc?
67
# TODO: Some operations like log might retrieve the same revisions
68
# repeatedly to calculate deltas. We could perhaps have a weakref
69
# cache in memory to make this faster. In general anything can be
70
# cached in memory between lock and unlock operations. .. nb thats
71
# what the transaction identity map provides
74
######################################################################
67
78
"""Branch holding a history of revisions.
70
Base directory/url of the branch; using control_url and
71
control_transport is more standardized.
81
Base directory/url of the branch.
73
83
hooks: An instance of BranchHooks.
165
167
control = bzrdir.BzrDir.open(base, _unsupported,
166
168
possible_transports=possible_transports)
167
return control.open_branch(unsupported=_unsupported)
169
return control.open_branch(_unsupported)
170
def open_from_transport(transport, name=None, _unsupported=False):
172
def open_from_transport(transport, _unsupported=False):
171
173
"""Open the branch rooted at transport"""
172
174
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
return control.open_branch(name=name, unsupported=_unsupported)
175
return control.open_branch(_unsupported)
176
178
def open_containing(url, possible_transports=None):
214
216
def _get_fallback_repository(self, url):
215
217
"""Get the repository we fallback to at url."""
216
218
url = urlutils.join(self.base, url)
217
a_branch = Branch.open(url,
219
a_bzrdir = bzrdir.BzrDir.open(url,
218
220
possible_transports=[self.bzrdir.root_transport])
219
return a_branch.repository
221
return a_bzrdir.open_branch().repository
221
223
def _get_tags_bytes(self):
222
224
"""Get the bytes of a serialised tags dict.
456
446
# start_revision_id.
457
447
if self._merge_sorted_revisions_cache is None:
458
448
last_revision = self.last_revision()
459
known_graph = self.repository.get_known_graph_ancestry(
449
last_key = (last_revision,)
450
known_graph = self.repository.revisions.get_known_graph_ancestry(
461
452
self._merge_sorted_revisions_cache = known_graph.merge_sort(
463
454
filtered = self._filter_merge_sorted_revisions(
464
455
self._merge_sorted_revisions_cache, start_revision_id,
465
456
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
457
if direction == 'reverse':
471
459
if direction == 'forward':
508
496
node.end_of_merge)
509
497
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
499
elif stop_rule == 'with-merges':
524
500
stop_rev = self.repository.get_revision(stop_revision_id)
525
501
if stop_rev.parent_ids:
526
502
left_parent = stop_rev.parent_ids[0]
528
504
left_parent = _mod_revision.NULL_REVISION
529
# left_parent is the actual revision we want to stop logging at,
530
# since we want to show the merged revisions after the stop_rev too
531
reached_stop_revision_id = False
532
revision_id_whitelist = []
533
505
for node in rev_iter:
534
506
rev_id = node.key[-1]
535
507
if rev_id == left_parent:
536
# reached the left parent after the stop_revision
538
if (not reached_stop_revision_id or
539
rev_id in revision_id_whitelist):
540
yield (rev_id, node.merge_depth, node.revno,
509
yield (rev_id, node.merge_depth, node.revno,
541
510
node.end_of_merge)
542
if reached_stop_revision_id or rev_id == stop_revision_id:
543
# only do the merged revs of rev_id from now on
544
rev = self.repository.get_revision(rev_id)
546
reached_stop_revision_id = True
547
revision_id_whitelist.extend(rev.parent_ids)
549
512
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
514
def leave_lock_in_place(self):
597
515
"""Tell this branch object not to release the physical lock when this
598
516
object is unlocked.
1434
1359
def supports_tags(self):
1435
1360
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
1362
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1451
1364
"""Ensure that revision_b is a descendant of revision_a.
1515
1428
return not (self == other)
1518
def find_format(klass, a_bzrdir, name=None):
1431
def find_format(klass, a_bzrdir):
1519
1432
"""Return the format for the branch object in a_bzrdir."""
1521
transport = a_bzrdir.get_branch_transport(None, name=name)
1522
format_string = transport.get_bytes("format")
1434
transport = a_bzrdir.get_branch_transport(None)
1435
format_string = transport.get("format").read()
1523
1436
return klass._formats[format_string]
1524
1437
except errors.NoSuchFile:
1525
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1438
raise errors.NotBranchError(path=transport.base)
1526
1439
except KeyError:
1527
1440
raise errors.UnknownFormatError(format=format_string, kind='branch')
1564
1477
"""Return the short format description for this format."""
1565
1478
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):
1480
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1577
1482
"""Initialize a branch in a bzrdir, with specified files
1579
1484
:param a_bzrdir: The bzrdir to initialize the branch in
1580
1485
:param utf8_files: The files to create as a list of
1581
1486
(filename, content) tuples
1582
:param name: Name of colocated branch to create, if any
1583
1487
:param set_format: If True, set the format with
1584
1488
self.get_format_string. (BzrBranch4 has its format set
1586
1490
: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)
1492
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1493
branch_transport = a_bzrdir.get_branch_transport(self)
1591
1495
'metadir': ('lock', lockdir.LockDir),
1592
1496
'branch4': ('branch-lock', lockable_files.TransportLock),
1615
1519
control_files.unlock()
1616
branch = self.open(a_bzrdir, name, _found=True)
1617
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1520
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.
1522
def initialize(self, a_bzrdir):
1523
"""Create a branch of this format in a_bzrdir."""
1625
1524
raise NotImplementedError(self.initialize)
1627
1526
def is_supported(self):
1658
1557
raise NotImplementedError(self.network_name)
1660
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1559
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1661
1560
"""Return the branch object for a_bzrdir
1663
1562
:param a_bzrdir: A BzrDir that contains a branch.
1664
:param name: Name of colocated branch to open
1665
1563
:param _found: a private parameter, do not use it. It is used to
1666
1564
indicate if format probing has already be done.
1667
1565
:param ignore_fallbacks: when set, no fallback branches will be opened
1775
1673
"multiple hooks installed for transform_fallback_location, "
1776
1674
"all are called with the url returned from the previous hook."
1777
1675
"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
1678
# install the default hooks into the Branch class.
1836
1717
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
1720
class BzrBranchFormat4(BranchFormat):
1918
1721
"""Bzr branch format 4.
1926
1729
"""See BranchFormat.get_format_description()."""
1927
1730
return "Branch format 4"
1929
def initialize(self, a_bzrdir, name=None):
1732
def initialize(self, a_bzrdir):
1930
1733
"""Create a branch of this format in a_bzrdir."""
1931
1734
utf8_files = [('revision-history', ''),
1932
1735
('branch-name', ''),
1934
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1737
return self._initialize_helper(a_bzrdir, utf8_files,
1935
1738
lock_type='branch4', set_format=False)
1937
1740
def __init__(self):
1972
1774
return self.get_format_string()
1974
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1776
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1975
1777
"""See BranchFormat.open()."""
1977
format = BranchFormat.find_format(a_bzrdir, name=name)
1779
format = BranchFormat.find_format(a_bzrdir)
1978
1780
if format.__class__ != self.__class__:
1979
1781
raise AssertionError("wrong format %r found for %r" %
1980
1782
(format, self))
1981
transport = a_bzrdir.get_branch_transport(None, name=name)
1784
transport = a_bzrdir.get_branch_transport(None)
1983
1785
control_files = lockable_files.LockableFiles(transport, 'lock',
1984
1786
lockdir.LockDir)
1985
1787
return self._branch_class()(_format=self,
1986
1788
_control_files=control_files,
1988
1789
a_bzrdir=a_bzrdir,
1989
1790
_repository=a_bzrdir.find_repository(),
1990
1791
ignore_fallbacks=ignore_fallbacks)
1991
1792
except errors.NoSuchFile:
1992
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1793
raise errors.NotBranchError(path=transport.base)
1994
1795
def __init__(self):
1995
1796
super(BranchFormatMetadir, self).__init__()
2024
1825
"""See BranchFormat.get_format_description()."""
2025
1826
return "Branch format 5"
2027
def initialize(self, a_bzrdir, name=None):
1828
def initialize(self, a_bzrdir):
2028
1829
"""Create a branch of this format in a_bzrdir."""
2029
1830
utf8_files = [('revision-history', ''),
2030
1831
('branch-name', ''),
2032
return self._initialize_helper(a_bzrdir, utf8_files, name)
1833
return self._initialize_helper(a_bzrdir, utf8_files)
2034
1835
def supports_tags(self):
2057
1858
"""See BranchFormat.get_format_description()."""
2058
1859
return "Branch format 6"
2060
def initialize(self, a_bzrdir, name=None):
1861
def initialize(self, a_bzrdir):
2061
1862
"""Create a branch of this format in a_bzrdir."""
2062
1863
utf8_files = [('last-revision', '0 null:\n'),
2063
1864
('branch.conf', ''),
2066
return self._initialize_helper(a_bzrdir, utf8_files, name)
1867
return self._initialize_helper(a_bzrdir, utf8_files)
2068
1869
def make_tags(self, branch):
2069
1870
"""See bzrlib.branch.BranchFormat.make_tags()."""
2087
1888
"""See BranchFormat.get_format_description()."""
2088
1889
return "Branch format 8"
2090
def initialize(self, a_bzrdir, name=None):
1891
def initialize(self, a_bzrdir):
2091
1892
"""Create a branch of this format in a_bzrdir."""
2092
1893
utf8_files = [('last-revision', '0 null:\n'),
2093
1894
('branch.conf', ''),
2095
1896
('references', '')
2097
return self._initialize_helper(a_bzrdir, utf8_files, name)
1898
return self._initialize_helper(a_bzrdir, utf8_files)
2099
1900
def __init__(self):
2100
1901
super(BzrBranchFormat8, self).__init__()
2123
1924
This format was introduced in bzr 1.6.
2126
def initialize(self, a_bzrdir, name=None):
1927
def initialize(self, a_bzrdir):
2127
1928
"""Create a branch of this format in a_bzrdir."""
2128
1929
utf8_files = [('last-revision', '0 null:\n'),
2129
1930
('branch.conf', ''),
2132
return self._initialize_helper(a_bzrdir, utf8_files, name)
1933
return self._initialize_helper(a_bzrdir, utf8_files)
2134
1935
def _branch_class(self):
2135
1936
return BzrBranch7
2170
1971
def get_reference(self, a_bzrdir):
2171
1972
"""See BranchFormat.get_reference()."""
2172
1973
transport = a_bzrdir.get_branch_transport(None)
2173
return transport.get_bytes('location')
1974
return transport.get('location').read()
2175
1976
def set_reference(self, a_bzrdir, to_branch):
2176
1977
"""See BranchFormat.set_reference()."""
2177
1978
transport = a_bzrdir.get_branch_transport(None)
2178
1979
location = transport.put_bytes('location', to_branch.base)
2180
def initialize(self, a_bzrdir, name=None, target_branch=None):
1981
def initialize(self, a_bzrdir, target_branch=None):
2181
1982
"""Create a branch of this format in a_bzrdir."""
2182
1983
if target_branch is None:
2183
1984
# this format does not implement branch itself, thus the implicit
2184
1985
# creation contract must see it as uninitializable
2185
1986
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)
1987
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1988
branch_transport = a_bzrdir.get_branch_transport(self)
2188
1989
branch_transport.put_bytes('location',
2189
target_branch.bzrdir.user_url)
1990
target_branch.bzrdir.root_transport.base)
2190
1991
branch_transport.put_bytes('format', self.get_format_string())
2192
a_bzrdir, name, _found=True,
1993
a_bzrdir, _found=True,
2193
1994
possible_transports=[target_branch.bzrdir.root_transport])
2194
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2197
1996
def __init__(self):
2198
1997
super(BranchReferenceFormat, self).__init__()
2204
2003
def clone(to_bzrdir, revision_id=None,
2205
2004
repository_policy=None):
2206
2005
"""See Branch.clone()."""
2207
return format.initialize(to_bzrdir, target_branch=a_branch)
2006
return format.initialize(to_bzrdir, a_branch)
2208
2007
# cannot obey revision_id limits when cloning a reference ...
2209
2008
# FIXME RBC 20060210 either nuke revision_id for clone, or
2210
2009
# emit some sort of warning/error to the caller ?!
2213
def open(self, a_bzrdir, name=None, _found=False, location=None,
2012
def open(self, a_bzrdir, _found=False, location=None,
2214
2013
possible_transports=None, ignore_fallbacks=False):
2215
2014
"""Return the branch that the branch reference in a_bzrdir points at.
2217
2016
:param a_bzrdir: A BzrDir that contains a branch.
2218
:param name: Name of colocated branch to open, if any
2219
2017
:param _found: a private parameter, do not use it. It is used to
2220
2018
indicate if format probing has already be done.
2221
2019
:param ignore_fallbacks: when set, no fallback branches will be opened
2234
2032
location = self.get_reference(a_bzrdir)
2235
2033
real_bzrdir = bzrdir.BzrDir.open(
2236
2034
location, possible_transports=possible_transports)
2237
result = real_bzrdir.open_branch(name=name,
2238
ignore_fallbacks=ignore_fallbacks)
2035
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2239
2036
# this changes the behaviour of result.clone to create a new reference
2240
2037
# rather than a copy of the content of the branch.
2241
2038
# I did not use a proxy object because that needs much more extensive
2275
2072
_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
class BzrBranch(Branch, _RelockDebugMixin):
2075
class BzrBranch(Branch):
2296
2076
"""A branch stored in the actual filesystem.
2298
2078
Note that it's "local" in the context of the filesystem; it doesn't
2304
2084
:ivar repository: Repository for this branch.
2305
2085
:ivar base: The url of the base directory for this branch; the one
2306
2086
containing the .bzr directory.
2307
:ivar name: Optional colocated branch name as it exists in the control
2311
2089
def __init__(self, _format=None,
2312
_control_files=None, a_bzrdir=None, name=None,
2313
_repository=None, ignore_fallbacks=False):
2090
_control_files=None, a_bzrdir=None, _repository=None,
2091
ignore_fallbacks=False):
2314
2092
"""Create new branch object at a particular location."""
2315
2093
if a_bzrdir is None:
2316
2094
raise ValueError('a_bzrdir must be supplied')
2318
2096
self.bzrdir = a_bzrdir
2319
2097
self._base = self.bzrdir.transport.clone('..').base
2321
2098
# XXX: We should be able to just do
2322
2099
# self.base = self.bzrdir.root_transport.base
2323
2100
# but this does not quite work yet -- mbp 20080522
2351
2124
return self.control_files.is_locked()
2353
2126
def lock_write(self, token=None):
2354
"""Lock the branch for write operations.
2356
:param token: A token to permit reacquiring a previously held and
2358
:return: A BranchWriteLockResult.
2360
if not self.is_locked():
2361
self._note_lock('w')
2362
2127
# All-in-one needs to always unlock/lock.
2363
2128
repo_control = getattr(self.repository, 'control_files', None)
2364
2129
if self.control_files == repo_control or not self.is_locked():
2365
self.repository._warn_if_deprecated(self)
2366
2130
self.repository.lock_write()
2367
2131
took_lock = True
2369
2133
took_lock = False
2371
return BranchWriteLockResult(self.unlock,
2372
self.control_files.lock_write(token=token))
2135
return self.control_files.lock_write(token=token)
2375
2138
self.repository.unlock()
2378
2141
def lock_read(self):
2379
"""Lock the branch for read operations.
2381
:return: A bzrlib.lock.LogicalLockResult.
2383
if not self.is_locked():
2384
self._note_lock('r')
2385
2142
# All-in-one needs to always unlock/lock.
2386
2143
repo_control = getattr(self.repository, 'control_files', None)
2387
2144
if self.control_files == repo_control or not self.is_locked():
2388
self.repository._warn_if_deprecated(self)
2389
2145
self.repository.lock_read()
2390
2146
took_lock = True
2392
2148
took_lock = False
2394
2150
self.control_files.lock_read()
2395
return LogicalLockResult(self.unlock)
2398
2153
self.repository.unlock()
2401
@only_raises(errors.LockNotHeld, errors.LockBroken)
2402
2156
def unlock(self):
2404
2158
self.control_files.unlock()
added
removed
bzrlib/branch.py
