49
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
50
from bzrlib.hooks import HookPoint, Hooks
51
51
from bzrlib.inter import InterObject
52
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
52
from bzrlib.lock import _RelockDebugMixin
53
53
from bzrlib import registry
54
54
from bzrlib.symbol_versioning import (
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.
80
def control_transport(self):
81
return self._transport
84
def user_transport(self):
85
return self.bzrdir.user_transport
87
90
def __init__(self, *ignored, **ignored_too):
88
91
self.tags = self._format.make_tags(self)
89
92
self._revision_history_cache = None
104
107
"""Activate the branch/repository from url as a fallback repository."""
105
108
repo = self._get_fallback_repository(url)
106
109
if repo.has_same_location(self.repository):
107
raise errors.UnstackableLocationError(self.user_url, url)
110
raise errors.UnstackableLocationError(self.base, url)
108
111
self.repository.add_fallback_repository(repo)
110
113
def break_lock(self):
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: A bzrlib.lock.LogicalLockResult.
300
293
raise NotImplementedError(self.lock_read)
302
295
def unlock(self):
427
420
* 'include' - the stop revision is the last item in the result
428
421
* 'with-merges' - include the stop revision and all of its
429
422
merged revisions in the result
430
* 'with-merges-without-common-ancestry' - filter out revisions
431
that are in both ancestries
432
423
:param direction: either 'reverse' or 'forward':
433
424
* reverse means return the start_revision_id first, i.e.
434
425
start at the most recent revision and go backwards in history
456
447
# start_revision_id.
457
448
if self._merge_sorted_revisions_cache is None:
458
449
last_revision = self.last_revision()
459
known_graph = self.repository.get_known_graph_ancestry(
450
last_key = (last_revision,)
451
known_graph = self.repository.revisions.get_known_graph_ancestry(
461
453
self._merge_sorted_revisions_cache = known_graph.merge_sort(
463
455
filtered = self._filter_merge_sorted_revisions(
464
456
self._merge_sorted_revisions_cache, start_revision_id,
465
457
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
458
if direction == 'reverse':
471
460
if direction == 'forward':
508
497
node.end_of_merge)
509
498
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
500
elif stop_rule == 'with-merges':
524
501
stop_rev = self.repository.get_revision(stop_revision_id)
525
502
if stop_rev.parent_ids:
549
526
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
528
def leave_lock_in_place(self):
597
529
"""Tell this branch object not to release the physical lock when this
598
530
object is unlocked.
615
547
:param other: The branch to bind to
616
548
:type other: Branch
618
raise errors.UpgradeRequired(self.user_url)
550
raise errors.UpgradeRequired(self.base)
620
552
def set_append_revisions_only(self, enabled):
621
553
if not self._format.supports_set_append_revisions_only():
622
raise errors.UpgradeRequired(self.user_url)
554
raise errors.UpgradeRequired(self.base)
673
605
def get_old_bound_location(self):
674
606
"""Return the URL of the branch we used to be bound to
676
raise errors.UpgradeRequired(self.user_url)
608
raise errors.UpgradeRequired(self.base)
678
610
def get_commit_builder(self, parents, config=None, timestamp=None,
679
611
timezone=None, committer=None, revprops=None,
759
691
if not self._format.supports_stacking():
760
raise errors.UnstackableBranchFormat(self._format, self.user_url)
692
raise errors.UnstackableBranchFormat(self._format, self.base)
761
693
# XXX: Changing from one fallback repository to another does not check
762
694
# that all the data you need is present in the new fallback.
763
695
# Possibly it should.
915
847
def unbind(self):
916
848
"""Older format branches cannot bind or unbind."""
917
raise errors.UpgradeRequired(self.user_url)
849
raise errors.UpgradeRequired(self.base)
919
851
def last_revision(self):
920
852
"""Return last revision id, or NULL_REVISION."""
1081
1013
return urlutils.join(self.base[:-1], parent)
1082
1014
except errors.InvalidURLJoin, e:
1083
raise errors.InaccessibleParent(parent, self.user_url)
1015
raise errors.InaccessibleParent(parent, self.base)
1085
1017
def _get_parent_location(self):
1086
1018
raise NotImplementedError(self._get_parent_location)
1357
1289
# XXX: Fix the bzrdir API to allow getting the branch back from the
1358
1290
# 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
1291
if revision_id is None:
1362
1292
revision_id = self.last_revision()
1363
1293
dir_to = self.bzrdir.clone_on_transport(to_transport,
1533
1463
"""Return the current default format."""
1534
1464
return klass._default_format
1536
def get_reference(self, a_bzrdir, name=None):
1466
def get_reference(self, a_bzrdir):
1537
1467
"""Get the target reference of the branch in a_bzrdir.
1539
1469
format probing must have been completed before calling
1541
1471
in a_bzrdir is correct.
1543
1473
:param a_bzrdir: The bzrdir to get the branch data from.
1544
:param name: Name of the colocated branch to fetch
1545
1474
:return: None if the branch is not a reference branch.
1550
def set_reference(self, a_bzrdir, name, to_branch):
1479
def set_reference(self, a_bzrdir, to_branch):
1551
1480
"""Set the target reference of the branch in a_bzrdir.
1553
1482
format probing must have been completed before calling
1555
1484
in a_bzrdir is correct.
1557
1486
:param a_bzrdir: The bzrdir to set the branch reference for.
1558
:param name: Name of colocated branch to set, None for default
1559
1487
:param to_branch: branch that the checkout is to reference
1561
1489
raise NotImplementedError(self.set_reference)
1590
1518
:return: a branch in this format
1592
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1520
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1593
1521
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1595
1523
'metadir': ('lock', lockdir.LockDir),
1788
1716
self.create_hook(HookPoint('post_branch_init',
1789
1717
"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))
1718
"post_branch_init is called with a bzrlib.branch.BranchInitHookParams. "
1719
"Note that init, branch and checkout will all trigger this hook.",
1794
1721
self.create_hook(HookPoint('post_switch',
1795
1722
"Called after a checkout switches branch. "
1796
1723
"post_switch is called with a "
1846
1773
There are 4 fields that hooks may wish to access:
1848
1775
:ivar format: the branch format
1849
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1776
:ivar bzrdir: the bzrdir where the branch will be/has been initialized
1850
1777
: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.
1778
:ivar branch: the branch
1858
1781
def __init__(self, format, a_bzrdir, name, branch):
1859
1782
"""Create a group of BranchInitHook parameters.
1861
1784
:param format: the branch format
1862
:param a_bzrdir: the BzrDir where the branch will be/has been
1785
:param a_bzrdir: the bzrdir where the branch will be/has been initialized
1864
1786
: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.
1787
:param branch: the branch
1871
1789
self.format = format
1872
1790
self.bzrdir = a_bzrdir
1982
1900
if format.__class__ != self.__class__:
1983
1901
raise AssertionError("wrong format %r found for %r" %
1984
1902
(format, self))
1985
transport = a_bzrdir.get_branch_transport(None, name=name)
1904
transport = a_bzrdir.get_branch_transport(None, name=name)
1987
1905
control_files = lockable_files.LockableFiles(transport, 'lock',
1988
1906
lockdir.LockDir)
1989
1907
return self._branch_class()(_format=self,
2171
2089
"""See BranchFormat.get_format_description()."""
2172
2090
return "Checkout reference format 1"
2174
def get_reference(self, a_bzrdir, name=None):
2092
def get_reference(self, a_bzrdir):
2175
2093
"""See BranchFormat.get_reference()."""
2176
transport = a_bzrdir.get_branch_transport(None, name=name)
2094
transport = a_bzrdir.get_branch_transport(None)
2177
2095
return transport.get_bytes('location')
2179
def set_reference(self, a_bzrdir, name, to_branch):
2097
def set_reference(self, a_bzrdir, to_branch):
2180
2098
"""See BranchFormat.set_reference()."""
2181
transport = a_bzrdir.get_branch_transport(None, name=name)
2099
transport = a_bzrdir.get_branch_transport(None)
2182
2100
location = transport.put_bytes('location', to_branch.base)
2184
2102
def initialize(self, a_bzrdir, name=None, target_branch=None):
2187
2105
# this format does not implement branch itself, thus the implicit
2188
2106
# creation contract must see it as uninitializable
2189
2107
raise errors.UninitializableFormat(self)
2190
mutter('creating branch reference in %s', a_bzrdir.user_url)
2108
mutter('creating branch reference in %s', a_bzrdir.transport.base)
2191
2109
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2192
2110
branch_transport.put_bytes('location',
2193
target_branch.bzrdir.user_url)
2111
target_branch.bzrdir.root_transport.base)
2194
2112
branch_transport.put_bytes('format', self.get_format_string())
2195
2113
branch = self.open(
2196
2114
a_bzrdir, name, _found=True,
2235
2153
raise AssertionError("wrong format %r found for %r" %
2236
2154
(format, self))
2237
2155
if location is None:
2238
location = self.get_reference(a_bzrdir, name)
2156
location = self.get_reference(a_bzrdir)
2239
2157
real_bzrdir = bzrdir.BzrDir.open(
2240
2158
location, possible_transports=possible_transports)
2241
2159
result = real_bzrdir.open_branch(name=name,
2279
2197
_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
2200
class BzrBranch(Branch, _RelockDebugMixin):
2300
2201
"""A branch stored in the actual filesystem.
2336
2237
def __str__(self):
2337
2238
if self.name is None:
2338
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2239
return '%s(%r)' % (self.__class__.__name__, self.base)
2340
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2241
return '%s(%r,%r)' % (self.__class__.__name__, self.base, self.name)
2343
2243
__repr__ = __str__
2355
2255
return self.control_files.is_locked()
2357
2257
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
2258
if not self.is_locked():
2365
2259
self._note_lock('w')
2366
2260
# All-in-one needs to always unlock/lock.
2373
2267
took_lock = False
2375
return BranchWriteLockResult(self.unlock,
2376
self.control_files.lock_write(token=token))
2269
return self.control_files.lock_write(token=token)
2379
2272
self.repository.unlock()
2382
2275
def lock_read(self):
2383
"""Lock the branch for read operations.
2385
:return: A bzrlib.lock.LogicalLockResult.
2387
2276
if not self.is_locked():
2388
2277
self._note_lock('r')
2389
2278
# All-in-one needs to always unlock/lock.
2573
2461
def get_stacked_on_url(self):
2574
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2462
raise errors.UnstackableBranchFormat(self._format, self.base)
2576
2464
def set_push_location(self, location):
2577
2465
"""See Branch.set_push_location."""
2767
2655
if _mod_revision.is_null(last_revision):
2769
2657
if last_revision not in self._lefthand_history(revision_id):
2770
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2658
raise errors.AppendRevisionsOnlyViolation(self.base)
2772
2660
def _gen_revision_history(self):
2773
2661
"""Generate the revision history from last revision
2873
2761
if branch_location is None:
2874
2762
return Branch.reference_parent(self, file_id, path,
2875
2763
possible_transports)
2876
branch_location = urlutils.join(self.user_url, branch_location)
2764
branch_location = urlutils.join(self.base, branch_location)
2877
2765
return Branch.open(branch_location,
2878
2766
possible_transports=possible_transports)
2925
2813
return stacked_url
2927
2815
def _get_append_revisions_only(self):
2928
return self.get_config(
2929
).get_user_option_as_bool('append_revisions_only')
2816
value = self.get_config().get_user_option('append_revisions_only')
2817
return value == 'True'
2931
2819
@needs_write_lock
2932
2820
def generate_revision_history(self, revision_id, last_rev=None,
2996
2884
def get_stacked_on_url(self):
2997
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2885
raise errors.UnstackableBranchFormat(self._format, self.base)
3000
2888
######################################################################
3087
2975
:param verbose: Requests more detailed display of what was checked,
3090
note('checked branch %s format %s', self.branch.user_url,
2978
note('checked branch %s format %s', self.branch.base,
3091
2979
self.branch._format)
3092
2980
for error in self.errors:
3093
2981
note('found error:%s', error)
3422
3310
if local and not bound_location:
3423
3311
raise errors.LocalRequiresBoundBranch()
3424
3312
master_branch = None
3425
if not local and bound_location and self.source.user_url != bound_location:
3313
if not local and bound_location and self.source.base != bound_location:
3426
3314
# not pulling from master, so we need to update master.
3427
3315
master_branch = self.target.get_master_branch(possible_transports)
3428
3316
master_branch.lock_write()
added
removed
bzrlib/branch.py
