436
233
:return: A dictionary mapping revision_id => dotted revno.
235
last_revision = self.last_revision()
236
revision_graph = self.repository.get_revision_graph(last_revision)
237
merge_sorted_revisions = tsort.merge_sort(
438
242
revision_id_to_revno = dict((rev_id, revno)
439
for rev_id, depth, revno, end_of_merge
440
in self.iter_merge_sorted_revisions())
243
for seq_num, rev_id, depth, revno, end_of_merge
244
in merge_sorted_revisions)
441
245
return revision_id_to_revno
444
def iter_merge_sorted_revisions(self, start_revision_id=None,
445
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
446
"""Walk the revisions for a branch in merge sorted order.
448
Merge sorted order is the output from a merge-aware,
449
topological sort, i.e. all parents come before their
450
children going forward; the opposite for reverse.
452
:param start_revision_id: the revision_id to begin walking from.
453
If None, the branch tip is used.
454
:param stop_revision_id: the revision_id to terminate the walk
455
after. If None, the rest of history is included.
456
:param stop_rule: if stop_revision_id is not None, the precise rule
457
to use for termination:
459
* 'exclude' - leave the stop revision out of the result (default)
460
* 'include' - the stop revision is the last item in the result
461
* 'with-merges' - include the stop revision and all of its
462
merged revisions in the result
463
* 'with-merges-without-common-ancestry' - filter out revisions
464
that are in both ancestries
465
:param direction: either 'reverse' or 'forward':
467
* reverse means return the start_revision_id first, i.e.
468
start at the most recent revision and go backwards in history
469
* forward returns tuples in the opposite order to reverse.
470
Note in particular that forward does *not* do any intelligent
471
ordering w.r.t. depth as some clients of this API may like.
472
(If required, that ought to be done at higher layers.)
474
:return: an iterator over (revision_id, depth, revno, end_of_merge)
477
* revision_id: the unique id of the revision
478
* depth: How many levels of merging deep this node has been
480
* revno_sequence: This field provides a sequence of
481
revision numbers for all revisions. The format is:
482
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
483
branch that the revno is on. From left to right the REVNO numbers
484
are the sequence numbers within that branch of the revision.
485
* end_of_merge: When True the next node (earlier in history) is
486
part of a different merge.
488
# Note: depth and revno values are in the context of the branch so
489
# we need the full graph to get stable numbers, regardless of the
491
if self._merge_sorted_revisions_cache is None:
492
last_revision = self.last_revision()
493
known_graph = self.repository.get_known_graph_ancestry(
495
self._merge_sorted_revisions_cache = known_graph.merge_sort(
497
filtered = self._filter_merge_sorted_revisions(
498
self._merge_sorted_revisions_cache, start_revision_id,
499
stop_revision_id, stop_rule)
500
# Make sure we don't return revisions that are not part of the
501
# start_revision_id ancestry.
502
filtered = self._filter_start_non_ancestors(filtered)
503
if direction == 'reverse':
505
if direction == 'forward':
506
return reversed(list(filtered))
508
raise ValueError('invalid direction %r' % direction)
510
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
511
start_revision_id, stop_revision_id, stop_rule):
512
"""Iterate over an inclusive range of sorted revisions."""
513
rev_iter = iter(merge_sorted_revisions)
514
if start_revision_id is not None:
515
for node in rev_iter:
517
if rev_id != start_revision_id:
520
# The decision to include the start or not
521
# depends on the stop_rule if a stop is provided
522
# so pop this node back into the iterator
523
rev_iter = chain(iter([node]), rev_iter)
525
if stop_revision_id is None:
527
for node in rev_iter:
529
yield (rev_id, node.merge_depth, node.revno,
531
elif stop_rule == 'exclude':
532
for node in rev_iter:
534
if rev_id == stop_revision_id:
536
yield (rev_id, node.merge_depth, node.revno,
538
elif stop_rule == 'include':
539
for node in rev_iter:
541
yield (rev_id, node.merge_depth, node.revno,
543
if rev_id == stop_revision_id:
545
elif stop_rule == 'with-merges-without-common-ancestry':
546
# We want to exclude all revisions that are already part of the
547
# stop_revision_id ancestry.
548
graph = self.repository.get_graph()
549
ancestors = graph.find_unique_ancestors(start_revision_id,
551
for node in rev_iter:
553
if rev_id not in ancestors:
555
yield (rev_id, node.merge_depth, node.revno,
557
elif stop_rule == 'with-merges':
558
stop_rev = self.repository.get_revision(stop_revision_id)
559
if stop_rev.parent_ids:
560
left_parent = stop_rev.parent_ids[0]
562
left_parent = _mod_revision.NULL_REVISION
563
# left_parent is the actual revision we want to stop logging at,
564
# since we want to show the merged revisions after the stop_rev too
565
reached_stop_revision_id = False
566
revision_id_whitelist = []
567
for node in rev_iter:
569
if rev_id == left_parent:
570
# reached the left parent after the stop_revision
572
if (not reached_stop_revision_id or
573
rev_id in revision_id_whitelist):
574
yield (rev_id, node.merge_depth, node.revno,
576
if reached_stop_revision_id or rev_id == stop_revision_id:
577
# only do the merged revs of rev_id from now on
578
rev = self.repository.get_revision(rev_id)
580
reached_stop_revision_id = True
581
revision_id_whitelist.extend(rev.parent_ids)
583
raise ValueError('invalid stop_rule %r' % stop_rule)
585
def _filter_start_non_ancestors(self, rev_iter):
586
# If we started from a dotted revno, we want to consider it as a tip
587
# and don't want to yield revisions that are not part of its
588
# ancestry. Given the order guaranteed by the merge sort, we will see
589
# uninteresting descendants of the first parent of our tip before the
591
first = rev_iter.next()
592
(rev_id, merge_depth, revno, end_of_merge) = first
595
# We start at a mainline revision so by definition, all others
596
# revisions in rev_iter are ancestors
597
for node in rev_iter:
602
pmap = self.repository.get_parent_map([rev_id])
603
parents = pmap.get(rev_id, [])
605
whitelist.update(parents)
607
# If there is no parents, there is nothing of interest left
609
# FIXME: It's hard to test this scenario here as this code is never
610
# called in that case. -- vila 20100322
613
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
615
if rev_id in whitelist:
616
pmap = self.repository.get_parent_map([rev_id])
617
parents = pmap.get(rev_id, [])
618
whitelist.remove(rev_id)
619
whitelist.update(parents)
621
# We've reached the mainline, there is nothing left to
625
# A revision that is not part of the ancestry of our
628
yield (rev_id, merge_depth, revno, end_of_merge)
630
247
def leave_lock_in_place(self):
631
248
"""Tell this branch object not to release the physical lock when this
632
249
object is unlocked.
634
251
If lock_write doesn't return a token, then this method is not supported.
636
253
self.control_files.leave_in_place()
730
357
The delta is relative to its mainline predecessor, or the
731
358
empty tree for revision 1.
360
assert isinstance(revno, int)
733
361
rh = self.revision_history()
734
362
if not (1 <= revno <= len(rh)):
735
raise errors.InvalidRevisionNumber(revno)
363
raise InvalidRevisionNumber(revno)
736
364
return self.repository.get_revision_delta(rh[revno-1])
738
def get_stacked_on_url(self):
739
"""Get the URL this branch is stacked against.
366
@deprecated_method(zero_sixteen)
367
def get_root_id(self):
368
"""Return the id of this branches root
741
:raises NotStacked: If the branch is not stacked.
742
:raises UnstackableBranchFormat: If the branch does not support
370
Deprecated: branches don't have root ids-- trees do.
371
Use basis_tree().get_root_id() instead.
745
raise NotImplementedError(self.get_stacked_on_url)
373
raise NotImplementedError(self.get_root_id)
747
375
def print_file(self, file, revision_id):
748
376
"""Print `file` to stdout."""
749
377
raise NotImplementedError(self.print_file)
751
@deprecated_method(deprecated_in((2, 4, 0)))
379
def append_revision(self, *revision_ids):
380
raise NotImplementedError(self.append_revision)
752
382
def set_revision_history(self, rev_history):
753
"""See Branch.set_revision_history."""
754
self._set_revision_history(rev_history)
757
def _set_revision_history(self, rev_history):
758
if len(rev_history) == 0:
759
revid = _mod_revision.NULL_REVISION
761
revid = rev_history[-1]
762
if rev_history != self._lefthand_history(revid):
763
raise errors.NotLefthandHistory(rev_history)
764
self.set_last_revision_info(len(rev_history), revid)
765
self._cache_revision_history(rev_history)
766
for hook in Branch.hooks['set_rh']:
767
hook(self, rev_history)
770
def set_last_revision_info(self, revno, revision_id):
771
"""Set the last revision of this branch.
773
The caller is responsible for checking that the revno is correct
774
for this revision id.
776
It may be possible to set the branch last revision to an id not
777
present in the repository. However, branches can also be
778
configured to check constraints on history, in which case this may not
781
raise NotImplementedError(self.set_last_revision_info)
784
def generate_revision_history(self, revision_id, last_rev=None,
786
"""See Branch.generate_revision_history"""
787
graph = self.repository.get_graph()
788
known_revision_ids = [
789
self.last_revision_info(),
790
(_mod_revision.NULL_REVISION, 0),
792
if last_rev is not None:
793
if not graph.is_ancestor(last_rev, revision_id):
794
# our previous tip is not merged into stop_revision
795
raise errors.DivergedBranches(self, other_branch)
796
revno = graph.find_distance_to_null(revision_id, known_revision_ids)
797
self.set_last_revision_info(revno, revision_id)
800
def set_parent(self, url):
801
"""See Branch.set_parent."""
802
# TODO: Maybe delete old location files?
803
# URLs should never be unicode, even on the local fs,
804
# FIXUP this and get_parent in a future branch format bump:
805
# read and rewrite the file. RBC 20060125
807
if isinstance(url, unicode):
809
url = url.encode('ascii')
810
except UnicodeEncodeError:
811
raise errors.InvalidURL(url,
812
"Urls must be 7-bit ascii, "
813
"use bzrlib.urlutils.escape")
814
url = urlutils.relative_url(self.base, url)
815
self._set_parent_location(url)
818
def set_stacked_on_url(self, url):
819
"""Set the URL this branch is stacked against.
821
:raises UnstackableBranchFormat: If the branch does not support
823
:raises UnstackableRepositoryFormat: If the repository does not support
826
if not self._format.supports_stacking():
827
raise errors.UnstackableBranchFormat(self._format, self.user_url)
828
# XXX: Changing from one fallback repository to another does not check
829
# that all the data you need is present in the new fallback.
830
# Possibly it should.
831
self._check_stackable_repo()
834
old_url = self.get_stacked_on_url()
835
except (errors.NotStacked, errors.UnstackableBranchFormat,
836
errors.UnstackableRepositoryFormat):
840
self._activate_fallback_location(url)
841
# write this out after the repository is stacked to avoid setting a
842
# stacked config that doesn't work.
843
self._set_config_location('stacked_on_location', url)
846
"""Change a branch to be unstacked, copying data as needed.
848
Don't call this directly, use set_stacked_on_url(None).
850
pb = ui.ui_factory.nested_progress_bar()
852
pb.update("Unstacking")
853
# The basic approach here is to fetch the tip of the branch,
854
# including all available ghosts, from the existing stacked
855
# repository into a new repository object without the fallbacks.
857
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
858
# correct for CHKMap repostiories
859
old_repository = self.repository
860
if len(old_repository._fallback_repositories) != 1:
861
raise AssertionError("can't cope with fallback repositories "
862
"of %r (fallbacks: %r)" % (old_repository,
863
old_repository._fallback_repositories))
864
# Open the new repository object.
865
# Repositories don't offer an interface to remove fallback
866
# repositories today; take the conceptually simpler option and just
867
# reopen it. We reopen it starting from the URL so that we
868
# get a separate connection for RemoteRepositories and can
869
# stream from one of them to the other. This does mean doing
870
# separate SSH connection setup, but unstacking is not a
871
# common operation so it's tolerable.
872
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
873
new_repository = new_bzrdir.find_repository()
874
if new_repository._fallback_repositories:
875
raise AssertionError("didn't expect %r to have "
876
"fallback_repositories"
877
% (self.repository,))
878
# Replace self.repository with the new repository.
879
# Do our best to transfer the lock state (i.e. lock-tokens and
880
# lock count) of self.repository to the new repository.
881
lock_token = old_repository.lock_write().repository_token
882
self.repository = new_repository
883
if isinstance(self, remote.RemoteBranch):
884
# Remote branches can have a second reference to the old
885
# repository that need to be replaced.
886
if self._real_branch is not None:
887
self._real_branch.repository = new_repository
888
self.repository.lock_write(token=lock_token)
889
if lock_token is not None:
890
old_repository.leave_lock_in_place()
891
old_repository.unlock()
892
if lock_token is not None:
893
# XXX: self.repository.leave_lock_in_place() before this
894
# function will not be preserved. Fortunately that doesn't
895
# affect the current default format (2a), and would be a
896
# corner-case anyway.
897
# - Andrew Bennetts, 2010/06/30
898
self.repository.dont_leave_lock_in_place()
902
old_repository.unlock()
903
except errors.LockNotHeld:
906
if old_lock_count == 0:
907
raise AssertionError(
908
'old_repository should have been locked at least once.')
909
for i in range(old_lock_count-1):
910
self.repository.lock_write()
911
# Fetch from the old repository into the new.
912
old_repository.lock_read()
914
# XXX: If you unstack a branch while it has a working tree
915
# with a pending merge, the pending-merged revisions will no
916
# longer be present. You can (probably) revert and remerge.
918
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
919
except errors.TagsNotSupported:
920
tags_to_fetch = set()
921
fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
922
old_repository, required_ids=[self.last_revision()],
923
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
924
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
926
old_repository.unlock()
930
def _set_tags_bytes(self, bytes):
931
"""Mirror method for _get_tags_bytes.
933
:seealso: Branch._get_tags_bytes.
935
op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
936
op.add_cleanup(self.lock_write().unlock)
937
return op.run_simple(bytes)
939
def _set_tags_bytes_locked(self, bytes):
940
self._tags_bytes = bytes
941
return self._transport.put_bytes('tags', bytes)
383
raise NotImplementedError(self.set_revision_history)
943
385
def _cache_revision_history(self, rev_history):
944
386
"""Set the cached revision history to rev_history.
1014
448
That is equivalent to the number of revisions committed to
1017
return self.last_revision_info()[0]
451
return len(self.revision_history())
1019
453
def unbind(self):
1020
454
"""Older format branches cannot bind or unbind."""
1021
raise errors.UpgradeRequired(self.user_url)
455
raise errors.UpgradeRequired(self.base)
457
def set_append_revisions_only(self, enabled):
458
"""Older format branches are never restricted to append-only"""
459
raise errors.UpgradeRequired(self.base)
1023
461
def last_revision(self):
1024
"""Return last revision id, or NULL_REVISION."""
1025
return self.last_revision_info()[1]
462
"""Return last revision id, or None"""
463
ph = self.revision_history()
1028
469
def last_revision_info(self):
1029
470
"""Return information about the last revision.
1031
:return: A tuple (revno, revision_id).
1033
if self._last_revision_info_cache is None:
1034
self._last_revision_info_cache = self._read_last_revision_info()
1035
return self._last_revision_info_cache
1037
def _read_last_revision_info(self):
1038
raise NotImplementedError(self._read_last_revision_info)
1040
@deprecated_method(deprecated_in((2, 4, 0)))
1041
def import_last_revision_info(self, source_repo, revno, revid):
1042
"""Set the last revision info, importing from another repo if necessary.
1044
:param source_repo: Source repository to optionally fetch from
1045
:param revno: Revision number of the new tip
1046
:param revid: Revision id of the new tip
1048
if not self.repository.has_same_location(source_repo):
1049
self.repository.fetch(source_repo, revision_id=revid)
1050
self.set_last_revision_info(revno, revid)
1052
def import_last_revision_info_and_tags(self, source, revno, revid,
1054
"""Set the last revision info, importing from another repo if necessary.
1056
This is used by the bound branch code to upload a revision to
1057
the master branch first before updating the tip of the local branch.
1058
Revisions referenced by source's tags are also transferred.
1060
:param source: Source branch to optionally fetch from
1061
:param revno: Revision number of the new tip
1062
:param revid: Revision id of the new tip
1063
:param lossy: Whether to discard metadata that can not be
1064
natively represented
1065
:return: Tuple with the new revision number and revision id
1066
(should only be different from the arguments when lossy=True)
1068
if not self.repository.has_same_location(source.repository):
1069
self.fetch(source, revid)
1070
self.set_last_revision_info(revno, revid)
1071
return (revno, revid)
472
:return: A tuple (revno, last_revision_id).
474
rh = self.revision_history()
477
return (revno, rh[-1])
479
return (0, _mod_revision.NULL_REVISION)
481
def missing_revisions(self, other, stop_revision=None):
482
"""Return a list of new revisions that would perfectly fit.
484
If self and other have not diverged, return a list of the revisions
485
present in other, but missing from self.
487
self_history = self.revision_history()
488
self_len = len(self_history)
489
other_history = other.revision_history()
490
other_len = len(other_history)
491
common_index = min(self_len, other_len) -1
492
if common_index >= 0 and \
493
self_history[common_index] != other_history[common_index]:
494
raise DivergedBranches(self, other)
496
if stop_revision is None:
497
stop_revision = other_len
499
assert isinstance(stop_revision, int)
500
if stop_revision > other_len:
501
raise errors.NoSuchRevision(self, stop_revision)
502
return other_history[self_len:stop_revision]
504
def update_revisions(self, other, stop_revision=None):
505
"""Pull in new perfect-fit revisions.
507
:param other: Another Branch to pull from
508
:param stop_revision: Updated until the given revision
511
raise NotImplementedError(self.update_revisions)
1073
513
def revision_id_to_revno(self, revision_id):
1074
514
"""Given a revision id, return its revno"""
1075
515
if _mod_revision.is_null(revision_id):
517
revision_id = osutils.safe_revision_id(revision_id)
1077
518
history = self.revision_history()
1079
520
return history.index(revision_id) + 1
1080
521
except ValueError:
1081
522
raise errors.NoSuchRevision(self, revision_id)
1084
524
def get_rev_id(self, revno, history=None):
1085
525
"""Find the revision id of the specified revno."""
1087
return _mod_revision.NULL_REVISION
1088
last_revno, last_revid = self.last_revision_info()
1089
if revno == last_revno:
1091
if revno <= 0 or revno > last_revno:
529
history = self.revision_history()
530
if revno <= 0 or revno > len(history):
1092
531
raise errors.NoSuchRevision(self, revno)
1093
distance_from_last = last_revno - revno
1094
if len(self._partial_revision_history_cache) <= distance_from_last:
1095
self._extend_partial_history(distance_from_last)
1096
return self._partial_revision_history_cache[distance_from_last]
532
return history[revno - 1]
1098
def pull(self, source, overwrite=False, stop_revision=None,
1099
possible_transports=None, *args, **kwargs):
534
def pull(self, source, overwrite=False, stop_revision=None):
1100
535
"""Mirror source into this branch.
1102
537
This branch is considered to be 'local', having low latency.
1104
539
:returns: PullResult instance
1106
return InterBranch.get(source, self).pull(overwrite=overwrite,
1107
stop_revision=stop_revision,
1108
possible_transports=possible_transports, *args, **kwargs)
541
raise NotImplementedError(self.pull)
1110
def push(self, target, overwrite=False, stop_revision=None, lossy=False,
543
def push(self, target, overwrite=False, stop_revision=None):
1112
544
"""Mirror this branch into target.
1114
546
This branch is considered to be 'local', having low latency.
1116
return InterBranch.get(self, target).push(overwrite, stop_revision,
1117
lossy, *args, **kwargs)
548
raise NotImplementedError(self.push)
1119
550
def basis_tree(self):
1120
551
"""Return `Tree` object for last revision."""
1121
552
return self.repository.revision_tree(self.last_revision())
554
def rename_one(self, from_rel, to_rel):
557
This can change the directory or the filename or both.
559
raise NotImplementedError(self.rename_one)
561
def move(self, from_paths, to_name):
564
to_name must exist as a versioned directory.
566
If to_name exists and is a directory, the files are moved into
567
it, keeping their old names. If it is a directory,
569
Note that to_name is only the last component of the new name;
570
this doesn't change the directory.
572
This returns a list of (from_path, to_path) pairs for each
575
raise NotImplementedError(self.move)
1123
577
def get_parent(self):
1124
578
"""Return the parent location of the branch.
1126
This is the default location for pull/missing. The usual
580
This is the default location for push/pull/missing. The usual
1127
581
pattern is that the user can override it by specifying a
1130
parent = self._get_parent_location()
1133
# This is an old-format absolute path to a local branch
1134
# turn it into a url
1135
if parent.startswith('/'):
1136
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1138
return urlutils.join(self.base[:-1], parent)
1139
except errors.InvalidURLJoin, e:
1140
raise errors.InaccessibleParent(parent, self.user_url)
1142
def _get_parent_location(self):
1143
raise NotImplementedError(self._get_parent_location)
584
raise NotImplementedError(self.get_parent)
1145
586
def _set_config_location(self, name, url, config=None,
1146
587
make_relative=False):
1247
665
self.check_real_revno(revno)
1249
667
def check_real_revno(self, revno):
1251
669
Check whether a revno corresponds to a real revision.
1252
670
Zero (the NULL revision) is considered invalid
1254
672
if revno < 1 or revno > self.revno():
1255
raise errors.InvalidRevisionNumber(revno)
673
raise InvalidRevisionNumber(revno)
1257
675
@needs_read_lock
1258
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
676
def clone(self, to_bzrdir, revision_id=None):
1259
677
"""Clone this branch into to_bzrdir preserving all semantic values.
1261
Most API users will want 'create_clone_on_transport', which creates a
1262
new bzrdir and branch on the fly.
1264
679
revision_id: if not None, the revision history in the new branch will
1265
680
be truncated to end with revision_id.
1267
result = to_bzrdir.create_branch()
1270
if repository_policy is not None:
1271
repository_policy.configure_branch(result)
1272
self.copy_content_into(result, revision_id=revision_id)
682
result = self._format.initialize(to_bzrdir)
683
self.copy_content_into(result, revision_id=revision_id)
1277
686
@needs_read_lock
1278
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
687
def sprout(self, to_bzrdir, revision_id=None):
1280
688
"""Create a new line of development from the branch, into to_bzrdir.
1282
to_bzrdir controls the branch format.
1284
690
revision_id: if not None, the revision history in the new branch will
1285
691
be truncated to end with revision_id.
1287
if (repository_policy is not None and
1288
repository_policy.requires_stacking()):
1289
to_bzrdir._format.require_stacking(_skip_repo=True)
1290
result = to_bzrdir.create_branch(repository=repository)
1293
if repository_policy is not None:
1294
repository_policy.configure_branch(result)
1295
self.copy_content_into(result, revision_id=revision_id)
1296
master_branch = self.get_master_branch()
1297
if master_branch is None:
1298
result.set_parent(self.bzrdir.root_transport.base)
1300
result.set_parent(master_branch.bzrdir.root_transport.base)
693
result = self._format.initialize(to_bzrdir)
694
self.copy_content_into(result, revision_id=revision_id)
695
result.set_parent(self.bzrdir.root_transport.base)
1305
698
def _synchronize_history(self, destination, revision_id):
1306
699
"""Synchronize last revision and revision history between branches.
1308
701
This version is most efficient when the destination is also a
1309
BzrBranch6, but works for BzrBranch5, as long as the destination's
1310
repository contains all the lefthand ancestors of the intended
1311
last_revision. If not, set_last_revision_info will fail.
702
BzrBranch5, but works for BzrBranch6 as long as the revision
703
history is the true lefthand parent history, and all of the revisions
704
are in the destination's repository. If not, set_revision_history
1313
707
:param destination: The branch to copy the history into
1314
708
:param revision_id: The revision-id to truncate history at. May
1315
709
be None to copy complete history.
1317
source_revno, source_revision_id = self.last_revision_info()
1318
if revision_id is None:
1319
revno, revision_id = source_revno, source_revision_id
1321
graph = self.repository.get_graph()
711
if revision_id == _mod_revision.NULL_REVISION:
713
new_history = self.revision_history()
714
if revision_id is not None and new_history != []:
715
revision_id = osutils.safe_revision_id(revision_id)
1323
revno = graph.find_distance_to_null(revision_id,
1324
[(source_revision_id, source_revno)])
1325
except errors.GhostRevisionsHaveNoRevno:
1326
# Default to 1, if we can't find anything else
1328
destination.set_last_revision_info(revno, revision_id)
717
new_history = new_history[:new_history.index(revision_id) + 1]
719
rev = self.repository.get_revision(revision_id)
720
new_history = rev.get_history(self.repository)[1:]
721
destination.set_revision_history(new_history)
1330
724
def copy_content_into(self, destination, revision_id=None):
1331
725
"""Copy the content of self into destination.
1333
727
revision_id: if not None, the revision history in the new branch will
1334
728
be truncated to end with revision_id.
1336
return InterBranch.get(self, destination).copy_content_into(
1337
revision_id=revision_id)
1339
def update_references(self, target):
1340
if not getattr(self._format, 'supports_reference_locations', False):
1342
reference_dict = self._get_all_reference_info()
1343
if len(reference_dict) == 0:
1345
old_base = self.base
1346
new_base = target.base
1347
target_reference_dict = target._get_all_reference_info()
1348
for file_id, (tree_path, branch_location) in (
1349
reference_dict.items()):
1350
branch_location = urlutils.rebase_url(branch_location,
1352
target_reference_dict.setdefault(
1353
file_id, (tree_path, branch_location))
1354
target._set_all_reference_info(target_reference_dict)
730
self._synchronize_history(destination, revision_id)
732
parent = self.get_parent()
733
except errors.InaccessibleParent, e:
734
mutter('parent was not accessible to copy: %s', e)
737
destination.set_parent(parent)
738
self.tags.merge_to(destination.tags)
1356
740
@needs_read_lock
1357
def check(self, refs):
1358
742
"""Check consistency of the branch.
1360
744
In particular this checks that revisions given in the revision-history
1361
do actually match up in the revision graph, and that they're all
745
do actually match up in the revision graph, and that they're all
1362
746
present in the repository.
1364
748
Callers will typically also want to check the repository.
1366
:param refs: Calculated refs for this branch as specified by
1367
branch._get_check_refs()
1368
750
:return: A BranchCheckResult.
1370
result = BranchCheckResult(self)
1371
last_revno, last_revision_id = self.last_revision_info()
1372
actual_revno = refs[('lefthand-distance', last_revision_id)]
1373
if actual_revno != last_revno:
1374
result.errors.append(errors.BzrCheckError(
1375
'revno does not match len(mainline) %s != %s' % (
1376
last_revno, actual_revno)))
1377
# TODO: We should probably also check that self.revision_history
1378
# matches the repository for older branch formats.
1379
# If looking for the code that cross-checks repository parents against
1380
# the iter_reverse_revision_history output, that is now a repository
752
mainline_parent_id = None
753
for revision_id in self.revision_history():
755
revision = self.repository.get_revision(revision_id)
756
except errors.NoSuchRevision, e:
757
raise errors.BzrCheckError("mainline revision {%s} not in repository"
759
# In general the first entry on the revision history has no parents.
760
# But it's not illegal for it to have parents listed; this can happen
761
# in imports from Arch when the parents weren't reachable.
762
if mainline_parent_id is not None:
763
if mainline_parent_id not in revision.parent_ids:
764
raise errors.BzrCheckError("previous revision {%s} not listed among "
766
% (mainline_parent_id, revision_id))
767
mainline_parent_id = revision_id
768
return BranchCheckResult(self)
1384
770
def _get_checkout_format(self):
1385
771
"""Return the most suitable metadir for a checkout of this branch.
1386
772
Weaves are used if this branch's repository uses weaves.
1388
format = self.repository.bzrdir.checkout_metadir()
1389
format.set_branch_format(self._format)
774
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
775
from bzrlib.repofmt import weaverepo
776
format = bzrdir.BzrDirMetaFormat1()
777
format.repository_format = weaverepo.RepositoryFormat7()
779
format = self.repository.bzrdir.checkout_metadir()
780
format.set_branch_format(self._format)
1392
def create_clone_on_transport(self, to_transport, revision_id=None,
1393
stacked_on=None, create_prefix=False, use_existing_dir=False,
1395
"""Create a clone of this branch and its bzrdir.
1397
:param to_transport: The transport to clone onto.
1398
:param revision_id: The revision id to use as tip in the new branch.
1399
If None the tip is obtained from this branch.
1400
:param stacked_on: An optional URL to stack the clone on.
1401
:param create_prefix: Create any missing directories leading up to
1403
:param use_existing_dir: Use an existing directory if one exists.
1405
# XXX: Fix the bzrdir API to allow getting the branch back from the
1406
# clone call. Or something. 20090224 RBC/spiv.
1407
# XXX: Should this perhaps clone colocated branches as well,
1408
# rather than just the default branch? 20100319 JRV
1409
if revision_id is None:
1410
revision_id = self.last_revision()
1411
dir_to = self.bzrdir.clone_on_transport(to_transport,
1412
revision_id=revision_id, stacked_on=stacked_on,
1413
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1415
return dir_to.open_branch()
1417
783
def create_checkout(self, to_location, revision_id=None,
1418
lightweight=False, accelerator_tree=None,
1420
785
"""Create a checkout of a branch.
1422
787
:param to_location: The url to produce the checkout at
1423
788
:param revision_id: The revision to check out
1424
789
:param lightweight: If True, produce a lightweight checkout, otherwise,
1425
produce a bound branch (heavyweight checkout)
1426
:param accelerator_tree: A tree which can be used for retrieving file
1427
contents more quickly than the revision tree, i.e. a workingtree.
1428
The revision tree will be used for cases where accelerator_tree's
1429
content is different.
1430
:param hardlink: If true, hard-link files from accelerator_tree,
790
produce a bound branch (heavyweight checkout)
1432
791
:return: The tree of the created checkout
1434
793
t = transport.get_transport(to_location)
1464
818
basis_tree.unlock()
1468
def reconcile(self, thorough=True):
1469
"""Make sure the data stored in this branch is consistent."""
1470
from bzrlib.reconcile import BranchReconciler
1471
reconciler = BranchReconciler(self, thorough=thorough)
1472
reconciler.reconcile()
1475
def reference_parent(self, file_id, path, possible_transports=None):
821
def reference_parent(self, file_id, path):
1476
822
"""Return the parent branch for a tree-reference file_id
1478
823
:param file_id: The file_id of the tree reference
1479
824
:param path: The path of the file_id in the tree
1480
825
:return: A branch associated with the file_id
1482
827
# FIXME should provide multiple branches, based on config
1483
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1484
possible_transports=possible_transports)
828
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1486
830
def supports_tags(self):
1487
831
return self._format.supports_tags()
1489
def automatic_tag_name(self, revision_id):
1490
"""Try to automatically find the tag name for a revision.
1492
:param revision_id: Revision id of the revision.
1493
:return: A tag name or None if no tag name could be determined.
1495
for hook in Branch.hooks['automatic_tag_name']:
1496
ret = hook(self, revision_id)
1501
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1503
"""Ensure that revision_b is a descendant of revision_a.
1505
This is a helper function for update_revisions.
1507
:raises: DivergedBranches if revision_b has diverged from revision_a.
1508
:returns: True if revision_b is a descendant of revision_a.
1510
relation = self._revision_relations(revision_a, revision_b, graph)
1511
if relation == 'b_descends_from_a':
1513
elif relation == 'diverged':
1514
raise errors.DivergedBranches(self, other_branch)
1515
elif relation == 'a_descends_from_b':
1518
raise AssertionError("invalid relation: %r" % (relation,))
1520
def _revision_relations(self, revision_a, revision_b, graph):
1521
"""Determine the relationship between two revisions.
1523
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1525
heads = graph.heads([revision_a, revision_b])
1526
if heads == set([revision_b]):
1527
return 'b_descends_from_a'
1528
elif heads == set([revision_a, revision_b]):
1529
# These branches have diverged
1531
elif heads == set([revision_a]):
1532
return 'a_descends_from_b'
1534
raise AssertionError("invalid heads: %r" % (heads,))
1536
def heads_to_fetch(self):
1537
"""Return the heads that must and that should be fetched to copy this
1538
branch into another repo.
1540
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1541
set of heads that must be fetched. if_present_fetch is a set of
1542
heads that must be fetched if present, but no error is necessary if
1543
they are not present.
1545
# For bzr native formats must_fetch is just the tip, and if_present_fetch
1547
must_fetch = set([self.last_revision()])
1549
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1550
except errors.TagsNotSupported:
1551
if_present_fetch = set()
1552
must_fetch.discard(_mod_revision.NULL_REVISION)
1553
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1554
return must_fetch, if_present_fetch
1557
class BranchFormat(controldir.ControlComponentFormat):
834
class BranchFormat(object):
1558
835
"""An encapsulation of the initialization and open routines for a format.
1560
837
Formats provide three things:
1643
898
"""Return the short format description for this format."""
1644
899
raise NotImplementedError(self.get_format_description)
1646
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1647
hooks = Branch.hooks['post_branch_init']
1650
params = BranchInitHookParams(self, a_bzrdir, name, branch)
901
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
903
"""Initialize a branch in a bzrdir, with specified files
1654
def initialize(self, a_bzrdir, name=None, repository=None):
1655
"""Create a branch of this format in a_bzrdir.
1657
:param name: Name of the colocated branch to create.
905
:param a_bzrdir: The bzrdir to initialize the branch in
906
:param utf8_files: The files to create as a list of
907
(filename, content) tuples
908
:param set_format: If True, set the format with
909
self.get_format_string. (BzrBranch4 has its format set
911
:return: a branch in this format
913
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
914
branch_transport = a_bzrdir.get_branch_transport(self)
916
'metadir': ('lock', lockdir.LockDir),
917
'branch4': ('branch-lock', lockable_files.TransportLock),
919
lock_name, lock_class = lock_map[lock_type]
920
control_files = lockable_files.LockableFiles(branch_transport,
921
lock_name, lock_class)
922
control_files.create_lock()
923
control_files.lock_write()
925
control_files.put_utf8('format', self.get_format_string())
927
for file, content in utf8_files:
928
control_files.put_utf8(file, content)
930
control_files.unlock()
931
return self.open(a_bzrdir, _found=True)
933
def initialize(self, a_bzrdir):
934
"""Create a branch of this format in a_bzrdir."""
1659
935
raise NotImplementedError(self.initialize)
1661
937
def is_supported(self):
1662
938
"""Is this format supported?
1664
940
Supported formats can be initialized and opened.
1665
Unsupported formats may not support initialization or committing or
941
Unsupported formats may not support initialization or committing or
1666
942
some other features depending on the reason for not being supported.
1670
def make_tags(self, branch):
1671
"""Create a tags object for branch.
1673
This method is on BranchFormat, because BranchFormats are reflected
1674
over the wire via network_name(), whereas full Branch instances require
1675
multiple VFS method calls to operate at all.
1677
The default implementation returns a disabled-tags instance.
1679
Note that it is normal for branch to be a RemoteBranch when using tags
1682
return DisabledTags(branch)
1684
def network_name(self):
1685
"""A simple byte string uniquely identifying this format for RPC calls.
1687
MetaDir branch formats use their disk format string to identify the
1688
repository over the wire. All in one formats such as bzr < 0.8, and
1689
foreign formats like svn/git and hg should use some marker which is
1690
unique and immutable.
1692
raise NotImplementedError(self.network_name)
1694
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
1695
found_repository=None):
946
def open(self, a_bzrdir, _found=False):
1696
947
"""Return the branch object for a_bzrdir
1698
:param a_bzrdir: A BzrDir that contains a branch.
1699
:param name: Name of colocated branch to open
1700
:param _found: a private parameter, do not use it. It is used to
1701
indicate if format probing has already be done.
1702
:param ignore_fallbacks: when set, no fallback branches will be opened
1703
(if there are any). Default is to open fallbacks.
949
_found is a private parameter, do not use it. It is used to indicate
950
if format probing has already be done.
1705
952
raise NotImplementedError(self.open)
1708
@deprecated_method(deprecated_in((2, 4, 0)))
1709
955
def register_format(klass, format):
1710
"""Register a metadir format.
1712
See MetaDirBranchFormatFactory for the ability to register a format
1713
without loading the code the format needs until it is actually used.
1715
format_registry.register(format)
956
klass._formats[format.get_format_string()] = format
1718
@deprecated_method(deprecated_in((2, 4, 0)))
1719
959
def set_default_format(klass, format):
1720
format_registry.set_default(format)
1722
def supports_set_append_revisions_only(self):
1723
"""True if this format supports set_append_revisions_only."""
1726
def supports_stacking(self):
1727
"""True if this format records a stacked-on branch."""
1730
def supports_leaving_lock(self):
1731
"""True if this format supports leaving locks in place."""
1732
return False # by default
960
klass._default_format = format
1735
@deprecated_method(deprecated_in((2, 4, 0)))
1736
963
def unregister_format(klass, format):
1737
format_registry.remove(format)
964
assert klass._formats[format.get_format_string()] is format
965
del klass._formats[format.get_format_string()]
1739
967
def __str__(self):
1740
return self.get_format_description().rstrip()
968
return self.get_format_string().rstrip()
1742
970
def supports_tags(self):
1743
971
"""True if this format supports tags stored in the branch"""
1744
972
return False # by default
1747
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1748
"""A factory for a BranchFormat object, permitting simple lazy registration.
1750
While none of the built in BranchFormats are lazy registered yet,
1751
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1752
use it, and the bzr-loom plugin uses it as well (see
1753
bzrlib.plugins.loom.formats).
1756
def __init__(self, format_string, module_name, member_name):
1757
"""Create a MetaDirBranchFormatFactory.
1759
:param format_string: The format string the format has.
1760
:param module_name: Module to load the format class from.
1761
:param member_name: Attribute name within the module for the format class.
1763
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1764
self._format_string = format_string
1766
def get_format_string(self):
1767
"""See BranchFormat.get_format_string."""
1768
return self._format_string
1771
"""Used for network_format_registry support."""
1772
return self.get_obj()()
974
# XXX: Probably doesn't really belong here -- mbp 20070212
975
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
977
branch_transport = a_bzrdir.get_branch_transport(self)
978
control_files = lockable_files.LockableFiles(branch_transport,
979
lock_filename, lock_class)
980
control_files.create_lock()
981
control_files.lock_write()
983
for filename, content in utf8_files:
984
control_files.put_utf8(filename, content)
986
control_files.unlock()
1775
989
class BranchHooks(Hooks):
1776
990
"""A dictionary mapping hook name to a list of callables for branch hooks.
1778
992
e.g. ['set_rh'] Is the list of items to be called when the
1779
993
set_revision_history function is invoked.
1785
999
These are all empty initially, because by default nothing should get
1788
Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1789
self.add_hook('set_rh',
1790
"Invoked whenever the revision history has been set via "
1791
"set_revision_history. The api signature is (branch, "
1792
"revision_history), and the branch will be write-locked. "
1793
"The set_rh hook can be expensive for bzr to trigger, a better "
1794
"hook to use is Branch.post_change_branch_tip.", (0, 15))
1795
self.add_hook('open',
1796
"Called with the Branch object that has been opened after a "
1797
"branch is opened.", (1, 8))
1798
self.add_hook('post_push',
1799
"Called after a push operation completes. post_push is called "
1800
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1801
"bzr client.", (0, 15))
1802
self.add_hook('post_pull',
1803
"Called after a pull operation completes. post_pull is called "
1804
"with a bzrlib.branch.PullResult object and only runs in the "
1805
"bzr client.", (0, 15))
1806
self.add_hook('pre_commit',
1807
"Called after a commit is calculated but before it is "
1808
"completed. pre_commit is called with (local, master, old_revno, "
1809
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1810
"). old_revid is NULL_REVISION for the first commit to a branch, "
1811
"tree_delta is a TreeDelta object describing changes from the "
1812
"basis revision. hooks MUST NOT modify this delta. "
1813
" future_tree is an in-memory tree obtained from "
1814
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1816
self.add_hook('post_commit',
1817
"Called in the bzr client after a commit has completed. "
1818
"post_commit is called with (local, master, old_revno, old_revid, "
1819
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1820
"commit to a branch.", (0, 15))
1821
self.add_hook('post_uncommit',
1822
"Called in the bzr client after an uncommit completes. "
1823
"post_uncommit is called with (local, master, old_revno, "
1824
"old_revid, new_revno, new_revid) where local is the local branch "
1825
"or None, master is the target branch, and an empty branch "
1826
"receives new_revno of 0, new_revid of None.", (0, 15))
1827
self.add_hook('pre_change_branch_tip',
1828
"Called in bzr client and server before a change to the tip of a "
1829
"branch is made. pre_change_branch_tip is called with a "
1830
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1831
"commit, uncommit will all trigger this hook.", (1, 6))
1832
self.add_hook('post_change_branch_tip',
1833
"Called in bzr client and server after a change to the tip of a "
1834
"branch is made. post_change_branch_tip is called with a "
1835
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1836
"commit, uncommit will all trigger this hook.", (1, 4))
1837
self.add_hook('transform_fallback_location',
1838
"Called when a stacked branch is activating its fallback "
1839
"locations. transform_fallback_location is called with (branch, "
1840
"url), and should return a new url. Returning the same url "
1841
"allows it to be used as-is, returning a different one can be "
1842
"used to cause the branch to stack on a closer copy of that "
1843
"fallback_location. Note that the branch cannot have history "
1844
"accessing methods called on it during this hook because the "
1845
"fallback locations have not been activated. When there are "
1846
"multiple hooks installed for transform_fallback_location, "
1847
"all are called with the url returned from the previous hook."
1848
"The order is however undefined.", (1, 9))
1849
self.add_hook('automatic_tag_name',
1850
"Called to determine an automatic tag name for a revision. "
1851
"automatic_tag_name is called with (branch, revision_id) and "
1852
"should return a tag name or None if no tag name could be "
1853
"determined. The first non-None tag name returned will be used.",
1855
self.add_hook('post_branch_init',
1856
"Called after new branch initialization completes. "
1857
"post_branch_init is called with a "
1858
"bzrlib.branch.BranchInitHookParams. "
1859
"Note that init, branch and checkout (both heavyweight and "
1860
"lightweight) will all trigger this hook.", (2, 2))
1861
self.add_hook('post_switch',
1862
"Called after a checkout switches branch. "
1863
"post_switch is called with a "
1864
"bzrlib.branch.SwitchHookParams.", (2, 2))
1002
Hooks.__init__(self)
1003
# Introduced in 0.15:
1004
# invoked whenever the revision history has been set
1005
# with set_revision_history. The api signature is
1006
# (branch, revision_history), and the branch will
1009
# invoked after a push operation completes.
1010
# the api signature is
1012
# containing the members
1013
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1014
# where local is the local target branch or None, master is the target
1015
# master branch, and the rest should be self explanatory. The source
1016
# is read locked and the target branches write locked. Source will
1017
# be the local low-latency branch.
1018
self['post_push'] = []
1019
# invoked after a pull operation completes.
1020
# the api signature is
1022
# containing the members
1023
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1024
# where local is the local branch or None, master is the target
1025
# master branch, and the rest should be self explanatory. The source
1026
# is read locked and the target branches write locked. The local
1027
# branch is the low-latency branch.
1028
self['post_pull'] = []
1029
# invoked after a commit operation completes.
1030
# the api signature is
1031
# (local, master, old_revno, old_revid, new_revno, new_revid)
1032
# old_revid is NULL_REVISION for the first commit to a branch.
1033
self['post_commit'] = []
1034
# invoked after a uncommit operation completes.
1035
# the api signature is
1036
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1037
# local is the local branch or None, master is the target branch,
1038
# and an empty branch recieves new_revno of 0, new_revid of None.
1039
self['post_uncommit'] = []
1868
1042
# install the default hooks into the Branch class.
1869
1043
Branch.hooks = BranchHooks()
1872
class ChangeBranchTipParams(object):
1873
"""Object holding parameters passed to `*_change_branch_tip` hooks.
1875
There are 5 fields that hooks may wish to access:
1877
:ivar branch: the branch being changed
1878
:ivar old_revno: revision number before the change
1879
:ivar new_revno: revision number after the change
1880
:ivar old_revid: revision id before the change
1881
:ivar new_revid: revision id after the change
1883
The revid fields are strings. The revno fields are integers.
1886
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1887
"""Create a group of ChangeBranchTip parameters.
1889
:param branch: The branch being changed.
1890
:param old_revno: Revision number before the change.
1891
:param new_revno: Revision number after the change.
1892
:param old_revid: Tip revision id before the change.
1893
:param new_revid: Tip revision id after the change.
1895
self.branch = branch
1896
self.old_revno = old_revno
1897
self.new_revno = new_revno
1898
self.old_revid = old_revid
1899
self.new_revid = new_revid
1901
def __eq__(self, other):
1902
return self.__dict__ == other.__dict__
1905
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1906
self.__class__.__name__, self.branch,
1907
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1910
class BranchInitHookParams(object):
1911
"""Object holding parameters passed to `*_branch_init` hooks.
1913
There are 4 fields that hooks may wish to access:
1915
:ivar format: the branch format
1916
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1917
:ivar name: name of colocated branch, if any (or None)
1918
:ivar branch: the branch created
1920
Note that for lightweight checkouts, the bzrdir and format fields refer to
1921
the checkout, hence they are different from the corresponding fields in
1922
branch, which refer to the original branch.
1925
def __init__(self, format, a_bzrdir, name, branch):
1926
"""Create a group of BranchInitHook parameters.
1928
:param format: the branch format
1929
:param a_bzrdir: the BzrDir where the branch will be/has been
1931
:param name: name of colocated branch, if any (or None)
1932
:param branch: the branch created
1934
Note that for lightweight checkouts, the bzrdir and format fields refer
1935
to the checkout, hence they are different from the corresponding fields
1936
in branch, which refer to the original branch.
1938
self.format = format
1939
self.bzrdir = a_bzrdir
1941
self.branch = branch
1943
def __eq__(self, other):
1944
return self.__dict__ == other.__dict__
1947
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1950
class SwitchHookParams(object):
1951
"""Object holding parameters passed to `*_switch` hooks.
1953
There are 4 fields that hooks may wish to access:
1955
:ivar control_dir: BzrDir of the checkout to change
1956
:ivar to_branch: branch that the checkout is to reference
1957
:ivar force: skip the check for local commits in a heavy checkout
1958
:ivar revision_id: revision ID to switch to (or None)
1961
def __init__(self, control_dir, to_branch, force, revision_id):
1962
"""Create a group of SwitchHook parameters.
1964
:param control_dir: BzrDir of the checkout to change
1965
:param to_branch: branch that the checkout is to reference
1966
:param force: skip the check for local commits in a heavy checkout
1967
:param revision_id: revision ID to switch to (or None)
1969
self.control_dir = control_dir
1970
self.to_branch = to_branch
1972
self.revision_id = revision_id
1974
def __eq__(self, other):
1975
return self.__dict__ == other.__dict__
1978
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1979
self.control_dir, self.to_branch,
1983
class BranchFormatMetadir(BranchFormat):
1984
"""Common logic for meta-dir based branch formats."""
1986
def _branch_class(self):
1987
"""What class to instantiate on open calls."""
1988
raise NotImplementedError(self._branch_class)
1990
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1992
"""Initialize a branch in a bzrdir, with specified files
1994
:param a_bzrdir: The bzrdir to initialize the branch in
1995
:param utf8_files: The files to create as a list of
1996
(filename, content) tuples
1997
:param name: Name of colocated branch to create, if any
1998
:return: a branch in this format
2000
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2001
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2002
control_files = lockable_files.LockableFiles(branch_transport,
2003
'lock', lockdir.LockDir)
2004
control_files.create_lock()
2005
control_files.lock_write()
2007
utf8_files += [('format', self.get_format_string())]
2008
for (filename, content) in utf8_files:
2009
branch_transport.put_bytes(
2011
mode=a_bzrdir._get_file_mode())
2013
control_files.unlock()
2014
branch = self.open(a_bzrdir, name, _found=True,
2015
found_repository=repository)
2016
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2019
def network_name(self):
2020
"""A simple byte string uniquely identifying this format for RPC calls.
2022
Metadir branch formats use their format string.
2024
return self.get_format_string()
2026
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2027
found_repository=None):
2028
"""See BranchFormat.open()."""
2030
format = BranchFormat.find_format(a_bzrdir, name=name)
2031
if format.__class__ != self.__class__:
2032
raise AssertionError("wrong format %r found for %r" %
2034
transport = a_bzrdir.get_branch_transport(None, name=name)
1046
class BzrBranchFormat4(BranchFormat):
1047
"""Bzr branch format 4.
1050
- a revision-history file.
1051
- a branch-lock lock file [ to be shared with the bzrdir ]
1054
def get_format_description(self):
1055
"""See BranchFormat.get_format_description()."""
1056
return "Branch format 4"
1058
def initialize(self, a_bzrdir):
1059
"""Create a branch of this format in a_bzrdir."""
1060
utf8_files = [('revision-history', ''),
1061
('branch-name', ''),
1063
return self._initialize_helper(a_bzrdir, utf8_files,
1064
lock_type='branch4', set_format=False)
1067
super(BzrBranchFormat4, self).__init__()
1068
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1070
def open(self, a_bzrdir, _found=False):
1071
"""Return the branch object for a_bzrdir
1073
_found is a private parameter, do not use it. It is used to indicate
1074
if format probing has already be done.
1077
# we are being called directly and must probe.
1078
raise NotImplementedError
1079
return BzrBranch(_format=self,
1080
_control_files=a_bzrdir._control_files,
1082
_repository=a_bzrdir.open_repository())
1085
return "Bazaar-NG branch format 4"
1088
class BzrBranchFormat5(BranchFormat):
1089
"""Bzr branch format 5.
1092
- a revision-history file.
1094
- a lock dir guarding the branch itself
1095
- all of this stored in a branch/ subdirectory
1096
- works with shared repositories.
1098
This format is new in bzr 0.8.
1101
def get_format_string(self):
1102
"""See BranchFormat.get_format_string()."""
1103
return "Bazaar-NG branch format 5\n"
1105
def get_format_description(self):
1106
"""See BranchFormat.get_format_description()."""
1107
return "Branch format 5"
1109
def initialize(self, a_bzrdir):
1110
"""Create a branch of this format in a_bzrdir."""
1111
utf8_files = [('revision-history', ''),
1112
('branch-name', ''),
1114
return self._initialize_helper(a_bzrdir, utf8_files)
1117
super(BzrBranchFormat5, self).__init__()
1118
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1120
def open(self, a_bzrdir, _found=False):
1121
"""Return the branch object for a_bzrdir
1123
_found is a private parameter, do not use it. It is used to indicate
1124
if format probing has already be done.
1127
format = BranchFormat.find_format(a_bzrdir)
1128
assert format.__class__ == self.__class__
1130
transport = a_bzrdir.get_branch_transport(None)
2036
1131
control_files = lockable_files.LockableFiles(transport, 'lock',
2037
1132
lockdir.LockDir)
2038
if found_repository is None:
2039
found_repository = a_bzrdir.find_repository()
2040
return self._branch_class()(_format=self,
1133
return BzrBranch5(_format=self,
2041
1134
_control_files=control_files,
2043
1135
a_bzrdir=a_bzrdir,
2044
_repository=found_repository,
2045
ignore_fallbacks=ignore_fallbacks)
2046
except errors.NoSuchFile:
2047
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2050
super(BranchFormatMetadir, self).__init__()
2051
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2052
self._matchingbzrdir.set_branch_format(self)
2054
def supports_tags(self):
2057
def supports_leaving_lock(self):
2061
class BzrBranchFormat5(BranchFormatMetadir):
2062
"""Bzr branch format 5.
2065
- a revision-history file.
2067
- a lock dir guarding the branch itself
2068
- all of this stored in a branch/ subdirectory
2069
- works with shared repositories.
2071
This format is new in bzr 0.8.
2074
def _branch_class(self):
2077
def get_format_string(self):
2078
"""See BranchFormat.get_format_string()."""
2079
return "Bazaar-NG branch format 5\n"
2081
def get_format_description(self):
2082
"""See BranchFormat.get_format_description()."""
2083
return "Branch format 5"
2085
def initialize(self, a_bzrdir, name=None, repository=None):
2086
"""Create a branch of this format in a_bzrdir."""
2087
utf8_files = [('revision-history', ''),
2088
('branch-name', ''),
2090
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2092
def supports_tags(self):
2096
class BzrBranchFormat6(BranchFormatMetadir):
2097
"""Branch format with last-revision and tags.
1136
_repository=a_bzrdir.find_repository())
1138
raise NotBranchError(path=transport.base)
1141
class BzrBranchFormat6(BzrBranchFormat5):
1142
"""Branch format with last-revision
2099
1144
Unlike previous formats, this has no explicit revision history. Instead,
2100
1145
this just stores the last-revision, and the left-hand history leading
2101
1146
up to there is the history.
2103
1148
This format was introduced in bzr 0.15
2104
and became the default in 0.91.
2107
def _branch_class(self):
2110
1151
def get_format_string(self):
2111
1152
"""See BranchFormat.get_format_string()."""
2112
1153
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2115
1156
"""See BranchFormat.get_format_description()."""
2116
1157
return "Branch format 6"
2118
def initialize(self, a_bzrdir, name=None, repository=None):
2119
"""Create a branch of this format in a_bzrdir."""
2120
utf8_files = [('last-revision', '0 null:\n'),
2121
('branch.conf', ''),
2124
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2126
def make_tags(self, branch):
2127
"""See bzrlib.branch.BranchFormat.make_tags()."""
2128
return BasicTags(branch)
2130
def supports_set_append_revisions_only(self):
2134
class BzrBranchFormat8(BranchFormatMetadir):
2135
"""Metadir format supporting storing locations of subtree branches."""
2137
def _branch_class(self):
2140
def get_format_string(self):
2141
"""See BranchFormat.get_format_string()."""
2142
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2144
def get_format_description(self):
2145
"""See BranchFormat.get_format_description()."""
2146
return "Branch format 8"
2148
def initialize(self, a_bzrdir, name=None, repository=None):
2149
"""Create a branch of this format in a_bzrdir."""
2150
utf8_files = [('last-revision', '0 null:\n'),
2151
('branch.conf', ''),
2155
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2157
def make_tags(self, branch):
2158
"""See bzrlib.branch.BranchFormat.make_tags()."""
2159
return BasicTags(branch)
2161
def supports_set_append_revisions_only(self):
2164
def supports_stacking(self):
2167
supports_reference_locations = True
2170
class BzrBranchFormat7(BranchFormatMetadir):
2171
"""Branch format with last-revision, tags, and a stacked location pointer.
2173
The stacked location pointer is passed down to the repository and requires
2174
a repository format with supports_external_lookups = True.
2176
This format was introduced in bzr 1.6.
2179
def initialize(self, a_bzrdir, name=None, repository=None):
2180
"""Create a branch of this format in a_bzrdir."""
2181
utf8_files = [('last-revision', '0 null:\n'),
2182
('branch.conf', ''),
2185
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2187
def _branch_class(self):
2190
def get_format_string(self):
2191
"""See BranchFormat.get_format_string()."""
2192
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2194
def get_format_description(self):
2195
"""See BranchFormat.get_format_description()."""
2196
return "Branch format 7"
2198
def supports_set_append_revisions_only(self):
2201
def supports_stacking(self):
2204
def make_tags(self, branch):
2205
"""See bzrlib.branch.BranchFormat.make_tags()."""
2206
return BasicTags(branch)
2208
supports_reference_locations = False
1159
def initialize(self, a_bzrdir):
1160
"""Create a branch of this format in a_bzrdir."""
1161
utf8_files = [('last-revision', '0 null:\n'),
1162
('branch-name', ''),
1163
('branch.conf', ''),
1166
return self._initialize_helper(a_bzrdir, utf8_files)
1168
def open(self, a_bzrdir, _found=False):
1169
"""Return the branch object for a_bzrdir
1171
_found is a private parameter, do not use it. It is used to indicate
1172
if format probing has already be done.
1175
format = BranchFormat.find_format(a_bzrdir)
1176
assert format.__class__ == self.__class__
1177
transport = a_bzrdir.get_branch_transport(None)
1178
control_files = lockable_files.LockableFiles(transport, 'lock',
1180
return BzrBranch6(_format=self,
1181
_control_files=control_files,
1183
_repository=a_bzrdir.find_repository())
1185
def supports_tags(self):
2211
1189
class BranchReferenceFormat(BranchFormat):
2226
1204
def get_format_description(self):
2227
1205
"""See BranchFormat.get_format_description()."""
2228
1206
return "Checkout reference format 1"
2230
def get_reference(self, a_bzrdir, name=None):
1208
def get_reference(self, a_bzrdir):
2231
1209
"""See BranchFormat.get_reference()."""
2232
transport = a_bzrdir.get_branch_transport(None, name=name)
2233
return transport.get_bytes('location')
2235
def set_reference(self, a_bzrdir, name, to_branch):
2236
"""See BranchFormat.set_reference()."""
2237
transport = a_bzrdir.get_branch_transport(None, name=name)
2238
location = transport.put_bytes('location', to_branch.base)
2240
def initialize(self, a_bzrdir, name=None, target_branch=None,
1210
transport = a_bzrdir.get_branch_transport(None)
1211
return transport.get('location').read()
1213
def initialize(self, a_bzrdir, target_branch=None):
2242
1214
"""Create a branch of this format in a_bzrdir."""
2243
1215
if target_branch is None:
2244
1216
# this format does not implement branch itself, thus the implicit
2245
1217
# creation contract must see it as uninitializable
2246
1218
raise errors.UninitializableFormat(self)
2247
mutter('creating branch reference in %s', a_bzrdir.user_url)
2248
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1219
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1220
branch_transport = a_bzrdir.get_branch_transport(self)
2249
1221
branch_transport.put_bytes('location',
2250
target_branch.bzrdir.user_url)
1222
target_branch.bzrdir.root_transport.base)
2251
1223
branch_transport.put_bytes('format', self.get_format_string())
2253
a_bzrdir, name, _found=True,
2254
possible_transports=[target_branch.bzrdir.root_transport])
2255
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1224
return self.open(a_bzrdir, _found=True)
2258
1226
def __init__(self):
2259
1227
super(BranchReferenceFormat, self).__init__()
2260
1228
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2261
self._matchingbzrdir.set_branch_format(self)
2263
1230
def _make_reference_clone_function(format, a_branch):
2264
1231
"""Create a clone() routine for a branch dynamically."""
2265
def clone(to_bzrdir, revision_id=None,
2266
repository_policy=None):
1232
def clone(to_bzrdir, revision_id=None):
2267
1233
"""See Branch.clone()."""
2268
return format.initialize(to_bzrdir, target_branch=a_branch)
1234
return format.initialize(to_bzrdir, a_branch)
2269
1235
# cannot obey revision_id limits when cloning a reference ...
2270
1236
# FIXME RBC 20060210 either nuke revision_id for clone, or
2271
1237
# emit some sort of warning/error to the caller ?!
2274
def open(self, a_bzrdir, name=None, _found=False, location=None,
2275
possible_transports=None, ignore_fallbacks=False,
2276
found_repository=None):
1240
def open(self, a_bzrdir, _found=False, location=None):
2277
1241
"""Return the branch that the branch reference in a_bzrdir points at.
2279
:param a_bzrdir: A BzrDir that contains a branch.
2280
:param name: Name of colocated branch to open, if any
2281
:param _found: a private parameter, do not use it. It is used to
2282
indicate if format probing has already be done.
2283
:param ignore_fallbacks: when set, no fallback branches will be opened
2284
(if there are any). Default is to open fallbacks.
2285
:param location: The location of the referenced branch. If
2286
unspecified, this will be determined from the branch reference in
2288
:param possible_transports: An optional reusable transports list.
1243
_found is a private parameter, do not use it. It is used to indicate
1244
if format probing has already be done.
2291
format = BranchFormat.find_format(a_bzrdir, name=name)
2292
if format.__class__ != self.__class__:
2293
raise AssertionError("wrong format %r found for %r" %
1247
format = BranchFormat.find_format(a_bzrdir)
1248
assert format.__class__ == self.__class__
2295
1249
if location is None:
2296
location = self.get_reference(a_bzrdir, name)
2297
real_bzrdir = bzrdir.BzrDir.open(
2298
location, possible_transports=possible_transports)
2299
result = real_bzrdir.open_branch(name=name,
2300
ignore_fallbacks=ignore_fallbacks)
1250
location = self.get_reference(a_bzrdir)
1251
real_bzrdir = bzrdir.BzrDir.open(location)
1252
result = real_bzrdir.open_branch()
2301
1253
# this changes the behaviour of result.clone to create a new reference
2302
1254
# rather than a copy of the content of the branch.
2303
1255
# I did not use a proxy object because that needs much more extensive
2313
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2314
"""Branch format registry."""
2316
def __init__(self, other_registry=None):
2317
super(BranchFormatRegistry, self).__init__(other_registry)
2318
self._default_format = None
2320
def set_default(self, format):
2321
self._default_format = format
2323
def get_default(self):
2324
return self._default_format
2327
network_format_registry = registry.FormatRegistry()
2328
"""Registry of formats indexed by their network name.
2330
The network name for a branch format is an identifier that can be used when
2331
referring to formats with smart server operations. See
2332
BranchFormat.network_name() for more detail.
2335
format_registry = BranchFormatRegistry(network_format_registry)
2338
1265
# formats which have no format string are not discoverable
2339
1266
# and not independently creatable, so are not registered.
2340
__format5 = BzrBranchFormat5()
2341
__format6 = BzrBranchFormat6()
2342
__format7 = BzrBranchFormat7()
2343
__format8 = BzrBranchFormat8()
2344
format_registry.register(__format5)
2345
format_registry.register(BranchReferenceFormat())
2346
format_registry.register(__format6)
2347
format_registry.register(__format7)
2348
format_registry.register(__format8)
2349
format_registry.set_default(__format7)
2352
class BranchWriteLockResult(LogicalLockResult):
2353
"""The result of write locking a branch.
2355
:ivar branch_token: The token obtained from the underlying branch lock, or
2357
:ivar unlock: A callable which will unlock the lock.
2360
def __init__(self, unlock, branch_token):
2361
LogicalLockResult.__init__(self, unlock)
2362
self.branch_token = branch_token
2365
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2369
class BzrBranch(Branch, _RelockDebugMixin):
1267
__default_format = BzrBranchFormat5()
1268
BranchFormat.register_format(__default_format)
1269
BranchFormat.register_format(BranchReferenceFormat())
1270
BranchFormat.register_format(BzrBranchFormat6())
1271
BranchFormat.set_default_format(__default_format)
1272
_legacy_formats = [BzrBranchFormat4(),
1275
class BzrBranch(Branch):
2370
1276
"""A branch stored in the actual filesystem.
2372
1278
Note that it's "local" in the context of the filesystem; it doesn't
2373
1279
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2374
1280
it's writable, and can be accessed via the normal filesystem API.
2376
:ivar _transport: Transport for file operations on this branch's
2377
control files, typically pointing to the .bzr/branch directory.
2378
:ivar repository: Repository for this branch.
2379
:ivar base: The url of the base directory for this branch; the one
2380
containing the .bzr directory.
2381
:ivar name: Optional colocated branch name as it exists in the control
2385
1283
def __init__(self, _format=None,
2386
_control_files=None, a_bzrdir=None, name=None,
2387
_repository=None, ignore_fallbacks=False):
1284
_control_files=None, a_bzrdir=None, _repository=None):
2388
1285
"""Create new branch object at a particular location."""
1286
Branch.__init__(self)
2389
1287
if a_bzrdir is None:
2390
1288
raise ValueError('a_bzrdir must be supplied')
2392
1290
self.bzrdir = a_bzrdir
1291
# self._transport used to point to the directory containing the
1292
# control directory, but was not used - now it's just the transport
1293
# for the branch control files. mbp 20070212
2393
1294
self._base = self.bzrdir.transport.clone('..').base
2395
# XXX: We should be able to just do
2396
# self.base = self.bzrdir.root_transport.base
2397
# but this does not quite work yet -- mbp 20080522
2398
1295
self._format = _format
2399
1296
if _control_files is None:
2400
1297
raise ValueError('BzrBranch _control_files is None')
2401
1298
self.control_files = _control_files
2402
1299
self._transport = _control_files._transport
2403
1300
self.repository = _repository
2404
Branch.__init__(self)
2406
1302
def __str__(self):
2407
if self.name is None:
2408
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2410
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
1303
return '%s(%r)' % (self.__class__.__name__, self.base)
2413
1305
__repr__ = __str__
2501
1367
return self.repository.print_file(file, revision_id)
2503
1369
@needs_write_lock
1370
def append_revision(self, *revision_ids):
1371
"""See Branch.append_revision."""
1372
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1373
for revision_id in revision_ids:
1374
_mod_revision.check_not_reserved_id(revision_id)
1375
mutter("add {%s} to revision-history" % revision_id)
1376
rev_history = self.revision_history()
1377
rev_history.extend(revision_ids)
1378
self.set_revision_history(rev_history)
1380
def _write_revision_history(self, history):
1381
"""Factored out of set_revision_history.
1383
This performs the actual writing to disk.
1384
It is intended to be called by BzrBranch5.set_revision_history."""
1385
self.control_files.put_bytes(
1386
'revision-history', '\n'.join(history))
1389
def set_revision_history(self, rev_history):
1390
"""See Branch.set_revision_history."""
1391
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1392
self._clear_cached_state()
1393
self._write_revision_history(rev_history)
1394
self._cache_revision_history(rev_history)
1395
for hook in Branch.hooks['set_rh']:
1396
hook(self, rev_history)
2504
1399
def set_last_revision_info(self, revno, revision_id):
2505
if not revision_id or not isinstance(revision_id, basestring):
2506
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2507
revision_id = _mod_revision.ensure_null(revision_id)
2508
old_revno, old_revid = self.last_revision_info()
2509
if self._get_append_revisions_only():
2510
self._check_history_violation(revision_id)
2511
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2512
self._write_last_revision_info(revno, revision_id)
2513
self._clear_cached_state()
2514
self._last_revision_info_cache = revno, revision_id
2515
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1400
revision_id = osutils.safe_revision_id(revision_id)
1401
history = self._lefthand_history(revision_id)
1402
assert len(history) == revno, '%d != %d' % (len(history), revno)
1403
self.set_revision_history(history)
1405
def _gen_revision_history(self):
1406
history = self.control_files.get('revision-history').read().split('\n')
1407
if history[-1:] == ['']:
1408
# There shouldn't be a trailing newline, but just in case.
1412
def _lefthand_history(self, revision_id, last_rev=None,
1414
# stop_revision must be a descendant of last_revision
1415
stop_graph = self.repository.get_revision_graph(revision_id)
1416
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1417
and last_rev not in stop_graph):
1418
# our previous tip is not merged into stop_revision
1419
raise errors.DivergedBranches(self, other_branch)
1420
# make a new revision history from the graph
1421
current_rev_id = revision_id
1423
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1424
new_history.append(current_rev_id)
1425
current_rev_id_parents = stop_graph[current_rev_id]
1427
current_rev_id = current_rev_id_parents[0]
1429
current_rev_id = None
1430
new_history.reverse()
1434
def generate_revision_history(self, revision_id, last_rev=None,
1436
"""Create a new revision history that will finish with revision_id.
1438
:param revision_id: the new tip to use.
1439
:param last_rev: The previous last_revision. If not None, then this
1440
must be a ancestory of revision_id, or DivergedBranches is raised.
1441
:param other_branch: The other branch that DivergedBranches should
1442
raise with respect to.
1444
revision_id = osutils.safe_revision_id(revision_id)
1445
self.set_revision_history(self._lefthand_history(revision_id,
1446
last_rev, other_branch))
1449
def update_revisions(self, other, stop_revision=None):
1450
"""See Branch.update_revisions."""
1453
if stop_revision is None:
1454
stop_revision = other.last_revision()
1455
if stop_revision is None:
1456
# if there are no commits, we're done.
1459
stop_revision = osutils.safe_revision_id(stop_revision)
1460
# whats the current last revision, before we fetch [and change it
1462
last_rev = _mod_revision.ensure_null(self.last_revision())
1463
# we fetch here regardless of whether we need to so that we pickup
1465
self.fetch(other, stop_revision)
1466
if self.repository.get_graph().is_ancestor(stop_revision,
1469
self.generate_revision_history(stop_revision, last_rev=last_rev,
2517
1474
def basis_tree(self):
2518
1475
"""See Branch.basis_tree."""
2519
1476
return self.repository.revision_tree(self.last_revision())
1478
@deprecated_method(zero_eight)
1479
def working_tree(self):
1480
"""Create a Working tree object for this branch."""
1482
from bzrlib.transport.local import LocalTransport
1483
if (self.base.find('://') != -1 or
1484
not isinstance(self._transport, LocalTransport)):
1485
raise NoWorkingTree(self.base)
1486
return self.bzrdir.open_workingtree()
1489
def pull(self, source, overwrite=False, stop_revision=None,
1490
_hook_master=None, run_hooks=True):
1493
:param _hook_master: Private parameter - set the branch to
1494
be supplied as the master to push hooks.
1495
:param run_hooks: Private parameter - if false, this branch
1496
is being called because it's the master of the primary branch,
1497
so it should not run its hooks.
1499
result = PullResult()
1500
result.source_branch = source
1501
result.target_branch = self
1504
result.old_revno, result.old_revid = self.last_revision_info()
1506
self.update_revisions(source, stop_revision)
1507
except DivergedBranches:
1511
if stop_revision is None:
1512
stop_revision = source.last_revision()
1513
self.generate_revision_history(stop_revision)
1514
result.tag_conflicts = source.tags.merge_to(self.tags)
1515
result.new_revno, result.new_revid = self.last_revision_info()
1517
result.master_branch = _hook_master
1518
result.local_branch = self
1520
result.master_branch = self
1521
result.local_branch = None
1523
for hook in Branch.hooks['post_pull']:
2521
1529
def _get_parent_location(self):
2522
1530
_locs = ['parent', 'pull', 'x-pull']
2523
1531
for l in _locs:
2525
return self._transport.get_bytes(l).strip('\n')
2526
except errors.NoSuchFile:
1533
return self.control_files.get(l).read().strip('\n')
2530
def get_stacked_on_url(self):
2531
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1539
def push(self, target, overwrite=False, stop_revision=None,
1540
_override_hook_source_branch=None):
1543
This is the basic concrete implementation of push()
1545
:param _override_hook_source_branch: If specified, run
1546
the hooks passing this Branch as the source, rather than self.
1547
This is for use of RemoteBranch, where push is delegated to the
1548
underlying vfs-based Branch.
1550
# TODO: Public option to disable running hooks - should be trivial but
1554
result = self._push_with_bound_branches(target, overwrite,
1556
_override_hook_source_branch=_override_hook_source_branch)
1561
def _push_with_bound_branches(self, target, overwrite,
1563
_override_hook_source_branch=None):
1564
"""Push from self into target, and into target's master if any.
1566
This is on the base BzrBranch class even though it doesn't support
1567
bound branches because the *target* might be bound.
1570
if _override_hook_source_branch:
1571
result.source_branch = _override_hook_source_branch
1572
for hook in Branch.hooks['post_push']:
1575
bound_location = target.get_bound_location()
1576
if bound_location and target.base != bound_location:
1577
# there is a master branch.
1579
# XXX: Why the second check? Is it even supported for a branch to
1580
# be bound to itself? -- mbp 20070507
1581
master_branch = target.get_master_branch()
1582
master_branch.lock_write()
1584
# push into the master from this branch.
1585
self._basic_push(master_branch, overwrite, stop_revision)
1586
# and push into the target branch from this. Note that we push from
1587
# this branch again, because its considered the highest bandwidth
1589
result = self._basic_push(target, overwrite, stop_revision)
1590
result.master_branch = master_branch
1591
result.local_branch = target
1595
master_branch.unlock()
1598
result = self._basic_push(target, overwrite, stop_revision)
1599
# TODO: Why set master_branch and local_branch if there's no
1600
# binding? Maybe cleaner to just leave them unset? -- mbp
1602
result.master_branch = target
1603
result.local_branch = None
1607
def _basic_push(self, target, overwrite, stop_revision):
1608
"""Basic implementation of push without bound branches or hooks.
1610
Must be called with self read locked and target write locked.
1612
result = PushResult()
1613
result.source_branch = self
1614
result.target_branch = target
1615
result.old_revno, result.old_revid = target.last_revision_info()
1617
target.update_revisions(self, stop_revision)
1618
except DivergedBranches:
1622
target.set_revision_history(self.revision_history())
1623
result.tag_conflicts = self.tags.merge_to(target.tags)
1624
result.new_revno, result.new_revid = target.last_revision_info()
1627
def get_parent(self):
1628
"""See Branch.get_parent."""
1630
assert self.base[-1] == '/'
1631
parent = self._get_parent_location()
1634
# This is an old-format absolute path to a local branch
1635
# turn it into a url
1636
if parent.startswith('/'):
1637
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1639
return urlutils.join(self.base[:-1], parent)
1640
except errors.InvalidURLJoin, e:
1641
raise errors.InaccessibleParent(parent, self.base)
2533
1643
def set_push_location(self, location):
2534
1644
"""See Branch.set_push_location."""
2536
1646
'push_location', location,
2537
1647
store=_mod_config.STORE_LOCATION_NORECURSE)
1650
def set_parent(self, url):
1651
"""See Branch.set_parent."""
1652
# TODO: Maybe delete old location files?
1653
# URLs should never be unicode, even on the local fs,
1654
# FIXUP this and get_parent in a future branch format bump:
1655
# read and rewrite the file, and have the new format code read
1656
# using .get not .get_utf8. RBC 20060125
1658
if isinstance(url, unicode):
1660
url = url.encode('ascii')
1661
except UnicodeEncodeError:
1662
raise errors.InvalidURL(url,
1663
"Urls must be 7-bit ascii, "
1664
"use bzrlib.urlutils.escape")
1665
url = urlutils.relative_url(self.base, url)
1666
self._set_parent_location(url)
2539
1668
def _set_parent_location(self, url):
2540
1669
if url is None:
2541
self._transport.delete('parent')
2543
self._transport.put_bytes('parent', url + '\n',
2544
mode=self.bzrdir._get_file_mode())
2548
"""If bound, unbind"""
2549
return self.set_bound_location(None)
1670
self.control_files._transport.delete('parent')
1672
assert isinstance(url, str)
1673
self.control_files.put_bytes('parent', url + '\n')
1675
@deprecated_function(zero_nine)
1676
def tree_config(self):
1677
"""DEPRECATED; call get_config instead.
1678
TreeConfig has become part of BranchConfig."""
1679
return TreeConfig(self)
1682
class BzrBranch5(BzrBranch):
1683
"""A format 5 branch. This supports new features over plan branches.
1685
It has support for a master_branch which is the data for bound branches.
1693
super(BzrBranch5, self).__init__(_format=_format,
1694
_control_files=_control_files,
1696
_repository=_repository)
1699
def pull(self, source, overwrite=False, stop_revision=None,
1701
"""Pull from source into self, updating my master if any.
1703
:param run_hooks: Private parameter - if false, this branch
1704
is being called because it's the master of the primary branch,
1705
so it should not run its hooks.
1707
bound_location = self.get_bound_location()
1708
master_branch = None
1709
if bound_location and source.base != bound_location:
1710
# not pulling from master, so we need to update master.
1711
master_branch = self.get_master_branch()
1712
master_branch.lock_write()
1715
# pull from source into master.
1716
master_branch.pull(source, overwrite, stop_revision,
1718
return super(BzrBranch5, self).pull(source, overwrite,
1719
stop_revision, _hook_master=master_branch,
1720
run_hooks=run_hooks)
1723
master_branch.unlock()
1725
def get_bound_location(self):
1727
return self.control_files.get_utf8('bound').read()[:-1]
1728
except errors.NoSuchFile:
1732
def get_master_branch(self):
1733
"""Return the branch we are bound to.
1735
:return: Either a Branch, or None
1737
This could memoise the branch, but if thats done
1738
it must be revalidated on each new lock.
1739
So for now we just don't memoise it.
1740
# RBC 20060304 review this decision.
1742
bound_loc = self.get_bound_location()
1746
return Branch.open(bound_loc)
1747
except (errors.NotBranchError, errors.ConnectionError), e:
1748
raise errors.BoundBranchConnectionFailure(
1752
def set_bound_location(self, location):
1753
"""Set the target where this branch is bound to.
1755
:param location: URL to the target branch
1758
self.control_files.put_utf8('bound', location+'\n')
1761
self.control_files._transport.delete('bound')
2551
1766
@needs_write_lock
2552
1767
def bind(self, other):
2639
def _read_last_revision_info(self):
2640
revision_string = self._transport.get_bytes('last-revision')
1831
class BzrBranchExperimental(BzrBranch5):
1832
"""Bzr experimental branch format
1835
- a revision-history file.
1837
- a lock dir guarding the branch itself
1838
- all of this stored in a branch/ subdirectory
1839
- works with shared repositories.
1840
- a tag dictionary in the branch
1842
This format is new in bzr 0.15, but shouldn't be used for real data,
1845
This class acts as it's own BranchFormat.
1848
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1851
def get_format_string(cls):
1852
"""See BranchFormat.get_format_string()."""
1853
return "Bazaar-NG branch format experimental\n"
1856
def get_format_description(cls):
1857
"""See BranchFormat.get_format_description()."""
1858
return "Experimental branch format"
1861
def get_reference(cls, a_bzrdir):
1862
"""Get the target reference of the branch in a_bzrdir.
1864
format probing must have been completed before calling
1865
this method - it is assumed that the format of the branch
1866
in a_bzrdir is correct.
1868
:param a_bzrdir: The bzrdir to get the branch data from.
1869
:return: None if the branch is not a reference branch.
1874
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1876
branch_transport = a_bzrdir.get_branch_transport(cls)
1877
control_files = lockable_files.LockableFiles(branch_transport,
1878
lock_filename, lock_class)
1879
control_files.create_lock()
1880
control_files.lock_write()
1882
for filename, content in utf8_files:
1883
control_files.put_utf8(filename, content)
1885
control_files.unlock()
1888
def initialize(cls, a_bzrdir):
1889
"""Create a branch of this format in a_bzrdir."""
1890
utf8_files = [('format', cls.get_format_string()),
1891
('revision-history', ''),
1892
('branch-name', ''),
1895
cls._initialize_control_files(a_bzrdir, utf8_files,
1896
'lock', lockdir.LockDir)
1897
return cls.open(a_bzrdir, _found=True)
1900
def open(cls, a_bzrdir, _found=False):
1901
"""Return the branch object for a_bzrdir
1903
_found is a private parameter, do not use it. It is used to indicate
1904
if format probing has already be done.
1907
format = BranchFormat.find_format(a_bzrdir)
1908
assert format.__class__ == cls
1909
transport = a_bzrdir.get_branch_transport(None)
1910
control_files = lockable_files.LockableFiles(transport, 'lock',
1912
return cls(_format=cls,
1913
_control_files=control_files,
1915
_repository=a_bzrdir.find_repository())
1918
def is_supported(cls):
1921
def _make_tags(self):
1922
return BasicTags(self)
1925
def supports_tags(cls):
1929
BranchFormat.register_format(BzrBranchExperimental)
1932
class BzrBranch6(BzrBranch5):
1935
def last_revision_info(self):
1936
revision_string = self.control_files.get('last-revision').read()
2641
1937
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2642
1938
revision_id = cache_utf8.get_cached_utf8(revision_id)
2643
1939
revno = int(revno)
2644
1940
return revno, revision_id
1942
def last_revision(self):
1943
"""Return last revision id, or None"""
1944
revision_id = self.last_revision_info()[1]
1945
if revision_id == _mod_revision.NULL_REVISION:
2646
1949
def _write_last_revision_info(self, revno, revision_id):
2647
1950
"""Simply write out the revision id, with no checks.
2649
1952
Use set_last_revision_info to perform this safely.
2651
1954
Does not update the revision_history cache.
1955
Intended to be called by set_last_revision_info and
1956
_write_revision_history.
2653
revision_id = _mod_revision.ensure_null(revision_id)
1958
if revision_id is None:
1959
revision_id = 'null:'
2654
1960
out_string = '%d %s\n' % (revno, revision_id)
2655
self._transport.put_bytes('last-revision', out_string,
2656
mode=self.bzrdir._get_file_mode())
2659
class FullHistoryBzrBranch(BzrBranch):
2660
"""Bzr branch which contains the full revision history."""
1961
self.control_files.put_bytes('last-revision', out_string)
2662
1963
@needs_write_lock
2663
1964
def set_last_revision_info(self, revno, revision_id):
2664
if not revision_id or not isinstance(revision_id, basestring):
2665
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2666
revision_id = _mod_revision.ensure_null(revision_id)
2667
# this old format stores the full history, but this api doesn't
2668
# provide it, so we must generate, and might as well check it's
2670
history = self._lefthand_history(revision_id)
2671
if len(history) != revno:
2672
raise AssertionError('%d != %d' % (len(history), revno))
2673
self._set_revision_history(history)
2675
def _read_last_revision_info(self):
2676
rh = self.revision_history()
2679
return (revno, rh[-1])
2681
return (0, _mod_revision.NULL_REVISION)
2683
@deprecated_method(deprecated_in((2, 4, 0)))
2685
def set_revision_history(self, rev_history):
2686
"""See Branch.set_revision_history."""
2687
self._set_revision_history(rev_history)
2689
def _set_revision_history(self, rev_history):
2690
if 'evil' in debug.debug_flags:
2691
mutter_callsite(3, "set_revision_history scales with history.")
2692
check_not_reserved_id = _mod_revision.check_not_reserved_id
2693
for rev_id in rev_history:
2694
check_not_reserved_id(rev_id)
2695
if Branch.hooks['post_change_branch_tip']:
2696
# Don't calculate the last_revision_info() if there are no hooks
2698
old_revno, old_revid = self.last_revision_info()
2699
if len(rev_history) == 0:
2700
revid = _mod_revision.NULL_REVISION
2702
revid = rev_history[-1]
2703
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2704
self._write_revision_history(rev_history)
1965
revision_id = osutils.safe_revision_id(revision_id)
1966
if self._get_append_revisions_only():
1967
self._check_history_violation(revision_id)
1968
self._write_last_revision_info(revno, revision_id)
2705
1969
self._clear_cached_state()
2706
self._cache_revision_history(rev_history)
2707
for hook in Branch.hooks['set_rh']:
2708
hook(self, rev_history)
2709
if Branch.hooks['post_change_branch_tip']:
2710
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2712
def _write_revision_history(self, history):
2713
"""Factored out of set_revision_history.
2715
This performs the actual writing to disk.
2716
It is intended to be called by set_revision_history."""
2717
self._transport.put_bytes(
2718
'revision-history', '\n'.join(history),
2719
mode=self.bzrdir._get_file_mode())
2721
def _gen_revision_history(self):
2722
history = self._transport.get_bytes('revision-history').split('\n')
2723
if history[-1:] == ['']:
2724
# There shouldn't be a trailing newline, but just in case.
2728
def _synchronize_history(self, destination, revision_id):
2729
if not isinstance(destination, FullHistoryBzrBranch):
2730
super(BzrBranch, self)._synchronize_history(
2731
destination, revision_id)
2733
if revision_id == _mod_revision.NULL_REVISION:
2736
new_history = self.revision_history()
2737
if revision_id is not None and new_history != []:
2739
new_history = new_history[:new_history.index(revision_id) + 1]
2741
rev = self.repository.get_revision(revision_id)
2742
new_history = rev.get_history(self.repository)[1:]
2743
destination._set_revision_history(new_history)
2746
def generate_revision_history(self, revision_id, last_rev=None,
2748
"""Create a new revision history that will finish with revision_id.
2750
:param revision_id: the new tip to use.
2751
:param last_rev: The previous last_revision. If not None, then this
2752
must be a ancestory of revision_id, or DivergedBranches is raised.
2753
:param other_branch: The other branch that DivergedBranches should
2754
raise with respect to.
2756
self._set_revision_history(self._lefthand_history(revision_id,
2757
last_rev, other_branch))
2760
class BzrBranch5(FullHistoryBzrBranch):
2761
"""A format 5 branch. This supports new features over plain branches.
2763
It has support for a master_branch which is the data for bound branches.
2767
class BzrBranch8(BzrBranch):
2768
"""A branch that stores tree-reference locations."""
2770
def _open_hook(self):
2771
if self._ignore_fallbacks:
2774
url = self.get_stacked_on_url()
2775
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2776
errors.UnstackableBranchFormat):
2779
for hook in Branch.hooks['transform_fallback_location']:
2780
url = hook(self, url)
2782
hook_name = Branch.hooks.get_hook_name(hook)
2783
raise AssertionError(
2784
"'transform_fallback_location' hook %s returned "
2785
"None, not a URL." % hook_name)
2786
self._activate_fallback_location(url)
2788
def __init__(self, *args, **kwargs):
2789
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2790
super(BzrBranch8, self).__init__(*args, **kwargs)
2791
self._last_revision_info_cache = None
2792
self._reference_info = None
2794
def _clear_cached_state(self):
2795
super(BzrBranch8, self)._clear_cached_state()
2796
self._last_revision_info_cache = None
2797
self._reference_info = None
2799
1971
def _check_history_violation(self, revision_id):
2800
current_revid = self.last_revision()
2801
last_revision = _mod_revision.ensure_null(current_revid)
1972
last_revision = _mod_revision.ensure_null(self.last_revision())
2802
1973
if _mod_revision.is_null(last_revision):
2804
graph = self.repository.get_graph()
2805
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2806
if lh_ancestor == current_revid:
2808
raise errors.AppendRevisionsOnlyViolation(self.user_url)
1975
if last_revision not in self._lefthand_history(revision_id):
1976
raise errors.AppendRevisionsOnlyViolation(self.base)
2810
1978
def _gen_revision_history(self):
2811
1979
"""Generate the revision history from last revision
2813
last_revno, last_revision = self.last_revision_info()
2814
self._extend_partial_history(stop_index=last_revno-1)
2815
return list(reversed(self._partial_revision_history_cache))
1981
history = list(self.repository.iter_reverse_revision_history(
1982
self.last_revision()))
1986
def _write_revision_history(self, history):
1987
"""Factored out of set_revision_history.
1989
This performs the actual writing to disk, with format-specific checks.
1990
It is intended to be called by BzrBranch5.set_revision_history.
1992
if len(history) == 0:
1993
last_revision = 'null:'
1995
if history != self._lefthand_history(history[-1]):
1996
raise errors.NotLefthandHistory(history)
1997
last_revision = history[-1]
1998
if self._get_append_revisions_only():
1999
self._check_history_violation(last_revision)
2000
self._write_last_revision_info(len(history), last_revision)
2003
def append_revision(self, *revision_ids):
2004
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
2005
if len(revision_ids) == 0:
2007
prev_revno, prev_revision = self.last_revision_info()
2008
for revision in self.repository.get_revisions(revision_ids):
2009
if prev_revision == _mod_revision.NULL_REVISION:
2010
if revision.parent_ids != []:
2011
raise errors.NotLeftParentDescendant(self, prev_revision,
2012
revision.revision_id)
2014
if revision.parent_ids[0] != prev_revision:
2015
raise errors.NotLeftParentDescendant(self, prev_revision,
2016
revision.revision_id)
2017
prev_revision = revision.revision_id
2018
self.set_last_revision_info(prev_revno + len(revision_ids),
2817
2021
@needs_write_lock
2818
2022
def _set_parent_location(self, url):
2938
2066
"""See Branch.get_old_bound_location"""
2939
2067
return self._get_bound_location(False)
2941
def get_stacked_on_url(self):
2942
# you can always ask for the URL; but you might not be able to use it
2943
# if the repo can't support stacking.
2944
## self._check_stackable_repo()
2945
# stacked_on_location is only ever defined in branch.conf, so don't
2946
# waste effort reading the whole stack of config files.
2947
config = self.get_config()._get_branch_data_config()
2948
stacked_url = self._get_config_location('stacked_on_location',
2950
if stacked_url is None:
2951
raise errors.NotStacked(self)
2069
def set_append_revisions_only(self, enabled):
2074
self.get_config().set_user_option('append_revisions_only', value,
2954
2077
def _get_append_revisions_only(self):
2955
return self.get_config(
2956
).get_user_option_as_bool('append_revisions_only')
2959
def get_rev_id(self, revno, history=None):
2960
"""Find the revision id of the specified revno."""
2962
return _mod_revision.NULL_REVISION
2964
last_revno, last_revision_id = self.last_revision_info()
2965
if revno <= 0 or revno > last_revno:
2966
raise errors.NoSuchRevision(self, revno)
2968
if history is not None:
2969
return history[revno - 1]
2971
index = last_revno - revno
2972
if len(self._partial_revision_history_cache) <= index:
2973
self._extend_partial_history(stop_index=index)
2974
if len(self._partial_revision_history_cache) > index:
2975
return self._partial_revision_history_cache[index]
2078
value = self.get_config().get_user_option('append_revisions_only')
2079
return value == 'True'
2081
def _synchronize_history(self, destination, revision_id):
2082
"""Synchronize last revision and revision history between branches.
2084
This version is most efficient when the destination is also a
2085
BzrBranch6, but works for BzrBranch5, as long as the destination's
2086
repository contains all the lefthand ancestors of the intended
2087
last_revision. If not, set_last_revision_info will fail.
2089
:param destination: The branch to copy the history into
2090
:param revision_id: The revision-id to truncate history at. May
2091
be None to copy complete history.
2093
if revision_id is None:
2094
revno, revision_id = self.last_revision_info()
2977
raise errors.NoSuchRevision(self, revno)
2980
def revision_id_to_revno(self, revision_id):
2981
"""Given a revision id, return its revno"""
2982
if _mod_revision.is_null(revision_id):
2985
index = self._partial_revision_history_cache.index(revision_id)
2988
self._extend_partial_history(stop_revision=revision_id)
2989
except errors.RevisionNotPresent, e:
2990
raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2991
index = len(self._partial_revision_history_cache) - 1
2992
if self._partial_revision_history_cache[index] != revision_id:
2993
raise errors.NoSuchRevision(self, revision_id)
2994
return self.revno() - index
2997
class BzrBranch7(BzrBranch8):
2998
"""A branch with support for a fallback repository."""
3000
def set_reference_info(self, file_id, tree_path, branch_location):
3001
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3003
def get_reference_info(self, file_id):
3004
Branch.get_reference_info(self, file_id)
3006
def reference_parent(self, file_id, path, possible_transports=None):
3007
return Branch.reference_parent(self, file_id, path,
3008
possible_transports)
3011
class BzrBranch6(BzrBranch7):
3012
"""See BzrBranchFormat6 for the capabilities of this branch.
3014
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
3018
def get_stacked_on_url(self):
3019
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2096
# To figure out the revno for a random revision, we need to build
2097
# the revision history, and count its length.
2098
# We don't care about the order, just how long it is.
2099
# Alternatively, we could start at the current location, and count
2100
# backwards. But there is no guarantee that we will find it since
2101
# it may be a merged revision.
2102
revno = len(list(self.repository.iter_reverse_revision_history(
2104
destination.set_last_revision_info(revno, revision_id)
2106
def _make_tags(self):
2107
return BasicTags(self)
3022
2110
######################################################################
3141
2208
new_branch.tags._set_tag_dict({})
3143
2210
# Copying done; now update target format
3144
new_branch._transport.put_bytes('format',
3145
format.get_format_string(),
3146
mode=new_branch.bzrdir._get_file_mode())
2211
new_branch.control_files.put_utf8('format',
2212
format.get_format_string())
3148
2214
# Clean up old files
3149
new_branch._transport.delete('revision-history')
2215
new_branch.control_files._transport.delete('revision-history')
3151
2217
branch.set_parent(None)
3152
except errors.NoSuchFile:
3154
2220
branch.set_bound_location(None)
3157
class Converter6to7(object):
3158
"""Perform an in-place upgrade of format 6 to format 7"""
3160
def convert(self, branch):
3161
format = BzrBranchFormat7()
3162
branch._set_config_location('stacked_on_location', '')
3163
# update target format
3164
branch._transport.put_bytes('format', format.get_format_string())
3167
class Converter7to8(object):
3168
"""Perform an in-place upgrade of format 6 to format 7"""
3170
def convert(self, branch):
3171
format = BzrBranchFormat8()
3172
branch._transport.put_bytes('references', '')
3173
# update target format
3174
branch._transport.put_bytes('format', format.get_format_string())
3177
class InterBranch(InterObject):
3178
"""This class represents operations taking place between two branches.
3180
Its instances have methods like pull() and push() and contain
3181
references to the source and target repositories these operations
3182
can be carried out on.
3186
"""The available optimised InterBranch types."""
3189
def _get_branch_formats_to_test(klass):
3190
"""Return an iterable of format tuples for testing.
3192
:return: An iterable of (from_format, to_format) to use when testing
3193
this InterBranch class. Each InterBranch class should define this
3196
raise NotImplementedError(klass._get_branch_formats_to_test)
3199
def pull(self, overwrite=False, stop_revision=None,
3200
possible_transports=None, local=False):
3201
"""Mirror source into target branch.
3203
The target branch is considered to be 'local', having low latency.
3205
:returns: PullResult instance
3207
raise NotImplementedError(self.pull)
3210
def push(self, overwrite=False, stop_revision=None, lossy=False,
3211
_override_hook_source_branch=None):
3212
"""Mirror the source branch into the target branch.
3214
The source branch is considered to be 'local', having low latency.
3216
raise NotImplementedError(self.push)
3219
def copy_content_into(self, revision_id=None):
3220
"""Copy the content of source into target
3222
revision_id: if not None, the revision history in the new branch will
3223
be truncated to end with revision_id.
3225
raise NotImplementedError(self.copy_content_into)
3228
def fetch(self, stop_revision=None, limit=None):
3231
:param stop_revision: Last revision to fetch
3232
:param limit: Optional rough limit of revisions to fetch
3234
raise NotImplementedError(self.fetch)
3237
class GenericInterBranch(InterBranch):
3238
"""InterBranch implementation that uses public Branch functions."""
3241
def is_compatible(klass, source, target):
3242
# GenericBranch uses the public API, so always compatible
3246
def _get_branch_formats_to_test(klass):
3247
return [(format_registry.get_default(), format_registry.get_default())]
3250
def unwrap_format(klass, format):
3251
if isinstance(format, remote.RemoteBranchFormat):
3252
format._ensure_real()
3253
return format._custom_format
3257
def copy_content_into(self, revision_id=None):
3258
"""Copy the content of source into target
3260
revision_id: if not None, the revision history in the new branch will
3261
be truncated to end with revision_id.
3263
self.source.update_references(self.target)
3264
self.source._synchronize_history(self.target, revision_id)
3266
parent = self.source.get_parent()
3267
except errors.InaccessibleParent, e:
3268
mutter('parent was not accessible to copy: %s', e)
3271
self.target.set_parent(parent)
3272
if self.source._push_should_merge_tags():
3273
self.source.tags.merge_to(self.target.tags)
3276
def fetch(self, stop_revision=None, limit=None):
3277
if self.target.base == self.source.base:
3279
self.source.lock_read()
3281
fetch_spec_factory = fetch.FetchSpecFactory()
3282
fetch_spec_factory.source_branch = self.source
3283
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3284
fetch_spec_factory.source_repo = self.source.repository
3285
fetch_spec_factory.target_repo = self.target.repository
3286
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3287
fetch_spec_factory.limit = limit
3288
fetch_spec = fetch_spec_factory.make_fetch_spec()
3289
return self.target.repository.fetch(self.source.repository,
3290
fetch_spec=fetch_spec)
3292
self.source.unlock()
3295
def _update_revisions(self, stop_revision=None, overwrite=False,
3297
other_revno, other_last_revision = self.source.last_revision_info()
3298
stop_revno = None # unknown
3299
if stop_revision is None:
3300
stop_revision = other_last_revision
3301
if _mod_revision.is_null(stop_revision):
3302
# if there are no commits, we're done.
3304
stop_revno = other_revno
3306
# what's the current last revision, before we fetch [and change it
3308
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3309
# we fetch here so that we don't process data twice in the common
3310
# case of having something to pull, and so that the check for
3311
# already merged can operate on the just fetched graph, which will
3312
# be cached in memory.
3313
self.fetch(stop_revision=stop_revision)
3314
# Check to see if one is an ancestor of the other
3317
graph = self.target.repository.get_graph()
3318
if self.target._check_if_descendant_or_diverged(
3319
stop_revision, last_rev, graph, self.source):
3320
# stop_revision is a descendant of last_rev, but we aren't
3321
# overwriting, so we're done.
3323
if stop_revno is None:
3325
graph = self.target.repository.get_graph()
3326
this_revno, this_last_revision = \
3327
self.target.last_revision_info()
3328
stop_revno = graph.find_distance_to_null(stop_revision,
3329
[(other_last_revision, other_revno),
3330
(this_last_revision, this_revno)])
3331
self.target.set_last_revision_info(stop_revno, stop_revision)
3334
def pull(self, overwrite=False, stop_revision=None,
3335
possible_transports=None, run_hooks=True,
3336
_override_hook_target=None, local=False):
3337
"""Pull from source into self, updating my master if any.
3339
:param run_hooks: Private parameter - if false, this branch
3340
is being called because it's the master of the primary branch,
3341
so it should not run its hooks.
3343
bound_location = self.target.get_bound_location()
3344
if local and not bound_location:
3345
raise errors.LocalRequiresBoundBranch()
3346
master_branch = None
3347
source_is_master = (self.source.user_url == bound_location)
3348
if not local and bound_location and not source_is_master:
3349
# not pulling from master, so we need to update master.
3350
master_branch = self.target.get_master_branch(possible_transports)
3351
master_branch.lock_write()
3354
# pull from source into master.
3355
master_branch.pull(self.source, overwrite, stop_revision,
3357
return self._pull(overwrite,
3358
stop_revision, _hook_master=master_branch,
3359
run_hooks=run_hooks,
3360
_override_hook_target=_override_hook_target,
3361
merge_tags_to_master=not source_is_master)
3364
master_branch.unlock()
3366
def push(self, overwrite=False, stop_revision=None, lossy=False,
3367
_override_hook_source_branch=None):
3368
"""See InterBranch.push.
3370
This is the basic concrete implementation of push()
3372
:param _override_hook_source_branch: If specified, run the hooks
3373
passing this Branch as the source, rather than self. This is for
3374
use of RemoteBranch, where push is delegated to the underlying
3378
raise errors.LossyPushToSameVCS(self.source, self.target)
3379
# TODO: Public option to disable running hooks - should be trivial but
3382
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3383
op.add_cleanup(self.source.lock_read().unlock)
3384
op.add_cleanup(self.target.lock_write().unlock)
3385
return op.run(overwrite, stop_revision,
3386
_override_hook_source_branch=_override_hook_source_branch)
3388
def _basic_push(self, overwrite, stop_revision):
3389
"""Basic implementation of push without bound branches or hooks.
3391
Must be called with source read locked and target write locked.
3393
result = BranchPushResult()
3394
result.source_branch = self.source
3395
result.target_branch = self.target
3396
result.old_revno, result.old_revid = self.target.last_revision_info()
3397
self.source.update_references(self.target)
3398
if result.old_revid != stop_revision:
3399
# We assume that during 'push' this repository is closer than
3401
graph = self.source.repository.get_graph(self.target.repository)
3402
self._update_revisions(stop_revision, overwrite=overwrite,
3404
if self.source._push_should_merge_tags():
3405
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3407
result.new_revno, result.new_revid = self.target.last_revision_info()
3410
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3411
_override_hook_source_branch=None):
3412
"""Push from source into target, and into target's master if any.
3415
if _override_hook_source_branch:
3416
result.source_branch = _override_hook_source_branch
3417
for hook in Branch.hooks['post_push']:
3420
bound_location = self.target.get_bound_location()
3421
if bound_location and self.target.base != bound_location:
3422
# there is a master branch.
3424
# XXX: Why the second check? Is it even supported for a branch to
3425
# be bound to itself? -- mbp 20070507
3426
master_branch = self.target.get_master_branch()
3427
master_branch.lock_write()
3428
operation.add_cleanup(master_branch.unlock)
3429
# push into the master from the source branch.
3430
master_inter = InterBranch.get(self.source, master_branch)
3431
master_inter._basic_push(overwrite, stop_revision)
3432
# and push into the target branch from the source. Note that
3433
# we push from the source branch again, because it's considered
3434
# the highest bandwidth repository.
3435
result = self._basic_push(overwrite, stop_revision)
3436
result.master_branch = master_branch
3437
result.local_branch = self.target
3439
master_branch = None
3441
result = self._basic_push(overwrite, stop_revision)
3442
# TODO: Why set master_branch and local_branch if there's no
3443
# binding? Maybe cleaner to just leave them unset? -- mbp
3445
result.master_branch = self.target
3446
result.local_branch = None
3450
def _pull(self, overwrite=False, stop_revision=None,
3451
possible_transports=None, _hook_master=None, run_hooks=True,
3452
_override_hook_target=None, local=False,
3453
merge_tags_to_master=True):
3456
This function is the core worker, used by GenericInterBranch.pull to
3457
avoid duplication when pulling source->master and source->local.
3459
:param _hook_master: Private parameter - set the branch to
3460
be supplied as the master to pull hooks.
3461
:param run_hooks: Private parameter - if false, this branch
3462
is being called because it's the master of the primary branch,
3463
so it should not run its hooks.
3464
is being called because it's the master of the primary branch,
3465
so it should not run its hooks.
3466
:param _override_hook_target: Private parameter - set the branch to be
3467
supplied as the target_branch to pull hooks.
3468
:param local: Only update the local branch, and not the bound branch.
3470
# This type of branch can't be bound.
3472
raise errors.LocalRequiresBoundBranch()
3473
result = PullResult()
3474
result.source_branch = self.source
3475
if _override_hook_target is None:
3476
result.target_branch = self.target
3478
result.target_branch = _override_hook_target
3479
self.source.lock_read()
3481
# We assume that during 'pull' the target repository is closer than
3483
self.source.update_references(self.target)
3484
graph = self.target.repository.get_graph(self.source.repository)
3485
# TODO: Branch formats should have a flag that indicates
3486
# that revno's are expensive, and pull() should honor that flag.
3488
result.old_revno, result.old_revid = \
3489
self.target.last_revision_info()
3490
self._update_revisions(stop_revision, overwrite=overwrite,
3492
# TODO: The old revid should be specified when merging tags,
3493
# so a tags implementation that versions tags can only
3494
# pull in the most recent changes. -- JRV20090506
3495
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3496
overwrite, ignore_master=not merge_tags_to_master)
3497
result.new_revno, result.new_revid = self.target.last_revision_info()
3499
result.master_branch = _hook_master
3500
result.local_branch = result.target_branch
3502
result.master_branch = result.target_branch
3503
result.local_branch = None
3505
for hook in Branch.hooks['post_pull']:
3508
self.source.unlock()
3512
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
