63
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
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
######################################################################
66
class Branch(bzrdir.ControlComponent):
79
67
"""Branch holding a history of revisions.
82
Base directory/url of the branch.
70
Base directory/url of the branch; using control_url and
71
control_transport is more standardized.
84
73
hooks: An instance of BranchHooks.
420
417
* 'include' - the stop revision is the last item in the result
421
418
* 'with-merges' - include the stop revision and all of its
422
419
merged revisions in the result
420
* 'with-merges-without-common-ancestry' - filter out revisions
421
that are in both ancestries
423
422
:param direction: either 'reverse' or 'forward':
424
423
* reverse means return the start_revision_id first, i.e.
425
424
start at the most recent revision and go backwards in history
499
498
node.end_of_merge)
500
499
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,
502
513
elif stop_rule == 'with-merges':
503
514
stop_rev = self.repository.get_revision(stop_revision_id)
504
515
if stop_rev.parent_ids:
652
663
def get_old_bound_location(self):
653
664
"""Return the URL of the branch we used to be bound to
655
raise errors.UpgradeRequired(self.base)
666
raise errors.UpgradeRequired(self.user_url)
657
668
def get_commit_builder(self, parents, config=None, timestamp=None,
658
669
timezone=None, committer=None, revprops=None,
1543
1554
"""Return the short format description for this format."""
1544
1555
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)
1546
1565
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1547
1566
lock_type='metadir', set_format=True):
1548
1567
"""Initialize a branch in a bzrdir, with specified files
1586
1605
control_files.unlock()
1587
return self.open(a_bzrdir, name, _found=True)
1606
branch = self.open(a_bzrdir, name, _found=True)
1607
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1589
1610
def initialize(self, a_bzrdir, name=None):
1590
1611
"""Create a branch of this format in a_bzrdir.
1750
1771
"should return a tag name or None if no tag name could be "
1751
1772
"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))
1795
1826
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,
1798
1907
class BzrBranchFormat4(BranchFormat):
1799
1908
"""Bzr branch format 4.
1859
1968
if format.__class__ != self.__class__:
1860
1969
raise AssertionError("wrong format %r found for %r" %
1861
1970
(format, self))
1971
transport = a_bzrdir.get_branch_transport(None, name=name)
1863
transport = a_bzrdir.get_branch_transport(None, name=name)
1864
1973
control_files = lockable_files.LockableFiles(transport, 'lock',
1865
1974
lockdir.LockDir)
1866
1975
return self._branch_class()(_format=self,
2064
2173
# this format does not implement branch itself, thus the implicit
2065
2174
# creation contract must see it as uninitializable
2066
2175
raise errors.UninitializableFormat(self)
2067
mutter('creating branch reference in %s', a_bzrdir.transport.base)
2176
mutter('creating branch reference in %s', a_bzrdir.user_url)
2068
2177
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2069
2178
branch_transport.put_bytes('location',
2070
target_branch.bzrdir.root_transport.base)
2179
target_branch.bzrdir.user_url)
2071
2180
branch_transport.put_bytes('format', self.get_format_string())
2073
2182
a_bzrdir, name, _found=True,
2074
2183
possible_transports=[target_branch.bzrdir.root_transport])
2184
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2076
2187
def __init__(self):
2077
2188
super(BranchReferenceFormat, self).__init__()
2718
2830
if branch_location is None:
2719
2831
return Branch.reference_parent(self, file_id, path,
2720
2832
possible_transports)
2721
branch_location = urlutils.join(self.base, branch_location)
2833
branch_location = urlutils.join(self.user_url, branch_location)
2722
2834
return Branch.open(branch_location,
2723
2835
possible_transports=possible_transports)