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.
457
446
# start_revision_id.
458
447
if self._merge_sorted_revisions_cache is None:
459
448
last_revision = self.last_revision()
460
known_graph = self.repository.get_known_graph_ancestry(
449
last_key = (last_revision,)
450
known_graph = self.repository.revisions.get_known_graph_ancestry(
462
452
self._merge_sorted_revisions_cache = known_graph.merge_sort(
464
454
filtered = self._filter_merge_sorted_revisions(
465
455
self._merge_sorted_revisions_cache, start_revision_id,
466
456
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
457
if direction == 'reverse':
472
459
if direction == 'forward':
509
496
node.end_of_merge)
510
497
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
499
elif stop_rule == 'with-merges':
525
500
stop_rev = self.repository.get_revision(stop_revision_id)
526
501
if stop_rev.parent_ids:
527
502
left_parent = stop_rev.parent_ids[0]
529
504
left_parent = _mod_revision.NULL_REVISION
530
# left_parent is the actual revision we want to stop logging at,
531
# since we want to show the merged revisions after the stop_rev too
532
reached_stop_revision_id = False
533
revision_id_whitelist = []
534
505
for node in rev_iter:
535
506
rev_id = node.key[-1]
536
507
if rev_id == left_parent:
537
# reached the left parent after the stop_revision
539
if (not reached_stop_revision_id or
540
rev_id in revision_id_whitelist):
541
yield (rev_id, node.merge_depth, node.revno,
509
yield (rev_id, node.merge_depth, node.revno,
542
510
node.end_of_merge)
543
if reached_stop_revision_id or rev_id == stop_revision_id:
544
# only do the merged revs of rev_id from now on
545
rev = self.repository.get_revision(rev_id)
547
reached_stop_revision_id = True
548
revision_id_whitelist.extend(rev.parent_ids)
550
512
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
514
def leave_lock_in_place(self):
598
515
"""Tell this branch object not to release the physical lock when this
599
516
object is unlocked.
1435
1359
def supports_tags(self):
1436
1360
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
1362
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1452
1364
"""Ensure that revision_b is a descendant of revision_a.
1516
1428
return not (self == other)
1519
def find_format(klass, a_bzrdir, name=None):
1431
def find_format(klass, a_bzrdir):
1520
1432
"""Return the format for the branch object in a_bzrdir."""
1522
transport = a_bzrdir.get_branch_transport(None, name=name)
1523
format_string = transport.get_bytes("format")
1434
transport = a_bzrdir.get_branch_transport(None)
1435
format_string = transport.get("format").read()
1524
1436
return klass._formats[format_string]
1525
1437
except errors.NoSuchFile:
1526
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1438
raise errors.NotBranchError(path=transport.base)
1527
1439
except KeyError:
1528
1440
raise errors.UnknownFormatError(format=format_string, kind='branch')
1565
1477
"""Return the short format description for this format."""
1566
1478
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):
1480
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1578
1482
"""Initialize a branch in a bzrdir, with specified files
1580
1484
:param a_bzrdir: The bzrdir to initialize the branch in
1581
1485
:param utf8_files: The files to create as a list of
1582
1486
(filename, content) tuples
1583
:param name: Name of colocated branch to create, if any
1584
1487
:param set_format: If True, set the format with
1585
1488
self.get_format_string. (BzrBranch4 has its format set
1587
1490
: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)
1492
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1493
branch_transport = a_bzrdir.get_branch_transport(self)
1592
1495
'metadir': ('lock', lockdir.LockDir),
1593
1496
'branch4': ('branch-lock', lockable_files.TransportLock),
1616
1519
control_files.unlock()
1617
branch = self.open(a_bzrdir, name, _found=True)
1618
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1520
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.
1522
def initialize(self, a_bzrdir):
1523
"""Create a branch of this format in a_bzrdir."""
1626
1524
raise NotImplementedError(self.initialize)
1628
1526
def is_supported(self):
1659
1557
raise NotImplementedError(self.network_name)
1661
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1559
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1662
1560
"""Return the branch object for a_bzrdir
1664
1562
:param a_bzrdir: A BzrDir that contains a branch.
1665
:param name: Name of colocated branch to open
1666
1563
:param _found: a private parameter, do not use it. It is used to
1667
1564
indicate if format probing has already be done.
1668
1565
:param ignore_fallbacks: when set, no fallback branches will be opened
1776
1673
"multiple hooks installed for transform_fallback_location, "
1777
1674
"all are called with the url returned from the previous hook."
1778
1675
"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
1678
# install the default hooks into the Branch class.
1837
1717
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
1720
class BzrBranchFormat4(BranchFormat):
1919
1721
"""Bzr branch format 4.
1927
1729
"""See BranchFormat.get_format_description()."""
1928
1730
return "Branch format 4"
1930
def initialize(self, a_bzrdir, name=None):
1732
def initialize(self, a_bzrdir):
1931
1733
"""Create a branch of this format in a_bzrdir."""
1932
1734
utf8_files = [('revision-history', ''),
1933
1735
('branch-name', ''),
1935
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1737
return self._initialize_helper(a_bzrdir, utf8_files,
1936
1738
lock_type='branch4', set_format=False)
1938
1740
def __init__(self):
1973
1774
return self.get_format_string()
1975
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1776
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1976
1777
"""See BranchFormat.open()."""
1978
format = BranchFormat.find_format(a_bzrdir, name=name)
1779
format = BranchFormat.find_format(a_bzrdir)
1979
1780
if format.__class__ != self.__class__:
1980
1781
raise AssertionError("wrong format %r found for %r" %
1981
1782
(format, self))
1982
transport = a_bzrdir.get_branch_transport(None, name=name)
1784
transport = a_bzrdir.get_branch_transport(None)
1984
1785
control_files = lockable_files.LockableFiles(transport, 'lock',
1985
1786
lockdir.LockDir)
1986
1787
return self._branch_class()(_format=self,
1987
1788
_control_files=control_files,
1989
1789
a_bzrdir=a_bzrdir,
1990
1790
_repository=a_bzrdir.find_repository(),
1991
1791
ignore_fallbacks=ignore_fallbacks)
1992
1792
except errors.NoSuchFile:
1993
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1793
raise errors.NotBranchError(path=transport.base)
1995
1795
def __init__(self):
1996
1796
super(BranchFormatMetadir, self).__init__()
2025
1825
"""See BranchFormat.get_format_description()."""
2026
1826
return "Branch format 5"
2028
def initialize(self, a_bzrdir, name=None):
1828
def initialize(self, a_bzrdir):
2029
1829
"""Create a branch of this format in a_bzrdir."""
2030
1830
utf8_files = [('revision-history', ''),
2031
1831
('branch-name', ''),
2033
return self._initialize_helper(a_bzrdir, utf8_files, name)
1833
return self._initialize_helper(a_bzrdir, utf8_files)
2035
1835
def supports_tags(self):
2058
1858
"""See BranchFormat.get_format_description()."""
2059
1859
return "Branch format 6"
2061
def initialize(self, a_bzrdir, name=None):
1861
def initialize(self, a_bzrdir):
2062
1862
"""Create a branch of this format in a_bzrdir."""
2063
1863
utf8_files = [('last-revision', '0 null:\n'),
2064
1864
('branch.conf', ''),
2067
return self._initialize_helper(a_bzrdir, utf8_files, name)
1867
return self._initialize_helper(a_bzrdir, utf8_files)
2069
1869
def make_tags(self, branch):
2070
1870
"""See bzrlib.branch.BranchFormat.make_tags()."""
2088
1888
"""See BranchFormat.get_format_description()."""
2089
1889
return "Branch format 8"
2091
def initialize(self, a_bzrdir, name=None):
1891
def initialize(self, a_bzrdir):
2092
1892
"""Create a branch of this format in a_bzrdir."""
2093
1893
utf8_files = [('last-revision', '0 null:\n'),
2094
1894
('branch.conf', ''),
2096
1896
('references', '')
2098
return self._initialize_helper(a_bzrdir, utf8_files, name)
1898
return self._initialize_helper(a_bzrdir, utf8_files)
2100
1900
def __init__(self):
2101
1901
super(BzrBranchFormat8, self).__init__()
2124
1924
This format was introduced in bzr 1.6.
2127
def initialize(self, a_bzrdir, name=None):
1927
def initialize(self, a_bzrdir):
2128
1928
"""Create a branch of this format in a_bzrdir."""
2129
1929
utf8_files = [('last-revision', '0 null:\n'),
2130
1930
('branch.conf', ''),
2133
return self._initialize_helper(a_bzrdir, utf8_files, name)
1933
return self._initialize_helper(a_bzrdir, utf8_files)
2135
1935
def _branch_class(self):
2136
1936
return BzrBranch7
2171
1971
def get_reference(self, a_bzrdir):
2172
1972
"""See BranchFormat.get_reference()."""
2173
1973
transport = a_bzrdir.get_branch_transport(None)
2174
return transport.get_bytes('location')
1974
return transport.get('location').read()
2176
1976
def set_reference(self, a_bzrdir, to_branch):
2177
1977
"""See BranchFormat.set_reference()."""
2178
1978
transport = a_bzrdir.get_branch_transport(None)
2179
1979
location = transport.put_bytes('location', to_branch.base)
2181
def initialize(self, a_bzrdir, name=None, target_branch=None):
1981
def initialize(self, a_bzrdir, target_branch=None):
2182
1982
"""Create a branch of this format in a_bzrdir."""
2183
1983
if target_branch is None:
2184
1984
# this format does not implement branch itself, thus the implicit
2185
1985
# creation contract must see it as uninitializable
2186
1986
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)
1987
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1988
branch_transport = a_bzrdir.get_branch_transport(self)
2189
1989
branch_transport.put_bytes('location',
2190
target_branch.bzrdir.user_url)
1990
target_branch.bzrdir.root_transport.base)
2191
1991
branch_transport.put_bytes('format', self.get_format_string())
2193
a_bzrdir, name, _found=True,
1993
a_bzrdir, _found=True,
2194
1994
possible_transports=[target_branch.bzrdir.root_transport])
2195
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2198
1996
def __init__(self):
2199
1997
super(BranchReferenceFormat, self).__init__()
2205
2003
def clone(to_bzrdir, revision_id=None,
2206
2004
repository_policy=None):
2207
2005
"""See Branch.clone()."""
2208
return format.initialize(to_bzrdir, target_branch=a_branch)
2006
return format.initialize(to_bzrdir, a_branch)
2209
2007
# cannot obey revision_id limits when cloning a reference ...
2210
2008
# FIXME RBC 20060210 either nuke revision_id for clone, or
2211
2009
# emit some sort of warning/error to the caller ?!
2214
def open(self, a_bzrdir, name=None, _found=False, location=None,
2012
def open(self, a_bzrdir, _found=False, location=None,
2215
2013
possible_transports=None, ignore_fallbacks=False):
2216
2014
"""Return the branch that the branch reference in a_bzrdir points at.
2218
2016
:param a_bzrdir: A BzrDir that contains a branch.
2219
:param name: Name of colocated branch to open, if any
2220
2017
:param _found: a private parameter, do not use it. It is used to
2221
2018
indicate if format probing has already be done.
2222
2019
:param ignore_fallbacks: when set, no fallback branches will be opened
2235
2032
location = self.get_reference(a_bzrdir)
2236
2033
real_bzrdir = bzrdir.BzrDir.open(
2237
2034
location, possible_transports=possible_transports)
2238
result = real_bzrdir.open_branch(name=name,
2239
ignore_fallbacks=ignore_fallbacks)
2035
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2240
2036
# this changes the behaviour of result.clone to create a new reference
2241
2037
# rather than a copy of the content of the branch.
2242
2038
# I did not use a proxy object because that needs much more extensive
2276
2072
_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
class BzrBranch(Branch, _RelockDebugMixin):
2075
class BzrBranch(Branch):
2297
2076
"""A branch stored in the actual filesystem.
2299
2078
Note that it's "local" in the context of the filesystem; it doesn't
2305
2084
:ivar repository: Repository for this branch.
2306
2085
:ivar base: The url of the base directory for this branch; the one
2307
2086
containing the .bzr directory.
2308
:ivar name: Optional colocated branch name as it exists in the control
2312
2089
def __init__(self, _format=None,
2313
_control_files=None, a_bzrdir=None, name=None,
2314
_repository=None, ignore_fallbacks=False):
2090
_control_files=None, a_bzrdir=None, _repository=None,
2091
ignore_fallbacks=False):
2315
2092
"""Create new branch object at a particular location."""
2316
2093
if a_bzrdir is None:
2317
2094
raise ValueError('a_bzrdir must be supplied')
2319
2096
self.bzrdir = a_bzrdir
2320
2097
self._base = self.bzrdir.transport.clone('..').base
2322
2098
# XXX: We should be able to just do
2323
2099
# self.base = self.bzrdir.root_transport.base
2324
2100
# but this does not quite work yet -- mbp 20080522
2352
2124
return self.control_files.is_locked()
2354
2126
def lock_write(self, token=None):
2355
"""Lock the branch for write operations.
2357
:param token: A token to permit reacquiring a previously held and
2359
:return: A BranchWriteLockResult.
2361
if not self.is_locked():
2362
self._note_lock('w')
2363
2127
# All-in-one needs to always unlock/lock.
2364
2128
repo_control = getattr(self.repository, 'control_files', None)
2365
2129
if self.control_files == repo_control or not self.is_locked():
2366
self.repository._warn_if_deprecated(self)
2367
2130
self.repository.lock_write()
2368
2131
took_lock = True
2370
2133
took_lock = False
2372
return BranchWriteLockResult(self.unlock,
2373
self.control_files.lock_write(token=token))
2135
return self.control_files.lock_write(token=token)
2376
2138
self.repository.unlock()
2379
2141
def lock_read(self):
2380
"""Lock the branch for read operations.
2382
:return: An object with an unlock method which will release the lock
2385
if not self.is_locked():
2386
self._note_lock('r')
2387
2142
# All-in-one needs to always unlock/lock.
2388
2143
repo_control = getattr(self.repository, 'control_files', None)
2389
2144
if self.control_files == repo_control or not self.is_locked():
2390
self.repository._warn_if_deprecated(self)
2391
2145
self.repository.lock_read()
2392
2146
took_lock = True
2394
2148
took_lock = False
2396
2150
self.control_files.lock_read()
2400
2153
self.repository.unlock()
2403
@only_raises(errors.LockNotHeld, errors.LockBroken)
2404
2156
def unlock(self):
2406
2158
self.control_files.unlock()
added
removed
bzrlib/branch.py
