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.
417
420
* 'include' - the stop revision is the last item in the result
418
421
* 'with-merges' - include the stop revision and all of its
419
422
merged revisions in the result
420
* 'with-merges-without-common-ancestry' - filter out revisions
421
that are in both ancestries
422
423
:param direction: either 'reverse' or 'forward':
423
424
* reverse means return the start_revision_id first, i.e.
424
425
start at the most recent revision and go backwards in history
446
447
# start_revision_id.
447
448
if self._merge_sorted_revisions_cache is None:
448
449
last_revision = self.last_revision()
449
known_graph = self.repository.get_known_graph_ancestry(
450
last_key = (last_revision,)
451
known_graph = self.repository.revisions.get_known_graph_ancestry(
451
453
self._merge_sorted_revisions_cache = known_graph.merge_sort(
453
455
filtered = self._filter_merge_sorted_revisions(
454
456
self._merge_sorted_revisions_cache, start_revision_id,
455
457
stop_revision_id, stop_rule)
456
458
# Make sure we don't return revisions that are not part of the
457
459
# start_revision_id ancestry.
458
filtered = self._filter_start_non_ancestors(filtered)
460
filtered = self._filter_non_ancestors(filtered)
459
461
if direction == 'reverse':
461
463
if direction == 'forward':
498
500
node.end_of_merge)
499
501
if rev_id == stop_revision_id:
501
elif stop_rule == 'with-merges-without-common-ancestry':
502
# We want to exclude all revisions that are already part of the
503
# stop_revision_id ancestry.
504
graph = self.repository.get_graph()
505
ancestors = graph.find_unique_ancestors(start_revision_id,
507
for node in rev_iter:
508
rev_id = node.key[-1]
509
if rev_id not in ancestors:
511
yield (rev_id, node.merge_depth, node.revno,
513
503
elif stop_rule == 'with-merges':
514
504
stop_rev = self.repository.get_revision(stop_revision_id)
515
505
if stop_rev.parent_ids:
663
653
def get_old_bound_location(self):
664
654
"""Return the URL of the branch we used to be bound to
666
raise errors.UpgradeRequired(self.user_url)
656
raise errors.UpgradeRequired(self.base)
668
658
def get_commit_builder(self, parents, config=None, timestamp=None,
669
659
timezone=None, committer=None, revprops=None,
1554
1544
"""Return the short format description for this format."""
1555
1545
raise NotImplementedError(self.get_format_description)
1557
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1558
hooks = Branch.hooks['post_branch_init']
1561
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1565
1547
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1566
1548
lock_type='metadir', set_format=True):
1567
1549
"""Initialize a branch in a bzrdir, with specified files
1605
1587
control_files.unlock()
1606
branch = self.open(a_bzrdir, name, _found=True)
1607
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1588
return self.open(a_bzrdir, name, _found=True)
1610
1590
def initialize(self, a_bzrdir, name=None):
1611
1591
"""Create a branch of this format in a_bzrdir.
1771
1751
"should return a tag name or None if no tag name could be "
1772
1752
"determined. The first non-None tag name returned will be used.",
1774
self.create_hook(HookPoint('post_branch_init',
1775
"Called after new branch initialization completes. "
1776
"post_branch_init is called with a "
1777
"bzrlib.branch.BranchInitHookParams. "
1778
"Note that init, branch and checkout (both heavyweight and "
1779
"lightweight) will all trigger this hook.", (2, 2), None))
1780
self.create_hook(HookPoint('post_switch',
1781
"Called after a checkout switches branch. "
1782
"post_switch is called with a "
1783
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1826
1796
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1829
class BranchInitHookParams(object):
1830
"""Object holding parameters passed to *_branch_init hooks.
1832
There are 4 fields that hooks may wish to access:
1834
:ivar format: the branch format
1835
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1836
:ivar name: name of colocated branch, if any (or None)
1837
:ivar branch: the branch created
1839
Note that for lightweight checkouts, the bzrdir and format fields refer to
1840
the checkout, hence they are different from the corresponding fields in
1841
branch, which refer to the original branch.
1844
def __init__(self, format, a_bzrdir, name, branch):
1845
"""Create a group of BranchInitHook parameters.
1847
:param format: the branch format
1848
:param a_bzrdir: the BzrDir where the branch will be/has been
1850
:param name: name of colocated branch, if any (or None)
1851
:param branch: the branch created
1853
Note that for lightweight checkouts, the bzrdir and format fields refer
1854
to the checkout, hence they are different from the corresponding fields
1855
in branch, which refer to the original branch.
1857
self.format = format
1858
self.bzrdir = a_bzrdir
1860
self.branch = branch
1862
def __eq__(self, other):
1863
return self.__dict__ == other.__dict__
1867
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1869
return "<%s of format:%s bzrdir:%s>" % (
1870
self.__class__.__name__, self.branch,
1871
self.format, self.bzrdir)
1874
class SwitchHookParams(object):
1875
"""Object holding parameters passed to *_switch hooks.
1877
There are 4 fields that hooks may wish to access:
1879
:ivar control_dir: BzrDir of the checkout to change
1880
:ivar to_branch: branch that the checkout is to reference
1881
:ivar force: skip the check for local commits in a heavy checkout
1882
:ivar revision_id: revision ID to switch to (or None)
1885
def __init__(self, control_dir, to_branch, force, revision_id):
1886
"""Create a group of SwitchHook parameters.
1888
:param control_dir: BzrDir of the checkout to change
1889
:param to_branch: branch that the checkout is to reference
1890
:param force: skip the check for local commits in a heavy checkout
1891
:param revision_id: revision ID to switch to (or None)
1893
self.control_dir = control_dir
1894
self.to_branch = to_branch
1896
self.revision_id = revision_id
1898
def __eq__(self, other):
1899
return self.__dict__ == other.__dict__
1902
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1903
self.control_dir, self.to_branch,
1907
1799
class BzrBranchFormat4(BranchFormat):
1908
1800
"""Bzr branch format 4.
1968
1860
if format.__class__ != self.__class__:
1969
1861
raise AssertionError("wrong format %r found for %r" %
1970
1862
(format, self))
1971
transport = a_bzrdir.get_branch_transport(None, name=name)
1864
transport = a_bzrdir.get_branch_transport(None, name=name)
1973
1865
control_files = lockable_files.LockableFiles(transport, 'lock',
1974
1866
lockdir.LockDir)
1975
1867
return self._branch_class()(_format=self,
2173
2065
# this format does not implement branch itself, thus the implicit
2174
2066
# creation contract must see it as uninitializable
2175
2067
raise errors.UninitializableFormat(self)
2176
mutter('creating branch reference in %s', a_bzrdir.user_url)
2068
mutter('creating branch reference in %s', a_bzrdir.transport.base)
2177
2069
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2178
2070
branch_transport.put_bytes('location',
2179
target_branch.bzrdir.user_url)
2071
target_branch.bzrdir.root_transport.base)
2180
2072
branch_transport.put_bytes('format', self.get_format_string())
2182
2074
a_bzrdir, name, _found=True,
2183
2075
possible_transports=[target_branch.bzrdir.root_transport])
2184
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2187
2077
def __init__(self):
2188
2078
super(BranchReferenceFormat, self).__init__()
2830
2719
if branch_location is None:
2831
2720
return Branch.reference_parent(self, file_id, path,
2832
2721
possible_transports)
2833
branch_location = urlutils.join(self.user_url, branch_location)
2722
branch_location = urlutils.join(self.base, branch_location)
2834
2723
return Branch.open(branch_location,
2835
2724
possible_transports=possible_transports)