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