188
142
possible_transports)
189
143
return control.open_branch(), relpath
191
def _push_should_merge_tags(self):
192
"""Should _basic_push merge this branch's tags into the target?
194
The default implementation returns False if this branch has no tags,
195
and True the rest of the time. Subclasses may override this.
197
return self.supports_tags() and self.tags.get_tag_dict()
199
145
def get_config(self):
200
146
return BranchConfig(self)
202
def _get_config(self):
203
"""Get the concrete config for just the config in this branch.
205
This is not intended for client use; see Branch.get_config for the
210
:return: An object supporting get_option and set_option.
212
raise NotImplementedError(self._get_config)
214
def _get_fallback_repository(self, url):
215
"""Get the repository we fallback to at url."""
216
url = urlutils.join(self.base, url)
217
a_branch = Branch.open(url,
218
possible_transports=[self.bzrdir.root_transport])
219
return a_branch.repository
221
def _get_tags_bytes(self):
222
"""Get the bytes of a serialised tags dict.
224
Note that not all branches support tags, nor do all use the same tags
225
logic: this method is specific to BasicTags. Other tag implementations
226
may use the same method name and behave differently, safely, because
227
of the double-dispatch via
228
format.make_tags->tags_instance->get_tags_dict.
230
:return: The bytes of the tags file.
231
:seealso: Branch._set_tags_bytes.
233
return self._transport.get_bytes('tags')
235
def _get_nick(self, local=False, possible_transports=None):
236
config = self.get_config()
237
# explicit overrides master, but don't look for master if local is True
238
if not local and not config.has_explicit_nickname():
240
master = self.get_master_branch(possible_transports)
241
if master is not None:
242
# return the master branch value
244
except errors.BzrError, e:
245
# Silently fall back to local implicit nick if the master is
247
mutter("Could not connect to bound branch, "
248
"falling back to local nick.\n " + str(e))
249
return config.get_nickname()
149
return self.get_config().get_nickname()
251
151
def _set_nick(self, nick):
252
152
self.get_config().set_user_option('nickname', nick, warn_masked=True)
311
173
raise NotImplementedError(self.get_physical_lock_status)
314
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
315
"""Return the revision_id for a dotted revno.
317
:param revno: a tuple like (1,) or (1,1,2)
318
:param _cache_reverse: a private parameter enabling storage
319
of the reverse mapping in a top level cache. (This should
320
only be done in selective circumstances as we want to
321
avoid having the mapping cached multiple times.)
322
:return: the revision_id
323
:raises errors.NoSuchRevision: if the revno doesn't exist
325
rev_id = self._do_dotted_revno_to_revision_id(revno)
327
self._partial_revision_id_to_revno_cache[rev_id] = revno
330
def _do_dotted_revno_to_revision_id(self, revno):
331
"""Worker function for dotted_revno_to_revision_id.
333
Subclasses should override this if they wish to
334
provide a more efficient implementation.
337
return self.get_rev_id(revno[0])
338
revision_id_to_revno = self.get_revision_id_to_revno_map()
339
revision_ids = [revision_id for revision_id, this_revno
340
in revision_id_to_revno.iteritems()
341
if revno == this_revno]
342
if len(revision_ids) == 1:
343
return revision_ids[0]
345
revno_str = '.'.join(map(str, revno))
346
raise errors.NoSuchRevision(self, revno_str)
349
def revision_id_to_dotted_revno(self, revision_id):
350
"""Given a revision id, return its dotted revno.
352
:return: a tuple like (1,) or (400,1,3).
354
return self._do_revision_id_to_dotted_revno(revision_id)
356
def _do_revision_id_to_dotted_revno(self, revision_id):
357
"""Worker function for revision_id_to_revno."""
358
# Try the caches if they are loaded
359
result = self._partial_revision_id_to_revno_cache.get(revision_id)
360
if result is not None:
362
if self._revision_id_to_revno_cache:
363
result = self._revision_id_to_revno_cache.get(revision_id)
365
raise errors.NoSuchRevision(self, revision_id)
366
# Try the mainline as it's optimised
368
revno = self.revision_id_to_revno(revision_id)
370
except errors.NoSuchRevision:
371
# We need to load and use the full revno map after all
372
result = self.get_revision_id_to_revno_map().get(revision_id)
374
raise errors.NoSuchRevision(self, revision_id)
378
176
def get_revision_id_to_revno_map(self):
379
177
"""Return the revision_id => dotted revno map.
405
203
:return: A dictionary mapping revision_id => dotted revno.
205
last_revision = self.last_revision()
206
revision_graph = repository._old_get_graph(self.repository,
208
merge_sorted_revisions = tsort.merge_sort(
407
213
revision_id_to_revno = dict((rev_id, revno)
408
for rev_id, depth, revno, end_of_merge
409
in self.iter_merge_sorted_revisions())
214
for seq_num, rev_id, depth, revno, end_of_merge
215
in merge_sorted_revisions)
410
216
return revision_id_to_revno
413
def iter_merge_sorted_revisions(self, start_revision_id=None,
414
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
415
"""Walk the revisions for a branch in merge sorted order.
417
Merge sorted order is the output from a merge-aware,
418
topological sort, i.e. all parents come before their
419
children going forward; the opposite for reverse.
421
:param start_revision_id: the revision_id to begin walking from.
422
If None, the branch tip is used.
423
:param stop_revision_id: the revision_id to terminate the walk
424
after. If None, the rest of history is included.
425
:param stop_rule: if stop_revision_id is not None, the precise rule
426
to use for termination:
427
* 'exclude' - leave the stop revision out of the result (default)
428
* 'include' - the stop revision is the last item in the result
429
* 'with-merges' - include the stop revision and all of its
430
merged revisions in the result
431
* 'with-merges-without-common-ancestry' - filter out revisions
432
that are in both ancestries
433
:param direction: either 'reverse' or 'forward':
434
* reverse means return the start_revision_id first, i.e.
435
start at the most recent revision and go backwards in history
436
* forward returns tuples in the opposite order to reverse.
437
Note in particular that forward does *not* do any intelligent
438
ordering w.r.t. depth as some clients of this API may like.
439
(If required, that ought to be done at higher layers.)
441
:return: an iterator over (revision_id, depth, revno, end_of_merge)
444
* revision_id: the unique id of the revision
445
* depth: How many levels of merging deep this node has been
447
* revno_sequence: This field provides a sequence of
448
revision numbers for all revisions. The format is:
449
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
450
branch that the revno is on. From left to right the REVNO numbers
451
are the sequence numbers within that branch of the revision.
452
* end_of_merge: When True the next node (earlier in history) is
453
part of a different merge.
455
# Note: depth and revno values are in the context of the branch so
456
# we need the full graph to get stable numbers, regardless of the
458
if self._merge_sorted_revisions_cache is None:
459
last_revision = self.last_revision()
460
known_graph = self.repository.get_known_graph_ancestry(
462
self._merge_sorted_revisions_cache = known_graph.merge_sort(
464
filtered = self._filter_merge_sorted_revisions(
465
self._merge_sorted_revisions_cache, start_revision_id,
466
stop_revision_id, stop_rule)
467
# Make sure we don't return revisions that are not part of the
468
# start_revision_id ancestry.
469
filtered = self._filter_start_non_ancestors(filtered)
470
if direction == 'reverse':
472
if direction == 'forward':
473
return reversed(list(filtered))
475
raise ValueError('invalid direction %r' % direction)
477
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
478
start_revision_id, stop_revision_id, stop_rule):
479
"""Iterate over an inclusive range of sorted revisions."""
480
rev_iter = iter(merge_sorted_revisions)
481
if start_revision_id is not None:
482
for node in rev_iter:
483
rev_id = node.key[-1]
484
if rev_id != start_revision_id:
487
# The decision to include the start or not
488
# depends on the stop_rule if a stop is provided
489
# so pop this node back into the iterator
490
rev_iter = chain(iter([node]), rev_iter)
492
if stop_revision_id is None:
494
for node in rev_iter:
495
rev_id = node.key[-1]
496
yield (rev_id, node.merge_depth, node.revno,
498
elif stop_rule == 'exclude':
499
for node in rev_iter:
500
rev_id = node.key[-1]
501
if rev_id == stop_revision_id:
503
yield (rev_id, node.merge_depth, node.revno,
505
elif stop_rule == 'include':
506
for node in rev_iter:
507
rev_id = node.key[-1]
508
yield (rev_id, node.merge_depth, node.revno,
510
if rev_id == stop_revision_id:
512
elif stop_rule == 'with-merges-without-common-ancestry':
513
# We want to exclude all revisions that are already part of the
514
# stop_revision_id ancestry.
515
graph = self.repository.get_graph()
516
ancestors = graph.find_unique_ancestors(start_revision_id,
518
for node in rev_iter:
519
rev_id = node.key[-1]
520
if rev_id not in ancestors:
522
yield (rev_id, node.merge_depth, node.revno,
524
elif stop_rule == 'with-merges':
525
stop_rev = self.repository.get_revision(stop_revision_id)
526
if stop_rev.parent_ids:
527
left_parent = stop_rev.parent_ids[0]
529
left_parent = _mod_revision.NULL_REVISION
530
# left_parent is the actual revision we want to stop logging at,
531
# since we want to show the merged revisions after the stop_rev too
532
reached_stop_revision_id = False
533
revision_id_whitelist = []
534
for node in rev_iter:
535
rev_id = node.key[-1]
536
if rev_id == left_parent:
537
# reached the left parent after the stop_revision
539
if (not reached_stop_revision_id or
540
rev_id in revision_id_whitelist):
541
yield (rev_id, node.merge_depth, node.revno,
543
if reached_stop_revision_id or rev_id == stop_revision_id:
544
# only do the merged revs of rev_id from now on
545
rev = self.repository.get_revision(rev_id)
547
reached_stop_revision_id = True
548
revision_id_whitelist.extend(rev.parent_ids)
550
raise ValueError('invalid stop_rule %r' % stop_rule)
552
def _filter_start_non_ancestors(self, rev_iter):
553
# If we started from a dotted revno, we want to consider it as a tip
554
# and don't want to yield revisions that are not part of its
555
# ancestry. Given the order guaranteed by the merge sort, we will see
556
# uninteresting descendants of the first parent of our tip before the
558
first = rev_iter.next()
559
(rev_id, merge_depth, revno, end_of_merge) = first
562
# We start at a mainline revision so by definition, all others
563
# revisions in rev_iter are ancestors
564
for node in rev_iter:
569
pmap = self.repository.get_parent_map([rev_id])
570
parents = pmap.get(rev_id, [])
572
whitelist.update(parents)
574
# If there is no parents, there is nothing of interest left
576
# FIXME: It's hard to test this scenario here as this code is never
577
# called in that case. -- vila 20100322
580
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
582
if rev_id in whitelist:
583
pmap = self.repository.get_parent_map([rev_id])
584
parents = pmap.get(rev_id, [])
585
whitelist.remove(rev_id)
586
whitelist.update(parents)
588
# We've reached the mainline, there is nothing left to
592
# A revision that is not part of the ancestry of our
595
yield (rev_id, merge_depth, revno, end_of_merge)
597
218
def leave_lock_in_place(self):
598
219
"""Tell this branch object not to release the physical lock when this
599
220
object is unlocked.
601
222
If lock_write doesn't return a token, then this method is not supported.
603
224
self.control_files.leave_in_place()
757
348
:raises UnstackableRepositoryFormat: If the repository does not support
760
if not self._format.supports_stacking():
761
raise errors.UnstackableBranchFormat(self._format, self.user_url)
762
# XXX: Changing from one fallback repository to another does not check
763
# that all the data you need is present in the new fallback.
764
# Possibly it should.
765
self._check_stackable_repo()
768
old_url = self.get_stacked_on_url()
769
except (errors.NotStacked, errors.UnstackableBranchFormat,
770
errors.UnstackableRepositoryFormat):
774
self._activate_fallback_location(url)
775
# write this out after the repository is stacked to avoid setting a
776
# stacked config that doesn't work.
777
self._set_config_location('stacked_on_location', url)
780
"""Change a branch to be unstacked, copying data as needed.
782
Don't call this directly, use set_stacked_on_url(None).
784
pb = ui.ui_factory.nested_progress_bar()
786
pb.update("Unstacking")
787
# The basic approach here is to fetch the tip of the branch,
788
# including all available ghosts, from the existing stacked
789
# repository into a new repository object without the fallbacks.
791
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
792
# correct for CHKMap repostiories
793
old_repository = self.repository
794
if len(old_repository._fallback_repositories) != 1:
795
raise AssertionError("can't cope with fallback repositories "
796
"of %r" % (self.repository,))
797
# unlock it, including unlocking the fallback
798
old_repository.unlock()
799
old_repository.lock_read()
801
# Repositories don't offer an interface to remove fallback
802
# repositories today; take the conceptually simpler option and just
803
# reopen it. We reopen it starting from the URL so that we
804
# get a separate connection for RemoteRepositories and can
805
# stream from one of them to the other. This does mean doing
806
# separate SSH connection setup, but unstacking is not a
807
# common operation so it's tolerable.
808
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
809
new_repository = new_bzrdir.find_repository()
810
self.repository = new_repository
811
if self.repository._fallback_repositories:
812
raise AssertionError("didn't expect %r to have "
813
"fallback_repositories"
814
% (self.repository,))
815
# this is not paired with an unlock because it's just restoring
816
# the previous state; the lock's released when set_stacked_on_url
818
self.repository.lock_write()
819
# XXX: If you unstack a branch while it has a working tree
820
# with a pending merge, the pending-merged revisions will no
821
# longer be present. You can (probably) revert and remerge.
823
# XXX: This only fetches up to the tip of the repository; it
824
# doesn't bring across any tags. That's fairly consistent
825
# with how branch works, but perhaps not ideal.
826
self.repository.fetch(old_repository,
827
revision_id=self.last_revision(),
830
old_repository.unlock()
834
def _set_tags_bytes(self, bytes):
835
"""Mirror method for _get_tags_bytes.
837
:seealso: Branch._get_tags_bytes.
839
return _run_with_write_locked_target(self, self._transport.put_bytes,
351
raise NotImplementedError(self.set_stacked_on_url)
842
353
def _cache_revision_history(self, rev_history):
843
354
"""Set the cached revision history to rev_history.
975
487
information. This can be None.
978
return InterBranch.get(other, self).update_revisions(stop_revision,
981
def import_last_revision_info(self, source_repo, revno, revid):
982
"""Set the last revision info, importing from another repo if necessary.
984
This is used by the bound branch code to upload a revision to
985
the master branch first before updating the tip of the local branch.
987
:param source_repo: Source repository to optionally fetch from
988
:param revno: Revision number of the new tip
989
:param revid: Revision id of the new tip
991
if not self.repository.has_same_location(source_repo):
992
self.repository.fetch(source_repo, revision_id=revid)
993
self.set_last_revision_info(revno, revid)
492
other_revno, other_last_revision = other.last_revision_info()
493
stop_revno = None # unknown
494
if stop_revision is None:
495
stop_revision = other_last_revision
496
if _mod_revision.is_null(stop_revision):
497
# if there are no commits, we're done.
499
stop_revno = other_revno
501
# what's the current last revision, before we fetch [and change it
503
last_rev = _mod_revision.ensure_null(self.last_revision())
504
# we fetch here so that we don't process data twice in the common
505
# case of having something to pull, and so that the check for
506
# already merged can operate on the just fetched graph, which will
507
# be cached in memory.
508
self.fetch(other, stop_revision)
509
# Check to see if one is an ancestor of the other
512
graph = self.repository.get_graph()
513
if self._check_if_descendant_or_diverged(
514
stop_revision, last_rev, graph, other):
515
# stop_revision is a descendant of last_rev, but we aren't
516
# overwriting, so we're done.
518
if stop_revno is None:
520
graph = self.repository.get_graph()
521
this_revno, this_last_revision = self.last_revision_info()
522
stop_revno = graph.find_distance_to_null(stop_revision,
523
[(other_last_revision, other_revno),
524
(this_last_revision, this_revno)])
525
self.set_last_revision_info(stop_revno, stop_revision)
995
529
def revision_id_to_revno(self, revision_id):
996
530
"""Given a revision id, return its revno"""
1002
536
except ValueError:
1003
537
raise errors.NoSuchRevision(self, revision_id)
1006
539
def get_rev_id(self, revno, history=None):
1007
540
"""Find the revision id of the specified revno."""
1009
542
return _mod_revision.NULL_REVISION
1010
last_revno, last_revid = self.last_revision_info()
1011
if revno == last_revno:
1013
if revno <= 0 or revno > last_revno:
544
history = self.revision_history()
545
if revno <= 0 or revno > len(history):
1014
546
raise errors.NoSuchRevision(self, revno)
1015
distance_from_last = last_revno - revno
1016
if len(self._partial_revision_history_cache) <= distance_from_last:
1017
self._extend_partial_history(distance_from_last)
1018
return self._partial_revision_history_cache[distance_from_last]
547
return history[revno - 1]
1021
549
def pull(self, source, overwrite=False, stop_revision=None,
1022
possible_transports=None, *args, **kwargs):
550
possible_transports=None, _override_hook_target=None):
1023
551
"""Mirror source into this branch.
1025
553
This branch is considered to be 'local', having low latency.
1027
555
:returns: PullResult instance
1029
return InterBranch.get(source, self).pull(overwrite=overwrite,
1030
stop_revision=stop_revision,
1031
possible_transports=possible_transports, *args, **kwargs)
557
raise NotImplementedError(self.pull)
1033
def push(self, target, overwrite=False, stop_revision=None, *args,
559
def push(self, target, overwrite=False, stop_revision=None):
1035
560
"""Mirror this branch into target.
1037
562
This branch is considered to be 'local', having low latency.
1039
return InterBranch.get(self, target).push(overwrite, stop_revision,
1042
def lossy_push(self, target, stop_revision=None):
1043
"""Push deltas into another branch.
1045
:note: This does not, like push, retain the revision ids from
1046
the source branch and will, rather than adding bzr-specific
1047
metadata, push only those semantics of the revision that can be
1048
natively represented by this branch' VCS.
1050
:param target: Target branch
1051
:param stop_revision: Revision to push, defaults to last revision.
1052
:return: BranchPushResult with an extra member revidmap:
1053
A dictionary mapping revision ids from the target branch
1054
to new revision ids in the target branch, for each
1055
revision that was pushed.
1057
inter = InterBranch.get(self, target)
1058
lossy_push = getattr(inter, "lossy_push", None)
1059
if lossy_push is None:
1060
raise errors.LossyPushToSameVCS(self, target)
1061
return lossy_push(stop_revision)
564
raise NotImplementedError(self.push)
1063
566
def basis_tree(self):
1064
567
"""Return `Tree` object for last revision."""
1227
685
revision_id: if not None, the revision history in the new branch will
1228
686
be truncated to end with revision_id.
1230
if (repository_policy is not None and
1231
repository_policy.requires_stacking()):
1232
to_bzrdir._format.require_stacking(_skip_repo=True)
1233
688
result = to_bzrdir.create_branch()
1236
if repository_policy is not None:
1237
repository_policy.configure_branch(result)
1238
self.copy_content_into(result, revision_id=revision_id)
1239
result.set_parent(self.bzrdir.root_transport.base)
689
self.copy_content_into(result, revision_id=revision_id)
690
result.set_parent(self.bzrdir.root_transport.base)
1244
693
def _synchronize_history(self, destination, revision_id):
1245
694
"""Synchronize last revision and revision history between branches.
1247
696
This version is most efficient when the destination is also a
1248
BzrBranch6, but works for BzrBranch5, as long as the destination's
1249
repository contains all the lefthand ancestors of the intended
1250
last_revision. If not, set_last_revision_info will fail.
697
BzrBranch5, but works for BzrBranch6 as long as the revision
698
history is the true lefthand parent history, and all of the revisions
699
are in the destination's repository. If not, set_revision_history
1252
702
:param destination: The branch to copy the history into
1253
703
:param revision_id: The revision-id to truncate history at. May
1254
704
be None to copy complete history.
1256
source_revno, source_revision_id = self.last_revision_info()
1257
if revision_id is None:
1258
revno, revision_id = source_revno, source_revision_id
706
if revision_id == _mod_revision.NULL_REVISION:
1260
graph = self.repository.get_graph()
709
new_history = self.revision_history()
710
if revision_id is not None and new_history != []:
1262
revno = graph.find_distance_to_null(revision_id,
1263
[(source_revision_id, source_revno)])
1264
except errors.GhostRevisionsHaveNoRevno:
1265
# Default to 1, if we can't find anything else
1267
destination.set_last_revision_info(revno, revision_id)
712
new_history = new_history[:new_history.index(revision_id) + 1]
714
rev = self.repository.get_revision(revision_id)
715
new_history = rev.get_history(self.repository)[1:]
716
destination.set_revision_history(new_history)
1269
718
@needs_read_lock
1270
719
def copy_content_into(self, destination, revision_id=None):
1284
732
destination.set_parent(parent)
1285
if self._push_should_merge_tags():
1286
self.tags.merge_to(destination.tags)
1288
def update_references(self, target):
1289
if not getattr(self._format, 'supports_reference_locations', False):
1291
reference_dict = self._get_all_reference_info()
1292
if len(reference_dict) == 0:
1294
old_base = self.base
1295
new_base = target.base
1296
target_reference_dict = target._get_all_reference_info()
1297
for file_id, (tree_path, branch_location) in (
1298
reference_dict.items()):
1299
branch_location = urlutils.rebase_url(branch_location,
1301
target_reference_dict.setdefault(
1302
file_id, (tree_path, branch_location))
1303
target._set_all_reference_info(target_reference_dict)
733
self.tags.merge_to(destination.tags)
1305
735
@needs_read_lock
1306
def check(self, refs):
1307
737
"""Check consistency of the branch.
1309
739
In particular this checks that revisions given in the revision-history
1310
do actually match up in the revision graph, and that they're all
740
do actually match up in the revision graph, and that they're all
1311
741
present in the repository.
1313
743
Callers will typically also want to check the repository.
1315
:param refs: Calculated refs for this branch as specified by
1316
branch._get_check_refs()
1317
745
:return: A BranchCheckResult.
1319
result = BranchCheckResult(self)
747
mainline_parent_id = None
1320
748
last_revno, last_revision_id = self.last_revision_info()
1321
actual_revno = refs[('lefthand-distance', last_revision_id)]
1322
if actual_revno != last_revno:
1323
result.errors.append(errors.BzrCheckError(
1324
'revno does not match len(mainline) %s != %s' % (
1325
last_revno, actual_revno)))
1326
# TODO: We should probably also check that self.revision_history
1327
# matches the repository for older branch formats.
1328
# If looking for the code that cross-checks repository parents against
1329
# the iter_reverse_revision_history output, that is now a repository
749
real_rev_history = list(self.repository.iter_reverse_revision_history(
751
real_rev_history.reverse()
752
if len(real_rev_history) != last_revno:
753
raise errors.BzrCheckError('revno does not match len(mainline)'
754
' %s != %s' % (last_revno, len(real_rev_history)))
755
# TODO: We should probably also check that real_rev_history actually
756
# matches self.revision_history()
757
for revision_id in real_rev_history:
759
revision = self.repository.get_revision(revision_id)
760
except errors.NoSuchRevision, e:
761
raise errors.BzrCheckError("mainline revision {%s} not in repository"
763
# In general the first entry on the revision history has no parents.
764
# But it's not illegal for it to have parents listed; this can happen
765
# in imports from Arch when the parents weren't reachable.
766
if mainline_parent_id is not None:
767
if mainline_parent_id not in revision.parent_ids:
768
raise errors.BzrCheckError("previous revision {%s} not listed among "
770
% (mainline_parent_id, revision_id))
771
mainline_parent_id = revision_id
772
return BranchCheckResult(self)
1333
774
def _get_checkout_format(self):
1334
775
"""Return the most suitable metadir for a checkout of this branch.
1612
1000
filename, content,
1613
1001
mode=a_bzrdir._get_file_mode())
1616
control_files.unlock()
1617
branch = self.open(a_bzrdir, name, _found=True)
1618
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1003
control_files.unlock()
1004
return self.open(a_bzrdir, _found=True)
1621
def initialize(self, a_bzrdir, name=None):
1622
"""Create a branch of this format in a_bzrdir.
1624
:param name: Name of the colocated branch to create.
1006
def initialize(self, a_bzrdir):
1007
"""Create a branch of this format in a_bzrdir."""
1626
1008
raise NotImplementedError(self.initialize)
1628
1010
def is_supported(self):
1629
1011
"""Is this format supported?
1631
1013
Supported formats can be initialized and opened.
1632
Unsupported formats may not support initialization or committing or
1014
Unsupported formats may not support initialization or committing or
1633
1015
some other features depending on the reason for not being supported.
1637
def make_tags(self, branch):
1638
"""Create a tags object for branch.
1640
This method is on BranchFormat, because BranchFormats are reflected
1641
over the wire via network_name(), whereas full Branch instances require
1642
multiple VFS method calls to operate at all.
1644
The default implementation returns a disabled-tags instance.
1646
Note that it is normal for branch to be a RemoteBranch when using tags
1649
return DisabledTags(branch)
1651
def network_name(self):
1652
"""A simple byte string uniquely identifying this format for RPC calls.
1654
MetaDir branch formats use their disk format string to identify the
1655
repository over the wire. All in one formats such as bzr < 0.8, and
1656
foreign formats like svn/git and hg should use some marker which is
1657
unique and immutable.
1659
raise NotImplementedError(self.network_name)
1661
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1019
def open(self, a_bzrdir, _found=False):
1662
1020
"""Return the branch object for a_bzrdir
1664
:param a_bzrdir: A BzrDir that contains a branch.
1665
:param name: Name of colocated branch to open
1666
:param _found: a private parameter, do not use it. It is used to
1667
indicate if format probing has already be done.
1668
:param ignore_fallbacks: when set, no fallback branches will be opened
1669
(if there are any). Default is to open fallbacks.
1022
_found is a private parameter, do not use it. It is used to indicate
1023
if format probing has already be done.
1671
1025
raise NotImplementedError(self.open)
1674
1028
def register_format(klass, format):
1675
"""Register a metadir format."""
1676
1029
klass._formats[format.get_format_string()] = format
1677
# Metadir formats have a network name of their format string, and get
1678
# registered as class factories.
1679
network_format_registry.register(format.get_format_string(), format.__class__)
1682
1032
def set_default_format(klass, format):
1683
1033
klass._default_format = format
1685
def supports_set_append_revisions_only(self):
1686
"""True if this format supports set_append_revisions_only."""
1689
1035
def supports_stacking(self):
1690
1036
"""True if this format records a stacked-on branch."""
1718
1064
Hooks.__init__(self)
1719
self.create_hook(HookPoint('set_rh',
1720
"Invoked whenever the revision history has been set via "
1721
"set_revision_history. The api signature is (branch, "
1722
"revision_history), and the branch will be write-locked. "
1723
"The set_rh hook can be expensive for bzr to trigger, a better "
1724
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1725
self.create_hook(HookPoint('open',
1726
"Called with the Branch object that has been opened after a "
1727
"branch is opened.", (1, 8), None))
1728
self.create_hook(HookPoint('post_push',
1729
"Called after a push operation completes. post_push is called "
1730
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1731
"bzr client.", (0, 15), None))
1732
self.create_hook(HookPoint('post_pull',
1733
"Called after a pull operation completes. post_pull is called "
1734
"with a bzrlib.branch.PullResult object and only runs in the "
1735
"bzr client.", (0, 15), None))
1736
self.create_hook(HookPoint('pre_commit',
1737
"Called after a commit is calculated but before it is is "
1738
"completed. pre_commit is called with (local, master, old_revno, "
1739
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1740
"). old_revid is NULL_REVISION for the first commit to a branch, "
1741
"tree_delta is a TreeDelta object describing changes from the "
1742
"basis revision. hooks MUST NOT modify this delta. "
1743
" future_tree is an in-memory tree obtained from "
1744
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1745
"tree.", (0,91), None))
1746
self.create_hook(HookPoint('post_commit',
1747
"Called in the bzr client after a commit has completed. "
1748
"post_commit is called with (local, master, old_revno, old_revid, "
1749
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1750
"commit to a branch.", (0, 15), None))
1751
self.create_hook(HookPoint('post_uncommit',
1752
"Called in the bzr client after an uncommit completes. "
1753
"post_uncommit is called with (local, master, old_revno, "
1754
"old_revid, new_revno, new_revid) where local is the local branch "
1755
"or None, master is the target branch, and an empty branch "
1756
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1757
self.create_hook(HookPoint('pre_change_branch_tip',
1758
"Called in bzr client and server before a change to the tip of a "
1759
"branch is made. pre_change_branch_tip is called with a "
1760
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1761
"commit, uncommit will all trigger this hook.", (1, 6), None))
1762
self.create_hook(HookPoint('post_change_branch_tip',
1763
"Called in bzr client and server after a change to the tip of a "
1764
"branch is made. post_change_branch_tip is called with a "
1765
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1766
"commit, uncommit will all trigger this hook.", (1, 4), None))
1767
self.create_hook(HookPoint('transform_fallback_location',
1768
"Called when a stacked branch is activating its fallback "
1769
"locations. transform_fallback_location is called with (branch, "
1770
"url), and should return a new url. Returning the same url "
1771
"allows it to be used as-is, returning a different one can be "
1772
"used to cause the branch to stack on a closer copy of that "
1773
"fallback_location. Note that the branch cannot have history "
1774
"accessing methods called on it during this hook because the "
1775
"fallback locations have not been activated. When there are "
1776
"multiple hooks installed for transform_fallback_location, "
1777
"all are called with the url returned from the previous hook."
1778
"The order is however undefined.", (1, 9), None))
1779
self.create_hook(HookPoint('automatic_tag_name',
1780
"Called to determine an automatic tag name for a revision."
1781
"automatic_tag_name is called with (branch, revision_id) and "
1782
"should return a tag name or None if no tag name could be "
1783
"determined. The first non-None tag name returned will be used.",
1785
self.create_hook(HookPoint('post_branch_init',
1786
"Called after new branch initialization completes. "
1787
"post_branch_init is called with a "
1788
"bzrlib.branch.BranchInitHookParams. "
1789
"Note that init, branch and checkout (both heavyweight and "
1790
"lightweight) will all trigger this hook.", (2, 2), None))
1791
self.create_hook(HookPoint('post_switch',
1792
"Called after a checkout switches branch. "
1793
"post_switch is called with a "
1794
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1065
# Introduced in 0.15:
1066
# invoked whenever the revision history has been set
1067
# with set_revision_history. The api signature is
1068
# (branch, revision_history), and the branch will
1071
# invoked after a push operation completes.
1072
# the api signature is
1074
# containing the members
1075
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1076
# where local is the local target branch or None, master is the target
1077
# master branch, and the rest should be self explanatory. The source
1078
# is read locked and the target branches write locked. Source will
1079
# be the local low-latency branch.
1080
self['post_push'] = []
1081
# invoked after a pull operation completes.
1082
# the api signature is
1084
# containing the members
1085
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1086
# where local is the local branch or None, master is the target
1087
# master branch, and the rest should be self explanatory. The source
1088
# is read locked and the target branches write locked. The local
1089
# branch is the low-latency branch.
1090
self['post_pull'] = []
1091
# invoked before a commit operation takes place.
1092
# the api signature is
1093
# (local, master, old_revno, old_revid, future_revno, future_revid,
1094
# tree_delta, future_tree).
1095
# old_revid is NULL_REVISION for the first commit to a branch
1096
# tree_delta is a TreeDelta object describing changes from the basis
1097
# revision, hooks MUST NOT modify this delta
1098
# future_tree is an in-memory tree obtained from
1099
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1100
self['pre_commit'] = []
1101
# invoked after a commit operation completes.
1102
# the api signature is
1103
# (local, master, old_revno, old_revid, new_revno, new_revid)
1104
# old_revid is NULL_REVISION for the first commit to a branch.
1105
self['post_commit'] = []
1106
# invoked after a uncommit operation completes.
1107
# the api signature is
1108
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1109
# local is the local branch or None, master is the target branch,
1110
# and an empty branch recieves new_revno of 0, new_revid of None.
1111
self['post_uncommit'] = []
1113
# Invoked before the tip of a branch changes.
1114
# the api signature is
1115
# (params) where params is a ChangeBranchTipParams with the members
1116
# (branch, old_revno, new_revno, old_revid, new_revid)
1117
self['pre_change_branch_tip'] = []
1119
# Invoked after the tip of a branch changes.
1120
# the api signature is
1121
# (params) where params is a ChangeBranchTipParams with the members
1122
# (branch, old_revno, new_revno, old_revid, new_revid)
1123
self['post_change_branch_tip'] = []
1798
1126
# install the default hooks into the Branch class.
1831
1159
def __eq__(self, other):
1832
1160
return self.__dict__ == other.__dict__
1834
1162
def __repr__(self):
1835
1163
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1836
self.__class__.__name__, self.branch,
1164
self.__class__.__name__, self.branch,
1837
1165
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1840
class BranchInitHookParams(object):
1841
"""Object holding parameters passed to *_branch_init hooks.
1843
There are 4 fields that hooks may wish to access:
1845
:ivar format: the branch format
1846
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1847
:ivar name: name of colocated branch, if any (or None)
1848
:ivar branch: the branch created
1850
Note that for lightweight checkouts, the bzrdir and format fields refer to
1851
the checkout, hence they are different from the corresponding fields in
1852
branch, which refer to the original branch.
1855
def __init__(self, format, a_bzrdir, name, branch):
1856
"""Create a group of BranchInitHook parameters.
1858
:param format: the branch format
1859
:param a_bzrdir: the BzrDir where the branch will be/has been
1861
:param name: name of colocated branch, if any (or None)
1862
:param branch: the branch created
1864
Note that for lightweight checkouts, the bzrdir and format fields refer
1865
to the checkout, hence they are different from the corresponding fields
1866
in branch, which refer to the original branch.
1868
self.format = format
1869
self.bzrdir = a_bzrdir
1871
self.branch = branch
1873
def __eq__(self, other):
1874
return self.__dict__ == other.__dict__
1878
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1880
return "<%s of format:%s bzrdir:%s>" % (
1881
self.__class__.__name__, self.branch,
1882
self.format, self.bzrdir)
1885
class SwitchHookParams(object):
1886
"""Object holding parameters passed to *_switch hooks.
1888
There are 4 fields that hooks may wish to access:
1890
:ivar control_dir: BzrDir of the checkout to change
1891
:ivar to_branch: branch that the checkout is to reference
1892
:ivar force: skip the check for local commits in a heavy checkout
1893
:ivar revision_id: revision ID to switch to (or None)
1896
def __init__(self, control_dir, to_branch, force, revision_id):
1897
"""Create a group of SwitchHook parameters.
1899
:param control_dir: BzrDir of the checkout to change
1900
:param to_branch: branch that the checkout is to reference
1901
:param force: skip the check for local commits in a heavy checkout
1902
:param revision_id: revision ID to switch to (or None)
1904
self.control_dir = control_dir
1905
self.to_branch = to_branch
1907
self.revision_id = revision_id
1909
def __eq__(self, other):
1910
return self.__dict__ == other.__dict__
1913
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1914
self.control_dir, self.to_branch,
1918
1168
class BzrBranchFormat4(BranchFormat):
1919
1169
"""Bzr branch format 4.
2058
1301
"""See BranchFormat.get_format_description()."""
2059
1302
return "Branch format 6"
2061
def initialize(self, a_bzrdir, name=None):
2062
"""Create a branch of this format in a_bzrdir."""
2063
utf8_files = [('last-revision', '0 null:\n'),
2064
('branch.conf', ''),
2067
return self._initialize_helper(a_bzrdir, utf8_files, name)
2069
def make_tags(self, branch):
2070
"""See bzrlib.branch.BranchFormat.make_tags()."""
2071
return BasicTags(branch)
2073
def supports_set_append_revisions_only(self):
2077
class BzrBranchFormat8(BranchFormatMetadir):
2078
"""Metadir format supporting storing locations of subtree branches."""
2080
def _branch_class(self):
2083
def get_format_string(self):
2084
"""See BranchFormat.get_format_string()."""
2085
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2087
def get_format_description(self):
2088
"""See BranchFormat.get_format_description()."""
2089
return "Branch format 8"
2091
def initialize(self, a_bzrdir, name=None):
2092
"""Create a branch of this format in a_bzrdir."""
2093
utf8_files = [('last-revision', '0 null:\n'),
2094
('branch.conf', ''),
2098
return self._initialize_helper(a_bzrdir, utf8_files, name)
2101
super(BzrBranchFormat8, self).__init__()
2102
self._matchingbzrdir.repository_format = \
2103
RepositoryFormatKnitPack5RichRoot()
2105
def make_tags(self, branch):
2106
"""See bzrlib.branch.BranchFormat.make_tags()."""
2107
return BasicTags(branch)
2109
def supports_set_append_revisions_only(self):
2112
def supports_stacking(self):
2115
supports_reference_locations = True
2118
class BzrBranchFormat7(BzrBranchFormat8):
1304
def initialize(self, a_bzrdir):
1305
"""Create a branch of this format in a_bzrdir."""
1306
utf8_files = [('last-revision', '0 null:\n'),
1307
('branch.conf', ''),
1310
return self._initialize_helper(a_bzrdir, utf8_files)
1313
class BzrBranchFormat7(BranchFormatMetadir):
2119
1314
"""Branch format with last-revision, tags, and a stacked location pointer.
2121
1316
The stacked location pointer is passed down to the repository and requires
2171
1369
def get_reference(self, a_bzrdir):
2172
1370
"""See BranchFormat.get_reference()."""
2173
1371
transport = a_bzrdir.get_branch_transport(None)
2174
return transport.get_bytes('location')
1372
return transport.get('location').read()
2176
1374
def set_reference(self, a_bzrdir, to_branch):
2177
1375
"""See BranchFormat.set_reference()."""
2178
1376
transport = a_bzrdir.get_branch_transport(None)
2179
1377
location = transport.put_bytes('location', to_branch.base)
2181
def initialize(self, a_bzrdir, name=None, target_branch=None):
1379
def initialize(self, a_bzrdir, target_branch=None):
2182
1380
"""Create a branch of this format in a_bzrdir."""
2183
1381
if target_branch is None:
2184
1382
# this format does not implement branch itself, thus the implicit
2185
1383
# creation contract must see it as uninitializable
2186
1384
raise errors.UninitializableFormat(self)
2187
mutter('creating branch reference in %s', a_bzrdir.user_url)
2188
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1385
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1386
branch_transport = a_bzrdir.get_branch_transport(self)
2189
1387
branch_transport.put_bytes('location',
2190
target_branch.bzrdir.user_url)
1388
target_branch.bzrdir.root_transport.base)
2191
1389
branch_transport.put_bytes('format', self.get_format_string())
2193
a_bzrdir, name, _found=True,
1391
a_bzrdir, _found=True,
2194
1392
possible_transports=[target_branch.bzrdir.root_transport])
2195
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2198
1394
def __init__(self):
2199
1395
super(BranchReferenceFormat, self).__init__()
2200
1396
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2201
self._matchingbzrdir.set_branch_format(self)
2203
1398
def _make_reference_clone_function(format, a_branch):
2204
1399
"""Create a clone() routine for a branch dynamically."""
2205
def clone(to_bzrdir, revision_id=None,
2206
repository_policy=None):
1400
def clone(to_bzrdir, revision_id=None):
2207
1401
"""See Branch.clone()."""
2208
return format.initialize(to_bzrdir, target_branch=a_branch)
1402
return format.initialize(to_bzrdir, a_branch)
2209
1403
# cannot obey revision_id limits when cloning a reference ...
2210
1404
# FIXME RBC 20060210 either nuke revision_id for clone, or
2211
1405
# emit some sort of warning/error to the caller ?!
2214
def open(self, a_bzrdir, name=None, _found=False, location=None,
2215
possible_transports=None, ignore_fallbacks=False):
1408
def open(self, a_bzrdir, _found=False, location=None,
1409
possible_transports=None):
2216
1410
"""Return the branch that the branch reference in a_bzrdir points at.
2218
:param a_bzrdir: A BzrDir that contains a branch.
2219
:param name: Name of colocated branch to open, if any
2220
:param _found: a private parameter, do not use it. It is used to
2221
indicate if format probing has already be done.
2222
:param ignore_fallbacks: when set, no fallback branches will be opened
2223
(if there are any). Default is to open fallbacks.
2224
:param location: The location of the referenced branch. If
2225
unspecified, this will be determined from the branch reference in
2227
:param possible_transports: An optional reusable transports list.
1412
_found is a private parameter, do not use it. It is used to indicate
1413
if format probing has already be done.
2230
format = BranchFormat.find_format(a_bzrdir, name=name)
1416
format = BranchFormat.find_format(a_bzrdir)
2231
1417
if format.__class__ != self.__class__:
2232
1418
raise AssertionError("wrong format %r found for %r" %
2233
1419
(format, self))
2252
network_format_registry = registry.FormatRegistry()
2253
"""Registry of formats indexed by their network name.
2255
The network name for a branch format is an identifier that can be used when
2256
referring to formats with smart server operations. See
2257
BranchFormat.network_name() for more detail.
2261
1437
# formats which have no format string are not discoverable
2262
1438
# and not independently creatable, so are not registered.
2263
1439
__format5 = BzrBranchFormat5()
2264
1440
__format6 = BzrBranchFormat6()
2265
1441
__format7 = BzrBranchFormat7()
2266
__format8 = BzrBranchFormat8()
2267
1442
BranchFormat.register_format(__format5)
2268
1443
BranchFormat.register_format(BranchReferenceFormat())
2269
1444
BranchFormat.register_format(__format6)
2270
1445
BranchFormat.register_format(__format7)
2271
BranchFormat.register_format(__format8)
2272
BranchFormat.set_default_format(__format7)
1446
BranchFormat.set_default_format(__format6)
2273
1447
_legacy_formats = [BzrBranchFormat4(),
2275
network_format_registry.register(
2276
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2279
class BranchWriteLockResult(object):
2280
"""The result of write locking a branch.
2282
:ivar branch_token: The token obtained from the underlying branch lock, or
2284
:ivar unlock: A callable which will unlock the lock.
2287
def __init__(self, unlock, branch_token):
2288
self.branch_token = branch_token
2289
self.unlock = unlock
2292
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2296
class BzrBranch(Branch, _RelockDebugMixin):
1450
class BzrBranch(Branch):
2297
1451
"""A branch stored in the actual filesystem.
2299
1453
Note that it's "local" in the context of the filesystem; it doesn't
2300
1454
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2301
1455
it's writable, and can be accessed via the normal filesystem API.
2303
:ivar _transport: Transport for file operations on this branch's
1457
:ivar _transport: Transport for file operations on this branch's
2304
1458
control files, typically pointing to the .bzr/branch directory.
2305
1459
:ivar repository: Repository for this branch.
2306
:ivar base: The url of the base directory for this branch; the one
1460
:ivar base: The url of the base directory for this branch; the one
2307
1461
containing the .bzr directory.
2308
:ivar name: Optional colocated branch name as it exists in the control
2312
1464
def __init__(self, _format=None,
2313
_control_files=None, a_bzrdir=None, name=None,
2314
_repository=None, ignore_fallbacks=False):
1465
_control_files=None, a_bzrdir=None, _repository=None):
2315
1466
"""Create new branch object at a particular location."""
2316
1467
if a_bzrdir is None:
2317
1468
raise ValueError('a_bzrdir must be supplied')
2319
1470
self.bzrdir = a_bzrdir
2320
1471
self._base = self.bzrdir.transport.clone('..').base
2322
1472
# XXX: We should be able to just do
2323
1473
# self.base = self.bzrdir.root_transport.base
2324
1474
# but this does not quite work yet -- mbp 20080522
2346
1492
base = property(_get_base, doc="The URL for the root of this branch.")
2348
def _get_config(self):
2349
return TransportConfig(self._transport, 'branch.conf')
2351
1494
def is_locked(self):
2352
1495
return self.control_files.is_locked()
2354
1497
def lock_write(self, token=None):
2355
"""Lock the branch for write operations.
2357
:param token: A token to permit reacquiring a previously held and
2359
:return: A BranchWriteLockResult.
2361
if not self.is_locked():
2362
self._note_lock('w')
2363
# All-in-one needs to always unlock/lock.
2364
repo_control = getattr(self.repository, 'control_files', None)
2365
if self.control_files == repo_control or not self.is_locked():
2366
self.repository._warn_if_deprecated(self)
2367
self.repository.lock_write()
1498
repo_token = self.repository.lock_write()
2372
return BranchWriteLockResult(self.unlock,
2373
self.control_files.lock_write(token=token))
1500
token = self.control_files.lock_write(token=token)
2376
self.repository.unlock()
1502
self.repository.unlock()
2379
1506
def lock_read(self):
2380
"""Lock the branch for read operations.
2382
:return: An object with an unlock method which will release the lock
2385
if not self.is_locked():
2386
self._note_lock('r')
2387
# All-in-one needs to always unlock/lock.
2388
repo_control = getattr(self.repository, 'control_files', None)
2389
if self.control_files == repo_control or not self.is_locked():
2390
self.repository._warn_if_deprecated(self)
2391
self.repository.lock_read()
1507
self.repository.lock_read()
2396
1509
self.control_files.lock_read()
2400
self.repository.unlock()
1511
self.repository.unlock()
2403
@only_raises(errors.LockNotHeld, errors.LockBroken)
2404
1514
def unlock(self):
1515
# TODO: test for failed two phase locks. This is known broken.
2406
1517
self.control_files.unlock()
2408
# All-in-one needs to always unlock/lock.
2409
repo_control = getattr(self.repository, 'control_files', None)
2410
if (self.control_files == repo_control or
2411
not self.control_files.is_locked()):
2412
self.repository.unlock()
2413
if not self.control_files.is_locked():
2414
# we just released the lock
2415
self._clear_cached_state()
1519
self.repository.unlock()
1520
if not self.control_files.is_locked():
1521
# we just released the lock
1522
self._clear_cached_state()
2417
1524
def peek_lock_mode(self):
2418
1525
if self.control_files._lock_count == 0:
2462
1569
if Branch.hooks['post_change_branch_tip']:
2463
1570
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2465
def _synchronize_history(self, destination, revision_id):
2466
"""Synchronize last revision and revision history between branches.
2468
This version is most efficient when the destination is also a
2469
BzrBranch5, but works for BzrBranch6 as long as the revision
2470
history is the true lefthand parent history, and all of the revisions
2471
are in the destination's repository. If not, set_revision_history
2474
:param destination: The branch to copy the history into
2475
:param revision_id: The revision-id to truncate history at. May
2476
be None to copy complete history.
2478
if not isinstance(destination._format, BzrBranchFormat5):
2479
super(BzrBranch, self)._synchronize_history(
2480
destination, revision_id)
1572
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1573
"""Run the pre_change_branch_tip hooks."""
1574
hooks = Branch.hooks['pre_change_branch_tip']
2482
if revision_id == _mod_revision.NULL_REVISION:
2485
new_history = self.revision_history()
2486
if revision_id is not None and new_history != []:
1577
old_revno, old_revid = self.last_revision_info()
1578
params = ChangeBranchTipParams(
1579
self, old_revno, new_revno, old_revid, new_revid)
2488
new_history = new_history[:new_history.index(revision_id) + 1]
2490
rev = self.repository.get_revision(revision_id)
2491
new_history = rev.get_history(self.repository)[1:]
2492
destination.set_revision_history(new_history)
1583
except errors.TipChangeRejected:
1586
exc_info = sys.exc_info()
1587
hook_name = Branch.hooks.get_hook_name(hook)
1588
raise errors.HookFailed(
1589
'pre_change_branch_tip', hook_name, exc_info)
1591
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1592
"""Run the post_change_branch_tip hooks."""
1593
hooks = Branch.hooks['post_change_branch_tip']
1596
new_revno, new_revid = self.last_revision_info()
1597
params = ChangeBranchTipParams(
1598
self, old_revno, new_revno, old_revid, new_revid)
2494
1602
@needs_write_lock
2495
1603
def set_last_revision_info(self, revno, revision_id):
2496
1604
"""Set the last revision of this branch.
1728
def push(self, target, overwrite=False, stop_revision=None,
1729
_override_hook_source_branch=None):
1732
This is the basic concrete implementation of push()
1734
:param _override_hook_source_branch: If specified, run
1735
the hooks passing this Branch as the source, rather than self.
1736
This is for use of RemoteBranch, where push is delegated to the
1737
underlying vfs-based Branch.
1739
# TODO: Public option to disable running hooks - should be trivial but
1743
result = self._push_with_bound_branches(target, overwrite,
1745
_override_hook_source_branch=_override_hook_source_branch)
1750
def _push_with_bound_branches(self, target, overwrite,
1752
_override_hook_source_branch=None):
1753
"""Push from self into target, and into target's master if any.
1755
This is on the base BzrBranch class even though it doesn't support
1756
bound branches because the *target* might be bound.
1759
if _override_hook_source_branch:
1760
result.source_branch = _override_hook_source_branch
1761
for hook in Branch.hooks['post_push']:
1764
bound_location = target.get_bound_location()
1765
if bound_location and target.base != bound_location:
1766
# there is a master branch.
1768
# XXX: Why the second check? Is it even supported for a branch to
1769
# be bound to itself? -- mbp 20070507
1770
master_branch = target.get_master_branch()
1771
master_branch.lock_write()
1773
# push into the master from this branch.
1774
self._basic_push(master_branch, overwrite, stop_revision)
1775
# and push into the target branch from this. Note that we push from
1776
# this branch again, because its considered the highest bandwidth
1778
result = self._basic_push(target, overwrite, stop_revision)
1779
result.master_branch = master_branch
1780
result.local_branch = target
1784
master_branch.unlock()
1787
result = self._basic_push(target, overwrite, stop_revision)
1788
# TODO: Why set master_branch and local_branch if there's no
1789
# binding? Maybe cleaner to just leave them unset? -- mbp
1791
result.master_branch = target
1792
result.local_branch = None
2549
1796
def _basic_push(self, target, overwrite, stop_revision):
2550
1797
"""Basic implementation of push without bound branches or hooks.
2552
Must be called with source read locked and target write locked.
1799
Must be called with self read locked and target write locked.
2554
result = BranchPushResult()
1801
result = PushResult()
2555
1802
result.source_branch = self
2556
1803
result.target_branch = target
2557
1804
result.old_revno, result.old_revid = target.last_revision_info()
2558
self.update_references(target)
2559
if result.old_revid != self.last_revision():
2560
# We assume that during 'push' this repository is closer than
2562
graph = self.repository.get_graph(target.repository)
2563
target.update_revisions(self, stop_revision,
2564
overwrite=overwrite, graph=graph)
2565
if self._push_should_merge_tags():
2566
result.tag_conflicts = self.tags.merge_to(target.tags,
1806
# We assume that during 'push' this repository is closer than
1808
graph = self.repository.get_graph(target.repository)
1809
target.update_revisions(self, stop_revision, overwrite=overwrite,
1811
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2568
1812
result.new_revno, result.new_revid = target.last_revision_info()
1815
def get_parent(self):
1816
"""See Branch.get_parent."""
1817
parent = self._get_parent_location()
1820
# This is an old-format absolute path to a local branch
1821
# turn it into a url
1822
if parent.startswith('/'):
1823
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1825
return urlutils.join(self.base[:-1], parent)
1826
except errors.InvalidURLJoin, e:
1827
raise errors.InaccessibleParent(parent, self.base)
2571
1829
def get_stacked_on_url(self):
2572
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1830
raise errors.UnstackableBranchFormat(self._format, self.base)
2574
1832
def set_push_location(self, location):
2575
1833
"""See Branch.set_push_location."""
2686
class BzrBranch8(BzrBranch5):
2687
"""A branch that stores tree-reference locations."""
1994
class BzrBranch7(BzrBranch5):
1995
"""A branch with support for a fallback repository."""
1997
def _get_fallback_repository(self, url):
1998
"""Get the repository we fallback to at url."""
1999
url = urlutils.join(self.base, url)
2000
return bzrdir.BzrDir.open(url).open_branch().repository
2002
def _activate_fallback_location(self, url):
2003
"""Activate the branch/repository from url as a fallback repository."""
2004
self.repository.add_fallback_repository(
2005
self._get_fallback_repository(url))
2689
2007
def _open_hook(self):
2690
if self._ignore_fallbacks:
2693
2009
url = self.get_stacked_on_url()
2694
2010
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2695
2011
errors.UnstackableBranchFormat):
2698
for hook in Branch.hooks['transform_fallback_location']:
2699
url = hook(self, url)
2701
hook_name = Branch.hooks.get_hook_name(hook)
2702
raise AssertionError(
2703
"'transform_fallback_location' hook %s returned "
2704
"None, not a URL." % hook_name)
2705
2014
self._activate_fallback_location(url)
2016
def _check_stackable_repo(self):
2017
if not self.repository._format.supports_external_lookups:
2018
raise errors.UnstackableRepositoryFormat(self.repository._format,
2019
self.repository.base)
2707
2021
def __init__(self, *args, **kwargs):
2708
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2709
super(BzrBranch8, self).__init__(*args, **kwargs)
2022
super(BzrBranch7, self).__init__(*args, **kwargs)
2710
2023
self._last_revision_info_cache = None
2711
self._reference_info = None
2024
self._partial_revision_history_cache = []
2713
2026
def _clear_cached_state(self):
2714
super(BzrBranch8, self)._clear_cached_state()
2027
super(BzrBranch7, self)._clear_cached_state()
2715
2028
self._last_revision_info_cache = None
2716
self._reference_info = None
2029
self._partial_revision_history_cache = []
2718
2031
def _last_revision_info(self):
2719
2032
revision_string = self._transport.get_bytes('last-revision')
2800
2130
"""Set the parent branch"""
2801
2131
return self._get_config_location('parent_location')
2804
def _set_all_reference_info(self, info_dict):
2805
"""Replace all reference info stored in a branch.
2807
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2810
writer = rio.RioWriter(s)
2811
for key, (tree_path, branch_location) in info_dict.iteritems():
2812
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2813
branch_location=branch_location)
2814
writer.write_stanza(stanza)
2815
self._transport.put_bytes('references', s.getvalue())
2816
self._reference_info = info_dict
2819
def _get_all_reference_info(self):
2820
"""Return all the reference info stored in a branch.
2822
:return: A dict of {file_id: (tree_path, branch_location)}
2824
if self._reference_info is not None:
2825
return self._reference_info
2826
rio_file = self._transport.get('references')
2828
stanzas = rio.read_stanzas(rio_file)
2829
info_dict = dict((s['file_id'], (s['tree_path'],
2830
s['branch_location'])) for s in stanzas)
2833
self._reference_info = info_dict
2836
def set_reference_info(self, file_id, tree_path, branch_location):
2837
"""Set the branch location to use for a tree reference.
2839
:param file_id: The file-id of the tree reference.
2840
:param tree_path: The path of the tree reference in the tree.
2841
:param branch_location: The location of the branch to retrieve tree
2844
info_dict = self._get_all_reference_info()
2845
info_dict[file_id] = (tree_path, branch_location)
2846
if None in (tree_path, branch_location):
2847
if tree_path is not None:
2848
raise ValueError('tree_path must be None when branch_location'
2850
if branch_location is not None:
2851
raise ValueError('branch_location must be None when tree_path'
2853
del info_dict[file_id]
2854
self._set_all_reference_info(info_dict)
2856
def get_reference_info(self, file_id):
2857
"""Get the tree_path and branch_location for a tree reference.
2859
:return: a tuple of (tree_path, branch_location)
2861
return self._get_all_reference_info().get(file_id, (None, None))
2863
def reference_parent(self, file_id, path, possible_transports=None):
2864
"""Return the parent branch for a tree-reference file_id.
2866
:param file_id: The file_id of the tree reference
2867
:param path: The path of the file_id in the tree
2868
:return: A branch associated with the file_id
2870
branch_location = self.get_reference_info(file_id)[1]
2871
if branch_location is None:
2872
return Branch.reference_parent(self, file_id, path,
2873
possible_transports)
2874
branch_location = urlutils.join(self.user_url, branch_location)
2875
return Branch.open(branch_location,
2876
possible_transports=possible_transports)
2878
2133
def set_push_location(self, location):
2879
2134
"""See Branch.set_push_location."""
2880
2135
self._set_config_location('push_location', location)
2914
2169
return self._get_bound_location(False)
2916
2171
def get_stacked_on_url(self):
2917
# you can always ask for the URL; but you might not be able to use it
2918
# if the repo can't support stacking.
2919
## self._check_stackable_repo()
2172
self._check_stackable_repo()
2920
2173
stacked_url = self._get_config_location('stacked_on_location')
2921
2174
if stacked_url is None:
2922
2175
raise errors.NotStacked(self)
2923
2176
return stacked_url
2178
def set_append_revisions_only(self, enabled):
2183
self.get_config().set_user_option('append_revisions_only', value,
2186
def set_stacked_on_url(self, url):
2187
self._check_stackable_repo()
2190
old_url = self.get_stacked_on_url()
2191
except (errors.NotStacked, errors.UnstackableBranchFormat,
2192
errors.UnstackableRepositoryFormat):
2195
# repositories don't offer an interface to remove fallback
2196
# repositories today; take the conceptually simpler option and just
2198
self.repository = self.bzrdir.find_repository()
2199
# for every revision reference the branch has, ensure it is pulled
2201
source_repository = self._get_fallback_repository(old_url)
2202
for revision_id in chain([self.last_revision()],
2203
self.tags.get_reverse_tag_dict()):
2204
self.repository.fetch(source_repository, revision_id,
2207
self._activate_fallback_location(url)
2208
# write this out after the repository is stacked to avoid setting a
2209
# stacked config that doesn't work.
2210
self._set_config_location('stacked_on_location', url)
2925
2212
def _get_append_revisions_only(self):
2926
return self.get_config(
2927
).get_user_option_as_bool('append_revisions_only')
2213
value = self.get_config().get_user_option('append_revisions_only')
2214
return value == 'True'
2216
def _synchronize_history(self, destination, revision_id):
2217
"""Synchronize last revision and revision history between branches.
2219
This version is most efficient when the destination is also a
2220
BzrBranch6, but works for BzrBranch5, as long as the destination's
2221
repository contains all the lefthand ancestors of the intended
2222
last_revision. If not, set_last_revision_info will fail.
2224
:param destination: The branch to copy the history into
2225
:param revision_id: The revision-id to truncate history at. May
2226
be None to copy complete history.
2228
source_revno, source_revision_id = self.last_revision_info()
2229
if revision_id is None:
2230
revno, revision_id = source_revno, source_revision_id
2231
elif source_revision_id == revision_id:
2232
# we know the revno without needing to walk all of history
2233
revno = source_revno
2235
# To figure out the revno for a random revision, we need to build
2236
# the revision history, and count its length.
2237
# We don't care about the order, just how long it is.
2238
# Alternatively, we could start at the current location, and count
2239
# backwards. But there is no guarantee that we will find it since
2240
# it may be a merged revision.
2241
revno = len(list(self.repository.iter_reverse_revision_history(
2243
destination.set_last_revision_info(revno, revision_id)
2245
def _make_tags(self):
2246
return BasicTags(self)
2929
2248
@needs_write_lock
2930
2249
def generate_revision_history(self, revision_id, last_rev=None,
3130
2429
branch._set_config_location('stacked_on_location', '')
3131
2430
# update target format
3132
2431
branch._transport.put_bytes('format', format.get_format_string())
3135
class Converter7to8(object):
3136
"""Perform an in-place upgrade of format 6 to format 7"""
3138
def convert(self, branch):
3139
format = BzrBranchFormat8()
3140
branch._transport.put_bytes('references', '')
3141
# update target format
3142
branch._transport.put_bytes('format', format.get_format_string())
3145
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3146
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3149
_run_with_write_locked_target will attempt to release the lock it acquires.
3151
If an exception is raised by callable, then that exception *will* be
3152
propagated, even if the unlock attempt raises its own error. Thus
3153
_run_with_write_locked_target should be preferred to simply doing::
3157
return callable(*args, **kwargs)
3162
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3163
# should share code?
3166
result = callable(*args, **kwargs)
3168
exc_info = sys.exc_info()
3172
raise exc_info[0], exc_info[1], exc_info[2]
3178
class InterBranch(InterObject):
3179
"""This class represents operations taking place between two branches.
3181
Its instances have methods like pull() and push() and contain
3182
references to the source and target repositories these operations
3183
can be carried out on.
3187
"""The available optimised InterBranch types."""
3190
def _get_branch_formats_to_test():
3191
"""Return a tuple with the Branch formats to use when testing."""
3192
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3194
def pull(self, overwrite=False, stop_revision=None,
3195
possible_transports=None, local=False):
3196
"""Mirror source into target branch.
3198
The target branch is considered to be 'local', having low latency.
3200
:returns: PullResult instance
3202
raise NotImplementedError(self.pull)
3204
def update_revisions(self, stop_revision=None, overwrite=False,
3206
"""Pull in new perfect-fit revisions.
3208
:param stop_revision: Updated until the given revision
3209
:param overwrite: Always set the branch pointer, rather than checking
3210
to see if it is a proper descendant.
3211
:param graph: A Graph object that can be used to query history
3212
information. This can be None.
3215
raise NotImplementedError(self.update_revisions)
3217
def push(self, overwrite=False, stop_revision=None,
3218
_override_hook_source_branch=None):
3219
"""Mirror the source branch into the target branch.
3221
The source branch is considered to be 'local', having low latency.
3223
raise NotImplementedError(self.push)
3226
class GenericInterBranch(InterBranch):
3227
"""InterBranch implementation that uses public Branch functions.
3231
def _get_branch_formats_to_test():
3232
return BranchFormat._default_format, BranchFormat._default_format
3234
def update_revisions(self, stop_revision=None, overwrite=False,
3236
"""See InterBranch.update_revisions()."""
3237
self.source.lock_read()
3239
other_revno, other_last_revision = self.source.last_revision_info()
3240
stop_revno = None # unknown
3241
if stop_revision is None:
3242
stop_revision = other_last_revision
3243
if _mod_revision.is_null(stop_revision):
3244
# if there are no commits, we're done.
3246
stop_revno = other_revno
3248
# what's the current last revision, before we fetch [and change it
3250
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3251
# we fetch here so that we don't process data twice in the common
3252
# case of having something to pull, and so that the check for
3253
# already merged can operate on the just fetched graph, which will
3254
# be cached in memory.
3255
self.target.fetch(self.source, stop_revision)
3256
# Check to see if one is an ancestor of the other
3259
graph = self.target.repository.get_graph()
3260
if self.target._check_if_descendant_or_diverged(
3261
stop_revision, last_rev, graph, self.source):
3262
# stop_revision is a descendant of last_rev, but we aren't
3263
# overwriting, so we're done.
3265
if stop_revno is None:
3267
graph = self.target.repository.get_graph()
3268
this_revno, this_last_revision = \
3269
self.target.last_revision_info()
3270
stop_revno = graph.find_distance_to_null(stop_revision,
3271
[(other_last_revision, other_revno),
3272
(this_last_revision, this_revno)])
3273
self.target.set_last_revision_info(stop_revno, stop_revision)
3275
self.source.unlock()
3277
def pull(self, overwrite=False, stop_revision=None,
3278
possible_transports=None, _hook_master=None, run_hooks=True,
3279
_override_hook_target=None, local=False):
3282
:param _hook_master: Private parameter - set the branch to
3283
be supplied as the master to pull hooks.
3284
:param run_hooks: Private parameter - if false, this branch
3285
is being called because it's the master of the primary branch,
3286
so it should not run its hooks.
3287
:param _override_hook_target: Private parameter - set the branch to be
3288
supplied as the target_branch to pull hooks.
3289
:param local: Only update the local branch, and not the bound branch.
3291
# This type of branch can't be bound.
3293
raise errors.LocalRequiresBoundBranch()
3294
result = PullResult()
3295
result.source_branch = self.source
3296
if _override_hook_target is None:
3297
result.target_branch = self.target
3299
result.target_branch = _override_hook_target
3300
self.source.lock_read()
3302
# We assume that during 'pull' the target repository is closer than
3304
self.source.update_references(self.target)
3305
graph = self.target.repository.get_graph(self.source.repository)
3306
# TODO: Branch formats should have a flag that indicates
3307
# that revno's are expensive, and pull() should honor that flag.
3309
result.old_revno, result.old_revid = \
3310
self.target.last_revision_info()
3311
self.target.update_revisions(self.source, stop_revision,
3312
overwrite=overwrite, graph=graph)
3313
# TODO: The old revid should be specified when merging tags,
3314
# so a tags implementation that versions tags can only
3315
# pull in the most recent changes. -- JRV20090506
3316
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3318
result.new_revno, result.new_revid = self.target.last_revision_info()
3320
result.master_branch = _hook_master
3321
result.local_branch = result.target_branch
3323
result.master_branch = result.target_branch
3324
result.local_branch = None
3326
for hook in Branch.hooks['post_pull']:
3329
self.source.unlock()
3332
def push(self, overwrite=False, stop_revision=None,
3333
_override_hook_source_branch=None):
3334
"""See InterBranch.push.
3336
This is the basic concrete implementation of push()
3338
:param _override_hook_source_branch: If specified, run
3339
the hooks passing this Branch as the source, rather than self.
3340
This is for use of RemoteBranch, where push is delegated to the
3341
underlying vfs-based Branch.
3343
# TODO: Public option to disable running hooks - should be trivial but
3345
self.source.lock_read()
3347
return _run_with_write_locked_target(
3348
self.target, self._push_with_bound_branches, overwrite,
3350
_override_hook_source_branch=_override_hook_source_branch)
3352
self.source.unlock()
3354
def _push_with_bound_branches(self, overwrite, stop_revision,
3355
_override_hook_source_branch=None):
3356
"""Push from source into target, and into target's master if any.
3359
if _override_hook_source_branch:
3360
result.source_branch = _override_hook_source_branch
3361
for hook in Branch.hooks['post_push']:
3364
bound_location = self.target.get_bound_location()
3365
if bound_location and self.target.base != bound_location:
3366
# there is a master branch.
3368
# XXX: Why the second check? Is it even supported for a branch to
3369
# be bound to itself? -- mbp 20070507
3370
master_branch = self.target.get_master_branch()
3371
master_branch.lock_write()
3373
# push into the master from the source branch.
3374
self.source._basic_push(master_branch, overwrite, stop_revision)
3375
# and push into the target branch from the source. Note that we
3376
# push from the source branch again, because its considered the
3377
# highest bandwidth repository.
3378
result = self.source._basic_push(self.target, overwrite,
3380
result.master_branch = master_branch
3381
result.local_branch = self.target
3385
master_branch.unlock()
3388
result = self.source._basic_push(self.target, overwrite,
3390
# TODO: Why set master_branch and local_branch if there's no
3391
# binding? Maybe cleaner to just leave them unset? -- mbp
3393
result.master_branch = self.target
3394
result.local_branch = None
3399
def is_compatible(self, source, target):
3400
# GenericBranch uses the public API, so always compatible
3404
class InterToBranch5(GenericInterBranch):
3407
def _get_branch_formats_to_test():
3408
return BranchFormat._default_format, BzrBranchFormat5()
3410
def pull(self, overwrite=False, stop_revision=None,
3411
possible_transports=None, run_hooks=True,
3412
_override_hook_target=None, local=False):
3413
"""Pull from source into self, updating my master if any.
3415
:param run_hooks: Private parameter - if false, this branch
3416
is being called because it's the master of the primary branch,
3417
so it should not run its hooks.
3419
bound_location = self.target.get_bound_location()
3420
if local and not bound_location:
3421
raise errors.LocalRequiresBoundBranch()
3422
master_branch = None
3423
if not local and bound_location and self.source.user_url != bound_location:
3424
# not pulling from master, so we need to update master.
3425
master_branch = self.target.get_master_branch(possible_transports)
3426
master_branch.lock_write()
3429
# pull from source into master.
3430
master_branch.pull(self.source, overwrite, stop_revision,
3432
return super(InterToBranch5, self).pull(overwrite,
3433
stop_revision, _hook_master=master_branch,
3434
run_hooks=run_hooks,
3435
_override_hook_target=_override_hook_target)
3438
master_branch.unlock()
3441
InterBranch.register_optimiser(GenericInterBranch)
3442
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
