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,
1547
1558
"""Return the short format description for this format."""
1548
1559
raise NotImplementedError(self.get_format_description)
1561
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1562
hooks = Branch.hooks['post_branch_init']
1565
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1550
1569
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1551
1570
lock_type='metadir', set_format=True):
1552
1571
"""Initialize a branch in a bzrdir, with specified files
1590
1609
control_files.unlock()
1591
return self.open(a_bzrdir, name, _found=True)
1610
branch = self.open(a_bzrdir, name, _found=True)
1611
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1593
1614
def initialize(self, a_bzrdir, name=None):
1594
1615
"""Create a branch of this format in a_bzrdir.
1754
1775
"should return a tag name or None if no tag name could be "
1755
1776
"determined. The first non-None tag name returned will be used.",
1778
self.create_hook(HookPoint('post_branch_init',
1779
"Called after new branch initialization completes. "
1780
"post_branch_init is called with a "
1781
"bzrlib.branch.BranchInitHookParams. "
1782
"Note that init, branch and checkout (both heavyweight and "
1783
"lightweight) will all trigger this hook.", (2, 2), None))
1784
self.create_hook(HookPoint('post_switch',
1785
"Called after a checkout switches branch. "
1786
"post_switch is called with a "
1787
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1799
1830
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1833
class BranchInitHookParams(object):
1834
"""Object holding parameters passed to *_branch_init hooks.
1836
There are 4 fields that hooks may wish to access:
1838
:ivar format: the branch format
1839
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1840
:ivar name: name of colocated branch, if any (or None)
1841
:ivar branch: the branch created
1843
Note that for lightweight checkouts, the bzrdir and format fields refer to
1844
the checkout, hence they are different from the corresponding fields in
1845
branch, which refer to the original branch.
1848
def __init__(self, format, a_bzrdir, name, branch):
1849
"""Create a group of BranchInitHook parameters.
1851
:param format: the branch format
1852
:param a_bzrdir: the BzrDir where the branch will be/has been
1854
:param name: name of colocated branch, if any (or None)
1855
:param branch: the branch created
1857
Note that for lightweight checkouts, the bzrdir and format fields refer
1858
to the checkout, hence they are different from the corresponding fields
1859
in branch, which refer to the original branch.
1861
self.format = format
1862
self.bzrdir = a_bzrdir
1864
self.branch = branch
1866
def __eq__(self, other):
1867
return self.__dict__ == other.__dict__
1871
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1873
return "<%s of format:%s bzrdir:%s>" % (
1874
self.__class__.__name__, self.branch,
1875
self.format, self.bzrdir)
1878
class SwitchHookParams(object):
1879
"""Object holding parameters passed to *_switch hooks.
1881
There are 4 fields that hooks may wish to access:
1883
:ivar control_dir: BzrDir of the checkout to change
1884
:ivar to_branch: branch that the checkout is to reference
1885
:ivar force: skip the check for local commits in a heavy checkout
1886
:ivar revision_id: revision ID to switch to (or None)
1889
def __init__(self, control_dir, to_branch, force, revision_id):
1890
"""Create a group of SwitchHook parameters.
1892
:param control_dir: BzrDir of the checkout to change
1893
:param to_branch: branch that the checkout is to reference
1894
:param force: skip the check for local commits in a heavy checkout
1895
:param revision_id: revision ID to switch to (or None)
1897
self.control_dir = control_dir
1898
self.to_branch = to_branch
1900
self.revision_id = revision_id
1902
def __eq__(self, other):
1903
return self.__dict__ == other.__dict__
1906
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1907
self.control_dir, self.to_branch,
1802
1911
class BzrBranchFormat4(BranchFormat):
1803
1912
"""Bzr branch format 4.
1863
1972
if format.__class__ != self.__class__:
1864
1973
raise AssertionError("wrong format %r found for %r" %
1865
1974
(format, self))
1975
transport = a_bzrdir.get_branch_transport(None, name=name)
1867
transport = a_bzrdir.get_branch_transport(None, name=name)
1868
1977
control_files = lockable_files.LockableFiles(transport, 'lock',
1869
1978
lockdir.LockDir)
1870
1979
return self._branch_class()(_format=self,
2068
2177
# this format does not implement branch itself, thus the implicit
2069
2178
# creation contract must see it as uninitializable
2070
2179
raise errors.UninitializableFormat(self)
2071
mutter('creating branch reference in %s', a_bzrdir.transport.base)
2180
mutter('creating branch reference in %s', a_bzrdir.user_url)
2072
2181
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2073
2182
branch_transport.put_bytes('location',
2074
target_branch.bzrdir.root_transport.base)
2183
target_branch.bzrdir.user_url)
2075
2184
branch_transport.put_bytes('format', self.get_format_string())
2077
2186
a_bzrdir, name, _found=True,
2078
2187
possible_transports=[target_branch.bzrdir.root_transport])
2188
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2080
2191
def __init__(self):
2081
2192
super(BranchReferenceFormat, self).__init__()
2722
2834
if branch_location is None:
2723
2835
return Branch.reference_parent(self, file_id, path,
2724
2836
possible_transports)
2725
branch_location = urlutils.join(self.base, branch_location)
2837
branch_location = urlutils.join(self.user_url, branch_location)
2726
2838
return Branch.open(branch_location,
2727
2839
possible_transports=possible_transports)