456
438
# start_revision_id.
457
439
if self._merge_sorted_revisions_cache is None:
458
440
last_revision = self.last_revision()
459
known_graph = self.repository.get_known_graph_ancestry(
461
self._merge_sorted_revisions_cache = known_graph.merge_sort(
441
graph = self.repository.get_graph()
442
parent_map = dict(((key, value) for key, value in
443
graph.iter_ancestry([last_revision]) if value is not None))
444
revision_graph = repository._strip_NULL_ghosts(parent_map)
445
revs = tsort.merge_sort(revision_graph, last_revision, None,
447
# Drop the sequence # before caching
448
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
463
450
filtered = self._filter_merge_sorted_revisions(
464
451
self._merge_sorted_revisions_cache, start_revision_id,
465
452
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
453
if direction == 'reverse':
471
455
if direction == 'forward':
478
462
"""Iterate over an inclusive range of sorted revisions."""
479
463
rev_iter = iter(merge_sorted_revisions)
480
464
if start_revision_id is not None:
481
for node in rev_iter:
482
rev_id = node.key[-1]
465
for rev_id, depth, revno, end_of_merge in rev_iter:
483
466
if rev_id != start_revision_id:
486
469
# The decision to include the start or not
487
470
# depends on the stop_rule if a stop is provided
488
# so pop this node back into the iterator
489
rev_iter = chain(iter([node]), rev_iter)
472
iter([(rev_id, depth, revno, end_of_merge)]),
491
475
if stop_revision_id is None:
493
for node in rev_iter:
494
rev_id = node.key[-1]
495
yield (rev_id, node.merge_depth, node.revno,
476
for rev_id, depth, revno, end_of_merge in rev_iter:
477
yield rev_id, depth, revno, end_of_merge
497
478
elif stop_rule == 'exclude':
498
for node in rev_iter:
499
rev_id = node.key[-1]
479
for rev_id, depth, revno, end_of_merge in rev_iter:
500
480
if rev_id == stop_revision_id:
502
yield (rev_id, node.merge_depth, node.revno,
482
yield rev_id, depth, revno, end_of_merge
504
483
elif stop_rule == 'include':
505
for node in rev_iter:
506
rev_id = node.key[-1]
507
yield (rev_id, node.merge_depth, node.revno,
484
for rev_id, depth, revno, end_of_merge in rev_iter:
485
yield rev_id, depth, revno, end_of_merge
509
486
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
488
elif stop_rule == 'with-merges':
524
489
stop_rev = self.repository.get_revision(stop_revision_id)
525
490
if stop_rev.parent_ids:
526
491
left_parent = stop_rev.parent_ids[0]
528
493
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
for node in rev_iter:
534
rev_id = node.key[-1]
494
for rev_id, depth, revno, end_of_merge in rev_iter:
535
495
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,
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)
497
yield rev_id, depth, revno, end_of_merge
549
499
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
501
def leave_lock_in_place(self):
597
502
"""Tell this branch object not to release the physical lock when this
598
503
object is unlocked.
1312
1222
Callers will typically also want to check the repository.
1314
:param refs: Calculated refs for this branch as specified by
1315
branch._get_check_refs()
1316
1224
:return: A BranchCheckResult.
1318
result = BranchCheckResult(self)
1226
ret = BranchCheckResult(self)
1227
mainline_parent_id = None
1319
1228
last_revno, last_revision_id = self.last_revision_info()
1320
actual_revno = refs[('lefthand-distance', last_revision_id)]
1321
if actual_revno != last_revno:
1322
result.errors.append(errors.BzrCheckError(
1323
'revno does not match len(mainline) %s != %s' % (
1324
last_revno, actual_revno)))
1325
# TODO: We should probably also check that self.revision_history
1326
# matches the repository for older branch formats.
1327
# If looking for the code that cross-checks repository parents against
1328
# the iter_reverse_revision_history output, that is now a repository
1229
real_rev_history = []
1231
for revid in self.repository.iter_reverse_revision_history(
1233
real_rev_history.append(revid)
1234
except errors.RevisionNotPresent:
1235
ret.ghosts_in_mainline = True
1237
ret.ghosts_in_mainline = False
1238
real_rev_history.reverse()
1239
if len(real_rev_history) != last_revno:
1240
raise errors.BzrCheckError('revno does not match len(mainline)'
1241
' %s != %s' % (last_revno, len(real_rev_history)))
1242
# TODO: We should probably also check that real_rev_history actually
1243
# matches self.revision_history()
1244
for revision_id in real_rev_history:
1246
revision = self.repository.get_revision(revision_id)
1247
except errors.NoSuchRevision, e:
1248
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1250
# In general the first entry on the revision history has no parents.
1251
# But it's not illegal for it to have parents listed; this can happen
1252
# in imports from Arch when the parents weren't reachable.
1253
if mainline_parent_id is not None:
1254
if mainline_parent_id not in revision.parent_ids:
1255
raise errors.BzrCheckError("previous revision {%s} not listed among "
1257
% (mainline_parent_id, revision_id))
1258
mainline_parent_id = revision_id
1332
1261
def _get_checkout_format(self):
1333
1262
"""Return the most suitable metadir for a checkout of this branch.
1357
1286
# XXX: Fix the bzrdir API to allow getting the branch back from the
1358
1287
# clone call. Or something. 20090224 RBC/spiv.
1359
# XXX: Should this perhaps clone colocated branches as well,
1360
# rather than just the default branch? 20100319 JRV
1361
1288
if revision_id is None:
1362
1289
revision_id = self.last_revision()
1363
dir_to = self.bzrdir.clone_on_transport(to_transport,
1364
revision_id=revision_id, stacked_on=stacked_on,
1365
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1291
dir_to = self.bzrdir.clone_on_transport(to_transport,
1292
revision_id=revision_id, stacked_on=stacked_on,
1293
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1294
except errors.FileExists:
1295
if not use_existing_dir:
1297
except errors.NoSuchFile:
1298
if not create_prefix:
1366
1300
return dir_to.open_branch()
1368
1302
def create_checkout(self, to_location, revision_id=None,
1568
1487
"""Return the short format description for this format."""
1569
1488
raise NotImplementedError(self.get_format_description)
1571
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1572
hooks = Branch.hooks['post_branch_init']
1575
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1579
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1580
lock_type='metadir', set_format=True):
1490
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1581
1492
"""Initialize a branch in a bzrdir, with specified files
1583
1494
:param a_bzrdir: The bzrdir to initialize the branch in
1584
1495
:param utf8_files: The files to create as a list of
1585
1496
(filename, content) tuples
1586
:param name: Name of colocated branch to create, if any
1587
1497
:param set_format: If True, set the format with
1588
1498
self.get_format_string. (BzrBranch4 has its format set
1590
1500
:return: a branch in this format
1592
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1593
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1502
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1503
branch_transport = a_bzrdir.get_branch_transport(self)
1595
1505
'metadir': ('lock', lockdir.LockDir),
1596
1506
'branch4': ('branch-lock', lockable_files.TransportLock),
1779
1683
"multiple hooks installed for transform_fallback_location, "
1780
1684
"all are called with the url returned from the previous hook."
1781
1685
"The order is however undefined.", (1, 9), None))
1782
self.create_hook(HookPoint('automatic_tag_name',
1783
"Called to determine an automatic tag name for a revision."
1784
"automatic_tag_name is called with (branch, revision_id) and "
1785
"should return a tag name or None if no tag name could be "
1786
"determined. The first non-None tag name returned will be used.",
1788
self.create_hook(HookPoint('post_branch_init',
1789
"Called after new branch initialization completes. "
1790
"post_branch_init is called with a "
1791
"bzrlib.branch.BranchInitHookParams. "
1792
"Note that init, branch and checkout (both heavyweight and "
1793
"lightweight) will all trigger this hook.", (2, 2), None))
1794
self.create_hook(HookPoint('post_switch',
1795
"Called after a checkout switches branch. "
1796
"post_switch is called with a "
1797
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1801
1688
# install the default hooks into the Branch class.
1840
1727
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1843
class BranchInitHookParams(object):
1844
"""Object holding parameters passed to *_branch_init hooks.
1846
There are 4 fields that hooks may wish to access:
1848
:ivar format: the branch format
1849
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1850
:ivar name: name of colocated branch, if any (or None)
1851
:ivar branch: the branch created
1853
Note that for lightweight checkouts, the bzrdir and format fields refer to
1854
the checkout, hence they are different from the corresponding fields in
1855
branch, which refer to the original branch.
1858
def __init__(self, format, a_bzrdir, name, branch):
1859
"""Create a group of BranchInitHook parameters.
1861
:param format: the branch format
1862
:param a_bzrdir: the BzrDir where the branch will be/has been
1864
:param name: name of colocated branch, if any (or None)
1865
:param branch: the branch created
1867
Note that for lightweight checkouts, the bzrdir and format fields refer
1868
to the checkout, hence they are different from the corresponding fields
1869
in branch, which refer to the original branch.
1871
self.format = format
1872
self.bzrdir = a_bzrdir
1874
self.branch = branch
1876
def __eq__(self, other):
1877
return self.__dict__ == other.__dict__
1881
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1883
return "<%s of format:%s bzrdir:%s>" % (
1884
self.__class__.__name__, self.branch,
1885
self.format, self.bzrdir)
1888
class SwitchHookParams(object):
1889
"""Object holding parameters passed to *_switch hooks.
1891
There are 4 fields that hooks may wish to access:
1893
:ivar control_dir: BzrDir of the checkout to change
1894
:ivar to_branch: branch that the checkout is to reference
1895
:ivar force: skip the check for local commits in a heavy checkout
1896
:ivar revision_id: revision ID to switch to (or None)
1899
def __init__(self, control_dir, to_branch, force, revision_id):
1900
"""Create a group of SwitchHook parameters.
1902
:param control_dir: BzrDir of the checkout to change
1903
:param to_branch: branch that the checkout is to reference
1904
:param force: skip the check for local commits in a heavy checkout
1905
:param revision_id: revision ID to switch to (or None)
1907
self.control_dir = control_dir
1908
self.to_branch = to_branch
1910
self.revision_id = revision_id
1912
def __eq__(self, other):
1913
return self.__dict__ == other.__dict__
1916
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1917
self.control_dir, self.to_branch,
1921
1730
class BzrBranchFormat4(BranchFormat):
1922
1731
"""Bzr branch format 4.
1976
1784
return self.get_format_string()
1978
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1786
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1979
1787
"""See BranchFormat.open()."""
1981
format = BranchFormat.find_format(a_bzrdir, name=name)
1789
format = BranchFormat.find_format(a_bzrdir)
1982
1790
if format.__class__ != self.__class__:
1983
1791
raise AssertionError("wrong format %r found for %r" %
1984
1792
(format, self))
1985
transport = a_bzrdir.get_branch_transport(None, name=name)
1794
transport = a_bzrdir.get_branch_transport(None)
1987
1795
control_files = lockable_files.LockableFiles(transport, 'lock',
1988
1796
lockdir.LockDir)
1989
1797
return self._branch_class()(_format=self,
1990
1798
_control_files=control_files,
1992
1799
a_bzrdir=a_bzrdir,
1993
1800
_repository=a_bzrdir.find_repository(),
1994
1801
ignore_fallbacks=ignore_fallbacks)
1995
1802
except errors.NoSuchFile:
1996
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1803
raise errors.NotBranchError(path=transport.base)
1998
1805
def __init__(self):
1999
1806
super(BranchFormatMetadir, self).__init__()
2171
1978
"""See BranchFormat.get_format_description()."""
2172
1979
return "Checkout reference format 1"
2174
def get_reference(self, a_bzrdir, name=None):
1981
def get_reference(self, a_bzrdir):
2175
1982
"""See BranchFormat.get_reference()."""
2176
transport = a_bzrdir.get_branch_transport(None, name=name)
2177
return transport.get_bytes('location')
1983
transport = a_bzrdir.get_branch_transport(None)
1984
return transport.get('location').read()
2179
def set_reference(self, a_bzrdir, name, to_branch):
1986
def set_reference(self, a_bzrdir, to_branch):
2180
1987
"""See BranchFormat.set_reference()."""
2181
transport = a_bzrdir.get_branch_transport(None, name=name)
1988
transport = a_bzrdir.get_branch_transport(None)
2182
1989
location = transport.put_bytes('location', to_branch.base)
2184
def initialize(self, a_bzrdir, name=None, target_branch=None):
1991
def initialize(self, a_bzrdir, target_branch=None):
2185
1992
"""Create a branch of this format in a_bzrdir."""
2186
1993
if target_branch is None:
2187
1994
# this format does not implement branch itself, thus the implicit
2188
1995
# creation contract must see it as uninitializable
2189
1996
raise errors.UninitializableFormat(self)
2190
mutter('creating branch reference in %s', a_bzrdir.user_url)
2191
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1997
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1998
branch_transport = a_bzrdir.get_branch_transport(self)
2192
1999
branch_transport.put_bytes('location',
2193
target_branch.bzrdir.user_url)
2000
target_branch.bzrdir.root_transport.base)
2194
2001
branch_transport.put_bytes('format', self.get_format_string())
2196
a_bzrdir, name, _found=True,
2003
a_bzrdir, _found=True,
2197
2004
possible_transports=[target_branch.bzrdir.root_transport])
2198
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2201
2006
def __init__(self):
2202
2007
super(BranchReferenceFormat, self).__init__()
2208
2013
def clone(to_bzrdir, revision_id=None,
2209
2014
repository_policy=None):
2210
2015
"""See Branch.clone()."""
2211
return format.initialize(to_bzrdir, target_branch=a_branch)
2016
return format.initialize(to_bzrdir, a_branch)
2212
2017
# cannot obey revision_id limits when cloning a reference ...
2213
2018
# FIXME RBC 20060210 either nuke revision_id for clone, or
2214
2019
# emit some sort of warning/error to the caller ?!
2217
def open(self, a_bzrdir, name=None, _found=False, location=None,
2022
def open(self, a_bzrdir, _found=False, location=None,
2218
2023
possible_transports=None, ignore_fallbacks=False):
2219
2024
"""Return the branch that the branch reference in a_bzrdir points at.
2221
2026
:param a_bzrdir: A BzrDir that contains a branch.
2222
:param name: Name of colocated branch to open, if any
2223
2027
:param _found: a private parameter, do not use it. It is used to
2224
2028
indicate if format probing has already be done.
2225
2029
:param ignore_fallbacks: when set, no fallback branches will be opened
2272
2075
BranchFormat.register_format(__format6)
2273
2076
BranchFormat.register_format(__format7)
2274
2077
BranchFormat.register_format(__format8)
2275
BranchFormat.set_default_format(__format7)
2078
BranchFormat.set_default_format(__format6)
2276
2079
_legacy_formats = [BzrBranchFormat4(),
2278
2081
network_format_registry.register(
2279
2082
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2282
class BranchWriteLockResult(LogicalLockResult):
2283
"""The result of write locking a branch.
2285
:ivar branch_token: The token obtained from the underlying branch lock, or
2287
:ivar unlock: A callable which will unlock the lock.
2290
def __init__(self, unlock, branch_token):
2291
LogicalLockResult.__init__(self, unlock)
2292
self.branch_token = branch_token
2295
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2299
class BzrBranch(Branch, _RelockDebugMixin):
2085
class BzrBranch(Branch):
2300
2086
"""A branch stored in the actual filesystem.
2302
2088
Note that it's "local" in the context of the filesystem; it doesn't
2308
2094
:ivar repository: Repository for this branch.
2309
2095
:ivar base: The url of the base directory for this branch; the one
2310
2096
containing the .bzr directory.
2311
:ivar name: Optional colocated branch name as it exists in the control
2315
2099
def __init__(self, _format=None,
2316
_control_files=None, a_bzrdir=None, name=None,
2317
_repository=None, ignore_fallbacks=False):
2100
_control_files=None, a_bzrdir=None, _repository=None,
2101
ignore_fallbacks=False):
2318
2102
"""Create new branch object at a particular location."""
2319
2103
if a_bzrdir is None:
2320
2104
raise ValueError('a_bzrdir must be supplied')
2322
2106
self.bzrdir = a_bzrdir
2323
2107
self._base = self.bzrdir.transport.clone('..').base
2325
2108
# XXX: We should be able to just do
2326
2109
# self.base = self.bzrdir.root_transport.base
2327
2110
# but this does not quite work yet -- mbp 20080522
2355
2134
return self.control_files.is_locked()
2357
2136
def lock_write(self, token=None):
2358
"""Lock the branch for write operations.
2360
:param token: A token to permit reacquiring a previously held and
2362
:return: A BranchWriteLockResult.
2364
if not self.is_locked():
2365
self._note_lock('w')
2366
2137
# All-in-one needs to always unlock/lock.
2367
2138
repo_control = getattr(self.repository, 'control_files', None)
2368
2139
if self.control_files == repo_control or not self.is_locked():
2369
self.repository._warn_if_deprecated(self)
2370
2140
self.repository.lock_write()
2371
2141
took_lock = True
2373
2143
took_lock = False
2375
return BranchWriteLockResult(self.unlock,
2376
self.control_files.lock_write(token=token))
2145
return self.control_files.lock_write(token=token)
2379
2148
self.repository.unlock()
2382
2151
def lock_read(self):
2383
"""Lock the branch for read operations.
2385
:return: A bzrlib.lock.LogicalLockResult.
2387
if not self.is_locked():
2388
self._note_lock('r')
2389
2152
# All-in-one needs to always unlock/lock.
2390
2153
repo_control = getattr(self.repository, 'control_files', None)
2391
2154
if self.control_files == repo_control or not self.is_locked():
2392
self.repository._warn_if_deprecated(self)
2393
2155
self.repository.lock_read()
2394
2156
took_lock = True
2396
2158
took_lock = False
2398
2160
self.control_files.lock_read()
2399
return LogicalLockResult(self.unlock)
2402
2163
self.repository.unlock()
2405
@only_raises(errors.LockNotHeld, errors.LockBroken)
2406
2166
def unlock(self):
2408
2168
self.control_files.unlock()