132
188
possible_transports)
133
189
return control.open_branch(), relpath
191
def _push_should_merge_tags(self):
192
"""Should _basic_push merge this branch's tags into the target?
194
The default implementation returns False if this branch has no tags,
195
and True the rest of the time. Subclasses may override this.
197
return self.supports_tags() and self.tags.get_tag_dict()
135
199
def get_config(self):
136
200
return BranchConfig(self)
139
return self.get_config().get_nickname()
202
def _get_config(self):
203
"""Get the concrete config for just the config in this branch.
205
This is not intended for client use; see Branch.get_config for the
210
:return: An object supporting get_option and set_option.
212
raise NotImplementedError(self._get_config)
214
def _get_fallback_repository(self, url):
215
"""Get the repository we fallback to at url."""
216
url = urlutils.join(self.base, url)
217
a_branch = Branch.open(url,
218
possible_transports=[self.bzrdir.root_transport])
219
return a_branch.repository
221
def _get_tags_bytes(self):
222
"""Get the bytes of a serialised tags dict.
224
Note that not all branches support tags, nor do all use the same tags
225
logic: this method is specific to BasicTags. Other tag implementations
226
may use the same method name and behave differently, safely, because
227
of the double-dispatch via
228
format.make_tags->tags_instance->get_tags_dict.
230
:return: The bytes of the tags file.
231
:seealso: Branch._set_tags_bytes.
233
return self._transport.get_bytes('tags')
235
def _get_nick(self, local=False, possible_transports=None):
236
config = self.get_config()
237
# explicit overrides master, but don't look for master if local is True
238
if not local and not config.has_explicit_nickname():
240
master = self.get_master_branch(possible_transports)
241
if master is not None:
242
# return the master branch value
244
except errors.BzrError, e:
245
# Silently fall back to local implicit nick if the master is
247
mutter("Could not connect to bound branch, "
248
"falling back to local nick.\n " + str(e))
249
return config.get_nickname()
141
251
def _set_nick(self, nick):
142
252
self.get_config().set_user_option('nickname', nick, warn_masked=True)
163
300
raise NotImplementedError(self.get_physical_lock_status)
303
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
304
"""Return the revision_id for a dotted revno.
306
:param revno: a tuple like (1,) or (1,1,2)
307
:param _cache_reverse: a private parameter enabling storage
308
of the reverse mapping in a top level cache. (This should
309
only be done in selective circumstances as we want to
310
avoid having the mapping cached multiple times.)
311
:return: the revision_id
312
:raises errors.NoSuchRevision: if the revno doesn't exist
314
rev_id = self._do_dotted_revno_to_revision_id(revno)
316
self._partial_revision_id_to_revno_cache[rev_id] = revno
319
def _do_dotted_revno_to_revision_id(self, revno):
320
"""Worker function for dotted_revno_to_revision_id.
322
Subclasses should override this if they wish to
323
provide a more efficient implementation.
326
return self.get_rev_id(revno[0])
327
revision_id_to_revno = self.get_revision_id_to_revno_map()
328
revision_ids = [revision_id for revision_id, this_revno
329
in revision_id_to_revno.iteritems()
330
if revno == this_revno]
331
if len(revision_ids) == 1:
332
return revision_ids[0]
334
revno_str = '.'.join(map(str, revno))
335
raise errors.NoSuchRevision(self, revno_str)
338
def revision_id_to_dotted_revno(self, revision_id):
339
"""Given a revision id, return its dotted revno.
341
:return: a tuple like (1,) or (400,1,3).
343
return self._do_revision_id_to_dotted_revno(revision_id)
345
def _do_revision_id_to_dotted_revno(self, revision_id):
346
"""Worker function for revision_id_to_revno."""
347
# Try the caches if they are loaded
348
result = self._partial_revision_id_to_revno_cache.get(revision_id)
349
if result is not None:
351
if self._revision_id_to_revno_cache:
352
result = self._revision_id_to_revno_cache.get(revision_id)
354
raise errors.NoSuchRevision(self, revision_id)
355
# Try the mainline as it's optimised
357
revno = self.revision_id_to_revno(revision_id)
359
except errors.NoSuchRevision:
360
# We need to load and use the full revno map after all
361
result = self.get_revision_id_to_revno_map().get(revision_id)
363
raise errors.NoSuchRevision(self, revision_id)
166
367
def get_revision_id_to_revno_map(self):
167
368
"""Return the revision_id => dotted revno map.
193
394
:return: A dictionary mapping revision_id => dotted revno.
195
last_revision = self.last_revision()
196
revision_graph = repository._old_get_graph(self.repository,
198
merge_sorted_revisions = tsort.merge_sort(
203
396
revision_id_to_revno = dict((rev_id, revno)
204
for seq_num, rev_id, depth, revno, end_of_merge
205
in merge_sorted_revisions)
397
for rev_id, depth, revno, end_of_merge
398
in self.iter_merge_sorted_revisions())
206
399
return revision_id_to_revno
402
def iter_merge_sorted_revisions(self, start_revision_id=None,
403
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
404
"""Walk the revisions for a branch in merge sorted order.
406
Merge sorted order is the output from a merge-aware,
407
topological sort, i.e. all parents come before their
408
children going forward; the opposite for reverse.
410
:param start_revision_id: the revision_id to begin walking from.
411
If None, the branch tip is used.
412
:param stop_revision_id: the revision_id to terminate the walk
413
after. If None, the rest of history is included.
414
:param stop_rule: if stop_revision_id is not None, the precise rule
415
to use for termination:
416
* 'exclude' - leave the stop revision out of the result (default)
417
* 'include' - the stop revision is the last item in the result
418
* 'with-merges' - include the stop revision and all of its
419
merged revisions in the result
420
* 'with-merges-without-common-ancestry' - filter out revisions
421
that are in both ancestries
422
:param direction: either 'reverse' or 'forward':
423
* reverse means return the start_revision_id first, i.e.
424
start at the most recent revision and go backwards in history
425
* forward returns tuples in the opposite order to reverse.
426
Note in particular that forward does *not* do any intelligent
427
ordering w.r.t. depth as some clients of this API may like.
428
(If required, that ought to be done at higher layers.)
430
:return: an iterator over (revision_id, depth, revno, end_of_merge)
433
* revision_id: the unique id of the revision
434
* depth: How many levels of merging deep this node has been
436
* revno_sequence: This field provides a sequence of
437
revision numbers for all revisions. The format is:
438
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
439
branch that the revno is on. From left to right the REVNO numbers
440
are the sequence numbers within that branch of the revision.
441
* end_of_merge: When True the next node (earlier in history) is
442
part of a different merge.
444
# Note: depth and revno values are in the context of the branch so
445
# we need the full graph to get stable numbers, regardless of the
447
if self._merge_sorted_revisions_cache is None:
448
last_revision = self.last_revision()
449
known_graph = self.repository.get_known_graph_ancestry(
451
self._merge_sorted_revisions_cache = known_graph.merge_sort(
453
filtered = self._filter_merge_sorted_revisions(
454
self._merge_sorted_revisions_cache, start_revision_id,
455
stop_revision_id, stop_rule)
456
# Make sure we don't return revisions that are not part of the
457
# start_revision_id ancestry.
458
filtered = self._filter_start_non_ancestors(filtered)
459
if direction == 'reverse':
461
if direction == 'forward':
462
return reversed(list(filtered))
464
raise ValueError('invalid direction %r' % direction)
466
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
467
start_revision_id, stop_revision_id, stop_rule):
468
"""Iterate over an inclusive range of sorted revisions."""
469
rev_iter = iter(merge_sorted_revisions)
470
if start_revision_id is not None:
471
for node in rev_iter:
472
rev_id = node.key[-1]
473
if rev_id != start_revision_id:
476
# The decision to include the start or not
477
# depends on the stop_rule if a stop is provided
478
# so pop this node back into the iterator
479
rev_iter = chain(iter([node]), rev_iter)
481
if stop_revision_id is None:
483
for node in rev_iter:
484
rev_id = node.key[-1]
485
yield (rev_id, node.merge_depth, node.revno,
487
elif stop_rule == 'exclude':
488
for node in rev_iter:
489
rev_id = node.key[-1]
490
if rev_id == stop_revision_id:
492
yield (rev_id, node.merge_depth, node.revno,
494
elif stop_rule == 'include':
495
for node in rev_iter:
496
rev_id = node.key[-1]
497
yield (rev_id, node.merge_depth, node.revno,
499
if rev_id == stop_revision_id:
501
elif stop_rule == 'with-merges-without-common-ancestry':
502
# We want to exclude all revisions that are already part of the
503
# stop_revision_id ancestry.
504
graph = self.repository.get_graph()
505
ancestors = graph.find_unique_ancestors(start_revision_id,
507
for node in rev_iter:
508
rev_id = node.key[-1]
509
if rev_id not in ancestors:
511
yield (rev_id, node.merge_depth, node.revno,
513
elif stop_rule == 'with-merges':
514
stop_rev = self.repository.get_revision(stop_revision_id)
515
if stop_rev.parent_ids:
516
left_parent = stop_rev.parent_ids[0]
518
left_parent = _mod_revision.NULL_REVISION
519
# left_parent is the actual revision we want to stop logging at,
520
# since we want to show the merged revisions after the stop_rev too
521
reached_stop_revision_id = False
522
revision_id_whitelist = []
523
for node in rev_iter:
524
rev_id = node.key[-1]
525
if rev_id == left_parent:
526
# reached the left parent after the stop_revision
528
if (not reached_stop_revision_id or
529
rev_id in revision_id_whitelist):
530
yield (rev_id, node.merge_depth, node.revno,
532
if reached_stop_revision_id or rev_id == stop_revision_id:
533
# only do the merged revs of rev_id from now on
534
rev = self.repository.get_revision(rev_id)
536
reached_stop_revision_id = True
537
revision_id_whitelist.extend(rev.parent_ids)
539
raise ValueError('invalid stop_rule %r' % stop_rule)
541
def _filter_start_non_ancestors(self, rev_iter):
542
# If we started from a dotted revno, we want to consider it as a tip
543
# and don't want to yield revisions that are not part of its
544
# ancestry. Given the order guaranteed by the merge sort, we will see
545
# uninteresting descendants of the first parent of our tip before the
547
first = rev_iter.next()
548
(rev_id, merge_depth, revno, end_of_merge) = first
551
# We start at a mainline revision so by definition, all others
552
# revisions in rev_iter are ancestors
553
for node in rev_iter:
558
pmap = self.repository.get_parent_map([rev_id])
559
parents = pmap.get(rev_id, [])
561
whitelist.update(parents)
563
# If there is no parents, there is nothing of interest left
565
# FIXME: It's hard to test this scenario here as this code is never
566
# called in that case. -- vila 20100322
569
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
571
if rev_id in whitelist:
572
pmap = self.repository.get_parent_map([rev_id])
573
parents = pmap.get(rev_id, [])
574
whitelist.remove(rev_id)
575
whitelist.update(parents)
577
# We've reached the mainline, there is nothing left to
581
# A revision that is not part of the ancestry of our
584
yield (rev_id, merge_depth, revno, end_of_merge)
208
586
def leave_lock_in_place(self):
209
587
"""Tell this branch object not to release the physical lock when this
210
588
object is unlocked.
212
590
If lock_write doesn't return a token, then this method is not supported.
214
592
self.control_files.leave_in_place()
339
719
def set_revision_history(self, rev_history):
340
720
raise NotImplementedError(self.set_revision_history)
723
def set_parent(self, url):
724
"""See Branch.set_parent."""
725
# TODO: Maybe delete old location files?
726
# URLs should never be unicode, even on the local fs,
727
# FIXUP this and get_parent in a future branch format bump:
728
# read and rewrite the file. RBC 20060125
730
if isinstance(url, unicode):
732
url = url.encode('ascii')
733
except UnicodeEncodeError:
734
raise errors.InvalidURL(url,
735
"Urls must be 7-bit ascii, "
736
"use bzrlib.urlutils.escape")
737
url = urlutils.relative_url(self.base, url)
738
self._set_parent_location(url)
741
def set_stacked_on_url(self, url):
742
"""Set the URL this branch is stacked against.
744
:raises UnstackableBranchFormat: If the branch does not support
746
:raises UnstackableRepositoryFormat: If the repository does not support
749
if not self._format.supports_stacking():
750
raise errors.UnstackableBranchFormat(self._format, self.user_url)
751
# XXX: Changing from one fallback repository to another does not check
752
# that all the data you need is present in the new fallback.
753
# Possibly it should.
754
self._check_stackable_repo()
757
old_url = self.get_stacked_on_url()
758
except (errors.NotStacked, errors.UnstackableBranchFormat,
759
errors.UnstackableRepositoryFormat):
763
self._activate_fallback_location(url)
764
# write this out after the repository is stacked to avoid setting a
765
# stacked config that doesn't work.
766
self._set_config_location('stacked_on_location', url)
769
"""Change a branch to be unstacked, copying data as needed.
771
Don't call this directly, use set_stacked_on_url(None).
773
pb = ui.ui_factory.nested_progress_bar()
775
pb.update("Unstacking")
776
# The basic approach here is to fetch the tip of the branch,
777
# including all available ghosts, from the existing stacked
778
# repository into a new repository object without the fallbacks.
780
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
781
# correct for CHKMap repostiories
782
old_repository = self.repository
783
if len(old_repository._fallback_repositories) != 1:
784
raise AssertionError("can't cope with fallback repositories "
785
"of %r" % (self.repository,))
786
# unlock it, including unlocking the fallback
787
old_repository.unlock()
788
old_repository.lock_read()
790
# Repositories don't offer an interface to remove fallback
791
# repositories today; take the conceptually simpler option and just
792
# reopen it. We reopen it starting from the URL so that we
793
# get a separate connection for RemoteRepositories and can
794
# stream from one of them to the other. This does mean doing
795
# separate SSH connection setup, but unstacking is not a
796
# common operation so it's tolerable.
797
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
798
new_repository = new_bzrdir.find_repository()
799
self.repository = new_repository
800
if self.repository._fallback_repositories:
801
raise AssertionError("didn't expect %r to have "
802
"fallback_repositories"
803
% (self.repository,))
804
# this is not paired with an unlock because it's just restoring
805
# the previous state; the lock's released when set_stacked_on_url
807
self.repository.lock_write()
808
# XXX: If you unstack a branch while it has a working tree
809
# with a pending merge, the pending-merged revisions will no
810
# longer be present. You can (probably) revert and remerge.
812
# XXX: This only fetches up to the tip of the repository; it
813
# doesn't bring across any tags. That's fairly consistent
814
# with how branch works, but perhaps not ideal.
815
self.repository.fetch(old_repository,
816
revision_id=self.last_revision(),
819
old_repository.unlock()
823
def _set_tags_bytes(self, bytes):
824
"""Mirror method for _get_tags_bytes.
826
:seealso: Branch._get_tags_bytes.
828
return _run_with_write_locked_target(self, self._transport.put_bytes,
342
831
def _cache_revision_history(self, rev_history):
343
832
"""Set the cached revision history to rev_history.
475
991
except ValueError:
476
992
raise errors.NoSuchRevision(self, revision_id)
478
995
def get_rev_id(self, revno, history=None):
479
996
"""Find the revision id of the specified revno."""
481
998
return _mod_revision.NULL_REVISION
483
history = self.revision_history()
484
if revno <= 0 or revno > len(history):
999
last_revno, last_revid = self.last_revision_info()
1000
if revno == last_revno:
1002
if revno <= 0 or revno > last_revno:
485
1003
raise errors.NoSuchRevision(self, revno)
486
return history[revno - 1]
1004
distance_from_last = last_revno - revno
1005
if len(self._partial_revision_history_cache) <= distance_from_last:
1006
self._extend_partial_history(distance_from_last)
1007
return self._partial_revision_history_cache[distance_from_last]
488
1010
def pull(self, source, overwrite=False, stop_revision=None,
489
possible_transports=None):
1011
possible_transports=None, *args, **kwargs):
490
1012
"""Mirror source into this branch.
492
1014
This branch is considered to be 'local', having low latency.
494
1016
:returns: PullResult instance
496
raise NotImplementedError(self.pull)
1018
return InterBranch.get(source, self).pull(overwrite=overwrite,
1019
stop_revision=stop_revision,
1020
possible_transports=possible_transports, *args, **kwargs)
498
def push(self, target, overwrite=False, stop_revision=None):
1022
def push(self, target, overwrite=False, stop_revision=None, *args,
499
1024
"""Mirror this branch into target.
501
1026
This branch is considered to be 'local', having low latency.
503
raise NotImplementedError(self.push)
1028
return InterBranch.get(self, target).push(overwrite, stop_revision,
1031
def lossy_push(self, target, stop_revision=None):
1032
"""Push deltas into another branch.
1034
:note: This does not, like push, retain the revision ids from
1035
the source branch and will, rather than adding bzr-specific
1036
metadata, push only those semantics of the revision that can be
1037
natively represented by this branch' VCS.
1039
:param target: Target branch
1040
:param stop_revision: Revision to push, defaults to last revision.
1041
:return: BranchPushResult with an extra member revidmap:
1042
A dictionary mapping revision ids from the target branch
1043
to new revision ids in the target branch, for each
1044
revision that was pushed.
1046
inter = InterBranch.get(self, target)
1047
lossy_push = getattr(inter, "lossy_push", None)
1048
if lossy_push is None:
1049
raise errors.LossyPushToSameVCS(self, target)
1050
return lossy_push(stop_revision)
505
1052
def basis_tree(self):
506
1053
"""Return `Tree` object for last revision."""
507
1054
return self.repository.revision_tree(self.last_revision())
509
def rename_one(self, from_rel, to_rel):
512
This can change the directory or the filename or both.
514
raise NotImplementedError(self.rename_one)
516
def move(self, from_paths, to_name):
519
to_name must exist as a versioned directory.
521
If to_name exists and is a directory, the files are moved into
522
it, keeping their old names. If it is a directory,
524
Note that to_name is only the last component of the new name;
525
this doesn't change the directory.
527
This returns a list of (from_path, to_path) pairs for each
530
raise NotImplementedError(self.move)
532
1056
def get_parent(self):
533
1057
"""Return the parent location of the branch.
535
This is the default location for push/pull/missing. The usual
1059
This is the default location for pull/missing. The usual
536
1060
pattern is that the user can override it by specifying a
539
raise NotImplementedError(self.get_parent)
1063
parent = self._get_parent_location()
1066
# This is an old-format absolute path to a local branch
1067
# turn it into a url
1068
if parent.startswith('/'):
1069
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1071
return urlutils.join(self.base[:-1], parent)
1072
except errors.InvalidURLJoin, e:
1073
raise errors.InaccessibleParent(parent, self.user_url)
1075
def _get_parent_location(self):
1076
raise NotImplementedError(self._get_parent_location)
541
1078
def _set_config_location(self, name, url, config=None,
542
1079
make_relative=False):
628
1188
raise errors.InvalidRevisionNumber(revno)
630
1190
@needs_read_lock
631
def clone(self, to_bzrdir, revision_id=None):
1191
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
632
1192
"""Clone this branch into to_bzrdir preserving all semantic values.
1194
Most API users will want 'create_clone_on_transport', which creates a
1195
new bzrdir and branch on the fly.
634
1197
revision_id: if not None, the revision history in the new branch will
635
1198
be truncated to end with revision_id.
637
result = self._format.initialize(to_bzrdir)
638
self.copy_content_into(result, revision_id=revision_id)
1200
result = to_bzrdir.create_branch()
1203
if repository_policy is not None:
1204
repository_policy.configure_branch(result)
1205
self.copy_content_into(result, revision_id=revision_id)
641
1210
@needs_read_lock
642
def sprout(self, to_bzrdir, revision_id=None):
1211
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
643
1212
"""Create a new line of development from the branch, into to_bzrdir.
1214
to_bzrdir controls the branch format.
645
1216
revision_id: if not None, the revision history in the new branch will
646
1217
be truncated to end with revision_id.
648
result = self._format.initialize(to_bzrdir)
649
self.copy_content_into(result, revision_id=revision_id)
650
result.set_parent(self.bzrdir.root_transport.base)
1219
if (repository_policy is not None and
1220
repository_policy.requires_stacking()):
1221
to_bzrdir._format.require_stacking(_skip_repo=True)
1222
result = to_bzrdir.create_branch()
1225
if repository_policy is not None:
1226
repository_policy.configure_branch(result)
1227
self.copy_content_into(result, revision_id=revision_id)
1228
result.set_parent(self.bzrdir.root_transport.base)
653
1233
def _synchronize_history(self, destination, revision_id):
654
1234
"""Synchronize last revision and revision history between branches.
656
1236
This version is most efficient when the destination is also a
657
BzrBranch5, but works for BzrBranch6 as long as the revision
658
history is the true lefthand parent history, and all of the revisions
659
are in the destination's repository. If not, set_revision_history
1237
BzrBranch6, but works for BzrBranch5, as long as the destination's
1238
repository contains all the lefthand ancestors of the intended
1239
last_revision. If not, set_last_revision_info will fail.
662
1241
:param destination: The branch to copy the history into
663
1242
:param revision_id: The revision-id to truncate history at. May
664
1243
be None to copy complete history.
666
if revision_id == _mod_revision.NULL_REVISION:
668
new_history = self.revision_history()
669
if revision_id is not None and new_history != []:
1245
source_revno, source_revision_id = self.last_revision_info()
1246
if revision_id is None:
1247
revno, revision_id = source_revno, source_revision_id
1249
graph = self.repository.get_graph()
671
new_history = new_history[:new_history.index(revision_id) + 1]
673
rev = self.repository.get_revision(revision_id)
674
new_history = rev.get_history(self.repository)[1:]
675
destination.set_revision_history(new_history)
1251
revno = graph.find_distance_to_null(revision_id,
1252
[(source_revision_id, source_revno)])
1253
except errors.GhostRevisionsHaveNoRevno:
1254
# Default to 1, if we can't find anything else
1256
destination.set_last_revision_info(revno, revision_id)
677
1258
@needs_read_lock
678
1259
def copy_content_into(self, destination, revision_id=None):
691
1273
destination.set_parent(parent)
692
self.tags.merge_to(destination.tags)
1274
if self._push_should_merge_tags():
1275
self.tags.merge_to(destination.tags)
1277
def update_references(self, target):
1278
if not getattr(self._format, 'supports_reference_locations', False):
1280
reference_dict = self._get_all_reference_info()
1281
if len(reference_dict) == 0:
1283
old_base = self.base
1284
new_base = target.base
1285
target_reference_dict = target._get_all_reference_info()
1286
for file_id, (tree_path, branch_location) in (
1287
reference_dict.items()):
1288
branch_location = urlutils.rebase_url(branch_location,
1290
target_reference_dict.setdefault(
1291
file_id, (tree_path, branch_location))
1292
target._set_all_reference_info(target_reference_dict)
694
1294
@needs_read_lock
1295
def check(self, refs):
696
1296
"""Check consistency of the branch.
698
1298
In particular this checks that revisions given in the revision-history
699
do actually match up in the revision graph, and that they're all
1299
do actually match up in the revision graph, and that they're all
700
1300
present in the repository.
702
1302
Callers will typically also want to check the repository.
1304
:param refs: Calculated refs for this branch as specified by
1305
branch._get_check_refs()
704
1306
:return: A BranchCheckResult.
706
mainline_parent_id = None
707
for revision_id in self.revision_history():
709
revision = self.repository.get_revision(revision_id)
710
except errors.NoSuchRevision, e:
711
raise errors.BzrCheckError("mainline revision {%s} not in repository"
713
# In general the first entry on the revision history has no parents.
714
# But it's not illegal for it to have parents listed; this can happen
715
# in imports from Arch when the parents weren't reachable.
716
if mainline_parent_id is not None:
717
if mainline_parent_id not in revision.parent_ids:
718
raise errors.BzrCheckError("previous revision {%s} not listed among "
720
% (mainline_parent_id, revision_id))
721
mainline_parent_id = revision_id
722
return BranchCheckResult(self)
1308
result = BranchCheckResult(self)
1309
last_revno, last_revision_id = self.last_revision_info()
1310
actual_revno = refs[('lefthand-distance', last_revision_id)]
1311
if actual_revno != last_revno:
1312
result.errors.append(errors.BzrCheckError(
1313
'revno does not match len(mainline) %s != %s' % (
1314
last_revno, actual_revno)))
1315
# TODO: We should probably also check that self.revision_history
1316
# matches the repository for older branch formats.
1317
# If looking for the code that cross-checks repository parents against
1318
# the iter_reverse_revision_history output, that is now a repository
724
1322
def _get_checkout_format(self):
725
1323
"""Return the most suitable metadir for a checkout of this branch.
783
1403
basis_tree.unlock()
786
def reference_parent(self, file_id, path):
1407
def reconcile(self, thorough=True):
1408
"""Make sure the data stored in this branch is consistent."""
1409
from bzrlib.reconcile import BranchReconciler
1410
reconciler = BranchReconciler(self, thorough=thorough)
1411
reconciler.reconcile()
1414
def reference_parent(self, file_id, path, possible_transports=None):
787
1415
"""Return the parent branch for a tree-reference file_id
788
1416
:param file_id: The file_id of the tree reference
789
1417
:param path: The path of the file_id in the tree
790
1418
:return: A branch associated with the file_id
792
1420
# FIXME should provide multiple branches, based on config
793
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1421
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1422
possible_transports=possible_transports)
795
1424
def supports_tags(self):
796
1425
return self._format.supports_tags()
1427
def automatic_tag_name(self, revision_id):
1428
"""Try to automatically find the tag name for a revision.
1430
:param revision_id: Revision id of the revision.
1431
:return: A tag name or None if no tag name could be determined.
1433
for hook in Branch.hooks['automatic_tag_name']:
1434
ret = hook(self, revision_id)
1439
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1441
"""Ensure that revision_b is a descendant of revision_a.
1443
This is a helper function for update_revisions.
1445
:raises: DivergedBranches if revision_b has diverged from revision_a.
1446
:returns: True if revision_b is a descendant of revision_a.
1448
relation = self._revision_relations(revision_a, revision_b, graph)
1449
if relation == 'b_descends_from_a':
1451
elif relation == 'diverged':
1452
raise errors.DivergedBranches(self, other_branch)
1453
elif relation == 'a_descends_from_b':
1456
raise AssertionError("invalid relation: %r" % (relation,))
1458
def _revision_relations(self, revision_a, revision_b, graph):
1459
"""Determine the relationship between two revisions.
1461
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1463
heads = graph.heads([revision_a, revision_b])
1464
if heads == set([revision_b]):
1465
return 'b_descends_from_a'
1466
elif heads == set([revision_a, revision_b]):
1467
# These branches have diverged
1469
elif heads == set([revision_a]):
1470
return 'a_descends_from_b'
1472
raise AssertionError("invalid heads: %r" % (heads,))
799
1475
class BranchFormat(object):
800
1476
"""An encapsulation of the initialization and open routines for a format.
898
1585
control_files = lockable_files.LockableFiles(branch_transport,
899
1586
lock_name, lock_class)
900
1587
control_files.create_lock()
901
control_files.lock_write()
1589
control_files.lock_write()
1590
except errors.LockContention:
1591
if lock_type != 'branch4':
903
control_files.put_utf8('format', self.get_format_string())
1597
utf8_files += [('format', self.get_format_string())]
905
for file, content in utf8_files:
906
control_files.put_utf8(file, content)
1599
for (filename, content) in utf8_files:
1600
branch_transport.put_bytes(
1602
mode=a_bzrdir._get_file_mode())
908
control_files.unlock()
909
return self.open(a_bzrdir, _found=True)
1605
control_files.unlock()
1606
branch = self.open(a_bzrdir, name, _found=True)
1607
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
911
def initialize(self, a_bzrdir):
912
"""Create a branch of this format in a_bzrdir."""
1610
def initialize(self, a_bzrdir, name=None):
1611
"""Create a branch of this format in a_bzrdir.
1613
:param name: Name of the colocated branch to create.
913
1615
raise NotImplementedError(self.initialize)
915
1617
def is_supported(self):
916
1618
"""Is this format supported?
918
1620
Supported formats can be initialized and opened.
919
Unsupported formats may not support initialization or committing or
1621
Unsupported formats may not support initialization or committing or
920
1622
some other features depending on the reason for not being supported.
924
def open(self, a_bzrdir, _found=False):
1626
def make_tags(self, branch):
1627
"""Create a tags object for branch.
1629
This method is on BranchFormat, because BranchFormats are reflected
1630
over the wire via network_name(), whereas full Branch instances require
1631
multiple VFS method calls to operate at all.
1633
The default implementation returns a disabled-tags instance.
1635
Note that it is normal for branch to be a RemoteBranch when using tags
1638
return DisabledTags(branch)
1640
def network_name(self):
1641
"""A simple byte string uniquely identifying this format for RPC calls.
1643
MetaDir branch formats use their disk format string to identify the
1644
repository over the wire. All in one formats such as bzr < 0.8, and
1645
foreign formats like svn/git and hg should use some marker which is
1646
unique and immutable.
1648
raise NotImplementedError(self.network_name)
1650
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
925
1651
"""Return the branch object for a_bzrdir
927
_found is a private parameter, do not use it. It is used to indicate
928
if format probing has already be done.
1653
:param a_bzrdir: A BzrDir that contains a branch.
1654
:param name: Name of colocated branch to open
1655
:param _found: a private parameter, do not use it. It is used to
1656
indicate if format probing has already be done.
1657
:param ignore_fallbacks: when set, no fallback branches will be opened
1658
(if there are any). Default is to open fallbacks.
930
1660
raise NotImplementedError(self.open)
933
1663
def register_format(klass, format):
1664
"""Register a metadir format."""
934
1665
klass._formats[format.get_format_string()] = format
1666
# Metadir formats have a network name of their format string, and get
1667
# registered as class factories.
1668
network_format_registry.register(format.get_format_string(), format.__class__)
937
1671
def set_default_format(klass, format):
938
1672
klass._default_format = format
1674
def supports_set_append_revisions_only(self):
1675
"""True if this format supports set_append_revisions_only."""
1678
def supports_stacking(self):
1679
"""True if this format records a stacked-on branch."""
941
1683
def unregister_format(klass, format):
942
assert klass._formats[format.get_format_string()] is format
943
1684
del klass._formats[format.get_format_string()]
945
1686
def __str__(self):
946
return self.get_format_string().rstrip()
1687
return self.get_format_description().rstrip()
948
1689
def supports_tags(self):
949
1690
"""True if this format supports tags stored in the branch"""
950
1691
return False # by default
952
# XXX: Probably doesn't really belong here -- mbp 20070212
953
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
955
branch_transport = a_bzrdir.get_branch_transport(self)
956
control_files = lockable_files.LockableFiles(branch_transport,
957
lock_filename, lock_class)
958
control_files.create_lock()
959
control_files.lock_write()
961
for filename, content in utf8_files:
962
control_files.put_utf8(filename, content)
964
control_files.unlock()
967
1694
class BranchHooks(Hooks):
968
1695
"""A dictionary mapping hook name to a list of callables for branch hooks.
970
1697
e.g. ['set_rh'] Is the list of items to be called when the
971
1698
set_revision_history function is invoked.
980
1707
Hooks.__init__(self)
981
# Introduced in 0.15:
982
# invoked whenever the revision history has been set
983
# with set_revision_history. The api signature is
984
# (branch, revision_history), and the branch will
987
# invoked after a push operation completes.
988
# the api signature is
990
# containing the members
991
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
992
# where local is the local target branch or None, master is the target
993
# master branch, and the rest should be self explanatory. The source
994
# is read locked and the target branches write locked. Source will
995
# be the local low-latency branch.
996
self['post_push'] = []
997
# invoked after a pull operation completes.
998
# the api signature is
1000
# containing the members
1001
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1002
# where local is the local branch or None, master is the target
1003
# master branch, and the rest should be self explanatory. The source
1004
# is read locked and the target branches write locked. The local
1005
# branch is the low-latency branch.
1006
self['post_pull'] = []
1007
# invoked before a commit operation takes place.
1008
# the api signature is
1009
# (local, master, old_revno, old_revid, future_revno, future_revid,
1010
# tree_delta, future_tree).
1011
# old_revid is NULL_REVISION for the first commit to a branch
1012
# tree_delta is a TreeDelta object describing changes from the basis
1013
# revision, hooks MUST NOT modify this delta
1014
# future_tree is an in-memory tree obtained from
1015
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1016
self['pre_commit'] = []
1017
# invoked after a commit operation completes.
1018
# the api signature is
1019
# (local, master, old_revno, old_revid, new_revno, new_revid)
1020
# old_revid is NULL_REVISION for the first commit to a branch.
1021
self['post_commit'] = []
1022
# invoked after a uncommit operation completes.
1023
# the api signature is
1024
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1025
# local is the local branch or None, master is the target branch,
1026
# and an empty branch recieves new_revno of 0, new_revid of None.
1027
self['post_uncommit'] = []
1708
self.create_hook(HookPoint('set_rh',
1709
"Invoked whenever the revision history has been set via "
1710
"set_revision_history. The api signature is (branch, "
1711
"revision_history), and the branch will be write-locked. "
1712
"The set_rh hook can be expensive for bzr to trigger, a better "
1713
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1714
self.create_hook(HookPoint('open',
1715
"Called with the Branch object that has been opened after a "
1716
"branch is opened.", (1, 8), None))
1717
self.create_hook(HookPoint('post_push',
1718
"Called after a push operation completes. post_push is called "
1719
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1720
"bzr client.", (0, 15), None))
1721
self.create_hook(HookPoint('post_pull',
1722
"Called after a pull operation completes. post_pull is called "
1723
"with a bzrlib.branch.PullResult object and only runs in the "
1724
"bzr client.", (0, 15), None))
1725
self.create_hook(HookPoint('pre_commit',
1726
"Called after a commit is calculated but before it is is "
1727
"completed. pre_commit is called with (local, master, old_revno, "
1728
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
"). old_revid is NULL_REVISION for the first commit to a branch, "
1730
"tree_delta is a TreeDelta object describing changes from the "
1731
"basis revision. hooks MUST NOT modify this delta. "
1732
" future_tree is an in-memory tree obtained from "
1733
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1734
"tree.", (0,91), None))
1735
self.create_hook(HookPoint('post_commit',
1736
"Called in the bzr client after a commit has completed. "
1737
"post_commit is called with (local, master, old_revno, old_revid, "
1738
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1739
"commit to a branch.", (0, 15), None))
1740
self.create_hook(HookPoint('post_uncommit',
1741
"Called in the bzr client after an uncommit completes. "
1742
"post_uncommit is called with (local, master, old_revno, "
1743
"old_revid, new_revno, new_revid) where local is the local branch "
1744
"or None, master is the target branch, and an empty branch "
1745
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1746
self.create_hook(HookPoint('pre_change_branch_tip',
1747
"Called in bzr client and server before a change to the tip of a "
1748
"branch is made. pre_change_branch_tip is called with a "
1749
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1750
"commit, uncommit will all trigger this hook.", (1, 6), None))
1751
self.create_hook(HookPoint('post_change_branch_tip',
1752
"Called in bzr client and server after a change to the tip of a "
1753
"branch is made. post_change_branch_tip is called with a "
1754
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1755
"commit, uncommit will all trigger this hook.", (1, 4), None))
1756
self.create_hook(HookPoint('transform_fallback_location',
1757
"Called when a stacked branch is activating its fallback "
1758
"locations. transform_fallback_location is called with (branch, "
1759
"url), and should return a new url. Returning the same url "
1760
"allows it to be used as-is, returning a different one can be "
1761
"used to cause the branch to stack on a closer copy of that "
1762
"fallback_location. Note that the branch cannot have history "
1763
"accessing methods called on it during this hook because the "
1764
"fallback locations have not been activated. When there are "
1765
"multiple hooks installed for transform_fallback_location, "
1766
"all are called with the url returned from the previous hook."
1767
"The order is however undefined.", (1, 9), None))
1768
self.create_hook(HookPoint('automatic_tag_name',
1769
"Called to determine an automatic tag name for a revision."
1770
"automatic_tag_name is called with (branch, revision_id) and "
1771
"should return a tag name or None if no tag name could be "
1772
"determined. The first non-None tag name returned will be used.",
1774
self.create_hook(HookPoint('post_branch_init',
1775
"Called after new branch initialization completes. "
1776
"post_branch_init is called with a "
1777
"bzrlib.branch.BranchInitHookParams. "
1778
"Note that init, branch and checkout (both heavyweight and "
1779
"lightweight) will all trigger this hook.", (2, 2), None))
1780
self.create_hook(HookPoint('post_switch',
1781
"Called after a checkout switches branch. "
1782
"post_switch is called with a "
1783
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1030
1787
# install the default hooks into the Branch class.
1031
1788
Branch.hooks = BranchHooks()
1791
class ChangeBranchTipParams(object):
1792
"""Object holding parameters passed to *_change_branch_tip hooks.
1794
There are 5 fields that hooks may wish to access:
1796
:ivar branch: the branch being changed
1797
:ivar old_revno: revision number before the change
1798
:ivar new_revno: revision number after the change
1799
:ivar old_revid: revision id before the change
1800
:ivar new_revid: revision id after the change
1802
The revid fields are strings. The revno fields are integers.
1805
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1806
"""Create a group of ChangeBranchTip parameters.
1808
:param branch: The branch being changed.
1809
:param old_revno: Revision number before the change.
1810
:param new_revno: Revision number after the change.
1811
:param old_revid: Tip revision id before the change.
1812
:param new_revid: Tip revision id after the change.
1814
self.branch = branch
1815
self.old_revno = old_revno
1816
self.new_revno = new_revno
1817
self.old_revid = old_revid
1818
self.new_revid = new_revid
1820
def __eq__(self, other):
1821
return self.__dict__ == other.__dict__
1824
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1825
self.__class__.__name__, self.branch,
1826
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1829
class BranchInitHookParams(object):
1830
"""Object holding parameters passed to *_branch_init hooks.
1832
There are 4 fields that hooks may wish to access:
1834
:ivar format: the branch format
1835
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1836
:ivar name: name of colocated branch, if any (or None)
1837
:ivar branch: the branch created
1839
Note that for lightweight checkouts, the bzrdir and format fields refer to
1840
the checkout, hence they are different from the corresponding fields in
1841
branch, which refer to the original branch.
1844
def __init__(self, format, a_bzrdir, name, branch):
1845
"""Create a group of BranchInitHook parameters.
1847
:param format: the branch format
1848
:param a_bzrdir: the BzrDir where the branch will be/has been
1850
:param name: name of colocated branch, if any (or None)
1851
:param branch: the branch created
1853
Note that for lightweight checkouts, the bzrdir and format fields refer
1854
to the checkout, hence they are different from the corresponding fields
1855
in branch, which refer to the original branch.
1857
self.format = format
1858
self.bzrdir = a_bzrdir
1860
self.branch = branch
1862
def __eq__(self, other):
1863
return self.__dict__ == other.__dict__
1867
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1869
return "<%s of format:%s bzrdir:%s>" % (
1870
self.__class__.__name__, self.branch,
1871
self.format, self.bzrdir)
1874
class SwitchHookParams(object):
1875
"""Object holding parameters passed to *_switch hooks.
1877
There are 4 fields that hooks may wish to access:
1879
:ivar control_dir: BzrDir of the checkout to change
1880
:ivar to_branch: branch that the checkout is to reference
1881
:ivar force: skip the check for local commits in a heavy checkout
1882
:ivar revision_id: revision ID to switch to (or None)
1885
def __init__(self, control_dir, to_branch, force, revision_id):
1886
"""Create a group of SwitchHook parameters.
1888
:param control_dir: BzrDir of the checkout to change
1889
:param to_branch: branch that the checkout is to reference
1890
:param force: skip the check for local commits in a heavy checkout
1891
:param revision_id: revision ID to switch to (or None)
1893
self.control_dir = control_dir
1894
self.to_branch = to_branch
1896
self.revision_id = revision_id
1898
def __eq__(self, other):
1899
return self.__dict__ == other.__dict__
1902
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1903
self.control_dir, self.to_branch,
1034
1907
class BzrBranchFormat4(BranchFormat):
1035
1908
"""Bzr branch format 4.
1043
1916
"""See BranchFormat.get_format_description()."""
1044
1917
return "Branch format 4"
1046
def initialize(self, a_bzrdir):
1919
def initialize(self, a_bzrdir, name=None):
1047
1920
"""Create a branch of this format in a_bzrdir."""
1048
1921
utf8_files = [('revision-history', ''),
1049
1922
('branch-name', ''),
1051
return self._initialize_helper(a_bzrdir, utf8_files,
1924
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1052
1925
lock_type='branch4', set_format=False)
1054
1927
def __init__(self):
1055
1928
super(BzrBranchFormat4, self).__init__()
1056
1929
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1058
def open(self, a_bzrdir, _found=False):
1059
"""Return the branch object for a_bzrdir
1931
def network_name(self):
1932
"""The network name for this format is the control dirs disk label."""
1933
return self._matchingbzrdir.get_format_string()
1061
_found is a private parameter, do not use it. It is used to indicate
1062
if format probing has already be done.
1935
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1936
"""See BranchFormat.open()."""
1065
1938
# we are being called directly and must probe.
1066
1939
raise NotImplementedError
1067
1940
return BzrBranch(_format=self,
1068
1941
_control_files=a_bzrdir._control_files,
1069
1942
a_bzrdir=a_bzrdir,
1070
1944
_repository=a_bzrdir.open_repository())
1072
1946
def __str__(self):
1073
1947
return "Bazaar-NG branch format 4"
1076
class BzrBranchFormat5(BranchFormat):
1950
class BranchFormatMetadir(BranchFormat):
1951
"""Common logic for meta-dir based branch formats."""
1953
def _branch_class(self):
1954
"""What class to instantiate on open calls."""
1955
raise NotImplementedError(self._branch_class)
1957
def network_name(self):
1958
"""A simple byte string uniquely identifying this format for RPC calls.
1960
Metadir branch formats use their format string.
1962
return self.get_format_string()
1964
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1965
"""See BranchFormat.open()."""
1967
format = BranchFormat.find_format(a_bzrdir, name=name)
1968
if format.__class__ != self.__class__:
1969
raise AssertionError("wrong format %r found for %r" %
1971
transport = a_bzrdir.get_branch_transport(None, name=name)
1973
control_files = lockable_files.LockableFiles(transport, 'lock',
1975
return self._branch_class()(_format=self,
1976
_control_files=control_files,
1979
_repository=a_bzrdir.find_repository(),
1980
ignore_fallbacks=ignore_fallbacks)
1981
except errors.NoSuchFile:
1982
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1985
super(BranchFormatMetadir, self).__init__()
1986
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1987
self._matchingbzrdir.set_branch_format(self)
1989
def supports_tags(self):
1993
class BzrBranchFormat5(BranchFormatMetadir):
1077
1994
"""Bzr branch format 5.
1079
1996
This format has:
1145
2047
"""See BranchFormat.get_format_description()."""
1146
2048
return "Branch format 6"
1148
def initialize(self, a_bzrdir):
1149
"""Create a branch of this format in a_bzrdir."""
1150
utf8_files = [('last-revision', '0 null:\n'),
1151
('branch.conf', ''),
1154
return self._initialize_helper(a_bzrdir, utf8_files)
1156
def open(self, a_bzrdir, _found=False):
1157
"""Return the branch object for a_bzrdir
1159
_found is a private parameter, do not use it. It is used to indicate
1160
if format probing has already be done.
1163
format = BranchFormat.find_format(a_bzrdir)
1164
assert format.__class__ == self.__class__
1165
transport = a_bzrdir.get_branch_transport(None)
1166
control_files = lockable_files.LockableFiles(transport, 'lock',
1168
return BzrBranch6(_format=self,
1169
_control_files=control_files,
1171
_repository=a_bzrdir.find_repository())
1173
def supports_tags(self):
2050
def initialize(self, a_bzrdir, name=None):
2051
"""Create a branch of this format in a_bzrdir."""
2052
utf8_files = [('last-revision', '0 null:\n'),
2053
('branch.conf', ''),
2056
return self._initialize_helper(a_bzrdir, utf8_files, name)
2058
def make_tags(self, branch):
2059
"""See bzrlib.branch.BranchFormat.make_tags()."""
2060
return BasicTags(branch)
2062
def supports_set_append_revisions_only(self):
2066
class BzrBranchFormat8(BranchFormatMetadir):
2067
"""Metadir format supporting storing locations of subtree branches."""
2069
def _branch_class(self):
2072
def get_format_string(self):
2073
"""See BranchFormat.get_format_string()."""
2074
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2076
def get_format_description(self):
2077
"""See BranchFormat.get_format_description()."""
2078
return "Branch format 8"
2080
def initialize(self, a_bzrdir, name=None):
2081
"""Create a branch of this format in a_bzrdir."""
2082
utf8_files = [('last-revision', '0 null:\n'),
2083
('branch.conf', ''),
2087
return self._initialize_helper(a_bzrdir, utf8_files, name)
2090
super(BzrBranchFormat8, self).__init__()
2091
self._matchingbzrdir.repository_format = \
2092
RepositoryFormatKnitPack5RichRoot()
2094
def make_tags(self, branch):
2095
"""See bzrlib.branch.BranchFormat.make_tags()."""
2096
return BasicTags(branch)
2098
def supports_set_append_revisions_only(self):
2101
def supports_stacking(self):
2104
supports_reference_locations = True
2107
class BzrBranchFormat7(BzrBranchFormat8):
2108
"""Branch format with last-revision, tags, and a stacked location pointer.
2110
The stacked location pointer is passed down to the repository and requires
2111
a repository format with supports_external_lookups = True.
2113
This format was introduced in bzr 1.6.
2116
def initialize(self, a_bzrdir, name=None):
2117
"""Create a branch of this format in a_bzrdir."""
2118
utf8_files = [('last-revision', '0 null:\n'),
2119
('branch.conf', ''),
2122
return self._initialize_helper(a_bzrdir, utf8_files, name)
2124
def _branch_class(self):
2127
def get_format_string(self):
2128
"""See BranchFormat.get_format_string()."""
2129
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2131
def get_format_description(self):
2132
"""See BranchFormat.get_format_description()."""
2133
return "Branch format 7"
2135
def supports_set_append_revisions_only(self):
2138
supports_reference_locations = False
1177
2141
class BranchReferenceFormat(BranchFormat):
1196
2160
def get_reference(self, a_bzrdir):
1197
2161
"""See BranchFormat.get_reference()."""
1198
2162
transport = a_bzrdir.get_branch_transport(None)
1199
return transport.get('location').read()
2163
return transport.get_bytes('location')
1201
2165
def set_reference(self, a_bzrdir, to_branch):
1202
2166
"""See BranchFormat.set_reference()."""
1203
2167
transport = a_bzrdir.get_branch_transport(None)
1204
2168
location = transport.put_bytes('location', to_branch.base)
1206
def initialize(self, a_bzrdir, target_branch=None):
2170
def initialize(self, a_bzrdir, name=None, target_branch=None):
1207
2171
"""Create a branch of this format in a_bzrdir."""
1208
2172
if target_branch is None:
1209
2173
# this format does not implement branch itself, thus the implicit
1210
2174
# creation contract must see it as uninitializable
1211
2175
raise errors.UninitializableFormat(self)
1212
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1213
branch_transport = a_bzrdir.get_branch_transport(self)
2176
mutter('creating branch reference in %s', a_bzrdir.user_url)
2177
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1214
2178
branch_transport.put_bytes('location',
1215
target_branch.bzrdir.root_transport.base)
2179
target_branch.bzrdir.user_url)
1216
2180
branch_transport.put_bytes('format', self.get_format_string())
1218
a_bzrdir, _found=True,
2182
a_bzrdir, name, _found=True,
1219
2183
possible_transports=[target_branch.bzrdir.root_transport])
2184
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1221
2187
def __init__(self):
1222
2188
super(BranchReferenceFormat, self).__init__()
1223
2189
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2190
self._matchingbzrdir.set_branch_format(self)
1225
2192
def _make_reference_clone_function(format, a_branch):
1226
2193
"""Create a clone() routine for a branch dynamically."""
1227
def clone(to_bzrdir, revision_id=None):
2194
def clone(to_bzrdir, revision_id=None,
2195
repository_policy=None):
1228
2196
"""See Branch.clone()."""
1229
return format.initialize(to_bzrdir, a_branch)
2197
return format.initialize(to_bzrdir, target_branch=a_branch)
1230
2198
# cannot obey revision_id limits when cloning a reference ...
1231
2199
# FIXME RBC 20060210 either nuke revision_id for clone, or
1232
2200
# emit some sort of warning/error to the caller ?!
1235
def open(self, a_bzrdir, _found=False, location=None,
1236
possible_transports=None):
2203
def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
possible_transports=None, ignore_fallbacks=False):
1237
2205
"""Return the branch that the branch reference in a_bzrdir points at.
1239
_found is a private parameter, do not use it. It is used to indicate
1240
if format probing has already be done.
2207
:param a_bzrdir: A BzrDir that contains a branch.
2208
:param name: Name of colocated branch to open, if any
2209
:param _found: a private parameter, do not use it. It is used to
2210
indicate if format probing has already be done.
2211
:param ignore_fallbacks: when set, no fallback branches will be opened
2212
(if there are any). Default is to open fallbacks.
2213
:param location: The location of the referenced branch. If
2214
unspecified, this will be determined from the branch reference in
2216
:param possible_transports: An optional reusable transports list.
1243
format = BranchFormat.find_format(a_bzrdir)
1244
assert format.__class__ == self.__class__
2219
format = BranchFormat.find_format(a_bzrdir, name=name)
2220
if format.__class__ != self.__class__:
2221
raise AssertionError("wrong format %r found for %r" %
1245
2223
if location is None:
1246
2224
location = self.get_reference(a_bzrdir)
1247
2225
real_bzrdir = bzrdir.BzrDir.open(
1248
2226
location, possible_transports=possible_transports)
1249
result = real_bzrdir.open_branch()
2227
result = real_bzrdir.open_branch(name=name,
2228
ignore_fallbacks=ignore_fallbacks)
1250
2229
# this changes the behaviour of result.clone to create a new reference
1251
2230
# rather than a copy of the content of the branch.
1252
2231
# I did not use a proxy object because that needs much more extensive
2241
network_format_registry = registry.FormatRegistry()
2242
"""Registry of formats indexed by their network name.
2244
The network name for a branch format is an identifier that can be used when
2245
referring to formats with smart server operations. See
2246
BranchFormat.network_name() for more detail.
1262
2250
# formats which have no format string are not discoverable
1263
2251
# and not independently creatable, so are not registered.
1264
2252
__format5 = BzrBranchFormat5()
1265
2253
__format6 = BzrBranchFormat6()
2254
__format7 = BzrBranchFormat7()
2255
__format8 = BzrBranchFormat8()
1266
2256
BranchFormat.register_format(__format5)
1267
2257
BranchFormat.register_format(BranchReferenceFormat())
1268
2258
BranchFormat.register_format(__format6)
1269
BranchFormat.set_default_format(__format6)
2259
BranchFormat.register_format(__format7)
2260
BranchFormat.register_format(__format8)
2261
BranchFormat.set_default_format(__format7)
1270
2262
_legacy_formats = [BzrBranchFormat4(),
1273
class BzrBranch(Branch):
2264
network_format_registry.register(
2265
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2268
class BzrBranch(Branch, _RelockDebugMixin):
1274
2269
"""A branch stored in the actual filesystem.
1276
2271
Note that it's "local" in the context of the filesystem; it doesn't
1277
2272
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1278
2273
it's writable, and can be accessed via the normal filesystem API.
2275
:ivar _transport: Transport for file operations on this branch's
2276
control files, typically pointing to the .bzr/branch directory.
2277
:ivar repository: Repository for this branch.
2278
:ivar base: The url of the base directory for this branch; the one
2279
containing the .bzr directory.
2280
:ivar name: Optional colocated branch name as it exists in the control
1281
2284
def __init__(self, _format=None,
1282
_control_files=None, a_bzrdir=None, _repository=None):
2285
_control_files=None, a_bzrdir=None, name=None,
2286
_repository=None, ignore_fallbacks=False):
1283
2287
"""Create new branch object at a particular location."""
1284
Branch.__init__(self)
1285
2288
if a_bzrdir is None:
1286
2289
raise ValueError('a_bzrdir must be supplied')
1288
2291
self.bzrdir = a_bzrdir
1289
# self._transport used to point to the directory containing the
1290
# control directory, but was not used - now it's just the transport
1291
# for the branch control files. mbp 20070212
1292
2292
self._base = self.bzrdir.transport.clone('..').base
2294
# XXX: We should be able to just do
2295
# self.base = self.bzrdir.root_transport.base
2296
# but this does not quite work yet -- mbp 20080522
1293
2297
self._format = _format
1294
2298
if _control_files is None:
1295
2299
raise ValueError('BzrBranch _control_files is None')
1296
2300
self.control_files = _control_files
1297
2301
self._transport = _control_files._transport
1298
2302
self.repository = _repository
2303
Branch.__init__(self)
1300
2305
def __str__(self):
1301
return '%s(%r)' % (self.__class__.__name__, self.base)
2306
if self.name is None:
2307
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2309
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
1303
2312
__repr__ = __str__
1370
2393
This performs the actual writing to disk.
1371
2394
It is intended to be called by BzrBranch5.set_revision_history."""
1372
self.control_files.put_bytes(
1373
'revision-history', '\n'.join(history))
2395
self._transport.put_bytes(
2396
'revision-history', '\n'.join(history),
2397
mode=self.bzrdir._get_file_mode())
1375
2399
@needs_write_lock
1376
2400
def set_revision_history(self, rev_history):
1377
2401
"""See Branch.set_revision_history."""
1378
2402
if 'evil' in debug.debug_flags:
1379
2403
mutter_callsite(3, "set_revision_history scales with history.")
2404
check_not_reserved_id = _mod_revision.check_not_reserved_id
2405
for rev_id in rev_history:
2406
check_not_reserved_id(rev_id)
2407
if Branch.hooks['post_change_branch_tip']:
2408
# Don't calculate the last_revision_info() if there are no hooks
2410
old_revno, old_revid = self.last_revision_info()
2411
if len(rev_history) == 0:
2412
revid = _mod_revision.NULL_REVISION
2414
revid = rev_history[-1]
2415
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1380
2416
self._write_revision_history(rev_history)
1381
2417
self._clear_cached_state()
1382
2418
self._cache_revision_history(rev_history)
1383
2419
for hook in Branch.hooks['set_rh']:
1384
2420
hook(self, rev_history)
2421
if Branch.hooks['post_change_branch_tip']:
2422
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2424
def _synchronize_history(self, destination, revision_id):
2425
"""Synchronize last revision and revision history between branches.
2427
This version is most efficient when the destination is also a
2428
BzrBranch5, but works for BzrBranch6 as long as the revision
2429
history is the true lefthand parent history, and all of the revisions
2430
are in the destination's repository. If not, set_revision_history
2433
:param destination: The branch to copy the history into
2434
:param revision_id: The revision-id to truncate history at. May
2435
be None to copy complete history.
2437
if not isinstance(destination._format, BzrBranchFormat5):
2438
super(BzrBranch, self)._synchronize_history(
2439
destination, revision_id)
2441
if revision_id == _mod_revision.NULL_REVISION:
2444
new_history = self.revision_history()
2445
if revision_id is not None and new_history != []:
2447
new_history = new_history[:new_history.index(revision_id) + 1]
2449
rev = self.repository.get_revision(revision_id)
2450
new_history = rev.get_history(self.repository)[1:]
2451
destination.set_revision_history(new_history)
1386
2453
@needs_write_lock
1387
2454
def set_last_revision_info(self, revno, revision_id):
1446
2492
self.set_revision_history(self._lefthand_history(revision_id,
1447
2493
last_rev, other_branch))
1450
def update_revisions(self, other, stop_revision=None, overwrite=False):
1451
"""See Branch.update_revisions."""
1454
other_last_revno, other_last_revision = other.last_revision_info()
1455
if stop_revision is None:
1456
stop_revision = other_last_revision
1457
if _mod_revision.is_null(stop_revision):
1458
# if there are no commits, we're done.
1460
# whats the current last revision, before we fetch [and change it
1462
last_rev = _mod_revision.ensure_null(self.last_revision())
1463
# we fetch here so that we don't process data twice in the common
1464
# case of having something to pull, and so that the check for
1465
# already merged can operate on the just fetched graph, which will
1466
# be cached in memory.
1467
self.fetch(other, stop_revision)
1468
# Check to see if one is an ancestor of the other
1470
heads = self.repository.get_graph().heads([stop_revision,
1472
if heads == set([last_rev]):
1473
# The current revision is a decendent of the target,
1476
elif heads == set([stop_revision, last_rev]):
1477
# These branches have diverged
1478
raise errors.DivergedBranches(self, other)
1479
assert heads == set([stop_revision])
1480
if other_last_revision == stop_revision:
1481
self.set_last_revision_info(other_last_revno,
1482
other_last_revision)
1484
# TODO: jam 2007-11-29 Is there a way to determine the
1485
# revno without searching all of history??
1487
self.generate_revision_history(stop_revision)
1489
self.generate_revision_history(stop_revision,
1490
last_rev=last_rev, other_branch=other)
1494
2495
def basis_tree(self):
1495
2496
"""See Branch.basis_tree."""
1496
2497
return self.repository.revision_tree(self.last_revision())
1499
def pull(self, source, overwrite=False, stop_revision=None,
1500
_hook_master=None, run_hooks=True, possible_transports=None):
1503
:param _hook_master: Private parameter - set the branch to
1504
be supplied as the master to push hooks.
1505
:param run_hooks: Private parameter - if false, this branch
1506
is being called because it's the master of the primary branch,
1507
so it should not run its hooks.
1509
result = PullResult()
1510
result.source_branch = source
1511
result.target_branch = self
1514
result.old_revno, result.old_revid = self.last_revision_info()
1515
self.update_revisions(source, stop_revision, overwrite=overwrite)
1516
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1517
result.new_revno, result.new_revid = self.last_revision_info()
1519
result.master_branch = _hook_master
1520
result.local_branch = self
1522
result.master_branch = self
1523
result.local_branch = None
1525
for hook in Branch.hooks['post_pull']:
1531
2499
def _get_parent_location(self):
1532
2500
_locs = ['parent', 'pull', 'x-pull']
1533
2501
for l in _locs:
1535
return self.control_files.get(l).read().strip('\n')
2503
return self._transport.get_bytes(l).strip('\n')
1536
2504
except errors.NoSuchFile:
1541
def push(self, target, overwrite=False, stop_revision=None,
1542
_override_hook_source_branch=None):
1545
This is the basic concrete implementation of push()
1547
:param _override_hook_source_branch: If specified, run
1548
the hooks passing this Branch as the source, rather than self.
1549
This is for use of RemoteBranch, where push is delegated to the
1550
underlying vfs-based Branch.
1552
# TODO: Public option to disable running hooks - should be trivial but
1556
result = self._push_with_bound_branches(target, overwrite,
1558
_override_hook_source_branch=_override_hook_source_branch)
1563
def _push_with_bound_branches(self, target, overwrite,
1565
_override_hook_source_branch=None):
1566
"""Push from self into target, and into target's master if any.
1568
This is on the base BzrBranch class even though it doesn't support
1569
bound branches because the *target* might be bound.
1572
if _override_hook_source_branch:
1573
result.source_branch = _override_hook_source_branch
1574
for hook in Branch.hooks['post_push']:
1577
bound_location = target.get_bound_location()
1578
if bound_location and target.base != bound_location:
1579
# there is a master branch.
1581
# XXX: Why the second check? Is it even supported for a branch to
1582
# be bound to itself? -- mbp 20070507
1583
master_branch = target.get_master_branch()
1584
master_branch.lock_write()
1586
# push into the master from this branch.
1587
self._basic_push(master_branch, overwrite, stop_revision)
1588
# and push into the target branch from this. Note that we push from
1589
# this branch again, because its considered the highest bandwidth
1591
result = self._basic_push(target, overwrite, stop_revision)
1592
result.master_branch = master_branch
1593
result.local_branch = target
1597
master_branch.unlock()
1600
result = self._basic_push(target, overwrite, stop_revision)
1601
# TODO: Why set master_branch and local_branch if there's no
1602
# binding? Maybe cleaner to just leave them unset? -- mbp
1604
result.master_branch = target
1605
result.local_branch = None
1609
2508
def _basic_push(self, target, overwrite, stop_revision):
1610
2509
"""Basic implementation of push without bound branches or hooks.
1612
Must be called with self read locked and target write locked.
2511
Must be called with source read locked and target write locked.
1614
result = PushResult()
2513
result = BranchPushResult()
1615
2514
result.source_branch = self
1616
2515
result.target_branch = target
1617
2516
result.old_revno, result.old_revid = target.last_revision_info()
1619
target.update_revisions(self, stop_revision)
1620
except errors.DivergedBranches:
1624
target.set_revision_history(self.revision_history())
1625
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2517
self.update_references(target)
2518
if result.old_revid != self.last_revision():
2519
# We assume that during 'push' this repository is closer than
2521
graph = self.repository.get_graph(target.repository)
2522
target.update_revisions(self, stop_revision,
2523
overwrite=overwrite, graph=graph)
2524
if self._push_should_merge_tags():
2525
result.tag_conflicts = self.tags.merge_to(target.tags,
1626
2527
result.new_revno, result.new_revid = target.last_revision_info()
1629
def get_parent(self):
1630
"""See Branch.get_parent."""
1632
assert self.base[-1] == '/'
1633
parent = self._get_parent_location()
1636
# This is an old-format absolute path to a local branch
1637
# turn it into a url
1638
if parent.startswith('/'):
1639
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1641
return urlutils.join(self.base[:-1], parent)
1642
except errors.InvalidURLJoin, e:
1643
raise errors.InaccessibleParent(parent, self.base)
2530
def get_stacked_on_url(self):
2531
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1645
2533
def set_push_location(self, location):
1646
2534
"""See Branch.set_push_location."""
1847
2690
Intended to be called by set_last_revision_info and
1848
2691
_write_revision_history.
1850
assert revision_id is not None, "Use NULL_REVISION, not None"
2693
revision_id = _mod_revision.ensure_null(revision_id)
1851
2694
out_string = '%d %s\n' % (revno, revision_id)
1852
self.control_files.put_bytes('last-revision', out_string)
2695
self._transport.put_bytes('last-revision', out_string,
2696
mode=self.bzrdir._get_file_mode())
1854
2698
@needs_write_lock
1855
2699
def set_last_revision_info(self, revno, revision_id):
1856
2700
revision_id = _mod_revision.ensure_null(revision_id)
2701
old_revno, old_revid = self.last_revision_info()
1857
2702
if self._get_append_revisions_only():
1858
2703
self._check_history_violation(revision_id)
2704
self._run_pre_change_branch_tip_hooks(revno, revision_id)
1859
2705
self._write_last_revision_info(revno, revision_id)
1860
2706
self._clear_cached_state()
1861
2707
self._last_revision_info_cache = revno, revision_id
2708
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2710
def _synchronize_history(self, destination, revision_id):
2711
"""Synchronize last revision and revision history between branches.
2713
:see: Branch._synchronize_history
2715
# XXX: The base Branch has a fast implementation of this method based
2716
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2717
# that uses set_revision_history. This class inherits from BzrBranch5,
2718
# but wants the fast implementation, so it calls
2719
# Branch._synchronize_history directly.
2720
Branch._synchronize_history(self, destination, revision_id)
1863
2722
def _check_history_violation(self, revision_id):
1864
2723
last_revision = _mod_revision.ensure_null(self.last_revision())
1865
2724
if _mod_revision.is_null(last_revision):
1867
2726
if last_revision not in self._lefthand_history(revision_id):
1868
raise errors.AppendRevisionsOnlyViolation(self.base)
2727
raise errors.AppendRevisionsOnlyViolation(self.user_url)
1870
2729
def _gen_revision_history(self):
1871
2730
"""Generate the revision history from last revision
1873
self._extend_partial_history()
2732
last_revno, last_revision = self.last_revision_info()
2733
self._extend_partial_history(stop_index=last_revno-1)
1874
2734
return list(reversed(self._partial_revision_history_cache))
1876
def _extend_partial_history(self, stop_index=None, stop_revision=None):
1877
"""Extend the partial history to include a given index
1879
If a stop_index is supplied, stop when that index has been reached.
1880
If a stop_revision is supplied, stop when that revision is
1881
encountered. Otherwise, stop when the beginning of history is
1884
:param stop_index: The index which should be present. When it is
1885
present, history extension will stop.
1886
:param revision_id: The revision id which should be present. When
1887
it is encountered, history extension will stop.
1889
repo = self.repository
1890
if len(self._partial_revision_history_cache) == 0:
1891
iterator = repo.iter_reverse_revision_history(self.last_revision())
1893
start_revision = self._partial_revision_history_cache[-1]
1894
iterator = repo.iter_reverse_revision_history(start_revision)
1895
#skip the last revision in the list
1896
next_revision = iterator.next()
1897
assert next_revision == start_revision
1898
for revision_id in iterator:
1899
self._partial_revision_history_cache.append(revision_id)
1900
if (stop_index is not None and
1901
len(self._partial_revision_history_cache) > stop_index):
1903
if revision_id == stop_revision:
1906
2736
def _write_revision_history(self, history):
1907
2737
"""Factored out of set_revision_history.
1929
2759
"""Set the parent branch"""
1930
2760
return self._get_config_location('parent_location')
2763
def _set_all_reference_info(self, info_dict):
2764
"""Replace all reference info stored in a branch.
2766
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2769
writer = rio.RioWriter(s)
2770
for key, (tree_path, branch_location) in info_dict.iteritems():
2771
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2772
branch_location=branch_location)
2773
writer.write_stanza(stanza)
2774
self._transport.put_bytes('references', s.getvalue())
2775
self._reference_info = info_dict
2778
def _get_all_reference_info(self):
2779
"""Return all the reference info stored in a branch.
2781
:return: A dict of {file_id: (tree_path, branch_location)}
2783
if self._reference_info is not None:
2784
return self._reference_info
2785
rio_file = self._transport.get('references')
2787
stanzas = rio.read_stanzas(rio_file)
2788
info_dict = dict((s['file_id'], (s['tree_path'],
2789
s['branch_location'])) for s in stanzas)
2792
self._reference_info = info_dict
2795
def set_reference_info(self, file_id, tree_path, branch_location):
2796
"""Set the branch location to use for a tree reference.
2798
:param file_id: The file-id of the tree reference.
2799
:param tree_path: The path of the tree reference in the tree.
2800
:param branch_location: The location of the branch to retrieve tree
2803
info_dict = self._get_all_reference_info()
2804
info_dict[file_id] = (tree_path, branch_location)
2805
if None in (tree_path, branch_location):
2806
if tree_path is not None:
2807
raise ValueError('tree_path must be None when branch_location'
2809
if branch_location is not None:
2810
raise ValueError('branch_location must be None when tree_path'
2812
del info_dict[file_id]
2813
self._set_all_reference_info(info_dict)
2815
def get_reference_info(self, file_id):
2816
"""Get the tree_path and branch_location for a tree reference.
2818
:return: a tuple of (tree_path, branch_location)
2820
return self._get_all_reference_info().get(file_id, (None, None))
2822
def reference_parent(self, file_id, path, possible_transports=None):
2823
"""Return the parent branch for a tree-reference file_id.
2825
:param file_id: The file_id of the tree reference
2826
:param path: The path of the file_id in the tree
2827
:return: A branch associated with the file_id
2829
branch_location = self.get_reference_info(file_id)[1]
2830
if branch_location is None:
2831
return Branch.reference_parent(self, file_id, path,
2832
possible_transports)
2833
branch_location = urlutils.join(self.user_url, branch_location)
2834
return Branch.open(branch_location,
2835
possible_transports=possible_transports)
1932
2837
def set_push_location(self, location):
1933
2838
"""See Branch.set_push_location."""
1934
2839
self._set_config_location('push_location', location)
2158
3068
new_branch.tags._set_tag_dict({})
2160
3070
# Copying done; now update target format
2161
new_branch.control_files.put_utf8('format',
2162
format.get_format_string())
3071
new_branch._transport.put_bytes('format',
3072
format.get_format_string(),
3073
mode=new_branch.bzrdir._get_file_mode())
2164
3075
# Clean up old files
2165
new_branch.control_files._transport.delete('revision-history')
3076
new_branch._transport.delete('revision-history')
2167
3078
branch.set_parent(None)
2168
3079
except errors.NoSuchFile:
2170
3081
branch.set_bound_location(None)
3084
class Converter6to7(object):
3085
"""Perform an in-place upgrade of format 6 to format 7"""
3087
def convert(self, branch):
3088
format = BzrBranchFormat7()
3089
branch._set_config_location('stacked_on_location', '')
3090
# update target format
3091
branch._transport.put_bytes('format', format.get_format_string())
3094
class Converter7to8(object):
3095
"""Perform an in-place upgrade of format 6 to format 7"""
3097
def convert(self, branch):
3098
format = BzrBranchFormat8()
3099
branch._transport.put_bytes('references', '')
3100
# update target format
3101
branch._transport.put_bytes('format', format.get_format_string())
3104
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3105
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3108
_run_with_write_locked_target will attempt to release the lock it acquires.
3110
If an exception is raised by callable, then that exception *will* be
3111
propagated, even if the unlock attempt raises its own error. Thus
3112
_run_with_write_locked_target should be preferred to simply doing::
3116
return callable(*args, **kwargs)
3121
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3122
# should share code?
3125
result = callable(*args, **kwargs)
3127
exc_info = sys.exc_info()
3131
raise exc_info[0], exc_info[1], exc_info[2]
3137
class InterBranch(InterObject):
3138
"""This class represents operations taking place between two branches.
3140
Its instances have methods like pull() and push() and contain
3141
references to the source and target repositories these operations
3142
can be carried out on.
3146
"""The available optimised InterBranch types."""
3149
def _get_branch_formats_to_test():
3150
"""Return a tuple with the Branch formats to use when testing."""
3151
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3153
def pull(self, overwrite=False, stop_revision=None,
3154
possible_transports=None, local=False):
3155
"""Mirror source into target branch.
3157
The target branch is considered to be 'local', having low latency.
3159
:returns: PullResult instance
3161
raise NotImplementedError(self.pull)
3163
def update_revisions(self, stop_revision=None, overwrite=False,
3165
"""Pull in new perfect-fit revisions.
3167
:param stop_revision: Updated until the given revision
3168
:param overwrite: Always set the branch pointer, rather than checking
3169
to see if it is a proper descendant.
3170
:param graph: A Graph object that can be used to query history
3171
information. This can be None.
3174
raise NotImplementedError(self.update_revisions)
3176
def push(self, overwrite=False, stop_revision=None,
3177
_override_hook_source_branch=None):
3178
"""Mirror the source branch into the target branch.
3180
The source branch is considered to be 'local', having low latency.
3182
raise NotImplementedError(self.push)
3185
class GenericInterBranch(InterBranch):
3186
"""InterBranch implementation that uses public Branch functions.
3190
def _get_branch_formats_to_test():
3191
return BranchFormat._default_format, BranchFormat._default_format
3193
def update_revisions(self, stop_revision=None, overwrite=False,
3195
"""See InterBranch.update_revisions()."""
3196
self.source.lock_read()
3198
other_revno, other_last_revision = self.source.last_revision_info()
3199
stop_revno = None # unknown
3200
if stop_revision is None:
3201
stop_revision = other_last_revision
3202
if _mod_revision.is_null(stop_revision):
3203
# if there are no commits, we're done.
3205
stop_revno = other_revno
3207
# what's the current last revision, before we fetch [and change it
3209
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3210
# we fetch here so that we don't process data twice in the common
3211
# case of having something to pull, and so that the check for
3212
# already merged can operate on the just fetched graph, which will
3213
# be cached in memory.
3214
self.target.fetch(self.source, stop_revision)
3215
# Check to see if one is an ancestor of the other
3218
graph = self.target.repository.get_graph()
3219
if self.target._check_if_descendant_or_diverged(
3220
stop_revision, last_rev, graph, self.source):
3221
# stop_revision is a descendant of last_rev, but we aren't
3222
# overwriting, so we're done.
3224
if stop_revno is None:
3226
graph = self.target.repository.get_graph()
3227
this_revno, this_last_revision = \
3228
self.target.last_revision_info()
3229
stop_revno = graph.find_distance_to_null(stop_revision,
3230
[(other_last_revision, other_revno),
3231
(this_last_revision, this_revno)])
3232
self.target.set_last_revision_info(stop_revno, stop_revision)
3234
self.source.unlock()
3236
def pull(self, overwrite=False, stop_revision=None,
3237
possible_transports=None, _hook_master=None, run_hooks=True,
3238
_override_hook_target=None, local=False):
3241
:param _hook_master: Private parameter - set the branch to
3242
be supplied as the master to pull hooks.
3243
:param run_hooks: Private parameter - if false, this branch
3244
is being called because it's the master of the primary branch,
3245
so it should not run its hooks.
3246
:param _override_hook_target: Private parameter - set the branch to be
3247
supplied as the target_branch to pull hooks.
3248
:param local: Only update the local branch, and not the bound branch.
3250
# This type of branch can't be bound.
3252
raise errors.LocalRequiresBoundBranch()
3253
result = PullResult()
3254
result.source_branch = self.source
3255
if _override_hook_target is None:
3256
result.target_branch = self.target
3258
result.target_branch = _override_hook_target
3259
self.source.lock_read()
3261
# We assume that during 'pull' the target repository is closer than
3263
self.source.update_references(self.target)
3264
graph = self.target.repository.get_graph(self.source.repository)
3265
# TODO: Branch formats should have a flag that indicates
3266
# that revno's are expensive, and pull() should honor that flag.
3268
result.old_revno, result.old_revid = \
3269
self.target.last_revision_info()
3270
self.target.update_revisions(self.source, stop_revision,
3271
overwrite=overwrite, graph=graph)
3272
# TODO: The old revid should be specified when merging tags,
3273
# so a tags implementation that versions tags can only
3274
# pull in the most recent changes. -- JRV20090506
3275
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3277
result.new_revno, result.new_revid = self.target.last_revision_info()
3279
result.master_branch = _hook_master
3280
result.local_branch = result.target_branch
3282
result.master_branch = result.target_branch
3283
result.local_branch = None
3285
for hook in Branch.hooks['post_pull']:
3288
self.source.unlock()
3291
def push(self, overwrite=False, stop_revision=None,
3292
_override_hook_source_branch=None):
3293
"""See InterBranch.push.
3295
This is the basic concrete implementation of push()
3297
:param _override_hook_source_branch: If specified, run
3298
the hooks passing this Branch as the source, rather than self.
3299
This is for use of RemoteBranch, where push is delegated to the
3300
underlying vfs-based Branch.
3302
# TODO: Public option to disable running hooks - should be trivial but
3304
self.source.lock_read()
3306
return _run_with_write_locked_target(
3307
self.target, self._push_with_bound_branches, overwrite,
3309
_override_hook_source_branch=_override_hook_source_branch)
3311
self.source.unlock()
3313
def _push_with_bound_branches(self, overwrite, stop_revision,
3314
_override_hook_source_branch=None):
3315
"""Push from source into target, and into target's master if any.
3318
if _override_hook_source_branch:
3319
result.source_branch = _override_hook_source_branch
3320
for hook in Branch.hooks['post_push']:
3323
bound_location = self.target.get_bound_location()
3324
if bound_location and self.target.base != bound_location:
3325
# there is a master branch.
3327
# XXX: Why the second check? Is it even supported for a branch to
3328
# be bound to itself? -- mbp 20070507
3329
master_branch = self.target.get_master_branch()
3330
master_branch.lock_write()
3332
# push into the master from the source branch.
3333
self.source._basic_push(master_branch, overwrite, stop_revision)
3334
# and push into the target branch from the source. Note that we
3335
# push from the source branch again, because its considered the
3336
# highest bandwidth repository.
3337
result = self.source._basic_push(self.target, overwrite,
3339
result.master_branch = master_branch
3340
result.local_branch = self.target
3344
master_branch.unlock()
3347
result = self.source._basic_push(self.target, overwrite,
3349
# TODO: Why set master_branch and local_branch if there's no
3350
# binding? Maybe cleaner to just leave them unset? -- mbp
3352
result.master_branch = self.target
3353
result.local_branch = None
3358
def is_compatible(self, source, target):
3359
# GenericBranch uses the public API, so always compatible
3363
class InterToBranch5(GenericInterBranch):
3366
def _get_branch_formats_to_test():
3367
return BranchFormat._default_format, BzrBranchFormat5()
3369
def pull(self, overwrite=False, stop_revision=None,
3370
possible_transports=None, run_hooks=True,
3371
_override_hook_target=None, local=False):
3372
"""Pull from source into self, updating my master if any.
3374
:param run_hooks: Private parameter - if false, this branch
3375
is being called because it's the master of the primary branch,
3376
so it should not run its hooks.
3378
bound_location = self.target.get_bound_location()
3379
if local and not bound_location:
3380
raise errors.LocalRequiresBoundBranch()
3381
master_branch = None
3382
if not local and bound_location and self.source.user_url != bound_location:
3383
# not pulling from master, so we need to update master.
3384
master_branch = self.target.get_master_branch(possible_transports)
3385
master_branch.lock_write()
3388
# pull from source into master.
3389
master_branch.pull(self.source, overwrite, stop_revision,
3391
return super(InterToBranch5, self).pull(overwrite,
3392
stop_revision, _hook_master=master_branch,
3393
run_hooks=run_hooks,
3394
_override_hook_target=_override_hook_target)
3397
master_branch.unlock()
3400
InterBranch.register_optimiser(GenericInterBranch)
3401
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
