13
13
# You should have received a copy of the GNU General Public License
14
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
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
18
from cStringIO import StringIO
20
21
from bzrlib.lazy_import import lazy_import
21
22
lazy_import(globals(), """
22
from warnings import warn
23
from itertools import chain
25
24
from bzrlib import (
28
27
config as _mod_config,
33
34
revision as _mod_revision,
40
from bzrlib.config import BranchConfig, TreeConfig
41
from bzrlib.lockable_files import LockableFiles, TransportLock
42
from bzrlib.config import BranchConfig, TransportConfig
43
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
42
44
from bzrlib.tag import (
48
from bzrlib.decorators import needs_read_lock, needs_write_lock
49
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
50
HistoryMissing, InvalidRevisionId,
51
InvalidRevisionNumber, LockError, NoSuchFile,
52
NoSuchRevision, NotVersionedError,
53
NotBranchError, UninitializableFormat,
54
UnlistableStore, UnlistableBranch,
56
from bzrlib.hooks import Hooks
57
from bzrlib.symbol_versioning import (deprecated_function,
61
zero_eight, zero_nine, zero_sixteen,
64
from bzrlib.trace import mutter, note
50
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
51
from bzrlib.hooks import HookPoint, Hooks
52
from bzrlib.inter import InterObject
53
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
54
from bzrlib import registry
55
from bzrlib.symbol_versioning import (
59
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
67
62
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
116
122
if master is not None:
117
123
master.break_lock()
125
def _check_stackable_repo(self):
126
if not self.repository._format.supports_external_lookups:
127
raise errors.UnstackableRepositoryFormat(self.repository._format,
128
self.repository.base)
130
def _extend_partial_history(self, stop_index=None, stop_revision=None):
131
"""Extend the partial history to include a given index
133
If a stop_index is supplied, stop when that index has been reached.
134
If a stop_revision is supplied, stop when that revision is
135
encountered. Otherwise, stop when the beginning of history is
138
:param stop_index: The index which should be present. When it is
139
present, history extension will stop.
140
:param stop_revision: The revision id which should be present. When
141
it is encountered, history extension will stop.
143
if len(self._partial_revision_history_cache) == 0:
144
self._partial_revision_history_cache = [self.last_revision()]
145
repository._iter_for_revno(
146
self.repository, self._partial_revision_history_cache,
147
stop_index=stop_index, stop_revision=stop_revision)
148
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
149
self._partial_revision_history_cache.pop()
151
def _get_check_refs(self):
152
"""Get the references needed for check().
156
revid = self.last_revision()
157
return [('revision-existence', revid), ('lefthand-distance', revid)]
120
def open(base, _unsupported=False):
160
def open(base, _unsupported=False, possible_transports=None):
121
161
"""Open the branch rooted at base.
123
163
For instance, if the branch is at URL/.bzr/branch,
124
164
Branch.open(URL) -> a Branch instance.
126
control = bzrdir.BzrDir.open(base, _unsupported)
127
return control.open_branch(_unsupported)
166
control = bzrdir.BzrDir.open(base, _unsupported,
167
possible_transports=possible_transports)
168
return control.open_branch(unsupported=_unsupported)
130
def open_from_transport(transport, _unsupported=False):
171
def open_from_transport(transport, name=None, _unsupported=False):
131
172
"""Open the branch rooted at transport"""
132
173
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
133
return control.open_branch(_unsupported)
174
return control.open_branch(name=name, unsupported=_unsupported)
136
177
def open_containing(url, possible_transports=None):
137
178
"""Open an existing branch which contains url.
139
180
This probes for a branch at url, and searches upwards from there.
141
182
Basically we keep looking up until we find the control directory or
142
183
run into the root. If there isn't one, raises NotBranchError.
143
If there is one and it is either an unrecognised format or an unsupported
184
If there is one and it is either an unrecognised format or an unsupported
144
185
format, UnknownFormatError or UnsupportedFormatError are raised.
145
186
If there is one, it is returned, along with the unused portion of url.
148
189
possible_transports)
149
190
return control.open_branch(), relpath
192
def _push_should_merge_tags(self):
193
"""Should _basic_push merge this branch's tags into the target?
195
The default implementation returns False if this branch has no tags,
196
and True the rest of the time. Subclasses may override this.
198
return self.supports_tags() and self.tags.get_tag_dict()
151
200
def get_config(self):
201
"""Get a bzrlib.config.BranchConfig for this Branch.
203
This can then be used to get and set configuration options for the
206
:return: A bzrlib.config.BranchConfig.
152
208
return BranchConfig(self)
155
return self.get_config().get_nickname()
210
def _get_config(self):
211
"""Get the concrete config for just the config in this branch.
213
This is not intended for client use; see Branch.get_config for the
218
:return: An object supporting get_option and set_option.
220
raise NotImplementedError(self._get_config)
222
def _get_fallback_repository(self, url):
223
"""Get the repository we fallback to at url."""
224
url = urlutils.join(self.base, url)
225
a_branch = Branch.open(url,
226
possible_transports=[self.bzrdir.root_transport])
227
return a_branch.repository
229
def _get_tags_bytes(self):
230
"""Get the bytes of a serialised tags dict.
232
Note that not all branches support tags, nor do all use the same tags
233
logic: this method is specific to BasicTags. Other tag implementations
234
may use the same method name and behave differently, safely, because
235
of the double-dispatch via
236
format.make_tags->tags_instance->get_tags_dict.
238
:return: The bytes of the tags file.
239
:seealso: Branch._set_tags_bytes.
241
return self._transport.get_bytes('tags')
243
def _get_nick(self, local=False, possible_transports=None):
244
config = self.get_config()
245
# explicit overrides master, but don't look for master if local is True
246
if not local and not config.has_explicit_nickname():
248
master = self.get_master_branch(possible_transports)
249
if master is not None:
250
# return the master branch value
252
except errors.BzrError, e:
253
# Silently fall back to local implicit nick if the master is
255
mutter("Could not connect to bound branch, "
256
"falling back to local nick.\n " + str(e))
257
return config.get_nickname()
157
259
def _set_nick(self, nick):
158
260
self.get_config().set_user_option('nickname', nick, warn_masked=True)
209
412
:return: A dictionary mapping revision_id => dotted revno.
211
last_revision = self.last_revision()
212
revision_graph = self.repository.get_revision_graph(last_revision)
213
merge_sorted_revisions = tsort.merge_sort(
218
414
revision_id_to_revno = dict((rev_id, revno)
219
for seq_num, rev_id, depth, revno, end_of_merge
220
in merge_sorted_revisions)
415
for rev_id, depth, revno, end_of_merge
416
in self.iter_merge_sorted_revisions())
221
417
return revision_id_to_revno
420
def iter_merge_sorted_revisions(self, start_revision_id=None,
421
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
422
"""Walk the revisions for a branch in merge sorted order.
424
Merge sorted order is the output from a merge-aware,
425
topological sort, i.e. all parents come before their
426
children going forward; the opposite for reverse.
428
:param start_revision_id: the revision_id to begin walking from.
429
If None, the branch tip is used.
430
:param stop_revision_id: the revision_id to terminate the walk
431
after. If None, the rest of history is included.
432
:param stop_rule: if stop_revision_id is not None, the precise rule
433
to use for termination:
434
* 'exclude' - leave the stop revision out of the result (default)
435
* 'include' - the stop revision is the last item in the result
436
* 'with-merges' - include the stop revision and all of its
437
merged revisions in the result
438
* 'with-merges-without-common-ancestry' - filter out revisions
439
that are in both ancestries
440
:param direction: either 'reverse' or 'forward':
441
* reverse means return the start_revision_id first, i.e.
442
start at the most recent revision and go backwards in history
443
* forward returns tuples in the opposite order to reverse.
444
Note in particular that forward does *not* do any intelligent
445
ordering w.r.t. depth as some clients of this API may like.
446
(If required, that ought to be done at higher layers.)
448
:return: an iterator over (revision_id, depth, revno, end_of_merge)
451
* revision_id: the unique id of the revision
452
* depth: How many levels of merging deep this node has been
454
* revno_sequence: This field provides a sequence of
455
revision numbers for all revisions. The format is:
456
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
457
branch that the revno is on. From left to right the REVNO numbers
458
are the sequence numbers within that branch of the revision.
459
* end_of_merge: When True the next node (earlier in history) is
460
part of a different merge.
462
# Note: depth and revno values are in the context of the branch so
463
# we need the full graph to get stable numbers, regardless of the
465
if self._merge_sorted_revisions_cache is None:
466
last_revision = self.last_revision()
467
known_graph = self.repository.get_known_graph_ancestry(
469
self._merge_sorted_revisions_cache = known_graph.merge_sort(
471
filtered = self._filter_merge_sorted_revisions(
472
self._merge_sorted_revisions_cache, start_revision_id,
473
stop_revision_id, stop_rule)
474
# Make sure we don't return revisions that are not part of the
475
# start_revision_id ancestry.
476
filtered = self._filter_start_non_ancestors(filtered)
477
if direction == 'reverse':
479
if direction == 'forward':
480
return reversed(list(filtered))
482
raise ValueError('invalid direction %r' % direction)
484
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
485
start_revision_id, stop_revision_id, stop_rule):
486
"""Iterate over an inclusive range of sorted revisions."""
487
rev_iter = iter(merge_sorted_revisions)
488
if start_revision_id is not None:
489
for node in rev_iter:
490
rev_id = node.key[-1]
491
if rev_id != start_revision_id:
494
# The decision to include the start or not
495
# depends on the stop_rule if a stop is provided
496
# so pop this node back into the iterator
497
rev_iter = chain(iter([node]), rev_iter)
499
if stop_revision_id is None:
501
for node in rev_iter:
502
rev_id = node.key[-1]
503
yield (rev_id, node.merge_depth, node.revno,
505
elif stop_rule == 'exclude':
506
for node in rev_iter:
507
rev_id = node.key[-1]
508
if rev_id == stop_revision_id:
510
yield (rev_id, node.merge_depth, node.revno,
512
elif stop_rule == 'include':
513
for node in rev_iter:
514
rev_id = node.key[-1]
515
yield (rev_id, node.merge_depth, node.revno,
517
if rev_id == stop_revision_id:
519
elif stop_rule == 'with-merges-without-common-ancestry':
520
# We want to exclude all revisions that are already part of the
521
# stop_revision_id ancestry.
522
graph = self.repository.get_graph()
523
ancestors = graph.find_unique_ancestors(start_revision_id,
525
for node in rev_iter:
526
rev_id = node.key[-1]
527
if rev_id not in ancestors:
529
yield (rev_id, node.merge_depth, node.revno,
531
elif stop_rule == 'with-merges':
532
stop_rev = self.repository.get_revision(stop_revision_id)
533
if stop_rev.parent_ids:
534
left_parent = stop_rev.parent_ids[0]
536
left_parent = _mod_revision.NULL_REVISION
537
# left_parent is the actual revision we want to stop logging at,
538
# since we want to show the merged revisions after the stop_rev too
539
reached_stop_revision_id = False
540
revision_id_whitelist = []
541
for node in rev_iter:
542
rev_id = node.key[-1]
543
if rev_id == left_parent:
544
# reached the left parent after the stop_revision
546
if (not reached_stop_revision_id or
547
rev_id in revision_id_whitelist):
548
yield (rev_id, node.merge_depth, node.revno,
550
if reached_stop_revision_id or rev_id == stop_revision_id:
551
# only do the merged revs of rev_id from now on
552
rev = self.repository.get_revision(rev_id)
554
reached_stop_revision_id = True
555
revision_id_whitelist.extend(rev.parent_ids)
557
raise ValueError('invalid stop_rule %r' % stop_rule)
559
def _filter_start_non_ancestors(self, rev_iter):
560
# If we started from a dotted revno, we want to consider it as a tip
561
# and don't want to yield revisions that are not part of its
562
# ancestry. Given the order guaranteed by the merge sort, we will see
563
# uninteresting descendants of the first parent of our tip before the
565
first = rev_iter.next()
566
(rev_id, merge_depth, revno, end_of_merge) = first
569
# We start at a mainline revision so by definition, all others
570
# revisions in rev_iter are ancestors
571
for node in rev_iter:
576
pmap = self.repository.get_parent_map([rev_id])
577
parents = pmap.get(rev_id, [])
579
whitelist.update(parents)
581
# If there is no parents, there is nothing of interest left
583
# FIXME: It's hard to test this scenario here as this code is never
584
# called in that case. -- vila 20100322
587
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
589
if rev_id in whitelist:
590
pmap = self.repository.get_parent_map([rev_id])
591
parents = pmap.get(rev_id, [])
592
whitelist.remove(rev_id)
593
whitelist.update(parents)
595
# We've reached the mainline, there is nothing left to
599
# A revision that is not part of the ancestry of our
602
yield (rev_id, merge_depth, revno, end_of_merge)
223
604
def leave_lock_in_place(self):
224
605
"""Tell this branch object not to release the physical lock when this
225
606
object is unlocked.
227
608
If lock_write doesn't return a token, then this method is not supported.
229
610
self.control_files.leave_in_place()
355
737
def set_revision_history(self, rev_history):
356
738
raise NotImplementedError(self.set_revision_history)
741
def set_parent(self, url):
742
"""See Branch.set_parent."""
743
# TODO: Maybe delete old location files?
744
# URLs should never be unicode, even on the local fs,
745
# FIXUP this and get_parent in a future branch format bump:
746
# read and rewrite the file. RBC 20060125
748
if isinstance(url, unicode):
750
url = url.encode('ascii')
751
except UnicodeEncodeError:
752
raise errors.InvalidURL(url,
753
"Urls must be 7-bit ascii, "
754
"use bzrlib.urlutils.escape")
755
url = urlutils.relative_url(self.base, url)
756
self._set_parent_location(url)
759
def set_stacked_on_url(self, url):
760
"""Set the URL this branch is stacked against.
762
:raises UnstackableBranchFormat: If the branch does not support
764
:raises UnstackableRepositoryFormat: If the repository does not support
767
if not self._format.supports_stacking():
768
raise errors.UnstackableBranchFormat(self._format, self.user_url)
769
# XXX: Changing from one fallback repository to another does not check
770
# that all the data you need is present in the new fallback.
771
# Possibly it should.
772
self._check_stackable_repo()
775
old_url = self.get_stacked_on_url()
776
except (errors.NotStacked, errors.UnstackableBranchFormat,
777
errors.UnstackableRepositoryFormat):
781
self._activate_fallback_location(url)
782
# write this out after the repository is stacked to avoid setting a
783
# stacked config that doesn't work.
784
self._set_config_location('stacked_on_location', url)
787
"""Change a branch to be unstacked, copying data as needed.
789
Don't call this directly, use set_stacked_on_url(None).
791
pb = ui.ui_factory.nested_progress_bar()
793
pb.update("Unstacking")
794
# The basic approach here is to fetch the tip of the branch,
795
# including all available ghosts, from the existing stacked
796
# repository into a new repository object without the fallbacks.
798
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
799
# correct for CHKMap repostiories
800
old_repository = self.repository
801
if len(old_repository._fallback_repositories) != 1:
802
raise AssertionError("can't cope with fallback repositories "
803
"of %r" % (self.repository,))
804
# Open the new repository object.
805
# Repositories don't offer an interface to remove fallback
806
# repositories today; take the conceptually simpler option and just
807
# reopen it. We reopen it starting from the URL so that we
808
# get a separate connection for RemoteRepositories and can
809
# stream from one of them to the other. This does mean doing
810
# separate SSH connection setup, but unstacking is not a
811
# common operation so it's tolerable.
812
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
813
new_repository = new_bzrdir.find_repository()
814
if new_repository._fallback_repositories:
815
raise AssertionError("didn't expect %r to have "
816
"fallback_repositories"
817
% (self.repository,))
818
# Replace self.repository with the new repository.
819
# Do our best to transfer the lock state (i.e. lock-tokens and
820
# lock count) of self.repository to the new repository.
821
lock_token = old_repository.lock_write().repository_token
822
self.repository = new_repository
823
if isinstance(self, remote.RemoteBranch):
824
# Remote branches can have a second reference to the old
825
# repository that need to be replaced.
826
if self._real_branch is not None:
827
self._real_branch.repository = new_repository
828
self.repository.lock_write(token=lock_token)
829
if lock_token is not None:
830
old_repository.leave_lock_in_place()
831
old_repository.unlock()
832
if lock_token is not None:
833
# XXX: self.repository.leave_lock_in_place() before this
834
# function will not be preserved. Fortunately that doesn't
835
# affect the current default format (2a), and would be a
836
# corner-case anyway.
837
# - Andrew Bennetts, 2010/06/30
838
self.repository.dont_leave_lock_in_place()
842
old_repository.unlock()
843
except errors.LockNotHeld:
846
if old_lock_count == 0:
847
raise AssertionError(
848
'old_repository should have been locked at least once.')
849
for i in range(old_lock_count-1):
850
self.repository.lock_write()
851
# Fetch from the old repository into the new.
852
old_repository.lock_read()
854
# XXX: If you unstack a branch while it has a working tree
855
# with a pending merge, the pending-merged revisions will no
856
# longer be present. You can (probably) revert and remerge.
858
# XXX: This only fetches up to the tip of the repository; it
859
# doesn't bring across any tags. That's fairly consistent
860
# with how branch works, but perhaps not ideal.
861
self.repository.fetch(old_repository,
862
revision_id=self.last_revision(),
865
old_repository.unlock()
869
def _set_tags_bytes(self, bytes):
870
"""Mirror method for _get_tags_bytes.
872
:seealso: Branch._get_tags_bytes.
874
return _run_with_write_locked_target(self, self._transport.put_bytes,
358
877
def _cache_revision_history(self, rev_history):
359
878
"""Set the cached revision history to rev_history.
464
988
common_index = min(self_len, other_len) -1
465
989
if common_index >= 0 and \
466
990
self_history[common_index] != other_history[common_index]:
467
raise DivergedBranches(self, other)
991
raise errors.DivergedBranches(self, other)
469
993
if stop_revision is None:
470
994
stop_revision = other_len
472
assert isinstance(stop_revision, int)
473
996
if stop_revision > other_len:
474
997
raise errors.NoSuchRevision(self, stop_revision)
475
998
return other_history[self_len:stop_revision]
477
def update_revisions(self, other, stop_revision=None):
1000
def update_revisions(self, other, stop_revision=None, overwrite=False,
478
1002
"""Pull in new perfect-fit revisions.
480
1004
:param other: Another Branch to pull from
481
1005
:param stop_revision: Updated until the given revision
1006
:param overwrite: Always set the branch pointer, rather than checking
1007
to see if it is a proper descendant.
1008
:param graph: A Graph object that can be used to query history
1009
information. This can be None.
484
raise NotImplementedError(self.update_revisions)
1012
return InterBranch.get(other, self).update_revisions(stop_revision,
1015
def import_last_revision_info(self, source_repo, revno, revid):
1016
"""Set the last revision info, importing from another repo if necessary.
1018
This is used by the bound branch code to upload a revision to
1019
the master branch first before updating the tip of the local branch.
1021
:param source_repo: Source repository to optionally fetch from
1022
:param revno: Revision number of the new tip
1023
:param revid: Revision id of the new tip
1025
if not self.repository.has_same_location(source_repo):
1026
self.repository.fetch(source_repo, revision_id=revid)
1027
self.set_last_revision_info(revno, revid)
486
1029
def revision_id_to_revno(self, revision_id):
487
1030
"""Given a revision id, return its revno"""
488
1031
if _mod_revision.is_null(revision_id):
490
revision_id = osutils.safe_revision_id(revision_id)
491
1033
history = self.revision_history()
493
1035
return history.index(revision_id) + 1
494
1036
except ValueError:
495
1037
raise errors.NoSuchRevision(self, revision_id)
497
1040
def get_rev_id(self, revno, history=None):
498
1041
"""Find the revision id of the specified revno."""
500
1043
return _mod_revision.NULL_REVISION
502
history = self.revision_history()
503
if revno <= 0 or revno > len(history):
1044
last_revno, last_revid = self.last_revision_info()
1045
if revno == last_revno:
1047
if revno <= 0 or revno > last_revno:
504
1048
raise errors.NoSuchRevision(self, revno)
505
return history[revno - 1]
1049
distance_from_last = last_revno - revno
1050
if len(self._partial_revision_history_cache) <= distance_from_last:
1051
self._extend_partial_history(distance_from_last)
1052
return self._partial_revision_history_cache[distance_from_last]
507
def pull(self, source, overwrite=False, stop_revision=None):
1054
def pull(self, source, overwrite=False, stop_revision=None,
1055
possible_transports=None, *args, **kwargs):
508
1056
"""Mirror source into this branch.
510
1058
This branch is considered to be 'local', having low latency.
512
1060
:returns: PullResult instance
514
raise NotImplementedError(self.pull)
1062
return InterBranch.get(source, self).pull(overwrite=overwrite,
1063
stop_revision=stop_revision,
1064
possible_transports=possible_transports, *args, **kwargs)
516
def push(self, target, overwrite=False, stop_revision=None):
1066
def push(self, target, overwrite=False, stop_revision=None, *args,
517
1068
"""Mirror this branch into target.
519
1070
This branch is considered to be 'local', having low latency.
521
raise NotImplementedError(self.push)
1072
return InterBranch.get(self, target).push(overwrite, stop_revision,
1075
def lossy_push(self, target, stop_revision=None):
1076
"""Push deltas into another branch.
1078
:note: This does not, like push, retain the revision ids from
1079
the source branch and will, rather than adding bzr-specific
1080
metadata, push only those semantics of the revision that can be
1081
natively represented by this branch' VCS.
1083
:param target: Target branch
1084
:param stop_revision: Revision to push, defaults to last revision.
1085
:return: BranchPushResult with an extra member revidmap:
1086
A dictionary mapping revision ids from the target branch
1087
to new revision ids in the target branch, for each
1088
revision that was pushed.
1090
inter = InterBranch.get(self, target)
1091
lossy_push = getattr(inter, "lossy_push", None)
1092
if lossy_push is None:
1093
raise errors.LossyPushToSameVCS(self, target)
1094
return lossy_push(stop_revision)
523
1096
def basis_tree(self):
524
1097
"""Return `Tree` object for last revision."""
525
1098
return self.repository.revision_tree(self.last_revision())
527
def rename_one(self, from_rel, to_rel):
530
This can change the directory or the filename or both.
532
raise NotImplementedError(self.rename_one)
534
def move(self, from_paths, to_name):
537
to_name must exist as a versioned directory.
539
If to_name exists and is a directory, the files are moved into
540
it, keeping their old names. If it is a directory,
542
Note that to_name is only the last component of the new name;
543
this doesn't change the directory.
545
This returns a list of (from_path, to_path) pairs for each
548
raise NotImplementedError(self.move)
550
1100
def get_parent(self):
551
1101
"""Return the parent location of the branch.
553
This is the default location for push/pull/missing. The usual
1103
This is the default location for pull/missing. The usual
554
1104
pattern is that the user can override it by specifying a
557
raise NotImplementedError(self.get_parent)
1107
parent = self._get_parent_location()
1110
# This is an old-format absolute path to a local branch
1111
# turn it into a url
1112
if parent.startswith('/'):
1113
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1115
return urlutils.join(self.base[:-1], parent)
1116
except errors.InvalidURLJoin, e:
1117
raise errors.InaccessibleParent(parent, self.user_url)
1119
def _get_parent_location(self):
1120
raise NotImplementedError(self._get_parent_location)
559
1122
def _set_config_location(self, name, url, config=None,
560
1123
make_relative=False):
638
1224
self.check_real_revno(revno)
640
1226
def check_real_revno(self, revno):
642
1228
Check whether a revno corresponds to a real revision.
643
1229
Zero (the NULL revision) is considered invalid
645
1231
if revno < 1 or revno > self.revno():
646
raise InvalidRevisionNumber(revno)
1232
raise errors.InvalidRevisionNumber(revno)
648
1234
@needs_read_lock
649
def clone(self, to_bzrdir, revision_id=None):
1235
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
650
1236
"""Clone this branch into to_bzrdir preserving all semantic values.
1238
Most API users will want 'create_clone_on_transport', which creates a
1239
new bzrdir and branch on the fly.
652
1241
revision_id: if not None, the revision history in the new branch will
653
1242
be truncated to end with revision_id.
655
result = self._format.initialize(to_bzrdir)
656
self.copy_content_into(result, revision_id=revision_id)
1244
result = to_bzrdir.create_branch()
1247
if repository_policy is not None:
1248
repository_policy.configure_branch(result)
1249
self.copy_content_into(result, revision_id=revision_id)
659
1254
@needs_read_lock
660
def sprout(self, to_bzrdir, revision_id=None):
1255
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
661
1256
"""Create a new line of development from the branch, into to_bzrdir.
1258
to_bzrdir controls the branch format.
663
1260
revision_id: if not None, the revision history in the new branch will
664
1261
be truncated to end with revision_id.
666
result = self._format.initialize(to_bzrdir)
667
self.copy_content_into(result, revision_id=revision_id)
668
result.set_parent(self.bzrdir.root_transport.base)
1263
if (repository_policy is not None and
1264
repository_policy.requires_stacking()):
1265
to_bzrdir._format.require_stacking(_skip_repo=True)
1266
result = to_bzrdir.create_branch()
1269
if repository_policy is not None:
1270
repository_policy.configure_branch(result)
1271
self.copy_content_into(result, revision_id=revision_id)
1272
result.set_parent(self.bzrdir.root_transport.base)
671
1277
def _synchronize_history(self, destination, revision_id):
672
1278
"""Synchronize last revision and revision history between branches.
674
1280
This version is most efficient when the destination is also a
675
BzrBranch5, but works for BzrBranch6 as long as the revision
676
history is the true lefthand parent history, and all of the revisions
677
are in the destination's repository. If not, set_revision_history
1281
BzrBranch6, but works for BzrBranch5, as long as the destination's
1282
repository contains all the lefthand ancestors of the intended
1283
last_revision. If not, set_last_revision_info will fail.
680
1285
:param destination: The branch to copy the history into
681
1286
:param revision_id: The revision-id to truncate history at. May
682
1287
be None to copy complete history.
684
if revision_id == _mod_revision.NULL_REVISION:
686
new_history = self.revision_history()
687
if revision_id is not None and new_history != []:
688
revision_id = osutils.safe_revision_id(revision_id)
1289
source_revno, source_revision_id = self.last_revision_info()
1290
if revision_id is None:
1291
revno, revision_id = source_revno, source_revision_id
1293
graph = self.repository.get_graph()
690
new_history = new_history[:new_history.index(revision_id) + 1]
692
rev = self.repository.get_revision(revision_id)
693
new_history = rev.get_history(self.repository)[1:]
694
destination.set_revision_history(new_history)
1295
revno = graph.find_distance_to_null(revision_id,
1296
[(source_revision_id, source_revno)])
1297
except errors.GhostRevisionsHaveNoRevno:
1298
# Default to 1, if we can't find anything else
1300
destination.set_last_revision_info(revno, revision_id)
697
1302
def copy_content_into(self, destination, revision_id=None):
698
1303
"""Copy the content of self into destination.
700
1305
revision_id: if not None, the revision history in the new branch will
701
1306
be truncated to end with revision_id.
703
self._synchronize_history(destination, revision_id)
705
parent = self.get_parent()
706
except errors.InaccessibleParent, e:
707
mutter('parent was not accessible to copy: %s', e)
710
destination.set_parent(parent)
711
self.tags.merge_to(destination.tags)
1308
return InterBranch.get(self, destination).copy_content_into(
1309
revision_id=revision_id)
1311
def update_references(self, target):
1312
if not getattr(self._format, 'supports_reference_locations', False):
1314
reference_dict = self._get_all_reference_info()
1315
if len(reference_dict) == 0:
1317
old_base = self.base
1318
new_base = target.base
1319
target_reference_dict = target._get_all_reference_info()
1320
for file_id, (tree_path, branch_location) in (
1321
reference_dict.items()):
1322
branch_location = urlutils.rebase_url(branch_location,
1324
target_reference_dict.setdefault(
1325
file_id, (tree_path, branch_location))
1326
target._set_all_reference_info(target_reference_dict)
713
1328
@needs_read_lock
1329
def check(self, refs):
715
1330
"""Check consistency of the branch.
717
1332
In particular this checks that revisions given in the revision-history
718
do actually match up in the revision graph, and that they're all
1333
do actually match up in the revision graph, and that they're all
719
1334
present in the repository.
721
1336
Callers will typically also want to check the repository.
1338
:param refs: Calculated refs for this branch as specified by
1339
branch._get_check_refs()
723
1340
:return: A BranchCheckResult.
725
mainline_parent_id = None
726
for revision_id in self.revision_history():
728
revision = self.repository.get_revision(revision_id)
729
except errors.NoSuchRevision, e:
730
raise errors.BzrCheckError("mainline revision {%s} not in repository"
732
# In general the first entry on the revision history has no parents.
733
# But it's not illegal for it to have parents listed; this can happen
734
# in imports from Arch when the parents weren't reachable.
735
if mainline_parent_id is not None:
736
if mainline_parent_id not in revision.parent_ids:
737
raise errors.BzrCheckError("previous revision {%s} not listed among "
739
% (mainline_parent_id, revision_id))
740
mainline_parent_id = revision_id
741
return BranchCheckResult(self)
1342
result = BranchCheckResult(self)
1343
last_revno, last_revision_id = self.last_revision_info()
1344
actual_revno = refs[('lefthand-distance', last_revision_id)]
1345
if actual_revno != last_revno:
1346
result.errors.append(errors.BzrCheckError(
1347
'revno does not match len(mainline) %s != %s' % (
1348
last_revno, actual_revno)))
1349
# TODO: We should probably also check that self.revision_history
1350
# matches the repository for older branch formats.
1351
# If looking for the code that cross-checks repository parents against
1352
# the iter_reverse_revision_history output, that is now a repository
743
1356
def _get_checkout_format(self):
744
1357
"""Return the most suitable metadir for a checkout of this branch.
791
1439
basis_tree.unlock()
794
def reference_parent(self, file_id, path):
1443
def reconcile(self, thorough=True):
1444
"""Make sure the data stored in this branch is consistent."""
1445
from bzrlib.reconcile import BranchReconciler
1446
reconciler = BranchReconciler(self, thorough=thorough)
1447
reconciler.reconcile()
1450
def reference_parent(self, file_id, path, possible_transports=None):
795
1451
"""Return the parent branch for a tree-reference file_id
796
1452
:param file_id: The file_id of the tree reference
797
1453
:param path: The path of the file_id in the tree
798
1454
:return: A branch associated with the file_id
800
1456
# FIXME should provide multiple branches, based on config
801
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1457
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1458
possible_transports=possible_transports)
803
1460
def supports_tags(self):
804
1461
return self._format.supports_tags()
1463
def automatic_tag_name(self, revision_id):
1464
"""Try to automatically find the tag name for a revision.
1466
:param revision_id: Revision id of the revision.
1467
:return: A tag name or None if no tag name could be determined.
1469
for hook in Branch.hooks['automatic_tag_name']:
1470
ret = hook(self, revision_id)
1475
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1477
"""Ensure that revision_b is a descendant of revision_a.
1479
This is a helper function for update_revisions.
1481
:raises: DivergedBranches if revision_b has diverged from revision_a.
1482
:returns: True if revision_b is a descendant of revision_a.
1484
relation = self._revision_relations(revision_a, revision_b, graph)
1485
if relation == 'b_descends_from_a':
1487
elif relation == 'diverged':
1488
raise errors.DivergedBranches(self, other_branch)
1489
elif relation == 'a_descends_from_b':
1492
raise AssertionError("invalid relation: %r" % (relation,))
1494
def _revision_relations(self, revision_a, revision_b, graph):
1495
"""Determine the relationship between two revisions.
1497
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1499
heads = graph.heads([revision_a, revision_b])
1500
if heads == set([revision_b]):
1501
return 'b_descends_from_a'
1502
elif heads == set([revision_a, revision_b]):
1503
# These branches have diverged
1505
elif heads == set([revision_a]):
1506
return 'a_descends_from_b'
1508
raise AssertionError("invalid heads: %r" % (heads,))
807
1511
class BranchFormat(object):
808
1512
"""An encapsulation of the initialization and open routines for a format.
893
1640
control_files = lockable_files.LockableFiles(branch_transport,
894
1641
lock_name, lock_class)
895
1642
control_files.create_lock()
896
control_files.lock_write()
1644
control_files.lock_write()
1645
except errors.LockContention:
1646
if lock_type != 'branch4':
898
control_files.put_utf8('format', self.get_format_string())
1652
utf8_files += [('format', self.get_format_string())]
900
for file, content in utf8_files:
901
control_files.put_utf8(file, content)
1654
for (filename, content) in utf8_files:
1655
branch_transport.put_bytes(
1657
mode=a_bzrdir._get_file_mode())
903
control_files.unlock()
904
return self.open(a_bzrdir, _found=True)
1660
control_files.unlock()
1661
branch = self.open(a_bzrdir, name, _found=True)
1662
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
906
def initialize(self, a_bzrdir):
907
"""Create a branch of this format in a_bzrdir."""
1665
def initialize(self, a_bzrdir, name=None):
1666
"""Create a branch of this format in a_bzrdir.
1668
:param name: Name of the colocated branch to create.
908
1670
raise NotImplementedError(self.initialize)
910
1672
def is_supported(self):
911
1673
"""Is this format supported?
913
1675
Supported formats can be initialized and opened.
914
Unsupported formats may not support initialization or committing or
1676
Unsupported formats may not support initialization or committing or
915
1677
some other features depending on the reason for not being supported.
919
def open(self, a_bzrdir, _found=False):
1681
def make_tags(self, branch):
1682
"""Create a tags object for branch.
1684
This method is on BranchFormat, because BranchFormats are reflected
1685
over the wire via network_name(), whereas full Branch instances require
1686
multiple VFS method calls to operate at all.
1688
The default implementation returns a disabled-tags instance.
1690
Note that it is normal for branch to be a RemoteBranch when using tags
1693
return DisabledTags(branch)
1695
def network_name(self):
1696
"""A simple byte string uniquely identifying this format for RPC calls.
1698
MetaDir branch formats use their disk format string to identify the
1699
repository over the wire. All in one formats such as bzr < 0.8, and
1700
foreign formats like svn/git and hg should use some marker which is
1701
unique and immutable.
1703
raise NotImplementedError(self.network_name)
1705
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
920
1706
"""Return the branch object for a_bzrdir
922
_found is a private parameter, do not use it. It is used to indicate
923
if format probing has already be done.
1708
:param a_bzrdir: A BzrDir that contains a branch.
1709
:param name: Name of colocated branch to open
1710
:param _found: a private parameter, do not use it. It is used to
1711
indicate if format probing has already be done.
1712
:param ignore_fallbacks: when set, no fallback branches will be opened
1713
(if there are any). Default is to open fallbacks.
925
1715
raise NotImplementedError(self.open)
928
1718
def register_format(klass, format):
1719
"""Register a metadir format.
1721
See MetaDirBranchFormatFactory for the ability to register a format
1722
without loading the code the format needs until it is actually used.
929
1724
klass._formats[format.get_format_string()] = format
1725
# Metadir formats have a network name of their format string, and get
1726
# registered as factories.
1727
if isinstance(format, MetaDirBranchFormatFactory):
1728
network_format_registry.register(format.get_format_string(), format)
1730
network_format_registry.register(format.get_format_string(),
932
1734
def set_default_format(klass, format):
933
1735
klass._default_format = format
1737
def supports_set_append_revisions_only(self):
1738
"""True if this format supports set_append_revisions_only."""
1741
def supports_stacking(self):
1742
"""True if this format records a stacked-on branch."""
936
1746
def unregister_format(klass, format):
937
assert klass._formats[format.get_format_string()] is format
938
1747
del klass._formats[format.get_format_string()]
940
1749
def __str__(self):
941
return self.get_format_string().rstrip()
1750
return self.get_format_description().rstrip()
943
1752
def supports_tags(self):
944
1753
"""True if this format supports tags stored in the branch"""
945
1754
return False # by default
947
# XXX: Probably doesn't really belong here -- mbp 20070212
948
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
950
branch_transport = a_bzrdir.get_branch_transport(self)
951
control_files = lockable_files.LockableFiles(branch_transport,
952
lock_filename, lock_class)
953
control_files.create_lock()
954
control_files.lock_write()
956
for filename, content in utf8_files:
957
control_files.put_utf8(filename, content)
959
control_files.unlock()
1757
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1758
"""A factory for a BranchFormat object, permitting simple lazy registration.
1760
While none of the built in BranchFormats are lazy registered yet,
1761
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1762
use it, and the bzr-loom plugin uses it as well (see
1763
bzrlib.plugins.loom.formats).
1766
def __init__(self, format_string, module_name, member_name):
1767
"""Create a MetaDirBranchFormatFactory.
1769
:param format_string: The format string the format has.
1770
:param module_name: Module to load the format class from.
1771
:param member_name: Attribute name within the module for the format class.
1773
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1774
self._format_string = format_string
1776
def get_format_string(self):
1777
"""See BranchFormat.get_format_string."""
1778
return self._format_string
1781
"""Used for network_format_registry support."""
1782
return self.get_obj()()
962
1785
class BranchHooks(Hooks):
963
1786
"""A dictionary mapping hook name to a list of callables for branch hooks.
965
1788
e.g. ['set_rh'] Is the list of items to be called when the
966
1789
set_revision_history function is invoked.
975
1798
Hooks.__init__(self)
976
# Introduced in 0.15:
977
# invoked whenever the revision history has been set
978
# with set_revision_history. The api signature is
979
# (branch, revision_history), and the branch will
982
# invoked after a push operation completes.
983
# the api signature is
985
# containing the members
986
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
987
# where local is the local target branch or None, master is the target
988
# master branch, and the rest should be self explanatory. The source
989
# is read locked and the target branches write locked. Source will
990
# be the local low-latency branch.
991
self['post_push'] = []
992
# invoked after a pull operation completes.
993
# the api signature is
995
# containing the members
996
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
997
# where local is the local branch or None, master is the target
998
# master branch, and the rest should be self explanatory. The source
999
# is read locked and the target branches write locked. The local
1000
# branch is the low-latency branch.
1001
self['post_pull'] = []
1002
# invoked after a commit operation completes.
1003
# the api signature is
1004
# (local, master, old_revno, old_revid, new_revno, new_revid)
1005
# old_revid is NULL_REVISION for the first commit to a branch.
1006
self['post_commit'] = []
1007
# invoked after a uncommit operation completes.
1008
# the api signature is
1009
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1010
# local is the local branch or None, master is the target branch,
1011
# and an empty branch recieves new_revno of 0, new_revid of None.
1012
self['post_uncommit'] = []
1799
self.create_hook(HookPoint('set_rh',
1800
"Invoked whenever the revision history has been set via "
1801
"set_revision_history. The api signature is (branch, "
1802
"revision_history), and the branch will be write-locked. "
1803
"The set_rh hook can be expensive for bzr to trigger, a better "
1804
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1805
self.create_hook(HookPoint('open',
1806
"Called with the Branch object that has been opened after a "
1807
"branch is opened.", (1, 8), None))
1808
self.create_hook(HookPoint('post_push',
1809
"Called after a push operation completes. post_push is called "
1810
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1811
"bzr client.", (0, 15), None))
1812
self.create_hook(HookPoint('post_pull',
1813
"Called after a pull operation completes. post_pull is called "
1814
"with a bzrlib.branch.PullResult object and only runs in the "
1815
"bzr client.", (0, 15), None))
1816
self.create_hook(HookPoint('pre_commit',
1817
"Called after a commit is calculated but before it is is "
1818
"completed. pre_commit is called with (local, master, old_revno, "
1819
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1820
"). old_revid is NULL_REVISION for the first commit to a branch, "
1821
"tree_delta is a TreeDelta object describing changes from the "
1822
"basis revision. hooks MUST NOT modify this delta. "
1823
" future_tree is an in-memory tree obtained from "
1824
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1825
"tree.", (0,91), None))
1826
self.create_hook(HookPoint('post_commit',
1827
"Called in the bzr client after a commit has completed. "
1828
"post_commit is called with (local, master, old_revno, old_revid, "
1829
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1830
"commit to a branch.", (0, 15), None))
1831
self.create_hook(HookPoint('post_uncommit',
1832
"Called in the bzr client after an uncommit completes. "
1833
"post_uncommit is called with (local, master, old_revno, "
1834
"old_revid, new_revno, new_revid) where local is the local branch "
1835
"or None, master is the target branch, and an empty branch "
1836
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1837
self.create_hook(HookPoint('pre_change_branch_tip',
1838
"Called in bzr client and server before a change to the tip of a "
1839
"branch is made. pre_change_branch_tip is called with a "
1840
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1841
"commit, uncommit will all trigger this hook.", (1, 6), None))
1842
self.create_hook(HookPoint('post_change_branch_tip',
1843
"Called in bzr client and server after a change to the tip of a "
1844
"branch is made. post_change_branch_tip is called with a "
1845
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1846
"commit, uncommit will all trigger this hook.", (1, 4), None))
1847
self.create_hook(HookPoint('transform_fallback_location',
1848
"Called when a stacked branch is activating its fallback "
1849
"locations. transform_fallback_location is called with (branch, "
1850
"url), and should return a new url. Returning the same url "
1851
"allows it to be used as-is, returning a different one can be "
1852
"used to cause the branch to stack on a closer copy of that "
1853
"fallback_location. Note that the branch cannot have history "
1854
"accessing methods called on it during this hook because the "
1855
"fallback locations have not been activated. When there are "
1856
"multiple hooks installed for transform_fallback_location, "
1857
"all are called with the url returned from the previous hook."
1858
"The order is however undefined.", (1, 9), None))
1859
self.create_hook(HookPoint('automatic_tag_name',
1860
"Called to determine an automatic tag name for a revision."
1861
"automatic_tag_name is called with (branch, revision_id) and "
1862
"should return a tag name or None if no tag name could be "
1863
"determined. The first non-None tag name returned will be used.",
1865
self.create_hook(HookPoint('post_branch_init',
1866
"Called after new branch initialization completes. "
1867
"post_branch_init is called with a "
1868
"bzrlib.branch.BranchInitHookParams. "
1869
"Note that init, branch and checkout (both heavyweight and "
1870
"lightweight) will all trigger this hook.", (2, 2), None))
1871
self.create_hook(HookPoint('post_switch',
1872
"Called after a checkout switches branch. "
1873
"post_switch is called with a "
1874
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1015
1878
# install the default hooks into the Branch class.
1016
1879
Branch.hooks = BranchHooks()
1882
class ChangeBranchTipParams(object):
1883
"""Object holding parameters passed to *_change_branch_tip hooks.
1885
There are 5 fields that hooks may wish to access:
1887
:ivar branch: the branch being changed
1888
:ivar old_revno: revision number before the change
1889
:ivar new_revno: revision number after the change
1890
:ivar old_revid: revision id before the change
1891
:ivar new_revid: revision id after the change
1893
The revid fields are strings. The revno fields are integers.
1896
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1897
"""Create a group of ChangeBranchTip parameters.
1899
:param branch: The branch being changed.
1900
:param old_revno: Revision number before the change.
1901
:param new_revno: Revision number after the change.
1902
:param old_revid: Tip revision id before the change.
1903
:param new_revid: Tip revision id after the change.
1905
self.branch = branch
1906
self.old_revno = old_revno
1907
self.new_revno = new_revno
1908
self.old_revid = old_revid
1909
self.new_revid = new_revid
1911
def __eq__(self, other):
1912
return self.__dict__ == other.__dict__
1915
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1916
self.__class__.__name__, self.branch,
1917
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1920
class BranchInitHookParams(object):
1921
"""Object holding parameters passed to *_branch_init hooks.
1923
There are 4 fields that hooks may wish to access:
1925
:ivar format: the branch format
1926
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1927
:ivar name: name of colocated branch, if any (or None)
1928
:ivar branch: the branch created
1930
Note that for lightweight checkouts, the bzrdir and format fields refer to
1931
the checkout, hence they are different from the corresponding fields in
1932
branch, which refer to the original branch.
1935
def __init__(self, format, a_bzrdir, name, branch):
1936
"""Create a group of BranchInitHook parameters.
1938
:param format: the branch format
1939
:param a_bzrdir: the BzrDir where the branch will be/has been
1941
:param name: name of colocated branch, if any (or None)
1942
:param branch: the branch created
1944
Note that for lightweight checkouts, the bzrdir and format fields refer
1945
to the checkout, hence they are different from the corresponding fields
1946
in branch, which refer to the original branch.
1948
self.format = format
1949
self.bzrdir = a_bzrdir
1951
self.branch = branch
1953
def __eq__(self, other):
1954
return self.__dict__ == other.__dict__
1958
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1960
return "<%s of format:%s bzrdir:%s>" % (
1961
self.__class__.__name__, self.branch,
1962
self.format, self.bzrdir)
1965
class SwitchHookParams(object):
1966
"""Object holding parameters passed to *_switch hooks.
1968
There are 4 fields that hooks may wish to access:
1970
:ivar control_dir: BzrDir of the checkout to change
1971
:ivar to_branch: branch that the checkout is to reference
1972
:ivar force: skip the check for local commits in a heavy checkout
1973
:ivar revision_id: revision ID to switch to (or None)
1976
def __init__(self, control_dir, to_branch, force, revision_id):
1977
"""Create a group of SwitchHook parameters.
1979
:param control_dir: BzrDir of the checkout to change
1980
:param to_branch: branch that the checkout is to reference
1981
:param force: skip the check for local commits in a heavy checkout
1982
:param revision_id: revision ID to switch to (or None)
1984
self.control_dir = control_dir
1985
self.to_branch = to_branch
1987
self.revision_id = revision_id
1989
def __eq__(self, other):
1990
return self.__dict__ == other.__dict__
1993
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1994
self.control_dir, self.to_branch,
1019
1998
class BzrBranchFormat4(BranchFormat):
1020
1999
"""Bzr branch format 4.
1028
2007
"""See BranchFormat.get_format_description()."""
1029
2008
return "Branch format 4"
1031
def initialize(self, a_bzrdir):
2010
def initialize(self, a_bzrdir, name=None):
1032
2011
"""Create a branch of this format in a_bzrdir."""
1033
2012
utf8_files = [('revision-history', ''),
1034
2013
('branch-name', ''),
1036
return self._initialize_helper(a_bzrdir, utf8_files,
2015
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1037
2016
lock_type='branch4', set_format=False)
1039
2018
def __init__(self):
1040
2019
super(BzrBranchFormat4, self).__init__()
1041
2020
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1043
def open(self, a_bzrdir, _found=False):
1044
"""Return the branch object for a_bzrdir
2022
def network_name(self):
2023
"""The network name for this format is the control dirs disk label."""
2024
return self._matchingbzrdir.get_format_string()
1046
_found is a private parameter, do not use it. It is used to indicate
1047
if format probing has already be done.
2026
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
2027
"""See BranchFormat.open()."""
1050
2029
# we are being called directly and must probe.
1051
2030
raise NotImplementedError
1052
2031
return BzrBranch(_format=self,
1053
2032
_control_files=a_bzrdir._control_files,
1054
2033
a_bzrdir=a_bzrdir,
1055
2035
_repository=a_bzrdir.open_repository())
1057
2037
def __str__(self):
1058
2038
return "Bazaar-NG branch format 4"
1061
class BzrBranchFormat5(BranchFormat):
2041
class BranchFormatMetadir(BranchFormat):
2042
"""Common logic for meta-dir based branch formats."""
2044
def _branch_class(self):
2045
"""What class to instantiate on open calls."""
2046
raise NotImplementedError(self._branch_class)
2048
def network_name(self):
2049
"""A simple byte string uniquely identifying this format for RPC calls.
2051
Metadir branch formats use their format string.
2053
return self.get_format_string()
2055
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
2056
"""See BranchFormat.open()."""
2058
format = BranchFormat.find_format(a_bzrdir, name=name)
2059
if format.__class__ != self.__class__:
2060
raise AssertionError("wrong format %r found for %r" %
2062
transport = a_bzrdir.get_branch_transport(None, name=name)
2064
control_files = lockable_files.LockableFiles(transport, 'lock',
2066
return self._branch_class()(_format=self,
2067
_control_files=control_files,
2070
_repository=a_bzrdir.find_repository(),
2071
ignore_fallbacks=ignore_fallbacks)
2072
except errors.NoSuchFile:
2073
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2076
super(BranchFormatMetadir, self).__init__()
2077
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2078
self._matchingbzrdir.set_branch_format(self)
2080
def supports_tags(self):
2084
class BzrBranchFormat5(BranchFormatMetadir):
1062
2085
"""Bzr branch format 5.
1064
2087
This format has:
1130
2138
"""See BranchFormat.get_format_description()."""
1131
2139
return "Branch format 6"
1133
def initialize(self, a_bzrdir):
1134
"""Create a branch of this format in a_bzrdir."""
1135
utf8_files = [('last-revision', '0 null:\n'),
1136
('branch-name', ''),
1137
('branch.conf', ''),
1140
return self._initialize_helper(a_bzrdir, utf8_files)
1142
def open(self, a_bzrdir, _found=False):
1143
"""Return the branch object for a_bzrdir
1145
_found is a private parameter, do not use it. It is used to indicate
1146
if format probing has already be done.
1149
format = BranchFormat.find_format(a_bzrdir)
1150
assert format.__class__ == self.__class__
1151
transport = a_bzrdir.get_branch_transport(None)
1152
control_files = lockable_files.LockableFiles(transport, 'lock',
1154
return BzrBranch6(_format=self,
1155
_control_files=control_files,
1157
_repository=a_bzrdir.find_repository())
1159
def supports_tags(self):
2141
def initialize(self, a_bzrdir, name=None):
2142
"""Create a branch of this format in a_bzrdir."""
2143
utf8_files = [('last-revision', '0 null:\n'),
2144
('branch.conf', ''),
2147
return self._initialize_helper(a_bzrdir, utf8_files, name)
2149
def make_tags(self, branch):
2150
"""See bzrlib.branch.BranchFormat.make_tags()."""
2151
return BasicTags(branch)
2153
def supports_set_append_revisions_only(self):
2157
class BzrBranchFormat8(BranchFormatMetadir):
2158
"""Metadir format supporting storing locations of subtree branches."""
2160
def _branch_class(self):
2163
def get_format_string(self):
2164
"""See BranchFormat.get_format_string()."""
2165
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2167
def get_format_description(self):
2168
"""See BranchFormat.get_format_description()."""
2169
return "Branch format 8"
2171
def initialize(self, a_bzrdir, name=None):
2172
"""Create a branch of this format in a_bzrdir."""
2173
utf8_files = [('last-revision', '0 null:\n'),
2174
('branch.conf', ''),
2178
return self._initialize_helper(a_bzrdir, utf8_files, name)
2181
super(BzrBranchFormat8, self).__init__()
2182
self._matchingbzrdir.repository_format = \
2183
RepositoryFormatKnitPack5RichRoot()
2185
def make_tags(self, branch):
2186
"""See bzrlib.branch.BranchFormat.make_tags()."""
2187
return BasicTags(branch)
2189
def supports_set_append_revisions_only(self):
2192
def supports_stacking(self):
2195
supports_reference_locations = True
2198
class BzrBranchFormat7(BzrBranchFormat8):
2199
"""Branch format with last-revision, tags, and a stacked location pointer.
2201
The stacked location pointer is passed down to the repository and requires
2202
a repository format with supports_external_lookups = True.
2204
This format was introduced in bzr 1.6.
2207
def initialize(self, a_bzrdir, name=None):
2208
"""Create a branch of this format in a_bzrdir."""
2209
utf8_files = [('last-revision', '0 null:\n'),
2210
('branch.conf', ''),
2213
return self._initialize_helper(a_bzrdir, utf8_files, name)
2215
def _branch_class(self):
2218
def get_format_string(self):
2219
"""See BranchFormat.get_format_string()."""
2220
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2222
def get_format_description(self):
2223
"""See BranchFormat.get_format_description()."""
2224
return "Branch format 7"
2226
def supports_set_append_revisions_only(self):
2229
supports_reference_locations = False
1163
2232
class BranchReferenceFormat(BranchFormat):
1178
2247
def get_format_description(self):
1179
2248
"""See BranchFormat.get_format_description()."""
1180
2249
return "Checkout reference format 1"
1182
def get_reference(self, a_bzrdir):
2251
def get_reference(self, a_bzrdir, name=None):
1183
2252
"""See BranchFormat.get_reference()."""
1184
transport = a_bzrdir.get_branch_transport(None)
1185
return transport.get('location').read()
1187
def initialize(self, a_bzrdir, target_branch=None):
2253
transport = a_bzrdir.get_branch_transport(None, name=name)
2254
return transport.get_bytes('location')
2256
def set_reference(self, a_bzrdir, name, to_branch):
2257
"""See BranchFormat.set_reference()."""
2258
transport = a_bzrdir.get_branch_transport(None, name=name)
2259
location = transport.put_bytes('location', to_branch.base)
2261
def initialize(self, a_bzrdir, name=None, target_branch=None):
1188
2262
"""Create a branch of this format in a_bzrdir."""
1189
2263
if target_branch is None:
1190
2264
# this format does not implement branch itself, thus the implicit
1191
2265
# creation contract must see it as uninitializable
1192
2266
raise errors.UninitializableFormat(self)
1193
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1194
branch_transport = a_bzrdir.get_branch_transport(self)
2267
mutter('creating branch reference in %s', a_bzrdir.user_url)
2268
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1195
2269
branch_transport.put_bytes('location',
1196
target_branch.bzrdir.root_transport.base)
2270
target_branch.bzrdir.user_url)
1197
2271
branch_transport.put_bytes('format', self.get_format_string())
1198
return self.open(a_bzrdir, _found=True)
2273
a_bzrdir, name, _found=True,
2274
possible_transports=[target_branch.bzrdir.root_transport])
2275
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1200
2278
def __init__(self):
1201
2279
super(BranchReferenceFormat, self).__init__()
1202
2280
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2281
self._matchingbzrdir.set_branch_format(self)
1204
2283
def _make_reference_clone_function(format, a_branch):
1205
2284
"""Create a clone() routine for a branch dynamically."""
1206
def clone(to_bzrdir, revision_id=None):
2285
def clone(to_bzrdir, revision_id=None,
2286
repository_policy=None):
1207
2287
"""See Branch.clone()."""
1208
return format.initialize(to_bzrdir, a_branch)
2288
return format.initialize(to_bzrdir, target_branch=a_branch)
1209
2289
# cannot obey revision_id limits when cloning a reference ...
1210
2290
# FIXME RBC 20060210 either nuke revision_id for clone, or
1211
2291
# emit some sort of warning/error to the caller ?!
1214
def open(self, a_bzrdir, _found=False, location=None):
2294
def open(self, a_bzrdir, name=None, _found=False, location=None,
2295
possible_transports=None, ignore_fallbacks=False):
1215
2296
"""Return the branch that the branch reference in a_bzrdir points at.
1217
_found is a private parameter, do not use it. It is used to indicate
1218
if format probing has already be done.
2298
:param a_bzrdir: A BzrDir that contains a branch.
2299
:param name: Name of colocated branch to open, if any
2300
:param _found: a private parameter, do not use it. It is used to
2301
indicate if format probing has already be done.
2302
:param ignore_fallbacks: when set, no fallback branches will be opened
2303
(if there are any). Default is to open fallbacks.
2304
:param location: The location of the referenced branch. If
2305
unspecified, this will be determined from the branch reference in
2307
:param possible_transports: An optional reusable transports list.
1221
format = BranchFormat.find_format(a_bzrdir)
1222
assert format.__class__ == self.__class__
2310
format = BranchFormat.find_format(a_bzrdir, name=name)
2311
if format.__class__ != self.__class__:
2312
raise AssertionError("wrong format %r found for %r" %
1223
2314
if location is None:
1224
location = self.get_reference(a_bzrdir)
1225
real_bzrdir = bzrdir.BzrDir.open(location)
1226
result = real_bzrdir.open_branch()
2315
location = self.get_reference(a_bzrdir, name)
2316
real_bzrdir = bzrdir.BzrDir.open(
2317
location, possible_transports=possible_transports)
2318
result = real_bzrdir.open_branch(name=name,
2319
ignore_fallbacks=ignore_fallbacks)
1227
2320
# this changes the behaviour of result.clone to create a new reference
1228
2321
# rather than a copy of the content of the branch.
1229
2322
# I did not use a proxy object because that needs much more extensive
2332
network_format_registry = registry.FormatRegistry()
2333
"""Registry of formats indexed by their network name.
2335
The network name for a branch format is an identifier that can be used when
2336
referring to formats with smart server operations. See
2337
BranchFormat.network_name() for more detail.
1239
2341
# formats which have no format string are not discoverable
1240
2342
# and not independently creatable, so are not registered.
1241
2343
__format5 = BzrBranchFormat5()
1242
2344
__format6 = BzrBranchFormat6()
2345
__format7 = BzrBranchFormat7()
2346
__format8 = BzrBranchFormat8()
1243
2347
BranchFormat.register_format(__format5)
1244
2348
BranchFormat.register_format(BranchReferenceFormat())
1245
2349
BranchFormat.register_format(__format6)
1246
BranchFormat.set_default_format(__format6)
2350
BranchFormat.register_format(__format7)
2351
BranchFormat.register_format(__format8)
2352
BranchFormat.set_default_format(__format7)
1247
2353
_legacy_formats = [BzrBranchFormat4(),
1250
class BzrBranch(Branch):
2355
network_format_registry.register(
2356
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2359
class BranchWriteLockResult(LogicalLockResult):
2360
"""The result of write locking a branch.
2362
:ivar branch_token: The token obtained from the underlying branch lock, or
2364
:ivar unlock: A callable which will unlock the lock.
2367
def __init__(self, unlock, branch_token):
2368
LogicalLockResult.__init__(self, unlock)
2369
self.branch_token = branch_token
2372
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2376
class BzrBranch(Branch, _RelockDebugMixin):
1251
2377
"""A branch stored in the actual filesystem.
1253
2379
Note that it's "local" in the context of the filesystem; it doesn't
1254
2380
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1255
2381
it's writable, and can be accessed via the normal filesystem API.
2383
:ivar _transport: Transport for file operations on this branch's
2384
control files, typically pointing to the .bzr/branch directory.
2385
:ivar repository: Repository for this branch.
2386
:ivar base: The url of the base directory for this branch; the one
2387
containing the .bzr directory.
2388
:ivar name: Optional colocated branch name as it exists in the control
1258
2392
def __init__(self, _format=None,
1259
_control_files=None, a_bzrdir=None, _repository=None):
2393
_control_files=None, a_bzrdir=None, name=None,
2394
_repository=None, ignore_fallbacks=False):
1260
2395
"""Create new branch object at a particular location."""
1261
Branch.__init__(self)
1262
2396
if a_bzrdir is None:
1263
2397
raise ValueError('a_bzrdir must be supplied')
1265
2399
self.bzrdir = a_bzrdir
1266
# self._transport used to point to the directory containing the
1267
# control directory, but was not used - now it's just the transport
1268
# for the branch control files. mbp 20070212
1269
2400
self._base = self.bzrdir.transport.clone('..').base
2402
# XXX: We should be able to just do
2403
# self.base = self.bzrdir.root_transport.base
2404
# but this does not quite work yet -- mbp 20080522
1270
2405
self._format = _format
1271
2406
if _control_files is None:
1272
2407
raise ValueError('BzrBranch _control_files is None')
1273
2408
self.control_files = _control_files
1274
2409
self._transport = _control_files._transport
1275
2410
self.repository = _repository
2411
Branch.__init__(self)
1277
2413
def __str__(self):
1278
return '%s(%r)' % (self.__class__.__name__, self.base)
2414
if self.name is None:
2415
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2417
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
1280
2420
__repr__ = __str__
1286
2426
base = property(_get_base, doc="The URL for the root of this branch.")
1288
def abspath(self, name):
1289
"""See Branch.abspath."""
1290
return self.control_files._transport.abspath(name)
1293
@deprecated_method(zero_sixteen)
1295
def get_root_id(self):
1296
"""See Branch.get_root_id."""
1297
tree = self.repository.revision_tree(self.last_revision())
1298
return tree.inventory.root.file_id
2428
def _get_config(self):
2429
return TransportConfig(self._transport, 'branch.conf')
1300
2431
def is_locked(self):
1301
2432
return self.control_files.is_locked()
1303
2434
def lock_write(self, token=None):
1304
repo_token = self.repository.lock_write()
2435
"""Lock the branch for write operations.
2437
:param token: A token to permit reacquiring a previously held and
2439
:return: A BranchWriteLockResult.
2441
if not self.is_locked():
2442
self._note_lock('w')
2443
# All-in-one needs to always unlock/lock.
2444
repo_control = getattr(self.repository, 'control_files', None)
2445
if self.control_files == repo_control or not self.is_locked():
2446
self.repository._warn_if_deprecated(self)
2447
self.repository.lock_write()
1306
token = self.control_files.lock_write(token=token)
2452
return BranchWriteLockResult(self.unlock,
2453
self.control_files.lock_write(token=token))
1308
self.repository.unlock()
2456
self.repository.unlock()
1312
2459
def lock_read(self):
1313
self.repository.lock_read()
2460
"""Lock the branch for read operations.
2462
:return: A bzrlib.lock.LogicalLockResult.
2464
if not self.is_locked():
2465
self._note_lock('r')
2466
# All-in-one needs to always unlock/lock.
2467
repo_control = getattr(self.repository, 'control_files', None)
2468
if self.control_files == repo_control or not self.is_locked():
2469
self.repository._warn_if_deprecated(self)
2470
self.repository.lock_read()
1315
2475
self.control_files.lock_read()
2476
return LogicalLockResult(self.unlock)
1317
self.repository.unlock()
2479
self.repository.unlock()
2482
@only_raises(errors.LockNotHeld, errors.LockBroken)
1320
2483
def unlock(self):
1321
# TODO: test for failed two phase locks. This is known broken.
1323
2485
self.control_files.unlock()
1325
self.repository.unlock()
1326
if not self.control_files.is_locked():
1327
# we just released the lock
1328
self._clear_cached_state()
2487
# All-in-one needs to always unlock/lock.
2488
repo_control = getattr(self.repository, 'control_files', None)
2489
if (self.control_files == repo_control or
2490
not self.control_files.is_locked()):
2491
self.repository.unlock()
2492
if not self.control_files.is_locked():
2493
# we just released the lock
2494
self._clear_cached_state()
1330
2496
def peek_lock_mode(self):
1331
2497
if self.control_files._lock_count == 0:
1347
2513
This performs the actual writing to disk.
1348
2514
It is intended to be called by BzrBranch5.set_revision_history."""
1349
self.control_files.put_bytes(
1350
'revision-history', '\n'.join(history))
2515
self._transport.put_bytes(
2516
'revision-history', '\n'.join(history),
2517
mode=self.bzrdir._get_file_mode())
1352
2519
@needs_write_lock
1353
2520
def set_revision_history(self, rev_history):
1354
2521
"""See Branch.set_revision_history."""
1355
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1356
self._clear_cached_state()
2522
if 'evil' in debug.debug_flags:
2523
mutter_callsite(3, "set_revision_history scales with history.")
2524
check_not_reserved_id = _mod_revision.check_not_reserved_id
2525
for rev_id in rev_history:
2526
check_not_reserved_id(rev_id)
2527
if Branch.hooks['post_change_branch_tip']:
2528
# Don't calculate the last_revision_info() if there are no hooks
2530
old_revno, old_revid = self.last_revision_info()
2531
if len(rev_history) == 0:
2532
revid = _mod_revision.NULL_REVISION
2534
revid = rev_history[-1]
2535
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1357
2536
self._write_revision_history(rev_history)
2537
self._clear_cached_state()
1358
2538
self._cache_revision_history(rev_history)
1359
2539
for hook in Branch.hooks['set_rh']:
1360
2540
hook(self, rev_history)
2541
if Branch.hooks['post_change_branch_tip']:
2542
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2544
def _synchronize_history(self, destination, revision_id):
2545
"""Synchronize last revision and revision history between branches.
2547
This version is most efficient when the destination is also a
2548
BzrBranch5, but works for BzrBranch6 as long as the revision
2549
history is the true lefthand parent history, and all of the revisions
2550
are in the destination's repository. If not, set_revision_history
2553
:param destination: The branch to copy the history into
2554
:param revision_id: The revision-id to truncate history at. May
2555
be None to copy complete history.
2557
if not isinstance(destination._format, BzrBranchFormat5):
2558
super(BzrBranch, self)._synchronize_history(
2559
destination, revision_id)
2561
if revision_id == _mod_revision.NULL_REVISION:
2564
new_history = self.revision_history()
2565
if revision_id is not None and new_history != []:
2567
new_history = new_history[:new_history.index(revision_id) + 1]
2569
rev = self.repository.get_revision(revision_id)
2570
new_history = rev.get_history(self.repository)[1:]
2571
destination.set_revision_history(new_history)
1362
2573
@needs_write_lock
1363
2574
def set_last_revision_info(self, revno, revision_id):
1415
2609
:param other_branch: The other branch that DivergedBranches should
1416
2610
raise with respect to.
1418
revision_id = osutils.safe_revision_id(revision_id)
1419
2612
self.set_revision_history(self._lefthand_history(revision_id,
1420
2613
last_rev, other_branch))
1423
def update_revisions(self, other, stop_revision=None):
1424
"""See Branch.update_revisions."""
1427
if stop_revision is None:
1428
stop_revision = other.last_revision()
1429
if stop_revision is None:
1430
# if there are no commits, we're done.
1433
stop_revision = osutils.safe_revision_id(stop_revision)
1434
# whats the current last revision, before we fetch [and change it
1436
last_rev = _mod_revision.ensure_null(self.last_revision())
1437
# we fetch here regardless of whether we need to so that we pickup
1439
self.fetch(other, stop_revision)
1440
if self.repository.get_graph().is_ancestor(stop_revision,
1443
self.generate_revision_history(stop_revision, last_rev=last_rev,
1448
2615
def basis_tree(self):
1449
2616
"""See Branch.basis_tree."""
1450
2617
return self.repository.revision_tree(self.last_revision())
1453
def pull(self, source, overwrite=False, stop_revision=None,
1454
_hook_master=None, run_hooks=True):
1457
:param _hook_master: Private parameter - set the branch to
1458
be supplied as the master to push hooks.
1459
:param run_hooks: Private parameter - if false, this branch
1460
is being called because it's the master of the primary branch,
1461
so it should not run its hooks.
1463
result = PullResult()
1464
result.source_branch = source
1465
result.target_branch = self
1468
result.old_revno, result.old_revid = self.last_revision_info()
1470
self.update_revisions(source, stop_revision)
1471
except DivergedBranches:
1475
if stop_revision is None:
1476
stop_revision = source.last_revision()
1477
self.generate_revision_history(stop_revision)
1478
result.tag_conflicts = source.tags.merge_to(self.tags)
1479
result.new_revno, result.new_revid = self.last_revision_info()
1481
result.master_branch = _hook_master
1482
result.local_branch = self
1484
result.master_branch = self
1485
result.local_branch = None
1487
for hook in Branch.hooks['post_pull']:
1493
2619
def _get_parent_location(self):
1494
2620
_locs = ['parent', 'pull', 'x-pull']
1495
2621
for l in _locs:
1497
return self.control_files.get(l).read().strip('\n')
2623
return self._transport.get_bytes(l).strip('\n')
2624
except errors.NoSuchFile:
1503
def push(self, target, overwrite=False, stop_revision=None,
1504
_override_hook_source_branch=None):
1507
This is the basic concrete implementation of push()
1509
:param _override_hook_source_branch: If specified, run
1510
the hooks passing this Branch as the source, rather than self.
1511
This is for use of RemoteBranch, where push is delegated to the
1512
underlying vfs-based Branch.
1514
# TODO: Public option to disable running hooks - should be trivial but
1518
result = self._push_with_bound_branches(target, overwrite,
1520
_override_hook_source_branch=_override_hook_source_branch)
1525
def _push_with_bound_branches(self, target, overwrite,
1527
_override_hook_source_branch=None):
1528
"""Push from self into target, and into target's master if any.
1530
This is on the base BzrBranch class even though it doesn't support
1531
bound branches because the *target* might be bound.
1534
if _override_hook_source_branch:
1535
result.source_branch = _override_hook_source_branch
1536
for hook in Branch.hooks['post_push']:
1539
bound_location = target.get_bound_location()
1540
if bound_location and target.base != bound_location:
1541
# there is a master branch.
1543
# XXX: Why the second check? Is it even supported for a branch to
1544
# be bound to itself? -- mbp 20070507
1545
master_branch = target.get_master_branch()
1546
master_branch.lock_write()
1548
# push into the master from this branch.
1549
self._basic_push(master_branch, overwrite, stop_revision)
1550
# and push into the target branch from this. Note that we push from
1551
# this branch again, because its considered the highest bandwidth
1553
result = self._basic_push(target, overwrite, stop_revision)
1554
result.master_branch = master_branch
1555
result.local_branch = target
1559
master_branch.unlock()
1562
result = self._basic_push(target, overwrite, stop_revision)
1563
# TODO: Why set master_branch and local_branch if there's no
1564
# binding? Maybe cleaner to just leave them unset? -- mbp
1566
result.master_branch = target
1567
result.local_branch = None
1571
2628
def _basic_push(self, target, overwrite, stop_revision):
1572
2629
"""Basic implementation of push without bound branches or hooks.
1574
Must be called with self read locked and target write locked.
2631
Must be called with source read locked and target write locked.
1576
result = PushResult()
2633
result = BranchPushResult()
1577
2634
result.source_branch = self
1578
2635
result.target_branch = target
1579
2636
result.old_revno, result.old_revid = target.last_revision_info()
1581
target.update_revisions(self, stop_revision)
1582
except DivergedBranches:
1586
target.set_revision_history(self.revision_history())
1587
result.tag_conflicts = self.tags.merge_to(target.tags)
2637
self.update_references(target)
2638
if result.old_revid != self.last_revision():
2639
# We assume that during 'push' this repository is closer than
2641
graph = self.repository.get_graph(target.repository)
2642
target.update_revisions(self, stop_revision,
2643
overwrite=overwrite, graph=graph)
2644
if self._push_should_merge_tags():
2645
result.tag_conflicts = self.tags.merge_to(target.tags,
1588
2647
result.new_revno, result.new_revid = target.last_revision_info()
1591
def get_parent(self):
1592
"""See Branch.get_parent."""
1594
assert self.base[-1] == '/'
1595
parent = self._get_parent_location()
1598
# This is an old-format absolute path to a local branch
1599
# turn it into a url
1600
if parent.startswith('/'):
1601
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1603
return urlutils.join(self.base[:-1], parent)
1604
except errors.InvalidURLJoin, e:
1605
raise errors.InaccessibleParent(parent, self.base)
2650
def get_stacked_on_url(self):
2651
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1607
2653
def set_push_location(self, location):
1608
2654
"""See Branch.set_push_location."""
1610
2656
'push_location', location,
1611
2657
store=_mod_config.STORE_LOCATION_NORECURSE)
1614
def set_parent(self, url):
1615
"""See Branch.set_parent."""
1616
# TODO: Maybe delete old location files?
1617
# URLs should never be unicode, even on the local fs,
1618
# FIXUP this and get_parent in a future branch format bump:
1619
# read and rewrite the file, and have the new format code read
1620
# using .get not .get_utf8. RBC 20060125
1622
if isinstance(url, unicode):
1624
url = url.encode('ascii')
1625
except UnicodeEncodeError:
1626
raise errors.InvalidURL(url,
1627
"Urls must be 7-bit ascii, "
1628
"use bzrlib.urlutils.escape")
1629
url = urlutils.relative_url(self.base, url)
1630
self._set_parent_location(url)
1632
2659
def _set_parent_location(self, url):
1633
2660
if url is None:
1634
self.control_files._transport.delete('parent')
2661
self._transport.delete('parent')
1636
assert isinstance(url, str)
1637
self.control_files.put_bytes('parent', url + '\n')
2663
self._transport.put_bytes('parent', url + '\n',
2664
mode=self.bzrdir._get_file_mode())
1640
2667
class BzrBranch5(BzrBranch):
1641
"""A format 5 branch. This supports new features over plan branches.
2668
"""A format 5 branch. This supports new features over plain branches.
1643
2670
It has support for a master_branch which is the data for bound branches.
1651
super(BzrBranch5, self).__init__(_format=_format,
1652
_control_files=_control_files,
1654
_repository=_repository)
1657
def pull(self, source, overwrite=False, stop_revision=None,
1659
"""Pull from source into self, updating my master if any.
1661
:param run_hooks: Private parameter - if false, this branch
1662
is being called because it's the master of the primary branch,
1663
so it should not run its hooks.
1665
bound_location = self.get_bound_location()
1666
master_branch = None
1667
if bound_location and source.base != bound_location:
1668
# not pulling from master, so we need to update master.
1669
master_branch = self.get_master_branch()
1670
master_branch.lock_write()
1673
# pull from source into master.
1674
master_branch.pull(source, overwrite, stop_revision,
1676
return super(BzrBranch5, self).pull(source, overwrite,
1677
stop_revision, _hook_master=master_branch,
1678
run_hooks=run_hooks)
1681
master_branch.unlock()
1683
2673
def get_bound_location(self):
1685
return self.control_files.get_utf8('bound').read()[:-1]
2675
return self._transport.get_bytes('bound')[:-1]
1686
2676
except errors.NoSuchFile:
1689
2679
@needs_read_lock
1690
def get_master_branch(self):
2680
def get_master_branch(self, possible_transports=None):
1691
2681
"""Return the branch we are bound to.
1693
2683
:return: Either a Branch, or None
1695
2685
This could memoise the branch, but if thats done
1789
class BzrBranchExperimental(BzrBranch5):
1790
"""Bzr experimental branch format
1793
- a revision-history file.
1795
- a lock dir guarding the branch itself
1796
- all of this stored in a branch/ subdirectory
1797
- works with shared repositories.
1798
- a tag dictionary in the branch
1800
This format is new in bzr 0.15, but shouldn't be used for real data,
1803
This class acts as it's own BranchFormat.
1806
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1809
def get_format_string(cls):
1810
"""See BranchFormat.get_format_string()."""
1811
return "Bazaar-NG branch format experimental\n"
1814
def get_format_description(cls):
1815
"""See BranchFormat.get_format_description()."""
1816
return "Experimental branch format"
1819
def get_reference(cls, a_bzrdir):
1820
"""Get the target reference of the branch in a_bzrdir.
1822
format probing must have been completed before calling
1823
this method - it is assumed that the format of the branch
1824
in a_bzrdir is correct.
1826
:param a_bzrdir: The bzrdir to get the branch data from.
1827
:return: None if the branch is not a reference branch.
1832
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1834
branch_transport = a_bzrdir.get_branch_transport(cls)
1835
control_files = lockable_files.LockableFiles(branch_transport,
1836
lock_filename, lock_class)
1837
control_files.create_lock()
1838
control_files.lock_write()
2765
class BzrBranch8(BzrBranch5):
2766
"""A branch that stores tree-reference locations."""
2768
def _open_hook(self):
2769
if self._ignore_fallbacks:
1840
for filename, content in utf8_files:
1841
control_files.put_utf8(filename, content)
1843
control_files.unlock()
1846
def initialize(cls, a_bzrdir):
1847
"""Create a branch of this format in a_bzrdir."""
1848
utf8_files = [('format', cls.get_format_string()),
1849
('revision-history', ''),
1850
('branch-name', ''),
1853
cls._initialize_control_files(a_bzrdir, utf8_files,
1854
'lock', lockdir.LockDir)
1855
return cls.open(a_bzrdir, _found=True)
1858
def open(cls, a_bzrdir, _found=False):
1859
"""Return the branch object for a_bzrdir
1861
_found is a private parameter, do not use it. It is used to indicate
1862
if format probing has already be done.
1865
format = BranchFormat.find_format(a_bzrdir)
1866
assert format.__class__ == cls
1867
transport = a_bzrdir.get_branch_transport(None)
1868
control_files = lockable_files.LockableFiles(transport, 'lock',
1870
return cls(_format=cls,
1871
_control_files=control_files,
1873
_repository=a_bzrdir.find_repository())
1876
def is_supported(cls):
1879
def _make_tags(self):
1880
return BasicTags(self)
1883
def supports_tags(cls):
1887
BranchFormat.register_format(BzrBranchExperimental)
1890
class BzrBranch6(BzrBranch5):
1893
def last_revision_info(self):
1894
revision_string = self.control_files.get('last-revision').read()
2772
url = self.get_stacked_on_url()
2773
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2774
errors.UnstackableBranchFormat):
2777
for hook in Branch.hooks['transform_fallback_location']:
2778
url = hook(self, url)
2780
hook_name = Branch.hooks.get_hook_name(hook)
2781
raise AssertionError(
2782
"'transform_fallback_location' hook %s returned "
2783
"None, not a URL." % hook_name)
2784
self._activate_fallback_location(url)
2786
def __init__(self, *args, **kwargs):
2787
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2788
super(BzrBranch8, self).__init__(*args, **kwargs)
2789
self._last_revision_info_cache = None
2790
self._reference_info = None
2792
def _clear_cached_state(self):
2793
super(BzrBranch8, self)._clear_cached_state()
2794
self._last_revision_info_cache = None
2795
self._reference_info = None
2797
def _last_revision_info(self):
2798
revision_string = self._transport.get_bytes('last-revision')
1895
2799
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1896
2800
revision_id = cache_utf8.get_cached_utf8(revision_id)
1897
2801
revno = int(revno)
1898
2802
return revno, revision_id
1900
def last_revision(self):
1901
"""Return last revision id, or None"""
1902
revision_id = self.last_revision_info()[1]
1905
2804
def _write_last_revision_info(self, revno, revision_id):
1906
2805
"""Simply write out the revision id, with no checks.
1911
2810
Intended to be called by set_last_revision_info and
1912
2811
_write_revision_history.
1914
if revision_id is None:
1915
revision_id = 'null:'
2813
revision_id = _mod_revision.ensure_null(revision_id)
1916
2814
out_string = '%d %s\n' % (revno, revision_id)
1917
self.control_files.put_bytes('last-revision', out_string)
2815
self._transport.put_bytes('last-revision', out_string,
2816
mode=self.bzrdir._get_file_mode())
1919
2818
@needs_write_lock
1920
2819
def set_last_revision_info(self, revno, revision_id):
1921
revision_id = osutils.safe_revision_id(revision_id)
2820
revision_id = _mod_revision.ensure_null(revision_id)
2821
old_revno, old_revid = self.last_revision_info()
1922
2822
if self._get_append_revisions_only():
1923
2823
self._check_history_violation(revision_id)
2824
self._run_pre_change_branch_tip_hooks(revno, revision_id)
1924
2825
self._write_last_revision_info(revno, revision_id)
1925
2826
self._clear_cached_state()
2827
self._last_revision_info_cache = revno, revision_id
2828
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2830
def _synchronize_history(self, destination, revision_id):
2831
"""Synchronize last revision and revision history between branches.
2833
:see: Branch._synchronize_history
2835
# XXX: The base Branch has a fast implementation of this method based
2836
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2837
# that uses set_revision_history. This class inherits from BzrBranch5,
2838
# but wants the fast implementation, so it calls
2839
# Branch._synchronize_history directly.
2840
Branch._synchronize_history(self, destination, revision_id)
1927
2842
def _check_history_violation(self, revision_id):
1928
2843
last_revision = _mod_revision.ensure_null(self.last_revision())
1929
2844
if _mod_revision.is_null(last_revision):
1931
2846
if last_revision not in self._lefthand_history(revision_id):
1932
raise errors.AppendRevisionsOnlyViolation(self.base)
2847
raise errors.AppendRevisionsOnlyViolation(self.user_url)
1934
2849
def _gen_revision_history(self):
1935
2850
"""Generate the revision history from last revision
1937
history = list(self.repository.iter_reverse_revision_history(
1938
self.last_revision()))
2852
last_revno, last_revision = self.last_revision_info()
2853
self._extend_partial_history(stop_index=last_revno-1)
2854
return list(reversed(self._partial_revision_history_cache))
1942
2856
def _write_revision_history(self, history):
1943
2857
"""Factored out of set_revision_history.
1965
2879
"""Set the parent branch"""
1966
2880
return self._get_config_location('parent_location')
2883
def _set_all_reference_info(self, info_dict):
2884
"""Replace all reference info stored in a branch.
2886
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2889
writer = rio.RioWriter(s)
2890
for key, (tree_path, branch_location) in info_dict.iteritems():
2891
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2892
branch_location=branch_location)
2893
writer.write_stanza(stanza)
2894
self._transport.put_bytes('references', s.getvalue())
2895
self._reference_info = info_dict
2898
def _get_all_reference_info(self):
2899
"""Return all the reference info stored in a branch.
2901
:return: A dict of {file_id: (tree_path, branch_location)}
2903
if self._reference_info is not None:
2904
return self._reference_info
2905
rio_file = self._transport.get('references')
2907
stanzas = rio.read_stanzas(rio_file)
2908
info_dict = dict((s['file_id'], (s['tree_path'],
2909
s['branch_location'])) for s in stanzas)
2912
self._reference_info = info_dict
2915
def set_reference_info(self, file_id, tree_path, branch_location):
2916
"""Set the branch location to use for a tree reference.
2918
:param file_id: The file-id of the tree reference.
2919
:param tree_path: The path of the tree reference in the tree.
2920
:param branch_location: The location of the branch to retrieve tree
2923
info_dict = self._get_all_reference_info()
2924
info_dict[file_id] = (tree_path, branch_location)
2925
if None in (tree_path, branch_location):
2926
if tree_path is not None:
2927
raise ValueError('tree_path must be None when branch_location'
2929
if branch_location is not None:
2930
raise ValueError('branch_location must be None when tree_path'
2932
del info_dict[file_id]
2933
self._set_all_reference_info(info_dict)
2935
def get_reference_info(self, file_id):
2936
"""Get the tree_path and branch_location for a tree reference.
2938
:return: a tuple of (tree_path, branch_location)
2940
return self._get_all_reference_info().get(file_id, (None, None))
2942
def reference_parent(self, file_id, path, possible_transports=None):
2943
"""Return the parent branch for a tree-reference file_id.
2945
:param file_id: The file_id of the tree reference
2946
:param path: The path of the file_id in the tree
2947
:return: A branch associated with the file_id
2949
branch_location = self.get_reference_info(file_id)[1]
2950
if branch_location is None:
2951
return Branch.reference_parent(self, file_id, path,
2952
possible_transports)
2953
branch_location = urlutils.join(self.user_url, branch_location)
2954
return Branch.open(branch_location,
2955
possible_transports=possible_transports)
1968
2957
def set_push_location(self, location):
1969
2958
"""See Branch.set_push_location."""
1970
2959
self._set_config_location('push_location', location)
2003
2992
"""See Branch.get_old_bound_location"""
2004
2993
return self._get_bound_location(False)
2006
def set_append_revisions_only(self, enabled):
2011
self.get_config().set_user_option('append_revisions_only', value,
2995
def get_stacked_on_url(self):
2996
# you can always ask for the URL; but you might not be able to use it
2997
# if the repo can't support stacking.
2998
## self._check_stackable_repo()
2999
stacked_url = self._get_config_location('stacked_on_location')
3000
if stacked_url is None:
3001
raise errors.NotStacked(self)
2014
3004
def _get_append_revisions_only(self):
2015
value = self.get_config().get_user_option('append_revisions_only')
2016
return value == 'True'
2018
def _synchronize_history(self, destination, revision_id):
2019
"""Synchronize last revision and revision history between branches.
2021
This version is most efficient when the destination is also a
2022
BzrBranch6, but works for BzrBranch5, as long as the destination's
2023
repository contains all the lefthand ancestors of the intended
2024
last_revision. If not, set_last_revision_info will fail.
2026
:param destination: The branch to copy the history into
2027
:param revision_id: The revision-id to truncate history at. May
2028
be None to copy complete history.
2030
source_revno, source_revision_id = self.last_revision_info()
2031
if revision_id is None:
2032
revno, revision_id = source_revno, source_revision_id
2033
elif source_revision_id == revision_id:
2034
# we know the revno without needing to walk all of history
2035
revno = source_revno
3005
return self.get_config(
3006
).get_user_option_as_bool('append_revisions_only')
3009
def generate_revision_history(self, revision_id, last_rev=None,
3011
"""See BzrBranch5.generate_revision_history"""
3012
history = self._lefthand_history(revision_id, last_rev, other_branch)
3013
revno = len(history)
3014
self.set_last_revision_info(revno, revision_id)
3017
def get_rev_id(self, revno, history=None):
3018
"""Find the revision id of the specified revno."""
3020
return _mod_revision.NULL_REVISION
3022
last_revno, last_revision_id = self.last_revision_info()
3023
if revno <= 0 or revno > last_revno:
3024
raise errors.NoSuchRevision(self, revno)
3026
if history is not None:
3027
return history[revno - 1]
3029
index = last_revno - revno
3030
if len(self._partial_revision_history_cache) <= index:
3031
self._extend_partial_history(stop_index=index)
3032
if len(self._partial_revision_history_cache) > index:
3033
return self._partial_revision_history_cache[index]
2037
# To figure out the revno for a random revision, we need to build
2038
# the revision history, and count its length.
2039
# We don't care about the order, just how long it is.
2040
# Alternatively, we could start at the current location, and count
2041
# backwards. But there is no guarantee that we will find it since
2042
# it may be a merged revision.
2043
revno = len(list(self.repository.iter_reverse_revision_history(
2045
destination.set_last_revision_info(revno, revision_id)
2047
def _make_tags(self):
2048
return BasicTags(self)
3035
raise errors.NoSuchRevision(self, revno)
3038
def revision_id_to_revno(self, revision_id):
3039
"""Given a revision id, return its revno"""
3040
if _mod_revision.is_null(revision_id):
3043
index = self._partial_revision_history_cache.index(revision_id)
3045
self._extend_partial_history(stop_revision=revision_id)
3046
index = len(self._partial_revision_history_cache) - 1
3047
if self._partial_revision_history_cache[index] != revision_id:
3048
raise errors.NoSuchRevision(self, revision_id)
3049
return self.revno() - index
3052
class BzrBranch7(BzrBranch8):
3053
"""A branch with support for a fallback repository."""
3055
def set_reference_info(self, file_id, tree_path, branch_location):
3056
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3058
def get_reference_info(self, file_id):
3059
Branch.get_reference_info(self, file_id)
3061
def reference_parent(self, file_id, path, possible_transports=None):
3062
return Branch.reference_parent(self, file_id, path,
3063
possible_transports)
3066
class BzrBranch6(BzrBranch7):
3067
"""See BzrBranchFormat6 for the capabilities of this branch.
3069
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
3073
def get_stacked_on_url(self):
3074
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2051
3077
######################################################################
2149
3188
new_branch.tags._set_tag_dict({})
2151
3190
# Copying done; now update target format
2152
new_branch.control_files.put_utf8('format',
2153
format.get_format_string())
3191
new_branch._transport.put_bytes('format',
3192
format.get_format_string(),
3193
mode=new_branch.bzrdir._get_file_mode())
2155
3195
# Clean up old files
2156
new_branch.control_files._transport.delete('revision-history')
3196
new_branch._transport.delete('revision-history')
2158
3198
branch.set_parent(None)
3199
except errors.NoSuchFile:
2161
3201
branch.set_bound_location(None)
3204
class Converter6to7(object):
3205
"""Perform an in-place upgrade of format 6 to format 7"""
3207
def convert(self, branch):
3208
format = BzrBranchFormat7()
3209
branch._set_config_location('stacked_on_location', '')
3210
# update target format
3211
branch._transport.put_bytes('format', format.get_format_string())
3214
class Converter7to8(object):
3215
"""Perform an in-place upgrade of format 6 to format 7"""
3217
def convert(self, branch):
3218
format = BzrBranchFormat8()
3219
branch._transport.put_bytes('references', '')
3220
# update target format
3221
branch._transport.put_bytes('format', format.get_format_string())
3224
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3225
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3228
_run_with_write_locked_target will attempt to release the lock it acquires.
3230
If an exception is raised by callable, then that exception *will* be
3231
propagated, even if the unlock attempt raises its own error. Thus
3232
_run_with_write_locked_target should be preferred to simply doing::
3236
return callable(*args, **kwargs)
3241
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3242
# should share code?
3245
result = callable(*args, **kwargs)
3247
exc_info = sys.exc_info()
3251
raise exc_info[0], exc_info[1], exc_info[2]
3257
class InterBranch(InterObject):
3258
"""This class represents operations taking place between two branches.
3260
Its instances have methods like pull() and push() and contain
3261
references to the source and target repositories these operations
3262
can be carried out on.
3266
"""The available optimised InterBranch types."""
3269
def _get_branch_formats_to_test(klass):
3270
"""Return an iterable of format tuples for testing.
3272
:return: An iterable of (from_format, to_format) to use when testing
3273
this InterBranch class. Each InterBranch class should define this
3276
raise NotImplementedError(klass._get_branch_formats_to_test)
3279
def pull(self, overwrite=False, stop_revision=None,
3280
possible_transports=None, local=False):
3281
"""Mirror source into target branch.
3283
The target branch is considered to be 'local', having low latency.
3285
:returns: PullResult instance
3287
raise NotImplementedError(self.pull)
3290
def update_revisions(self, stop_revision=None, overwrite=False,
3292
"""Pull in new perfect-fit revisions.
3294
:param stop_revision: Updated until the given revision
3295
:param overwrite: Always set the branch pointer, rather than checking
3296
to see if it is a proper descendant.
3297
:param graph: A Graph object that can be used to query history
3298
information. This can be None.
3301
raise NotImplementedError(self.update_revisions)
3304
def push(self, overwrite=False, stop_revision=None,
3305
_override_hook_source_branch=None):
3306
"""Mirror the source branch into the target branch.
3308
The source branch is considered to be 'local', having low latency.
3310
raise NotImplementedError(self.push)
3313
def copy_content_into(self, revision_id=None):
3314
"""Copy the content of source into target
3316
revision_id: if not None, the revision history in the new branch will
3317
be truncated to end with revision_id.
3319
raise NotImplementedError(self.copy_content_into)
3322
class GenericInterBranch(InterBranch):
3323
"""InterBranch implementation that uses public Branch functions."""
3326
def is_compatible(klass, source, target):
3327
# GenericBranch uses the public API, so always compatible
3331
def _get_branch_formats_to_test(klass):
3332
return [(BranchFormat._default_format, BranchFormat._default_format)]
3335
def unwrap_format(klass, format):
3336
if isinstance(format, remote.RemoteBranchFormat):
3337
format._ensure_real()
3338
return format._custom_format
3342
def copy_content_into(self, revision_id=None):
3343
"""Copy the content of source into target
3345
revision_id: if not None, the revision history in the new branch will
3346
be truncated to end with revision_id.
3348
self.source.update_references(self.target)
3349
self.source._synchronize_history(self.target, revision_id)
3351
parent = self.source.get_parent()
3352
except errors.InaccessibleParent, e:
3353
mutter('parent was not accessible to copy: %s', e)
3356
self.target.set_parent(parent)
3357
if self.source._push_should_merge_tags():
3358
self.source.tags.merge_to(self.target.tags)
3361
def update_revisions(self, stop_revision=None, overwrite=False,
3363
"""See InterBranch.update_revisions()."""
3364
other_revno, other_last_revision = self.source.last_revision_info()
3365
stop_revno = None # unknown
3366
if stop_revision is None:
3367
stop_revision = other_last_revision
3368
if _mod_revision.is_null(stop_revision):
3369
# if there are no commits, we're done.
3371
stop_revno = other_revno
3373
# what's the current last revision, before we fetch [and change it
3375
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3376
# we fetch here so that we don't process data twice in the common
3377
# case of having something to pull, and so that the check for
3378
# already merged can operate on the just fetched graph, which will
3379
# be cached in memory.
3380
self.target.fetch(self.source, stop_revision)
3381
# Check to see if one is an ancestor of the other
3384
graph = self.target.repository.get_graph()
3385
if self.target._check_if_descendant_or_diverged(
3386
stop_revision, last_rev, graph, self.source):
3387
# stop_revision is a descendant of last_rev, but we aren't
3388
# overwriting, so we're done.
3390
if stop_revno is None:
3392
graph = self.target.repository.get_graph()
3393
this_revno, this_last_revision = \
3394
self.target.last_revision_info()
3395
stop_revno = graph.find_distance_to_null(stop_revision,
3396
[(other_last_revision, other_revno),
3397
(this_last_revision, this_revno)])
3398
self.target.set_last_revision_info(stop_revno, stop_revision)
3401
def pull(self, overwrite=False, stop_revision=None,
3402
possible_transports=None, run_hooks=True,
3403
_override_hook_target=None, local=False):
3404
"""Pull from source into self, updating my master if any.
3406
:param run_hooks: Private parameter - if false, this branch
3407
is being called because it's the master of the primary branch,
3408
so it should not run its hooks.
3410
bound_location = self.target.get_bound_location()
3411
if local and not bound_location:
3412
raise errors.LocalRequiresBoundBranch()
3413
master_branch = None
3414
if not local and bound_location and self.source.user_url != bound_location:
3415
# not pulling from master, so we need to update master.
3416
master_branch = self.target.get_master_branch(possible_transports)
3417
master_branch.lock_write()
3420
# pull from source into master.
3421
master_branch.pull(self.source, overwrite, stop_revision,
3423
return self._pull(overwrite,
3424
stop_revision, _hook_master=master_branch,
3425
run_hooks=run_hooks,
3426
_override_hook_target=_override_hook_target)
3429
master_branch.unlock()
3431
def push(self, overwrite=False, stop_revision=None,
3432
_override_hook_source_branch=None):
3433
"""See InterBranch.push.
3435
This is the basic concrete implementation of push()
3437
:param _override_hook_source_branch: If specified, run
3438
the hooks passing this Branch as the source, rather than self.
3439
This is for use of RemoteBranch, where push is delegated to the
3440
underlying vfs-based Branch.
3442
# TODO: Public option to disable running hooks - should be trivial but
3444
self.source.lock_read()
3446
return _run_with_write_locked_target(
3447
self.target, self._push_with_bound_branches, overwrite,
3449
_override_hook_source_branch=_override_hook_source_branch)
3451
self.source.unlock()
3453
def _push_with_bound_branches(self, overwrite, stop_revision,
3454
_override_hook_source_branch=None):
3455
"""Push from source into target, and into target's master if any.
3458
if _override_hook_source_branch:
3459
result.source_branch = _override_hook_source_branch
3460
for hook in Branch.hooks['post_push']:
3463
bound_location = self.target.get_bound_location()
3464
if bound_location and self.target.base != bound_location:
3465
# there is a master branch.
3467
# XXX: Why the second check? Is it even supported for a branch to
3468
# be bound to itself? -- mbp 20070507
3469
master_branch = self.target.get_master_branch()
3470
master_branch.lock_write()
3472
# push into the master from the source branch.
3473
self.source._basic_push(master_branch, overwrite, stop_revision)
3474
# and push into the target branch from the source. Note that we
3475
# push from the source branch again, because its considered the
3476
# highest bandwidth repository.
3477
result = self.source._basic_push(self.target, overwrite,
3479
result.master_branch = master_branch
3480
result.local_branch = self.target
3484
master_branch.unlock()
3487
result = self.source._basic_push(self.target, overwrite,
3489
# TODO: Why set master_branch and local_branch if there's no
3490
# binding? Maybe cleaner to just leave them unset? -- mbp
3492
result.master_branch = self.target
3493
result.local_branch = None
3497
def _pull(self, overwrite=False, stop_revision=None,
3498
possible_transports=None, _hook_master=None, run_hooks=True,
3499
_override_hook_target=None, local=False):
3502
This function is the core worker, used by GenericInterBranch.pull to
3503
avoid duplication when pulling source->master and source->local.
3505
:param _hook_master: Private parameter - set the branch to
3506
be supplied as the master to pull hooks.
3507
:param run_hooks: Private parameter - if false, this branch
3508
is being called because it's the master of the primary branch,
3509
so it should not run its hooks.
3510
:param _override_hook_target: Private parameter - set the branch to be
3511
supplied as the target_branch to pull hooks.
3512
:param local: Only update the local branch, and not the bound branch.
3514
# This type of branch can't be bound.
3516
raise errors.LocalRequiresBoundBranch()
3517
result = PullResult()
3518
result.source_branch = self.source
3519
if _override_hook_target is None:
3520
result.target_branch = self.target
3522
result.target_branch = _override_hook_target
3523
self.source.lock_read()
3525
# We assume that during 'pull' the target repository is closer than
3527
self.source.update_references(self.target)
3528
graph = self.target.repository.get_graph(self.source.repository)
3529
# TODO: Branch formats should have a flag that indicates
3530
# that revno's are expensive, and pull() should honor that flag.
3532
result.old_revno, result.old_revid = \
3533
self.target.last_revision_info()
3534
self.target.update_revisions(self.source, stop_revision,
3535
overwrite=overwrite, graph=graph)
3536
# TODO: The old revid should be specified when merging tags,
3537
# so a tags implementation that versions tags can only
3538
# pull in the most recent changes. -- JRV20090506
3539
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3541
result.new_revno, result.new_revid = self.target.last_revision_info()
3543
result.master_branch = _hook_master
3544
result.local_branch = result.target_branch
3546
result.master_branch = result.target_branch
3547
result.local_branch = None
3549
for hook in Branch.hooks['post_pull']:
3552
self.source.unlock()
3556
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
