1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from bzrlib.lazy_import import lazy_import
19
lazy_import(globals(), """
23
config as _mod_config,
29
revision as _mod_revision,
35
from bzrlib.config import BranchConfig
36
from bzrlib.tag import (
42
from bzrlib.decorators import needs_read_lock, needs_write_lock
43
from bzrlib.hooks import Hooks
44
from bzrlib.symbol_versioning import (
48
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
51
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
52
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
53
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
56
# TODO: Maybe include checks for common corruption of newlines, etc?
58
# TODO: Some operations like log might retrieve the same revisions
59
# repeatedly to calculate deltas. We could perhaps have a weakref
60
# cache in memory to make this faster. In general anything can be
61
# cached in memory between lock and unlock operations. .. nb thats
62
# what the transaction identity map provides
65
######################################################################
69
"""Branch holding a history of revisions.
72
Base directory/url of the branch.
74
hooks: An instance of BranchHooks.
76
# this is really an instance variable - FIXME move it there
80
# override this to set the strategy for storing tags
82
return DisabledTags(self)
84
def __init__(self, *ignored, **ignored_too):
85
self.tags = self._make_tags()
86
self._revision_history_cache = None
87
self._revision_id_to_revno_cache = None
88
self._last_revision_info_cache = None
91
"""Break a lock if one is present from another instance.
93
Uses the ui factory to ask for confirmation if the lock may be from
96
This will probe the repository for its lock as well.
98
self.control_files.break_lock()
99
self.repository.break_lock()
100
master = self.get_master_branch()
101
if master is not None:
105
def open(base, _unsupported=False, possible_transports=None):
106
"""Open the branch rooted at base.
108
For instance, if the branch is at URL/.bzr/branch,
109
Branch.open(URL) -> a Branch instance.
111
control = bzrdir.BzrDir.open(base, _unsupported,
112
possible_transports=possible_transports)
113
return control.open_branch(_unsupported)
116
def open_from_transport(transport, _unsupported=False):
117
"""Open the branch rooted at transport"""
118
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
119
return control.open_branch(_unsupported)
122
def open_containing(url, possible_transports=None):
123
"""Open an existing branch which contains url.
125
This probes for a branch at url, and searches upwards from there.
127
Basically we keep looking up until we find the control directory or
128
run into the root. If there isn't one, raises NotBranchError.
129
If there is one and it is either an unrecognised format or an unsupported
130
format, UnknownFormatError or UnsupportedFormatError are raised.
131
If there is one, it is returned, along with the unused portion of url.
133
control, relpath = bzrdir.BzrDir.open_containing(url,
135
return control.open_branch(), relpath
137
def get_config(self):
138
return BranchConfig(self)
141
return self.get_config().get_nickname()
143
def _set_nick(self, nick):
144
self.get_config().set_user_option('nickname', nick, warn_masked=True)
146
nick = property(_get_nick, _set_nick)
149
raise NotImplementedError(self.is_locked)
151
def lock_write(self):
152
raise NotImplementedError(self.lock_write)
155
raise NotImplementedError(self.lock_read)
158
raise NotImplementedError(self.unlock)
160
def peek_lock_mode(self):
161
"""Return lock mode for the Branch: 'r', 'w' or None"""
162
raise NotImplementedError(self.peek_lock_mode)
164
def get_physical_lock_status(self):
165
raise NotImplementedError(self.get_physical_lock_status)
168
def get_revision_id_to_revno_map(self):
169
"""Return the revision_id => dotted revno map.
171
This will be regenerated on demand, but will be cached.
173
:return: A dictionary mapping revision_id => dotted revno.
174
This dictionary should not be modified by the caller.
176
if self._revision_id_to_revno_cache is not None:
177
mapping = self._revision_id_to_revno_cache
179
mapping = self._gen_revno_map()
180
self._cache_revision_id_to_revno(mapping)
181
# TODO: jam 20070417 Since this is being cached, should we be returning
183
# I would rather not, and instead just declare that users should not
184
# modify the return value.
187
def _gen_revno_map(self):
188
"""Create a new mapping from revision ids to dotted revnos.
190
Dotted revnos are generated based on the current tip in the revision
192
This is the worker function for get_revision_id_to_revno_map, which
193
just caches the return value.
195
:return: A dictionary mapping revision_id => dotted revno.
197
last_revision = self.last_revision()
198
revision_graph = repository._old_get_graph(self.repository,
200
merge_sorted_revisions = tsort.merge_sort(
205
revision_id_to_revno = dict((rev_id, revno)
206
for seq_num, rev_id, depth, revno, end_of_merge
207
in merge_sorted_revisions)
208
return revision_id_to_revno
210
def leave_lock_in_place(self):
211
"""Tell this branch object not to release the physical lock when this
214
If lock_write doesn't return a token, then this method is not supported.
216
self.control_files.leave_in_place()
218
def dont_leave_lock_in_place(self):
219
"""Tell this branch object to release the physical lock when this
220
object is unlocked, even if it didn't originally acquire it.
222
If lock_write doesn't return a token, then this method is not supported.
224
self.control_files.dont_leave_in_place()
226
@deprecated_method(deprecated_in((0, 16, 0)))
227
def abspath(self, name):
228
"""Return absolute filename for something in the branch
230
XXX: Robert Collins 20051017 what is this used for? why is it a branch
231
method and not a tree method.
233
raise NotImplementedError(self.abspath)
235
def bind(self, other):
236
"""Bind the local branch the other branch.
238
:param other: The branch to bind to
241
raise errors.UpgradeRequired(self.base)
244
def fetch(self, from_branch, last_revision=None, pb=None):
245
"""Copy revisions from from_branch into this branch.
247
:param from_branch: Where to copy from.
248
:param last_revision: What revision to stop at (None for at the end
250
:param pb: An optional progress bar to use.
252
Returns the copied revision count and the failed revisions in a tuple:
255
if self.base == from_branch.base:
258
nested_pb = ui.ui_factory.nested_progress_bar()
263
from_branch.lock_read()
265
if last_revision is None:
266
pb.update('get source history')
267
last_revision = from_branch.last_revision()
268
last_revision = _mod_revision.ensure_null(last_revision)
269
return self.repository.fetch(from_branch.repository,
270
revision_id=last_revision,
273
if nested_pb is not None:
277
def get_bound_location(self):
278
"""Return the URL of the branch we are bound to.
280
Older format branches cannot bind, please be sure to use a metadir
285
def get_old_bound_location(self):
286
"""Return the URL of the branch we used to be bound to
288
raise errors.UpgradeRequired(self.base)
290
def get_commit_builder(self, parents, config=None, timestamp=None,
291
timezone=None, committer=None, revprops=None,
293
"""Obtain a CommitBuilder for this branch.
295
:param parents: Revision ids of the parents of the new revision.
296
:param config: Optional configuration to use.
297
:param timestamp: Optional timestamp recorded for commit.
298
:param timezone: Optional timezone for timestamp.
299
:param committer: Optional committer to set for commit.
300
:param revprops: Optional dictionary of revision properties.
301
:param revision_id: Optional revision id.
305
config = self.get_config()
307
return self.repository.get_commit_builder(self, parents, config,
308
timestamp, timezone, committer, revprops, revision_id)
310
def get_master_branch(self, possible_transports=None):
311
"""Return the branch we are bound to.
313
:return: Either a Branch, or None
317
def get_revision_delta(self, revno):
318
"""Return the delta for one revision.
320
The delta is relative to its mainline predecessor, or the
321
empty tree for revision 1.
323
rh = self.revision_history()
324
if not (1 <= revno <= len(rh)):
325
raise errors.InvalidRevisionNumber(revno)
326
return self.repository.get_revision_delta(rh[revno-1])
328
def print_file(self, file, revision_id):
329
"""Print `file` to stdout."""
330
raise NotImplementedError(self.print_file)
332
def set_revision_history(self, rev_history):
333
raise NotImplementedError(self.set_revision_history)
335
def _cache_revision_history(self, rev_history):
336
"""Set the cached revision history to rev_history.
338
The revision_history method will use this cache to avoid regenerating
339
the revision history.
341
This API is semi-public; it only for use by subclasses, all other code
342
should consider it to be private.
344
self._revision_history_cache = rev_history
346
def _cache_revision_id_to_revno(self, revision_id_to_revno):
347
"""Set the cached revision_id => revno map to revision_id_to_revno.
349
This API is semi-public; it only for use by subclasses, all other code
350
should consider it to be private.
352
self._revision_id_to_revno_cache = revision_id_to_revno
354
def _clear_cached_state(self):
355
"""Clear any cached data on this branch, e.g. cached revision history.
357
This means the next call to revision_history will need to call
358
_gen_revision_history.
360
This API is semi-public; it only for use by subclasses, all other code
361
should consider it to be private.
363
self._revision_history_cache = None
364
self._revision_id_to_revno_cache = None
365
self._last_revision_info_cache = None
367
def _gen_revision_history(self):
368
"""Return sequence of revision hashes on to this branch.
370
Unlike revision_history, this method always regenerates or rereads the
371
revision history, i.e. it does not cache the result, so repeated calls
374
Concrete subclasses should override this instead of revision_history so
375
that subclasses do not need to deal with caching logic.
377
This API is semi-public; it only for use by subclasses, all other code
378
should consider it to be private.
380
raise NotImplementedError(self._gen_revision_history)
383
def revision_history(self):
384
"""Return sequence of revision ids on this branch.
386
This method will cache the revision history for as long as it is safe to
389
if 'evil' in debug.debug_flags:
390
mutter_callsite(3, "revision_history scales with history.")
391
if self._revision_history_cache is not None:
392
history = self._revision_history_cache
394
history = self._gen_revision_history()
395
self._cache_revision_history(history)
399
"""Return current revision number for this branch.
401
That is equivalent to the number of revisions committed to
404
return self.last_revision_info()[0]
407
"""Older format branches cannot bind or unbind."""
408
raise errors.UpgradeRequired(self.base)
410
def set_append_revisions_only(self, enabled):
411
"""Older format branches are never restricted to append-only"""
412
raise errors.UpgradeRequired(self.base)
414
def last_revision(self):
415
"""Return last revision id, or NULL_REVISION."""
416
return self.last_revision_info()[1]
419
def last_revision_info(self):
420
"""Return information about the last revision.
422
:return: A tuple (revno, revision_id).
424
if self._last_revision_info_cache is None:
425
self._last_revision_info_cache = self._last_revision_info()
426
return self._last_revision_info_cache
428
def _last_revision_info(self):
429
rh = self.revision_history()
432
return (revno, rh[-1])
434
return (0, _mod_revision.NULL_REVISION)
436
@deprecated_method(deprecated_in((1, 6, 0)))
437
def missing_revisions(self, other, stop_revision=None):
438
"""Return a list of new revisions that would perfectly fit.
440
If self and other have not diverged, return a list of the revisions
441
present in other, but missing from self.
443
self_history = self.revision_history()
444
self_len = len(self_history)
445
other_history = other.revision_history()
446
other_len = len(other_history)
447
common_index = min(self_len, other_len) -1
448
if common_index >= 0 and \
449
self_history[common_index] != other_history[common_index]:
450
raise errors.DivergedBranches(self, other)
452
if stop_revision is None:
453
stop_revision = other_len
455
if stop_revision > other_len:
456
raise errors.NoSuchRevision(self, stop_revision)
457
return other_history[self_len:stop_revision]
460
def update_revisions(self, other, stop_revision=None, overwrite=False,
462
"""Pull in new perfect-fit revisions.
464
:param other: Another Branch to pull from
465
:param stop_revision: Updated until the given revision
466
:param overwrite: Always set the branch pointer, rather than checking
467
to see if it is a proper descendant.
468
:param graph: A Graph object that can be used to query history
469
information. This can be None.
474
other_revno, other_last_revision = other.last_revision_info()
475
stop_revno = None # unknown
476
if stop_revision is None:
477
stop_revision = other_last_revision
478
if _mod_revision.is_null(stop_revision):
479
# if there are no commits, we're done.
481
stop_revno = other_revno
483
# what's the current last revision, before we fetch [and change it
485
last_rev = _mod_revision.ensure_null(self.last_revision())
486
# we fetch here so that we don't process data twice in the common
487
# case of having something to pull, and so that the check for
488
# already merged can operate on the just fetched graph, which will
489
# be cached in memory.
490
self.fetch(other, stop_revision)
491
# Check to see if one is an ancestor of the other
494
graph = self.repository.get_graph()
495
if self._check_if_descendant_or_diverged(
496
stop_revision, last_rev, graph, other):
497
# stop_revision is a descendant of last_rev, but we aren't
498
# overwriting, so we're done.
500
if stop_revno is None:
502
graph = self.repository.get_graph()
503
this_revno, this_last_revision = self.last_revision_info()
504
stop_revno = graph.find_distance_to_null(stop_revision,
505
[(other_last_revision, other_revno),
506
(this_last_revision, this_revno)])
507
self.set_last_revision_info(stop_revno, stop_revision)
513
def revision_id_to_revno(self, revision_id):
514
"""Given a revision id, return its revno"""
515
if _mod_revision.is_null(revision_id):
517
history = self.revision_history()
519
return history.index(revision_id) + 1
521
raise errors.NoSuchRevision(self, revision_id)
523
def get_rev_id(self, revno, history=None):
524
"""Find the revision id of the specified revno."""
526
return _mod_revision.NULL_REVISION
528
history = self.revision_history()
529
if revno <= 0 or revno > len(history):
530
raise errors.NoSuchRevision(self, revno)
531
return history[revno - 1]
533
def pull(self, source, overwrite=False, stop_revision=None,
534
possible_transports=None, _override_hook_target=None):
535
"""Mirror source into this branch.
537
This branch is considered to be 'local', having low latency.
539
:returns: PullResult instance
541
raise NotImplementedError(self.pull)
543
def push(self, target, overwrite=False, stop_revision=None):
544
"""Mirror this branch into target.
546
This branch is considered to be 'local', having low latency.
548
raise NotImplementedError(self.push)
550
def basis_tree(self):
551
"""Return `Tree` object for last revision."""
552
return self.repository.revision_tree(self.last_revision())
554
def rename_one(self, from_rel, to_rel):
557
This can change the directory or the filename or both.
559
raise NotImplementedError(self.rename_one)
561
def move(self, from_paths, to_name):
564
to_name must exist as a versioned directory.
566
If to_name exists and is a directory, the files are moved into
567
it, keeping their old names. If it is a directory,
569
Note that to_name is only the last component of the new name;
570
this doesn't change the directory.
572
This returns a list of (from_path, to_path) pairs for each
575
raise NotImplementedError(self.move)
577
def get_parent(self):
578
"""Return the parent location of the branch.
580
This is the default location for push/pull/missing. The usual
581
pattern is that the user can override it by specifying a
584
raise NotImplementedError(self.get_parent)
586
def _set_config_location(self, name, url, config=None,
587
make_relative=False):
589
config = self.get_config()
593
url = urlutils.relative_url(self.base, url)
594
config.set_user_option(name, url, warn_masked=True)
596
def _get_config_location(self, name, config=None):
598
config = self.get_config()
599
location = config.get_user_option(name)
604
def get_submit_branch(self):
605
"""Return the submit location of the branch.
607
This is the default location for bundle. The usual
608
pattern is that the user can override it by specifying a
611
return self.get_config().get_user_option('submit_branch')
613
def set_submit_branch(self, location):
614
"""Return the submit location of the branch.
616
This is the default location for bundle. The usual
617
pattern is that the user can override it by specifying a
620
self.get_config().set_user_option('submit_branch', location,
623
def get_public_branch(self):
624
"""Return the public location of the branch.
626
This is is used by merge directives.
628
return self._get_config_location('public_branch')
630
def set_public_branch(self, location):
631
"""Return the submit location of the branch.
633
This is the default location for bundle. The usual
634
pattern is that the user can override it by specifying a
637
self._set_config_location('public_branch', location)
639
def get_push_location(self):
640
"""Return the None or the location to push this branch to."""
641
push_loc = self.get_config().get_user_option('push_location')
644
def set_push_location(self, location):
645
"""Set a new push location for this branch."""
646
raise NotImplementedError(self.set_push_location)
648
def set_parent(self, url):
649
raise NotImplementedError(self.set_parent)
653
"""Synchronise this branch with the master branch if any.
655
:return: None or the last_revision pivoted out during the update.
659
def check_revno(self, revno):
661
Check whether a revno corresponds to any revision.
662
Zero (the NULL revision) is considered valid.
665
self.check_real_revno(revno)
667
def check_real_revno(self, revno):
669
Check whether a revno corresponds to a real revision.
670
Zero (the NULL revision) is considered invalid
672
if revno < 1 or revno > self.revno():
673
raise errors.InvalidRevisionNumber(revno)
676
def clone(self, to_bzrdir, revision_id=None):
677
"""Clone this branch into to_bzrdir preserving all semantic values.
679
revision_id: if not None, the revision history in the new branch will
680
be truncated to end with revision_id.
682
result = self._format.initialize(to_bzrdir)
683
self.copy_content_into(result, revision_id=revision_id)
687
def sprout(self, to_bzrdir, revision_id=None):
688
"""Create a new line of development from the branch, into to_bzrdir.
690
revision_id: if not None, the revision history in the new branch will
691
be truncated to end with revision_id.
693
result = self._format.initialize(to_bzrdir)
694
self.copy_content_into(result, revision_id=revision_id)
695
result.set_parent(self.bzrdir.root_transport.base)
698
def _synchronize_history(self, destination, revision_id):
699
"""Synchronize last revision and revision history between branches.
701
This version is most efficient when the destination is also a
702
BzrBranch5, but works for BzrBranch6 as long as the revision
703
history is the true lefthand parent history, and all of the revisions
704
are in the destination's repository. If not, set_revision_history
707
:param destination: The branch to copy the history into
708
:param revision_id: The revision-id to truncate history at. May
709
be None to copy complete history.
711
if revision_id == _mod_revision.NULL_REVISION:
713
new_history = self.revision_history()
714
if revision_id is not None and new_history != []:
716
new_history = new_history[:new_history.index(revision_id) + 1]
718
rev = self.repository.get_revision(revision_id)
719
new_history = rev.get_history(self.repository)[1:]
720
destination.set_revision_history(new_history)
723
def copy_content_into(self, destination, revision_id=None):
724
"""Copy the content of self into destination.
726
revision_id: if not None, the revision history in the new branch will
727
be truncated to end with revision_id.
729
self._synchronize_history(destination, revision_id)
731
parent = self.get_parent()
732
except errors.InaccessibleParent, e:
733
mutter('parent was not accessible to copy: %s', e)
736
destination.set_parent(parent)
737
self.tags.merge_to(destination.tags)
741
"""Check consistency of the branch.
743
In particular this checks that revisions given in the revision-history
744
do actually match up in the revision graph, and that they're all
745
present in the repository.
747
Callers will typically also want to check the repository.
749
:return: A BranchCheckResult.
751
mainline_parent_id = None
752
last_revno, last_revision_id = self.last_revision_info()
753
real_rev_history = list(self.repository.iter_reverse_revision_history(
755
real_rev_history.reverse()
756
if len(real_rev_history) != last_revno:
757
raise errors.BzrCheckError('revno does not match len(mainline)'
758
' %s != %s' % (last_revno, len(real_rev_history)))
759
# TODO: We should probably also check that real_rev_history actually
760
# matches self.revision_history()
761
for revision_id in real_rev_history:
763
revision = self.repository.get_revision(revision_id)
764
except errors.NoSuchRevision, e:
765
raise errors.BzrCheckError("mainline revision {%s} not in repository"
767
# In general the first entry on the revision history has no parents.
768
# But it's not illegal for it to have parents listed; this can happen
769
# in imports from Arch when the parents weren't reachable.
770
if mainline_parent_id is not None:
771
if mainline_parent_id not in revision.parent_ids:
772
raise errors.BzrCheckError("previous revision {%s} not listed among "
774
% (mainline_parent_id, revision_id))
775
mainline_parent_id = revision_id
776
return BranchCheckResult(self)
778
def _get_checkout_format(self):
779
"""Return the most suitable metadir for a checkout of this branch.
780
Weaves are used if this branch's repository uses weaves.
782
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
783
from bzrlib.repofmt import weaverepo
784
format = bzrdir.BzrDirMetaFormat1()
785
format.repository_format = weaverepo.RepositoryFormat7()
787
format = self.repository.bzrdir.checkout_metadir()
788
format.set_branch_format(self._format)
791
def create_checkout(self, to_location, revision_id=None,
792
lightweight=False, accelerator_tree=None,
794
"""Create a checkout of a branch.
796
:param to_location: The url to produce the checkout at
797
:param revision_id: The revision to check out
798
:param lightweight: If True, produce a lightweight checkout, otherwise,
799
produce a bound branch (heavyweight checkout)
800
:param accelerator_tree: A tree which can be used for retrieving file
801
contents more quickly than the revision tree, i.e. a workingtree.
802
The revision tree will be used for cases where accelerator_tree's
803
content is different.
804
:param hardlink: If true, hard-link files from accelerator_tree,
806
:return: The tree of the created checkout
808
t = transport.get_transport(to_location)
811
format = self._get_checkout_format()
812
checkout = format.initialize_on_transport(t)
813
from_branch = BranchReferenceFormat().initialize(checkout, self)
815
format = self._get_checkout_format()
816
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
817
to_location, force_new_tree=False, format=format)
818
checkout = checkout_branch.bzrdir
819
checkout_branch.bind(self)
820
# pull up to the specified revision_id to set the initial
821
# branch tip correctly, and seed it with history.
822
checkout_branch.pull(self, stop_revision=revision_id)
824
tree = checkout.create_workingtree(revision_id,
825
from_branch=from_branch,
826
accelerator_tree=accelerator_tree,
828
basis_tree = tree.basis_tree()
829
basis_tree.lock_read()
831
for path, file_id in basis_tree.iter_references():
832
reference_parent = self.reference_parent(file_id, path)
833
reference_parent.create_checkout(tree.abspath(path),
834
basis_tree.get_reference_revision(file_id, path),
841
def reconcile(self, thorough=True):
842
"""Make sure the data stored in this branch is consistent."""
843
from bzrlib.reconcile import BranchReconciler
844
reconciler = BranchReconciler(self, thorough=thorough)
845
reconciler.reconcile()
848
def reference_parent(self, file_id, path):
849
"""Return the parent branch for a tree-reference file_id
850
:param file_id: The file_id of the tree reference
851
:param path: The path of the file_id in the tree
852
:return: A branch associated with the file_id
854
# FIXME should provide multiple branches, based on config
855
return Branch.open(self.bzrdir.root_transport.clone(path).base)
857
def supports_tags(self):
858
return self._format.supports_tags()
860
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
862
"""Ensure that revision_b is a descendant of revision_a.
864
This is a helper function for update_revisions.
866
:raises: DivergedBranches if revision_b has diverged from revision_a.
867
:returns: True if revision_b is a descendant of revision_a.
869
relation = self._revision_relations(revision_a, revision_b, graph)
870
if relation == 'b_descends_from_a':
872
elif relation == 'diverged':
873
raise errors.DivergedBranches(self, other_branch)
874
elif relation == 'a_descends_from_b':
877
raise AssertionError("invalid heads: %r" % heads)
879
def _revision_relations(self, revision_a, revision_b, graph):
880
"""Determine the relationship between two revisions.
882
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
884
heads = graph.heads([revision_a, revision_b])
885
if heads == set([revision_b]):
886
return 'b_descends_from_a'
887
elif heads == set([revision_a, revision_b]):
888
# These branches have diverged
890
elif heads == set([revision_a]):
891
return 'a_descends_from_b'
893
raise AssertionError("invalid heads: %r" % heads)
896
class BranchFormat(object):
897
"""An encapsulation of the initialization and open routines for a format.
899
Formats provide three things:
900
* An initialization routine,
904
Formats are placed in an dict by their format string for reference
905
during branch opening. Its not required that these be instances, they
906
can be classes themselves with class methods - it simply depends on
907
whether state is needed for a given format or not.
909
Once a format is deprecated, just deprecate the initialize and open
910
methods on the format class. Do not deprecate the object, as the
911
object will be created every time regardless.
914
_default_format = None
915
"""The default format used for new branches."""
918
"""The known formats."""
920
def __eq__(self, other):
921
return self.__class__ is other.__class__
923
def __ne__(self, other):
924
return not (self == other)
927
def find_format(klass, a_bzrdir):
928
"""Return the format for the branch object in a_bzrdir."""
930
transport = a_bzrdir.get_branch_transport(None)
931
format_string = transport.get("format").read()
932
return klass._formats[format_string]
933
except errors.NoSuchFile:
934
raise errors.NotBranchError(path=transport.base)
936
raise errors.UnknownFormatError(format=format_string, kind='branch')
939
def get_default_format(klass):
940
"""Return the current default format."""
941
return klass._default_format
943
def get_reference(self, a_bzrdir):
944
"""Get the target reference of the branch in a_bzrdir.
946
format probing must have been completed before calling
947
this method - it is assumed that the format of the branch
948
in a_bzrdir is correct.
950
:param a_bzrdir: The bzrdir to get the branch data from.
951
:return: None if the branch is not a reference branch.
956
def set_reference(self, a_bzrdir, to_branch):
957
"""Set the target reference of the branch in a_bzrdir.
959
format probing must have been completed before calling
960
this method - it is assumed that the format of the branch
961
in a_bzrdir is correct.
963
:param a_bzrdir: The bzrdir to set the branch reference for.
964
:param to_branch: branch that the checkout is to reference
966
raise NotImplementedError(self.set_reference)
968
def get_format_string(self):
969
"""Return the ASCII format string that identifies this format."""
970
raise NotImplementedError(self.get_format_string)
972
def get_format_description(self):
973
"""Return the short format description for this format."""
974
raise NotImplementedError(self.get_format_description)
976
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
978
"""Initialize a branch in a bzrdir, with specified files
980
:param a_bzrdir: The bzrdir to initialize the branch in
981
:param utf8_files: The files to create as a list of
982
(filename, content) tuples
983
:param set_format: If True, set the format with
984
self.get_format_string. (BzrBranch4 has its format set
986
:return: a branch in this format
988
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
989
branch_transport = a_bzrdir.get_branch_transport(self)
991
'metadir': ('lock', lockdir.LockDir),
992
'branch4': ('branch-lock', lockable_files.TransportLock),
994
lock_name, lock_class = lock_map[lock_type]
995
control_files = lockable_files.LockableFiles(branch_transport,
996
lock_name, lock_class)
997
control_files.create_lock()
998
control_files.lock_write()
1000
utf8_files += [('format', self.get_format_string())]
1002
for (filename, content) in utf8_files:
1003
branch_transport.put_bytes(
1005
mode=a_bzrdir._get_file_mode())
1007
control_files.unlock()
1008
return self.open(a_bzrdir, _found=True)
1010
def initialize(self, a_bzrdir):
1011
"""Create a branch of this format in a_bzrdir."""
1012
raise NotImplementedError(self.initialize)
1014
def is_supported(self):
1015
"""Is this format supported?
1017
Supported formats can be initialized and opened.
1018
Unsupported formats may not support initialization or committing or
1019
some other features depending on the reason for not being supported.
1023
def open(self, a_bzrdir, _found=False):
1024
"""Return the branch object for a_bzrdir
1026
_found is a private parameter, do not use it. It is used to indicate
1027
if format probing has already be done.
1029
raise NotImplementedError(self.open)
1032
def register_format(klass, format):
1033
klass._formats[format.get_format_string()] = format
1036
def set_default_format(klass, format):
1037
klass._default_format = format
1040
def unregister_format(klass, format):
1041
del klass._formats[format.get_format_string()]
1044
return self.get_format_string().rstrip()
1046
def supports_tags(self):
1047
"""True if this format supports tags stored in the branch"""
1048
return False # by default
1051
class BranchHooks(Hooks):
1052
"""A dictionary mapping hook name to a list of callables for branch hooks.
1054
e.g. ['set_rh'] Is the list of items to be called when the
1055
set_revision_history function is invoked.
1059
"""Create the default hooks.
1061
These are all empty initially, because by default nothing should get
1064
Hooks.__init__(self)
1065
# Introduced in 0.15:
1066
# invoked whenever the revision history has been set
1067
# with set_revision_history. The api signature is
1068
# (branch, revision_history), and the branch will
1071
# invoked after a push operation completes.
1072
# the api signature is
1074
# containing the members
1075
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1076
# where local is the local target branch or None, master is the target
1077
# master branch, and the rest should be self explanatory. The source
1078
# is read locked and the target branches write locked. Source will
1079
# be the local low-latency branch.
1080
self['post_push'] = []
1081
# invoked after a pull operation completes.
1082
# the api signature is
1084
# containing the members
1085
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1086
# where local is the local branch or None, master is the target
1087
# master branch, and the rest should be self explanatory. The source
1088
# is read locked and the target branches write locked. The local
1089
# branch is the low-latency branch.
1090
self['post_pull'] = []
1091
# invoked before a commit operation takes place.
1092
# the api signature is
1093
# (local, master, old_revno, old_revid, future_revno, future_revid,
1094
# tree_delta, future_tree).
1095
# old_revid is NULL_REVISION for the first commit to a branch
1096
# tree_delta is a TreeDelta object describing changes from the basis
1097
# revision, hooks MUST NOT modify this delta
1098
# future_tree is an in-memory tree obtained from
1099
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1100
self['pre_commit'] = []
1101
# invoked after a commit operation completes.
1102
# the api signature is
1103
# (local, master, old_revno, old_revid, new_revno, new_revid)
1104
# old_revid is NULL_REVISION for the first commit to a branch.
1105
self['post_commit'] = []
1106
# invoked after a uncommit operation completes.
1107
# the api signature is
1108
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1109
# local is the local branch or None, master is the target branch,
1110
# and an empty branch recieves new_revno of 0, new_revid of None.
1111
self['post_uncommit'] = []
1113
# Invoked before the tip of a branch changes.
1114
# the api signature is
1115
# (params) where params is a ChangeBranchTipParams with the members
1116
# (branch, old_revno, new_revno, old_revid, new_revid)
1117
self['pre_change_branch_tip'] = []
1119
# Invoked after the tip of a branch changes.
1120
# the api signature is
1121
# (params) where params is a ChangeBranchTipParams with the members
1122
# (branch, old_revno, new_revno, old_revid, new_revid)
1123
self['post_change_branch_tip'] = []
1126
# install the default hooks into the Branch class.
1127
Branch.hooks = BranchHooks()
1130
class ChangeBranchTipParams(object):
1131
"""Object holding parameters passed to *_change_branch_tip hooks.
1133
There are 5 fields that hooks may wish to access:
1135
:ivar branch: the branch being changed
1136
:ivar old_revno: revision number before the change
1137
:ivar new_revno: revision number after the change
1138
:ivar old_revid: revision id before the change
1139
:ivar new_revid: revision id after the change
1141
The revid fields are strings. The revno fields are integers.
1144
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1145
"""Create a group of ChangeBranchTip parameters.
1147
:param branch: The branch being changed.
1148
:param old_revno: Revision number before the change.
1149
:param new_revno: Revision number after the change.
1150
:param old_revid: Tip revision id before the change.
1151
:param new_revid: Tip revision id after the change.
1153
self.branch = branch
1154
self.old_revno = old_revno
1155
self.new_revno = new_revno
1156
self.old_revid = old_revid
1157
self.new_revid = new_revid
1159
def __eq__(self, other):
1160
return self.__dict__ == other.__dict__
1163
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1164
self.__class__.__name__, self.branch,
1165
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1168
class BzrBranchFormat4(BranchFormat):
1169
"""Bzr branch format 4.
1172
- a revision-history file.
1173
- a branch-lock lock file [ to be shared with the bzrdir ]
1176
def get_format_description(self):
1177
"""See BranchFormat.get_format_description()."""
1178
return "Branch format 4"
1180
def initialize(self, a_bzrdir):
1181
"""Create a branch of this format in a_bzrdir."""
1182
utf8_files = [('revision-history', ''),
1183
('branch-name', ''),
1185
return self._initialize_helper(a_bzrdir, utf8_files,
1186
lock_type='branch4', set_format=False)
1189
super(BzrBranchFormat4, self).__init__()
1190
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1192
def open(self, a_bzrdir, _found=False):
1193
"""Return the branch object for a_bzrdir
1195
_found is a private parameter, do not use it. It is used to indicate
1196
if format probing has already be done.
1199
# we are being called directly and must probe.
1200
raise NotImplementedError
1201
return BzrBranch(_format=self,
1202
_control_files=a_bzrdir._control_files,
1204
_repository=a_bzrdir.open_repository())
1207
return "Bazaar-NG branch format 4"
1210
class BzrBranchFormat5(BranchFormat):
1211
"""Bzr branch format 5.
1214
- a revision-history file.
1216
- a lock dir guarding the branch itself
1217
- all of this stored in a branch/ subdirectory
1218
- works with shared repositories.
1220
This format is new in bzr 0.8.
1223
def get_format_string(self):
1224
"""See BranchFormat.get_format_string()."""
1225
return "Bazaar-NG branch format 5\n"
1227
def get_format_description(self):
1228
"""See BranchFormat.get_format_description()."""
1229
return "Branch format 5"
1231
def initialize(self, a_bzrdir):
1232
"""Create a branch of this format in a_bzrdir."""
1233
utf8_files = [('revision-history', ''),
1234
('branch-name', ''),
1236
return self._initialize_helper(a_bzrdir, utf8_files)
1239
super(BzrBranchFormat5, self).__init__()
1240
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1242
def open(self, a_bzrdir, _found=False):
1243
"""Return the branch object for a_bzrdir
1245
_found is a private parameter, do not use it. It is used to indicate
1246
if format probing has already be done.
1249
format = BranchFormat.find_format(a_bzrdir)
1250
if format.__class__ != self.__class__:
1251
raise AssertionError("wrong format %r found for %r" %
1254
transport = a_bzrdir.get_branch_transport(None)
1255
control_files = lockable_files.LockableFiles(transport, 'lock',
1257
return BzrBranch5(_format=self,
1258
_control_files=control_files,
1260
_repository=a_bzrdir.find_repository())
1261
except errors.NoSuchFile:
1262
raise errors.NotBranchError(path=transport.base)
1265
class BzrBranchFormat6(BzrBranchFormat5):
1266
"""Branch format with last-revision and tags.
1268
Unlike previous formats, this has no explicit revision history. Instead,
1269
this just stores the last-revision, and the left-hand history leading
1270
up to there is the history.
1272
This format was introduced in bzr 0.15
1273
and became the default in 0.91.
1276
def get_format_string(self):
1277
"""See BranchFormat.get_format_string()."""
1278
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1280
def get_format_description(self):
1281
"""See BranchFormat.get_format_description()."""
1282
return "Branch format 6"
1284
def initialize(self, a_bzrdir):
1285
"""Create a branch of this format in a_bzrdir."""
1286
utf8_files = [('last-revision', '0 null:\n'),
1287
('branch.conf', ''),
1290
return self._initialize_helper(a_bzrdir, utf8_files)
1292
def open(self, a_bzrdir, _found=False):
1293
"""Return the branch object for a_bzrdir
1295
_found is a private parameter, do not use it. It is used to indicate
1296
if format probing has already be done.
1299
format = BranchFormat.find_format(a_bzrdir)
1300
if format.__class__ != self.__class__:
1301
raise AssertionError("wrong format %r found for %r" %
1303
transport = a_bzrdir.get_branch_transport(None)
1304
control_files = lockable_files.LockableFiles(transport, 'lock',
1306
return BzrBranch6(_format=self,
1307
_control_files=control_files,
1309
_repository=a_bzrdir.find_repository())
1311
def supports_tags(self):
1315
class BranchReferenceFormat(BranchFormat):
1316
"""Bzr branch reference format.
1318
Branch references are used in implementing checkouts, they
1319
act as an alias to the real branch which is at some other url.
1326
def get_format_string(self):
1327
"""See BranchFormat.get_format_string()."""
1328
return "Bazaar-NG Branch Reference Format 1\n"
1330
def get_format_description(self):
1331
"""See BranchFormat.get_format_description()."""
1332
return "Checkout reference format 1"
1334
def get_reference(self, a_bzrdir):
1335
"""See BranchFormat.get_reference()."""
1336
transport = a_bzrdir.get_branch_transport(None)
1337
return transport.get('location').read()
1339
def set_reference(self, a_bzrdir, to_branch):
1340
"""See BranchFormat.set_reference()."""
1341
transport = a_bzrdir.get_branch_transport(None)
1342
location = transport.put_bytes('location', to_branch.base)
1344
def initialize(self, a_bzrdir, target_branch=None):
1345
"""Create a branch of this format in a_bzrdir."""
1346
if target_branch is None:
1347
# this format does not implement branch itself, thus the implicit
1348
# creation contract must see it as uninitializable
1349
raise errors.UninitializableFormat(self)
1350
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1351
branch_transport = a_bzrdir.get_branch_transport(self)
1352
branch_transport.put_bytes('location',
1353
target_branch.bzrdir.root_transport.base)
1354
branch_transport.put_bytes('format', self.get_format_string())
1356
a_bzrdir, _found=True,
1357
possible_transports=[target_branch.bzrdir.root_transport])
1360
super(BranchReferenceFormat, self).__init__()
1361
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1363
def _make_reference_clone_function(format, a_branch):
1364
"""Create a clone() routine for a branch dynamically."""
1365
def clone(to_bzrdir, revision_id=None):
1366
"""See Branch.clone()."""
1367
return format.initialize(to_bzrdir, a_branch)
1368
# cannot obey revision_id limits when cloning a reference ...
1369
# FIXME RBC 20060210 either nuke revision_id for clone, or
1370
# emit some sort of warning/error to the caller ?!
1373
def open(self, a_bzrdir, _found=False, location=None,
1374
possible_transports=None):
1375
"""Return the branch that the branch reference in a_bzrdir points at.
1377
_found is a private parameter, do not use it. It is used to indicate
1378
if format probing has already be done.
1381
format = BranchFormat.find_format(a_bzrdir)
1382
if format.__class__ != self.__class__:
1383
raise AssertionError("wrong format %r found for %r" %
1385
if location is None:
1386
location = self.get_reference(a_bzrdir)
1387
real_bzrdir = bzrdir.BzrDir.open(
1388
location, possible_transports=possible_transports)
1389
result = real_bzrdir.open_branch()
1390
# this changes the behaviour of result.clone to create a new reference
1391
# rather than a copy of the content of the branch.
1392
# I did not use a proxy object because that needs much more extensive
1393
# testing, and we are only changing one behaviour at the moment.
1394
# If we decide to alter more behaviours - i.e. the implicit nickname
1395
# then this should be refactored to introduce a tested proxy branch
1396
# and a subclass of that for use in overriding clone() and ....
1398
result.clone = self._make_reference_clone_function(result)
1402
# formats which have no format string are not discoverable
1403
# and not independently creatable, so are not registered.
1404
__format5 = BzrBranchFormat5()
1405
__format6 = BzrBranchFormat6()
1406
BranchFormat.register_format(__format5)
1407
BranchFormat.register_format(BranchReferenceFormat())
1408
BranchFormat.register_format(__format6)
1409
BranchFormat.set_default_format(__format6)
1410
_legacy_formats = [BzrBranchFormat4(),
1413
class BzrBranch(Branch):
1414
"""A branch stored in the actual filesystem.
1416
Note that it's "local" in the context of the filesystem; it doesn't
1417
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1418
it's writable, and can be accessed via the normal filesystem API.
1420
:ivar _transport: Transport for file operations on this branch's
1421
control files, typically pointing to the .bzr/branch directory.
1422
:ivar repository: Repository for this branch.
1423
:ivar base: The url of the base directory for this branch; the one
1424
containing the .bzr directory.
1427
def __init__(self, _format=None,
1428
_control_files=None, a_bzrdir=None, _repository=None):
1429
"""Create new branch object at a particular location."""
1430
Branch.__init__(self)
1431
if a_bzrdir is None:
1432
raise ValueError('a_bzrdir must be supplied')
1434
self.bzrdir = a_bzrdir
1435
self._base = self.bzrdir.transport.clone('..').base
1436
# XXX: We should be able to just do
1437
# self.base = self.bzrdir.root_transport.base
1438
# but this does not quite work yet -- mbp 20080522
1439
self._format = _format
1440
if _control_files is None:
1441
raise ValueError('BzrBranch _control_files is None')
1442
self.control_files = _control_files
1443
self._transport = _control_files._transport
1444
self.repository = _repository
1447
return '%s(%r)' % (self.__class__.__name__, self.base)
1451
def _get_base(self):
1452
"""Returns the directory containing the control directory."""
1455
base = property(_get_base, doc="The URL for the root of this branch.")
1457
@deprecated_method(deprecated_in((0, 16, 0)))
1458
def abspath(self, name):
1459
"""See Branch.abspath."""
1460
return self._transport.abspath(name)
1462
def is_locked(self):
1463
return self.control_files.is_locked()
1465
def lock_write(self, token=None):
1466
repo_token = self.repository.lock_write()
1468
token = self.control_files.lock_write(token=token)
1470
self.repository.unlock()
1474
def lock_read(self):
1475
self.repository.lock_read()
1477
self.control_files.lock_read()
1479
self.repository.unlock()
1483
# TODO: test for failed two phase locks. This is known broken.
1485
self.control_files.unlock()
1487
self.repository.unlock()
1488
if not self.control_files.is_locked():
1489
# we just released the lock
1490
self._clear_cached_state()
1492
def peek_lock_mode(self):
1493
if self.control_files._lock_count == 0:
1496
return self.control_files._lock_mode
1498
def get_physical_lock_status(self):
1499
return self.control_files.get_physical_lock_status()
1502
def print_file(self, file, revision_id):
1503
"""See Branch.print_file."""
1504
return self.repository.print_file(file, revision_id)
1506
def _write_revision_history(self, history):
1507
"""Factored out of set_revision_history.
1509
This performs the actual writing to disk.
1510
It is intended to be called by BzrBranch5.set_revision_history."""
1511
self._transport.put_bytes(
1512
'revision-history', '\n'.join(history),
1513
mode=self.bzrdir._get_file_mode())
1516
def set_revision_history(self, rev_history):
1517
"""See Branch.set_revision_history."""
1518
if 'evil' in debug.debug_flags:
1519
mutter_callsite(3, "set_revision_history scales with history.")
1520
check_not_reserved_id = _mod_revision.check_not_reserved_id
1521
for rev_id in rev_history:
1522
check_not_reserved_id(rev_id)
1523
self._write_revision_history(rev_history)
1524
self._clear_cached_state()
1525
self._cache_revision_history(rev_history)
1526
for hook in Branch.hooks['set_rh']:
1527
hook(self, rev_history)
1529
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1530
"""Run the pre_change_branch_tip hooks."""
1531
hooks = Branch.hooks['pre_change_branch_tip']
1534
old_revno, old_revid = self.last_revision_info()
1535
params = ChangeBranchTipParams(
1536
self, old_revno, new_revno, old_revid, new_revid)
1540
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1541
"""Run the post_change_branch_tip hooks."""
1542
hooks = Branch.hooks['post_change_branch_tip']
1545
new_revno, new_revid = self.last_revision_info()
1546
params = ChangeBranchTipParams(
1547
self, old_revno, new_revno, old_revid, new_revid)
1552
def set_last_revision_info(self, revno, revision_id):
1553
"""Set the last revision of this branch.
1555
The caller is responsible for checking that the revno is correct
1556
for this revision id.
1558
It may be possible to set the branch last revision to an id not
1559
present in the repository. However, branches can also be
1560
configured to check constraints on history, in which case this may not
1563
revision_id = _mod_revision.ensure_null(revision_id)
1564
old_revno, old_revid = self.last_revision_info()
1565
# this old format stores the full history, but this api doesn't
1566
# provide it, so we must generate, and might as well check it's
1568
history = self._lefthand_history(revision_id)
1569
if len(history) != revno:
1570
raise AssertionError('%d != %d' % (len(history), revno))
1571
self._run_pre_change_branch_tip_hooks(revno, revision_id)
1572
self.set_revision_history(history)
1573
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1575
def _gen_revision_history(self):
1576
history = self._transport.get_bytes('revision-history').split('\n')
1577
if history[-1:] == ['']:
1578
# There shouldn't be a trailing newline, but just in case.
1582
def _lefthand_history(self, revision_id, last_rev=None,
1584
if 'evil' in debug.debug_flags:
1585
mutter_callsite(4, "_lefthand_history scales with history.")
1586
# stop_revision must be a descendant of last_revision
1587
graph = self.repository.get_graph()
1588
if last_rev is not None:
1589
if not graph.is_ancestor(last_rev, revision_id):
1590
# our previous tip is not merged into stop_revision
1591
raise errors.DivergedBranches(self, other_branch)
1592
# make a new revision history from the graph
1593
parents_map = graph.get_parent_map([revision_id])
1594
if revision_id not in parents_map:
1595
raise errors.NoSuchRevision(self, revision_id)
1596
current_rev_id = revision_id
1598
check_not_reserved_id = _mod_revision.check_not_reserved_id
1599
# Do not include ghosts or graph origin in revision_history
1600
while (current_rev_id in parents_map and
1601
len(parents_map[current_rev_id]) > 0):
1602
check_not_reserved_id(current_rev_id)
1603
new_history.append(current_rev_id)
1604
current_rev_id = parents_map[current_rev_id][0]
1605
parents_map = graph.get_parent_map([current_rev_id])
1606
new_history.reverse()
1610
def generate_revision_history(self, revision_id, last_rev=None,
1612
"""Create a new revision history that will finish with revision_id.
1614
:param revision_id: the new tip to use.
1615
:param last_rev: The previous last_revision. If not None, then this
1616
must be a ancestory of revision_id, or DivergedBranches is raised.
1617
:param other_branch: The other branch that DivergedBranches should
1618
raise with respect to.
1620
self.set_revision_history(self._lefthand_history(revision_id,
1621
last_rev, other_branch))
1623
def basis_tree(self):
1624
"""See Branch.basis_tree."""
1625
return self.repository.revision_tree(self.last_revision())
1628
def pull(self, source, overwrite=False, stop_revision=None,
1629
_hook_master=None, run_hooks=True, possible_transports=None,
1630
_override_hook_target=None):
1633
:param _hook_master: Private parameter - set the branch to
1634
be supplied as the master to pull hooks.
1635
:param run_hooks: Private parameter - if false, this branch
1636
is being called because it's the master of the primary branch,
1637
so it should not run its hooks.
1638
:param _override_hook_target: Private parameter - set the branch to be
1639
supplied as the target_branch to pull hooks.
1641
result = PullResult()
1642
result.source_branch = source
1643
if _override_hook_target is None:
1644
result.target_branch = self
1646
result.target_branch = _override_hook_target
1649
# We assume that during 'pull' the local repository is closer than
1651
graph = self.repository.get_graph(source.repository)
1652
result.old_revno, result.old_revid = self.last_revision_info()
1653
self.update_revisions(source, stop_revision, overwrite=overwrite,
1655
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1656
result.new_revno, result.new_revid = self.last_revision_info()
1658
result.master_branch = _hook_master
1659
result.local_branch = result.target_branch
1661
result.master_branch = result.target_branch
1662
result.local_branch = None
1664
for hook in Branch.hooks['post_pull']:
1670
def _get_parent_location(self):
1671
_locs = ['parent', 'pull', 'x-pull']
1674
return self._transport.get_bytes(l).strip('\n')
1675
except errors.NoSuchFile:
1680
def push(self, target, overwrite=False, stop_revision=None,
1681
_override_hook_source_branch=None):
1684
This is the basic concrete implementation of push()
1686
:param _override_hook_source_branch: If specified, run
1687
the hooks passing this Branch as the source, rather than self.
1688
This is for use of RemoteBranch, where push is delegated to the
1689
underlying vfs-based Branch.
1691
# TODO: Public option to disable running hooks - should be trivial but
1695
result = self._push_with_bound_branches(target, overwrite,
1697
_override_hook_source_branch=_override_hook_source_branch)
1702
def _push_with_bound_branches(self, target, overwrite,
1704
_override_hook_source_branch=None):
1705
"""Push from self into target, and into target's master if any.
1707
This is on the base BzrBranch class even though it doesn't support
1708
bound branches because the *target* might be bound.
1711
if _override_hook_source_branch:
1712
result.source_branch = _override_hook_source_branch
1713
for hook in Branch.hooks['post_push']:
1716
bound_location = target.get_bound_location()
1717
if bound_location and target.base != bound_location:
1718
# there is a master branch.
1720
# XXX: Why the second check? Is it even supported for a branch to
1721
# be bound to itself? -- mbp 20070507
1722
master_branch = target.get_master_branch()
1723
master_branch.lock_write()
1725
# push into the master from this branch.
1726
self._basic_push(master_branch, overwrite, stop_revision)
1727
# and push into the target branch from this. Note that we push from
1728
# this branch again, because its considered the highest bandwidth
1730
result = self._basic_push(target, overwrite, stop_revision)
1731
result.master_branch = master_branch
1732
result.local_branch = target
1736
master_branch.unlock()
1739
result = self._basic_push(target, overwrite, stop_revision)
1740
# TODO: Why set master_branch and local_branch if there's no
1741
# binding? Maybe cleaner to just leave them unset? -- mbp
1743
result.master_branch = target
1744
result.local_branch = None
1748
def _basic_push(self, target, overwrite, stop_revision):
1749
"""Basic implementation of push without bound branches or hooks.
1751
Must be called with self read locked and target write locked.
1753
result = PushResult()
1754
result.source_branch = self
1755
result.target_branch = target
1756
result.old_revno, result.old_revid = target.last_revision_info()
1758
# We assume that during 'push' this repository is closer than
1760
graph = self.repository.get_graph(target.repository)
1761
target.update_revisions(self, stop_revision, overwrite=overwrite,
1763
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1764
result.new_revno, result.new_revid = target.last_revision_info()
1767
def get_parent(self):
1768
"""See Branch.get_parent."""
1769
parent = self._get_parent_location()
1772
# This is an old-format absolute path to a local branch
1773
# turn it into a url
1774
if parent.startswith('/'):
1775
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1777
return urlutils.join(self.base[:-1], parent)
1778
except errors.InvalidURLJoin, e:
1779
raise errors.InaccessibleParent(parent, self.base)
1781
def set_push_location(self, location):
1782
"""See Branch.set_push_location."""
1783
self.get_config().set_user_option(
1784
'push_location', location,
1785
store=_mod_config.STORE_LOCATION_NORECURSE)
1788
def set_parent(self, url):
1789
"""See Branch.set_parent."""
1790
# TODO: Maybe delete old location files?
1791
# URLs should never be unicode, even on the local fs,
1792
# FIXUP this and get_parent in a future branch format bump:
1793
# read and rewrite the file. RBC 20060125
1795
if isinstance(url, unicode):
1797
url = url.encode('ascii')
1798
except UnicodeEncodeError:
1799
raise errors.InvalidURL(url,
1800
"Urls must be 7-bit ascii, "
1801
"use bzrlib.urlutils.escape")
1802
url = urlutils.relative_url(self.base, url)
1803
self._set_parent_location(url)
1805
def _set_parent_location(self, url):
1807
self._transport.delete('parent')
1809
self._transport.put_bytes('parent', url + '\n',
1810
mode=self.bzrdir._get_file_mode())
1813
class BzrBranch5(BzrBranch):
1814
"""A format 5 branch. This supports new features over plain branches.
1816
It has support for a master_branch which is the data for bound branches.
1824
super(BzrBranch5, self).__init__(_format=_format,
1825
_control_files=_control_files,
1827
_repository=_repository)
1830
def pull(self, source, overwrite=False, stop_revision=None,
1831
run_hooks=True, possible_transports=None,
1832
_override_hook_target=None):
1833
"""Pull from source into self, updating my master if any.
1835
:param run_hooks: Private parameter - if false, this branch
1836
is being called because it's the master of the primary branch,
1837
so it should not run its hooks.
1839
bound_location = self.get_bound_location()
1840
master_branch = None
1841
if bound_location and source.base != bound_location:
1842
# not pulling from master, so we need to update master.
1843
master_branch = self.get_master_branch(possible_transports)
1844
master_branch.lock_write()
1847
# pull from source into master.
1848
master_branch.pull(source, overwrite, stop_revision,
1850
return super(BzrBranch5, self).pull(source, overwrite,
1851
stop_revision, _hook_master=master_branch,
1852
run_hooks=run_hooks,
1853
_override_hook_target=_override_hook_target)
1856
master_branch.unlock()
1858
def get_bound_location(self):
1860
return self._transport.get_bytes('bound')[:-1]
1861
except errors.NoSuchFile:
1865
def get_master_branch(self, possible_transports=None):
1866
"""Return the branch we are bound to.
1868
:return: Either a Branch, or None
1870
This could memoise the branch, but if thats done
1871
it must be revalidated on each new lock.
1872
So for now we just don't memoise it.
1873
# RBC 20060304 review this decision.
1875
bound_loc = self.get_bound_location()
1879
return Branch.open(bound_loc,
1880
possible_transports=possible_transports)
1881
except (errors.NotBranchError, errors.ConnectionError), e:
1882
raise errors.BoundBranchConnectionFailure(
1886
def set_bound_location(self, location):
1887
"""Set the target where this branch is bound to.
1889
:param location: URL to the target branch
1892
self._transport.put_bytes('bound', location+'\n',
1893
mode=self.bzrdir._get_file_mode())
1896
self._transport.delete('bound')
1897
except errors.NoSuchFile:
1902
def bind(self, other):
1903
"""Bind this branch to the branch other.
1905
This does not push or pull data between the branches, though it does
1906
check for divergence to raise an error when the branches are not
1907
either the same, or one a prefix of the other. That behaviour may not
1908
be useful, so that check may be removed in future.
1910
:param other: The branch to bind to
1913
# TODO: jam 20051230 Consider checking if the target is bound
1914
# It is debatable whether you should be able to bind to
1915
# a branch which is itself bound.
1916
# Committing is obviously forbidden,
1917
# but binding itself may not be.
1918
# Since we *have* to check at commit time, we don't
1919
# *need* to check here
1921
# we want to raise diverged if:
1922
# last_rev is not in the other_last_rev history, AND
1923
# other_last_rev is not in our history, and do it without pulling
1925
self.set_bound_location(other.base)
1929
"""If bound, unbind"""
1930
return self.set_bound_location(None)
1933
def update(self, possible_transports=None):
1934
"""Synchronise this branch with the master branch if any.
1936
:return: None or the last_revision that was pivoted out during the
1939
master = self.get_master_branch(possible_transports)
1940
if master is not None:
1941
old_tip = _mod_revision.ensure_null(self.last_revision())
1942
self.pull(master, overwrite=True)
1943
if self.repository.get_graph().is_ancestor(old_tip,
1944
_mod_revision.ensure_null(self.last_revision())):
1950
class BzrBranch6(BzrBranch5):
1952
def __init__(self, *args, **kwargs):
1953
super(BzrBranch6, self).__init__(*args, **kwargs)
1954
self._partial_revision_history_cache = []
1956
def _clear_cached_state(self):
1957
super(BzrBranch6, self)._clear_cached_state()
1958
self._partial_revision_history_cache = []
1960
def _last_revision_info(self):
1961
revision_string = self._transport.get_bytes('last-revision')
1962
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1963
revision_id = cache_utf8.get_cached_utf8(revision_id)
1965
return revno, revision_id
1967
def _write_last_revision_info(self, revno, revision_id):
1968
"""Simply write out the revision id, with no checks.
1970
Use set_last_revision_info to perform this safely.
1972
Does not update the revision_history cache.
1973
Intended to be called by set_last_revision_info and
1974
_write_revision_history.
1976
revision_id = _mod_revision.ensure_null(revision_id)
1977
out_string = '%d %s\n' % (revno, revision_id)
1978
self._transport.put_bytes('last-revision', out_string,
1979
mode=self.bzrdir._get_file_mode())
1982
def set_last_revision_info(self, revno, revision_id):
1983
revision_id = _mod_revision.ensure_null(revision_id)
1984
old_revno, old_revid = self.last_revision_info()
1985
if self._get_append_revisions_only():
1986
self._check_history_violation(revision_id)
1987
self._run_pre_change_branch_tip_hooks(revno, revision_id)
1988
self._write_last_revision_info(revno, revision_id)
1989
self._clear_cached_state()
1990
self._last_revision_info_cache = revno, revision_id
1991
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1993
def _check_history_violation(self, revision_id):
1994
last_revision = _mod_revision.ensure_null(self.last_revision())
1995
if _mod_revision.is_null(last_revision):
1997
if last_revision not in self._lefthand_history(revision_id):
1998
raise errors.AppendRevisionsOnlyViolation(self.base)
2000
def _gen_revision_history(self):
2001
"""Generate the revision history from last revision
2003
last_revno, last_revision = self.last_revision_info()
2004
self._extend_partial_history(stop_index=last_revno-1)
2005
return list(reversed(self._partial_revision_history_cache))
2007
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2008
"""Extend the partial history to include a given index
2010
If a stop_index is supplied, stop when that index has been reached.
2011
If a stop_revision is supplied, stop when that revision is
2012
encountered. Otherwise, stop when the beginning of history is
2015
:param stop_index: The index which should be present. When it is
2016
present, history extension will stop.
2017
:param revision_id: The revision id which should be present. When
2018
it is encountered, history extension will stop.
2020
repo = self.repository
2021
if len(self._partial_revision_history_cache) == 0:
2022
iterator = repo.iter_reverse_revision_history(self.last_revision())
2024
start_revision = self._partial_revision_history_cache[-1]
2025
iterator = repo.iter_reverse_revision_history(start_revision)
2026
#skip the last revision in the list
2027
next_revision = iterator.next()
2028
for revision_id in iterator:
2029
self._partial_revision_history_cache.append(revision_id)
2030
if (stop_index is not None and
2031
len(self._partial_revision_history_cache) > stop_index):
2033
if revision_id == stop_revision:
2036
def _write_revision_history(self, history):
2037
"""Factored out of set_revision_history.
2039
This performs the actual writing to disk, with format-specific checks.
2040
It is intended to be called by BzrBranch5.set_revision_history.
2042
if len(history) == 0:
2043
last_revision = 'null:'
2045
if history != self._lefthand_history(history[-1]):
2046
raise errors.NotLefthandHistory(history)
2047
last_revision = history[-1]
2048
if self._get_append_revisions_only():
2049
self._check_history_violation(last_revision)
2050
self._write_last_revision_info(len(history), last_revision)
2053
def _set_parent_location(self, url):
2054
"""Set the parent branch"""
2055
self._set_config_location('parent_location', url, make_relative=True)
2058
def _get_parent_location(self):
2059
"""Set the parent branch"""
2060
return self._get_config_location('parent_location')
2062
def set_push_location(self, location):
2063
"""See Branch.set_push_location."""
2064
self._set_config_location('push_location', location)
2066
def set_bound_location(self, location):
2067
"""See Branch.set_push_location."""
2069
config = self.get_config()
2070
if location is None:
2071
if config.get_user_option('bound') != 'True':
2074
config.set_user_option('bound', 'False', warn_masked=True)
2077
self._set_config_location('bound_location', location,
2079
config.set_user_option('bound', 'True', warn_masked=True)
2082
def _get_bound_location(self, bound):
2083
"""Return the bound location in the config file.
2085
Return None if the bound parameter does not match"""
2086
config = self.get_config()
2087
config_bound = (config.get_user_option('bound') == 'True')
2088
if config_bound != bound:
2090
return self._get_config_location('bound_location', config=config)
2092
def get_bound_location(self):
2093
"""See Branch.set_push_location."""
2094
return self._get_bound_location(True)
2096
def get_old_bound_location(self):
2097
"""See Branch.get_old_bound_location"""
2098
return self._get_bound_location(False)
2100
def set_append_revisions_only(self, enabled):
2105
self.get_config().set_user_option('append_revisions_only', value,
2108
def _get_append_revisions_only(self):
2109
value = self.get_config().get_user_option('append_revisions_only')
2110
return value == 'True'
2112
def _synchronize_history(self, destination, revision_id):
2113
"""Synchronize last revision and revision history between branches.
2115
This version is most efficient when the destination is also a
2116
BzrBranch6, but works for BzrBranch5, as long as the destination's
2117
repository contains all the lefthand ancestors of the intended
2118
last_revision. If not, set_last_revision_info will fail.
2120
:param destination: The branch to copy the history into
2121
:param revision_id: The revision-id to truncate history at. May
2122
be None to copy complete history.
2124
source_revno, source_revision_id = self.last_revision_info()
2125
if revision_id is None:
2126
revno, revision_id = source_revno, source_revision_id
2127
elif source_revision_id == revision_id:
2128
# we know the revno without needing to walk all of history
2129
revno = source_revno
2131
# To figure out the revno for a random revision, we need to build
2132
# the revision history, and count its length.
2133
# We don't care about the order, just how long it is.
2134
# Alternatively, we could start at the current location, and count
2135
# backwards. But there is no guarantee that we will find it since
2136
# it may be a merged revision.
2137
revno = len(list(self.repository.iter_reverse_revision_history(
2139
destination.set_last_revision_info(revno, revision_id)
2141
def _make_tags(self):
2142
return BasicTags(self)
2145
def generate_revision_history(self, revision_id, last_rev=None,
2147
"""See BzrBranch5.generate_revision_history"""
2148
history = self._lefthand_history(revision_id, last_rev, other_branch)
2149
revno = len(history)
2150
self.set_last_revision_info(revno, revision_id)
2153
def get_rev_id(self, revno, history=None):
2154
"""Find the revision id of the specified revno."""
2156
return _mod_revision.NULL_REVISION
2158
last_revno, last_revision_id = self.last_revision_info()
2159
if revno <= 0 or revno > last_revno:
2160
raise errors.NoSuchRevision(self, revno)
2162
if history is not None:
2163
return history[revno - 1]
2165
index = last_revno - revno
2166
if len(self._partial_revision_history_cache) <= index:
2167
self._extend_partial_history(stop_index=index)
2168
if len(self._partial_revision_history_cache) > index:
2169
return self._partial_revision_history_cache[index]
2171
raise errors.NoSuchRevision(self, revno)
2174
def revision_id_to_revno(self, revision_id):
2175
"""Given a revision id, return its revno"""
2176
if _mod_revision.is_null(revision_id):
2179
index = self._partial_revision_history_cache.index(revision_id)
2181
self._extend_partial_history(stop_revision=revision_id)
2182
index = len(self._partial_revision_history_cache) - 1
2183
if self._partial_revision_history_cache[index] != revision_id:
2184
raise errors.NoSuchRevision(self, revision_id)
2185
return self.revno() - index
2188
######################################################################
2189
# results of operations
2192
class _Result(object):
2194
def _show_tag_conficts(self, to_file):
2195
if not getattr(self, 'tag_conflicts', None):
2197
to_file.write('Conflicting tags:\n')
2198
for name, value1, value2 in self.tag_conflicts:
2199
to_file.write(' %s\n' % (name, ))
2202
class PullResult(_Result):
2203
"""Result of a Branch.pull operation.
2205
:ivar old_revno: Revision number before pull.
2206
:ivar new_revno: Revision number after pull.
2207
:ivar old_revid: Tip revision id before pull.
2208
:ivar new_revid: Tip revision id after pull.
2209
:ivar source_branch: Source (local) branch object.
2210
:ivar master_branch: Master branch of the target, or the target if no
2212
:ivar local_branch: target branch if there is a Master, else None
2213
:ivar target_branch: Target/destination branch object.
2214
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2218
# DEPRECATED: pull used to return the change in revno
2219
return self.new_revno - self.old_revno
2221
def report(self, to_file):
2223
if self.old_revid == self.new_revid:
2224
to_file.write('No revisions to pull.\n')
2226
to_file.write('Now on revision %d.\n' % self.new_revno)
2227
self._show_tag_conficts(to_file)
2230
class PushResult(_Result):
2231
"""Result of a Branch.push operation.
2233
:ivar old_revno: Revision number before push.
2234
:ivar new_revno: Revision number after push.
2235
:ivar old_revid: Tip revision id before push.
2236
:ivar new_revid: Tip revision id after push.
2237
:ivar source_branch: Source branch object.
2238
:ivar master_branch: Master branch of the target, or None.
2239
:ivar target_branch: Target/destination branch object.
2243
# DEPRECATED: push used to return the change in revno
2244
return self.new_revno - self.old_revno
2246
def report(self, to_file):
2247
"""Write a human-readable description of the result."""
2248
if self.old_revid == self.new_revid:
2249
to_file.write('No new revisions to push.\n')
2251
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2252
self._show_tag_conficts(to_file)
2255
class BranchCheckResult(object):
2256
"""Results of checking branch consistency.
2261
def __init__(self, branch):
2262
self.branch = branch
2264
def report_results(self, verbose):
2265
"""Report the check results via trace.note.
2267
:param verbose: Requests more detailed display of what was checked,
2270
note('checked branch %s format %s',
2272
self.branch._format)
2275
class Converter5to6(object):
2276
"""Perform an in-place upgrade of format 5 to format 6"""
2278
def convert(self, branch):
2279
# Data for 5 and 6 can peacefully coexist.
2280
format = BzrBranchFormat6()
2281
new_branch = format.open(branch.bzrdir, _found=True)
2283
# Copy source data into target
2284
new_branch._write_last_revision_info(*branch.last_revision_info())
2285
new_branch.set_parent(branch.get_parent())
2286
new_branch.set_bound_location(branch.get_bound_location())
2287
new_branch.set_push_location(branch.get_push_location())
2289
# New branch has no tags by default
2290
new_branch.tags._set_tag_dict({})
2292
# Copying done; now update target format
2293
new_branch._transport.put_bytes('format',
2294
format.get_format_string(),
2295
mode=new_branch.bzrdir._get_file_mode())
2297
# Clean up old files
2298
new_branch._transport.delete('revision-history')
2300
branch.set_parent(None)
2301
except errors.NoSuchFile:
2303
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
