437
211
:return: A dictionary mapping revision_id => dotted revno.
213
last_revision = self.last_revision()
214
revision_graph = self.repository.get_revision_graph(last_revision)
215
merge_sorted_revisions = tsort.merge_sort(
439
220
revision_id_to_revno = dict((rev_id, revno)
440
for rev_id, depth, revno, end_of_merge
441
in self.iter_merge_sorted_revisions())
221
for seq_num, rev_id, depth, revno, end_of_merge
222
in merge_sorted_revisions)
442
223
return revision_id_to_revno
445
def iter_merge_sorted_revisions(self, start_revision_id=None,
446
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
447
"""Walk the revisions for a branch in merge sorted order.
449
Merge sorted order is the output from a merge-aware,
450
topological sort, i.e. all parents come before their
451
children going forward; the opposite for reverse.
453
:param start_revision_id: the revision_id to begin walking from.
454
If None, the branch tip is used.
455
:param stop_revision_id: the revision_id to terminate the walk
456
after. If None, the rest of history is included.
457
:param stop_rule: if stop_revision_id is not None, the precise rule
458
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':
466
* reverse means return the start_revision_id first, i.e.
467
start at the most recent revision and go backwards in history
468
* forward returns tuples in the opposite order to reverse.
469
Note in particular that forward does *not* do any intelligent
470
ordering w.r.t. depth as some clients of this API may like.
471
(If required, that ought to be done at higher layers.)
473
:return: an iterator over (revision_id, depth, revno, end_of_merge)
476
* revision_id: the unique id of the revision
477
* depth: How many levels of merging deep this node has been
479
* revno_sequence: This field provides a sequence of
480
revision numbers for all revisions. The format is:
481
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
482
branch that the revno is on. From left to right the REVNO numbers
483
are the sequence numbers within that branch of the revision.
484
* end_of_merge: When True the next node (earlier in history) is
485
part of a different merge.
487
# Note: depth and revno values are in the context of the branch so
488
# we need the full graph to get stable numbers, regardless of the
490
if self._merge_sorted_revisions_cache is None:
491
last_revision = self.last_revision()
492
known_graph = self.repository.get_known_graph_ancestry(
494
self._merge_sorted_revisions_cache = known_graph.merge_sort(
496
filtered = self._filter_merge_sorted_revisions(
497
self._merge_sorted_revisions_cache, start_revision_id,
498
stop_revision_id, stop_rule)
499
# Make sure we don't return revisions that are not part of the
500
# start_revision_id ancestry.
501
filtered = self._filter_start_non_ancestors(filtered)
502
if direction == 'reverse':
504
if direction == 'forward':
505
return reversed(list(filtered))
507
raise ValueError('invalid direction %r' % direction)
509
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
510
start_revision_id, stop_revision_id, stop_rule):
511
"""Iterate over an inclusive range of sorted revisions."""
512
rev_iter = iter(merge_sorted_revisions)
513
if start_revision_id is not None:
514
for node in rev_iter:
515
rev_id = node.key[-1]
516
if rev_id != start_revision_id:
519
# The decision to include the start or not
520
# depends on the stop_rule if a stop is provided
521
# so pop this node back into the iterator
522
rev_iter = chain(iter([node]), rev_iter)
524
if stop_revision_id is None:
526
for node in rev_iter:
527
rev_id = node.key[-1]
528
yield (rev_id, node.merge_depth, node.revno,
530
elif stop_rule == 'exclude':
531
for node in rev_iter:
532
rev_id = node.key[-1]
533
if rev_id == stop_revision_id:
535
yield (rev_id, node.merge_depth, node.revno,
537
elif stop_rule == 'include':
538
for node in rev_iter:
539
rev_id = node.key[-1]
540
yield (rev_id, node.merge_depth, node.revno,
542
if rev_id == stop_revision_id:
544
elif stop_rule == 'with-merges-without-common-ancestry':
545
# We want to exclude all revisions that are already part of the
546
# stop_revision_id ancestry.
547
graph = self.repository.get_graph()
548
ancestors = graph.find_unique_ancestors(start_revision_id,
550
for node in rev_iter:
551
rev_id = node.key[-1]
552
if rev_id not in ancestors:
554
yield (rev_id, node.merge_depth, node.revno,
556
elif stop_rule == 'with-merges':
557
stop_rev = self.repository.get_revision(stop_revision_id)
558
if stop_rev.parent_ids:
559
left_parent = stop_rev.parent_ids[0]
561
left_parent = _mod_revision.NULL_REVISION
562
# left_parent is the actual revision we want to stop logging at,
563
# since we want to show the merged revisions after the stop_rev too
564
reached_stop_revision_id = False
565
revision_id_whitelist = []
566
for node in rev_iter:
567
rev_id = node.key[-1]
568
if rev_id == left_parent:
569
# reached the left parent after the stop_revision
571
if (not reached_stop_revision_id or
572
rev_id in revision_id_whitelist):
573
yield (rev_id, node.merge_depth, node.revno,
575
if reached_stop_revision_id or rev_id == stop_revision_id:
576
# only do the merged revs of rev_id from now on
577
rev = self.repository.get_revision(rev_id)
579
reached_stop_revision_id = True
580
revision_id_whitelist.extend(rev.parent_ids)
582
raise ValueError('invalid stop_rule %r' % stop_rule)
584
def _filter_start_non_ancestors(self, rev_iter):
585
# If we started from a dotted revno, we want to consider it as a tip
586
# and don't want to yield revisions that are not part of its
587
# ancestry. Given the order guaranteed by the merge sort, we will see
588
# uninteresting descendants of the first parent of our tip before the
590
first = rev_iter.next()
591
(rev_id, merge_depth, revno, end_of_merge) = first
594
# We start at a mainline revision so by definition, all others
595
# revisions in rev_iter are ancestors
596
for node in rev_iter:
601
pmap = self.repository.get_parent_map([rev_id])
602
parents = pmap.get(rev_id, [])
604
whitelist.update(parents)
606
# If there is no parents, there is nothing of interest left
608
# FIXME: It's hard to test this scenario here as this code is never
609
# called in that case. -- vila 20100322
612
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
614
if rev_id in whitelist:
615
pmap = self.repository.get_parent_map([rev_id])
616
parents = pmap.get(rev_id, [])
617
whitelist.remove(rev_id)
618
whitelist.update(parents)
620
# We've reached the mainline, there is nothing left to
624
# A revision that is not part of the ancestry of our
627
yield (rev_id, merge_depth, revno, end_of_merge)
629
225
def leave_lock_in_place(self):
630
226
"""Tell this branch object not to release the physical lock when this
631
227
object is unlocked.
633
229
If lock_write doesn't return a token, then this method is not supported.
635
231
self.control_files.leave_in_place()
749
357
def set_revision_history(self, rev_history):
750
358
raise NotImplementedError(self.set_revision_history)
753
def set_parent(self, url):
754
"""See Branch.set_parent."""
755
# TODO: Maybe delete old location files?
756
# URLs should never be unicode, even on the local fs,
757
# FIXUP this and get_parent in a future branch format bump:
758
# read and rewrite the file. RBC 20060125
760
if isinstance(url, unicode):
762
url = url.encode('ascii')
763
except UnicodeEncodeError:
764
raise errors.InvalidURL(url,
765
"Urls must be 7-bit ascii, "
766
"use bzrlib.urlutils.escape")
767
url = urlutils.relative_url(self.base, url)
768
self._set_parent_location(url)
771
def set_stacked_on_url(self, url):
772
"""Set the URL this branch is stacked against.
774
:raises UnstackableBranchFormat: If the branch does not support
776
:raises UnstackableRepositoryFormat: If the repository does not support
779
if not self._format.supports_stacking():
780
raise errors.UnstackableBranchFormat(self._format, self.user_url)
781
# XXX: Changing from one fallback repository to another does not check
782
# that all the data you need is present in the new fallback.
783
# Possibly it should.
784
self._check_stackable_repo()
787
old_url = self.get_stacked_on_url()
788
except (errors.NotStacked, errors.UnstackableBranchFormat,
789
errors.UnstackableRepositoryFormat):
793
self._activate_fallback_location(url)
794
# write this out after the repository is stacked to avoid setting a
795
# stacked config that doesn't work.
796
self._set_config_location('stacked_on_location', url)
799
"""Change a branch to be unstacked, copying data as needed.
801
Don't call this directly, use set_stacked_on_url(None).
803
pb = ui.ui_factory.nested_progress_bar()
805
pb.update("Unstacking")
806
# The basic approach here is to fetch the tip of the branch,
807
# including all available ghosts, from the existing stacked
808
# repository into a new repository object without the fallbacks.
810
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
811
# correct for CHKMap repostiories
812
old_repository = self.repository
813
if len(old_repository._fallback_repositories) != 1:
814
raise AssertionError("can't cope with fallback repositories "
815
"of %r (fallbacks: %r)" % (old_repository,
816
old_repository._fallback_repositories))
817
# Open the new repository object.
818
# Repositories don't offer an interface to remove fallback
819
# repositories today; take the conceptually simpler option and just
820
# reopen it. We reopen it starting from the URL so that we
821
# get a separate connection for RemoteRepositories and can
822
# stream from one of them to the other. This does mean doing
823
# separate SSH connection setup, but unstacking is not a
824
# common operation so it's tolerable.
825
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
826
new_repository = new_bzrdir.find_repository()
827
if new_repository._fallback_repositories:
828
raise AssertionError("didn't expect %r to have "
829
"fallback_repositories"
830
% (self.repository,))
831
# Replace self.repository with the new repository.
832
# Do our best to transfer the lock state (i.e. lock-tokens and
833
# lock count) of self.repository to the new repository.
834
lock_token = old_repository.lock_write().repository_token
835
self.repository = new_repository
836
if isinstance(self, remote.RemoteBranch):
837
# Remote branches can have a second reference to the old
838
# repository that need to be replaced.
839
if self._real_branch is not None:
840
self._real_branch.repository = new_repository
841
self.repository.lock_write(token=lock_token)
842
if lock_token is not None:
843
old_repository.leave_lock_in_place()
844
old_repository.unlock()
845
if lock_token is not None:
846
# XXX: self.repository.leave_lock_in_place() before this
847
# function will not be preserved. Fortunately that doesn't
848
# affect the current default format (2a), and would be a
849
# corner-case anyway.
850
# - Andrew Bennetts, 2010/06/30
851
self.repository.dont_leave_lock_in_place()
855
old_repository.unlock()
856
except errors.LockNotHeld:
859
if old_lock_count == 0:
860
raise AssertionError(
861
'old_repository should have been locked at least once.')
862
for i in range(old_lock_count-1):
863
self.repository.lock_write()
864
# Fetch from the old repository into the new.
865
old_repository.lock_read()
867
# XXX: If you unstack a branch while it has a working tree
868
# with a pending merge, the pending-merged revisions will no
869
# longer be present. You can (probably) revert and remerge.
871
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
872
except errors.TagsNotSupported:
873
tags_to_fetch = set()
874
fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
875
old_repository, required_ids=[self.last_revision()],
876
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
877
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
879
old_repository.unlock()
883
def _set_tags_bytes(self, bytes):
884
"""Mirror method for _get_tags_bytes.
886
:seealso: Branch._get_tags_bytes.
888
return _run_with_write_locked_target(self, self._set_tags_bytes_locked,
891
def _set_tags_bytes_locked(self, bytes):
892
self._tags_bytes = bytes
893
return self._transport.put_bytes('tags', bytes)
895
360
def _cache_revision_history(self, rev_history):
896
361
"""Set the cached revision history to rev_history.
1052
497
except ValueError:
1053
498
raise errors.NoSuchRevision(self, revision_id)
1056
500
def get_rev_id(self, revno, history=None):
1057
501
"""Find the revision id of the specified revno."""
1059
503
return _mod_revision.NULL_REVISION
1060
last_revno, last_revid = self.last_revision_info()
1061
if revno == last_revno:
1063
if revno <= 0 or revno > last_revno:
505
history = self.revision_history()
506
if revno <= 0 or revno > len(history):
1064
507
raise errors.NoSuchRevision(self, revno)
1065
distance_from_last = last_revno - revno
1066
if len(self._partial_revision_history_cache) <= distance_from_last:
1067
self._extend_partial_history(distance_from_last)
1068
return self._partial_revision_history_cache[distance_from_last]
508
return history[revno - 1]
1070
510
def pull(self, source, overwrite=False, stop_revision=None,
1071
possible_transports=None, *args, **kwargs):
511
possible_transports=None):
1072
512
"""Mirror source into this branch.
1074
514
This branch is considered to be 'local', having low latency.
1076
516
:returns: PullResult instance
1078
return InterBranch.get(source, self).pull(overwrite=overwrite,
1079
stop_revision=stop_revision,
1080
possible_transports=possible_transports, *args, **kwargs)
518
raise NotImplementedError(self.pull)
1082
def push(self, target, overwrite=False, stop_revision=None, *args,
520
def push(self, target, overwrite=False, stop_revision=None):
1084
521
"""Mirror this branch into target.
1086
523
This branch is considered to be 'local', having low latency.
1088
return InterBranch.get(self, target).push(overwrite, stop_revision,
1091
def lossy_push(self, target, stop_revision=None):
1092
"""Push deltas into another branch.
1094
:note: This does not, like push, retain the revision ids from
1095
the source branch and will, rather than adding bzr-specific
1096
metadata, push only those semantics of the revision that can be
1097
natively represented by this branch' VCS.
1099
:param target: Target branch
1100
:param stop_revision: Revision to push, defaults to last revision.
1101
:return: BranchPushResult with an extra member revidmap:
1102
A dictionary mapping revision ids from the target branch
1103
to new revision ids in the target branch, for each
1104
revision that was pushed.
1106
inter = InterBranch.get(self, target)
1107
lossy_push = getattr(inter, "lossy_push", None)
1108
if lossy_push is None:
1109
raise errors.LossyPushToSameVCS(self, target)
1110
return lossy_push(stop_revision)
525
raise NotImplementedError(self.push)
1112
527
def basis_tree(self):
1113
528
"""Return `Tree` object for last revision."""
1114
529
return self.repository.revision_tree(self.last_revision())
531
def rename_one(self, from_rel, to_rel):
534
This can change the directory or the filename or both.
536
raise NotImplementedError(self.rename_one)
538
def move(self, from_paths, to_name):
541
to_name must exist as a versioned directory.
543
If to_name exists and is a directory, the files are moved into
544
it, keeping their old names. If it is a directory,
546
Note that to_name is only the last component of the new name;
547
this doesn't change the directory.
549
This returns a list of (from_path, to_path) pairs for each
552
raise NotImplementedError(self.move)
1116
554
def get_parent(self):
1117
555
"""Return the parent location of the branch.
1119
This is the default location for pull/missing. The usual
557
This is the default location for push/pull/missing. The usual
1120
558
pattern is that the user can override it by specifying a
1123
parent = self._get_parent_location()
1126
# This is an old-format absolute path to a local branch
1127
# turn it into a url
1128
if parent.startswith('/'):
1129
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1131
return urlutils.join(self.base[:-1], parent)
1132
except errors.InvalidURLJoin, e:
1133
raise errors.InaccessibleParent(parent, self.user_url)
1135
def _get_parent_location(self):
1136
raise NotImplementedError(self._get_parent_location)
561
raise NotImplementedError(self.get_parent)
1138
563
def _set_config_location(self, name, url, config=None,
1139
564
make_relative=False):
1240
642
self.check_real_revno(revno)
1242
644
def check_real_revno(self, revno):
1244
646
Check whether a revno corresponds to a real revision.
1245
647
Zero (the NULL revision) is considered invalid
1247
649
if revno < 1 or revno > self.revno():
1248
raise errors.InvalidRevisionNumber(revno)
650
raise InvalidRevisionNumber(revno)
1250
652
@needs_read_lock
1251
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
653
def clone(self, to_bzrdir, revision_id=None):
1252
654
"""Clone this branch into to_bzrdir preserving all semantic values.
1254
Most API users will want 'create_clone_on_transport', which creates a
1255
new bzrdir and branch on the fly.
1257
656
revision_id: if not None, the revision history in the new branch will
1258
657
be truncated to end with revision_id.
1260
result = to_bzrdir.create_branch()
1263
if repository_policy is not None:
1264
repository_policy.configure_branch(result)
1265
self.copy_content_into(result, revision_id=revision_id)
659
result = self._format.initialize(to_bzrdir)
660
self.copy_content_into(result, revision_id=revision_id)
1270
663
@needs_read_lock
1271
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
664
def sprout(self, to_bzrdir, revision_id=None):
1273
665
"""Create a new line of development from the branch, into to_bzrdir.
1275
to_bzrdir controls the branch format.
1277
667
revision_id: if not None, the revision history in the new branch will
1278
668
be truncated to end with revision_id.
1280
if (repository_policy is not None and
1281
repository_policy.requires_stacking()):
1282
to_bzrdir._format.require_stacking(_skip_repo=True)
1283
result = to_bzrdir.create_branch(repository=repository)
1286
if repository_policy is not None:
1287
repository_policy.configure_branch(result)
1288
self.copy_content_into(result, revision_id=revision_id)
1289
result.set_parent(self.bzrdir.root_transport.base)
670
result = self._format.initialize(to_bzrdir)
671
self.copy_content_into(result, revision_id=revision_id)
672
result.set_parent(self.bzrdir.root_transport.base)
1294
675
def _synchronize_history(self, destination, revision_id):
1295
676
"""Synchronize last revision and revision history between branches.
1297
678
This version is most efficient when the destination is also a
1298
BzrBranch6, but works for BzrBranch5, as long as the destination's
1299
repository contains all the lefthand ancestors of the intended
1300
last_revision. If not, set_last_revision_info will fail.
679
BzrBranch5, but works for BzrBranch6 as long as the revision
680
history is the true lefthand parent history, and all of the revisions
681
are in the destination's repository. If not, set_revision_history
1302
684
:param destination: The branch to copy the history into
1303
685
:param revision_id: The revision-id to truncate history at. May
1304
686
be None to copy complete history.
1306
source_revno, source_revision_id = self.last_revision_info()
1307
if revision_id is None:
1308
revno, revision_id = source_revno, source_revision_id
1310
graph = self.repository.get_graph()
688
if revision_id == _mod_revision.NULL_REVISION:
690
new_history = self.revision_history()
691
if revision_id is not None and new_history != []:
1312
revno = graph.find_distance_to_null(revision_id,
1313
[(source_revision_id, source_revno)])
1314
except errors.GhostRevisionsHaveNoRevno:
1315
# Default to 1, if we can't find anything else
1317
destination.set_last_revision_info(revno, revision_id)
693
new_history = new_history[:new_history.index(revision_id) + 1]
695
rev = self.repository.get_revision(revision_id)
696
new_history = rev.get_history(self.repository)[1:]
697
destination.set_revision_history(new_history)
1319
700
def copy_content_into(self, destination, revision_id=None):
1320
701
"""Copy the content of self into destination.
1322
703
revision_id: if not None, the revision history in the new branch will
1323
704
be truncated to end with revision_id.
1325
return InterBranch.get(self, destination).copy_content_into(
1326
revision_id=revision_id)
1328
def update_references(self, target):
1329
if not getattr(self._format, 'supports_reference_locations', False):
1331
reference_dict = self._get_all_reference_info()
1332
if len(reference_dict) == 0:
1334
old_base = self.base
1335
new_base = target.base
1336
target_reference_dict = target._get_all_reference_info()
1337
for file_id, (tree_path, branch_location) in (
1338
reference_dict.items()):
1339
branch_location = urlutils.rebase_url(branch_location,
1341
target_reference_dict.setdefault(
1342
file_id, (tree_path, branch_location))
1343
target._set_all_reference_info(target_reference_dict)
706
self._synchronize_history(destination, revision_id)
708
parent = self.get_parent()
709
except errors.InaccessibleParent, e:
710
mutter('parent was not accessible to copy: %s', e)
713
destination.set_parent(parent)
714
self.tags.merge_to(destination.tags)
1345
716
@needs_read_lock
1346
def check(self, refs):
1347
718
"""Check consistency of the branch.
1349
720
In particular this checks that revisions given in the revision-history
1350
do actually match up in the revision graph, and that they're all
721
do actually match up in the revision graph, and that they're all
1351
722
present in the repository.
1353
724
Callers will typically also want to check the repository.
1355
:param refs: Calculated refs for this branch as specified by
1356
branch._get_check_refs()
1357
726
:return: A BranchCheckResult.
1359
result = BranchCheckResult(self)
1360
last_revno, last_revision_id = self.last_revision_info()
1361
actual_revno = refs[('lefthand-distance', last_revision_id)]
1362
if actual_revno != last_revno:
1363
result.errors.append(errors.BzrCheckError(
1364
'revno does not match len(mainline) %s != %s' % (
1365
last_revno, actual_revno)))
1366
# TODO: We should probably also check that self.revision_history
1367
# matches the repository for older branch formats.
1368
# If looking for the code that cross-checks repository parents against
1369
# the iter_reverse_revision_history output, that is now a repository
728
mainline_parent_id = None
729
for revision_id in self.revision_history():
731
revision = self.repository.get_revision(revision_id)
732
except errors.NoSuchRevision, e:
733
raise errors.BzrCheckError("mainline revision {%s} not in repository"
735
# In general the first entry on the revision history has no parents.
736
# But it's not illegal for it to have parents listed; this can happen
737
# in imports from Arch when the parents weren't reachable.
738
if mainline_parent_id is not None:
739
if mainline_parent_id not in revision.parent_ids:
740
raise errors.BzrCheckError("previous revision {%s} not listed among "
742
% (mainline_parent_id, revision_id))
743
mainline_parent_id = revision_id
744
return BranchCheckResult(self)
1373
746
def _get_checkout_format(self):
1374
747
"""Return the most suitable metadir for a checkout of this branch.
1375
748
Weaves are used if this branch's repository uses weaves.
1377
format = self.repository.bzrdir.checkout_metadir()
1378
format.set_branch_format(self._format)
750
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
751
from bzrlib.repofmt import weaverepo
752
format = bzrdir.BzrDirMetaFormat1()
753
format.repository_format = weaverepo.RepositoryFormat7()
755
format = self.repository.bzrdir.checkout_metadir()
756
format.set_branch_format(self._format)
1381
def create_clone_on_transport(self, to_transport, revision_id=None,
1382
stacked_on=None, create_prefix=False, use_existing_dir=False,
1384
"""Create a clone of this branch and its bzrdir.
1386
:param to_transport: The transport to clone onto.
1387
:param revision_id: The revision id to use as tip in the new branch.
1388
If None the tip is obtained from this branch.
1389
:param stacked_on: An optional URL to stack the clone on.
1390
:param create_prefix: Create any missing directories leading up to
1392
:param use_existing_dir: Use an existing directory if one exists.
1394
# XXX: Fix the bzrdir API to allow getting the branch back from the
1395
# clone call. Or something. 20090224 RBC/spiv.
1396
# XXX: Should this perhaps clone colocated branches as well,
1397
# rather than just the default branch? 20100319 JRV
1398
if revision_id is None:
1399
revision_id = self.last_revision()
1400
dir_to = self.bzrdir.clone_on_transport(to_transport,
1401
revision_id=revision_id, stacked_on=stacked_on,
1402
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1404
return dir_to.open_branch()
1406
759
def create_checkout(self, to_location, revision_id=None,
1407
lightweight=False, accelerator_tree=None,
1409
761
"""Create a checkout of a branch.
1411
763
:param to_location: The url to produce the checkout at
1412
764
:param revision_id: The revision to check out
1413
765
:param lightweight: If True, produce a lightweight checkout, otherwise,
1414
766
produce a bound branch (heavyweight checkout)
1415
:param accelerator_tree: A tree which can be used for retrieving file
1416
contents more quickly than the revision tree, i.e. a workingtree.
1417
The revision tree will be used for cases where accelerator_tree's
1418
content is different.
1419
:param hardlink: If true, hard-link files from accelerator_tree,
1421
767
:return: The tree of the created checkout
1423
769
t = transport.get_transport(to_location)
1453
794
basis_tree.unlock()
1457
def reconcile(self, thorough=True):
1458
"""Make sure the data stored in this branch is consistent."""
1459
from bzrlib.reconcile import BranchReconciler
1460
reconciler = BranchReconciler(self, thorough=thorough)
1461
reconciler.reconcile()
1464
def reference_parent(self, file_id, path, possible_transports=None):
797
def reference_parent(self, file_id, path):
1465
798
"""Return the parent branch for a tree-reference file_id
1466
799
:param file_id: The file_id of the tree reference
1467
800
:param path: The path of the file_id in the tree
1468
801
:return: A branch associated with the file_id
1470
803
# FIXME should provide multiple branches, based on config
1471
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1472
possible_transports=possible_transports)
804
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1474
806
def supports_tags(self):
1475
807
return self._format.supports_tags()
1477
def automatic_tag_name(self, revision_id):
1478
"""Try to automatically find the tag name for a revision.
1480
:param revision_id: Revision id of the revision.
1481
:return: A tag name or None if no tag name could be determined.
1483
for hook in Branch.hooks['automatic_tag_name']:
1484
ret = hook(self, revision_id)
1489
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1491
"""Ensure that revision_b is a descendant of revision_a.
1493
This is a helper function for update_revisions.
1495
:raises: DivergedBranches if revision_b has diverged from revision_a.
1496
:returns: True if revision_b is a descendant of revision_a.
1498
relation = self._revision_relations(revision_a, revision_b, graph)
1499
if relation == 'b_descends_from_a':
1501
elif relation == 'diverged':
1502
raise errors.DivergedBranches(self, other_branch)
1503
elif relation == 'a_descends_from_b':
1506
raise AssertionError("invalid relation: %r" % (relation,))
1508
def _revision_relations(self, revision_a, revision_b, graph):
1509
"""Determine the relationship between two revisions.
1511
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1513
heads = graph.heads([revision_a, revision_b])
1514
if heads == set([revision_b]):
1515
return 'b_descends_from_a'
1516
elif heads == set([revision_a, revision_b]):
1517
# These branches have diverged
1519
elif heads == set([revision_a]):
1520
return 'a_descends_from_b'
1522
raise AssertionError("invalid heads: %r" % (heads,))
1524
def heads_to_fetch(self):
1525
"""Return the heads that must and that should be fetched to copy this
1526
branch into another repo.
1528
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1529
set of heads that must be fetched. if_present_fetch is a set of
1530
heads that must be fetched if present, but no error is necessary if
1531
they are not present.
1533
# For bzr native formats must_fetch is just the tip, and if_present_fetch
1535
must_fetch = set([self.last_revision()])
1537
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1538
except errors.TagsNotSupported:
1539
if_present_fetch = set()
1540
must_fetch.discard(_mod_revision.NULL_REVISION)
1541
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1542
return must_fetch, if_present_fetch
1545
class BranchFormat(controldir.ControlComponentFormat):
810
class BranchFormat(object):
1546
811
"""An encapsulation of the initialization and open routines for a format.
1548
813
Formats provide three things:
1631
874
"""Return the short format description for this format."""
1632
875
raise NotImplementedError(self.get_format_description)
1634
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1635
hooks = Branch.hooks['post_branch_init']
1638
params = BranchInitHookParams(self, a_bzrdir, name, branch)
877
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
879
"""Initialize a branch in a bzrdir, with specified files
1642
def initialize(self, a_bzrdir, name=None, repository=None):
1643
"""Create a branch of this format in a_bzrdir.
1645
:param name: Name of the colocated branch to create.
881
:param a_bzrdir: The bzrdir to initialize the branch in
882
:param utf8_files: The files to create as a list of
883
(filename, content) tuples
884
:param set_format: If True, set the format with
885
self.get_format_string. (BzrBranch4 has its format set
887
:return: a branch in this format
889
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
890
branch_transport = a_bzrdir.get_branch_transport(self)
892
'metadir': ('lock', lockdir.LockDir),
893
'branch4': ('branch-lock', lockable_files.TransportLock),
895
lock_name, lock_class = lock_map[lock_type]
896
control_files = lockable_files.LockableFiles(branch_transport,
897
lock_name, lock_class)
898
control_files.create_lock()
899
control_files.lock_write()
901
control_files.put_utf8('format', self.get_format_string())
903
for file, content in utf8_files:
904
control_files.put_utf8(file, content)
906
control_files.unlock()
907
return self.open(a_bzrdir, _found=True)
909
def initialize(self, a_bzrdir):
910
"""Create a branch of this format in a_bzrdir."""
1647
911
raise NotImplementedError(self.initialize)
1649
913
def is_supported(self):
1650
914
"""Is this format supported?
1652
916
Supported formats can be initialized and opened.
1653
Unsupported formats may not support initialization or committing or
917
Unsupported formats may not support initialization or committing or
1654
918
some other features depending on the reason for not being supported.
1658
def make_tags(self, branch):
1659
"""Create a tags object for branch.
1661
This method is on BranchFormat, because BranchFormats are reflected
1662
over the wire via network_name(), whereas full Branch instances require
1663
multiple VFS method calls to operate at all.
1665
The default implementation returns a disabled-tags instance.
1667
Note that it is normal for branch to be a RemoteBranch when using tags
1670
return DisabledTags(branch)
1672
def network_name(self):
1673
"""A simple byte string uniquely identifying this format for RPC calls.
1675
MetaDir branch formats use their disk format string to identify the
1676
repository over the wire. All in one formats such as bzr < 0.8, and
1677
foreign formats like svn/git and hg should use some marker which is
1678
unique and immutable.
1680
raise NotImplementedError(self.network_name)
1682
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
1683
found_repository=None):
922
def open(self, a_bzrdir, _found=False):
1684
923
"""Return the branch object for a_bzrdir
1686
:param a_bzrdir: A BzrDir that contains a branch.
1687
:param name: Name of colocated branch to open
1688
:param _found: a private parameter, do not use it. It is used to
1689
indicate if format probing has already be done.
1690
:param ignore_fallbacks: when set, no fallback branches will be opened
1691
(if there are any). Default is to open fallbacks.
925
_found is a private parameter, do not use it. It is used to indicate
926
if format probing has already be done.
1693
928
raise NotImplementedError(self.open)
1696
@deprecated_method(deprecated_in((2, 4, 0)))
1697
931
def register_format(klass, format):
1698
"""Register a metadir format.
1700
See MetaDirBranchFormatFactory for the ability to register a format
1701
without loading the code the format needs until it is actually used.
1703
format_registry.register(format)
932
klass._formats[format.get_format_string()] = format
1706
@deprecated_method(deprecated_in((2, 4, 0)))
1707
935
def set_default_format(klass, format):
1708
format_registry.set_default(format)
1710
def supports_set_append_revisions_only(self):
1711
"""True if this format supports set_append_revisions_only."""
1714
def supports_stacking(self):
1715
"""True if this format records a stacked-on branch."""
1718
def supports_leaving_lock(self):
1719
"""True if this format supports leaving locks in place."""
1720
return False # by default
936
klass._default_format = format
1723
@deprecated_method(deprecated_in((2, 4, 0)))
1724
939
def unregister_format(klass, format):
1725
format_registry.remove(format)
940
assert klass._formats[format.get_format_string()] is format
941
del klass._formats[format.get_format_string()]
1727
943
def __str__(self):
1728
return self.get_format_description().rstrip()
944
return self.get_format_string().rstrip()
1730
946
def supports_tags(self):
1731
947
"""True if this format supports tags stored in the branch"""
1732
948
return False # by default
1735
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1736
"""A factory for a BranchFormat object, permitting simple lazy registration.
1738
While none of the built in BranchFormats are lazy registered yet,
1739
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1740
use it, and the bzr-loom plugin uses it as well (see
1741
bzrlib.plugins.loom.formats).
1744
def __init__(self, format_string, module_name, member_name):
1745
"""Create a MetaDirBranchFormatFactory.
1747
:param format_string: The format string the format has.
1748
:param module_name: Module to load the format class from.
1749
:param member_name: Attribute name within the module for the format class.
1751
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1752
self._format_string = format_string
1754
def get_format_string(self):
1755
"""See BranchFormat.get_format_string."""
1756
return self._format_string
1759
"""Used for network_format_registry support."""
1760
return self.get_obj()()
950
# XXX: Probably doesn't really belong here -- mbp 20070212
951
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
953
branch_transport = a_bzrdir.get_branch_transport(self)
954
control_files = lockable_files.LockableFiles(branch_transport,
955
lock_filename, lock_class)
956
control_files.create_lock()
957
control_files.lock_write()
959
for filename, content in utf8_files:
960
control_files.put_utf8(filename, content)
962
control_files.unlock()
1763
965
class BranchHooks(Hooks):
1764
966
"""A dictionary mapping hook name to a list of callables for branch hooks.
1766
968
e.g. ['set_rh'] Is the list of items to be called when the
1767
969
set_revision_history function is invoked.
1773
975
These are all empty initially, because by default nothing should get
1776
Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1777
self.add_hook('set_rh',
1778
"Invoked whenever the revision history has been set via "
1779
"set_revision_history. The api signature is (branch, "
1780
"revision_history), and the branch will be write-locked. "
1781
"The set_rh hook can be expensive for bzr to trigger, a better "
1782
"hook to use is Branch.post_change_branch_tip.", (0, 15))
1783
self.add_hook('open',
1784
"Called with the Branch object that has been opened after a "
1785
"branch is opened.", (1, 8))
1786
self.add_hook('post_push',
1787
"Called after a push operation completes. post_push is called "
1788
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1789
"bzr client.", (0, 15))
1790
self.add_hook('post_pull',
1791
"Called after a pull operation completes. post_pull is called "
1792
"with a bzrlib.branch.PullResult object and only runs in the "
1793
"bzr client.", (0, 15))
1794
self.add_hook('pre_commit',
1795
"Called after a commit is calculated but before it is "
1796
"completed. pre_commit is called with (local, master, old_revno, "
1797
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1798
"). old_revid is NULL_REVISION for the first commit to a branch, "
1799
"tree_delta is a TreeDelta object describing changes from the "
1800
"basis revision. hooks MUST NOT modify this delta. "
1801
" future_tree is an in-memory tree obtained from "
1802
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1804
self.add_hook('post_commit',
1805
"Called in the bzr client after a commit has completed. "
1806
"post_commit is called with (local, master, old_revno, old_revid, "
1807
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1808
"commit to a branch.", (0, 15))
1809
self.add_hook('post_uncommit',
1810
"Called in the bzr client after an uncommit completes. "
1811
"post_uncommit is called with (local, master, old_revno, "
1812
"old_revid, new_revno, new_revid) where local is the local branch "
1813
"or None, master is the target branch, and an empty branch "
1814
"receives new_revno of 0, new_revid of None.", (0, 15))
1815
self.add_hook('pre_change_branch_tip',
1816
"Called in bzr client and server before a change to the tip of a "
1817
"branch is made. pre_change_branch_tip is called with a "
1818
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1819
"commit, uncommit will all trigger this hook.", (1, 6))
1820
self.add_hook('post_change_branch_tip',
1821
"Called in bzr client and server after a change to the tip of a "
1822
"branch is made. post_change_branch_tip is called with a "
1823
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1824
"commit, uncommit will all trigger this hook.", (1, 4))
1825
self.add_hook('transform_fallback_location',
1826
"Called when a stacked branch is activating its fallback "
1827
"locations. transform_fallback_location is called with (branch, "
1828
"url), and should return a new url. Returning the same url "
1829
"allows it to be used as-is, returning a different one can be "
1830
"used to cause the branch to stack on a closer copy of that "
1831
"fallback_location. Note that the branch cannot have history "
1832
"accessing methods called on it during this hook because the "
1833
"fallback locations have not been activated. When there are "
1834
"multiple hooks installed for transform_fallback_location, "
1835
"all are called with the url returned from the previous hook."
1836
"The order is however undefined.", (1, 9))
1837
self.add_hook('automatic_tag_name',
1838
"Called to determine an automatic tag name for a revision. "
1839
"automatic_tag_name is called with (branch, revision_id) and "
1840
"should return a tag name or None if no tag name could be "
1841
"determined. The first non-None tag name returned will be used.",
1843
self.add_hook('post_branch_init',
1844
"Called after new branch initialization completes. "
1845
"post_branch_init is called with a "
1846
"bzrlib.branch.BranchInitHookParams. "
1847
"Note that init, branch and checkout (both heavyweight and "
1848
"lightweight) will all trigger this hook.", (2, 2))
1849
self.add_hook('post_switch',
1850
"Called after a checkout switches branch. "
1851
"post_switch is called with a "
1852
"bzrlib.branch.SwitchHookParams.", (2, 2))
979
# Introduced in 0.15:
980
# invoked whenever the revision history has been set
981
# with set_revision_history. The api signature is
982
# (branch, revision_history), and the branch will
985
# invoked after a push operation completes.
986
# the api signature is
988
# containing the members
989
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
990
# where local is the local target branch or None, master is the target
991
# master branch, and the rest should be self explanatory. The source
992
# is read locked and the target branches write locked. Source will
993
# be the local low-latency branch.
994
self['post_push'] = []
995
# invoked after a pull operation completes.
996
# the api signature is
998
# containing the members
999
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1000
# where local is the local branch or None, master is the target
1001
# master branch, and the rest should be self explanatory. The source
1002
# is read locked and the target branches write locked. The local
1003
# branch is the low-latency branch.
1004
self['post_pull'] = []
1005
# invoked before a commit operation takes place.
1006
# the api signature is
1007
# (local, master, old_revno, old_revid, future_revno, future_revid,
1008
# tree_delta, future_tree).
1009
# old_revid is NULL_REVISION for the first commit to a branch
1010
# tree_delta is a TreeDelta object describing changes from the basis
1011
# revision, hooks MUST NOT modify this delta
1012
# future_tree is an in-memory tree obtained from
1013
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1014
self['pre_commit'] = []
1015
# invoked after a commit operation completes.
1016
# the api signature is
1017
# (local, master, old_revno, old_revid, new_revno, new_revid)
1018
# old_revid is NULL_REVISION for the first commit to a branch.
1019
self['post_commit'] = []
1020
# invoked after a uncommit operation completes.
1021
# the api signature is
1022
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1023
# local is the local branch or None, master is the target branch,
1024
# and an empty branch recieves new_revno of 0, new_revid of None.
1025
self['post_uncommit'] = []
1856
1028
# install the default hooks into the Branch class.
1857
1029
Branch.hooks = BranchHooks()
1860
class ChangeBranchTipParams(object):
1861
"""Object holding parameters passed to *_change_branch_tip hooks.
1863
There are 5 fields that hooks may wish to access:
1865
:ivar branch: the branch being changed
1866
:ivar old_revno: revision number before the change
1867
:ivar new_revno: revision number after the change
1868
:ivar old_revid: revision id before the change
1869
:ivar new_revid: revision id after the change
1871
The revid fields are strings. The revno fields are integers.
1874
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1875
"""Create a group of ChangeBranchTip parameters.
1877
:param branch: The branch being changed.
1878
:param old_revno: Revision number before the change.
1879
:param new_revno: Revision number after the change.
1880
:param old_revid: Tip revision id before the change.
1881
:param new_revid: Tip revision id after the change.
1883
self.branch = branch
1884
self.old_revno = old_revno
1885
self.new_revno = new_revno
1886
self.old_revid = old_revid
1887
self.new_revid = new_revid
1889
def __eq__(self, other):
1890
return self.__dict__ == other.__dict__
1893
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1894
self.__class__.__name__, self.branch,
1895
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1898
class BranchInitHookParams(object):
1899
"""Object holding parameters passed to *_branch_init hooks.
1901
There are 4 fields that hooks may wish to access:
1903
:ivar format: the branch format
1904
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1905
:ivar name: name of colocated branch, if any (or None)
1906
:ivar branch: the branch created
1908
Note that for lightweight checkouts, the bzrdir and format fields refer to
1909
the checkout, hence they are different from the corresponding fields in
1910
branch, which refer to the original branch.
1913
def __init__(self, format, a_bzrdir, name, branch):
1914
"""Create a group of BranchInitHook parameters.
1916
:param format: the branch format
1917
:param a_bzrdir: the BzrDir where the branch will be/has been
1919
:param name: name of colocated branch, if any (or None)
1920
:param branch: the branch created
1922
Note that for lightweight checkouts, the bzrdir and format fields refer
1923
to the checkout, hence they are different from the corresponding fields
1924
in branch, which refer to the original branch.
1926
self.format = format
1927
self.bzrdir = a_bzrdir
1929
self.branch = branch
1931
def __eq__(self, other):
1932
return self.__dict__ == other.__dict__
1935
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1938
class SwitchHookParams(object):
1939
"""Object holding parameters passed to *_switch hooks.
1941
There are 4 fields that hooks may wish to access:
1943
:ivar control_dir: BzrDir of the checkout to change
1944
:ivar to_branch: branch that the checkout is to reference
1945
:ivar force: skip the check for local commits in a heavy checkout
1946
:ivar revision_id: revision ID to switch to (or None)
1949
def __init__(self, control_dir, to_branch, force, revision_id):
1950
"""Create a group of SwitchHook parameters.
1952
:param control_dir: BzrDir of the checkout to change
1953
:param to_branch: branch that the checkout is to reference
1954
:param force: skip the check for local commits in a heavy checkout
1955
:param revision_id: revision ID to switch to (or None)
1957
self.control_dir = control_dir
1958
self.to_branch = to_branch
1960
self.revision_id = revision_id
1962
def __eq__(self, other):
1963
return self.__dict__ == other.__dict__
1966
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1967
self.control_dir, self.to_branch,
1971
class BranchFormatMetadir(BranchFormat):
1972
"""Common logic for meta-dir based branch formats."""
1974
def _branch_class(self):
1975
"""What class to instantiate on open calls."""
1976
raise NotImplementedError(self._branch_class)
1978
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1980
"""Initialize a branch in a bzrdir, with specified files
1982
:param a_bzrdir: The bzrdir to initialize the branch in
1983
:param utf8_files: The files to create as a list of
1984
(filename, content) tuples
1985
:param name: Name of colocated branch to create, if any
1986
:return: a branch in this format
1988
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1989
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1990
control_files = lockable_files.LockableFiles(branch_transport,
1991
'lock', lockdir.LockDir)
1992
control_files.create_lock()
1993
control_files.lock_write()
1995
utf8_files += [('format', self.get_format_string())]
1996
for (filename, content) in utf8_files:
1997
branch_transport.put_bytes(
1999
mode=a_bzrdir._get_file_mode())
2001
control_files.unlock()
2002
branch = self.open(a_bzrdir, name, _found=True,
2003
found_repository=repository)
2004
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2007
def network_name(self):
2008
"""A simple byte string uniquely identifying this format for RPC calls.
2010
Metadir branch formats use their format string.
2012
return self.get_format_string()
2014
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2015
found_repository=None):
2016
"""See BranchFormat.open()."""
2018
format = BranchFormat.find_format(a_bzrdir, name=name)
2019
if format.__class__ != self.__class__:
2020
raise AssertionError("wrong format %r found for %r" %
2022
transport = a_bzrdir.get_branch_transport(None, name=name)
1032
class BzrBranchFormat4(BranchFormat):
1033
"""Bzr branch format 4.
1036
- a revision-history file.
1037
- a branch-lock lock file [ to be shared with the bzrdir ]
1040
def get_format_description(self):
1041
"""See BranchFormat.get_format_description()."""
1042
return "Branch format 4"
1044
def initialize(self, a_bzrdir):
1045
"""Create a branch of this format in a_bzrdir."""
1046
utf8_files = [('revision-history', ''),
1047
('branch-name', ''),
1049
return self._initialize_helper(a_bzrdir, utf8_files,
1050
lock_type='branch4', set_format=False)
1053
super(BzrBranchFormat4, self).__init__()
1054
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1056
def open(self, a_bzrdir, _found=False):
1057
"""Return the branch object for a_bzrdir
1059
_found is a private parameter, do not use it. It is used to indicate
1060
if format probing has already be done.
1063
# we are being called directly and must probe.
1064
raise NotImplementedError
1065
return BzrBranch(_format=self,
1066
_control_files=a_bzrdir._control_files,
1068
_repository=a_bzrdir.open_repository())
1071
return "Bazaar-NG branch format 4"
1074
class BzrBranchFormat5(BranchFormat):
1075
"""Bzr branch format 5.
1078
- a revision-history file.
1080
- a lock dir guarding the branch itself
1081
- all of this stored in a branch/ subdirectory
1082
- works with shared repositories.
1084
This format is new in bzr 0.8.
1087
def get_format_string(self):
1088
"""See BranchFormat.get_format_string()."""
1089
return "Bazaar-NG branch format 5\n"
1091
def get_format_description(self):
1092
"""See BranchFormat.get_format_description()."""
1093
return "Branch format 5"
1095
def initialize(self, a_bzrdir):
1096
"""Create a branch of this format in a_bzrdir."""
1097
utf8_files = [('revision-history', ''),
1098
('branch-name', ''),
1100
return self._initialize_helper(a_bzrdir, utf8_files)
1103
super(BzrBranchFormat5, self).__init__()
1104
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1106
def open(self, a_bzrdir, _found=False):
1107
"""Return the branch object for a_bzrdir
1109
_found is a private parameter, do not use it. It is used to indicate
1110
if format probing has already be done.
1113
format = BranchFormat.find_format(a_bzrdir)
1114
assert format.__class__ == self.__class__
1116
transport = a_bzrdir.get_branch_transport(None)
2024
1117
control_files = lockable_files.LockableFiles(transport, 'lock',
2025
1118
lockdir.LockDir)
2026
if found_repository is None:
2027
found_repository = a_bzrdir.find_repository()
2028
return self._branch_class()(_format=self,
1119
return BzrBranch5(_format=self,
2029
1120
_control_files=control_files,
2031
1121
a_bzrdir=a_bzrdir,
2032
_repository=found_repository,
2033
ignore_fallbacks=ignore_fallbacks)
2034
except errors.NoSuchFile:
2035
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2038
super(BranchFormatMetadir, self).__init__()
2039
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2040
self._matchingbzrdir.set_branch_format(self)
2042
def supports_tags(self):
2045
def supports_leaving_lock(self):
2049
class BzrBranchFormat5(BranchFormatMetadir):
2050
"""Bzr branch format 5.
2053
- a revision-history file.
2055
- a lock dir guarding the branch itself
2056
- all of this stored in a branch/ subdirectory
2057
- works with shared repositories.
2059
This format is new in bzr 0.8.
2062
def _branch_class(self):
2065
def get_format_string(self):
2066
"""See BranchFormat.get_format_string()."""
2067
return "Bazaar-NG branch format 5\n"
2069
def get_format_description(self):
2070
"""See BranchFormat.get_format_description()."""
2071
return "Branch format 5"
2073
def initialize(self, a_bzrdir, name=None, repository=None):
2074
"""Create a branch of this format in a_bzrdir."""
2075
utf8_files = [('revision-history', ''),
2076
('branch-name', ''),
2078
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2080
def supports_tags(self):
2084
class BzrBranchFormat6(BranchFormatMetadir):
1122
_repository=a_bzrdir.find_repository())
1124
raise NotBranchError(path=transport.base)
1127
class BzrBranchFormat6(BzrBranchFormat5):
2085
1128
"""Branch format with last-revision and tags.
2087
1130
Unlike previous formats, this has no explicit revision history. Instead,
2103
1143
"""See BranchFormat.get_format_description()."""
2104
1144
return "Branch format 6"
2106
def initialize(self, a_bzrdir, name=None, repository=None):
2107
"""Create a branch of this format in a_bzrdir."""
2108
utf8_files = [('last-revision', '0 null:\n'),
2109
('branch.conf', ''),
2112
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2114
def make_tags(self, branch):
2115
"""See bzrlib.branch.BranchFormat.make_tags()."""
2116
return BasicTags(branch)
2118
def supports_set_append_revisions_only(self):
2122
class BzrBranchFormat8(BranchFormatMetadir):
2123
"""Metadir format supporting storing locations of subtree branches."""
2125
def _branch_class(self):
2128
def get_format_string(self):
2129
"""See BranchFormat.get_format_string()."""
2130
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2132
def get_format_description(self):
2133
"""See BranchFormat.get_format_description()."""
2134
return "Branch format 8"
2136
def initialize(self, a_bzrdir, name=None, repository=None):
2137
"""Create a branch of this format in a_bzrdir."""
2138
utf8_files = [('last-revision', '0 null:\n'),
2139
('branch.conf', ''),
2143
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2145
def make_tags(self, branch):
2146
"""See bzrlib.branch.BranchFormat.make_tags()."""
2147
return BasicTags(branch)
2149
def supports_set_append_revisions_only(self):
2152
def supports_stacking(self):
2155
supports_reference_locations = True
2158
class BzrBranchFormat7(BranchFormatMetadir):
2159
"""Branch format with last-revision, tags, and a stacked location pointer.
2161
The stacked location pointer is passed down to the repository and requires
2162
a repository format with supports_external_lookups = True.
2164
This format was introduced in bzr 1.6.
2167
def initialize(self, a_bzrdir, name=None, repository=None):
2168
"""Create a branch of this format in a_bzrdir."""
2169
utf8_files = [('last-revision', '0 null:\n'),
2170
('branch.conf', ''),
2173
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2175
def _branch_class(self):
2178
def get_format_string(self):
2179
"""See BranchFormat.get_format_string()."""
2180
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2182
def get_format_description(self):
2183
"""See BranchFormat.get_format_description()."""
2184
return "Branch format 7"
2186
def supports_set_append_revisions_only(self):
2189
def supports_stacking(self):
2192
def make_tags(self, branch):
2193
"""See bzrlib.branch.BranchFormat.make_tags()."""
2194
return BasicTags(branch)
2196
supports_reference_locations = False
1146
def initialize(self, a_bzrdir):
1147
"""Create a branch of this format in a_bzrdir."""
1148
utf8_files = [('last-revision', '0 null:\n'),
1149
('branch-name', ''),
1150
('branch.conf', ''),
1153
return self._initialize_helper(a_bzrdir, utf8_files)
1155
def open(self, a_bzrdir, _found=False):
1156
"""Return the branch object for a_bzrdir
1158
_found is a private parameter, do not use it. It is used to indicate
1159
if format probing has already be done.
1162
format = BranchFormat.find_format(a_bzrdir)
1163
assert format.__class__ == self.__class__
1164
transport = a_bzrdir.get_branch_transport(None)
1165
control_files = lockable_files.LockableFiles(transport, 'lock',
1167
return BzrBranch6(_format=self,
1168
_control_files=control_files,
1170
_repository=a_bzrdir.find_repository())
1172
def supports_tags(self):
2199
1176
class BranchReferenceFormat(BranchFormat):
2214
1191
def get_format_description(self):
2215
1192
"""See BranchFormat.get_format_description()."""
2216
1193
return "Checkout reference format 1"
2218
def get_reference(self, a_bzrdir, name=None):
1195
def get_reference(self, a_bzrdir):
2219
1196
"""See BranchFormat.get_reference()."""
2220
transport = a_bzrdir.get_branch_transport(None, name=name)
2221
return transport.get_bytes('location')
2223
def set_reference(self, a_bzrdir, name, to_branch):
2224
"""See BranchFormat.set_reference()."""
2225
transport = a_bzrdir.get_branch_transport(None, name=name)
2226
location = transport.put_bytes('location', to_branch.base)
2228
def initialize(self, a_bzrdir, name=None, target_branch=None,
1197
transport = a_bzrdir.get_branch_transport(None)
1198
return transport.get('location').read()
1200
def initialize(self, a_bzrdir, target_branch=None):
2230
1201
"""Create a branch of this format in a_bzrdir."""
2231
1202
if target_branch is None:
2232
1203
# this format does not implement branch itself, thus the implicit
2233
1204
# creation contract must see it as uninitializable
2234
1205
raise errors.UninitializableFormat(self)
2235
mutter('creating branch reference in %s', a_bzrdir.user_url)
2236
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1206
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1207
branch_transport = a_bzrdir.get_branch_transport(self)
2237
1208
branch_transport.put_bytes('location',
2238
target_branch.bzrdir.user_url)
1209
target_branch.bzrdir.root_transport.base)
2239
1210
branch_transport.put_bytes('format', self.get_format_string())
2241
a_bzrdir, name, _found=True,
2242
possible_transports=[target_branch.bzrdir.root_transport])
2243
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1211
return self.open(a_bzrdir, _found=True)
2246
1213
def __init__(self):
2247
1214
super(BranchReferenceFormat, self).__init__()
2248
1215
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2249
self._matchingbzrdir.set_branch_format(self)
2251
1217
def _make_reference_clone_function(format, a_branch):
2252
1218
"""Create a clone() routine for a branch dynamically."""
2253
def clone(to_bzrdir, revision_id=None,
2254
repository_policy=None):
1219
def clone(to_bzrdir, revision_id=None):
2255
1220
"""See Branch.clone()."""
2256
return format.initialize(to_bzrdir, target_branch=a_branch)
1221
return format.initialize(to_bzrdir, a_branch)
2257
1222
# cannot obey revision_id limits when cloning a reference ...
2258
1223
# FIXME RBC 20060210 either nuke revision_id for clone, or
2259
1224
# emit some sort of warning/error to the caller ?!
2262
def open(self, a_bzrdir, name=None, _found=False, location=None,
2263
possible_transports=None, ignore_fallbacks=False,
2264
found_repository=None):
1227
def open(self, a_bzrdir, _found=False, location=None):
2265
1228
"""Return the branch that the branch reference in a_bzrdir points at.
2267
:param a_bzrdir: A BzrDir that contains a branch.
2268
:param name: Name of colocated branch to open, if any
2269
:param _found: a private parameter, do not use it. It is used to
2270
indicate if format probing has already be done.
2271
:param ignore_fallbacks: when set, no fallback branches will be opened
2272
(if there are any). Default is to open fallbacks.
2273
:param location: The location of the referenced branch. If
2274
unspecified, this will be determined from the branch reference in
2276
:param possible_transports: An optional reusable transports list.
1230
_found is a private parameter, do not use it. It is used to indicate
1231
if format probing has already be done.
2279
format = BranchFormat.find_format(a_bzrdir, name=name)
2280
if format.__class__ != self.__class__:
2281
raise AssertionError("wrong format %r found for %r" %
1234
format = BranchFormat.find_format(a_bzrdir)
1235
assert format.__class__ == self.__class__
2283
1236
if location is None:
2284
location = self.get_reference(a_bzrdir, name)
2285
real_bzrdir = bzrdir.BzrDir.open(
2286
location, possible_transports=possible_transports)
2287
result = real_bzrdir.open_branch(name=name,
2288
ignore_fallbacks=ignore_fallbacks)
1237
location = self.get_reference(a_bzrdir)
1238
real_bzrdir = bzrdir.BzrDir.open(location)
1239
result = real_bzrdir.open_branch()
2289
1240
# this changes the behaviour of result.clone to create a new reference
2290
1241
# rather than a copy of the content of the branch.
2291
1242
# I did not use a proxy object because that needs much more extensive
2301
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2302
"""Branch format registry."""
2304
def __init__(self, other_registry=None):
2305
super(BranchFormatRegistry, self).__init__(other_registry)
2306
self._default_format = None
2308
def set_default(self, format):
2309
self._default_format = format
2311
def get_default(self):
2312
return self._default_format
2315
network_format_registry = registry.FormatRegistry()
2316
"""Registry of formats indexed by their network name.
2318
The network name for a branch format is an identifier that can be used when
2319
referring to formats with smart server operations. See
2320
BranchFormat.network_name() for more detail.
2323
format_registry = BranchFormatRegistry(network_format_registry)
2326
1252
# formats which have no format string are not discoverable
2327
1253
# and not independently creatable, so are not registered.
2328
1254
__format5 = BzrBranchFormat5()
2329
1255
__format6 = BzrBranchFormat6()
2330
__format7 = BzrBranchFormat7()
2331
__format8 = BzrBranchFormat8()
2332
format_registry.register(__format5)
2333
format_registry.register(BranchReferenceFormat())
2334
format_registry.register(__format6)
2335
format_registry.register(__format7)
2336
format_registry.register(__format8)
2337
format_registry.set_default(__format7)
2340
class BranchWriteLockResult(LogicalLockResult):
2341
"""The result of write locking a branch.
2343
:ivar branch_token: The token obtained from the underlying branch lock, or
2345
:ivar unlock: A callable which will unlock the lock.
2348
def __init__(self, unlock, branch_token):
2349
LogicalLockResult.__init__(self, unlock)
2350
self.branch_token = branch_token
2353
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2357
class BzrBranch(Branch, _RelockDebugMixin):
1256
BranchFormat.register_format(__format5)
1257
BranchFormat.register_format(BranchReferenceFormat())
1258
BranchFormat.register_format(__format6)
1259
BranchFormat.set_default_format(__format6)
1260
_legacy_formats = [BzrBranchFormat4(),
1263
class BzrBranch(Branch):
2358
1264
"""A branch stored in the actual filesystem.
2360
1266
Note that it's "local" in the context of the filesystem; it doesn't
2361
1267
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2362
1268
it's writable, and can be accessed via the normal filesystem API.
2364
:ivar _transport: Transport for file operations on this branch's
2365
control files, typically pointing to the .bzr/branch directory.
2366
:ivar repository: Repository for this branch.
2367
:ivar base: The url of the base directory for this branch; the one
2368
containing the .bzr directory.
2369
:ivar name: Optional colocated branch name as it exists in the control
2373
1271
def __init__(self, _format=None,
2374
_control_files=None, a_bzrdir=None, name=None,
2375
_repository=None, ignore_fallbacks=False):
1272
_control_files=None, a_bzrdir=None, _repository=None):
2376
1273
"""Create new branch object at a particular location."""
1274
Branch.__init__(self)
2377
1275
if a_bzrdir is None:
2378
1276
raise ValueError('a_bzrdir must be supplied')
2380
1278
self.bzrdir = a_bzrdir
1279
# self._transport used to point to the directory containing the
1280
# control directory, but was not used - now it's just the transport
1281
# for the branch control files. mbp 20070212
2381
1282
self._base = self.bzrdir.transport.clone('..').base
2383
# XXX: We should be able to just do
2384
# self.base = self.bzrdir.root_transport.base
2385
# but this does not quite work yet -- mbp 20080522
2386
1283
self._format = _format
2387
1284
if _control_files is None:
2388
1285
raise ValueError('BzrBranch _control_files is None')
2389
1286
self.control_files = _control_files
2390
1287
self._transport = _control_files._transport
2391
1288
self.repository = _repository
2392
Branch.__init__(self)
2394
1290
def __str__(self):
2395
if self.name is None:
2396
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2398
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
1291
return '%s(%r)' % (self.__class__.__name__, self.base)
2401
1293
__repr__ = __str__
2595
1430
:param other_branch: The other branch that DivergedBranches should
2596
1431
raise with respect to.
2598
self._set_revision_history(self._lefthand_history(revision_id,
1433
self.set_revision_history(self._lefthand_history(revision_id,
2599
1434
last_rev, other_branch))
1437
def update_revisions(self, other, stop_revision=None):
1438
"""See Branch.update_revisions."""
1441
if stop_revision is None:
1442
stop_revision = other.last_revision()
1443
if stop_revision is None:
1444
# if there are no commits, we're done.
1446
# whats the current last revision, before we fetch [and change it
1448
last_rev = _mod_revision.ensure_null(self.last_revision())
1449
# we fetch here so that we don't process data twice in the common
1450
# case of having something to pull, and so that the check for
1451
# already merged can operate on the just fetched graph, which will
1452
# be cached in memory.
1453
self.fetch(other, stop_revision)
1454
if self.repository.get_graph().is_ancestor(stop_revision,
1457
self.generate_revision_history(stop_revision, last_rev=last_rev,
2601
1462
def basis_tree(self):
2602
1463
"""See Branch.basis_tree."""
2603
1464
return self.repository.revision_tree(self.last_revision())
1467
def pull(self, source, overwrite=False, stop_revision=None,
1468
_hook_master=None, run_hooks=True, possible_transports=None):
1471
:param _hook_master: Private parameter - set the branch to
1472
be supplied as the master to push hooks.
1473
:param run_hooks: Private parameter - if false, this branch
1474
is being called because it's the master of the primary branch,
1475
so it should not run its hooks.
1477
result = PullResult()
1478
result.source_branch = source
1479
result.target_branch = self
1482
result.old_revno, result.old_revid = self.last_revision_info()
1484
self.update_revisions(source, stop_revision)
1485
except DivergedBranches:
1489
if stop_revision is None:
1490
stop_revision = source.last_revision()
1491
self.generate_revision_history(stop_revision)
1492
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1493
result.new_revno, result.new_revid = self.last_revision_info()
1495
result.master_branch = _hook_master
1496
result.local_branch = self
1498
result.master_branch = self
1499
result.local_branch = None
1501
for hook in Branch.hooks['post_pull']:
2605
1507
def _get_parent_location(self):
2606
1508
_locs = ['parent', 'pull', 'x-pull']
2607
1509
for l in _locs:
2609
return self._transport.get_bytes(l).strip('\n')
2610
except errors.NoSuchFile:
1511
return self.control_files.get(l).read().strip('\n')
1517
def push(self, target, overwrite=False, stop_revision=None,
1518
_override_hook_source_branch=None):
1521
This is the basic concrete implementation of push()
1523
:param _override_hook_source_branch: If specified, run
1524
the hooks passing this Branch as the source, rather than self.
1525
This is for use of RemoteBranch, where push is delegated to the
1526
underlying vfs-based Branch.
1528
# TODO: Public option to disable running hooks - should be trivial but
1532
result = self._push_with_bound_branches(target, overwrite,
1534
_override_hook_source_branch=_override_hook_source_branch)
1539
def _push_with_bound_branches(self, target, overwrite,
1541
_override_hook_source_branch=None):
1542
"""Push from self into target, and into target's master if any.
1544
This is on the base BzrBranch class even though it doesn't support
1545
bound branches because the *target* might be bound.
1548
if _override_hook_source_branch:
1549
result.source_branch = _override_hook_source_branch
1550
for hook in Branch.hooks['post_push']:
1553
bound_location = target.get_bound_location()
1554
if bound_location and target.base != bound_location:
1555
# there is a master branch.
1557
# XXX: Why the second check? Is it even supported for a branch to
1558
# be bound to itself? -- mbp 20070507
1559
master_branch = target.get_master_branch()
1560
master_branch.lock_write()
1562
# push into the master from this branch.
1563
self._basic_push(master_branch, overwrite, stop_revision)
1564
# and push into the target branch from this. Note that we push from
1565
# this branch again, because its considered the highest bandwidth
1567
result = self._basic_push(target, overwrite, stop_revision)
1568
result.master_branch = master_branch
1569
result.local_branch = target
1573
master_branch.unlock()
1576
result = self._basic_push(target, overwrite, stop_revision)
1577
# TODO: Why set master_branch and local_branch if there's no
1578
# binding? Maybe cleaner to just leave them unset? -- mbp
1580
result.master_branch = target
1581
result.local_branch = None
2614
1585
def _basic_push(self, target, overwrite, stop_revision):
2615
1586
"""Basic implementation of push without bound branches or hooks.
2617
Must be called with source read locked and target write locked.
1588
Must be called with self read locked and target write locked.
2619
result = BranchPushResult()
1590
result = PushResult()
2620
1591
result.source_branch = self
2621
1592
result.target_branch = target
2622
1593
result.old_revno, result.old_revid = target.last_revision_info()
2623
self.update_references(target)
2624
if result.old_revid != stop_revision:
2625
# We assume that during 'push' this repository is closer than
2627
graph = self.repository.get_graph(target.repository)
2628
target.update_revisions(self, stop_revision,
2629
overwrite=overwrite, graph=graph)
2630
if self._push_should_merge_tags():
2631
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1595
target.update_revisions(self, stop_revision)
1596
except DivergedBranches:
1600
target.set_revision_history(self.revision_history())
1601
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2632
1602
result.new_revno, result.new_revid = target.last_revision_info()
2635
def get_stacked_on_url(self):
2636
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1605
def get_parent(self):
1606
"""See Branch.get_parent."""
1608
assert self.base[-1] == '/'
1609
parent = self._get_parent_location()
1612
# This is an old-format absolute path to a local branch
1613
# turn it into a url
1614
if parent.startswith('/'):
1615
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1617
return urlutils.join(self.base[:-1], parent)
1618
except errors.InvalidURLJoin, e:
1619
raise errors.InaccessibleParent(parent, self.base)
2638
1621
def set_push_location(self, location):
2639
1622
"""See Branch.set_push_location."""
2752
class BzrBranch8(BzrBranch5):
2753
"""A branch that stores tree-reference locations."""
2755
def _open_hook(self):
2756
if self._ignore_fallbacks:
1804
class BzrBranchExperimental(BzrBranch5):
1805
"""Bzr experimental branch format
1808
- a revision-history file.
1810
- a lock dir guarding the branch itself
1811
- all of this stored in a branch/ subdirectory
1812
- works with shared repositories.
1813
- a tag dictionary in the branch
1815
This format is new in bzr 0.15, but shouldn't be used for real data,
1818
This class acts as it's own BranchFormat.
1821
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1824
def get_format_string(cls):
1825
"""See BranchFormat.get_format_string()."""
1826
return "Bazaar-NG branch format experimental\n"
1829
def get_format_description(cls):
1830
"""See BranchFormat.get_format_description()."""
1831
return "Experimental branch format"
1834
def get_reference(cls, a_bzrdir):
1835
"""Get the target reference of the branch in a_bzrdir.
1837
format probing must have been completed before calling
1838
this method - it is assumed that the format of the branch
1839
in a_bzrdir is correct.
1841
:param a_bzrdir: The bzrdir to get the branch data from.
1842
:return: None if the branch is not a reference branch.
1847
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1849
branch_transport = a_bzrdir.get_branch_transport(cls)
1850
control_files = lockable_files.LockableFiles(branch_transport,
1851
lock_filename, lock_class)
1852
control_files.create_lock()
1853
control_files.lock_write()
2759
url = self.get_stacked_on_url()
2760
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2761
errors.UnstackableBranchFormat):
2764
for hook in Branch.hooks['transform_fallback_location']:
2765
url = hook(self, url)
2767
hook_name = Branch.hooks.get_hook_name(hook)
2768
raise AssertionError(
2769
"'transform_fallback_location' hook %s returned "
2770
"None, not a URL." % hook_name)
2771
self._activate_fallback_location(url)
2773
def __init__(self, *args, **kwargs):
2774
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2775
super(BzrBranch8, self).__init__(*args, **kwargs)
2776
self._last_revision_info_cache = None
2777
self._reference_info = None
2779
def _clear_cached_state(self):
2780
super(BzrBranch8, self)._clear_cached_state()
2781
self._last_revision_info_cache = None
2782
self._reference_info = None
2784
def _last_revision_info(self):
2785
revision_string = self._transport.get_bytes('last-revision')
1855
for filename, content in utf8_files:
1856
control_files.put_utf8(filename, content)
1858
control_files.unlock()
1861
def initialize(cls, a_bzrdir):
1862
"""Create a branch of this format in a_bzrdir."""
1863
utf8_files = [('format', cls.get_format_string()),
1864
('revision-history', ''),
1865
('branch-name', ''),
1868
cls._initialize_control_files(a_bzrdir, utf8_files,
1869
'lock', lockdir.LockDir)
1870
return cls.open(a_bzrdir, _found=True)
1873
def open(cls, a_bzrdir, _found=False):
1874
"""Return the branch object for a_bzrdir
1876
_found is a private parameter, do not use it. It is used to indicate
1877
if format probing has already be done.
1880
format = BranchFormat.find_format(a_bzrdir)
1881
assert format.__class__ == cls
1882
transport = a_bzrdir.get_branch_transport(None)
1883
control_files = lockable_files.LockableFiles(transport, 'lock',
1885
return cls(_format=cls,
1886
_control_files=control_files,
1888
_repository=a_bzrdir.find_repository())
1891
def is_supported(cls):
1894
def _make_tags(self):
1895
return BasicTags(self)
1898
def supports_tags(cls):
1902
BranchFormat.register_format(BzrBranchExperimental)
1905
class BzrBranch6(BzrBranch5):
1908
def last_revision_info(self):
1909
revision_string = self.control_files.get('last-revision').read()
2786
1910
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2787
1911
revision_id = cache_utf8.get_cached_utf8(revision_id)
2788
1912
revno = int(revno)
2789
1913
return revno, revision_id
1915
def last_revision(self):
1916
"""Return last revision id, or None"""
1917
revision_id = self.last_revision_info()[1]
2791
1920
def _write_last_revision_info(self, revno, revision_id):
2792
1921
"""Simply write out the revision id, with no checks.
2981
2017
"""See Branch.get_old_bound_location"""
2982
2018
return self._get_bound_location(False)
2984
def get_stacked_on_url(self):
2985
# you can always ask for the URL; but you might not be able to use it
2986
# if the repo can't support stacking.
2987
## self._check_stackable_repo()
2988
stacked_url = self._get_config_location('stacked_on_location')
2989
if stacked_url is None:
2990
raise errors.NotStacked(self)
2020
def set_append_revisions_only(self, enabled):
2025
self.get_config().set_user_option('append_revisions_only', value,
2993
2028
def _get_append_revisions_only(self):
2994
return self.get_config(
2995
).get_user_option_as_bool('append_revisions_only')
2998
def generate_revision_history(self, revision_id, last_rev=None,
3000
"""See BzrBranch5.generate_revision_history"""
3001
history = self._lefthand_history(revision_id, last_rev, other_branch)
3002
revno = len(history)
3003
self.set_last_revision_info(revno, revision_id)
3006
def get_rev_id(self, revno, history=None):
3007
"""Find the revision id of the specified revno."""
3009
return _mod_revision.NULL_REVISION
3011
last_revno, last_revision_id = self.last_revision_info()
3012
if revno <= 0 or revno > last_revno:
3013
raise errors.NoSuchRevision(self, revno)
3015
if history is not None:
3016
return history[revno - 1]
3018
index = last_revno - revno
3019
if len(self._partial_revision_history_cache) <= index:
3020
self._extend_partial_history(stop_index=index)
3021
if len(self._partial_revision_history_cache) > index:
3022
return self._partial_revision_history_cache[index]
2029
value = self.get_config().get_user_option('append_revisions_only')
2030
return value == 'True'
2032
def _synchronize_history(self, destination, revision_id):
2033
"""Synchronize last revision and revision history between branches.
2035
This version is most efficient when the destination is also a
2036
BzrBranch6, but works for BzrBranch5, as long as the destination's
2037
repository contains all the lefthand ancestors of the intended
2038
last_revision. If not, set_last_revision_info will fail.
2040
:param destination: The branch to copy the history into
2041
:param revision_id: The revision-id to truncate history at. May
2042
be None to copy complete history.
2044
source_revno, source_revision_id = self.last_revision_info()
2045
if revision_id is None:
2046
revno, revision_id = source_revno, source_revision_id
2047
elif source_revision_id == revision_id:
2048
# we know the revno without needing to walk all of history
2049
revno = source_revno
3024
raise errors.NoSuchRevision(self, revno)
3027
def revision_id_to_revno(self, revision_id):
3028
"""Given a revision id, return its revno"""
3029
if _mod_revision.is_null(revision_id):
3032
index = self._partial_revision_history_cache.index(revision_id)
3035
self._extend_partial_history(stop_revision=revision_id)
3036
except errors.RevisionNotPresent, e:
3037
raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
3038
index = len(self._partial_revision_history_cache) - 1
3039
if self._partial_revision_history_cache[index] != revision_id:
3040
raise errors.NoSuchRevision(self, revision_id)
3041
return self.revno() - index
3044
class BzrBranch7(BzrBranch8):
3045
"""A branch with support for a fallback repository."""
3047
def set_reference_info(self, file_id, tree_path, branch_location):
3048
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3050
def get_reference_info(self, file_id):
3051
Branch.get_reference_info(self, file_id)
3053
def reference_parent(self, file_id, path, possible_transports=None):
3054
return Branch.reference_parent(self, file_id, path,
3055
possible_transports)
3058
class BzrBranch6(BzrBranch7):
3059
"""See BzrBranchFormat6 for the capabilities of this branch.
3061
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
3065
def get_stacked_on_url(self):
3066
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2051
# To figure out the revno for a random revision, we need to build
2052
# the revision history, and count its length.
2053
# We don't care about the order, just how long it is.
2054
# Alternatively, we could start at the current location, and count
2055
# backwards. But there is no guarantee that we will find it since
2056
# it may be a merged revision.
2057
revno = len(list(self.repository.iter_reverse_revision_history(
2059
destination.set_last_revision_info(revno, revision_id)
2061
def _make_tags(self):
2062
return BasicTags(self)
3069
2065
######################################################################
3188
2163
new_branch.tags._set_tag_dict({})
3190
2165
# Copying done; now update target format
3191
new_branch._transport.put_bytes('format',
3192
format.get_format_string(),
3193
mode=new_branch.bzrdir._get_file_mode())
2166
new_branch.control_files.put_utf8('format',
2167
format.get_format_string())
3195
2169
# Clean up old files
3196
new_branch._transport.delete('revision-history')
2170
new_branch.control_files._transport.delete('revision-history')
3198
2172
branch.set_parent(None)
3199
except errors.NoSuchFile:
3201
2175
branch.set_bound_location(None)
3204
class Converter6to7(object):
3205
"""Perform an in-place upgrade of format 6 to format 7"""
3207
def convert(self, branch):
3208
format = BzrBranchFormat7()
3209
branch._set_config_location('stacked_on_location', '')
3210
# update target format
3211
branch._transport.put_bytes('format', format.get_format_string())
3214
class Converter7to8(object):
3215
"""Perform an in-place upgrade of format 6 to format 7"""
3217
def convert(self, branch):
3218
format = BzrBranchFormat8()
3219
branch._transport.put_bytes('references', '')
3220
# update target format
3221
branch._transport.put_bytes('format', format.get_format_string())
3224
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3225
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3228
_run_with_write_locked_target will attempt to release the lock it acquires.
3230
If an exception is raised by callable, then that exception *will* be
3231
propagated, even if the unlock attempt raises its own error. Thus
3232
_run_with_write_locked_target should be preferred to simply doing::
3236
return callable(*args, **kwargs)
3241
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3242
# should share code?
3245
result = callable(*args, **kwargs)
3247
exc_info = sys.exc_info()
3251
raise exc_info[0], exc_info[1], exc_info[2]
3257
class InterBranch(InterObject):
3258
"""This class represents operations taking place between two branches.
3260
Its instances have methods like pull() and push() and contain
3261
references to the source and target repositories these operations
3262
can be carried out on.
3266
"""The available optimised InterBranch types."""
3269
def _get_branch_formats_to_test(klass):
3270
"""Return an iterable of format tuples for testing.
3272
:return: An iterable of (from_format, to_format) to use when testing
3273
this InterBranch class. Each InterBranch class should define this
3276
raise NotImplementedError(klass._get_branch_formats_to_test)
3279
def pull(self, overwrite=False, stop_revision=None,
3280
possible_transports=None, local=False):
3281
"""Mirror source into target branch.
3283
The target branch is considered to be 'local', having low latency.
3285
:returns: PullResult instance
3287
raise NotImplementedError(self.pull)
3290
def update_revisions(self, stop_revision=None, overwrite=False,
3292
"""Pull in new perfect-fit revisions.
3294
:param stop_revision: Updated until the given revision
3295
:param overwrite: Always set the branch pointer, rather than checking
3296
to see if it is a proper descendant.
3297
:param graph: A Graph object that can be used to query history
3298
information. This can be None.
3301
raise NotImplementedError(self.update_revisions)
3304
def push(self, overwrite=False, stop_revision=None,
3305
_override_hook_source_branch=None):
3306
"""Mirror the source branch into the target branch.
3308
The source branch is considered to be 'local', having low latency.
3310
raise NotImplementedError(self.push)
3313
def copy_content_into(self, revision_id=None):
3314
"""Copy the content of source into target
3316
revision_id: if not None, the revision history in the new branch will
3317
be truncated to end with revision_id.
3319
raise NotImplementedError(self.copy_content_into)
3322
def fetch(self, stop_revision=None):
3325
:param stop_revision: Last revision to fetch
3327
raise NotImplementedError(self.fetch)
3330
class GenericInterBranch(InterBranch):
3331
"""InterBranch implementation that uses public Branch functions."""
3334
def is_compatible(klass, source, target):
3335
# GenericBranch uses the public API, so always compatible
3339
def _get_branch_formats_to_test(klass):
3340
return [(format_registry.get_default(), format_registry.get_default())]
3343
def unwrap_format(klass, format):
3344
if isinstance(format, remote.RemoteBranchFormat):
3345
format._ensure_real()
3346
return format._custom_format
3350
def copy_content_into(self, revision_id=None):
3351
"""Copy the content of source into target
3353
revision_id: if not None, the revision history in the new branch will
3354
be truncated to end with revision_id.
3356
self.source.update_references(self.target)
3357
self.source._synchronize_history(self.target, revision_id)
3359
parent = self.source.get_parent()
3360
except errors.InaccessibleParent, e:
3361
mutter('parent was not accessible to copy: %s', e)
3364
self.target.set_parent(parent)
3365
if self.source._push_should_merge_tags():
3366
self.source.tags.merge_to(self.target.tags)
3369
def fetch(self, stop_revision=None):
3370
if self.target.base == self.source.base:
3372
self.source.lock_read()
3374
fetch_spec_factory = fetch.FetchSpecFactory()
3375
fetch_spec_factory.source_branch = self.source
3376
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3377
fetch_spec_factory.source_repo = self.source.repository
3378
fetch_spec_factory.target_repo = self.target.repository
3379
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3380
fetch_spec = fetch_spec_factory.make_fetch_spec()
3381
return self.target.repository.fetch(self.source.repository,
3382
fetch_spec=fetch_spec)
3384
self.source.unlock()
3387
def update_revisions(self, stop_revision=None, overwrite=False,
3389
"""See InterBranch.update_revisions()."""
3390
other_revno, other_last_revision = self.source.last_revision_info()
3391
stop_revno = None # unknown
3392
if stop_revision is None:
3393
stop_revision = other_last_revision
3394
if _mod_revision.is_null(stop_revision):
3395
# if there are no commits, we're done.
3397
stop_revno = other_revno
3399
# what's the current last revision, before we fetch [and change it
3401
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3402
# we fetch here so that we don't process data twice in the common
3403
# case of having something to pull, and so that the check for
3404
# already merged can operate on the just fetched graph, which will
3405
# be cached in memory.
3406
self.fetch(stop_revision=stop_revision)
3407
# Check to see if one is an ancestor of the other
3410
graph = self.target.repository.get_graph()
3411
if self.target._check_if_descendant_or_diverged(
3412
stop_revision, last_rev, graph, self.source):
3413
# stop_revision is a descendant of last_rev, but we aren't
3414
# overwriting, so we're done.
3416
if stop_revno is None:
3418
graph = self.target.repository.get_graph()
3419
this_revno, this_last_revision = \
3420
self.target.last_revision_info()
3421
stop_revno = graph.find_distance_to_null(stop_revision,
3422
[(other_last_revision, other_revno),
3423
(this_last_revision, this_revno)])
3424
self.target.set_last_revision_info(stop_revno, stop_revision)
3427
def pull(self, overwrite=False, stop_revision=None,
3428
possible_transports=None, run_hooks=True,
3429
_override_hook_target=None, local=False):
3430
"""Pull from source into self, updating my master if any.
3432
:param run_hooks: Private parameter - if false, this branch
3433
is being called because it's the master of the primary branch,
3434
so it should not run its hooks.
3436
bound_location = self.target.get_bound_location()
3437
if local and not bound_location:
3438
raise errors.LocalRequiresBoundBranch()
3439
master_branch = None
3440
source_is_master = (self.source.user_url == bound_location)
3441
if not local and bound_location and not source_is_master:
3442
# not pulling from master, so we need to update master.
3443
master_branch = self.target.get_master_branch(possible_transports)
3444
master_branch.lock_write()
3447
# pull from source into master.
3448
master_branch.pull(self.source, overwrite, stop_revision,
3450
return self._pull(overwrite,
3451
stop_revision, _hook_master=master_branch,
3452
run_hooks=run_hooks,
3453
_override_hook_target=_override_hook_target,
3454
merge_tags_to_master=not source_is_master)
3457
master_branch.unlock()
3459
def push(self, overwrite=False, stop_revision=None,
3460
_override_hook_source_branch=None):
3461
"""See InterBranch.push.
3463
This is the basic concrete implementation of push()
3465
:param _override_hook_source_branch: If specified, run
3466
the hooks passing this Branch as the source, rather than self.
3467
This is for use of RemoteBranch, where push is delegated to the
3468
underlying vfs-based Branch.
3470
# TODO: Public option to disable running hooks - should be trivial but
3472
self.source.lock_read()
3474
return _run_with_write_locked_target(
3475
self.target, self._push_with_bound_branches, overwrite,
3477
_override_hook_source_branch=_override_hook_source_branch)
3479
self.source.unlock()
3481
def _push_with_bound_branches(self, overwrite, stop_revision,
3482
_override_hook_source_branch=None):
3483
"""Push from source into target, and into target's master if any.
3486
if _override_hook_source_branch:
3487
result.source_branch = _override_hook_source_branch
3488
for hook in Branch.hooks['post_push']:
3491
bound_location = self.target.get_bound_location()
3492
if bound_location and self.target.base != bound_location:
3493
# there is a master branch.
3495
# XXX: Why the second check? Is it even supported for a branch to
3496
# be bound to itself? -- mbp 20070507
3497
master_branch = self.target.get_master_branch()
3498
master_branch.lock_write()
3500
# push into the master from the source branch.
3501
self.source._basic_push(master_branch, overwrite, stop_revision)
3502
# and push into the target branch from the source. Note that we
3503
# push from the source branch again, because it's considered the
3504
# highest bandwidth repository.
3505
result = self.source._basic_push(self.target, overwrite,
3507
result.master_branch = master_branch
3508
result.local_branch = self.target
3512
master_branch.unlock()
3515
result = self.source._basic_push(self.target, overwrite,
3517
# TODO: Why set master_branch and local_branch if there's no
3518
# binding? Maybe cleaner to just leave them unset? -- mbp
3520
result.master_branch = self.target
3521
result.local_branch = None
3525
def _pull(self, overwrite=False, stop_revision=None,
3526
possible_transports=None, _hook_master=None, run_hooks=True,
3527
_override_hook_target=None, local=False,
3528
merge_tags_to_master=True):
3531
This function is the core worker, used by GenericInterBranch.pull to
3532
avoid duplication when pulling source->master and source->local.
3534
:param _hook_master: Private parameter - set the branch to
3535
be supplied as the master to pull hooks.
3536
:param run_hooks: Private parameter - if false, this branch
3537
is being called because it's the master of the primary branch,
3538
so it should not run its hooks.
3539
is being called because it's the master of the primary branch,
3540
so it should not run its hooks.
3541
:param _override_hook_target: Private parameter - set the branch to be
3542
supplied as the target_branch to pull hooks.
3543
:param local: Only update the local branch, and not the bound branch.
3545
# This type of branch can't be bound.
3547
raise errors.LocalRequiresBoundBranch()
3548
result = PullResult()
3549
result.source_branch = self.source
3550
if _override_hook_target is None:
3551
result.target_branch = self.target
3553
result.target_branch = _override_hook_target
3554
self.source.lock_read()
3556
# We assume that during 'pull' the target repository is closer than
3558
self.source.update_references(self.target)
3559
graph = self.target.repository.get_graph(self.source.repository)
3560
# TODO: Branch formats should have a flag that indicates
3561
# that revno's are expensive, and pull() should honor that flag.
3563
result.old_revno, result.old_revid = \
3564
self.target.last_revision_info()
3565
self.target.update_revisions(self.source, stop_revision,
3566
overwrite=overwrite, graph=graph)
3567
# TODO: The old revid should be specified when merging tags,
3568
# so a tags implementation that versions tags can only
3569
# pull in the most recent changes. -- JRV20090506
3570
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3571
overwrite, ignore_master=not merge_tags_to_master)
3572
result.new_revno, result.new_revid = self.target.last_revision_info()
3574
result.master_branch = _hook_master
3575
result.local_branch = result.target_branch
3577
result.master_branch = result.target_branch
3578
result.local_branch = None
3580
for hook in Branch.hooks['post_pull']:
3583
self.source.unlock()
3587
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
