188
150
possible_transports)
189
151
return control.open_branch(), relpath
191
def _push_should_merge_tags(self):
192
"""Should _basic_push merge this branch's tags into the target?
194
The default implementation returns False if this branch has no tags,
195
and True the rest of the time. Subclasses may override this.
197
return self.supports_tags() and self.tags.get_tag_dict()
199
153
def get_config(self):
200
154
return BranchConfig(self)
202
def _get_config(self):
203
"""Get the concrete config for just the config in this branch.
205
This is not intended for client use; see Branch.get_config for the
210
:return: An object supporting get_option and set_option.
212
raise NotImplementedError(self._get_config)
214
def _get_fallback_repository(self, url):
215
"""Get the repository we fallback to at url."""
216
url = urlutils.join(self.base, url)
217
a_branch = Branch.open(url,
218
possible_transports=[self.bzrdir.root_transport])
219
return a_branch.repository
221
def _get_tags_bytes(self):
222
"""Get the bytes of a serialised tags dict.
224
Note that not all branches support tags, nor do all use the same tags
225
logic: this method is specific to BasicTags. Other tag implementations
226
may use the same method name and behave differently, safely, because
227
of the double-dispatch via
228
format.make_tags->tags_instance->get_tags_dict.
230
:return: The bytes of the tags file.
231
:seealso: Branch._set_tags_bytes.
233
return self._transport.get_bytes('tags')
235
def _get_nick(self, local=False, possible_transports=None):
236
config = self.get_config()
237
# explicit overrides master, but don't look for master if local is True
238
if not local and not config.has_explicit_nickname():
240
master = self.get_master_branch(possible_transports)
241
if master is not None:
242
# return the master branch value
244
except errors.BzrError, e:
245
# Silently fall back to local implicit nick if the master is
247
mutter("Could not connect to bound branch, "
248
"falling back to local nick.\n " + str(e))
249
return config.get_nickname()
157
return self.get_config().get_nickname()
251
159
def _set_nick(self, nick):
252
160
self.get_config().set_user_option('nickname', nick, warn_masked=True)
311
181
raise NotImplementedError(self.get_physical_lock_status)
314
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
315
"""Return the revision_id for a dotted revno.
317
:param revno: a tuple like (1,) or (1,1,2)
318
:param _cache_reverse: a private parameter enabling storage
319
of the reverse mapping in a top level cache. (This should
320
only be done in selective circumstances as we want to
321
avoid having the mapping cached multiple times.)
322
:return: the revision_id
323
:raises errors.NoSuchRevision: if the revno doesn't exist
325
rev_id = self._do_dotted_revno_to_revision_id(revno)
327
self._partial_revision_id_to_revno_cache[rev_id] = revno
330
def _do_dotted_revno_to_revision_id(self, revno):
331
"""Worker function for dotted_revno_to_revision_id.
333
Subclasses should override this if they wish to
334
provide a more efficient implementation.
337
return self.get_rev_id(revno[0])
338
revision_id_to_revno = self.get_revision_id_to_revno_map()
339
revision_ids = [revision_id for revision_id, this_revno
340
in revision_id_to_revno.iteritems()
341
if revno == this_revno]
342
if len(revision_ids) == 1:
343
return revision_ids[0]
345
revno_str = '.'.join(map(str, revno))
346
raise errors.NoSuchRevision(self, revno_str)
349
def revision_id_to_dotted_revno(self, revision_id):
350
"""Given a revision id, return its dotted revno.
352
:return: a tuple like (1,) or (400,1,3).
354
return self._do_revision_id_to_dotted_revno(revision_id)
356
def _do_revision_id_to_dotted_revno(self, revision_id):
357
"""Worker function for revision_id_to_revno."""
358
# Try the caches if they are loaded
359
result = self._partial_revision_id_to_revno_cache.get(revision_id)
360
if result is not None:
362
if self._revision_id_to_revno_cache:
363
result = self._revision_id_to_revno_cache.get(revision_id)
365
raise errors.NoSuchRevision(self, revision_id)
366
# Try the mainline as it's optimised
368
revno = self.revision_id_to_revno(revision_id)
370
except errors.NoSuchRevision:
371
# We need to load and use the full revno map after all
372
result = self.get_revision_id_to_revno_map().get(revision_id)
374
raise errors.NoSuchRevision(self, revision_id)
378
184
def get_revision_id_to_revno_map(self):
379
185
"""Return the revision_id => dotted revno map.
405
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(
407
220
revision_id_to_revno = dict((rev_id, revno)
408
for rev_id, depth, revno, end_of_merge
409
in self.iter_merge_sorted_revisions())
221
for seq_num, rev_id, depth, revno, end_of_merge
222
in merge_sorted_revisions)
410
223
return revision_id_to_revno
413
def iter_merge_sorted_revisions(self, start_revision_id=None,
414
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
415
"""Walk the revisions for a branch in merge sorted order.
417
Merge sorted order is the output from a merge-aware,
418
topological sort, i.e. all parents come before their
419
children going forward; the opposite for reverse.
421
:param start_revision_id: the revision_id to begin walking from.
422
If None, the branch tip is used.
423
:param stop_revision_id: the revision_id to terminate the walk
424
after. If None, the rest of history is included.
425
:param stop_rule: if stop_revision_id is not None, the precise rule
426
to use for termination:
427
* 'exclude' - leave the stop revision out of the result (default)
428
* 'include' - the stop revision is the last item in the result
429
* 'with-merges' - include the stop revision and all of its
430
merged revisions in the result
431
* 'with-merges-without-common-ancestry' - filter out revisions
432
that are in both ancestries
433
:param direction: either 'reverse' or 'forward':
434
* reverse means return the start_revision_id first, i.e.
435
start at the most recent revision and go backwards in history
436
* forward returns tuples in the opposite order to reverse.
437
Note in particular that forward does *not* do any intelligent
438
ordering w.r.t. depth as some clients of this API may like.
439
(If required, that ought to be done at higher layers.)
441
:return: an iterator over (revision_id, depth, revno, end_of_merge)
444
* revision_id: the unique id of the revision
445
* depth: How many levels of merging deep this node has been
447
* revno_sequence: This field provides a sequence of
448
revision numbers for all revisions. The format is:
449
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
450
branch that the revno is on. From left to right the REVNO numbers
451
are the sequence numbers within that branch of the revision.
452
* end_of_merge: When True the next node (earlier in history) is
453
part of a different merge.
455
# Note: depth and revno values are in the context of the branch so
456
# we need the full graph to get stable numbers, regardless of the
458
if self._merge_sorted_revisions_cache is None:
459
last_revision = self.last_revision()
460
known_graph = self.repository.get_known_graph_ancestry(
462
self._merge_sorted_revisions_cache = known_graph.merge_sort(
464
filtered = self._filter_merge_sorted_revisions(
465
self._merge_sorted_revisions_cache, start_revision_id,
466
stop_revision_id, stop_rule)
467
# Make sure we don't return revisions that are not part of the
468
# start_revision_id ancestry.
469
filtered = self._filter_start_non_ancestors(filtered)
470
if direction == 'reverse':
472
if direction == 'forward':
473
return reversed(list(filtered))
475
raise ValueError('invalid direction %r' % direction)
477
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
478
start_revision_id, stop_revision_id, stop_rule):
479
"""Iterate over an inclusive range of sorted revisions."""
480
rev_iter = iter(merge_sorted_revisions)
481
if start_revision_id is not None:
482
for node in rev_iter:
483
rev_id = node.key[-1]
484
if rev_id != start_revision_id:
487
# The decision to include the start or not
488
# depends on the stop_rule if a stop is provided
489
# so pop this node back into the iterator
490
rev_iter = chain(iter([node]), rev_iter)
492
if stop_revision_id is None:
494
for node in rev_iter:
495
rev_id = node.key[-1]
496
yield (rev_id, node.merge_depth, node.revno,
498
elif stop_rule == 'exclude':
499
for node in rev_iter:
500
rev_id = node.key[-1]
501
if rev_id == stop_revision_id:
503
yield (rev_id, node.merge_depth, node.revno,
505
elif stop_rule == 'include':
506
for node in rev_iter:
507
rev_id = node.key[-1]
508
yield (rev_id, node.merge_depth, node.revno,
510
if rev_id == stop_revision_id:
512
elif stop_rule == 'with-merges-without-common-ancestry':
513
# We want to exclude all revisions that are already part of the
514
# stop_revision_id ancestry.
515
graph = self.repository.get_graph()
516
ancestors = graph.find_unique_ancestors(start_revision_id,
518
for node in rev_iter:
519
rev_id = node.key[-1]
520
if rev_id not in ancestors:
522
yield (rev_id, node.merge_depth, node.revno,
524
elif stop_rule == 'with-merges':
525
stop_rev = self.repository.get_revision(stop_revision_id)
526
if stop_rev.parent_ids:
527
left_parent = stop_rev.parent_ids[0]
529
left_parent = _mod_revision.NULL_REVISION
530
# left_parent is the actual revision we want to stop logging at,
531
# since we want to show the merged revisions after the stop_rev too
532
reached_stop_revision_id = False
533
revision_id_whitelist = []
534
for node in rev_iter:
535
rev_id = node.key[-1]
536
if rev_id == left_parent:
537
# reached the left parent after the stop_revision
539
if (not reached_stop_revision_id or
540
rev_id in revision_id_whitelist):
541
yield (rev_id, node.merge_depth, node.revno,
543
if reached_stop_revision_id or rev_id == stop_revision_id:
544
# only do the merged revs of rev_id from now on
545
rev = self.repository.get_revision(rev_id)
547
reached_stop_revision_id = True
548
revision_id_whitelist.extend(rev.parent_ids)
550
raise ValueError('invalid stop_rule %r' % stop_rule)
552
def _filter_start_non_ancestors(self, rev_iter):
553
# If we started from a dotted revno, we want to consider it as a tip
554
# and don't want to yield revisions that are not part of its
555
# ancestry. Given the order guaranteed by the merge sort, we will see
556
# uninteresting descendants of the first parent of our tip before the
558
first = rev_iter.next()
559
(rev_id, merge_depth, revno, end_of_merge) = first
562
# We start at a mainline revision so by definition, all others
563
# revisions in rev_iter are ancestors
564
for node in rev_iter:
569
pmap = self.repository.get_parent_map([rev_id])
570
parents = pmap.get(rev_id, [])
572
whitelist.update(parents)
574
# If there is no parents, there is nothing of interest left
576
# FIXME: It's hard to test this scenario here as this code is never
577
# called in that case. -- vila 20100322
580
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
582
if rev_id in whitelist:
583
pmap = self.repository.get_parent_map([rev_id])
584
parents = pmap.get(rev_id, [])
585
whitelist.remove(rev_id)
586
whitelist.update(parents)
588
# We've reached the mainline, there is nothing left to
592
# A revision that is not part of the ancestry of our
595
yield (rev_id, merge_depth, revno, end_of_merge)
597
225
def leave_lock_in_place(self):
598
226
"""Tell this branch object not to release the physical lock when this
599
227
object is unlocked.
601
229
If lock_write doesn't return a token, then this method is not supported.
603
231
self.control_files.leave_in_place()
730
357
def set_revision_history(self, rev_history):
731
358
raise NotImplementedError(self.set_revision_history)
734
def set_parent(self, url):
735
"""See Branch.set_parent."""
736
# TODO: Maybe delete old location files?
737
# URLs should never be unicode, even on the local fs,
738
# FIXUP this and get_parent in a future branch format bump:
739
# read and rewrite the file. RBC 20060125
741
if isinstance(url, unicode):
743
url = url.encode('ascii')
744
except UnicodeEncodeError:
745
raise errors.InvalidURL(url,
746
"Urls must be 7-bit ascii, "
747
"use bzrlib.urlutils.escape")
748
url = urlutils.relative_url(self.base, url)
749
self._set_parent_location(url)
752
def set_stacked_on_url(self, url):
753
"""Set the URL this branch is stacked against.
755
:raises UnstackableBranchFormat: If the branch does not support
757
:raises UnstackableRepositoryFormat: If the repository does not support
760
if not self._format.supports_stacking():
761
raise errors.UnstackableBranchFormat(self._format, self.user_url)
762
# XXX: Changing from one fallback repository to another does not check
763
# that all the data you need is present in the new fallback.
764
# Possibly it should.
765
self._check_stackable_repo()
768
old_url = self.get_stacked_on_url()
769
except (errors.NotStacked, errors.UnstackableBranchFormat,
770
errors.UnstackableRepositoryFormat):
774
self._activate_fallback_location(url)
775
# write this out after the repository is stacked to avoid setting a
776
# stacked config that doesn't work.
777
self._set_config_location('stacked_on_location', url)
780
"""Change a branch to be unstacked, copying data as needed.
782
Don't call this directly, use set_stacked_on_url(None).
784
pb = ui.ui_factory.nested_progress_bar()
786
pb.update("Unstacking")
787
# The basic approach here is to fetch the tip of the branch,
788
# including all available ghosts, from the existing stacked
789
# repository into a new repository object without the fallbacks.
791
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
792
# correct for CHKMap repostiories
793
old_repository = self.repository
794
if len(old_repository._fallback_repositories) != 1:
795
raise AssertionError("can't cope with fallback repositories "
796
"of %r" % (self.repository,))
797
# unlock it, including unlocking the fallback
798
old_repository.unlock()
799
old_repository.lock_read()
801
# Repositories don't offer an interface to remove fallback
802
# repositories today; take the conceptually simpler option and just
803
# reopen it. We reopen it starting from the URL so that we
804
# get a separate connection for RemoteRepositories and can
805
# stream from one of them to the other. This does mean doing
806
# separate SSH connection setup, but unstacking is not a
807
# common operation so it's tolerable.
808
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
809
new_repository = new_bzrdir.find_repository()
810
self.repository = new_repository
811
if self.repository._fallback_repositories:
812
raise AssertionError("didn't expect %r to have "
813
"fallback_repositories"
814
% (self.repository,))
815
# this is not paired with an unlock because it's just restoring
816
# the previous state; the lock's released when set_stacked_on_url
818
self.repository.lock_write()
819
# XXX: If you unstack a branch while it has a working tree
820
# with a pending merge, the pending-merged revisions will no
821
# longer be present. You can (probably) revert and remerge.
823
# XXX: This only fetches up to the tip of the repository; it
824
# doesn't bring across any tags. That's fairly consistent
825
# with how branch works, but perhaps not ideal.
826
self.repository.fetch(old_repository,
827
revision_id=self.last_revision(),
830
old_repository.unlock()
834
def _set_tags_bytes(self, bytes):
835
"""Mirror method for _get_tags_bytes.
837
:seealso: Branch._get_tags_bytes.
839
return _run_with_write_locked_target(self, self._transport.put_bytes,
842
360
def _cache_revision_history(self, rev_history):
843
361
"""Set the cached revision history to rev_history.
1002
497
except ValueError:
1003
498
raise errors.NoSuchRevision(self, revision_id)
1006
500
def get_rev_id(self, revno, history=None):
1007
501
"""Find the revision id of the specified revno."""
1009
503
return _mod_revision.NULL_REVISION
1010
last_revno, last_revid = self.last_revision_info()
1011
if revno == last_revno:
1013
if revno <= 0 or revno > last_revno:
505
history = self.revision_history()
506
if revno <= 0 or revno > len(history):
1014
507
raise errors.NoSuchRevision(self, revno)
1015
distance_from_last = last_revno - revno
1016
if len(self._partial_revision_history_cache) <= distance_from_last:
1017
self._extend_partial_history(distance_from_last)
1018
return self._partial_revision_history_cache[distance_from_last]
508
return history[revno - 1]
1021
510
def pull(self, source, overwrite=False, stop_revision=None,
1022
possible_transports=None, *args, **kwargs):
511
possible_transports=None):
1023
512
"""Mirror source into this branch.
1025
514
This branch is considered to be 'local', having low latency.
1027
516
:returns: PullResult instance
1029
return InterBranch.get(source, self).pull(overwrite=overwrite,
1030
stop_revision=stop_revision,
1031
possible_transports=possible_transports, *args, **kwargs)
518
raise NotImplementedError(self.pull)
1033
def push(self, target, overwrite=False, stop_revision=None, *args,
520
def push(self, target, overwrite=False, stop_revision=None):
1035
521
"""Mirror this branch into target.
1037
523
This branch is considered to be 'local', having low latency.
1039
return InterBranch.get(self, target).push(overwrite, stop_revision,
1042
def lossy_push(self, target, stop_revision=None):
1043
"""Push deltas into another branch.
1045
:note: This does not, like push, retain the revision ids from
1046
the source branch and will, rather than adding bzr-specific
1047
metadata, push only those semantics of the revision that can be
1048
natively represented by this branch' VCS.
1050
:param target: Target branch
1051
:param stop_revision: Revision to push, defaults to last revision.
1052
:return: BranchPushResult with an extra member revidmap:
1053
A dictionary mapping revision ids from the target branch
1054
to new revision ids in the target branch, for each
1055
revision that was pushed.
1057
inter = InterBranch.get(self, target)
1058
lossy_push = getattr(inter, "lossy_push", None)
1059
if lossy_push is None:
1060
raise errors.LossyPushToSameVCS(self, target)
1061
return lossy_push(stop_revision)
525
raise NotImplementedError(self.push)
1063
527
def basis_tree(self):
1064
528
"""Return `Tree` object for last revision."""
1065
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)
1067
554
def get_parent(self):
1068
555
"""Return the parent location of the branch.
1070
This is the default location for pull/missing. The usual
557
This is the default location for push/pull/missing. The usual
1071
558
pattern is that the user can override it by specifying a
1074
parent = self._get_parent_location()
1077
# This is an old-format absolute path to a local branch
1078
# turn it into a url
1079
if parent.startswith('/'):
1080
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1082
return urlutils.join(self.base[:-1], parent)
1083
except errors.InvalidURLJoin, e:
1084
raise errors.InaccessibleParent(parent, self.user_url)
1086
def _get_parent_location(self):
1087
raise NotImplementedError(self._get_parent_location)
561
raise NotImplementedError(self.get_parent)
1089
563
def _set_config_location(self, name, url, config=None,
1090
564
make_relative=False):
1191
642
self.check_real_revno(revno)
1193
644
def check_real_revno(self, revno):
1195
646
Check whether a revno corresponds to a real revision.
1196
647
Zero (the NULL revision) is considered invalid
1198
649
if revno < 1 or revno > self.revno():
1199
raise errors.InvalidRevisionNumber(revno)
650
raise InvalidRevisionNumber(revno)
1201
652
@needs_read_lock
1202
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
653
def clone(self, to_bzrdir, revision_id=None):
1203
654
"""Clone this branch into to_bzrdir preserving all semantic values.
1205
Most API users will want 'create_clone_on_transport', which creates a
1206
new bzrdir and branch on the fly.
1208
656
revision_id: if not None, the revision history in the new branch will
1209
657
be truncated to end with revision_id.
1211
result = to_bzrdir.create_branch()
1214
if repository_policy is not None:
1215
repository_policy.configure_branch(result)
1216
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)
1221
663
@needs_read_lock
1222
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
664
def sprout(self, to_bzrdir, revision_id=None):
1223
665
"""Create a new line of development from the branch, into to_bzrdir.
1225
to_bzrdir controls the branch format.
1227
667
revision_id: if not None, the revision history in the new branch will
1228
668
be truncated to end with revision_id.
1230
if (repository_policy is not None and
1231
repository_policy.requires_stacking()):
1232
to_bzrdir._format.require_stacking(_skip_repo=True)
1233
result = to_bzrdir.create_branch()
1236
if repository_policy is not None:
1237
repository_policy.configure_branch(result)
1238
self.copy_content_into(result, revision_id=revision_id)
1239
result.set_parent(self.bzrdir.root_transport.base)
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)
1244
675
def _synchronize_history(self, destination, revision_id):
1245
676
"""Synchronize last revision and revision history between branches.
1247
678
This version is most efficient when the destination is also a
1248
BzrBranch6, but works for BzrBranch5, as long as the destination's
1249
repository contains all the lefthand ancestors of the intended
1250
last_revision. If not, set_last_revision_info will fail.
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
1252
684
:param destination: The branch to copy the history into
1253
685
:param revision_id: The revision-id to truncate history at. May
1254
686
be None to copy complete history.
1256
source_revno, source_revision_id = self.last_revision_info()
1257
if revision_id is None:
1258
revno, revision_id = source_revno, source_revision_id
1260
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 != []:
1262
revno = graph.find_distance_to_null(revision_id,
1263
[(source_revision_id, source_revno)])
1264
except errors.GhostRevisionsHaveNoRevno:
1265
# Default to 1, if we can't find anything else
1267
destination.set_last_revision_info(revno, revision_id)
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)
1269
699
@needs_read_lock
1270
700
def copy_content_into(self, destination, revision_id=None):
1284
713
destination.set_parent(parent)
1285
if self._push_should_merge_tags():
1286
self.tags.merge_to(destination.tags)
1288
def update_references(self, target):
1289
if not getattr(self._format, 'supports_reference_locations', False):
1291
reference_dict = self._get_all_reference_info()
1292
if len(reference_dict) == 0:
1294
old_base = self.base
1295
new_base = target.base
1296
target_reference_dict = target._get_all_reference_info()
1297
for file_id, (tree_path, branch_location) in (
1298
reference_dict.items()):
1299
branch_location = urlutils.rebase_url(branch_location,
1301
target_reference_dict.setdefault(
1302
file_id, (tree_path, branch_location))
1303
target._set_all_reference_info(target_reference_dict)
714
self.tags.merge_to(destination.tags)
1305
716
@needs_read_lock
1306
def check(self, refs):
1307
718
"""Check consistency of the branch.
1309
720
In particular this checks that revisions given in the revision-history
1310
do actually match up in the revision graph, and that they're all
721
do actually match up in the revision graph, and that they're all
1311
722
present in the repository.
1313
724
Callers will typically also want to check the repository.
1315
:param refs: Calculated refs for this branch as specified by
1316
branch._get_check_refs()
1317
726
:return: A BranchCheckResult.
1319
result = BranchCheckResult(self)
1320
last_revno, last_revision_id = self.last_revision_info()
1321
actual_revno = refs[('lefthand-distance', last_revision_id)]
1322
if actual_revno != last_revno:
1323
result.errors.append(errors.BzrCheckError(
1324
'revno does not match len(mainline) %s != %s' % (
1325
last_revno, actual_revno)))
1326
# TODO: We should probably also check that self.revision_history
1327
# matches the repository for older branch formats.
1328
# If looking for the code that cross-checks repository parents against
1329
# the iter_reverse_revision_history output, that is now a repository
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)
1333
746
def _get_checkout_format(self):
1334
747
"""Return the most suitable metadir for a checkout of this branch.
1414
805
basis_tree.unlock()
1418
def reconcile(self, thorough=True):
1419
"""Make sure the data stored in this branch is consistent."""
1420
from bzrlib.reconcile import BranchReconciler
1421
reconciler = BranchReconciler(self, thorough=thorough)
1422
reconciler.reconcile()
1425
def reference_parent(self, file_id, path, possible_transports=None):
808
def reference_parent(self, file_id, path):
1426
809
"""Return the parent branch for a tree-reference file_id
1427
810
:param file_id: The file_id of the tree reference
1428
811
:param path: The path of the file_id in the tree
1429
812
:return: A branch associated with the file_id
1431
814
# FIXME should provide multiple branches, based on config
1432
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1433
possible_transports=possible_transports)
815
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1435
817
def supports_tags(self):
1436
818
return self._format.supports_tags()
1438
def automatic_tag_name(self, revision_id):
1439
"""Try to automatically find the tag name for a revision.
1441
:param revision_id: Revision id of the revision.
1442
:return: A tag name or None if no tag name could be determined.
1444
for hook in Branch.hooks['automatic_tag_name']:
1445
ret = hook(self, revision_id)
1450
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1452
"""Ensure that revision_b is a descendant of revision_a.
1454
This is a helper function for update_revisions.
1456
:raises: DivergedBranches if revision_b has diverged from revision_a.
1457
:returns: True if revision_b is a descendant of revision_a.
1459
relation = self._revision_relations(revision_a, revision_b, graph)
1460
if relation == 'b_descends_from_a':
1462
elif relation == 'diverged':
1463
raise errors.DivergedBranches(self, other_branch)
1464
elif relation == 'a_descends_from_b':
1467
raise AssertionError("invalid relation: %r" % (relation,))
1469
def _revision_relations(self, revision_a, revision_b, graph):
1470
"""Determine the relationship between two revisions.
1472
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1474
heads = graph.heads([revision_a, revision_b])
1475
if heads == set([revision_b]):
1476
return 'b_descends_from_a'
1477
elif heads == set([revision_a, revision_b]):
1478
# These branches have diverged
1480
elif heads == set([revision_a]):
1481
return 'a_descends_from_b'
1483
raise AssertionError("invalid heads: %r" % (heads,))
1486
821
class BranchFormat(object):
1487
822
"""An encapsulation of the initialization and open routines for a format.
1596
920
control_files = lockable_files.LockableFiles(branch_transport,
1597
921
lock_name, lock_class)
1598
922
control_files.create_lock()
1600
control_files.lock_write()
1601
except errors.LockContention:
1602
if lock_type != 'branch4':
923
control_files.lock_write()
1608
utf8_files += [('format', self.get_format_string())]
925
control_files.put_utf8('format', self.get_format_string())
1610
for (filename, content) in utf8_files:
1611
branch_transport.put_bytes(
1613
mode=a_bzrdir._get_file_mode())
927
for file, content in utf8_files:
928
control_files.put_utf8(file, content)
1616
control_files.unlock()
1617
branch = self.open(a_bzrdir, name, _found=True)
1618
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
930
control_files.unlock()
931
return self.open(a_bzrdir, _found=True)
1621
def initialize(self, a_bzrdir, name=None):
1622
"""Create a branch of this format in a_bzrdir.
1624
:param name: Name of the colocated branch to create.
933
def initialize(self, a_bzrdir):
934
"""Create a branch of this format in a_bzrdir."""
1626
935
raise NotImplementedError(self.initialize)
1628
937
def is_supported(self):
1629
938
"""Is this format supported?
1631
940
Supported formats can be initialized and opened.
1632
Unsupported formats may not support initialization or committing or
941
Unsupported formats may not support initialization or committing or
1633
942
some other features depending on the reason for not being supported.
1637
def make_tags(self, branch):
1638
"""Create a tags object for branch.
1640
This method is on BranchFormat, because BranchFormats are reflected
1641
over the wire via network_name(), whereas full Branch instances require
1642
multiple VFS method calls to operate at all.
1644
The default implementation returns a disabled-tags instance.
1646
Note that it is normal for branch to be a RemoteBranch when using tags
1649
return DisabledTags(branch)
1651
def network_name(self):
1652
"""A simple byte string uniquely identifying this format for RPC calls.
1654
MetaDir branch formats use their disk format string to identify the
1655
repository over the wire. All in one formats such as bzr < 0.8, and
1656
foreign formats like svn/git and hg should use some marker which is
1657
unique and immutable.
1659
raise NotImplementedError(self.network_name)
1661
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
946
def open(self, a_bzrdir, _found=False):
1662
947
"""Return the branch object for a_bzrdir
1664
:param a_bzrdir: A BzrDir that contains a branch.
1665
:param name: Name of colocated branch to open
1666
:param _found: a private parameter, do not use it. It is used to
1667
indicate if format probing has already be done.
1668
:param ignore_fallbacks: when set, no fallback branches will be opened
1669
(if there are any). Default is to open fallbacks.
949
_found is a private parameter, do not use it. It is used to indicate
950
if format probing has already be done.
1671
952
raise NotImplementedError(self.open)
1674
955
def register_format(klass, format):
1675
"""Register a metadir format."""
1676
956
klass._formats[format.get_format_string()] = format
1677
# Metadir formats have a network name of their format string, and get
1678
# registered as class factories.
1679
network_format_registry.register(format.get_format_string(), format.__class__)
1682
959
def set_default_format(klass, format):
1683
960
klass._default_format = format
1685
def supports_set_append_revisions_only(self):
1686
"""True if this format supports set_append_revisions_only."""
1689
def supports_stacking(self):
1690
"""True if this format records a stacked-on branch."""
1694
963
def unregister_format(klass, format):
964
assert klass._formats[format.get_format_string()] is format
1695
965
del klass._formats[format.get_format_string()]
1697
967
def __str__(self):
1698
return self.get_format_description().rstrip()
968
return self.get_format_string().rstrip()
1700
970
def supports_tags(self):
1701
971
"""True if this format supports tags stored in the branch"""
1702
972
return False # by default
974
# XXX: Probably doesn't really belong here -- mbp 20070212
975
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
977
branch_transport = a_bzrdir.get_branch_transport(self)
978
control_files = lockable_files.LockableFiles(branch_transport,
979
lock_filename, lock_class)
980
control_files.create_lock()
981
control_files.lock_write()
983
for filename, content in utf8_files:
984
control_files.put_utf8(filename, content)
986
control_files.unlock()
1705
989
class BranchHooks(Hooks):
1706
990
"""A dictionary mapping hook name to a list of callables for branch hooks.
1708
992
e.g. ['set_rh'] Is the list of items to be called when the
1709
993
set_revision_history function is invoked.
1718
1002
Hooks.__init__(self)
1719
self.create_hook(HookPoint('set_rh',
1720
"Invoked whenever the revision history has been set via "
1721
"set_revision_history. The api signature is (branch, "
1722
"revision_history), and the branch will be write-locked. "
1723
"The set_rh hook can be expensive for bzr to trigger, a better "
1724
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1725
self.create_hook(HookPoint('open',
1726
"Called with the Branch object that has been opened after a "
1727
"branch is opened.", (1, 8), None))
1728
self.create_hook(HookPoint('post_push',
1729
"Called after a push operation completes. post_push is called "
1730
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1731
"bzr client.", (0, 15), None))
1732
self.create_hook(HookPoint('post_pull',
1733
"Called after a pull operation completes. post_pull is called "
1734
"with a bzrlib.branch.PullResult object and only runs in the "
1735
"bzr client.", (0, 15), None))
1736
self.create_hook(HookPoint('pre_commit',
1737
"Called after a commit is calculated but before it is is "
1738
"completed. pre_commit is called with (local, master, old_revno, "
1739
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1740
"). old_revid is NULL_REVISION for the first commit to a branch, "
1741
"tree_delta is a TreeDelta object describing changes from the "
1742
"basis revision. hooks MUST NOT modify this delta. "
1743
" future_tree is an in-memory tree obtained from "
1744
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1745
"tree.", (0,91), None))
1746
self.create_hook(HookPoint('post_commit',
1747
"Called in the bzr client after a commit has completed. "
1748
"post_commit is called with (local, master, old_revno, old_revid, "
1749
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1750
"commit to a branch.", (0, 15), None))
1751
self.create_hook(HookPoint('post_uncommit',
1752
"Called in the bzr client after an uncommit completes. "
1753
"post_uncommit is called with (local, master, old_revno, "
1754
"old_revid, new_revno, new_revid) where local is the local branch "
1755
"or None, master is the target branch, and an empty branch "
1756
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1757
self.create_hook(HookPoint('pre_change_branch_tip',
1758
"Called in bzr client and server before a change to the tip of a "
1759
"branch is made. pre_change_branch_tip is called with a "
1760
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1761
"commit, uncommit will all trigger this hook.", (1, 6), None))
1762
self.create_hook(HookPoint('post_change_branch_tip',
1763
"Called in bzr client and server after a change to the tip of a "
1764
"branch is made. post_change_branch_tip is called with a "
1765
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1766
"commit, uncommit will all trigger this hook.", (1, 4), None))
1767
self.create_hook(HookPoint('transform_fallback_location',
1768
"Called when a stacked branch is activating its fallback "
1769
"locations. transform_fallback_location is called with (branch, "
1770
"url), and should return a new url. Returning the same url "
1771
"allows it to be used as-is, returning a different one can be "
1772
"used to cause the branch to stack on a closer copy of that "
1773
"fallback_location. Note that the branch cannot have history "
1774
"accessing methods called on it during this hook because the "
1775
"fallback locations have not been activated. When there are "
1776
"multiple hooks installed for transform_fallback_location, "
1777
"all are called with the url returned from the previous hook."
1778
"The order is however undefined.", (1, 9), None))
1779
self.create_hook(HookPoint('automatic_tag_name',
1780
"Called to determine an automatic tag name for a revision."
1781
"automatic_tag_name is called with (branch, revision_id) and "
1782
"should return a tag name or None if no tag name could be "
1783
"determined. The first non-None tag name returned will be used.",
1785
self.create_hook(HookPoint('post_branch_init',
1786
"Called after new branch initialization completes. "
1787
"post_branch_init is called with a "
1788
"bzrlib.branch.BranchInitHookParams. "
1789
"Note that init, branch and checkout (both heavyweight and "
1790
"lightweight) will all trigger this hook.", (2, 2), None))
1791
self.create_hook(HookPoint('post_switch',
1792
"Called after a checkout switches branch. "
1793
"post_switch is called with a "
1794
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1003
# Introduced in 0.15:
1004
# invoked whenever the revision history has been set
1005
# with set_revision_history. The api signature is
1006
# (branch, revision_history), and the branch will
1009
# invoked after a push operation completes.
1010
# the api signature is
1012
# containing the members
1013
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1014
# where local is the local target branch or None, master is the target
1015
# master branch, and the rest should be self explanatory. The source
1016
# is read locked and the target branches write locked. Source will
1017
# be the local low-latency branch.
1018
self['post_push'] = []
1019
# invoked after a pull operation completes.
1020
# the api signature is
1022
# containing the members
1023
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1024
# where local is the local branch or None, master is the target
1025
# master branch, and the rest should be self explanatory. The source
1026
# is read locked and the target branches write locked. The local
1027
# branch is the low-latency branch.
1028
self['post_pull'] = []
1029
# invoked before a commit operation takes place.
1030
# the api signature is
1031
# (local, master, old_revno, old_revid, future_revno, future_revid,
1032
# tree_delta, future_tree).
1033
# old_revid is NULL_REVISION for the first commit to a branch
1034
# tree_delta is a TreeDelta object describing changes from the basis
1035
# revision, hooks MUST NOT modify this delta
1036
# future_tree is an in-memory tree obtained from
1037
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1038
self['pre_commit'] = []
1039
# invoked after a commit operation completes.
1040
# the api signature is
1041
# (local, master, old_revno, old_revid, new_revno, new_revid)
1042
# old_revid is NULL_REVISION for the first commit to a branch.
1043
self['post_commit'] = []
1044
# invoked after a uncommit operation completes.
1045
# the api signature is
1046
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1047
# local is the local branch or None, master is the target branch,
1048
# and an empty branch recieves new_revno of 0, new_revid of None.
1049
self['post_uncommit'] = []
1798
1052
# install the default hooks into the Branch class.
1799
1053
Branch.hooks = BranchHooks()
1802
class ChangeBranchTipParams(object):
1803
"""Object holding parameters passed to *_change_branch_tip hooks.
1805
There are 5 fields that hooks may wish to access:
1807
:ivar branch: the branch being changed
1808
:ivar old_revno: revision number before the change
1809
:ivar new_revno: revision number after the change
1810
:ivar old_revid: revision id before the change
1811
:ivar new_revid: revision id after the change
1813
The revid fields are strings. The revno fields are integers.
1816
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1817
"""Create a group of ChangeBranchTip parameters.
1819
:param branch: The branch being changed.
1820
:param old_revno: Revision number before the change.
1821
:param new_revno: Revision number after the change.
1822
:param old_revid: Tip revision id before the change.
1823
:param new_revid: Tip revision id after the change.
1825
self.branch = branch
1826
self.old_revno = old_revno
1827
self.new_revno = new_revno
1828
self.old_revid = old_revid
1829
self.new_revid = new_revid
1831
def __eq__(self, other):
1832
return self.__dict__ == other.__dict__
1835
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1836
self.__class__.__name__, self.branch,
1837
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1840
class BranchInitHookParams(object):
1841
"""Object holding parameters passed to *_branch_init hooks.
1843
There are 4 fields that hooks may wish to access:
1845
:ivar format: the branch format
1846
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1847
:ivar name: name of colocated branch, if any (or None)
1848
:ivar branch: the branch created
1850
Note that for lightweight checkouts, the bzrdir and format fields refer to
1851
the checkout, hence they are different from the corresponding fields in
1852
branch, which refer to the original branch.
1855
def __init__(self, format, a_bzrdir, name, branch):
1856
"""Create a group of BranchInitHook parameters.
1858
:param format: the branch format
1859
:param a_bzrdir: the BzrDir where the branch will be/has been
1861
:param name: name of colocated branch, if any (or None)
1862
:param branch: the branch created
1864
Note that for lightweight checkouts, the bzrdir and format fields refer
1865
to the checkout, hence they are different from the corresponding fields
1866
in branch, which refer to the original branch.
1868
self.format = format
1869
self.bzrdir = a_bzrdir
1871
self.branch = branch
1873
def __eq__(self, other):
1874
return self.__dict__ == other.__dict__
1878
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1880
return "<%s of format:%s bzrdir:%s>" % (
1881
self.__class__.__name__, self.branch,
1882
self.format, self.bzrdir)
1885
class SwitchHookParams(object):
1886
"""Object holding parameters passed to *_switch hooks.
1888
There are 4 fields that hooks may wish to access:
1890
:ivar control_dir: BzrDir of the checkout to change
1891
:ivar to_branch: branch that the checkout is to reference
1892
:ivar force: skip the check for local commits in a heavy checkout
1893
:ivar revision_id: revision ID to switch to (or None)
1896
def __init__(self, control_dir, to_branch, force, revision_id):
1897
"""Create a group of SwitchHook parameters.
1899
:param control_dir: BzrDir of the checkout to change
1900
:param to_branch: branch that the checkout is to reference
1901
:param force: skip the check for local commits in a heavy checkout
1902
:param revision_id: revision ID to switch to (or None)
1904
self.control_dir = control_dir
1905
self.to_branch = to_branch
1907
self.revision_id = revision_id
1909
def __eq__(self, other):
1910
return self.__dict__ == other.__dict__
1913
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1914
self.control_dir, self.to_branch,
1918
1056
class BzrBranchFormat4(BranchFormat):
1919
1057
"""Bzr branch format 4.
1927
1065
"""See BranchFormat.get_format_description()."""
1928
1066
return "Branch format 4"
1930
def initialize(self, a_bzrdir, name=None):
1068
def initialize(self, a_bzrdir):
1931
1069
"""Create a branch of this format in a_bzrdir."""
1932
1070
utf8_files = [('revision-history', ''),
1933
1071
('branch-name', ''),
1935
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1073
return self._initialize_helper(a_bzrdir, utf8_files,
1936
1074
lock_type='branch4', set_format=False)
1938
1076
def __init__(self):
1939
1077
super(BzrBranchFormat4, self).__init__()
1940
1078
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1942
def network_name(self):
1943
"""The network name for this format is the control dirs disk label."""
1944
return self._matchingbzrdir.get_format_string()
1080
def open(self, a_bzrdir, _found=False):
1081
"""Return the branch object for a_bzrdir
1946
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1947
"""See BranchFormat.open()."""
1083
_found is a private parameter, do not use it. It is used to indicate
1084
if format probing has already be done.
1949
1087
# we are being called directly and must probe.
1950
1088
raise NotImplementedError
1951
1089
return BzrBranch(_format=self,
1952
1090
_control_files=a_bzrdir._control_files,
1953
1091
a_bzrdir=a_bzrdir,
1955
1092
_repository=a_bzrdir.open_repository())
1957
1094
def __str__(self):
1958
1095
return "Bazaar-NG branch format 4"
1961
class BranchFormatMetadir(BranchFormat):
1962
"""Common logic for meta-dir based branch formats."""
1964
def _branch_class(self):
1965
"""What class to instantiate on open calls."""
1966
raise NotImplementedError(self._branch_class)
1968
def network_name(self):
1969
"""A simple byte string uniquely identifying this format for RPC calls.
1971
Metadir branch formats use their format string.
1098
class BzrBranchFormat5(BranchFormat):
1099
"""Bzr branch format 5.
1102
- a revision-history file.
1104
- a lock dir guarding the branch itself
1105
- all of this stored in a branch/ subdirectory
1106
- works with shared repositories.
1108
This format is new in bzr 0.8.
1111
def get_format_string(self):
1112
"""See BranchFormat.get_format_string()."""
1113
return "Bazaar-NG branch format 5\n"
1115
def get_format_description(self):
1116
"""See BranchFormat.get_format_description()."""
1117
return "Branch format 5"
1119
def initialize(self, a_bzrdir):
1120
"""Create a branch of this format in a_bzrdir."""
1121
utf8_files = [('revision-history', ''),
1122
('branch-name', ''),
1124
return self._initialize_helper(a_bzrdir, utf8_files)
1127
super(BzrBranchFormat5, self).__init__()
1128
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1130
def open(self, a_bzrdir, _found=False):
1131
"""Return the branch object for a_bzrdir
1133
_found is a private parameter, do not use it. It is used to indicate
1134
if format probing has already be done.
1973
return self.get_format_string()
1975
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1976
"""See BranchFormat.open()."""
1978
format = BranchFormat.find_format(a_bzrdir, name=name)
1979
if format.__class__ != self.__class__:
1980
raise AssertionError("wrong format %r found for %r" %
1982
transport = a_bzrdir.get_branch_transport(None, name=name)
1137
format = BranchFormat.find_format(a_bzrdir)
1138
assert format.__class__ == self.__class__
1140
transport = a_bzrdir.get_branch_transport(None)
1984
1141
control_files = lockable_files.LockableFiles(transport, 'lock',
1985
1142
lockdir.LockDir)
1986
return self._branch_class()(_format=self,
1143
return BzrBranch5(_format=self,
1987
1144
_control_files=control_files,
1989
1145
a_bzrdir=a_bzrdir,
1990
_repository=a_bzrdir.find_repository(),
1991
ignore_fallbacks=ignore_fallbacks)
1992
except errors.NoSuchFile:
1993
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1996
super(BranchFormatMetadir, self).__init__()
1997
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1998
self._matchingbzrdir.set_branch_format(self)
2000
def supports_tags(self):
2004
class BzrBranchFormat5(BranchFormatMetadir):
2005
"""Bzr branch format 5.
2008
- a revision-history file.
2010
- a lock dir guarding the branch itself
2011
- all of this stored in a branch/ subdirectory
2012
- works with shared repositories.
2014
This format is new in bzr 0.8.
2017
def _branch_class(self):
2020
def get_format_string(self):
2021
"""See BranchFormat.get_format_string()."""
2022
return "Bazaar-NG branch format 5\n"
2024
def get_format_description(self):
2025
"""See BranchFormat.get_format_description()."""
2026
return "Branch format 5"
2028
def initialize(self, a_bzrdir, name=None):
2029
"""Create a branch of this format in a_bzrdir."""
2030
utf8_files = [('revision-history', ''),
2031
('branch-name', ''),
2033
return self._initialize_helper(a_bzrdir, utf8_files, name)
2035
def supports_tags(self):
2039
class BzrBranchFormat6(BranchFormatMetadir):
1146
_repository=a_bzrdir.find_repository())
1148
raise NotBranchError(path=transport.base)
1151
class BzrBranchFormat6(BzrBranchFormat5):
2040
1152
"""Branch format with last-revision and tags.
2042
1154
Unlike previous formats, this has no explicit revision history. Instead,
2058
1167
"""See BranchFormat.get_format_description()."""
2059
1168
return "Branch format 6"
2061
def initialize(self, a_bzrdir, name=None):
2062
"""Create a branch of this format in a_bzrdir."""
2063
utf8_files = [('last-revision', '0 null:\n'),
2064
('branch.conf', ''),
2067
return self._initialize_helper(a_bzrdir, utf8_files, name)
2069
def make_tags(self, branch):
2070
"""See bzrlib.branch.BranchFormat.make_tags()."""
2071
return BasicTags(branch)
2073
def supports_set_append_revisions_only(self):
2077
class BzrBranchFormat8(BranchFormatMetadir):
2078
"""Metadir format supporting storing locations of subtree branches."""
2080
def _branch_class(self):
2083
def get_format_string(self):
2084
"""See BranchFormat.get_format_string()."""
2085
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2087
def get_format_description(self):
2088
"""See BranchFormat.get_format_description()."""
2089
return "Branch format 8"
2091
def initialize(self, a_bzrdir, name=None):
2092
"""Create a branch of this format in a_bzrdir."""
2093
utf8_files = [('last-revision', '0 null:\n'),
2094
('branch.conf', ''),
2098
return self._initialize_helper(a_bzrdir, utf8_files, name)
2101
super(BzrBranchFormat8, self).__init__()
2102
self._matchingbzrdir.repository_format = \
2103
RepositoryFormatKnitPack5RichRoot()
2105
def make_tags(self, branch):
2106
"""See bzrlib.branch.BranchFormat.make_tags()."""
2107
return BasicTags(branch)
2109
def supports_set_append_revisions_only(self):
2112
def supports_stacking(self):
2115
supports_reference_locations = True
2118
class BzrBranchFormat7(BzrBranchFormat8):
2119
"""Branch format with last-revision, tags, and a stacked location pointer.
2121
The stacked location pointer is passed down to the repository and requires
2122
a repository format with supports_external_lookups = True.
2124
This format was introduced in bzr 1.6.
2127
def initialize(self, a_bzrdir, name=None):
2128
"""Create a branch of this format in a_bzrdir."""
2129
utf8_files = [('last-revision', '0 null:\n'),
2130
('branch.conf', ''),
2133
return self._initialize_helper(a_bzrdir, utf8_files, name)
2135
def _branch_class(self):
2138
def get_format_string(self):
2139
"""See BranchFormat.get_format_string()."""
2140
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2142
def get_format_description(self):
2143
"""See BranchFormat.get_format_description()."""
2144
return "Branch format 7"
2146
def supports_set_append_revisions_only(self):
2149
supports_reference_locations = False
1170
def initialize(self, a_bzrdir):
1171
"""Create a branch of this format in a_bzrdir."""
1172
utf8_files = [('last-revision', '0 null:\n'),
1173
('branch.conf', ''),
1176
return self._initialize_helper(a_bzrdir, utf8_files)
1178
def open(self, a_bzrdir, _found=False):
1179
"""Return the branch object for a_bzrdir
1181
_found is a private parameter, do not use it. It is used to indicate
1182
if format probing has already be done.
1185
format = BranchFormat.find_format(a_bzrdir)
1186
assert format.__class__ == self.__class__
1187
transport = a_bzrdir.get_branch_transport(None)
1188
control_files = lockable_files.LockableFiles(transport, 'lock',
1190
return BzrBranch6(_format=self,
1191
_control_files=control_files,
1193
_repository=a_bzrdir.find_repository())
1195
def supports_tags(self):
2152
1199
class BranchReferenceFormat(BranchFormat):
2171
1218
def get_reference(self, a_bzrdir):
2172
1219
"""See BranchFormat.get_reference()."""
2173
1220
transport = a_bzrdir.get_branch_transport(None)
2174
return transport.get_bytes('location')
1221
return transport.get('location').read()
2176
1223
def set_reference(self, a_bzrdir, to_branch):
2177
1224
"""See BranchFormat.set_reference()."""
2178
1225
transport = a_bzrdir.get_branch_transport(None)
2179
1226
location = transport.put_bytes('location', to_branch.base)
2181
def initialize(self, a_bzrdir, name=None, target_branch=None):
1228
def initialize(self, a_bzrdir, target_branch=None):
2182
1229
"""Create a branch of this format in a_bzrdir."""
2183
1230
if target_branch is None:
2184
1231
# this format does not implement branch itself, thus the implicit
2185
1232
# creation contract must see it as uninitializable
2186
1233
raise errors.UninitializableFormat(self)
2187
mutter('creating branch reference in %s', a_bzrdir.user_url)
2188
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1234
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1235
branch_transport = a_bzrdir.get_branch_transport(self)
2189
1236
branch_transport.put_bytes('location',
2190
target_branch.bzrdir.user_url)
1237
target_branch.bzrdir.root_transport.base)
2191
1238
branch_transport.put_bytes('format', self.get_format_string())
2193
a_bzrdir, name, _found=True,
1240
a_bzrdir, _found=True,
2194
1241
possible_transports=[target_branch.bzrdir.root_transport])
2195
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2198
1243
def __init__(self):
2199
1244
super(BranchReferenceFormat, self).__init__()
2200
1245
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2201
self._matchingbzrdir.set_branch_format(self)
2203
1247
def _make_reference_clone_function(format, a_branch):
2204
1248
"""Create a clone() routine for a branch dynamically."""
2205
def clone(to_bzrdir, revision_id=None,
2206
repository_policy=None):
1249
def clone(to_bzrdir, revision_id=None):
2207
1250
"""See Branch.clone()."""
2208
return format.initialize(to_bzrdir, target_branch=a_branch)
1251
return format.initialize(to_bzrdir, a_branch)
2209
1252
# cannot obey revision_id limits when cloning a reference ...
2210
1253
# FIXME RBC 20060210 either nuke revision_id for clone, or
2211
1254
# emit some sort of warning/error to the caller ?!
2214
def open(self, a_bzrdir, name=None, _found=False, location=None,
2215
possible_transports=None, ignore_fallbacks=False):
1257
def open(self, a_bzrdir, _found=False, location=None,
1258
possible_transports=None):
2216
1259
"""Return the branch that the branch reference in a_bzrdir points at.
2218
:param a_bzrdir: A BzrDir that contains a branch.
2219
:param name: Name of colocated branch to open, if any
2220
:param _found: a private parameter, do not use it. It is used to
2221
indicate if format probing has already be done.
2222
:param ignore_fallbacks: when set, no fallback branches will be opened
2223
(if there are any). Default is to open fallbacks.
2224
:param location: The location of the referenced branch. If
2225
unspecified, this will be determined from the branch reference in
2227
:param possible_transports: An optional reusable transports list.
1261
_found is a private parameter, do not use it. It is used to indicate
1262
if format probing has already be done.
2230
format = BranchFormat.find_format(a_bzrdir, name=name)
2231
if format.__class__ != self.__class__:
2232
raise AssertionError("wrong format %r found for %r" %
1265
format = BranchFormat.find_format(a_bzrdir)
1266
assert format.__class__ == self.__class__
2234
1267
if location is None:
2235
1268
location = self.get_reference(a_bzrdir)
2236
1269
real_bzrdir = bzrdir.BzrDir.open(
2237
1270
location, possible_transports=possible_transports)
2238
result = real_bzrdir.open_branch(name=name,
2239
ignore_fallbacks=ignore_fallbacks)
1271
result = real_bzrdir.open_branch()
2240
1272
# this changes the behaviour of result.clone to create a new reference
2241
1273
# rather than a copy of the content of the branch.
2242
1274
# I did not use a proxy object because that needs much more extensive
2252
network_format_registry = registry.FormatRegistry()
2253
"""Registry of formats indexed by their network name.
2255
The network name for a branch format is an identifier that can be used when
2256
referring to formats with smart server operations. See
2257
BranchFormat.network_name() for more detail.
2261
1284
# formats which have no format string are not discoverable
2262
1285
# and not independently creatable, so are not registered.
2263
1286
__format5 = BzrBranchFormat5()
2264
1287
__format6 = BzrBranchFormat6()
2265
__format7 = BzrBranchFormat7()
2266
__format8 = BzrBranchFormat8()
2267
1288
BranchFormat.register_format(__format5)
2268
1289
BranchFormat.register_format(BranchReferenceFormat())
2269
1290
BranchFormat.register_format(__format6)
2270
BranchFormat.register_format(__format7)
2271
BranchFormat.register_format(__format8)
2272
BranchFormat.set_default_format(__format7)
1291
BranchFormat.set_default_format(__format6)
2273
1292
_legacy_formats = [BzrBranchFormat4(),
2275
network_format_registry.register(
2276
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2279
class BranchWriteLockResult(object):
2280
"""The result of write locking a branch.
2282
:ivar branch_token: The token obtained from the underlying branch lock, or
2284
:ivar unlock: A callable which will unlock the lock.
2287
def __init__(self, unlock, branch_token):
2288
self.branch_token = branch_token
2289
self.unlock = unlock
2292
class BzrBranch(Branch, _RelockDebugMixin):
1295
class BzrBranch(Branch):
2293
1296
"""A branch stored in the actual filesystem.
2295
1298
Note that it's "local" in the context of the filesystem; it doesn't
2296
1299
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2297
1300
it's writable, and can be accessed via the normal filesystem API.
2299
:ivar _transport: Transport for file operations on this branch's
2300
control files, typically pointing to the .bzr/branch directory.
2301
:ivar repository: Repository for this branch.
2302
:ivar base: The url of the base directory for this branch; the one
2303
containing the .bzr directory.
2304
:ivar name: Optional colocated branch name as it exists in the control
2308
1303
def __init__(self, _format=None,
2309
_control_files=None, a_bzrdir=None, name=None,
2310
_repository=None, ignore_fallbacks=False):
1304
_control_files=None, a_bzrdir=None, _repository=None):
2311
1305
"""Create new branch object at a particular location."""
1306
Branch.__init__(self)
2312
1307
if a_bzrdir is None:
2313
1308
raise ValueError('a_bzrdir must be supplied')
2315
1310
self.bzrdir = a_bzrdir
1311
# self._transport used to point to the directory containing the
1312
# control directory, but was not used - now it's just the transport
1313
# for the branch control files. mbp 20070212
2316
1314
self._base = self.bzrdir.transport.clone('..').base
2318
# XXX: We should be able to just do
2319
# self.base = self.bzrdir.root_transport.base
2320
# but this does not quite work yet -- mbp 20080522
2321
1315
self._format = _format
2322
1316
if _control_files is None:
2323
1317
raise ValueError('BzrBranch _control_files is None')
2324
1318
self.control_files = _control_files
2325
1319
self._transport = _control_files._transport
2326
1320
self.repository = _repository
2327
Branch.__init__(self)
2329
1322
def __str__(self):
2330
if self.name is None:
2331
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2333
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
1323
return '%s(%r)' % (self.__class__.__name__, self.base)
2336
1325
__repr__ = __str__
2342
1331
base = property(_get_base, doc="The URL for the root of this branch.")
2344
def _get_config(self):
2345
return TransportConfig(self._transport, 'branch.conf')
1333
def abspath(self, name):
1334
"""See Branch.abspath."""
1335
return self.control_files._transport.abspath(name)
1338
@deprecated_method(zero_sixteen)
1340
def get_root_id(self):
1341
"""See Branch.get_root_id."""
1342
tree = self.repository.revision_tree(self.last_revision())
1343
return tree.get_root_id()
2347
1345
def is_locked(self):
2348
1346
return self.control_files.is_locked()
2350
1348
def lock_write(self, token=None):
2351
"""Lock the branch for write operations.
2353
:param token: A token to permit reacquiring a previously held and
2355
:return: A BranchWriteLockResult.
2357
if not self.is_locked():
2358
self._note_lock('w')
2359
# All-in-one needs to always unlock/lock.
2360
repo_control = getattr(self.repository, 'control_files', None)
2361
if self.control_files == repo_control or not self.is_locked():
2362
self.repository._warn_if_deprecated(self)
2363
self.repository.lock_write()
1349
repo_token = self.repository.lock_write()
2368
return BranchWriteLockResult(self.unlock,
2369
self.control_files.lock_write(token=token))
1351
token = self.control_files.lock_write(token=token)
2372
self.repository.unlock()
1353
self.repository.unlock()
2375
1357
def lock_read(self):
2376
"""Lock the branch for read operations.
2378
:return: An object with an unlock method which will release the lock
2381
if not self.is_locked():
2382
self._note_lock('r')
2383
# All-in-one needs to always unlock/lock.
2384
repo_control = getattr(self.repository, 'control_files', None)
2385
if self.control_files == repo_control or not self.is_locked():
2386
self.repository._warn_if_deprecated(self)
2387
self.repository.lock_read()
1358
self.repository.lock_read()
2392
1360
self.control_files.lock_read()
2396
self.repository.unlock()
1362
self.repository.unlock()
2399
@only_raises(errors.LockNotHeld, errors.LockBroken)
2400
1365
def unlock(self):
1366
# TODO: test for failed two phase locks. This is known broken.
2402
1368
self.control_files.unlock()
2404
# All-in-one needs to always unlock/lock.
2405
repo_control = getattr(self.repository, 'control_files', None)
2406
if (self.control_files == repo_control or
2407
not self.control_files.is_locked()):
2408
self.repository.unlock()
2409
if not self.control_files.is_locked():
2410
# we just released the lock
2411
self._clear_cached_state()
1370
self.repository.unlock()
1371
if not self.control_files.is_locked():
1372
# we just released the lock
1373
self._clear_cached_state()
2413
1375
def peek_lock_mode(self):
2414
1376
if self.control_files._lock_count == 0:
2430
1392
This performs the actual writing to disk.
2431
1393
It is intended to be called by BzrBranch5.set_revision_history."""
2432
self._transport.put_bytes(
2433
'revision-history', '\n'.join(history),
2434
mode=self.bzrdir._get_file_mode())
1394
self.control_files.put_bytes(
1395
'revision-history', '\n'.join(history))
2436
1397
@needs_write_lock
2437
1398
def set_revision_history(self, rev_history):
2438
1399
"""See Branch.set_revision_history."""
2439
1400
if 'evil' in debug.debug_flags:
2440
1401
mutter_callsite(3, "set_revision_history scales with history.")
2441
check_not_reserved_id = _mod_revision.check_not_reserved_id
2442
for rev_id in rev_history:
2443
check_not_reserved_id(rev_id)
2444
if Branch.hooks['post_change_branch_tip']:
2445
# Don't calculate the last_revision_info() if there are no hooks
2447
old_revno, old_revid = self.last_revision_info()
2448
if len(rev_history) == 0:
2449
revid = _mod_revision.NULL_REVISION
2451
revid = rev_history[-1]
2452
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1402
self._clear_cached_state()
2453
1403
self._write_revision_history(rev_history)
2454
self._clear_cached_state()
2455
1404
self._cache_revision_history(rev_history)
2456
1405
for hook in Branch.hooks['set_rh']:
2457
1406
hook(self, rev_history)
2458
if Branch.hooks['post_change_branch_tip']:
2459
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2461
def _synchronize_history(self, destination, revision_id):
2462
"""Synchronize last revision and revision history between branches.
2464
This version is most efficient when the destination is also a
2465
BzrBranch5, but works for BzrBranch6 as long as the revision
2466
history is the true lefthand parent history, and all of the revisions
2467
are in the destination's repository. If not, set_revision_history
2470
:param destination: The branch to copy the history into
2471
:param revision_id: The revision-id to truncate history at. May
2472
be None to copy complete history.
2474
if not isinstance(destination._format, BzrBranchFormat5):
2475
super(BzrBranch, self)._synchronize_history(
2476
destination, revision_id)
2478
if revision_id == _mod_revision.NULL_REVISION:
2481
new_history = self.revision_history()
2482
if revision_id is not None and new_history != []:
2484
new_history = new_history[:new_history.index(revision_id) + 1]
2486
rev = self.repository.get_revision(revision_id)
2487
new_history = rev.get_history(self.repository)[1:]
2488
destination.set_revision_history(new_history)
2490
1408
@needs_write_lock
2491
1409
def set_last_revision_info(self, revno, revision_id):
2529
1465
self.set_revision_history(self._lefthand_history(revision_id,
2530
1466
last_rev, other_branch))
1469
def update_revisions(self, other, stop_revision=None, overwrite=False):
1470
"""See Branch.update_revisions."""
1473
other_last_revno, other_last_revision = other.last_revision_info()
1474
if stop_revision is None:
1475
stop_revision = other_last_revision
1476
if _mod_revision.is_null(stop_revision):
1477
# if there are no commits, we're done.
1479
# whats the current last revision, before we fetch [and change it
1481
last_rev = _mod_revision.ensure_null(self.last_revision())
1482
# we fetch here so that we don't process data twice in the common
1483
# case of having something to pull, and so that the check for
1484
# already merged can operate on the just fetched graph, which will
1485
# be cached in memory.
1486
self.fetch(other, stop_revision)
1487
# Check to see if one is an ancestor of the other
1489
heads = self.repository.get_graph().heads([stop_revision,
1491
if heads == set([last_rev]):
1492
# The current revision is a decendent of the target,
1495
elif heads == set([stop_revision, last_rev]):
1496
# These branches have diverged
1497
raise errors.DivergedBranches(self, other)
1498
assert heads == set([stop_revision])
1499
if other_last_revision == stop_revision:
1500
self.set_last_revision_info(other_last_revno,
1501
other_last_revision)
1503
# TODO: jam 2007-11-29 Is there a way to determine the
1504
# revno without searching all of history??
1506
self.generate_revision_history(stop_revision)
1508
self.generate_revision_history(stop_revision,
1509
last_rev=last_rev, other_branch=other)
2532
1513
def basis_tree(self):
2533
1514
"""See Branch.basis_tree."""
2534
1515
return self.repository.revision_tree(self.last_revision())
1518
def pull(self, source, overwrite=False, stop_revision=None,
1519
_hook_master=None, run_hooks=True, possible_transports=None):
1522
:param _hook_master: Private parameter - set the branch to
1523
be supplied as the master to push hooks.
1524
:param run_hooks: Private parameter - if false, this branch
1525
is being called because it's the master of the primary branch,
1526
so it should not run its hooks.
1528
result = PullResult()
1529
result.source_branch = source
1530
result.target_branch = self
1533
result.old_revno, result.old_revid = self.last_revision_info()
1534
self.update_revisions(source, stop_revision, overwrite=overwrite)
1535
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1536
result.new_revno, result.new_revid = self.last_revision_info()
1538
result.master_branch = _hook_master
1539
result.local_branch = self
1541
result.master_branch = self
1542
result.local_branch = None
1544
for hook in Branch.hooks['post_pull']:
2536
1550
def _get_parent_location(self):
2537
1551
_locs = ['parent', 'pull', 'x-pull']
2538
1552
for l in _locs:
2540
return self._transport.get_bytes(l).strip('\n')
2541
except errors.NoSuchFile:
1554
return self.control_files.get(l).read().strip('\n')
1560
def push(self, target, overwrite=False, stop_revision=None,
1561
_override_hook_source_branch=None):
1564
This is the basic concrete implementation of push()
1566
:param _override_hook_source_branch: If specified, run
1567
the hooks passing this Branch as the source, rather than self.
1568
This is for use of RemoteBranch, where push is delegated to the
1569
underlying vfs-based Branch.
1571
# TODO: Public option to disable running hooks - should be trivial but
1575
result = self._push_with_bound_branches(target, overwrite,
1577
_override_hook_source_branch=_override_hook_source_branch)
1582
def _push_with_bound_branches(self, target, overwrite,
1584
_override_hook_source_branch=None):
1585
"""Push from self into target, and into target's master if any.
1587
This is on the base BzrBranch class even though it doesn't support
1588
bound branches because the *target* might be bound.
1591
if _override_hook_source_branch:
1592
result.source_branch = _override_hook_source_branch
1593
for hook in Branch.hooks['post_push']:
1596
bound_location = target.get_bound_location()
1597
if bound_location and target.base != bound_location:
1598
# there is a master branch.
1600
# XXX: Why the second check? Is it even supported for a branch to
1601
# be bound to itself? -- mbp 20070507
1602
master_branch = target.get_master_branch()
1603
master_branch.lock_write()
1605
# push into the master from this branch.
1606
self._basic_push(master_branch, overwrite, stop_revision)
1607
# and push into the target branch from this. Note that we push from
1608
# this branch again, because its considered the highest bandwidth
1610
result = self._basic_push(target, overwrite, stop_revision)
1611
result.master_branch = master_branch
1612
result.local_branch = target
1616
master_branch.unlock()
1619
result = self._basic_push(target, overwrite, stop_revision)
1620
# TODO: Why set master_branch and local_branch if there's no
1621
# binding? Maybe cleaner to just leave them unset? -- mbp
1623
result.master_branch = target
1624
result.local_branch = None
2545
1628
def _basic_push(self, target, overwrite, stop_revision):
2546
1629
"""Basic implementation of push without bound branches or hooks.
2548
Must be called with source read locked and target write locked.
1631
Must be called with self read locked and target write locked.
2550
result = BranchPushResult()
1633
result = PushResult()
2551
1634
result.source_branch = self
2552
1635
result.target_branch = target
2553
1636
result.old_revno, result.old_revid = target.last_revision_info()
2554
self.update_references(target)
2555
if result.old_revid != self.last_revision():
2556
# We assume that during 'push' this repository is closer than
2558
graph = self.repository.get_graph(target.repository)
2559
target.update_revisions(self, stop_revision,
2560
overwrite=overwrite, graph=graph)
2561
if self._push_should_merge_tags():
2562
result.tag_conflicts = self.tags.merge_to(target.tags,
1638
target.update_revisions(self, stop_revision)
1639
except DivergedBranches:
1643
target.set_revision_history(self.revision_history())
1644
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2564
1645
result.new_revno, result.new_revid = target.last_revision_info()
2567
def get_stacked_on_url(self):
2568
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1648
def get_parent(self):
1649
"""See Branch.get_parent."""
1651
assert self.base[-1] == '/'
1652
parent = self._get_parent_location()
1655
# This is an old-format absolute path to a local branch
1656
# turn it into a url
1657
if parent.startswith('/'):
1658
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1660
return urlutils.join(self.base[:-1], parent)
1661
except errors.InvalidURLJoin, e:
1662
raise errors.InaccessibleParent(parent, self.base)
2570
1664
def set_push_location(self, location):
2571
1665
"""See Branch.set_push_location."""
2682
class BzrBranch8(BzrBranch5):
2683
"""A branch that stores tree-reference locations."""
2685
def _open_hook(self):
2686
if self._ignore_fallbacks:
1831
class BzrBranchExperimental(BzrBranch5):
1832
"""Bzr experimental branch format
1835
- a revision-history file.
1837
- a lock dir guarding the branch itself
1838
- all of this stored in a branch/ subdirectory
1839
- works with shared repositories.
1840
- a tag dictionary in the branch
1842
This format is new in bzr 0.15, but shouldn't be used for real data,
1845
This class acts as it's own BranchFormat.
1848
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1851
def get_format_string(cls):
1852
"""See BranchFormat.get_format_string()."""
1853
return "Bazaar-NG branch format experimental\n"
1856
def get_format_description(cls):
1857
"""See BranchFormat.get_format_description()."""
1858
return "Experimental branch format"
1861
def get_reference(cls, a_bzrdir):
1862
"""Get the target reference of the branch in a_bzrdir.
1864
format probing must have been completed before calling
1865
this method - it is assumed that the format of the branch
1866
in a_bzrdir is correct.
1868
:param a_bzrdir: The bzrdir to get the branch data from.
1869
:return: None if the branch is not a reference branch.
1874
def set_reference(self, a_bzrdir, to_branch):
1875
"""Set the target reference of the branch in a_bzrdir.
1877
format probing must have been completed before calling
1878
this method - it is assumed that the format of the branch
1879
in a_bzrdir is correct.
1881
:param a_bzrdir: The bzrdir to set the branch reference for.
1882
:param to_branch: branch that the checkout is to reference
1884
raise NotImplementedError(self.set_reference)
1887
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1889
branch_transport = a_bzrdir.get_branch_transport(cls)
1890
control_files = lockable_files.LockableFiles(branch_transport,
1891
lock_filename, lock_class)
1892
control_files.create_lock()
1893
control_files.lock_write()
2689
url = self.get_stacked_on_url()
2690
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2691
errors.UnstackableBranchFormat):
2694
for hook in Branch.hooks['transform_fallback_location']:
2695
url = hook(self, url)
2697
hook_name = Branch.hooks.get_hook_name(hook)
2698
raise AssertionError(
2699
"'transform_fallback_location' hook %s returned "
2700
"None, not a URL." % hook_name)
2701
self._activate_fallback_location(url)
2703
def __init__(self, *args, **kwargs):
2704
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2705
super(BzrBranch8, self).__init__(*args, **kwargs)
2706
self._last_revision_info_cache = None
2707
self._reference_info = None
2709
def _clear_cached_state(self):
2710
super(BzrBranch8, self)._clear_cached_state()
2711
self._last_revision_info_cache = None
2712
self._reference_info = None
2714
def _last_revision_info(self):
2715
revision_string = self._transport.get_bytes('last-revision')
1895
for filename, content in utf8_files:
1896
control_files.put_utf8(filename, content)
1898
control_files.unlock()
1901
def initialize(cls, a_bzrdir):
1902
"""Create a branch of this format in a_bzrdir."""
1903
utf8_files = [('format', cls.get_format_string()),
1904
('revision-history', ''),
1905
('branch-name', ''),
1908
cls._initialize_control_files(a_bzrdir, utf8_files,
1909
'lock', lockdir.LockDir)
1910
return cls.open(a_bzrdir, _found=True)
1913
def open(cls, a_bzrdir, _found=False):
1914
"""Return the branch object for a_bzrdir
1916
_found is a private parameter, do not use it. It is used to indicate
1917
if format probing has already be done.
1920
format = BranchFormat.find_format(a_bzrdir)
1921
assert format.__class__ == cls
1922
transport = a_bzrdir.get_branch_transport(None)
1923
control_files = lockable_files.LockableFiles(transport, 'lock',
1925
return cls(_format=cls,
1926
_control_files=control_files,
1928
_repository=a_bzrdir.find_repository())
1931
def is_supported(cls):
1934
def _make_tags(self):
1935
return BasicTags(self)
1938
def supports_tags(cls):
1942
BranchFormat.register_format(BzrBranchExperimental)
1945
class BzrBranch6(BzrBranch5):
1948
def last_revision_info(self):
1949
revision_string = self.control_files.get('last-revision').read()
2716
1950
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2717
1951
revision_id = cache_utf8.get_cached_utf8(revision_id)
2718
1952
revno = int(revno)
2719
1953
return revno, revision_id
1955
def last_revision(self):
1956
"""Return last revision id, or None"""
1957
revision_id = self.last_revision_info()[1]
2721
1960
def _write_last_revision_info(self, revno, revision_id):
2722
1961
"""Simply write out the revision id, with no checks.
2727
1966
Intended to be called by set_last_revision_info and
2728
1967
_write_revision_history.
2730
revision_id = _mod_revision.ensure_null(revision_id)
1969
if revision_id is None:
1970
revision_id = 'null:'
2731
1971
out_string = '%d %s\n' % (revno, revision_id)
2732
self._transport.put_bytes('last-revision', out_string,
2733
mode=self.bzrdir._get_file_mode())
1972
self.control_files.put_bytes('last-revision', out_string)
2735
1974
@needs_write_lock
2736
1975
def set_last_revision_info(self, revno, revision_id):
2737
revision_id = _mod_revision.ensure_null(revision_id)
2738
old_revno, old_revid = self.last_revision_info()
2739
1976
if self._get_append_revisions_only():
2740
1977
self._check_history_violation(revision_id)
2741
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2742
1978
self._write_last_revision_info(revno, revision_id)
2743
1979
self._clear_cached_state()
2744
self._last_revision_info_cache = revno, revision_id
2745
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2747
def _synchronize_history(self, destination, revision_id):
2748
"""Synchronize last revision and revision history between branches.
2750
:see: Branch._synchronize_history
2752
# XXX: The base Branch has a fast implementation of this method based
2753
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2754
# that uses set_revision_history. This class inherits from BzrBranch5,
2755
# but wants the fast implementation, so it calls
2756
# Branch._synchronize_history directly.
2757
Branch._synchronize_history(self, destination, revision_id)
2759
1981
def _check_history_violation(self, revision_id):
2760
1982
last_revision = _mod_revision.ensure_null(self.last_revision())
2761
1983
if _mod_revision.is_null(last_revision):
2763
1985
if last_revision not in self._lefthand_history(revision_id):
2764
raise errors.AppendRevisionsOnlyViolation(self.user_url)
1986
raise errors.AppendRevisionsOnlyViolation(self.base)
2766
1988
def _gen_revision_history(self):
2767
1989
"""Generate the revision history from last revision
2769
last_revno, last_revision = self.last_revision_info()
2770
self._extend_partial_history(stop_index=last_revno-1)
2771
return list(reversed(self._partial_revision_history_cache))
1991
history = list(self.repository.iter_reverse_revision_history(
1992
self.last_revision()))
2773
1996
def _write_revision_history(self, history):
2774
1997
"""Factored out of set_revision_history.
2796
2019
"""Set the parent branch"""
2797
2020
return self._get_config_location('parent_location')
2800
def _set_all_reference_info(self, info_dict):
2801
"""Replace all reference info stored in a branch.
2803
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2806
writer = rio.RioWriter(s)
2807
for key, (tree_path, branch_location) in info_dict.iteritems():
2808
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2809
branch_location=branch_location)
2810
writer.write_stanza(stanza)
2811
self._transport.put_bytes('references', s.getvalue())
2812
self._reference_info = info_dict
2815
def _get_all_reference_info(self):
2816
"""Return all the reference info stored in a branch.
2818
:return: A dict of {file_id: (tree_path, branch_location)}
2820
if self._reference_info is not None:
2821
return self._reference_info
2822
rio_file = self._transport.get('references')
2824
stanzas = rio.read_stanzas(rio_file)
2825
info_dict = dict((s['file_id'], (s['tree_path'],
2826
s['branch_location'])) for s in stanzas)
2829
self._reference_info = info_dict
2832
def set_reference_info(self, file_id, tree_path, branch_location):
2833
"""Set the branch location to use for a tree reference.
2835
:param file_id: The file-id of the tree reference.
2836
:param tree_path: The path of the tree reference in the tree.
2837
:param branch_location: The location of the branch to retrieve tree
2840
info_dict = self._get_all_reference_info()
2841
info_dict[file_id] = (tree_path, branch_location)
2842
if None in (tree_path, branch_location):
2843
if tree_path is not None:
2844
raise ValueError('tree_path must be None when branch_location'
2846
if branch_location is not None:
2847
raise ValueError('branch_location must be None when tree_path'
2849
del info_dict[file_id]
2850
self._set_all_reference_info(info_dict)
2852
def get_reference_info(self, file_id):
2853
"""Get the tree_path and branch_location for a tree reference.
2855
:return: a tuple of (tree_path, branch_location)
2857
return self._get_all_reference_info().get(file_id, (None, None))
2859
def reference_parent(self, file_id, path, possible_transports=None):
2860
"""Return the parent branch for a tree-reference file_id.
2862
:param file_id: The file_id of the tree reference
2863
:param path: The path of the file_id in the tree
2864
:return: A branch associated with the file_id
2866
branch_location = self.get_reference_info(file_id)[1]
2867
if branch_location is None:
2868
return Branch.reference_parent(self, file_id, path,
2869
possible_transports)
2870
branch_location = urlutils.join(self.user_url, branch_location)
2871
return Branch.open(branch_location,
2872
possible_transports=possible_transports)
2874
2022
def set_push_location(self, location):
2875
2023
"""See Branch.set_push_location."""
2876
2024
self._set_config_location('push_location', location)
2909
2057
"""See Branch.get_old_bound_location"""
2910
2058
return self._get_bound_location(False)
2912
def get_stacked_on_url(self):
2913
# you can always ask for the URL; but you might not be able to use it
2914
# if the repo can't support stacking.
2915
## self._check_stackable_repo()
2916
stacked_url = self._get_config_location('stacked_on_location')
2917
if stacked_url is None:
2918
raise errors.NotStacked(self)
2060
def set_append_revisions_only(self, enabled):
2065
self.get_config().set_user_option('append_revisions_only', value,
2921
2068
def _get_append_revisions_only(self):
2922
return self.get_config(
2923
).get_user_option_as_bool('append_revisions_only')
2926
def generate_revision_history(self, revision_id, last_rev=None,
2928
"""See BzrBranch5.generate_revision_history"""
2929
history = self._lefthand_history(revision_id, last_rev, other_branch)
2930
revno = len(history)
2931
self.set_last_revision_info(revno, revision_id)
2934
def get_rev_id(self, revno, history=None):
2935
"""Find the revision id of the specified revno."""
2937
return _mod_revision.NULL_REVISION
2939
last_revno, last_revision_id = self.last_revision_info()
2940
if revno <= 0 or revno > last_revno:
2941
raise errors.NoSuchRevision(self, revno)
2943
if history is not None:
2944
return history[revno - 1]
2946
index = last_revno - revno
2947
if len(self._partial_revision_history_cache) <= index:
2948
self._extend_partial_history(stop_index=index)
2949
if len(self._partial_revision_history_cache) > index:
2950
return self._partial_revision_history_cache[index]
2069
value = self.get_config().get_user_option('append_revisions_only')
2070
return value == 'True'
2072
def _synchronize_history(self, destination, revision_id):
2073
"""Synchronize last revision and revision history between branches.
2075
This version is most efficient when the destination is also a
2076
BzrBranch6, but works for BzrBranch5, as long as the destination's
2077
repository contains all the lefthand ancestors of the intended
2078
last_revision. If not, set_last_revision_info will fail.
2080
:param destination: The branch to copy the history into
2081
:param revision_id: The revision-id to truncate history at. May
2082
be None to copy complete history.
2084
source_revno, source_revision_id = self.last_revision_info()
2085
if revision_id is None:
2086
revno, revision_id = source_revno, source_revision_id
2087
elif source_revision_id == revision_id:
2088
# we know the revno without needing to walk all of history
2089
revno = source_revno
2952
raise errors.NoSuchRevision(self, revno)
2955
def revision_id_to_revno(self, revision_id):
2956
"""Given a revision id, return its revno"""
2957
if _mod_revision.is_null(revision_id):
2960
index = self._partial_revision_history_cache.index(revision_id)
2962
self._extend_partial_history(stop_revision=revision_id)
2963
index = len(self._partial_revision_history_cache) - 1
2964
if self._partial_revision_history_cache[index] != revision_id:
2965
raise errors.NoSuchRevision(self, revision_id)
2966
return self.revno() - index
2969
class BzrBranch7(BzrBranch8):
2970
"""A branch with support for a fallback repository."""
2972
def set_reference_info(self, file_id, tree_path, branch_location):
2973
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2975
def get_reference_info(self, file_id):
2976
Branch.get_reference_info(self, file_id)
2978
def reference_parent(self, file_id, path, possible_transports=None):
2979
return Branch.reference_parent(self, file_id, path,
2980
possible_transports)
2983
class BzrBranch6(BzrBranch7):
2984
"""See BzrBranchFormat6 for the capabilities of this branch.
2986
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2990
def get_stacked_on_url(self):
2991
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2091
# To figure out the revno for a random revision, we need to build
2092
# the revision history, and count its length.
2093
# We don't care about the order, just how long it is.
2094
# Alternatively, we could start at the current location, and count
2095
# backwards. But there is no guarantee that we will find it since
2096
# it may be a merged revision.
2097
revno = len(list(self.repository.iter_reverse_revision_history(
2099
destination.set_last_revision_info(revno, revision_id)
2101
def _make_tags(self):
2102
return BasicTags(self)
2994
2105
######################################################################
3105
2203
new_branch.tags._set_tag_dict({})
3107
2205
# Copying done; now update target format
3108
new_branch._transport.put_bytes('format',
3109
format.get_format_string(),
3110
mode=new_branch.bzrdir._get_file_mode())
2206
new_branch.control_files.put_utf8('format',
2207
format.get_format_string())
3112
2209
# Clean up old files
3113
new_branch._transport.delete('revision-history')
2210
new_branch.control_files._transport.delete('revision-history')
3115
2212
branch.set_parent(None)
3116
except errors.NoSuchFile:
3118
2215
branch.set_bound_location(None)
3121
class Converter6to7(object):
3122
"""Perform an in-place upgrade of format 6 to format 7"""
3124
def convert(self, branch):
3125
format = BzrBranchFormat7()
3126
branch._set_config_location('stacked_on_location', '')
3127
# update target format
3128
branch._transport.put_bytes('format', format.get_format_string())
3131
class Converter7to8(object):
3132
"""Perform an in-place upgrade of format 6 to format 7"""
3134
def convert(self, branch):
3135
format = BzrBranchFormat8()
3136
branch._transport.put_bytes('references', '')
3137
# update target format
3138
branch._transport.put_bytes('format', format.get_format_string())
3141
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3142
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3145
_run_with_write_locked_target will attempt to release the lock it acquires.
3147
If an exception is raised by callable, then that exception *will* be
3148
propagated, even if the unlock attempt raises its own error. Thus
3149
_run_with_write_locked_target should be preferred to simply doing::
3153
return callable(*args, **kwargs)
3158
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3159
# should share code?
3162
result = callable(*args, **kwargs)
3164
exc_info = sys.exc_info()
3168
raise exc_info[0], exc_info[1], exc_info[2]
3174
class InterBranch(InterObject):
3175
"""This class represents operations taking place between two branches.
3177
Its instances have methods like pull() and push() and contain
3178
references to the source and target repositories these operations
3179
can be carried out on.
3183
"""The available optimised InterBranch types."""
3186
def _get_branch_formats_to_test():
3187
"""Return a tuple with the Branch formats to use when testing."""
3188
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3190
def pull(self, overwrite=False, stop_revision=None,
3191
possible_transports=None, local=False):
3192
"""Mirror source into target branch.
3194
The target branch is considered to be 'local', having low latency.
3196
:returns: PullResult instance
3198
raise NotImplementedError(self.pull)
3200
def update_revisions(self, stop_revision=None, overwrite=False,
3202
"""Pull in new perfect-fit revisions.
3204
:param stop_revision: Updated until the given revision
3205
:param overwrite: Always set the branch pointer, rather than checking
3206
to see if it is a proper descendant.
3207
:param graph: A Graph object that can be used to query history
3208
information. This can be None.
3211
raise NotImplementedError(self.update_revisions)
3213
def push(self, overwrite=False, stop_revision=None,
3214
_override_hook_source_branch=None):
3215
"""Mirror the source branch into the target branch.
3217
The source branch is considered to be 'local', having low latency.
3219
raise NotImplementedError(self.push)
3222
class GenericInterBranch(InterBranch):
3223
"""InterBranch implementation that uses public Branch functions.
3227
def _get_branch_formats_to_test():
3228
return BranchFormat._default_format, BranchFormat._default_format
3230
def update_revisions(self, stop_revision=None, overwrite=False,
3232
"""See InterBranch.update_revisions()."""
3233
self.source.lock_read()
3235
other_revno, other_last_revision = self.source.last_revision_info()
3236
stop_revno = None # unknown
3237
if stop_revision is None:
3238
stop_revision = other_last_revision
3239
if _mod_revision.is_null(stop_revision):
3240
# if there are no commits, we're done.
3242
stop_revno = other_revno
3244
# what's the current last revision, before we fetch [and change it
3246
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3247
# we fetch here so that we don't process data twice in the common
3248
# case of having something to pull, and so that the check for
3249
# already merged can operate on the just fetched graph, which will
3250
# be cached in memory.
3251
self.target.fetch(self.source, stop_revision)
3252
# Check to see if one is an ancestor of the other
3255
graph = self.target.repository.get_graph()
3256
if self.target._check_if_descendant_or_diverged(
3257
stop_revision, last_rev, graph, self.source):
3258
# stop_revision is a descendant of last_rev, but we aren't
3259
# overwriting, so we're done.
3261
if stop_revno is None:
3263
graph = self.target.repository.get_graph()
3264
this_revno, this_last_revision = \
3265
self.target.last_revision_info()
3266
stop_revno = graph.find_distance_to_null(stop_revision,
3267
[(other_last_revision, other_revno),
3268
(this_last_revision, this_revno)])
3269
self.target.set_last_revision_info(stop_revno, stop_revision)
3271
self.source.unlock()
3273
def pull(self, overwrite=False, stop_revision=None,
3274
possible_transports=None, _hook_master=None, run_hooks=True,
3275
_override_hook_target=None, local=False):
3278
:param _hook_master: Private parameter - set the branch to
3279
be supplied as the master to pull hooks.
3280
:param run_hooks: Private parameter - if false, this branch
3281
is being called because it's the master of the primary branch,
3282
so it should not run its hooks.
3283
:param _override_hook_target: Private parameter - set the branch to be
3284
supplied as the target_branch to pull hooks.
3285
:param local: Only update the local branch, and not the bound branch.
3287
# This type of branch can't be bound.
3289
raise errors.LocalRequiresBoundBranch()
3290
result = PullResult()
3291
result.source_branch = self.source
3292
if _override_hook_target is None:
3293
result.target_branch = self.target
3295
result.target_branch = _override_hook_target
3296
self.source.lock_read()
3298
# We assume that during 'pull' the target repository is closer than
3300
self.source.update_references(self.target)
3301
graph = self.target.repository.get_graph(self.source.repository)
3302
# TODO: Branch formats should have a flag that indicates
3303
# that revno's are expensive, and pull() should honor that flag.
3305
result.old_revno, result.old_revid = \
3306
self.target.last_revision_info()
3307
self.target.update_revisions(self.source, stop_revision,
3308
overwrite=overwrite, graph=graph)
3309
# TODO: The old revid should be specified when merging tags,
3310
# so a tags implementation that versions tags can only
3311
# pull in the most recent changes. -- JRV20090506
3312
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3314
result.new_revno, result.new_revid = self.target.last_revision_info()
3316
result.master_branch = _hook_master
3317
result.local_branch = result.target_branch
3319
result.master_branch = result.target_branch
3320
result.local_branch = None
3322
for hook in Branch.hooks['post_pull']:
3325
self.source.unlock()
3328
def push(self, overwrite=False, stop_revision=None,
3329
_override_hook_source_branch=None):
3330
"""See InterBranch.push.
3332
This is the basic concrete implementation of push()
3334
:param _override_hook_source_branch: If specified, run
3335
the hooks passing this Branch as the source, rather than self.
3336
This is for use of RemoteBranch, where push is delegated to the
3337
underlying vfs-based Branch.
3339
# TODO: Public option to disable running hooks - should be trivial but
3341
self.source.lock_read()
3343
return _run_with_write_locked_target(
3344
self.target, self._push_with_bound_branches, overwrite,
3346
_override_hook_source_branch=_override_hook_source_branch)
3348
self.source.unlock()
3350
def _push_with_bound_branches(self, overwrite, stop_revision,
3351
_override_hook_source_branch=None):
3352
"""Push from source into target, and into target's master if any.
3355
if _override_hook_source_branch:
3356
result.source_branch = _override_hook_source_branch
3357
for hook in Branch.hooks['post_push']:
3360
bound_location = self.target.get_bound_location()
3361
if bound_location and self.target.base != bound_location:
3362
# there is a master branch.
3364
# XXX: Why the second check? Is it even supported for a branch to
3365
# be bound to itself? -- mbp 20070507
3366
master_branch = self.target.get_master_branch()
3367
master_branch.lock_write()
3369
# push into the master from the source branch.
3370
self.source._basic_push(master_branch, overwrite, stop_revision)
3371
# and push into the target branch from the source. Note that we
3372
# push from the source branch again, because its considered the
3373
# highest bandwidth repository.
3374
result = self.source._basic_push(self.target, overwrite,
3376
result.master_branch = master_branch
3377
result.local_branch = self.target
3381
master_branch.unlock()
3384
result = self.source._basic_push(self.target, overwrite,
3386
# TODO: Why set master_branch and local_branch if there's no
3387
# binding? Maybe cleaner to just leave them unset? -- mbp
3389
result.master_branch = self.target
3390
result.local_branch = None
3395
def is_compatible(self, source, target):
3396
# GenericBranch uses the public API, so always compatible
3400
class InterToBranch5(GenericInterBranch):
3403
def _get_branch_formats_to_test():
3404
return BranchFormat._default_format, BzrBranchFormat5()
3406
def pull(self, overwrite=False, stop_revision=None,
3407
possible_transports=None, run_hooks=True,
3408
_override_hook_target=None, local=False):
3409
"""Pull from source into self, updating my master if any.
3411
:param run_hooks: Private parameter - if false, this branch
3412
is being called because it's the master of the primary branch,
3413
so it should not run its hooks.
3415
bound_location = self.target.get_bound_location()
3416
if local and not bound_location:
3417
raise errors.LocalRequiresBoundBranch()
3418
master_branch = None
3419
if not local and bound_location and self.source.user_url != bound_location:
3420
# not pulling from master, so we need to update master.
3421
master_branch = self.target.get_master_branch(possible_transports)
3422
master_branch.lock_write()
3425
# pull from source into master.
3426
master_branch.pull(self.source, overwrite, stop_revision,
3428
return super(InterToBranch5, self).pull(overwrite,
3429
stop_revision, _hook_master=master_branch,
3430
run_hooks=run_hooks,
3431
_override_hook_target=_override_hook_target)
3434
master_branch.unlock()
3437
InterBranch.register_optimiser(GenericInterBranch)
3438
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
